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