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