X-Git-Url: https://code.delx.au/pulseaudio/blobdiff_plain/8c0e3efbf8fcd500048b1c1b21d21a4ea8c09fd3..fb70fa22c36f9220e8f4424948d0af476fb3d7a9:/src/pulsecore/sink.c diff --git a/src/pulsecore/sink.c b/src/pulsecore/sink.c index 3cadbff6..c1cd2db4 100644 --- a/src/pulsecore/sink.c +++ b/src/pulsecore/sink.c @@ -24,22 +24,25 @@ #include #endif +#include #include #include -#include #include +#include #include #include #include #include -#include #include +#include +#include #include #include #include #include +#include #include #include #include @@ -79,6 +82,7 @@ pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data) { pa_zero(*data); data->proplist = pa_proplist_new(); + data->ports = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL, (pa_free_cb_t) pa_device_port_unref); return data; } @@ -104,6 +108,13 @@ void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_m data->channel_map = *map; } +void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data *data, const uint32_t alternate_sample_rate) { + pa_assert(data); + + data->alternate_sample_rate_is_set = true; + data->alternate_sample_rate = alternate_sample_rate; +} + void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume) { pa_assert(data); @@ -111,10 +122,10 @@ void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volum data->volume = *volume; } -void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute) { +void pa_sink_new_data_set_muted(pa_sink_new_data *data, bool mute) { pa_assert(data); - data->muted_is_set = TRUE; + data->muted_is_set = true; data->muted = !!mute; } @@ -130,41 +141,13 @@ void pa_sink_new_data_done(pa_sink_new_data *data) { pa_proplist_free(data->proplist); - if (data->ports) { - pa_device_port *p; - - while ((p = pa_hashmap_steal_first(data->ports))) - pa_device_port_free(p); - - pa_hashmap_free(data->ports, NULL, NULL); - } + if (data->ports) + pa_hashmap_free(data->ports); pa_xfree(data->name); pa_xfree(data->active_port); } -pa_device_port *pa_device_port_new(const char *name, const char *description, size_t extra) { - pa_device_port *p; - - pa_assert(name); - - p = pa_xmalloc(PA_ALIGN(sizeof(pa_device_port)) + extra); - p->name = pa_xstrdup(name); - p->description = pa_xstrdup(description); - - p->priority = 0; - - return p; -} - -void pa_device_port_free(pa_device_port *p) { - pa_assert(p); - - pa_xfree(p->name); - pa_xfree(p->description); - pa_xfree(p); -} - /* Called from main context */ static void reset_callbacks(pa_sink *s) { pa_assert(s); @@ -172,11 +155,15 @@ static void reset_callbacks(pa_sink *s) { s->set_state = NULL; s->get_volume = NULL; s->set_volume = NULL; + s->write_volume = NULL; s->get_mute = NULL; s->set_mute = NULL; s->request_rewind = NULL; s->update_requested_latency = NULL; s->set_port = NULL; + s->get_formats = NULL; + s->set_formats = NULL; + s->update_rate = NULL; } /* Called from main context */ @@ -226,22 +213,34 @@ pa_sink* pa_sink_new( pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map)); pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels); - if (!data->volume_is_set) + /* FIXME: There should probably be a general function for checking whether + * the sink volume is allowed to be set, like there is for sink inputs. */ + pa_assert(!data->volume_is_set || !(flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)); + + if (!data->volume_is_set) { pa_cvolume_reset(&data->volume, data->sample_spec.channels); + data->save_volume = false; + } pa_return_null_if_fail(pa_cvolume_valid(&data->volume)); pa_return_null_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec)); if (!data->muted_is_set) - data->muted = FALSE; + data->muted = false; if (data->card) pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->card->proplist); - pa_device_init_description(data->proplist); - pa_device_init_icon(data->proplist, TRUE); + pa_device_init_description(data->proplist, data->card); + pa_device_init_icon(data->proplist, true); pa_device_init_intended_roles(data->proplist); + if (!data->active_port) { + pa_device_port *p = pa_device_port_find_best(data->ports); + if (p) + pa_sink_new_data_set_port(data, p->name); + } + if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_FIXATE], data) < 0) { pa_xfree(s); pa_namereg_unregister(core, name); @@ -255,7 +254,8 @@ pa_sink* pa_sink_new( s->state = PA_SINK_INIT; s->flags = flags; s->priority = 0; - s->suspend_cause = 0; + s->suspend_cause = data->suspend_cause; + pa_sink_set_mixer_dirty(s, false); s->name = pa_xstrdup(name); s->proplist = pa_proplist_copy(data->proplist); s->driver = pa_xstrdup(pa_path_get_filename(data->driver)); @@ -266,16 +266,28 @@ pa_sink* pa_sink_new( s->sample_spec = data->sample_spec; s->channel_map = data->channel_map; + s->default_sample_rate = s->sample_spec.rate; + + if (data->alternate_sample_rate_is_set) + s->alternate_sample_rate = data->alternate_sample_rate; + else + s->alternate_sample_rate = s->core->alternate_sample_rate; + + if (s->sample_spec.rate == s->alternate_sample_rate) { + pa_log_warn("Default and alternate sample rates are the same."); + s->alternate_sample_rate = 0; + } s->inputs = pa_idxset_new(NULL, NULL); s->n_corked = 0; + s->input_to_master = NULL; s->reference_volume = s->real_volume = data->volume; pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels); s->base_volume = PA_VOLUME_NORM; s->n_volume_steps = PA_VOLUME_NORM+1; s->muted = data->muted; - s->refresh_volume = s->refresh_muted = FALSE; + s->refresh_volume = s->refresh_muted = false; reset_callbacks(s); s->userdata = NULL; @@ -288,20 +300,21 @@ pa_sink* pa_sink_new( data->ports = NULL; s->active_port = NULL; - s->save_port = FALSE; + s->save_port = false; - if (data->active_port && s->ports) + if (data->active_port) if ((s->active_port = pa_hashmap_get(s->ports, data->active_port))) s->save_port = data->save_port; - if (!s->active_port && s->ports) { - void *state; - pa_device_port *p; + /* Hopefully the active port has already been assigned in the previous call + to pa_device_port_find_best, but better safe than sorry */ + if (!s->active_port) + s->active_port = pa_device_port_find_best(s->ports); - PA_HASHMAP_FOREACH(p, s->ports, state) - if (!s->active_port || p->priority > s->active_port->priority) - s->active_port = p; - } + if (s->active_port) + s->latency_offset = s->active_port->latency_offset; + else + s->latency_offset = 0; s->save_volume = data->save_volume; s->save_muted = data->save_muted; @@ -314,15 +327,16 @@ pa_sink* pa_sink_new( 0); s->thread_info.rtpoll = NULL; - s->thread_info.inputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func); + s->thread_info.inputs = pa_hashmap_new_full(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func, NULL, + (pa_free_cb_t) pa_sink_input_unref); s->thread_info.soft_volume = s->soft_volume; s->thread_info.soft_muted = s->muted; s->thread_info.state = s->state; s->thread_info.rewind_nbytes = 0; - s->thread_info.rewind_requested = FALSE; + s->thread_info.rewind_requested = false; s->thread_info.max_rewind = 0; s->thread_info.max_request = 0; - s->thread_info.requested_latency_valid = FALSE; + s->thread_info.requested_latency_valid = false; s->thread_info.requested_latency = 0; s->thread_info.min_latency = ABSOLUTE_MIN_LATENCY; s->thread_info.max_latency = ABSOLUTE_MAX_LATENCY; @@ -331,8 +345,9 @@ pa_sink* pa_sink_new( PA_LLIST_HEAD_INIT(pa_sink_volume_change, s->thread_info.volume_changes); s->thread_info.volume_changes_tail = NULL; pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume); - s->thread_info.volume_change_safety_margin = core->sync_volume_safety_margin_usec; - s->thread_info.volume_change_extra_delay = core->sync_volume_extra_delay_usec; + s->thread_info.volume_change_safety_margin = core->deferred_volume_safety_margin_usec; + s->thread_info.volume_change_extra_delay = core->deferred_volume_extra_delay_usec; + s->thread_info.latency_offset = s->latency_offset; /* FIXME: This should probably be moved to pa_sink_put() */ pa_assert_se(pa_idxset_put(core->sinks, s, &s->index) >= 0); @@ -352,6 +367,7 @@ pa_sink* pa_sink_new( pa_source_new_data_init(&source_data); pa_source_new_data_set_sample_spec(&source_data, &s->sample_spec); pa_source_new_data_set_channel_map(&source_data, &s->channel_map); + pa_source_new_data_set_alternate_sample_rate(&source_data, s->alternate_sample_rate); source_data.name = pa_sprintf_malloc("%s.monitor", name); source_data.driver = data->driver; source_data.module = data->module; @@ -385,7 +401,7 @@ pa_sink* pa_sink_new( /* Called from main context */ static int sink_set_state(pa_sink *s, pa_sink_state_t state) { int ret; - pa_bool_t suspend_change; + bool suspend_change; pa_sink_state_t original_state; pa_assert(s); @@ -415,7 +431,7 @@ static int sink_set_state(pa_sink *s, pa_sink_state_t state) { s->state = state; - if (state != PA_SINK_UNLINKED) { /* if we enter UNLINKED state pa_sink_unlink() will fire the apropriate events */ + if (state != PA_SINK_UNLINKED) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */ pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], s); pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_CHANGE, s->index); } @@ -440,51 +456,207 @@ static int sink_set_state(pa_sink *s, pa_sink_state_t state) { return 0; } +void pa_sink_set_get_volume_callback(pa_sink *s, pa_sink_cb_t cb) { + pa_assert(s); + + s->get_volume = cb; +} + +void pa_sink_set_set_volume_callback(pa_sink *s, pa_sink_cb_t cb) { + pa_sink_flags_t flags; + + pa_assert(s); + pa_assert(!s->write_volume || cb); + + s->set_volume = cb; + + /* Save the current flags so we can tell if they've changed */ + flags = s->flags; + + if (cb) { + /* The sink implementor is responsible for setting decibel volume support */ + s->flags |= PA_SINK_HW_VOLUME_CTRL; + } else { + s->flags &= ~PA_SINK_HW_VOLUME_CTRL; + /* See note below in pa_sink_put() about volume sharing and decibel volumes */ + pa_sink_enable_decibel_volume(s, !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)); + } + + /* If the flags have changed after init, let any clients know via a change event */ + if (s->state != PA_SINK_INIT && flags != s->flags) + pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); +} + +void pa_sink_set_write_volume_callback(pa_sink *s, pa_sink_cb_t cb) { + pa_sink_flags_t flags; + + pa_assert(s); + pa_assert(!cb || s->set_volume); + + s->write_volume = cb; + + /* Save the current flags so we can tell if they've changed */ + flags = s->flags; + + if (cb) + s->flags |= PA_SINK_DEFERRED_VOLUME; + else + s->flags &= ~PA_SINK_DEFERRED_VOLUME; + + /* If the flags have changed after init, let any clients know via a change event */ + if (s->state != PA_SINK_INIT && flags != s->flags) + pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); +} + +void pa_sink_set_get_mute_callback(pa_sink *s, pa_sink_cb_t cb) { + pa_assert(s); + + s->get_mute = cb; +} + +void pa_sink_set_set_mute_callback(pa_sink *s, pa_sink_cb_t cb) { + pa_sink_flags_t flags; + + pa_assert(s); + + s->set_mute = cb; + + /* Save the current flags so we can tell if they've changed */ + flags = s->flags; + + if (cb) + s->flags |= PA_SINK_HW_MUTE_CTRL; + else + s->flags &= ~PA_SINK_HW_MUTE_CTRL; + + /* If the flags have changed after init, let any clients know via a change event */ + if (s->state != PA_SINK_INIT && flags != s->flags) + pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); +} + +static void enable_flat_volume(pa_sink *s, bool enable) { + pa_sink_flags_t flags; + + pa_assert(s); + + /* Always follow the overall user preference here */ + enable = enable && s->core->flat_volumes; + + /* Save the current flags so we can tell if they've changed */ + flags = s->flags; + + if (enable) + s->flags |= PA_SINK_FLAT_VOLUME; + else + s->flags &= ~PA_SINK_FLAT_VOLUME; + + /* If the flags have changed after init, let any clients know via a change event */ + if (s->state != PA_SINK_INIT && flags != s->flags) + pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); +} + +void pa_sink_enable_decibel_volume(pa_sink *s, bool enable) { + pa_sink_flags_t flags; + + pa_assert(s); + + /* Save the current flags so we can tell if they've changed */ + flags = s->flags; + + if (enable) { + s->flags |= PA_SINK_DECIBEL_VOLUME; + enable_flat_volume(s, true); + } else { + s->flags &= ~PA_SINK_DECIBEL_VOLUME; + enable_flat_volume(s, false); + } + + /* If the flags have changed after init, let any clients know via a change event */ + if (s->state != PA_SINK_INIT && flags != s->flags) + pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); +} + /* Called from main context */ void pa_sink_put(pa_sink* s) { pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(s->state == PA_SINK_INIT); + pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || s->input_to_master); /* The following fields must be initialized properly when calling _put() */ pa_assert(s->asyncmsgq); pa_assert(s->thread_info.min_latency <= s->thread_info.max_latency); /* Generally, flags should be initialized via pa_sink_new(). As a - * special exception we allow volume related flags to be set - * between _new() and _put(). */ + * special exception we allow some volume related flags to be set + * between _new() and _put() by the callback setter functions above. + * + * Thus we implement a couple safeguards here which ensure the above + * setters were used (or at least the implementor made manual changes + * in a compatible way). + * + * Note: All of these flags set here can change over the life time + * of the sink. */ + pa_assert(!(s->flags & PA_SINK_HW_VOLUME_CTRL) || s->set_volume); + pa_assert(!(s->flags & PA_SINK_DEFERRED_VOLUME) || s->write_volume); + pa_assert(!(s->flags & PA_SINK_HW_MUTE_CTRL) || s->set_mute); - if (!(s->flags & PA_SINK_HW_VOLUME_CTRL)) - s->flags |= PA_SINK_DECIBEL_VOLUME; + /* XXX: Currently decibel volume is disabled for all sinks that use volume + * sharing. When the master sink supports decibel volume, it would be good + * to have the flag also in the filter sink, but currently we don't do that + * so that the flags of the filter sink never change when it's moved from + * a master sink to another. One solution for this problem would be to + * remove user-visible volume altogether from filter sinks when volume + * sharing is used, but the current approach was easier to implement... */ + /* We always support decibel volumes in software, otherwise we leave it to + * the sink implementor to set this flag as needed. + * + * Note: This flag can also change over the life time of the sink. */ + if (!(s->flags & PA_SINK_HW_VOLUME_CTRL) && !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) + pa_sink_enable_decibel_volume(s, true); - if ((s->flags & PA_SINK_DECIBEL_VOLUME) && s->core->flat_volumes) - s->flags |= PA_SINK_FLAT_VOLUME; + /* If the sink implementor support DB volumes by itself, we should always + * try and enable flat volumes too */ + if ((s->flags & PA_SINK_DECIBEL_VOLUME)) + enable_flat_volume(s, true); + + if (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) { + pa_sink *root_sink = pa_sink_get_master(s); - /* We assume that if the sink implementor changed the default - * volume he did so in real_volume, because that is the usual - * place where he is supposed to place his changes. */ - s->reference_volume = s->real_volume; + pa_assert(root_sink); + + s->reference_volume = root_sink->reference_volume; + pa_cvolume_remap(&s->reference_volume, &root_sink->channel_map, &s->channel_map); + + s->real_volume = root_sink->real_volume; + pa_cvolume_remap(&s->real_volume, &root_sink->channel_map, &s->channel_map); + } else + /* We assume that if the sink implementor changed the default + * volume he did so in real_volume, because that is the usual + * place where he is supposed to place his changes. */ + s->reference_volume = s->real_volume; s->thread_info.soft_volume = s->soft_volume; s->thread_info.soft_muted = s->muted; pa_sw_cvolume_multiply(&s->thread_info.current_hw_volume, &s->soft_volume, &s->real_volume); - pa_assert((s->flags & PA_SINK_HW_VOLUME_CTRL) || (s->base_volume == PA_VOLUME_NORM && s->flags & PA_SINK_DECIBEL_VOLUME)); + pa_assert((s->flags & PA_SINK_HW_VOLUME_CTRL) + || (s->base_volume == PA_VOLUME_NORM + && ((s->flags & PA_SINK_DECIBEL_VOLUME || (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))))); pa_assert(!(s->flags & PA_SINK_DECIBEL_VOLUME) || s->n_volume_steps == PA_VOLUME_NORM+1); pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == (s->thread_info.fixed_latency != 0)); pa_assert(!(s->flags & PA_SINK_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_LATENCY)); pa_assert(!(s->flags & PA_SINK_DYNAMIC_LATENCY) == !(s->monitor_source->flags & PA_SOURCE_DYNAMIC_LATENCY)); - pa_assert(!(s->flags & PA_SINK_HW_VOLUME_CTRL) || s->set_volume); - pa_assert(!(s->flags & PA_SINK_SYNC_VOLUME) || (s->flags & PA_SINK_HW_VOLUME_CTRL)); - pa_assert(!(s->flags & PA_SINK_SYNC_VOLUME) || s->write_volume); - pa_assert(!(s->flags & PA_SINK_HW_MUTE_CTRL) || s->set_mute); pa_assert(s->monitor_source->thread_info.fixed_latency == s->thread_info.fixed_latency); pa_assert(s->monitor_source->thread_info.min_latency == s->thread_info.min_latency); pa_assert(s->monitor_source->thread_info.max_latency == s->thread_info.max_latency); - pa_assert_se(sink_set_state(s, PA_SINK_IDLE) == 0); + if (s->suspend_cause) + pa_assert_se(sink_set_state(s, PA_SINK_SUSPENDED) == 0); + else + pa_assert_se(sink_set_state(s, PA_SINK_IDLE) == 0); pa_source_put(s->monitor_source); @@ -494,7 +666,7 @@ void pa_sink_put(pa_sink* s) { /* Called from main context */ void pa_sink_unlink(pa_sink* s) { - pa_bool_t linked; + bool linked; pa_sink_input *i, *j = NULL; pa_assert(s); @@ -545,7 +717,6 @@ void pa_sink_unlink(pa_sink* s) { /* Called from main context */ static void sink_free(pa_object *o) { pa_sink *s = PA_SINK(o); - pa_sink_input *i; pa_assert(s); pa_assert_ctl_context(); @@ -561,12 +732,8 @@ static void sink_free(pa_object *o) { s->monitor_source = NULL; } - pa_idxset_free(s->inputs, NULL, NULL); - - while ((i = pa_hashmap_steal_first(s->thread_info.inputs))) - pa_sink_input_unref(i); - - pa_hashmap_free(s->thread_info.inputs, NULL, NULL); + pa_idxset_free(s->inputs, NULL); + pa_hashmap_free(s->thread_info.inputs); if (s->silence.memblock) pa_memblock_unref(s->silence.memblock); @@ -577,14 +744,8 @@ static void sink_free(pa_object *o) { if (s->proplist) pa_proplist_free(s->proplist); - if (s->ports) { - pa_device_port *p; - - while ((p = pa_hashmap_steal_first(s->ports))) - pa_device_port_free(p); - - pa_hashmap_free(s->ports, NULL, NULL); - } + if (s->ports) + pa_hashmap_free(s->ports); pa_xfree(s); } @@ -602,22 +763,43 @@ void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q) { /* Called from main context, and not while the IO thread is active, please */ void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value) { + pa_sink_flags_t old_flags; + pa_sink_input *input; + uint32_t idx; + pa_sink_assert_ref(s); pa_assert_ctl_context(); - if (mask == 0) - return; - /* For now, allow only a minimal set of flags to be changed. */ pa_assert((mask & ~(PA_SINK_DYNAMIC_LATENCY|PA_SINK_LATENCY)) == 0); + old_flags = s->flags; s->flags = (s->flags & ~mask) | (value & mask); - pa_source_update_flags(s->monitor_source, - ((mask & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) | - ((mask & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0), - ((value & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) | - ((value & PA_SINK_DYNAMIC_LATENCY) ? PA_SINK_DYNAMIC_LATENCY : 0)); + if (s->flags == old_flags) + return; + + if ((s->flags & PA_SINK_LATENCY) != (old_flags & PA_SINK_LATENCY)) + pa_log_debug("Sink %s: LATENCY flag %s.", s->name, (s->flags & PA_SINK_LATENCY) ? "enabled" : "disabled"); + + if ((s->flags & PA_SINK_DYNAMIC_LATENCY) != (old_flags & PA_SINK_DYNAMIC_LATENCY)) + pa_log_debug("Sink %s: DYNAMIC_LATENCY flag %s.", + s->name, (s->flags & PA_SINK_DYNAMIC_LATENCY) ? "enabled" : "disabled"); + + pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_CHANGE, s->index); + pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_FLAGS_CHANGED], s); + + if (s->monitor_source) + pa_source_update_flags(s->monitor_source, + ((mask & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) | + ((mask & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0), + ((value & PA_SINK_LATENCY) ? PA_SOURCE_LATENCY : 0) | + ((value & PA_SINK_DYNAMIC_LATENCY) ? PA_SOURCE_DYNAMIC_LATENCY : 0)); + + PA_IDXSET_FOREACH(input, s->inputs, idx) { + if (input->origin_sink) + pa_sink_update_flags(input->origin_sink, mask, value); + } } /* Called from IO context, or before _put() from main context */ @@ -643,8 +825,13 @@ int pa_sink_update_status(pa_sink*s) { return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE); } +/* Called from any context - must be threadsafe */ +void pa_sink_set_mixer_dirty(pa_sink *s, bool is_dirty) { + pa_atomic_store(&s->mixer_dirty, is_dirty ? 1 : 0); +} + /* Called from main context */ -int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause) { +int pa_sink_suspend(pa_sink *s, bool suspend, pa_suspend_cause_t cause) { pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); @@ -658,6 +845,27 @@ int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause) { s->monitor_source->suspend_cause &= ~cause; } + if (!(s->suspend_cause & PA_SUSPEND_SESSION) && (pa_atomic_load(&s->mixer_dirty) != 0)) { + /* This might look racy but isn't: If somebody sets mixer_dirty exactly here, + it'll be handled just fine. */ + pa_sink_set_mixer_dirty(s, false); + pa_log_debug("Mixer is now accessible. Updating alsa mixer settings."); + if (s->active_port && s->set_port) { + if (s->flags & PA_SINK_DEFERRED_VOLUME) { + struct sink_message_set_port msg = { .port = s->active_port, .ret = 0 }; + pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT, &msg, 0, NULL) == 0); + } + else + s->set_port(s, s->active_port); + } + else { + if (s->set_mute) + s->set_mute(s); + if (s->set_volume) + s->set_volume(s); + } + } + if ((pa_sink_get_state(s) == PA_SINK_SUSPENDED) == !!s->suspend_cause) return 0; @@ -696,7 +904,7 @@ pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q) { } /* Called from main context */ -void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save) { +void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, bool save) { pa_sink_input *i; pa_sink_assert_ref(s); @@ -711,7 +919,7 @@ void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save) { pa_sink_input_unref(i); } - pa_queue_free(q, NULL, NULL); + pa_queue_free(q, NULL); } /* Called from main context */ @@ -726,7 +934,33 @@ void pa_sink_move_all_fail(pa_queue *q) { pa_sink_input_unref(i); } - pa_queue_free(q, NULL, NULL); + pa_queue_free(q, NULL); +} + + /* Called from IO thread context */ +size_t pa_sink_process_input_underruns(pa_sink *s, size_t left_to_play) { + pa_sink_input *i; + void *state = NULL; + size_t result = 0; + + pa_sink_assert_ref(s); + pa_sink_assert_io_context(s); + + PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) { + size_t uf = i->thread_info.underrun_for_sink; + if (uf == 0) + continue; + if (uf >= left_to_play) { + if (pa_sink_input_process_underrun(i)) + continue; + } + else if (uf > result) + result = uf; + } + + if (result > 0) + pa_log_debug("Found underrun %ld bytes ago (%ld bytes ahead in playback buffer)", (long) result, (long) left_to_play - result); + return left_to_play - result; } /* Called from IO thread context */ @@ -746,14 +980,11 @@ void pa_sink_process_rewind(pa_sink *s, size_t nbytes) { return; s->thread_info.rewind_nbytes = 0; - s->thread_info.rewind_requested = FALSE; - - if (s->thread_info.state == PA_SINK_SUSPENDED) - return; + s->thread_info.rewind_requested = false; if (nbytes > 0) { pa_log_debug("Processing rewind..."); - if (s->flags & PA_SINK_SYNC_VOLUME) + if (s->flags & PA_SINK_DEFERRED_VOLUME) pa_sink_volume_change_rewind(s, nbytes); } @@ -878,9 +1109,10 @@ static void inputs_drop(pa_sink *s, pa_mix_info *info, unsigned n, pa_memchunk * } if (m) { - if (m->chunk.memblock) + if (m->chunk.memblock) { pa_memblock_unref(m->chunk.memblock); pa_memchunk_reset(&m->chunk); + } pa_sink_input_unref(m->userdata); m->userdata = NULL; @@ -1147,6 +1379,92 @@ void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result) { pa_sink_unref(s); } +/* Called from main thread */ +int pa_sink_update_rate(pa_sink *s, uint32_t rate, bool passthrough) { + int ret = -1; + uint32_t desired_rate = rate; + uint32_t default_rate = s->default_sample_rate; + uint32_t alternate_rate = s->alternate_sample_rate; + uint32_t idx; + pa_sink_input *i; + bool use_alternate = false; + + if (rate == s->sample_spec.rate) + return 0; + + if (!s->update_rate) + return -1; + + if (PA_UNLIKELY(default_rate == alternate_rate && !passthrough)) { + pa_log_debug("Default and alternate sample rates are the same."); + return -1; + } + + if (PA_SINK_IS_RUNNING(s->state)) { + pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz", + s->sample_spec.rate); + return -1; + } + + if (s->monitor_source) { + if (PA_SOURCE_IS_RUNNING(s->monitor_source->state) == true) { + pa_log_info("Cannot update rate, monitor source is RUNNING"); + return -1; + } + } + + if (PA_UNLIKELY(!pa_sample_rate_valid(desired_rate))) + return -1; + + if (!passthrough) { + pa_assert((default_rate % 4000 == 0) || (default_rate % 11025 == 0)); + pa_assert((alternate_rate % 4000 == 0) || (alternate_rate % 11025 == 0)); + + if (default_rate % 11025 == 0) { + if ((alternate_rate % 4000 == 0) && (desired_rate % 4000 == 0)) + use_alternate=true; + } else { + /* default is 4000 multiple */ + if ((alternate_rate % 11025 == 0) && (desired_rate % 11025 == 0)) + use_alternate=true; + } + + if (use_alternate) + desired_rate = alternate_rate; + else + desired_rate = default_rate; + } else { + desired_rate = rate; /* use stream sampling rate, discard default/alternate settings */ + } + + if (desired_rate == s->sample_spec.rate) + return -1; + + if (!passthrough && pa_sink_used_by(s) > 0) + return -1; + + pa_log_debug("Suspending sink %s due to changing the sample rate.", s->name); + pa_sink_suspend(s, true, PA_SUSPEND_INTERNAL); + + if (s->update_rate(s, desired_rate) >= 0) { + /* update monitor source as well */ + if (s->monitor_source && !passthrough) + pa_source_update_rate(s->monitor_source, desired_rate, false); + pa_log_info("Changed sampling rate successfully"); + + PA_IDXSET_FOREACH(i, s->inputs, idx) { + if (i->state == PA_SINK_INPUT_CORKED) + pa_sink_input_update_rate(i); + } + + ret = 0; + } + + pa_sink_suspend(s, false, PA_SUSPEND_INTERNAL); + + return ret; +} + /* Called from main thread */ pa_usec_t pa_sink_get_latency(pa_sink *s) { pa_usec_t usec = 0; @@ -1165,6 +1483,13 @@ pa_usec_t pa_sink_get_latency(pa_sink *s) { pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) == 0); + /* usec is unsigned, so check that the offset can be added to usec without + * underflowing. */ + if (-s->latency_offset <= (int64_t) usec) + usec += s->latency_offset; + else + usec = 0; + return usec; } @@ -1192,10 +1517,224 @@ pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s) { if (o->process_msg(o, PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0) return -1; + /* usec is unsigned, so check that the offset can be added to usec without + * underflowing. */ + if (-s->thread_info.latency_offset <= (int64_t) usec) + usec += s->thread_info.latency_offset; + else + usec = 0; + return usec; } -static pa_cvolume* cvolume_remap_minimal_impact( +/* Called from the main thread (and also from the IO thread while the main + * thread is waiting). + * + * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag + * set. Instead, flat volume mode is detected by checking whether the root sink + * has the flag set. */ +bool pa_sink_flat_volume_enabled(pa_sink *s) { + pa_sink_assert_ref(s); + + s = pa_sink_get_master(s); + + if (PA_LIKELY(s)) + return (s->flags & PA_SINK_FLAT_VOLUME); + else + return false; +} + +/* Called from the main thread (and also from the IO thread while the main + * thread is waiting). */ +pa_sink *pa_sink_get_master(pa_sink *s) { + pa_sink_assert_ref(s); + + while (s && (s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) { + if (PA_UNLIKELY(!s->input_to_master)) + return NULL; + + s = s->input_to_master->sink; + } + + return s; +} + +/* Called from main context */ +bool pa_sink_is_passthrough(pa_sink *s) { + pa_sink_input *alt_i; + uint32_t idx; + + pa_sink_assert_ref(s); + + /* one and only one PASSTHROUGH input can possibly be connected */ + if (pa_idxset_size(s->inputs) == 1) { + alt_i = pa_idxset_first(s->inputs, &idx); + + if (pa_sink_input_is_passthrough(alt_i)) + return true; + } + + return false; +} + +/* Called from main context */ +void pa_sink_enter_passthrough(pa_sink *s) { + pa_cvolume volume; + + /* disable the monitor in passthrough mode */ + if (s->monitor_source) { + pa_log_debug("Suspending monitor source %s, because the sink is entering the passthrough mode.", s->monitor_source->name); + pa_source_suspend(s->monitor_source, true, PA_SUSPEND_PASSTHROUGH); + } + + /* set the volume to NORM */ + s->saved_volume = *pa_sink_get_volume(s, true); + s->saved_save_volume = s->save_volume; + + pa_cvolume_set(&volume, s->sample_spec.channels, PA_MIN(s->base_volume, PA_VOLUME_NORM)); + pa_sink_set_volume(s, &volume, true, false); +} + +/* Called from main context */ +void pa_sink_leave_passthrough(pa_sink *s) { + /* Unsuspend monitor */ + if (s->monitor_source) { + pa_log_debug("Resuming monitor source %s, because the sink is leaving the passthrough mode.", s->monitor_source->name); + pa_source_suspend(s->monitor_source, false, PA_SUSPEND_PASSTHROUGH); + } + + /* Restore sink volume to what it was before we entered passthrough mode */ + pa_sink_set_volume(s, &s->saved_volume, true, s->saved_save_volume); + + pa_cvolume_init(&s->saved_volume); + s->saved_save_volume = false; +} + +/* Called from main context. */ +static void compute_reference_ratio(pa_sink_input *i) { + unsigned c = 0; + pa_cvolume remapped; + + pa_assert(i); + pa_assert(pa_sink_flat_volume_enabled(i->sink)); + + /* + * Calculates the reference ratio from the sink's reference + * volume. This basically calculates: + * + * i->reference_ratio = i->volume / i->sink->reference_volume + */ + + remapped = i->sink->reference_volume; + pa_cvolume_remap(&remapped, &i->sink->channel_map, &i->channel_map); + + i->reference_ratio.channels = i->sample_spec.channels; + + for (c = 0; c < i->sample_spec.channels; c++) { + + /* We don't update when the sink volume is 0 anyway */ + if (remapped.values[c] <= PA_VOLUME_MUTED) + continue; + + /* Don't update the reference ratio unless necessary */ + if (pa_sw_volume_multiply( + i->reference_ratio.values[c], + remapped.values[c]) == i->volume.values[c]) + continue; + + i->reference_ratio.values[c] = pa_sw_volume_divide( + i->volume.values[c], + remapped.values[c]); + } +} + +/* Called from main context. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. */ +static void compute_reference_ratios(pa_sink *s) { + uint32_t idx; + pa_sink_input *i; + + pa_sink_assert_ref(s); + pa_assert_ctl_context(); + pa_assert(PA_SINK_IS_LINKED(s->state)); + pa_assert(pa_sink_flat_volume_enabled(s)); + + PA_IDXSET_FOREACH(i, s->inputs, idx) { + compute_reference_ratio(i); + + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) + compute_reference_ratios(i->origin_sink); + } +} + +/* Called from main context. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. */ +static void compute_real_ratios(pa_sink *s) { + pa_sink_input *i; + uint32_t idx; + + pa_sink_assert_ref(s); + pa_assert_ctl_context(); + pa_assert(PA_SINK_IS_LINKED(s->state)); + pa_assert(pa_sink_flat_volume_enabled(s)); + + PA_IDXSET_FOREACH(i, s->inputs, idx) { + unsigned c; + pa_cvolume remapped; + + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) { + /* The origin sink uses volume sharing, so this input's real ratio + * is handled as a special case - the real ratio must be 0 dB, and + * as a result i->soft_volume must equal i->volume_factor. */ + pa_cvolume_reset(&i->real_ratio, i->real_ratio.channels); + i->soft_volume = i->volume_factor; + + compute_real_ratios(i->origin_sink); + + continue; + } + + /* + * This basically calculates: + * + * i->real_ratio := i->volume / s->real_volume + * i->soft_volume := i->real_ratio * i->volume_factor + */ + + remapped = s->real_volume; + pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map); + + i->real_ratio.channels = i->sample_spec.channels; + i->soft_volume.channels = i->sample_spec.channels; + + for (c = 0; c < i->sample_spec.channels; c++) { + + if (remapped.values[c] <= PA_VOLUME_MUTED) { + /* We leave i->real_ratio untouched */ + i->soft_volume.values[c] = PA_VOLUME_MUTED; + continue; + } + + /* Don't lose accuracy unless necessary */ + if (pa_sw_volume_multiply( + i->real_ratio.values[c], + remapped.values[c]) != i->volume.values[c]) + + i->real_ratio.values[c] = pa_sw_volume_divide( + i->volume.values[c], + remapped.values[c]); + + i->soft_volume.values[c] = pa_sw_volume_multiply( + i->real_ratio.values[c], + i->volume_factor.values[c]); + } + + /* We don't copy the soft_volume to the thread_info data + * here. That must be done by the caller */ + } +} + +static pa_cvolume *cvolume_remap_minimal_impact( pa_cvolume *v, const pa_cvolume *template, const pa_channel_map *from, @@ -1207,9 +1746,8 @@ static pa_cvolume* cvolume_remap_minimal_impact( pa_assert(template); pa_assert(from); pa_assert(to); - - pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v, from), NULL); - pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(template, to), NULL); + pa_assert(pa_cvolume_compatible_with_channel_map(v, from)); + pa_assert(pa_cvolume_compatible_with_channel_map(template, to)); /* Much like pa_cvolume_remap(), but tries to minimize impact when * mapping from sink input to sink volumes: @@ -1235,122 +1773,105 @@ static pa_cvolume* cvolume_remap_minimal_impact( return v; } -/* Called from main context */ -static void compute_reference_ratios(pa_sink *s) { - uint32_t idx; +/* Called from main thread. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. */ +static void get_maximum_input_volume(pa_sink *s, pa_cvolume *max_volume, const pa_channel_map *channel_map) { pa_sink_input *i; + uint32_t idx; pa_sink_assert_ref(s); - pa_assert_ctl_context(); - pa_assert(PA_SINK_IS_LINKED(s->state)); - pa_assert(s->flags & PA_SINK_FLAT_VOLUME); + pa_assert(max_volume); + pa_assert(channel_map); + pa_assert(pa_sink_flat_volume_enabled(s)); PA_IDXSET_FOREACH(i, s->inputs, idx) { - unsigned c; pa_cvolume remapped; - /* - * Calculates the reference volume from the sink's reference - * volume. This basically calculates: - * - * i->reference_ratio = i->volume / s->reference_volume - */ - - remapped = s->reference_volume; - pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map); - - i->reference_ratio.channels = i->sample_spec.channels; + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) { + get_maximum_input_volume(i->origin_sink, max_volume, channel_map); - for (c = 0; c < i->sample_spec.channels; c++) { - - /* We don't update when the sink volume is 0 anyway */ - if (remapped.values[c] <= PA_VOLUME_MUTED) - continue; - - /* Don't update the reference ratio unless necessary */ - if (pa_sw_volume_multiply( - i->reference_ratio.values[c], - remapped.values[c]) == i->volume.values[c]) - continue; - - i->reference_ratio.values[c] = pa_sw_volume_divide( - i->volume.values[c], - remapped.values[c]); + /* Ignore this input. The origin sink uses volume sharing, so this + * input's volume will be set to be equal to the root sink's real + * volume. Obviously this input's current volume must not then + * affect what the root sink's real volume will be. */ + continue; } + + remapped = i->volume; + cvolume_remap_minimal_impact(&remapped, max_volume, &i->channel_map, channel_map); + pa_cvolume_merge(max_volume, max_volume, &remapped); } } -/* Called from main context */ -static void compute_real_ratios(pa_sink *s) { +/* Called from main thread. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. */ +static bool has_inputs(pa_sink *s) { pa_sink_input *i; uint32_t idx; pa_sink_assert_ref(s); - pa_assert_ctl_context(); - pa_assert(PA_SINK_IS_LINKED(s->state)); - pa_assert(s->flags & PA_SINK_FLAT_VOLUME); PA_IDXSET_FOREACH(i, s->inputs, idx) { - unsigned c; - pa_cvolume remapped; + if (!i->origin_sink || !(i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER) || has_inputs(i->origin_sink)) + return true; + } - /* - * This basically calculates: - * - * i->real_ratio := i->volume / s->real_volume - * i->soft_volume := i->real_ratio * i->volume_factor - */ + return false; +} - remapped = s->real_volume; - pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map); +/* Called from main thread. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. */ +static void update_real_volume(pa_sink *s, const pa_cvolume *new_volume, pa_channel_map *channel_map) { + pa_sink_input *i; + uint32_t idx; - i->real_ratio.channels = i->sample_spec.channels; - i->soft_volume.channels = i->sample_spec.channels; + pa_sink_assert_ref(s); + pa_assert(new_volume); + pa_assert(channel_map); - for (c = 0; c < i->sample_spec.channels; c++) { + s->real_volume = *new_volume; + pa_cvolume_remap(&s->real_volume, channel_map, &s->channel_map); - if (remapped.values[c] <= PA_VOLUME_MUTED) { - /* We leave i->real_ratio untouched */ - i->soft_volume.values[c] = PA_VOLUME_MUTED; - continue; - } + PA_IDXSET_FOREACH(i, s->inputs, idx) { + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) { + if (pa_sink_flat_volume_enabled(s)) { + pa_cvolume old_volume = i->volume; - /* Don't lose accuracy unless necessary */ - if (pa_sw_volume_multiply( - i->real_ratio.values[c], - remapped.values[c]) != i->volume.values[c]) + /* Follow the root sink's real volume. */ + i->volume = *new_volume; + pa_cvolume_remap(&i->volume, channel_map, &i->channel_map); + compute_reference_ratio(i); - i->real_ratio.values[c] = pa_sw_volume_divide( - i->volume.values[c], - remapped.values[c]); + /* The volume changed, let's tell people so */ + if (!pa_cvolume_equal(&old_volume, &i->volume)) { + if (i->volume_changed) + i->volume_changed(i); - i->soft_volume.values[c] = pa_sw_volume_multiply( - i->real_ratio.values[c], - i->volume_factor.values[c]); - } + pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index); + } + } - /* We don't copy the soft_volume to the thread_info data - * here. That must be done by the caller */ + update_real_volume(i->origin_sink, new_volume, channel_map); + } } } -/* Called from main thread */ +/* Called from main thread. Only called for the root sink in shared volume + * cases. */ static void compute_real_volume(pa_sink *s) { - pa_sink_input *i; - uint32_t idx; - pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); - pa_assert(s->flags & PA_SINK_FLAT_VOLUME); + pa_assert(pa_sink_flat_volume_enabled(s)); + pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)); /* This determines the maximum volume of all streams and sets * s->real_volume accordingly. */ - if (pa_idxset_isempty(s->inputs)) { - /* In the special case that we have no sink input we leave the + if (!has_inputs(s)) { + /* In the special case that we have no sink inputs we leave the * volume unmodified. */ - s->real_volume = s->reference_volume; + update_real_volume(s, &s->reference_volume, &s->channel_map); return; } @@ -1358,20 +1879,16 @@ static void compute_real_volume(pa_sink *s) { /* First let's determine the new maximum volume of all inputs * connected to this sink */ - PA_IDXSET_FOREACH(i, s->inputs, idx) { - pa_cvolume remapped; - - remapped = i->volume; - cvolume_remap_minimal_impact(&remapped, &s->real_volume, &i->channel_map, &s->channel_map); - pa_cvolume_merge(&s->real_volume, &s->real_volume, &remapped); - } + get_maximum_input_volume(s, &s->real_volume, &s->channel_map); + update_real_volume(s, &s->real_volume, &s->channel_map); /* Then, let's update the real ratios/soft volumes of all inputs * connected to this sink */ compute_real_ratios(s); } -/* Called from main thread */ +/* Called from main thread. Only called for the root sink in shared volume + * cases, except for internal recursive calls. */ static void propagate_reference_volume(pa_sink *s) { pa_sink_input *i; uint32_t idx; @@ -1379,14 +1896,23 @@ static void propagate_reference_volume(pa_sink *s) { pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); - pa_assert(s->flags & PA_SINK_FLAT_VOLUME); + pa_assert(pa_sink_flat_volume_enabled(s)); /* This is called whenever the sink volume changes that is not * caused by a sink input volume change. We need to fix up the * sink input volumes accordingly */ PA_IDXSET_FOREACH(i, s->inputs, idx) { - pa_cvolume old_volume, remapped; + pa_cvolume old_volume; + + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) { + propagate_reference_volume(i->origin_sink); + + /* Since the origin sink uses volume sharing, this input's volume + * needs to be updated to match the root sink's real volume, but + * that will be done later in update_shared_real_volume(). */ + continue; + } old_volume = i->volume; @@ -1394,9 +1920,9 @@ static void propagate_reference_volume(pa_sink *s) { * * i->volume := s->reference_volume * i->reference_ratio */ - remapped = s->reference_volume; - pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map); - pa_sw_cvolume_multiply(&i->volume, &remapped, &i->reference_ratio); + i->volume = s->reference_volume; + pa_cvolume_remap(&i->volume, &s->channel_map, &i->channel_map); + pa_sw_cvolume_multiply(&i->volume, &i->volume, &i->reference_ratio); /* The volume changed, let's tell people so */ if (!pa_cvolume_equal(&old_volume, &i->volume)) { @@ -1409,112 +1935,155 @@ static void propagate_reference_volume(pa_sink *s) { } } +/* Called from main thread. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. The return value indicates + * whether any reference volume actually changed. */ +static bool update_reference_volume(pa_sink *s, const pa_cvolume *v, const pa_channel_map *channel_map, bool save) { + pa_cvolume volume; + bool reference_volume_changed; + pa_sink_input *i; + uint32_t idx; + + pa_sink_assert_ref(s); + pa_assert(PA_SINK_IS_LINKED(s->state)); + pa_assert(v); + pa_assert(channel_map); + pa_assert(pa_cvolume_valid(v)); + + volume = *v; + pa_cvolume_remap(&volume, channel_map, &s->channel_map); + + reference_volume_changed = !pa_cvolume_equal(&volume, &s->reference_volume); + pa_sink_set_reference_volume_direct(s, &volume); + + s->save_volume = (!reference_volume_changed && s->save_volume) || save; + + if (!reference_volume_changed && !(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) + /* If the root sink's volume doesn't change, then there can't be any + * changes in the other sinks in the sink tree either. + * + * It's probably theoretically possible that even if the root sink's + * volume changes slightly, some filter sink doesn't change its volume + * due to rounding errors. If that happens, we still want to propagate + * the changed root sink volume to the sinks connected to the + * intermediate sink that didn't change its volume. This theoretical + * possibility is the reason why we have that !(s->flags & + * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would + * notice even if we returned here false always if + * reference_volume_changed is false. */ + return false; + + PA_IDXSET_FOREACH(i, s->inputs, idx) { + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) + update_reference_volume(i->origin_sink, v, channel_map, false); + } + + return true; +} + /* Called from main thread */ void pa_sink_set_volume( pa_sink *s, const pa_cvolume *volume, - pa_bool_t send_msg, - pa_bool_t save) { + bool send_msg, + bool save) { - pa_cvolume old_reference_volume; - pa_bool_t reference_changed; + pa_cvolume new_reference_volume; + pa_sink *root_sink; pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); pa_assert(!volume || pa_cvolume_valid(volume)); - pa_assert(volume || (s->flags & PA_SINK_FLAT_VOLUME)); + pa_assert(volume || pa_sink_flat_volume_enabled(s)); pa_assert(!volume || volume->channels == 1 || pa_cvolume_compatible(volume, &s->sample_spec)); - /* make sure we don't change the volume when a PASSTHROUGH input is connected */ - if (s->flags & PA_SINK_PASSTHROUGH) { - pa_sink_input *alt_i; - uint32_t idx; - - /* one and only one PASSTHROUGH input can possibly be connected */ - if (pa_idxset_size(s->inputs) == 1) { + /* make sure we don't change the volume when a PASSTHROUGH input is connected ... + * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */ + if (pa_sink_is_passthrough(s) && (!volume || !pa_cvolume_is_norm(volume))) { + pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input"); + return; + } - alt_i = pa_idxset_first(s->inputs, &idx); + /* In case of volume sharing, the volume is set for the root sink first, + * from which it's then propagated to the sharing sinks. */ + root_sink = pa_sink_get_master(s); - if (alt_i->flags & PA_SINK_INPUT_PASSTHROUGH) { - /* FIXME: Need to notify client that volume control is disabled */ - pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input"); - return; - } - } - } + if (PA_UNLIKELY(!root_sink)) + return; /* As a special exception we accept mono volumes on all sinks -- * even on those with more complex channel maps */ - /* If volume is NULL we synchronize the sink's real and reference - * volumes with the stream volumes. If it is not NULL we update - * the reference_volume with it. */ - - old_reference_volume = s->reference_volume; - if (volume) { - if (pa_cvolume_compatible(volume, &s->sample_spec)) - s->reference_volume = *volume; - else - pa_cvolume_scale(&s->reference_volume, pa_cvolume_max(volume)); + new_reference_volume = *volume; + else { + new_reference_volume = s->reference_volume; + pa_cvolume_scale(&new_reference_volume, pa_cvolume_max(volume)); + } - if (s->flags & PA_SINK_FLAT_VOLUME) { - /* OK, propagate this volume change back to the inputs */ - propagate_reference_volume(s); + pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map); - /* And now recalculate the real volume */ - compute_real_volume(s); - } else - s->real_volume = s->reference_volume; + if (update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save)) { + if (pa_sink_flat_volume_enabled(root_sink)) { + /* OK, propagate this volume change back to the inputs */ + propagate_reference_volume(root_sink); + + /* And now recalculate the real volume */ + compute_real_volume(root_sink); + } else + update_real_volume(root_sink, &root_sink->reference_volume, &root_sink->channel_map); + } } else { - pa_assert(s->flags & PA_SINK_FLAT_VOLUME); + /* If volume is NULL we synchronize the sink's real and + * reference volumes with the stream volumes. */ + + pa_assert(pa_sink_flat_volume_enabled(root_sink)); /* Ok, let's determine the new real volume */ - compute_real_volume(s); + compute_real_volume(root_sink); /* Let's 'push' the reference volume if necessary */ - pa_cvolume_merge(&s->reference_volume, &s->reference_volume, &s->real_volume); + pa_cvolume_merge(&new_reference_volume, &s->reference_volume, &root_sink->real_volume); + /* If the sink and its root don't have the same number of channels, we need to remap */ + if (s != root_sink && !pa_channel_map_equal(&s->channel_map, &root_sink->channel_map)) + pa_cvolume_remap(&new_reference_volume, &s->channel_map, &root_sink->channel_map); + update_reference_volume(root_sink, &new_reference_volume, &root_sink->channel_map, save); - /* We need to fix the reference ratios of all streams now that - * we changed the reference volume */ - compute_reference_ratios(s); + /* Now that the reference volume is updated, we can update the streams' + * reference ratios. */ + compute_reference_ratios(root_sink); } - reference_changed = !pa_cvolume_equal(&old_reference_volume, &s->reference_volume); - s->save_volume = (!reference_changed && s->save_volume) || save; - - if (s->set_volume) { + if (root_sink->set_volume) { /* If we have a function set_volume(), then we do not apply a * soft volume by default. However, set_volume() is free to - * apply one to s->soft_volume */ + * apply one to root_sink->soft_volume */ - pa_cvolume_reset(&s->soft_volume, s->sample_spec.channels); - if (!(s->flags & PA_SINK_SYNC_VOLUME)) - s->set_volume(s); - else - send_msg = TRUE; + pa_cvolume_reset(&root_sink->soft_volume, root_sink->sample_spec.channels); + if (!(root_sink->flags & PA_SINK_DEFERRED_VOLUME)) + root_sink->set_volume(root_sink); } else /* If we have no function set_volume(), then the soft volume - * becomes the virtual volume */ - s->soft_volume = s->real_volume; + * becomes the real volume */ + root_sink->soft_volume = root_sink->real_volume; - /* This tells the sink that soft and/or virtual volume changed */ + /* This tells the sink that soft volume and/or real volume changed */ if (send_msg) - pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL) == 0); - - if (reference_changed) - pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); + pa_assert_se(pa_asyncmsgq_send(root_sink->asyncmsgq, PA_MSGOBJECT(root_sink), PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL) == 0); } /* Called from the io thread if sync volume is used, otherwise from the main thread. * Only to be called by sink implementor */ void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume) { + pa_sink_assert_ref(s); - if (s->flags & PA_SINK_SYNC_VOLUME) + pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)); + + if (s->flags & PA_SINK_DEFERRED_VOLUME) pa_sink_assert_io_context(s); else pa_assert_ctl_context(); @@ -1524,18 +2093,20 @@ void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume) { else s->soft_volume = *volume; - if (PA_SINK_IS_LINKED(s->state) && !(s->flags & PA_SINK_SYNC_VOLUME)) + if (PA_SINK_IS_LINKED(s->state) && !(s->flags & PA_SINK_DEFERRED_VOLUME)) pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME, NULL, 0, NULL) == 0); else s->thread_info.soft_volume = s->soft_volume; } +/* Called from the main thread. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. */ static void propagate_real_volume(pa_sink *s, const pa_cvolume *old_real_volume) { pa_sink_input *i; uint32_t idx; - pa_cvolume old_reference_volume; pa_sink_assert_ref(s); + pa_assert(old_real_volume); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); @@ -1544,20 +2115,18 @@ static void propagate_real_volume(pa_sink *s, const pa_cvolume *old_real_volume) * reference volume and then rebuild the stream volumes based on * i->real_ratio which should stay fixed. */ - if (old_real_volume && pa_cvolume_equal(old_real_volume, &s->real_volume)) - return; - - old_reference_volume = s->reference_volume; + if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) { + if (pa_cvolume_equal(old_real_volume, &s->real_volume)) + return; - /* 1. Make the real volume the reference volume */ - s->reference_volume = s->real_volume; + /* 1. Make the real volume the reference volume */ + update_reference_volume(s, &s->real_volume, &s->channel_map, true); + } - if (s->flags & PA_SINK_FLAT_VOLUME) { + if (pa_sink_flat_volume_enabled(s)) { PA_IDXSET_FOREACH(i, s->inputs, idx) { - pa_cvolume old_volume, remapped; - - old_volume = i->volume; + pa_cvolume old_volume = i->volume; /* 2. Since the sink's reference and real volumes are equal * now our ratios should be too. */ @@ -1571,9 +2140,9 @@ static void propagate_real_volume(pa_sink *s, const pa_cvolume *old_real_volume) * i->volume = s->reference_volume * i->reference_ratio * * This is identical to propagate_reference_volume() */ - remapped = s->reference_volume; - pa_cvolume_remap(&remapped, &s->channel_map, &i->channel_map); - pa_sw_cvolume_multiply(&i->volume, &remapped, &i->reference_ratio); + i->volume = s->reference_volume; + pa_cvolume_remap(&i->volume, &s->channel_map, &i->channel_map); + pa_sw_cvolume_multiply(&i->volume, &i->volume, &i->reference_ratio); /* Notify if something changed */ if (!pa_cvolume_equal(&old_volume, &i->volume)) { @@ -1583,16 +2152,17 @@ static void propagate_real_volume(pa_sink *s, const pa_cvolume *old_real_volume) pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index); } + + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) + propagate_real_volume(i->origin_sink, old_real_volume); } } /* Something got changed in the hardware. It probably makes sense * to save changed hw settings given that hw volume changes not * triggered by PA are almost certainly done by the user. */ - s->save_volume = TRUE; - - if (!pa_cvolume_equal(&old_reference_volume, &s->reference_volume)) - pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); + if (!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) + s->save_volume = true; } /* Called from io thread */ @@ -1604,7 +2174,7 @@ void pa_sink_update_volume_and_mute(pa_sink *s) { } /* Called from main thread */ -const pa_cvolume *pa_sink_get_volume(pa_sink *s, pa_bool_t force_refresh) { +const pa_cvolume *pa_sink_get_volume(pa_sink *s, bool force_refresh) { pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); @@ -1612,38 +2182,42 @@ const pa_cvolume *pa_sink_get_volume(pa_sink *s, pa_bool_t force_refresh) { if (s->refresh_volume || force_refresh) { struct pa_cvolume old_real_volume; + pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)); + old_real_volume = s->real_volume; - if (!(s->flags & PA_SINK_SYNC_VOLUME) && s->get_volume) + if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume) s->get_volume(s); pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_VOLUME, NULL, 0, NULL) == 0); + update_real_volume(s, &s->real_volume, &s->channel_map); propagate_real_volume(s, &old_real_volume); } return &s->reference_volume; } -/* Called from main thread */ +/* Called from main thread. In volume sharing cases, only the root sink may + * call this. */ void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_real_volume) { pa_cvolume old_real_volume; pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); + pa_assert(!(s->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)); /* The sink implementor may call this if the volume changed to make sure everyone is notified */ old_real_volume = s->real_volume; - s->real_volume = *new_real_volume; - + update_real_volume(s, new_real_volume, &s->channel_map); propagate_real_volume(s, &old_real_volume); } /* Called from main thread */ -void pa_sink_set_mute(pa_sink *s, pa_bool_t mute, pa_bool_t save) { - pa_bool_t old_muted; +void pa_sink_set_mute(pa_sink *s, bool mute, bool save) { + bool old_muted; pa_sink_assert_ref(s); pa_assert_ctl_context(); @@ -1653,7 +2227,7 @@ void pa_sink_set_mute(pa_sink *s, pa_bool_t mute, pa_bool_t save) { s->muted = mute; s->save_muted = (old_muted == s->muted && s->save_muted) || save; - if (!(s->flags & PA_SINK_SYNC_VOLUME) && s->set_mute) + if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->set_mute) s->set_mute(s); pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MUTE, NULL, 0, NULL) == 0); @@ -1663,22 +2237,22 @@ void pa_sink_set_mute(pa_sink *s, pa_bool_t mute, pa_bool_t save) { } /* Called from main thread */ -pa_bool_t pa_sink_get_mute(pa_sink *s, pa_bool_t force_refresh) { +bool pa_sink_get_mute(pa_sink *s, bool force_refresh) { pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); if (s->refresh_muted || force_refresh) { - pa_bool_t old_muted = s->muted; + bool old_muted = s->muted; - if (!(s->flags & PA_SINK_SYNC_VOLUME) && s->get_mute) + if (!(s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_mute) s->get_mute(s); pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MUTE, NULL, 0, NULL) == 0); if (old_muted != s->muted) { - s->save_muted = TRUE; + s->save_muted = true; pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); @@ -1691,7 +2265,7 @@ pa_bool_t pa_sink_get_mute(pa_sink *s, pa_bool_t force_refresh) { } /* Called from main thread */ -void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted) { +void pa_sink_mute_changed(pa_sink *s, bool new_muted) { pa_sink_assert_ref(s); pa_assert_ctl_context(); pa_assert(PA_SINK_IS_LINKED(s->state)); @@ -1702,13 +2276,13 @@ void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted) { return; s->muted = new_muted; - s->save_muted = TRUE; + s->save_muted = true; pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); } /* Called from main thread */ -pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p) { +bool pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p) { pa_sink_assert_ref(s); pa_assert_ctl_context(); @@ -1720,7 +2294,7 @@ pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); } - return TRUE; + return true; } /* Called from main thread */ @@ -1768,7 +2342,7 @@ unsigned pa_sink_linked_by(pa_sink *s) { ret = pa_idxset_size(s->inputs); /* We add in the number of streams connected to us here. Please - * note the asymmmetry to pa_sink_used_by()! */ + * note the asymmetry to pa_sink_used_by()! */ if (s->monitor_source) ret += pa_source_linked_by(s->monitor_source); @@ -1815,7 +2389,7 @@ unsigned pa_sink_check_suspend(pa_sink *s) { /* We do not assert here. It is perfectly valid for a sink input to * be in the INIT state (i.e. created, marked done but not yet put) * and we should not care if it's unlinked as it won't contribute - * towarards our busy status. + * towards our busy status. */ if (!PA_SINK_INPUT_IS_LINKED(st)) continue; @@ -1844,15 +2418,27 @@ static void sync_input_volumes_within_thread(pa_sink *s) { pa_sink_assert_io_context(s); PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) { - if (pa_atomic_load(&i->before_ramping_v)) - i->thread_info.future_soft_volume = i->soft_volume; - if (pa_cvolume_equal(&i->thread_info.soft_volume, &i->soft_volume)) continue; - if (!pa_atomic_load(&i->before_ramping_v)) - i->thread_info.soft_volume = i->soft_volume; - pa_sink_input_request_rewind(i, 0, TRUE, FALSE, FALSE); + i->thread_info.soft_volume = i->soft_volume; + pa_sink_input_request_rewind(i, 0, true, false, false); + } +} + +/* Called from the IO thread. Only called for the root sink in volume sharing + * cases, except for internal recursive calls. */ +static void set_shared_volume_within_thread(pa_sink *s) { + pa_sink_input *i = NULL; + void *state = NULL; + + pa_sink_assert_ref(s); + + PA_MSGOBJECT(s)->process_msg(PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL); + + PA_HASHMAP_FOREACH(i, s->thread_info.inputs, state) { + if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) + set_shared_volume_within_thread(i->origin_sink); } } @@ -1889,15 +2475,23 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse } pa_assert(!i->thread_info.attached); - i->thread_info.attached = TRUE; + i->thread_info.attached = true; if (i->attach) i->attach(i); pa_sink_input_set_state_within_thread(i, i->state); - /* The requested latency of the sink input needs to be - * fixed up and then configured on the sink */ + /* The requested latency of the sink input needs to be fixed up and + * then configured on the sink. If this causes the sink latency to + * go down, the sink implementor is responsible for doing a rewind + * in the update_requested_latency() callback to ensure that the + * sink buffer doesn't contain more data than what the new latency + * allows. + * + * XXX: Does it really make sense to push this responsibility to + * the sink implementors? Wouldn't it be better to do it once in + * the core than many times in the modules? */ if (i->thread_info.requested_sink_latency != (pa_usec_t) -1) pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency); @@ -1908,11 +2502,15 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse /* We don't rewind here automatically. This is left to the * sink input implementor because some sink inputs need a * slow start, i.e. need some time to buffer client - * samples before beginning streaming. */ + * samples before beginning streaming. + * + * XXX: Does it really make sense to push this functionality to + * the sink implementors? Wouldn't it be better to do it once in + * the core than many times in the modules? */ /* In flat volume mode we need to update the volume as * well */ - return o->process_msg(o, PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL); + return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL); } case PA_SINK_MESSAGE_REMOVE_INPUT: { @@ -1920,7 +2518,7 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse /* If you change anything here, make sure to change the * sink input handling a few lines down at - * PA_SINK_MESSAGE_PREPAPRE_MOVE, too. */ + * PA_SINK_MESSAGE_START_MOVE, too. */ if (i->detach) i->detach(i); @@ -1928,7 +2526,7 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse pa_sink_input_set_state_within_thread(i, i->state); pa_assert(i->thread_info.attached); - i->thread_info.attached = FALSE; + i->thread_info.attached = false; /* Since the caller sleeps in pa_sink_input_unlink(), * we can safely access data outside of thread_info even @@ -1947,15 +2545,13 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse i->thread_info.sync_next = NULL; } - if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index))) - pa_sink_input_unref(i); - - pa_sink_invalidate_requested_latency(s, TRUE); + pa_hashmap_remove_and_free(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index)); + pa_sink_invalidate_requested_latency(s, true); pa_sink_request_rewind(s, (size_t) -1); /* In flat volume mode we need to update the volume as * well */ - return o->process_msg(o, PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL); + return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL); } case PA_SINK_MESSAGE_START_MOVE: { @@ -1971,6 +2567,46 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse pa_usec_t usec = 0; size_t sink_nbytes, total_nbytes; + /* The old sink probably has some audio from this + * stream in its buffer. We want to "take it back" as + * much as possible and play it to the new sink. We + * don't know at this point how much the old sink can + * rewind. We have to pick something, and that + * something is the full latency of the old sink here. + * So we rewind the stream buffer by the sink latency + * amount, which may be more than what we should + * rewind. This can result in a chunk of audio being + * played both to the old sink and the new sink. + * + * FIXME: Fix this code so that we don't have to make + * guesses about how much the sink will actually be + * able to rewind. If someone comes up with a solution + * for this, something to note is that the part of the + * latency that the old sink couldn't rewind should + * ideally be compensated after the stream has moved + * to the new sink by adding silence. The new sink + * most likely can't start playing the moved stream + * immediately, and that gap should be removed from + * the "compensation silence" (at least at the time of + * writing this, the move finish code will actually + * already take care of dropping the new sink's + * unrewindable latency, so taking into account the + * unrewindable latency of the old sink is the only + * problem). + * + * The render_memblockq contents are discarded, + * because when the sink changes, the format of the + * audio stored in the render_memblockq may change + * too, making the stored audio invalid. FIXME: + * However, the read and write indices are moved back + * the same amount, so if they are not the same now, + * they won't be the same after the rewind either. If + * the write index of the render_memblockq is ahead of + * the read index, then the render_memblockq will feed + * the new sink some silence first, which it shouldn't + * do. The write index should be flushed to be the + * same as the read index. */ + /* Get the latency of the sink */ usec = pa_sink_get_latency_within_thread(s); sink_nbytes = pa_usec_to_bytes(usec, &s->sample_spec); @@ -1978,7 +2614,7 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse if (total_nbytes > 0) { i->thread_info.rewrite_nbytes = i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, total_nbytes) : total_nbytes; - i->thread_info.rewrite_flush = TRUE; + i->thread_info.rewrite_flush = true; pa_sink_input_process_rewind(i, sink_nbytes); } } @@ -1987,20 +2623,19 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse i->detach(i); pa_assert(i->thread_info.attached); - i->thread_info.attached = FALSE; + i->thread_info.attached = false; /* Let's remove the sink input ...*/ - if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index))) - pa_sink_input_unref(i); + pa_hashmap_remove_and_free(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index)); - pa_sink_invalidate_requested_latency(s, TRUE); + pa_sink_invalidate_requested_latency(s, true); pa_log_debug("Requesting rewind due to started move"); pa_sink_request_rewind(s, (size_t) -1); /* In flat volume mode we need to update the volume as * well */ - return o->process_msg(o, PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL); + return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL); } case PA_SINK_MESSAGE_FINISH_MOVE: { @@ -2015,21 +2650,33 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i)); pa_assert(!i->thread_info.attached); - i->thread_info.attached = TRUE; + i->thread_info.attached = true; if (i->attach) i->attach(i); - if (i->thread_info.requested_sink_latency != (pa_usec_t) -1) - pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency); - - pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind); - pa_sink_input_update_max_request(i, s->thread_info.max_request); - if (i->thread_info.state != PA_SINK_INPUT_CORKED) { pa_usec_t usec = 0; size_t nbytes; + /* In the ideal case the new sink would start playing + * the stream immediately. That requires the sink to + * be able to rewind all of its latency, which usually + * isn't possible, so there will probably be some gap + * before the moved stream becomes audible. We then + * have two possibilities: 1) start playing the stream + * from where it is now, or 2) drop the unrewindable + * latency of the sink from the stream. With option 1 + * we won't lose any audio but the stream will have a + * pause. With option 2 we may lose some audio but the + * stream time will be somewhat in sync with the wall + * clock. Lennart seems to have chosen option 2 (one + * of the reasons might have been that option 1 is + * actually much harder to implement), so we drop the + * latency of the new sink from the moved stream and + * hope that the sink will undo most of that in the + * rewind. */ + /* Get the latency of the sink */ usec = pa_sink_get_latency_within_thread(s); nbytes = pa_usec_to_bytes(usec, &s->sample_spec); @@ -2041,14 +2688,32 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse pa_sink_request_rewind(s, nbytes); } - /* In flat volume mode we need to update the volume as - * well */ - return o->process_msg(o, PA_SINK_MESSAGE_SET_VOLUME_SYNCED, NULL, 0, NULL); + /* Updating the requested sink latency has to be done + * after the sink rewind request, not before, because + * otherwise the sink may limit the rewind amount + * needlessly. */ + + if (i->thread_info.requested_sink_latency != (pa_usec_t) -1) + pa_sink_input_set_requested_latency_within_thread(i, i->thread_info.requested_sink_latency); + + pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind); + pa_sink_input_update_max_request(i, s->thread_info.max_request); + + return o->process_msg(o, PA_SINK_MESSAGE_SET_SHARED_VOLUME, NULL, 0, NULL); + } + + case PA_SINK_MESSAGE_SET_SHARED_VOLUME: { + pa_sink *root_sink = pa_sink_get_master(s); + + if (PA_LIKELY(root_sink)) + set_shared_volume_within_thread(root_sink); + + return 0; } case PA_SINK_MESSAGE_SET_VOLUME_SYNCED: - if (s->flags & PA_SINK_SYNC_VOLUME) { + if (s->flags & PA_SINK_DEFERRED_VOLUME) { s->set_volume(s); pa_sink_volume_change_push(s); } @@ -2061,9 +2726,6 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse pa_sink_request_rewind(s, (size_t) -1); } - if (!(s->flags & PA_SINK_FLAT_VOLUME)) - return 0; - /* Fall through ... */ case PA_SINK_MESSAGE_SYNC_VOLUMES: @@ -2072,7 +2734,7 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse case PA_SINK_MESSAGE_GET_VOLUME: - if ((s->flags & PA_SINK_SYNC_VOLUME) && s->get_volume) { + if ((s->flags & PA_SINK_DEFERRED_VOLUME) && s->get_volume) { s->get_volume(s); pa_sink_volume_change_flush(s); pa_sw_cvolume_divide(&s->thread_info.current_hw_volume, &s->real_volume, &s->soft_volume); @@ -2093,21 +2755,21 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse pa_sink_request_rewind(s, (size_t) -1); } - if (s->flags & PA_SINK_SYNC_VOLUME && s->set_mute) + if (s->flags & PA_SINK_DEFERRED_VOLUME && s->set_mute) s->set_mute(s); return 0; case PA_SINK_MESSAGE_GET_MUTE: - if (s->flags & PA_SINK_SYNC_VOLUME && s->get_mute) + if (s->flags & PA_SINK_DEFERRED_VOLUME && s->get_mute) s->get_mute(s); return 0; case PA_SINK_MESSAGE_SET_STATE: { - pa_bool_t suspend_change = + bool suspend_change = (s->thread_info.state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata))) || (PA_SINK_IS_OPENED(s->thread_info.state) && PA_PTR_TO_UINT(userdata) == PA_SINK_SUSPENDED); @@ -2115,7 +2777,7 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse if (s->thread_info.state == PA_SINK_SUSPENDED) { s->thread_info.rewind_nbytes = 0; - s->thread_info.rewind_requested = FALSE; + s->thread_info.rewind_requested = false; } if (suspend_change) { @@ -2130,18 +2792,6 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse return 0; } - case PA_SINK_MESSAGE_DETACH: - - /* Detach all streams */ - pa_sink_detach_within_thread(s); - return 0; - - case PA_SINK_MESSAGE_ATTACH: - - /* Reattach all streams */ - pa_sink_attach_within_thread(s); - return 0; - case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY: { pa_usec_t *usec = userdata; @@ -2216,8 +2866,16 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse /* This message is sent from IO-thread and handled in main thread. */ pa_assert_ctl_context(); - pa_sink_get_volume(s, TRUE); - pa_sink_get_mute(s, TRUE); + /* Make sure we're not messing with main thread when no longer linked */ + if (!PA_SINK_IS_LINKED(s->state)) + return 0; + + pa_sink_get_volume(s, true); + pa_sink_get_mute(s, true); + return 0; + + case PA_SINK_MESSAGE_SET_LATENCY_OFFSET: + s->thread_info.latency_offset = offset; return 0; case PA_SINK_MESSAGE_GET_LATENCY: @@ -2229,7 +2887,7 @@ int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offse } /* Called from main thread */ -int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause) { +int pa_sink_suspend_all(pa_core *c, bool suspend, pa_suspend_cause_t cause) { pa_sink *sink; uint32_t idx; int ret = 0; @@ -2248,24 +2906,6 @@ int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause) return ret; } -/* Called from main thread */ -void pa_sink_detach(pa_sink *s) { - pa_sink_assert_ref(s); - pa_assert_ctl_context(); - pa_assert(PA_SINK_IS_LINKED(s->state)); - - pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_DETACH, NULL, 0, NULL) == 0); -} - -/* Called from main thread */ -void pa_sink_attach(pa_sink *s) { - pa_sink_assert_ref(s); - pa_assert_ctl_context(); - pa_assert(PA_SINK_IS_LINKED(s->state)); - - pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_ATTACH, NULL, 0, NULL) == 0); -} - /* Called from IO thread */ void pa_sink_detach_within_thread(pa_sink *s) { pa_sink_input *i; @@ -2306,9 +2946,6 @@ void pa_sink_request_rewind(pa_sink*s, size_t nbytes) { pa_sink_assert_io_context(s); pa_assert(PA_SINK_IS_LINKED(s->thread_info.state)); - if (s->thread_info.state == PA_SINK_SUSPENDED) - return; - if (nbytes == (size_t) -1) nbytes = s->thread_info.max_rewind; @@ -2319,7 +2956,7 @@ void pa_sink_request_rewind(pa_sink*s, size_t nbytes) { return; s->thread_info.rewind_nbytes = nbytes; - s->thread_info.rewind_requested = TRUE; + s->thread_info.rewind_requested = true; if (s->request_rewind) s->request_rewind(s); @@ -2358,7 +2995,7 @@ pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s) { if (PA_SINK_IS_LINKED(s->thread_info.state)) { /* Only cache if properly initialized */ s->thread_info.requested_latency = result; - s->thread_info.requested_latency_valid = TRUE; + s->thread_info.requested_latency_valid = true; } return result; @@ -2376,6 +3013,7 @@ pa_usec_t pa_sink_get_requested_latency(pa_sink *s) { return 0; pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0); + return usec; } @@ -2443,7 +3081,7 @@ void pa_sink_set_max_request(pa_sink *s, size_t max_request) { } /* Called from IO thread */ -void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic) { +void pa_sink_invalidate_requested_latency(pa_sink *s, bool dynamic) { pa_sink_input *i; void *state = NULL; @@ -2451,7 +3089,7 @@ void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic) { pa_sink_assert_io_context(s); if ((s->flags & PA_SINK_DYNAMIC_LATENCY)) - s->thread_info.requested_latency_valid = FALSE; + s->thread_info.requested_latency_valid = false; else if (dynamic) return; @@ -2503,22 +3141,22 @@ void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_ /* Called from main thread */ void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency) { - pa_sink_assert_ref(s); - pa_assert_ctl_context(); - pa_assert(min_latency); - pa_assert(max_latency); + pa_sink_assert_ref(s); + pa_assert_ctl_context(); + pa_assert(min_latency); + pa_assert(max_latency); - if (PA_SINK_IS_LINKED(s->state)) { - pa_usec_t r[2] = { 0, 0 }; + if (PA_SINK_IS_LINKED(s->state)) { + pa_usec_t r[2] = { 0, 0 }; - pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0); + pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY_RANGE, r, 0, NULL) == 0); - *min_latency = r[0]; - *max_latency = r[1]; - } else { - *min_latency = s->thread_info.min_latency; - *max_latency = s->thread_info.max_latency; - } + *min_latency = r[0]; + *max_latency = r[1]; + } else { + *min_latency = s->thread_info.min_latency; + *max_latency = s->thread_info.max_latency; + } } /* Called from IO thread */ @@ -2551,7 +3189,7 @@ void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, i->update_sink_latency_range(i); } - pa_sink_invalidate_requested_latency(s, FALSE); + pa_sink_invalidate_requested_latency(s, false); pa_source_set_latency_range_within_thread(s->monitor_source, min_latency, max_latency); } @@ -2605,6 +3243,11 @@ void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency) { if (s->flags & PA_SINK_DYNAMIC_LATENCY) { pa_assert(latency == 0); + s->thread_info.fixed_latency = 0; + + if (s->monitor_source) + pa_source_set_fixed_latency_within_thread(s->monitor_source, 0); + return; } @@ -2625,16 +3268,28 @@ void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency) { i->update_sink_fixed_latency(i); } - pa_sink_invalidate_requested_latency(s, FALSE); + pa_sink_invalidate_requested_latency(s, false); pa_source_set_fixed_latency_within_thread(s->monitor_source, latency); } +/* Called from main context */ +void pa_sink_set_latency_offset(pa_sink *s, int64_t offset) { + pa_sink_assert_ref(s); + + s->latency_offset = offset; + + if (PA_SINK_IS_LINKED(s->state)) + pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_LATENCY_OFFSET, NULL, offset, NULL) == 0); + else + s->thread_info.latency_offset = offset; +} + /* Called from main context */ size_t pa_sink_get_max_rewind(pa_sink *s) { size_t r; - pa_sink_assert_ref(s); pa_assert_ctl_context(); + pa_sink_assert_ref(s); if (!PA_SINK_IS_LINKED(s->state)) return s->thread_info.max_rewind; @@ -2659,9 +3314,10 @@ size_t pa_sink_get_max_request(pa_sink *s) { } /* Called from main context */ -int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save) { +int pa_sink_set_port(pa_sink *s, const char *name, bool save) { pa_device_port *port; int ret; + pa_sink_assert_ref(s); pa_assert_ctl_context(); @@ -2670,7 +3326,7 @@ int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save) { return -PA_ERR_NOTIMPLEMENTED; } - if (!s->ports) + if (!name) return -PA_ERR_NOENTITY; if (!(port = pa_hashmap_get(s->ports, name))) @@ -2681,7 +3337,7 @@ int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save) { return 0; } - if (s->flags & PA_SINK_SYNC_VOLUME) { + if (s->flags & PA_SINK_DEFERRED_VOLUME) { struct sink_message_set_port msg = { .port = port, .ret = 0 }; pa_assert_se(pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_PORT, &msg, 0, NULL) == 0); ret = msg.ret; @@ -2699,16 +3355,20 @@ int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save) { s->active_port = port; s->save_port = save; + pa_sink_set_latency_offset(s, s->active_port->latency_offset); + + pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PORT_CHANGED], s); + return 0; } -pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink) { +bool pa_device_init_icon(pa_proplist *p, bool is_sink) { const char *ff, *c, *t = NULL, *s = "", *profile, *bus; pa_assert(p); if (pa_proplist_contains(p, PA_PROP_DEVICE_ICON_NAME)) - return TRUE; + return true; if ((ff = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) { @@ -2766,19 +3426,24 @@ pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink) { pa_proplist_setf(p, PA_PROP_DEVICE_ICON_NAME, "%s%s%s%s", t, pa_strempty(s), bus ? "-" : "", pa_strempty(bus)); - return TRUE; + return true; } -pa_bool_t pa_device_init_description(pa_proplist *p) { +bool pa_device_init_description(pa_proplist *p, pa_card *card) { const char *s, *d = NULL, *k; pa_assert(p); if (pa_proplist_contains(p, PA_PROP_DEVICE_DESCRIPTION)) - return TRUE; + return true; - if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) - if (pa_streq(s, "internal")) - d = _("Internal Audio"); + if (card) + if ((s = pa_proplist_gets(card->proplist, PA_PROP_DEVICE_DESCRIPTION))) + d = s; + + if (!d) + if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) + if (pa_streq(s, "internal")) + d = _("Built-in Audio"); if (!d) if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_CLASS))) @@ -2789,33 +3454,33 @@ pa_bool_t pa_device_init_description(pa_proplist *p) { d = pa_proplist_gets(p, PA_PROP_DEVICE_PRODUCT_NAME); if (!d) - return FALSE; + return false; k = pa_proplist_gets(p, PA_PROP_DEVICE_PROFILE_DESCRIPTION); if (d && k) - pa_proplist_setf(p, PA_PROP_DEVICE_DESCRIPTION, _("%s %s"), d, k); + pa_proplist_setf(p, PA_PROP_DEVICE_DESCRIPTION, "%s %s", d, k); else if (d) pa_proplist_sets(p, PA_PROP_DEVICE_DESCRIPTION, d); - return TRUE; + return true; } -pa_bool_t pa_device_init_intended_roles(pa_proplist *p) { +bool pa_device_init_intended_roles(pa_proplist *p) { const char *s; pa_assert(p); if (pa_proplist_contains(p, PA_PROP_DEVICE_INTENDED_ROLES)) - return TRUE; + return true; if ((s = pa_proplist_gets(p, PA_PROP_DEVICE_FORM_FACTOR))) if (pa_streq(s, "handset") || pa_streq(s, "hands-free") || pa_streq(s, "headset")) { pa_proplist_sets(p, PA_PROP_DEVICE_INTENDED_ROLES, "phone"); - return TRUE; + return true; } - return FALSE; + return false; } unsigned pa_device_init_priority(pa_proplist *p) { @@ -2942,11 +3607,11 @@ void pa_sink_volume_change_push(pa_sink *s) { PA_LLIST_INSERT_AFTER(pa_sink_volume_change, s->thread_info.volume_changes, c, nc); } - pa_log_debug("Volume going %s to %d at %llu", direction, pa_cvolume_avg(&nc->hw_volume), nc->at); + pa_log_debug("Volume going %s to %d at %llu", direction, pa_cvolume_avg(&nc->hw_volume), (long long unsigned) nc->at); /* We can ignore volume events that came earlier but should happen later than this. */ PA_LLIST_FOREACH(c, nc->next) { - pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c->hw_volume), c->at); + pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at); pa_sink_volume_change_free(c); } nc->next = NULL; @@ -2967,30 +3632,40 @@ static void pa_sink_volume_change_flush(pa_sink *s) { } /* Called from the IO thread. */ -pa_bool_t pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next) { - pa_usec_t now = pa_rtclock_now(); - pa_bool_t ret = FALSE; +bool pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next) { + pa_usec_t now; + bool ret = false; pa_assert(s); + + if (!s->thread_info.volume_changes || !PA_SINK_IS_LINKED(s->state)) { + if (usec_to_next) + *usec_to_next = 0; + return ret; + } + pa_assert(s->write_volume); + now = pa_rtclock_now(); + while (s->thread_info.volume_changes && now >= s->thread_info.volume_changes->at) { pa_sink_volume_change *c = s->thread_info.volume_changes; PA_LLIST_REMOVE(pa_sink_volume_change, s->thread_info.volume_changes, c); - pa_log_debug("Volume change to %d at %llu was written %llu usec late", pa_cvolume_avg(&c->hw_volume), c->at, now - c->at); - ret = TRUE; + pa_log_debug("Volume change to %d at %llu was written %llu usec late", + pa_cvolume_avg(&c->hw_volume), (long long unsigned) c->at, (long long unsigned) (now - c->at)); + ret = true; s->thread_info.current_hw_volume = c->hw_volume; pa_sink_volume_change_free(c); } - if (s->write_volume && ret) + if (ret) s->write_volume(s); if (s->thread_info.volume_changes) { if (usec_to_next) *usec_to_next = s->thread_info.volume_changes->at - now; - if (pa_log_ratelimit()) - pa_log_debug("Next volume change in %lld usec", s->thread_info.volume_changes->at - now); + if (pa_log_ratelimit(PA_LOG_DEBUG)) + pa_log_debug("Next volume change in %lld usec", (long long) (s->thread_info.volume_changes->at - now)); } else { if (usec_to_next) @@ -3008,7 +3683,7 @@ static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes) { pa_usec_t rewound = pa_bytes_to_usec(nbytes, &s->sample_spec); pa_usec_t limit = pa_sink_get_latency_within_thread(s); - pa_log_debug("latency = %lld", limit); + pa_log_debug("latency = %lld", (long long) limit); limit += pa_rtclock_now() + s->thread_info.volume_change_extra_delay; PA_LLIST_FOREACH(c, s->thread_info.volume_changes) { @@ -3026,3 +3701,122 @@ static void pa_sink_volume_change_rewind(pa_sink *s, size_t nbytes) { } pa_sink_volume_change_apply(s, NULL); } + +/* Called from the main thread */ +/* Gets the list of formats supported by the sink. The members and idxset must + * be freed by the caller. */ +pa_idxset* pa_sink_get_formats(pa_sink *s) { + pa_idxset *ret; + + pa_assert(s); + + if (s->get_formats) { + /* Sink supports format query, all is good */ + ret = s->get_formats(s); + } else { + /* Sink doesn't support format query, so assume it does PCM */ + pa_format_info *f = pa_format_info_new(); + f->encoding = PA_ENCODING_PCM; + + ret = pa_idxset_new(NULL, NULL); + pa_idxset_put(ret, f, NULL); + } + + return ret; +} + +/* Called from the main thread */ +/* Allows an external source to set what formats a sink supports if the sink + * permits this. The function makes a copy of the formats on success. */ +bool pa_sink_set_formats(pa_sink *s, pa_idxset *formats) { + pa_assert(s); + pa_assert(formats); + + if (s->set_formats) + /* Sink supports setting formats -- let's give it a shot */ + return s->set_formats(s, formats); + else + /* Sink doesn't support setting this -- bail out */ + return false; +} + +/* Called from the main thread */ +/* Checks if the sink can accept this format */ +bool pa_sink_check_format(pa_sink *s, pa_format_info *f) { + pa_idxset *formats = NULL; + bool ret = false; + + pa_assert(s); + pa_assert(f); + + formats = pa_sink_get_formats(s); + + if (formats) { + pa_format_info *finfo_device; + uint32_t i; + + PA_IDXSET_FOREACH(finfo_device, formats, i) { + if (pa_format_info_is_compatible(finfo_device, f)) { + ret = true; + break; + } + } + + pa_idxset_free(formats, (pa_free_cb_t) pa_format_info_free); + } + + return ret; +} + +/* Called from the main thread */ +/* Calculates the intersection between formats supported by the sink and + * in_formats, and returns these, in the order of the sink's formats. */ +pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats) { + pa_idxset *out_formats = pa_idxset_new(NULL, NULL), *sink_formats = NULL; + pa_format_info *f_sink, *f_in; + uint32_t i, j; + + pa_assert(s); + + if (!in_formats || pa_idxset_isempty(in_formats)) + goto done; + + sink_formats = pa_sink_get_formats(s); + + PA_IDXSET_FOREACH(f_sink, sink_formats, i) { + PA_IDXSET_FOREACH(f_in, in_formats, j) { + if (pa_format_info_is_compatible(f_sink, f_in)) + pa_idxset_put(out_formats, pa_format_info_copy(f_in), NULL); + } + } + +done: + if (sink_formats) + pa_idxset_free(sink_formats, (pa_free_cb_t) pa_format_info_free); + + return out_formats; +} + +/* Called from the main thread. */ +void pa_sink_set_reference_volume_direct(pa_sink *s, const pa_cvolume *volume) { + pa_cvolume old_volume; + char old_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX]; + char new_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX]; + + pa_assert(s); + pa_assert(volume); + + old_volume = s->reference_volume; + + if (pa_cvolume_equal(volume, &old_volume)) + return; + + s->reference_volume = *volume; + pa_log_debug("The reference volume of sink %s changed from %s to %s.", s->name, + pa_cvolume_snprint_verbose(old_volume_str, sizeof(old_volume_str), &old_volume, &s->channel_map, + s->flags & PA_SINK_DECIBEL_VOLUME), + pa_cvolume_snprint_verbose(new_volume_str, sizeof(new_volume_str), volume, &s->channel_map, + s->flags & PA_SINK_DECIBEL_VOLUME)); + + pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index); +}