fixed-point: converted all signals to spx_sig_t
[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    char  *stack;          /**< Pseudo-stack allocation for temporary memory */
73    spx_sig_t *inBuf;          /**< Input buffer (original signal) */
74    spx_sig_t *frame;          /**< Start of original frame */
75    spx_sig_t *excBuf;         /**< Excitation buffer */
76    spx_sig_t *exc;            /**< Start of excitation frame */
77    spx_sig_t *exc2Buf;        /**< "Pitch enhanced" excitation */
78    spx_sig_t *exc2;           /**< "Pitch enhanced" excitation */
79    spx_sig_t *swBuf;          /**< Weighted signal buffer */
80    spx_sig_t *sw;             /**< Start of weighted signal frame */
81    spx_sig_t *innov;          /**< Innovation for the frame */
82    spx_word16_t *window;         /**< Temporary (Hanning) window */
83    spx_sig_t *buf2;           /**< 2nd temporary buffer */
84    spx_word16_t *autocorr;       /**< auto-correlation */
85    float *lagWindow;      /**< Window applied to auto-correlation */
86    spx_coef_t *lpc;            /**< LPCs for current frame */
87    float *lsp;            /**< LSPs for current frame */
88    float *qlsp;           /**< Quantized LSPs for current frame */
89    float *old_lsp;        /**< LSPs for previous frame */
90    float *old_qlsp;       /**< Quantized LSPs for previous frame */
91    float *interp_lsp;     /**< Interpolated LSPs */
92    float *interp_qlsp;    /**< Interpolated quantized LSPs */
93    spx_coef_t *interp_lpc;     /**< Interpolated LPCs */
94    spx_coef_t *interp_qlpc;    /**< Interpolated quantized LPCs */
95    spx_coef_t *bw_lpc1;        /**< LPCs after bandwidth expansion by gamma1 for perceptual weighting*/
96    spx_coef_t *bw_lpc2;        /**< LPCs after bandwidth expansion by gamma2 for perceptual weighting*/
97    spx_mem_t *mem_sp;         /**< Filter memory for signal synthesis */
98    spx_mem_t *mem_sw;         /**< Filter memory for perceptually-weighted signal */
99    spx_mem_t *mem_sw_whole;   /**< Filter memory for perceptually-weighted signal (whole frame)*/
100    spx_mem_t *mem_exc;        /**< Filter memory for excitation (whole frame) */
101    float *pi_gain;        /**< Gain of LPC filter at theta=pi (fe/2) */
102
103    VBRState *vbr;         /**< State of the VBR data */
104    float  vbr_quality;    /**< Quality setting for VBR encoding */
105    float  relative_quality; /**< Relative quality that will be needed by VBR */
106    int    vbr_enabled;    /**< 1 for enabling VBR, 0 otherwise */
107    int    vad_enabled;    /**< 1 for enabling VAD, 0 otherwise */
108    int    dtx_enabled;    /**< 1 for enabling DTX, 0 otherwise */
109    int    dtx_count;      /**< Number of consecutive DTX frames */
110    int    abr_enabled;    /**< ABR setting (in bps), 0 if off */
111    float  abr_drift;
112    float  abr_drift2;
113    float  abr_count;
114    int    complexity;     /**< Complexity setting (0-10 from least complex to most complex) */
115    int    sampling_rate;
116
117    int    encode_submode;
118    SpeexSubmode **submodes; /**< Sub-mode data */
119    int    submodeID;      /**< Activated sub-mode */
120    int    submodeSelect;  /**< Mode chosen by the user (may differ from submodeID if VAD is on) */
121 } EncState;
122
123 /**Structure representing the full state of the narrowband decoder*/
124 typedef struct DecState {
125    SpeexMode *mode;       /**< Mode corresponding to the state */
126    int    first;          /**< Is this the first frame? */
127    int    count_lost;     /**< Was the last frame lost? */
128    int    frameSize;      /**< Size of frames */
129    int    subframeSize;   /**< Size of sub-frames */
130    int    nbSubframes;    /**< Number of sub-frames */
131    int    windowSize;     /**< Analysis (LPC) window length */
132    int    lpcSize;        /**< LPC order */
133    int    bufSize;        /**< Buffer size */
134    int    min_pitch;      /**< Minimum pitch value allowed */
135    int    max_pitch;      /**< Maximum pitch value allowed */
136    int    sampling_rate;
137
138 #ifdef EPIC_48K
139    int    lbr_48k;
140 #endif
141
142    float  last_ol_gain;   /**< Open-loop gain for previous frame */
143
144    float  gamma1;         /**< Perceptual filter: A(z/gamma1) */
145    float  gamma2;         /**< Perceptual filter: A(z/gamma2) */
146    char  *stack;          /**< Pseudo-stack allocation for temporary memory */
147    spx_sig_t *inBuf;          /**< Input buffer (original signal) */
148    spx_sig_t *frame;          /**< Start of original frame */
149    spx_sig_t *excBuf;         /**< Excitation buffer */
150    spx_sig_t *exc;            /**< Start of excitation frame */
151    spx_sig_t *innov;          /**< Innovation for the frame */
152    float *qlsp;           /**< Quantized LSPs for current frame */
153    float *old_qlsp;       /**< Quantized LSPs for previous frame */
154    float *interp_qlsp;    /**< Interpolated quantized LSPs */
155    spx_coef_t *interp_qlpc;    /**< Interpolated quantized LPCs */
156    spx_mem_t *mem_sp;         /**< Filter memory for synthesis signal */
157    float *pi_gain;        /**< Gain of LPC filter at theta=pi (fe/2) */
158    int    last_pitch;     /**< Pitch of last correctly decoded frame */
159    float  last_pitch_gain; /**< Pitch gain of last correctly decoded frame */
160    float  pitch_gain_buf[3];  /**< Pitch gain of last decoded frames */
161    int    pitch_gain_buf_idx; /**< Tail of the buffer */
162
163    int    encode_submode;
164    SpeexSubmode **submodes; /**< Sub-mode data */
165    int    submodeID;      /**< Activated sub-mode */
166    int    lpc_enh_enabled; /**< 1 when LPC enhancer is on, 0 otherwise */
167    CombFilterMem *comb_mem;
168    SpeexCallback speex_callbacks[SPEEX_MAX_CALLBACKS];
169
170    SpeexCallback user_callback;
171
172    /*Vocoder data*/
173    float  voc_m1;
174    float  voc_m2;
175    float  voc_mean;
176    int    voc_offset;
177
178    int    dtx_enabled;
179 } DecState;
180
181 /** Initializes encoder state*/
182 void *nb_encoder_init(SpeexMode *m);
183
184 /** De-allocates encoder state resources*/
185 void nb_encoder_destroy(void *state);
186
187 /** Encodes one frame*/
188 int nb_encode(void *state, float *in, SpeexBits *bits);
189
190
191 /** Initializes decoder state*/
192 void *nb_decoder_init(SpeexMode *m);
193
194 /** De-allocates decoder state resources*/
195 void nb_decoder_destroy(void *state);
196
197 /** Decodes one frame*/
198 int nb_decode(void *state, SpeexBits *bits, float *out);
199
200 /** ioctl-like function for controlling a narrowband encoder */
201 int nb_encoder_ctl(void *state, int request, void *ptr);
202
203 /** ioctl-like function for controlling a narrowband decoder */
204 int nb_decoder_ctl(void *state, int request, void *ptr);
205
206
207 #endif