filter: Move the proplist defines into the central place and document them.

diff --git a/src/modules/module-filter-apply.c b/src/modules/module-filter-apply.c
index d4bded506d0a5e4b51a8cebc8eae9a1a25b36d6f..c29e74d293ae80fc5250c1ffb6709f7d260e343a 100644 (file)
--- a/src/modules/module-filter-apply.c
+++ b/src/modules/module-filter-apply.c
@@ -36,9 +36,6 @@
 
 #include "module-filter-apply-symdef.h"
 
-#define PA_PROP_FILTER_WANT "filter.want"
-#define PA_PROP_FILTER_SUPPRESS "filter.suppress"
-
 
 PA_MODULE_AUTHOR("Colin Guthrie");
 PA_MODULE_DESCRIPTION("Load filter sinks automatically when needed");

diff --git a/src/modules/module-filter-heuristics.c b/src/modules/module-filter-heuristics.c
index fb01f85a19009aa867586e3a7c8aa09d37b5affb..bd8a60032ef769a7aa8329f9efd95be96e18d2dd 100644 (file)
--- a/src/modules/module-filter-heuristics.c
+++ b/src/modules/module-filter-heuristics.c
@@ -33,9 +33,6 @@
 
 #include "module-filter-heuristics-symdef.h"
 
-#define PA_PROP_FILTER_WANT "filter.want"
-#define PA_PROP_FILTER_SUPPRESS "filter.suppress"
-
 
 PA_MODULE_AUTHOR("Colin Guthrie");
 PA_MODULE_DESCRIPTION("Detect when various filters are desirable");

diff --git a/src/pulse/proplist.h b/src/pulse/proplist.h
index 5db3ada51d3950269ebd9c6b5af6111415918c44..4670d61c963513b216cd1ed270f0919380ddb998 100644 (file)
--- a/src/pulse/proplist.h
+++ b/src/pulse/proplist.h
@@ -62,6 +62,12 @@ PA_C_DECL_BEGIN
 /** For streams: logic role of this media. One of the strings "video", "music", "game", "event", "phone", "animation", "production", "a11y", "test" */
 #define PA_PROP_MEDIA_ROLE                     "media.role"
 
+/** For streams: the name of a filter that is desired, e.g. "echo-cancel" or "equalizer-sink" \since 1.0 */
+#define PA_PROP_FILTER_WANT "filter.want"
+
+/** 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 */
+#define PA_PROP_FILTER_SUPPRESS "filter.suppress"
+
 /** For event sound streams: XDG event sound name. e.g. "message-new-email" (Event sound streams are those with media.role set to "event") */
 #define PA_PROP_EVENT_ID                       "event.id"