More assert updates, make the initialization in silk_warped_autocorrelation_FLP more...
[opus.git] / silk / LP_variable_cutoff.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 /*
33
34     Elliptic/Cauer filters designed with 0.1 dB passband ripple,
35         80 dB minimum stopband attenuation, and
36         [0.95 : 0.15 : 0.35] normalized cut off frequencies.
37
38 */
39 #include "main.h"
40
41 /* Helper function, interpolates the filter taps */
42 static inline void silk_LP_interpolate_filter_taps(
43     opus_int32           B_Q28[ TRANSITION_NB ],
44     opus_int32           A_Q28[ TRANSITION_NA ],
45     const opus_int       ind,
46     const opus_int32     fac_Q16
47 )
48 {
49     opus_int nb, na;
50
51     if( ind < TRANSITION_INT_NUM - 1 ) {
52         if( fac_Q16 > 0 ) {
53             if( fac_Q16 < 32768 ) { /* fac_Q16 is in range of a 16-bit int */
54                 /* Piece-wise linear interpolation of B and A */
55                 for( nb = 0; nb < TRANSITION_NB; nb++ ) {
56                     B_Q28[ nb ] = silk_SMLAWB(
57                         silk_Transition_LP_B_Q28[ ind     ][ nb ],
58                         silk_Transition_LP_B_Q28[ ind + 1 ][ nb ] -
59                         silk_Transition_LP_B_Q28[ ind     ][ nb ],
60                         fac_Q16 );
61                 }
62                 for( na = 0; na < TRANSITION_NA; na++ ) {
63                     A_Q28[ na ] = silk_SMLAWB(
64                         silk_Transition_LP_A_Q28[ ind     ][ na ],
65                         silk_Transition_LP_A_Q28[ ind + 1 ][ na ] -
66                         silk_Transition_LP_A_Q28[ ind     ][ na ],
67                         fac_Q16 );
68                 }
69             } else { /* ( fac_Q16 - ( 1 << 16 ) ) is in range of a 16-bit int */
70                 silk_assert( fac_Q16 - ( 1 << 16 ) == silk_SAT16( fac_Q16 - ( 1 << 16 ) ) );
71                 /* Piece-wise linear interpolation of B and A */
72                 for( nb = 0; nb < TRANSITION_NB; nb++ ) {
73                     B_Q28[ nb ] = silk_SMLAWB(
74                         silk_Transition_LP_B_Q28[ ind + 1 ][ nb ],
75                         silk_Transition_LP_B_Q28[ ind + 1 ][ nb ] -
76                         silk_Transition_LP_B_Q28[ ind     ][ nb ],
77                         fac_Q16 - ( 1 << 16 ) );
78                 }
79                 for( na = 0; na < TRANSITION_NA; na++ ) {
80                     A_Q28[ na ] = silk_SMLAWB(
81                         silk_Transition_LP_A_Q28[ ind + 1 ][ na ],
82                         silk_Transition_LP_A_Q28[ ind + 1 ][ na ] -
83                         silk_Transition_LP_A_Q28[ ind     ][ na ],
84                         fac_Q16 - ( 1 << 16 ) );
85                 }
86             }
87         } else {
88             silk_memcpy( B_Q28, silk_Transition_LP_B_Q28[ ind ], TRANSITION_NB * sizeof( opus_int32 ) );
89             silk_memcpy( A_Q28, silk_Transition_LP_A_Q28[ ind ], TRANSITION_NA * sizeof( opus_int32 ) );
90         }
91     } else {
92         silk_memcpy( B_Q28, silk_Transition_LP_B_Q28[ TRANSITION_INT_NUM - 1 ], TRANSITION_NB * sizeof( opus_int32 ) );
93         silk_memcpy( A_Q28, silk_Transition_LP_A_Q28[ TRANSITION_INT_NUM - 1 ], TRANSITION_NA * sizeof( opus_int32 ) );
94     }
95 }
96
97 /* Low-pass filter with variable cutoff frequency based on  */
98 /* piece-wise linear interpolation between elliptic filters */
99 /* Start by setting psEncC->mode <> 0;                      */
100 /* Deactivate by setting psEncC->mode = 0;                  */
101 void silk_LP_variable_cutoff(
102     silk_LP_state           *psLP,              /* I/O  LP filter state                             */
103     opus_int16                   *frame,         /* I/O  Low-pass filtered output                   */
104     const opus_int               frame_length        /* I    Frame length                                */
105 )
106 {
107     opus_int32   B_Q28[ TRANSITION_NB ], A_Q28[ TRANSITION_NA ], fac_Q16 = 0;
108     opus_int     ind = 0;
109
110     silk_assert( psLP->transition_frame_no >= 0 && psLP->transition_frame_no <= TRANSITION_FRAMES );
111
112     /* Run filter if needed */
113     if( psLP->mode != 0 ) {
114         /* Calculate index and interpolation factor for interpolation */
115 #if( TRANSITION_INT_STEPS == 64 )
116         fac_Q16 = silk_LSHIFT( TRANSITION_FRAMES - psLP->transition_frame_no, 16 - 6 );
117 #else
118         fac_Q16 = silk_DIV32_16( silk_LSHIFT( TRANSITION_FRAMES - psLP->transition_frame_no, 16 ), TRANSITION_FRAMES );
119 #endif
120         ind      = silk_RSHIFT( fac_Q16, 16 );
121         fac_Q16 -= silk_LSHIFT( ind, 16 );
122
123         silk_assert( ind >= 0 );
124         silk_assert( ind < TRANSITION_INT_NUM );
125
126         /* Interpolate filter coefficients */
127         silk_LP_interpolate_filter_taps( B_Q28, A_Q28, ind, fac_Q16 );
128
129         /* Update transition frame number for next frame */
130         psLP->transition_frame_no = silk_LIMIT( psLP->transition_frame_no + psLP->mode, 0, TRANSITION_FRAMES );
131
132         /* ARMA low-pass filtering */
133         silk_assert( TRANSITION_NB == 3 && TRANSITION_NA == 2 );
134         silk_biquad_alt( frame, B_Q28, A_Q28, psLP->In_LP_State, frame, frame_length, 1);
135     }
136 }