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 #ifdef __TIZEN__
  50 typedef enum pa_sink_avc_mode {
  51     PA_SINK_AVC_OFF,
  52     PA_SINK_AVC_SILENT,
  53     PA_SINK_AVC_NORM,
  54 } pa_sink_avc_mode_t;
  55 #endif
  56
  57 /* Returns true if sink is linked: registered and accessible from client side. */
  58 static inline bool PA_SINK_IS_LINKED(pa_sink_state_t x) {
  59     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  60 }
  61
  62 /* A generic definition for void callback functions */
  63 typedef void(*pa_sink_cb_t)(pa_sink *s);
  64
  65 typedef int (*pa_sink_get_mute_cb_t)(pa_sink *s, bool *mute);
  66
  67 struct pa_sink {
  68     pa_msgobject parent;
  69
  70     uint32_t index;
  71     pa_core *core;
  72
  73     pa_sink_state_t state;
  74
  75     /* Set in the beginning of pa_sink_unlink() before setting the sink state
  76      * to UNLINKED. The purpose is to prevent moving streams to a sink that is
  77      * about to be removed. */
  78     bool unlink_requested;
  79
  80     pa_sink_flags_t flags;
  81     pa_suspend_cause_t suspend_cause;
  82
  83     char *name;
  84     char *driver;                           /* may be NULL */
  85     pa_proplist *proplist;
  86
  87     pa_module *module;                      /* may be NULL */
  88     pa_card *card;                          /* may be NULL */
  89
  90     pa_sample_spec sample_spec;
  91     pa_channel_map channel_map;
  92     uint32_t default_sample_rate;
  93     uint32_t alternate_sample_rate;
  94     bool avoid_resampling:1;
  95 #ifdef __TIZEN__
  96     uint32_t *supported_sample_rates;
  97     uint32_t selected_sample_rate;
  98     pa_sample_format_t *supported_sample_formats;
  99     pa_sample_format_t selected_sample_format;
 100     bool origin_avoid_resampling;
 101 #endif
 102
 103     pa_idxset *inputs;
 104     unsigned n_corked;
 105     pa_source *monitor_source;
 106     pa_sink_input *input_to_master;         /* non-NULL only for filter sinks */
 107
 108     pa_volume_t base_volume; /* shall be constant */
 109     unsigned n_volume_steps; /* shall be constant */
 110
 111     /* Also see http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/Developer/Volumes/ */
 112     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative sink input volumes */
 113     pa_cvolume real_volume;      /* The volume that the hardware is configured to  */
 114     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
 115
 116     bool muted:1;
 117
 118     bool refresh_volume:1;
 119     bool refresh_muted:1;
 120     bool save_port:1;
 121     bool save_volume:1;
 122     bool save_muted:1;
 123
 124     /* Saved volume state while we're in passthrough mode */
 125     pa_cvolume saved_volume;
 126     bool saved_save_volume:1;
 127
 128     pa_asyncmsgq *asyncmsgq;
 129
 130     pa_memchunk silence;
 131
 132     pa_hashmap *ports;
 133     pa_device_port *active_port;
 134     pa_atomic_t mixer_dirty;
 135
 136     /* The latency offset is inherited from the currently active port */
 137     int64_t port_latency_offset;
 138
 139     unsigned priority;
 140
 141     bool set_mute_in_progress;
 142
 143     /* Called when the main loop requests a state change. Called from
 144      * main loop context. If returns -1 the state change will be
 145      * inhibited */
 146     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
 147
 148     /* Sink drivers that support hardware volume may set this
 149      * callback. This is called when the current volume needs to be
 150      * re-read from the hardware.
 151      *
 152      * There are two ways for drivers to implement hardware volume
 153      * query: either set this callback or handle
 154      * PA_SINK_MESSAGE_GET_VOLUME. The callback implementation or the
 155      * message handler must update s->real_volume and s->soft_volume
 156      * (using pa_sink_set_soft_volume()) to match the current hardware
 157      * volume.
 158      *
 159      * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
 160      * main thread before sending PA_SINK_MESSAGE_GET_VOLUME, so in
 161      * this case the driver can choose whether to read the volume from
 162      * the hardware in the main thread or in the IO thread.
 163      *
 164      * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
 165      * thread within the default handler for
 166      * PA_SINK_MESSAGE_GET_VOLUME (the main thread is waiting while
 167      * the message is being processed), so there's no choice of where
 168      * to do the volume reading - it has to be done in the IO thread
 169      * always.
 170      *
 171      * You must use the function pa_sink_set_get_volume_callback() to
 172      * set this callback. */
 173     pa_sink_cb_t get_volume; /* may be NULL */
 174
 175     /* Sink drivers that support hardware volume must set this
 176      * callback. This is called when the hardware volume needs to be
 177      * updated.
 178      *
 179      * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
 180      * main thread. The callback implementation must set the hardware
 181      * volume according to s->real_volume. If the driver can't set the
 182      * hardware volume to the exact requested value, it has to update
 183      * s->real_volume and/or s->soft_volume so that they together
 184      * match the actual hardware volume that was set.
 185      *
 186      * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
 187      * thread. The callback implementation must not actually set the
 188      * hardware volume yet, but it must check how close to the
 189      * requested volume the hardware volume can be set, and update
 190      * s->real_volume and/or s->soft_volume so that they together
 191      * match the actual hardware volume that will be set later in the
 192      * write_volume callback.
 193      *
 194      * You must use the function pa_sink_set_set_volume_callback() to
 195      * set this callback. */
 196     pa_sink_cb_t set_volume; /* may be NULL */
 197
 198     /* Sink drivers that set PA_SINK_DEFERRED_VOLUME must provide this
 199      * callback. This callback is not used with sinks that do not set
 200      * PA_SINK_DEFERRED_VOLUME. This is called from the IO thread when a
 201      * pending hardware volume change has to be written to the
 202      * hardware. The requested volume is passed to the callback
 203      * implementation in s->thread_info.current_hw_volume.
 204      *
 205      * The call is done inside pa_sink_volume_change_apply(), which is
 206      * not called automatically - it is the driver's responsibility to
 207      * schedule that function to be called at the right times in the
 208      * IO thread.
 209      *
 210      * You must use the function pa_sink_set_write_volume_callback() to
 211      * set this callback. */
 212     pa_sink_cb_t write_volume; /* may be NULL */
 213
 214     /* If the sink mute can change "spontaneously" (i.e. initiated by the sink
 215      * implementation, not by someone else calling pa_sink_set_mute()), then
 216      * the sink implementation can notify about changed mute either by calling
 217      * pa_sink_mute_changed() or by calling pa_sink_get_mute() with
 218      * force_refresh=true. If the implementation chooses the latter approach,
 219      * it should implement the get_mute callback. Otherwise get_mute can be
 220      * NULL.
 221      *
 222      * This is called when pa_sink_get_mute() is called with
 223      * force_refresh=true. This is called from the IO thread if the
 224      * PA_SINK_DEFERRED_VOLUME flag is set, otherwise this is called from the
 225      * main thread. On success, the implementation is expected to return 0 and
 226      * set the mute parameter that is passed as a reference. On failure, the
 227      * implementation is expected to return -1.
 228      *
 229      * You must use the function pa_sink_set_get_mute_callback() to
 230      * set this callback. */
 231     pa_sink_get_mute_cb_t get_mute;
 232
 233     /* Called when the mute setting shall be changed. A PA_SINK_MESSAGE_SET_MUTE
 234      * message will also be sent. Called from IO thread if PA_SINK_DEFERRED_VOLUME
 235      * flag is set otherwise from main loop context.
 236      *
 237      * You must use the function pa_sink_set_set_mute_callback() to
 238      * set this callback. */
 239     pa_sink_cb_t set_mute; /* may be NULL */
 240
 241     /* Called when a rewind request is issued. Called from IO thread
 242      * context. */
 243     pa_sink_cb_t request_rewind; /* may be NULL */
 244
 245     /* Called when a the requested latency is changed. Called from IO
 246      * thread context. */
 247     pa_sink_cb_t update_requested_latency; /* may be NULL */
 248
 249     /* Called whenever the port shall be changed. Called from IO
 250      * thread if deferred volumes are enabled, and main thread otherwise. */
 251     int (*set_port)(pa_sink *s, pa_device_port *port); /* may be NULL */
 252
 253     /* Called to get the list of formats supported by the sink, sorted
 254      * in descending order of preference. */
 255     pa_idxset* (*get_formats)(pa_sink *s); /* may be NULL */
 256
 257     /* Called to set the list of formats supported by the sink. Can be
 258      * NULL if the sink does not support this. Returns true on success,
 259      * false otherwise (for example when an unsupportable format is
 260      * set). Makes a copy of the formats passed in. */
 261     bool (*set_formats)(pa_sink *s, pa_idxset *formats); /* may be NULL */
 262
 263     /* Called whenever device parameters need to be changed. Called from
 264      * main thread. */
 265     void (*reconfigure)(pa_sink *s, pa_sample_spec *spec, bool passthrough);
 266
 267     /* Contains copies of the above data so that the real-time worker
 268      * thread can work without access locking */
 269     struct {
 270         pa_sink_state_t state;
 271         pa_hashmap *inputs;
 272
 273         pa_rtpoll *rtpoll;
 274
 275         pa_cvolume soft_volume;
 276         bool soft_muted:1;
 277
 278         /* The requested latency is used for dynamic latency
 279          * sinks. For fixed latency sinks it is always identical to
 280          * the fixed_latency. See below. */
 281         bool requested_latency_valid:1;
 282         pa_usec_t requested_latency;
 283
 284         /* The number of bytes streams need to keep around as history to
 285          * be able to satisfy every DMA buffer rewrite */
 286         size_t max_rewind;
 287
 288         /* The number of bytes streams need to keep around to satisfy
 289          * every DMA write request */
 290         size_t max_request;
 291
 292         /* Maximum of what clients requested to rewind in this cycle */
 293         size_t rewind_nbytes;
 294         bool rewind_requested;
 295
 296         /* Both dynamic and fixed latencies will be clamped to this
 297          * range. */
 298         pa_usec_t min_latency; /* we won't go below this latency */
 299         pa_usec_t max_latency; /* An upper limit for the latencies */
 300
 301         /* 'Fixed' simply means that the latency is exclusively
 302          * decided on by the sink, and the clients have no influence
 303          * in changing it */
 304         pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
 305
 306         /* This latency offset is a direct copy from s->port_latency_offset */
 307         int64_t port_latency_offset;
 308
 309         /* Delayed volume change events are queued here. The events
 310          * are stored in expiration order. The one expiring next is in
 311          * the head of the list. */
 312         PA_LLIST_HEAD(pa_sink_volume_change, volume_changes);
 313         pa_sink_volume_change *volume_changes_tail;
 314         /* This value is updated in pa_sink_volume_change_apply() and
 315          * used only by sinks with PA_SINK_DEFERRED_VOLUME. */
 316         pa_cvolume current_hw_volume;
 317
 318         /* The amount of usec volume up events are delayed and volume
 319          * down events are made earlier. */
 320         uint32_t volume_change_safety_margin;
 321         /* Usec delay added to all volume change events, may be negative. */
 322         int32_t volume_change_extra_delay;
 323     } thread_info;
 324
 325 #ifdef __TIZEN__
 326     FILE *pcm_dump_fp;
 327     char *dump_path;
 328     void *device_item;
 329     bool use_internal_codec;
 330     pa_sink_avc_mode_t avc_mode;
 331 #endif
 332     void *userdata;
 333 };
 334
 335 PA_DECLARE_PUBLIC_CLASS(pa_sink);
 336 #define PA_SINK(s) (pa_sink_cast(s))
 337
 338 typedef enum pa_sink_message {
 339     PA_SINK_MESSAGE_ADD_INPUT,
 340     PA_SINK_MESSAGE_REMOVE_INPUT,
 341     PA_SINK_MESSAGE_GET_VOLUME,
 342     PA_SINK_MESSAGE_SET_SHARED_VOLUME,
 343     PA_SINK_MESSAGE_SET_VOLUME_SYNCED,
 344     PA_SINK_MESSAGE_SET_VOLUME,
 345     PA_SINK_MESSAGE_SYNC_VOLUMES,
 346     PA_SINK_MESSAGE_GET_MUTE,
 347     PA_SINK_MESSAGE_SET_MUTE,
 348     PA_SINK_MESSAGE_GET_LATENCY,
 349     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 350     PA_SINK_MESSAGE_SET_STATE,
 351     PA_SINK_MESSAGE_START_MOVE,
 352     PA_SINK_MESSAGE_FINISH_MOVE,
 353     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 354     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 355     PA_SINK_MESSAGE_SET_FIXED_LATENCY,
 356     PA_SINK_MESSAGE_GET_FIXED_LATENCY,
 357     PA_SINK_MESSAGE_GET_MAX_REWIND,
 358     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 359     PA_SINK_MESSAGE_SET_MAX_REWIND,
 360     PA_SINK_MESSAGE_SET_MAX_REQUEST,
 361     PA_SINK_MESSAGE_SET_PORT,
 362     PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE,
 363     PA_SINK_MESSAGE_SET_PORT_LATENCY_OFFSET,
 364     PA_SINK_MESSAGE_MAX
 365 } pa_sink_message_t;
 366
 367 typedef struct pa_sink_new_data {
 368     pa_suspend_cause_t suspend_cause;
 369
 370     char *name;
 371     pa_proplist *proplist;
 372
 373     const char *driver;
 374     pa_module *module;
 375     pa_card *card;
 376
 377     pa_hashmap *ports;
 378     char *active_port;
 379
 380     pa_sample_spec sample_spec;
 381     pa_channel_map channel_map;
 382     uint32_t alternate_sample_rate;
 383     bool avoid_resampling:1;
 384     pa_cvolume volume;
 385     bool muted:1;
 386
 387     bool sample_spec_is_set:1;
 388     bool channel_map_is_set:1;
 389     bool alternate_sample_rate_is_set:1;
 390     bool volume_is_set:1;
 391     bool muted_is_set:1;
 392
 393     bool namereg_fail:1;
 394
 395     bool save_port:1;
 396     bool save_volume:1;
 397     bool save_muted:1;
 398 } pa_sink_new_data;
 399
 400 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 401 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 402 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 403 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 404 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data *data, const uint32_t alternate_sample_rate);
 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 void pa_sink_set_mixer_dirty(pa_sink *s, bool is_dirty);
 490
 491 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 492 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 493
 494 /* Returns how many streams are active that don't allow suspensions. If
 495  * "ignore_input" or "ignore_output" is non-NULL, that stream is not included
 496  * in the count (the returned count includes the value from
 497  * pa_source_check_suspend(), which is called for the monitor source, so that's
 498  * why "ignore_output" may be relevant). */
 499 unsigned pa_sink_check_suspend(pa_sink *s, pa_sink_input *ignore_input, pa_source_output *ignore_output);
 500
 501 #define pa_sink_get_state(s) ((s)->state)
 502
 503 const char *pa_sink_state_to_string(pa_sink_state_t state);
 504
 505 /* Moves all inputs away, and stores them in pa_queue */
 506 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
 507 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, bool save);
 508 void pa_sink_move_all_fail(pa_queue *q);
 509
 510 /* Returns a copy of the sink formats. TODO: Get rid of this function (or at
 511  * least get rid of the copying). There's no good reason to copy the formats
 512  * every time someone wants to know what formats the sink supports. The formats
 513  * idxset could be stored directly in the pa_sink struct.
 514  * https://bugs.freedesktop.org/show_bug.cgi?id=71924 */
 515 pa_idxset* pa_sink_get_formats(pa_sink *s);
 516
 517 bool pa_sink_set_formats(pa_sink *s, pa_idxset *formats);
 518 bool pa_sink_check_format(pa_sink *s, pa_format_info *f);
 519 pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats);
 520
 521 void pa_sink_set_sample_format(pa_sink *s, pa_sample_format_t format);
 522 void pa_sink_set_sample_rate(pa_sink *s, uint32_t rate);
 523
 524 /*** To be called exclusively by the sink driver, from IO context */
 525
 526 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 527 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 528 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 529 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 530
 531 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 532
 533 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 534
 535 void pa_sink_attach_within_thread(pa_sink *s);
 536 void pa_sink_detach_within_thread(pa_sink *s);
 537
 538 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 539
 540 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
 541 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
 542
 543 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 544 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
 545
 546 void pa_sink_update_volume_and_mute(pa_sink *s);
 547
 548 bool pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next);
 549
 550 size_t pa_sink_process_input_underruns(pa_sink *s, size_t left_to_play);
 551
 552 /*** To be called exclusively by sink input drivers, from IO context */
 553
 554 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 555
 556 void pa_sink_invalidate_requested_latency(pa_sink *s, bool dynamic);
 557
 558 int64_t pa_sink_get_latency_within_thread(pa_sink *s, bool allow_negative);
 559
 560 /* Called from the main thread, from sink-input.c only. The normal way to set
 561  * the sink reference volume is to call pa_sink_set_volume(), but the flat
 562  * volume logic in sink-input.c needs also a function that doesn't do all the
 563  * extra stuff that pa_sink_set_volume() does. This function simply sets
 564  * s->reference_volume and fires change notifications. */
 565 void pa_sink_set_reference_volume_direct(pa_sink *s, const pa_cvolume *volume);
 566
 567
 568 #ifdef __TIZEN__
 569 void pa_sink_set_avc_mode(pa_sink *s, pa_sink_avc_mode_t mode);
 570 pa_sink_avc_mode_t pa_sink_get_avc_mode(pa_sink *s);
 571 #endif
 572
 573 /* Verify that we called in IO context (aka 'thread context), or that
 574  * the sink is not yet set up, i.e. the thread not set up yet. See
 575  * pa_assert_io_context() in thread-mq.h for more information. */
 576 #define pa_sink_assert_io_context(s) \
 577     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
 578
 579 #endif