More resampler cleanups.
[opus.git] / 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 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 /* Matrix of resampling methods used:
33  *                                 Fs_out (kHz)
34  *                        8      12     16     24    48
35  *
36  *               8        C      UF     U      UF     UF
37  *              12        AF     C      UF     U      UF
38  * Fs_in (kHz)  16        D      AF     C      UF     UF
39  *              24        AIF    D      AF     C      U
40  *              48        DAF    DAF    AF     D      C
41  *
42  * default method: UF
43  *
44  * C   -> Copy (no resampling)
45  * D   -> Allpass-based 2x downsampling
46  * U   -> Allpass-based 2x upsampling
47  * DAF -> Allpass-based 2x downsampling followed by AR2 filter followed by FIR interpolation
48  * UF  -> Allpass-based 2x upsampling followed by FIR interpolation
49  * AF  -> AR2 filter followed by FIR interpolation
50  *
51  * Signals sampled above 48 kHz are not supported.
52  */
53
54 #include "resampler_private.h"
55
56 #define USE_silk_resampler_copy (0)
57 #define USE_silk_resampler_private_up2_HQ_wrapper (1)
58 #define USE_silk_resampler_private_IIR_FIR (2)
59 #define USE_silk_resampler_private_down_FIR (3)
60
61 /* Initialize/reset the resampler state for a given pair of input/output sampling rates */
62 opus_int silk_resampler_init(
63     silk_resampler_state_struct    *S,                    /* I/O: Resampler state             */
64     opus_int32                            Fs_Hz_in,    /* I:    Input sampling rate (Hz)    */
65     opus_int32                            Fs_Hz_out    /* I:    Output sampling rate (Hz)    */
66 )
67 {
68     opus_int32 up2 = 0, down2 = 0;
69
70     /* Clear state */
71     silk_memset( S, 0, sizeof( silk_resampler_state_struct ) );
72
73     /* Input checking */
74     if( (Fs_Hz_in!=8000 && Fs_Hz_in!=12000 && Fs_Hz_in!=16000 && Fs_Hz_in!=24000 && Fs_Hz_in!=48000) ||
75         (Fs_Hz_out!=8000 && Fs_Hz_out!=12000 && Fs_Hz_out!=16000 && Fs_Hz_out!=24000 && Fs_Hz_out!=48000) ) {
76         silk_assert( 0 );
77         return -1;
78     }
79
80     /* Number of samples processed per batch */
81     S->batchSize = silk_DIV32_16( Fs_Hz_in, 100 );
82
83     /* Find resampler with the right sampling ratio */
84     if( Fs_Hz_out > Fs_Hz_in ) {
85         /* Upsample */
86         if( Fs_Hz_out == silk_MUL( Fs_Hz_in, 2 ) ) {                             /* Fs_out : Fs_in = 2 : 1 */
87             /* Special case: directly use 2x upsampler */
88             S->resampler_function = USE_silk_resampler_private_up2_HQ_wrapper;
89         } else {
90             /* Default resampler */
91             S->resampler_function = USE_silk_resampler_private_IIR_FIR;
92             up2 = 1;
93         }
94     } else if ( Fs_Hz_out < Fs_Hz_in ) {
95         /* Downsample */
96         if( silk_MUL( Fs_Hz_out, 4 ) == silk_MUL( Fs_Hz_in, 3 ) ) {               /* Fs_out : Fs_in = 3 : 4 */
97             S->FIR_Fracs = 3;
98             S->Coefs = silk_Resampler_3_4_COEFS;
99             S->resampler_function = USE_silk_resampler_private_down_FIR;
100         } else if( silk_MUL( Fs_Hz_out, 3 ) == silk_MUL( Fs_Hz_in, 2 ) ) {        /* Fs_out : Fs_in = 2 : 3 */
101             S->FIR_Fracs = 2;
102             S->Coefs = silk_Resampler_2_3_COEFS;
103             S->resampler_function = USE_silk_resampler_private_down_FIR;
104         } else if( silk_MUL( Fs_Hz_out, 2 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 2 */
105             S->FIR_Fracs = 1;
106             S->Coefs = silk_Resampler_1_2_COEFS;
107             S->resampler_function = USE_silk_resampler_private_down_FIR;
108         } else if( silk_MUL( Fs_Hz_out, 3 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 3 */
109             S->FIR_Fracs = 1;
110             S->Coefs = silk_Resampler_1_3_COEFS;
111             S->resampler_function = USE_silk_resampler_private_down_FIR;
112         } else if( silk_MUL( Fs_Hz_out, 4 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 4 */
113             S->FIR_Fracs = 1;
114             down2 = 1;
115             S->Coefs = silk_Resampler_1_2_COEFS;
116             S->resampler_function = USE_silk_resampler_private_down_FIR;
117         } else if( silk_MUL( Fs_Hz_out, 6 ) == Fs_Hz_in ) {                      /* Fs_out : Fs_in = 1 : 6 */
118             S->FIR_Fracs = 1;
119             down2 = 1;
120             S->Coefs = silk_Resampler_1_3_COEFS;
121             S->resampler_function = USE_silk_resampler_private_down_FIR;
122         } else {
123             /* None available */
124             silk_assert( 0 );
125             return -1;
126         }
127     } else {
128         /* Input and output sampling rates are equal: copy */
129         S->resampler_function = USE_silk_resampler_copy;
130     }
131
132     S->input2x = up2 | down2;
133
134     /* Ratio of input/output samples */
135     S->invRatio_Q16 = silk_LSHIFT32( silk_DIV32( silk_LSHIFT32( Fs_Hz_in, 14 + up2 - down2 ), Fs_Hz_out ), 2 );
136     /* Make sure the ratio is rounded up */
137     while( silk_SMULWW( S->invRatio_Q16, silk_LSHIFT32( Fs_Hz_out, down2 ) ) < silk_LSHIFT32( Fs_Hz_in, up2 ) ) {
138         S->invRatio_Q16++;
139     }
140
141     return 0;
142 }
143
144 /* Clear the states of all resampling filters, without resetting sampling rate ratio */
145 opus_int silk_resampler_clear(
146     silk_resampler_state_struct    *S            /* I/O: Resampler state             */
147 )
148 {
149     /* Clear state */
150     silk_memset( S->sDown2, 0, sizeof( S->sDown2 ) );
151     silk_memset( S->sIIR,   0, sizeof( S->sIIR ) );
152     silk_memset( S->sFIR,   0, sizeof( S->sFIR ) );
153     return 0;
154 }
155
156 /* Resampler: convert from one sampling rate to another                                 */
157 opus_int silk_resampler(
158     silk_resampler_state_struct    *S,                    /* I/O: Resampler state             */
159     opus_int16                            out[],        /* O:    Output signal                 */
160     const opus_int16                        in[],        /* I:    Input signal                */
161     opus_int32                            inLen        /* I:    Number of input samples        */
162 )
163 {
164     /* Input and output sampling rate are at most 48000 Hz */
165     switch(S->resampler_function) {
166         case USE_silk_resampler_private_up2_HQ_wrapper:
167             silk_resampler_private_up2_HQ_wrapper( S, out, in, inLen );
168             break;
169         case USE_silk_resampler_private_IIR_FIR:
170             silk_resampler_private_IIR_FIR( S, out, in, inLen );
171             break;
172         case USE_silk_resampler_private_down_FIR:
173             silk_resampler_private_down_FIR( S, out, in, inLen );
174             break;
175         default:
176             silk_memcpy( out, in, inLen * sizeof( opus_int16 ) );
177     }
178     return 0;
179 }