/***
This file is part of PulseAudio.
Copyright 2009 Lennart Poettering
PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License,
or (at your option) any later version.
PulseAudio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with PulseAudio; if not, see .
***/
#ifdef HAVE_CONFIG_H
#include
#endif
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "stream-interaction.h"
struct userdata {
pa_core *core;
const char *name;
pa_hashmap *interaction_state;
pa_idxset *trigger_roles;
pa_idxset *interaction_roles;
pa_volume_t volume;
bool global:1;
bool duck:1;
pa_hook_slot
*sink_input_put_slot,
*sink_input_unlink_slot,
*sink_input_move_start_slot,
*sink_input_move_finish_slot,
*sink_input_state_changed_slot,
*sink_input_mute_changed_slot,
*sink_input_proplist_changed_slot;
};
static const char *get_trigger_role(struct userdata *u, pa_sink_input *i) {
const char *role, *trigger_role;
uint32_t role_idx;
if (!(role = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_ROLE)))
role = "no_role";
PA_IDXSET_FOREACH(trigger_role, u->trigger_roles, role_idx) {
if (pa_streq(role, trigger_role))
return trigger_role;
}
return NULL;
}
static const char *find_trigger_stream(struct userdata *u, pa_sink *s, pa_sink_input *ignore) {
pa_sink_input *j;
uint32_t idx;
const char *trigger_role;
pa_assert(u);
pa_sink_assert_ref(s);
for (j = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx)); j; j = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx))) {
if (j == ignore)
continue;
trigger_role = get_trigger_role(u, j);
if (trigger_role && !j->muted && pa_sink_input_get_state(j) != PA_SINK_INPUT_CORKED)
return trigger_role;
}
return NULL;
}
static const char *find_global_trigger_stream(struct userdata *u, pa_sink *s, pa_sink_input *ignore) {
const char *trigger_role = NULL;
pa_assert(u);
if (u->global) {
uint32_t idx;
PA_IDXSET_FOREACH(s, u->core->sinks, idx)
if ((trigger_role = find_trigger_stream(u, s, ignore)))
break;
} else
trigger_role = find_trigger_stream(u, s, ignore);
return trigger_role;
}
static void cork_or_duck(struct userdata *u, pa_sink_input *i, const char *interaction_role, const char *trigger_role, bool interaction_applied) {
if (u->duck && !interaction_applied) {
pa_cvolume vol;
vol.channels = 1;
vol.values[0] = u->volume;
pa_log_debug("Found a '%s' stream that ducks a '%s' stream.", trigger_role, interaction_role);
pa_sink_input_add_volume_factor(i, u->name, &vol);
} else if (!u->duck) {
pa_log_debug("Found a '%s' stream that corks/mutes a '%s' stream.", trigger_role, interaction_role);
pa_sink_input_set_mute(i, true, false);
pa_sink_input_send_event(i, PA_STREAM_EVENT_REQUEST_CORK, NULL);
}
}
static void uncork_or_unduck(struct userdata *u, pa_sink_input *i, const char *interaction_role, bool corked) {
if (u->duck) {
pa_log_debug("Found a '%s' stream that should be unducked", interaction_role);
pa_sink_input_remove_volume_factor(i, u->name);
}
else if (corked || i->muted) {
pa_log_debug("Found a '%s' stream that should be uncorked/unmuted.", interaction_role);
if (i->muted)
pa_sink_input_set_mute(i, false, false);
if (corked)
pa_sink_input_send_event(i, PA_STREAM_EVENT_REQUEST_UNCORK, NULL);
}
}
static inline void apply_interaction_to_sink(struct userdata *u, pa_sink *s, const char *new_trigger, pa_sink_input *ignore, bool new_stream) {
pa_sink_input *j;
uint32_t idx, role_idx;
const char *interaction_role;
bool trigger = false;
pa_assert(u);
pa_sink_assert_ref(s);
for (j = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx)); j; j = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx))) {
bool corked, interaction_applied;
const char *role;
if (j == ignore)
continue;
if (!(role = pa_proplist_gets(j->proplist, PA_PROP_MEDIA_ROLE)))
role = "no_role";
PA_IDXSET_FOREACH(interaction_role, u->interaction_roles, role_idx) {
if ((trigger = pa_streq(role, interaction_role)))
break;
if ((trigger = (pa_streq(interaction_role, "any_role") && !get_trigger_role(u, j))))
break;
}
if (!trigger)
continue;
/* Some applications start their streams corked, so the stream is uncorked by */
/* the application only after sink_input_put() was called. If a new stream turns */
/* up, act as if it was not corked. In the case of module-role-cork this will */
/* only mute the stream because corking is reverted later by the application */
corked = (pa_sink_input_get_state(j) == PA_SINK_INPUT_CORKED);
if (new_stream && corked)
corked = false;
interaction_applied = !!pa_hashmap_get(u->interaction_state, j);
if (new_trigger && ((!corked && !j->muted) || u->duck)) {
if (!interaction_applied)
pa_hashmap_put(u->interaction_state, j, PA_INT_TO_PTR(1));
cork_or_duck(u, j, role, new_trigger, interaction_applied);
} else if (!new_trigger && interaction_applied) {
pa_hashmap_remove(u->interaction_state, j);
uncork_or_unduck(u, j, role, corked);
}
}
}
static void apply_interaction(struct userdata *u, pa_sink *s, const char *trigger_role, pa_sink_input *ignore, bool new_stream) {
pa_assert(u);
if (u->global) {
uint32_t idx;
PA_IDXSET_FOREACH(s, u->core->sinks, idx)
apply_interaction_to_sink(u, s, trigger_role, ignore, new_stream);
} else
apply_interaction_to_sink(u, s, trigger_role, ignore, new_stream);
}
static void remove_interactions(struct userdata *u) {
uint32_t idx, idx_input;
pa_sink *s;
pa_sink_input *j;
bool corked;
const char *role;
PA_IDXSET_FOREACH(s, u->core->sinks, idx) {
for (j = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx_input)); j; j = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx_input))) {
if(!!pa_hashmap_get(u->interaction_state, j)) {
corked = (pa_sink_input_get_state(j) == PA_SINK_INPUT_CORKED);
if (!(role = pa_proplist_gets(j->proplist, PA_PROP_MEDIA_ROLE)))
role = "no_role";
uncork_or_unduck(u, j, role, corked);
}
}
}
}
static pa_hook_result_t process(struct userdata *u, pa_sink_input *i, bool create, bool new_stream) {
const char *trigger_role;
pa_assert(u);
pa_sink_input_assert_ref(i);
if (!create)
pa_hashmap_remove(u->interaction_state, i);
if (!i->sink)
return PA_HOOK_OK;
trigger_role = find_global_trigger_stream(u, i->sink, create ? NULL : i);
apply_interaction(u, i->sink, trigger_role, create ? NULL : i, new_stream);
return PA_HOOK_OK;
}
static pa_hook_result_t sink_input_put_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_core_assert_ref(core);
pa_sink_input_assert_ref(i);
return process(u, i, true, true);
}
static pa_hook_result_t sink_input_unlink_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_sink_input_assert_ref(i);
return process(u, i, false, false);
}
static pa_hook_result_t sink_input_move_start_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_core_assert_ref(core);
pa_sink_input_assert_ref(i);
return process(u, i, false, false);
}
static pa_hook_result_t sink_input_move_finish_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_core_assert_ref(core);
pa_sink_input_assert_ref(i);
return process(u, i, true, false);
}
static pa_hook_result_t sink_input_state_changed_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_core_assert_ref(core);
pa_sink_input_assert_ref(i);
if (PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(i)) && get_trigger_role(u, i))
return process(u, i, true, false);
return PA_HOOK_OK;
}
static pa_hook_result_t sink_input_mute_changed_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_core_assert_ref(core);
pa_sink_input_assert_ref(i);
if (PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(i)) && get_trigger_role(u, i))
return process(u, i, true, false);
return PA_HOOK_OK;
}
static pa_hook_result_t sink_input_proplist_changed_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_core_assert_ref(core);
pa_sink_input_assert_ref(i);
if (PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(i)))
return process(u, i, true, false);
return PA_HOOK_OK;
}
int pa_stream_interaction_init(pa_module *m, const char* const v_modargs[]) {
pa_modargs *ma = NULL;
struct userdata *u;
const char *roles;
bool global = false;
pa_assert(m);
if (!(ma = pa_modargs_new(m->argument, v_modargs))) {
pa_log("Failed to parse module arguments");
goto fail;
}
m->userdata = u = pa_xnew(struct userdata, 1);
u->core = m->core;
u->name = m->name;
u->interaction_state = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
u->duck = false;
if (pa_streq(u->name, "module-role-ducking")) {
u->duck = true;
u->volume = pa_sw_volume_from_dB(-20);
if (pa_modargs_get_value_volume(ma, "volume", &u->volume) < 0) {
pa_log("Failed to parse a volume parameter: volume");
goto fail;
}
}
u->trigger_roles = pa_idxset_new(NULL, NULL);
roles = pa_modargs_get_value(ma, "trigger_roles", NULL);
if (roles) {
const char *split_state = NULL;
char *n = NULL;
while ((n = pa_split(roles, ",", &split_state))) {
if (n[0] != '\0')
pa_idxset_put(u->trigger_roles, n, NULL);
else
pa_xfree(n);
}
}
if (pa_idxset_isempty(u->trigger_roles)) {
pa_log_debug("Using role 'phone' as trigger role.");
pa_idxset_put(u->trigger_roles, pa_xstrdup("phone"), NULL);
}
u->interaction_roles = pa_idxset_new(NULL, NULL);
roles = pa_modargs_get_value(ma, u->duck ? "ducking_roles" : "cork_roles", NULL);
if (roles) {
const char *split_state = NULL;
char *n = NULL;
while ((n = pa_split(roles, ",", &split_state))) {
if (n[0] != '\0')
pa_idxset_put(u->interaction_roles, n, NULL);
else
pa_xfree(n);
}
}
if (pa_idxset_isempty(u->interaction_roles)) {
pa_log_debug("Using roles 'music' and 'video' as %s roles.", u->duck ? "ducking" : "cork");
pa_idxset_put(u->interaction_roles, pa_xstrdup("music"), NULL);
pa_idxset_put(u->interaction_roles, pa_xstrdup("video"), NULL);
}
if (pa_modargs_get_value_boolean(ma, "global", &global) < 0) {
pa_log("Invalid boolean parameter: global");
goto fail;
}
u->global = global;
u->sink_input_put_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_put_cb, u);
u->sink_input_unlink_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_unlink_cb, u);
u->sink_input_move_start_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_START], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_move_start_cb, u);
u->sink_input_move_finish_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_move_finish_cb, u);
u->sink_input_state_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_state_changed_cb, u);
u->sink_input_mute_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_MUTE_CHANGED], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_mute_changed_cb, u);
u->sink_input_proplist_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_proplist_changed_cb, u);
pa_modargs_free(ma);
return 0;
fail:
pa_stream_interaction_done(m);
if (ma)
pa_modargs_free(ma);
return -1;
}
void pa_stream_interaction_done(pa_module *m) {
struct userdata* u;
pa_assert(m);
if (!(u = m->userdata))
return;
if (u->trigger_roles)
pa_idxset_free(u->trigger_roles, pa_xfree);
if (u->interaction_roles)
pa_idxset_free(u->interaction_roles, pa_xfree);
if (u->sink_input_put_slot)
pa_hook_slot_free(u->sink_input_put_slot);
if (u->sink_input_unlink_slot)
pa_hook_slot_free(u->sink_input_unlink_slot);
if (u->sink_input_move_start_slot)
pa_hook_slot_free(u->sink_input_move_start_slot);
if (u->sink_input_move_finish_slot)
pa_hook_slot_free(u->sink_input_move_finish_slot);
if (u->sink_input_state_changed_slot)
pa_hook_slot_free(u->sink_input_state_changed_slot);
if (u->sink_input_mute_changed_slot)
pa_hook_slot_free(u->sink_input_mute_changed_slot);
if (u->sink_input_proplist_changed_slot)
pa_hook_slot_free(u->sink_input_proplist_changed_slot);
if (u->interaction_state) {
remove_interactions(u);
pa_hashmap_free(u->interaction_state);
}
pa_xfree(u);
}