summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArun Raghavan <arun.raghavan@collabora.co.uk>2010-09-06 15:51:20 +0530
committerArun Raghavan <arun.raghavan@collabora.co.uk>2011-03-28 14:40:59 +0530
commit57c598393780e27915c84ff167d82fc85803ffe2 (patch)
tree731fdd84e5b191b53d5ebf681a2f033dc1b7b48f
parent6d8a90709e5d0a3dc5c11e4a7d54c2cdbb774f3a (diff)
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.
-rw-r--r--src/Makefile.am2
-rw-r--r--src/modules/echo-cancel/echo-cancel.h61
-rw-r--r--src/modules/echo-cancel/module-echo-cancel.c93
-rw-r--r--src/modules/echo-cancel/speex.c64
4 files changed, 184 insertions, 36 deletions
diff --git a/src/Makefile.am b/src/Makefile.am
index 49465ccb..242532ca 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -1605,7 +1605,7 @@ module_suspend_on_idle_la_LIBADD = $(AM_LIBADD) libpulsecore-@PA_MAJORMINORMICRO
module_suspend_on_idle_la_CFLAGS = $(AM_CFLAGS)
# echo-cancel module
-module_echo_cancel_la_SOURCES = modules/echo-cancel/module-echo-cancel.c
+module_echo_cancel_la_SOURCES = modules/echo-cancel/module-echo-cancel.c modules/echo-cancel/speex.c
module_echo_cancel_la_LDFLAGS = $(MODULE_LDFLAGS)
module_echo_cancel_la_LIBADD = $(AM_LIBADD) libpulsecore-@PA_MAJORMINORMICRO@.la libpulsecommon-@PA_MAJORMINORMICRO@.la libpulse.la $(LIBSPEEX_LIBS)
module_echo_cancel_la_CFLAGS = $(AM_CFLAGS) $(LIBSPEEX_CFLAGS)
diff --git a/src/modules/echo-cancel/echo-cancel.h b/src/modules/echo-cancel/echo-cancel.h
new file mode 100644
index 00000000..bb6c0ed4
--- /dev/null
+++ b/src/modules/echo-cancel/echo-cancel.h
@@ -0,0 +1,61 @@
+/***
+ This file is part of PulseAudio.
+
+ Copyright 2010 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.
+***/
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <pulse/sample.h>
+#include <pulse/channelmap.h>
+#include <pulsecore/macro.h>
+
+#include <speex/speex_echo.h>
+
+/* Common data structures */
+
+typedef struct pa_echo_canceller_params pa_echo_canceller_params;
+
+struct pa_echo_canceller_params {
+ union {
+ struct {
+ uint32_t blocksize;
+ SpeexEchoState *state;
+ } speex;
+ /* each canceller-specific structure goes here */
+ } priv;
+};
+
+typedef struct pa_echo_canceller pa_echo_canceller;
+
+struct pa_echo_canceller {
+ pa_bool_t (*init) (pa_echo_canceller *ec, pa_sample_spec ss, pa_channel_map map, uint32_t filter_size_ms, uint32_t frame_size_ms);
+ void (*run) (pa_echo_canceller *ec, uint8_t *rec, uint8_t *play, uint8_t *out);
+ void (*done) (pa_echo_canceller *ec);
+ uint32_t (*get_block_size) (pa_echo_canceller *ec);
+
+ pa_echo_canceller_params params;
+};
+
+/* Speex canceller functions */
+pa_bool_t pa_speex_ec_init(pa_echo_canceller *ec, pa_sample_spec ss, pa_channel_map map, uint32_t filter_size_ms, uint32_t frame_size_ms);
+void pa_speex_ec_run(pa_echo_canceller *ec, uint8_t *rec, uint8_t *play, uint8_t *out);
+void pa_speex_ec_done(pa_echo_canceller *ec);
+uint32_t pa_speex_ec_get_block_size(pa_echo_canceller *ec);
diff --git a/src/modules/echo-cancel/module-echo-cancel.c b/src/modules/echo-cancel/module-echo-cancel.c
index d6c2ca14..2e724344 100644
--- a/src/modules/echo-cancel/module-echo-cancel.c
+++ b/src/modules/echo-cancel/module-echo-cancel.c
@@ -33,7 +33,7 @@
#include <stdio.h>
#include <math.h>
-#include <speex/speex_echo.h>
+#include "echo-cancel.h"
#include <pulse/xmalloc.h>
#include <pulse/i18n.h>
@@ -80,6 +80,23 @@ PA_MODULE_USAGE(
"save_aec=<save AEC data in /tmp> "
));
+/* NOTE: Make sure the enum and ec_table are maintained in the correct order */
+enum {
+ PA_ECHO_CANCELLER_SPEEX,
+};
+
+#define DEFAULT_ECHO_CANCELLER PA_ECHO_CANCELLER_SPEEX
+
+static const pa_echo_canceller ec_table[] = {
+ {
+ /* Speex */
+ .init = pa_speex_ec_init,
+ .run = pa_speex_ec_run,
+ .done = pa_speex_ec_done,
+ .get_block_size = pa_speex_ec_get_block_size,
+ },
+};
+
/* should be between 10-20 ms */
#define DEFAULT_FRAME_SIZE_MS 20
/* should be between 100-500 ms */
@@ -140,9 +157,8 @@ struct userdata {
uint32_t frame_size_ms;
uint32_t save_aec;
- SpeexEchoState *echo_state;
+ pa_echo_canceller *ec;
- size_t blocksize;
pa_bool_t need_realign;
/* to wakeup the source I/O thread */
@@ -326,7 +342,7 @@ static int source_process_msg_cb(pa_msgobject *o, int code, void *data, int64_t
/* Add the latency internal to our source output on top */
pa_bytes_to_usec(pa_memblockq_get_length(u->source_output->thread_info.delay_memblockq), &u->source_output->source->sample_spec) +
/* and the buffering we do on the source */
- pa_bytes_to_usec(u->blocksize, &u->source_output->source->sample_spec);
+ pa_bytes_to_usec(u->ec->get_block_size(u->ec), &u->source_output->source->sample_spec);
return 0;
@@ -613,6 +629,7 @@ static void do_resync(struct userdata *u) {
static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk) {
struct userdata *u;
size_t rlen, plen;
+ uint32_t blocksize;
pa_source_output_assert_ref(o);
pa_source_output_assert_io_context(o);
@@ -638,18 +655,20 @@ static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk)
rlen = pa_memblockq_get_length(u->source_memblockq);
plen = pa_memblockq_get_length(u->sink_memblockq);
- while (rlen >= u->blocksize) {
+ blocksize = u->ec->get_block_size(u->ec);
+
+ while (rlen >= blocksize) {
pa_memchunk rchunk, pchunk;
/* take fixed block from recorded samples */
- pa_memblockq_peek_fixed_size(u->source_memblockq, u->blocksize, &rchunk);
+ pa_memblockq_peek_fixed_size(u->source_memblockq, blocksize, &rchunk);
- if (plen > u->blocksize) {
+ if (plen > blocksize) {
uint8_t *rdata, *pdata, *cdata;
pa_memchunk cchunk;
/* take fixed block from played samples */
- pa_memblockq_peek_fixed_size(u->sink_memblockq, u->blocksize, &pchunk);
+ pa_memblockq_peek_fixed_size(u->sink_memblockq, blocksize, &pchunk);
rdata = pa_memblock_acquire(rchunk.memblock);
rdata += rchunk.index;
@@ -657,21 +676,20 @@ static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk)
pdata += pchunk.index;
cchunk.index = 0;
- cchunk.length = u->blocksize;
+ cchunk.length = blocksize;
cchunk.memblock = pa_memblock_new(u->source->core->mempool, cchunk.length);
cdata = pa_memblock_acquire(cchunk.memblock);
/* perform echo cancelation */
- speex_echo_cancellation(u->echo_state, (const spx_int16_t *) rdata,
- (const spx_int16_t *) pdata, (spx_int16_t *) cdata);
+ u->ec->run(u->ec, rdata, pdata, cdata);
if (u->save_aec) {
if (u->captured_file)
- fwrite(rdata, 1, u->blocksize, u->captured_file);
+ fwrite(rdata, 1, blocksize, u->captured_file);
if (u->played_file)
- fwrite(pdata, 1, u->blocksize, u->played_file);
+ fwrite(pdata, 1, blocksize, u->played_file);
if (u->canceled_file)
- fwrite(cdata, 1, u->blocksize, u->canceled_file);
+ fwrite(cdata, 1, blocksize, u->canceled_file);
pa_log_debug("AEC frame saved.");
}
@@ -680,7 +698,7 @@ static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk)
pa_memblock_release(rchunk.memblock);
/* drop consumed sink samples */
- pa_memblockq_drop(u->sink_memblockq, u->blocksize);
+ pa_memblockq_drop(u->sink_memblockq, blocksize);
pa_memblock_unref(pchunk.memblock);
pa_memblock_unref(rchunk.memblock);
@@ -688,11 +706,11 @@ static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk)
* source */
rchunk = cchunk;
- plen -= u->blocksize;
+ plen -= blocksize;
} else {
/* not enough played samples to perform echo cancelation,
* drop what we have */
- pa_memblockq_drop(u->sink_memblockq, u->blocksize - plen);
+ pa_memblockq_drop(u->sink_memblockq, blocksize - plen);
plen = 0;
}
@@ -700,9 +718,9 @@ static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk)
pa_source_post(u->source, &rchunk);
pa_memblock_unref(rchunk.memblock);
- pa_memblockq_drop(u->source_memblockq, u->blocksize);
+ pa_memblockq_drop(u->source_memblockq, blocksize);
- rlen -= u->blocksize;
+ rlen -= blocksize;
}
}
@@ -1269,7 +1287,6 @@ int pa__init(pa_module*m) {
pa_source_new_data source_data;
pa_sink_new_data sink_data;
pa_memchunk silence;
- int framelen, rate, y;
uint32_t frame_size_ms, filter_size_ms;
uint32_t adjust_time_sec;
@@ -1321,18 +1338,16 @@ int pa__init(pa_module*m) {
u->module = m;
m->userdata = u;
u->frame_size_ms = frame_size_ms;
- rate = ss.rate;
- framelen = (rate * frame_size_ms) / 1000;
- /* framelen should be a power of 2, round down to nearest power of two */
- y = 1 << ((8 * sizeof (int)) - 2);
- while (y > framelen)
- y >>= 1;
- framelen = y;
-
- u->blocksize = framelen * pa_frame_size (&ss);
- pa_log_debug ("Using framelen %d, blocksize %lld, channels %d, rate %d", framelen, (long long) u->blocksize,
- ss.channels, ss.rate);
+ u->ec = pa_xnew0(pa_echo_canceller, 1);
+ if (!u->ec) {
+ pa_log("Failed to alloc echo canceller");
+ goto fail;
+ }
+ u->ec->init = ec_table[DEFAULT_ECHO_CANCELLER].init;
+ u->ec->run = ec_table[DEFAULT_ECHO_CANCELLER].run;
+ u->ec->done = ec_table[DEFAULT_ECHO_CANCELLER].done;
+ u->ec->get_block_size = ec_table[DEFAULT_ECHO_CANCELLER].get_block_size;
adjust_time_sec = DEFAULT_ADJUST_TIME_USEC / PA_USEC_PER_SEC;
if (pa_modargs_get_value_u32(ma, "adjust_time", &adjust_time_sec) < 0) {
@@ -1353,8 +1368,12 @@ int pa__init(pa_module*m) {
u->asyncmsgq = pa_asyncmsgq_new(0);
u->need_realign = TRUE;
- u->echo_state = speex_echo_state_init_mc (framelen, (rate * filter_size_ms) / 1000, ss.channels, ss.channels);
- speex_echo_ctl(u->echo_state, SPEEX_ECHO_SET_SAMPLING_RATE, &rate);
+ if (u->ec->init) {
+ if (!u->ec->init(u->ec, ss, map, filter_size_ms, frame_size_ms)) {
+ pa_log("Failed to init AEC engine");
+ goto fail;
+ }
+ }
/* Create source */
pa_source_new_data_init(&source_data);
@@ -1615,8 +1634,12 @@ void pa__done(pa_module*m) {
if (u->sink_memblockq)
pa_memblockq_free(u->sink_memblockq);
- if (u->echo_state)
- speex_echo_state_destroy (u->echo_state);
+ if (u->ec) {
+ if (u->ec->done)
+ u->ec->done(u->ec);
+
+ pa_xfree(u->ec);
+ }
if (u->asyncmsgq)
pa_asyncmsgq_unref(u->asyncmsgq);
diff --git a/src/modules/echo-cancel/speex.c b/src/modules/echo-cancel/speex.c
new file mode 100644
index 00000000..1b9e76f4
--- /dev/null
+++ b/src/modules/echo-cancel/speex.c
@@ -0,0 +1,64 @@
+/***
+ 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.
+***/
+
+#include "echo-cancel.h"
+
+pa_bool_t pa_speex_ec_init(pa_echo_canceller *ec, pa_sample_spec ss, pa_channel_map map, uint32_t filter_size_ms, uint32_t frame_size_ms)
+{
+ int framelen, y, rate = ss.rate;
+
+ framelen = (rate * frame_size_ms) / 1000;
+ /* framelen should be a power of 2, round down to nearest power of two */
+ y = 1 << ((8 * sizeof (int)) - 2);
+ while (y > framelen)
+ y >>= 1;
+ framelen = y;
+
+ ec->params.priv.speex.blocksize = framelen * pa_frame_size (&ss);
+
+ pa_log_debug ("Using framelen %d, blocksize %lld, channels %d, rate %d", framelen, (long long) ec->params.priv.speex.blocksize, ss.channels, ss.rate);
+
+ ec->params.priv.speex.state = speex_echo_state_init_mc (framelen, (rate * filter_size_ms) / 1000, ss.channels, ss.channels);
+
+ if (ec->params.priv.speex.state) {
+ speex_echo_ctl(ec->params.priv.speex.state, SPEEX_ECHO_SET_SAMPLING_RATE, &rate);
+ return TRUE;
+ } else
+ return FALSE;
+}
+
+void pa_speex_ec_run(pa_echo_canceller *ec, uint8_t *rec, uint8_t *play, uint8_t *out)
+{
+ speex_echo_cancellation(ec->params.priv.speex.state, (const spx_int16_t *) rec, (const spx_int16_t *) play, (spx_int16_t *) out);
+}
+
+void pa_speex_ec_done(pa_echo_canceller *ec)
+{
+ speex_echo_state_destroy (ec->params.priv.speex.state);
+ ec->params.priv.speex.state = NULL;
+}
+
+uint32_t pa_speex_ec_get_block_size(pa_echo_canceller *ec)
+{
+ return ec->params.priv.speex.blocksize;
+}