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