2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
31 #include <pulse/introspect.h>
32 #include <pulse/format.h>
33 #include <pulse/utf8.h>
34 #include <pulse/xmalloc.h>
35 #include <pulse/timeval.h>
36 #include <pulse/util.h>
37 #include <pulse/rtclock.h>
38 #include <pulse/internal.h>
40 #include <pulsecore/i18n.h>
41 #include <pulsecore/sink-input.h>
42 #include <pulsecore/namereg.h>
43 #include <pulsecore/core-util.h>
44 #include <pulsecore/sample-util.h>
45 #include <pulsecore/core-subscribe.h>
46 #include <pulsecore/log.h>
47 #include <pulsecore/macro.h>
48 #include <pulsecore/play-memblockq.h>
49 #include <pulsecore/flist.h>
53 #define MAX_MIX_CHANNELS 32
54 #define MIX_BUFFER_LENGTH (PA_PAGE_SIZE)
55 #define ABSOLUTE_MIN_LATENCY (500)
56 #define ABSOLUTE_MAX_LATENCY (10*PA_USEC_PER_SEC)
57 #define DEFAULT_FIXED_LATENCY (250*PA_USEC_PER_MSEC)
59 PA_DEFINE_PUBLIC_CLASS(pa_sink, pa_msgobject);
61 struct pa_sink_volume_change {
65 PA_LLIST_FIELDS(pa_sink_volume_change);
68 struct sink_message_set_port {
73 static void sink_free(pa_object *s);
75 static void pa_sink_volume_change_push(pa_sink *s);
76 static void pa_sink_volume_change_flush(pa_sink *s);
77 static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes);
79 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data) {
83 data->proplist = pa_proplist_new();
88 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name) {
92 data->name = pa_xstrdup(name);
95 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec) {
98 if ((data->sample_spec_is_set = !!spec))
99 data->sample_spec = *spec;
102 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map) {
105 if ((data->channel_map_is_set = !!map))
106 data->channel_map = *map;
109 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data *data, const uint32_t alternate_sample_rate) {
112 data->alternate_sample_rate_is_set = TRUE;
113 data->alternate_sample_rate = alternate_sample_rate;
116 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume) {
119 if ((data->volume_is_set = !!volume))
120 data->volume = *volume;
123 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute) {
126 data->muted_is_set = TRUE;
127 data->muted = !!mute;
130 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port) {
133 pa_xfree(data->active_port);
134 data->active_port = pa_xstrdup(port);
137 void pa_sink_new_data_done(pa_sink_new_data *data) {
140 pa_proplist_free(data->proplist);
143 pa_device_port_hashmap_free(data->ports);
145 pa_xfree(data->name);
146 pa_xfree(data->active_port);
150 /* Called from main context */
151 static void reset_callbacks(pa_sink *s) {
155 s->get_volume = NULL;
156 s->set_volume = NULL;
157 s->write_volume = NULL;
160 s->request_rewind = NULL;
161 s->update_requested_latency = NULL;
163 s->get_formats = NULL;
164 s->set_formats = NULL;
165 s->update_rate = NULL;
168 /* Called from main context */
169 pa_sink* pa_sink_new(
171 pa_sink_new_data *data,
172 pa_sink_flags_t flags) {
176 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
177 pa_source_new_data source_data;
183 pa_assert(data->name);
184 pa_assert_ctl_context();
186 s = pa_msgobject_new(pa_sink);
188 if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SINK, s, data->namereg_fail))) {
189 pa_log_debug("Failed to register name %s.", data->name);
194 pa_sink_new_data_set_name(data, name);
196 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_NEW], data) < 0) {
198 pa_namereg_unregister(core, name);
202 /* FIXME, need to free s here on failure */
204 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
205 pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
207 pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
209 if (!data->channel_map_is_set)
210 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
212 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
213 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
215 /* FIXME: There should probably be a general function for checking whether
216 * the sink volume is allowed to be set, like there is for sink inputs. */
217 pa_assert(!data->volume_is_set || !(flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
219 if (!data->volume_is_set) {
220 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
221 data->save_volume = FALSE;
224 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
225 pa_return_null_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec));
227 if (!data->muted_is_set)
231 pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->card->proplist);
233 pa_device_init_description(data->proplist);
234 pa_device_init_icon(data->proplist, TRUE);
235 pa_device_init_intended_roles(data->proplist);
237 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_FIXATE], data) < 0) {
239 pa_namereg_unregister(core, name);
243 s->parent.parent.free = sink_free;
244 s->parent.process_msg = pa_sink_process_msg;
247 s->state = PA_SINK_INIT;
250 s->suspend_cause = 0;
251 s->name = pa_xstrdup(name);
252 s->proplist = pa_proplist_copy(data->proplist);
253 s->driver = pa_xstrdup(pa_path_get_filename(data->driver));
254 s->module = data->module;
255 s->card = data->card;
257 s->priority = pa_device_init_priority(s->proplist);
259 s->sample_spec = data->sample_spec;
260 s->channel_map = data->channel_map;
261 s->default_sample_rate = s->sample_spec.rate;
263 if (data->alternate_sample_rate_is_set)
264 s->alternate_sample_rate = data->alternate_sample_rate;
266 s->alternate_sample_rate = s->core->alternate_sample_rate;
268 if (s->sample_spec.rate == s->alternate_sample_rate) {
269 pa_log_warn("Default and alternate sample rates are the same.");
270 s->alternate_sample_rate = 0;
273 s->inputs = pa_idxset_new(NULL, NULL);
275 s->input_to_master = NULL;
277 s->reference_volume = s->real_volume = data->volume;
278 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
279 s->base_volume = PA_VOLUME_NORM;
280 s->n_volume_steps = PA_VOLUME_NORM+1;
281 s->muted = data->muted;
282 s->refresh_volume = s->refresh_muted = FALSE;
289 /* As a minor optimization we just steal the list instead of
291 s->ports = data->ports;
294 s->active_port = NULL;
295 s->save_port = FALSE;
297 if (data->active_port && s->ports)
298 if ((s->active_port = pa_hashmap_get(s->ports, data->active_port)))
299 s->save_port = data->save_port;
301 if (!s->active_port && s->ports) {
305 PA_HASHMAP_FOREACH(p, s->ports, state)
306 if (!s->active_port || p->priority > s->active_port->priority)
310 s->save_volume = data->save_volume;
311 s->save_muted = data->save_muted;
313 pa_silence_memchunk_get(
314 &core->silence_cache,
320 s->thread_info.rtpoll = NULL;
321 s->thread_info.inputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
322 s->thread_info.soft_volume = s->soft_volume;
323 s->thread_info.soft_muted = s->muted;
324 s->thread_info.state = s->state;
325 s->thread_info.rewind_nbytes = 0;
326 s->thread_info.rewind_requested = FALSE;
327 s->thread_info.max_rewind = 0;
328 s->thread_info.max_request = 0;
329 s->thread_info.requested_latency_valid = FALSE;
330 s->thread_info.requested_latency = 0;
331 s->thread_info.min_latency = ABSOLUTE_MIN_LATENCY;
332 s->thread_info.max_latency = ABSOLUTE_MAX_LATENCY;
333 s->thread_info.fixed_latency = flags & PA_SINK_DYNAMIC_LATENCY ? 0 : DEFAULT_FIXED_LATENCY;
335 PA_LLIST_HEAD_INIT(pa_sink_volume_change, s->thread_info.volume_changes);
336 s->thread_info.volume_changes_tail = NULL;
337 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
338 s->thread_info.volume_change_safety_margin = core->deferred_volume_safety_margin_usec;
339 s->thread_info.volume_change_extra_delay = core->deferred_volume_extra_delay_usec;
341 /* FIXME: This should probably be moved to pa_sink_put() */
342 pa_assert_se(pa_idxset_put(core->sinks, s, &s->index) >= 0);
345 pa_assert_se(pa_idxset_put(s->card->sinks, s, NULL) >= 0);
347 pt = pa_proplist_to_string_sep(s->proplist, "\n ");
348 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n %s",
351 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
352 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map),
356 pa_source_new_data_init(&source_data);
357 pa_source_new_data_set_sample_spec(&source_data, &s->sample_spec);
358 pa_source_new_data_set_channel_map(&source_data, &s->channel_map);
359 pa_source_new_data_set_alternate_sample_rate(&source_data, s->alternate_sample_rate);
360 source_data.name = pa_sprintf_malloc("%s.monitor", name);
361 source_data.driver = data->driver;
362 source_data.module = data->module;
363 source_data.card = data->card;
365 dn = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
366 pa_proplist_setf(source_data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Monitor of %s", dn ? dn : s->name);
367 pa_proplist_sets(source_data.proplist, PA_PROP_DEVICE_CLASS, "monitor");
369 s->monitor_source = pa_source_new(core, &source_data,
370 ((flags & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
371 ((flags & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0));
373 pa_source_new_data_done(&source_data);
375 if (!s->monitor_source) {
381 s->monitor_source->monitor_of = s;
383 pa_source_set_latency_range(s->monitor_source, s->thread_info.min_latency, s->thread_info.max_latency);
384 pa_source_set_fixed_latency(s->monitor_source, s->thread_info.fixed_latency);
385 pa_source_set_max_rewind(s->monitor_source, s->thread_info.max_rewind);
390 /* Called from main context */
391 static int sink_set_state(pa_sink *s, pa_sink_state_t state) {
393 pa_bool_t suspend_change;
394 pa_sink_state_t original_state;
397 pa_assert_ctl_context();
399 if (s->state == state)
402 original_state = s->state;
405 (original_state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(state)) ||
406 (PA_SINK_IS_OPENED(original_state) && state == PA_SINK_SUSPENDED);
409 if ((ret = s->set_state(s, state)) < 0)
413 if ((ret = pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL)) < 0) {
416 s->set_state(s, original_state);
423 if (state != PA_SINK_UNLINKED) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
424 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], s);
425 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
428 if (suspend_change) {
432 /* We're suspending or resuming, tell everyone about it */
434 PA_IDXSET_FOREACH(i, s->inputs, idx)
435 if (s->state == PA_SINK_SUSPENDED &&
436 (i->flags & PA_SINK_INPUT_KILL_ON_SUSPEND))
437 pa_sink_input_kill(i);
439 i->suspend(i, state == PA_SINK_SUSPENDED);
441 if (s->monitor_source)
442 pa_source_sync_suspend(s->monitor_source);
448 void pa_sink_set_get_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
454 void pa_sink_set_set_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
455 pa_sink_flags_t flags;
458 pa_assert(!s->write_volume || cb);
462 /* Save the current flags so we can tell if they've changed */
466 /* The sink implementor is responsible for setting decibel volume support */
467 s->flags |= PA_SINK_HW_VOLUME_CTRL;
469 s->flags &= ~PA_SINK_HW_VOLUME_CTRL;
470 /* See note below in pa_sink_put() about volume sharing and decibel volumes */
471 pa_sink_enable_decibel_volume(s, !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
474 /* If the flags have changed after init, let any clients know via a change event */
475 if (s->state != PA_SINK_INIT && flags != s->flags)
476 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
479 void pa_sink_set_write_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
480 pa_sink_flags_t flags;
483 pa_assert(!cb || s->set_volume);
485 s->write_volume = cb;
487 /* Save the current flags so we can tell if they've changed */
491 s->flags |= PA_SINK_DEFERRED_VOLUME;
493 s->flags &= ~PA_SINK_DEFERRED_VOLUME;
495 /* If the flags have changed after init, let any clients know via a change event */
496 if (s->state != PA_SINK_INIT && flags != s->flags)
497 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
500 void pa_sink_set_get_mute_callback(pa_sink *s, pa_sink_cb_t cb) {
506 void pa_sink_set_set_mute_callback(pa_sink *s, pa_sink_cb_t cb) {
507 pa_sink_flags_t flags;
513 /* Save the current flags so we can tell if they've changed */
517 s->flags |= PA_SINK_HW_MUTE_CTRL;
519 s->flags &= ~PA_SINK_HW_MUTE_CTRL;
521 /* If the flags have changed after init, let any clients know via a change event */
522 if (s->state != PA_SINK_INIT && flags != s->flags)
523 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
526 static void enable_flat_volume(pa_sink *s, pa_bool_t enable) {
527 pa_sink_flags_t flags;
531 /* Always follow the overall user preference here */
532 enable = enable && s->core->flat_volumes;
534 /* Save the current flags so we can tell if they've changed */
538 s->flags |= PA_SINK_FLAT_VOLUME;
540 s->flags &= ~PA_SINK_FLAT_VOLUME;
542 /* If the flags have changed after init, let any clients know via a change event */
543 if (s->state != PA_SINK_INIT && flags != s->flags)
544 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
547 void pa_sink_enable_decibel_volume(pa_sink *s, pa_bool_t enable) {
548 pa_sink_flags_t flags;
552 /* Save the current flags so we can tell if they've changed */
556 s->flags |= PA_SINK_DECIBEL_VOLUME;
557 enable_flat_volume(s, TRUE);
559 s->flags &= ~PA_SINK_DECIBEL_VOLUME;
560 enable_flat_volume(s, FALSE);
563 /* If the flags have changed after init, let any clients know via a change event */
564 if (s->state != PA_SINK_INIT && flags != s->flags)
565 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
568 /* Called from main context */
569 void pa_sink_put(pa_sink* s) {
570 pa_sink_assert_ref(s);
571 pa_assert_ctl_context();
573 pa_assert(s->state == PA_SINK_INIT);
574 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || s->input_to_master);
576 /* The following fields must be initialized properly when calling _put() */
577 pa_assert(s->asyncmsgq);
578 pa_assert(s->thread_info.min_latency <= s->thread_info.max_latency);
580 /* Generally, flags should be initialized via pa_sink_new(). As a
581 * special exception we allow some volume related flags to be set
582 * between _new() and _put() by the callback setter functions above.
584 * Thus we implement a couple safeguards here which ensure the above
585 * setters were used (or at least the implementor made manual changes
586 * in a compatible way).
588 * Note: All of these flags set here can change over the life time
590 pa_assert(!(s->flags & PA_SINK_HW_VOLUME_CTRL) || s->set_volume);
591 pa_assert(!(s->flags & PA_SINK_DEFERRED_VOLUME) || s->write_volume);
592 pa_assert(!(s->flags & PA_SINK_HW_MUTE_CTRL) || s->set_mute);
594 /* XXX: Currently decibel volume is disabled for all sinks that use volume
595 * sharing. When the master sink supports decibel volume, it would be good
596 * to have the flag also in the filter sink, but currently we don't do that
597 * so that the flags of the filter sink never change when it's moved from
598 * a master sink to another. One solution for this problem would be to
599 * remove user-visible volume altogether from filter sinks when volume
600 * sharing is used, but the current approach was easier to implement... */
601 /* We always support decibel volumes in software, otherwise we leave it to
602 * the sink implementor to set this flag as needed.
604 * Note: This flag can also change over the life time of the sink. */
605 if (!(s->flags & PA_SINK_HW_VOLUME_CTRL) && !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
606 pa_sink_enable_decibel_volume(s, TRUE);
608 /* If the sink implementor support DB volumes by itself, we should always
609 * try and enable flat volumes too */
610 if ((s->flags & PA_SINK_DECIBEL_VOLUME))
611 enable_flat_volume(s, TRUE);
613 if (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) {
614 pa_sink *root_sink = pa_sink_get_master(s);
616 pa_assert(root_sink);
618 s->reference_volume = root_sink->reference_volume;
619 pa_cvolume_remap(&s->reference_volume, &root_sink->channel_map, &s->channel_map);
621 s->real_volume = root_sink->real_volume;
622 pa_cvolume_remap(&s->real_volume, &root_sink->channel_map, &s->channel_map);
624 /* We assume that if the sink implementor changed the default
625 * volume he did so in real_volume, because that is the usual
626 * place where he is supposed to place his changes. */
627 s->reference_volume = s->real_volume;
629 s->thread_info.soft_volume = s->soft_volume;
630 s->thread_info.soft_muted = s->muted;
631 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
633 pa_assert((s->flags & PA_SINK_HW_VOLUME_CTRL)
634 || (s->base_volume == PA_VOLUME_NORM
635 && ((s->flags & PA_SINK_DECIBEL_VOLUME || (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)))));
636 pa_assert(!(s->flags & PA_SINK_DECIBEL_VOLUME) || s->n_volume_steps == PA_VOLUME_NORM+1);
637 pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == (s->thread_info.fixed_latency != 0));
638 pa_assert(!(s->flags & PA_SINK_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_LATENCY));
639 pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_DYNAMIC_LATENCY));
641 pa_assert(s->monitor_source->thread_info.fixed_latency == s->thread_info.fixed_latency);
642 pa_assert(s->monitor_source->thread_info.min_latency == s->thread_info.min_latency);
643 pa_assert(s->monitor_source->thread_info.max_latency == s->thread_info.max_latency);
645 pa_assert_se(sink_set_state(s, PA_SINK_IDLE) == 0);
647 pa_source_put(s->monitor_source);
649 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_NEW, s->index);
650 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PUT], s);
653 /* Called from main context */
654 void pa_sink_unlink(pa_sink* s) {
656 pa_sink_input *i, *j = NULL;
659 pa_assert_ctl_context();
661 /* Please note that pa_sink_unlink() does more than simply
662 * reversing pa_sink_put(). It also undoes the registrations
663 * already done in pa_sink_new()! */
665 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
666 * may be called multiple times on the same sink without bad
669 linked = PA_SINK_IS_LINKED(s->state);
672 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK], s);
674 if (s->state != PA_SINK_UNLINKED)
675 pa_namereg_unregister(s->core, s->name);
676 pa_idxset_remove_by_data(s->core->sinks, s, NULL);
679 pa_idxset_remove_by_data(s->card->sinks, s, NULL);
681 while ((i = pa_idxset_first(s->inputs, NULL))) {
683 pa_sink_input_kill(i);
688 sink_set_state(s, PA_SINK_UNLINKED);
690 s->state = PA_SINK_UNLINKED;
694 if (s->monitor_source)
695 pa_source_unlink(s->monitor_source);
698 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
699 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK_POST], s);
703 /* Called from main context */
704 static void sink_free(pa_object *o) {
705 pa_sink *s = PA_SINK(o);
709 pa_assert_ctl_context();
710 pa_assert(pa_sink_refcnt(s) == 0);
712 if (PA_SINK_IS_LINKED(s->state))
715 pa_log_info("Freeing sink %u \"%s\"", s->index, s->name);
717 if (s->monitor_source) {
718 pa_source_unref(s->monitor_source);
719 s->monitor_source = NULL;
722 pa_idxset_free(s->inputs, NULL, NULL);
724 while ((i = pa_hashmap_steal_first(s->thread_info.inputs)))
725 pa_sink_input_unref(i);
727 pa_hashmap_free(s->thread_info.inputs, NULL, NULL);
729 if (s->silence.memblock)
730 pa_memblock_unref(s->silence.memblock);
736 pa_proplist_free(s->proplist);
739 pa_device_port_hashmap_free(s->ports);
744 /* Called from main context, and not while the IO thread is active, please */
745 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q) {
746 pa_sink_assert_ref(s);
747 pa_assert_ctl_context();
751 if (s->monitor_source)
752 pa_source_set_asyncmsgq(s->monitor_source, q);
755 /* Called from main context, and not while the IO thread is active, please */
756 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value) {
757 pa_sink_assert_ref(s);
758 pa_assert_ctl_context();
763 /* For now, allow only a minimal set of flags to be changed. */
764 pa_assert((mask & ~(PA_SINK_DYNAMIC_LATENCY|PA_SINK_LATENCY)) == 0);
766 s->flags = (s->flags & ~mask) | (value & mask);
768 pa_source_update_flags(s->monitor_source,
769 ((mask & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
770 ((mask & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0),
771 ((value & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
772 ((value & PA_SINK_DYNAMIC_LATENCY) ? PA_SINK_DYNAMIC_LATENCY : 0));
775 /* Called from IO context, or before _put() from main context */
776 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p) {
777 pa_sink_assert_ref(s);
778 pa_sink_assert_io_context(s);
780 s->thread_info.rtpoll = p;
782 if (s->monitor_source)
783 pa_source_set_rtpoll(s->monitor_source, p);
786 /* Called from main context */
787 int pa_sink_update_status(pa_sink*s) {
788 pa_sink_assert_ref(s);
789 pa_assert_ctl_context();
790 pa_assert(PA_SINK_IS_LINKED(s->state));
792 if (s->state == PA_SINK_SUSPENDED)
795 return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
798 /* Called from main context */
799 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause) {
800 pa_sink_assert_ref(s);
801 pa_assert_ctl_context();
802 pa_assert(PA_SINK_IS_LINKED(s->state));
803 pa_assert(cause != 0);
806 s->suspend_cause |= cause;
807 s->monitor_source->suspend_cause |= cause;
809 s->suspend_cause &= ~cause;
810 s->monitor_source->suspend_cause &= ~cause;
813 if ((pa_sink_get_state(s) == PA_SINK_SUSPENDED) == !!s->suspend_cause)
816 pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s->name, s->suspend_cause, s->suspend_cause ? "suspending" : "resuming");
818 if (s->suspend_cause)
819 return sink_set_state(s, PA_SINK_SUSPENDED);
821 return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
824 /* Called from main context */
825 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q) {
826 pa_sink_input *i, *n;
829 pa_sink_assert_ref(s);
830 pa_assert_ctl_context();
831 pa_assert(PA_SINK_IS_LINKED(s->state));
836 for (i = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx)); i; i = n) {
837 n = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx));
839 pa_sink_input_ref(i);
841 if (pa_sink_input_start_move(i) >= 0)
844 pa_sink_input_unref(i);
850 /* Called from main context */
851 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save) {
854 pa_sink_assert_ref(s);
855 pa_assert_ctl_context();
856 pa_assert(PA_SINK_IS_LINKED(s->state));
859 while ((i = PA_SINK_INPUT(pa_queue_pop(q)))) {
860 if (pa_sink_input_finish_move(i, s, save) < 0)
861 pa_sink_input_fail_move(i);
863 pa_sink_input_unref(i);
866 pa_queue_free(q, NULL);
869 /* Called from main context */
870 void pa_sink_move_all_fail(pa_queue *q) {
873 pa_assert_ctl_context();
876 while ((i = PA_SINK_INPUT(pa_queue_pop(q)))) {
877 pa_sink_input_fail_move(i);
878 pa_sink_input_unref(i);
881 pa_queue_free(q, NULL);
884 /* Called from IO thread context */
885 void pa_sink_process_rewind(pa_sink *s, size_t nbytes) {
889 pa_sink_assert_ref(s);
890 pa_sink_assert_io_context(s);
891 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
893 /* If nobody requested this and this is actually no real rewind
894 * then we can short cut this. Please note that this means that
895 * not all rewind requests triggered upstream will always be
896 * translated in actual requests! */
897 if (!s->thread_info.rewind_requested && nbytes <= 0)
900 s->thread_info.rewind_nbytes = 0;
901 s->thread_info.rewind_requested = FALSE;
903 if (s->thread_info.state == PA_SINK_SUSPENDED)
907 pa_log_debug("Processing rewind...");
908 if (s->flags & PA_SINK_DEFERRED_VOLUME)
909 pa_sink_volume_change_rewind(s, nbytes);
912 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
913 pa_sink_input_assert_ref(i);
914 pa_sink_input_process_rewind(i, nbytes);
918 if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state))
919 pa_source_process_rewind(s->monitor_source, nbytes);
923 /* Called from IO thread context */
924 static unsigned fill_mix_info(pa_sink *s, size_t *length, pa_mix_info *info, unsigned maxinfo) {
928 size_t mixlength = *length;
930 pa_sink_assert_ref(s);
931 pa_sink_assert_io_context(s);
934 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)) && maxinfo > 0) {
935 pa_sink_input_assert_ref(i);
937 pa_sink_input_peek(i, *length, &info->chunk, &info->volume);
939 if (mixlength == 0 || info->chunk.length < mixlength)
940 mixlength = info->chunk.length;
942 if (pa_memblock_is_silence(info->chunk.memblock)) {
943 pa_memblock_unref(info->chunk.memblock);
947 info->userdata = pa_sink_input_ref(i);
949 pa_assert(info->chunk.memblock);
950 pa_assert(info->chunk.length > 0);
963 /* Called from IO thread context */
964 static void inputs_drop(pa_sink *s, pa_mix_info *info, unsigned n, pa_memchunk *result) {
968 unsigned n_unreffed = 0;
970 pa_sink_assert_ref(s);
971 pa_sink_assert_io_context(s);
973 pa_assert(result->memblock);
974 pa_assert(result->length > 0);
976 /* We optimize for the case where the order of the inputs has not changed */
978 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
980 pa_mix_info* m = NULL;
982 pa_sink_input_assert_ref(i);
984 /* Let's try to find the matching entry info the pa_mix_info array */
985 for (j = 0; j < n; j ++) {
987 if (info[p].userdata == i) {
998 pa_sink_input_drop(i, result->length);
1000 if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state)) {
1002 if (pa_hashmap_size(i->thread_info.direct_outputs) > 0) {
1003 void *ostate = NULL;
1004 pa_source_output *o;
1007 if (m && m->chunk.memblock) {
1009 pa_memblock_ref(c.memblock);
1010 pa_assert(result->length <= c.length);
1011 c.length = result->length;
1013 pa_memchunk_make_writable(&c, 0);
1014 pa_volume_memchunk(&c, &s->sample_spec, &m->volume);
1017 pa_memblock_ref(c.memblock);
1018 pa_assert(result->length <= c.length);
1019 c.length = result->length;
1022 while ((o = pa_hashmap_iterate(i->thread_info.direct_outputs, &ostate, NULL))) {
1023 pa_source_output_assert_ref(o);
1024 pa_assert(o->direct_on_input == i);
1025 pa_source_post_direct(s->monitor_source, o, &c);
1028 pa_memblock_unref(c.memblock);
1033 if (m->chunk.memblock)
1034 pa_memblock_unref(m->chunk.memblock);
1035 pa_memchunk_reset(&m->chunk);
1037 pa_sink_input_unref(m->userdata);
1044 /* Now drop references to entries that are included in the
1045 * pa_mix_info array but don't exist anymore */
1047 if (n_unreffed < n) {
1048 for (; n > 0; info++, n--) {
1050 pa_sink_input_unref(info->userdata);
1051 if (info->chunk.memblock)
1052 pa_memblock_unref(info->chunk.memblock);
1056 if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state))
1057 pa_source_post(s->monitor_source, result);
1060 /* Called from IO thread context */
1061 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result) {
1062 pa_mix_info info[MAX_MIX_CHANNELS];
1064 size_t block_size_max;
1066 pa_sink_assert_ref(s);
1067 pa_sink_assert_io_context(s);
1068 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1069 pa_assert(pa_frame_aligned(length, &s->sample_spec));
1072 pa_assert(!s->thread_info.rewind_requested);
1073 pa_assert(s->thread_info.rewind_nbytes == 0);
1075 if (s->thread_info.state == PA_SINK_SUSPENDED) {
1076 result->memblock = pa_memblock_ref(s->silence.memblock);
1077 result->index = s->silence.index;
1078 result->length = PA_MIN(s->silence.length, length);
1085 length = pa_frame_align(MIX_BUFFER_LENGTH, &s->sample_spec);
1087 block_size_max = pa_mempool_block_size_max(s->core->mempool);
1088 if (length > block_size_max)
1089 length = pa_frame_align(block_size_max, &s->sample_spec);
1091 pa_assert(length > 0);
1093 n = fill_mix_info(s, &length, info, MAX_MIX_CHANNELS);
1097 *result = s->silence;
1098 pa_memblock_ref(result->memblock);
1100 if (result->length > length)
1101 result->length = length;
1103 } else if (n == 1) {
1106 *result = info[0].chunk;
1107 pa_memblock_ref(result->memblock);
1109 if (result->length > length)
1110 result->length = length;
1112 pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
1114 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume)) {
1115 pa_memblock_unref(result->memblock);
1116 pa_silence_memchunk_get(&s->core->silence_cache,
1121 } else if (!pa_cvolume_is_norm(&volume)) {
1122 pa_memchunk_make_writable(result, 0);
1123 pa_volume_memchunk(result, &s->sample_spec, &volume);
1127 result->memblock = pa_memblock_new(s->core->mempool, length);
1129 ptr = pa_memblock_acquire(result->memblock);
1130 result->length = pa_mix(info, n,
1133 &s->thread_info.soft_volume,
1134 s->thread_info.soft_muted);
1135 pa_memblock_release(result->memblock);
1140 inputs_drop(s, info, n, result);
1145 /* Called from IO thread context */
1146 void pa_sink_render_into(pa_sink*s, pa_memchunk *target) {
1147 pa_mix_info info[MAX_MIX_CHANNELS];
1149 size_t length, block_size_max;
1151 pa_sink_assert_ref(s);
1152 pa_sink_assert_io_context(s);
1153 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1155 pa_assert(target->memblock);
1156 pa_assert(target->length > 0);
1157 pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
1159 pa_assert(!s->thread_info.rewind_requested);
1160 pa_assert(s->thread_info.rewind_nbytes == 0);
1162 if (s->thread_info.state == PA_SINK_SUSPENDED) {
1163 pa_silence_memchunk(target, &s->sample_spec);
1169 length = target->length;
1170 block_size_max = pa_mempool_block_size_max(s->core->mempool);
1171 if (length > block_size_max)
1172 length = pa_frame_align(block_size_max, &s->sample_spec);
1174 pa_assert(length > 0);
1176 n = fill_mix_info(s, &length, info, MAX_MIX_CHANNELS);
1179 if (target->length > length)
1180 target->length = length;
1182 pa_silence_memchunk(target, &s->sample_spec);
1183 } else if (n == 1) {
1186 if (target->length > length)
1187 target->length = length;
1189 pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
1191 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume))
1192 pa_silence_memchunk(target, &s->sample_spec);
1196 vchunk = info[0].chunk;
1197 pa_memblock_ref(vchunk.memblock);
1199 if (vchunk.length > length)
1200 vchunk.length = length;
1202 if (!pa_cvolume_is_norm(&volume)) {
1203 pa_memchunk_make_writable(&vchunk, 0);
1204 pa_volume_memchunk(&vchunk, &s->sample_spec, &volume);
1207 pa_memchunk_memcpy(target, &vchunk);
1208 pa_memblock_unref(vchunk.memblock);
1214 ptr = pa_memblock_acquire(target->memblock);
1216 target->length = pa_mix(info, n,
1217 (uint8_t*) ptr + target->index, length,
1219 &s->thread_info.soft_volume,
1220 s->thread_info.soft_muted);
1222 pa_memblock_release(target->memblock);
1225 inputs_drop(s, info, n, target);
1230 /* Called from IO thread context */
1231 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target) {
1235 pa_sink_assert_ref(s);
1236 pa_sink_assert_io_context(s);
1237 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1239 pa_assert(target->memblock);
1240 pa_assert(target->length > 0);
1241 pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
1243 pa_assert(!s->thread_info.rewind_requested);
1244 pa_assert(s->thread_info.rewind_nbytes == 0);
1246 if (s->thread_info.state == PA_SINK_SUSPENDED) {
1247 pa_silence_memchunk(target, &s->sample_spec);
1260 pa_sink_render_into(s, &chunk);
1269 /* Called from IO thread context */
1270 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result) {
1271 pa_sink_assert_ref(s);
1272 pa_sink_assert_io_context(s);
1273 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1274 pa_assert(length > 0);
1275 pa_assert(pa_frame_aligned(length, &s->sample_spec));
1278 pa_assert(!s->thread_info.rewind_requested);
1279 pa_assert(s->thread_info.rewind_nbytes == 0);
1283 pa_sink_render(s, length, result);
1285 if (result->length < length) {
1288 pa_memchunk_make_writable(result, length);
1290 chunk.memblock = result->memblock;
1291 chunk.index = result->index + result->length;
1292 chunk.length = length - result->length;
1294 pa_sink_render_into_full(s, &chunk);
1296 result->length = length;
1302 /* Called from main thread */
1303 pa_bool_t pa_sink_update_rate(pa_sink *s, uint32_t rate, pa_bool_t passthrough)
1305 if (s->update_rate) {
1306 uint32_t desired_rate = rate;
1307 uint32_t default_rate = s->default_sample_rate;
1308 uint32_t alternate_rate = s->alternate_sample_rate;
1311 pa_bool_t use_alternate = FALSE;
1313 if (PA_UNLIKELY(default_rate == alternate_rate)) {
1314 pa_log_warn("Default and alternate sample rates are the same.");
1318 if (PA_SINK_IS_RUNNING(s->state)) {
1319 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1320 s->sample_spec.rate);
1324 if (s->monitor_source) {
1325 if (PA_SOURCE_IS_RUNNING(s->monitor_source->state) == TRUE) {
1326 pa_log_info("Cannot update rate, monitor source is RUNNING");
1331 if (PA_UNLIKELY (desired_rate < 8000 ||
1332 desired_rate > PA_RATE_MAX))
1336 pa_assert(default_rate % 4000 || default_rate % 11025);
1337 pa_assert(alternate_rate % 4000 || alternate_rate % 11025);
1339 if (default_rate % 4000) {
1340 /* default is a 11025 multiple */
1341 if ((alternate_rate % 4000 == 0) && (desired_rate % 4000 == 0))
1344 /* default is 4000 multiple */
1345 if ((alternate_rate % 11025 == 0) && (desired_rate % 11025 == 0))
1350 desired_rate = alternate_rate;
1352 desired_rate = default_rate;
1354 desired_rate = rate; /* use stream sampling rate, discard default/alternate settings */
1357 if (!passthrough && pa_sink_used_by(s) > 0)
1360 pa_sink_suspend(s, TRUE, PA_SUSPEND_IDLE); /* needed before rate update, will be resumed automatically */
1362 if (s->update_rate(s, desired_rate) == TRUE) {
1363 /* update monitor source as well */
1364 if (s->monitor_source && !passthrough)
1365 pa_source_update_rate(s->monitor_source, desired_rate, FALSE);
1366 pa_log_info("Changed sampling rate successfully");
1368 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1369 if (i->state == PA_SINK_INPUT_CORKED)
1370 pa_sink_input_update_rate(i);
1379 /* Called from main thread */
1380 pa_usec_t pa_sink_get_latency(pa_sink *s) {
1383 pa_sink_assert_ref(s);
1384 pa_assert_ctl_context();
1385 pa_assert(PA_SINK_IS_LINKED(s->state));
1387 /* The returned value is supposed to be in the time domain of the sound card! */
1389 if (s->state == PA_SINK_SUSPENDED)
1392 if (!(s->flags & PA_SINK_LATENCY))
1395 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
1400 /* Called from IO thread */
1401 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s) {
1405 pa_sink_assert_ref(s);
1406 pa_sink_assert_io_context(s);
1407 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1409 /* The returned value is supposed to be in the time domain of the sound card! */
1411 if (s->thread_info.state == PA_SINK_SUSPENDED)
1414 if (!(s->flags & PA_SINK_LATENCY))
1417 o = PA_MSGOBJECT(s);
1419 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1421 if (o->process_msg(o, PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
1427 /* Called from the main thread (and also from the IO thread while the main
1428 * thread is waiting).
1430 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1431 * set. Instead, flat volume mode is detected by checking whether the root sink
1432 * has the flag set. */
1433 pa_bool_t pa_sink_flat_volume_enabled(pa_sink *s) {
1434 pa_sink_assert_ref(s);
1436 s = pa_sink_get_master(s);
1439 return (s->flags & PA_SINK_FLAT_VOLUME);
1444 /* Called from the main thread (and also from the IO thread while the main
1445 * thread is waiting). */
1446 pa_sink *pa_sink_get_master(pa_sink *s) {
1447 pa_sink_assert_ref(s);
1449 while (s && (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1450 if (PA_UNLIKELY(!s->input_to_master))
1453 s = s->input_to_master->sink;
1459 /* Called from main context */
1460 pa_bool_t pa_sink_is_passthrough(pa_sink *s) {
1461 pa_sink_input *alt_i;
1464 pa_sink_assert_ref(s);
1466 /* one and only one PASSTHROUGH input can possibly be connected */
1467 if (pa_idxset_size(s->inputs) == 1) {
1468 alt_i = pa_idxset_first(s->inputs, &idx);
1470 if (pa_sink_input_is_passthrough(alt_i))
1477 /* Called from main context */
1478 void pa_sink_enter_passthrough(pa_sink *s) {
1481 /* disable the monitor in passthrough mode */
1482 if (s->monitor_source)
1483 pa_source_suspend(s->monitor_source, TRUE, PA_SUSPEND_PASSTHROUGH);
1485 /* set the volume to NORM */
1486 s->saved_volume = *pa_sink_get_volume(s, TRUE);
1487 s->saved_save_volume = s->save_volume;
1489 pa_cvolume_set(&volume, s->sample_spec.channels, PA_MIN(s->base_volume, PA_VOLUME_NORM));
1490 pa_sink_set_volume(s, &volume, TRUE, FALSE);
1493 /* Called from main context */
1494 void pa_sink_leave_passthrough(pa_sink *s) {
1495 /* Unsuspend monitor */
1496 if (s->monitor_source)
1497 pa_source_suspend(s->monitor_source, FALSE, PA_SUSPEND_PASSTHROUGH);
1499 /* Restore sink volume to what it was before we entered passthrough mode */
1500 pa_sink_set_volume(s, &s->saved_volume, TRUE, s->saved_save_volume);
1502 pa_cvolume_init(&s->saved_volume);
1503 s->saved_save_volume = FALSE;
1506 /* Called from main context. */
1507 static void compute_reference_ratio(pa_sink_input *i) {
1509 pa_cvolume remapped;
1512 pa_assert(pa_sink_flat_volume_enabled(i->sink));
1515 * Calculates the reference ratio from the sink's reference
1516 * volume. This basically calculates:
1518 * i->reference_ratio = i->volume / i->sink->reference_volume
1521 remapped = i->sink->reference_volume;
1522 pa_cvolume_remap(&remapped, &i->sink->channel_map, &i->channel_map);
1524 i->reference_ratio.channels = i->sample_spec.channels;
1526 for (c = 0; c < i->sample_spec.channels; c++) {
1528 /* We don't update when the sink volume is 0 anyway */
1529 if (remapped.values[c] <= PA_VOLUME_MUTED)
1532 /* Don't update the reference ratio unless necessary */
1533 if (pa_sw_volume_multiply(
1534 i->reference_ratio.values[c],
1535 remapped.values[c]) == i->volume.values[c])
1538 i->reference_ratio.values[c] = pa_sw_volume_divide(
1539 i->volume.values[c],
1540 remapped.values[c]);
1544 /* Called from main context. Only called for the root sink in volume sharing
1545 * cases, except for internal recursive calls. */
1546 static void compute_reference_ratios(pa_sink *s) {
1550 pa_sink_assert_ref(s);
1551 pa_assert_ctl_context();
1552 pa_assert(PA_SINK_IS_LINKED(s->state));
1553 pa_assert(pa_sink_flat_volume_enabled(s));
1555 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1556 compute_reference_ratio(i);
1558 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1559 compute_reference_ratios(i->origin_sink);
1563 /* Called from main context. Only called for the root sink in volume sharing
1564 * cases, except for internal recursive calls. */
1565 static void compute_real_ratios(pa_sink *s) {
1569 pa_sink_assert_ref(s);
1570 pa_assert_ctl_context();
1571 pa_assert(PA_SINK_IS_LINKED(s->state));
1572 pa_assert(pa_sink_flat_volume_enabled(s));
1574 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1576 pa_cvolume remapped;
1578 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1579 /* The origin sink uses volume sharing, so this input's real ratio
1580 * is handled as a special case - the real ratio must be 0 dB, and
1581 * as a result i->soft_volume must equal i->volume_factor. */
1582 pa_cvolume_reset(&i->real_ratio, i->real_ratio.channels);
1583 i->soft_volume = i->volume_factor;
1585 compute_real_ratios(i->origin_sink);
1591 * This basically calculates:
1593 * i->real_ratio := i->volume / s->real_volume
1594 * i->soft_volume := i->real_ratio * i->volume_factor
1597 remapped = s->real_volume;
1598 pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map);
1600 i->real_ratio.channels = i->sample_spec.channels;
1601 i->soft_volume.channels = i->sample_spec.channels;
1603 for (c = 0; c < i->sample_spec.channels; c++) {
1605 if (remapped.values[c] <= PA_VOLUME_MUTED) {
1606 /* We leave i->real_ratio untouched */
1607 i->soft_volume.values[c] = PA_VOLUME_MUTED;
1611 /* Don't lose accuracy unless necessary */
1612 if (pa_sw_volume_multiply(
1613 i->real_ratio.values[c],
1614 remapped.values[c]) != i->volume.values[c])
1616 i->real_ratio.values[c] = pa_sw_volume_divide(
1617 i->volume.values[c],
1618 remapped.values[c]);
1620 i->soft_volume.values[c] = pa_sw_volume_multiply(
1621 i->real_ratio.values[c],
1622 i->volume_factor.values[c]);
1625 /* We don't copy the soft_volume to the thread_info data
1626 * here. That must be done by the caller */
1630 static pa_cvolume *cvolume_remap_minimal_impact(
1632 const pa_cvolume *template,
1633 const pa_channel_map *from,
1634 const pa_channel_map *to) {
1639 pa_assert(template);
1642 pa_assert(pa_cvolume_compatible_with_channel_map(v, from));
1643 pa_assert(pa_cvolume_compatible_with_channel_map(template, to));
1645 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1646 * mapping from sink input to sink volumes:
1648 * If template is a possible remapping from v it is used instead
1649 * of remapping anew.
1651 * If the channel maps don't match we set an all-channel volume on
1652 * the sink to ensure that changing a volume on one stream has no
1653 * effect that cannot be compensated for in another stream that
1654 * does not have the same channel map as the sink. */
1656 if (pa_channel_map_equal(from, to))
1660 if (pa_cvolume_equal(pa_cvolume_remap(&t, to, from), v)) {
1665 pa_cvolume_set(v, to->channels, pa_cvolume_max(v));
1669 /* Called from main thread. Only called for the root sink in volume sharing
1670 * cases, except for internal recursive calls. */
1671 static void get_maximum_input_volume(pa_sink *s, pa_cvolume *max_volume, const pa_channel_map *channel_map) {
1675 pa_sink_assert_ref(s);
1676 pa_assert(max_volume);
1677 pa_assert(channel_map);
1678 pa_assert(pa_sink_flat_volume_enabled(s));
1680 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1681 pa_cvolume remapped;
1683 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1684 get_maximum_input_volume(i->origin_sink, max_volume, channel_map);
1686 /* Ignore this input. The origin sink uses volume sharing, so this
1687 * input's volume will be set to be equal to the root sink's real
1688 * volume. Obviously this input's current volume must not then
1689 * affect what the root sink's real volume will be. */
1693 remapped = i->volume;
1694 cvolume_remap_minimal_impact(&remapped, max_volume, &i->channel_map, channel_map);
1695 pa_cvolume_merge(max_volume, max_volume, &remapped);
1699 /* Called from main thread. Only called for the root sink in volume sharing
1700 * cases, except for internal recursive calls. */
1701 static pa_bool_t has_inputs(pa_sink *s) {
1705 pa_sink_assert_ref(s);
1707 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1708 if (!i->origin_sink || !(i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || has_inputs(i->origin_sink))
1715 /* Called from main thread. Only called for the root sink in volume sharing
1716 * cases, except for internal recursive calls. */
1717 static void update_real_volume(pa_sink *s, const pa_cvolume *new_volume, pa_channel_map *channel_map) {
1721 pa_sink_assert_ref(s);
1722 pa_assert(new_volume);
1723 pa_assert(channel_map);
1725 s->real_volume = *new_volume;
1726 pa_cvolume_remap(&s->real_volume, channel_map, &s->channel_map);
1728 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1729 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1730 if (pa_sink_flat_volume_enabled(s)) {
1731 pa_cvolume old_volume = i->volume;
1733 /* Follow the root sink's real volume. */
1734 i->volume = *new_volume;
1735 pa_cvolume_remap(&i->volume, channel_map, &i->channel_map);
1736 compute_reference_ratio(i);
1738 /* The volume changed, let's tell people so */
1739 if (!pa_cvolume_equal(&old_volume, &i->volume)) {
1740 if (i->volume_changed)
1741 i->volume_changed(i);
1743 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1747 update_real_volume(i->origin_sink, new_volume, channel_map);
1752 /* Called from main thread. Only called for the root sink in shared volume
1754 static void compute_real_volume(pa_sink *s) {
1755 pa_sink_assert_ref(s);
1756 pa_assert_ctl_context();
1757 pa_assert(PA_SINK_IS_LINKED(s->state));
1758 pa_assert(pa_sink_flat_volume_enabled(s));
1759 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
1761 /* This determines the maximum volume of all streams and sets
1762 * s->real_volume accordingly. */
1764 if (!has_inputs(s)) {
1765 /* In the special case that we have no sink inputs we leave the
1766 * volume unmodified. */
1767 update_real_volume(s, &s->reference_volume, &s->channel_map);
1771 pa_cvolume_mute(&s->real_volume, s->channel_map.channels);
1773 /* First let's determine the new maximum volume of all inputs
1774 * connected to this sink */
1775 get_maximum_input_volume(s, &s->real_volume, &s->channel_map);
1776 update_real_volume(s, &s->real_volume, &s->channel_map);
1778 /* Then, let's update the real ratios/soft volumes of all inputs
1779 * connected to this sink */
1780 compute_real_ratios(s);
1783 /* Called from main thread. Only called for the root sink in shared volume
1784 * cases, except for internal recursive calls. */
1785 static void propagate_reference_volume(pa_sink *s) {
1789 pa_sink_assert_ref(s);
1790 pa_assert_ctl_context();
1791 pa_assert(PA_SINK_IS_LINKED(s->state));
1792 pa_assert(pa_sink_flat_volume_enabled(s));
1794 /* This is called whenever the sink volume changes that is not
1795 * caused by a sink input volume change. We need to fix up the
1796 * sink input volumes accordingly */
1798 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1799 pa_cvolume old_volume;
1801 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1802 propagate_reference_volume(i->origin_sink);
1804 /* Since the origin sink uses volume sharing, this input's volume
1805 * needs to be updated to match the root sink's real volume, but
1806 * that will be done later in update_shared_real_volume(). */
1810 old_volume = i->volume;
1812 /* This basically calculates:
1814 * i->volume := s->reference_volume * i->reference_ratio */
1816 i->volume = s->reference_volume;
1817 pa_cvolume_remap(&i->volume, &s->channel_map, &i->channel_map);
1818 pa_sw_cvolume_multiply(&i->volume, &i->volume, &i->reference_ratio);
1820 /* The volume changed, let's tell people so */
1821 if (!pa_cvolume_equal(&old_volume, &i->volume)) {
1823 if (i->volume_changed)
1824 i->volume_changed(i);
1826 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1831 /* Called from main thread. Only called for the root sink in volume sharing
1832 * cases, except for internal recursive calls. The return value indicates
1833 * whether any reference volume actually changed. */
1834 static pa_bool_t update_reference_volume(pa_sink *s, const pa_cvolume *v, const pa_channel_map *channel_map, pa_bool_t save) {
1836 pa_bool_t reference_volume_changed;
1840 pa_sink_assert_ref(s);
1841 pa_assert(PA_SINK_IS_LINKED(s->state));
1843 pa_assert(channel_map);
1844 pa_assert(pa_cvolume_valid(v));
1847 pa_cvolume_remap(&volume, channel_map, &s->channel_map);
1849 reference_volume_changed = !pa_cvolume_equal(&volume, &s->reference_volume);
1850 s->reference_volume = volume;
1852 s->save_volume = (!reference_volume_changed && s->save_volume) || save;
1854 if (reference_volume_changed)
1855 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1856 else if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1857 /* If the root sink's volume doesn't change, then there can't be any
1858 * changes in the other sinks in the sink tree either.
1860 * It's probably theoretically possible that even if the root sink's
1861 * volume changes slightly, some filter sink doesn't change its volume
1862 * due to rounding errors. If that happens, we still want to propagate
1863 * the changed root sink volume to the sinks connected to the
1864 * intermediate sink that didn't change its volume. This theoretical
1865 * possibility is the reason why we have that !(s->flags &
1866 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1867 * notice even if we returned here FALSE always if
1868 * reference_volume_changed is FALSE. */
1871 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1872 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1873 update_reference_volume(i->origin_sink, v, channel_map, FALSE);
1879 /* Called from main thread */
1880 void pa_sink_set_volume(
1882 const pa_cvolume *volume,
1886 pa_cvolume new_reference_volume;
1889 pa_sink_assert_ref(s);
1890 pa_assert_ctl_context();
1891 pa_assert(PA_SINK_IS_LINKED(s->state));
1892 pa_assert(!volume || pa_cvolume_valid(volume));
1893 pa_assert(volume || pa_sink_flat_volume_enabled(s));
1894 pa_assert(!volume || volume->channels == 1 || pa_cvolume_compatible(volume, &s->sample_spec));
1896 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
1897 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1898 if (pa_sink_is_passthrough(s) && (!volume || !pa_cvolume_is_norm(volume))) {
1899 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
1903 /* In case of volume sharing, the volume is set for the root sink first,
1904 * from which it's then propagated to the sharing sinks. */
1905 root_sink = pa_sink_get_master(s);
1907 if (PA_UNLIKELY(!root_sink))
1910 /* As a special exception we accept mono volumes on all sinks --
1911 * even on those with more complex channel maps */
1914 if (pa_cvolume_compatible(volume, &s->sample_spec))
1915 new_reference_volume = *volume;
1917 new_reference_volume = s->reference_volume;
1918 pa_cvolume_scale(&new_reference_volume, pa_cvolume_max(volume));
1921 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map);
1923 if (update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save)) {
1924 if (pa_sink_flat_volume_enabled(root_sink)) {
1925 /* OK, propagate this volume change back to the inputs */
1926 propagate_reference_volume(root_sink);
1928 /* And now recalculate the real volume */
1929 compute_real_volume(root_sink);
1931 update_real_volume(root_sink, &root_sink->reference_volume, &root_sink->channel_map);
1935 /* If volume is NULL we synchronize the sink's real and
1936 * reference volumes with the stream volumes. */
1938 pa_assert(pa_sink_flat_volume_enabled(root_sink));
1940 /* Ok, let's determine the new real volume */
1941 compute_real_volume(root_sink);
1943 /* Let's 'push' the reference volume if necessary */
1944 pa_cvolume_merge(&new_reference_volume, &s->reference_volume, &root_sink->real_volume);
1945 /* If the sink and it's root don't have the same number of channels, we need to remap */
1946 if (s != root_sink && !pa_channel_map_equal(&s->channel_map, &root_sink->channel_map))
1947 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map);
1948 update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save);
1950 /* Now that the reference volume is updated, we can update the streams'
1951 * reference ratios. */
1952 compute_reference_ratios(root_sink);
1955 if (root_sink->set_volume) {
1956 /* If we have a function set_volume(), then we do not apply a
1957 * soft volume by default. However, set_volume() is free to
1958 * apply one to root_sink->soft_volume */
1960 pa_cvolume_reset(&root_sink->soft_volume, root_sink->sample_spec.channels);
1961 if (!(root_sink->flags & PA_SINK_DEFERRED_VOLUME))
1962 root_sink->set_volume(root_sink);
1965 /* If we have no function set_volume(), then the soft volume
1966 * becomes the real volume */
1967 root_sink->soft_volume = root_sink->real_volume;
1969 /* This tells the sink that soft volume and/or real volume changed */
1971 pa_assert_se(pa_asyncmsgq_send(root_sink->asyncmsgq, PA_MSGOBJECT(root_sink), PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL) == 0);
1974 /* Called from the io thread if sync volume is used, otherwise from the main thread.
1975 * Only to be called by sink implementor */
1976 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume) {
1978 pa_sink_assert_ref(s);
1979 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
1981 if (s->flags & PA_SINK_DEFERRED_VOLUME)
1982 pa_sink_assert_io_context(s);
1984 pa_assert_ctl_context();
1987 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
1989 s->soft_volume = *volume;
1991 if (PA_SINK_IS_LINKED(s->state) && !(s->flags & PA_SINK_DEFERRED_VOLUME))
1992 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0);
1994 s->thread_info.soft_volume = s->soft_volume;
1997 /* Called from the main thread. Only called for the root sink in volume sharing
1998 * cases, except for internal recursive calls. */
1999 static void propagate_real_volume(pa_sink *s, const pa_cvolume *old_real_volume) {
2003 pa_sink_assert_ref(s);
2004 pa_assert(old_real_volume);
2005 pa_assert_ctl_context();
2006 pa_assert(PA_SINK_IS_LINKED(s->state));
2008 /* This is called when the hardware's real volume changes due to
2009 * some external event. We copy the real volume into our
2010 * reference volume and then rebuild the stream volumes based on
2011 * i->real_ratio which should stay fixed. */
2013 if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
2014 if (pa_cvolume_equal(old_real_volume, &s->real_volume))
2017 /* 1. Make the real volume the reference volume */
2018 update_reference_volume(s, &s->real_volume, &s->channel_map, TRUE);
2021 if (pa_sink_flat_volume_enabled(s)) {
2023 PA_IDXSET_FOREACH(i, s->inputs, idx) {
2024 pa_cvolume old_volume = i->volume;
2026 /* 2. Since the sink's reference and real volumes are equal
2027 * now our ratios should be too. */
2028 i->reference_ratio = i->real_ratio;
2030 /* 3. Recalculate the new stream reference volume based on the
2031 * reference ratio and the sink's reference volume.
2033 * This basically calculates:
2035 * i->volume = s->reference_volume * i->reference_ratio
2037 * This is identical to propagate_reference_volume() */
2038 i->volume = s->reference_volume;
2039 pa_cvolume_remap(&i->volume, &s->channel_map, &i->channel_map);
2040 pa_sw_cvolume_multiply(&i->volume, &i->volume, &i->reference_ratio);
2042 /* Notify if something changed */
2043 if (!pa_cvolume_equal(&old_volume, &i->volume)) {
2045 if (i->volume_changed)
2046 i->volume_changed(i);
2048 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
2051 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2052 propagate_real_volume(i->origin_sink, old_real_volume);
2056 /* Something got changed in the hardware. It probably makes sense
2057 * to save changed hw settings given that hw volume changes not
2058 * triggered by PA are almost certainly done by the user. */
2059 if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2060 s->save_volume = TRUE;
2063 /* Called from io thread */
2064 void pa_sink_update_volume_and_mute(pa_sink *s) {
2066 pa_sink_assert_io_context(s);
2068 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE, NULL, 0, NULL, NULL);
2071 /* Called from main thread */
2072 const pa_cvolume *pa_sink_get_volume(pa_sink *s, pa_bool_t force_refresh) {
2073 pa_sink_assert_ref(s);
2074 pa_assert_ctl_context();
2075 pa_assert(PA_SINK_IS_LINKED(s->state));
2077 if (s->refresh_volume || force_refresh) {
2078 struct pa_cvolume old_real_volume;
2080 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2082 old_real_volume = s->real_volume;
2084 if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume)
2087 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_VOLUME, NULL, 0, NULL) == 0);
2089 update_real_volume(s, &s->real_volume, &s->channel_map);
2090 propagate_real_volume(s, &old_real_volume);
2093 return &s->reference_volume;
2096 /* Called from main thread. In volume sharing cases, only the root sink may
2098 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_real_volume) {
2099 pa_cvolume old_real_volume;
2101 pa_sink_assert_ref(s);
2102 pa_assert_ctl_context();
2103 pa_assert(PA_SINK_IS_LINKED(s->state));
2104 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2106 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2108 old_real_volume = s->real_volume;
2109 update_real_volume(s, new_real_volume, &s->channel_map);
2110 propagate_real_volume(s, &old_real_volume);
2113 /* Called from main thread */
2114 void pa_sink_set_mute(pa_sink *s, pa_bool_t mute, pa_bool_t save) {
2115 pa_bool_t old_muted;
2117 pa_sink_assert_ref(s);
2118 pa_assert_ctl_context();
2119 pa_assert(PA_SINK_IS_LINKED(s->state));
2121 old_muted = s->muted;
2123 s->save_muted = (old_muted == s->muted && s->save_muted) || save;
2125 if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->set_mute)
2128 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
2130 if (old_muted != s->muted)
2131 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2134 /* Called from main thread */
2135 pa_bool_t pa_sink_get_mute(pa_sink *s, pa_bool_t force_refresh) {
2137 pa_sink_assert_ref(s);
2138 pa_assert_ctl_context();
2139 pa_assert(PA_SINK_IS_LINKED(s->state));
2141 if (s->refresh_muted || force_refresh) {
2142 pa_bool_t old_muted = s->muted;
2144 if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_mute)
2147 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MUTE, NULL, 0, NULL) == 0);
2149 if (old_muted != s->muted) {
2150 s->save_muted = TRUE;
2152 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2154 /* Make sure the soft mute status stays in sync */
2155 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
2162 /* Called from main thread */
2163 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted) {
2164 pa_sink_assert_ref(s);
2165 pa_assert_ctl_context();
2166 pa_assert(PA_SINK_IS_LINKED(s->state));
2168 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2170 if (s->muted == new_muted)
2173 s->muted = new_muted;
2174 s->save_muted = TRUE;
2176 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2179 /* Called from main thread */
2180 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p) {
2181 pa_sink_assert_ref(s);
2182 pa_assert_ctl_context();
2185 pa_proplist_update(s->proplist, mode, p);
2187 if (PA_SINK_IS_LINKED(s->state)) {
2188 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
2189 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2195 /* Called from main thread */
2196 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2197 void pa_sink_set_description(pa_sink *s, const char *description) {
2199 pa_sink_assert_ref(s);
2200 pa_assert_ctl_context();
2202 if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
2205 old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
2207 if (old && description && pa_streq(old, description))
2211 pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
2213 pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
2215 if (s->monitor_source) {
2218 n = pa_sprintf_malloc("Monitor Source of %s", description ? description : s->name);
2219 pa_source_set_description(s->monitor_source, n);
2223 if (PA_SINK_IS_LINKED(s->state)) {
2224 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2225 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
2229 /* Called from main thread */
2230 unsigned pa_sink_linked_by(pa_sink *s) {
2233 pa_sink_assert_ref(s);
2234 pa_assert_ctl_context();
2235 pa_assert(PA_SINK_IS_LINKED(s->state));
2237 ret = pa_idxset_size(s->inputs);
2239 /* We add in the number of streams connected to us here. Please
2240 * note the asymmetry to pa_sink_used_by()! */
2242 if (s->monitor_source)
2243 ret += pa_source_linked_by(s->monitor_source);
2248 /* Called from main thread */
2249 unsigned pa_sink_used_by(pa_sink *s) {
2252 pa_sink_assert_ref(s);
2253 pa_assert_ctl_context();
2254 pa_assert(PA_SINK_IS_LINKED(s->state));
2256 ret = pa_idxset_size(s->inputs);
2257 pa_assert(ret >= s->n_corked);
2259 /* Streams connected to our monitor source do not matter for
2260 * pa_sink_used_by()!.*/
2262 return ret - s->n_corked;
2265 /* Called from main thread */
2266 unsigned pa_sink_check_suspend(pa_sink *s) {
2271 pa_sink_assert_ref(s);
2272 pa_assert_ctl_context();
2274 if (!PA_SINK_IS_LINKED(s->state))
2279 PA_IDXSET_FOREACH(i, s->inputs, idx) {
2280 pa_sink_input_state_t st;
2282 st = pa_sink_input_get_state(i);
2284 /* We do not assert here. It is perfectly valid for a sink input to
2285 * be in the INIT state (i.e. created, marked done but not yet put)
2286 * and we should not care if it's unlinked as it won't contribute
2287 * towards our busy status.
2289 if (!PA_SINK_INPUT_IS_LINKED(st))
2292 if (st == PA_SINK_INPUT_CORKED)
2295 if (i->flags & PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND)
2301 if (s->monitor_source)
2302 ret += pa_source_check_suspend(s->monitor_source);
2307 /* Called from the IO thread */
2308 static void sync_input_volumes_within_thread(pa_sink *s) {
2312 pa_sink_assert_ref(s);
2313 pa_sink_assert_io_context(s);
2315 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
2316 if (pa_cvolume_equal(&i->thread_info.soft_volume, &i->soft_volume))
2319 i->thread_info.soft_volume = i->soft_volume;
2320 pa_sink_input_request_rewind(i, 0, TRUE, FALSE, FALSE);
2324 /* Called from the IO thread. Only called for the root sink in volume sharing
2325 * cases, except for internal recursive calls. */
2326 static void set_shared_volume_within_thread(pa_sink *s) {
2327 pa_sink_input *i = NULL;
2330 pa_sink_assert_ref(s);
2332 PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL);
2334 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
2335 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2336 set_shared_volume_within_thread(i->origin_sink);
2340 /* Called from IO thread, except when it is not */
2341 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
2342 pa_sink *s = PA_SINK(o);
2343 pa_sink_assert_ref(s);
2345 switch ((pa_sink_message_t) code) {
2347 case PA_SINK_MESSAGE_ADD_INPUT: {
2348 pa_sink_input *i = PA_SINK_INPUT(userdata);
2350 /* If you change anything here, make sure to change the
2351 * sink input handling a few lines down at
2352 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2354 pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
2356 /* Since the caller sleeps in pa_sink_input_put(), we can
2357 * safely access data outside of thread_info even though
2360 if ((i->thread_info.sync_prev = i->sync_prev)) {
2361 pa_assert(i->sink == i->thread_info.sync_prev->sink);
2362 pa_assert(i->sync_prev->sync_next == i);
2363 i->thread_info.sync_prev->thread_info.sync_next = i;
2366 if ((i->thread_info.sync_next = i->sync_next)) {
2367 pa_assert(i->sink == i->thread_info.sync_next->sink);
2368 pa_assert(i->sync_next->sync_prev == i);
2369 i->thread_info.sync_next->thread_info.sync_prev = i;
2372 pa_assert(!i->thread_info.attached);
2373 i->thread_info.attached = TRUE;
2378 pa_sink_input_set_state_within_thread(i, i->state);
2380 /* The requested latency of the sink input needs to be
2381 * fixed up and then configured on the sink */
2383 if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
2384 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
2386 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
2387 pa_sink_input_update_max_request(i, s->thread_info.max_request);
2389 /* We don't rewind here automatically. This is left to the
2390 * sink input implementor because some sink inputs need a
2391 * slow start, i.e. need some time to buffer client
2392 * samples before beginning streaming. */
2394 /* FIXME: Actually rewinding should be requested before
2395 * updating the sink requested latency, because updating
2396 * the requested latency updates also max_rewind of the
2397 * sink. Now consider this: a sink has a 10 s buffer and
2398 * nobody has requested anything less. Then a new stream
2399 * appears while the sink buffer is full. The new stream
2400 * requests e.g. 100 ms latency. That request is forwarded
2401 * to the sink, so now max_rewind is 100 ms. When a rewind
2402 * is requested, the sink will only rewind 100 ms, and the
2403 * new stream will have to wait about 10 seconds before it
2404 * becomes audible. */
2406 /* In flat volume mode we need to update the volume as
2408 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2411 case PA_SINK_MESSAGE_REMOVE_INPUT: {
2412 pa_sink_input *i = PA_SINK_INPUT(userdata);
2414 /* If you change anything here, make sure to change the
2415 * sink input handling a few lines down at
2416 * PA_SINK_MESSAGE_START_MOVE, too. */
2421 pa_sink_input_set_state_within_thread(i, i->state);
2423 pa_assert(i->thread_info.attached);
2424 i->thread_info.attached = FALSE;
2426 /* Since the caller sleeps in pa_sink_input_unlink(),
2427 * we can safely access data outside of thread_info even
2428 * though it is mutable */
2430 pa_assert(!i->sync_prev);
2431 pa_assert(!i->sync_next);
2433 if (i->thread_info.sync_prev) {
2434 i->thread_info.sync_prev->thread_info.sync_next = i->thread_info.sync_prev->sync_next;
2435 i->thread_info.sync_prev = NULL;
2438 if (i->thread_info.sync_next) {
2439 i->thread_info.sync_next->thread_info.sync_prev = i->thread_info.sync_next->sync_prev;
2440 i->thread_info.sync_next = NULL;
2443 if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index)))
2444 pa_sink_input_unref(i);
2446 pa_sink_invalidate_requested_latency(s, TRUE);
2447 pa_sink_request_rewind(s, (size_t) -1);
2449 /* In flat volume mode we need to update the volume as
2451 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2454 case PA_SINK_MESSAGE_START_MOVE: {
2455 pa_sink_input *i = PA_SINK_INPUT(userdata);
2457 /* We don't support moving synchronized streams. */
2458 pa_assert(!i->sync_prev);
2459 pa_assert(!i->sync_next);
2460 pa_assert(!i->thread_info.sync_next);
2461 pa_assert(!i->thread_info.sync_prev);
2463 if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
2465 size_t sink_nbytes, total_nbytes;
2467 /* The old sink probably has some audio from this
2468 * stream in its buffer. We want to "take it back" as
2469 * much as possible and play it to the new sink. We
2470 * don't know at this point how much the old sink can
2471 * rewind. We have to pick something, and that
2472 * something is the full latency of the old sink here.
2473 * So we rewind the stream buffer by the sink latency
2474 * amount, which may be more than what we should
2475 * rewind. This can result in a chunk of audio being
2476 * played both to the old sink and the new sink.
2478 * FIXME: Fix this code so that we don't have to make
2479 * guesses about how much the sink will actually be
2480 * able to rewind. If someone comes up with a solution
2481 * for this, something to note is that the part of the
2482 * latency that the old sink couldn't rewind should
2483 * ideally be compensated after the stream has moved
2484 * to the new sink by adding silence. The new sink
2485 * most likely can't start playing the moved stream
2486 * immediately, and that gap should be removed from
2487 * the "compensation silence" (at least at the time of
2488 * writing this, the move finish code will actually
2489 * already take care of dropping the new sink's
2490 * unrewindable latency, so taking into account the
2491 * unrewindable latency of the old sink is the only
2494 * The render_memblockq contents are discarded,
2495 * because when the sink changes, the format of the
2496 * audio stored in the render_memblockq may change
2497 * too, making the stored audio invalid. FIXME:
2498 * However, the read and write indices are moved back
2499 * the same amount, so if they are not the same now,
2500 * they won't be the same after the rewind either. If
2501 * the write index of the render_memblockq is ahead of
2502 * the read index, then the render_memblockq will feed
2503 * the new sink some silence first, which it shouldn't
2504 * do. The write index should be flushed to be the
2505 * same as the read index. */
2507 /* Get the latency of the sink */
2508 usec = pa_sink_get_latency_within_thread(s);
2509 sink_nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
2510 total_nbytes = sink_nbytes + pa_memblockq_get_length(i->thread_info.render_memblockq);
2512 if (total_nbytes > 0) {
2513 i->thread_info.rewrite_nbytes = i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, total_nbytes) : total_nbytes;
2514 i->thread_info.rewrite_flush = TRUE;
2515 pa_sink_input_process_rewind(i, sink_nbytes);
2522 pa_assert(i->thread_info.attached);
2523 i->thread_info.attached = FALSE;
2525 /* Let's remove the sink input ...*/
2526 if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index)))
2527 pa_sink_input_unref(i);
2529 pa_sink_invalidate_requested_latency(s, TRUE);
2531 pa_log_debug("Requesting rewind due to started move");
2532 pa_sink_request_rewind(s, (size_t) -1);
2534 /* In flat volume mode we need to update the volume as
2536 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2539 case PA_SINK_MESSAGE_FINISH_MOVE: {
2540 pa_sink_input *i = PA_SINK_INPUT(userdata);
2542 /* We don't support moving synchronized streams. */
2543 pa_assert(!i->sync_prev);
2544 pa_assert(!i->sync_next);
2545 pa_assert(!i->thread_info.sync_next);
2546 pa_assert(!i->thread_info.sync_prev);
2548 pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
2550 pa_assert(!i->thread_info.attached);
2551 i->thread_info.attached = TRUE;
2556 if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
2560 /* In the ideal case the new sink would start playing
2561 * the stream immediately. That requires the sink to
2562 * be able to rewind all of its latency, which usually
2563 * isn't possible, so there will probably be some gap
2564 * before the moved stream becomes audible. We then
2565 * have two possibilities: 1) start playing the stream
2566 * from where it is now, or 2) drop the unrewindable
2567 * latency of the sink from the stream. With option 1
2568 * we won't lose any audio but the stream will have a
2569 * pause. With option 2 we may lose some audio but the
2570 * stream time will be somewhat in sync with the wall
2571 * clock. Lennart seems to have chosen option 2 (one
2572 * of the reasons might have been that option 1 is
2573 * actually much harder to implement), so we drop the
2574 * latency of the new sink from the moved stream and
2575 * hope that the sink will undo most of that in the
2578 /* Get the latency of the sink */
2579 usec = pa_sink_get_latency_within_thread(s);
2580 nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
2583 pa_sink_input_drop(i, nbytes);
2585 pa_log_debug("Requesting rewind due to finished move");
2586 pa_sink_request_rewind(s, nbytes);
2589 /* Updating the requested sink latency has to be done
2590 * after the sink rewind request, not before, because
2591 * otherwise the sink may limit the rewind amount
2594 if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
2595 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
2597 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
2598 pa_sink_input_update_max_request(i, s->thread_info.max_request);
2600 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2603 case PA_SINK_MESSAGE_SET_SHARED_VOLUME: {
2604 pa_sink *root_sink = pa_sink_get_master(s);
2606 if (PA_LIKELY(root_sink))
2607 set_shared_volume_within_thread(root_sink);
2612 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED:
2614 if (s->flags & PA_SINK_DEFERRED_VOLUME) {
2616 pa_sink_volume_change_push(s);
2618 /* Fall through ... */
2620 case PA_SINK_MESSAGE_SET_VOLUME:
2622 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2623 s->thread_info.soft_volume = s->soft_volume;
2624 pa_sink_request_rewind(s, (size_t) -1);
2627 /* Fall through ... */
2629 case PA_SINK_MESSAGE_SYNC_VOLUMES:
2630 sync_input_volumes_within_thread(s);
2633 case PA_SINK_MESSAGE_GET_VOLUME:
2635 if ((s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume) {
2637 pa_sink_volume_change_flush(s);
2638 pa_sw_cvolume_divide(&s->thread_info.current_hw_volume, &s->real_volume, &s->soft_volume);
2641 /* In case sink implementor reset SW volume. */
2642 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2643 s->thread_info.soft_volume = s->soft_volume;
2644 pa_sink_request_rewind(s, (size_t) -1);
2649 case PA_SINK_MESSAGE_SET_MUTE:
2651 if (s->thread_info.soft_muted != s->muted) {
2652 s->thread_info.soft_muted = s->muted;
2653 pa_sink_request_rewind(s, (size_t) -1);
2656 if (s->flags & PA_SINK_DEFERRED_VOLUME && s->set_mute)
2661 case PA_SINK_MESSAGE_GET_MUTE:
2663 if (s->flags & PA_SINK_DEFERRED_VOLUME && s->get_mute)
2668 case PA_SINK_MESSAGE_SET_STATE: {
2670 pa_bool_t suspend_change =
2671 (s->thread_info.state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata))) ||
2672 (PA_SINK_IS_OPENED(s->thread_info.state) && PA_PTR_TO_UINT(userdata) == PA_SINK_SUSPENDED);
2674 s->thread_info.state = PA_PTR_TO_UINT(userdata);
2676 if (s->thread_info.state == PA_SINK_SUSPENDED) {
2677 s->thread_info.rewind_nbytes = 0;
2678 s->thread_info.rewind_requested = FALSE;
2681 if (suspend_change) {
2685 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
2686 if (i->suspend_within_thread)
2687 i->suspend_within_thread(i, s->thread_info.state == PA_SINK_SUSPENDED);
2693 case PA_SINK_MESSAGE_DETACH:
2695 /* Detach all streams */
2696 pa_sink_detach_within_thread(s);
2699 case PA_SINK_MESSAGE_ATTACH:
2701 /* Reattach all streams */
2702 pa_sink_attach_within_thread(s);
2705 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY: {
2707 pa_usec_t *usec = userdata;
2708 *usec = pa_sink_get_requested_latency_within_thread(s);
2710 /* Yes, that's right, the IO thread will see -1 when no
2711 * explicit requested latency is configured, the main
2712 * thread will see max_latency */
2713 if (*usec == (pa_usec_t) -1)
2714 *usec = s->thread_info.max_latency;
2719 case PA_SINK_MESSAGE_SET_LATENCY_RANGE: {
2720 pa_usec_t *r = userdata;
2722 pa_sink_set_latency_range_within_thread(s, r[0], r[1]);
2727 case PA_SINK_MESSAGE_GET_LATENCY_RANGE: {
2728 pa_usec_t *r = userdata;
2730 r[0] = s->thread_info.min_latency;
2731 r[1] = s->thread_info.max_latency;
2736 case PA_SINK_MESSAGE_GET_FIXED_LATENCY:
2738 *((pa_usec_t*) userdata) = s->thread_info.fixed_latency;
2741 case PA_SINK_MESSAGE_SET_FIXED_LATENCY:
2743 pa_sink_set_fixed_latency_within_thread(s, (pa_usec_t) offset);
2746 case PA_SINK_MESSAGE_GET_MAX_REWIND:
2748 *((size_t*) userdata) = s->thread_info.max_rewind;
2751 case PA_SINK_MESSAGE_GET_MAX_REQUEST:
2753 *((size_t*) userdata) = s->thread_info.max_request;
2756 case PA_SINK_MESSAGE_SET_MAX_REWIND:
2758 pa_sink_set_max_rewind_within_thread(s, (size_t) offset);
2761 case PA_SINK_MESSAGE_SET_MAX_REQUEST:
2763 pa_sink_set_max_request_within_thread(s, (size_t) offset);
2766 case PA_SINK_MESSAGE_SET_PORT:
2768 pa_assert(userdata);
2770 struct sink_message_set_port *msg_data = userdata;
2771 msg_data->ret = s->set_port(s, msg_data->port);
2775 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE:
2776 /* This message is sent from IO-thread and handled in main thread. */
2777 pa_assert_ctl_context();
2779 /* Make sure we're not messing with main thread when no longer linked */
2780 if (!PA_SINK_IS_LINKED(s->state))
2783 pa_sink_get_volume(s, TRUE);
2784 pa_sink_get_mute(s, TRUE);
2787 case PA_SINK_MESSAGE_GET_LATENCY:
2788 case PA_SINK_MESSAGE_MAX:
2795 /* Called from main thread */
2796 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause) {
2801 pa_core_assert_ref(c);
2802 pa_assert_ctl_context();
2803 pa_assert(cause != 0);
2805 PA_IDXSET_FOREACH(sink, c->sinks, idx) {
2808 if ((r = pa_sink_suspend(sink, suspend, cause)) < 0)
2815 /* Called from main thread */
2816 void pa_sink_detach(pa_sink *s) {
2817 pa_sink_assert_ref(s);
2818 pa_assert_ctl_context();
2819 pa_assert(PA_SINK_IS_LINKED(s->state));
2821 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_DETACH, NULL, 0, NULL) == 0);
2824 /* Called from main thread */
2825 void pa_sink_attach(pa_sink *s) {
2826 pa_sink_assert_ref(s);
2827 pa_assert_ctl_context();
2828 pa_assert(PA_SINK_IS_LINKED(s->state));
2830 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_ATTACH, NULL, 0, NULL) == 0);
2833 /* Called from IO thread */
2834 void pa_sink_detach_within_thread(pa_sink *s) {
2838 pa_sink_assert_ref(s);
2839 pa_sink_assert_io_context(s);
2840 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2842 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2846 if (s->monitor_source)
2847 pa_source_detach_within_thread(s->monitor_source);
2850 /* Called from IO thread */
2851 void pa_sink_attach_within_thread(pa_sink *s) {
2855 pa_sink_assert_ref(s);
2856 pa_sink_assert_io_context(s);
2857 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2859 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2863 if (s->monitor_source)
2864 pa_source_attach_within_thread(s->monitor_source);
2867 /* Called from IO thread */
2868 void pa_sink_request_rewind(pa_sink*s, size_t nbytes) {
2869 pa_sink_assert_ref(s);
2870 pa_sink_assert_io_context(s);
2871 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2873 if (s->thread_info.state == PA_SINK_SUSPENDED)
2876 if (nbytes == (size_t) -1)
2877 nbytes = s->thread_info.max_rewind;
2879 nbytes = PA_MIN(nbytes, s->thread_info.max_rewind);
2881 if (s->thread_info.rewind_requested &&
2882 nbytes <= s->thread_info.rewind_nbytes)
2885 s->thread_info.rewind_nbytes = nbytes;
2886 s->thread_info.rewind_requested = TRUE;
2888 if (s->request_rewind)
2889 s->request_rewind(s);
2892 /* Called from IO thread */
2893 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s) {
2894 pa_usec_t result = (pa_usec_t) -1;
2897 pa_usec_t monitor_latency;
2899 pa_sink_assert_ref(s);
2900 pa_sink_assert_io_context(s);
2902 if (!(s->flags & PA_SINK_DYNAMIC_LATENCY))
2903 return PA_CLAMP(s->thread_info.fixed_latency, s->thread_info.min_latency, s->thread_info.max_latency);
2905 if (s->thread_info.requested_latency_valid)
2906 return s->thread_info.requested_latency;
2908 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2909 if (i->thread_info.requested_sink_latency != (pa_usec_t) -1 &&
2910 (result == (pa_usec_t) -1 || result > i->thread_info.requested_sink_latency))
2911 result = i->thread_info.requested_sink_latency;
2913 monitor_latency = pa_source_get_requested_latency_within_thread(s->monitor_source);
2915 if (monitor_latency != (pa_usec_t) -1 &&
2916 (result == (pa_usec_t) -1 || result > monitor_latency))
2917 result = monitor_latency;
2919 if (result != (pa_usec_t) -1)
2920 result = PA_CLAMP(result, s->thread_info.min_latency, s->thread_info.max_latency);
2922 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
2923 /* Only cache if properly initialized */
2924 s->thread_info.requested_latency = result;
2925 s->thread_info.requested_latency_valid = TRUE;
2931 /* Called from main thread */
2932 pa_usec_t pa_sink_get_requested_latency(pa_sink *s) {
2935 pa_sink_assert_ref(s);
2936 pa_assert_ctl_context();
2937 pa_assert(PA_SINK_IS_LINKED(s->state));
2939 if (s->state == PA_SINK_SUSPENDED)
2942 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
2947 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
2948 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind) {
2952 pa_sink_assert_ref(s);
2953 pa_sink_assert_io_context(s);
2955 if (max_rewind == s->thread_info.max_rewind)
2958 s->thread_info.max_rewind = max_rewind;
2960 if (PA_SINK_IS_LINKED(s->thread_info.state))
2961 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2962 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
2964 if (s->monitor_source)
2965 pa_source_set_max_rewind_within_thread(s->monitor_source, s->thread_info.max_rewind);
2968 /* Called from main thread */
2969 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind) {
2970 pa_sink_assert_ref(s);
2971 pa_assert_ctl_context();
2973 if (PA_SINK_IS_LINKED(s->state))
2974 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MAX_REWIND, NULL, max_rewind, NULL) == 0);
2976 pa_sink_set_max_rewind_within_thread(s, max_rewind);
2979 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
2980 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request) {
2983 pa_sink_assert_ref(s);
2984 pa_sink_assert_io_context(s);
2986 if (max_request == s->thread_info.max_request)
2989 s->thread_info.max_request = max_request;
2991 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
2994 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2995 pa_sink_input_update_max_request(i, s->thread_info.max_request);
2999 /* Called from main thread */
3000 void pa_sink_set_max_request(pa_sink *s, size_t max_request) {
3001 pa_sink_assert_ref(s);
3002 pa_assert_ctl_context();
3004 if (PA_SINK_IS_LINKED(s->state))
3005 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MAX_REQUEST, NULL, max_request, NULL) == 0);
3007 pa_sink_set_max_request_within_thread(s, max_request);
3010 /* Called from IO thread */
3011 void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic) {
3015 pa_sink_assert_ref(s);
3016 pa_sink_assert_io_context(s);
3018 if ((s->flags & PA_SINK_DYNAMIC_LATENCY))
3019 s->thread_info.requested_latency_valid = FALSE;
3023 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3025 if (s->update_requested_latency)
3026 s->update_requested_latency(s);
3028 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3029 if (i->update_sink_requested_latency)
3030 i->update_sink_requested_latency(i);
3034 /* Called from main thread */
3035 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
3036 pa_sink_assert_ref(s);
3037 pa_assert_ctl_context();
3039 /* min_latency == 0: no limit
3040 * min_latency anything else: specified limit
3042 * Similar for max_latency */
3044 if (min_latency < ABSOLUTE_MIN_LATENCY)
3045 min_latency = ABSOLUTE_MIN_LATENCY;
3047 if (max_latency <= 0 ||
3048 max_latency > ABSOLUTE_MAX_LATENCY)
3049 max_latency = ABSOLUTE_MAX_LATENCY;
3051 pa_assert(min_latency <= max_latency);
3053 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3054 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
3055 max_latency == ABSOLUTE_MAX_LATENCY) ||
3056 (s->flags & PA_SINK_DYNAMIC_LATENCY));
3058 if (PA_SINK_IS_LINKED(s->state)) {
3064 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
3066 pa_sink_set_latency_range_within_thread(s, min_latency, max_latency);
3069 /* Called from main thread */
3070 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
3071 pa_sink_assert_ref(s);
3072 pa_assert_ctl_context();
3073 pa_assert(min_latency);
3074 pa_assert(max_latency);
3076 if (PA_SINK_IS_LINKED(s->state)) {
3077 pa_usec_t r[2] = { 0, 0 };
3079 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
3081 *min_latency = r[0];
3082 *max_latency = r[1];
3084 *min_latency = s->thread_info.min_latency;
3085 *max_latency = s->thread_info.max_latency;
3089 /* Called from IO thread */
3090 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
3091 pa_sink_assert_ref(s);
3092 pa_sink_assert_io_context(s);
3094 pa_assert(min_latency >= ABSOLUTE_MIN_LATENCY);
3095 pa_assert(max_latency <= ABSOLUTE_MAX_LATENCY);
3096 pa_assert(min_latency <= max_latency);
3098 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3099 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
3100 max_latency == ABSOLUTE_MAX_LATENCY) ||
3101 (s->flags & PA_SINK_DYNAMIC_LATENCY));
3103 if (s->thread_info.min_latency == min_latency &&
3104 s->thread_info.max_latency == max_latency)
3107 s->thread_info.min_latency = min_latency;
3108 s->thread_info.max_latency = max_latency;
3110 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3114 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3115 if (i->update_sink_latency_range)
3116 i->update_sink_latency_range(i);
3119 pa_sink_invalidate_requested_latency(s, FALSE);
3121 pa_source_set_latency_range_within_thread(s->monitor_source, min_latency, max_latency);
3124 /* Called from main thread */
3125 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency) {
3126 pa_sink_assert_ref(s);
3127 pa_assert_ctl_context();
3129 if (s->flags & PA_SINK_DYNAMIC_LATENCY) {
3130 pa_assert(latency == 0);
3134 if (latency < ABSOLUTE_MIN_LATENCY)
3135 latency = ABSOLUTE_MIN_LATENCY;
3137 if (latency > ABSOLUTE_MAX_LATENCY)
3138 latency = ABSOLUTE_MAX_LATENCY;
3140 if (PA_SINK_IS_LINKED(s->state))
3141 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_FIXED_LATENCY, NULL, (int64_t) latency, NULL) == 0);
3143 s->thread_info.fixed_latency = latency;
3145 pa_source_set_fixed_latency(s->monitor_source, latency);
3148 /* Called from main thread */
3149 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s) {
3152 pa_sink_assert_ref(s);
3153 pa_assert_ctl_context();
3155 if (s->flags & PA_SINK_DYNAMIC_LATENCY)
3158 if (PA_SINK_IS_LINKED(s->state))
3159 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_FIXED_LATENCY, &latency, 0, NULL) == 0);
3161 latency = s->thread_info.fixed_latency;
3166 /* Called from IO thread */
3167 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency) {
3168 pa_sink_assert_ref(s);
3169 pa_sink_assert_io_context(s);
3171 if (s->flags & PA_SINK_DYNAMIC_LATENCY) {
3172 pa_assert(latency == 0);
3176 pa_assert(latency >= ABSOLUTE_MIN_LATENCY);
3177 pa_assert(latency <= ABSOLUTE_MAX_LATENCY);
3179 if (s->thread_info.fixed_latency == latency)
3182 s->thread_info.fixed_latency = latency;
3184 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3188 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3189 if (i->update_sink_fixed_latency)
3190 i->update_sink_fixed_latency(i);
3193 pa_sink_invalidate_requested_latency(s, FALSE);
3195 pa_source_set_fixed_latency_within_thread(s->monitor_source, latency);
3198 /* Called from main context */
3199 size_t pa_sink_get_max_rewind(pa_sink *s) {
3201 pa_assert_ctl_context();
3202 pa_sink_assert_ref(s);
3204 if (!PA_SINK_IS_LINKED(s->state))
3205 return s->thread_info.max_rewind;
3207 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
3212 /* Called from main context */
3213 size_t pa_sink_get_max_request(pa_sink *s) {
3215 pa_sink_assert_ref(s);
3216 pa_assert_ctl_context();
3218 if (!PA_SINK_IS_LINKED(s->state))
3219 return s->thread_info.max_request;
3221 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REQUEST, &r, 0, NULL) == 0);
3226 /* Called from main context */
3227 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save) {
3228 pa_device_port *port;
3231 pa_sink_assert_ref(s);
3232 pa_assert_ctl_context();
3235 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s->index, s->name);
3236 return -PA_ERR_NOTIMPLEMENTED;
3239 if (!s->ports || !name)
3240 return -PA_ERR_NOENTITY;
3242 if (!(port = pa_hashmap_get(s->ports, name)))
3243 return -PA_ERR_NOENTITY;
3245 if (s->active_port == port) {
3246 s->save_port = s->save_port || save;
3250 if (s->flags & PA_SINK_DEFERRED_VOLUME) {
3251 struct sink_message_set_port msg = { .port = port, .ret = 0 };
3252 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
3256 ret = s->set_port(s, port);
3259 return -PA_ERR_NOENTITY;
3261 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
3263 pa_log_info("Changed port of sink %u \"%s\" to %s", s->index, s->name, port->name);
3265 s->active_port = port;
3266 s->save_port = save;
3268 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PORT_CHANGED], s);
3273 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink) {
3274 const char *ff, *c, *t = NULL, *s = "", *profile, *bus;
3278 if (pa_proplist_contains(p, PA_PROP_DEVICE_ICON_NAME))
3281 if ((ff = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) {
3283 if (pa_streq(ff, "microphone"))
3284 t = "audio-input-microphone";
3285 else if (pa_streq(ff, "webcam"))
3287 else if (pa_streq(ff, "computer"))
3289 else if (pa_streq(ff, "handset"))
3291 else if (pa_streq(ff, "portable"))
3292 t = "multimedia-player";
3293 else if (pa_streq(ff, "tv"))
3294 t = "video-display";
3297 * The following icons are not part of the icon naming spec,
3298 * because Rodney Dawes sucks as the maintainer of that spec.
3300 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3302 else if (pa_streq(ff, "headset"))
3303 t = "audio-headset";
3304 else if (pa_streq(ff, "headphone"))
3305 t = "audio-headphones";
3306 else if (pa_streq(ff, "speaker"))
3307 t = "audio-speakers";
3308 else if (pa_streq(ff, "hands-free"))
3309 t = "audio-handsfree";
3313 if ((c = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS)))
3314 if (pa_streq(c, "modem"))
3321 t = "audio-input-microphone";
3324 if ((profile = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_NAME))) {
3325 if (strstr(profile, "analog"))
3327 else if (strstr(profile, "iec958"))
3329 else if (strstr(profile, "hdmi"))
3333 bus = pa_proplist_gets(p, PA_PROP_DEVICE_BUS);
3335 pa_proplist_setf(p, PA_PROP_DEVICE_ICON_NAME, "%s%s%s%s", t, pa_strempty(s), bus ? "-" : "", pa_strempty(bus));
3340 pa_bool_t pa_device_init_description(pa_proplist *p) {
3341 const char *s, *d = NULL, *k;
3344 if (pa_proplist_contains(p, PA_PROP_DEVICE_DESCRIPTION))
3347 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR)))
3348 if (pa_streq(s, "internal"))
3349 d = _("Built-in Audio");
3352 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS)))
3353 if (pa_streq(s, "modem"))
3357 d = pa_proplist_gets(p, PA_PROP_DEVICE_PRODUCT_NAME);
3362 k = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_DESCRIPTION);
3365 pa_proplist_setf(p, PA_PROP_DEVICE_DESCRIPTION, "%s %s", d, k);
3367 pa_proplist_sets(p, PA_PROP_DEVICE_DESCRIPTION, d);
3372 pa_bool_t pa_device_init_intended_roles(pa_proplist *p) {
3376 if (pa_proplist_contains(p, PA_PROP_DEVICE_INTENDED_ROLES))
3379 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR)))
3380 if (pa_streq(s, "handset") || pa_streq(s, "hands-free")
3381 || pa_streq(s, "headset")) {
3382 pa_proplist_sets(p, PA_PROP_DEVICE_INTENDED_ROLES, "phone");
3389 unsigned pa_device_init_priority(pa_proplist *p) {
3391 unsigned priority = 0;
3395 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS))) {
3397 if (pa_streq(s, "sound"))
3399 else if (!pa_streq(s, "modem"))
3403 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) {
3405 if (pa_streq(s, "internal"))
3407 else if (pa_streq(s, "speaker"))
3409 else if (pa_streq(s, "headphone"))
3413 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_BUS))) {
3415 if (pa_streq(s, "pci"))
3417 else if (pa_streq(s, "usb"))
3419 else if (pa_streq(s, "bluetooth"))
3423 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_NAME))) {
3425 if (pa_startswith(s, "analog-"))
3427 else if (pa_startswith(s, "iec958-"))
3434 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change, 0, pa_xfree);
3436 /* Called from the IO thread. */
3437 static pa_sink_volume_change *pa_sink_volume_change_new(pa_sink *s) {
3438 pa_sink_volume_change *c;
3439 if (!(c = pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change))))
3440 c = pa_xnew(pa_sink_volume_change, 1);
3442 PA_LLIST_INIT(pa_sink_volume_change, c);
3444 pa_cvolume_reset(&c->hw_volume, s->sample_spec.channels);
3448 /* Called from the IO thread. */
3449 static void pa_sink_volume_change_free(pa_sink_volume_change *c) {
3451 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change), c) < 0)
3455 /* Called from the IO thread. */
3456 void pa_sink_volume_change_push(pa_sink *s) {
3457 pa_sink_volume_change *c = NULL;
3458 pa_sink_volume_change *nc = NULL;
3459 uint32_t safety_margin = s->thread_info.volume_change_safety_margin;
3461 const char *direction = NULL;
3464 nc = pa_sink_volume_change_new(s);
3466 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3467 * Adding one more volume for HW would get us rid of this, but I am trying
3468 * to survive with the ones we already have. */
3469 pa_sw_cvolume_divide(&nc->hw_volume, &s->real_volume, &s->soft_volume);
3471 if (!s->thread_info.volume_changes && pa_cvolume_equal(&nc->hw_volume, &s->thread_info.current_hw_volume)) {
3472 pa_log_debug("Volume not changing");
3473 pa_sink_volume_change_free(nc);
3477 nc->at = pa_sink_get_latency_within_thread(s);
3478 nc->at += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
3480 if (s->thread_info.volume_changes_tail) {
3481 for (c = s->thread_info.volume_changes_tail; c; c = c->prev) {
3482 /* If volume is going up let's do it a bit late. If it is going
3483 * down let's do it a bit early. */
3484 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&c->hw_volume)) {
3485 if (nc->at + safety_margin > c->at) {
3486 nc->at += safety_margin;
3491 else if (nc->at - safety_margin > c->at) {
3492 nc->at -= safety_margin;
3500 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&s->thread_info.current_hw_volume)) {
3501 nc->at += safety_margin;
3504 nc->at -= safety_margin;
3507 PA_LLIST_PREPEND(pa_sink_volume_change, s->thread_info.volume_changes, nc);
3510 PA_LLIST_INSERT_AFTER(pa_sink_volume_change, s->thread_info.volume_changes, c, nc);
3513 pa_log_debug("Volume going %s to %d at %llu", direction, pa_cvolume_avg(&nc->hw_volume), (long long unsigned) nc->at);
3515 /* We can ignore volume events that came earlier but should happen later than this. */
3516 PA_LLIST_FOREACH(c, nc->next) {
3517 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at);
3518 pa_sink_volume_change_free(c);
3521 s->thread_info.volume_changes_tail = nc;
3524 /* Called from the IO thread. */
3525 static void pa_sink_volume_change_flush(pa_sink *s) {
3526 pa_sink_volume_change *c = s->thread_info.volume_changes;
3528 s->thread_info.volume_changes = NULL;
3529 s->thread_info.volume_changes_tail = NULL;
3531 pa_sink_volume_change *next = c->next;
3532 pa_sink_volume_change_free(c);
3537 /* Called from the IO thread. */
3538 pa_bool_t pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next) {
3540 pa_bool_t ret = FALSE;
3544 if (!s->thread_info.volume_changes || !PA_SINK_IS_LINKED(s->state)) {
3550 pa_assert(s->write_volume);
3552 now = pa_rtclock_now();
3554 while (s->thread_info.volume_changes && now >= s->thread_info.volume_changes->at) {
3555 pa_sink_volume_change *c = s->thread_info.volume_changes;
3556 PA_LLIST_REMOVE(pa_sink_volume_change, s->thread_info.volume_changes, c);
3557 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3558 pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at, (long long unsigned) (now - c->at));
3560 s->thread_info.current_hw_volume = c->hw_volume;
3561 pa_sink_volume_change_free(c);
3567 if (s->thread_info.volume_changes) {
3569 *usec_to_next = s->thread_info.volume_changes->at - now;
3570 if (pa_log_ratelimit(PA_LOG_DEBUG))
3571 pa_log_debug("Next volume change in %lld usec", (long long) (s->thread_info.volume_changes->at - now));
3576 s->thread_info.volume_changes_tail = NULL;
3581 /* Called from the IO thread. */
3582 static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes) {
3583 /* All the queued volume events later than current latency are shifted to happen earlier. */
3584 pa_sink_volume_change *c;
3585 pa_volume_t prev_vol = pa_cvolume_avg(&s->thread_info.current_hw_volume);
3586 pa_usec_t rewound = pa_bytes_to_usec(nbytes, &s->sample_spec);
3587 pa_usec_t limit = pa_sink_get_latency_within_thread(s);
3589 pa_log_debug("latency = %lld", (long long) limit);
3590 limit += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
3592 PA_LLIST_FOREACH(c, s->thread_info.volume_changes) {
3593 pa_usec_t modified_limit = limit;
3594 if (prev_vol > pa_cvolume_avg(&c->hw_volume))
3595 modified_limit -= s->thread_info.volume_change_safety_margin;
3597 modified_limit += s->thread_info.volume_change_safety_margin;
3598 if (c->at > modified_limit) {
3600 if (c->at < modified_limit)
3601 c->at = modified_limit;
3603 prev_vol = pa_cvolume_avg(&c->hw_volume);
3605 pa_sink_volume_change_apply(s, NULL);
3608 /* Called from the main thread */
3609 /* Gets the list of formats supported by the sink. The members and idxset must
3610 * be freed by the caller. */
3611 pa_idxset* pa_sink_get_formats(pa_sink *s) {
3616 if (s->get_formats) {
3617 /* Sink supports format query, all is good */
3618 ret = s->get_formats(s);
3620 /* Sink doesn't support format query, so assume it does PCM */
3621 pa_format_info *f = pa_format_info_new();
3622 f->encoding = PA_ENCODING_PCM;
3624 ret = pa_idxset_new(NULL, NULL);
3625 pa_idxset_put(ret, f, NULL);
3631 /* Called from the main thread */
3632 /* Allows an external source to set what formats a sink supports if the sink
3633 * permits this. The function makes a copy of the formats on success. */
3634 pa_bool_t pa_sink_set_formats(pa_sink *s, pa_idxset *formats) {
3639 /* Sink supports setting formats -- let's give it a shot */
3640 return s->set_formats(s, formats);
3642 /* Sink doesn't support setting this -- bail out */
3646 /* Called from the main thread */
3647 /* Checks if the sink can accept this format */
3648 pa_bool_t pa_sink_check_format(pa_sink *s, pa_format_info *f)
3650 pa_idxset *formats = NULL;
3651 pa_bool_t ret = FALSE;
3656 formats = pa_sink_get_formats(s);
3659 pa_format_info *finfo_device;
3662 PA_IDXSET_FOREACH(finfo_device, formats, i) {
3663 if (pa_format_info_is_compatible(finfo_device, f)) {
3669 pa_idxset_free(formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
3675 /* Called from the main thread */
3676 /* Calculates the intersection between formats supported by the sink and
3677 * in_formats, and returns these, in the order of the sink's formats. */
3678 pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats) {
3679 pa_idxset *out_formats = pa_idxset_new(NULL, NULL), *sink_formats = NULL;
3680 pa_format_info *f_sink, *f_in;
3685 if (!in_formats || pa_idxset_isempty(in_formats))
3688 sink_formats = pa_sink_get_formats(s);
3690 PA_IDXSET_FOREACH(f_sink, sink_formats, i) {
3691 PA_IDXSET_FOREACH(f_in, in_formats, j) {
3692 if (pa_format_info_is_compatible(f_sink, f_in))
3693 pa_idxset_put(out_formats, pa_format_info_copy(f_in), NULL);
3699 pa_idxset_free(sink_formats, (pa_free2_cb_t) pa_format_info_free2, NULL);