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