Improvements to error handling and warning fixes
[opus.git] / silk / SKP_Silk_LP_variable_cutoff.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 /* \r
29 \r
30     Elliptic/Cauer filters designed with 0.1 dB passband ripple, \r
31         80 dB minimum stopband attenuation, and\r
32         [0.95 : 0.15 : 0.35] normalized cut off frequencies.\r
33 \r
34 */\r
35 #include "SKP_Silk_main.h"\r
36 \r
37 /* Helper function, interpolates the filter taps */\r
38 SKP_INLINE void SKP_Silk_LP_interpolate_filter_taps( \r
39     SKP_int32           B_Q28[ TRANSITION_NB ], \r
40     SKP_int32           A_Q28[ TRANSITION_NA ],\r
41     const SKP_int       ind,\r
42     const SKP_int32     fac_Q16\r
43 )\r
44 {\r
45     SKP_int nb, na;\r
46 \r
47     if( ind < TRANSITION_INT_NUM - 1 ) {\r
48         if( fac_Q16 > 0 ) {\r
49             if( fac_Q16 < 32768 ) { /* fac_Q16 is in range of a 16-bit int */\r
50                 /* Piece-wise linear interpolation of B and A */\r
51                 for( nb = 0; nb < TRANSITION_NB; nb++ ) {\r
52                     B_Q28[ nb ] = SKP_SMLAWB(\r
53                         SKP_Silk_Transition_LP_B_Q28[ ind     ][ nb ],\r
54                         SKP_Silk_Transition_LP_B_Q28[ ind + 1 ][ nb ] -\r
55                         SKP_Silk_Transition_LP_B_Q28[ ind     ][ nb ],\r
56                         fac_Q16 );\r
57                 }\r
58                 for( na = 0; na < TRANSITION_NA; na++ ) {\r
59                     A_Q28[ na ] = SKP_SMLAWB(\r
60                         SKP_Silk_Transition_LP_A_Q28[ ind     ][ na ],\r
61                         SKP_Silk_Transition_LP_A_Q28[ ind + 1 ][ na ] -\r
62                         SKP_Silk_Transition_LP_A_Q28[ ind     ][ na ],\r
63                         fac_Q16 );\r
64                 }\r
65             } else { /* ( fac_Q16 - ( 1 << 16 ) ) is in range of a 16-bit int */\r
66                 SKP_assert( fac_Q16 - ( 1 << 16 ) == SKP_SAT16( fac_Q16 - ( 1 << 16 ) ) );\r
67                 /* Piece-wise linear interpolation of B and A */\r
68                 for( nb = 0; nb < TRANSITION_NB; nb++ ) {\r
69                     B_Q28[ nb ] = SKP_SMLAWB(\r
70                         SKP_Silk_Transition_LP_B_Q28[ ind + 1 ][ nb ],\r
71                         SKP_Silk_Transition_LP_B_Q28[ ind + 1 ][ nb ] -\r
72                         SKP_Silk_Transition_LP_B_Q28[ ind     ][ nb ],\r
73                         fac_Q16 - ( 1 << 16 ) );\r
74                 }\r
75                 for( na = 0; na < TRANSITION_NA; na++ ) {\r
76                     A_Q28[ na ] = SKP_SMLAWB(\r
77                         SKP_Silk_Transition_LP_A_Q28[ ind + 1 ][ na ],\r
78                         SKP_Silk_Transition_LP_A_Q28[ ind + 1 ][ na ] -\r
79                         SKP_Silk_Transition_LP_A_Q28[ ind     ][ na ],\r
80                         fac_Q16 - ( 1 << 16 ) );\r
81                 }\r
82             }\r
83         } else {\r
84             SKP_memcpy( B_Q28, SKP_Silk_Transition_LP_B_Q28[ ind ], TRANSITION_NB * sizeof( SKP_int32 ) );\r
85             SKP_memcpy( A_Q28, SKP_Silk_Transition_LP_A_Q28[ ind ], TRANSITION_NA * sizeof( SKP_int32 ) );\r
86         }\r
87     } else {\r
88         SKP_memcpy( B_Q28, SKP_Silk_Transition_LP_B_Q28[ TRANSITION_INT_NUM - 1 ], TRANSITION_NB * sizeof( SKP_int32 ) );\r
89         SKP_memcpy( A_Q28, SKP_Silk_Transition_LP_A_Q28[ TRANSITION_INT_NUM - 1 ], TRANSITION_NA * sizeof( SKP_int32 ) );\r
90     }\r
91 }\r
92 \r
93 /* Low-pass filter with variable cutoff frequency based on  */\r
94 /* piece-wise linear interpolation between elliptic filters */\r
95 /* Start by setting psEncC->mode <> 0;                      */\r
96 /* Deactivate by setting psEncC->mode = 0;                  */\r
97 void SKP_Silk_LP_variable_cutoff(\r
98     SKP_Silk_LP_state           *psLP,              /* I/O  LP filter state                             */\r
99     SKP_int16                   *signal,            /* I/O  Low-pass filtered output signal             */\r
100     const SKP_int               frame_length        /* I    Frame length                                */\r
101 )\r
102 {\r
103     SKP_int32   B_Q28[ TRANSITION_NB ], A_Q28[ TRANSITION_NA ], fac_Q16 = 0;\r
104     SKP_int     ind = 0;\r
105 \r
106     SKP_assert( psLP->transition_frame_no >= 0 && psLP->transition_frame_no <= TRANSITION_FRAMES );\r
107 \r
108     /* Run filter if needed */\r
109     if( psLP->mode != 0 ) {\r
110         /* Calculate index and interpolation factor for interpolation */\r
111 #if( TRANSITION_INT_STEPS == 64 )\r
112         fac_Q16 = SKP_LSHIFT( TRANSITION_FRAMES - psLP->transition_frame_no, 16 - 6 );\r
113 #else\r
114         fac_Q16 = SKP_DIV32_16( SKP_LSHIFT( TRANSITION_FRAMES - psLP->transition_frame_no, 16 ), TRANSITION_FRAMES );\r
115 #endif\r
116         ind      = SKP_RSHIFT( fac_Q16, 16 );\r
117         fac_Q16 -= SKP_LSHIFT( ind, 16 );\r
118 \r
119         SKP_assert( ind >= 0 );\r
120         SKP_assert( ind < TRANSITION_INT_NUM );\r
121 \r
122         /* Interpolate filter coefficients */\r
123         SKP_Silk_LP_interpolate_filter_taps( B_Q28, A_Q28, ind, fac_Q16 );\r
124 \r
125         /* Update transition frame number for next frame */\r
126         psLP->transition_frame_no = SKP_LIMIT( psLP->transition_frame_no + psLP->mode, 0, TRANSITION_FRAMES );\r
127 \r
128         /* ARMA low-pass filtering */\r
129         SKP_assert( TRANSITION_NB == 3 && TRANSITION_NA == 2 );\r
130         SKP_Silk_biquad_alt( signal, B_Q28, A_Q28, psLP->In_LP_State, signal, frame_length );\r
131     }\r
132 }\r