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