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 typedef struct pa_sink_volume_change pa_sink_volume_change;
  29
  30 #include <inttypes.h>
  31
  32 #include <pulse/def.h>
  33 #include <pulse/sample.h>
  34 #include <pulse/channelmap.h>
  35 #include <pulse/volume.h>
  36
  37 #include <pulsecore/core.h>
  38 #include <pulsecore/idxset.h>
  39 #include <pulsecore/source.h>
  40 #include <pulsecore/module.h>
  41 #include <pulsecore/refcnt.h>
  42 #include <pulsecore/msgobject.h>
  43 #include <pulsecore/rtpoll.h>
  44 #include <pulsecore/card.h>
  45 #include <pulsecore/queue.h>
  46 #include <pulsecore/thread-mq.h>
  47
  48 #define PA_MAX_INPUTS_PER_SINK 32
  49
  50 /* Returns true if sink is linked: registered and accessible from client side. */
  51 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
  52     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  53 }
  54
  55 struct pa_device_port {
  56     char *name;
  57     char *description;
  58
  59     unsigned priority;
  60
  61     /* .. followed by some implementation specific data */
  62 };
  63
  64 #define PA_DEVICE_PORT_DATA(d) ((void*) ((uint8_t*) d + PA_ALIGN(sizeof(pa_device_port))))
  65
  66 struct pa_sink {
  67     pa_msgobject parent;
  68
  69     uint32_t index;
  70     pa_core *core;
  71
  72     pa_sink_state_t state;
  73     pa_sink_flags_t flags;
  74     pa_suspend_cause_t suspend_cause;
  75
  76     char *name;
  77     char *driver;                           /* may be NULL */
  78     pa_proplist *proplist;
  79
  80     pa_module *module;                      /* may be NULL */
  81     pa_card *card;                          /* may be NULL */
  82
  83     pa_sample_spec sample_spec;
  84     pa_channel_map channel_map;
  85
  86     pa_idxset *inputs;
  87     unsigned n_corked;
  88     pa_source *monitor_source;
  89
  90     pa_volume_t base_volume; /* shall be constant */
  91     unsigned n_volume_steps; /* shall be constant */
  92
  93     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
  94     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative sink input volumes */
  95     pa_cvolume real_volume;      /* The volume that the hardware is configured to  */
  96     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
  97
  98     pa_bool_t muted:1;
  99
 100     pa_bool_t refresh_volume:1;
 101     pa_bool_t refresh_muted:1;
 102     pa_bool_t save_port:1;
 103     pa_bool_t save_volume:1;
 104     pa_bool_t save_muted:1;
 105
 106     pa_asyncmsgq *asyncmsgq;
 107
 108     pa_memchunk silence;
 109
 110     pa_hashmap *ports;
 111     pa_device_port *active_port;
 112
 113     unsigned priority;
 114
 115     /* Called when the main loop requests a state change. Called from
 116      * main loop context. If returns -1 the state change will be
 117      * inhibited */
 118     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
 119
 120     /* Sink drivers that support hardware volume may set this
 121      * callback. This is called when the current volume needs to be
 122      * re-read from the hardware.
 123      *
 124      * There are two ways for drivers to implement hardware volume
 125      * query: either set this callback or handle
 126      * PA_SINK_MESSAGE_GET_VOLUME. The callback implementation or the
 127      * message handler must update s->real_volume and s->soft_volume
 128      * (using pa_sink_set_soft_volume()) to match the current hardware
 129      * volume.
 130      *
 131      * If PA_SINK_SYNC_VOLUME is not set, then this is called from the
 132      * main thread before sending PA_SINK_MESSAGE_GET_VOLUME, so in
 133      * this case the driver can choose whether to read the volume from
 134      * the hardware in the main thread or in the IO thread.
 135      *
 136      * If PA_SINK_SYNC_VOLUME is set, then this is called from the IO
 137      * thread within the default handler for
 138      * PA_SINK_MESSAGE_GET_VOLUME (the main thread is waiting while
 139      * the message is being processed), so there's no choice of where
 140      * to do the volume reading - it has to be done in the IO thread
 141      * always. */
 142     void (*get_volume)(pa_sink *s);             /* may be NULL */
 143
 144     /* Sink drivers that support hardware volume must set this
 145      * callback. This is called when the hardware volume needs to be
 146      * updated.
 147      *
 148      * If PA_SINK_SYNC_VOLUME is not set, then this is called from the
 149      * main thread. The callback implementation must set the hardware
 150      * volume according to s->real_volume. If the driver can't set the
 151      * hardware volume to the exact requested value, it has to update
 152      * s->real_volume and/or s->soft_volume so that they together
 153      * match the actual hardware volume that was set.
 154      *
 155      * If PA_SINK_SYNC_VOLUME is set, then this is called from the IO
 156      * thread. The callback implementation must not actually set the
 157      * hardware volume yet, but it must check how close to the
 158      * requested volume the hardware volume can be set, and update
 159      * s->real_volume and/or s->soft_volume so that they together
 160      * match the actual hardware volume that will be set later in the
 161      * write_volume callback. */
 162     void (*set_volume)(pa_sink *s);             /* dito */
 163
 164     /* Sink drivers that set PA_SINK_SYNC_VOLUME must provide this
 165      * callback. This callback is not used with sinks that do not set
 166      * PA_SINK_SYNC_VOLUME. This is called from the IO thread when a
 167      * pending hardware volume change has to be written to the
 168      * hardware. The requested volume is passed to the callback
 169      * implementation in s->thread_info.current_hw_volume.
 170      *
 171      * The call is done inside pa_sink_volume_change_apply(), which is
 172      * not called automatically - it is the driver's responsibility to
 173      * schedule that function to be called at the right times in the
 174      * IO thread. */
 175     void (*write_volume)(pa_sink *s);           /* dito */
 176
 177     /* Called when the mute setting is queried. A PA_SINK_MESSAGE_GET_MUTE
 178      * message will also be sent. Called from IO thread if PA_SINK_SYNC_VOLUME
 179      * flag is set otherwise from main loop context. If refresh_mute is FALSE
 180      * neither this function is called nor a message is sent.*/
 181     void (*get_mute)(pa_sink *s);               /* dito */
 182
 183     /* Called when the mute setting shall be changed. A PA_SINK_MESSAGE_SET_MUTE
 184      * message will also be sent. Called from IO thread if PA_SINK_SYNC_VOLUME
 185      * flag is set otherwise from main loop context. */
 186     void (*set_mute)(pa_sink *s);               /* dito */
 187
 188     /* Called when a rewind request is issued. Called from IO thread
 189      * context. */
 190     void (*request_rewind)(pa_sink *s);        /* dito */
 191
 192     /* Called when a the requested latency is changed. Called from IO
 193      * thread context. */
 194     void (*update_requested_latency)(pa_sink *s); /* dito */
 195
 196     /* Called whenever the port shall be changed. Called from main
 197      * thread. */
 198     int (*set_port)(pa_sink *s, pa_device_port *port); /* dito */
 199
 200     /* Contains copies of the above data so that the real-time worker
 201      * thread can work without access locking */
 202     struct {
 203         pa_sink_state_t state;
 204         pa_hashmap *inputs;
 205
 206         pa_rtpoll *rtpoll;
 207
 208         pa_cvolume soft_volume;
 209         pa_bool_t soft_muted:1;
 210
 211         /* The requested latency is used for dynamic latency
 212          * sinks. For fixed latency sinks it is always identical to
 213          * the fixed_latency. See below. */
 214         pa_bool_t requested_latency_valid:1;
 215         pa_usec_t requested_latency;
 216
 217         /* The number of bytes streams need to keep around as history to
 218          * be able to satisfy every DMA buffer rewrite */
 219         size_t max_rewind;
 220
 221         /* The number of bytes streams need to keep around to satisfy
 222          * every DMA write request */
 223         size_t max_request;
 224
 225         /* Maximum of what clients requested to rewind in this cycle */
 226         size_t rewind_nbytes;
 227         pa_bool_t rewind_requested;
 228
 229         /* Both dynamic and fixed latencies will be clamped to this
 230          * range. */
 231         pa_usec_t min_latency; /* we won't go below this latency */
 232         pa_usec_t max_latency; /* An upper limit for the latencies */
 233
 234         /* 'Fixed' simply means that the latency is exclusively
 235          * decided on by the sink, and the clients have no influence
 236          * in changing it */
 237         pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
 238
 239         /* Delayed volume change events are queued here. The events
 240          * are stored in expiration order. The one expiring next is in
 241          * the head of the list. */
 242         PA_LLIST_HEAD(pa_sink_volume_change, volume_changes);
 243         pa_sink_volume_change *volume_changes_tail;
 244         /* This value is updated in pa_sink_volume_change_apply() and
 245          * used only by sinks with PA_SINK_SYNC_VOLUME. */
 246         pa_cvolume current_hw_volume;
 247
 248         /* The amount of usec volume up events are delayed and volume
 249          * down events are made earlier. */
 250         uint32_t volume_change_safety_margin;
 251         /* Usec delay added to all volume change events, may be negative. */
 252         int32_t volume_change_extra_delay;
 253     } thread_info;
 254
 255     void *userdata;
 256 };
 257
 258 PA_DECLARE_PUBLIC_CLASS(pa_sink);
 259 #define PA_SINK(s) (pa_sink_cast(s))
 260
 261 typedef enum pa_sink_message {
 262     PA_SINK_MESSAGE_ADD_INPUT,
 263     PA_SINK_MESSAGE_REMOVE_INPUT,
 264     PA_SINK_MESSAGE_GET_VOLUME,
 265     PA_SINK_MESSAGE_SET_VOLUME_SYNCED,
 266     PA_SINK_MESSAGE_SET_VOLUME,
 267     PA_SINK_MESSAGE_SYNC_VOLUMES,
 268     PA_SINK_MESSAGE_GET_MUTE,
 269     PA_SINK_MESSAGE_SET_MUTE,
 270     PA_SINK_MESSAGE_GET_LATENCY,
 271     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 272     PA_SINK_MESSAGE_SET_STATE,
 273     PA_SINK_MESSAGE_START_MOVE,
 274     PA_SINK_MESSAGE_FINISH_MOVE,
 275     PA_SINK_MESSAGE_ATTACH,
 276     PA_SINK_MESSAGE_DETACH,
 277     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 278     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 279     PA_SINK_MESSAGE_SET_FIXED_LATENCY,
 280     PA_SINK_MESSAGE_GET_FIXED_LATENCY,
 281     PA_SINK_MESSAGE_GET_MAX_REWIND,
 282     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 283     PA_SINK_MESSAGE_SET_MAX_REWIND,
 284     PA_SINK_MESSAGE_SET_MAX_REQUEST,
 285     PA_SINK_MESSAGE_SET_PORT,
 286     PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE,
 287     PA_SINK_MESSAGE_MAX
 288 } pa_sink_message_t;
 289
 290 typedef struct pa_sink_new_data {
 291     char *name;
 292     pa_proplist *proplist;
 293
 294     const char *driver;
 295     pa_module *module;
 296     pa_card *card;
 297
 298     pa_hashmap *ports;
 299     char *active_port;
 300
 301     pa_sample_spec sample_spec;
 302     pa_channel_map channel_map;
 303     pa_cvolume volume;
 304     pa_bool_t muted :1;
 305
 306     pa_bool_t sample_spec_is_set:1;
 307     pa_bool_t channel_map_is_set:1;
 308     pa_bool_t volume_is_set:1;
 309     pa_bool_t muted_is_set:1;
 310
 311     pa_bool_t namereg_fail:1;
 312
 313     pa_bool_t save_port:1;
 314     pa_bool_t save_volume:1;
 315     pa_bool_t save_muted:1;
 316 } pa_sink_new_data;
 317
 318 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 319 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 320 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 321 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 322 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 323 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 324 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
 325 void pa_sink_new_data_done(pa_sink_new_data *data);
 326
 327 /*** To be called exclusively by the sink driver, from main context */
 328
 329 pa_sink* pa_sink_new(
 330         pa_core *core,
 331         pa_sink_new_data *data,
 332         pa_sink_flags_t flags);
 333
 334 void pa_sink_put(pa_sink *s);
 335 void pa_sink_unlink(pa_sink* s);
 336
 337 void pa_sink_set_description(pa_sink *s, const char *description);
 338 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 339 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 340
 341 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 342 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
 343 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 344 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
 345
 346 void pa_sink_detach(pa_sink *s);
 347 void pa_sink_attach(pa_sink *s);
 348
 349 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
 350 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
 351 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted);
 352
 353 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value);
 354
 355 pa_bool_t pa_device_init_description(pa_proplist *p);
 356 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
 357 pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
 358 unsigned pa_device_init_priority(pa_proplist *p);
 359
 360 /**** May be called by everyone, from main context */
 361
 362 /* The returned value is supposed to be in the time domain of the sound card! */
 363 pa_usec_t pa_sink_get_latency(pa_sink *s);
 364 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 365 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 366 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s);
 367
 368 size_t pa_sink_get_max_rewind(pa_sink *s);
 369 size_t pa_sink_get_max_request(pa_sink *s);
 370
 371 int pa_sink_update_status(pa_sink*s);
 372 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 373 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 374
 375 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, pa_bool_t sendmsg, pa_bool_t save);
 376 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh);
 377
 378 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
 379 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
 380
 381 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
 382
 383 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
 384
 385 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 386 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 387 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
 388 #define pa_sink_get_state(s) ((s)->state)
 389
 390 /* Moves all inputs away, and stores them in pa_queue */
 391 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
 392 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
 393 void pa_sink_move_all_fail(pa_queue *q);
 394
 395 /*** To be called exclusively by the sink driver, from IO context */
 396
 397 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 398 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 399 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 400 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 401
 402 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 403
 404 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 405
 406 void pa_sink_attach_within_thread(pa_sink *s);
 407 void pa_sink_detach_within_thread(pa_sink *s);
 408
 409 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 410
 411 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
 412 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
 413
 414 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 415 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
 416
 417 void pa_sink_update_volume_and_mute(pa_sink *s);
 418
 419 pa_bool_t pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next);
 420
 421 /*** To be called exclusively by sink input drivers, from IO context */
 422
 423 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 424
 425 void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic);
 426
 427 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
 428
 429 pa_device_port *pa_device_port_new(const char *name, const char *description, size_t extra);
 430 void pa_device_port_free(pa_device_port *p);
 431
 432 /* Verify that we called in IO context (aka 'thread context), or that
 433  * the sink is not yet set up, i.e. the thread not set up yet. See
 434  * pa_assert_io_context() in thread-mq.h for more information. */
 435 #define pa_sink_assert_io_context(s) \
 436     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
 437
 438 #endif