code.delx.au - pulseaudio/blob - src/pulsecore/sink.h

   1 #ifndef foopulsesinkhfoo
   2 #define foopulsesinkhfoo
   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.1 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 typedef struct pa_sink pa_sink;
  27 typedef struct pa_device_port pa_device_port;
  28
  29 #include <inttypes.h>
  30
  31 #include <pulse/def.h>
  32 #include <pulse/sample.h>
  33 #include <pulse/channelmap.h>
  34 #include <pulse/volume.h>
  35
  36 #include <pulsecore/core.h>
  37 #include <pulsecore/idxset.h>
  38 #include <pulsecore/source.h>
  39 #include <pulsecore/module.h>
  40 #include <pulsecore/refcnt.h>
  41 #include <pulsecore/msgobject.h>
  42 #include <pulsecore/rtpoll.h>
  43 #include <pulsecore/card.h>
  44 #include <pulsecore/queue.h>
  45 #include <pulsecore/thread-mq.h>
  46
  47 #define PA_MAX_INPUTS_PER_SINK 32
  48
  49 /* Returns true if sink is linked: registered and accessible from client side. */
  50 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
  51     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  52 }
  53
  54 struct pa_device_port {
  55     char *name;
  56     char *description;
  57
  58     unsigned priority;
  59
  60     /* .. followed by some implementation specific data */
  61 };
  62
  63 #define PA_DEVICE_PORT_DATA(d) ((void*) ((uint8_t*) d + PA_ALIGN(sizeof(pa_device_port))))
  64
  65 struct pa_sink {
  66     pa_msgobject parent;
  67
  68     uint32_t index;
  69     pa_core *core;
  70
  71     pa_sink_state_t state;
  72     pa_sink_flags_t flags;
  73     pa_suspend_cause_t suspend_cause;
  74
  75     char *name;
  76     char *driver;                           /* may be NULL */
  77     pa_proplist *proplist;
  78
  79     pa_module *module;                      /* may be NULL */
  80     pa_card *card;                          /* may be NULL */
  81
  82     pa_sample_spec sample_spec;
  83     pa_channel_map channel_map;
  84
  85     pa_idxset *inputs;
  86     unsigned n_corked;
  87     pa_source *monitor_source;
  88
  89     pa_volume_t base_volume; /* shall be constant */
  90     unsigned n_volume_steps; /* shall be constant */
  91
  92     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
  93     pa_cvolume virtual_volume;   /* The volume clients are informed about */
  94     pa_cvolume reference_volume; /* The volume taken as refernce base for relative sink input volumes */
  95     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
  96     pa_bool_t muted:1;
  97
  98     pa_bool_t refresh_volume:1;
  99     pa_bool_t refresh_muted:1;
 100     pa_bool_t save_port:1;
 101     pa_bool_t save_volume:1;
 102     pa_bool_t save_muted:1;
 103
 104     pa_asyncmsgq *asyncmsgq;
 105
 106     pa_memchunk silence;
 107
 108     pa_hashmap *ports;
 109     pa_device_port *active_port;
 110
 111     /* Called when the main loop requests a state change. Called from
 112      * main loop context. If returns -1 the state change will be
 113      * inhibited */
 114     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
 115
 116     /* Callled when the volume is queried. Called from main loop
 117      * context. If this is NULL a PA_SINK_MESSAGE_GET_VOLUME message
 118      * will be sent to the IO thread instead. If refresh_volume is
 119      * FALSE neither this function is called nor a message is sent. */
 120     void (*get_volume)(pa_sink *s);             /* may be NULL */
 121
 122     /* Called when the volume shall be changed. Called from main loop
 123      * context. If this is NULL a PA_SINK_MESSAGE_SET_VOLUME message
 124      * will be sent to the IO thread instead. */
 125     void (*set_volume)(pa_sink *s);             /* dito */
 126
 127     /* Called when the mute setting is queried. Called from main loop
 128      * context. If this is NULL a PA_SINK_MESSAGE_GET_MUTE message
 129      * will be sent to the IO thread instead. If refresh_mute is
 130      * FALSE neither this function is called nor a message is sent.*/
 131     void (*get_mute)(pa_sink *s);               /* dito */
 132
 133     /* Called when the mute setting shall be changed. Called from main
 134      * loop context. If this is NULL a PA_SINK_MESSAGE_SET_MUTE
 135      * message will be sent to the IO thread instead. */
 136     void (*set_mute)(pa_sink *s);               /* dito */
 137
 138     /* Called when a rewind request is issued. Called from IO thread
 139      * context. */
 140     void (*request_rewind)(pa_sink *s);        /* dito */
 141
 142     /* Called when a the requested latency is changed. Called from IO
 143      * thread context. */
 144     void (*update_requested_latency)(pa_sink *s); /* dito */
 145
 146     /* Called whenever the port shall be changed. Called from main
 147      * thread. */
 148     int (*set_port)(pa_sink *s, pa_device_port *port); /* dito */
 149
 150     /* Contains copies of the above data so that the real-time worker
 151      * thread can work without access locking */
 152     struct {
 153         pa_sink_state_t state;
 154         pa_hashmap *inputs;
 155
 156         pa_rtpoll *rtpoll;
 157
 158         pa_cvolume soft_volume;
 159         pa_bool_t soft_muted:1;
 160
 161         /* The requested latency is used for dynamic latency
 162          * sinks. For fixed latency sinks it is always identical to
 163          * the fixed_latency. See below. */
 164         pa_bool_t requested_latency_valid:1;
 165         pa_usec_t requested_latency;
 166
 167         /* The number of bytes streams need to keep around as history to
 168          * be able to satisfy every DMA buffer rewrite */
 169         size_t max_rewind;
 170
 171         /* The number of bytes streams need to keep around to satisfy
 172          * every DMA write request */
 173         size_t max_request;
 174
 175         /* Maximum of what clients requested to rewind in this cycle */
 176         size_t rewind_nbytes;
 177         pa_bool_t rewind_requested;
 178
 179         /* Both dynamic and fixed latencies will be clamped to this
 180          * range. */
 181         pa_usec_t min_latency; /* we won't go below this latency */
 182         pa_usec_t max_latency; /* An upper limit for the latencies */
 183
 184         /* 'Fixed' simply means that the latency is exclusively
 185          * decided on by the sink, and the clients have no influence
 186          * in changing it */
 187         pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
 188     } thread_info;
 189
 190     void *userdata;
 191 };
 192
 193 PA_DECLARE_CLASS(pa_sink);
 194 #define PA_SINK(s) (pa_sink_cast(s))
 195
 196 typedef enum pa_sink_message {
 197     PA_SINK_MESSAGE_ADD_INPUT,
 198     PA_SINK_MESSAGE_REMOVE_INPUT,
 199     PA_SINK_MESSAGE_GET_VOLUME,
 200     PA_SINK_MESSAGE_SET_VOLUME,
 201     PA_SINK_MESSAGE_SYNC_VOLUMES,
 202     PA_SINK_MESSAGE_GET_MUTE,
 203     PA_SINK_MESSAGE_SET_MUTE,
 204     PA_SINK_MESSAGE_GET_LATENCY,
 205     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 206     PA_SINK_MESSAGE_SET_STATE,
 207     PA_SINK_MESSAGE_START_MOVE,
 208     PA_SINK_MESSAGE_FINISH_MOVE,
 209     PA_SINK_MESSAGE_ATTACH,
 210     PA_SINK_MESSAGE_DETACH,
 211     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 212     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 213     PA_SINK_MESSAGE_SET_FIXED_LATENCY,
 214     PA_SINK_MESSAGE_GET_FIXED_LATENCY,
 215     PA_SINK_MESSAGE_GET_MAX_REWIND,
 216     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 217     PA_SINK_MESSAGE_SET_MAX_REWIND,
 218     PA_SINK_MESSAGE_SET_MAX_REQUEST,
 219     PA_SINK_MESSAGE_MAX
 220 } pa_sink_message_t;
 221
 222 typedef struct pa_sink_new_data {
 223     char *name;
 224     pa_proplist *proplist;
 225
 226     const char *driver;
 227     pa_module *module;
 228     pa_card *card;
 229
 230     pa_hashmap *ports;
 231     char *active_port;
 232
 233     pa_sample_spec sample_spec;
 234     pa_channel_map channel_map;
 235     pa_cvolume volume;
 236     pa_bool_t muted :1;
 237
 238     pa_bool_t sample_spec_is_set:1;
 239     pa_bool_t channel_map_is_set:1;
 240     pa_bool_t volume_is_set:1;
 241     pa_bool_t muted_is_set:1;
 242
 243     pa_bool_t namereg_fail:1;
 244
 245     pa_bool_t save_port:1;
 246     pa_bool_t save_volume:1;
 247     pa_bool_t save_muted:1;
 248 } pa_sink_new_data;
 249
 250 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 251 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 252 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 253 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 254 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 255 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 256 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
 257 void pa_sink_new_data_done(pa_sink_new_data *data);
 258
 259 /*** To be called exclusively by the sink driver, from main context */
 260
 261 pa_sink* pa_sink_new(
 262         pa_core *core,
 263         pa_sink_new_data *data,
 264         pa_sink_flags_t flags);
 265
 266 void pa_sink_put(pa_sink *s);
 267 void pa_sink_unlink(pa_sink* s);
 268
 269 void pa_sink_set_description(pa_sink *s, const char *description);
 270 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 271 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 272
 273 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 274 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
 275 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 276 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
 277
 278 void pa_sink_detach(pa_sink *s);
 279 void pa_sink_attach(pa_sink *s);
 280
 281 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
 282 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
 283 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted);
 284
 285 pa_bool_t pa_device_init_description(pa_proplist *p);
 286 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
 287 pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
 288
 289 /**** May be called by everyone, from main context */
 290
 291 /* The returned value is supposed to be in the time domain of the sound card! */
 292 pa_usec_t pa_sink_get_latency(pa_sink *s);
 293 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 294 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 295 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s);
 296
 297 size_t pa_sink_get_max_rewind(pa_sink *s);
 298 size_t pa_sink_get_max_request(pa_sink *s);
 299
 300 int pa_sink_update_status(pa_sink*s);
 301 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 302 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 303
 304 void pa_sink_update_flat_volume(pa_sink *s, pa_cvolume *new_volume);
 305 void pa_sink_propagate_flat_volume(pa_sink *s);
 306
 307 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, pa_bool_t propagate, pa_bool_t sendmsg, pa_bool_t become_reference, pa_bool_t save);
 308 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh, pa_bool_t reference);
 309
 310 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
 311 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
 312
 313 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
 314
 315 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
 316
 317 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 318 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 319 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
 320 #define pa_sink_get_state(s) ((s)->state)
 321
 322 /* Moves all inputs away, and stores them in pa_queue */
 323 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
 324 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
 325 void pa_sink_move_all_fail(pa_queue *q);
 326
 327 /*** To be called exclusively by the sink driver, from IO context */
 328
 329 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 330 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 331 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 332 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 333
 334 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 335
 336 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 337
 338 void pa_sink_attach_within_thread(pa_sink *s);
 339 void pa_sink_detach_within_thread(pa_sink *s);
 340
 341 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 342
 343 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
 344 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
 345
 346 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 347 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
 348
 349 /*** To be called exclusively by sink input drivers, from IO context */
 350
 351 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 352
 353 void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic);
 354
 355 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
 356
 357 pa_device_port *pa_device_port_new(const char *name, const char *description, size_t extra);
 358 void pa_device_port_free(pa_device_port *p);
 359
 360 /* Verify that we called in IO context (aka 'thread context), or that
 361  * the sink is not yet set up, i.e. the thread not set up yet. See
 362  * pa_assert_io_context() in thread-mq.h for more information. */
 363 #define pa_sink_assert_io_context(s) \
 364     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
 365
 366 #endif