2 This file is part of PulseAudio.
4 Copyright 2010 Arun Raghavan <arun.raghavan@collabora.co.uk>
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.
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.
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
22 #ifndef fooechocancelhfoo
23 #define fooechocancelhfoo
29 #include <pulse/sample.h>
30 #include <pulse/channelmap.h>
31 #include <pulsecore/core.h>
32 #include <pulsecore/macro.h>
35 #include <speex/speex_echo.h>
36 #include <speex/speex_preprocess.h>
41 /* Common data structures */
43 typedef struct pa_echo_canceller_msg pa_echo_canceller_msg
;
45 typedef struct pa_echo_canceller_params pa_echo_canceller_params
;
47 struct pa_echo_canceller_params
{
51 SpeexEchoState
*state
;
52 SpeexPreprocessState
*pp_state
;
63 /* This is a void* so that we don't have to convert this whole file
64 * to C++ linkage. apm is a pointer to an AudioProcessing object */
67 pa_sample_spec sample_spec
;
71 /* each canceller-specific structure goes here */
74 /* Set this if canceller can do drift compensation. Also see set_drift()
76 pa_bool_t drift_compensation
;
79 typedef struct pa_echo_canceller pa_echo_canceller
;
81 struct pa_echo_canceller
{
82 /* Initialise canceller engine. */
83 pa_bool_t (*init
) (pa_core
*c
,
84 pa_echo_canceller
*ec
,
85 pa_sample_spec
*source_ss
,
86 pa_channel_map
*source_map
,
87 pa_sample_spec
*sink_ss
,
88 pa_channel_map
*sink_map
,
92 /* You should have only one of play()+record() or run() set. The first
93 * works under the assumption that you'll handle buffering and matching up
94 * samples yourself. If you set run(), module-echo-cancel will handle
95 * synchronising the playback and record streams. */
97 /* Feed the engine 'nframes' playback frames. */
98 void (*play
) (pa_echo_canceller
*ec
, const uint8_t *play
);
99 /* Feed the engine 'nframes' record frames. nframes processed frames are
100 * returned in out. */
101 void (*record
) (pa_echo_canceller
*ec
, const uint8_t *rec
, uint8_t *out
);
102 /* Feed the engine nframes playback and record frames, with a reasonable
103 * effort at keeping the two in sync. nframes processed frames are
104 * returned in out. */
105 void (*run
) (pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
107 /* Optional callback to set the drift, expressed as the ratio of the
108 * difference in number of playback and capture samples to the number of
109 * capture samples, for some instant of time. This is used only if the
110 * canceller signals that it supports drift compensation, and is called
111 * before record(). The actual implementation needs to derive drift based
112 * on point samples -- the individual values are not accurate enough to use
114 /* NOTE: the semantics of this function might change in the future. */
115 void (*set_drift
) (pa_echo_canceller
*ec
, float drift
);
117 /* Free up resources. */
118 void (*done
) (pa_echo_canceller
*ec
);
120 /* Structure with common and engine-specific canceller parameters. */
121 pa_echo_canceller_params params
;
123 /* msgobject that can be used to send messages back to the main thread */
124 pa_echo_canceller_msg
*msg
;
127 /* Functions to be used by the canceller analog gain control routines */
128 void pa_echo_canceller_get_capture_volume(pa_echo_canceller
*ec
, pa_cvolume
*v
);
129 void pa_echo_canceller_set_capture_volume(pa_echo_canceller
*ec
, pa_cvolume
*v
);
131 /* Null canceller functions */
132 pa_bool_t
pa_null_ec_init(pa_core
*c
, pa_echo_canceller
*ec
,
133 pa_sample_spec
*source_ss
, pa_channel_map
*source_map
,
134 pa_sample_spec
*sink_ss
, pa_channel_map
*sink_map
,
135 uint32_t *nframes
, const char *args
);
136 void pa_null_ec_run(pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
137 void pa_null_ec_done(pa_echo_canceller
*ec
);
140 /* Speex canceller functions */
141 pa_bool_t
pa_speex_ec_init(pa_core
*c
, pa_echo_canceller
*ec
,
142 pa_sample_spec
*source_ss
, pa_channel_map
*source_map
,
143 pa_sample_spec
*sink_ss
, pa_channel_map
*sink_map
,
144 uint32_t *nframes
, const char *args
);
145 void pa_speex_ec_run(pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
146 void pa_speex_ec_done(pa_echo_canceller
*ec
);
149 #ifdef HAVE_ADRIAN_EC
150 /* Adrian Andre's echo canceller */
151 pa_bool_t
pa_adrian_ec_init(pa_core
*c
, pa_echo_canceller
*ec
,
152 pa_sample_spec
*source_ss
, pa_channel_map
*source_map
,
153 pa_sample_spec
*sink_ss
, pa_channel_map
*sink_map
,
154 uint32_t *nframes
, const char *args
);
155 void pa_adrian_ec_run(pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
156 void pa_adrian_ec_done(pa_echo_canceller
*ec
);
160 /* WebRTC canceller functions */
162 pa_bool_t
pa_webrtc_ec_init(pa_core
*c
, pa_echo_canceller
*ec
,
163 pa_sample_spec
*source_ss
, pa_channel_map
*source_map
,
164 pa_sample_spec
*sink_ss
, pa_channel_map
*sink_map
,
165 uint32_t *nframes
, const char *args
);
166 void pa_webrtc_ec_play(pa_echo_canceller
*ec
, const uint8_t *play
);
167 void pa_webrtc_ec_record(pa_echo_canceller
*ec
, const uint8_t *rec
, uint8_t *out
);
168 void pa_webrtc_ec_set_drift(pa_echo_canceller
*ec
, float drift
);
169 void pa_webrtc_ec_run(pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
170 void pa_webrtc_ec_done(pa_echo_canceller
*ec
);
174 #endif /* fooechocancelhfoo */