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