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/sample-util.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();
80 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name) {
84 data->name = pa_xstrdup(name);
87 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec) {
90 if ((data->sample_spec_is_set = !!spec))
91 data->sample_spec = *spec;
94 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map) {
97 if ((data->channel_map_is_set = !!map))
98 data->channel_map = *map;
101 void pa_source_new_data_set_alternate_sample_rate(pa_source_new_data *data, const uint32_t alternate_sample_rate) {
104 data->alternate_sample_rate_is_set = TRUE;
105 data->alternate_sample_rate = alternate_sample_rate;
108 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume) {
111 if ((data->volume_is_set = !!volume))
112 data->volume = *volume;
115 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute) {
118 data->muted_is_set = TRUE;
119 data->muted = !!mute;
122 void pa_source_new_data_set_port(pa_source_new_data *data, const char *port) {
125 pa_xfree(data->active_port);
126 data->active_port = pa_xstrdup(port);
129 void pa_source_new_data_done(pa_source_new_data *data) {
132 pa_proplist_free(data->proplist);
137 while ((p = pa_hashmap_steal_first(data->ports)))
138 pa_device_port_free(p);
140 pa_hashmap_free(data->ports, NULL, NULL);
143 pa_xfree(data->name);
144 pa_xfree(data->active_port);
147 /* Called from main context */
148 static void reset_callbacks(pa_source *s) {
152 s->get_volume = NULL;
153 s->set_volume = NULL;
154 s->write_volume = NULL;
157 s->update_requested_latency = NULL;
159 s->get_formats = NULL;
160 s->update_rate = NULL;
163 /* Called from main context */
164 pa_source* pa_source_new(
166 pa_source_new_data *data,
167 pa_source_flags_t flags) {
171 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
176 pa_assert(data->name);
177 pa_assert_ctl_context();
179 s = pa_msgobject_new(pa_source);
181 if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SOURCE, s, data->namereg_fail))) {
182 pa_log_debug("Failed to register name %s.", data->name);
187 pa_source_new_data_set_name(data, name);
189 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_NEW], data) < 0) {
191 pa_namereg_unregister(core, name);
195 /* FIXME, need to free s here on failure */
197 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
198 pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
200 pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
202 if (!data->channel_map_is_set)
203 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
205 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
206 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
208 /* FIXME: There should probably be a general function for checking whether
209 * the source volume is allowed to be set, like there is for source outputs. */
210 pa_assert(!data->volume_is_set || !(flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
212 if (!data->volume_is_set) {
213 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
214 data->save_volume = FALSE;
217 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
218 pa_return_null_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec));
220 if (!data->muted_is_set)
224 pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->card->proplist);
226 pa_device_init_description(data->proplist);
227 pa_device_init_icon(data->proplist, FALSE);
228 pa_device_init_intended_roles(data->proplist);
230 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], data) < 0) {
232 pa_namereg_unregister(core, name);
236 s->parent.parent.free = source_free;
237 s->parent.process_msg = pa_source_process_msg;
240 s->state = PA_SOURCE_INIT;
243 s->suspend_cause = 0;
244 s->name = pa_xstrdup(name);
245 s->proplist = pa_proplist_copy(data->proplist);
246 s->driver = pa_xstrdup(pa_path_get_filename(data->driver));
247 s->module = data->module;
248 s->card = data->card;
250 s->priority = pa_device_init_priority(s->proplist);
252 s->sample_spec = data->sample_spec;
253 s->channel_map = data->channel_map;
254 s->default_sample_rate = s->sample_spec.rate;
256 if (data->alternate_sample_rate_is_set)
257 s->alternate_sample_rate = data->alternate_sample_rate;
259 s->alternate_sample_rate = s->core->alternate_sample_rate;
261 if (s->sample_spec.rate == s->alternate_sample_rate) {
262 pa_log_warn("Default and alternate sample rates are the same.");
263 s->alternate_sample_rate = 0;
266 s->outputs = pa_idxset_new(NULL, NULL);
268 s->monitor_of = NULL;
269 s->output_from_master = NULL;
271 s->reference_volume = s->real_volume = data->volume;
272 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
273 s->base_volume = PA_VOLUME_NORM;
274 s->n_volume_steps = PA_VOLUME_NORM+1;
275 s->muted = data->muted;
276 s->refresh_volume = s->refresh_muted = FALSE;
283 /* As a minor optimization we just steal the list instead of
285 s->ports = data->ports;
288 s->active_port = NULL;
289 s->save_port = FALSE;
291 if (data->active_port && s->ports)
292 if ((s->active_port = pa_hashmap_get(s->ports, data->active_port)))
293 s->save_port = data->save_port;
295 if (!s->active_port && s->ports) {
299 PA_HASHMAP_FOREACH(p, s->ports, state)
300 if (!s->active_port || p->priority > s->active_port->priority)
304 s->save_volume = data->save_volume;
305 s->save_muted = data->save_muted;
307 pa_silence_memchunk_get(
308 &core->silence_cache,
314 s->thread_info.rtpoll = NULL;
315 s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
316 s->thread_info.soft_volume = s->soft_volume;
317 s->thread_info.soft_muted = s->muted;
318 s->thread_info.state = s->state;
319 s->thread_info.max_rewind = 0;
320 s->thread_info.requested_latency_valid = FALSE;
321 s->thread_info.requested_latency = 0;
322 s->thread_info.min_latency = ABSOLUTE_MIN_LATENCY;
323 s->thread_info.max_latency = ABSOLUTE_MAX_LATENCY;
324 s->thread_info.fixed_latency = flags & PA_SOURCE_DYNAMIC_LATENCY ? 0 : DEFAULT_FIXED_LATENCY;
326 PA_LLIST_HEAD_INIT(pa_source_volume_change, s->thread_info.volume_changes);
327 s->thread_info.volume_changes_tail = NULL;
328 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
329 s->thread_info.volume_change_safety_margin = core->deferred_volume_safety_margin_usec;
330 s->thread_info.volume_change_extra_delay = core->deferred_volume_extra_delay_usec;
332 /* FIXME: This should probably be moved to pa_source_put() */
333 pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
336 pa_assert_se(pa_idxset_put(s->card->sources, s, NULL) >= 0);
338 pt = pa_proplist_to_string_sep(s->proplist, "\n ");
339 pa_log_info("Created source %u \"%s\" with sample spec %s and channel map %s\n %s",
342 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
343 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map),
350 /* Called from main context */
351 static int source_set_state(pa_source *s, pa_source_state_t state) {
353 pa_bool_t suspend_change;
354 pa_source_state_t original_state;
357 pa_assert_ctl_context();
359 if (s->state == state)
362 original_state = s->state;
365 (original_state == PA_SOURCE_SUSPENDED && PA_SOURCE_IS_OPENED(state)) ||
366 (PA_SOURCE_IS_OPENED(original_state) && state == PA_SOURCE_SUSPENDED);
369 if ((ret = s->set_state(s, state)) < 0)
373 if ((ret = pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL)) < 0) {
376 s->set_state(s, original_state);
383 if (state != PA_SOURCE_UNLINKED) { /* if we enter UNLINKED state pa_source_unlink() will fire the appropriate events */
384 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
385 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
388 if (suspend_change) {
392 /* We're suspending or resuming, tell everyone about it */
394 PA_IDXSET_FOREACH(o, s->outputs, idx)
395 if (s->state == PA_SOURCE_SUSPENDED &&
396 (o->flags & PA_SOURCE_OUTPUT_KILL_ON_SUSPEND))
397 pa_source_output_kill(o);
399 o->suspend(o, state == PA_SOURCE_SUSPENDED);
405 void pa_source_set_get_volume_callback(pa_source *s, pa_source_cb_t cb) {
411 void pa_source_set_set_volume_callback(pa_source *s, pa_source_cb_t cb) {
412 pa_source_flags_t flags;
415 pa_assert(!s->write_volume || cb);
419 /* Save the current flags so we can tell if they've changed */
423 /* The source implementor is responsible for setting decibel volume support */
424 s->flags |= PA_SOURCE_HW_VOLUME_CTRL;
426 s->flags &= ~PA_SOURCE_HW_VOLUME_CTRL;
427 /* See note below in pa_source_put() about volume sharing and decibel volumes */
428 pa_source_enable_decibel_volume(s, !(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
431 /* If the flags have changed after init, let any clients know via a change event */
432 if (s->state != PA_SOURCE_INIT && flags != s->flags)
433 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
436 void pa_source_set_write_volume_callback(pa_source *s, pa_source_cb_t cb) {
437 pa_source_flags_t flags;
440 pa_assert(!cb || s->set_volume);
442 s->write_volume = cb;
444 /* Save the current flags so we can tell if they've changed */
448 s->flags |= PA_SOURCE_DEFERRED_VOLUME;
450 s->flags &= ~PA_SOURCE_DEFERRED_VOLUME;
452 /* If the flags have changed after init, let any clients know via a change event */
453 if (s->state != PA_SOURCE_INIT && flags != s->flags)
454 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
457 void pa_source_set_get_mute_callback(pa_source *s, pa_source_cb_t cb) {
463 void pa_source_set_set_mute_callback(pa_source *s, pa_source_cb_t cb) {
464 pa_source_flags_t flags;
470 /* Save the current flags so we can tell if they've changed */
474 s->flags |= PA_SOURCE_HW_MUTE_CTRL;
476 s->flags &= ~PA_SOURCE_HW_MUTE_CTRL;
478 /* If the flags have changed after init, let any clients know via a change event */
479 if (s->state != PA_SOURCE_INIT && flags != s->flags)
480 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
483 static void enable_flat_volume(pa_source *s, pa_bool_t enable) {
484 pa_source_flags_t flags;
488 /* Always follow the overall user preference here */
489 enable = enable && s->core->flat_volumes;
491 /* Save the current flags so we can tell if they've changed */
495 s->flags |= PA_SOURCE_FLAT_VOLUME;
497 s->flags &= ~PA_SOURCE_FLAT_VOLUME;
499 /* If the flags have changed after init, let any clients know via a change event */
500 if (s->state != PA_SOURCE_INIT && flags != s->flags)
501 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
504 void pa_source_enable_decibel_volume(pa_source *s, pa_bool_t enable) {
505 pa_source_flags_t flags;
509 /* Save the current flags so we can tell if they've changed */
513 s->flags |= PA_SOURCE_DECIBEL_VOLUME;
514 enable_flat_volume(s, TRUE);
516 s->flags &= ~PA_SOURCE_DECIBEL_VOLUME;
517 enable_flat_volume(s, FALSE);
520 /* If the flags have changed after init, let any clients know via a change event */
521 if (s->state != PA_SOURCE_INIT && flags != s->flags)
522 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
525 /* Called from main context */
526 void pa_source_put(pa_source *s) {
527 pa_source_assert_ref(s);
528 pa_assert_ctl_context();
530 pa_assert(s->state == PA_SOURCE_INIT);
531 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER) || s->output_from_master);
533 /* The following fields must be initialized properly when calling _put() */
534 pa_assert(s->asyncmsgq);
535 pa_assert(s->thread_info.min_latency <= s->thread_info.max_latency);
537 /* Generally, flags should be initialized via pa_source_new(). As a
538 * special exception we allow some volume related flags to be set
539 * between _new() and _put() by the callback setter functions above.
541 * Thus we implement a couple safeguards here which ensure the above
542 * setters were used (or at least the implementor made manual changes
543 * in a compatible way).
545 * Note: All of these flags set here can change over the life time
547 pa_assert(!(s->flags & PA_SOURCE_HW_VOLUME_CTRL) || s->set_volume);
548 pa_assert(!(s->flags & PA_SOURCE_DEFERRED_VOLUME) || s->write_volume);
549 pa_assert(!(s->flags & PA_SOURCE_HW_MUTE_CTRL) || s->set_mute);
551 /* XXX: Currently decibel volume is disabled for all sources that use volume
552 * sharing. When the master source supports decibel volume, it would be good
553 * to have the flag also in the filter source, but currently we don't do that
554 * so that the flags of the filter source never change when it's moved from
555 * a master source to another. One solution for this problem would be to
556 * remove user-visible volume altogether from filter sources when volume
557 * sharing is used, but the current approach was easier to implement... */
558 /* We always support decibel volumes in software, otherwise we leave it to
559 * the source implementor to set this flag as needed.
561 * Note: This flag can also change over the life time of the source. */
562 if (!(s->flags & PA_SOURCE_HW_VOLUME_CTRL) && !(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
563 pa_source_enable_decibel_volume(s, TRUE);
565 /* If the source implementor support DB volumes by itself, we should always
566 * try and enable flat volumes too */
567 if ((s->flags & PA_SOURCE_DECIBEL_VOLUME))
568 enable_flat_volume(s, TRUE);
570 if (s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER) {
571 pa_source *root_source = pa_source_get_master(s);
573 pa_assert(PA_LIKELY(root_source));
575 s->reference_volume = root_source->reference_volume;
576 pa_cvolume_remap(&s->reference_volume, &root_source->channel_map, &s->channel_map);
578 s->real_volume = root_source->real_volume;
579 pa_cvolume_remap(&s->real_volume, &root_source->channel_map, &s->channel_map);
581 /* We assume that if the sink implementor changed the default
582 * volume he did so in real_volume, because that is the usual
583 * place where he is supposed to place his changes. */
584 s->reference_volume = s->real_volume;
586 s->thread_info.soft_volume = s->soft_volume;
587 s->thread_info.soft_muted = s->muted;
588 pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume);
590 pa_assert((s->flags & PA_SOURCE_HW_VOLUME_CTRL)
591 || (s->base_volume == PA_VOLUME_NORM
592 && ((s->flags & PA_SOURCE_DECIBEL_VOLUME || (s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)))));
593 pa_assert(!(s->flags & PA_SOURCE_DECIBEL_VOLUME) || s->n_volume_steps == PA_VOLUME_NORM+1);
594 pa_assert(!(s->flags & PA_SOURCE_DYNAMIC_LATENCY) == (s->thread_info.fixed_latency != 0));
596 pa_assert_se(source_set_state(s, PA_SOURCE_IDLE) == 0);
598 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
599 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PUT], s);
602 /* Called from main context */
603 void pa_source_unlink(pa_source *s) {
605 pa_source_output *o, *j = NULL;
608 pa_assert_ctl_context();
610 /* See pa_sink_unlink() for a couple of comments how this function
613 linked = PA_SOURCE_IS_LINKED(s->state);
616 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
618 if (s->state != PA_SOURCE_UNLINKED)
619 pa_namereg_unregister(s->core, s->name);
620 pa_idxset_remove_by_data(s->core->sources, s, NULL);
623 pa_idxset_remove_by_data(s->card->sources, s, NULL);
625 while ((o = pa_idxset_first(s->outputs, NULL))) {
627 pa_source_output_kill(o);
632 source_set_state(s, PA_SOURCE_UNLINKED);
634 s->state = PA_SOURCE_UNLINKED;
639 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
640 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
644 /* Called from main context */
645 static void source_free(pa_object *o) {
646 pa_source_output *so;
647 pa_source *s = PA_SOURCE(o);
650 pa_assert_ctl_context();
651 pa_assert(pa_source_refcnt(s) == 0);
653 if (PA_SOURCE_IS_LINKED(s->state))
656 pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
658 pa_idxset_free(s->outputs, NULL, NULL);
660 while ((so = pa_hashmap_steal_first(s->thread_info.outputs)))
661 pa_source_output_unref(so);
663 pa_hashmap_free(s->thread_info.outputs, NULL, NULL);
665 if (s->silence.memblock)
666 pa_memblock_unref(s->silence.memblock);
672 pa_proplist_free(s->proplist);
677 while ((p = pa_hashmap_steal_first(s->ports)))
678 pa_device_port_free(p);
680 pa_hashmap_free(s->ports, NULL, NULL);
686 /* Called from main context, and not while the IO thread is active, please */
687 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
688 pa_source_assert_ref(s);
689 pa_assert_ctl_context();
694 /* Called from main context, and not while the IO thread is active, please */
695 void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flags_t value) {
696 pa_source_assert_ref(s);
697 pa_assert_ctl_context();
702 /* For now, allow only a minimal set of flags to be changed. */
703 pa_assert((mask & ~(PA_SOURCE_DYNAMIC_LATENCY|PA_SOURCE_LATENCY)) == 0);
705 s->flags = (s->flags & ~mask) | (value & mask);
708 /* Called from IO context, or before _put() from main context */
709 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
710 pa_source_assert_ref(s);
711 pa_source_assert_io_context(s);
713 s->thread_info.rtpoll = p;
716 /* Called from main context */
717 int pa_source_update_status(pa_source*s) {
718 pa_source_assert_ref(s);
719 pa_assert_ctl_context();
720 pa_assert(PA_SOURCE_IS_LINKED(s->state));
722 if (s->state == PA_SOURCE_SUSPENDED)
725 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
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 ((pa_source_get_state(s) == PA_SOURCE_SUSPENDED) == !!s->suspend_cause)
746 pa_log_debug("Suspend cause of source %s is 0x%04x, %s", s->name, s->suspend_cause, s->suspend_cause ? "suspending" : "resuming");
748 if (s->suspend_cause)
749 return source_set_state(s, PA_SOURCE_SUSPENDED);
751 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
754 /* Called from main context */
755 int pa_source_sync_suspend(pa_source *s) {
756 pa_sink_state_t state;
758 pa_source_assert_ref(s);
759 pa_assert_ctl_context();
760 pa_assert(PA_SOURCE_IS_LINKED(s->state));
761 pa_assert(s->monitor_of);
763 state = pa_sink_get_state(s->monitor_of);
765 if (state == PA_SINK_SUSPENDED)
766 return source_set_state(s, PA_SOURCE_SUSPENDED);
768 pa_assert(PA_SINK_IS_OPENED(state));
770 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
773 /* Called from main context */
774 pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q) {
775 pa_source_output *o, *n;
778 pa_source_assert_ref(s);
779 pa_assert_ctl_context();
780 pa_assert(PA_SOURCE_IS_LINKED(s->state));
785 for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = n) {
786 n = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx));
788 pa_source_output_ref(o);
790 if (pa_source_output_start_move(o) >= 0)
793 pa_source_output_unref(o);
799 /* Called from main context */
800 void pa_source_move_all_finish(pa_source *s, pa_queue *q, pa_bool_t save) {
803 pa_source_assert_ref(s);
804 pa_assert_ctl_context();
805 pa_assert(PA_SOURCE_IS_LINKED(s->state));
808 while ((o = PA_SOURCE_OUTPUT(pa_queue_pop(q)))) {
809 if (pa_source_output_finish_move(o, s, save) < 0)
810 pa_source_output_fail_move(o);
812 pa_source_output_unref(o);
815 pa_queue_free(q, NULL, NULL);
818 /* Called from main context */
819 void pa_source_move_all_fail(pa_queue *q) {
822 pa_assert_ctl_context();
825 while ((o = PA_SOURCE_OUTPUT(pa_queue_pop(q)))) {
826 pa_source_output_fail_move(o);
827 pa_source_output_unref(o);
830 pa_queue_free(q, NULL, NULL);
833 /* Called from IO thread context */
834 void pa_source_process_rewind(pa_source *s, size_t nbytes) {
838 pa_source_assert_ref(s);
839 pa_source_assert_io_context(s);
840 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
845 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
848 pa_log_debug("Processing rewind...");
850 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state) {
851 pa_source_output_assert_ref(o);
852 pa_source_output_process_rewind(o, nbytes);
856 /* Called from IO thread context */
857 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
861 pa_source_assert_ref(s);
862 pa_source_assert_io_context(s);
863 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
866 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
869 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
870 pa_memchunk vchunk = *chunk;
872 pa_memblock_ref(vchunk.memblock);
873 pa_memchunk_make_writable(&vchunk, 0);
875 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
876 pa_silence_memchunk(&vchunk, &s->sample_spec);
878 pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
880 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
881 pa_source_output_assert_ref(o);
883 if (!o->thread_info.direct_on_input)
884 pa_source_output_push(o, &vchunk);
887 pa_memblock_unref(vchunk.memblock);
890 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
891 pa_source_output_assert_ref(o);
893 if (!o->thread_info.direct_on_input)
894 pa_source_output_push(o, chunk);
899 /* Called from IO thread context */
900 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk) {
901 pa_source_assert_ref(s);
902 pa_source_assert_io_context(s);
903 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
904 pa_source_output_assert_ref(o);
905 pa_assert(o->thread_info.direct_on_input);
908 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
911 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
912 pa_memchunk vchunk = *chunk;
914 pa_memblock_ref(vchunk.memblock);
915 pa_memchunk_make_writable(&vchunk, 0);
917 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
918 pa_silence_memchunk(&vchunk, &s->sample_spec);
920 pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
922 pa_source_output_push(o, &vchunk);
924 pa_memblock_unref(vchunk.memblock);
926 pa_source_output_push(o, chunk);
929 /* Called from main thread */
930 pa_bool_t pa_source_update_rate(pa_source *s, uint32_t rate, pa_bool_t passthrough)
932 if (s->update_rate) {
933 uint32_t desired_rate = rate;
934 uint32_t default_rate = s->default_sample_rate;
935 uint32_t alternate_rate = s->alternate_sample_rate;
936 pa_bool_t use_alternate = FALSE;
938 if (PA_UNLIKELY(default_rate == alternate_rate)) {
939 pa_log_warn("Default and alternate sample rates are the same.");
943 if (PA_SOURCE_IS_RUNNING(s->state)) {
944 pa_log_info("Cannot update rate, SOURCE_IS_RUNNING, will keep using %u kHz",
945 s->sample_spec.rate);
949 if (PA_UNLIKELY (desired_rate < 8000 ||
950 desired_rate > PA_RATE_MAX))
954 pa_assert(default_rate % 4000 || default_rate % 11025);
955 pa_assert(alternate_rate % 4000 || alternate_rate % 11025);
957 if (default_rate % 4000) {
958 /* default is a 11025 multiple */
959 if ((alternate_rate % 4000 == 0) && (desired_rate % 4000 == 0))
962 /* default is 4000 multiple */
963 if ((alternate_rate % 11025 == 0) && (desired_rate % 11025 == 0))
968 desired_rate = alternate_rate;
970 desired_rate = default_rate;
972 desired_rate = rate; /* use stream sampling rate, discard default/alternate settings */
975 if (passthrough || pa_source_used_by(s) == 0) {
976 pa_source_suspend(s, TRUE, PA_SUSPEND_IDLE); /* needed before rate update, will be resumed automatically */
979 if (s->update_rate(s, desired_rate) == TRUE) {
980 pa_log_info("Changed sampling rate successfully ");
987 /* Called from main thread */
988 pa_usec_t pa_source_get_latency(pa_source *s) {
991 pa_source_assert_ref(s);
992 pa_assert_ctl_context();
993 pa_assert(PA_SOURCE_IS_LINKED(s->state));
995 if (s->state == PA_SOURCE_SUSPENDED)
998 if (!(s->flags & PA_SOURCE_LATENCY))
1001 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0);
1006 /* Called from IO thread */
1007 pa_usec_t pa_source_get_latency_within_thread(pa_source *s) {
1011 pa_source_assert_ref(s);
1012 pa_source_assert_io_context(s);
1013 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
1015 /* The returned value is supposed to be in the time domain of the sound card! */
1017 if (s->thread_info.state == PA_SOURCE_SUSPENDED)
1020 if (!(s->flags & PA_SOURCE_LATENCY))
1023 o = PA_MSGOBJECT(s);
1025 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1027 if (o->process_msg(o, PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
1033 /* Called from the main thread (and also from the IO thread while the main
1034 * thread is waiting).
1036 * When a source uses volume sharing, it never has the PA_SOURCE_FLAT_VOLUME flag
1037 * set. Instead, flat volume mode is detected by checking whether the root source
1038 * has the flag set. */
1039 pa_bool_t pa_source_flat_volume_enabled(pa_source *s) {
1040 pa_source_assert_ref(s);
1042 s = pa_source_get_master(s);
1045 return (s->flags & PA_SOURCE_FLAT_VOLUME);
1050 /* Called from the main thread (and also from the IO thread while the main
1051 * thread is waiting). */
1052 pa_source *pa_source_get_master(pa_source *s) {
1053 pa_source_assert_ref(s);
1055 while (s && (s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1056 if (PA_UNLIKELY(!s->output_from_master))
1059 s = s->output_from_master->source;
1065 /* Called from main context */
1066 pa_bool_t pa_source_is_passthrough(pa_source *s) {
1068 pa_source_assert_ref(s);
1070 /* NB Currently only monitor sources support passthrough mode */
1071 return (s->monitor_of && pa_sink_is_passthrough(s->monitor_of));
1074 /* Called from main context */
1075 void pa_source_enter_passthrough(pa_source *s) {
1078 /* set the volume to NORM */
1079 s->saved_volume = *pa_source_get_volume(s, TRUE);
1080 s->saved_save_volume = s->save_volume;
1082 pa_cvolume_set(&volume, s->sample_spec.channels, PA_MIN(s->base_volume, PA_VOLUME_NORM));
1083 pa_source_set_volume(s, &volume, TRUE, FALSE);
1086 /* Called from main context */
1087 void pa_source_leave_passthrough(pa_source *s) {
1088 /* Restore source volume to what it was before we entered passthrough mode */
1089 pa_source_set_volume(s, &s->saved_volume, TRUE, s->saved_save_volume);
1091 pa_cvolume_init(&s->saved_volume);
1092 s->saved_save_volume = FALSE;
1095 /* Called from main context. */
1096 static void compute_reference_ratio(pa_source_output *o) {
1098 pa_cvolume remapped;
1101 pa_assert(pa_source_flat_volume_enabled(o->source));
1104 * Calculates the reference ratio from the source's reference
1105 * volume. This basically calculates:
1107 * o->reference_ratio = o->volume / o->source->reference_volume
1110 remapped = o->source->reference_volume;
1111 pa_cvolume_remap(&remapped, &o->source->channel_map, &o->channel_map);
1113 o->reference_ratio.channels = o->sample_spec.channels;
1115 for (c = 0; c < o->sample_spec.channels; c++) {
1117 /* We don't update when the source volume is 0 anyway */
1118 if (remapped.values[c] <= PA_VOLUME_MUTED)
1121 /* Don't update the reference ratio unless necessary */
1122 if (pa_sw_volume_multiply(
1123 o->reference_ratio.values[c],
1124 remapped.values[c]) == o->volume.values[c])
1127 o->reference_ratio.values[c] = pa_sw_volume_divide(
1128 o->volume.values[c],
1129 remapped.values[c]);
1133 /* Called from main context. Only called for the root source in volume sharing
1134 * cases, except for internal recursive calls. */
1135 static void compute_reference_ratios(pa_source *s) {
1137 pa_source_output *o;
1139 pa_source_assert_ref(s);
1140 pa_assert_ctl_context();
1141 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1142 pa_assert(pa_source_flat_volume_enabled(s));
1144 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1145 compute_reference_ratio(o);
1147 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1148 compute_reference_ratios(o->destination_source);
1152 /* Called from main context. Only called for the root source in volume sharing
1153 * cases, except for internal recursive calls. */
1154 static void compute_real_ratios(pa_source *s) {
1155 pa_source_output *o;
1158 pa_source_assert_ref(s);
1159 pa_assert_ctl_context();
1160 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1161 pa_assert(pa_source_flat_volume_enabled(s));
1163 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1165 pa_cvolume remapped;
1167 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1168 /* The origin source uses volume sharing, so this input's real ratio
1169 * is handled as a special case - the real ratio must be 0 dB, and
1170 * as a result i->soft_volume must equal i->volume_factor. */
1171 pa_cvolume_reset(&o->real_ratio, o->real_ratio.channels);
1172 o->soft_volume = o->volume_factor;
1174 compute_real_ratios(o->destination_source);
1180 * This basically calculates:
1182 * i->real_ratio := i->volume / s->real_volume
1183 * i->soft_volume := i->real_ratio * i->volume_factor
1186 remapped = s->real_volume;
1187 pa_cvolume_remap(&remapped, &s->channel_map, &o->channel_map);
1189 o->real_ratio.channels = o->sample_spec.channels;
1190 o->soft_volume.channels = o->sample_spec.channels;
1192 for (c = 0; c < o->sample_spec.channels; c++) {
1194 if (remapped.values[c] <= PA_VOLUME_MUTED) {
1195 /* We leave o->real_ratio untouched */
1196 o->soft_volume.values[c] = PA_VOLUME_MUTED;
1200 /* Don't lose accuracy unless necessary */
1201 if (pa_sw_volume_multiply(
1202 o->real_ratio.values[c],
1203 remapped.values[c]) != o->volume.values[c])
1205 o->real_ratio.values[c] = pa_sw_volume_divide(
1206 o->volume.values[c],
1207 remapped.values[c]);
1209 o->soft_volume.values[c] = pa_sw_volume_multiply(
1210 o->real_ratio.values[c],
1211 o->volume_factor.values[c]);
1214 /* We don't copy the soft_volume to the thread_info data
1215 * here. That must be done by the caller */
1219 static pa_cvolume *cvolume_remap_minimal_impact(
1221 const pa_cvolume *template,
1222 const pa_channel_map *from,
1223 const pa_channel_map *to) {
1228 pa_assert(template);
1231 pa_assert(pa_cvolume_compatible_with_channel_map(v, from));
1232 pa_assert(pa_cvolume_compatible_with_channel_map(template, to));
1234 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1235 * mapping from source output to source volumes:
1237 * If template is a possible remapping from v it is used instead
1238 * of remapping anew.
1240 * If the channel maps don't match we set an all-channel volume on
1241 * the source to ensure that changing a volume on one stream has no
1242 * effect that cannot be compensated for in another stream that
1243 * does not have the same channel map as the source. */
1245 if (pa_channel_map_equal(from, to))
1249 if (pa_cvolume_equal(pa_cvolume_remap(&t, to, from), v)) {
1254 pa_cvolume_set(v, to->channels, pa_cvolume_max(v));
1258 /* Called from main thread. Only called for the root source in volume sharing
1259 * cases, except for internal recursive calls. */
1260 static void get_maximum_output_volume(pa_source *s, pa_cvolume *max_volume, const pa_channel_map *channel_map) {
1261 pa_source_output *o;
1264 pa_source_assert_ref(s);
1265 pa_assert(max_volume);
1266 pa_assert(channel_map);
1267 pa_assert(pa_source_flat_volume_enabled(s));
1269 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1270 pa_cvolume remapped;
1272 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1273 get_maximum_output_volume(o->destination_source, max_volume, channel_map);
1275 /* Ignore this output. The origin source uses volume sharing, so this
1276 * output's volume will be set to be equal to the root source's real
1277 * volume. Obviously this output's current volume must not then
1278 * affect what the root source's real volume will be. */
1282 remapped = o->volume;
1283 cvolume_remap_minimal_impact(&remapped, max_volume, &o->channel_map, channel_map);
1284 pa_cvolume_merge(max_volume, max_volume, &remapped);
1288 /* Called from main thread. Only called for the root source in volume sharing
1289 * cases, except for internal recursive calls. */
1290 static pa_bool_t has_outputs(pa_source *s) {
1291 pa_source_output *o;
1294 pa_source_assert_ref(s);
1296 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1297 if (!o->destination_source || !(o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER) || has_outputs(o->destination_source))
1304 /* Called from main thread. Only called for the root source in volume sharing
1305 * cases, except for internal recursive calls. */
1306 static void update_real_volume(pa_source *s, const pa_cvolume *new_volume, pa_channel_map *channel_map) {
1307 pa_source_output *o;
1310 pa_source_assert_ref(s);
1311 pa_assert(new_volume);
1312 pa_assert(channel_map);
1314 s->real_volume = *new_volume;
1315 pa_cvolume_remap(&s->real_volume, channel_map, &s->channel_map);
1317 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1318 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1319 if (pa_source_flat_volume_enabled(s)) {
1320 pa_cvolume old_volume = o->volume;
1322 /* Follow the root source's real volume. */
1323 o->volume = *new_volume;
1324 pa_cvolume_remap(&o->volume, channel_map, &o->channel_map);
1325 compute_reference_ratio(o);
1327 /* The volume changed, let's tell people so */
1328 if (!pa_cvolume_equal(&old_volume, &o->volume)) {
1329 if (o->volume_changed)
1330 o->volume_changed(o);
1332 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1336 update_real_volume(o->destination_source, new_volume, channel_map);
1341 /* Called from main thread. Only called for the root source in shared volume
1343 static void compute_real_volume(pa_source *s) {
1344 pa_source_assert_ref(s);
1345 pa_assert_ctl_context();
1346 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1347 pa_assert(pa_source_flat_volume_enabled(s));
1348 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1350 /* This determines the maximum volume of all streams and sets
1351 * s->real_volume accordingly. */
1353 if (!has_outputs(s)) {
1354 /* In the special case that we have no source outputs we leave the
1355 * volume unmodified. */
1356 update_real_volume(s, &s->reference_volume, &s->channel_map);
1360 pa_cvolume_mute(&s->real_volume, s->channel_map.channels);
1362 /* First let's determine the new maximum volume of all outputs
1363 * connected to this source */
1364 get_maximum_output_volume(s, &s->real_volume, &s->channel_map);
1365 update_real_volume(s, &s->real_volume, &s->channel_map);
1367 /* Then, let's update the real ratios/soft volumes of all outputs
1368 * connected to this source */
1369 compute_real_ratios(s);
1372 /* Called from main thread. Only called for the root source in shared volume
1373 * cases, except for internal recursive calls. */
1374 static void propagate_reference_volume(pa_source *s) {
1375 pa_source_output *o;
1378 pa_source_assert_ref(s);
1379 pa_assert_ctl_context();
1380 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1381 pa_assert(pa_source_flat_volume_enabled(s));
1383 /* This is called whenever the source volume changes that is not
1384 * caused by a source output volume change. We need to fix up the
1385 * source output volumes accordingly */
1387 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1388 pa_cvolume old_volume;
1390 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1391 propagate_reference_volume(o->destination_source);
1393 /* Since the origin source uses volume sharing, this output's volume
1394 * needs to be updated to match the root source's real volume, but
1395 * that will be done later in update_shared_real_volume(). */
1399 old_volume = o->volume;
1401 /* This basically calculates:
1403 * o->volume := o->reference_volume * o->reference_ratio */
1405 o->volume = s->reference_volume;
1406 pa_cvolume_remap(&o->volume, &s->channel_map, &o->channel_map);
1407 pa_sw_cvolume_multiply(&o->volume, &o->volume, &o->reference_ratio);
1409 /* The volume changed, let's tell people so */
1410 if (!pa_cvolume_equal(&old_volume, &o->volume)) {
1412 if (o->volume_changed)
1413 o->volume_changed(o);
1415 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1420 /* Called from main thread. Only called for the root source in volume sharing
1421 * cases, except for internal recursive calls. The return value indicates
1422 * whether any reference volume actually changed. */
1423 static pa_bool_t update_reference_volume(pa_source *s, const pa_cvolume *v, const pa_channel_map *channel_map, pa_bool_t save) {
1425 pa_bool_t reference_volume_changed;
1426 pa_source_output *o;
1429 pa_source_assert_ref(s);
1430 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1432 pa_assert(channel_map);
1433 pa_assert(pa_cvolume_valid(v));
1436 pa_cvolume_remap(&volume, channel_map, &s->channel_map);
1438 reference_volume_changed = !pa_cvolume_equal(&volume, &s->reference_volume);
1439 s->reference_volume = volume;
1441 s->save_volume = (!reference_volume_changed && s->save_volume) || save;
1443 if (reference_volume_changed)
1444 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1445 else if (!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1446 /* If the root source's volume doesn't change, then there can't be any
1447 * changes in the other source in the source tree either.
1449 * It's probably theoretically possible that even if the root source's
1450 * volume changes slightly, some filter source doesn't change its volume
1451 * due to rounding errors. If that happens, we still want to propagate
1452 * the changed root source volume to the sources connected to the
1453 * intermediate source that didn't change its volume. This theoretical
1454 * possibility is the reason why we have that !(s->flags &
1455 * PA_SOURCE_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1456 * notice even if we returned here FALSE always if
1457 * reference_volume_changed is FALSE. */
1460 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1461 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1462 update_reference_volume(o->destination_source, v, channel_map, FALSE);
1468 /* Called from main thread */
1469 void pa_source_set_volume(
1471 const pa_cvolume *volume,
1475 pa_cvolume new_reference_volume;
1476 pa_source *root_source;
1478 pa_source_assert_ref(s);
1479 pa_assert_ctl_context();
1480 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1481 pa_assert(!volume || pa_cvolume_valid(volume));
1482 pa_assert(volume || pa_source_flat_volume_enabled(s));
1483 pa_assert(!volume || volume->channels == 1 || pa_cvolume_compatible(volume, &s->sample_spec));
1485 /* make sure we don't change the volume in PASSTHROUGH mode ...
1486 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1487 if (pa_source_is_passthrough(s) && (!volume || !pa_cvolume_is_norm(volume))) {
1488 pa_log_warn("Cannot change volume, Source is monitor of a PASSTHROUGH sink");
1492 /* In case of volume sharing, the volume is set for the root source first,
1493 * from which it's then propagated to the sharing sources. */
1494 root_source = pa_source_get_master(s);
1496 if (PA_UNLIKELY(!root_source))
1499 /* As a special exception we accept mono volumes on all sources --
1500 * even on those with more complex channel maps */
1503 if (pa_cvolume_compatible(volume, &s->sample_spec))
1504 new_reference_volume = *volume;
1506 new_reference_volume = s->reference_volume;
1507 pa_cvolume_scale(&new_reference_volume, pa_cvolume_max(volume));
1510 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_source->channel_map);
1513 /* If volume is NULL we synchronize the source's real and reference
1514 * volumes with the stream volumes. If it is not NULL we update
1515 * the reference_volume with it. */
1518 if (update_reference_volume(root_source, &new_reference_volume, &root_source->channel_map, save)) {
1519 if (pa_source_flat_volume_enabled(root_source)) {
1520 /* OK, propagate this volume change back to the outputs */
1521 propagate_reference_volume(root_source);
1523 /* And now recalculate the real volume */
1524 compute_real_volume(root_source);
1526 update_real_volume(root_source, &root_source->reference_volume, &root_source->channel_map);
1530 pa_assert(pa_source_flat_volume_enabled(root_source));
1532 /* Ok, let's determine the new real volume */
1533 compute_real_volume(root_source);
1535 /* Let's 'push' the reference volume if necessary */
1536 pa_cvolume_merge(&new_reference_volume, &s->reference_volume, &root_source->real_volume);
1537 /* If the source and it's root don't have the same number of channels, we need to remap */
1538 if (s != root_source && !pa_channel_map_equal(&s->channel_map, &root_source->channel_map))
1539 pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_source->channel_map);
1540 update_reference_volume(root_source, &new_reference_volume, &root_source->channel_map, save);
1542 /* Now that the reference volume is updated, we can update the streams'
1543 * reference ratios. */
1544 compute_reference_ratios(root_source);
1547 if (root_source->set_volume) {
1548 /* If we have a function set_volume(), then we do not apply a
1549 * soft volume by default. However, set_volume() is free to
1550 * apply one to root_source->soft_volume */
1552 pa_cvolume_reset(&root_source->soft_volume, root_source->sample_spec.channels);
1553 if (!(root_source->flags & PA_SOURCE_DEFERRED_VOLUME))
1554 root_source->set_volume(root_source);
1557 /* If we have no function set_volume(), then the soft volume
1558 * becomes the real volume */
1559 root_source->soft_volume = root_source->real_volume;
1561 /* This tells the source that soft volume and/or real volume changed */
1563 pa_assert_se(pa_asyncmsgq_send(root_source->asyncmsgq, PA_MSGOBJECT(root_source), PA_SOURCE_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL) == 0);
1566 /* Called from the io thread if sync volume is used, otherwise from the main thread.
1567 * Only to be called by source implementor */
1568 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume) {
1570 pa_source_assert_ref(s);
1571 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1573 if (s->flags & PA_SOURCE_DEFERRED_VOLUME)
1574 pa_source_assert_io_context(s);
1576 pa_assert_ctl_context();
1579 pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels);
1581 s->soft_volume = *volume;
1583 if (PA_SOURCE_IS_LINKED(s->state) && !(s->flags & PA_SOURCE_DEFERRED_VOLUME))
1584 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0);
1586 s->thread_info.soft_volume = s->soft_volume;
1589 /* Called from the main thread. Only called for the root source in volume sharing
1590 * cases, except for internal recursive calls. */
1591 static void propagate_real_volume(pa_source *s, const pa_cvolume *old_real_volume) {
1592 pa_source_output *o;
1595 pa_source_assert_ref(s);
1596 pa_assert(old_real_volume);
1597 pa_assert_ctl_context();
1598 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1600 /* This is called when the hardware's real volume changes due to
1601 * some external event. We copy the real volume into our
1602 * reference volume and then rebuild the stream volumes based on
1603 * i->real_ratio which should stay fixed. */
1605 if (!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1606 if (pa_cvolume_equal(old_real_volume, &s->real_volume))
1609 /* 1. Make the real volume the reference volume */
1610 update_reference_volume(s, &s->real_volume, &s->channel_map, TRUE);
1613 if (pa_source_flat_volume_enabled(s)) {
1615 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1616 pa_cvolume old_volume = o->volume;
1618 /* 2. Since the source's reference and real volumes are equal
1619 * now our ratios should be too. */
1620 o->reference_ratio = o->real_ratio;
1622 /* 3. Recalculate the new stream reference volume based on the
1623 * reference ratio and the sink's reference volume.
1625 * This basically calculates:
1627 * o->volume = s->reference_volume * o->reference_ratio
1629 * This is identical to propagate_reference_volume() */
1630 o->volume = s->reference_volume;
1631 pa_cvolume_remap(&o->volume, &s->channel_map, &o->channel_map);
1632 pa_sw_cvolume_multiply(&o->volume, &o->volume, &o->reference_ratio);
1634 /* Notify if something changed */
1635 if (!pa_cvolume_equal(&old_volume, &o->volume)) {
1637 if (o->volume_changed)
1638 o->volume_changed(o);
1640 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1643 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1644 propagate_real_volume(o->destination_source, old_real_volume);
1648 /* Something got changed in the hardware. It probably makes sense
1649 * to save changed hw settings given that hw volume changes not
1650 * triggered by PA are almost certainly done by the user. */
1651 if (!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1652 s->save_volume = TRUE;
1655 /* Called from io thread */
1656 void pa_source_update_volume_and_mute(pa_source *s) {
1658 pa_source_assert_io_context(s);
1660 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE, NULL, 0, NULL, NULL);
1663 /* Called from main thread */
1664 const pa_cvolume *pa_source_get_volume(pa_source *s, pa_bool_t force_refresh) {
1665 pa_source_assert_ref(s);
1666 pa_assert_ctl_context();
1667 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1669 if (s->refresh_volume || force_refresh) {
1670 struct pa_cvolume old_real_volume;
1672 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1674 old_real_volume = s->real_volume;
1676 if (!(s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->get_volume)
1679 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, NULL, 0, NULL) == 0);
1681 update_real_volume(s, &s->real_volume, &s->channel_map);
1682 propagate_real_volume(s, &old_real_volume);
1685 return &s->reference_volume;
1688 /* Called from main thread. In volume sharing cases, only the root source may
1690 void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_real_volume) {
1691 pa_cvolume old_real_volume;
1693 pa_source_assert_ref(s);
1694 pa_assert_ctl_context();
1695 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1696 pa_assert(!(s->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER));
1698 /* The source implementor may call this if the volume changed to make sure everyone is notified */
1700 old_real_volume = s->real_volume;
1701 update_real_volume(s, new_real_volume, &s->channel_map);
1702 propagate_real_volume(s, &old_real_volume);
1705 /* Called from main thread */
1706 void pa_source_set_mute(pa_source *s, pa_bool_t mute, pa_bool_t save) {
1707 pa_bool_t old_muted;
1709 pa_source_assert_ref(s);
1710 pa_assert_ctl_context();
1711 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1713 old_muted = s->muted;
1715 s->save_muted = (old_muted == s->muted && s->save_muted) || save;
1717 if (!(s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->set_mute)
1720 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
1722 if (old_muted != s->muted)
1723 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1726 /* Called from main thread */
1727 pa_bool_t pa_source_get_mute(pa_source *s, pa_bool_t force_refresh) {
1729 pa_source_assert_ref(s);
1730 pa_assert_ctl_context();
1731 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1733 if (s->refresh_muted || force_refresh) {
1734 pa_bool_t old_muted = s->muted;
1736 if (!(s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->get_mute)
1739 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, NULL, 0, NULL) == 0);
1741 if (old_muted != s->muted) {
1742 s->save_muted = TRUE;
1744 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1746 /* Make sure the soft mute status stays in sync */
1747 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0);
1754 /* Called from main thread */
1755 void pa_source_mute_changed(pa_source *s, pa_bool_t new_muted) {
1756 pa_source_assert_ref(s);
1757 pa_assert_ctl_context();
1758 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1760 /* The source implementor may call this if the mute state changed to make sure everyone is notified */
1762 if (s->muted == new_muted)
1765 s->muted = new_muted;
1766 s->save_muted = TRUE;
1768 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1771 /* Called from main thread */
1772 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p) {
1773 pa_source_assert_ref(s);
1774 pa_assert_ctl_context();
1777 pa_proplist_update(s->proplist, mode, p);
1779 if (PA_SOURCE_IS_LINKED(s->state)) {
1780 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
1781 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1787 /* Called from main thread */
1788 /* FIXME -- this should be dropped and be merged into pa_source_update_proplist() */
1789 void pa_source_set_description(pa_source *s, const char *description) {
1791 pa_source_assert_ref(s);
1792 pa_assert_ctl_context();
1794 if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
1797 old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
1799 if (old && description && pa_streq(old, description))
1803 pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
1805 pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
1807 if (PA_SOURCE_IS_LINKED(s->state)) {
1808 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
1809 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
1813 /* Called from main thread */
1814 unsigned pa_source_linked_by(pa_source *s) {
1815 pa_source_assert_ref(s);
1816 pa_assert_ctl_context();
1817 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1819 return pa_idxset_size(s->outputs);
1822 /* Called from main thread */
1823 unsigned pa_source_used_by(pa_source *s) {
1826 pa_source_assert_ref(s);
1827 pa_assert_ctl_context();
1828 pa_assert(PA_SOURCE_IS_LINKED(s->state));
1830 ret = pa_idxset_size(s->outputs);
1831 pa_assert(ret >= s->n_corked);
1833 return ret - s->n_corked;
1836 /* Called from main thread */
1837 unsigned pa_source_check_suspend(pa_source *s) {
1839 pa_source_output *o;
1842 pa_source_assert_ref(s);
1843 pa_assert_ctl_context();
1845 if (!PA_SOURCE_IS_LINKED(s->state))
1850 PA_IDXSET_FOREACH(o, s->outputs, idx) {
1851 pa_source_output_state_t st;
1853 st = pa_source_output_get_state(o);
1855 /* We do not assert here. It is perfectly valid for a source output to
1856 * be in the INIT state (i.e. created, marked done but not yet put)
1857 * and we should not care if it's unlinked as it won't contribute
1858 * towards our busy status.
1860 if (!PA_SOURCE_OUTPUT_IS_LINKED(st))
1863 if (st == PA_SOURCE_OUTPUT_CORKED)
1866 if (o->flags & PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND)
1875 /* Called from the IO thread */
1876 static void sync_output_volumes_within_thread(pa_source *s) {
1877 pa_source_output *o;
1880 pa_source_assert_ref(s);
1881 pa_source_assert_io_context(s);
1883 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state) {
1884 if (pa_cvolume_equal(&o->thread_info.soft_volume, &o->soft_volume))
1887 o->thread_info.soft_volume = o->soft_volume;
1888 //pa_source_output_request_rewind(o, 0, TRUE, FALSE, FALSE);
1892 /* Called from the IO thread. Only called for the root source in volume sharing
1893 * cases, except for internal recursive calls. */
1894 static void set_shared_volume_within_thread(pa_source *s) {
1895 pa_source_output *o;
1898 pa_source_assert_ref(s);
1900 PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL);
1902 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state) {
1903 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
1904 set_shared_volume_within_thread(o->destination_source);
1908 /* Called from IO thread, except when it is not */
1909 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1910 pa_source *s = PA_SOURCE(object);
1911 pa_source_assert_ref(s);
1913 switch ((pa_source_message_t) code) {
1915 case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
1916 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
1918 pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
1920 if (o->direct_on_input) {
1921 o->thread_info.direct_on_input = o->direct_on_input;
1922 pa_hashmap_put(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index), o);
1925 pa_assert(!o->thread_info.attached);
1926 o->thread_info.attached = TRUE;
1931 pa_source_output_set_state_within_thread(o, o->state);
1933 if (o->thread_info.requested_source_latency != (pa_usec_t) -1)
1934 pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
1936 pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
1938 /* We don't just invalidate the requested latency here,
1939 * because if we are in a move we might need to fix up the
1940 * requested latency. */
1941 pa_source_output_set_requested_latency_within_thread(o, o->thread_info.requested_source_latency);
1943 /* In flat volume mode we need to update the volume as
1945 return object->process_msg(object, PA_SOURCE_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
1948 case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
1949 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
1951 pa_source_output_set_state_within_thread(o, o->state);
1956 pa_assert(o->thread_info.attached);
1957 o->thread_info.attached = FALSE;
1959 if (o->thread_info.direct_on_input) {
1960 pa_hashmap_remove(o->thread_info.direct_on_input->thread_info.direct_outputs, PA_UINT32_TO_PTR(o->index));
1961 o->thread_info.direct_on_input = NULL;
1964 if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
1965 pa_source_output_unref(o);
1967 pa_source_invalidate_requested_latency(s, TRUE);
1969 /* In flat volume mode we need to update the volume as
1971 return object->process_msg(object, PA_SOURCE_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL);
1974 case PA_SOURCE_MESSAGE_SET_SHARED_VOLUME: {
1975 pa_source *root_source = pa_source_get_master(s);
1977 if (PA_LIKELY(root_source))
1978 set_shared_volume_within_thread(root_source);
1983 case PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED:
1985 if (s->flags & PA_SOURCE_DEFERRED_VOLUME) {
1987 pa_source_volume_change_push(s);
1989 /* Fall through ... */
1991 case PA_SOURCE_MESSAGE_SET_VOLUME:
1993 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
1994 s->thread_info.soft_volume = s->soft_volume;
1997 /* Fall through ... */
1999 case PA_SOURCE_MESSAGE_SYNC_VOLUMES:
2000 sync_output_volumes_within_thread(s);
2003 case PA_SOURCE_MESSAGE_GET_VOLUME:
2005 if ((s->flags & PA_SOURCE_DEFERRED_VOLUME) && s->get_volume) {
2007 pa_source_volume_change_flush(s);
2008 pa_sw_cvolume_divide(&s->thread_info.current_hw_volume, &s->real_volume, &s->soft_volume);
2011 /* In case source implementor reset SW volume. */
2012 if (!pa_cvolume_equal(&s->thread_info.soft_volume, &s->soft_volume)) {
2013 s->thread_info.soft_volume = s->soft_volume;
2018 case PA_SOURCE_MESSAGE_SET_MUTE:
2020 if (s->thread_info.soft_muted != s->muted) {
2021 s->thread_info.soft_muted = s->muted;
2024 if (s->flags & PA_SOURCE_DEFERRED_VOLUME && s->set_mute)
2029 case PA_SOURCE_MESSAGE_GET_MUTE:
2031 if (s->flags & PA_SOURCE_DEFERRED_VOLUME && s->get_mute)
2036 case PA_SOURCE_MESSAGE_SET_STATE: {
2038 pa_bool_t suspend_change =
2039 (s->thread_info.state == PA_SOURCE_SUSPENDED && PA_SOURCE_IS_OPENED(PA_PTR_TO_UINT(userdata))) ||
2040 (PA_SOURCE_IS_OPENED(s->thread_info.state) && PA_PTR_TO_UINT(userdata) == PA_SOURCE_SUSPENDED);
2042 s->thread_info.state = PA_PTR_TO_UINT(userdata);
2044 if (suspend_change) {
2045 pa_source_output *o;
2048 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
2049 if (o->suspend_within_thread)
2050 o->suspend_within_thread(o, s->thread_info.state == PA_SOURCE_SUSPENDED);
2056 case PA_SOURCE_MESSAGE_DETACH:
2058 /* Detach all streams */
2059 pa_source_detach_within_thread(s);
2062 case PA_SOURCE_MESSAGE_ATTACH:
2064 /* Reattach all streams */
2065 pa_source_attach_within_thread(s);
2068 case PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY: {
2070 pa_usec_t *usec = userdata;
2071 *usec = pa_source_get_requested_latency_within_thread(s);
2073 /* Yes, that's right, the IO thread will see -1 when no
2074 * explicit requested latency is configured, the main
2075 * thread will see max_latency */
2076 if (*usec == (pa_usec_t) -1)
2077 *usec = s->thread_info.max_latency;
2082 case PA_SOURCE_MESSAGE_SET_LATENCY_RANGE: {
2083 pa_usec_t *r = userdata;
2085 pa_source_set_latency_range_within_thread(s, r[0], r[1]);
2090 case PA_SOURCE_MESSAGE_GET_LATENCY_RANGE: {
2091 pa_usec_t *r = userdata;
2093 r[0] = s->thread_info.min_latency;
2094 r[1] = s->thread_info.max_latency;
2099 case PA_SOURCE_MESSAGE_GET_FIXED_LATENCY:
2101 *((pa_usec_t*) userdata) = s->thread_info.fixed_latency;
2104 case PA_SOURCE_MESSAGE_SET_FIXED_LATENCY:
2106 pa_source_set_fixed_latency_within_thread(s, (pa_usec_t) offset);
2109 case PA_SOURCE_MESSAGE_GET_MAX_REWIND:
2111 *((size_t*) userdata) = s->thread_info.max_rewind;
2114 case PA_SOURCE_MESSAGE_SET_MAX_REWIND:
2116 pa_source_set_max_rewind_within_thread(s, (size_t) offset);
2119 case PA_SOURCE_MESSAGE_GET_LATENCY:
2121 if (s->monitor_of) {
2122 *((pa_usec_t*) userdata) = 0;
2126 /* Implementors need to overwrite this implementation! */
2129 case PA_SOURCE_MESSAGE_SET_PORT:
2131 pa_assert(userdata);
2133 struct source_message_set_port *msg_data = userdata;
2134 msg_data->ret = s->set_port(s, msg_data->port);
2138 case PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE:
2139 /* This message is sent from IO-thread and handled in main thread. */
2140 pa_assert_ctl_context();
2142 /* Make sure we're not messing with main thread when no longer linked */
2143 if (!PA_SOURCE_IS_LINKED(s->state))
2146 pa_source_get_volume(s, TRUE);
2147 pa_source_get_mute(s, TRUE);
2150 case PA_SOURCE_MESSAGE_MAX:
2157 /* Called from main thread */
2158 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause) {
2163 pa_core_assert_ref(c);
2164 pa_assert_ctl_context();
2165 pa_assert(cause != 0);
2167 for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx))) {
2170 if (source->monitor_of)
2173 if ((r = pa_source_suspend(source, suspend, cause)) < 0)
2180 /* Called from main thread */
2181 void pa_source_detach(pa_source *s) {
2182 pa_source_assert_ref(s);
2183 pa_assert_ctl_context();
2184 pa_assert(PA_SOURCE_IS_LINKED(s->state));
2186 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL) == 0);
2189 /* Called from main thread */
2190 void pa_source_attach(pa_source *s) {
2191 pa_source_assert_ref(s);
2192 pa_assert_ctl_context();
2193 pa_assert(PA_SOURCE_IS_LINKED(s->state));
2195 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL) == 0);
2198 /* Called from IO thread */
2199 void pa_source_detach_within_thread(pa_source *s) {
2200 pa_source_output *o;
2203 pa_source_assert_ref(s);
2204 pa_source_assert_io_context(s);
2205 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
2207 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2212 /* Called from IO thread */
2213 void pa_source_attach_within_thread(pa_source *s) {
2214 pa_source_output *o;
2217 pa_source_assert_ref(s);
2218 pa_source_assert_io_context(s);
2219 pa_assert(PA_SOURCE_IS_LINKED(s->thread_info.state));
2221 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2226 /* Called from IO thread */
2227 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s) {
2228 pa_usec_t result = (pa_usec_t) -1;
2229 pa_source_output *o;
2232 pa_source_assert_ref(s);
2233 pa_source_assert_io_context(s);
2235 if (!(s->flags & PA_SOURCE_DYNAMIC_LATENCY))
2236 return PA_CLAMP(s->thread_info.fixed_latency, s->thread_info.min_latency, s->thread_info.max_latency);
2238 if (s->thread_info.requested_latency_valid)
2239 return s->thread_info.requested_latency;
2241 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2242 if (o->thread_info.requested_source_latency != (pa_usec_t) -1 &&
2243 (result == (pa_usec_t) -1 || result > o->thread_info.requested_source_latency))
2244 result = o->thread_info.requested_source_latency;
2246 if (result != (pa_usec_t) -1)
2247 result = PA_CLAMP(result, s->thread_info.min_latency, s->thread_info.max_latency);
2249 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2250 /* Only cache this if we are fully set up */
2251 s->thread_info.requested_latency = result;
2252 s->thread_info.requested_latency_valid = TRUE;
2258 /* Called from main thread */
2259 pa_usec_t pa_source_get_requested_latency(pa_source *s) {
2262 pa_source_assert_ref(s);
2263 pa_assert_ctl_context();
2264 pa_assert(PA_SOURCE_IS_LINKED(s->state));
2266 if (s->state == PA_SOURCE_SUSPENDED)
2269 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
2274 /* Called from IO thread */
2275 void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind) {
2276 pa_source_output *o;
2279 pa_source_assert_ref(s);
2280 pa_source_assert_io_context(s);
2282 if (max_rewind == s->thread_info.max_rewind)
2285 s->thread_info.max_rewind = max_rewind;
2287 if (PA_SOURCE_IS_LINKED(s->thread_info.state))
2288 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2289 pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
2292 /* Called from main thread */
2293 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind) {
2294 pa_source_assert_ref(s);
2295 pa_assert_ctl_context();
2297 if (PA_SOURCE_IS_LINKED(s->state))
2298 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MAX_REWIND, NULL, max_rewind, NULL) == 0);
2300 pa_source_set_max_rewind_within_thread(s, max_rewind);
2303 /* Called from IO thread */
2304 void pa_source_invalidate_requested_latency(pa_source *s, pa_bool_t dynamic) {
2305 pa_source_output *o;
2308 pa_source_assert_ref(s);
2309 pa_source_assert_io_context(s);
2311 if ((s->flags & PA_SOURCE_DYNAMIC_LATENCY))
2312 s->thread_info.requested_latency_valid = FALSE;
2316 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2318 if (s->update_requested_latency)
2319 s->update_requested_latency(s);
2321 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
2322 if (o->update_source_requested_latency)
2323 o->update_source_requested_latency(o);
2327 pa_sink_invalidate_requested_latency(s->monitor_of, dynamic);
2330 /* Called from main thread */
2331 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
2332 pa_source_assert_ref(s);
2333 pa_assert_ctl_context();
2335 /* min_latency == 0: no limit
2336 * min_latency anything else: specified limit
2338 * Similar for max_latency */
2340 if (min_latency < ABSOLUTE_MIN_LATENCY)
2341 min_latency = ABSOLUTE_MIN_LATENCY;
2343 if (max_latency <= 0 ||
2344 max_latency > ABSOLUTE_MAX_LATENCY)
2345 max_latency = ABSOLUTE_MAX_LATENCY;
2347 pa_assert(min_latency <= max_latency);
2349 /* Hmm, let's see if someone forgot to set PA_SOURCE_DYNAMIC_LATENCY here... */
2350 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
2351 max_latency == ABSOLUTE_MAX_LATENCY) ||
2352 (s->flags & PA_SOURCE_DYNAMIC_LATENCY));
2354 if (PA_SOURCE_IS_LINKED(s->state)) {
2360 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_LATENCY_RANGE, r, 0, NULL) == 0);
2362 pa_source_set_latency_range_within_thread(s, min_latency, max_latency);
2365 /* Called from main thread */
2366 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency) {
2367 pa_source_assert_ref(s);
2368 pa_assert_ctl_context();
2369 pa_assert(min_latency);
2370 pa_assert(max_latency);
2372 if (PA_SOURCE_IS_LINKED(s->state)) {
2373 pa_usec_t r[2] = { 0, 0 };
2375 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0);
2377 *min_latency = r[0];
2378 *max_latency = r[1];
2380 *min_latency = s->thread_info.min_latency;
2381 *max_latency = s->thread_info.max_latency;
2385 /* Called from IO thread, and from main thread before pa_source_put() is called */
2386 void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency) {
2387 pa_source_assert_ref(s);
2388 pa_source_assert_io_context(s);
2390 pa_assert(min_latency >= ABSOLUTE_MIN_LATENCY);
2391 pa_assert(max_latency <= ABSOLUTE_MAX_LATENCY);
2392 pa_assert(min_latency <= max_latency);
2394 /* Hmm, let's see if someone forgot to set PA_SOURCE_DYNAMIC_LATENCY here... */
2395 pa_assert((min_latency == ABSOLUTE_MIN_LATENCY &&
2396 max_latency == ABSOLUTE_MAX_LATENCY) ||
2397 (s->flags & PA_SOURCE_DYNAMIC_LATENCY) ||
2400 if (s->thread_info.min_latency == min_latency &&
2401 s->thread_info.max_latency == max_latency)
2404 s->thread_info.min_latency = min_latency;
2405 s->thread_info.max_latency = max_latency;
2407 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2408 pa_source_output *o;
2411 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2412 if (o->update_source_latency_range)
2413 o->update_source_latency_range(o);
2416 pa_source_invalidate_requested_latency(s, FALSE);
2419 /* Called from main thread, before the source is put */
2420 void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency) {
2421 pa_source_assert_ref(s);
2422 pa_assert_ctl_context();
2424 if (s->flags & PA_SOURCE_DYNAMIC_LATENCY) {
2425 pa_assert(latency == 0);
2429 if (latency < ABSOLUTE_MIN_LATENCY)
2430 latency = ABSOLUTE_MIN_LATENCY;
2432 if (latency > ABSOLUTE_MAX_LATENCY)
2433 latency = ABSOLUTE_MAX_LATENCY;
2435 if (PA_SOURCE_IS_LINKED(s->state))
2436 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_FIXED_LATENCY, NULL, (int64_t) latency, NULL) == 0);
2438 s->thread_info.fixed_latency = latency;
2441 /* Called from main thread */
2442 pa_usec_t pa_source_get_fixed_latency(pa_source *s) {
2445 pa_source_assert_ref(s);
2446 pa_assert_ctl_context();
2448 if (s->flags & PA_SOURCE_DYNAMIC_LATENCY)
2451 if (PA_SOURCE_IS_LINKED(s->state))
2452 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_FIXED_LATENCY, &latency, 0, NULL) == 0);
2454 latency = s->thread_info.fixed_latency;
2459 /* Called from IO thread */
2460 void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency) {
2461 pa_source_assert_ref(s);
2462 pa_source_assert_io_context(s);
2464 if (s->flags & PA_SOURCE_DYNAMIC_LATENCY) {
2465 pa_assert(latency == 0);
2469 pa_assert(latency >= ABSOLUTE_MIN_LATENCY);
2470 pa_assert(latency <= ABSOLUTE_MAX_LATENCY);
2472 if (s->thread_info.fixed_latency == latency)
2475 s->thread_info.fixed_latency = latency;
2477 if (PA_SOURCE_IS_LINKED(s->thread_info.state)) {
2478 pa_source_output *o;
2481 PA_HASHMAP_FOREACH(o, s->thread_info.outputs, state)
2482 if (o->update_source_fixed_latency)
2483 o->update_source_fixed_latency(o);
2486 pa_source_invalidate_requested_latency(s, FALSE);
2489 /* Called from main thread */
2490 size_t pa_source_get_max_rewind(pa_source *s) {
2492 pa_assert_ctl_context();
2493 pa_source_assert_ref(s);
2495 if (!PA_SOURCE_IS_LINKED(s->state))
2496 return s->thread_info.max_rewind;
2498 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MAX_REWIND, &r, 0, NULL) == 0);
2503 /* Called from main context */
2504 int pa_source_set_port(pa_source *s, const char *name, pa_bool_t save) {
2505 pa_device_port *port;
2508 pa_source_assert_ref(s);
2509 pa_assert_ctl_context();
2512 pa_log_debug("set_port() operation not implemented for source %u \"%s\"", s->index, s->name);
2513 return -PA_ERR_NOTIMPLEMENTED;
2517 return -PA_ERR_NOENTITY;
2519 if (!(port = pa_hashmap_get(s->ports, name)))
2520 return -PA_ERR_NOENTITY;
2522 if (s->active_port == port) {
2523 s->save_port = s->save_port || save;
2527 if (s->flags & PA_SOURCE_DEFERRED_VOLUME) {
2528 struct source_message_set_port msg = { .port = port, .ret = 0 };
2529 pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_PORT, &msg, 0, NULL) == 0);
2533 ret = s->set_port(s, port);
2536 return -PA_ERR_NOENTITY;
2538 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
2540 pa_log_info("Changed port of source %u \"%s\" to %s", s->index, s->name, port->name);
2542 s->active_port = port;
2543 s->save_port = save;
2545 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PORT_CHANGED], s);
2550 PA_STATIC_FLIST_DECLARE(pa_source_volume_change, 0, pa_xfree);
2552 /* Called from the IO thread. */
2553 static pa_source_volume_change *pa_source_volume_change_new(pa_source *s) {
2554 pa_source_volume_change *c;
2555 if (!(c = pa_flist_pop(PA_STATIC_FLIST_GET(pa_source_volume_change))))
2556 c = pa_xnew(pa_source_volume_change, 1);
2558 PA_LLIST_INIT(pa_source_volume_change, c);
2560 pa_cvolume_reset(&c->hw_volume, s->sample_spec.channels);
2564 /* Called from the IO thread. */
2565 static void pa_source_volume_change_free(pa_source_volume_change *c) {
2567 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_source_volume_change), c) < 0)
2571 /* Called from the IO thread. */
2572 void pa_source_volume_change_push(pa_source *s) {
2573 pa_source_volume_change *c = NULL;
2574 pa_source_volume_change *nc = NULL;
2575 uint32_t safety_margin = s->thread_info.volume_change_safety_margin;
2577 const char *direction = NULL;
2580 nc = pa_source_volume_change_new(s);
2582 /* NOTE: There is already more different volumes in pa_source that I can remember.
2583 * Adding one more volume for HW would get us rid of this, but I am trying
2584 * to survive with the ones we already have. */
2585 pa_sw_cvolume_divide(&nc->hw_volume, &s->real_volume, &s->soft_volume);
2587 if (!s->thread_info.volume_changes && pa_cvolume_equal(&nc->hw_volume, &s->thread_info.current_hw_volume)) {
2588 pa_log_debug("Volume not changing");
2589 pa_source_volume_change_free(nc);
2593 nc->at = pa_source_get_latency_within_thread(s);
2594 nc->at += pa_rtclock_now() + s->thread_info.volume_change_extra_delay;
2596 if (s->thread_info.volume_changes_tail) {
2597 for (c = s->thread_info.volume_changes_tail; c; c = c->prev) {
2598 /* If volume is going up let's do it a bit late. If it is going
2599 * down let's do it a bit early. */
2600 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&c->hw_volume)) {
2601 if (nc->at + safety_margin > c->at) {
2602 nc->at += safety_margin;
2607 else if (nc->at - safety_margin > c->at) {
2608 nc->at -= safety_margin;
2616 if (pa_cvolume_avg(&nc->hw_volume) > pa_cvolume_avg(&s->thread_info.current_hw_volume)) {
2617 nc->at += safety_margin;
2620 nc->at -= safety_margin;
2623 PA_LLIST_PREPEND(pa_source_volume_change, s->thread_info.volume_changes, nc);
2626 PA_LLIST_INSERT_AFTER(pa_source_volume_change, s->thread_info.volume_changes, c, nc);
2629 pa_log_debug("Volume going %s to %d at %llu", direction, pa_cvolume_avg(&nc->hw_volume), (long long unsigned) nc->at);
2631 /* We can ignore volume events that came earlier but should happen later than this. */
2632 PA_LLIST_FOREACH(c, nc->next) {
2633 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at);
2634 pa_source_volume_change_free(c);
2637 s->thread_info.volume_changes_tail = nc;
2640 /* Called from the IO thread. */
2641 static void pa_source_volume_change_flush(pa_source *s) {
2642 pa_source_volume_change *c = s->thread_info.volume_changes;
2644 s->thread_info.volume_changes = NULL;
2645 s->thread_info.volume_changes_tail = NULL;
2647 pa_source_volume_change *next = c->next;
2648 pa_source_volume_change_free(c);
2653 /* Called from the IO thread. */
2654 pa_bool_t pa_source_volume_change_apply(pa_source *s, pa_usec_t *usec_to_next) {
2656 pa_bool_t ret = FALSE;
2660 if (!s->thread_info.volume_changes || !PA_SOURCE_IS_LINKED(s->state)) {
2666 pa_assert(s->write_volume);
2668 now = pa_rtclock_now();
2670 while (s->thread_info.volume_changes && now >= s->thread_info.volume_changes->at) {
2671 pa_source_volume_change *c = s->thread_info.volume_changes;
2672 PA_LLIST_REMOVE(pa_source_volume_change, s->thread_info.volume_changes, c);
2673 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
2674 pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at, (long long unsigned) (now - c->at));
2676 s->thread_info.current_hw_volume = c->hw_volume;
2677 pa_source_volume_change_free(c);
2683 if (s->thread_info.volume_changes) {
2685 *usec_to_next = s->thread_info.volume_changes->at - now;
2686 if (pa_log_ratelimit(PA_LOG_DEBUG))
2687 pa_log_debug("Next volume change in %lld usec", (long long) (s->thread_info.volume_changes->at - now));
2692 s->thread_info.volume_changes_tail = NULL;
2698 /* Called from the main thread */
2699 /* Gets the list of formats supported by the source. The members and idxset must
2700 * be freed by the caller. */
2701 pa_idxset* pa_source_get_formats(pa_source *s) {
2706 if (s->get_formats) {
2707 /* Source supports format query, all is good */
2708 ret = s->get_formats(s);
2710 /* Source doesn't support format query, so assume it does PCM */
2711 pa_format_info *f = pa_format_info_new();
2712 f->encoding = PA_ENCODING_PCM;
2714 ret = pa_idxset_new(NULL, NULL);
2715 pa_idxset_put(ret, f, NULL);
2721 /* Called from the main thread */
2722 /* Checks if the source can accept this format */
2723 pa_bool_t pa_source_check_format(pa_source *s, pa_format_info *f)
2725 pa_idxset *formats = NULL;
2726 pa_bool_t ret = FALSE;
2731 formats = pa_source_get_formats(s);
2734 pa_format_info *finfo_device;
2737 PA_IDXSET_FOREACH(finfo_device, formats, i) {
2738 if (pa_format_info_is_compatible(finfo_device, f)) {
2744 pa_idxset_free(formats, (pa_free2_cb_t) pa_format_info_free2, NULL);
2750 /* Called from the main thread */
2751 /* Calculates the intersection between formats supported by the source and
2752 * in_formats, and returns these, in the order of the source's formats. */
2753 pa_idxset* pa_source_check_formats(pa_source *s, pa_idxset *in_formats) {
2754 pa_idxset *out_formats = pa_idxset_new(NULL, NULL), *source_formats = NULL;
2755 pa_format_info *f_source, *f_in;
2760 if (!in_formats || pa_idxset_isempty(in_formats))
2763 source_formats = pa_source_get_formats(s);
2765 PA_IDXSET_FOREACH(f_source, source_formats, i) {
2766 PA_IDXSET_FOREACH(f_in, in_formats, j) {
2767 if (pa_format_info_is_compatible(f_source, f_in))
2768 pa_idxset_put(out_formats, pa_format_info_copy(f_in), NULL);
2774 pa_idxset_free(source_formats, (pa_free2_cb_t) pa_format_info_free2, NULL);