volume ramp: add volume ramping to sink
[platform/upstream/pulseaudio.git] / 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, write to the Free Software
22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23   USA.
24 ***/
25
26 typedef struct pa_sink pa_sink;
27 typedef struct pa_sink_volume_change pa_sink_volume_change;
28
29 #include <inttypes.h>
30
31 #include <pulse/def.h>
32 #include <pulse/format.h>
33 #include <pulse/sample.h>
34 #include <pulse/channelmap.h>
35 #include <pulse/volume.h>
36
37 #include <pulsecore/core.h>
38 #include <pulsecore/idxset.h>
39 #include <pulsecore/memchunk.h>
40 #include <pulsecore/mix.h>
41 #include <pulsecore/source.h>
42 #include <pulsecore/module.h>
43 #include <pulsecore/asyncmsgq.h>
44 #include <pulsecore/msgobject.h>
45 #include <pulsecore/rtpoll.h>
46 #include <pulsecore/device-port.h>
47 #include <pulsecore/card.h>
48 #include <pulsecore/queue.h>
49 #include <pulsecore/thread-mq.h>
50 #include <pulsecore/sink-input.h>
51
52 #define PA_MAX_INPUTS_PER_SINK 256
53
54 /* Returns true if sink is linked: registered and accessible from client side. */
55 static inline bool PA_SINK_IS_LINKED(pa_sink_state_t x) {
56     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
57 }
58
59 /* A generic definition for void callback functions */
60 typedef void(*pa_sink_cb_t)(pa_sink *s);
61
62 struct pa_sink {
63     pa_msgobject parent;
64
65     uint32_t index;
66     pa_core *core;
67
68     pa_sink_state_t state;
69     pa_sink_flags_t flags;
70     pa_suspend_cause_t suspend_cause;
71
72     char *name;
73     char *driver;                           /* may be NULL */
74     pa_proplist *proplist;
75
76     pa_module *module;                      /* may be NULL */
77     pa_card *card;                          /* may be NULL */
78
79     pa_sample_spec sample_spec;
80     pa_channel_map channel_map;
81     uint32_t default_sample_rate;
82     uint32_t alternate_sample_rate;
83
84     pa_idxset *inputs;
85     unsigned n_corked;
86     pa_source *monitor_source;
87     pa_sink_input *input_to_master;         /* non-NULL only for filter sinks */
88
89     pa_volume_t base_volume; /* shall be constant */
90     unsigned n_volume_steps; /* shall be constant */
91
92     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
93     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative sink input volumes */
94     pa_cvolume real_volume;      /* The volume that the hardware is configured to  */
95     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
96
97     bool muted:1;
98
99     bool refresh_volume:1;
100     bool refresh_muted:1;
101     bool save_port:1;
102     bool save_volume:1;
103     bool save_muted:1;
104
105     /* Saved volume state while we're in passthrough mode */
106     pa_cvolume saved_volume;
107     bool saved_save_volume:1;
108
109     /* for volume ramps */
110     pa_cvolume_ramp_int ramp;
111
112     pa_asyncmsgq *asyncmsgq;
113
114     pa_memchunk silence;
115
116     pa_hashmap *ports;
117     pa_device_port *active_port;
118     pa_atomic_t mixer_dirty;
119
120     /* The latency offset is inherited from the currently active port */
121     int64_t latency_offset;
122
123     unsigned priority;
124
125     /* Called when the main loop requests a state change. Called from
126      * main loop context. If returns -1 the state change will be
127      * inhibited */
128     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
129
130     /* Sink drivers that support hardware volume may set this
131      * callback. This is called when the current volume needs to be
132      * re-read from the hardware.
133      *
134      * There are two ways for drivers to implement hardware volume
135      * query: either set this callback or handle
136      * PA_SINK_MESSAGE_GET_VOLUME. The callback implementation or the
137      * message handler must update s->real_volume and s->soft_volume
138      * (using pa_sink_set_soft_volume()) to match the current hardware
139      * volume.
140      *
141      * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
142      * main thread before sending PA_SINK_MESSAGE_GET_VOLUME, so in
143      * this case the driver can choose whether to read the volume from
144      * the hardware in the main thread or in the IO thread.
145      *
146      * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
147      * thread within the default handler for
148      * PA_SINK_MESSAGE_GET_VOLUME (the main thread is waiting while
149      * the message is being processed), so there's no choice of where
150      * to do the volume reading - it has to be done in the IO thread
151      * always.
152      *
153      * You must use the function pa_sink_set_get_volume_callback() to
154      * set this callback. */
155     pa_sink_cb_t get_volume; /* may be NULL */
156
157     /* Sink drivers that support hardware volume must set this
158      * callback. This is called when the hardware volume needs to be
159      * updated.
160      *
161      * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
162      * main thread. The callback implementation must set the hardware
163      * volume according to s->real_volume. If the driver can't set the
164      * hardware volume to the exact requested value, it has to update
165      * s->real_volume and/or s->soft_volume so that they together
166      * match the actual hardware volume that was set.
167      *
168      * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
169      * thread. The callback implementation must not actually set the
170      * hardware volume yet, but it must check how close to the
171      * requested volume the hardware volume can be set, and update
172      * s->real_volume and/or s->soft_volume so that they together
173      * match the actual hardware volume that will be set later in the
174      * write_volume callback.
175      *
176      * You must use the function pa_sink_set_set_volume_callback() to
177      * set this callback. */
178     pa_sink_cb_t set_volume; /* may be NULL */
179
180     /* Sink drivers that set PA_SINK_DEFERRED_VOLUME must provide this
181      * callback. This callback is not used with sinks that do not set
182      * PA_SINK_DEFERRED_VOLUME. This is called from the IO thread when a
183      * pending hardware volume change has to be written to the
184      * hardware. The requested volume is passed to the callback
185      * implementation in s->thread_info.current_hw_volume.
186      *
187      * The call is done inside pa_sink_volume_change_apply(), which is
188      * not called automatically - it is the driver's responsibility to
189      * schedule that function to be called at the right times in the
190      * IO thread.
191      *
192      * You must use the function pa_sink_set_write_volume_callback() to
193      * set this callback. */
194     pa_sink_cb_t write_volume; /* may be NULL */
195
196     /* Called when the mute setting is queried. A PA_SINK_MESSAGE_GET_MUTE
197      * message will also be sent. Called from IO thread if PA_SINK_DEFERRED_VOLUME
198      * flag is set otherwise from main loop context. If refresh_mute is false
199      * neither this function is called nor a message is sent.
200      *
201      * You must use the function pa_sink_set_get_mute_callback() to
202      * set this callback. */
203     pa_sink_cb_t get_mute; /* may be NULL */
204
205     /* Called when the mute setting shall be changed. A PA_SINK_MESSAGE_SET_MUTE
206      * message will also be sent. Called from IO thread if PA_SINK_DEFERRED_VOLUME
207      * flag is set otherwise from main loop context.
208      *
209      * You must use the function pa_sink_set_set_mute_callback() to
210      * set this callback. */
211     pa_sink_cb_t set_mute; /* may be NULL */
212
213     /* Called when a rewind request is issued. Called from IO thread
214      * context. */
215     pa_sink_cb_t request_rewind; /* may be NULL */
216
217     /* Called when a the requested latency is changed. Called from IO
218      * thread context. */
219     pa_sink_cb_t update_requested_latency; /* may be NULL */
220
221     /* Called whenever the port shall be changed. Called from IO
222      * thread if deferred volumes are enabled, and main thread otherwise. */
223     int (*set_port)(pa_sink *s, pa_device_port *port); /* may be NULL */
224
225     /* Called to get the list of formats supported by the sink, sorted
226      * in descending order of preference. */
227     pa_idxset* (*get_formats)(pa_sink *s); /* may be NULL */
228
229     /* Called to set the list of formats supported by the sink. Can be
230      * NULL if the sink does not support this. Returns true on success,
231      * false otherwise (for example when an unsupportable format is
232      * set). Makes a copy of the formats passed in. */
233     bool (*set_formats)(pa_sink *s, pa_idxset *formats); /* may be NULL */
234
235     /* Called whenever the sampling frequency shall be changed. Called from
236      * main thread. */
237     int (*update_rate)(pa_sink *s, uint32_t rate);
238
239     /* Contains copies of the above data so that the real-time worker
240      * thread can work without access locking */
241     struct {
242         pa_sink_state_t state;
243         pa_hashmap *inputs;
244
245         pa_rtpoll *rtpoll;
246
247         pa_cvolume soft_volume;
248         bool soft_muted:1;
249
250         /* The requested latency is used for dynamic latency
251          * sinks. For fixed latency sinks it is always identical to
252          * the fixed_latency. See below. */
253         bool requested_latency_valid:1;
254         pa_usec_t requested_latency;
255
256         /* The number of bytes streams need to keep around as history to
257          * be able to satisfy every DMA buffer rewrite */
258         size_t max_rewind;
259
260         /* The number of bytes streams need to keep around to satisfy
261          * every DMA write request */
262         size_t max_request;
263
264         /* Maximum of what clients requested to rewind in this cycle */
265         size_t rewind_nbytes;
266         bool rewind_requested;
267
268         /* Both dynamic and fixed latencies will be clamped to this
269          * range. */
270         pa_usec_t min_latency; /* we won't go below this latency */
271         pa_usec_t max_latency; /* An upper limit for the latencies */
272
273         /* 'Fixed' simply means that the latency is exclusively
274          * decided on by the sink, and the clients have no influence
275          * in changing it */
276         pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
277
278         /* This latency offset is a direct copy from s->latency_offset */
279         int64_t latency_offset;
280
281         /* Delayed volume change events are queued here. The events
282          * are stored in expiration order. The one expiring next is in
283          * the head of the list. */
284         PA_LLIST_HEAD(pa_sink_volume_change, volume_changes);
285         pa_sink_volume_change *volume_changes_tail;
286         /* This value is updated in pa_sink_volume_change_apply() and
287          * used only by sinks with PA_SINK_DEFERRED_VOLUME. */
288         pa_cvolume current_hw_volume;
289
290         /* The amount of usec volume up events are delayed and volume
291          * down events are made earlier. */
292         uint32_t volume_change_safety_margin;
293         /* Usec delay added to all volume change events, may be negative. */
294         int32_t volume_change_extra_delay;
295
296         pa_cvolume_ramp_int ramp;
297     } thread_info;
298
299     void *userdata;
300 };
301
302 PA_DECLARE_PUBLIC_CLASS(pa_sink);
303 #define PA_SINK(s) (pa_sink_cast(s))
304
305 typedef enum pa_sink_message {
306     PA_SINK_MESSAGE_ADD_INPUT,
307     PA_SINK_MESSAGE_REMOVE_INPUT,
308     PA_SINK_MESSAGE_GET_VOLUME,
309     PA_SINK_MESSAGE_SET_SHARED_VOLUME,
310     PA_SINK_MESSAGE_SET_VOLUME_SYNCED,
311     PA_SINK_MESSAGE_SET_VOLUME,
312     PA_SINK_MESSAGE_SYNC_VOLUMES,
313     PA_SINK_MESSAGE_GET_MUTE,
314     PA_SINK_MESSAGE_SET_MUTE,
315     PA_SINK_MESSAGE_GET_LATENCY,
316     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
317     PA_SINK_MESSAGE_SET_STATE,
318     PA_SINK_MESSAGE_START_MOVE,
319     PA_SINK_MESSAGE_FINISH_MOVE,
320     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
321     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
322     PA_SINK_MESSAGE_SET_FIXED_LATENCY,
323     PA_SINK_MESSAGE_GET_FIXED_LATENCY,
324     PA_SINK_MESSAGE_GET_MAX_REWIND,
325     PA_SINK_MESSAGE_GET_MAX_REQUEST,
326     PA_SINK_MESSAGE_SET_MAX_REWIND,
327     PA_SINK_MESSAGE_SET_MAX_REQUEST,
328     PA_SINK_MESSAGE_SET_PORT,
329     PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE,
330     PA_SINK_MESSAGE_SET_LATENCY_OFFSET,
331     PA_SINK_MESSAGE_SET_VOLUME_RAMP,
332     PA_SINK_MESSAGE_MAX
333 } pa_sink_message_t;
334
335 typedef struct pa_sink_new_data {
336     pa_suspend_cause_t suspend_cause;
337
338     char *name;
339     pa_proplist *proplist;
340
341     const char *driver;
342     pa_module *module;
343     pa_card *card;
344
345     pa_hashmap *ports;
346     char *active_port;
347
348     pa_sample_spec sample_spec;
349     pa_channel_map channel_map;
350     uint32_t alternate_sample_rate;
351     pa_cvolume volume;
352     bool muted :1;
353
354     bool sample_spec_is_set:1;
355     bool channel_map_is_set:1;
356     bool alternate_sample_rate_is_set:1;
357     bool volume_is_set:1;
358     bool muted_is_set:1;
359
360     bool namereg_fail:1;
361
362     bool save_port:1;
363     bool save_volume:1;
364     bool save_muted:1;
365 } pa_sink_new_data;
366
367 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
368 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
369 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
370 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
371 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data *data, const uint32_t alternate_sample_rate);
372 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
373 void pa_sink_new_data_set_muted(pa_sink_new_data *data, bool mute);
374 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
375 void pa_sink_new_data_done(pa_sink_new_data *data);
376
377 /*** To be called exclusively by the sink driver, from main context */
378
379 pa_sink* pa_sink_new(
380         pa_core *core,
381         pa_sink_new_data *data,
382         pa_sink_flags_t flags);
383
384 void pa_sink_set_get_volume_callback(pa_sink *s, pa_sink_cb_t cb);
385 void pa_sink_set_set_volume_callback(pa_sink *s, pa_sink_cb_t cb);
386 void pa_sink_set_write_volume_callback(pa_sink *s, pa_sink_cb_t cb);
387 void pa_sink_set_get_mute_callback(pa_sink *s, pa_sink_cb_t cb);
388 void pa_sink_set_set_mute_callback(pa_sink *s, pa_sink_cb_t cb);
389 void pa_sink_enable_decibel_volume(pa_sink *s, bool enable);
390
391 void pa_sink_put(pa_sink *s);
392 void pa_sink_unlink(pa_sink* s);
393
394 void pa_sink_set_description(pa_sink *s, const char *description);
395 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
396 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
397
398 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
399 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
400 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
401 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
402
403 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
404 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
405 void pa_sink_mute_changed(pa_sink *s, bool new_muted);
406
407 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value);
408
409 bool pa_device_init_description(pa_proplist *p);
410 bool pa_device_init_icon(pa_proplist *p, bool is_sink);
411 bool pa_device_init_intended_roles(pa_proplist *p);
412 unsigned pa_device_init_priority(pa_proplist *p);
413
414 /**** May be called by everyone, from main context */
415
416 int pa_sink_update_rate(pa_sink *s, uint32_t rate, bool passthrough);
417 void pa_sink_set_latency_offset(pa_sink *s, int64_t offset);
418
419 /* The returned value is supposed to be in the time domain of the sound card! */
420 pa_usec_t pa_sink_get_latency(pa_sink *s);
421 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
422 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
423 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s);
424
425 size_t pa_sink_get_max_rewind(pa_sink *s);
426 size_t pa_sink_get_max_request(pa_sink *s);
427
428 int pa_sink_update_status(pa_sink*s);
429 int pa_sink_suspend(pa_sink *s, bool suspend, pa_suspend_cause_t cause);
430 int pa_sink_suspend_all(pa_core *c, bool suspend, pa_suspend_cause_t cause);
431
432 /* Use this instead of checking s->flags & PA_SINK_FLAT_VOLUME directly. */
433 bool pa_sink_flat_volume_enabled(pa_sink *s);
434
435 /* Get the master sink when sharing volumes */
436 pa_sink *pa_sink_get_master(pa_sink *s);
437
438 /* Is the sink in passthrough mode? (that is, is there a passthrough sink input
439  * connected to this sink? */
440 bool pa_sink_is_passthrough(pa_sink *s);
441 /* These should be called when a sink enters/leaves passthrough mode */
442 void pa_sink_enter_passthrough(pa_sink *s);
443 void pa_sink_leave_passthrough(pa_sink *s);
444
445 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, bool sendmsg, bool save);
446 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, bool force_refresh);
447
448 void pa_sink_set_mute(pa_sink *sink, bool mute, bool save);
449 bool pa_sink_get_mute(pa_sink *sink, bool force_refresh);
450
451 bool pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
452
453 void pa_sink_set_volume_ramp(pa_sink *s, const pa_cvolume_ramp *ramp, bool send_msg, bool save);
454
455 int pa_sink_set_port(pa_sink *s, const char *name, bool save);
456 void pa_sink_set_mixer_dirty(pa_sink *s, bool is_dirty);
457
458 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
459 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
460 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
461 #define pa_sink_get_state(s) ((s)->state)
462
463 /* Moves all inputs away, and stores them in pa_queue */
464 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
465 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, bool save);
466 void pa_sink_move_all_fail(pa_queue *q);
467
468 /* Returns a copy of the sink formats. TODO: Get rid of this function (or at
469  * least get rid of the copying). There's no good reason to copy the formats
470  * every time someone wants to know what formats the sink supports. The formats
471  * idxset could be stored directly in the pa_sink struct.
472  * https://bugs.freedesktop.org/show_bug.cgi?id=71924 */
473 pa_idxset* pa_sink_get_formats(pa_sink *s);
474
475 bool pa_sink_set_formats(pa_sink *s, pa_idxset *formats);
476 bool pa_sink_check_format(pa_sink *s, pa_format_info *f);
477 pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats);
478
479 /*** To be called exclusively by the sink driver, from IO context */
480
481 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
482 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
483 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
484 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
485
486 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
487
488 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
489
490 void pa_sink_attach_within_thread(pa_sink *s);
491 void pa_sink_detach_within_thread(pa_sink *s);
492
493 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
494
495 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
496 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
497
498 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
499 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
500
501 void pa_sink_update_volume_and_mute(pa_sink *s);
502
503 bool pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next);
504
505 size_t pa_sink_process_input_underruns(pa_sink *s, size_t left_to_play);
506
507 /*** To be called exclusively by sink input drivers, from IO context */
508
509 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
510
511 void pa_sink_invalidate_requested_latency(pa_sink *s, bool dynamic);
512
513 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
514
515 /* Verify that we called in IO context (aka 'thread context), or that
516  * the sink is not yet set up, i.e. the thread not set up yet. See
517  * pa_assert_io_context() in thread-mq.h for more information. */
518 #define pa_sink_assert_io_context(s) \
519     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
520
521 #endif