| /* Copyright (C) 2003 Epic Games |
| Written by Jean-Marc Valin */ |
| /** |
| * @file speex_preprocess.h |
| * @brief Speex preprocessor. The preprocess can do noise suppression, |
| * residual echo suppression (after using the echo canceller), automatic |
| * gain control (AGC) and voice activity detection (VAD). |
| */ |
| /* |
| Redistribution and use in source and binary forms, with or without |
| modification, are permitted provided that the following conditions are |
| met: |
| |
| 1. Redistributions of source code must retain the above copyright notice, |
| this list of conditions and the following disclaimer. |
| |
| 2. Redistributions in binary form must reproduce the above copyright |
| notice, this list of conditions and the following disclaimer in the |
| documentation and/or other materials provided with the distribution. |
| |
| 3. The name of the author may not be used to endorse or promote products |
| derived from this software without specific prior written permission. |
| |
| THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, |
| INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
| ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| #ifndef SPEEX_PREPROCESS_H |
| #define SPEEX_PREPROCESS_H |
| /** @defgroup SpeexPreprocessState SpeexPreprocessState: The Speex preprocessor |
| * This is the Speex preprocessor. The preprocess can do noise suppression, |
| * residual echo suppression (after using the echo canceller), automatic |
| * gain control (AGC) and voice activity detection (VAD). |
| * @{ |
| */ |
| |
| #include "speex/speex_types.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** State of the preprocessor (one per channel). Should never be accessed directly. */ |
| struct SpeexPreprocessState_; |
| |
| /** State of the preprocessor (one per channel). Should never be accessed directly. */ |
| typedef struct SpeexPreprocessState_ SpeexPreprocessState; |
| |
| |
| /** Creates a new preprocessing state. You MUST create one state per channel processed. |
| * @param frame_size Number of samples to process at one time (should correspond to 10-20 ms). Must be |
| * the same value as that used for the echo canceller for residual echo cancellation to work. |
| * @param sampling_rate Sampling rate used for the input. |
| * @return Newly created preprocessor state |
| */ |
| SpeexPreprocessState *speex_preprocess_state_init(int frame_size, int sampling_rate); |
| |
| /** Destroys a preprocessor state |
| * @param st Preprocessor state to destroy |
| */ |
| void speex_preprocess_state_destroy(SpeexPreprocessState *st); |
| |
| /** Preprocess a frame |
| * @param st Preprocessor state |
| * @param x Audio sample vector (in and out). Must be same size as specified in speex_preprocess_state_init(). |
| * @return Bool value for voice activity (1 for speech, 0 for noise/silence), ONLY if VAD turned on. |
| */ |
| int speex_preprocess_run(SpeexPreprocessState *st, spx_int16_t *x); |
| |
| /** Preprocess a frame (deprecated, use speex_preprocess_run() instead)*/ |
| int speex_preprocess(SpeexPreprocessState *st, spx_int16_t *x, spx_int32_t *echo); |
| |
| /** Update preprocessor state, but do not compute the output |
| * @param st Preprocessor state |
| * @param x Audio sample vector (in only). Must be same size as specified in speex_preprocess_state_init(). |
| */ |
| void speex_preprocess_estimate_update(SpeexPreprocessState *st, spx_int16_t *x); |
| |
| /** Used like the ioctl function to control the preprocessor parameters |
| * @param st Preprocessor state |
| * @param request ioctl-type request (one of the SPEEX_PREPROCESS_* macros) |
| * @param ptr Data exchanged to-from function |
| * @return 0 if no error, -1 if request in unknown |
| */ |
| int speex_preprocess_ctl(SpeexPreprocessState *st, int request, void *ptr); |
| |
| |
| |
| /** Set preprocessor denoiser state */ |
| #define SPEEX_PREPROCESS_SET_DENOISE 0 |
| /** Get preprocessor denoiser state */ |
| #define SPEEX_PREPROCESS_GET_DENOISE 1 |
| |
| /** Set preprocessor Automatic Gain Control state */ |
| #define SPEEX_PREPROCESS_SET_AGC 2 |
| /** Get preprocessor Automatic Gain Control state */ |
| #define SPEEX_PREPROCESS_GET_AGC 3 |
| |
| /** Set preprocessor Voice Activity Detection state */ |
| #define SPEEX_PREPROCESS_SET_VAD 4 |
| /** Get preprocessor Voice Activity Detection state */ |
| #define SPEEX_PREPROCESS_GET_VAD 5 |
| |
| /** Set preprocessor Automatic Gain Control level (float) */ |
| #define SPEEX_PREPROCESS_SET_AGC_LEVEL 6 |
| /** Get preprocessor Automatic Gain Control level (float) */ |
| #define SPEEX_PREPROCESS_GET_AGC_LEVEL 7 |
| |
| /** Set preprocessor dereverb state */ |
| #define SPEEX_PREPROCESS_SET_DEREVERB 8 |
| /** Get preprocessor dereverb state */ |
| #define SPEEX_PREPROCESS_GET_DEREVERB 9 |
| |
| /** Set preprocessor dereverb level */ |
| #define SPEEX_PREPROCESS_SET_DEREVERB_LEVEL 10 |
| /** Get preprocessor dereverb level */ |
| #define SPEEX_PREPROCESS_GET_DEREVERB_LEVEL 11 |
| |
| /** Set preprocessor dereverb decay */ |
| #define SPEEX_PREPROCESS_SET_DEREVERB_DECAY 12 |
| /** Get preprocessor dereverb decay */ |
| #define SPEEX_PREPROCESS_GET_DEREVERB_DECAY 13 |
| |
| /** Set probability required for the VAD to go from silence to voice */ |
| #define SPEEX_PREPROCESS_SET_PROB_START 14 |
| /** Get probability required for the VAD to go from silence to voice */ |
| #define SPEEX_PREPROCESS_GET_PROB_START 15 |
| |
| /** Set probability required for the VAD to stay in the voice state (integer percent) */ |
| #define SPEEX_PREPROCESS_SET_PROB_CONTINUE 16 |
| /** Get probability required for the VAD to stay in the voice state (integer percent) */ |
| #define SPEEX_PREPROCESS_GET_PROB_CONTINUE 17 |
| |
| /** Set maximum attenuation of the noise in dB (negative number) */ |
| #define SPEEX_PREPROCESS_SET_NOISE_SUPPRESS 18 |
| /** Get maximum attenuation of the noise in dB (negative number) */ |
| #define SPEEX_PREPROCESS_GET_NOISE_SUPPRESS 19 |
| |
| /** Set maximum attenuation of the residual echo in dB (negative number) */ |
| #define SPEEX_PREPROCESS_SET_ECHO_SUPPRESS 20 |
| /** Get maximum attenuation of the residual echo in dB (negative number) */ |
| #define SPEEX_PREPROCESS_GET_ECHO_SUPPRESS 21 |
| |
| /** Set maximum attenuation of the residual echo in dB when near end is active (negative number) */ |
| #define SPEEX_PREPROCESS_SET_ECHO_SUPPRESS_ACTIVE 22 |
| /** Get maximum attenuation of the residual echo in dB when near end is active (negative number) */ |
| #define SPEEX_PREPROCESS_GET_ECHO_SUPPRESS_ACTIVE 23 |
| |
| /** Set the corresponding echo canceller state so that residual echo suppression can be performed (NULL for no residual echo suppression) */ |
| #define SPEEX_PREPROCESS_SET_ECHO_STATE 24 |
| /** Get the corresponding echo canceller state */ |
| #define SPEEX_PREPROCESS_GET_ECHO_STATE 25 |
| |
| /** Set maximal gain increase in dB/second (int32) */ |
| #define SPEEX_PREPROCESS_SET_AGC_INCREMENT 26 |
| |
| /** Get maximal gain increase in dB/second (int32) */ |
| #define SPEEX_PREPROCESS_GET_AGC_INCREMENT 27 |
| |
| /** Set maximal gain decrease in dB/second (int32) */ |
| #define SPEEX_PREPROCESS_SET_AGC_DECREMENT 28 |
| |
| /** Get maximal gain decrease in dB/second (int32) */ |
| #define SPEEX_PREPROCESS_GET_AGC_DECREMENT 29 |
| |
| /** Set maximal gain in dB (int32) */ |
| #define SPEEX_PREPROCESS_SET_AGC_MAX_GAIN 30 |
| |
| /** Get maximal gain in dB (int32) */ |
| #define SPEEX_PREPROCESS_GET_AGC_MAX_GAIN 31 |
| |
| /* Can't set loudness */ |
| /** Get loudness */ |
| #define SPEEX_PREPROCESS_GET_AGC_LOUDNESS 33 |
| |
| /* Can't set gain */ |
| /** Get current gain (int32 percent) */ |
| #define SPEEX_PREPROCESS_GET_AGC_GAIN 35 |
| |
| /* Can't set spectrum size */ |
| /** Get spectrum size for power spectrum (int32) */ |
| #define SPEEX_PREPROCESS_GET_PSD_SIZE 37 |
| |
| /* Can't set power spectrum */ |
| /** Get power spectrum (int32[] of squared values) */ |
| #define SPEEX_PREPROCESS_GET_PSD 39 |
| |
| /* Can't set noise size */ |
| /** Get spectrum size for noise estimate (int32) */ |
| #define SPEEX_PREPROCESS_GET_NOISE_PSD_SIZE 41 |
| |
| /* Can't set noise estimate */ |
| /** Get noise estimate (int32[] of squared values) */ |
| #define SPEEX_PREPROCESS_GET_NOISE_PSD 43 |
| |
| /* Can't set speech probability */ |
| /** Get speech probability in last frame (int32). */ |
| #define SPEEX_PREPROCESS_GET_PROB 45 |
| |
| /** Set preprocessor Automatic Gain Control level (int32) */ |
| #define SPEEX_PREPROCESS_SET_AGC_TARGET 46 |
| /** Get preprocessor Automatic Gain Control level (int32) */ |
| #define SPEEX_PREPROCESS_GET_AGC_TARGET 47 |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| /** @}*/ |
| #endif |