Fixing silk fixed point
[opus.git] / silk / silk_resampler.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 /* Matrix of resampling methods used:\r
29  *                                        Fs_out (kHz)\r
30  *                        8      12     16     24     32     44.1   48\r
31  *\r
32  *               8        C      UF     U      UF     UF     UF     UF\r
33  *              12        AF     C      UF     U      UF     UF     UF\r
34  *              16        D      AF     C      UF     U      UF     UF\r
35  * Fs_in (kHz)  24        AIF    D      AF     C      UF     UF     U\r
36  *              32        UF     AF     D      AF     C      UF     UF\r
37  *              44.1      AMI    AMI    AMI    AMI    AMI    C      UF\r
38  *              48        DAF    DAF    AF     D      AF     UF     C\r
39  *\r
40  * default method: UF\r
41  *\r
42  * C   -> Copy (no resampling)\r
43  * D   -> Allpass-based 2x downsampling\r
44  * U   -> Allpass-based 2x upsampling\r
45  * DAF -> Allpass-based 2x downsampling followed by AR2 filter followed by FIR interpolation\r
46  * UF  -> Allpass-based 2x upsampling followed by FIR interpolation\r
47  * AMI -> ARMA4 filter followed by FIR interpolation\r
48  * AF  -> AR2 filter followed by FIR interpolation\r
49  *\r
50  * Input signals sampled above 48 kHz are first downsampled to at most 48 kHz.\r
51  * Output signals sampled above 48 kHz are upsampled from at most 48 kHz.\r
52  */\r
53 \r
54 #include "silk_resampler_private.h"\r
55 \r
56 /* Greatest common divisor */\r
57 static SKP_int32 gcd(\r
58     SKP_int32 a,\r
59     SKP_int32 b\r
60 )\r
61 {\r
62     SKP_int32 tmp;\r
63     while( b > 0 ) {\r
64         tmp = a - b * SKP_DIV32( a, b );\r
65         a   = b;\r
66         b   = tmp;\r
67     }\r
68     return a;\r
69 }\r
70 \r
71 /* Initialize/reset the resampler state for a given pair of input/output sampling rates */\r
72 SKP_int silk_resampler_init( \r
73         silk_resampler_state_struct     *S,                 /* I/O: Resampler state                     */\r
74         SKP_int32                                                       Fs_Hz_in,       /* I:   Input sampling rate (Hz)        */\r
75         SKP_int32                                                       Fs_Hz_out       /* I:   Output sampling rate (Hz)       */\r
76 )\r
77 {\r
78     SKP_int32 cycleLen, cyclesPerBatch, up2 = 0, down2 = 0;\r
79 \r
80         /* Clear state */\r
81         SKP_memset( S, 0, sizeof( silk_resampler_state_struct ) );\r
82 \r
83         /* Input checking */\r
84 #if RESAMPLER_SUPPORT_ABOVE_48KHZ\r
85         if( Fs_Hz_in < 8000 || Fs_Hz_in > 192000 || Fs_Hz_out < 8000 || Fs_Hz_out > 192000 ) {\r
86 #else\r
87     if( Fs_Hz_in < 8000 || Fs_Hz_in >  48000 || Fs_Hz_out < 8000 || Fs_Hz_out >  48000 ) {\r
88 #endif\r
89                 SKP_assert( 0 );\r
90                 return -1;\r
91         }\r
92 \r
93 #if RESAMPLER_SUPPORT_ABOVE_48KHZ\r
94         /* Determine pre downsampling and post upsampling */\r
95         if( Fs_Hz_in > 96000 ) {\r
96                 S->nPreDownsamplers = 2;\r
97         S->down_pre_function = silk_resampler_private_down4;\r
98     } else if( Fs_Hz_in > 48000 ) {\r
99                 S->nPreDownsamplers = 1;\r
100         S->down_pre_function = silk_resampler_down2;\r
101     } else {\r
102                 S->nPreDownsamplers = 0;\r
103         S->down_pre_function = NULL;\r
104     }\r
105 \r
106         if( Fs_Hz_out > 96000 ) {\r
107                 S->nPostUpsamplers = 2;\r
108         S->up_post_function = silk_resampler_private_up4;\r
109     } else if( Fs_Hz_out > 48000 ) {\r
110                 S->nPostUpsamplers = 1;\r
111         S->up_post_function = silk_resampler_up2;\r
112     } else {\r
113                 S->nPostUpsamplers = 0;\r
114         S->up_post_function = NULL;\r
115     }\r
116 \r
117     if( S->nPreDownsamplers + S->nPostUpsamplers > 0 ) {\r
118         /* Ratio of output/input samples */\r
119             S->ratio_Q16 = SKP_LSHIFT32( SKP_DIV32( SKP_LSHIFT32( Fs_Hz_out, 13 ), Fs_Hz_in ), 3 );\r
120         /* Make sure the ratio is rounded up */\r
121         while( SKP_SMULWW( S->ratio_Q16, Fs_Hz_in ) < Fs_Hz_out ) S->ratio_Q16++;\r
122 \r
123         /* Batch size is 10 ms */\r
124         S->batchSizePrePost = SKP_DIV32_16( Fs_Hz_in, 100 );\r
125 \r
126         /* Convert sampling rate to those after pre-downsampling and before post-upsampling */\r
127             Fs_Hz_in  = SKP_RSHIFT( Fs_Hz_in,  S->nPreDownsamplers  );\r
128             Fs_Hz_out = SKP_RSHIFT( Fs_Hz_out, S->nPostUpsamplers  );\r
129     }\r
130 #endif\r
131 \r
132     /* Number of samples processed per batch */\r
133     /* First, try 10 ms frames */\r
134     S->batchSize = SKP_DIV32_16( Fs_Hz_in, 100 );\r
135     if( ( SKP_MUL( S->batchSize, 100 ) != Fs_Hz_in ) || ( Fs_Hz_in % 100 != 0 ) ) {\r
136         /* No integer number of input or output samples with 10 ms frames, use greatest common divisor */\r
137         cycleLen = SKP_DIV32( Fs_Hz_in, gcd( Fs_Hz_in, Fs_Hz_out ) );\r
138         cyclesPerBatch = SKP_DIV32( RESAMPLER_MAX_BATCH_SIZE_IN, cycleLen );\r
139         if( cyclesPerBatch == 0 ) {\r
140             /* cycleLen too big, let's just use the maximum batch size. Some distortion will result. */\r
141             S->batchSize = RESAMPLER_MAX_BATCH_SIZE_IN;\r
142             SKP_assert( 0 );\r
143         } else {\r
144             S->batchSize = SKP_MUL( cyclesPerBatch, cycleLen );\r
145         }\r
146     }\r
147 \r
148 \r
149         /* Find resampler with the right sampling ratio */\r
150     if( Fs_Hz_out > Fs_Hz_in ) {\r
151         /* Upsample */\r
152         if( Fs_Hz_out == SKP_MUL( Fs_Hz_in, 2 ) ) {                             /* Fs_out : Fs_in = 2 : 1 */\r
153             /* Special case: directly use 2x upsampler */\r
154             S->resampler_function = silk_resampler_private_up2_HQ_wrapper;\r
155         } else {\r
156                 /* Default resampler */\r
157                 S->resampler_function = silk_resampler_private_IIR_FIR;\r
158             up2 = 1;\r
159             if( Fs_Hz_in > 24000 ) {\r
160                 /* Low-quality all-pass upsampler */\r
161                 S->up2_function = silk_resampler_up2;\r
162             } else {\r
163                 /* High-quality all-pass upsampler */\r
164                 S->up2_function = silk_resampler_private_up2_HQ;\r
165             }\r
166         }\r
167     } else if ( Fs_Hz_out < Fs_Hz_in ) {\r
168         /* Downsample */\r
169         if( SKP_MUL( Fs_Hz_out, 4 ) == SKP_MUL( Fs_Hz_in, 3 ) ) {               /* Fs_out : Fs_in = 3 : 4 */\r
170             S->FIR_Fracs = 3;\r
171             S->Coefs = silk_Resampler_3_4_COEFS;\r
172             S->resampler_function = silk_resampler_private_down_FIR;\r
173         } else if( SKP_MUL( Fs_Hz_out, 3 ) == SKP_MUL( Fs_Hz_in, 2 ) ) {        /* Fs_out : Fs_in = 2 : 3 */\r
174             S->FIR_Fracs = 2;\r
175             S->Coefs = silk_Resampler_2_3_COEFS;\r
176             S->resampler_function = silk_resampler_private_down_FIR;\r
177         } else if( SKP_MUL( Fs_Hz_out, 2 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 2 */\r
178             S->FIR_Fracs = 1;\r
179             S->Coefs = silk_Resampler_1_2_COEFS;\r
180             S->resampler_function = silk_resampler_private_down_FIR;\r
181         } else if( SKP_MUL( Fs_Hz_out, 8 ) == SKP_MUL( Fs_Hz_in, 3 ) ) {        /* Fs_out : Fs_in = 3 : 8 */\r
182             S->FIR_Fracs = 3;\r
183             S->Coefs = silk_Resampler_3_8_COEFS;\r
184             S->resampler_function = silk_resampler_private_down_FIR;\r
185         } else if( SKP_MUL( Fs_Hz_out, 3 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 3 */\r
186             S->FIR_Fracs = 1;\r
187             S->Coefs = silk_Resampler_1_3_COEFS;\r
188             S->resampler_function = silk_resampler_private_down_FIR;\r
189         } else if( SKP_MUL( Fs_Hz_out, 4 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 4 */\r
190             S->FIR_Fracs = 1;\r
191             down2 = 1;\r
192             S->Coefs = silk_Resampler_1_2_COEFS;\r
193             S->resampler_function = silk_resampler_private_down_FIR;\r
194         } else if( SKP_MUL( Fs_Hz_out, 6 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 6 */\r
195             S->FIR_Fracs = 1;\r
196             down2 = 1;\r
197             S->Coefs = silk_Resampler_1_3_COEFS;\r
198             S->resampler_function = silk_resampler_private_down_FIR;\r
199         } else if( SKP_MUL( Fs_Hz_out, 441 ) == SKP_MUL( Fs_Hz_in, 80 ) ) {     /* Fs_out : Fs_in = 80 : 441 */\r
200             S->Coefs = silk_Resampler_80_441_ARMA4_COEFS;\r
201             S->resampler_function = silk_resampler_private_IIR_FIR;\r
202         } else if( SKP_MUL( Fs_Hz_out, 441 ) == SKP_MUL( Fs_Hz_in, 120 ) ) {    /* Fs_out : Fs_in = 120 : 441 */\r
203             S->Coefs = silk_Resampler_120_441_ARMA4_COEFS;\r
204             S->resampler_function = silk_resampler_private_IIR_FIR;\r
205         } else if( SKP_MUL( Fs_Hz_out, 441 ) == SKP_MUL( Fs_Hz_in, 160 ) ) {    /* Fs_out : Fs_in = 160 : 441 */\r
206             S->Coefs = silk_Resampler_160_441_ARMA4_COEFS;\r
207             S->resampler_function = silk_resampler_private_IIR_FIR;\r
208         } else if( SKP_MUL( Fs_Hz_out, 441 ) == SKP_MUL( Fs_Hz_in, 240 ) ) {    /* Fs_out : Fs_in = 240 : 441 */\r
209             S->Coefs = silk_Resampler_240_441_ARMA4_COEFS;\r
210             S->resampler_function = silk_resampler_private_IIR_FIR;\r
211         } else if( SKP_MUL( Fs_Hz_out, 441 ) == SKP_MUL( Fs_Hz_in, 320 ) ) {    /* Fs_out : Fs_in = 320 : 441 */\r
212             S->Coefs = silk_Resampler_320_441_ARMA4_COEFS;\r
213             S->resampler_function = silk_resampler_private_IIR_FIR;\r
214         } else {\r
215                 /* Default resampler */\r
216                 S->resampler_function = silk_resampler_private_IIR_FIR;\r
217             up2 = 1;\r
218             if( Fs_Hz_in > 24000 ) {\r
219                 /* Low-quality all-pass upsampler */\r
220                 S->up2_function = silk_resampler_up2;\r
221             } else {\r
222                 /* High-quality all-pass upsampler */\r
223                 S->up2_function = silk_resampler_private_up2_HQ;\r
224             }\r
225         }\r
226     } else {\r
227         /* Input and output sampling rates are equal: copy */\r
228         S->resampler_function = silk_resampler_private_copy;\r
229     }\r
230 \r
231     S->input2x = up2 | down2;\r
232 \r
233     /* Ratio of input/output samples */\r
234     S->invRatio_Q16 = SKP_LSHIFT32( SKP_DIV32( SKP_LSHIFT32( Fs_Hz_in, 14 + up2 - down2 ), Fs_Hz_out ), 2 );\r
235     /* Make sure the ratio is rounded up */\r
236     while( SKP_SMULWW( S->invRatio_Q16, SKP_LSHIFT32( Fs_Hz_out, down2 ) ) < SKP_LSHIFT32( Fs_Hz_in, up2 ) ) {\r
237         S->invRatio_Q16++;\r
238     }\r
239 \r
240         S->magic_number = 123456789;\r
241 \r
242         return 0;\r
243 }\r
244 \r
245 /* Clear the states of all resampling filters, without resetting sampling rate ratio */\r
246 SKP_int silk_resampler_clear( \r
247         silk_resampler_state_struct     *S                  /* I/O: Resampler state                     */\r
248 )\r
249 {\r
250         /* Clear state */\r
251         SKP_memset( S->sDown2, 0, sizeof( S->sDown2 ) );\r
252         SKP_memset( S->sIIR,   0, sizeof( S->sIIR ) );\r
253         SKP_memset( S->sFIR,   0, sizeof( S->sFIR ) );\r
254 #if RESAMPLER_SUPPORT_ABOVE_48KHZ\r
255         SKP_memset( S->sDownPre, 0, sizeof( S->sDownPre ) );\r
256         SKP_memset( S->sUpPost,  0, sizeof( S->sUpPost ) );\r
257 #endif\r
258     return 0;\r
259 }\r
260 \r
261 /* Resampler: convert from one sampling rate to another                                 */\r
262 SKP_int silk_resampler( \r
263         silk_resampler_state_struct     *S,                 /* I/O: Resampler state                     */\r
264         SKP_int16                                                       out[],      /* O:       Output signal                           */\r
265         const SKP_int16                                         in[],       /* I:       Input signal                            */\r
266         SKP_int32                                                       inLen       /* I:       Number of input samples         */\r
267 )\r
268 {\r
269         /* Verify that state was initialized and has not been corrupted */\r
270     if( S->magic_number != 123456789 ) {\r
271         SKP_assert( 0 );\r
272         return -1;\r
273     }\r
274 \r
275 #if RESAMPLER_SUPPORT_ABOVE_48KHZ\r
276         if( S->nPreDownsamplers + S->nPostUpsamplers > 0 ) {\r
277                 /* The input and/or output sampling rate is above 48000 Hz */\r
278         SKP_int32       nSamplesIn, nSamplesOut;\r
279                 SKP_int16               in_buf[ 480 ], out_buf[ 480 ];\r
280 \r
281         while( inLen > 0 ) {\r
282             /* Number of input and output samples to process */\r
283                 nSamplesIn = SKP_min( inLen, S->batchSizePrePost );\r
284             nSamplesOut = SKP_SMULWB( S->ratio_Q16, nSamplesIn );\r
285 \r
286             SKP_assert( SKP_RSHIFT32( nSamplesIn,  S->nPreDownsamplers ) <= 480 );\r
287             SKP_assert( SKP_RSHIFT32( nSamplesOut, S->nPostUpsamplers  ) <= 480 );\r
288 \r
289                 if( S->nPreDownsamplers > 0 ) {\r
290                 S->down_pre_function( S->sDownPre, in_buf, in, nSamplesIn );\r
291                     if( S->nPostUpsamplers > 0 ) {\r
292                         S->resampler_function( S, out_buf, in_buf, SKP_RSHIFT32( nSamplesIn, S->nPreDownsamplers ) );\r
293                     S->up_post_function( S->sUpPost, out, out_buf, SKP_RSHIFT32( nSamplesOut, S->nPostUpsamplers ) );\r
294                 } else {\r
295                         S->resampler_function( S, out, in_buf, SKP_RSHIFT32( nSamplesIn, S->nPreDownsamplers ) );\r
296                 }\r
297             } else {\r
298                         S->resampler_function( S, out_buf, in, SKP_RSHIFT32( nSamplesIn, S->nPreDownsamplers ) );\r
299                 S->up_post_function( S->sUpPost, out, out_buf, SKP_RSHIFT32( nSamplesOut, S->nPostUpsamplers ) );\r
300             }\r
301 \r
302                 in += nSamplesIn;\r
303             out += nSamplesOut;\r
304                 inLen -= nSamplesIn;\r
305         }\r
306         } else \r
307 #endif\r
308         {\r
309                 /* Input and output sampling rate are at most 48000 Hz */\r
310                 S->resampler_function( S, out, in, inLen );\r
311         }\r
312 \r
313         return 0;\r
314 }\r