struct pa_echo_canceller_params {
union {
+ struct {
+ pa_sample_spec out_ss;
+ } null;
#ifdef HAVE_SPEEX
struct {
SpeexEchoState *state;
void *apm;
uint32_t blocksize;
pa_sample_spec sample_spec;
- pa_bool_t agc;
+ bool agc;
} webrtc;
#endif
/* each canceller-specific structure goes here */
/* Set this if canceller can do drift compensation. Also see set_drift()
* below */
- pa_bool_t drift_compensation;
+ bool drift_compensation;
};
typedef struct pa_echo_canceller pa_echo_canceller;
struct pa_echo_canceller {
/* Initialise canceller engine. */
- pa_bool_t (*init) (pa_core *c,
+ bool (*init) (pa_core *c,
pa_echo_canceller *ec,
- pa_sample_spec *source_ss,
- pa_channel_map *source_map,
- pa_sample_spec *sink_ss,
- pa_channel_map *sink_map,
- uint32_t *blocksize,
+ 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,
+ uint32_t *nframes,
const char *args);
/* You should have only one of play()+record() or run() set. The first
* samples yourself. If you set run(), module-echo-cancel will handle
* synchronising the playback and record streams. */
- /* Feed the engine 'blocksize' playback bytes.. */
+ /* Feed the engine 'nframes' playback frames. */
void (*play) (pa_echo_canceller *ec, const uint8_t *play);
- /* Feed the engine 'blocksize' record bytes. blocksize processed bytes are
+ /* Feed the engine 'nframes' record frames. nframes processed frames are
* returned in out. */
void (*record) (pa_echo_canceller *ec, const uint8_t *rec, uint8_t *out);
- /* Feed the engine blocksize playback and record streams, with a reasonable
- * effort at keeping the two in sync. blocksize processed bytes are
+ /* Feed the engine nframes playback and record frames, with a reasonable
+ * effort at keeping the two in sync. nframes processed frames are
* returned in out. */
void (*run) (pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out);
void pa_echo_canceller_get_capture_volume(pa_echo_canceller *ec, pa_cvolume *v);
void pa_echo_canceller_set_capture_volume(pa_echo_canceller *ec, pa_cvolume *v);
+/* Computes EC block size in frames (rounded down to nearest power-of-2) based
+ * on sample rate and milliseconds. */
+uint32_t pa_echo_canceller_blocksize_power2(unsigned rate, unsigned ms);
+
+/* Null canceller functions */
+bool pa_null_ec_init(pa_core *c, pa_echo_canceller *ec,
+ 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,
+ uint32_t *nframes, const char *args);
+void pa_null_ec_run(pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out);
+void pa_null_ec_done(pa_echo_canceller *ec);
+
#ifdef HAVE_SPEEX
/* Speex canceller functions */
-pa_bool_t pa_speex_ec_init(pa_core *c, pa_echo_canceller *ec,
- pa_sample_spec *source_ss, pa_channel_map *source_map,
- pa_sample_spec *sink_ss, pa_channel_map *sink_map,
- uint32_t *blocksize, const char *args);
+bool pa_speex_ec_init(pa_core *c, pa_echo_canceller *ec,
+ 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,
+ uint32_t *nframes, const char *args);
void pa_speex_ec_run(pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out);
void pa_speex_ec_done(pa_echo_canceller *ec);
#endif
#ifdef HAVE_ADRIAN_EC
/* Adrian Andre's echo canceller */
-pa_bool_t pa_adrian_ec_init(pa_core *c, pa_echo_canceller *ec,
- pa_sample_spec *source_ss, pa_channel_map *source_map,
- pa_sample_spec *sink_ss, pa_channel_map *sink_map,
- uint32_t *blocksize, const char *args);
+bool pa_adrian_ec_init(pa_core *c, pa_echo_canceller *ec,
+ 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,
+ uint32_t *nframes, const char *args);
void pa_adrian_ec_run(pa_echo_canceller *ec, const uint8_t *rec, const uint8_t *play, uint8_t *out);
void pa_adrian_ec_done(pa_echo_canceller *ec);
#endif
#ifdef HAVE_WEBRTC
/* WebRTC canceller functions */
PA_C_DECL_BEGIN
-pa_bool_t pa_webrtc_ec_init(pa_core *c, pa_echo_canceller *ec,
- pa_sample_spec *source_ss, pa_channel_map *source_map,
- pa_sample_spec *sink_ss, pa_channel_map *sink_map,
- uint32_t *blocksize, const char *args);
+bool pa_webrtc_ec_init(pa_core *c, pa_echo_canceller *ec,
+ 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,
+ uint32_t *nframes, const char *args);
void pa_webrtc_ec_play(pa_echo_canceller *ec, const uint8_t *play);
void pa_webrtc_ec_record(pa_echo_canceller *ec, const uint8_t *rec, uint8_t *out);
void pa_webrtc_ec_set_drift(pa_echo_canceller *ec, float drift);