Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_define.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 #ifndef SKP_SILK_DEFINE_H\r
29 #define SKP_SILK_DEFINE_H\r
30 \r
31 #include "SKP_Silk_errors.h"\r
32 #include "SKP_Silk_typedef.h"\r
33 \r
34 #ifdef __cplusplus\r
35 extern "C"\r
36 {\r
37 #endif\r
38 \r
39 \r
40 #define MAX_FRAMES_PER_PACKET                   5\r
41 #define BIT_STREAM_V3                           3\r
42 #define BIT_STREAM_V4                           4\r
43 #define USE_BIT_STREAM_V                        BIT_STREAM_V3 // Should be moved to a API call\r
44 \r
45 \r
46 /* MAX DELTA LAG used for multiframe packets */\r
47 #define MAX_DELTA_LAG                           10\r
48 \r
49 /* Lower limit on bitrate for each mode */\r
50 #define MIN_TARGET_RATE_NB_BPS                  5000\r
51 #define MIN_TARGET_RATE_MB_BPS                  7000\r
52 #define MIN_TARGET_RATE_WB_BPS                  8000\r
53 #define MIN_TARGET_RATE_SWB_BPS                 20000\r
54 \r
55 /* Transition bitrates between modes */\r
56 #define SWB2WB_BITRATE_BPS                      30000\r
57 #define SWB2WB_BITRATE_BPS_INITIAL              25000\r
58 #define WB2SWB_BITRATE_BPS                      35000\r
59 #define WB2MB_BITRATE_BPS                       15000\r
60 #define MB2WB_BITRATE_BPS                       20000\r
61 #define MB2NB_BITRATE_BPS                       10000\r
62 #define NB2MB_BITRATE_BPS                       14000\r
63 \r
64 /* Integration/hysteresis threshold for lowering internal sample frequency */\r
65 /* 30000000 -> 6 sec if bitrate is 5000 bps below limit; 3 sec if bitrate is 10000 bps below limit */\r
66 #define ACCUM_BITS_DIFF_THRESHOLD               30000000 \r
67 #define TARGET_RATE_TAB_SZ                      8\r
68 \r
69 /* DTX settings                                 */\r
70 #define NO_SPEECH_FRAMES_BEFORE_DTX             5       /* eq 100 ms */\r
71 #define MAX_CONSECUTIVE_DTX                     20      /* eq 400 ms */\r
72 \r
73 #define USE_LBRR                                1\r
74 \r
75 /* Amount of concecutive no FEC packets before telling JB */\r
76 #define NO_LBRR_THRES                           10\r
77 \r
78 /* Maximum delay between real packet and LBRR packet */\r
79 #define MAX_LBRR_DELAY                          2\r
80 #define LBRR_IDX_MASK                           1\r
81 \r
82 #define INBAND_FEC_MIN_RATE_BPS                 18000  /* Dont use inband FEC below this total target rate  */\r
83 #define LBRR_LOSS_THRES                         2   /* Start adding LBRR at this loss rate (needs tuning)   */\r
84 \r
85 /* LBRR usage defines */\r
86 #define SKP_SILK_NO_LBRR                        0   /* No LBRR information for this packet                  */\r
87 #define SKP_SILK_ADD_LBRR_TO_PLUS1              1   /* Add LBRR for this packet to packet n + 1             */\r
88 #define SKP_SILK_ADD_LBRR_TO_PLUS2              2   /* Add LBRR for this packet to packet n + 2             */\r
89 \r
90 /* Frame termination indicator defines */\r
91 #define SKP_SILK_LAST_FRAME                     0   /* Last frames in packet                                */\r
92 #define SKP_SILK_MORE_FRAMES                    1   /* More frames to follow this one                       */\r
93 #define SKP_SILK_LBRR_VER1                      2   /* LBRR information from packet n - 1                   */\r
94 #define SKP_SILK_LBRR_VER2                      3   /* LBRR information from packet n - 2                   */\r
95 #define SKP_SILK_EXT_LAYER                      4   /* Extension layers added                               */\r
96 \r
97 /* Number of Second order Sections for SWB detection HP filter */\r
98 #define NB_SOS                                  3\r
99 #define HP_8_KHZ_THRES                          10          /* average energy per sample, above 8 kHz       */\r
100 #define CONCEC_SWB_SMPLS_THRES                  480 * 15    /* 300 ms                                       */\r
101 #define WB_DETECT_ACTIVE_SPEECH_MS_THRES        15000       /* ms of active speech needed for WB detection  */\r
102 \r
103 /* Low complexity setting */\r
104 #ifdef EMBEDDED_OPT\r
105 #   define LOW_COMPLEXITY_ONLY                  1\r
106 #else\r
107 #   define LOW_COMPLEXITY_ONLY                  0\r
108 #endif\r
109 \r
110 /* Activate bandwidth transition filtering for mode switching */\r
111 #ifdef EMBEDDED_OPT\r
112 #   define SWITCH_TRANSITION_FILTERING          0\r
113 #else\r
114 #ifndef FORCE_FS_KHZ \r
115 #   define SWITCH_TRANSITION_FILTERING          1\r
116 #else\r
117 #   define SWITCH_TRANSITION_FILTERING          0\r
118 #endif\r
119 #endif\r
120 \r
121 /* Decoder Parameters */\r
122 #define DEC_HP_ORDER                            2\r
123 \r
124 /* Maximum sampling frequency, should be 16 for embedded */\r
125 #define MAX_FS_KHZ                              24 \r
126 \r
127 /* Signal Types used by silk */\r
128 #define SIG_TYPE_VOICED                         0\r
129 #define SIG_TYPE_UNVOICED                       1\r
130 \r
131 /* VAD Types used by silk */\r
132 #define NO_VOICE_ACTIVITY                       0\r
133 #define VOICE_ACTIVITY                          1\r
134 \r
135 /* number of samples per frame */ \r
136 #define FRAME_LENGTH_MS                         20 /* 20 ms */\r
137 #define MAX_FRAME_LENGTH                        (FRAME_LENGTH_MS * MAX_FS_KHZ)\r
138 \r
139 /* number of lookahead samples for pitch analysis */\r
140 #define LA_PITCH_MS                             3\r
141 #define LA_PITCH_MAX                            (LA_PITCH_MS * MAX_FS_KHZ)\r
142 \r
143 /* number of lookahead samples for noise shape analysis */\r
144 #define LA_SHAPE_MS                             5\r
145 #define LA_SHAPE_MAX                            (LA_SHAPE_MS * MAX_FS_KHZ)\r
146 \r
147 /* Order of LPC used in find pitch */\r
148 #define FIND_PITCH_LPC_ORDER_MAX                16\r
149 \r
150 /* Length of LPC window used in find pitch */\r
151 #define FIND_PITCH_LPC_WIN_MS                   (30 + (LA_PITCH_MS << 1))\r
152 #define FIND_PITCH_LPC_WIN_MAX                  (FIND_PITCH_LPC_WIN_MS * MAX_FS_KHZ)\r
153 \r
154 #define PITCH_EST_COMPLEXITY_HC_MODE            SigProc_PITCH_EST_MAX_COMPLEX\r
155 #define PITCH_EST_COMPLEXITY_MC_MODE            SigProc_PITCH_EST_MID_COMPLEX\r
156 #define PITCH_EST_COMPLEXITY_LC_MODE            SigProc_PITCH_EST_MIN_COMPLEX\r
157 \r
158 \r
159 /* Max number of bytes in payload output buffer (may contain multiple frames) */\r
160 #define MAX_ARITHM_BYTES                        1024\r
161 \r
162 #define RANGE_CODER_WRITE_BEYOND_BUFFER         -1\r
163 #define RANGE_CODER_CDF_OUT_OF_RANGE            -2\r
164 #define RANGE_CODER_NORMALIZATION_FAILED        -3\r
165 #define RANGE_CODER_ZERO_INTERVAL_WIDTH         -4\r
166 #define RANGE_CODER_DECODER_CHECK_FAILED        -5\r
167 #define RANGE_CODER_READ_BEYOND_BUFFER          -6\r
168 #define RANGE_CODER_ILLEGAL_SAMPLING_RATE       -7\r
169 #define RANGE_CODER_DEC_PAYLOAD_TOO_LONG        -8\r
170 \r
171 /* dB level of lowest gain quantization level */\r
172 #define MIN_QGAIN_DB                            6\r
173 /* dB level of highest gain quantization level */\r
174 #define MAX_QGAIN_DB                            86\r
175 /* Number of gain quantization levels */\r
176 #define N_LEVELS_QGAIN                          64\r
177 /* Max increase in gain quantization index */\r
178 #define MAX_DELTA_GAIN_QUANT                    40\r
179 /* Max decrease in gain quantization index */\r
180 #define MIN_DELTA_GAIN_QUANT                    -4\r
181 \r
182 /* Quantization offsets (multiples of 4) */\r
183 #define OFFSET_VL_Q10                           32\r
184 #define OFFSET_VH_Q10                           100\r
185 #define OFFSET_UVL_Q10                          100\r
186 #define OFFSET_UVH_Q10                          256\r
187 \r
188 /* Maximum numbers of iterations used to stabilize a LPC vector */\r
189 #define MAX_LPC_STABILIZE_ITERATIONS            20\r
190 \r
191 #define MAX_LPC_ORDER                           16\r
192 #define MIN_LPC_ORDER                           10\r
193 \r
194 /* Find Pred Coef defines */\r
195 #define LTP_ORDER                               5\r
196 \r
197 /* LTP quantization settings */\r
198 #define NB_LTP_CBKS                             3\r
199 \r
200 /* Number of subframes */\r
201 #define NB_SUBFR                                4\r
202 \r
203 /* Flag to use harmonic noise shaping */\r
204 #define USE_HARM_SHAPING                        1\r
205 \r
206 /* Max LPC order of noise shaping filters */\r
207 #define SHAPE_LPC_ORDER_MAX                     16\r
208 \r
209 #define HARM_SHAPE_FIR_TAPS                     3\r
210 \r
211 /* Length of LPC window used in noise shape analysis */\r
212 #define SHAPE_LPC_WIN_MS                        15\r
213 #define SHAPE_LPC_WIN_16_KHZ                    (SHAPE_LPC_WIN_MS * 16)\r
214 #define SHAPE_LPC_WIN_24_KHZ                    (SHAPE_LPC_WIN_MS * 24)\r
215 #define SHAPE_LPC_WIN_MAX                       (SHAPE_LPC_WIN_MS * MAX_FS_KHZ)\r
216 \r
217 /* Maximum number of delayed decision states */\r
218 #define DEL_DEC_STATES_MAX                      4\r
219 \r
220 #define LTP_BUF_LENGTH                          512\r
221 #define LTP_MASK                                (LTP_BUF_LENGTH - 1)\r
222 \r
223 #define DECISION_DELAY                          32\r
224 #define DECISION_DELAY_MASK                     (DECISION_DELAY - 1)\r
225 \r
226 /* number of subframes for excitation entropy coding */\r
227 #define SHELL_CODEC_FRAME_LENGTH                16\r
228 #define MAX_NB_SHELL_BLOCKS                     (MAX_FRAME_LENGTH / SHELL_CODEC_FRAME_LENGTH)\r
229 \r
230 /* number of rate levels, for entropy coding of excitation */\r
231 #define N_RATE_LEVELS                           10\r
232 \r
233 /* maximum sum of pulses per shell coding frame */\r
234 #define MAX_PULSES                              18\r
235 \r
236 #define MAX_MATRIX_SIZE                         MAX_LPC_ORDER /* Max of LPC Order and LTP order */\r
237 \r
238 #if( MAX_LPC_ORDER > DECISION_DELAY )\r
239 # define NSQ_LPC_BUF_LENGTH                     MAX_LPC_ORDER\r
240 #else\r
241 # define NSQ_LPC_BUF_LENGTH                     DECISION_DELAY\r
242 #endif\r
243 \r
244 /***********************/\r
245 /* High pass filtering */\r
246 /***********************/\r
247 #define HIGH_PASS_INPUT                         1\r
248 \r
249 /***************************/\r
250 /* Voice activity detector */\r
251 /***************************/\r
252 #define VAD_N_BANDS                             4       /* 0-1, 1-2, 2-4, and 4-8 kHz                       */\r
253 \r
254 #define VAD_INTERNAL_SUBFRAMES_LOG2             2\r
255 #define VAD_INTERNAL_SUBFRAMES                  (1 << VAD_INTERNAL_SUBFRAMES_LOG2)\r
256     \r
257 #define VAD_NOISE_LEVEL_SMOOTH_COEF_Q16         1024    /* Must be <  4096                                  */\r
258 #define VAD_NOISE_LEVELS_BIAS                   50 \r
259 \r
260 /* Sigmoid settings */\r
261 #define VAD_NEGATIVE_OFFSET_Q5                  128     /* sigmoid is 0 at -128                             */\r
262 #define VAD_SNR_FACTOR_Q16                      45000 \r
263 \r
264 /* smoothing for SNR measurement */\r
265 #define VAD_SNR_SMOOTH_COEF_Q18                 4096\r
266 \r
267 /******************/\r
268 /* NLSF quantizer */\r
269 /******************/\r
270 #ifdef NLSF_TRAINING\r
271 #   define NLSF_MSVQ_MAX_CB_STAGES                      30 \r
272 #   define NLSF_MSVQ_MAX_VECTORS_IN_STAGE               256\r
273 #   define NLSF_MSVQ_MAX_VECTORS_IN_STAGE_TWO_TO_END    128\r
274 #else\r
275 #   define NLSF_MSVQ_MAX_CB_STAGES                      10  /* Update manually when changing codebooks      */\r
276 #   define NLSF_MSVQ_MAX_VECTORS_IN_STAGE               128 /* Update manually when changing codebooks      */\r
277 #   define NLSF_MSVQ_MAX_VECTORS_IN_STAGE_TWO_TO_END    16  /* Update manually when changing codebooks      */\r
278 #endif\r
279 \r
280 #define NLSF_MSVQ_FLUCTUATION_REDUCTION         1\r
281 #define MAX_NLSF_MSVQ_SURVIVORS                 16\r
282 #define MAX_NLSF_MSVQ_SURVIVORS_LC_MODE         2\r
283 #define MAX_NLSF_MSVQ_SURVIVORS_MC_MODE         4\r
284 \r
285 /* Based on above defines, calculate how much memory is necessary to allocate */\r
286 #if( NLSF_MSVQ_MAX_VECTORS_IN_STAGE > ( MAX_NLSF_MSVQ_SURVIVORS_LC_MODE * NLSF_MSVQ_MAX_VECTORS_IN_STAGE_TWO_TO_END ) )\r
287 #   define NLSF_MSVQ_TREE_SEARCH_MAX_VECTORS_EVALUATED_LC_MODE  NLSF_MSVQ_MAX_VECTORS_IN_STAGE\r
288 #else\r
289 #   define NLSF_MSVQ_TREE_SEARCH_MAX_VECTORS_EVALUATED_LC_MODE  MAX_NLSF_MSVQ_SURVIVORS_LC_MODE * NLSF_MSVQ_MAX_VECTORS_IN_STAGE_TWO_TO_END\r
290 #endif\r
291 \r
292 #if( NLSF_MSVQ_MAX_VECTORS_IN_STAGE > ( MAX_NLSF_MSVQ_SURVIVORS * NLSF_MSVQ_MAX_VECTORS_IN_STAGE_TWO_TO_END ) )\r
293 #   define NLSF_MSVQ_TREE_SEARCH_MAX_VECTORS_EVALUATED  NLSF_MSVQ_MAX_VECTORS_IN_STAGE\r
294 #else\r
295 #   define NLSF_MSVQ_TREE_SEARCH_MAX_VECTORS_EVALUATED  MAX_NLSF_MSVQ_SURVIVORS * NLSF_MSVQ_MAX_VECTORS_IN_STAGE_TWO_TO_END\r
296 #endif\r
297 \r
298 #define NLSF_MSVQ_SURV_MAX_REL_RD               4\r
299 \r
300 /* Transition filtering for mode switching */\r
301 #if SWITCH_TRANSITION_FILTERING\r
302 #  define TRANSITION_TIME_UP_MS             5120 // 5120 = 64 * FRAME_LENGTH_MS * ( TRANSITION_INT_NUM - 1 ) = 64*(20*4)\r
303 #  define TRANSITION_TIME_DOWN_MS           2560 // 2560 = 32 * FRAME_LENGTH_MS * ( TRANSITION_INT_NUM - 1 ) = 32*(20*4)\r
304 #  define TRANSITION_NB                     3 /* Hardcoded in tables */\r
305 #  define TRANSITION_NA                     2 /* Hardcoded in tables */\r
306 #  define TRANSITION_INT_NUM                5 /* Hardcoded in tables */\r
307 #  define TRANSITION_FRAMES_UP          ( TRANSITION_TIME_UP_MS   / FRAME_LENGTH_MS )\r
308 #  define TRANSITION_FRAMES_DOWN        ( TRANSITION_TIME_DOWN_MS / FRAME_LENGTH_MS )\r
309 #  define TRANSITION_INT_STEPS_UP       ( TRANSITION_FRAMES_UP    / ( TRANSITION_INT_NUM - 1 )  )\r
310 #  define TRANSITION_INT_STEPS_DOWN     ( TRANSITION_FRAMES_DOWN  / ( TRANSITION_INT_NUM - 1 )  )\r
311 #endif\r
312 \r
313 /* Row based */\r
314 #define matrix_ptr(Matrix_base_adr, row, column, N)         *(Matrix_base_adr + ((row)*(N)+(column)))\r
315 #define matrix_adr(Matrix_base_adr, row, column, N)          (Matrix_base_adr + ((row)*(N)+(column)))\r
316 \r
317 /* Column based */\r
318 #ifndef matrix_c_ptr\r
319 #   define matrix_c_ptr(Matrix_base_adr, row, column, M)    *(Matrix_base_adr + ((row)+(M)*(column)))\r
320 #endif\r
321 #define matrix_c_adr(Matrix_base_adr, row, column, M)        (Matrix_base_adr + ((row)+(M)*(column)))\r
322 \r
323 /* BWE factors to apply after packet loss */\r
324 #define BWE_AFTER_LOSS_Q16                              63570\r
325 \r
326 #ifdef __cplusplus\r
327 }\r
328 #endif\r
329 \r
330 #endif\r