mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-11-05 13:29:57 -05:00
role-ducking: Apply a ducking effect based on streams roles
This module works pretty similar to the module-role-cork. It should be used as an alternative to that module. Basically it decreases the volume of the streams specified in ducking_roles in the presence of at least one stream specified in trigger_roles. Also, it's possible to choice the volume that will be used in the ducking streams and if it should operates in all devices or not. For basic reference: http://en.wikipedia.org/wiki/Ducking
This commit is contained in:
Flavio Ceolin
Tanu Kaskinen
parent
b9f6bfcadc
commit
4d65c9582d
2 changed files with 332 additions and 1 deletions
323
src/modules/module-role-ducking.c
Normal file
323
src/modules/module-role-ducking.c
Normal file
|
|
@ -0,0 +1,323 @@
|
|||
/***
|
||||
This file is part of PulseAudio.
|
||||
|
||||
Copyright 2012 Flavio Ceolin <flavio.ceolin@profusion.mobi>
|
||||
|
||||
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, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
||||
USA.
|
||||
***/
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include <config.h>
|
||||
#endif
|
||||
|
||||
#include <pulse/volume.h>
|
||||
#include <pulse/xmalloc.h>
|
||||
|
||||
#include <pulsecore/macro.h>
|
||||
#include <pulsecore/hashmap.h>
|
||||
#include <pulsecore/hook-list.h>
|
||||
#include <pulsecore/core.h>
|
||||
#include <pulsecore/core-util.h>
|
||||
#include <pulsecore/sink-input.h>
|
||||
#include <pulsecore/modargs.h>
|
||||
|
||||
#include "module-role-ducking-symdef.h"
|
||||
|
||||
PA_MODULE_AUTHOR("Flavio Ceolin <flavio.ceolin@profusion.mobi>");
|
||||
PA_MODULE_DESCRIPTION("Apply a ducking effect based on streams roles");
|
||||
PA_MODULE_VERSION(PACKAGE_VERSION);
|
||||
PA_MODULE_LOAD_ONCE(true);
|
||||
PA_MODULE_USAGE(
|
||||
"trigger_roles=<Comma separated list of roles which will trigger a ducking> "
|
||||
"ducking_roles=<Comma separated list of roles which will be ducked> "
|
||||
"global=<Should we operate globally or only inside the same device?>"
|
||||
"volume=<Volume for the attenuated streams. Default: -20dB"
|
||||
);
|
||||
|
||||
static const char* const valid_modargs[] = {
|
||||
"trigger_roles",
|
||||
"ducking_roles",
|
||||
"global",
|
||||
"volume",
|
||||
NULL
|
||||
};
|
||||
|
||||
struct userdata {
|
||||
pa_core *core;
|
||||
const char *name;
|
||||
pa_idxset *trigger_roles;
|
||||
pa_idxset *ducking_roles;
|
||||
pa_idxset *ducked_inputs;
|
||||
bool global;
|
||||
pa_volume_t volume;
|
||||
pa_hook_slot
|
||||
*sink_input_put_slot,
|
||||
*sink_input_unlink_slot,
|
||||
*sink_input_move_start_slot,
|
||||
*sink_input_move_finish_slot;
|
||||
};
|
||||
|
||||
static bool sink_has_trigger_streams(struct userdata *u, pa_sink *s, pa_sink_input *ignore) {
|
||||
pa_sink_input *j;
|
||||
uint32_t idx, role_idx;
|
||||
const char *trigger_role;
|
||||
|
||||
pa_assert(u);
|
||||
pa_sink_assert_ref(s);
|
||||
|
||||
PA_IDXSET_FOREACH(j, s->inputs, idx) {
|
||||
const char *role;
|
||||
|
||||
if (j == ignore)
|
||||
continue;
|
||||
|
||||
if (!(role = pa_proplist_gets(j->proplist, PA_PROP_MEDIA_ROLE)))
|
||||
continue;
|
||||
|
||||
PA_IDXSET_FOREACH(trigger_role, u->trigger_roles, role_idx) {
|
||||
if (pa_streq(role, trigger_role)) {
|
||||
pa_log_debug("Found a '%s' stream that will trigger the ducking.", trigger_role);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
static void apply_ducking_to_sink(struct userdata *u, pa_sink *s, pa_sink_input *ignore, bool duck) {
|
||||
pa_sink_input *j;
|
||||
uint32_t idx, role_idx;
|
||||
const char *ducking_role;
|
||||
bool trigger = false;
|
||||
|
||||
pa_assert(u);
|
||||
pa_sink_assert_ref(s);
|
||||
|
||||
PA_IDXSET_FOREACH(j, s->inputs, idx) {
|
||||
const char *role;
|
||||
pa_sink_input *i;
|
||||
|
||||
if (j == ignore)
|
||||
continue;
|
||||
|
||||
if (!(role = pa_proplist_gets(j->proplist, PA_PROP_MEDIA_ROLE)))
|
||||
continue;
|
||||
|
||||
PA_IDXSET_FOREACH(ducking_role, u->ducking_roles, role_idx) {
|
||||
if ((trigger = pa_streq(role, ducking_role)))
|
||||
break;
|
||||
}
|
||||
if (!trigger)
|
||||
continue;
|
||||
|
||||
i = pa_idxset_get_by_data(u->ducked_inputs, j, NULL);
|
||||
if (duck && !i) {
|
||||
pa_cvolume vol;
|
||||
vol.channels = 1;
|
||||
vol.values[0] = u->volume;
|
||||
|
||||
pa_log_debug("Found a '%s' stream that should be ducked.", ducking_role);
|
||||
pa_sink_input_add_volume_factor(j, u->name, &vol);
|
||||
pa_idxset_put(u->ducked_inputs, j, NULL);
|
||||
} else if (!duck && i) { /* This stream should not longer be ducked */
|
||||
pa_log_debug("Found a '%s' stream that should be unducked", ducking_role);
|
||||
pa_idxset_remove_by_data(u->ducked_inputs, j, NULL);
|
||||
pa_sink_input_remove_volume_factor(j, u->name);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void apply_ducking(struct userdata *u, pa_sink *s, pa_sink_input *ignore, bool duck) {
|
||||
pa_assert(u);
|
||||
|
||||
if (u->global) {
|
||||
uint32_t idx;
|
||||
PA_IDXSET_FOREACH(s, u->core->sinks, idx)
|
||||
apply_ducking_to_sink(u, s, ignore, duck);
|
||||
} else
|
||||
apply_ducking_to_sink(u, s, ignore, duck);
|
||||
}
|
||||
|
||||
static pa_hook_result_t process(struct userdata *u, pa_sink_input *i, bool duck) {
|
||||
bool should_duck = false;
|
||||
const char *role;
|
||||
|
||||
pa_assert(u);
|
||||
pa_sink_input_assert_ref(i);
|
||||
|
||||
if (!(role = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_ROLE)))
|
||||
return PA_HOOK_OK;
|
||||
|
||||
if (!i->sink)
|
||||
return PA_HOOK_OK;
|
||||
|
||||
should_duck = sink_has_trigger_streams(u, i->sink, duck ? NULL : i);
|
||||
apply_ducking(u, i->sink, duck ? NULL : i, should_duck);
|
||||
|
||||
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);
|
||||
}
|
||||
|
||||
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);
|
||||
|
||||
pa_idxset_remove_by_data(u->ducked_inputs, i, NULL);
|
||||
return process(u, i, 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);
|
||||
}
|
||||
|
||||
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);
|
||||
}
|
||||
|
||||
int pa__init(pa_module *m) {
|
||||
pa_modargs *ma = NULL;
|
||||
struct userdata *u;
|
||||
const char *roles;
|
||||
|
||||
pa_assert(m);
|
||||
|
||||
if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
|
||||
pa_log("Failed to parse module arguments");
|
||||
goto fail;
|
||||
}
|
||||
|
||||
m->userdata = u = pa_xnew0(struct userdata, 1);
|
||||
|
||||
u->core = m->core;
|
||||
u->name = m->name;
|
||||
|
||||
u->ducked_inputs = pa_idxset_new(NULL, NULL);
|
||||
|
||||
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->ducking_roles = pa_idxset_new(NULL, NULL);
|
||||
roles = pa_modargs_get_value(ma, "ducking_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->ducking_roles, n, NULL);
|
||||
else
|
||||
pa_xfree(n);
|
||||
}
|
||||
}
|
||||
if (pa_idxset_isempty(u->ducking_roles)) {
|
||||
pa_log_debug("Using roles 'music' and 'video' as ducking roles.");
|
||||
pa_idxset_put(u->ducking_roles, pa_xstrdup("music"), NULL);
|
||||
pa_idxset_put(u->ducking_roles, pa_xstrdup("video"), NULL);
|
||||
}
|
||||
|
||||
u->global = false;
|
||||
if (pa_modargs_get_value_boolean(ma, "global", &u->global) < 0) {
|
||||
pa_log("Failed to parse a boolean parameter: global");
|
||||
goto fail;
|
||||
}
|
||||
|
||||
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->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);
|
||||
|
||||
pa_modargs_free(ma);
|
||||
|
||||
return 0;
|
||||
|
||||
fail:
|
||||
pa__done(m);
|
||||
|
||||
if (ma)
|
||||
pa_modargs_free(ma);
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
void pa__done(pa_module *m) {
|
||||
struct userdata* u;
|
||||
pa_sink_input *i;
|
||||
char *role;
|
||||
|
||||
pa_assert(m);
|
||||
|
||||
if (!(u = m->userdata))
|
||||
return;
|
||||
|
||||
if (u->trigger_roles) {
|
||||
while ((role = pa_idxset_steal_first(u->trigger_roles, NULL)))
|
||||
pa_xfree(role);
|
||||
pa_idxset_free(u->trigger_roles, NULL, NULL);
|
||||
}
|
||||
if (u->ducking_roles) {
|
||||
while ((role = pa_idxset_steal_first(u->ducking_roles, NULL)))
|
||||
pa_xfree(role);
|
||||
pa_idxset_free(u->ducking_roles, NULL, NULL);
|
||||
}
|
||||
if (u->ducked_inputs) {
|
||||
while ((i = pa_idxset_steal_first(u->ducked_inputs, NULL)))
|
||||
pa_sink_input_remove_volume_factor(i, u->name);
|
||||
|
||||
pa_idxset_free(u->ducked_inputs, NULL, NULL);
|
||||
}
|
||||
|
||||
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);
|
||||
|
||||
pa_xfree(u);
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue