#include <pulsecore/hook-list.h>
#include <pulsecore/sink-input.h>
#include <pulsecore/modargs.h>
+#include <pulsecore/proplist-util.h>
#include "module-filter-apply-symdef.h"
PA_MODULE_AUTHOR("Colin Guthrie");
PA_MODULE_DESCRIPTION("Load filter sinks automatically when needed");
PA_MODULE_VERSION(PACKAGE_VERSION);
-PA_MODULE_LOAD_ONCE(TRUE);
+PA_MODULE_LOAD_ONCE(true);
PA_MODULE_USAGE(_("autoclean=<automatically unload unused filters?>"));
static const char* const valid_modargs[] = {
NULL
};
-#define DEFAULT_AUTOCLEAN TRUE
+#define DEFAULT_AUTOCLEAN true
#define HOUSEKEEPING_INTERVAL (10 * PA_USEC_PER_SEC)
struct filter {
*source_output_proplist_slot,
*source_output_unlink_slot,
*source_unlink_slot;
- pa_bool_t autoclean;
+ bool autoclean;
pa_time_event *housekeeping_time_event;
};
else if (!f->sink_master && f->source_master)
return (unsigned) ((f->source_master->index << 16) + pa_idxset_string_hash_func(f->name));
else
- pa_assert_not_reached();
+ return (unsigned) (f->sink_master->index + (f->source_master->index << 16) + pa_idxset_string_hash_func(f->name));
}
static int filter_compare(const void *a, const void *b) {
pa_xfree(f);
}
-static const char* should_filter(pa_object *o, pa_bool_t is_sink_input) {
+static const char* should_filter(pa_object *o, bool is_sink_input) {
const char *apply;
pa_proplist *pl;
return NULL;
}
-static pa_bool_t nothing_attached(struct filter *f) {
- pa_bool_t no_si = TRUE, no_so = TRUE;
+static bool should_group_filter(struct filter *filter) {
+ return pa_streq(filter->name, "echo-cancel");
+}
+
+static char* get_group(pa_object *o, bool is_sink_input) {
+ pa_proplist *pl;
+
+ if (is_sink_input)
+ pl = PA_SINK_INPUT(o)->proplist;
+ else
+ pl = PA_SOURCE_OUTPUT(o)->proplist;
+
+ /* There's a bit of cleverness here -- the second argument ensures that we
+ * only group streams that require the same filter */
+ return pa_proplist_get_stream_group(pl, pa_proplist_gets(pl, PA_PROP_FILTER_APPLY), NULL);
+}
+
+/* For filters that apply on a source-output/sink-input pair, this finds the
+ * master sink if we know the master source, or vice versa. It does this by
+ * looking up streams that belong to the same stream group as the original
+ * object. The idea is that streams from the sam group are always routed
+ * together. */
+static bool find_paired_master(struct userdata *u, struct filter *filter, pa_object *o, bool is_sink_input) {
+ char *group;
+
+ if ((group = get_group(o, is_sink_input))) {
+ uint32_t idx;
+ char *g;
+ char *module_name = pa_sprintf_malloc("module-%s", filter->name);
+
+ if (is_sink_input) {
+ pa_source_output *so;
+
+ PA_IDXSET_FOREACH(so, u->core->source_outputs, idx) {
+ g = get_group(PA_OBJECT(so), false);
+
+ if (pa_streq(g, group)) {
+ if (pa_streq(module_name, so->source->module->name)) {
+ /* Make sure we're not routing to another instance of
+ * the same filter. */
+ filter->source_master = so->source->output_from_master->source;
+ } else {
+ filter->source_master = so->source;
+ }
+
+ pa_xfree(g);
+ break;
+ }
+
+ pa_xfree (g);
+ }
+ } else {
+ pa_sink_input *si;
+
+ PA_IDXSET_FOREACH(si, u->core->sink_inputs, idx) {
+ g = get_group(PA_OBJECT(si), true);
+
+ if (pa_streq(g, group)) {
+ if (pa_streq(module_name, si->sink->module->name)) {
+ /* Make sure we're not routing to another instance of
+ * the same filter. */
+ filter->sink_master = si->sink->input_to_master->sink;
+ } else {
+ filter->sink_master = si->sink;
+ }
+
+ pa_xfree(g);
+ break;
+ }
+
+ pa_xfree(g);
+ }
+ }
+
+ pa_xfree(group);
+ pa_xfree(module_name);
+
+ if (!filter->sink_master || !filter->source_master)
+ return false;
+ }
+
+ return true;
+}
+
+static bool nothing_attached(struct filter *f) {
+ bool no_si = true, no_so = true;
if (f->sink)
no_si = pa_idxset_isempty(f->sink->inputs);
- else if (f->source)
+ if (f->source)
no_so = pa_idxset_isempty(f->source->outputs);
return no_si && no_so;
idx = filter->module_index;
pa_hashmap_remove(u->filters, filter);
filter_free(filter);
- pa_module_unload_request_by_index(u->core, idx, TRUE);
+ pa_module_unload_request_by_index(u->core, idx, true);
}
}
u->housekeeping_time_event = pa_core_rttime_new(u->core, pa_rtclock_now() + HOUSEKEEPING_INTERVAL, housekeeping_time_callback, u);
}
-static int do_move(pa_object *obj, pa_object *parent, pa_bool_t restore, pa_bool_t is_input) {
+static int do_move(pa_object *obj, pa_object *parent, bool restore, bool is_input) {
if (is_input)
return pa_sink_input_move_to(PA_SINK_INPUT(obj), PA_SINK(parent), restore);
else
return pa_source_output_move_to(PA_SOURCE_OUTPUT(obj), PA_SOURCE(parent), restore);
}
-static void move_object_for_filter(pa_object *o, struct filter* filter, pa_bool_t restore, pa_bool_t is_sink_input) {
+static void move_object_for_filter(pa_object *o, struct filter* filter, bool restore, bool is_sink_input) {
pa_object *parent;
pa_proplist *pl;
const char *name;
if (is_sink_input) {
pl = PA_SINK_INPUT(o)->proplist;
- pa_assert_se(parent = PA_OBJECT(restore ? filter->sink_master : filter->sink));
+ parent = PA_OBJECT(restore ? filter->sink_master : filter->sink);
+ if (!parent)
+ return;
name = PA_SINK(parent)->name;
} else {
pl = PA_SOURCE_OUTPUT(o)->proplist;
- pa_assert_se(parent = PA_OBJECT(restore ? filter->source_master : filter->source));
+ parent = PA_OBJECT(restore ? filter->source_master : filter->source);
+ if (!parent)
+ return;
name = PA_SOURCE(parent)->name;
}
pa_proplist_sets(pl, PA_PROP_FILTER_APPLY_MOVING, "1");
- if (do_move(o, parent, FALSE, is_sink_input) < 0)
+ if (do_move(o, parent, false, is_sink_input) < 0)
pa_log_info("Failed to move %s for \"%s\" to <%s>.", is_sink_input ? "sink-input" : "source-output",
pa_strnull(pa_proplist_gets(pl, PA_PROP_APPLICATION_NAME)), name);
else
pa_proplist_unset(pl, PA_PROP_FILTER_APPLY_MOVING);
}
+static void move_objects_for_filter(struct userdata *u, pa_object *o, struct filter* filter, bool restore,
+ bool is_sink_input) {
+
+ if (!should_group_filter(filter))
+ move_object_for_filter(o, filter, restore, is_sink_input);
+ else {
+ pa_source_output *so;
+ pa_sink_input *si;
+ char *g, *group;
+ uint32_t idx;
+
+ group = get_group(o, is_sink_input);
+
+ PA_IDXSET_FOREACH(so, u->core->source_outputs, idx) {
+ g = get_group(PA_OBJECT(so), false);
+
+ if (pa_streq(g, group))
+ move_object_for_filter(PA_OBJECT(so), filter, restore, false);
+
+ pa_xfree(g);
+ }
+
+ PA_IDXSET_FOREACH(si, u->core->sink_inputs, idx) {
+ g = get_group(PA_OBJECT(si), true);
+
+ if (pa_streq(g, group))
+ move_object_for_filter(PA_OBJECT(si), filter, restore, true);
+
+ pa_xfree(g);
+ }
+
+ pa_xfree(group);
+ }
+}
+
+/* Note that we assume a filter will provide at most one sink and at most one
+ * source (and at least one of either). */
static void find_filters_for_module(struct userdata *u, pa_module *m, const char *name) {
uint32_t idx;
pa_sink *sink;
pa_source *source;
- struct filter *fltr;
+ struct filter *fltr = NULL;
PA_IDXSET_FOREACH(sink, u->core->sinks, idx) {
if (sink->module == m) {
fltr->module_index = m->index;
fltr->sink = sink;
- pa_hashmap_put(u->filters, fltr, fltr);
+ break;
}
}
if (source->module == m && !source->monitor_of) {
pa_assert(source->output_from_master != NULL);
- fltr = filter_new(name, NULL, source->output_from_master->source);
- fltr->module_index = m->index;
- fltr->source = source;
+ if (!fltr) {
+ fltr = filter_new(name, NULL, source->output_from_master->source);
+ fltr->module_index = m->index;
+ fltr->source = source;
+ } else {
+ fltr->source = source;
+ fltr->source_master = source->output_from_master->source;
+ }
- pa_hashmap_put(u->filters, fltr, fltr);
+ break;
}
}
+
+ pa_hashmap_put(u->filters, fltr, fltr);
}
-static pa_bool_t can_unload_module(struct userdata *u, uint32_t idx) {
+static bool can_unload_module(struct userdata *u, uint32_t idx) {
void *state;
struct filter *filter;
/* Check if any other struct filters point to the same module */
PA_HASHMAP_FOREACH(filter, u->filters, state) {
if (filter->module_index == idx && !nothing_attached(filter))
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
-static pa_hook_result_t process(struct userdata *u, pa_object *o, pa_bool_t is_sink_input) {
+static pa_hook_result_t process(struct userdata *u, pa_object *o, bool is_sink_input) {
const char *want;
- pa_bool_t done_something = FALSE;
+ bool done_something = false;
pa_sink *sink = NULL;
pa_source *source = NULL;
- const char *sink_name = NULL, *source_name = NULL;
- pa_module *module;
+ pa_module *module = NULL;
if (is_sink_input) {
sink = PA_SINK_INPUT(o)->sink;
- sink_name = sink->name;
- module = sink->module;
+
+ if (sink)
+ module = sink->module;
} else {
source = PA_SOURCE_OUTPUT(o)->source;
- source_name = source->name;
- module = source->module;
+
+ if (source)
+ module = source->module;
}
/* If there is no sink/source yet, we can't do much */
fltr = filter_new(want, sink, source);
+ if (should_group_filter(fltr) && !find_paired_master(u, fltr, o, is_sink_input)) {
+ pa_log_debug("Want group filtering but don't have enough streams.");
+ return PA_HOOK_OK;
+ }
+
if (!(filter = pa_hashmap_get(u->filters, fltr))) {
char *args;
pa_module *m;
- args = pa_sprintf_malloc("autoloaded=1 %s_master=%s", is_sink_input ? "sink" : "source",
- is_sink_input ? sink_name : source_name);
+ args = pa_sprintf_malloc("autoloaded=1 %s%s %s%s",
+ fltr->sink_master ? "sink_master=" : "",
+ fltr->sink_master ? fltr->sink_master->name : "",
+ fltr->source_master ? "source_master=" : "",
+ fltr->source_master ? fltr->source_master->name : "");
+
pa_log_debug("Loading %s with arguments '%s'", module_name, args);
if ((m = pa_module_load(u->core, module_name, args))) {
find_filters_for_module(u, m, want);
filter = pa_hashmap_get(u->filters, fltr);
- done_something = TRUE;
+ done_something = true;
}
pa_xfree(args);
}
pa_xfree(fltr);
if (!filter) {
- pa_log("Unable to load %s for <%s>", module_name, is_sink_input ? sink_name : source_name);
+ pa_log("Unable to load %s", module_name);
pa_xfree(module_name);
return PA_HOOK_OK;
}
/* We can move the stream now as we know the destination. If this
* isn't true, we will do it later when the sink appears. */
if ((is_sink_input && filter->sink) || (!is_sink_input && filter->source)) {
- move_object_for_filter(o, filter, FALSE, is_sink_input);
- done_something = TRUE;
+ move_objects_for_filter(u, o, filter, false, is_sink_input);
+ done_something = true;
}
} else {
void *state;
* This can happen if an input's proplist changes */
PA_HASHMAP_FOREACH(filter, u->filters, state) {
if ((is_sink_input && sink == filter->sink) || (!is_sink_input && source == filter->source)) {
- move_object_for_filter(o, filter, TRUE, is_sink_input);
- done_something = TRUE;
+ move_objects_for_filter(u, o, filter, true, is_sink_input);
+ done_something = true;
break;
}
}
pa_core_assert_ref(core);
pa_sink_input_assert_ref(i);
- return process(u, PA_OBJECT(i), TRUE);
+ return process(u, PA_OBJECT(i), true);
}
static pa_hook_result_t sink_input_move_finish_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
if (pa_proplist_gets(i->proplist, PA_PROP_FILTER_APPLY_MOVING))
return PA_HOOK_OK;
- return process(u, PA_OBJECT(i), TRUE);
+ return process(u, PA_OBJECT(i), true);
}
static pa_hook_result_t sink_input_proplist_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, PA_OBJECT(i), TRUE);
+ return process(u, PA_OBJECT(i), true);
}
static pa_hook_result_t sink_input_unlink_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
pa_sink_input *i;
PA_IDXSET_FOREACH(i, sink->inputs, idx)
- move_object_for_filter(PA_OBJECT(i), filter, TRUE, TRUE);
+ move_objects_for_filter(u, PA_OBJECT(i), filter, true, true);
}
idx = filter->module_index;
filter_free(filter);
if (can_unload_module(u, idx))
- pa_module_unload_request_by_index(u->core, idx, TRUE);
+ pa_module_unload_request_by_index(u->core, idx, true);
}
}
pa_core_assert_ref(core);
pa_source_output_assert_ref(o);
- return process(u, PA_OBJECT(o), FALSE);
+ return process(u, PA_OBJECT(o), false);
}
static pa_hook_result_t source_output_move_finish_cb(pa_core *core, pa_source_output *o, struct userdata *u) {
if (pa_proplist_gets(o->proplist, PA_PROP_FILTER_APPLY_MOVING))
return PA_HOOK_OK;
- return process(u, PA_OBJECT(o), FALSE);
+ return process(u, PA_OBJECT(o), false);
}
static pa_hook_result_t source_output_proplist_cb(pa_core *core, pa_source_output *o, struct userdata *u) {
pa_core_assert_ref(core);
pa_source_output_assert_ref(o);
- return process(u, PA_OBJECT(o), FALSE);
+ return process(u, PA_OBJECT(o), false);
}
static pa_hook_result_t source_output_unlink_cb(pa_core *core, pa_source_output *o, struct userdata *u) {
pa_source_output *o;
PA_IDXSET_FOREACH(o, source->outputs, idx)
- move_object_for_filter(PA_OBJECT(o), filter, TRUE, FALSE);
+ move_objects_for_filter(u, PA_OBJECT(o), filter, true, false);
}
idx = filter->module_index;
filter_free(filter);
if (can_unload_module(u, idx))
- pa_module_unload_request_by_index(u->core, idx, TRUE);
+ pa_module_unload_request_by_index(u->core, idx, true);
}
}
struct filter *f;
while ((f = pa_hashmap_steal_first(u->filters))) {
- pa_module_unload_request_by_index(u->core, f->module_index, TRUE);
+ pa_module_unload_request_by_index(u->core, f->module_index, true);
filter_free(f);
}
- pa_hashmap_free(u->filters, NULL, NULL);
+ pa_hashmap_free(u->filters);
}
pa_xfree(u);