Renamed SKP_[u]int* to opus_[u]int*
[opus.git] / silk / silk_LPC_inv_pred_gain.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 #include "silk_SigProc_FIX.h"\r
29 \r
30 #define QA          16\r
31 #define A_LIMIT     SILK_FIX_CONST( 0.99975, QA )\r
32 \r
33 /* Compute inverse of LPC prediction gain, and                          */\r
34 /* test if LPC coefficients are stable (all poles within unit circle)   */\r
35 static opus_int LPC_inverse_pred_gain_QA(        /* O:   Returns 1 if unstable, otherwise 0          */\r
36     opus_int32           *invGain_Q30,           /* O:   Inverse prediction gain, Q30 energy domain  */\r
37     opus_int32           A_QA[ 2 ][ SILK_MAX_ORDER_LPC ],         \r
38                                                 /* I:   Prediction coefficients                     */\r
39     const opus_int       order                   /* I:   Prediction order                            */\r
40 )\r
41 {\r
42     opus_int   k, n, headrm;\r
43     opus_int32 rc_Q31, rc_mult1_Q30, rc_mult2_Q16, tmp_QA;\r
44     opus_int32 *Aold_QA, *Anew_QA;\r
45 \r
46     Anew_QA = A_QA[ order & 1 ];\r
47 \r
48     *invGain_Q30 = ( 1 << 30 );\r
49     for( k = order - 1; k > 0; k-- ) {\r
50         /* Check for stability */\r
51         if( ( Anew_QA[ k ] > A_LIMIT ) || ( Anew_QA[ k ] < -A_LIMIT ) ) {\r
52             return 1;\r
53         }\r
54 \r
55         /* Set RC equal to negated AR coef */\r
56         rc_Q31 = -SKP_LSHIFT( Anew_QA[ k ], 31 - QA );\r
57         \r
58         /* rc_mult1_Q30 range: [ 1 : 2^30-1 ] */\r
59         rc_mult1_Q30 = ( SKP_int32_MAX >> 1 ) - SKP_SMMUL( rc_Q31, rc_Q31 );\r
60         SKP_assert( rc_mult1_Q30 > ( 1 << 15 ) );                   /* reduce A_LIMIT if fails */\r
61         SKP_assert( rc_mult1_Q30 < ( 1 << 30 ) );\r
62 \r
63         /* rc_mult2_Q16 range: [ 2^16 : SKP_int32_MAX ] */\r
64         rc_mult2_Q16 = silk_INVERSE32_varQ( rc_mult1_Q30, 46 );      /* 16 = 46 - 30 */\r
65 \r
66         /* Update inverse gain */\r
67         /* invGain_Q30 range: [ 0 : 2^30 ] */\r
68         *invGain_Q30 = SKP_LSHIFT( SKP_SMMUL( *invGain_Q30, rc_mult1_Q30 ), 2 );\r
69         SKP_assert( *invGain_Q30 >= 0           );\r
70         SKP_assert( *invGain_Q30 <= ( 1 << 30 ) );\r
71 \r
72         /* Swap pointers */\r
73         Aold_QA = Anew_QA;\r
74         Anew_QA = A_QA[ k & 1 ];\r
75         \r
76         /* Update AR coefficient */\r
77         headrm = silk_CLZ32( rc_mult2_Q16 ) - 1;\r
78         rc_mult2_Q16 = SKP_LSHIFT( rc_mult2_Q16, headrm );          /* Q: 16 + headrm */\r
79         for( n = 0; n < k; n++ ) {\r
80             tmp_QA = Aold_QA[ n ] - SKP_LSHIFT( SKP_SMMUL( Aold_QA[ k - n - 1 ], rc_Q31 ), 1 );\r
81             Anew_QA[ n ] = SKP_LSHIFT( SKP_SMMUL( tmp_QA, rc_mult2_Q16 ), 16 - headrm );\r
82         }\r
83     }\r
84 \r
85     /* Check for stability */\r
86     if( ( Anew_QA[ 0 ] > A_LIMIT ) || ( Anew_QA[ 0 ] < -A_LIMIT ) ) {\r
87         return 1;\r
88     }\r
89 \r
90     /* Set RC equal to negated AR coef */\r
91     rc_Q31 = -SKP_LSHIFT( Anew_QA[ 0 ], 31 - QA );\r
92 \r
93     /* Range: [ 1 : 2^30 ] */\r
94     rc_mult1_Q30 = ( SKP_int32_MAX >> 1 ) - SKP_SMMUL( rc_Q31, rc_Q31 );\r
95 \r
96     /* Update inverse gain */\r
97     /* Range: [ 0 : 2^30 ] */\r
98     *invGain_Q30 = SKP_LSHIFT( SKP_SMMUL( *invGain_Q30, rc_mult1_Q30 ), 2 );\r
99     SKP_assert( *invGain_Q30 >= 0     );\r
100     SKP_assert( *invGain_Q30 <= 1<<30 );\r
101 \r
102     return 0;\r
103 }\r
104 \r
105 /* For input in Q12 domain */\r
106 opus_int silk_LPC_inverse_pred_gain(             /* O:   Returns 1 if unstable, otherwise 0          */\r
107     opus_int32           *invGain_Q30,           /* O:   Inverse prediction gain, Q30 energy domain  */\r
108     const opus_int16     *A_Q12,                 /* I:   Prediction coefficients, Q12 [order]        */\r
109     const opus_int       order                   /* I:   Prediction order                            */\r
110 )\r
111 {\r
112     opus_int   k;\r
113     opus_int32 Atmp_QA[ 2 ][ SILK_MAX_ORDER_LPC ];\r
114     opus_int32 *Anew_QA;\r
115 \r
116     Anew_QA = Atmp_QA[ order & 1 ];\r
117 \r
118     /* Increase Q domain of the AR coefficients */\r
119     for( k = 0; k < order; k++ ) {\r
120         Anew_QA[ k ] = SKP_LSHIFT( (opus_int32)A_Q12[ k ], QA - 12 );\r
121     }\r
122 \r
123     return LPC_inverse_pred_gain_QA( invGain_Q30, Atmp_QA, order );\r
124 }\r
125 \r
126 /* For input in Q24 domain */\r
127 opus_int silk_LPC_inverse_pred_gain_Q24(         /* O:   Returns 1 if unstable, otherwise 0          */\r
128     opus_int32           *invGain_Q30,           /* O:   Inverse prediction gain, Q30 energy domain  */\r
129     const opus_int32     *A_Q24,                 /* I:   Prediction coefficients, Q24 [order]        */\r
130     const opus_int       order                   /* I:   Prediction order                            */\r
131 )\r
132 {\r
133     opus_int   k;\r
134     opus_int32 Atmp_QA[ 2 ][ SILK_MAX_ORDER_LPC ];\r
135     opus_int32 *Anew_QA;\r
136 \r
137     Anew_QA = Atmp_QA[ order & 1 ];\r
138 \r
139     /* Increase Q domain of the AR coefficients */\r
140     for( k = 0; k < order; k++ ) {\r
141         Anew_QA[ k ] = SKP_RSHIFT_ROUND( A_Q24[ k ], 24 - QA );\r
142     }\r
143 \r
144     return LPC_inverse_pred_gain_QA( invGain_Q30, Atmp_QA, order );\r
145 }\r
146 \r