Update SILK code using the CELT range coder
[opus.git] / src_common / SKP_Silk_LP_variable_cutoff.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, 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 /* \r
29 \r
30     Elliptic/Cauer filters designed with 0.1 dB passband ripple, \r
31         80 dB minimum stopband attenuation, and\r
32         [0.95 : 0.15 : 0.35] normalized cut off frequencies.\r
33 \r
34 */\r
35 #include "SKP_Silk_main.h"\r
36 \r
37 #if SWITCH_TRANSITION_FILTERING\r
38 \r
39 /* Helper function, that interpolates the filter taps */\r
40 SKP_INLINE void SKP_Silk_LP_interpolate_filter_taps( \r
41     SKP_int32           B_Q28[ TRANSITION_NB ], \r
42     SKP_int32           A_Q28[ TRANSITION_NA ],\r
43     const SKP_int       ind,\r
44     const SKP_int32     fac_Q16\r
45 )\r
46 {\r
47     SKP_int nb, na;\r
48 \r
49     if( ind < TRANSITION_INT_NUM - 1 ) {\r
50         if( fac_Q16 > 0 ) {\r
51             if( fac_Q16 == SKP_SAT16( fac_Q16 ) ) { /* fac_Q16 is in range of a 16-bit int */\r
52                 /* Piece-wise linear interpolation of B and A */\r
53                 for( nb = 0; nb < TRANSITION_NB; nb++ ) {\r
54                     B_Q28[ nb ] = SKP_SMLAWB(\r
55                         SKP_Silk_Transition_LP_B_Q28[ ind     ][ nb ],\r
56                         SKP_Silk_Transition_LP_B_Q28[ ind + 1 ][ nb ] -\r
57                         SKP_Silk_Transition_LP_B_Q28[ ind     ][ nb ],\r
58                         fac_Q16 );\r
59                 }\r
60                 for( na = 0; na < TRANSITION_NA; na++ ) {\r
61                     A_Q28[ na ] = SKP_SMLAWB(\r
62                         SKP_Silk_Transition_LP_A_Q28[ ind     ][ na ],\r
63                         SKP_Silk_Transition_LP_A_Q28[ ind + 1 ][ na ] -\r
64                         SKP_Silk_Transition_LP_A_Q28[ ind     ][ na ],\r
65                         fac_Q16 );\r
66                 }\r
67             } else if( fac_Q16 == ( 1 << 15 ) ) { /* Neither fac_Q16 nor ( ( 1 << 16 ) - fac_Q16 ) is in range of a 16-bit int */\r
68 \r
69                 /* Piece-wise linear interpolation of B and A */\r
70                 for( nb = 0; nb < TRANSITION_NB; nb++ ) {\r
71                     B_Q28[ nb ] = SKP_RSHIFT( \r
72                         SKP_Silk_Transition_LP_B_Q28[ ind     ][ nb ] +\r
73                         SKP_Silk_Transition_LP_B_Q28[ ind + 1 ][ nb ],\r
74                         1 );\r
75                 }\r
76                 for( na = 0; na < TRANSITION_NA; na++ ) {\r
77                     A_Q28[ na ] = SKP_RSHIFT( \r
78                         SKP_Silk_Transition_LP_A_Q28[ ind     ][ na ] + \r
79                         SKP_Silk_Transition_LP_A_Q28[ ind + 1 ][ na ], \r
80                         1 );\r
81                 }\r
82             } else { /* ( ( 1 << 16 ) - fac_Q16 ) is in range of a 16-bit int */\r
83                 \r
84                 SKP_assert( ( ( 1 << 16 ) - fac_Q16 ) == SKP_SAT16( ( ( 1 << 16 ) - fac_Q16) ) );\r
85                 /* Piece-wise linear interpolation of B and A */\r
86                 for( nb = 0; nb < TRANSITION_NB; nb++ ) {\r
87                     B_Q28[ nb ] = SKP_SMLAWB(\r
88                         SKP_Silk_Transition_LP_B_Q28[ ind + 1 ][ nb ],\r
89                         SKP_Silk_Transition_LP_B_Q28[ ind     ][ nb ] -\r
90                         SKP_Silk_Transition_LP_B_Q28[ ind + 1 ][ nb ],\r
91                         ( 1 << 16 ) - fac_Q16 );\r
92                 }\r
93                 for( na = 0; na < TRANSITION_NA; na++ ) {\r
94                     A_Q28[ na ] = SKP_SMLAWB(\r
95                         SKP_Silk_Transition_LP_A_Q28[ ind + 1 ][ na ],\r
96                         SKP_Silk_Transition_LP_A_Q28[ ind     ][ na ] -\r
97                         SKP_Silk_Transition_LP_A_Q28[ ind + 1 ][ na ],\r
98                         ( 1 << 16 ) - fac_Q16 );\r
99                 }\r
100             }\r
101         } else {\r
102             SKP_memcpy( B_Q28, SKP_Silk_Transition_LP_B_Q28[ ind ], TRANSITION_NB * sizeof( SKP_int32 ) );\r
103             SKP_memcpy( A_Q28, SKP_Silk_Transition_LP_A_Q28[ ind ], TRANSITION_NA * sizeof( SKP_int32 ) );\r
104         }\r
105     } else {\r
106         SKP_memcpy( B_Q28, SKP_Silk_Transition_LP_B_Q28[ TRANSITION_INT_NUM - 1 ], TRANSITION_NB * sizeof( SKP_int32 ) );\r
107         SKP_memcpy( A_Q28, SKP_Silk_Transition_LP_A_Q28[ TRANSITION_INT_NUM - 1 ], TRANSITION_NA * sizeof( SKP_int32 ) );\r
108     }\r
109 }\r
110 \r
111 /* Low-pass filter with variable cutoff frequency based on  */\r
112 /* piece-wise linear interpolation between elliptic filters */\r
113 /* Start by setting psEncC->transition_frame_no = 1;            */\r
114 /* Deactivate by setting psEncC->transition_frame_no = 0;   */\r
115 void SKP_Silk_LP_variable_cutoff(\r
116     SKP_Silk_LP_state               *psLP,          /* I/O  LP filter state                     */\r
117     SKP_int16                       *out,           /* O    Low-pass filtered output signal     */\r
118     const SKP_int16                 *in,            /* I    Input signal                        */\r
119     const SKP_int                   frame_length    /* I    Frame length                        */\r
120 )\r
121 {\r
122     SKP_int32   B_Q28[ TRANSITION_NB ], A_Q28[ TRANSITION_NA ], fac_Q16 = 0;\r
123     SKP_int     ind = 0;\r
124 \r
125     SKP_assert( psLP->transition_frame_no >= 0 );\r
126     SKP_assert( ( ( ( psLP->transition_frame_no <= TRANSITION_FRAMES_DOWN ) && ( psLP->mode == 0 ) ) || \r
127                   ( ( psLP->transition_frame_no <= TRANSITION_FRAMES_UP   ) && ( psLP->mode == 1 ) ) ) );\r
128 \r
129     /* Interpolate filter coefficients if needed */\r
130     if( psLP->transition_frame_no > 0 ) {\r
131         if( psLP->mode == 0 ) {\r
132             if( psLP->transition_frame_no < TRANSITION_FRAMES_DOWN ) {\r
133                 /* Calculate index and interpolation factor for interpolation */\r
134 #if( TRANSITION_INT_STEPS_DOWN == 32 )\r
135                 fac_Q16 = SKP_LSHIFT( psLP->transition_frame_no, 16 - 5 );\r
136 #else\r
137                 fac_Q16 = SKP_DIV32_16( SKP_LSHIFT( psLP->transition_frame_no, 16 ), TRANSITION_INT_STEPS_DOWN );\r
138 #endif\r
139                 ind      = SKP_RSHIFT( fac_Q16, 16 );\r
140                 fac_Q16 -= SKP_LSHIFT( ind, 16 );\r
141 \r
142                 SKP_assert( ind >= 0 );\r
143                 SKP_assert( ind < TRANSITION_INT_NUM );\r
144 \r
145                 /* Interpolate filter coefficients */\r
146                 SKP_Silk_LP_interpolate_filter_taps( B_Q28, A_Q28, ind, fac_Q16 );\r
147 \r
148                 /* Increment transition frame number for next frame */\r
149                 psLP->transition_frame_no++;\r
150 \r
151             } else {\r
152                 SKP_assert( psLP->transition_frame_no == TRANSITION_FRAMES_DOWN );\r
153                 /* End of transition phase */\r
154                 SKP_Silk_LP_interpolate_filter_taps( B_Q28, A_Q28, TRANSITION_INT_NUM - 1, 0 );\r
155             }\r
156         } else {\r
157             SKP_assert( psLP->mode == 1 );\r
158             if( psLP->transition_frame_no < TRANSITION_FRAMES_UP ) {\r
159                 /* Calculate index and interpolation factor for interpolation */\r
160 #if( TRANSITION_INT_STEPS_UP == 64 )\r
161                 fac_Q16 = SKP_LSHIFT( TRANSITION_FRAMES_UP - psLP->transition_frame_no, 16 - 6 );\r
162 #else\r
163                 fac_Q16 = SKP_DIV32_16( SKP_LSHIFT( TRANSITION_FRAMES_UP - psLP->transition_frame_no, 16 ), TRANSITION_INT_STEPS_UP );\r
164 #endif\r
165                 ind      = SKP_RSHIFT( fac_Q16, 16 );\r
166                 fac_Q16 -= SKP_LSHIFT( ind, 16 );\r
167 \r
168                 SKP_assert( ind >= 0 );\r
169                 SKP_assert( ind < TRANSITION_INT_NUM );\r
170 \r
171                 /* Interpolate filter coefficients */\r
172                 SKP_Silk_LP_interpolate_filter_taps( B_Q28, A_Q28, ind, fac_Q16 );\r
173 \r
174                 /* Increment transition frame number for next frame */\r
175                 psLP->transition_frame_no++;\r
176             \r
177             } else {\r
178                 SKP_assert( psLP->transition_frame_no == TRANSITION_FRAMES_UP );\r
179                 /* End of transition phase */\r
180                 SKP_Silk_LP_interpolate_filter_taps( B_Q28, A_Q28, 0, 0 );\r
181             }\r
182         }\r
183     } \r
184     \r
185     if( psLP->transition_frame_no > 0 ) {\r
186         /* ARMA low-pass filtering */\r
187         SKP_assert( TRANSITION_NB == 3 && TRANSITION_NA == 2 );\r
188         SKP_Silk_biquad_alt( in, B_Q28, A_Q28, psLP->In_LP_State, out, frame_length );\r
189     } else {\r
190         /* Instead of using the filter, copy input directly to output */\r
191         SKP_memcpy( out, in, frame_length * sizeof( SKP_int16 ) );\r
192     }\r
193 }\r
194 #endif\r