jitter buffer: make tick() a tiny bit smarter.
[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 <speex/speex_bits.h>
41 #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 /**Structure representing the full state of the narrowband encoder*/
50 typedef struct EncState {
51    const SpeexMode *mode;        /**< Mode corresponding to the state */
52    int    first;                 /**< Is this the first frame? */
53    int    frameSize;             /**< Size of frames */
54    int    subframeSize;          /**< Size of sub-frames */
55    int    nbSubframes;           /**< Number of sub-frames */
56    int    windowSize;            /**< Analysis (LPC) window length */
57    int    lpcSize;               /**< LPC order */
58    int    min_pitch;             /**< Minimum pitch value allowed */
59    int    max_pitch;             /**< Maximum pitch value allowed */
60
61    spx_word32_t cumul_gain;      /**< Product of previously used pitch gains (Q10) */
62    int    bounded_pitch;         /**< Next frame should not rely on previous frames for pitch */
63    int    ol_pitch;              /**< Open-loop pitch */
64    int    ol_voiced;             /**< Open-loop voiced/non-voiced decision */
65    int   *pitch;
66
67 #ifdef VORBIS_PSYCHO
68    VorbisPsy *psy;
69    float *psy_window;
70    float *curve;
71    float *old_curve;
72 #endif
73
74    spx_word16_t  gamma1;         /**< Perceptual filter: A(z/gamma1) */
75    spx_word16_t  gamma2;         /**< Perceptual filter: A(z/gamma2) */
76    spx_word16_t  lpc_floor;      /**< Noise floor multiplier for A[0] in LPC analysis*/
77    char  *stack;                 /**< Pseudo-stack allocation for temporary memory */
78    spx_word16_t *winBuf;         /**< Input buffer (original signal) */
79    spx_word16_t *excBuf;         /**< Excitation buffer */
80    spx_word16_t *exc;            /**< Start of excitation frame */
81    spx_word16_t *swBuf;          /**< Weighted signal buffer */
82    spx_word16_t *sw;             /**< Start of weighted signal frame */
83    const spx_word16_t *window;   /**< Temporary (Hanning) window */
84    const spx_word16_t *lagWindow;      /**< Window applied to auto-correlation */
85    spx_lsp_t *old_lsp;           /**< LSPs for previous frame */
86    spx_lsp_t *old_qlsp;          /**< Quantized LSPs for previous frame */
87    spx_mem_t *mem_sp;            /**< Filter memory for signal synthesis */
88    spx_mem_t *mem_sw;            /**< Filter memory for perceptually-weighted signal */
89    spx_mem_t *mem_sw_whole;      /**< Filter memory for perceptually-weighted signal (whole frame)*/
90    spx_mem_t *mem_exc;           /**< Filter memory for excitation (whole frame) */
91    spx_mem_t *mem_exc2;          /**< Filter memory for excitation (whole frame) */
92    spx_mem_t mem_hp[2];          /**< High-pass filter memory */
93    spx_word32_t *pi_gain;        /**< Gain of LPC filter at theta=pi (fe/2) */
94    spx_word16_t *innov_rms_save; /**< If non-NULL, innovation RMS is copied here */
95          
96    VBRState *vbr;                /**< State of the VBR data */
97    float  vbr_quality;           /**< Quality setting for VBR encoding */
98    float  relative_quality;      /**< Relative quality that will be needed by VBR */
99    spx_int32_t vbr_enabled;      /**< 1 for enabling VBR, 0 otherwise */
100    spx_int32_t vbr_max;          /**< Max bit-rate allowed in VBR mode */
101    int    vad_enabled;           /**< 1 for enabling VAD, 0 otherwise */
102    int    dtx_enabled;           /**< 1 for enabling DTX, 0 otherwise */
103    int    dtx_count;             /**< Number of consecutive DTX frames */
104    spx_int32_t abr_enabled;      /**< ABR setting (in bps), 0 if off */
105    float  abr_drift;
106    float  abr_drift2;
107    float  abr_count;
108    int    complexity;            /**< Complexity setting (0-10 from least complex to most complex) */
109    spx_int32_t sampling_rate;
110    int    plc_tuning;
111    int    encode_submode;
112    const SpeexSubmode * const *submodes; /**< Sub-mode data */
113    int    submodeID;             /**< Activated sub-mode */
114    int    submodeSelect;         /**< Mode chosen by the user (may differ from submodeID if VAD is on) */
115    int    isWideband;            /**< Is this used as part of the embedded wideband codec */
116    int    highpass_enabled;        /**< Is the input filter enabled */
117 } EncState;
118
119 /**Structure representing the full state of the narrowband decoder*/
120 typedef struct DecState {
121    const SpeexMode *mode;       /**< Mode corresponding to the state */
122    int    first;                /**< Is this the first frame? */
123    int    count_lost;           /**< Was the last frame lost? */
124    int    frameSize;            /**< Size of frames */
125    int    subframeSize;         /**< Size of sub-frames */
126    int    nbSubframes;          /**< Number of sub-frames */
127    int    lpcSize;              /**< LPC order */
128    int    min_pitch;            /**< Minimum pitch value allowed */
129    int    max_pitch;            /**< Maximum pitch value allowed */
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;        /**< Excitation buffer */
136    spx_word16_t *exc;           /**< Start of excitation frame */
137    spx_lsp_t *old_qlsp;         /**< Quantized LSPs for previous frame */
138    spx_coef_t *interp_qlpc;     /**< Interpolated quantized LPCs */
139    spx_mem_t *mem_sp;           /**< Filter memory for synthesis signal */
140    spx_mem_t mem_hp[2];         /**< High-pass filter memory */
141    spx_word32_t *pi_gain;       /**< 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