1 #ifndef foopulsesinkhfoo
2 #define foopulsesinkhfoo
5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
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.
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.
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
26 typedef struct pa_sink pa_sink;
27 typedef struct pa_sink_volume_change pa_sink_volume_change;
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>
37 #include <pulsecore/core.h>
38 #include <pulsecore/idxset.h>
39 #include <pulsecore/memchunk.h>
40 #include <pulsecore/source.h>
41 #include <pulsecore/module.h>
42 #include <pulsecore/asyncmsgq.h>
43 #include <pulsecore/msgobject.h>
44 #include <pulsecore/rtpoll.h>
45 #include <pulsecore/device-port.h>
46 #include <pulsecore/card.h>
47 #include <pulsecore/queue.h>
48 #include <pulsecore/thread-mq.h>
49 #include <pulsecore/sink-input.h>
51 #define PA_MAX_INPUTS_PER_SINK 32
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;
58 /* A generic definition for void callback functions */
59 typedef void(*pa_sink_cb_t)(pa_sink *s);
67 pa_sink_state_t state;
68 pa_sink_flags_t flags;
69 pa_suspend_cause_t suspend_cause;
72 char *driver; /* may be NULL */
73 pa_proplist *proplist;
75 pa_module *module; /* may be NULL */
76 pa_card *card; /* may be NULL */
78 pa_sample_spec sample_spec;
79 pa_channel_map channel_map;
80 uint32_t default_sample_rate;
81 uint32_t alternate_sample_rate;
85 pa_source *monitor_source;
86 pa_sink_input *input_to_master; /* non-NULL only for filter sinks */
88 pa_volume_t base_volume; /* shall be constant */
89 unsigned n_volume_steps; /* shall be constant */
91 /* Also see http://pulseaudio.org/wiki/InternalVolumes */
92 pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative sink input volumes */
93 pa_cvolume real_volume; /* The volume that the hardware is configured to */
94 pa_cvolume soft_volume; /* The internal software volume we apply to all PCM data while it passes through */
98 pa_bool_t refresh_volume:1;
99 pa_bool_t refresh_muted:1;
100 pa_bool_t save_port:1;
101 pa_bool_t save_volume:1;
102 pa_bool_t save_muted:1;
104 /* Saved volume state while we're in passthrough mode */
105 pa_cvolume saved_volume;
106 pa_bool_t saved_save_volume:1;
108 pa_asyncmsgq *asyncmsgq;
113 pa_device_port *active_port;
117 /* Called when the main loop requests a state change. Called from
118 * main loop context. If returns -1 the state change will be
120 int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
122 /* Sink drivers that support hardware volume may set this
123 * callback. This is called when the current volume needs to be
124 * re-read from the hardware.
126 * There are two ways for drivers to implement hardware volume
127 * query: either set this callback or handle
128 * PA_SINK_MESSAGE_GET_VOLUME. The callback implementation or the
129 * message handler must update s->real_volume and s->soft_volume
130 * (using pa_sink_set_soft_volume()) to match the current hardware
133 * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
134 * main thread before sending PA_SINK_MESSAGE_GET_VOLUME, so in
135 * this case the driver can choose whether to read the volume from
136 * the hardware in the main thread or in the IO thread.
138 * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
139 * thread within the default handler for
140 * PA_SINK_MESSAGE_GET_VOLUME (the main thread is waiting while
141 * the message is being processed), so there's no choice of where
142 * to do the volume reading - it has to be done in the IO thread
145 * You must use the function pa_sink_set_get_volume_callback() to
146 * set this callback. */
147 pa_sink_cb_t get_volume; /* may be NULL */
149 /* Sink drivers that support hardware volume must set this
150 * callback. This is called when the hardware volume needs to be
153 * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
154 * main thread. The callback implementation must set the hardware
155 * volume according to s->real_volume. If the driver can't set the
156 * hardware volume to the exact requested value, it has to update
157 * s->real_volume and/or s->soft_volume so that they together
158 * match the actual hardware volume that was set.
160 * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
161 * thread. The callback implementation must not actually set the
162 * hardware volume yet, but it must check how close to the
163 * requested volume the hardware volume can be set, and update
164 * s->real_volume and/or s->soft_volume so that they together
165 * match the actual hardware volume that will be set later in the
166 * write_volume callback.
168 * You must use the function pa_sink_set_set_volume_callback() to
169 * set this callback. */
170 pa_sink_cb_t set_volume; /* may be NULL */
172 /* Sink drivers that set PA_SINK_DEFERRED_VOLUME must provide this
173 * callback. This callback is not used with sinks that do not set
174 * PA_SINK_DEFERRED_VOLUME. This is called from the IO thread when a
175 * pending hardware volume change has to be written to the
176 * hardware. The requested volume is passed to the callback
177 * implementation in s->thread_info.current_hw_volume.
179 * The call is done inside pa_sink_volume_change_apply(), which is
180 * not called automatically - it is the driver's responsibility to
181 * schedule that function to be called at the right times in the
184 * You must use the function pa_sink_set_write_volume_callback() to
185 * set this callback. */
186 pa_sink_cb_t write_volume; /* may be NULL */
188 /* Called when the mute setting is queried. A PA_SINK_MESSAGE_GET_MUTE
189 * message will also be sent. Called from IO thread if PA_SINK_DEFERRED_VOLUME
190 * flag is set otherwise from main loop context. If refresh_mute is FALSE
191 * neither this function is called nor a message is sent.
193 * You must use the function pa_sink_set_get_mute_callback() to
194 * set this callback. */
195 pa_sink_cb_t get_mute; /* may be NULL */
197 /* Called when the mute setting shall be changed. A PA_SINK_MESSAGE_SET_MUTE
198 * message will also be sent. Called from IO thread if PA_SINK_DEFERRED_VOLUME
199 * flag is set otherwise from main loop context.
201 * You must use the function pa_sink_set_set_mute_callback() to
202 * set this callback. */
203 pa_sink_cb_t set_mute; /* may be NULL */
205 /* Called when a rewind request is issued. Called from IO thread
207 pa_sink_cb_t request_rewind; /* may be NULL */
209 /* Called when a the requested latency is changed. Called from IO
211 pa_sink_cb_t update_requested_latency; /* may be NULL */
213 /* Called whenever the port shall be changed. Called from main
215 int (*set_port)(pa_sink *s, pa_device_port *port); /* may be NULL */
217 /* Called to get the list of formats supported by the sink, sorted
218 * in descending order of preference. */
219 pa_idxset* (*get_formats)(pa_sink *s); /* may be NULL */
221 /* Called to set the list of formats supported by the sink. Can be
222 * NULL if the sink does not support this. Returns TRUE on success,
223 * FALSE otherwise (for example when an unsupportable format is
224 * set). Makes a copy of the formats passed in. */
225 pa_bool_t (*set_formats)(pa_sink *s, pa_idxset *formats); /* may be NULL */
227 /* Called whenever the sampling frequency shall be changed. Called from
229 pa_bool_t (*update_rate)(pa_sink *s, uint32_t rate);
231 /* Contains copies of the above data so that the real-time worker
232 * thread can work without access locking */
234 pa_sink_state_t state;
239 pa_cvolume soft_volume;
240 pa_bool_t soft_muted:1;
242 /* The requested latency is used for dynamic latency
243 * sinks. For fixed latency sinks it is always identical to
244 * the fixed_latency. See below. */
245 pa_bool_t requested_latency_valid:1;
246 pa_usec_t requested_latency;
248 /* The number of bytes streams need to keep around as history to
249 * be able to satisfy every DMA buffer rewrite */
252 /* The number of bytes streams need to keep around to satisfy
253 * every DMA write request */
256 /* Maximum of what clients requested to rewind in this cycle */
257 size_t rewind_nbytes;
258 pa_bool_t rewind_requested;
260 /* Both dynamic and fixed latencies will be clamped to this
262 pa_usec_t min_latency; /* we won't go below this latency */
263 pa_usec_t max_latency; /* An upper limit for the latencies */
265 /* 'Fixed' simply means that the latency is exclusively
266 * decided on by the sink, and the clients have no influence
268 pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
270 /* Delayed volume change events are queued here. The events
271 * are stored in expiration order. The one expiring next is in
272 * the head of the list. */
273 PA_LLIST_HEAD(pa_sink_volume_change, volume_changes);
274 pa_sink_volume_change *volume_changes_tail;
275 /* This value is updated in pa_sink_volume_change_apply() and
276 * used only by sinks with PA_SINK_DEFERRED_VOLUME. */
277 pa_cvolume current_hw_volume;
279 /* The amount of usec volume up events are delayed and volume
280 * down events are made earlier. */
281 uint32_t volume_change_safety_margin;
282 /* Usec delay added to all volume change events, may be negative. */
283 int32_t volume_change_extra_delay;
289 PA_DECLARE_PUBLIC_CLASS(pa_sink);
290 #define PA_SINK(s) (pa_sink_cast(s))
292 typedef enum pa_sink_message {
293 PA_SINK_MESSAGE_ADD_INPUT,
294 PA_SINK_MESSAGE_REMOVE_INPUT,
295 PA_SINK_MESSAGE_GET_VOLUME,
296 PA_SINK_MESSAGE_SET_SHARED_VOLUME,
297 PA_SINK_MESSAGE_SET_VOLUME_SYNCED,
298 PA_SINK_MESSAGE_SET_VOLUME,
299 PA_SINK_MESSAGE_SYNC_VOLUMES,
300 PA_SINK_MESSAGE_GET_MUTE,
301 PA_SINK_MESSAGE_SET_MUTE,
302 PA_SINK_MESSAGE_GET_LATENCY,
303 PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
304 PA_SINK_MESSAGE_SET_STATE,
305 PA_SINK_MESSAGE_START_MOVE,
306 PA_SINK_MESSAGE_FINISH_MOVE,
307 PA_SINK_MESSAGE_ATTACH,
308 PA_SINK_MESSAGE_DETACH,
309 PA_SINK_MESSAGE_SET_LATENCY_RANGE,
310 PA_SINK_MESSAGE_GET_LATENCY_RANGE,
311 PA_SINK_MESSAGE_SET_FIXED_LATENCY,
312 PA_SINK_MESSAGE_GET_FIXED_LATENCY,
313 PA_SINK_MESSAGE_GET_MAX_REWIND,
314 PA_SINK_MESSAGE_GET_MAX_REQUEST,
315 PA_SINK_MESSAGE_SET_MAX_REWIND,
316 PA_SINK_MESSAGE_SET_MAX_REQUEST,
317 PA_SINK_MESSAGE_SET_PORT,
318 PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE,
322 typedef struct pa_sink_new_data {
324 pa_proplist *proplist;
333 pa_sample_spec sample_spec;
334 pa_channel_map channel_map;
335 uint32_t alternate_sample_rate;
339 pa_bool_t sample_spec_is_set:1;
340 pa_bool_t channel_map_is_set:1;
341 pa_bool_t alternate_sample_rate_is_set:1;
342 pa_bool_t volume_is_set:1;
343 pa_bool_t muted_is_set:1;
345 pa_bool_t namereg_fail:1;
347 pa_bool_t save_port:1;
348 pa_bool_t save_volume:1;
349 pa_bool_t save_muted:1;
352 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
353 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
354 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
355 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
356 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data *data, const uint32_t alternate_sample_rate);
357 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
358 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
359 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
360 void pa_sink_new_data_done(pa_sink_new_data *data);
362 /*** To be called exclusively by the sink driver, from main context */
364 pa_sink* pa_sink_new(
366 pa_sink_new_data *data,
367 pa_sink_flags_t flags);
369 void pa_sink_set_get_volume_callback(pa_sink *s, pa_sink_cb_t cb);
370 void pa_sink_set_set_volume_callback(pa_sink *s, pa_sink_cb_t cb);
371 void pa_sink_set_write_volume_callback(pa_sink *s, pa_sink_cb_t cb);
372 void pa_sink_set_get_mute_callback(pa_sink *s, pa_sink_cb_t cb);
373 void pa_sink_set_set_mute_callback(pa_sink *s, pa_sink_cb_t cb);
374 void pa_sink_enable_decibel_volume(pa_sink *s, pa_bool_t enable);
376 void pa_sink_put(pa_sink *s);
377 void pa_sink_unlink(pa_sink* s);
379 void pa_sink_set_description(pa_sink *s, const char *description);
380 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
381 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
383 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
384 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
385 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
386 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
388 void pa_sink_detach(pa_sink *s);
389 void pa_sink_attach(pa_sink *s);
391 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
392 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
393 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted);
395 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value);
397 pa_bool_t pa_device_init_description(pa_proplist *p);
398 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
399 pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
400 unsigned pa_device_init_priority(pa_proplist *p);
402 /**** May be called by everyone, from main context */
404 pa_bool_t pa_sink_update_rate(pa_sink *s, uint32_t rate, pa_bool_t passthrough);
406 /* The returned value is supposed to be in the time domain of the sound card! */
407 pa_usec_t pa_sink_get_latency(pa_sink *s);
408 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
409 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
410 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s);
412 size_t pa_sink_get_max_rewind(pa_sink *s);
413 size_t pa_sink_get_max_request(pa_sink *s);
415 int pa_sink_update_status(pa_sink*s);
416 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
417 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
419 /* Use this instead of checking s->flags & PA_SINK_FLAT_VOLUME directly. */
420 pa_bool_t pa_sink_flat_volume_enabled(pa_sink *s);
422 /* Get the master sink when sharing volumes */
423 pa_sink *pa_sink_get_master(pa_sink *s);
425 /* Is the sink in passthrough mode? (that is, is there a passthrough sink input
426 * connected to this sink? */
427 pa_bool_t pa_sink_is_passthrough(pa_sink *s);
428 /* These should be called when a sink enters/leaves passthrough mode */
429 void pa_sink_enter_passthrough(pa_sink *s);
430 void pa_sink_leave_passthrough(pa_sink *s);
432 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, pa_bool_t sendmsg, pa_bool_t save);
433 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh);
435 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
436 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
438 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
440 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
442 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
443 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
444 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
445 #define pa_sink_get_state(s) ((s)->state)
447 /* Moves all inputs away, and stores them in pa_queue */
448 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
449 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
450 void pa_sink_move_all_fail(pa_queue *q);
452 pa_idxset* pa_sink_get_formats(pa_sink *s);
453 pa_bool_t pa_sink_set_formats(pa_sink *s, pa_idxset *formats);
454 pa_bool_t pa_sink_check_format(pa_sink *s, pa_format_info *f);
455 pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats);
457 /*** To be called exclusively by the sink driver, from IO context */
459 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
460 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
461 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
462 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
464 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
466 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
468 void pa_sink_attach_within_thread(pa_sink *s);
469 void pa_sink_detach_within_thread(pa_sink *s);
471 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
473 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
474 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
476 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
477 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
479 void pa_sink_update_volume_and_mute(pa_sink *s);
481 pa_bool_t pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next);
483 /*** To be called exclusively by sink input drivers, from IO context */
485 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
487 void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic);
489 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
491 /* Verify that we called in IO context (aka 'thread context), or that
492 * the sink is not yet set up, i.e. the thread not set up yet. See
493 * pa_assert_io_context() in thread-mq.h for more information. */
494 #define pa_sink_assert_io_context(s) \
495 pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))