Fixes the case of PLC before receiving any valid packet
[opus.git] / silk / silk_HP_variable_cutoff.c
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 #ifdef HAVE_CONFIG_H\r
29 #include "config.h"\r
30 #endif\r
31 #ifdef FIXED_POINT\r
32 #include "silk_main_FIX.h"\r
33 #else\r
34 #include "silk_main_FLP.h"\r
35 #endif\r
36 #include "silk_tuning_parameters.h"\r
37 \r
38 /* High-pass filter with cutoff frequency adaptation based on pitch lag statistics */\r
39 void silk_HP_variable_cutoff(\r
40     silk_encoder_state_Fxx          state_Fxx[],        /* I/O  Encoder states                          */\r
41     const SKP_int                   nChannels           /* I    Number of channels                      */\r
42 )\r
43 {\r
44     SKP_int   quality_Q15, cutoff_Hz;\r
45     SKP_int32 B_Q28[ 3 ], A_Q28[ 2 ];\r
46     SKP_int32 Fc_Q19, r_Q28, r_Q22;\r
47     SKP_int32 pitch_freq_Hz_Q16, pitch_freq_log_Q7, delta_freq_Q7;\r
48     silk_encoder_state *psEncC1 = &state_Fxx[ 0 ].sCmn;\r
49 \r
50     if( psEncC1->HP_cutoff_Hz == 0 ) {\r
51         /* Adaptive cutoff frequency: estimate low end of pitch frequency range */\r
52         if( psEncC1->prevSignalType == TYPE_VOICED ) {\r
53             /* difference, in log domain */\r
54             pitch_freq_Hz_Q16 = SKP_DIV32_16( SKP_LSHIFT( SKP_MUL( psEncC1->fs_kHz, 1000 ), 16 ), psEncC1->prevLag );\r
55             pitch_freq_log_Q7 = silk_lin2log( pitch_freq_Hz_Q16 ) - ( 16 << 7 );\r
56 \r
57             /* adjustment based on quality */\r
58             quality_Q15 = psEncC1->input_quality_bands_Q15[ 0 ];\r
59             pitch_freq_log_Q7 = SKP_SMLAWB( pitch_freq_log_Q7, SKP_SMULWB( SKP_LSHIFT( -quality_Q15, 2 ), quality_Q15 ), \r
60                 pitch_freq_log_Q7 - ( silk_lin2log( SILK_FIX_CONST( VARIABLE_HP_MIN_CUTOFF_HZ, 16 ) ) - ( 16 << 7 ) ) );\r
61 \r
62             /* delta_freq = pitch_freq_log - psEnc->variable_HP_smth1; */\r
63             delta_freq_Q7 = pitch_freq_log_Q7 - SKP_RSHIFT( psEncC1->variable_HP_smth1_Q15, 8 );\r
64             if( delta_freq_Q7 < 0 ) {\r
65                 /* less smoothing for decreasing pitch frequency, to track something close to the minimum */\r
66                 delta_freq_Q7 = SKP_MUL( delta_freq_Q7, 3 );\r
67             }\r
68 \r
69             /* limit delta, to reduce impact of outliers in pitch estimation */\r
70             delta_freq_Q7 = SKP_LIMIT_32( delta_freq_Q7, -SILK_FIX_CONST( VARIABLE_HP_MAX_DELTA_FREQ, 7 ), SILK_FIX_CONST( VARIABLE_HP_MAX_DELTA_FREQ, 7 ) );\r
71 \r
72             /* update smoother */\r
73             psEncC1->variable_HP_smth1_Q15 = SKP_SMLAWB( psEncC1->variable_HP_smth1_Q15, \r
74                 SKP_SMULBB( psEncC1->speech_activity_Q8, delta_freq_Q7 ), SILK_FIX_CONST( VARIABLE_HP_SMTH_COEF1, 16 ) );\r
75 \r
76             /* limit frequency range */\r
77             psEncC1->variable_HP_smth1_Q15 = SKP_LIMIT_32( psEncC1->variable_HP_smth1_Q15, \r
78                 SKP_LSHIFT( silk_lin2log( VARIABLE_HP_MIN_CUTOFF_HZ ), 8 ), \r
79                 SKP_LSHIFT( silk_lin2log( VARIABLE_HP_MAX_CUTOFF_HZ ), 8 ) );\r
80         }\r
81     } else {\r
82         /* Externally-controlled cutoff frequency */\r
83         cutoff_Hz = SKP_LIMIT( psEncC1->HP_cutoff_Hz, 10, 500 );\r
84         psEncC1->variable_HP_smth1_Q15 = SKP_LSHIFT( silk_lin2log( cutoff_Hz ), 8 );\r
85     }\r
86 \r
87     /* second smoother */\r
88     psEncC1->variable_HP_smth2_Q15 = SKP_SMLAWB( psEncC1->variable_HP_smth2_Q15, \r
89         psEncC1->variable_HP_smth1_Q15 - psEncC1->variable_HP_smth2_Q15, SILK_FIX_CONST( VARIABLE_HP_SMTH_COEF2, 16 ) );\r
90 \r
91     /* convert from log scale to Hertz */\r
92     cutoff_Hz = silk_log2lin( SKP_RSHIFT( psEncC1->variable_HP_smth2_Q15, 8 ) );\r
93 \r
94     /********************************/\r
95     /* Compute Filter Coefficients  */\r
96     /********************************/\r
97     /* compute cut-off frequency, in radians    */\r
98     /* Fc_num   = 1.5 * 3.14159 * cutoff_Hz     */\r
99     /* Fc_denom = 1e3f * psEncC1->fs_kHz        */\r
100     SKP_assert( cutoff_Hz <= SKP_int32_MAX / SILK_FIX_CONST( 1.5 * 3.14159 / 1000, 19 ) );\r
101     Fc_Q19 = SKP_DIV32_16( SKP_SMULBB( SILK_FIX_CONST( 1.5 * 3.14159 / 1000, 19 ), cutoff_Hz ), psEncC1->fs_kHz );\r
102     SKP_assert( Fc_Q19 > 0 && Fc_Q19 < 32768 );\r
103 \r
104     r_Q28 = SILK_FIX_CONST( 1.0, 28 ) - SKP_MUL( SILK_FIX_CONST( 0.92, 9 ), Fc_Q19 );\r
105 \r
106     /* b = r * [ 1; -2; 1 ]; */\r
107     /* a = [ 1; -2 * r * ( 1 - 0.5 * Fc^2 ); r^2 ]; */\r
108     B_Q28[ 0 ] = r_Q28;\r
109     B_Q28[ 1 ] = SKP_LSHIFT( -r_Q28, 1 );\r
110     B_Q28[ 2 ] = r_Q28;\r
111     \r
112     /* -r * ( 2 - Fc * Fc ); */\r
113     r_Q22  = SKP_RSHIFT( r_Q28, 6 );\r
114     A_Q28[ 0 ] = SKP_SMULWW( r_Q22, SKP_SMULWW( Fc_Q19, Fc_Q19 ) - SILK_FIX_CONST( 2.0,  22 ) );\r
115     A_Q28[ 1 ] = SKP_SMULWW( r_Q22, r_Q22 );\r
116 \r
117     /********************************/\r
118     /* High-Pass Filter             */\r
119     /********************************/\r
120     silk_biquad_alt( psEncC1->inputBuf, B_Q28, A_Q28, psEncC1->In_HP_State, psEncC1->inputBuf, psEncC1->frame_length );\r
121     if( nChannels == 2 ) {\r
122         silk_biquad_alt( state_Fxx[ 1 ].sCmn.inputBuf, B_Q28, A_Q28, state_Fxx[ 1 ].sCmn.In_HP_State, \r
123             state_Fxx[ 1 ].sCmn.inputBuf, state_Fxx[ 1 ].sCmn.frame_length );\r
124     }\r
125 }\r