Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / silk_define.h
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifndef SILK_DEFINE_H
29 #define SILK_DEFINE_H
30
31 #include "silk_errors.h"
32 #include "silk_typedef.h"
33
34 #ifdef HAVE_CONFIG_H
35 #include "config.h"
36 #endif
37
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42
43 /* Max number of encoder channels (1/2) */
44 #define ENCODER_NUM_CHANNELS                    2
45 /* Number of decoder channels (1/2) */
46 #define DECODER_NUM_CHANNELS                    2
47
48 #define MAX_FRAMES_PER_PACKET                   3
49
50 /* Limits on bitrate */
51 #define MIN_TARGET_RATE_BPS                     5000
52 #define MAX_TARGET_RATE_BPS                     80000
53 #define TARGET_RATE_TAB_SZ                      8
54
55 /* LBRR thresholds */
56 #define LBRR_NB_MIN_RATE_BPS                    12000
57 #define LBRR_MB_MIN_RATE_BPS                    14000
58 #define LBRR_WB_MIN_RATE_BPS                    16000
59
60 /* DTX settings */
61 #define NB_SPEECH_FRAMES_BEFORE_DTX             10      /* eq 200 ms */
62 #define MAX_CONSECUTIVE_DTX                     20      /* eq 400 ms */
63
64 /* Maximum sampling frequency, should be 16 for embedded */
65 #define MAX_FS_KHZ                              16
66 #define MAX_API_FS_KHZ                          48
67
68 /* Signal types */
69 #define TYPE_NO_VOICE_ACTIVITY                  0
70 #define TYPE_UNVOICED                           1
71 #define TYPE_VOICED                             2
72
73 /* Settings for stereo processing */
74 #define STEREO_QUANT_TAB_SIZE                   16
75 #define STEREO_QUANT_SUB_STEPS                  5
76 #define STEREO_INTERP_LEN_MS                    8           /* must be even */
77 #define STEREO_RATIO_SMOOTH_COEF                0.01        /* smoothing coef for signal norms and stereo width */
78
79 /* Range of pitch lag estimates */
80 #define PITCH_EST_MIN_LAG_MS                    2           /* 2 ms -> 500 Hz */
81 #define PITCH_EST_MAX_LAG_MS                    18          /* 18 ms -> 56 Hz */
82
83 /* Maximum number of subframes */
84 #define MAX_NB_SUBFR                            4
85
86 /* Number of samples per frame */
87 #define LTP_MEM_LENGTH_MS                       20
88 #define SUB_FRAME_LENGTH_MS                     5
89 #define MAX_SUB_FRAME_LENGTH                    ( SUB_FRAME_LENGTH_MS * MAX_FS_KHZ )
90 #define MAX_FRAME_LENGTH_MS                     ( SUB_FRAME_LENGTH_MS * MAX_NB_SUBFR )
91 #define MAX_FRAME_LENGTH                        ( MAX_FRAME_LENGTH_MS * MAX_FS_KHZ )
92
93 /* Milliseconds of lookahead for pitch analysis */
94 #define LA_PITCH_MS                             2
95 #define LA_PITCH_MAX                            ( LA_PITCH_MS * MAX_FS_KHZ )
96
97 /* Order of LPC used in find pitch */
98 #define MAX_FIND_PITCH_LPC_ORDER                16
99
100 /* Length of LPC window used in find pitch */
101 #define FIND_PITCH_LPC_WIN_MS                   ( 20 + (LA_PITCH_MS << 1) )
102 #define FIND_PITCH_LPC_WIN_MS_2_SF              ( 10 + (LA_PITCH_MS << 1) )
103 #define FIND_PITCH_LPC_WIN_MAX                  ( FIND_PITCH_LPC_WIN_MS * MAX_FS_KHZ )
104
105 /* Milliseconds of lookahead for noise shape analysis */
106 #define LA_SHAPE_MS                             5
107 #define LA_SHAPE_MAX                            ( LA_SHAPE_MS * MAX_FS_KHZ )
108
109 /* Maximum length of LPC window used in noise shape analysis */
110 #define SHAPE_LPC_WIN_MAX                       ( 15 * MAX_FS_KHZ )
111
112 /* dB level of lowest gain quantization level */
113 #define MIN_QGAIN_DB                            2
114 /* dB level of highest gain quantization level */
115 #define MAX_QGAIN_DB                            88
116 /* Number of gain quantization levels */
117 #define N_LEVELS_QGAIN                          64
118 /* Max increase in gain quantization index */
119 #define MAX_DELTA_GAIN_QUANT                    36
120 /* Max decrease in gain quantization index */
121 #define MIN_DELTA_GAIN_QUANT                    -4
122
123 /* Quantization offsets (multiples of 4) */
124 #define OFFSET_VL_Q10                           32
125 #define OFFSET_VH_Q10                           100
126 #define OFFSET_UVL_Q10                          100
127 #define OFFSET_UVH_Q10                          240
128
129 #define QUANT_LEVEL_ADJUST_Q10                  80
130
131 /* Maximum numbers of iterations used to stabilize a LPC vector */
132 #define MAX_LPC_STABILIZE_ITERATIONS            20
133
134 #define MAX_LPC_ORDER                           16
135 #define MIN_LPC_ORDER                           10
136
137 /* Find Pred Coef defines */
138 #define LTP_ORDER                               5
139
140 /* LTP quantization settings */
141 #define NB_LTP_CBKS                             3
142
143 /* Flag to use harmonic noise shaping */
144 #define USE_HARM_SHAPING                        1
145
146 /* Max LPC order of noise shaping filters */
147 #define MAX_SHAPE_LPC_ORDER                     16
148
149 #define HARM_SHAPE_FIR_TAPS                     3
150
151 /* Maximum number of delayed decision states */
152 #define MAX_DEL_DEC_STATES                      4
153
154 #define LTP_BUF_LENGTH                          512
155 #define LTP_MASK                                ( LTP_BUF_LENGTH - 1 )
156
157 #define DECISION_DELAY                          32
158 #define DECISION_DELAY_MASK                     ( DECISION_DELAY - 1 )
159
160 /* Number of subframes for excitation entropy coding */
161 #define SHELL_CODEC_FRAME_LENGTH                16
162 #define LOG2_SHELL_CODEC_FRAME_LENGTH           4
163 #define MAX_NB_SHELL_BLOCKS                     ( MAX_FRAME_LENGTH / SHELL_CODEC_FRAME_LENGTH )
164
165 /* Number of rate levels, for entropy coding of excitation */
166 #define N_RATE_LEVELS                           10
167
168 /* Maximum sum of pulses per shell coding frame */
169 #define MAX_PULSES                              16
170
171 #define MAX_MATRIX_SIZE                         MAX_LPC_ORDER /* Max of LPC Order and LTP order */
172
173 #if( MAX_LPC_ORDER > DECISION_DELAY )
174 # define NSQ_LPC_BUF_LENGTH                     MAX_LPC_ORDER
175 #else
176 # define NSQ_LPC_BUF_LENGTH                     DECISION_DELAY
177 #endif
178
179 /***********************/
180 /* High pass filtering */
181 /***********************/
182 #define HIGH_PASS_INPUT                         1
183
184 /***************************/
185 /* Voice activity detector */
186 /***************************/
187 #define VAD_N_BANDS                             4
188
189 #define VAD_INTERNAL_SUBFRAMES_LOG2             2
190 #define VAD_INTERNAL_SUBFRAMES                  (1 << VAD_INTERNAL_SUBFRAMES_LOG2)
191
192 #define VAD_NOISE_LEVEL_SMOOTH_COEF_Q16         1024    /* Must be <  4096                                  */
193 #define VAD_NOISE_LEVELS_BIAS                   50
194
195 /* Sigmoid settings */
196 #define VAD_NEGATIVE_OFFSET_Q5                  128     /* sigmoid is 0 at -128                             */
197 #define VAD_SNR_FACTOR_Q16                      45000
198
199 /* smoothing for SNR measurement */
200 #define VAD_SNR_SMOOTH_COEF_Q18                 4096
201
202 /* Size of the piecewise linear cosine approximation table for the LSFs */
203 #define LSF_COS_TAB_SZ_FIX                      128
204
205 /******************/
206 /* NLSF quantizer */
207 /******************/
208 #define NLSF_W_Q                                2
209 #define NLSF_VQ_MAX_VECTORS                     32
210 #define NLSF_VQ_MAX_SURVIVORS                   32
211 #define NLSF_QUANT_MAX_AMPLITUDE                4
212 #define NLSF_QUANT_MAX_AMPLITUDE_EXT            10
213 #define NLSF_QUANT_LEVEL_ADJ                    0.1
214 #define NLSF_QUANT_DEL_DEC_STATES_LOG2          2
215 #define NLSF_QUANT_DEL_DEC_STATES               ( 1 << NLSF_QUANT_DEL_DEC_STATES_LOG2 )
216
217 /* Transition filtering for mode switching */
218 #  define TRANSITION_TIME_MS                    5120 // 5120 = 64 * FRAME_LENGTH_MS * ( TRANSITION_INT_NUM - 1 ) = 64*(20*4)
219 #  define TRANSITION_NB                         3 /* Hardcoded in tables */
220 #  define TRANSITION_NA                         2 /* Hardcoded in tables */
221 #  define TRANSITION_INT_NUM                    5 /* Hardcoded in tables */
222 #  define TRANSITION_FRAMES                     ( TRANSITION_TIME_MS / MAX_FRAME_LENGTH_MS ) // todo: needs to be made flexible for 10 ms frames
223 #  define TRANSITION_INT_STEPS                  ( TRANSITION_FRAMES  / ( TRANSITION_INT_NUM - 1 ) )
224
225 /* BWE factors to apply after packet loss */
226 #define BWE_AFTER_LOSS_Q16                      63570
227
228 /* Defines for CN generation */
229 #define CNG_BUF_MASK_MAX                        255             /* 2^floor(log2(MAX_FRAME_LENGTH))-1    */
230 #define CNG_GAIN_SMTH_Q16                       4634            /* 0.25^(1/4)                           */
231 #define CNG_NLSF_SMTH_Q16                       16348           /* 0.25                                 */
232
233 #ifdef __cplusplus
234 }
235 #endif
236
237 #endif