Removed all the silk_ prefixes in source file names (not symbols)
[opus.git] / silk / tuning_parameters.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_TUNING_PARAMETERS_H
29 #define SILK_TUNING_PARAMETERS_H
30
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #endif
35
36 /* Decay time for bitreservoir */
37 #define BITRESERVOIR_DECAY_TIME_MS                      500
38
39 /*******************/
40 /* Pitch estimator */
41 /*******************/
42
43 /* Level of noise floor for whitening filter LPC analysis in pitch analysis */
44 #define FIND_PITCH_WHITE_NOISE_FRACTION                 1e-3f
45
46 /* Bandwidth expansion for whitening filter in pitch analysis */
47 #define FIND_PITCH_BANDWITH_EXPANSION                   0.99f
48
49 /*********************/
50 /* Linear prediction */
51 /*********************/
52
53 /* LPC analysis defines: regularization and bandwidth expansion */
54 #define FIND_LPC_COND_FAC                               2.5e-5f
55 #define FIND_LPC_CHIRP                                  0.99995f
56 #define FIND_LPC_CHIRP_FIRST_FRAME                      0.96f
57
58 /* LTP analysis defines */
59 #define FIND_LTP_COND_FAC                               1e-5f
60 #define LTP_DAMPING                                     0.01f
61 #define LTP_SMOOTHING                                   0.1f
62
63 /* LTP quantization settings */
64 #define MU_LTP_QUANT_NB                                 0.03f
65 #define MU_LTP_QUANT_MB                                 0.025f
66 #define MU_LTP_QUANT_WB                                 0.02f
67
68 /***********************/
69 /* High pass filtering */
70 /***********************/
71
72 /* Smoothing parameters for low end of pitch frequency range estimation */
73 #define VARIABLE_HP_SMTH_COEF1                          0.1f
74 #define VARIABLE_HP_SMTH_COEF2                          0.015f
75 #define VARIABLE_HP_MAX_DELTA_FREQ                      0.4f
76
77 /* Min and max cut-off frequency values (-3 dB points) */
78 #define VARIABLE_HP_MIN_CUTOFF_HZ                       60
79 #define VARIABLE_HP_MAX_CUTOFF_HZ                       100
80
81 /***********/
82 /* Various */
83 /***********/
84
85 /* VAD threshold */
86 #define SPEECH_ACTIVITY_DTX_THRES                       0.05f
87
88 /* Speech Activity LBRR enable threshold */
89 #define LBRR_SPEECH_ACTIVITY_THRES                      0.3f
90
91 /*************************/
92 /* Perceptual parameters */
93 /*************************/
94
95 /* reduction in coding SNR during low speech activity */
96 #define BG_SNR_DECR_dB                                  2.0f
97
98 /* factor for reducing quantization noise during voiced speech */
99 #define HARM_SNR_INCR_dB                                2.0f
100
101 /* factor for reducing quantization noise for unvoiced sparse signals */
102 #define SPARSE_SNR_INCR_dB                              2.0f
103
104 /* threshold for sparseness measure above which to use lower quantization offset during unvoiced */
105 #define SPARSENESS_THRESHOLD_QNT_OFFSET                 0.75f
106
107 /* warping control */
108 #define WARPING_MULTIPLIER                              0.015f
109
110 /* fraction added to first autocorrelation value */
111 #define SHAPE_WHITE_NOISE_FRACTION                      1e-5f
112
113 /* noise shaping filter chirp factor */
114 #define BANDWIDTH_EXPANSION                             0.95f
115
116 /* difference between chirp factors for analysis and synthesis noise shaping filters at low bitrates */
117 #define LOW_RATE_BANDWIDTH_EXPANSION_DELTA              0.01f
118
119 /* extra harmonic boosting (signal shaping) at low bitrates */
120 #define LOW_RATE_HARMONIC_BOOST                         0.1f
121
122 /* extra harmonic boosting (signal shaping) for noisy input signals */
123 #define LOW_INPUT_QUALITY_HARMONIC_BOOST                0.1f
124
125 /* harmonic noise shaping */
126 #define HARMONIC_SHAPING                                0.3f
127
128 /* extra harmonic noise shaping for high bitrates or noisy input */
129 #define HIGH_RATE_OR_LOW_QUALITY_HARMONIC_SHAPING       0.2f
130
131 /* parameter for shaping noise towards higher frequencies */
132 #define HP_NOISE_COEF                                   0.25f
133
134 /* parameter for shaping noise even more towards higher frequencies during voiced speech */
135 #define HARM_HP_NOISE_COEF                              0.35f
136
137 /* parameter for applying a high-pass tilt to the input signal */
138 #define INPUT_TILT                                      0.05f
139
140 /* parameter for extra high-pass tilt to the input signal at high rates */
141 #define HIGH_RATE_INPUT_TILT                            0.1f
142
143 /* parameter for reducing noise at the very low frequencies */
144 #define LOW_FREQ_SHAPING                                4.0f
145
146 /* less reduction of noise at the very low frequencies for signals with low SNR at low frequencies */
147 #define LOW_QUALITY_LOW_FREQ_SHAPING_DECR               0.5f
148
149 /* subframe smoothing coefficient for HarmBoost, HarmShapeGain, Tilt (lower -> more smoothing) */
150 #define SUBFR_SMTH_COEF                                 0.4f
151
152 /* parameters defining the R/D tradeoff in the residual quantizer */
153 #define LAMBDA_OFFSET                                   1.2f
154 #define LAMBDA_SPEECH_ACT                               -0.2f
155 #define LAMBDA_DELAYED_DECISIONS                        -0.05f
156 #define LAMBDA_INPUT_QUALITY                            -0.1f
157 #define LAMBDA_CODING_QUALITY                           -0.2f
158 #define LAMBDA_QUANT_OFFSET                             0.8f
159
160 /* Compensation in bitrate calculations for 10 ms modes */
161 #define REDUCE_BITRATE_10_MS_BPS                        2200
162
163 /* Maximum time before allowing a bandwidth transition */
164 #define MAX_BANDWIDTH_SWITCH_DELAY_MS                   5000
165
166 #ifdef __cplusplus
167 }
168 #endif
169
170 #endif /* SILK_TUNING_PARAMETERS_H*/