filter-apply: support group of filters

Currently, filter-apply manages filters using name of filter module and master sink.
Even if a filter able to load various plugins, it cannot run as multiple instances.
New 'group' of filter will provide to run multiple instances in this case.

For example,
a filter group 'group1' of module-ladspa-sink has opened 'ladspa1' plugin.
Other group 'group2' able to open 'ladspa2' plugin in same time.
e.g) paplay file1.wav --property=filter.apply=ladspa-sink \
                      --property=filter.apply.extra.group=group1 \
                      --property=filter.apply.extra.parameters="plugin=ladspa1 label=stereo control=0"
     paplay file2.wav --property=filter.apply=ladspa-sink \
                      --property=filter.apply.extra.group=group2 \
                      --property=filter.apply.extra.parameters="plugin=ladspa2 label=stereo control=0"

Changes in v1:
    * add group of filters.

Changes in v2:
    * Use pa_safe_streq() instead of strcmp().
    * Fix typos.

Changes in v3:
    * To clarify meaning, rename should_group_filter() to is_duplex_filter().
    * Remove unnecessary 'extra' word from module-filter-apply.c.

[Version] 5.0.115
[Profile] Common
[Issue Type] New Feature

Signed-off-by: KimJeongYeon <jeongyeon.kim@samsung.com>
Change-Id: I6730e4070e0d296db1e879cb18ba2e5a63c67a18

diff --git a/packaging/pulseaudio.spec b/packaging/pulseaudio.spec
index 6e2bc56..17b9970 100644 (file)
--- a/packaging/pulseaudio.spec
+++ b/packaging/pulseaudio.spec
@@ -12,7 +12,7 @@
 Name:             pulseaudio
 Summary:          Improved Linux sound server
 Version:          5.0
-Release:          114
+Release:          115
 Group:            Multimedia/Audio
 License:          LGPL-2.1
 URL:              http://pulseaudio.org

diff --git a/src/modules/module-filter-apply.c b/src/modules/module-filter-apply.c
index 6412e2e..55019b2 100644 (file)
--- a/src/modules/module-filter-apply.c
+++ b/src/modules/module-filter-apply.c
@@ -57,6 +57,7 @@ static const char* const valid_modargs[] = {
 
 struct filter {
     char *name;
+    char *group;
     uint32_t module_index;
     pa_sink *sink;
     pa_sink *sink_master;
@@ -95,23 +96,24 @@ static unsigned filter_hash(const void *p) {
 
 static int filter_compare(const void *a, const void *b) {
     const struct filter *fa = a, *fb = b;
-    int r;
 
     if (fa->sink_master != fb->sink_master || fa->source_master != fb->source_master)
         return 1;
-    if ((r = strcmp(fa->name, fb->name)))
-        return r;
-
+    if (!pa_safe_streq(fa->name, fb->name))
+        return 1;
+    if (!pa_safe_streq(fa->group, fb->group))
+        return 1;
     return 0;
 }
 
-static struct filter *filter_new(const char *name, pa_sink *sink, pa_source *source) {
+static struct filter *filter_new(const char *name, const char *group, pa_sink *sink, pa_source *source) {
     struct filter *f;
 
     pa_assert(sink || source);
 
     f = pa_xnew(struct filter, 1);
     f->name = pa_xstrdup(name);
+    f->group = pa_xstrdup(group);
     f->sink_master = sink;
     f->source_master = source;
     f->module_index = PA_INVALID_INDEX;
@@ -125,6 +127,7 @@ static void filter_free(struct filter *f) {
     pa_assert(f);
 
     pa_xfree(f->name);
+    pa_xfree(f->group);
     pa_xfree(f);
 }
 
@@ -148,9 +151,8 @@ static const char* should_filter(pa_object *o, bool is_sink_input) {
     return NULL;
 }
 
-#ifdef __TIZEN__
-static const char* should_filter_extra_parameters(pa_object *o, bool is_sink_input) {
-    const char *extra_parameters;
+static const char* should_filter_parameters(pa_object *o, bool is_sink_input) {
+    const char *parameters;
     pa_proplist *pl;
 
     if (is_sink_input)
@@ -158,15 +160,30 @@ static const char* should_filter_extra_parameters(pa_object *o, bool is_sink_inp
     else
         pl = PA_SOURCE_OUTPUT(o)->proplist;
 
-    /* If the stream need extra parameters, append them to module. */
-    if ((extra_parameters = pa_proplist_gets(pl, PA_PROP_FILTER_APPLY_EXTRA_PARAMETERS)) && !pa_streq(extra_parameters, ""))
-        return extra_parameters;
+    /* If the stream needs parameters, append them to module. */
+    if ((parameters = pa_proplist_gets(pl, PA_PROP_FILTER_APPLY_EXTRA_PARAMETERS)) && !pa_streq(parameters, ""))
+        return parameters;
 
     return NULL;
 }
-#endif
 
-static bool should_group_filter(struct filter *filter) {
+static const char* should_filter_group(pa_object *o, bool is_sink_input) {
+    const char *group;
+    pa_proplist *pl;
+
+    if (is_sink_input)
+        pl = PA_SINK_INPUT(o)->proplist;
+    else
+        pl = PA_SOURCE_OUTPUT(o)->proplist;
+
+    /* If the stream needs group of filters, allow multiple instances. */
+    if ((group = pa_proplist_gets(pl, PA_PROP_FILTER_APPLY_EXTRA_GROUP)) && !pa_streq(group, ""))
+        return group;
+
+    return NULL;
+}
+
+static bool is_duplex_filter(struct filter *filter) {
     return pa_streq(filter->name, "echo-cancel");
 }
 
@@ -278,7 +295,8 @@ static void housekeeping_time_callback(pa_mainloop_api*a, pa_time_event* e, cons
         if (nothing_attached(filter)) {
             uint32_t idx;
 
-            pa_log_debug("Detected filter %s as no longer used. Unloading.", filter->name);
+            pa_log_debug("Detected filter %s(%s) as no longer used. Unloading.", filter->name,
+                         filter->group ? filter->group : "no group");
             idx = filter->module_index;
             pa_hashmap_remove(u->filters, filter);
             filter_free(filter);
@@ -345,7 +363,7 @@ static void move_object_for_filter(pa_object *o, struct filter* filter, bool res
 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))
+    if (!is_duplex_filter(filter))
         move_object_for_filter(o, filter, restore, is_sink_input);
     else {
         pa_source_output *so;
@@ -379,7 +397,7 @@ static void move_objects_for_filter(struct userdata *u, pa_object *o, struct fil
 
 /* 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) {
+static void find_filters_for_module(struct userdata *u, pa_module *m, const char *name, const char *group) {
     uint32_t idx;
     pa_sink *sink;
     pa_source *source;
@@ -389,7 +407,7 @@ static void find_filters_for_module(struct userdata *u, pa_module *m, const char
         if (sink->module == m) {
             pa_assert(sink->input_to_master != NULL);
 
-            fltr = filter_new(name, sink->input_to_master->sink, NULL);
+            fltr = filter_new(name, group, sink->input_to_master->sink, NULL);
             fltr->module_index = m->index;
             fltr->sink = sink;
 
@@ -402,7 +420,7 @@ static void find_filters_for_module(struct userdata *u, pa_module *m, const char
             pa_assert(source->output_from_master != NULL);
 
             if (!fltr) {
-                fltr = filter_new(name, NULL, source->output_from_master->source);
+                fltr = filter_new(name, group, NULL, source->output_from_master->source);
                 fltr->module_index = m->index;
                 fltr->source = source;
             } else {
@@ -432,9 +450,6 @@ static bool can_unload_module(struct userdata *u, uint32_t idx) {
 
 static pa_hook_result_t process(struct userdata *u, pa_object *o, bool is_sink_input) {
     const char *want;
-#ifdef __TIZEN__
-    const char *extra_parameters;
-#endif
     bool done_something = false;
     pa_sink *sink = NULL;
     pa_source *source = NULL;
@@ -460,6 +475,8 @@ static pa_hook_result_t process(struct userdata *u, pa_object *o, bool is_sink_i
     if ((want = should_filter(o, is_sink_input))) {
         char *module_name;
         struct filter *fltr, *filter;
+        const char *parameters;
+        const char *group;
 
         /* We need to ensure the SI is playing on a sink of this type
          * attached to the sink it's "officially" playing on */
@@ -474,9 +491,16 @@ static pa_hook_result_t process(struct userdata *u, pa_object *o, bool is_sink_i
             return PA_HOOK_OK;
         }
 
-        fltr = filter_new(want, sink, source);
+        /* Some filter modules might require parameters by default.
+         * (e.g. 'plugin', 'label', 'control' of module-ladspa-sink) */
+        parameters = should_filter_parameters(o, is_sink_input);
+
+        /* Some applications may want group of filters. (optional) */
+        group = should_filter_group(o, is_sink_input);
 
-        if (should_group_filter(fltr) && !find_paired_master(u, fltr, o, is_sink_input)) {
+        fltr = filter_new(want, group, sink, source);
+
+        if (is_duplex_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;
         }
@@ -485,29 +509,17 @@ static pa_hook_result_t process(struct userdata *u, pa_object *o, bool is_sink_i
             char *args;
             pa_module *m;
 
-#ifdef __TIZEN__
-            /* Some filter modules might be required extra parameters by default.
-             * (e.g 'plugin', 'label', 'control' of module-ladspa-sink) */
-            extra_parameters = should_filter_extra_parameters(o, is_sink_input);
-
             args = pa_sprintf_malloc("autoloaded=1 %s%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 : "",
-                    extra_parameters ? extra_parameters : "");
-#else
-            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 : "");
-#endif
+                    parameters ? parameters : "");
 
             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);
+                find_filters_for_module(u, m, want, group);
                 filter = pa_hashmap_get(u->filters, fltr);
                 done_something = true;
             }

diff --git a/src/pulse/proplist.h b/src/pulse/proplist.h
index 0dac82f..5240485 100644 (file)
--- a/src/pulse/proplist.h
+++ b/src/pulse/proplist.h
@@ -71,12 +71,13 @@ PA_C_DECL_BEGIN
 /** For streams: the name of a filter that is desired, e.g.\ "echo-cancel" or "equalizer-sink". Differs from PA_PROP_FILTER_WANT in that it forces PulseAudio to apply the filter, regardless of whether PulseAudio thinks it makes sense to do so or not. If this is set, PA_PROP_FILTER_WANT is ignored. In other words, you almost certainly do not want to use this. \since 1.0 */
 #define PA_PROP_FILTER_APPLY                   "filter.apply"
 
-#ifdef __TIZEN__
-/** For streams: some module required extra parameters, e.g.\ "plugin=ladspa label=ladspa_stereo control=0" in case of "ladspa-sink" filter */
+/** For streams: some modules require extra parameters, e.g.\ "plugin=ladspa label=ladspa_stereo control=0" in case of "ladspa-sink" filter */
 #define PA_PROP_FILTER_APPLY_EXTRA_PARAMETERS  "filter.apply.extra.parameters"
-#endif
 
-/** For streams: the name of a filter that should specifically suppressed (i.e.\ overrides PA_PROP_FILTER_WANT). Useful for the times that PA_PROP_FILTER_WANT is automatically added (e.g. echo-cancellation for phone streams when $VOIP_APP does it's own, internal AEC) \since 1.0 */
+/** For streams: some applications may want to classify sub filter groups and they can be used as multiple instances. (e.g. load multiple plugin instances of "ladspa-sink" filter) */
+#define PA_PROP_FILTER_APPLY_EXTRA_GROUP       "filter.apply.extra.group"
+
+/** For streams: the name of a filter that should specifically be suppressed (i.e.\ overrides PA_PROP_FILTER_WANT). Useful for the times that PA_PROP_FILTER_WANT is automatically added (e.g. echo-cancellation for phone streams when $VOIP_APP does it's own, internal AEC) \since 1.0 */
 #define PA_PROP_FILTER_SUPPRESS                "filter.suppress"
 
 #ifdef __TIZEN__