mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-10 13:29:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pulseaudio/src/modules/echo-cancel/speex.c

228 lines
7.9 KiB
C
Raw Normal View History

echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
/***
This file is part of PulseAudio.
Copyright 2010 Wim Taymans <wim.taymans@gmail.com>
Contributor: Arun Raghavan <arun.raghavan@collabora.co.uk>
PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License,
or (at your option) any later version.
PulseAudio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with PulseAudio; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA.
***/
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
#include <pulsecore/core-util.h>
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
#include <pulsecore/modargs.h>
echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
#include "echo-cancel.h"
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
/* should be between 10-20 ms */
#define DEFAULT_FRAME_SIZE_MS 20
/* should be between 100-500 ms */
#define DEFAULT_FILTER_SIZE_MS 200
Remove pa_bool_t and replace it with bool. commands used for this (executed from the pulseaudio/src directory): find . -regex '\(.*\.[hc]\|.*\.cc\|.*\.m4\)' -not -name 'macro.h' \ -a -not -name 'reserve.[ch]' -a -not -name 'reserve-monitor.[ch]' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'poll-win32.c' -a -not -name 'thread-win32.c' \ -a -not -name 'dllmain.c' -a -not -name 'gconf-helper.c' \ -exec sed -i -e 's/\bpa_bool_t\b/bool/g' \ -e 's/\bTRUE\b/true/g' -e 's/\bFALSE\b/false/g' {} \; and: sed -i -e '181,194!s/\bpa_bool_t\b/bool/' \ -e '181,194!s/\bTRUE\b/true/' -e \ '181,194!s/\bFALSE\b/false/' pulsecore/macro.h
2013-06-27 19:28:09 +02:00
#define DEFAULT_AGC_ENABLED true
#define DEFAULT_DENOISE_ENABLED true
#define DEFAULT_ECHO_SUPPRESS_ENABLED true
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
#define DEFAULT_ECHO_SUPPRESS_ATTENUATION 0
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
static const char* const valid_modargs[] = {
"frame_size_ms",
"filter_size_ms",
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
"agc",
"denoise",
"echo_suppress",
"echo_suppress_attenuation",
"echo_suppress_attenuation_active",
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
NULL
};
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
static void pa_speex_ec_fixate_spec(pa_sample_spec *rec_ss, pa_channel_map *rec_map,
pa_sample_spec *play_ss, pa_channel_map *play_map,
Style fix: Remove new lines from opening brackets This patch replaces every occurrence of ')\n{' with ') {'. Command used for this: find . -type d \( -name ffmpeg \) -prune -o \ -regex '\(.*\.[hc]\|.*\.cc\)' \ -a -not -name core-util.c -a -not \ -name adrian-aec.c -a -not -name g711.c \ -exec sed -i -e '/)$/{N;s/)\n{$/) {/}' {} \; The excluded files are mirrored files from external sources.
2013-06-18 22:24:24 +02:00
pa_sample_spec *out_ss, pa_channel_map *out_map) {
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
out_ss->format = PA_SAMPLE_S16NE;
echo-cancel: Let AEC module determine source/sink spec Since the source and sink specification will need to be determined by the AEC algorithm (can it handle multi-channel audio, does it work with a fixed sample rate, etc.), we negotiate these using inout parameters at initialisation time. There is opportunity to make the sink-handling more elegant. Since the sink data isn't used for playback (just processing), we could pass through the data as-is and resample to the required spec before using in the cancellation algorithm. This isn't too important immediately, but would be nice to have.
2010-09-06 22:23:51 +05:30
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
*play_ss = *out_ss;
*play_map = *out_map;
*rec_ss = *out_ss;
*rec_map = *out_map;
echo-cancel: Let AEC module determine source/sink spec Since the source and sink specification will need to be determined by the AEC algorithm (can it handle multi-channel audio, does it work with a fixed sample rate, etc.), we negotiate these using inout parameters at initialisation time. There is opportunity to make the sink-handling more elegant. Since the sink data isn't used for playback (just processing), we could pass through the data as-is and resample to the required spec before using in the cancellation algorithm. This isn't too important immediately, but would be nice to have.
2010-09-06 22:23:51 +05:30
}
Remove pa_bool_t and replace it with bool. commands used for this (executed from the pulseaudio/src directory): find . -regex '\(.*\.[hc]\|.*\.cc\|.*\.m4\)' -not -name 'macro.h' \ -a -not -name 'reserve.[ch]' -a -not -name 'reserve-monitor.[ch]' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'poll-win32.c' -a -not -name 'thread-win32.c' \ -a -not -name 'dllmain.c' -a -not -name 'gconf-helper.c' \ -exec sed -i -e 's/\bpa_bool_t\b/bool/g' \ -e 's/\bTRUE\b/true/g' -e 's/\bFALSE\b/false/g' {} \; and: sed -i -e '181,194!s/\bpa_bool_t\b/bool/' \ -e '181,194!s/\bTRUE\b/true/' -e \ '181,194!s/\bFALSE\b/false/' pulsecore/macro.h
2013-06-27 19:28:09 +02:00
static bool pa_speex_ec_preprocessor_init(pa_echo_canceller *ec, pa_sample_spec *out_ss, uint32_t nframes, pa_modargs *ma) {
bool agc;
bool denoise;
bool echo_suppress;
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
int32_t echo_suppress_attenuation;
int32_t echo_suppress_attenuation_active;
agc = DEFAULT_AGC_ENABLED;
if (pa_modargs_get_value_boolean(ma, "agc", &agc) < 0) {
pa_log("Failed to parse agc value");
goto fail;
}
denoise = DEFAULT_DENOISE_ENABLED;
if (pa_modargs_get_value_boolean(ma, "denoise", &denoise) < 0) {
pa_log("Failed to parse denoise value");
goto fail;
}
echo_suppress = DEFAULT_ECHO_SUPPRESS_ENABLED;
if (pa_modargs_get_value_boolean(ma, "echo_suppress", &echo_suppress) < 0) {
pa_log("Failed to parse echo_suppress value");
goto fail;
}
echo_suppress_attenuation = DEFAULT_ECHO_SUPPRESS_ATTENUATION;
if (pa_modargs_get_value_s32(ma, "echo_suppress_attenuation", &echo_suppress_attenuation) < 0) {
pa_log("Failed to parse echo_suppress_attenuation value");
goto fail;
}
if (echo_suppress_attenuation > 0) {
pa_log("echo_suppress_attenuation should be a negative dB value");
goto fail;
}
echo_suppress_attenuation_active = DEFAULT_ECHO_SUPPRESS_ATTENUATION;
if (pa_modargs_get_value_s32(ma, "echo_suppress_attenuation_active", &echo_suppress_attenuation_active) < 0) {
pa_log("Failed to parse echo_suppress_attenuation_active value");
goto fail;
}
if (echo_suppress_attenuation_active > 0) {
pa_log("echo_suppress_attenuation_active should be a negative dB value");
goto fail;
}
if (agc || denoise || echo_suppress) {
spx_int32_t tmp;
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
if (out_ss->channels != 1) {
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
pa_log("AGC, denoising and echo suppression only work with channels=1");
goto fail;
}
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
ec->params.priv.speex.pp_state = speex_preprocess_state_init(nframes, out_ss->rate);
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
tmp = agc;
speex_preprocess_ctl(ec->params.priv.speex.pp_state, SPEEX_PREPROCESS_SET_AGC, &tmp);
tmp = denoise;
speex_preprocess_ctl(ec->params.priv.speex.pp_state, SPEEX_PREPROCESS_SET_DENOISE, &tmp);
if (echo_suppress) {
if (echo_suppress_attenuation)
speex_preprocess_ctl(ec->params.priv.speex.pp_state, SPEEX_PREPROCESS_SET_ECHO_SUPPRESS,
&echo_suppress_attenuation);
if (echo_suppress_attenuation_active) {
speex_preprocess_ctl(ec->params.priv.speex.pp_state, SPEEX_PREPROCESS_SET_ECHO_SUPPRESS_ACTIVE,
&echo_suppress_attenuation_active);
}
speex_preprocess_ctl(ec->params.priv.speex.pp_state, SPEEX_PREPROCESS_SET_ECHO_STATE,
ec->params.priv.speex.state);
}
pa_log_info("Loaded speex preprocessor with params: agc=%s, denoise=%s, echo_suppress=%s", pa_yes_no(agc),
pa_yes_no(denoise), pa_yes_no(echo_suppress));
} else
pa_log_info("All preprocessing options are disabled");
Remove pa_bool_t and replace it with bool. commands used for this (executed from the pulseaudio/src directory): find . -regex '\(.*\.[hc]\|.*\.cc\|.*\.m4\)' -not -name 'macro.h' \ -a -not -name 'reserve.[ch]' -a -not -name 'reserve-monitor.[ch]' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'poll-win32.c' -a -not -name 'thread-win32.c' \ -a -not -name 'dllmain.c' -a -not -name 'gconf-helper.c' \ -exec sed -i -e 's/\bpa_bool_t\b/bool/g' \ -e 's/\bTRUE\b/true/g' -e 's/\bFALSE\b/false/g' {} \; and: sed -i -e '181,194!s/\bpa_bool_t\b/bool/' \ -e '181,194!s/\bTRUE\b/true/' -e \ '181,194!s/\bFALSE\b/false/' pulsecore/macro.h
2013-06-27 19:28:09 +02:00
return true;
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
fail:
Remove pa_bool_t and replace it with bool. commands used for this (executed from the pulseaudio/src directory): find . -regex '\(.*\.[hc]\|.*\.cc\|.*\.m4\)' -not -name 'macro.h' \ -a -not -name 'reserve.[ch]' -a -not -name 'reserve-monitor.[ch]' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'poll-win32.c' -a -not -name 'thread-win32.c' \ -a -not -name 'dllmain.c' -a -not -name 'gconf-helper.c' \ -exec sed -i -e 's/\bpa_bool_t\b/bool/g' \ -e 's/\bTRUE\b/true/g' -e 's/\bFALSE\b/false/g' {} \; and: sed -i -e '181,194!s/\bpa_bool_t\b/bool/' \ -e '181,194!s/\bTRUE\b/true/' -e \ '181,194!s/\bFALSE\b/false/' pulsecore/macro.h
2013-06-27 19:28:09 +02:00
return false;
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
}
Remove pa_bool_t and replace it with bool. commands used for this (executed from the pulseaudio/src directory): find . -regex '\(.*\.[hc]\|.*\.cc\|.*\.m4\)' -not -name 'macro.h' \ -a -not -name 'reserve.[ch]' -a -not -name 'reserve-monitor.[ch]' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'poll-win32.c' -a -not -name 'thread-win32.c' \ -a -not -name 'dllmain.c' -a -not -name 'gconf-helper.c' \ -exec sed -i -e 's/\bpa_bool_t\b/bool/g' \ -e 's/\bTRUE\b/true/g' -e 's/\bFALSE\b/false/g' {} \; and: sed -i -e '181,194!s/\bpa_bool_t\b/bool/' \ -e '181,194!s/\bTRUE\b/true/' -e \ '181,194!s/\bFALSE\b/false/' pulsecore/macro.h
2013-06-27 19:28:09 +02:00
bool pa_speex_ec_init(pa_core *c, pa_echo_canceller *ec,
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
pa_sample_spec *rec_ss, pa_channel_map *rec_map,
pa_sample_spec *play_ss, pa_channel_map *play_map,
pa_sample_spec *out_ss, pa_channel_map *out_map,
Style fix: Remove new lines from opening brackets This patch replaces every occurrence of ')\n{' with ') {'. Command used for this: find . -type d \( -name ffmpeg \) -prune -o \ -regex '\(.*\.[hc]\|.*\.cc\)' \ -a -not -name core-util.c -a -not \ -name adrian-aec.c -a -not -name g711.c \ -exec sed -i -e '/)$/{N;s/)\n{$/) {/}' {} \; The excluded files are mirrored files from external sources.
2013-06-18 22:24:24 +02:00
uint32_t *nframes, const char *args) {
echo-cancel: Enable different blocksizes for sink and source In order to support different blocksizes for source and sink (e.g, for 4-to-1 beamforming/echo canceling which involves 4 record channels and 1 playback channel) the AEC API is altered: The blocksize for source and sink may differ (due to different sample specs) but the number of frames that are processed in one invokation of the AEC implementation's run() function is the same for the playback and the record stream. Consequently, the AEC implementation's init() function initalizes 'nframes' instead of 'blocksize' and the source's and sink's blocksizes are derived from 'nframes'. The old API also caused code duplication in each AEC implementation's init function for the compution of the blocksize, which is eliminated by the new API. Signed-off-by: Stefan Huber <s.huber@bct-electronic.com> Acked-by: Peter Meerwald <p.meerwald@bct-electronic.com>
2012-12-20 11:33:04 +01:00
int rate;
echo-cancel: Add function pa_echo_canceller_blocksize_power2() computes EC block size in frames (rounded down to nearest power-of-2) based on sample rate and milliseconds move code from speex AEC implementation to module-echo-cancel such that functionality can be reused by other AEC implementations Signed-off-by: Peter Meerwald <p.meerwald@bct-electronic.com>
2013-02-13 17:26:51 +01:00
uint32_t frame_size_ms, filter_size_ms;
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
pa_modargs *ma;
if (!(ma = pa_modargs_new(args, valid_modargs))) {
pa_log("Failed to parse submodule arguments.");
goto fail;
}
filter_size_ms = DEFAULT_FILTER_SIZE_MS;
if (pa_modargs_get_value_u32(ma, "filter_size_ms", &filter_size_ms) < 0 || filter_size_ms < 1 || filter_size_ms > 2000) {
pa_log("Invalid filter_size_ms specification");
goto fail;
}
frame_size_ms = DEFAULT_FRAME_SIZE_MS;
if (pa_modargs_get_value_u32(ma, "frame_size_ms", &frame_size_ms) < 0 || frame_size_ms < 1 || frame_size_ms > 200) {
pa_log("Invalid frame_size_ms specification");
goto fail;
}
echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
pa_speex_ec_fixate_spec(rec_ss, rec_map, play_ss, play_map, out_ss, out_map);
echo-cancel: Let AEC module determine source/sink spec Since the source and sink specification will need to be determined by the AEC algorithm (can it handle multi-channel audio, does it work with a fixed sample rate, etc.), we negotiate these using inout parameters at initialisation time. There is opportunity to make the sink-handling more elegant. Since the sink data isn't used for playback (just processing), we could pass through the data as-is and resample to the required spec before using in the cancellation algorithm. This isn't too important immediately, but would be nice to have.
2010-09-06 22:23:51 +05:30
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
rate = out_ss->rate;
echo-cancel: Add function pa_echo_canceller_blocksize_power2() computes EC block size in frames (rounded down to nearest power-of-2) based on sample rate and milliseconds move code from speex AEC implementation to module-echo-cancel such that functionality can be reused by other AEC implementations Signed-off-by: Peter Meerwald <p.meerwald@bct-electronic.com>
2013-02-13 17:26:51 +01:00
*nframes = pa_echo_canceller_blocksize_power2(rate, frame_size_ms);
echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
pa_log_debug ("Using nframes %d, channels %d, rate %d", *nframes, out_ss->channels, out_ss->rate);
ec->params.priv.speex.state = speex_echo_state_init_mc(*nframes, (rate * filter_size_ms) / 1000, out_ss->channels, out_ss->channels);
echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
if (!ec->params.priv.speex.state)
Fix up according to Coding Style Only whitespace changes in here
2011-03-02 12:41:26 +01:00
goto fail;
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
speex_echo_ctl(ec->params.priv.speex.state, SPEEX_ECHO_SET_SAMPLING_RATE, &rate);
echo-cancel: Enable different sample specs for rec and out stream Enable advanced AEC methods to use different specs (i.e., number of channels) for rec and out stream. A typical application is beam forming resp. multi-channel AEC, which takes multiple record channels to produce an echo-canceled output stream. This commit alters the EC API as follows: the EC's init() used to get source and sink's sample spec/channel map. The new interface renamed source to rec and sink to play and additionally passes sample spec and channel map of the out stream. The new parameter names of init() {rec,play,out}_{ss,map} are more intuitive and also resemble to the parameter names known from run(). Both rec_{ss,map} and out_{ss,map} are initialized as we knew it from source_{ss,map} before being passed to init(). The previous EC implementations only require trivial changes, i.e., setting rec_{ss,map} to out_{ss,map} at the end of init() in case that out_{ss,map} is modified in init().
2013-02-18 16:31:03 +01:00
if (!pa_speex_ec_preprocessor_init(ec, out_ss, *nframes, ma))
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
goto fail;
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
pa_modargs_free(ma);
Remove pa_bool_t and replace it with bool. commands used for this (executed from the pulseaudio/src directory): find . -regex '\(.*\.[hc]\|.*\.cc\|.*\.m4\)' -not -name 'macro.h' \ -a -not -name 'reserve.[ch]' -a -not -name 'reserve-monitor.[ch]' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'poll-win32.c' -a -not -name 'thread-win32.c' \ -a -not -name 'dllmain.c' -a -not -name 'gconf-helper.c' \ -exec sed -i -e 's/\bpa_bool_t\b/bool/g' \ -e 's/\bTRUE\b/true/g' -e 's/\bFALSE\b/false/g' {} \; and: sed -i -e '181,194!s/\bpa_bool_t\b/bool/' \ -e '181,194!s/\bTRUE\b/true/' -e \ '181,194!s/\bFALSE\b/false/' pulsecore/macro.h
2013-06-27 19:28:09 +02:00
return true;
echo-cancel: Pass arguments to the specific canceller module This allows us to tweak module parameters for whichever AEC module is chosen.
2010-09-06 21:24:55 +05:30
fail:
if (ma)
Fix up according to Coding Style Only whitespace changes in here
2011-03-02 12:41:26 +01:00
pa_modargs_free(ma);
echo-cancel: Fix error cleanup of pa_speex_ec_init() Signed-off-by: Peter Meerwald <p.meerwald@bct-electronic.com>
2013-01-11 15:59:27 +01:00
if (ec->params.priv.speex.pp_state) {
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
speex_preprocess_state_destroy(ec->params.priv.speex.pp_state);
echo-cancel: Fix error cleanup of pa_speex_ec_init() Signed-off-by: Peter Meerwald <p.meerwald@bct-electronic.com>
2013-01-11 15:59:27 +01:00
ec->params.priv.speex.pp_state = NULL;
}
if (ec->params.priv.speex.state) {
speex_echo_state_destroy(ec->params.priv.speex.state);
ec->params.priv.speex.state = NULL;
}
Remove pa_bool_t and replace it with bool. commands used for this (executed from the pulseaudio/src directory): find . -regex '\(.*\.[hc]\|.*\.cc\|.*\.m4\)' -not -name 'macro.h' \ -a -not -name 'reserve.[ch]' -a -not -name 'reserve-monitor.[ch]' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'glib-mainloop.c' -a -not -name 'gkt-test.c' \ -a -not -name 'poll-win32.c' -a -not -name 'thread-win32.c' \ -a -not -name 'dllmain.c' -a -not -name 'gconf-helper.c' \ -exec sed -i -e 's/\bpa_bool_t\b/bool/g' \ -e 's/\bTRUE\b/true/g' -e 's/\bFALSE\b/false/g' {} \; and: sed -i -e '181,194!s/\bpa_bool_t\b/bool/' \ -e '181,194!s/\bTRUE\b/true/' -e \ '181,194!s/\bFALSE\b/false/' pulsecore/macro.h
2013-06-27 19:28:09 +02:00
return false;
echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
}
Fix up according to Coding Style Only whitespace changes in here
2011-03-02 12:41:26 +01:00
void pa_speex_ec_run(pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out) {
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
speex_echo_cancellation(ec->params.priv.speex.state, (const spx_int16_t *) rec, (const spx_int16_t *) play,
(spx_int16_t *) out);
/* preprecessor is run after AEC. This is not a mistake! */
if (ec->params.priv.speex.pp_state)
speex_preprocess_run(ec->params.priv.speex.pp_state, (spx_int16_t *) out);
echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
}
Fix up according to Coding Style Only whitespace changes in here
2011-03-02 12:41:26 +01:00
void pa_speex_ec_done(pa_echo_canceller *ec) {
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
if (ec->params.priv.speex.pp_state) {
speex_preprocess_state_destroy(ec->params.priv.speex.pp_state);
ec->params.priv.speex.pp_state = NULL;
}
if (ec->params.priv.speex.state) {
echo-cancel: Fix a crash is speex cleanup If module initialisation fails, the speex done() function might try to free a value that's not been allocated yet. Adding protection for this condition.
2011-05-28 07:51:35 +05:30
speex_echo_state_destroy(ec->params.priv.speex.state);
echo-cancel: Move speex preprocessing out of the main module I initially included put the Speex preprocessing assuming that we'd want to use the digital gain control and noise suppression from Speex for all echo cancelling implementations. In practice, we're probably going to get entire implementations all processing in one package (WebRTC, custom modules from various vendors, etc.). This moves out this preprocessing and related knobs into the speex implementation, which serves to clean out all implementation-specific details from the module-echo-cancel core.
2011-08-25 17:47:05 +05:30
ec->params.priv.speex.state = NULL;
}
echo-cancel: Split out speex code from the core module This splits out the echo-cancelling core from the PA-specific bits to allow us to plug in other echo-cancellation engines.
2010-09-06 15:51:20 +05:30
}
Reference in a new issue Copy permalink