2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
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/core-util.h>
39 #include <pulsecore/source-output.h>
40 #include <pulsecore/namereg.h>
41 #include <pulsecore/core-subscribe.h>
42 #include <pulsecore/log.h>
43 #include <pulsecore/mix.h>
44 #include <pulsecore/flist.h>
48 #define ABSOLUTE_MIN_LATENCY (500)
49 #define ABSOLUTE_MAX_LATENCY (10*PA_USEC_PER_SEC)
50 #define DEFAULT_FIXED_LATENCY (250*PA_USEC_PER_MSEC)
52 PA_DEFINE_PUBLIC_CLASS(pa_source, pa_msgobject);
54 struct pa_source_volume_change {
58 PA_LLIST_FIELDS(pa_source_volume_change);
61 struct source_message_set_port {
66 static void source_free(pa_object *o);
68 static void pa_source_volume_change_push(pa_source *s);
69 static void pa_source_volume_change_flush(pa_source *s);
71 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data) {
75 data->proplist = pa_proplist_new();
76 data->ports = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
81 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name) {
85 data->name = pa_xstrdup(name);
88 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec) {
91 if ((data->sample_spec_is_set = !!spec))
92 data->sample_spec = *spec;
95 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map) {
98 if ((data->channel_map_is_set = !!map))
99 data->channel_map = *map;
102 void pa_source_new_data_set_alternate_sample_rate(pa_source_new_data *data, const uint32_t alternate_sample_rate) {
105 data->alternate_sample_rate_is_set = TRUE;
106 data->alternate_sample_rate = alternate_sample_rate;
109 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume) {
112 if ((data->volume_is_set = !!volume))
113 data->volume = *volume;
116 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute) {
119 data->muted_is_set = TRUE;
120 data->muted = !!mute;
123 void pa_source_new_data_set_port(pa_source_new_data *data, const char *port) {
126 pa_xfree(data->active_port);
127 data->active_port = pa_xstrdup(port);
130 void pa_source_new_data_done(pa_source_new_data *data) {
133 pa_proplist_free(data->proplist);
136 pa_device_port_hashmap_free(data->ports);
138 pa_xfree(data->name);
139 pa_xfree(data->active_port);
142 /* Called from main context */
143 static void reset_callbacks(pa_source *s) {
147 s->get_volume = NULL;
148 s->set_volume = NULL;
149 s->write_volume = NULL;
152 s->update_requested_latency = NULL;
154 s->get_formats = NULL;
155 s->update_rate = NULL;
158 /* Called from main context */
159 pa_source* pa_source_new(
161 pa_source_new_data *data,
162 pa_source_flags_t flags) {
166 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
171 pa_assert(data->name);
172 pa_assert_ctl_context();
174 s = pa_msgobject_new(pa_source);
176 if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SOURCE, s, data->namereg_fail))) {
177 pa_log_debug("Failed to register name %s.", data->name);
182 pa_source_new_data_set_name(data, name);
184 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_NEW], data) < 0) {
186 pa_namereg_unregister(core, name);
190 /* FIXME, need to free s here on failure */
192 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
193 pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
195 pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
197 if (!data->channel_map_is_set)
198 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
200 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
201 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
203 /* FIXME: There should probably be a general function for checking whether
204 * the source volume is allowed to be set, like there is for source outputs. */
205 pa_assert(!data->volume_is_set || !(flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
207 if (!data->volume_is_set) {
208 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
209 data->save_volume = FALSE;
212 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
213 pa_return_null_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec));
215 if (!data->muted_is_set)
219 pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->card->proplist);
221 pa_device_init_description(data->proplist);
222 pa_device_init_icon(data->proplist, FALSE);
223 pa_device_init_intended_roles(data->proplist);
225 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], data) < 0) {
227 pa_namereg_unregister(core, name);
231 s->parent.parent.free = source_free;
232 s->parent.process_msg = pa_source_process_msg;
235 s->state = PA_SOURCE_INIT;
238 s->suspend_cause = data->suspend_cause;
239 pa_source_set_mixer_dirty(s, FALSE);
240 s->name = pa_xstrdup(name);
241 s->proplist = pa_proplist_copy(data->proplist);
242 s->driver = pa_xstrdup(pa_path_get_filename(data->driver));
243 s->module = data->module;
244 s->card = data->card;
246 s->priority = pa_device_init_priority(s->proplist);
248 s->sample_spec = data->sample_spec;
249 s->channel_map = data->channel_map;
250 s->default_sample_rate = s->sample_spec.rate;
252 if (data->alternate_sample_rate_is_set)
253 s->alternate_sample_rate = data->alternate_sample_rate;
255 s->alternate_sample_rate = s->core->alternate_sample_rate;
257 if (s->sample_spec.rate == s->alternate_sample_rate) {
258 pa_log_warn("Default and alternate sample rates are the same.");
259 s->alternate_sample_rate = 0;
262 s->outputs = pa_idxset_new(NULL, NULL);
264 s->monitor_of = NULL;
265 s->output_from_master = NULL;
267 s->reference_volume = s->real_volume = data->volume;
268 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
269 s->base_volume = PA_VOLUME_NORM;
270 s->n_volume_steps = PA_VOLUME_NORM+1;
271 s->muted = data->muted;
272 s->refresh_volume = s->refresh_muted = FALSE;
279 /* As a minor optimization we just steal the list instead of
281 s->ports = data->ports;
284 s->active_port = NULL;
285 s->save_port = FALSE;
287 if (data->active_port)
288 if ((s->active_port = pa_hashmap_get(s->ports, data->active_port)))
289 s->save_port = data->save_port;
291 if (!s->active_port) {
295 PA_HASHMAP_FOREACH(p, s->ports, state)
296 if (!s->active_port || p->priority > s->active_port->priority)
301 s->latency_offset = s->active_port->latency_offset;
303 s->latency_offset = 0;
305 s->save_volume = data->save_volume;
306 s->save_muted = data->save_muted;
308 pa_silence_memchunk_get(
309 &core->silence_cache,
315 s->thread_info.rtpoll = NULL;
316 s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
317 s->thread_info.soft_volume = s->soft_volume;
318 s->thread_info.soft_muted = s->muted;
319 s->thread_info.state = s->state;
320 s->thread_info.max_rewind = 0;
321 s->thread_info.requested_latency_valid = FALSE;
322 s->thread_info.requested_latency = 0;
323 s->thread_info.min_latency = ABSOLUTE_MIN_LATENCY;
324 s->thread_info.max_latency = ABSOLUTE_MAX_LATENCY;
325 s->thread_info.fixed_latency = flags & PA_SOURCE_DYNAMIC_LATENCY ? 0 : DEFAULT_FIXED_LATENCY;
327 PA_LLIST_HEAD_INIT(pa_source_volume_change, s->thread_info.volume_changes);
328 s->thread_info.volume_changes_tail = NULL;
329 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
330 s->thread_info.volume_change_safety_margin = core->deferred_volume_safety_margin_usec;
331 s->thread_info.volume_change_extra_delay = core->deferred_volume_extra_delay_usec;
332 s->thread_info.latency_offset = s->latency_offset;
334 /* FIXME: This should probably be moved to pa_source_put() */
335 pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
338 pa_assert_se(pa_idxset_put(s->card->sources, s, NULL) >= 0);
340 pt = pa_proplist_to_string_sep(s->proplist, "\n ");
341 pa_log_info("Created source %u \"%s\" with sample spec %s and channel map %s\n %s",
344 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
345 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map),
352 /* Called from main context */
353 static int source_set_state(pa_source *s, pa_source_state_t state) {
355 pa_bool_t suspend_change;
356 pa_source_state_t original_state;
359 pa_assert_ctl_context();
361 if (s->state == state)
364 original_state = s->state;
367 (original_state == PA_SOURCE_SUSPENDED && PA_SOURCE_IS_OPENED(state)) ||
368 (PA_SOURCE_IS_OPENED(original_state) && state == PA_SOURCE_SUSPENDED);
371 if ((ret = s->set_state(s, state)) < 0)
375 if ((ret = pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL)) < 0) {
378 s->set_state(s, original_state);
385 if (state != PA_SOURCE_UNLINKED) { /* if we enter UNLINKED state pa_source_unlink() will fire the appropriate events */
386 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
387 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
390 if (suspend_change) {
394 /* We're suspending or resuming, tell everyone about it */
396 PA_IDXSET_FOREACH(o, s->outputs, idx)
397 if (s->state == PA_SOURCE_SUSPENDED &&
398 (o->flags & PA_SOURCE_OUTPUT_KILL_ON_SUSPEND))
399 pa_source_output_kill(o);
401 o->suspend(o, state == PA_SOURCE_SUSPENDED);
407 void pa_source_set_get_volume_callback(pa_source *s, pa_source_cb_t cb) {
413 void pa_source_set_set_volume_callback(pa_source *s, pa_source_cb_t cb) {
414 pa_source_flags_t flags;
417 pa_assert(!s->write_volume || cb);
421 /* Save the current flags so we can tell if they've changed */
425 /* The source implementor is responsible for setting decibel volume support */
426 s->flags |= PA_SOURCE_HW_VOLUME_CTRL;
428 s->flags &= ~PA_SOURCE_HW_VOLUME_CTRL;
429 /* See note below in pa_source_put() about volume sharing and decibel volumes */
430 pa_source_enable_decibel_volume(s, !(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
433 /* If the flags have changed after init, let any clients know via a change event */
434 if (s->state != PA_SOURCE_INIT && flags != s->flags)
435 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
438 void pa_source_set_write_volume_callback(pa_source *s, pa_source_cb_t cb) {
439 pa_source_flags_t flags;
442 pa_assert(!cb || s->set_volume);
444 s->write_volume = cb;
446 /* Save the current flags so we can tell if they've changed */
450 s->flags |= PA_SOURCE_DEFERRED_VOLUME;
452 s->flags &= ~PA_SOURCE_DEFERRED_VOLUME;
454 /* If the flags have changed after init, let any clients know via a change event */
455 if (s->state != PA_SOURCE_INIT && flags != s->flags)
456 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
459 void pa_source_set_get_mute_callback(pa_source *s, pa_source_cb_t cb) {
465 void pa_source_set_set_mute_callback(pa_source *s, pa_source_cb_t cb) {
466 pa_source_flags_t flags;
472 /* Save the current flags so we can tell if they've changed */
476 s->flags |= PA_SOURCE_HW_MUTE_CTRL;
478 s->flags &= ~PA_SOURCE_HW_MUTE_CTRL;
480 /* If the flags have changed after init, let any clients know via a change event */
481 if (s->state != PA_SOURCE_INIT && flags != s->flags)
482 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
485 static void enable_flat_volume(pa_source *s, pa_bool_t enable) {
486 pa_source_flags_t flags;
490 /* Always follow the overall user preference here */
491 enable = enable && s->core->flat_volumes;
493 /* Save the current flags so we can tell if they've changed */
497 s->flags |= PA_SOURCE_FLAT_VOLUME;
499 s->flags &= ~PA_SOURCE_FLAT_VOLUME;
501 /* If the flags have changed after init, let any clients know via a change event */
502 if (s->state != PA_SOURCE_INIT && flags != s->flags)
503 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
506 void pa_source_enable_decibel_volume(pa_source *s, pa_bool_t enable) {
507 pa_source_flags_t flags;
511 /* Save the current flags so we can tell if they've changed */
515 s->flags |= PA_SOURCE_DECIBEL_VOLUME;
516 enable_flat_volume(s, TRUE);
518 s->flags &= ~PA_SOURCE_DECIBEL_VOLUME;
519 enable_flat_volume(s, FALSE);
522 /* If the flags have changed after init, let any clients know via a change event */
523 if (s->state != PA_SOURCE_INIT && flags != s->flags)
524 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
527 /* Called from main context */
528 void pa_source_put(pa_source *s) {
529 pa_source_assert_ref(s);
530 pa_assert_ctl_context();
532 pa_assert(s->state == PA_SOURCE_INIT);
533 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER) || s->output_from_master);
535 /* The following fields must be initialized properly when calling _put() */
536 pa_assert(s->asyncmsgq);
537 pa_assert(s->thread_info.min_latency <= s->thread_info.max_latency);
539 /* Generally, flags should be initialized via pa_source_new(). As a
540 * special exception we allow some volume related flags to be set
541 * between _new() and _put() by the callback setter functions above.
543 * Thus we implement a couple safeguards here which ensure the above
544 * setters were used (or at least the implementor made manual changes
545 * in a compatible way).
547 * Note: All of these flags set here can change over the life time
549 pa_assert(!(s->flags & PA_SOURCE_HW_VOLUME_CTRL) || s->set_volume);
550 pa_assert(!(s->flags & PA_SOURCE_DEFERRED_VOLUME) || s->write_volume);
551 pa_assert(!(s->flags & PA_SOURCE_HW_MUTE_CTRL) || s->set_mute);
553 /* XXX: Currently decibel volume is disabled for all sources that use volume
554 * sharing. When the master source supports decibel volume, it would be good
555 * to have the flag also in the filter source, but currently we don't do that
556 * so that the flags of the filter source never change when it's moved from
557 * a master source to another. One solution for this problem would be to
558 * remove user-visible volume altogether from filter sources when volume
559 * sharing is used, but the current approach was easier to implement... */
560 /* We always support decibel volumes in software, otherwise we leave it to
561 * the source implementor to set this flag as needed.
563 * Note: This flag can also change over the life time of the source. */
564 if (!(s->flags & PA_SOURCE_HW_VOLUME_CTRL) && !(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
565 pa_source_enable_decibel_volume(s, TRUE);
567 /* If the source implementor support DB volumes by itself, we should always
568 * try and enable flat volumes too */
569 if ((s->flags & PA_SOURCE_DECIBEL_VOLUME))
570 enable_flat_volume(s, TRUE);
572 if (s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER) {
573 pa_source *root_source = pa_source_get_master(s);
575 pa_assert(PA_LIKELY(root_source));
577 s->reference_volume = root_source->reference_volume;
578 pa_cvolume_remap(&s->reference_volume, &root_source->channel_map, &s->channel_map);
580 s->real_volume = root_source->real_volume;
581 pa_cvolume_remap(&s->real_volume, &root_source->channel_map, &s->channel_map);
583 /* We assume that if the sink implementor changed the default
584 * volume he did so in real_volume, because that is the usual
585 * place where he is supposed to place his changes. */
586 s->reference_volume = s->real_volume;
588 s->thread_info.soft_volume = s->soft_volume;
589 s->thread_info.soft_muted = s->muted;
590 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
592 pa_assert((s->flags & PA_SOURCE_HW_VOLUME_CTRL)
593 || (s->base_volume == PA_VOLUME_NORM
594 && ((s->flags & PA_SOURCE_DECIBEL_VOLUME || (s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)))));
595 pa_assert(!(s->flags & PA_SOURCE_DECIBEL_VOLUME) || s->n_volume_steps == PA_VOLUME_NORM+1);
596 pa_assert(!(s->flags & PA_SOURCE_DYNAMIC_LATENCY) == (s->thread_info.fixed_latency != 0));
598 if (s->suspend_cause)
599 pa_assert_se(source_set_state(s, PA_SOURCE_SUSPENDED) == 0);
601 pa_assert_se(source_set_state(s, PA_SOURCE_IDLE) == 0);
603 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
604 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PUT], s);
607 /* Called from main context */
608 void pa_source_unlink(pa_source *s) {
610 pa_source_output *o, *j = NULL;
613 pa_assert_ctl_context();
615 /* See pa_sink_unlink() for a couple of comments how this function
618 linked = PA_SOURCE_IS_LINKED(s->state);
621 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
623 if (s->state != PA_SOURCE_UNLINKED)
624 pa_namereg_unregister(s->core, s->name);
625 pa_idxset_remove_by_data(s->core->sources, s, NULL);
628 pa_idxset_remove_by_data(s->card->sources, s, NULL);
630 while ((o = pa_idxset_first(s->outputs, NULL))) {
632 pa_source_output_kill(o);
637 source_set_state(s, PA_SOURCE_UNLINKED);
639 s->state = PA_SOURCE_UNLINKED;
644 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
645 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
649 /* Called from main context */
650 static void source_free(pa_object *o) {
651 pa_source *s = PA_SOURCE(o);
654 pa_assert_ctl_context();
655 pa_assert(pa_source_refcnt(s) == 0);
657 if (PA_SOURCE_IS_LINKED(s->state))
660 pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
662 pa_idxset_free(s->outputs, NULL, NULL);
663 pa_hashmap_free(s->thread_info.outputs, (pa_free_cb_t) pa_source_output_unref);
665 if (s->silence.memblock)
666 pa_memblock_unref(s->silence.memblock);
672 pa_proplist_free(s->proplist);
675 pa_device_port_hashmap_free(s->ports);
680 /* Called from main context, and not while the IO thread is active, please */
681 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
682 pa_source_assert_ref(s);
683 pa_assert_ctl_context();
688 /* Called from main context, and not while the IO thread is active, please */
689 void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flags_t value) {
690 pa_source_assert_ref(s);
691 pa_assert_ctl_context();
696 /* For now, allow only a minimal set of flags to be changed. */
697 pa_assert((mask & ~(PA_SOURCE_DYNAMIC_LATENCY|PA_SOURCE_LATENCY)) == 0);
699 s->flags = (s->flags & ~mask) | (value & mask);
702 /* Called from IO context, or before _put() from main context */
703 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
704 pa_source_assert_ref(s);
705 pa_source_assert_io_context(s);
707 s->thread_info.rtpoll = p;
710 /* Called from main context */
711 int pa_source_update_status(pa_source*s) {
712 pa_source_assert_ref(s);
713 pa_assert_ctl_context();
714 pa_assert(PA_SOURCE_IS_LINKED(s->state));
716 if (s->state == PA_SOURCE_SUSPENDED)
719 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
722 /* Called from any context - must be threadsafe */
723 void pa_source_set_mixer_dirty(pa_source *s, pa_bool_t is_dirty)
725 pa_atomic_store(&s->mixer_dirty, is_dirty ? 1 : 0);
728 /* Called from main context */
729 int pa_source_suspend(pa_source *s, pa_bool_t suspend, pa_suspend_cause_t cause) {
730 pa_source_assert_ref(s);
731 pa_assert_ctl_context();
732 pa_assert(PA_SOURCE_IS_LINKED(s->state));
733 pa_assert(cause != 0);
735 if (s->monitor_of && cause != PA_SUSPEND_PASSTHROUGH)
736 return -PA_ERR_NOTSUPPORTED;
739 s->suspend_cause |= cause;
741 s->suspend_cause &= ~cause;
743 if (!(s->suspend_cause & PA_SUSPEND_SESSION) && (pa_atomic_load(&s->mixer_dirty) != 0)) {
744 /* This might look racy but isn't: If somebody sets mixer_dirty exactly here,
745 it'll be handled just fine. */
746 pa_source_set_mixer_dirty(s, FALSE);
747 pa_log_debug("Mixer is now accessible. Updating alsa mixer settings.");
748 if (s->active_port && s->set_port) {
749 if (s->flags & PA_SOURCE_DEFERRED_VOLUME) {
750 struct source_message_set_port msg = { .port = s->active_port, .ret = 0 };
751 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
754 s->set_port(s, s->active_port);
764 if ((pa_source_get_state(s) == PA_SOURCE_SUSPENDED) == !!s->suspend_cause)
767 pa_log_debug("Suspend cause of source %s is 0x%04x, %s", s->name, s->suspend_cause, s->suspend_cause ? "suspending" : "resuming");
769 if (s->suspend_cause)
770 return source_set_state(s, PA_SOURCE_SUSPENDED);
772 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
775 /* Called from main context */
776 int pa_source_sync_suspend(pa_source *s) {
777 pa_sink_state_t state;
779 pa_source_assert_ref(s);
780 pa_assert_ctl_context();
781 pa_assert(PA_SOURCE_IS_LINKED(s->state));
782 pa_assert(s->monitor_of);
784 state = pa_sink_get_state(s->monitor_of);
786 if (state == PA_SINK_SUSPENDED)
787 return source_set_state(s, PA_SOURCE_SUSPENDED);
789 pa_assert(PA_SINK_IS_OPENED(state));
791 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
794 /* Called from main context */
795 pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q) {
796 pa_source_output *o, *n;
799 pa_source_assert_ref(s);
800 pa_assert_ctl_context();
801 pa_assert(PA_SOURCE_IS_LINKED(s->state));
806 for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = n) {
807 n = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx));
809 pa_source_output_ref(o);
811 if (pa_source_output_start_move(o) >= 0)
814 pa_source_output_unref(o);
820 /* Called from main context */
821 void pa_source_move_all_finish(pa_source *s, pa_queue *q, pa_bool_t save) {
824 pa_source_assert_ref(s);
825 pa_assert_ctl_context();
826 pa_assert(PA_SOURCE_IS_LINKED(s->state));
829 while ((o = PA_SOURCE_OUTPUT(pa_queue_pop(q)))) {
830 if (pa_source_output_finish_move(o, s, save) < 0)
831 pa_source_output_fail_move(o);
833 pa_source_output_unref(o);
836 pa_queue_free(q, NULL);
839 /* Called from main context */
840 void pa_source_move_all_fail(pa_queue *q) {
843 pa_assert_ctl_context();
846 while ((o = PA_SOURCE_OUTPUT(pa_queue_pop(q)))) {
847 pa_source_output_fail_move(o);
848 pa_source_output_unref(o);
851 pa_queue_free(q, NULL);
854 /* Called from IO thread context */
855 void pa_source_process_rewind(pa_source *s, size_t nbytes) {
859 pa_source_assert_ref(s);
860 pa_source_assert_io_context(s);
861 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
866 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
869 pa_log_debug("Processing rewind...");
871 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state) {
872 pa_source_output_assert_ref(o);
873 pa_source_output_process_rewind(o, nbytes);
877 /* Called from IO thread context */
878 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
882 pa_source_assert_ref(s);
883 pa_source_assert_io_context(s);
884 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
887 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
890 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
891 pa_memchunk vchunk = *chunk;
893 pa_memblock_ref(vchunk.memblock);
894 pa_memchunk_make_writable(&vchunk, 0);
896 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
897 pa_silence_memchunk(&vchunk, &s->sample_spec);
899 pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
901 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
902 pa_source_output_assert_ref(o);
904 if (!o->thread_info.direct_on_input)
905 pa_source_output_push(o, &vchunk);
908 pa_memblock_unref(vchunk.memblock);
911 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
912 pa_source_output_assert_ref(o);
914 if (!o->thread_info.direct_on_input)
915 pa_source_output_push(o, chunk);
920 /* Called from IO thread context */
921 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk) {
922 pa_source_assert_ref(s);
923 pa_source_assert_io_context(s);
924 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
925 pa_source_output_assert_ref(o);
926 pa_assert(o->thread_info.direct_on_input);
929 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
932 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
933 pa_memchunk vchunk = *chunk;
935 pa_memblock_ref(vchunk.memblock);
936 pa_memchunk_make_writable(&vchunk, 0);
938 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
939 pa_silence_memchunk(&vchunk, &s->sample_spec);
941 pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
943 pa_source_output_push(o, &vchunk);
945 pa_memblock_unref(vchunk.memblock);
947 pa_source_output_push(o, chunk);
950 /* Called from main thread */
951 pa_bool_t pa_source_update_rate(pa_source *s, uint32_t rate, pa_bool_t passthrough)
953 if (s->update_rate) {
954 uint32_t desired_rate = rate;
955 uint32_t default_rate = s->default_sample_rate;
956 uint32_t alternate_rate = s->alternate_sample_rate;
959 pa_bool_t use_alternate = FALSE;
961 if (PA_UNLIKELY(default_rate == alternate_rate)) {
962 pa_log_warn("Default and alternate sample rates are the same.");
966 if (PA_SOURCE_IS_RUNNING(s->state)) {
967 pa_log_info("Cannot update rate, SOURCE_IS_RUNNING, will keep using %u Hz",
968 s->sample_spec.rate);
972 if (PA_UNLIKELY (desired_rate < 8000 ||
973 desired_rate > PA_RATE_MAX))
977 pa_assert(default_rate % 4000 || default_rate % 11025);
978 pa_assert(alternate_rate % 4000 || alternate_rate % 11025);
980 if (default_rate % 4000) {
981 /* default is a 11025 multiple */
982 if ((alternate_rate % 4000 == 0) && (desired_rate % 4000 == 0))
985 /* default is 4000 multiple */
986 if ((alternate_rate % 11025 == 0) && (desired_rate % 11025 == 0))
991 desired_rate = alternate_rate;
993 desired_rate = default_rate;
995 desired_rate = rate; /* use stream sampling rate, discard default/alternate settings */
998 if (desired_rate == s->sample_spec.rate)
1001 if (!passthrough && pa_source_used_by(s) > 0)
1004 pa_log_debug("Suspending source %s due to changing the sample rate.", s->name);
1005 pa_source_suspend(s, TRUE, PA_SUSPEND_IDLE); /* needed before rate update, will be resumed automatically */
1007 if (s->update_rate(s, desired_rate) == TRUE) {
1008 pa_log_info("Changed sampling rate successfully ");
1010 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1011 if (o->state == PA_SOURCE_OUTPUT_CORKED)
1012 pa_source_output_update_rate(o);
1020 /* Called from main thread */
1021 pa_usec_t pa_source_get_latency(pa_source *s) {
1024 pa_source_assert_ref(s);
1025 pa_assert_ctl_context();
1026 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1028 if (s->state == PA_SOURCE_SUSPENDED)
1031 if (!(s->flags & PA_SOURCE_LATENCY))
1034 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
1036 /* usec is unsigned, so check that the offset can be added to usec without
1038 if (-s->latency_offset <= (int64_t) usec)
1039 usec += s->latency_offset;
1046 /* Called from IO thread */
1047 pa_usec_t pa_source_get_latency_within_thread(pa_source *s) {
1051 pa_source_assert_ref(s);
1052 pa_source_assert_io_context(s);
1053 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
1055 /* The returned value is supposed to be in the time domain of the sound card! */
1057 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
1060 if (!(s->flags & PA_SOURCE_LATENCY))
1063 o = PA_MSGOBJECT(s);
1065 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1067 if (o->process_msg(o, PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
1070 /* usec is unsigned, so check that the offset can be added to usec without
1072 if (-s->thread_info.latency_offset <= (int64_t) usec)
1073 usec += s->thread_info.latency_offset;
1080 /* Called from the main thread (and also from the IO thread while the main
1081 * thread is waiting).
1083 * When a source uses volume sharing, it never has the PA_SOURCE_FLAT_VOLUME flag
1084 * set. Instead, flat volume mode is detected by checking whether the root source
1085 * has the flag set. */
1086 pa_bool_t pa_source_flat_volume_enabled(pa_source *s) {
1087 pa_source_assert_ref(s);
1089 s = pa_source_get_master(s);
1092 return (s->flags & PA_SOURCE_FLAT_VOLUME);
1097 /* Called from the main thread (and also from the IO thread while the main
1098 * thread is waiting). */
1099 pa_source *pa_source_get_master(pa_source *s) {
1100 pa_source_assert_ref(s);
1102 while (s && (s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1103 if (PA_UNLIKELY(!s->output_from_master))
1106 s = s->output_from_master->source;
1112 /* Called from main context */
1113 pa_bool_t pa_source_is_passthrough(pa_source *s) {
1115 pa_source_assert_ref(s);
1117 /* NB Currently only monitor sources support passthrough mode */
1118 return (s->monitor_of && pa_sink_is_passthrough(s->monitor_of));
1121 /* Called from main context */
1122 void pa_source_enter_passthrough(pa_source *s) {
1125 /* set the volume to NORM */
1126 s->saved_volume = *pa_source_get_volume(s, TRUE);
1127 s->saved_save_volume = s->save_volume;
1129 pa_cvolume_set(&volume, s->sample_spec.channels, PA_MIN(s->base_volume, PA_VOLUME_NORM));
1130 pa_source_set_volume(s, &volume, TRUE, FALSE);
1133 /* Called from main context */
1134 void pa_source_leave_passthrough(pa_source *s) {
1135 /* Restore source volume to what it was before we entered passthrough mode */
1136 pa_source_set_volume(s, &s->saved_volume, TRUE, s->saved_save_volume);
1138 pa_cvolume_init(&s->saved_volume);
1139 s->saved_save_volume = FALSE;
1142 /* Called from main context. */
1143 static void compute_reference_ratio(pa_source_output *o) {
1145 pa_cvolume remapped;
1148 pa_assert(pa_source_flat_volume_enabled(o->source));
1151 * Calculates the reference ratio from the source's reference
1152 * volume. This basically calculates:
1154 * o->reference_ratio = o->volume / o->source->reference_volume
1157 remapped = o->source->reference_volume;
1158 pa_cvolume_remap(&remapped, &o->source->channel_map, &o->channel_map);
1160 o->reference_ratio.channels = o->sample_spec.channels;
1162 for (c = 0; c < o->sample_spec.channels; c++) {
1164 /* We don't update when the source volume is 0 anyway */
1165 if (remapped.values[c] <= PA_VOLUME_MUTED)
1168 /* Don't update the reference ratio unless necessary */
1169 if (pa_sw_volume_multiply(
1170 o->reference_ratio.values[c],
1171 remapped.values[c]) == o->volume.values[c])
1174 o->reference_ratio.values[c] = pa_sw_volume_divide(
1175 o->volume.values[c],
1176 remapped.values[c]);
1180 /* Called from main context. Only called for the root source in volume sharing
1181 * cases, except for internal recursive calls. */
1182 static void compute_reference_ratios(pa_source *s) {
1184 pa_source_output *o;
1186 pa_source_assert_ref(s);
1187 pa_assert_ctl_context();
1188 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1189 pa_assert(pa_source_flat_volume_enabled(s));
1191 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1192 compute_reference_ratio(o);
1194 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1195 compute_reference_ratios(o->destination_source);
1199 /* Called from main context. Only called for the root source in volume sharing
1200 * cases, except for internal recursive calls. */
1201 static void compute_real_ratios(pa_source *s) {
1202 pa_source_output *o;
1205 pa_source_assert_ref(s);
1206 pa_assert_ctl_context();
1207 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1208 pa_assert(pa_source_flat_volume_enabled(s));
1210 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1212 pa_cvolume remapped;
1214 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1215 /* The origin source uses volume sharing, so this input's real ratio
1216 * is handled as a special case - the real ratio must be 0 dB, and
1217 * as a result i->soft_volume must equal i->volume_factor. */
1218 pa_cvolume_reset(&o->real_ratio, o->real_ratio.channels);
1219 o->soft_volume = o->volume_factor;
1221 compute_real_ratios(o->destination_source);
1227 * This basically calculates:
1229 * i->real_ratio := i->volume / s->real_volume
1230 * i->soft_volume := i->real_ratio * i->volume_factor
1233 remapped = s->real_volume;
1234 pa_cvolume_remap(&remapped, &s->channel_map, &o->channel_map);
1236 o->real_ratio.channels = o->sample_spec.channels;
1237 o->soft_volume.channels = o->sample_spec.channels;
1239 for (c = 0; c < o->sample_spec.channels; c++) {
1241 if (remapped.values[c] <= PA_VOLUME_MUTED) {
1242 /* We leave o->real_ratio untouched */
1243 o->soft_volume.values[c] = PA_VOLUME_MUTED;
1247 /* Don't lose accuracy unless necessary */
1248 if (pa_sw_volume_multiply(
1249 o->real_ratio.values[c],
1250 remapped.values[c]) != o->volume.values[c])
1252 o->real_ratio.values[c] = pa_sw_volume_divide(
1253 o->volume.values[c],
1254 remapped.values[c]);
1256 o->soft_volume.values[c] = pa_sw_volume_multiply(
1257 o->real_ratio.values[c],
1258 o->volume_factor.values[c]);
1261 /* We don't copy the soft_volume to the thread_info data
1262 * here. That must be done by the caller */
1266 static pa_cvolume *cvolume_remap_minimal_impact(
1268 const pa_cvolume *template,
1269 const pa_channel_map *from,
1270 const pa_channel_map *to) {
1275 pa_assert(template);
1278 pa_assert(pa_cvolume_compatible_with_channel_map(v, from));
1279 pa_assert(pa_cvolume_compatible_with_channel_map(template, to));
1281 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1282 * mapping from source output to source volumes:
1284 * If template is a possible remapping from v it is used instead
1285 * of remapping anew.
1287 * If the channel maps don't match we set an all-channel volume on
1288 * the source to ensure that changing a volume on one stream has no
1289 * effect that cannot be compensated for in another stream that
1290 * does not have the same channel map as the source. */
1292 if (pa_channel_map_equal(from, to))
1296 if (pa_cvolume_equal(pa_cvolume_remap(&t, to, from), v)) {
1301 pa_cvolume_set(v, to->channels, pa_cvolume_max(v));
1305 /* Called from main thread. Only called for the root source in volume sharing
1306 * cases, except for internal recursive calls. */
1307 static void get_maximum_output_volume(pa_source *s, pa_cvolume *max_volume, const pa_channel_map *channel_map) {
1308 pa_source_output *o;
1311 pa_source_assert_ref(s);
1312 pa_assert(max_volume);
1313 pa_assert(channel_map);
1314 pa_assert(pa_source_flat_volume_enabled(s));
1316 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1317 pa_cvolume remapped;
1319 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1320 get_maximum_output_volume(o->destination_source, max_volume, channel_map);
1322 /* Ignore this output. The origin source uses volume sharing, so this
1323 * output's volume will be set to be equal to the root source's real
1324 * volume. Obviously this output's current volume must not then
1325 * affect what the root source's real volume will be. */
1329 remapped = o->volume;
1330 cvolume_remap_minimal_impact(&remapped, max_volume, &o->channel_map, channel_map);
1331 pa_cvolume_merge(max_volume, max_volume, &remapped);
1335 /* Called from main thread. Only called for the root source in volume sharing
1336 * cases, except for internal recursive calls. */
1337 static pa_bool_t has_outputs(pa_source *s) {
1338 pa_source_output *o;
1341 pa_source_assert_ref(s);
1343 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1344 if (!o->destination_source || !(o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER) || has_outputs(o->destination_source))
1351 /* Called from main thread. Only called for the root source in volume sharing
1352 * cases, except for internal recursive calls. */
1353 static void update_real_volume(pa_source *s, const pa_cvolume *new_volume, pa_channel_map *channel_map) {
1354 pa_source_output *o;
1357 pa_source_assert_ref(s);
1358 pa_assert(new_volume);
1359 pa_assert(channel_map);
1361 s->real_volume = *new_volume;
1362 pa_cvolume_remap(&s->real_volume, channel_map, &s->channel_map);
1364 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1365 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1366 if (pa_source_flat_volume_enabled(s)) {
1367 pa_cvolume old_volume = o->volume;
1369 /* Follow the root source's real volume. */
1370 o->volume = *new_volume;
1371 pa_cvolume_remap(&o->volume, channel_map, &o->channel_map);
1372 compute_reference_ratio(o);
1374 /* The volume changed, let's tell people so */
1375 if (!pa_cvolume_equal(&old_volume, &o->volume)) {
1376 if (o->volume_changed)
1377 o->volume_changed(o);
1379 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1383 update_real_volume(o->destination_source, new_volume, channel_map);
1388 /* Called from main thread. Only called for the root source in shared volume
1390 static void compute_real_volume(pa_source *s) {
1391 pa_source_assert_ref(s);
1392 pa_assert_ctl_context();
1393 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1394 pa_assert(pa_source_flat_volume_enabled(s));
1395 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1397 /* This determines the maximum volume of all streams and sets
1398 * s->real_volume accordingly. */
1400 if (!has_outputs(s)) {
1401 /* In the special case that we have no source outputs we leave the
1402 * volume unmodified. */
1403 update_real_volume(s, &s->reference_volume, &s->channel_map);
1407 pa_cvolume_mute(&s->real_volume, s->channel_map.channels);
1409 /* First let's determine the new maximum volume of all outputs
1410 * connected to this source */
1411 get_maximum_output_volume(s, &s->real_volume, &s->channel_map);
1412 update_real_volume(s, &s->real_volume, &s->channel_map);
1414 /* Then, let's update the real ratios/soft volumes of all outputs
1415 * connected to this source */
1416 compute_real_ratios(s);
1419 /* Called from main thread. Only called for the root source in shared volume
1420 * cases, except for internal recursive calls. */
1421 static void propagate_reference_volume(pa_source *s) {
1422 pa_source_output *o;
1425 pa_source_assert_ref(s);
1426 pa_assert_ctl_context();
1427 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1428 pa_assert(pa_source_flat_volume_enabled(s));
1430 /* This is called whenever the source volume changes that is not
1431 * caused by a source output volume change. We need to fix up the
1432 * source output volumes accordingly */
1434 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1435 pa_cvolume old_volume;
1437 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1438 propagate_reference_volume(o->destination_source);
1440 /* Since the origin source uses volume sharing, this output's volume
1441 * needs to be updated to match the root source's real volume, but
1442 * that will be done later in update_shared_real_volume(). */
1446 old_volume = o->volume;
1448 /* This basically calculates:
1450 * o->volume := o->reference_volume * o->reference_ratio */
1452 o->volume = s->reference_volume;
1453 pa_cvolume_remap(&o->volume, &s->channel_map, &o->channel_map);
1454 pa_sw_cvolume_multiply(&o->volume, &o->volume, &o->reference_ratio);
1456 /* The volume changed, let's tell people so */
1457 if (!pa_cvolume_equal(&old_volume, &o->volume)) {
1459 if (o->volume_changed)
1460 o->volume_changed(o);
1462 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1467 /* Called from main thread. Only called for the root source in volume sharing
1468 * cases, except for internal recursive calls. The return value indicates
1469 * whether any reference volume actually changed. */
1470 static pa_bool_t update_reference_volume(pa_source *s, const pa_cvolume *v, const pa_channel_map *channel_map, pa_bool_t save) {
1472 pa_bool_t reference_volume_changed;
1473 pa_source_output *o;
1476 pa_source_assert_ref(s);
1477 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1479 pa_assert(channel_map);
1480 pa_assert(pa_cvolume_valid(v));
1483 pa_cvolume_remap(&volume, channel_map, &s->channel_map);
1485 reference_volume_changed = !pa_cvolume_equal(&volume, &s->reference_volume);
1486 s->reference_volume = volume;
1488 s->save_volume = (!reference_volume_changed && s->save_volume) || save;
1490 if (reference_volume_changed)
1491 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1492 else if (!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1493 /* If the root source's volume doesn't change, then there can't be any
1494 * changes in the other source in the source tree either.
1496 * It's probably theoretically possible that even if the root source's
1497 * volume changes slightly, some filter source doesn't change its volume
1498 * due to rounding errors. If that happens, we still want to propagate
1499 * the changed root source volume to the sources connected to the
1500 * intermediate source that didn't change its volume. This theoretical
1501 * possibility is the reason why we have that !(s->flags &
1502 * PA_SOURCE_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1503 * notice even if we returned here FALSE always if
1504 * reference_volume_changed is FALSE. */
1507 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1508 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1509 update_reference_volume(o->destination_source, v, channel_map, FALSE);
1515 /* Called from main thread */
1516 void pa_source_set_volume(
1518 const pa_cvolume *volume,
1522 pa_cvolume new_reference_volume;
1523 pa_source *root_source;
1525 pa_source_assert_ref(s);
1526 pa_assert_ctl_context();
1527 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1528 pa_assert(!volume || pa_cvolume_valid(volume));
1529 pa_assert(volume || pa_source_flat_volume_enabled(s));
1530 pa_assert(!volume || volume->channels == 1 || pa_cvolume_compatible(volume, &s->sample_spec));
1532 /* make sure we don't change the volume in PASSTHROUGH mode ...
1533 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1534 if (pa_source_is_passthrough(s) && (!volume || !pa_cvolume_is_norm(volume))) {
1535 pa_log_warn("Cannot change volume, source is monitor of a PASSTHROUGH sink");
1539 /* In case of volume sharing, the volume is set for the root source first,
1540 * from which it's then propagated to the sharing sources. */
1541 root_source = pa_source_get_master(s);
1543 if (PA_UNLIKELY(!root_source))
1546 /* As a special exception we accept mono volumes on all sources --
1547 * even on those with more complex channel maps */
1550 if (pa_cvolume_compatible(volume, &s->sample_spec))
1551 new_reference_volume = *volume;
1553 new_reference_volume = s->reference_volume;
1554 pa_cvolume_scale(&new_reference_volume, pa_cvolume_max(volume));
1557 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_source->channel_map);
1559 if (update_reference_volume(root_source, &new_reference_volume, &root_source->channel_map, save)) {
1560 if (pa_source_flat_volume_enabled(root_source)) {
1561 /* OK, propagate this volume change back to the outputs */
1562 propagate_reference_volume(root_source);
1564 /* And now recalculate the real volume */
1565 compute_real_volume(root_source);
1567 update_real_volume(root_source, &root_source->reference_volume, &root_source->channel_map);
1571 /* If volume is NULL we synchronize the source's real and
1572 * reference volumes with the stream volumes. */
1574 pa_assert(pa_source_flat_volume_enabled(root_source));
1576 /* Ok, let's determine the new real volume */
1577 compute_real_volume(root_source);
1579 /* Let's 'push' the reference volume if necessary */
1580 pa_cvolume_merge(&new_reference_volume, &s->reference_volume, &root_source->real_volume);
1581 /* If the source and it's root don't have the same number of channels, we need to remap */
1582 if (s != root_source && !pa_channel_map_equal(&s->channel_map, &root_source->channel_map))
1583 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_source->channel_map);
1584 update_reference_volume(root_source, &new_reference_volume, &root_source->channel_map, save);
1586 /* Now that the reference volume is updated, we can update the streams'
1587 * reference ratios. */
1588 compute_reference_ratios(root_source);
1591 if (root_source->set_volume) {
1592 /* If we have a function set_volume(), then we do not apply a
1593 * soft volume by default. However, set_volume() is free to
1594 * apply one to root_source->soft_volume */
1596 pa_cvolume_reset(&root_source->soft_volume, root_source->sample_spec.channels);
1597 if (!(root_source->flags & PA_SOURCE_DEFERRED_VOLUME))
1598 root_source->set_volume(root_source);
1601 /* If we have no function set_volume(), then the soft volume
1602 * becomes the real volume */
1603 root_source->soft_volume = root_source->real_volume;
1605 /* This tells the source that soft volume and/or real volume changed */
1607 pa_assert_se(pa_asyncmsgq_send(root_source->asyncmsgq, PA_MSGOBJECT(root_source), PA_SOURCE_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL) == 0);
1610 /* Called from the io thread if sync volume is used, otherwise from the main thread.
1611 * Only to be called by source implementor */
1612 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume) {
1614 pa_source_assert_ref(s);
1615 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1617 if (s->flags & PA_SOURCE_DEFERRED_VOLUME)
1618 pa_source_assert_io_context(s);
1620 pa_assert_ctl_context();
1623 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
1625 s->soft_volume = *volume;
1627 if (PA_SOURCE_IS_LINKED(s->state) && !(s->flags & PA_SOURCE_DEFERRED_VOLUME))
1628 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0);
1630 s->thread_info.soft_volume = s->soft_volume;
1633 /* Called from the main thread. Only called for the root source in volume sharing
1634 * cases, except for internal recursive calls. */
1635 static void propagate_real_volume(pa_source *s, const pa_cvolume *old_real_volume) {
1636 pa_source_output *o;
1639 pa_source_assert_ref(s);
1640 pa_assert(old_real_volume);
1641 pa_assert_ctl_context();
1642 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1644 /* This is called when the hardware's real volume changes due to
1645 * some external event. We copy the real volume into our
1646 * reference volume and then rebuild the stream volumes based on
1647 * i->real_ratio which should stay fixed. */
1649 if (!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1650 if (pa_cvolume_equal(old_real_volume, &s->real_volume))
1653 /* 1. Make the real volume the reference volume */
1654 update_reference_volume(s, &s->real_volume, &s->channel_map, TRUE);
1657 if (pa_source_flat_volume_enabled(s)) {
1659 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1660 pa_cvolume old_volume = o->volume;
1662 /* 2. Since the source's reference and real volumes are equal
1663 * now our ratios should be too. */
1664 o->reference_ratio = o->real_ratio;
1666 /* 3. Recalculate the new stream reference volume based on the
1667 * reference ratio and the sink's reference volume.
1669 * This basically calculates:
1671 * o->volume = s->reference_volume * o->reference_ratio
1673 * This is identical to propagate_reference_volume() */
1674 o->volume = s->reference_volume;
1675 pa_cvolume_remap(&o->volume, &s->channel_map, &o->channel_map);
1676 pa_sw_cvolume_multiply(&o->volume, &o->volume, &o->reference_ratio);
1678 /* Notify if something changed */
1679 if (!pa_cvolume_equal(&old_volume, &o->volume)) {
1681 if (o->volume_changed)
1682 o->volume_changed(o);
1684 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1687 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1688 propagate_real_volume(o->destination_source, old_real_volume);
1692 /* Something got changed in the hardware. It probably makes sense
1693 * to save changed hw settings given that hw volume changes not
1694 * triggered by PA are almost certainly done by the user. */
1695 if (!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1696 s->save_volume = TRUE;
1699 /* Called from io thread */
1700 void pa_source_update_volume_and_mute(pa_source *s) {
1702 pa_source_assert_io_context(s);
1704 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE, NULL, 0, NULL, NULL);
1707 /* Called from main thread */
1708 const pa_cvolume *pa_source_get_volume(pa_source *s, pa_bool_t force_refresh) {
1709 pa_source_assert_ref(s);
1710 pa_assert_ctl_context();
1711 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1713 if (s->refresh_volume || force_refresh) {
1714 struct pa_cvolume old_real_volume;
1716 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1718 old_real_volume = s->real_volume;
1720 if (!(s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->get_volume)
1723 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, NULL, 0, NULL) == 0);
1725 update_real_volume(s, &s->real_volume, &s->channel_map);
1726 propagate_real_volume(s, &old_real_volume);
1729 return &s->reference_volume;
1732 /* Called from main thread. In volume sharing cases, only the root source may
1734 void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_real_volume) {
1735 pa_cvolume old_real_volume;
1737 pa_source_assert_ref(s);
1738 pa_assert_ctl_context();
1739 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1740 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1742 /* The source implementor may call this if the volume changed to make sure everyone is notified */
1744 old_real_volume = s->real_volume;
1745 update_real_volume(s, new_real_volume, &s->channel_map);
1746 propagate_real_volume(s, &old_real_volume);
1749 /* Called from main thread */
1750 void pa_source_set_mute(pa_source *s, pa_bool_t mute, pa_bool_t save) {
1751 pa_bool_t old_muted;
1753 pa_source_assert_ref(s);
1754 pa_assert_ctl_context();
1755 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1757 old_muted = s->muted;
1759 s->save_muted = (old_muted == s->muted && s->save_muted) || save;
1761 if (!(s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->set_mute)
1764 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
1766 if (old_muted != s->muted)
1767 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1770 /* Called from main thread */
1771 pa_bool_t pa_source_get_mute(pa_source *s, pa_bool_t force_refresh) {
1773 pa_source_assert_ref(s);
1774 pa_assert_ctl_context();
1775 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1777 if (s->refresh_muted || force_refresh) {
1778 pa_bool_t old_muted = s->muted;
1780 if (!(s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->get_mute)
1783 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, NULL, 0, NULL) == 0);
1785 if (old_muted != s->muted) {
1786 s->save_muted = TRUE;
1788 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1790 /* Make sure the soft mute status stays in sync */
1791 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
1798 /* Called from main thread */
1799 void pa_source_mute_changed(pa_source *s, pa_bool_t new_muted) {
1800 pa_source_assert_ref(s);
1801 pa_assert_ctl_context();
1802 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1804 /* The source implementor may call this if the mute state changed to make sure everyone is notified */
1806 if (s->muted == new_muted)
1809 s->muted = new_muted;
1810 s->save_muted = TRUE;
1812 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1815 /* Called from main thread */
1816 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p) {
1817 pa_source_assert_ref(s);
1818 pa_assert_ctl_context();
1821 pa_proplist_update(s->proplist, mode, p);
1823 if (PA_SOURCE_IS_LINKED(s->state)) {
1824 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
1825 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1831 /* Called from main thread */
1832 /* FIXME -- this should be dropped and be merged into pa_source_update_proplist() */
1833 void pa_source_set_description(pa_source *s, const char *description) {
1835 pa_source_assert_ref(s);
1836 pa_assert_ctl_context();
1838 if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
1841 old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
1843 if (old && description && pa_streq(old, description))
1847 pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
1849 pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
1851 if (PA_SOURCE_IS_LINKED(s->state)) {
1852 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1853 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
1857 /* Called from main thread */
1858 unsigned pa_source_linked_by(pa_source *s) {
1859 pa_source_assert_ref(s);
1860 pa_assert_ctl_context();
1861 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1863 return pa_idxset_size(s->outputs);
1866 /* Called from main thread */
1867 unsigned pa_source_used_by(pa_source *s) {
1870 pa_source_assert_ref(s);
1871 pa_assert_ctl_context();
1872 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1874 ret = pa_idxset_size(s->outputs);
1875 pa_assert(ret >= s->n_corked);
1877 return ret - s->n_corked;
1880 /* Called from main thread */
1881 unsigned pa_source_check_suspend(pa_source *s) {
1883 pa_source_output *o;
1886 pa_source_assert_ref(s);
1887 pa_assert_ctl_context();
1889 if (!PA_SOURCE_IS_LINKED(s->state))
1894 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1895 pa_source_output_state_t st;
1897 st = pa_source_output_get_state(o);
1899 /* We do not assert here. It is perfectly valid for a source output to
1900 * be in the INIT state (i.e. created, marked done but not yet put)
1901 * and we should not care if it's unlinked as it won't contribute
1902 * towards our busy status.
1904 if (!PA_SOURCE_OUTPUT_IS_LINKED(st))
1907 if (st == PA_SOURCE_OUTPUT_CORKED)
1910 if (o->flags & PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND)
1919 /* Called from the IO thread */
1920 static void sync_output_volumes_within_thread(pa_source *s) {
1921 pa_source_output *o;
1924 pa_source_assert_ref(s);
1925 pa_source_assert_io_context(s);
1927 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state) {
1928 if (pa_cvolume_equal(&o->thread_info.soft_volume, &o->soft_volume))
1931 o->thread_info.soft_volume = o->soft_volume;
1932 //pa_source_output_request_rewind(o, 0, TRUE, FALSE, FALSE);
1936 /* Called from the IO thread. Only called for the root source in volume sharing
1937 * cases, except for internal recursive calls. */
1938 static void set_shared_volume_within_thread(pa_source *s) {
1939 pa_source_output *o;
1942 pa_source_assert_ref(s);
1944 PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL);
1946 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state) {
1947 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1948 set_shared_volume_within_thread(o->destination_source);
1952 /* Called from IO thread, except when it is not */
1953 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1954 pa_source *s = PA_SOURCE(object);
1955 pa_source_assert_ref(s);
1957 switch ((pa_source_message_t) code) {
1959 case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
1960 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
1962 pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
1964 if (o->direct_on_input) {
1965 o->thread_info.direct_on_input = o->direct_on_input;
1966 pa_hashmap_put(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index), o);
1969 pa_assert(!o->thread_info.attached);
1970 o->thread_info.attached = TRUE;
1975 pa_source_output_set_state_within_thread(o, o->state);
1977 if (o->thread_info.requested_source_latency != (pa_usec_t) -1)
1978 pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
1980 pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
1982 /* We don't just invalidate the requested latency here,
1983 * because if we are in a move we might need to fix up the
1984 * requested latency. */
1985 pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
1987 /* In flat volume mode we need to update the volume as
1989 return object->process_msg(object, PA_SOURCE_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
1992 case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
1993 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
1995 pa_source_output_set_state_within_thread(o, o->state);
2000 pa_assert(o->thread_info.attached);
2001 o->thread_info.attached = FALSE;
2003 if (o->thread_info.direct_on_input) {
2004 pa_hashmap_remove(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index));
2005 o->thread_info.direct_on_input = NULL;
2008 if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
2009 pa_source_output_unref(o);
2011 pa_source_invalidate_requested_latency(s, TRUE);
2013 /* In flat volume mode we need to update the volume as
2015 return object->process_msg(object, PA_SOURCE_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
2018 case PA_SOURCE_MESSAGE_SET_SHARED_VOLUME: {
2019 pa_source *root_source = pa_source_get_master(s);
2021 if (PA_LIKELY(root_source))
2022 set_shared_volume_within_thread(root_source);
2027 case PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED:
2029 if (s->flags & PA_SOURCE_DEFERRED_VOLUME) {
2031 pa_source_volume_change_push(s);
2033 /* Fall through ... */
2035 case PA_SOURCE_MESSAGE_SET_VOLUME:
2037 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2038 s->thread_info.soft_volume = s->soft_volume;
2041 /* Fall through ... */
2043 case PA_SOURCE_MESSAGE_SYNC_VOLUMES:
2044 sync_output_volumes_within_thread(s);
2047 case PA_SOURCE_MESSAGE_GET_VOLUME:
2049 if ((s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->get_volume) {
2051 pa_source_volume_change_flush(s);
2052 pa_sw_cvolume_divide(&s->thread_info.current_hw_volume, &s->real_volume, &s->soft_volume);
2055 /* In case source implementor reset SW volume. */
2056 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2057 s->thread_info.soft_volume = s->soft_volume;
2062 case PA_SOURCE_MESSAGE_SET_MUTE:
2064 if (s->thread_info.soft_muted != s->muted) {
2065 s->thread_info.soft_muted = s->muted;
2068 if (s->flags & PA_SOURCE_DEFERRED_VOLUME && s->set_mute)
2073 case PA_SOURCE_MESSAGE_GET_MUTE:
2075 if (s->flags & PA_SOURCE_DEFERRED_VOLUME && s->get_mute)
2080 case PA_SOURCE_MESSAGE_SET_STATE: {
2082 pa_bool_t suspend_change =
2083 (s->thread_info.state == PA_SOURCE_SUSPENDED && PA_SOURCE_IS_OPENED(PA_PTR_TO_UINT(userdata))) ||
2084 (PA_SOURCE_IS_OPENED(s->thread_info.state) && PA_PTR_TO_UINT(userdata) == PA_SOURCE_SUSPENDED);
2086 s->thread_info.state = PA_PTR_TO_UINT(userdata);
2088 if (suspend_change) {
2089 pa_source_output *o;
2092 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
2093 if (o->suspend_within_thread)
2094 o->suspend_within_thread(o, s->thread_info.state == PA_SOURCE_SUSPENDED);
2100 case PA_SOURCE_MESSAGE_DETACH:
2102 /* Detach all streams */
2103 pa_source_detach_within_thread(s);
2106 case PA_SOURCE_MESSAGE_ATTACH:
2108 /* Reattach all streams */
2109 pa_source_attach_within_thread(s);
2112 case PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY: {
2114 pa_usec_t *usec = userdata;
2115 *usec = pa_source_get_requested_latency_within_thread(s);
2117 /* Yes, that's right, the IO thread will see -1 when no
2118 * explicit requested latency is configured, the main
2119 * thread will see max_latency */
2120 if (*usec == (pa_usec_t) -1)
2121 *usec = s->thread_info.max_latency;
2126 case PA_SOURCE_MESSAGE_SET_LATENCY_RANGE: {
2127 pa_usec_t *r = userdata;
2129 pa_source_set_latency_range_within_thread(s, r[0], r[1]);
2134 case PA_SOURCE_MESSAGE_GET_LATENCY_RANGE: {
2135 pa_usec_t *r = userdata;
2137 r[0] = s->thread_info.min_latency;
2138 r[1] = s->thread_info.max_latency;
2143 case PA_SOURCE_MESSAGE_GET_FIXED_LATENCY:
2145 *((pa_usec_t*) userdata) = s->thread_info.fixed_latency;
2148 case PA_SOURCE_MESSAGE_SET_FIXED_LATENCY:
2150 pa_source_set_fixed_latency_within_thread(s, (pa_usec_t) offset);
2153 case PA_SOURCE_MESSAGE_GET_MAX_REWIND:
2155 *((size_t*) userdata) = s->thread_info.max_rewind;
2158 case PA_SOURCE_MESSAGE_SET_MAX_REWIND:
2160 pa_source_set_max_rewind_within_thread(s, (size_t) offset);
2163 case PA_SOURCE_MESSAGE_GET_LATENCY:
2165 if (s->monitor_of) {
2166 *((pa_usec_t*) userdata) = 0;
2170 /* Implementors need to overwrite this implementation! */
2173 case PA_SOURCE_MESSAGE_SET_PORT:
2175 pa_assert(userdata);
2177 struct source_message_set_port *msg_data = userdata;
2178 msg_data->ret = s->set_port(s, msg_data->port);
2182 case PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE:
2183 /* This message is sent from IO-thread and handled in main thread. */
2184 pa_assert_ctl_context();
2186 /* Make sure we're not messing with main thread when no longer linked */
2187 if (!PA_SOURCE_IS_LINKED(s->state))
2190 pa_source_get_volume(s, TRUE);
2191 pa_source_get_mute(s, TRUE);
2194 case PA_SOURCE_MESSAGE_SET_LATENCY_OFFSET:
2195 s->thread_info.latency_offset = offset;
2198 case PA_SOURCE_MESSAGE_MAX:
2205 /* Called from main thread */
2206 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause) {
2211 pa_core_assert_ref(c);
2212 pa_assert_ctl_context();
2213 pa_assert(cause != 0);
2215 for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx))) {
2218 if (source->monitor_of)
2221 if ((r = pa_source_suspend(source, suspend, cause)) < 0)
2228 /* Called from main thread */
2229 void pa_source_detach(pa_source *s) {
2230 pa_source_assert_ref(s);
2231 pa_assert_ctl_context();
2232 pa_assert(PA_SOURCE_IS_LINKED(s->state));
2234 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL) == 0);
2237 /* Called from main thread */
2238 void pa_source_attach(pa_source *s) {
2239 pa_source_assert_ref(s);
2240 pa_assert_ctl_context();
2241 pa_assert(PA_SOURCE_IS_LINKED(s->state));
2243 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL) == 0);
2246 /* Called from IO thread */
2247 void pa_source_detach_within_thread(pa_source *s) {
2248 pa_source_output *o;
2251 pa_source_assert_ref(s);
2252 pa_source_assert_io_context(s);
2253 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
2255 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2260 /* Called from IO thread */
2261 void pa_source_attach_within_thread(pa_source *s) {
2262 pa_source_output *o;
2265 pa_source_assert_ref(s);
2266 pa_source_assert_io_context(s);
2267 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
2269 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2274 /* Called from IO thread */
2275 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s) {
2276 pa_usec_t result = (pa_usec_t) -1;
2277 pa_source_output *o;
2280 pa_source_assert_ref(s);
2281 pa_source_assert_io_context(s);
2283 if (!(s->flags & PA_SOURCE_DYNAMIC_LATENCY))
2284 return PA_CLAMP(s->thread_info.fixed_latency, s->thread_info.min_latency, s->thread_info.max_latency);
2286 if (s->thread_info.requested_latency_valid)
2287 return s->thread_info.requested_latency;
2289 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2290 if (o->thread_info.requested_source_latency != (pa_usec_t) -1 &&
2291 (result == (pa_usec_t) -1 || result > o->thread_info.requested_source_latency))
2292 result = o->thread_info.requested_source_latency;
2294 if (result != (pa_usec_t) -1)
2295 result = PA_CLAMP(result, s->thread_info.min_latency, s->thread_info.max_latency);
2297 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2298 /* Only cache this if we are fully set up */
2299 s->thread_info.requested_latency = result;
2300 s->thread_info.requested_latency_valid = TRUE;
2306 /* Called from main thread */
2307 pa_usec_t pa_source_get_requested_latency(pa_source *s) {
2310 pa_source_assert_ref(s);
2311 pa_assert_ctl_context();
2312 pa_assert(PA_SOURCE_IS_LINKED(s->state));
2314 if (s->state == PA_SOURCE_SUSPENDED)
2317 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
2322 /* Called from IO thread */
2323 void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind) {
2324 pa_source_output *o;
2327 pa_source_assert_ref(s);
2328 pa_source_assert_io_context(s);
2330 if (max_rewind == s->thread_info.max_rewind)
2333 s->thread_info.max_rewind = max_rewind;
2335 if (PA_SOURCE_IS_LINKED(s->thread_info.state))
2336 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2337 pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
2340 /* Called from main thread */
2341 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind) {
2342 pa_source_assert_ref(s);
2343 pa_assert_ctl_context();
2345 if (PA_SOURCE_IS_LINKED(s->state))
2346 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MAX_REWIND, NULL, max_rewind, NULL) == 0);
2348 pa_source_set_max_rewind_within_thread(s, max_rewind);
2351 /* Called from IO thread */
2352 void pa_source_invalidate_requested_latency(pa_source *s, pa_bool_t dynamic) {
2353 pa_source_output *o;
2356 pa_source_assert_ref(s);
2357 pa_source_assert_io_context(s);
2359 if ((s->flags & PA_SOURCE_DYNAMIC_LATENCY))
2360 s->thread_info.requested_latency_valid = FALSE;
2364 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2366 if (s->update_requested_latency)
2367 s->update_requested_latency(s);
2369 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
2370 if (o->update_source_requested_latency)
2371 o->update_source_requested_latency(o);
2375 pa_sink_invalidate_requested_latency(s->monitor_of, dynamic);
2378 /* Called from main thread */
2379 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
2380 pa_source_assert_ref(s);
2381 pa_assert_ctl_context();
2383 /* min_latency == 0: no limit
2384 * min_latency anything else: specified limit
2386 * Similar for max_latency */
2388 if (min_latency < ABSOLUTE_MIN_LATENCY)
2389 min_latency = ABSOLUTE_MIN_LATENCY;
2391 if (max_latency <= 0 ||
2392 max_latency > ABSOLUTE_MAX_LATENCY)
2393 max_latency = ABSOLUTE_MAX_LATENCY;
2395 pa_assert(min_latency <= max_latency);
2397 /* Hmm, let's see if someone forgot to set PA_SOURCE_DYNAMIC_LATENCY here... */
2398 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
2399 max_latency == ABSOLUTE_MAX_LATENCY) ||
2400 (s->flags & PA_SOURCE_DYNAMIC_LATENCY));
2402 if (PA_SOURCE_IS_LINKED(s->state)) {
2408 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
2410 pa_source_set_latency_range_within_thread(s, min_latency, max_latency);
2413 /* Called from main thread */
2414 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
2415 pa_source_assert_ref(s);
2416 pa_assert_ctl_context();
2417 pa_assert(min_latency);
2418 pa_assert(max_latency);
2420 if (PA_SOURCE_IS_LINKED(s->state)) {
2421 pa_usec_t r[2] = { 0, 0 };
2423 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
2425 *min_latency = r[0];
2426 *max_latency = r[1];
2428 *min_latency = s->thread_info.min_latency;
2429 *max_latency = s->thread_info.max_latency;
2433 /* Called from IO thread, and from main thread before pa_source_put() is called */
2434 void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
2435 pa_source_assert_ref(s);
2436 pa_source_assert_io_context(s);
2438 pa_assert(min_latency >= ABSOLUTE_MIN_LATENCY);
2439 pa_assert(max_latency <= ABSOLUTE_MAX_LATENCY);
2440 pa_assert(min_latency <= max_latency);
2442 /* Hmm, let's see if someone forgot to set PA_SOURCE_DYNAMIC_LATENCY here... */
2443 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
2444 max_latency == ABSOLUTE_MAX_LATENCY) ||
2445 (s->flags & PA_SOURCE_DYNAMIC_LATENCY) ||
2448 if (s->thread_info.min_latency == min_latency &&
2449 s->thread_info.max_latency == max_latency)
2452 s->thread_info.min_latency = min_latency;
2453 s->thread_info.max_latency = max_latency;
2455 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2456 pa_source_output *o;
2459 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2460 if (o->update_source_latency_range)
2461 o->update_source_latency_range(o);
2464 pa_source_invalidate_requested_latency(s, FALSE);
2467 /* Called from main thread, before the source is put */
2468 void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency) {
2469 pa_source_assert_ref(s);
2470 pa_assert_ctl_context();
2472 if (s->flags & PA_SOURCE_DYNAMIC_LATENCY) {
2473 pa_assert(latency == 0);
2477 if (latency < ABSOLUTE_MIN_LATENCY)
2478 latency = ABSOLUTE_MIN_LATENCY;
2480 if (latency > ABSOLUTE_MAX_LATENCY)
2481 latency = ABSOLUTE_MAX_LATENCY;
2483 if (PA_SOURCE_IS_LINKED(s->state))
2484 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_FIXED_LATENCY, NULL, (int64_t) latency, NULL) == 0);
2486 s->thread_info.fixed_latency = latency;
2489 /* Called from main thread */
2490 pa_usec_t pa_source_get_fixed_latency(pa_source *s) {
2493 pa_source_assert_ref(s);
2494 pa_assert_ctl_context();
2496 if (s->flags & PA_SOURCE_DYNAMIC_LATENCY)
2499 if (PA_SOURCE_IS_LINKED(s->state))
2500 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_FIXED_LATENCY, &latency, 0, NULL) == 0);
2502 latency = s->thread_info.fixed_latency;
2507 /* Called from IO thread */
2508 void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency) {
2509 pa_source_assert_ref(s);
2510 pa_source_assert_io_context(s);
2512 if (s->flags & PA_SOURCE_DYNAMIC_LATENCY) {
2513 pa_assert(latency == 0);
2517 pa_assert(latency >= ABSOLUTE_MIN_LATENCY);
2518 pa_assert(latency <= ABSOLUTE_MAX_LATENCY);
2520 if (s->thread_info.fixed_latency == latency)
2523 s->thread_info.fixed_latency = latency;
2525 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2526 pa_source_output *o;
2529 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2530 if (o->update_source_fixed_latency)
2531 o->update_source_fixed_latency(o);
2534 pa_source_invalidate_requested_latency(s, FALSE);
2537 /* Called from main thread */
2538 void pa_source_set_latency_offset(pa_source *s, int64_t offset) {
2539 pa_source_assert_ref(s);
2541 s->latency_offset = offset;
2543 if (PA_SOURCE_IS_LINKED(s->state))
2544 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_LATENCY_OFFSET, NULL, offset, NULL) == 0);
2546 s->thread_info.latency_offset = offset;
2549 /* Called from main thread */
2550 size_t pa_source_get_max_rewind(pa_source *s) {
2552 pa_assert_ctl_context();
2553 pa_source_assert_ref(s);
2555 if (!PA_SOURCE_IS_LINKED(s->state))
2556 return s->thread_info.max_rewind;
2558 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
2563 /* Called from main context */
2564 int pa_source_set_port(pa_source *s, const char *name, pa_bool_t save) {
2565 pa_device_port *port;
2568 pa_source_assert_ref(s);
2569 pa_assert_ctl_context();
2572 pa_log_debug("set_port() operation not implemented for source %u \"%s\"", s->index, s->name);
2573 return -PA_ERR_NOTIMPLEMENTED;
2577 return -PA_ERR_NOENTITY;
2579 if (!(port = pa_hashmap_get(s->ports, name)))
2580 return -PA_ERR_NOENTITY;
2582 if (s->active_port == port) {
2583 s->save_port = s->save_port || save;
2587 if (s->flags & PA_SOURCE_DEFERRED_VOLUME) {
2588 struct source_message_set_port msg = { .port = port, .ret = 0 };
2589 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
2593 ret = s->set_port(s, port);
2596 return -PA_ERR_NOENTITY;
2598 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2600 pa_log_info("Changed port of source %u \"%s\" to %s", s->index, s->name, port->name);
2602 s->active_port = port;
2603 s->save_port = save;
2605 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PORT_CHANGED], s);
2610 PA_STATIC_FLIST_DECLARE(pa_source_volume_change, 0, pa_xfree);
2612 /* Called from the IO thread. */
2613 static pa_source_volume_change *pa_source_volume_change_new(pa_source *s) {
2614 pa_source_volume_change *c;
2615 if (!(c = pa_flist_pop(PA_STATIC_FLIST_GET(pa_source_volume_change))))
2616 c = pa_xnew(pa_source_volume_change, 1);
2618 PA_LLIST_INIT(pa_source_volume_change, c);
2620 pa_cvolume_reset(&c->hw_volume, s->sample_spec.channels);
2624 /* Called from the IO thread. */
2625 static void pa_source_volume_change_free(pa_source_volume_change *c) {
2627 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_source_volume_change), c) < 0)
2631 /* Called from the IO thread. */
2632 void pa_source_volume_change_push(pa_source *s) {
2633 pa_source_volume_change *c = NULL;
2634 pa_source_volume_change *nc = NULL;
2635 uint32_t safety_margin = s->thread_info.volume_change_safety_margin;
2637 const char *direction = NULL;
2640 nc = pa_source_volume_change_new(s);
2642 /* NOTE: There is already more different volumes in pa_source that I can remember.
2643 * Adding one more volume for HW would get us rid of this, but I am trying
2644 * to survive with the ones we already have. */
2645 pa_sw_cvolume_divide(&nc->hw_volume, &s->real_volume, &s->soft_volume);
2647 if (!s->thread_info.volume_changes && pa_cvolume_equal(&nc->hw_volume, &s->thread_info.current_hw_volume)) {
2648 pa_log_debug("Volume not changing");
2649 pa_source_volume_change_free(nc);
2653 nc->at = pa_source_get_latency_within_thread(s);
2654 nc->at += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
2656 if (s->thread_info.volume_changes_tail) {
2657 for (c = s->thread_info.volume_changes_tail; c; c = c->prev) {
2658 /* If volume is going up let's do it a bit late. If it is going
2659 * down let's do it a bit early. */
2660 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&c->hw_volume)) {
2661 if (nc->at + safety_margin > c->at) {
2662 nc->at += safety_margin;
2667 else if (nc->at - safety_margin > c->at) {
2668 nc->at -= safety_margin;
2676 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&s->thread_info.current_hw_volume)) {
2677 nc->at += safety_margin;
2680 nc->at -= safety_margin;
2683 PA_LLIST_PREPEND(pa_source_volume_change, s->thread_info.volume_changes, nc);
2686 PA_LLIST_INSERT_AFTER(pa_source_volume_change, s->thread_info.volume_changes, c, nc);
2689 pa_log_debug("Volume going %s to %d at %llu", direction, pa_cvolume_avg(&nc->hw_volume), (long long unsigned) nc->at);
2691 /* We can ignore volume events that came earlier but should happen later than this. */
2692 PA_LLIST_FOREACH(c, nc->next) {
2693 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at);
2694 pa_source_volume_change_free(c);
2697 s->thread_info.volume_changes_tail = nc;
2700 /* Called from the IO thread. */
2701 static void pa_source_volume_change_flush(pa_source *s) {
2702 pa_source_volume_change *c = s->thread_info.volume_changes;
2704 s->thread_info.volume_changes = NULL;
2705 s->thread_info.volume_changes_tail = NULL;
2707 pa_source_volume_change *next = c->next;
2708 pa_source_volume_change_free(c);
2713 /* Called from the IO thread. */
2714 pa_bool_t pa_source_volume_change_apply(pa_source *s, pa_usec_t *usec_to_next) {
2716 pa_bool_t ret = FALSE;
2720 if (!s->thread_info.volume_changes || !PA_SOURCE_IS_LINKED(s->state)) {
2726 pa_assert(s->write_volume);
2728 now = pa_rtclock_now();
2730 while (s->thread_info.volume_changes && now >= s->thread_info.volume_changes->at) {
2731 pa_source_volume_change *c = s->thread_info.volume_changes;
2732 PA_LLIST_REMOVE(pa_source_volume_change, s->thread_info.volume_changes, c);
2733 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
2734 pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at, (long long unsigned) (now - c->at));
2736 s->thread_info.current_hw_volume = c->hw_volume;
2737 pa_source_volume_change_free(c);
2743 if (s->thread_info.volume_changes) {
2745 *usec_to_next = s->thread_info.volume_changes->at - now;
2746 if (pa_log_ratelimit(PA_LOG_DEBUG))
2747 pa_log_debug("Next volume change in %lld usec", (long long) (s->thread_info.volume_changes->at - now));
2752 s->thread_info.volume_changes_tail = NULL;
2758 /* Called from the main thread */
2759 /* Gets the list of formats supported by the source. The members and idxset must
2760 * be freed by the caller. */
2761 pa_idxset* pa_source_get_formats(pa_source *s) {
2766 if (s->get_formats) {
2767 /* Source supports format query, all is good */
2768 ret = s->get_formats(s);
2770 /* Source doesn't support format query, so assume it does PCM */
2771 pa_format_info *f = pa_format_info_new();
2772 f->encoding = PA_ENCODING_PCM;
2774 ret = pa_idxset_new(NULL, NULL);
2775 pa_idxset_put(ret, f, NULL);
2781 /* Called from the main thread */
2782 /* Checks if the source can accept this format */
2783 pa_bool_t pa_source_check_format(pa_source *s, pa_format_info *f)
2785 pa_idxset *formats = NULL;
2786 pa_bool_t ret = FALSE;
2791 formats = pa_source_get_formats(s);
2794 pa_format_info *finfo_device;
2797 PA_IDXSET_FOREACH(finfo_device, formats, i) {
2798 if (pa_format_info_is_compatible(finfo_device, f)) {
2804 pa_idxset_free(formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
2810 /* Called from the main thread */
2811 /* Calculates the intersection between formats supported by the source and
2812 * in_formats, and returns these, in the order of the source's formats. */
2813 pa_idxset* pa_source_check_formats(pa_source *s, pa_idxset *in_formats) {
2814 pa_idxset *out_formats = pa_idxset_new(NULL, NULL), *source_formats = NULL;
2815 pa_format_info *f_source, *f_in;
2820 if (!in_formats || pa_idxset_isempty(in_formats))
2823 source_formats = pa_source_get_formats(s);
2825 PA_IDXSET_FOREACH(f_source, source_formats, i) {
2826 PA_IDXSET_FOREACH(f_in, in_formats, j) {
2827 if (pa_format_info_is_compatible(f_source, f_in))
2828 pa_idxset_put(out_formats, pa_format_info_copy(f_in), NULL);
2834 pa_idxset_free(source_formats, (pa_free2_cb_t) pa_format_info_free2, NULL);