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