Bug 96804 - No documentation for module-filter-heuristics and module-filter-apply
Summary: No documentation for module-filter-heuristics and module-filter-apply
Alias: None
Product: PulseAudio
Classification: Unclassified
Component: modules (show other bugs)
Version: unspecified
Hardware: Other All
: medium minor
Assignee: pulseaudio-bugs
QA Contact: pulseaudio-bugs
Depends on:
Reported: 2016-07-04 14:43 UTC by wavexx
Modified: 2018-03-11 18:02 UTC (History)
2 users (show)

See Also:
i915 platform:
i915 features:


Description wavexx 2016-07-04 14:43:00 UTC
This is the only documentation about `module-filter-heuristics` and `module-filter-apply`:

### Modules to allow autoloading of filters (such as echo cancellation)
### on demand. module-filter-heuristics tries to determine what filters
### make sense, and module-filter-apply does the heavy-lifting of
### loading modules and rerouting streams.

By reading these lines, I still have no idea what these filters actually do, and why both are required to operate.

That's not enough for me, I want to know /exactly/ what these filters do. I can read the code, but I shouldn't have to. If you look online, the first thing everybody suggests is to disable these modules as nobody knows what they are supposed to do and in which conditions.

Please document the exact behavior.
Comment 1 Rudd-O 2016-09-19 18:19:46 UTC
Seconded.  Please.
Comment 2 Tanu Kaskinen 2018-03-11 18:02:22 UTC
Nandor Han sent a documentation patch that I applied, see

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.