Fixed a bunch of typos pointed to by: larry@doolittle.boa.org
[speexdsp.git] / libspeex / sb_celp.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3    @file sb_celp.h
4    @brief Sub-band CELP mode used for wideband encoding
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 SB_CELP_H
37 #define SB_CELP_H
38
39 #include "modes.h"
40 #include "speex_bits.h"
41 #include "nb_celp.h"
42
43 /**Structure representing the full state of the sub-band encoder*/
44 typedef struct SBEncState {
45    SpeexMode *mode;            /**< Pointer to the mode (containing for vtable info) */
46    void *st_low;               /**< State of the low-band (narrowband) encoder */
47    int    full_frame_size;     /**< Length of full-band frames*/
48    int    frame_size;          /**< Length of high-band frames*/
49    int    subframeSize;        /**< Length of high-band sub-frames*/
50    int    nbSubframes;         /**< Number of high-band sub-frames*/
51    int    windowSize;          /**< Length of high-band LPC window*/
52    int    lpcSize;             /**< Order of high-band LPC analysis */
53    int    bufSize;             /**< Buffer size */
54    int    first;               /**< First frame? */
55    float  lag_factor;          /**< Lag-windowing control parameter */
56    float  lpc_floor;           /**< Controls LPC analysis noise floor */
57    float  gamma1;              /**< Perceptual weighting coef 1 */
58    float  gamma2;              /**< Perceptual weighting coef 2 */
59
60    char  *stack;               /**< Temporary allocation stack */
61    float *x0d, *x1d; /**< QMF filter signals*/
62    float *high;                /**< High-band signal (buffer) */
63    float *y0, *y1;             /**< QMF synthesis signals */
64    float *h0_mem, *h1_mem, *g0_mem, *g1_mem; /**< QMF memories */
65
66    float *excBuf;              /**< High-band excitation */
67    float *exc;                 /**< High-band excitation (for QMF only)*/
68    float *buf;                 /**< Temporary buffer */
69    float *res;                 /**< Zero-input response (ringing) */
70    float *sw;                  /**< Perceptually weighted signal */
71    float *target;              /**< Weighted target signal (analysis by synthesis) */
72    float *window;              /**< LPC analysis window */
73    float *lagWindow;           /**< Auto-correlation window */
74    float *autocorr;            /**< Auto-correlation (for LPC analysis) */
75    float *rc;                  /**< Reflection coefficients (unused) */
76    float *lpc;                 /**< LPC coefficients */
77    float *lsp;                 /**< LSP coefficients */
78    float *qlsp;                /**< Quantized LSPs */
79    float *old_lsp;             /**< LSPs of previous frame */
80    float *old_qlsp;            /**< Quantized LSPs of previous frame */
81    float *interp_lsp;          /**< Interpolated LSPs for current sub-frame */
82    float *interp_qlsp;         /**< Interpolated quantized LSPs for current sub-frame */
83    float *interp_lpc;          /**< Interpolated LPCs for current sub-frame */
84    float *interp_qlpc;         /**< Interpolated quantized LPCs for current sub-frame */
85    float *bw_lpc1;             /**< Bandwidth-expanded version of LPCs (#1) */
86    float *bw_lpc2;             /**< Bandwidth-expanded version of LPCs (#2) */
87
88    float *mem_sp;              /**< Synthesis signal memory */
89    float *mem_sp2;
90    float *mem_sw;              /**< Perceptual signal memory */
91    float *pi_gain;
92
93    float  vbr_quality;         /**< Quality setting for VBR encoding */
94    int    vbr_enabled;         /**< 1 for enabling VBR, 0 otherwise */
95    int    abr_enabled;         /**< ABR setting (in bps), 0 if off */
96    float  abr_drift;
97    float  abr_drift2;
98    float  abr_count;
99    int    vad_enabled;         /**< 1 for enabling VAD, 0 otherwise */
100    float  relative_quality;
101
102    SpeexSubmode **submodes;
103    int    submodeID;
104    int    submodeSelect;
105    int    complexity;
106    int    sampling_rate;
107
108 } SBEncState;
109
110
111 /**Structure representing the full state of the sub-band decoder*/
112 typedef struct SBDecState {
113    SpeexMode *mode;            /**< Pointer to the mode (containing for vtable info) */
114    void *st_low;               /**< State of the low-band (narrowband) encoder */
115    int    full_frame_size;
116    int    frame_size;
117    int    subframeSize;
118    int    nbSubframes;
119    int    lpcSize;
120    int    first;
121    int    sampling_rate;
122    int    lpc_enh_enabled;
123
124    char  *stack;
125    float *x0d, *x1d;
126    float *high;
127    float *y0, *y1;
128    float *h0_mem, *h1_mem, *g0_mem, *g1_mem;
129
130    float *exc;
131    float *qlsp;
132    float *old_qlsp;
133    float *interp_qlsp;
134    float *interp_qlpc;
135
136    float *mem_sp;
137    float *pi_gain;
138
139    SpeexSubmode **submodes;
140    int    submodeID;
141 } SBDecState;
142
143
144 /**Initializes encoder state*/
145 void *sb_encoder_init(SpeexMode *m);
146
147 /**De-allocates encoder state resources*/
148 void sb_encoder_destroy(void *state);
149
150 /**Encodes one frame*/
151 int sb_encode(void *state, float *in, SpeexBits *bits);
152
153
154 /**Initializes decoder state*/
155 void *sb_decoder_init(SpeexMode *m);
156
157 /**De-allocates decoder state resources*/
158 void sb_decoder_destroy(void *state);
159
160 /**Decodes one frame*/
161 int sb_decode(void *state, SpeexBits *bits, float *out);
162
163 int sb_encoder_ctl(void *state, int request, void *ptr);
164
165 int sb_decoder_ctl(void *state, int request, void *ptr);
166
167 #endif