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>
34 #include <speex/speex_echo.h>
35 #include <speex/speex_preprocess.h>
38 /* Common data structures */
40 typedef struct pa_echo_canceller_msg pa_echo_canceller_msg
;
42 typedef struct pa_echo_canceller_params pa_echo_canceller_params
;
44 struct pa_echo_canceller_params
{
47 SpeexEchoState
*state
;
48 SpeexPreprocessState
*pp_state
;
56 /* This is a void* so that we don't have to convert this whole file
57 * to C++ linkage. apm is a pointer to an AudioProcessing object */
60 pa_sample_spec sample_spec
;
64 /* each canceller-specific structure goes here */
67 /* Set this if canceller can do drift compensation. Also see set_drift()
69 pa_bool_t drift_compensation
;
72 typedef struct pa_echo_canceller pa_echo_canceller
;
74 struct pa_echo_canceller
{
75 /* Initialise canceller engine. */
76 pa_bool_t (*init
) (pa_core
*c
,
77 pa_echo_canceller
*ec
,
78 pa_sample_spec
*source_ss
,
79 pa_channel_map
*source_map
,
80 pa_sample_spec
*sink_ss
,
81 pa_channel_map
*sink_map
,
85 /* You should have only one of play()+record() or run() set. The first
86 * works under the assumption that you'll handle buffering and matching up
87 * samples yourself. If you set run(), module-echo-cancel will handle
88 * synchronising the playback and record streams. */
90 /* Feed the engine 'blocksize' playback bytes.. */
91 void (*play
) (pa_echo_canceller
*ec
, const uint8_t *play
);
92 /* Feed the engine 'blocksize' record bytes. blocksize processed bytes are
94 void (*record
) (pa_echo_canceller
*ec
, const uint8_t *rec
, uint8_t *out
);
95 /* Feed the engine blocksize playback and record streams, with a reasonable
96 * effort at keeping the two in sync. blocksize processed bytes are
98 void (*run
) (pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
100 /* Optional callback to set the drift, expressed as the ratio of the
101 * difference in number of playback and capture samples to the number of
102 * capture samples, for some instant of time. This is used only if the
103 * canceller signals that it supports drift compensation, and is called
104 * before record(). The actual implementation needs to derive drift based
105 * on point samples -- the individual values are not accurate enough to use
107 /* NOTE: the semantics of this function might change in the future. */
108 void (*set_drift
) (pa_echo_canceller
*ec
, float drift
);
110 /* Free up resources. */
111 void (*done
) (pa_echo_canceller
*ec
);
113 /* Structure with common and engine-specific canceller parameters. */
114 pa_echo_canceller_params params
;
116 /* msgobject that can be used to send messages back to the main thread */
117 pa_echo_canceller_msg
*msg
;
120 /* Functions to be used by the canceller analog gain control routines */
121 void pa_echo_canceller_get_capture_volume(pa_echo_canceller
*ec
, pa_cvolume
*v
);
122 void pa_echo_canceller_set_capture_volume(pa_echo_canceller
*ec
, pa_cvolume
*v
);
124 /* Speex canceller functions */
125 pa_bool_t
pa_speex_ec_init(pa_core
*c
, pa_echo_canceller
*ec
,
126 pa_sample_spec
*source_ss
, pa_channel_map
*source_map
,
127 pa_sample_spec
*sink_ss
, pa_channel_map
*sink_map
,
128 uint32_t *blocksize
, const char *args
);
129 void pa_speex_ec_run(pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
130 void pa_speex_ec_done(pa_echo_canceller
*ec
);
132 /* Adrian Andre's echo canceller */
133 pa_bool_t
pa_adrian_ec_init(pa_core
*c
, pa_echo_canceller
*ec
,
134 pa_sample_spec
*source_ss
, pa_channel_map
*source_map
,
135 pa_sample_spec
*sink_ss
, pa_channel_map
*sink_map
,
136 uint32_t *blocksize
, const char *args
);
137 void pa_adrian_ec_run(pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
138 void pa_adrian_ec_done(pa_echo_canceller
*ec
);
141 /* WebRTC canceller functions */
143 pa_bool_t
pa_webrtc_ec_init(pa_core
*c
, pa_echo_canceller
*ec
,
144 pa_sample_spec
*source_ss
, pa_channel_map
*source_map
,
145 pa_sample_spec
*sink_ss
, pa_channel_map
*sink_map
,
146 uint32_t *blocksize
, const char *args
);
147 void pa_webrtc_ec_play(pa_echo_canceller
*ec
, const uint8_t *play
);
148 void pa_webrtc_ec_record(pa_echo_canceller
*ec
, const uint8_t *rec
, uint8_t *out
);
149 void pa_webrtc_ec_set_drift(pa_echo_canceller
*ec
, float drift
);
150 void pa_webrtc_ec_run(pa_echo_canceller
*ec
, const uint8_t *rec
, const uint8_t *play
, uint8_t *out
);
151 void pa_webrtc_ec_done(pa_echo_canceller
*ec
);
155 #endif /* fooechocancelhfoo */