Fixes the case of PLC before receiving any valid packet
[opus.git] / silk / silk_define.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, 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 SILK_DEFINE_H\r
29 #define SILK_DEFINE_H\r
30 \r
31 #include "silk_errors.h"\r
32 #include "silk_typedef.h"\r
33 \r
34 #ifdef HAVE_CONFIG_H\r
35 #include "config.h"\r
36 #endif\r
37 \r
38 #ifdef __cplusplus\r
39 extern "C"\r
40 {\r
41 #endif\r
42 \r
43 /* Max number of encoder channels (1/2) */\r
44 #define ENCODER_NUM_CHANNELS                    2\r
45 /* Number of decoder channels (1/2) */\r
46 #define DECODER_NUM_CHANNELS                    2\r
47 \r
48 #define MAX_FRAMES_PER_PACKET                   3\r
49 \r
50 /* Limits on bitrate */\r
51 #define MIN_TARGET_RATE_BPS                     5000\r
52 #define MAX_TARGET_RATE_BPS                     80000\r
53 #define TARGET_RATE_TAB_SZ                      8\r
54 \r
55 /* LBRR thresholds */\r
56 #define LBRR_NB_MIN_RATE_BPS                    12000\r
57 #define LBRR_MB_MIN_RATE_BPS                    14000\r
58 #define LBRR_WB_MIN_RATE_BPS                    16000\r
59 \r
60 /* DTX settings */\r
61 #define NB_SPEECH_FRAMES_BEFORE_DTX             10      /* eq 200 ms */\r
62 #define MAX_CONSECUTIVE_DTX                     20      /* eq 400 ms */\r
63 \r
64 /* Maximum sampling frequency, should be 16 for embedded */\r
65 #define MAX_FS_KHZ                              16 \r
66 #define MAX_API_FS_KHZ                          48\r
67 \r
68 /* Signal types */\r
69 #define TYPE_NO_VOICE_ACTIVITY                  0\r
70 #define TYPE_UNVOICED                           1\r
71 #define TYPE_VOICED                             2\r
72 \r
73 /* Settings for stereo processing */\r
74 #define STEREO_QUANT_TAB_SIZE                   16\r
75 #define STEREO_QUANT_SUB_STEPS                  5\r
76 #define STEREO_INTERP_LEN_MS                    8           /* must be even */\r
77 #define STEREO_RATIO_SMOOTH_COEF                0.01        /* smoothing coef for signal norms and stereo width */\r
78 \r
79 /* Range of pitch lag estimates */\r
80 #define PITCH_EST_MIN_LAG_MS                    2           /* 2 ms -> 500 Hz */\r
81 #define PITCH_EST_MAX_LAG_MS                    18          /* 18 ms -> 56 Hz */\r
82 \r
83 /* Maximum number of subframes */\r
84 #define MAX_NB_SUBFR                            4\r
85 \r
86 /* Number of samples per frame */ \r
87 #define LTP_MEM_LENGTH_MS                       20\r
88 #define SUB_FRAME_LENGTH_MS                     5\r
89 #define MAX_SUB_FRAME_LENGTH                    ( SUB_FRAME_LENGTH_MS * MAX_FS_KHZ )\r
90 #define MAX_FRAME_LENGTH_MS                     ( SUB_FRAME_LENGTH_MS * MAX_NB_SUBFR )\r
91 #define MAX_FRAME_LENGTH                        ( MAX_FRAME_LENGTH_MS * MAX_FS_KHZ )\r
92 \r
93 /* Milliseconds of lookahead for pitch analysis */\r
94 #define LA_PITCH_MS                             2\r
95 #define LA_PITCH_MAX                            ( LA_PITCH_MS * MAX_FS_KHZ )\r
96 \r
97 /* Order of LPC used in find pitch */\r
98 #define MAX_FIND_PITCH_LPC_ORDER                16\r
99 \r
100 /* Length of LPC window used in find pitch */\r
101 #define FIND_PITCH_LPC_WIN_MS                   ( 20 + (LA_PITCH_MS << 1) )\r
102 #define FIND_PITCH_LPC_WIN_MS_2_SF              ( 10 + (LA_PITCH_MS << 1) )\r
103 #define FIND_PITCH_LPC_WIN_MAX                  ( FIND_PITCH_LPC_WIN_MS * MAX_FS_KHZ )\r
104 \r
105 /* Milliseconds of lookahead for noise shape analysis */\r
106 #define LA_SHAPE_MS                             5\r
107 #define LA_SHAPE_MAX                            ( LA_SHAPE_MS * MAX_FS_KHZ )\r
108 \r
109 /* Maximum length of LPC window used in noise shape analysis */\r
110 #define SHAPE_LPC_WIN_MAX                       ( 15 * MAX_FS_KHZ )\r
111 \r
112 /* dB level of lowest gain quantization level */\r
113 #define MIN_QGAIN_DB                            2\r
114 /* dB level of highest gain quantization level */\r
115 #define MAX_QGAIN_DB                            88\r
116 /* Number of gain quantization levels */\r
117 #define N_LEVELS_QGAIN                          64\r
118 /* Max increase in gain quantization index */\r
119 #define MAX_DELTA_GAIN_QUANT                    36\r
120 /* Max decrease in gain quantization index */\r
121 #define MIN_DELTA_GAIN_QUANT                    -4\r
122 \r
123 /* Quantization offsets (multiples of 4) */\r
124 #define OFFSET_VL_Q10                           32\r
125 #define OFFSET_VH_Q10                           100\r
126 #define OFFSET_UVL_Q10                          100\r
127 #define OFFSET_UVH_Q10                          240\r
128 \r
129 #define QUANT_LEVEL_ADJUST_Q10                  80\r
130 \r
131 /* Maximum numbers of iterations used to stabilize a LPC vector */\r
132 #define MAX_LPC_STABILIZE_ITERATIONS            20\r
133 \r
134 #define MAX_LPC_ORDER                           16\r
135 #define MIN_LPC_ORDER                           10\r
136 \r
137 /* Find Pred Coef defines */\r
138 #define LTP_ORDER                               5\r
139 \r
140 /* LTP quantization settings */\r
141 #define NB_LTP_CBKS                             3\r
142 \r
143 /* Flag to use harmonic noise shaping */\r
144 #define USE_HARM_SHAPING                        1\r
145 \r
146 /* Max LPC order of noise shaping filters */\r
147 #define MAX_SHAPE_LPC_ORDER                     16\r
148 \r
149 #define HARM_SHAPE_FIR_TAPS                     3\r
150 \r
151 /* Maximum number of delayed decision states */\r
152 #define MAX_DEL_DEC_STATES                      4\r
153 \r
154 #define LTP_BUF_LENGTH                          512\r
155 #define LTP_MASK                                ( LTP_BUF_LENGTH - 1 )\r
156 \r
157 #define DECISION_DELAY                          32\r
158 #define DECISION_DELAY_MASK                     ( DECISION_DELAY - 1 )\r
159 \r
160 /* Number of subframes for excitation entropy coding */\r
161 #define SHELL_CODEC_FRAME_LENGTH                16\r
162 #define LOG2_SHELL_CODEC_FRAME_LENGTH           4\r
163 #define MAX_NB_SHELL_BLOCKS                     ( MAX_FRAME_LENGTH / SHELL_CODEC_FRAME_LENGTH )\r
164 \r
165 /* Number of rate levels, for entropy coding of excitation */\r
166 #define N_RATE_LEVELS                           10\r
167 \r
168 /* Maximum sum of pulses per shell coding frame */\r
169 #define MAX_PULSES                              16\r
170 \r
171 #define MAX_MATRIX_SIZE                         MAX_LPC_ORDER /* Max of LPC Order and LTP order */\r
172 \r
173 #if( MAX_LPC_ORDER > DECISION_DELAY )\r
174 # define NSQ_LPC_BUF_LENGTH                     MAX_LPC_ORDER\r
175 #else\r
176 # define NSQ_LPC_BUF_LENGTH                     DECISION_DELAY\r
177 #endif\r
178 \r
179 /***********************/\r
180 /* High pass filtering */\r
181 /***********************/\r
182 #define HIGH_PASS_INPUT                         1\r
183 \r
184 /***************************/\r
185 /* Voice activity detector */\r
186 /***************************/\r
187 #define VAD_N_BANDS                             4\r
188 \r
189 #define VAD_INTERNAL_SUBFRAMES_LOG2             2\r
190 #define VAD_INTERNAL_SUBFRAMES                  (1 << VAD_INTERNAL_SUBFRAMES_LOG2)\r
191     \r
192 #define VAD_NOISE_LEVEL_SMOOTH_COEF_Q16         1024    /* Must be <  4096                                  */\r
193 #define VAD_NOISE_LEVELS_BIAS                   50 \r
194 \r
195 /* Sigmoid settings */\r
196 #define VAD_NEGATIVE_OFFSET_Q5                  128     /* sigmoid is 0 at -128                             */\r
197 #define VAD_SNR_FACTOR_Q16                      45000 \r
198 \r
199 /* smoothing for SNR measurement */\r
200 #define VAD_SNR_SMOOTH_COEF_Q18                 4096\r
201 \r
202 /* Size of the piecewise linear cosine approximation table for the LSFs */\r
203 #define LSF_COS_TAB_SZ_FIX                      128\r
204 \r
205 /******************/\r
206 /* NLSF quantizer */\r
207 /******************/\r
208 #define NLSF_VQ_MAX_VECTORS                     32\r
209 #define NLSF_VQ_MAX_SURVIVORS                   16\r
210 #define NLSF_QUANT_MAX_AMPLITUDE                4\r
211 #define NLSF_QUANT_MAX_AMPLITUDE_EXT            10\r
212 #define NLSF_QUANT_LEVEL_ADJ                    0.1\r
213 #define NLSF_QUANT_DEL_DEC_STATES_LOG2          2\r
214 #define NLSF_QUANT_DEL_DEC_STATES               ( 1 << NLSF_QUANT_DEL_DEC_STATES_LOG2 )\r
215 \r
216 /* Transition filtering for mode switching */\r
217 #  define TRANSITION_TIME_MS                    5120 // 5120 = 64 * FRAME_LENGTH_MS * ( TRANSITION_INT_NUM - 1 ) = 64*(20*4)\r
218 #  define TRANSITION_NB                         3 /* Hardcoded in tables */\r
219 #  define TRANSITION_NA                         2 /* Hardcoded in tables */\r
220 #  define TRANSITION_INT_NUM                    5 /* Hardcoded in tables */\r
221 #  define TRANSITION_FRAMES                     ( TRANSITION_TIME_MS / MAX_FRAME_LENGTH_MS ) // todo: needs to be made flexible for 10 ms frames\r
222 #  define TRANSITION_INT_STEPS                  ( TRANSITION_FRAMES  / ( TRANSITION_INT_NUM - 1 ) )\r
223 \r
224 /* BWE factors to apply after packet loss */\r
225 #define BWE_AFTER_LOSS_Q16                      63570\r
226 \r
227 /* Defines for CN generation */\r
228 #define CNG_BUF_MASK_MAX                        255             /* 2^floor(log2(MAX_FRAME_LENGTH))-1    */\r
229 #define CNG_GAIN_SMTH_Q16                       4634            /* 0.25^(1/4)                           */\r
230 #define CNG_NLSF_SMTH_Q16                       16348           /* 0.25                                 */\r
231 \r
232 #ifdef __cplusplus\r
233 }\r
234 #endif\r
235 \r
236 #endif\r