cleaning up for 1.1
[speexdsp.git] / libspeex / nb_celp.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3     @file nb_celp.h
4     @brief Narrowband CELP encoder/decoder
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - 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    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34 */
35
36 #ifndef NB_CELP_H
37 #define NB_CELP_H
38
39 #include "modes.h"
40 #include "speex_bits.h"
41 #include "speex_callbacks.h"
42 #include "vbr.h"
43 #include "filters.h"
44
45 /**Structure representing the full state of the narrowband encoder*/
46 typedef struct EncState {
47    SpeexMode *mode;       /**< Mode corresponding to the state */
48    int    first;          /**< Is this the first frame? */
49    int    frameSize;      /**< Size of frames */
50    int    subframeSize;   /**< Size of sub-frames */
51    int    nbSubframes;    /**< Number of sub-frames */
52    int    windowSize;     /**< Analysis (LPC) window length */
53    int    lpcSize;        /**< LPC order */
54    int    bufSize;        /**< Buffer size */
55    int    min_pitch;      /**< Minimum pitch value allowed */
56    int    max_pitch;      /**< Maximum pitch value allowed */
57
58    int    safe_pitch;     /**< Don't use too large values for pitch (in case we lose a packet) */
59    int    bounded_pitch;  /**< Next frame should not rely on previous frames for pitch */
60    int    ol_pitch;       /**< Open-loop pitch */
61    int    ol_voiced;      /**< Open-loop voiced/non-voiced decision */
62    int   *pitch;
63
64 #ifdef EPIC_48K
65    int    lbr_48k;
66 #endif
67
68    float  gamma1;         /**< Perceptual filter: A(z/gamma1) */
69    float  gamma2;         /**< Perceptual filter: A(z/gamma2) */
70    float  lag_factor;     /**< Lag windowing Gaussian width */
71    float  lpc_floor;      /**< Noise floor multiplier for A[0] in LPC analysis*/
72    float  preemph;        /**< Pre-emphasis: P(z) = 1 - a*z^-1*/
73    float  pre_mem;        /**< 1-element memory for pre-emphasis */
74    float  pre_mem2;       /**< 1-element memory for pre-emphasis */
75    char  *stack;          /**< Pseudo-stack allocation for temporary memory */
76    float *inBuf;          /**< Input buffer (original signal) */
77    float *frame;          /**< Start of original frame */
78    float *excBuf;         /**< Excitation buffer */
79    float *exc;            /**< Start of excitation frame */
80    float *exc2Buf;        /**< "Pitch enhanced" excitation */
81    float *exc2;           /**< "Pitch enhanced" excitation */
82    float *swBuf;          /**< Weighted signal buffer */
83    float *sw;             /**< Start of weighted signal frame */
84    float *innov;          /**< Innovation for the frame */
85    float *window;         /**< Temporary (Hanning) window */
86    float *buf2;           /**< 2nd temporary buffer */
87    float *autocorr;       /**< auto-correlation */
88    float *lagWindow;      /**< Window applied to auto-correlation */
89    float *lpc;            /**< LPCs for current frame */
90    float *lsp;            /**< LSPs for current frame */
91    float *qlsp;           /**< Quantized LSPs for current frame */
92    float *old_lsp;        /**< LSPs for previous frame */
93    float *old_qlsp;       /**< Quantized LSPs for previous frame */
94    float *interp_lsp;     /**< Interpolated LSPs */
95    float *interp_qlsp;    /**< Interpolated quantized LSPs */
96    float *interp_lpc;     /**< Interpolated LPCs */
97    float *interp_qlpc;    /**< Interpolated quantized LPCs */
98    float *bw_lpc1;        /**< LPCs after bandwidth expansion by gamma1 for perceptual weighting*/
99    float *bw_lpc2;        /**< LPCs after bandwidth expansion by gamma2 for perceptual weighting*/
100    float *mem_sp;         /**< Filter memory for signal synthesis */
101    float *mem_sw;         /**< Filter memory for perceptually-weighted signal */
102    float *mem_sw_whole;   /**< Filter memory for perceptually-weighted signal (whole frame)*/
103    float *mem_exc;        /**< Filter memory for excitation (whole frame) */
104    float *pi_gain;        /**< Gain of LPC filter at theta=pi (fe/2) */
105
106    VBRState *vbr;         /**< State of the VBR data */
107    float  vbr_quality;    /**< Quality setting for VBR encoding */
108    float  relative_quality; /**< Relative quality that will be needed by VBR */
109    int    vbr_enabled;    /**< 1 for enabling VBR, 0 otherwise */
110    int    vad_enabled;    /**< 1 for enabling VAD, 0 otherwise */
111    int    dtx_enabled;    /**< 1 for enabling DTX, 0 otherwise */
112    int    dtx_count;      /**< Number of consecutive DTX frames */
113    int    abr_enabled;    /**< ABR setting (in bps), 0 if off */
114    float  abr_drift;
115    float  abr_drift2;
116    float  abr_count;
117    int    complexity;     /**< Complexity setting (0-10 from least complex to most complex) */
118    int    sampling_rate;
119
120    int    encode_submode;
121    SpeexSubmode **submodes; /**< Sub-mode data */
122    int    submodeID;      /**< Activated sub-mode */
123    int    submodeSelect;  /**< Mode chosen by the user (may differ from submodeID if VAD is on) */
124 } EncState;
125
126 /**Structure representing the full state of the narrowband decoder*/
127 typedef struct DecState {
128    SpeexMode *mode;       /**< Mode corresponding to the state */
129    int    first;          /**< Is this the first frame? */
130    int    count_lost;     /**< Was the last frame lost? */
131    int    frameSize;      /**< Size of frames */
132    int    subframeSize;   /**< Size of sub-frames */
133    int    nbSubframes;    /**< Number of sub-frames */
134    int    windowSize;     /**< Analysis (LPC) window length */
135    int    lpcSize;        /**< LPC order */
136    int    bufSize;        /**< Buffer size */
137    int    min_pitch;      /**< Minimum pitch value allowed */
138    int    max_pitch;      /**< Maximum pitch value allowed */
139    int    sampling_rate;
140
141 #ifdef EPIC_48K
142    int    lbr_48k;
143 #endif
144
145    float  last_ol_gain;   /**< Open-loop gain for previous frame */
146
147    float  gamma1;         /**< Perceptual filter: A(z/gamma1) */
148    float  gamma2;         /**< Perceptual filter: A(z/gamma2) */
149    float  preemph;        /**< Pre-emphasis: P(z) = 1 - a*z^-1*/
150    float  pre_mem;        /**< 1-element memory for pre-emphasis */
151    char  *stack;          /**< Pseudo-stack allocation for temporary memory */
152    float *inBuf;          /**< Input buffer (original signal) */
153    float *frame;          /**< Start of original frame */
154    float *excBuf;         /**< Excitation buffer */
155    float *exc;            /**< Start of excitation frame */
156    float *innov;          /**< Innovation for the frame */
157    float *qlsp;           /**< Quantized LSPs for current frame */
158    float *old_qlsp;       /**< Quantized LSPs for previous frame */
159    float *interp_qlsp;    /**< Interpolated quantized LSPs */
160    float *interp_qlpc;    /**< Interpolated quantized LPCs */
161    float *mem_sp;         /**< Filter memory for synthesis signal */
162    float *pi_gain;        /**< Gain of LPC filter at theta=pi (fe/2) */
163    int    last_pitch;     /**< Pitch of last correctly decoded frame */
164    float  last_pitch_gain; /**< Pitch gain of last correctly decoded frame */
165    float  pitch_gain_buf[3];  /**< Pitch gain of last decoded frames */
166    int    pitch_gain_buf_idx; /**< Tail of the buffer */
167
168    int    encode_submode;
169    SpeexSubmode **submodes; /**< Sub-mode data */
170    int    submodeID;      /**< Activated sub-mode */
171    int    lpc_enh_enabled; /**< 1 when LPC enhancer is on, 0 otherwise */
172    CombFilterMem *comb_mem;
173    SpeexCallback speex_callbacks[SPEEX_MAX_CALLBACKS];
174
175    SpeexCallback user_callback;
176
177    /*Vocoder data*/
178    float  voc_m1;
179    float  voc_m2;
180    float  voc_mean;
181    int    voc_offset;
182
183    int    dtx_enabled;
184 } DecState;
185
186 /** Initializes encoder state*/
187 void *nb_encoder_init(SpeexMode *m);
188
189 /** De-allocates encoder state resources*/
190 void nb_encoder_destroy(void *state);
191
192 /** Encodes one frame*/
193 int nb_encode(void *state, float *in, SpeexBits *bits);
194
195
196 /** Initializes decoder state*/
197 void *nb_decoder_init(SpeexMode *m);
198
199 /** De-allocates decoder state resources*/
200 void nb_decoder_destroy(void *state);
201
202 /** Decodes one frame*/
203 int nb_decode(void *state, SpeexBits *bits, float *out);
204
205 /** ioctl-like function for controlling a narrowband encoder */
206 int nb_encoder_ctl(void *state, int request, void *ptr);
207
208 /** ioctl-like function for controlling a narrowband decoder */
209 int nb_decoder_ctl(void *state, int request, void *ptr);
210
211
212 #endif