Starting (still incomplete) average bit-rate (ABR) implementation
[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
44 /**Structure representing the full state of the narrowband encoder*/
45 typedef struct EncState {
46    SpeexMode *mode;       /**< Mode curresponding to the state */
47    int    first;          /**< Is this the first frame? */
48    int    frameSize;      /**< Size of frames */
49    int    subframeSize;   /**< Size of sub-frames */
50    int    nbSubframes;    /**< Number of sub-frames */
51    int    windowSize;     /**< Analysis (LPC) window length */
52    int    lpcSize;        /**< LPC order */
53    int    bufSize;        /**< Buffer size */
54    int    min_pitch;      /**< Minimum pitch value allowed */
55    int    max_pitch;      /**< Maximum pitch value allowed */
56
57    int    safe_pitch;     /**< Don't use too large values for pitch (in case we lose a packet) */
58    int    bounded_pitch;  /**< Next frame should not rely on previous frames for pitch */
59    int    ol_pitch;       /**< Open-loop pitch */
60    int    ol_voiced;      /**< Open-loop voiced/non-voiced decision */
61    int   *pitch;
62    float  gamma1;         /**< Perceptual filter: A(z/gamma1) */
63    float  gamma2;         /**< Perceptual filter: A(z/gamma2) */
64    float  lag_factor;     /**< Lag windowing gaussian width */
65    float  lpc_floor;      /**< Noise floor multiplier for A[0] in LPC analysis*/
66    float  preemph;        /**< Pre-emphasis: P(z) = 1 - a*z^-1*/
67    float  pre_mem;        /**< 1-element memory for pre-emphasis */
68    float  pre_mem2;       /**< 1-element memory for pre-emphasis */
69    void  *stack;          /**< Pseudo-stack allocation for temporary memory */
70    float *inBuf;          /**< Input buffer (original signal) */
71    float *frame;          /**< Start of original frame */
72    float *excBuf;         /**< Excitation buffer */
73    float *exc;            /**< Start of excitation frame */
74    float *exc2Buf;        /**< "Pitch enhanced" excitation */
75    float *exc2;           /**< "Pitch enhanced" excitation */
76    float *swBuf;          /**< Weighted signal buffer */
77    float *sw;             /**< Start of weighted signal frame */
78    float *innov;          /**< Innovation for the frame */
79    float *window;         /**< Temporary (Hanning) window */
80    float *buf2;           /**< 2nd temporary buffer */
81    float *autocorr;       /**< auto-correlation */
82    float *lagWindow;      /**< Window applied to auto-correlation */
83    float *lpc;            /**< LPCs for current frame */
84    float *lsp;            /**< LSPs for current frame */
85    float *qlsp;           /**< Quantized LSPs for current frame */
86    float *old_lsp;        /**< LSPs for previous frame */
87    float *old_qlsp;       /**< Quantized LSPs for previous frame */
88    float *interp_lsp;     /**< Interpolated LSPs */
89    float *interp_qlsp;    /**< Interpolated quantized LSPs */
90    float *interp_lpc;     /**< Interpolated LPCs */
91    float *interp_qlpc;    /**< Interpolated quantized LPCs */
92    float *bw_lpc1;        /**< LPCs after bandwidth expansion by gamma1 for perceptual weighting*/
93    float *bw_lpc2;        /**< LPCs after bandwidth expansion by gamma2 for perceptual weighting*/
94    float *rc;             /**< Reflection coefficients */
95    float *mem_sp;         /**< Filter memory for signal synthesis */
96    float *mem_sw;         /**< Filter memory for perceptually-weighted signal */
97    float *mem_sw_whole;   /**< Filter memory for perceptually-weighted signal (whole frame)*/
98    float *mem_exc;        /**< Filter memory for excitation (whole frame) */
99    float *pi_gain;        /**< Gain of LPC filter at theta=pi (fe/2) */
100
101    VBRState *vbr;         /**< State of the VBR data */
102    float  vbr_quality;    /**< Quality setting for VBR encoding */
103    float  relative_quality; /**< Relative quality that will be needed by VBR */
104    int    vbr_enabled;    /**< 1 for enabling VBR, 0 otherwise */
105    int    vad_enabled;    /**< 1 for enabling VAD, 0 otherwise */
106    int    abr_enabled;    /**< 1 for enabling ABR, 0 otherwise */
107    float  abr_drift;
108    int    complexity;     /**< Complexity setting (0-10 from least complex to most complex) */
109    int    sampling_rate;
110
111    SpeexSubmode **submodes; /**< Sub-mode data */
112    int    submodeID;      /**< Activated sub-mode */
113    int    submodeSelect;  /**< Mode chosen by the user (may differ from submodeID if VAD is on) */
114 } EncState;
115
116 /**Structure representing the full state of the narrowband decoder*/
117 typedef struct DecState {
118    SpeexMode *mode;       /**< Mode curresponding to the state */
119    int    first;          /**< Is this the first frame? */
120    int    count_lost;     /**< Was the last frame lost? */
121    int    frameSize;      /**< Size of frames */
122    int    subframeSize;   /**< Size of sub-frames */
123    int    nbSubframes;    /**< Number of sub-frames */
124    int    windowSize;     /**< Analysis (LPC) window length */
125    int    lpcSize;        /**< LPC order */
126    int    bufSize;        /**< Buffer size */
127    int    min_pitch;      /**< Minimum pitch value allowed */
128    int    max_pitch;      /**< Maximum pitch value allowed */
129    int    sampling_rate;
130    int    last_ol_gain;   /**< Open-loop gain for previous frame */
131
132
133    float  gamma1;         /**< Perceptual filter: A(z/gamma1) */
134    float  gamma2;         /**< Perceptual filter: A(z/gamma2) */
135    float  preemph;        /**< Pre-emphasis: P(z) = 1 - a*z^-1*/
136    float  pre_mem;        /**< 1-element memory for pre-emphasis */
137    void  *stack;          /**< Pseudo-stack allocation for temporary memory */
138    float *inBuf;          /**< Input buffer (original signal) */
139    float *frame;          /**< Start of original frame */
140    float *excBuf;         /**< Excitation buffer */
141    float *exc;            /**< Start of excitation frame */
142    float *innov;          /**< Innovation for the frame */
143    float *qlsp;           /**< Quantized LSPs for current frame */
144    float *old_qlsp;       /**< Quantized LSPs for previous frame */
145    float *interp_qlsp;    /**< Interpolated quantized LSPs */
146    float *interp_qlpc;    /**< Interpolated quantized LPCs */
147    float *mem_sp;         /**< Filter memory for synthesis signal */
148    float *pi_gain;        /**< Gain of LPC filter at theta=pi (fe/2) */
149    int    last_pitch;     /**< Pitch of last correctly decoded frame */
150    float  last_pitch_gain; /**< Pitch gain of last correctly decoded frame */
151    float  pitch_gain_buf[3];  /**< Pitch gain of last decoded frames */
152    int    pitch_gain_buf_idx; /**< Tail of the buffer */
153
154    SpeexSubmode **submodes; /**< Sub-mode data */
155    int    submodeID;      /**< Activated sub-mode */
156    int    lpc_enh_enabled; /**< 1 when LPC enhancer is on, 0 otherwise */
157
158    SpeexCallback speex_callbacks[SPEEX_MAX_CALLBACKS];
159
160    SpeexCallback user_callback;
161
162    /*Vocoder data*/
163    float  voc_m1;
164    float  voc_m2;
165    float  voc_mean;
166    int    voc_offset;
167 } DecState;
168
169 /** Initializes encoder state*/
170 void *nb_encoder_init(SpeexMode *m);
171
172 /** De-allocates encoder state resources*/
173 void nb_encoder_destroy(void *state);
174
175 /** Encodes one frame*/
176 void nb_encode(void *state, float *in, SpeexBits *bits);
177
178
179 /** Initializes decoder state*/
180 void *nb_decoder_init(SpeexMode *m);
181
182 /** De-allocates decoder state resources*/
183 void nb_decoder_destroy(void *state);
184
185 /** Decodes one frame*/
186 int nb_decode(void *state, SpeexBits *bits, float *out);
187
188 /** ioctl-like function for controlling a narrowband encoder */
189 void nb_encoder_ctl(void *state, int request, void *ptr);
190
191 /** ioctl-like function for controlling a narrowband decoder */
192 void nb_decoder_ctl(void *state, int request, void *ptr);
193
194
195 #endif