6f1af750f86cc5ade654cb77e9dd0c27d496324a
[speexdsp.git] / include / speex / speex_echo.h
1 /* Copyright (C) Jean-Marc Valin */
2 /**
3    @file speex_echo.h
4    @brief Echo cancellation
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions are
9    met:
10
11    1. Redistributions of source code must retain the above copyright notice,
12    this list of conditions and the following disclaimer.
13
14    2. Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17
18    3. The name of the author may not be used to endorse or promote products
19    derived from this software without specific prior written permission.
20
21    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24    DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
25    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31    POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef SPEEX_ECHO_H
35 #define SPEEX_ECHO_H
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct drft_lookup;
42
43 /** Speex echo cancellation state. */
44 typedef struct SpeexEchoState {
45    int frame_size;           /**< Number of samples processed each time */
46    int window_size;
47    int M;
48    int cancel_count;
49    int adapted;
50    float sum_adapt;
51    
52    float *x;
53    float *X;
54    float *d;
55    float *y;
56    float *last_y;
57    float *Yps;
58    float *Y;
59    float *E;
60    float *PHI;
61    float *W;
62    float *power;
63    float *power_1;
64    float *Rf;
65    float *Yf;
66    float *Xf;
67    float *Eh;
68    float *Yh;
69    float Pey;
70    float Pyy;
71    struct drft_lookup *fft_lookup;
72
73
74 } SpeexEchoState;
75
76
77 /** Creates a new echo canceller state */
78 SpeexEchoState *speex_echo_state_init(int frame_size, int filter_length);
79
80 /** Destroys an echo canceller state */
81 void speex_echo_state_destroy(SpeexEchoState *st);
82
83 /** Performs echo cancellation a frame */
84 void speex_echo_cancel(SpeexEchoState *st, short *ref, short *echo, short *out, float *Y);
85
86 /** Reset the echo canceller state */
87 void speex_echo_state_reset(SpeexEchoState *st);
88
89 #ifdef __cplusplus
90 }
91 #endif
92
93 #endif