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