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