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