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