2 This file is part of PulseAudio.
4 Copyright 2011 Colin Guthrie
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
26 #include <pulse/timeval.h>
27 #include <pulse/rtclock.h>
29 #include <pulsecore/macro.h>
30 #include <pulsecore/hashmap.h>
31 #include <pulsecore/hook-list.h>
32 #include <pulsecore/core.h>
33 #include <pulsecore/core-util.h>
34 #include <pulsecore/sink-input.h>
35 #include <pulsecore/modargs.h>
37 #include "module-filter-apply-symdef.h"
40 PA_MODULE_AUTHOR("Colin Guthrie");
41 PA_MODULE_DESCRIPTION("Load filter sinks automatically when needed");
42 PA_MODULE_VERSION(PACKAGE_VERSION);
43 PA_MODULE_LOAD_ONCE(TRUE);
45 static const char* const valid_modargs[] = {
49 #define HOUSEKEEPING_INTERVAL (10 * PA_USEC_PER_SEC)
54 uint32_t module_index;
63 *sink_input_proplist_slot,
64 *sink_input_unlink_slot,
66 pa_time_event *housekeeping_time_event;
69 static unsigned filter_hash(const void *p) {
70 const struct filter *f = p;
73 (unsigned) f->parent_sink->index +
74 pa_idxset_string_hash_func(f->name);
77 static int filter_compare(const void *a, const void *b) {
78 const struct filter *fa = a, *fb = b;
81 if (fa->parent_sink != fb->parent_sink)
83 if ((r = strcmp(fa->name, fb->name)))
89 static struct filter *filter_new(const char *name, pa_sink* parent_sink) {
92 f = pa_xnew(struct filter, 1);
93 f->name = pa_xstrdup(name);
94 pa_assert_se(f->parent_sink = parent_sink);
95 f->module_index = PA_INVALID_INDEX;
100 static void filter_free(struct filter *f) {
107 static const char* should_filter(pa_sink_input *i) {
110 /* If the stream doesn't what any filter, then let it be. */
111 if ((want = pa_proplist_gets(i->proplist, PA_PROP_FILTER_WANT)) && !pa_streq(want, "")) {
112 const char* suppress = pa_proplist_gets(i->proplist, PA_PROP_FILTER_SUPPRESS);
114 if (!suppress || !pa_streq(suppress, want))
121 static void housekeeping_time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *t, void *userdata) {
122 struct userdata *u = userdata;
123 struct filter *filter;
130 pa_assert(e == u->housekeeping_time_event);
131 u->core->mainloop->time_free(u->housekeeping_time_event);
132 u->housekeeping_time_event = NULL;
134 PA_HASHMAP_FOREACH(filter, u->filters, state) {
135 if (filter->sink && pa_idxset_size(filter->sink->inputs) == 0) {
138 pa_log_debug("Detected filter %s as no longer used on sink %s. Unloading.", filter->name, filter->sink->name);
139 idx = filter->module_index;
140 pa_hashmap_remove(u->filters, filter);
142 pa_module_unload_request_by_index(u->core, idx, TRUE);
146 pa_log_info("Housekeeping Done.");
149 static void trigger_housekeeping(struct userdata *u) {
152 if (u->housekeeping_time_event)
155 u->housekeeping_time_event = pa_core_rttime_new(u->core, pa_rtclock_now() + HOUSEKEEPING_INTERVAL, housekeeping_time_callback, u);
158 static void move_input_for_filter(pa_sink_input *i, struct filter* filter, pa_bool_t restore) {
164 pa_assert_se(sink = (restore ? filter->parent_sink : filter->sink));
166 if (pa_sink_input_move_to(i, sink, FALSE) < 0)
167 pa_log_info("Failed to move sink input %u \"%s\" to <%s>.", i->index,
168 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_APPLICATION_NAME)), sink->name);
170 pa_log_info("Sucessfully moved sink input %u \"%s\" to <%s>.", i->index,
171 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_APPLICATION_NAME)), sink->name);
174 static pa_hook_result_t process(struct userdata *u, pa_sink_input *i) {
176 pa_bool_t done_something = FALSE;
179 pa_sink_input_assert_ref(i);
181 /* If there is no sink yet, we can't do much */
185 /* If the stream doesn't what any filter, then let it be. */
186 if ((want = should_filter(i))) {
188 struct filter *fltr, *filter;
190 /* We need to ensure the SI is playing on a sink of this type
191 * attached to the sink it's "officially" playing on */
193 if (!i->sink->module)
196 module_name = pa_sprintf_malloc("module-%s", want);
197 if (pa_streq(i->sink->module->name, module_name)) {
198 pa_log_debug("Stream appears to be playing on an appropriate sink already. Ignoring.");
199 pa_xfree(module_name);
203 fltr = filter_new(want, i->sink);
205 if (!(filter = pa_hashmap_get(u->filters, fltr))) {
209 args = pa_sprintf_malloc("sink_master=%s", i->sink->name);
210 pa_log_debug("Loading %s with arguments '%s'", module_name, args);
212 if ((m = pa_module_load(u->core, module_name, args))) {
216 fltr->module_index = m->index;
217 /* We cannot use the SINK_PUT hook here to detect our sink as it'll
218 * be called during the module load so we wont yet have put the filter
219 * in our hashmap to compare... so we have to search for it */
220 PA_IDXSET_FOREACH(sink, u->core->sinks, idx) {
221 if (sink->module == m) {
226 pa_hashmap_put(u->filters, fltr, fltr);
229 done_something = TRUE;
236 pa_log("Unable to load %s for sink <%s>", module_name, i->sink->name);
237 pa_xfree(module_name);
240 pa_xfree(module_name);
243 /* We can move the sink_input now as the know the destination.
244 * If this isn't true, we will do it later when the sink appears. */
245 move_input_for_filter(i, filter, FALSE);
246 done_something = TRUE;
250 struct filter *filter = NULL;
252 /* We do not want to filter... but are we already filtered?
253 * This can happen if an input's proplist changes */
254 PA_HASHMAP_FOREACH(filter, u->filters, state) {
255 if (i->sink == filter->sink) {
256 move_input_for_filter(i, filter, TRUE);
257 done_something = TRUE;
264 trigger_housekeeping(u);
269 static pa_hook_result_t sink_input_put_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
270 pa_core_assert_ref(core);
271 pa_sink_input_assert_ref(i);
273 return process(u, i);
276 static pa_hook_result_t sink_input_proplist_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
277 pa_core_assert_ref(core);
278 pa_sink_input_assert_ref(i);
280 return process(u, i);
283 static pa_hook_result_t sink_input_unlink_cb(pa_core *core, pa_sink_input *i, struct userdata *u) {
284 pa_core_assert_ref(core);
285 pa_sink_input_assert_ref(i);
289 if (pa_hashmap_size(u->filters) > 0)
290 trigger_housekeeping(u);
295 static pa_hook_result_t sink_unlink_cb(pa_core *core, pa_sink *sink, struct userdata *u) {
297 struct filter *filter = NULL;
299 pa_core_assert_ref(core);
300 pa_sink_assert_ref(sink);
303 /* If either the parent or the sink we've loaded disappears,
304 * we should remove it from our hashmap */
305 PA_HASHMAP_FOREACH(filter, u->filters, state) {
306 if (filter->parent_sink == sink || filter->sink == sink) {
309 /* Attempt to rescue any streams to the parent sink as this is likely
310 * the best course of action (as opposed to a generic rescue via
311 * module-rescue-streams */
312 if (filter->sink == sink) {
315 PA_IDXSET_FOREACH(i, sink->inputs, idx)
316 move_input_for_filter(i, filter, TRUE);
319 idx = filter->module_index;
320 pa_hashmap_remove(u->filters, filter);
322 pa_module_unload_request_by_index(u->core, idx, TRUE);
330 int pa__init(pa_module *m) {
331 pa_modargs *ma = NULL;
336 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
337 pa_log("Failed to parse module arguments");
341 m->userdata = u = pa_xnew0(struct userdata, 1);
345 u->filters = pa_hashmap_new(filter_hash, filter_compare);
347 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);
348 u->sink_input_proplist_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], PA_HOOK_LATE, (pa_hook_cb_t) sink_input_proplist_cb, u);
349 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);
350 u->sink_unlink_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_UNLINK], PA_HOOK_LATE, (pa_hook_cb_t) sink_unlink_cb, u);
365 void pa__done(pa_module *m) {
370 if (!(u = m->userdata))
373 if (u->sink_input_put_slot)
374 pa_hook_slot_free(u->sink_input_put_slot);
375 if (u->sink_input_proplist_slot)
376 pa_hook_slot_free(u->sink_input_proplist_slot);
377 if (u->sink_input_unlink_slot)
378 pa_hook_slot_free(u->sink_input_unlink_slot);
379 if (u->sink_unlink_slot)
380 pa_hook_slot_free(u->sink_unlink_slot);
382 if (u->housekeeping_time_event)
383 u->core->mainloop->time_free(u->housekeeping_time_event);
388 while ((f = pa_hashmap_steal_first(u->filters))) {
389 pa_module_unload_request_by_index(u->core, f->module_index, TRUE);
393 pa_hashmap_free(u->filters, NULL, NULL);