Most of the narrowband array sizes are now compile-time constants
[speexdsp.git] / libspeex / nb_celp.h
1 /* Copyright (C) 2002-2006 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 "../include/speex/speex_bits.h"
41 #include "../include/speex/speex_callbacks.h"
42 #include "vbr.h"
43 #include "filters.h"
44
45 #ifdef VORBIS_PSYCHO
46 #include "vorbis_psy.h"
47 #endif
48
49 #define NB_ORDER 10
50 #define NB_FRAME_SIZE 160
51 #define NB_SUBFRAME_SIZE 40
52 #define NB_NB_SUBFRAMES 4
53 #define NB_PITCH_START 17
54 #define NB_PITCH_END 144
55
56 #define NB_WINDOW_SIZE (NB_FRAME_SIZE+NB_SUBFRAME_SIZE)
57 #define NB_EXCBUF (NB_FRAME_SIZE+NB_PITCH_END+2)
58 #define NB_DEC_BUFFER (NB_FRAME_SIZE+2*NB_PITCH_END+NB_SUBFRAME_SIZE+12)
59 /**Structure representing the full state of the narrowband encoder*/
60 typedef struct EncState {
61    const SpeexMode *mode;        /**< Mode corresponding to the state */
62    int    first;                 /**< Is this the first frame? */
63
64    spx_word32_t cumul_gain;      /**< Product of previously used pitch gains (Q10) */
65    int    bounded_pitch;         /**< Next frame should not rely on previous frames for pitch */
66    int    ol_pitch;              /**< Open-loop pitch */
67    int    ol_voiced;             /**< Open-loop voiced/non-voiced decision */
68    int   pitch[NB_NB_SUBFRAMES];
69
70 #ifdef VORBIS_PSYCHO
71    VorbisPsy *psy;
72    float *psy_window;
73    float *curve;
74    float *old_curve;
75 #endif
76
77    spx_word16_t  gamma1;         /**< Perceptual filter: A(z/gamma1) */
78    spx_word16_t  gamma2;         /**< Perceptual filter: A(z/gamma2) */
79    spx_word16_t  lpc_floor;      /**< Noise floor multiplier for A[0] in LPC analysis*/
80    char  *stack;                 /**< Pseudo-stack allocation for temporary memory */
81    spx_word16_t winBuf[NB_WINDOW_SIZE-NB_FRAME_SIZE];         /**< Input buffer (original signal) */
82    spx_word16_t excBuf[NB_EXCBUF];         /**< Excitation buffer */
83    spx_word16_t *exc;            /**< Start of excitation frame */
84    spx_word16_t swBuf[NB_EXCBUF];          /**< Weighted signal buffer */
85    spx_word16_t *sw;             /**< Start of weighted signal frame */
86    const spx_word16_t *window;   /**< Temporary (Hanning) window */
87    const spx_word16_t *lagWindow;      /**< Window applied to auto-correlation */
88    spx_lsp_t old_lsp[NB_ORDER];           /**< LSPs for previous frame */
89    spx_lsp_t old_qlsp[NB_ORDER];          /**< Quantized LSPs for previous frame */
90    spx_mem_t mem_sp[NB_ORDER];            /**< Filter memory for signal synthesis */
91    spx_mem_t mem_sw[NB_ORDER];            /**< Filter memory for perceptually-weighted signal */
92    spx_mem_t mem_sw_whole[NB_ORDER];      /**< Filter memory for perceptually-weighted signal (whole frame)*/
93    spx_mem_t mem_exc[NB_ORDER];           /**< Filter memory for excitation (whole frame) */
94    spx_mem_t mem_exc2[NB_ORDER];          /**< Filter memory for excitation (whole frame) */
95    spx_mem_t mem_hp[2];          /**< High-pass filter memory */
96    spx_word32_t pi_gain[NB_NB_SUBFRAMES];        /**< Gain of LPC filter at theta=pi (fe/2) */
97    spx_word16_t *innov_rms_save; /**< If non-NULL, innovation RMS is copied here */
98
99 #ifndef DISABLE_VBR
100    VBRState vbr;                /**< State of the VBR data */
101    float  vbr_quality;           /**< Quality setting for VBR encoding */
102    float  relative_quality;      /**< Relative quality that will be needed by VBR */
103    spx_int32_t vbr_enabled;      /**< 1 for enabling VBR, 0 otherwise */
104    spx_int32_t vbr_max;          /**< Max bit-rate allowed in VBR mode */
105    int    vad_enabled;           /**< 1 for enabling VAD, 0 otherwise */
106    int    dtx_enabled;           /**< 1 for enabling DTX, 0 otherwise */
107    int    dtx_count;             /**< Number of consecutive DTX frames */
108    spx_int32_t abr_enabled;      /**< ABR setting (in bps), 0 if off */
109    float  abr_drift;
110    float  abr_drift2;
111    float  abr_count;
112 #endif /* #ifndef DISABLE_VBR */
113    
114    int    complexity;            /**< Complexity setting (0-10 from least complex to most complex) */
115    spx_int32_t sampling_rate;
116    int    plc_tuning;
117    int    encode_submode;
118    const SpeexSubmode * const *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    int    isWideband;            /**< Is this used as part of the embedded wideband codec */
122    int    highpass_enabled;        /**< Is the input filter enabled */
123 } EncState;
124
125 /**Structure representing the full state of the narrowband decoder*/
126 typedef struct DecState {
127    const SpeexMode *mode;       /**< Mode corresponding to the state */
128    int    first;                /**< Is this the first frame? */
129    int    count_lost;           /**< Was the last frame lost? */
130    spx_int32_t sampling_rate;
131
132    spx_word16_t  last_ol_gain;  /**< Open-loop gain for previous frame */
133
134    char  *stack;                /**< Pseudo-stack allocation for temporary memory */
135    spx_word16_t excBuf[NB_DEC_BUFFER];        /**< Excitation buffer */
136    spx_word16_t *exc;           /**< Start of excitation frame */
137    spx_lsp_t old_qlsp[NB_ORDER];         /**< Quantized LSPs for previous frame */
138    spx_coef_t interp_qlpc[NB_ORDER];     /**< Interpolated quantized LPCs */
139    spx_mem_t mem_sp[NB_ORDER];           /**< Filter memory for synthesis signal */
140    spx_mem_t mem_hp[2];         /**< High-pass filter memory */
141    spx_word32_t pi_gain[NB_NB_SUBFRAMES];       /**< Gain of LPC filter at theta=pi (fe/2) */
142    spx_word16_t *innov_save;    /** If non-NULL, innovation is copied here */
143    
144    spx_word16_t level;
145    spx_word16_t max_level;
146    spx_word16_t min_level;
147    
148    /* This is used in packet loss concealment */
149    int    last_pitch;           /**< Pitch of last correctly decoded frame */
150    spx_word16_t  last_pitch_gain; /**< Pitch gain of last correctly decoded frame */
151    spx_word16_t  pitch_gain_buf[3]; /**< Pitch gain of last decoded frames */
152    int    pitch_gain_buf_idx;   /**< Tail of the buffer */
153    spx_int32_t seed;            /** Seed used for random number generation */
154    
155    int    encode_submode;
156    const SpeexSubmode * const *submodes; /**< Sub-mode data */
157    int    submodeID;            /**< Activated sub-mode */
158    int    lpc_enh_enabled;      /**< 1 when LPC enhancer is on, 0 otherwise */
159    SpeexCallback speex_callbacks[SPEEX_MAX_CALLBACKS];
160
161    SpeexCallback user_callback;
162
163    /*Vocoder data*/
164    spx_word16_t  voc_m1;
165    spx_word32_t  voc_m2;
166    spx_word16_t  voc_mean;
167    int    voc_offset;
168
169    int    dtx_enabled;
170    int    isWideband;            /**< Is this used as part of the embedded wideband codec */
171    int    highpass_enabled;        /**< Is the input filter enabled */
172 } DecState;
173
174 /** Initializes encoder state*/
175 void *nb_encoder_init(const SpeexMode *m);
176
177 /** De-allocates encoder state resources*/
178 void nb_encoder_destroy(void *state);
179
180 /** Encodes one frame*/
181 int nb_encode(void *state, void *in, SpeexBits *bits);
182
183
184 /** Initializes decoder state*/
185 void *nb_decoder_init(const SpeexMode *m);
186
187 /** De-allocates decoder state resources*/
188 void nb_decoder_destroy(void *state);
189
190 /** Decodes one frame*/
191 int nb_decode(void *state, SpeexBits *bits, void *out);
192
193 /** ioctl-like function for controlling a narrowband encoder */
194 int nb_encoder_ctl(void *state, int request, void *ptr);
195
196 /** ioctl-like function for controlling a narrowband decoder */
197 int nb_decoder_ctl(void *state, int request, void *ptr);
198
199
200 #endif