code.delx.au - pulseaudio/blob - src/pulse/internal.h

   1 #ifndef foointernalhfoo
   2 #define foointernalhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   9
  10   PulseAudio is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU Lesser General Public License as published
  12   by the Free Software Foundation; either version 2 of the License,
  13   or (at your option) any later version.
  14
  15   PulseAudio is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with PulseAudio; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <pulse/mainloop-api.h>
  27 #include <pulse/context.h>
  28 #include <pulse/stream.h>
  29 #include <pulse/operation.h>
  30 #include <pulse/subscribe.h>
  31 #include <pulse/ext-stream-restore.h>
  32
  33 #include <pulsecore/socket-client.h>
  34 #include <pulsecore/pstream.h>
  35 #include <pulsecore/pdispatch.h>
  36 #include <pulsecore/dynarray.h>
  37 #include <pulsecore/llist.h>
  38 #include <pulsecore/native-common.h>
  39 #include <pulsecore/strlist.h>
  40 #include <pulsecore/mcalign.h>
  41 #include <pulsecore/memblockq.h>
  42 #include <pulsecore/hashmap.h>
  43 #include <pulsecore/refcnt.h>
  44 #include <pulsecore/time-smoother.h>
  45
  46 #include "client-conf.h"
  47
  48 #define DEFAULT_TIMEOUT (30)
  49
  50 struct pa_context {
  51     PA_REFCNT_DECLARE;
  52
  53     pa_proplist *proplist;
  54     pa_mainloop_api* mainloop;
  55
  56     pa_socket_client *client;
  57     pa_pstream *pstream;
  58     pa_pdispatch *pdispatch;
  59
  60     pa_dynarray *record_streams, *playback_streams;
  61     PA_LLIST_HEAD(pa_stream, streams);
  62     PA_LLIST_HEAD(pa_operation, operations);
  63
  64     uint32_t version;
  65     uint32_t ctag;
  66     uint32_t csyncid;
  67     int error;
  68     pa_context_state_t state;
  69
  70     pa_context_notify_cb_t state_callback;
  71     void *state_userdata;
  72     pa_context_subscribe_cb_t subscribe_callback;
  73     void *subscribe_userdata;
  74
  75     pa_mempool *mempool;
  76
  77     pa_bool_t is_local:1;
  78     pa_bool_t do_shm:1;
  79
  80     pa_bool_t do_autospawn:1;
  81     pa_spawn_api spawn_api;
  82
  83     pa_strlist *server_list;
  84
  85     char *server;
  86
  87     pa_client_conf *conf;
  88
  89     uint32_t client_index;
  90
  91     /* Extension specific data */
  92     struct {
  93         pa_ext_stream_restore_subscribe_cb_t callback;
  94         void *userdata;
  95     } ext_stream_restore;
  96 };
  97
  98 #define PA_MAX_WRITE_INDEX_CORRECTIONS 32
  99
 100 typedef struct pa_index_correction {
 101     uint32_t tag;
 102     int64_t value;
 103     pa_bool_t valid:1;
 104     pa_bool_t absolute:1;
 105     pa_bool_t corrupt:1;
 106 } pa_index_correction;
 107
 108 struct pa_stream {
 109     PA_REFCNT_DECLARE;
 110     PA_LLIST_FIELDS(pa_stream);
 111
 112     pa_context *context;
 113     pa_mainloop_api *mainloop;
 114
 115     uint32_t direct_on_input;
 116
 117     pa_stream_direction_t direction;
 118     pa_stream_state_t state;
 119     pa_stream_flags_t flags;
 120
 121     pa_sample_spec sample_spec;
 122     pa_channel_map channel_map;
 123
 124     pa_proplist *proplist;
 125
 126     pa_bool_t channel_valid:1;
 127     pa_bool_t suspended:1;
 128     pa_bool_t corked:1;
 129     pa_bool_t timing_info_valid:1;
 130     pa_bool_t auto_timing_update_requested:1;
 131
 132     uint32_t channel;
 133     uint32_t syncid;
 134     uint32_t stream_index;
 135
 136     uint32_t requested_bytes;
 137     pa_buffer_attr buffer_attr;
 138
 139     uint32_t device_index;
 140     char *device_name;
 141
 142     pa_memchunk peek_memchunk;
 143     void *peek_data;
 144     pa_memblockq *record_memblockq;
 145
 146     /* Store latest latency info */
 147     pa_timing_info timing_info;
 148
 149     /* Use to make sure that time advances monotonically */
 150     pa_usec_t previous_time;
 151
 152     /* time updates with tags older than these are invalid */
 153     uint32_t write_index_not_before;
 154     uint32_t read_index_not_before;
 155
 156     /* Data about individual timing update correctoins */
 157     pa_index_correction write_index_corrections[PA_MAX_WRITE_INDEX_CORRECTIONS];
 158     int current_write_index_correction;
 159
 160     /* Latency interpolation stuff */
 161     pa_time_event *auto_timing_update_event;
 162
 163     pa_smoother *smoother;
 164
 165     /* Callbacks */
 166     pa_stream_notify_cb_t state_callback;
 167     void *state_userdata;
 168     pa_stream_request_cb_t read_callback;
 169     void *read_userdata;
 170     pa_stream_request_cb_t write_callback;
 171     void *write_userdata;
 172     pa_stream_notify_cb_t overflow_callback;
 173     void *overflow_userdata;
 174     pa_stream_notify_cb_t underflow_callback;
 175     void *underflow_userdata;
 176     pa_stream_notify_cb_t latency_update_callback;
 177     void *latency_update_userdata;
 178     pa_stream_notify_cb_t moved_callback;
 179     void *moved_userdata;
 180     pa_stream_notify_cb_t suspended_callback;
 181     void *suspended_userdata;
 182     pa_stream_notify_cb_t started_callback;
 183     void *started_userdata;
 184 };
 185
 186 typedef void (*pa_operation_cb_t)(void);
 187
 188 struct pa_operation {
 189     PA_REFCNT_DECLARE;
 190
 191     pa_context *context;
 192     pa_stream *stream;
 193
 194     PA_LLIST_FIELDS(pa_operation);
 195
 196     pa_operation_state_t state;
 197     void *userdata;
 198     pa_operation_cb_t callback;
 199
 200     void *private; /* some operations might need this */
 201 };
 202
 203 void pa_command_request(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 204 void pa_command_stream_killed(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 205 void pa_command_subscribe_event(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 206 void pa_command_overflow_or_underflow(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 207 void pa_command_stream_suspended(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 208 void pa_command_stream_moved(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 209 void pa_command_stream_started(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 210 pa_operation *pa_operation_new(pa_context *c, pa_stream *s, pa_operation_cb_t callback, void *userdata);
 211 void pa_operation_done(pa_operation *o);
 212
 213 void pa_create_stream_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 214 void pa_stream_disconnect_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 215 void pa_context_simple_ack_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 216 void pa_stream_simple_ack_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
 217
 218 void pa_context_fail(pa_context *c, int error);
 219 int pa_context_set_error(pa_context *c, int error);
 220 void pa_context_set_state(pa_context *c, pa_context_state_t st);
 221 int pa_context_handle_error(pa_context *c, uint32_t command, pa_tagstruct *t, pa_bool_t fail);
 222 pa_operation* pa_context_send_simple_command(pa_context *c, uint32_t command, void (*internal_callback)(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata), void (*cb)(void), void *userdata);
 223
 224 void pa_stream_set_state(pa_stream *s, pa_stream_state_t st);
 225
 226 pa_tagstruct *pa_tagstruct_command(pa_context *c, uint32_t command, uint32_t *tag);
 227
 228 #define PA_CHECK_VALIDITY(context, expression, error) do { \
 229         if (!(expression)) \
 230             return -pa_context_set_error((context), (error)); \
 231 } while(0)
 232
 233
 234 #define PA_CHECK_VALIDITY_RETURN_ANY(context, expression, error, value) do { \
 235         if (!(expression)) { \
 236             pa_context_set_error((context), (error)); \
 237             return value; \
 238         } \
 239 } while(0)
 240
 241 #define PA_CHECK_VALIDITY_RETURN_NULL(context, expression, error) PA_CHECK_VALIDITY_RETURN_ANY(context, expression, error, NULL)
 242
 243 void pa_ext_stream_restore_command(pa_context *c, uint32_t tag, pa_tagstruct *t);
 244
 245 #endif