9f679807454f2cb23603dc62d38333cae36e19e1
[platform/upstream/pulseaudio.git] / src / modules / echo-cancel / echo-cancel.h
1 /***
2     This file is part of PulseAudio.
3
4     Copyright 2010 Arun Raghavan <arun.raghavan@collabora.co.uk>
5
6     PulseAudio is free software; you can redistribute it and/or modify
7     it under the terms of the GNU Lesser General Public License as published
8     by the Free Software Foundation; either version 2.1 of the License,
9     or (at your option) any later version.
10
11     PulseAudio is distributed in the hope that it will be useful, but
12     WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14     General Public License for more details.
15
16     You should have received a copy of the GNU Lesser General Public License
17     along with PulseAudio; if not, write to the Free Software
18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19     USA.
20 ***/
21
22 #ifndef fooechocancelhfoo
23 #define fooechocancelhfoo
24
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28
29 #include <pulse/sample.h>
30 #include <pulse/channelmap.h>
31 #include <pulsecore/core.h>
32 #include <pulsecore/macro.h>
33
34 #include <speex/speex_echo.h>
35 #include <speex/speex_preprocess.h>
36 #include "adrian.h"
37
38 /* Common data structures */
39
40 typedef struct pa_echo_canceller_params pa_echo_canceller_params;
41
42 struct pa_echo_canceller_params {
43     union {
44         struct {
45             SpeexEchoState *state;
46             SpeexPreprocessState *pp_state;
47         } speex;
48         struct {
49             uint32_t blocksize;
50             AEC *aec;
51         } adrian;
52         /* each canceller-specific structure goes here */
53     } priv;
54 };
55
56 typedef struct pa_echo_canceller pa_echo_canceller;
57
58 struct pa_echo_canceller {
59     pa_bool_t   (*init)                 (pa_core *c,
60                                          pa_echo_canceller *ec,
61                                          pa_sample_spec *source_ss,
62                                          pa_channel_map *source_map,
63                                          pa_sample_spec *sink_ss,
64                                          pa_channel_map *sink_map,
65                                          uint32_t *blocksize,
66                                          const char *args);
67     void        (*run)                  (pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out);
68     void        (*done)                 (pa_echo_canceller *ec);
69
70     pa_echo_canceller_params params;
71 };
72
73 /* Speex canceller functions */
74 pa_bool_t pa_speex_ec_init(pa_core *c, pa_echo_canceller *ec,
75                            pa_sample_spec *source_ss, pa_channel_map *source_map,
76                            pa_sample_spec *sink_ss, pa_channel_map *sink_map,
77                            uint32_t *blocksize, const char *args);
78 void pa_speex_ec_run(pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out);
79 void pa_speex_ec_done(pa_echo_canceller *ec);
80
81 /* Adrian Andre's echo canceller */
82 pa_bool_t pa_adrian_ec_init(pa_core *c, pa_echo_canceller *ec,
83                            pa_sample_spec *source_ss, pa_channel_map *source_map,
84                            pa_sample_spec *sink_ss, pa_channel_map *sink_map,
85                            uint32_t *blocksize, const char *args);
86 void pa_adrian_ec_run(pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out);
87 void pa_adrian_ec_done(pa_echo_canceller *ec);
88
89 #endif /* fooechocancelhfoo */