added the "speex" prefix to the denoising stuff
[speexdsp.git] / libspeex / speex_denoise.h
1 /* Copyright (C) 2003 Epic Games 
2    Written by Jean-Marc Valin
3
4    File: speex_denoise.h
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
35 #include "smallft.h"
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 typedef struct SpeexDenoiseState {
42    int frame_size;           /**< Number of samples processed each time */
43    int ps_size;              /**< Number of points in the power spectrum */
44
45    float *frame;             /**< Processing frame (2*ps_size) */
46    float *ps;                /**< Current power spectrum */
47    float *gain2;             /**< Adjusted gains */
48    float *window;            /**< Analysis/Synthesis window */
49    float *noise;             /**< Noise estimate */
50    float *old_ps;            /**< Power spectrum for last frame */
51    float *gain;              /**< Ephraim Malah gain */
52    float *prior;             /**< A-priori SNR */
53    float *post;              /**< A-posteriori SNR */
54    float *min_ps;            /**< */
55    float *last_energy;       /**< Energy of the previous frames */
56    float *last_ps;           /**< Power spectrum of the past frames */
57    float *loudness_weight;   /**< */
58    int    last_id;           /**< */
59
60    float *inbuf;             /**< Input buffer (overlapped analysis) */
61    float *outbuf;            /**< Output buffer (for overlap and add) */
62
63    float  loudness;          /**< loudness estimate */
64    float  loudness2;          /**< loudness estimate */
65    int    nb_adapt;          /**< Number of frames used for adaptation so far */
66    int    nb_loudness_adapt; /**< Number of frames used for loudness adaptation so far */
67    int    consec_noise;      /**< Number of consecutive noise frames */
68    int    nb_denoise;        /**< Number of frames processed so far */
69    int    nb_min_estimate;   /**< */
70    int    last_update;       /**< */
71    float  min_ener;          /**< */
72    drft_lookup fft_lookup;   /**< */
73
74 } SpeexDenoiseState;
75
76 /** Creates a new denoising state */
77 SpeexDenoiseState *speex_denoise_state_init(int frame_size);
78
79 /** Destroys a denoising state */
80 void speex_denoise_state_destroy(SpeexDenoiseState *st);
81
82 /** Denoise a frame */
83 int speex_denoise(SpeexDenoiseState *st, float *x);
84
85 #ifdef __cplusplus
86 }
87 #endif