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, see <http://www.gnu.org/licenses/>.
29 #include <pulse/introspect.h>
30 #include <pulse/format.h>
31 #include <pulse/utf8.h>
32 #include <pulse/xmalloc.h>
33 #include <pulse/timeval.h>
34 #include <pulse/util.h>
35 #include <pulse/rtclock.h>
36 #include <pulse/internal.h>
38 #include <pulsecore/i18n.h>
39 #include <pulsecore/sink-input.h>
40 #include <pulsecore/namereg.h>
41 #include <pulsecore/core-util.h>
42 #include <pulsecore/sample-util.h>
43 #include <pulsecore/mix.h>
44 #include <pulsecore/core-subscribe.h>
45 #include <pulsecore/log.h>
46 #include <pulsecore/macro.h>
47 #include <pulsecore/play-memblockq.h>
48 #include <pulsecore/flist.h>
52 #define MAX_MIX_CHANNELS 32
53 #define MIX_BUFFER_LENGTH (PA_PAGE_SIZE)
54 #define ABSOLUTE_MIN_LATENCY (500)
55 #define ABSOLUTE_MAX_LATENCY (10*PA_USEC_PER_SEC)
56 #define DEFAULT_FIXED_LATENCY (250*PA_USEC_PER_MSEC)
58 PA_DEFINE_PUBLIC_CLASS(pa_sink, pa_msgobject);
60 struct pa_sink_volume_change {
64 PA_LLIST_FIELDS(pa_sink_volume_change);
67 struct sink_message_set_port {
72 static void sink_free(pa_object *s);
74 static void pa_sink_volume_change_push(pa_sink *s);
75 static void pa_sink_volume_change_flush(pa_sink *s);
76 static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes);
78 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data) {
82 data->proplist = pa_proplist_new();
83 data->ports = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL, (pa_free_cb_t) pa_device_port_unref);
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, bool mute) {
126 data->muted_is_set = true;
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_hashmap_free(data->ports);
145 pa_xfree(data->name);
146 pa_xfree(data->active_port);
149 /* Called from main context */
150 static void reset_callbacks(pa_sink *s) {
154 s->get_volume = NULL;
155 s->set_volume = NULL;
156 s->write_volume = NULL;
159 s->request_rewind = NULL;
160 s->update_requested_latency = NULL;
162 s->get_formats = NULL;
163 s->set_formats = NULL;
164 s->update_rate = NULL;
167 /* Called from main context */
168 pa_sink* pa_sink_new(
170 pa_sink_new_data *data,
171 pa_sink_flags_t flags) {
175 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
176 pa_source_new_data source_data;
182 pa_assert(data->name);
183 pa_assert_ctl_context();
185 s = pa_msgobject_new(pa_sink);
187 if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SINK, s, data->namereg_fail))) {
188 pa_log_debug("Failed to register name %s.", data->name);
193 pa_sink_new_data_set_name(data, name);
195 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_NEW], data) < 0) {
197 pa_namereg_unregister(core, name);
201 /* FIXME, need to free s here on failure */
203 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
204 pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
206 pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
208 if (!data->channel_map_is_set)
209 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
211 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
212 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
214 /* FIXME: There should probably be a general function for checking whether
215 * the sink volume is allowed to be set, like there is for sink inputs. */
216 pa_assert(!data->volume_is_set || !(flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
218 if (!data->volume_is_set) {
219 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
220 data->save_volume = false;
223 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
224 pa_return_null_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec));
226 if (!data->muted_is_set)
230 pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->card->proplist);
232 pa_device_init_description(data->proplist, data->card);
233 pa_device_init_icon(data->proplist, true);
234 pa_device_init_intended_roles(data->proplist);
236 if (!data->active_port) {
237 pa_device_port *p = pa_device_port_find_best(data->ports);
239 pa_sink_new_data_set_port(data, p->name);
242 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_FIXATE], data) < 0) {
244 pa_namereg_unregister(core, name);
248 s->parent.parent.free = sink_free;
249 s->parent.process_msg = pa_sink_process_msg;
252 s->state = PA_SINK_INIT;
255 s->suspend_cause = data->suspend_cause;
256 pa_sink_set_mixer_dirty(s, false);
257 s->name = pa_xstrdup(name);
258 s->proplist = pa_proplist_copy(data->proplist);
259 s->driver = pa_xstrdup(pa_path_get_filename(data->driver));
260 s->module = data->module;
261 s->card = data->card;
263 s->priority = pa_device_init_priority(s->proplist);
265 s->sample_spec = data->sample_spec;
266 s->channel_map = data->channel_map;
267 s->default_sample_rate = s->sample_spec.rate;
269 if (data->alternate_sample_rate_is_set)
270 s->alternate_sample_rate = data->alternate_sample_rate;
272 s->alternate_sample_rate = s->core->alternate_sample_rate;
274 if (s->sample_spec.rate == s->alternate_sample_rate) {
275 pa_log_warn("Default and alternate sample rates are the same.");
276 s->alternate_sample_rate = 0;
279 s->inputs = pa_idxset_new(NULL, NULL);
281 s->input_to_master = NULL;
283 s->reference_volume = s->real_volume = data->volume;
284 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
285 s->base_volume = PA_VOLUME_NORM;
286 s->n_volume_steps = PA_VOLUME_NORM+1;
287 s->muted = data->muted;
288 s->refresh_volume = s->refresh_muted = false;
295 /* As a minor optimization we just steal the list instead of
297 s->ports = data->ports;
300 s->active_port = NULL;
301 s->save_port = false;
303 if (data->active_port)
304 if ((s->active_port = pa_hashmap_get(s->ports, data->active_port)))
305 s->save_port = data->save_port;
307 /* Hopefully the active port has already been assigned in the previous call
308 to pa_device_port_find_best, but better safe than sorry */
310 s->active_port = pa_device_port_find_best(s->ports);
313 s->port_latency_offset = s->active_port->latency_offset;
315 s->port_latency_offset = 0;
317 s->save_volume = data->save_volume;
318 s->save_muted = data->save_muted;
320 pa_silence_memchunk_get(
321 &core->silence_cache,
327 s->thread_info.rtpoll = NULL;
328 s->thread_info.inputs = pa_hashmap_new_full(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func, NULL,
329 (pa_free_cb_t) pa_sink_input_unref);
330 s->thread_info.soft_volume = s->soft_volume;
331 s->thread_info.soft_muted = s->muted;
332 s->thread_info.state = s->state;
333 s->thread_info.rewind_nbytes = 0;
334 s->thread_info.rewind_requested = false;
335 s->thread_info.max_rewind = 0;
336 s->thread_info.max_request = 0;
337 s->thread_info.requested_latency_valid = false;
338 s->thread_info.requested_latency = 0;
339 s->thread_info.min_latency = ABSOLUTE_MIN_LATENCY;
340 s->thread_info.max_latency = ABSOLUTE_MAX_LATENCY;
341 s->thread_info.fixed_latency = flags & PA_SINK_DYNAMIC_LATENCY ? 0 : DEFAULT_FIXED_LATENCY;
343 PA_LLIST_HEAD_INIT(pa_sink_volume_change, s->thread_info.volume_changes);
344 s->thread_info.volume_changes_tail = NULL;
345 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
346 s->thread_info.volume_change_safety_margin = core->deferred_volume_safety_margin_usec;
347 s->thread_info.volume_change_extra_delay = core->deferred_volume_extra_delay_usec;
348 s->thread_info.port_latency_offset = s->port_latency_offset;
350 /* FIXME: This should probably be moved to pa_sink_put() */
351 pa_assert_se(pa_idxset_put(core->sinks, s, &s->index) >= 0);
354 pa_assert_se(pa_idxset_put(s->card->sinks, s, NULL) >= 0);
356 pt = pa_proplist_to_string_sep(s->proplist, "\n ");
357 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n %s",
360 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
361 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map),
365 pa_source_new_data_init(&source_data);
366 pa_source_new_data_set_sample_spec(&source_data, &s->sample_spec);
367 pa_source_new_data_set_channel_map(&source_data, &s->channel_map);
368 pa_source_new_data_set_alternate_sample_rate(&source_data, s->alternate_sample_rate);
369 source_data.name = pa_sprintf_malloc("%s.monitor", name);
370 source_data.driver = data->driver;
371 source_data.module = data->module;
372 source_data.card = data->card;
374 dn = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
375 pa_proplist_setf(source_data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Monitor of %s", dn ? dn : s->name);
376 pa_proplist_sets(source_data.proplist, PA_PROP_DEVICE_CLASS, "monitor");
378 s->monitor_source = pa_source_new(core, &source_data,
379 ((flags & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
380 ((flags & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0));
382 pa_source_new_data_done(&source_data);
384 if (!s->monitor_source) {
390 s->monitor_source->monitor_of = s;
392 pa_source_set_latency_range(s->monitor_source, s->thread_info.min_latency, s->thread_info.max_latency);
393 pa_source_set_fixed_latency(s->monitor_source, s->thread_info.fixed_latency);
394 pa_source_set_max_rewind(s->monitor_source, s->thread_info.max_rewind);
399 /* Called from main context */
400 static int sink_set_state(pa_sink *s, pa_sink_state_t state) {
403 pa_sink_state_t original_state;
406 pa_assert_ctl_context();
408 if (s->state == state)
411 original_state = s->state;
414 (original_state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(state)) ||
415 (PA_SINK_IS_OPENED(original_state) && state == PA_SINK_SUSPENDED);
418 if ((ret = s->set_state(s, state)) < 0)
422 if ((ret = pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL)) < 0) {
425 s->set_state(s, original_state);
432 if (state != PA_SINK_UNLINKED) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
433 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], s);
434 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
437 if (suspend_change) {
441 /* We're suspending or resuming, tell everyone about it */
443 PA_IDXSET_FOREACH(i, s->inputs, idx)
444 if (s->state == PA_SINK_SUSPENDED &&
445 (i->flags & PA_SINK_INPUT_KILL_ON_SUSPEND))
446 pa_sink_input_kill(i);
448 i->suspend(i, state == PA_SINK_SUSPENDED);
450 if (s->monitor_source)
451 pa_source_sync_suspend(s->monitor_source);
457 void pa_sink_set_get_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
463 void pa_sink_set_set_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
464 pa_sink_flags_t flags;
467 pa_assert(!s->write_volume || cb);
471 /* Save the current flags so we can tell if they've changed */
475 /* The sink implementor is responsible for setting decibel volume support */
476 s->flags |= PA_SINK_HW_VOLUME_CTRL;
478 s->flags &= ~PA_SINK_HW_VOLUME_CTRL;
479 /* See note below in pa_sink_put() about volume sharing and decibel volumes */
480 pa_sink_enable_decibel_volume(s, !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
483 /* If the flags have changed after init, let any clients know via a change event */
484 if (s->state != PA_SINK_INIT && flags != s->flags)
485 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
488 void pa_sink_set_write_volume_callback(pa_sink *s, pa_sink_cb_t cb) {
489 pa_sink_flags_t flags;
492 pa_assert(!cb || s->set_volume);
494 s->write_volume = cb;
496 /* Save the current flags so we can tell if they've changed */
500 s->flags |= PA_SINK_DEFERRED_VOLUME;
502 s->flags &= ~PA_SINK_DEFERRED_VOLUME;
504 /* If the flags have changed after init, let any clients know via a change event */
505 if (s->state != PA_SINK_INIT && flags != s->flags)
506 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
509 void pa_sink_set_get_mute_callback(pa_sink *s, pa_sink_get_mute_cb_t cb) {
515 void pa_sink_set_set_mute_callback(pa_sink *s, pa_sink_cb_t cb) {
516 pa_sink_flags_t flags;
522 /* Save the current flags so we can tell if they've changed */
526 s->flags |= PA_SINK_HW_MUTE_CTRL;
528 s->flags &= ~PA_SINK_HW_MUTE_CTRL;
530 /* If the flags have changed after init, let any clients know via a change event */
531 if (s->state != PA_SINK_INIT && flags != s->flags)
532 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
535 static void enable_flat_volume(pa_sink *s, bool enable) {
536 pa_sink_flags_t flags;
540 /* Always follow the overall user preference here */
541 enable = enable && s->core->flat_volumes;
543 /* Save the current flags so we can tell if they've changed */
547 s->flags |= PA_SINK_FLAT_VOLUME;
549 s->flags &= ~PA_SINK_FLAT_VOLUME;
551 /* If the flags have changed after init, let any clients know via a change event */
552 if (s->state != PA_SINK_INIT && flags != s->flags)
553 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
556 void pa_sink_enable_decibel_volume(pa_sink *s, bool enable) {
557 pa_sink_flags_t flags;
561 /* Save the current flags so we can tell if they've changed */
565 s->flags |= PA_SINK_DECIBEL_VOLUME;
566 enable_flat_volume(s, true);
568 s->flags &= ~PA_SINK_DECIBEL_VOLUME;
569 enable_flat_volume(s, false);
572 /* If the flags have changed after init, let any clients know via a change event */
573 if (s->state != PA_SINK_INIT && flags != s->flags)
574 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
577 /* Called from main context */
578 void pa_sink_put(pa_sink* s) {
579 pa_sink_assert_ref(s);
580 pa_assert_ctl_context();
582 pa_assert(s->state == PA_SINK_INIT);
583 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || pa_sink_is_filter(s));
585 /* The following fields must be initialized properly when calling _put() */
586 pa_assert(s->asyncmsgq);
587 pa_assert(s->thread_info.min_latency <= s->thread_info.max_latency);
589 /* Generally, flags should be initialized via pa_sink_new(). As a
590 * special exception we allow some volume related flags to be set
591 * between _new() and _put() by the callback setter functions above.
593 * Thus we implement a couple safeguards here which ensure the above
594 * setters were used (or at least the implementor made manual changes
595 * in a compatible way).
597 * Note: All of these flags set here can change over the life time
599 pa_assert(!(s->flags & PA_SINK_HW_VOLUME_CTRL) || s->set_volume);
600 pa_assert(!(s->flags & PA_SINK_DEFERRED_VOLUME) || s->write_volume);
601 pa_assert(!(s->flags & PA_SINK_HW_MUTE_CTRL) || s->set_mute);
603 /* XXX: Currently decibel volume is disabled for all sinks that use volume
604 * sharing. When the master sink supports decibel volume, it would be good
605 * to have the flag also in the filter sink, but currently we don't do that
606 * so that the flags of the filter sink never change when it's moved from
607 * a master sink to another. One solution for this problem would be to
608 * remove user-visible volume altogether from filter sinks when volume
609 * sharing is used, but the current approach was easier to implement... */
610 /* We always support decibel volumes in software, otherwise we leave it to
611 * the sink implementor to set this flag as needed.
613 * Note: This flag can also change over the life time of the sink. */
614 if (!(s->flags & PA_SINK_HW_VOLUME_CTRL) && !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
615 pa_sink_enable_decibel_volume(s, true);
616 s->soft_volume = s->reference_volume;
619 /* If the sink implementor support DB volumes by itself, we should always
620 * try and enable flat volumes too */
621 if ((s->flags & PA_SINK_DECIBEL_VOLUME))
622 enable_flat_volume(s, true);
624 if (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) {
625 pa_sink *root_sink = pa_sink_get_master(s);
627 pa_assert(root_sink);
629 s->reference_volume = root_sink->reference_volume;
630 pa_cvolume_remap(&s->reference_volume, &root_sink->channel_map, &s->channel_map);
632 s->real_volume = root_sink->real_volume;
633 pa_cvolume_remap(&s->real_volume, &root_sink->channel_map, &s->channel_map);
635 /* We assume that if the sink implementor changed the default
636 * volume he did so in real_volume, because that is the usual
637 * place where he is supposed to place his changes. */
638 s->reference_volume = s->real_volume;
640 s->thread_info.soft_volume = s->soft_volume;
641 s->thread_info.soft_muted = s->muted;
642 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
644 pa_assert((s->flags & PA_SINK_HW_VOLUME_CTRL)
645 || (s->base_volume == PA_VOLUME_NORM
646 && ((s->flags & PA_SINK_DECIBEL_VOLUME || (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)))));
647 pa_assert(!(s->flags & PA_SINK_DECIBEL_VOLUME) || s->n_volume_steps == PA_VOLUME_NORM+1);
648 pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == !(s->thread_info.fixed_latency == 0));
649 pa_assert(!(s->flags & PA_SINK_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_LATENCY));
650 pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_DYNAMIC_LATENCY));
652 pa_assert(s->monitor_source->thread_info.fixed_latency == s->thread_info.fixed_latency);
653 pa_assert(s->monitor_source->thread_info.min_latency == s->thread_info.min_latency);
654 pa_assert(s->monitor_source->thread_info.max_latency == s->thread_info.max_latency);
656 if (s->suspend_cause)
657 pa_assert_se(sink_set_state(s, PA_SINK_SUSPENDED) == 0);
659 pa_assert_se(sink_set_state(s, PA_SINK_IDLE) == 0);
661 pa_source_put(s->monitor_source);
663 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_NEW, s->index);
664 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PUT], s);
667 /* Called from main context */
668 void pa_sink_unlink(pa_sink* s) {
670 pa_sink_input *i, PA_UNUSED *j = NULL;
672 pa_sink_assert_ref(s);
673 pa_assert_ctl_context();
675 /* Please note that pa_sink_unlink() does more than simply
676 * reversing pa_sink_put(). It also undoes the registrations
677 * already done in pa_sink_new()! */
679 if (s->unlink_requested)
682 s->unlink_requested = true;
684 linked = PA_SINK_IS_LINKED(s->state);
687 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK], s);
689 if (s->state != PA_SINK_UNLINKED)
690 pa_namereg_unregister(s->core, s->name);
691 pa_idxset_remove_by_data(s->core->sinks, s, NULL);
694 pa_idxset_remove_by_data(s->card->sinks, s, NULL);
696 while ((i = pa_idxset_first(s->inputs, NULL))) {
698 pa_sink_input_kill(i);
703 sink_set_state(s, PA_SINK_UNLINKED);
705 s->state = PA_SINK_UNLINKED;
709 if (s->monitor_source)
710 pa_source_unlink(s->monitor_source);
713 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
714 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK_POST], s);
718 /* Called from main context */
719 static void sink_free(pa_object *o) {
720 pa_sink *s = PA_SINK(o);
723 pa_assert_ctl_context();
724 pa_assert(pa_sink_refcnt(s) == 0);
725 pa_assert(!PA_SINK_IS_LINKED(s->state));
727 pa_log_info("Freeing sink %u \"%s\"", s->index, s->name);
729 pa_sink_volume_change_flush(s);
731 if (s->monitor_source) {
732 pa_source_unref(s->monitor_source);
733 s->monitor_source = NULL;
736 pa_idxset_free(s->inputs, NULL);
737 pa_hashmap_free(s->thread_info.inputs);
739 if (s->silence.memblock)
740 pa_memblock_unref(s->silence.memblock);
746 pa_proplist_free(s->proplist);
749 pa_hashmap_free(s->ports);
754 /* Called from main context, and not while the IO thread is active, please */
755 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q) {
756 pa_sink_assert_ref(s);
757 pa_assert_ctl_context();
761 if (s->monitor_source)
762 pa_source_set_asyncmsgq(s->monitor_source, q);
765 /* Called from main context, and not while the IO thread is active, please */
766 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value) {
767 pa_sink_flags_t old_flags;
768 pa_sink_input *input;
771 pa_sink_assert_ref(s);
772 pa_assert_ctl_context();
774 /* For now, allow only a minimal set of flags to be changed. */
775 pa_assert((mask & ~(PA_SINK_DYNAMIC_LATENCY|PA_SINK_LATENCY)) == 0);
777 old_flags = s->flags;
778 s->flags = (s->flags & ~mask) | (value & mask);
780 if (s->flags == old_flags)
783 if ((s->flags & PA_SINK_LATENCY) != (old_flags & PA_SINK_LATENCY))
784 pa_log_debug("Sink %s: LATENCY flag %s.", s->name, (s->flags & PA_SINK_LATENCY) ? "enabled" : "disabled");
786 if ((s->flags & PA_SINK_DYNAMIC_LATENCY) != (old_flags & PA_SINK_DYNAMIC_LATENCY))
787 pa_log_debug("Sink %s: DYNAMIC_LATENCY flag %s.",
788 s->name, (s->flags & PA_SINK_DYNAMIC_LATENCY) ? "enabled" : "disabled");
790 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
791 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_FLAGS_CHANGED], s);
793 if (s->monitor_source)
794 pa_source_update_flags(s->monitor_source,
795 ((mask & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
796 ((mask & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0),
797 ((value & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) |
798 ((value & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0));
800 PA_IDXSET_FOREACH(input, s->inputs, idx) {
801 if (input->origin_sink)
802 pa_sink_update_flags(input->origin_sink, mask, value);
806 /* Called from IO context, or before _put() from main context */
807 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p) {
808 pa_sink_assert_ref(s);
809 pa_sink_assert_io_context(s);
811 s->thread_info.rtpoll = p;
813 if (s->monitor_source)
814 pa_source_set_rtpoll(s->monitor_source, p);
817 /* Called from main context */
818 int pa_sink_update_status(pa_sink*s) {
819 pa_sink_assert_ref(s);
820 pa_assert_ctl_context();
821 pa_assert(PA_SINK_IS_LINKED(s->state));
823 if (s->state == PA_SINK_SUSPENDED)
826 return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
829 /* Called from any context - must be threadsafe */
830 void pa_sink_set_mixer_dirty(pa_sink *s, bool is_dirty) {
831 pa_atomic_store(&s->mixer_dirty, is_dirty ? 1 : 0);
834 /* Called from main context */
835 int pa_sink_suspend(pa_sink *s, bool suspend, pa_suspend_cause_t cause) {
836 pa_sink_assert_ref(s);
837 pa_assert_ctl_context();
838 pa_assert(PA_SINK_IS_LINKED(s->state));
839 pa_assert(cause != 0);
842 s->suspend_cause |= cause;
843 s->monitor_source->suspend_cause |= cause;
845 s->suspend_cause &= ~cause;
846 s->monitor_source->suspend_cause &= ~cause;
849 if (!(s->suspend_cause & PA_SUSPEND_SESSION) && (pa_atomic_load(&s->mixer_dirty) != 0)) {
850 /* This might look racy but isn't: If somebody sets mixer_dirty exactly here,
851 it'll be handled just fine. */
852 pa_sink_set_mixer_dirty(s, false);
853 pa_log_debug("Mixer is now accessible. Updating alsa mixer settings.");
854 if (s->active_port && s->set_port) {
855 if (s->flags & PA_SINK_DEFERRED_VOLUME) {
856 struct sink_message_set_port msg = { .port = s->active_port, .ret = 0 };
857 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
860 s->set_port(s, s->active_port);
870 if ((pa_sink_get_state(s) == PA_SINK_SUSPENDED) == !!s->suspend_cause)
873 pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s->name, s->suspend_cause, s->suspend_cause ? "suspending" : "resuming");
875 if (s->suspend_cause)
876 return sink_set_state(s, PA_SINK_SUSPENDED);
878 return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
881 /* Called from main context */
882 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q) {
883 pa_sink_input *i, *n;
886 pa_sink_assert_ref(s);
887 pa_assert_ctl_context();
888 pa_assert(PA_SINK_IS_LINKED(s->state));
893 for (i = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx)); i; i = n) {
894 n = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx));
896 pa_sink_input_ref(i);
898 if (pa_sink_input_start_move(i) >= 0)
901 pa_sink_input_unref(i);
907 /* Called from main context */
908 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, bool save) {
911 pa_sink_assert_ref(s);
912 pa_assert_ctl_context();
913 pa_assert(PA_SINK_IS_LINKED(s->state));
916 while ((i = PA_SINK_INPUT(pa_queue_pop(q)))) {
917 if (pa_sink_input_finish_move(i, s, save) < 0)
918 pa_sink_input_fail_move(i);
920 pa_sink_input_unref(i);
923 pa_queue_free(q, NULL);
926 /* Called from main context */
927 void pa_sink_move_all_fail(pa_queue *q) {
930 pa_assert_ctl_context();
933 while ((i = PA_SINK_INPUT(pa_queue_pop(q)))) {
934 pa_sink_input_fail_move(i);
935 pa_sink_input_unref(i);
938 pa_queue_free(q, NULL);
941 /* Called from IO thread context */
942 size_t pa_sink_process_input_underruns(pa_sink *s, size_t left_to_play) {
947 pa_sink_assert_ref(s);
948 pa_sink_assert_io_context(s);
950 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
951 size_t uf = i->thread_info.underrun_for_sink;
953 /* Propagate down the filter tree */
954 if (i->origin_sink) {
955 size_t filter_result, left_to_play_origin;
957 /* The recursive call works in the origin sink domain ... */
958 left_to_play_origin = pa_convert_size(left_to_play, &i->sink->sample_spec, &i->origin_sink->sample_spec);
960 /* .. and returns the time to sleep before waking up. We need the
961 * underrun duration for comparisons, so we undo the subtraction on
962 * the return value... */
963 filter_result = left_to_play_origin - pa_sink_process_input_underruns(i->origin_sink, left_to_play_origin);
965 /* ... and convert it back to the master sink domain */
966 filter_result = pa_convert_size(filter_result, &i->origin_sink->sample_spec, &i->sink->sample_spec);
968 /* Remember the longest underrun so far */
969 if (filter_result > result)
970 result = filter_result;
974 /* No underrun here, move on */
976 } else if (uf >= left_to_play) {
977 /* The sink has possibly consumed all the data the sink input provided */
978 pa_sink_input_process_underrun(i);
979 } else if (uf > result) {
980 /* Remember the longest underrun so far */
986 pa_log_debug("%s: Found underrun %ld bytes ago (%ld bytes ahead in playback buffer)", s->name,
987 (long) result, (long) left_to_play - result);
988 return left_to_play - result;
991 /* Called from IO thread context */
992 void pa_sink_process_rewind(pa_sink *s, size_t nbytes) {
996 pa_sink_assert_ref(s);
997 pa_sink_assert_io_context(s);
998 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1000 /* If nobody requested this and this is actually no real rewind
1001 * then we can short cut this. Please note that this means that
1002 * not all rewind requests triggered upstream will always be
1003 * translated in actual requests! */
1004 if (!s->thread_info.rewind_requested && nbytes <= 0)
1007 s->thread_info.rewind_nbytes = 0;
1008 s->thread_info.rewind_requested = false;
1011 pa_log_debug("Processing rewind...");
1012 if (s->flags & PA_SINK_DEFERRED_VOLUME)
1013 pa_sink_volume_change_rewind(s, nbytes);
1016 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
1017 pa_sink_input_assert_ref(i);
1018 pa_sink_input_process_rewind(i, nbytes);
1022 if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state))
1023 pa_source_process_rewind(s->monitor_source, nbytes);
1027 /* Called from IO thread context */
1028 static unsigned fill_mix_info(pa_sink *s, size_t *length, pa_mix_info *info, unsigned maxinfo) {
1032 size_t mixlength = *length;
1034 pa_sink_assert_ref(s);
1035 pa_sink_assert_io_context(s);
1038 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)) && maxinfo > 0) {
1039 pa_sink_input_assert_ref(i);
1041 pa_sink_input_peek(i, *length, &info->chunk, &info->volume);
1043 if (mixlength == 0 || info->chunk.length < mixlength)
1044 mixlength = info->chunk.length;
1046 if (pa_memblock_is_silence(info->chunk.memblock)) {
1047 pa_memblock_unref(info->chunk.memblock);
1051 info->userdata = pa_sink_input_ref(i);
1053 pa_assert(info->chunk.memblock);
1054 pa_assert(info->chunk.length > 0);
1062 *length = mixlength;
1067 /* Called from IO thread context */
1068 static void inputs_drop(pa_sink *s, pa_mix_info *info, unsigned n, pa_memchunk *result) {
1072 unsigned n_unreffed = 0;
1074 pa_sink_assert_ref(s);
1075 pa_sink_assert_io_context(s);
1077 pa_assert(result->memblock);
1078 pa_assert(result->length > 0);
1080 /* We optimize for the case where the order of the inputs has not changed */
1082 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
1084 pa_mix_info* m = NULL;
1086 pa_sink_input_assert_ref(i);
1088 /* Let's try to find the matching entry info the pa_mix_info array */
1089 for (j = 0; j < n; j ++) {
1091 if (info[p].userdata == i) {
1101 /* Drop read data */
1102 pa_sink_input_drop(i, result->length);
1104 if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state)) {
1106 if (pa_hashmap_size(i->thread_info.direct_outputs) > 0) {
1107 void *ostate = NULL;
1108 pa_source_output *o;
1111 if (m && m->chunk.memblock) {
1113 pa_memblock_ref(c.memblock);
1114 pa_assert(result->length <= c.length);
1115 c.length = result->length;
1117 pa_memchunk_make_writable(&c, 0);
1118 pa_volume_memchunk(&c, &s->sample_spec, &m->volume);
1121 pa_memblock_ref(c.memblock);
1122 pa_assert(result->length <= c.length);
1123 c.length = result->length;
1126 while ((o = pa_hashmap_iterate(i->thread_info.direct_outputs, &ostate, NULL))) {
1127 pa_source_output_assert_ref(o);
1128 pa_assert(o->direct_on_input == i);
1129 pa_source_post_direct(s->monitor_source, o, &c);
1132 pa_memblock_unref(c.memblock);
1137 if (m->chunk.memblock) {
1138 pa_memblock_unref(m->chunk.memblock);
1139 pa_memchunk_reset(&m->chunk);
1142 pa_sink_input_unref(m->userdata);
1149 /* Now drop references to entries that are included in the
1150 * pa_mix_info array but don't exist anymore */
1152 if (n_unreffed < n) {
1153 for (; n > 0; info++, n--) {
1155 pa_sink_input_unref(info->userdata);
1156 if (info->chunk.memblock)
1157 pa_memblock_unref(info->chunk.memblock);
1161 if (s->monitor_source && PA_SOURCE_IS_LINKED(s->monitor_source->thread_info.state))
1162 pa_source_post(s->monitor_source, result);
1165 /* Called from IO thread context */
1166 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result) {
1167 pa_mix_info info[MAX_MIX_CHANNELS];
1169 size_t block_size_max;
1171 pa_sink_assert_ref(s);
1172 pa_sink_assert_io_context(s);
1173 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1174 pa_assert(pa_frame_aligned(length, &s->sample_spec));
1177 pa_assert(!s->thread_info.rewind_requested);
1178 pa_assert(s->thread_info.rewind_nbytes == 0);
1180 if (s->thread_info.state == PA_SINK_SUSPENDED) {
1181 result->memblock = pa_memblock_ref(s->silence.memblock);
1182 result->index = s->silence.index;
1183 result->length = PA_MIN(s->silence.length, length);
1190 length = pa_frame_align(MIX_BUFFER_LENGTH, &s->sample_spec);
1192 block_size_max = pa_mempool_block_size_max(s->core->mempool);
1193 if (length > block_size_max)
1194 length = pa_frame_align(block_size_max, &s->sample_spec);
1196 pa_assert(length > 0);
1198 n = fill_mix_info(s, &length, info, MAX_MIX_CHANNELS);
1202 *result = s->silence;
1203 pa_memblock_ref(result->memblock);
1205 if (result->length > length)
1206 result->length = length;
1208 } else if (n == 1) {
1211 *result = info[0].chunk;
1212 pa_memblock_ref(result->memblock);
1214 if (result->length > length)
1215 result->length = length;
1217 pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
1219 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume)) {
1220 pa_memblock_unref(result->memblock);
1221 pa_silence_memchunk_get(&s->core->silence_cache,
1226 } else if (!pa_cvolume_is_norm(&volume)) {
1227 pa_memchunk_make_writable(result, 0);
1228 pa_volume_memchunk(result, &s->sample_spec, &volume);
1232 result->memblock = pa_memblock_new(s->core->mempool, length);
1234 ptr = pa_memblock_acquire(result->memblock);
1235 result->length = pa_mix(info, n,
1238 &s->thread_info.soft_volume,
1239 s->thread_info.soft_muted);
1240 pa_memblock_release(result->memblock);
1245 inputs_drop(s, info, n, result);
1250 /* Called from IO thread context */
1251 void pa_sink_render_into(pa_sink*s, pa_memchunk *target) {
1252 pa_mix_info info[MAX_MIX_CHANNELS];
1254 size_t length, block_size_max;
1256 pa_sink_assert_ref(s);
1257 pa_sink_assert_io_context(s);
1258 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1260 pa_assert(target->memblock);
1261 pa_assert(target->length > 0);
1262 pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
1264 pa_assert(!s->thread_info.rewind_requested);
1265 pa_assert(s->thread_info.rewind_nbytes == 0);
1267 if (s->thread_info.state == PA_SINK_SUSPENDED) {
1268 pa_silence_memchunk(target, &s->sample_spec);
1274 length = target->length;
1275 block_size_max = pa_mempool_block_size_max(s->core->mempool);
1276 if (length > block_size_max)
1277 length = pa_frame_align(block_size_max, &s->sample_spec);
1279 pa_assert(length > 0);
1281 n = fill_mix_info(s, &length, info, MAX_MIX_CHANNELS);
1284 if (target->length > length)
1285 target->length = length;
1287 pa_silence_memchunk(target, &s->sample_spec);
1288 } else if (n == 1) {
1291 if (target->length > length)
1292 target->length = length;
1294 pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
1296 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume))
1297 pa_silence_memchunk(target, &s->sample_spec);
1301 vchunk = info[0].chunk;
1302 pa_memblock_ref(vchunk.memblock);
1304 if (vchunk.length > length)
1305 vchunk.length = length;
1307 if (!pa_cvolume_is_norm(&volume)) {
1308 pa_memchunk_make_writable(&vchunk, 0);
1309 pa_volume_memchunk(&vchunk, &s->sample_spec, &volume);
1312 pa_memchunk_memcpy(target, &vchunk);
1313 pa_memblock_unref(vchunk.memblock);
1319 ptr = pa_memblock_acquire(target->memblock);
1321 target->length = pa_mix(info, n,
1322 (uint8_t*) ptr + target->index, length,
1324 &s->thread_info.soft_volume,
1325 s->thread_info.soft_muted);
1327 pa_memblock_release(target->memblock);
1330 inputs_drop(s, info, n, target);
1335 /* Called from IO thread context */
1336 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target) {
1340 pa_sink_assert_ref(s);
1341 pa_sink_assert_io_context(s);
1342 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1344 pa_assert(target->memblock);
1345 pa_assert(target->length > 0);
1346 pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
1348 pa_assert(!s->thread_info.rewind_requested);
1349 pa_assert(s->thread_info.rewind_nbytes == 0);
1351 if (s->thread_info.state == PA_SINK_SUSPENDED) {
1352 pa_silence_memchunk(target, &s->sample_spec);
1365 pa_sink_render_into(s, &chunk);
1374 /* Called from IO thread context */
1375 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result) {
1376 pa_sink_assert_ref(s);
1377 pa_sink_assert_io_context(s);
1378 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1379 pa_assert(length > 0);
1380 pa_assert(pa_frame_aligned(length, &s->sample_spec));
1383 pa_assert(!s->thread_info.rewind_requested);
1384 pa_assert(s->thread_info.rewind_nbytes == 0);
1388 pa_sink_render(s, length, result);
1390 if (result->length < length) {
1393 pa_memchunk_make_writable(result, length);
1395 chunk.memblock = result->memblock;
1396 chunk.index = result->index + result->length;
1397 chunk.length = length - result->length;
1399 pa_sink_render_into_full(s, &chunk);
1401 result->length = length;
1407 /* Called from main thread */
1408 int pa_sink_update_rate(pa_sink *s, uint32_t rate, bool passthrough) {
1410 uint32_t desired_rate = rate;
1411 uint32_t default_rate = s->default_sample_rate;
1412 uint32_t alternate_rate = s->alternate_sample_rate;
1415 bool default_rate_is_usable = false;
1416 bool alternate_rate_is_usable = false;
1418 if (rate == s->sample_spec.rate)
1421 if (!s->update_rate)
1424 if (PA_UNLIKELY(default_rate == alternate_rate && !passthrough)) {
1425 pa_log_debug("Default and alternate sample rates are the same, so there is no point in switching.");
1429 if (PA_SINK_IS_RUNNING(s->state)) {
1430 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1431 s->sample_spec.rate);
1435 if (s->monitor_source) {
1436 if (PA_SOURCE_IS_RUNNING(s->monitor_source->state) == true) {
1437 pa_log_info("Cannot update rate, monitor source is RUNNING");
1442 if (PA_UNLIKELY(!pa_sample_rate_valid(desired_rate)))
1445 if (!passthrough && default_rate != desired_rate && alternate_rate != desired_rate) {
1446 if (default_rate % 11025 == 0 && desired_rate % 11025 == 0)
1447 default_rate_is_usable = true;
1448 if (default_rate % 4000 == 0 && desired_rate % 4000 == 0)
1449 default_rate_is_usable = true;
1450 if (alternate_rate && alternate_rate % 11025 == 0 && desired_rate % 11025 == 0)
1451 alternate_rate_is_usable = true;
1452 if (alternate_rate && alternate_rate % 4000 == 0 && desired_rate % 4000 == 0)
1453 alternate_rate_is_usable = true;
1455 if (alternate_rate_is_usable && !default_rate_is_usable)
1456 desired_rate = alternate_rate;
1458 desired_rate = default_rate;
1461 if (desired_rate == s->sample_spec.rate)
1464 if (!passthrough && pa_sink_used_by(s) > 0)
1467 pa_log_debug("Suspending sink %s due to changing the sample rate.", s->name);
1468 pa_sink_suspend(s, true, PA_SUSPEND_INTERNAL);
1470 if (s->update_rate(s, desired_rate) >= 0) {
1471 /* update monitor source as well */
1472 if (s->monitor_source && !passthrough)
1473 pa_source_update_rate(s->monitor_source, desired_rate, false);
1474 pa_log_info("Changed sampling rate successfully");
1476 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1477 if (i->state == PA_SINK_INPUT_CORKED)
1478 pa_sink_input_update_rate(i);
1484 pa_sink_suspend(s, false, PA_SUSPEND_INTERNAL);
1489 /* Called from main thread */
1490 pa_usec_t pa_sink_get_latency(pa_sink *s) {
1493 pa_sink_assert_ref(s);
1494 pa_assert_ctl_context();
1495 pa_assert(PA_SINK_IS_LINKED(s->state));
1497 /* The returned value is supposed to be in the time domain of the sound card! */
1499 if (s->state == PA_SINK_SUSPENDED)
1502 if (!(s->flags & PA_SINK_LATENCY))
1505 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
1507 /* usec is unsigned, so check that the offset can be added to usec without
1509 if (-s->port_latency_offset <= (int64_t) usec)
1510 usec += s->port_latency_offset;
1517 /* Called from IO thread */
1518 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s) {
1522 pa_sink_assert_ref(s);
1523 pa_sink_assert_io_context(s);
1524 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1526 /* The returned value is supposed to be in the time domain of the sound card! */
1528 if (s->thread_info.state == PA_SINK_SUSPENDED)
1531 if (!(s->flags & PA_SINK_LATENCY))
1534 o = PA_MSGOBJECT(s);
1536 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1538 if (o->process_msg(o, PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
1541 /* usec is unsigned, so check that the offset can be added to usec without
1543 if (-s->thread_info.port_latency_offset <= (int64_t) usec)
1544 usec += s->thread_info.port_latency_offset;
1551 /* Called from the main thread (and also from the IO thread while the main
1552 * thread is waiting).
1554 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1555 * set. Instead, flat volume mode is detected by checking whether the root sink
1556 * has the flag set. */
1557 bool pa_sink_flat_volume_enabled(pa_sink *s) {
1558 pa_sink_assert_ref(s);
1560 s = pa_sink_get_master(s);
1563 return (s->flags & PA_SINK_FLAT_VOLUME);
1568 /* Called from the main thread (and also from the IO thread while the main
1569 * thread is waiting). */
1570 pa_sink *pa_sink_get_master(pa_sink *s) {
1571 pa_sink_assert_ref(s);
1573 while (s && (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1574 if (PA_UNLIKELY(!s->input_to_master))
1577 s = s->input_to_master->sink;
1583 /* Called from main context */
1584 bool pa_sink_is_filter(pa_sink *s) {
1585 pa_sink_assert_ref(s);
1587 return (s->input_to_master != NULL);
1590 /* Called from main context */
1591 bool pa_sink_is_passthrough(pa_sink *s) {
1592 pa_sink_input *alt_i;
1595 pa_sink_assert_ref(s);
1597 /* one and only one PASSTHROUGH input can possibly be connected */
1598 if (pa_idxset_size(s->inputs) == 1) {
1599 alt_i = pa_idxset_first(s->inputs, &idx);
1601 if (pa_sink_input_is_passthrough(alt_i))
1608 /* Called from main context */
1609 void pa_sink_enter_passthrough(pa_sink *s) {
1612 /* disable the monitor in passthrough mode */
1613 if (s->monitor_source) {
1614 pa_log_debug("Suspending monitor source %s, because the sink is entering the passthrough mode.", s->monitor_source->name);
1615 pa_source_suspend(s->monitor_source, true, PA_SUSPEND_PASSTHROUGH);
1618 /* set the volume to NORM */
1619 s->saved_volume = *pa_sink_get_volume(s, true);
1620 s->saved_save_volume = s->save_volume;
1622 pa_cvolume_set(&volume, s->sample_spec.channels, PA_MIN(s->base_volume, PA_VOLUME_NORM));
1623 pa_sink_set_volume(s, &volume, true, false);
1626 /* Called from main context */
1627 void pa_sink_leave_passthrough(pa_sink *s) {
1628 /* Unsuspend monitor */
1629 if (s->monitor_source) {
1630 pa_log_debug("Resuming monitor source %s, because the sink is leaving the passthrough mode.", s->monitor_source->name);
1631 pa_source_suspend(s->monitor_source, false, PA_SUSPEND_PASSTHROUGH);
1634 /* Restore sink volume to what it was before we entered passthrough mode */
1635 pa_sink_set_volume(s, &s->saved_volume, true, s->saved_save_volume);
1637 pa_cvolume_init(&s->saved_volume);
1638 s->saved_save_volume = false;
1641 /* Called from main context. */
1642 static void compute_reference_ratio(pa_sink_input *i) {
1644 pa_cvolume remapped;
1648 pa_assert(pa_sink_flat_volume_enabled(i->sink));
1651 * Calculates the reference ratio from the sink's reference
1652 * volume. This basically calculates:
1654 * i->reference_ratio = i->volume / i->sink->reference_volume
1657 remapped = i->sink->reference_volume;
1658 pa_cvolume_remap(&remapped, &i->sink->channel_map, &i->channel_map);
1660 ratio = i->reference_ratio;
1662 for (c = 0; c < i->sample_spec.channels; c++) {
1664 /* We don't update when the sink volume is 0 anyway */
1665 if (remapped.values[c] <= PA_VOLUME_MUTED)
1668 /* Don't update the reference ratio unless necessary */
1669 if (pa_sw_volume_multiply(
1671 remapped.values[c]) == i->volume.values[c])
1674 ratio.values[c] = pa_sw_volume_divide(
1675 i->volume.values[c],
1676 remapped.values[c]);
1679 pa_sink_input_set_reference_ratio(i, &ratio);
1682 /* Called from main context. Only called for the root sink in volume sharing
1683 * cases, except for internal recursive calls. */
1684 static void compute_reference_ratios(pa_sink *s) {
1688 pa_sink_assert_ref(s);
1689 pa_assert_ctl_context();
1690 pa_assert(PA_SINK_IS_LINKED(s->state));
1691 pa_assert(pa_sink_flat_volume_enabled(s));
1693 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1694 compute_reference_ratio(i);
1696 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1697 compute_reference_ratios(i->origin_sink);
1701 /* Called from main context. Only called for the root sink in volume sharing
1702 * cases, except for internal recursive calls. */
1703 static void compute_real_ratios(pa_sink *s) {
1707 pa_sink_assert_ref(s);
1708 pa_assert_ctl_context();
1709 pa_assert(PA_SINK_IS_LINKED(s->state));
1710 pa_assert(pa_sink_flat_volume_enabled(s));
1712 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1714 pa_cvolume remapped;
1716 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1717 /* The origin sink uses volume sharing, so this input's real ratio
1718 * is handled as a special case - the real ratio must be 0 dB, and
1719 * as a result i->soft_volume must equal i->volume_factor. */
1720 pa_cvolume_reset(&i->real_ratio, i->real_ratio.channels);
1721 i->soft_volume = i->volume_factor;
1723 compute_real_ratios(i->origin_sink);
1729 * This basically calculates:
1731 * i->real_ratio := i->volume / s->real_volume
1732 * i->soft_volume := i->real_ratio * i->volume_factor
1735 remapped = s->real_volume;
1736 pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map);
1738 i->real_ratio.channels = i->sample_spec.channels;
1739 i->soft_volume.channels = i->sample_spec.channels;
1741 for (c = 0; c < i->sample_spec.channels; c++) {
1743 if (remapped.values[c] <= PA_VOLUME_MUTED) {
1744 /* We leave i->real_ratio untouched */
1745 i->soft_volume.values[c] = PA_VOLUME_MUTED;
1749 /* Don't lose accuracy unless necessary */
1750 if (pa_sw_volume_multiply(
1751 i->real_ratio.values[c],
1752 remapped.values[c]) != i->volume.values[c])
1754 i->real_ratio.values[c] = pa_sw_volume_divide(
1755 i->volume.values[c],
1756 remapped.values[c]);
1758 i->soft_volume.values[c] = pa_sw_volume_multiply(
1759 i->real_ratio.values[c],
1760 i->volume_factor.values[c]);
1763 /* We don't copy the soft_volume to the thread_info data
1764 * here. That must be done by the caller */
1768 static pa_cvolume *cvolume_remap_minimal_impact(
1770 const pa_cvolume *template,
1771 const pa_channel_map *from,
1772 const pa_channel_map *to) {
1777 pa_assert(template);
1780 pa_assert(pa_cvolume_compatible_with_channel_map(v, from));
1781 pa_assert(pa_cvolume_compatible_with_channel_map(template, to));
1783 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1784 * mapping from sink input to sink volumes:
1786 * If template is a possible remapping from v it is used instead
1787 * of remapping anew.
1789 * If the channel maps don't match we set an all-channel volume on
1790 * the sink to ensure that changing a volume on one stream has no
1791 * effect that cannot be compensated for in another stream that
1792 * does not have the same channel map as the sink. */
1794 if (pa_channel_map_equal(from, to))
1798 if (pa_cvolume_equal(pa_cvolume_remap(&t, to, from), v)) {
1803 pa_cvolume_set(v, to->channels, pa_cvolume_max(v));
1807 /* Called from main thread. Only called for the root sink in volume sharing
1808 * cases, except for internal recursive calls. */
1809 static void get_maximum_input_volume(pa_sink *s, pa_cvolume *max_volume, const pa_channel_map *channel_map) {
1813 pa_sink_assert_ref(s);
1814 pa_assert(max_volume);
1815 pa_assert(channel_map);
1816 pa_assert(pa_sink_flat_volume_enabled(s));
1818 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1819 pa_cvolume remapped;
1821 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1822 get_maximum_input_volume(i->origin_sink, max_volume, channel_map);
1824 /* Ignore this input. The origin sink uses volume sharing, so this
1825 * input's volume will be set to be equal to the root sink's real
1826 * volume. Obviously this input's current volume must not then
1827 * affect what the root sink's real volume will be. */
1831 remapped = i->volume;
1832 cvolume_remap_minimal_impact(&remapped, max_volume, &i->channel_map, channel_map);
1833 pa_cvolume_merge(max_volume, max_volume, &remapped);
1837 /* Called from main thread. Only called for the root sink in volume sharing
1838 * cases, except for internal recursive calls. */
1839 static bool has_inputs(pa_sink *s) {
1843 pa_sink_assert_ref(s);
1845 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1846 if (!i->origin_sink || !(i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || has_inputs(i->origin_sink))
1853 /* Called from main thread. Only called for the root sink in volume sharing
1854 * cases, except for internal recursive calls. */
1855 static void update_real_volume(pa_sink *s, const pa_cvolume *new_volume, pa_channel_map *channel_map) {
1859 pa_sink_assert_ref(s);
1860 pa_assert(new_volume);
1861 pa_assert(channel_map);
1863 s->real_volume = *new_volume;
1864 pa_cvolume_remap(&s->real_volume, channel_map, &s->channel_map);
1866 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1867 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1868 if (pa_sink_flat_volume_enabled(s)) {
1869 pa_cvolume new_input_volume;
1871 /* Follow the root sink's real volume. */
1872 new_input_volume = *new_volume;
1873 pa_cvolume_remap(&new_input_volume, channel_map, &i->channel_map);
1874 pa_sink_input_set_volume_direct(i, &new_input_volume);
1875 compute_reference_ratio(i);
1878 update_real_volume(i->origin_sink, new_volume, channel_map);
1883 /* Called from main thread. Only called for the root sink in shared volume
1885 static void compute_real_volume(pa_sink *s) {
1886 pa_sink_assert_ref(s);
1887 pa_assert_ctl_context();
1888 pa_assert(PA_SINK_IS_LINKED(s->state));
1889 pa_assert(pa_sink_flat_volume_enabled(s));
1890 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
1892 /* This determines the maximum volume of all streams and sets
1893 * s->real_volume accordingly. */
1895 if (!has_inputs(s)) {
1896 /* In the special case that we have no sink inputs we leave the
1897 * volume unmodified. */
1898 update_real_volume(s, &s->reference_volume, &s->channel_map);
1902 pa_cvolume_mute(&s->real_volume, s->channel_map.channels);
1904 /* First let's determine the new maximum volume of all inputs
1905 * connected to this sink */
1906 get_maximum_input_volume(s, &s->real_volume, &s->channel_map);
1907 update_real_volume(s, &s->real_volume, &s->channel_map);
1909 /* Then, let's update the real ratios/soft volumes of all inputs
1910 * connected to this sink */
1911 compute_real_ratios(s);
1914 /* Called from main thread. Only called for the root sink in shared volume
1915 * cases, except for internal recursive calls. */
1916 static void propagate_reference_volume(pa_sink *s) {
1920 pa_sink_assert_ref(s);
1921 pa_assert_ctl_context();
1922 pa_assert(PA_SINK_IS_LINKED(s->state));
1923 pa_assert(pa_sink_flat_volume_enabled(s));
1925 /* This is called whenever the sink volume changes that is not
1926 * caused by a sink input volume change. We need to fix up the
1927 * sink input volumes accordingly */
1929 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1930 pa_cvolume new_volume;
1932 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1933 propagate_reference_volume(i->origin_sink);
1935 /* Since the origin sink uses volume sharing, this input's volume
1936 * needs to be updated to match the root sink's real volume, but
1937 * that will be done later in update_shared_real_volume(). */
1941 /* This basically calculates:
1943 * i->volume := s->reference_volume * i->reference_ratio */
1945 new_volume = s->reference_volume;
1946 pa_cvolume_remap(&new_volume, &s->channel_map, &i->channel_map);
1947 pa_sw_cvolume_multiply(&new_volume, &new_volume, &i->reference_ratio);
1948 pa_sink_input_set_volume_direct(i, &new_volume);
1952 /* Called from main thread. Only called for the root sink in volume sharing
1953 * cases, except for internal recursive calls. The return value indicates
1954 * whether any reference volume actually changed. */
1955 static bool update_reference_volume(pa_sink *s, const pa_cvolume *v, const pa_channel_map *channel_map, bool save) {
1957 bool reference_volume_changed;
1961 pa_sink_assert_ref(s);
1962 pa_assert(PA_SINK_IS_LINKED(s->state));
1964 pa_assert(channel_map);
1965 pa_assert(pa_cvolume_valid(v));
1968 pa_cvolume_remap(&volume, channel_map, &s->channel_map);
1970 reference_volume_changed = !pa_cvolume_equal(&volume, &s->reference_volume);
1971 pa_sink_set_reference_volume_direct(s, &volume);
1973 s->save_volume = (!reference_volume_changed && s->save_volume) || save;
1975 if (!reference_volume_changed && !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1976 /* If the root sink's volume doesn't change, then there can't be any
1977 * changes in the other sinks in the sink tree either.
1979 * It's probably theoretically possible that even if the root sink's
1980 * volume changes slightly, some filter sink doesn't change its volume
1981 * due to rounding errors. If that happens, we still want to propagate
1982 * the changed root sink volume to the sinks connected to the
1983 * intermediate sink that didn't change its volume. This theoretical
1984 * possibility is the reason why we have that !(s->flags &
1985 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1986 * notice even if we returned here false always if
1987 * reference_volume_changed is false. */
1990 PA_IDXSET_FOREACH(i, s->inputs, idx) {
1991 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
1992 update_reference_volume(i->origin_sink, v, channel_map, false);
1998 /* Called from main thread */
1999 void pa_sink_set_volume(
2001 const pa_cvolume *volume,
2005 pa_cvolume new_reference_volume;
2008 pa_sink_assert_ref(s);
2009 pa_assert_ctl_context();
2010 pa_assert(PA_SINK_IS_LINKED(s->state));
2011 pa_assert(!volume || pa_cvolume_valid(volume));
2012 pa_assert(volume || pa_sink_flat_volume_enabled(s));
2013 pa_assert(!volume || volume->channels == 1 || pa_cvolume_compatible(volume, &s->sample_spec));
2015 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
2016 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
2017 if (pa_sink_is_passthrough(s) && (!volume || !pa_cvolume_is_norm(volume))) {
2018 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
2022 /* In case of volume sharing, the volume is set for the root sink first,
2023 * from which it's then propagated to the sharing sinks. */
2024 root_sink = pa_sink_get_master(s);
2026 if (PA_UNLIKELY(!root_sink))
2029 /* As a special exception we accept mono volumes on all sinks --
2030 * even on those with more complex channel maps */
2033 if (pa_cvolume_compatible(volume, &s->sample_spec))
2034 new_reference_volume = *volume;
2036 new_reference_volume = s->reference_volume;
2037 pa_cvolume_scale(&new_reference_volume, pa_cvolume_max(volume));
2040 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map);
2042 if (update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save)) {
2043 if (pa_sink_flat_volume_enabled(root_sink)) {
2044 /* OK, propagate this volume change back to the inputs */
2045 propagate_reference_volume(root_sink);
2047 /* And now recalculate the real volume */
2048 compute_real_volume(root_sink);
2050 update_real_volume(root_sink, &root_sink->reference_volume, &root_sink->channel_map);
2054 /* If volume is NULL we synchronize the sink's real and
2055 * reference volumes with the stream volumes. */
2057 pa_assert(pa_sink_flat_volume_enabled(root_sink));
2059 /* Ok, let's determine the new real volume */
2060 compute_real_volume(root_sink);
2062 /* Let's 'push' the reference volume if necessary */
2063 pa_cvolume_merge(&new_reference_volume, &s->reference_volume, &root_sink->real_volume);
2064 /* If the sink and its root don't have the same number of channels, we need to remap */
2065 if (s != root_sink && !pa_channel_map_equal(&s->channel_map, &root_sink->channel_map))
2066 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map);
2067 update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save);
2069 /* Now that the reference volume is updated, we can update the streams'
2070 * reference ratios. */
2071 compute_reference_ratios(root_sink);
2074 if (root_sink->set_volume) {
2075 /* If we have a function set_volume(), then we do not apply a
2076 * soft volume by default. However, set_volume() is free to
2077 * apply one to root_sink->soft_volume */
2079 pa_cvolume_reset(&root_sink->soft_volume, root_sink->sample_spec.channels);
2080 if (!(root_sink->flags & PA_SINK_DEFERRED_VOLUME))
2081 root_sink->set_volume(root_sink);
2084 /* If we have no function set_volume(), then the soft volume
2085 * becomes the real volume */
2086 root_sink->soft_volume = root_sink->real_volume;
2088 /* This tells the sink that soft volume and/or real volume changed */
2090 pa_assert_se(pa_asyncmsgq_send(root_sink->asyncmsgq, PA_MSGOBJECT(root_sink), PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL) == 0);
2093 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2094 * Only to be called by sink implementor */
2095 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume) {
2097 pa_sink_assert_ref(s);
2098 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2100 if (s->flags & PA_SINK_DEFERRED_VOLUME)
2101 pa_sink_assert_io_context(s);
2103 pa_assert_ctl_context();
2106 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
2108 s->soft_volume = *volume;
2110 if (PA_SINK_IS_LINKED(s->state) && !(s->flags & PA_SINK_DEFERRED_VOLUME))
2111 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0);
2113 s->thread_info.soft_volume = s->soft_volume;
2116 /* Called from the main thread. Only called for the root sink in volume sharing
2117 * cases, except for internal recursive calls. */
2118 static void propagate_real_volume(pa_sink *s, const pa_cvolume *old_real_volume) {
2122 pa_sink_assert_ref(s);
2123 pa_assert(old_real_volume);
2124 pa_assert_ctl_context();
2125 pa_assert(PA_SINK_IS_LINKED(s->state));
2127 /* This is called when the hardware's real volume changes due to
2128 * some external event. We copy the real volume into our
2129 * reference volume and then rebuild the stream volumes based on
2130 * i->real_ratio which should stay fixed. */
2132 if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
2133 if (pa_cvolume_equal(old_real_volume, &s->real_volume))
2136 /* 1. Make the real volume the reference volume */
2137 update_reference_volume(s, &s->real_volume, &s->channel_map, true);
2140 if (pa_sink_flat_volume_enabled(s)) {
2142 PA_IDXSET_FOREACH(i, s->inputs, idx) {
2143 pa_cvolume new_volume;
2145 /* 2. Since the sink's reference and real volumes are equal
2146 * now our ratios should be too. */
2147 pa_sink_input_set_reference_ratio(i, &i->real_ratio);
2149 /* 3. Recalculate the new stream reference volume based on the
2150 * reference ratio and the sink's reference volume.
2152 * This basically calculates:
2154 * i->volume = s->reference_volume * i->reference_ratio
2156 * This is identical to propagate_reference_volume() */
2157 new_volume = s->reference_volume;
2158 pa_cvolume_remap(&new_volume, &s->channel_map, &i->channel_map);
2159 pa_sw_cvolume_multiply(&new_volume, &new_volume, &i->reference_ratio);
2160 pa_sink_input_set_volume_direct(i, &new_volume);
2162 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2163 propagate_real_volume(i->origin_sink, old_real_volume);
2167 /* Something got changed in the hardware. It probably makes sense
2168 * to save changed hw settings given that hw volume changes not
2169 * triggered by PA are almost certainly done by the user. */
2170 if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2171 s->save_volume = true;
2174 /* Called from io thread */
2175 void pa_sink_update_volume_and_mute(pa_sink *s) {
2177 pa_sink_assert_io_context(s);
2179 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE, NULL, 0, NULL, NULL);
2182 /* Called from main thread */
2183 const pa_cvolume *pa_sink_get_volume(pa_sink *s, bool force_refresh) {
2184 pa_sink_assert_ref(s);
2185 pa_assert_ctl_context();
2186 pa_assert(PA_SINK_IS_LINKED(s->state));
2188 if (s->refresh_volume || force_refresh) {
2189 struct pa_cvolume old_real_volume;
2191 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2193 old_real_volume = s->real_volume;
2195 if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume)
2198 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_VOLUME, NULL, 0, NULL) == 0);
2200 update_real_volume(s, &s->real_volume, &s->channel_map);
2201 propagate_real_volume(s, &old_real_volume);
2204 return &s->reference_volume;
2207 /* Called from main thread. In volume sharing cases, only the root sink may
2209 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_real_volume) {
2210 pa_cvolume old_real_volume;
2212 pa_sink_assert_ref(s);
2213 pa_assert_ctl_context();
2214 pa_assert(PA_SINK_IS_LINKED(s->state));
2215 pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER));
2217 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2219 old_real_volume = s->real_volume;
2220 update_real_volume(s, new_real_volume, &s->channel_map);
2221 propagate_real_volume(s, &old_real_volume);
2224 /* Called from main thread */
2225 void pa_sink_set_mute(pa_sink *s, bool mute, bool save) {
2228 pa_sink_assert_ref(s);
2229 pa_assert_ctl_context();
2231 old_muted = s->muted;
2233 if (mute == old_muted) {
2234 s->save_muted |= save;
2239 s->save_muted = save;
2241 if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->set_mute) {
2242 s->set_mute_in_progress = true;
2244 s->set_mute_in_progress = false;
2247 if (!PA_SINK_IS_LINKED(s->state))
2250 pa_log_debug("The mute of sink %s changed from %s to %s.", s->name, pa_yes_no(old_muted), pa_yes_no(mute));
2251 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
2252 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2253 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_MUTE_CHANGED], s);
2256 /* Called from main thread */
2257 bool pa_sink_get_mute(pa_sink *s, bool force_refresh) {
2259 pa_sink_assert_ref(s);
2260 pa_assert_ctl_context();
2261 pa_assert(PA_SINK_IS_LINKED(s->state));
2263 if ((s->refresh_muted || force_refresh) && s->get_mute) {
2266 if (s->flags & PA_SINK_DEFERRED_VOLUME) {
2267 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MUTE, &mute, 0, NULL) >= 0)
2268 pa_sink_mute_changed(s, mute);
2270 if (s->get_mute(s, &mute) >= 0)
2271 pa_sink_mute_changed(s, mute);
2278 /* Called from main thread */
2279 void pa_sink_mute_changed(pa_sink *s, bool new_muted) {
2280 pa_sink_assert_ref(s);
2281 pa_assert_ctl_context();
2282 pa_assert(PA_SINK_IS_LINKED(s->state));
2284 if (s->set_mute_in_progress)
2287 /* pa_sink_set_mute() does this same check, so this may appear redundant,
2288 * but we must have this here also, because the save parameter of
2289 * pa_sink_set_mute() would otherwise have unintended side effects (saving
2290 * the mute state when it shouldn't be saved). */
2291 if (new_muted == s->muted)
2294 pa_sink_set_mute(s, new_muted, true);
2297 /* Called from main thread */
2298 bool pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p) {
2299 pa_sink_assert_ref(s);
2300 pa_assert_ctl_context();
2303 pa_proplist_update(s->proplist, mode, p);
2305 if (PA_SINK_IS_LINKED(s->state)) {
2306 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
2307 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2313 /* Called from main thread */
2314 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2315 void pa_sink_set_description(pa_sink *s, const char *description) {
2317 pa_sink_assert_ref(s);
2318 pa_assert_ctl_context();
2320 if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
2323 old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
2325 if (old && description && pa_streq(old, description))
2329 pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
2331 pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
2333 if (s->monitor_source) {
2336 n = pa_sprintf_malloc("Monitor Source of %s", description ? description : s->name);
2337 pa_source_set_description(s->monitor_source, n);
2341 if (PA_SINK_IS_LINKED(s->state)) {
2342 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2343 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
2347 /* Called from main thread */
2348 unsigned pa_sink_linked_by(pa_sink *s) {
2351 pa_sink_assert_ref(s);
2352 pa_assert_ctl_context();
2353 pa_assert(PA_SINK_IS_LINKED(s->state));
2355 ret = pa_idxset_size(s->inputs);
2357 /* We add in the number of streams connected to us here. Please
2358 * note the asymmetry to pa_sink_used_by()! */
2360 if (s->monitor_source)
2361 ret += pa_source_linked_by(s->monitor_source);
2366 /* Called from main thread */
2367 unsigned pa_sink_used_by(pa_sink *s) {
2370 pa_sink_assert_ref(s);
2371 pa_assert_ctl_context();
2372 pa_assert(PA_SINK_IS_LINKED(s->state));
2374 ret = pa_idxset_size(s->inputs);
2375 pa_assert(ret >= s->n_corked);
2377 /* Streams connected to our monitor source do not matter for
2378 * pa_sink_used_by()!.*/
2380 return ret - s->n_corked;
2383 /* Called from main thread */
2384 unsigned pa_sink_check_suspend(pa_sink *s) {
2389 pa_sink_assert_ref(s);
2390 pa_assert_ctl_context();
2392 if (!PA_SINK_IS_LINKED(s->state))
2397 PA_IDXSET_FOREACH(i, s->inputs, idx) {
2398 pa_sink_input_state_t st;
2400 st = pa_sink_input_get_state(i);
2402 /* We do not assert here. It is perfectly valid for a sink input to
2403 * be in the INIT state (i.e. created, marked done but not yet put)
2404 * and we should not care if it's unlinked as it won't contribute
2405 * towards our busy status.
2407 if (!PA_SINK_INPUT_IS_LINKED(st))
2410 if (st == PA_SINK_INPUT_CORKED)
2413 if (i->flags & PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND)
2419 if (s->monitor_source)
2420 ret += pa_source_check_suspend(s->monitor_source);
2425 /* Called from the IO thread */
2426 static void sync_input_volumes_within_thread(pa_sink *s) {
2430 pa_sink_assert_ref(s);
2431 pa_sink_assert_io_context(s);
2433 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
2434 if (pa_cvolume_equal(&i->thread_info.soft_volume, &i->soft_volume))
2437 i->thread_info.soft_volume = i->soft_volume;
2438 pa_sink_input_request_rewind(i, 0, true, false, false);
2442 /* Called from the IO thread. Only called for the root sink in volume sharing
2443 * cases, except for internal recursive calls. */
2444 static void set_shared_volume_within_thread(pa_sink *s) {
2445 pa_sink_input *i = NULL;
2448 pa_sink_assert_ref(s);
2450 PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL);
2452 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) {
2453 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
2454 set_shared_volume_within_thread(i->origin_sink);
2458 /* Called from IO thread, except when it is not */
2459 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
2460 pa_sink *s = PA_SINK(o);
2461 pa_sink_assert_ref(s);
2463 switch ((pa_sink_message_t) code) {
2465 case PA_SINK_MESSAGE_ADD_INPUT: {
2466 pa_sink_input *i = PA_SINK_INPUT(userdata);
2468 /* If you change anything here, make sure to change the
2469 * sink input handling a few lines down at
2470 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2472 pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
2474 /* Since the caller sleeps in pa_sink_input_put(), we can
2475 * safely access data outside of thread_info even though
2478 if ((i->thread_info.sync_prev = i->sync_prev)) {
2479 pa_assert(i->sink == i->thread_info.sync_prev->sink);
2480 pa_assert(i->sync_prev->sync_next == i);
2481 i->thread_info.sync_prev->thread_info.sync_next = i;
2484 if ((i->thread_info.sync_next = i->sync_next)) {
2485 pa_assert(i->sink == i->thread_info.sync_next->sink);
2486 pa_assert(i->sync_next->sync_prev == i);
2487 i->thread_info.sync_next->thread_info.sync_prev = i;
2490 pa_assert(!i->thread_info.attached);
2491 i->thread_info.attached = true;
2496 pa_sink_input_set_state_within_thread(i, i->state);
2498 /* The requested latency of the sink input needs to be fixed up and
2499 * then configured on the sink. If this causes the sink latency to
2500 * go down, the sink implementor is responsible for doing a rewind
2501 * in the update_requested_latency() callback to ensure that the
2502 * sink buffer doesn't contain more data than what the new latency
2505 * XXX: Does it really make sense to push this responsibility to
2506 * the sink implementors? Wouldn't it be better to do it once in
2507 * the core than many times in the modules? */
2509 if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
2510 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
2512 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
2513 pa_sink_input_update_max_request(i, s->thread_info.max_request);
2515 /* We don't rewind here automatically. This is left to the
2516 * sink input implementor because some sink inputs need a
2517 * slow start, i.e. need some time to buffer client
2518 * samples before beginning streaming.
2520 * XXX: Does it really make sense to push this functionality to
2521 * the sink implementors? Wouldn't it be better to do it once in
2522 * the core than many times in the modules? */
2524 /* In flat volume mode we need to update the volume as
2526 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2529 case PA_SINK_MESSAGE_REMOVE_INPUT: {
2530 pa_sink_input *i = PA_SINK_INPUT(userdata);
2532 /* If you change anything here, make sure to change the
2533 * sink input handling a few lines down at
2534 * PA_SINK_MESSAGE_START_MOVE, too. */
2539 pa_sink_input_set_state_within_thread(i, i->state);
2541 pa_assert(i->thread_info.attached);
2542 i->thread_info.attached = false;
2544 /* Since the caller sleeps in pa_sink_input_unlink(),
2545 * we can safely access data outside of thread_info even
2546 * though it is mutable */
2548 pa_assert(!i->sync_prev);
2549 pa_assert(!i->sync_next);
2551 if (i->thread_info.sync_prev) {
2552 i->thread_info.sync_prev->thread_info.sync_next = i->thread_info.sync_prev->sync_next;
2553 i->thread_info.sync_prev = NULL;
2556 if (i->thread_info.sync_next) {
2557 i->thread_info.sync_next->thread_info.sync_prev = i->thread_info.sync_next->sync_prev;
2558 i->thread_info.sync_next = NULL;
2561 pa_hashmap_remove_and_free(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index));
2562 pa_sink_invalidate_requested_latency(s, true);
2563 pa_sink_request_rewind(s, (size_t) -1);
2565 /* In flat volume mode we need to update the volume as
2567 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2570 case PA_SINK_MESSAGE_START_MOVE: {
2571 pa_sink_input *i = PA_SINK_INPUT(userdata);
2573 /* We don't support moving synchronized streams. */
2574 pa_assert(!i->sync_prev);
2575 pa_assert(!i->sync_next);
2576 pa_assert(!i->thread_info.sync_next);
2577 pa_assert(!i->thread_info.sync_prev);
2579 if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
2581 size_t sink_nbytes, total_nbytes;
2583 /* The old sink probably has some audio from this
2584 * stream in its buffer. We want to "take it back" as
2585 * much as possible and play it to the new sink. We
2586 * don't know at this point how much the old sink can
2587 * rewind. We have to pick something, and that
2588 * something is the full latency of the old sink here.
2589 * So we rewind the stream buffer by the sink latency
2590 * amount, which may be more than what we should
2591 * rewind. This can result in a chunk of audio being
2592 * played both to the old sink and the new sink.
2594 * FIXME: Fix this code so that we don't have to make
2595 * guesses about how much the sink will actually be
2596 * able to rewind. If someone comes up with a solution
2597 * for this, something to note is that the part of the
2598 * latency that the old sink couldn't rewind should
2599 * ideally be compensated after the stream has moved
2600 * to the new sink by adding silence. The new sink
2601 * most likely can't start playing the moved stream
2602 * immediately, and that gap should be removed from
2603 * the "compensation silence" (at least at the time of
2604 * writing this, the move finish code will actually
2605 * already take care of dropping the new sink's
2606 * unrewindable latency, so taking into account the
2607 * unrewindable latency of the old sink is the only
2610 * The render_memblockq contents are discarded,
2611 * because when the sink changes, the format of the
2612 * audio stored in the render_memblockq may change
2613 * too, making the stored audio invalid. FIXME:
2614 * However, the read and write indices are moved back
2615 * the same amount, so if they are not the same now,
2616 * they won't be the same after the rewind either. If
2617 * the write index of the render_memblockq is ahead of
2618 * the read index, then the render_memblockq will feed
2619 * the new sink some silence first, which it shouldn't
2620 * do. The write index should be flushed to be the
2621 * same as the read index. */
2623 /* Get the latency of the sink */
2624 usec = pa_sink_get_latency_within_thread(s);
2625 sink_nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
2626 total_nbytes = sink_nbytes + pa_memblockq_get_length(i->thread_info.render_memblockq);
2628 if (total_nbytes > 0) {
2629 i->thread_info.rewrite_nbytes = i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, total_nbytes) : total_nbytes;
2630 i->thread_info.rewrite_flush = true;
2631 pa_sink_input_process_rewind(i, sink_nbytes);
2638 pa_assert(i->thread_info.attached);
2639 i->thread_info.attached = false;
2641 /* Let's remove the sink input ...*/
2642 pa_hashmap_remove_and_free(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index));
2644 pa_sink_invalidate_requested_latency(s, true);
2646 pa_log_debug("Requesting rewind due to started move");
2647 pa_sink_request_rewind(s, (size_t) -1);
2649 /* In flat volume mode we need to update the volume as
2651 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2654 case PA_SINK_MESSAGE_FINISH_MOVE: {
2655 pa_sink_input *i = PA_SINK_INPUT(userdata);
2657 /* We don't support moving synchronized streams. */
2658 pa_assert(!i->sync_prev);
2659 pa_assert(!i->sync_next);
2660 pa_assert(!i->thread_info.sync_next);
2661 pa_assert(!i->thread_info.sync_prev);
2663 pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
2665 pa_assert(!i->thread_info.attached);
2666 i->thread_info.attached = true;
2671 if (i->thread_info.state != PA_SINK_INPUT_CORKED) {
2675 /* In the ideal case the new sink would start playing
2676 * the stream immediately. That requires the sink to
2677 * be able to rewind all of its latency, which usually
2678 * isn't possible, so there will probably be some gap
2679 * before the moved stream becomes audible. We then
2680 * have two possibilities: 1) start playing the stream
2681 * from where it is now, or 2) drop the unrewindable
2682 * latency of the sink from the stream. With option 1
2683 * we won't lose any audio but the stream will have a
2684 * pause. With option 2 we may lose some audio but the
2685 * stream time will be somewhat in sync with the wall
2686 * clock. Lennart seems to have chosen option 2 (one
2687 * of the reasons might have been that option 1 is
2688 * actually much harder to implement), so we drop the
2689 * latency of the new sink from the moved stream and
2690 * hope that the sink will undo most of that in the
2693 /* Get the latency of the sink */
2694 usec = pa_sink_get_latency_within_thread(s);
2695 nbytes = pa_usec_to_bytes(usec, &s->sample_spec);
2698 pa_sink_input_drop(i, nbytes);
2700 pa_log_debug("Requesting rewind due to finished move");
2701 pa_sink_request_rewind(s, nbytes);
2704 /* Updating the requested sink latency has to be done
2705 * after the sink rewind request, not before, because
2706 * otherwise the sink may limit the rewind amount
2709 if (i->thread_info.requested_sink_latency != (pa_usec_t) -1)
2710 pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency);
2712 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
2713 pa_sink_input_update_max_request(i, s->thread_info.max_request);
2715 return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2718 case PA_SINK_MESSAGE_SET_SHARED_VOLUME: {
2719 pa_sink *root_sink = pa_sink_get_master(s);
2721 if (PA_LIKELY(root_sink))
2722 set_shared_volume_within_thread(root_sink);
2727 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED:
2729 if (s->flags & PA_SINK_DEFERRED_VOLUME) {
2731 pa_sink_volume_change_push(s);
2733 /* Fall through ... */
2735 case PA_SINK_MESSAGE_SET_VOLUME:
2737 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2738 s->thread_info.soft_volume = s->soft_volume;
2739 pa_sink_request_rewind(s, (size_t) -1);
2742 /* Fall through ... */
2744 case PA_SINK_MESSAGE_SYNC_VOLUMES:
2745 sync_input_volumes_within_thread(s);
2748 case PA_SINK_MESSAGE_GET_VOLUME:
2750 if ((s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume) {
2752 pa_sink_volume_change_flush(s);
2753 pa_sw_cvolume_divide(&s->thread_info.current_hw_volume, &s->real_volume, &s->soft_volume);
2756 /* In case sink implementor reset SW volume. */
2757 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2758 s->thread_info.soft_volume = s->soft_volume;
2759 pa_sink_request_rewind(s, (size_t) -1);
2764 case PA_SINK_MESSAGE_SET_MUTE:
2766 if (s->thread_info.soft_muted != s->muted) {
2767 s->thread_info.soft_muted = s->muted;
2768 pa_sink_request_rewind(s, (size_t) -1);
2771 if (s->flags & PA_SINK_DEFERRED_VOLUME && s->set_mute)
2776 case PA_SINK_MESSAGE_GET_MUTE:
2778 if (s->flags & PA_SINK_DEFERRED_VOLUME && s->get_mute)
2779 return s->get_mute(s, userdata);
2783 case PA_SINK_MESSAGE_SET_STATE: {
2785 bool suspend_change =
2786 (s->thread_info.state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata))) ||
2787 (PA_SINK_IS_OPENED(s->thread_info.state) && PA_PTR_TO_UINT(userdata) == PA_SINK_SUSPENDED);
2789 s->thread_info.state = PA_PTR_TO_UINT(userdata);
2791 if (s->thread_info.state == PA_SINK_SUSPENDED) {
2792 s->thread_info.rewind_nbytes = 0;
2793 s->thread_info.rewind_requested = false;
2796 if (suspend_change) {
2800 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
2801 if (i->suspend_within_thread)
2802 i->suspend_within_thread(i, s->thread_info.state == PA_SINK_SUSPENDED);
2808 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY: {
2810 pa_usec_t *usec = userdata;
2811 *usec = pa_sink_get_requested_latency_within_thread(s);
2813 /* Yes, that's right, the IO thread will see -1 when no
2814 * explicit requested latency is configured, the main
2815 * thread will see max_latency */
2816 if (*usec == (pa_usec_t) -1)
2817 *usec = s->thread_info.max_latency;
2822 case PA_SINK_MESSAGE_SET_LATENCY_RANGE: {
2823 pa_usec_t *r = userdata;
2825 pa_sink_set_latency_range_within_thread(s, r[0], r[1]);
2830 case PA_SINK_MESSAGE_GET_LATENCY_RANGE: {
2831 pa_usec_t *r = userdata;
2833 r[0] = s->thread_info.min_latency;
2834 r[1] = s->thread_info.max_latency;
2839 case PA_SINK_MESSAGE_GET_FIXED_LATENCY:
2841 *((pa_usec_t*) userdata) = s->thread_info.fixed_latency;
2844 case PA_SINK_MESSAGE_SET_FIXED_LATENCY:
2846 pa_sink_set_fixed_latency_within_thread(s, (pa_usec_t) offset);
2849 case PA_SINK_MESSAGE_GET_MAX_REWIND:
2851 *((size_t*) userdata) = s->thread_info.max_rewind;
2854 case PA_SINK_MESSAGE_GET_MAX_REQUEST:
2856 *((size_t*) userdata) = s->thread_info.max_request;
2859 case PA_SINK_MESSAGE_SET_MAX_REWIND:
2861 pa_sink_set_max_rewind_within_thread(s, (size_t) offset);
2864 case PA_SINK_MESSAGE_SET_MAX_REQUEST:
2866 pa_sink_set_max_request_within_thread(s, (size_t) offset);
2869 case PA_SINK_MESSAGE_SET_PORT:
2871 pa_assert(userdata);
2873 struct sink_message_set_port *msg_data = userdata;
2874 msg_data->ret = s->set_port(s, msg_data->port);
2878 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE:
2879 /* This message is sent from IO-thread and handled in main thread. */
2880 pa_assert_ctl_context();
2882 /* Make sure we're not messing with main thread when no longer linked */
2883 if (!PA_SINK_IS_LINKED(s->state))
2886 pa_sink_get_volume(s, true);
2887 pa_sink_get_mute(s, true);
2890 case PA_SINK_MESSAGE_SET_PORT_LATENCY_OFFSET:
2891 s->thread_info.port_latency_offset = offset;
2894 case PA_SINK_MESSAGE_GET_LATENCY:
2895 case PA_SINK_MESSAGE_MAX:
2902 /* Called from main thread */
2903 int pa_sink_suspend_all(pa_core *c, bool suspend, pa_suspend_cause_t cause) {
2908 pa_core_assert_ref(c);
2909 pa_assert_ctl_context();
2910 pa_assert(cause != 0);
2912 PA_IDXSET_FOREACH(sink, c->sinks, idx) {
2915 if ((r = pa_sink_suspend(sink, suspend, cause)) < 0)
2922 /* Called from IO thread */
2923 void pa_sink_detach_within_thread(pa_sink *s) {
2927 pa_sink_assert_ref(s);
2928 pa_sink_assert_io_context(s);
2929 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2931 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2935 if (s->monitor_source)
2936 pa_source_detach_within_thread(s->monitor_source);
2939 /* Called from IO thread */
2940 void pa_sink_attach_within_thread(pa_sink *s) {
2944 pa_sink_assert_ref(s);
2945 pa_sink_assert_io_context(s);
2946 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2948 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2952 if (s->monitor_source)
2953 pa_source_attach_within_thread(s->monitor_source);
2956 /* Called from IO thread */
2957 void pa_sink_request_rewind(pa_sink*s, size_t nbytes) {
2958 pa_sink_assert_ref(s);
2959 pa_sink_assert_io_context(s);
2960 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
2962 if (nbytes == (size_t) -1)
2963 nbytes = s->thread_info.max_rewind;
2965 nbytes = PA_MIN(nbytes, s->thread_info.max_rewind);
2967 if (s->thread_info.rewind_requested &&
2968 nbytes <= s->thread_info.rewind_nbytes)
2971 s->thread_info.rewind_nbytes = nbytes;
2972 s->thread_info.rewind_requested = true;
2974 if (s->request_rewind)
2975 s->request_rewind(s);
2978 /* Called from IO thread */
2979 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s) {
2980 pa_usec_t result = (pa_usec_t) -1;
2983 pa_usec_t monitor_latency;
2985 pa_sink_assert_ref(s);
2986 pa_sink_assert_io_context(s);
2988 if (!(s->flags & PA_SINK_DYNAMIC_LATENCY))
2989 return PA_CLAMP(s->thread_info.fixed_latency, s->thread_info.min_latency, s->thread_info.max_latency);
2991 if (s->thread_info.requested_latency_valid)
2992 return s->thread_info.requested_latency;
2994 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
2995 if (i->thread_info.requested_sink_latency != (pa_usec_t) -1 &&
2996 (result == (pa_usec_t) -1 || result > i->thread_info.requested_sink_latency))
2997 result = i->thread_info.requested_sink_latency;
2999 monitor_latency = pa_source_get_requested_latency_within_thread(s->monitor_source);
3001 if (monitor_latency != (pa_usec_t) -1 &&
3002 (result == (pa_usec_t) -1 || result > monitor_latency))
3003 result = monitor_latency;
3005 if (result != (pa_usec_t) -1)
3006 result = PA_CLAMP(result, s->thread_info.min_latency, s->thread_info.max_latency);
3008 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3009 /* Only cache if properly initialized */
3010 s->thread_info.requested_latency = result;
3011 s->thread_info.requested_latency_valid = true;
3017 /* Called from main thread */
3018 pa_usec_t pa_sink_get_requested_latency(pa_sink *s) {
3021 pa_sink_assert_ref(s);
3022 pa_assert_ctl_context();
3023 pa_assert(PA_SINK_IS_LINKED(s->state));
3025 if (s->state == PA_SINK_SUSPENDED)
3028 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
3033 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3034 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind) {
3038 pa_sink_assert_ref(s);
3039 pa_sink_assert_io_context(s);
3041 if (max_rewind == s->thread_info.max_rewind)
3044 s->thread_info.max_rewind = max_rewind;
3046 if (PA_SINK_IS_LINKED(s->thread_info.state))
3047 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3048 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
3050 if (s->monitor_source)
3051 pa_source_set_max_rewind_within_thread(s->monitor_source, s->thread_info.max_rewind);
3054 /* Called from main thread */
3055 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind) {
3056 pa_sink_assert_ref(s);
3057 pa_assert_ctl_context();
3059 if (PA_SINK_IS_LINKED(s->state))
3060 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MAX_REWIND, NULL, max_rewind, NULL) == 0);
3062 pa_sink_set_max_rewind_within_thread(s, max_rewind);
3065 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3066 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request) {
3069 pa_sink_assert_ref(s);
3070 pa_sink_assert_io_context(s);
3072 if (max_request == s->thread_info.max_request)
3075 s->thread_info.max_request = max_request;
3077 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3080 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3081 pa_sink_input_update_max_request(i, s->thread_info.max_request);
3085 /* Called from main thread */
3086 void pa_sink_set_max_request(pa_sink *s, size_t max_request) {
3087 pa_sink_assert_ref(s);
3088 pa_assert_ctl_context();
3090 if (PA_SINK_IS_LINKED(s->state))
3091 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MAX_REQUEST, NULL, max_request, NULL) == 0);
3093 pa_sink_set_max_request_within_thread(s, max_request);
3096 /* Called from IO thread */
3097 void pa_sink_invalidate_requested_latency(pa_sink *s, bool dynamic) {
3101 pa_sink_assert_ref(s);
3102 pa_sink_assert_io_context(s);
3104 if ((s->flags & PA_SINK_DYNAMIC_LATENCY))
3105 s->thread_info.requested_latency_valid = false;
3109 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3111 if (s->update_requested_latency)
3112 s->update_requested_latency(s);
3114 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3115 if (i->update_sink_requested_latency)
3116 i->update_sink_requested_latency(i);
3120 /* Called from main thread */
3121 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
3122 pa_sink_assert_ref(s);
3123 pa_assert_ctl_context();
3125 /* min_latency == 0: no limit
3126 * min_latency anything else: specified limit
3128 * Similar for max_latency */
3130 if (min_latency < ABSOLUTE_MIN_LATENCY)
3131 min_latency = ABSOLUTE_MIN_LATENCY;
3133 if (max_latency <= 0 ||
3134 max_latency > ABSOLUTE_MAX_LATENCY)
3135 max_latency = ABSOLUTE_MAX_LATENCY;
3137 pa_assert(min_latency <= max_latency);
3139 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3140 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
3141 max_latency == ABSOLUTE_MAX_LATENCY) ||
3142 (s->flags & PA_SINK_DYNAMIC_LATENCY));
3144 if (PA_SINK_IS_LINKED(s->state)) {
3150 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
3152 pa_sink_set_latency_range_within_thread(s, min_latency, max_latency);
3155 /* Called from main thread */
3156 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
3157 pa_sink_assert_ref(s);
3158 pa_assert_ctl_context();
3159 pa_assert(min_latency);
3160 pa_assert(max_latency);
3162 if (PA_SINK_IS_LINKED(s->state)) {
3163 pa_usec_t r[2] = { 0, 0 };
3165 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
3167 *min_latency = r[0];
3168 *max_latency = r[1];
3170 *min_latency = s->thread_info.min_latency;
3171 *max_latency = s->thread_info.max_latency;
3175 /* Called from IO thread */
3176 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency) {
3177 pa_sink_assert_ref(s);
3178 pa_sink_assert_io_context(s);
3180 pa_assert(min_latency >= ABSOLUTE_MIN_LATENCY);
3181 pa_assert(max_latency <= ABSOLUTE_MAX_LATENCY);
3182 pa_assert(min_latency <= max_latency);
3184 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3185 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
3186 max_latency == ABSOLUTE_MAX_LATENCY) ||
3187 (s->flags & PA_SINK_DYNAMIC_LATENCY));
3189 if (s->thread_info.min_latency == min_latency &&
3190 s->thread_info.max_latency == max_latency)
3193 s->thread_info.min_latency = min_latency;
3194 s->thread_info.max_latency = max_latency;
3196 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3200 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3201 if (i->update_sink_latency_range)
3202 i->update_sink_latency_range(i);
3205 pa_sink_invalidate_requested_latency(s, false);
3207 pa_source_set_latency_range_within_thread(s->monitor_source, min_latency, max_latency);
3210 /* Called from main thread */
3211 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency) {
3212 pa_sink_assert_ref(s);
3213 pa_assert_ctl_context();
3215 if (s->flags & PA_SINK_DYNAMIC_LATENCY) {
3216 pa_assert(latency == 0);
3220 if (latency < ABSOLUTE_MIN_LATENCY)
3221 latency = ABSOLUTE_MIN_LATENCY;
3223 if (latency > ABSOLUTE_MAX_LATENCY)
3224 latency = ABSOLUTE_MAX_LATENCY;
3226 if (PA_SINK_IS_LINKED(s->state))
3227 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_FIXED_LATENCY, NULL, (int64_t) latency, NULL) == 0);
3229 s->thread_info.fixed_latency = latency;
3231 pa_source_set_fixed_latency(s->monitor_source, latency);
3234 /* Called from main thread */
3235 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s) {
3238 pa_sink_assert_ref(s);
3239 pa_assert_ctl_context();
3241 if (s->flags & PA_SINK_DYNAMIC_LATENCY)
3244 if (PA_SINK_IS_LINKED(s->state))
3245 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_FIXED_LATENCY, &latency, 0, NULL) == 0);
3247 latency = s->thread_info.fixed_latency;
3252 /* Called from IO thread */
3253 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency) {
3254 pa_sink_assert_ref(s);
3255 pa_sink_assert_io_context(s);
3257 if (s->flags & PA_SINK_DYNAMIC_LATENCY) {
3258 pa_assert(latency == 0);
3259 s->thread_info.fixed_latency = 0;
3261 if (s->monitor_source)
3262 pa_source_set_fixed_latency_within_thread(s->monitor_source, 0);
3267 pa_assert(latency >= ABSOLUTE_MIN_LATENCY);
3268 pa_assert(latency <= ABSOLUTE_MAX_LATENCY);
3270 if (s->thread_info.fixed_latency == latency)
3273 s->thread_info.fixed_latency = latency;
3275 if (PA_SINK_IS_LINKED(s->thread_info.state)) {
3279 PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state)
3280 if (i->update_sink_fixed_latency)
3281 i->update_sink_fixed_latency(i);
3284 pa_sink_invalidate_requested_latency(s, false);
3286 pa_source_set_fixed_latency_within_thread(s->monitor_source, latency);
3289 /* Called from main context */
3290 void pa_sink_set_port_latency_offset(pa_sink *s, int64_t offset) {
3291 pa_sink_assert_ref(s);
3293 s->port_latency_offset = offset;
3295 if (PA_SINK_IS_LINKED(s->state))
3296 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT_LATENCY_OFFSET, NULL, offset, NULL) == 0);
3298 s->thread_info.port_latency_offset = offset;
3301 /* Called from main context */
3302 size_t pa_sink_get_max_rewind(pa_sink *s) {
3304 pa_assert_ctl_context();
3305 pa_sink_assert_ref(s);
3307 if (!PA_SINK_IS_LINKED(s->state))
3308 return s->thread_info.max_rewind;
3310 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
3315 /* Called from main context */
3316 size_t pa_sink_get_max_request(pa_sink *s) {
3318 pa_sink_assert_ref(s);
3319 pa_assert_ctl_context();
3321 if (!PA_SINK_IS_LINKED(s->state))
3322 return s->thread_info.max_request;
3324 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MAX_REQUEST, &r, 0, NULL) == 0);
3329 /* Called from main context */
3330 int pa_sink_set_port(pa_sink *s, const char *name, bool save) {
3331 pa_device_port *port;
3334 pa_sink_assert_ref(s);
3335 pa_assert_ctl_context();
3338 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s->index, s->name);
3339 return -PA_ERR_NOTIMPLEMENTED;
3343 return -PA_ERR_NOENTITY;
3345 if (!(port = pa_hashmap_get(s->ports, name)))
3346 return -PA_ERR_NOENTITY;
3348 if (s->active_port == port) {
3349 s->save_port = s->save_port || save;
3353 if (s->flags & PA_SINK_DEFERRED_VOLUME) {
3354 struct sink_message_set_port msg = { .port = port, .ret = 0 };
3355 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
3359 ret = s->set_port(s, port);
3362 return -PA_ERR_NOENTITY;
3364 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
3366 pa_log_info("Changed port of sink %u \"%s\" to %s", s->index, s->name, port->name);
3368 s->active_port = port;
3369 s->save_port = save;
3371 pa_sink_set_port_latency_offset(s, s->active_port->latency_offset);
3373 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PORT_CHANGED], s);
3378 bool pa_device_init_icon(pa_proplist *p, bool is_sink) {
3379 const char *ff, *c, *t = NULL, *s = "", *profile, *bus;
3383 if (pa_proplist_contains(p, PA_PROP_DEVICE_ICON_NAME))
3386 if ((ff = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) {
3388 if (pa_streq(ff, "microphone"))
3389 t = "audio-input-microphone";
3390 else if (pa_streq(ff, "webcam"))
3392 else if (pa_streq(ff, "computer"))
3394 else if (pa_streq(ff, "handset"))
3396 else if (pa_streq(ff, "portable"))
3397 t = "multimedia-player";
3398 else if (pa_streq(ff, "tv"))
3399 t = "video-display";
3402 * The following icons are not part of the icon naming spec,
3403 * because Rodney Dawes sucks as the maintainer of that spec.
3405 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3407 else if (pa_streq(ff, "headset"))
3408 t = "audio-headset";
3409 else if (pa_streq(ff, "headphone"))
3410 t = "audio-headphones";
3411 else if (pa_streq(ff, "speaker"))
3412 t = "audio-speakers";
3413 else if (pa_streq(ff, "hands-free"))
3414 t = "audio-handsfree";
3418 if ((c = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS)))
3419 if (pa_streq(c, "modem"))
3426 t = "audio-input-microphone";
3429 if ((profile = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_NAME))) {
3430 if (strstr(profile, "analog"))
3432 else if (strstr(profile, "iec958"))
3434 else if (strstr(profile, "hdmi"))
3438 bus = pa_proplist_gets(p, PA_PROP_DEVICE_BUS);
3440 pa_proplist_setf(p, PA_PROP_DEVICE_ICON_NAME, "%s%s%s%s", t, pa_strempty(s), bus ? "-" : "", pa_strempty(bus));
3445 bool pa_device_init_description(pa_proplist *p, pa_card *card) {
3446 const char *s, *d = NULL, *k;
3449 if (pa_proplist_contains(p, PA_PROP_DEVICE_DESCRIPTION))
3453 if ((s = pa_proplist_gets(card->proplist, PA_PROP_DEVICE_DESCRIPTION)))
3457 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR)))
3458 if (pa_streq(s, "internal"))
3459 d = _("Built-in Audio");
3462 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS)))
3463 if (pa_streq(s, "modem"))
3467 d = pa_proplist_gets(p, PA_PROP_DEVICE_PRODUCT_NAME);
3472 k = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_DESCRIPTION);
3475 pa_proplist_setf(p, PA_PROP_DEVICE_DESCRIPTION, "%s %s", d, k);
3477 pa_proplist_sets(p, PA_PROP_DEVICE_DESCRIPTION, d);
3482 bool pa_device_init_intended_roles(pa_proplist *p) {
3486 if (pa_proplist_contains(p, PA_PROP_DEVICE_INTENDED_ROLES))
3489 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR)))
3490 if (pa_streq(s, "handset") || pa_streq(s, "hands-free")
3491 || pa_streq(s, "headset")) {
3492 pa_proplist_sets(p, PA_PROP_DEVICE_INTENDED_ROLES, "phone");
3499 unsigned pa_device_init_priority(pa_proplist *p) {
3501 unsigned priority = 0;
3505 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS))) {
3507 if (pa_streq(s, "sound"))
3509 else if (!pa_streq(s, "modem"))
3513 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) {
3515 if (pa_streq(s, "internal"))
3517 else if (pa_streq(s, "speaker"))
3519 else if (pa_streq(s, "headphone"))
3523 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_BUS))) {
3525 if (pa_streq(s, "pci"))
3527 else if (pa_streq(s, "usb"))
3529 else if (pa_streq(s, "bluetooth"))
3533 if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_NAME))) {
3535 if (pa_startswith(s, "analog-"))
3537 else if (pa_startswith(s, "iec958-"))
3544 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change, 0, pa_xfree);
3546 /* Called from the IO thread. */
3547 static pa_sink_volume_change *pa_sink_volume_change_new(pa_sink *s) {
3548 pa_sink_volume_change *c;
3549 if (!(c = pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change))))
3550 c = pa_xnew(pa_sink_volume_change, 1);
3552 PA_LLIST_INIT(pa_sink_volume_change, c);
3554 pa_cvolume_reset(&c->hw_volume, s->sample_spec.channels);
3558 /* Called from the IO thread. */
3559 static void pa_sink_volume_change_free(pa_sink_volume_change *c) {
3561 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change), c) < 0)
3565 /* Called from the IO thread. */
3566 void pa_sink_volume_change_push(pa_sink *s) {
3567 pa_sink_volume_change *c = NULL;
3568 pa_sink_volume_change *nc = NULL;
3569 pa_sink_volume_change *pc = NULL;
3570 uint32_t safety_margin = s->thread_info.volume_change_safety_margin;
3572 const char *direction = NULL;
3575 nc = pa_sink_volume_change_new(s);
3577 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3578 * Adding one more volume for HW would get us rid of this, but I am trying
3579 * to survive with the ones we already have. */
3580 pa_sw_cvolume_divide(&nc->hw_volume, &s->real_volume, &s->soft_volume);
3582 if (!s->thread_info.volume_changes && pa_cvolume_equal(&nc->hw_volume, &s->thread_info.current_hw_volume)) {
3583 pa_log_debug("Volume not changing");
3584 pa_sink_volume_change_free(nc);
3588 nc->at = pa_sink_get_latency_within_thread(s);
3589 nc->at += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
3591 if (s->thread_info.volume_changes_tail) {
3592 for (c = s->thread_info.volume_changes_tail; c; c = c->prev) {
3593 /* If volume is going up let's do it a bit late. If it is going
3594 * down let's do it a bit early. */
3595 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&c->hw_volume)) {
3596 if (nc->at + safety_margin > c->at) {
3597 nc->at += safety_margin;
3602 else if (nc->at - safety_margin > c->at) {
3603 nc->at -= safety_margin;
3611 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&s->thread_info.current_hw_volume)) {
3612 nc->at += safety_margin;
3615 nc->at -= safety_margin;
3618 PA_LLIST_PREPEND(pa_sink_volume_change, s->thread_info.volume_changes, nc);
3621 PA_LLIST_INSERT_AFTER(pa_sink_volume_change, s->thread_info.volume_changes, c, nc);
3624 pa_log_debug("Volume going %s to %d at %llu", direction, pa_cvolume_avg(&nc->hw_volume), (long long unsigned) nc->at);
3626 /* We can ignore volume events that came earlier but should happen later than this. */
3627 PA_LLIST_FOREACH_SAFE(c, pc, nc->next) {
3628 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at);
3629 pa_sink_volume_change_free(c);
3632 s->thread_info.volume_changes_tail = nc;
3635 /* Called from the IO thread. */
3636 static void pa_sink_volume_change_flush(pa_sink *s) {
3637 pa_sink_volume_change *c = s->thread_info.volume_changes;
3639 s->thread_info.volume_changes = NULL;
3640 s->thread_info.volume_changes_tail = NULL;
3642 pa_sink_volume_change *next = c->next;
3643 pa_sink_volume_change_free(c);
3648 /* Called from the IO thread. */
3649 bool pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next) {
3655 if (!s->thread_info.volume_changes || !PA_SINK_IS_LINKED(s->state)) {
3661 pa_assert(s->write_volume);
3663 now = pa_rtclock_now();
3665 while (s->thread_info.volume_changes && now >= s->thread_info.volume_changes->at) {
3666 pa_sink_volume_change *c = s->thread_info.volume_changes;
3667 PA_LLIST_REMOVE(pa_sink_volume_change, s->thread_info.volume_changes, c);
3668 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3669 pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at, (long long unsigned) (now - c->at));
3671 s->thread_info.current_hw_volume = c->hw_volume;
3672 pa_sink_volume_change_free(c);
3678 if (s->thread_info.volume_changes) {
3680 *usec_to_next = s->thread_info.volume_changes->at - now;
3681 if (pa_log_ratelimit(PA_LOG_DEBUG))
3682 pa_log_debug("Next volume change in %lld usec", (long long) (s->thread_info.volume_changes->at - now));
3687 s->thread_info.volume_changes_tail = NULL;
3692 /* Called from the IO thread. */
3693 static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes) {
3694 /* All the queued volume events later than current latency are shifted to happen earlier. */
3695 pa_sink_volume_change *c;
3696 pa_volume_t prev_vol = pa_cvolume_avg(&s->thread_info.current_hw_volume);
3697 pa_usec_t rewound = pa_bytes_to_usec(nbytes, &s->sample_spec);
3698 pa_usec_t limit = pa_sink_get_latency_within_thread(s);
3700 pa_log_debug("latency = %lld", (long long) limit);
3701 limit += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
3703 PA_LLIST_FOREACH(c, s->thread_info.volume_changes) {
3704 pa_usec_t modified_limit = limit;
3705 if (prev_vol > pa_cvolume_avg(&c->hw_volume))
3706 modified_limit -= s->thread_info.volume_change_safety_margin;
3708 modified_limit += s->thread_info.volume_change_safety_margin;
3709 if (c->at > modified_limit) {
3711 if (c->at < modified_limit)
3712 c->at = modified_limit;
3714 prev_vol = pa_cvolume_avg(&c->hw_volume);
3716 pa_sink_volume_change_apply(s, NULL);
3719 /* Called from the main thread */
3720 /* Gets the list of formats supported by the sink. The members and idxset must
3721 * be freed by the caller. */
3722 pa_idxset* pa_sink_get_formats(pa_sink *s) {
3727 if (s->get_formats) {
3728 /* Sink supports format query, all is good */
3729 ret = s->get_formats(s);
3731 /* Sink doesn't support format query, so assume it does PCM */
3732 pa_format_info *f = pa_format_info_new();
3733 f->encoding = PA_ENCODING_PCM;
3735 ret = pa_idxset_new(NULL, NULL);
3736 pa_idxset_put(ret, f, NULL);
3742 /* Called from the main thread */
3743 /* Allows an external source to set what formats a sink supports if the sink
3744 * permits this. The function makes a copy of the formats on success. */
3745 bool pa_sink_set_formats(pa_sink *s, pa_idxset *formats) {
3750 /* Sink supports setting formats -- let's give it a shot */
3751 return s->set_formats(s, formats);
3753 /* Sink doesn't support setting this -- bail out */
3757 /* Called from the main thread */
3758 /* Checks if the sink can accept this format */
3759 bool pa_sink_check_format(pa_sink *s, pa_format_info *f) {
3760 pa_idxset *formats = NULL;
3766 formats = pa_sink_get_formats(s);
3769 pa_format_info *finfo_device;
3772 PA_IDXSET_FOREACH(finfo_device, formats, i) {
3773 if (pa_format_info_is_compatible(finfo_device, f)) {
3779 pa_idxset_free(formats, (pa_free_cb_t) pa_format_info_free);
3785 /* Called from the main thread */
3786 /* Calculates the intersection between formats supported by the sink and
3787 * in_formats, and returns these, in the order of the sink's formats. */
3788 pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats) {
3789 pa_idxset *out_formats = pa_idxset_new(NULL, NULL), *sink_formats = NULL;
3790 pa_format_info *f_sink, *f_in;
3795 if (!in_formats || pa_idxset_isempty(in_formats))
3798 sink_formats = pa_sink_get_formats(s);
3800 PA_IDXSET_FOREACH(f_sink, sink_formats, i) {
3801 PA_IDXSET_FOREACH(f_in, in_formats, j) {
3802 if (pa_format_info_is_compatible(f_sink, f_in))
3803 pa_idxset_put(out_formats, pa_format_info_copy(f_in), NULL);
3809 pa_idxset_free(sink_formats, (pa_free_cb_t) pa_format_info_free);
3814 /* Called from the main thread. */
3815 void pa_sink_set_reference_volume_direct(pa_sink *s, const pa_cvolume *volume) {
3816 pa_cvolume old_volume;
3817 char old_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX];
3818 char new_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX];
3823 old_volume = s->reference_volume;
3825 if (pa_cvolume_equal(volume, &old_volume))
3828 s->reference_volume = *volume;
3829 pa_log_debug("The reference volume of sink %s changed from %s to %s.", s->name,
3830 pa_cvolume_snprint_verbose(old_volume_str, sizeof(old_volume_str), &old_volume, &s->channel_map,
3831 s->flags & PA_SINK_DECIBEL_VOLUME),
3832 pa_cvolume_snprint_verbose(new_volume_str, sizeof(new_volume_str), volume, &s->channel_map,
3833 s->flags & PA_SINK_DECIBEL_VOLUME));
3835 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
3836 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_VOLUME_CHANGED], s);