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