Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / silk_resampler_private_down_FIR.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 #include "silk_SigProc_FIX.h"
29 #include "silk_resampler_private.h"
30
31 SKP_INLINE opus_int16 *silk_resampler_private_down_FIR_INTERPOL0(
32     opus_int16 *out, opus_int32 *buf2, const opus_int16 *FIR_Coefs, opus_int32 max_index_Q16, opus_int32 index_increment_Q16){
33
34     opus_int32 index_Q16, res_Q6;
35     opus_int32 *buf_ptr;
36     for( index_Q16 = 0; index_Q16 < max_index_Q16; index_Q16 += index_increment_Q16 ) {
37         /* Integer part gives pointer to buffered input */
38         buf_ptr = buf2 + SKP_RSHIFT( index_Q16, 16 );
39
40         /* Inner product */
41         res_Q6 = SKP_SMULWB(         SKP_ADD32( buf_ptr[ 0 ], buf_ptr[ 15 ] ), FIR_Coefs[ 0 ] );
42         res_Q6 = SKP_SMLAWB( res_Q6, SKP_ADD32( buf_ptr[ 1 ], buf_ptr[ 14 ] ), FIR_Coefs[ 1 ] );
43         res_Q6 = SKP_SMLAWB( res_Q6, SKP_ADD32( buf_ptr[ 2 ], buf_ptr[ 13 ] ), FIR_Coefs[ 2 ] );
44         res_Q6 = SKP_SMLAWB( res_Q6, SKP_ADD32( buf_ptr[ 3 ], buf_ptr[ 12 ] ), FIR_Coefs[ 3 ] );
45         res_Q6 = SKP_SMLAWB( res_Q6, SKP_ADD32( buf_ptr[ 4 ], buf_ptr[ 11 ] ), FIR_Coefs[ 4 ] );
46         res_Q6 = SKP_SMLAWB( res_Q6, SKP_ADD32( buf_ptr[ 5 ], buf_ptr[ 10 ] ), FIR_Coefs[ 5 ] );
47         res_Q6 = SKP_SMLAWB( res_Q6, SKP_ADD32( buf_ptr[ 6 ], buf_ptr[  9 ] ), FIR_Coefs[ 6 ] );
48         res_Q6 = SKP_SMLAWB( res_Q6, SKP_ADD32( buf_ptr[ 7 ], buf_ptr[  8 ] ), FIR_Coefs[ 7 ] );
49
50                 /* Scale down, saturate and store in output array */
51         *out++ = (opus_int16)SKP_SAT16( SKP_RSHIFT_ROUND( res_Q6, 6 ) );
52     }
53     return out;
54 }
55
56 SKP_INLINE opus_int16 *silk_resampler_private_down_FIR_INTERPOL1(
57     opus_int16 *out, opus_int32 *buf2, const opus_int16 *FIR_Coefs, opus_int32 max_index_Q16, opus_int32 index_increment_Q16, opus_int32 FIR_Fracs){
58
59     opus_int32 index_Q16, res_Q6;
60     opus_int32 *buf_ptr;
61     opus_int32 interpol_ind;
62     const opus_int16 *interpol_ptr;
63     for( index_Q16 = 0; index_Q16 < max_index_Q16; index_Q16 += index_increment_Q16 ) {
64         /* Integer part gives pointer to buffered input */
65         buf_ptr = buf2 + SKP_RSHIFT( index_Q16, 16 );
66
67         /* Fractional part gives interpolation coefficients */
68         interpol_ind = SKP_SMULWB( index_Q16 & 0xFFFF, FIR_Fracs );
69
70         /* Inner product */
71         interpol_ptr = &FIR_Coefs[ RESAMPLER_DOWN_ORDER_FIR / 2 * interpol_ind ];
72         res_Q6 = SKP_SMULWB(         buf_ptr[ 0 ], interpol_ptr[ 0 ] );
73         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 1 ], interpol_ptr[ 1 ] );
74         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 2 ], interpol_ptr[ 2 ] );
75         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 3 ], interpol_ptr[ 3 ] );
76         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 4 ], interpol_ptr[ 4 ] );
77         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 5 ], interpol_ptr[ 5 ] );
78         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 6 ], interpol_ptr[ 6 ] );
79         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 7 ], interpol_ptr[ 7 ] );
80         interpol_ptr = &FIR_Coefs[ RESAMPLER_DOWN_ORDER_FIR / 2 * ( FIR_Fracs - 1 - interpol_ind ) ];
81         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 15 ], interpol_ptr[ 0 ] );
82         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 14 ], interpol_ptr[ 1 ] );
83         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 13 ], interpol_ptr[ 2 ] );
84         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 12 ], interpol_ptr[ 3 ] );
85         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 11 ], interpol_ptr[ 4 ] );
86         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[ 10 ], interpol_ptr[ 5 ] );
87         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[  9 ], interpol_ptr[ 6 ] );
88         res_Q6 = SKP_SMLAWB( res_Q6, buf_ptr[  8 ], interpol_ptr[ 7 ] );
89
90         /* Scale down, saturate and store in output array */
91         *out++ = (opus_int16)SKP_SAT16( SKP_RSHIFT_ROUND( res_Q6, 6 ) );
92     }
93     return out;
94 }
95
96
97 /* Resample with a 2x downsampler (optional), a 2nd order AR filter followed by FIR interpolation */
98 void silk_resampler_private_down_FIR(
99     void                            *SS,            /* I/O: Resampler state                         */
100     opus_int16                        out[],            /* O:    Output signal                             */
101     const opus_int16                    in[],            /* I:    Input signal                            */
102     opus_int32                        inLen            /* I:    Number of input samples                    */
103 )
104 {
105     silk_resampler_state_struct *S = (silk_resampler_state_struct *)SS;
106     opus_int32 nSamplesIn;
107     opus_int32 max_index_Q16, index_increment_Q16;
108     opus_int16 buf1[ RESAMPLER_MAX_BATCH_SIZE_IN / 2 ];
109     opus_int32 buf2[ RESAMPLER_MAX_BATCH_SIZE_IN + RESAMPLER_DOWN_ORDER_FIR ];
110     const opus_int16 *FIR_Coefs;
111
112     /* Copy buffered samples to start of buffer */
113     SKP_memcpy( buf2, S->sFIR, RESAMPLER_DOWN_ORDER_FIR * sizeof( opus_int32 ) );
114
115     FIR_Coefs = &S->Coefs[ 2 ];
116
117     /* Iterate over blocks of frameSizeIn input samples */
118     index_increment_Q16 = S->invRatio_Q16;
119     while( 1 ) {
120         nSamplesIn = SKP_min( inLen, S->batchSize );
121
122         if( S->input2x == 1 ) {
123             /* Downsample 2x */
124             silk_resampler_down2( S->sDown2, buf1, in, nSamplesIn );
125
126             nSamplesIn = SKP_RSHIFT32( nSamplesIn, 1 );
127
128             /* Second-order AR filter (output in Q8) */
129             silk_resampler_private_AR2( S->sIIR, &buf2[ RESAMPLER_DOWN_ORDER_FIR ], buf1, S->Coefs, nSamplesIn );
130         } else {
131             /* Second-order AR filter (output in Q8) */
132             silk_resampler_private_AR2( S->sIIR, &buf2[ RESAMPLER_DOWN_ORDER_FIR ], in, S->Coefs, nSamplesIn );
133         }
134
135         max_index_Q16 = SKP_LSHIFT32( nSamplesIn, 16 );
136
137         /* Interpolate filtered signal */
138         if( S->FIR_Fracs == 1 ) {
139             out = silk_resampler_private_down_FIR_INTERPOL0(out, buf2, FIR_Coefs, max_index_Q16, index_increment_Q16);
140         } else {
141             out = silk_resampler_private_down_FIR_INTERPOL1(out, buf2, FIR_Coefs, max_index_Q16, index_increment_Q16, S->FIR_Fracs);
142         }
143
144         in += nSamplesIn << S->input2x;
145         inLen -= nSamplesIn << S->input2x;
146
147         if( inLen > S->input2x ) {
148             /* More iterations to do; copy last part of filtered signal to beginning of buffer */
149             SKP_memcpy( buf2, &buf2[ nSamplesIn ], RESAMPLER_DOWN_ORDER_FIR * sizeof( opus_int32 ) );
150         } else {
151             break;
152         }
153     }
154
155     /* Copy last part of filtered signal to the state for the next call */
156     SKP_memcpy( S->sFIR, &buf2[ nSamplesIn ], RESAMPLER_DOWN_ORDER_FIR * sizeof( opus_int32 ) );
157 }
158