Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src_SigProc_FIX / SKP_Silk_LPC_inv_pred_gain.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, 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  * SKP_Silk_LPC_inverse_pred_gain.c                                   *\r
30  *                                                                      *\r
31  * Compute inverse of LPC prediction gain, and                          *\r
32  * test if LPC coefficients are stable (all poles within unit circle)   *\r
33  *                                                                      *\r
34  * Copyright 2008 (c), Skype Limited                                    *\r
35  *                                                                      */\r
36 #include "SKP_Silk_SigProc_FIX.h"\r
37 #define QA          16\r
38 #define A_LIMIT     SKP_FIX_CONST( 0.99975, QA )\r
39 \r
40 /* Compute inverse of LPC prediction gain, and                          */\r
41 /* test if LPC coefficients are stable (all poles within unit circle)   */\r
42 static SKP_int LPC_inverse_pred_gain_QA(        /* O:   Returns 1 if unstable, otherwise 0          */\r
43     SKP_int32           *invGain_Q30,           /* O:   Inverse prediction gain, Q30 energy domain  */\r
44     SKP_int32           A_QA[ 2 ][ SKP_Silk_MAX_ORDER_LPC ],         \r
45                                                 /* I:   Prediction coefficients                     */\r
46     const SKP_int       order                   /* I:   Prediction order                            */\r
47 )\r
48 {\r
49     SKP_int   k, n, headrm;\r
50     SKP_int32 rc_Q31, rc_mult1_Q30, rc_mult2_Q16, tmp_QA;\r
51     SKP_int32 *Aold_QA, *Anew_QA;\r
52 \r
53     Anew_QA = A_QA[ order & 1 ];\r
54 \r
55     *invGain_Q30 = ( 1 << 30 );\r
56     for( k = order - 1; k > 0; k-- ) {\r
57         /* Check for stability */\r
58         if( ( Anew_QA[ k ] > A_LIMIT ) || ( Anew_QA[ k ] < -A_LIMIT ) ) {\r
59             return 1;\r
60         }\r
61 \r
62         /* Set RC equal to negated AR coef */\r
63         rc_Q31 = -SKP_LSHIFT( Anew_QA[ k ], 31 - QA );\r
64         \r
65         /* rc_mult1_Q30 range: [ 1 : 2^30-1 ] */\r
66         rc_mult1_Q30 = ( SKP_int32_MAX >> 1 ) - SKP_SMMUL( rc_Q31, rc_Q31 );\r
67         SKP_assert( rc_mult1_Q30 > ( 1 << 15 ) );                   /* reduce A_LIMIT if fails */\r
68         SKP_assert( rc_mult1_Q30 < ( 1 << 30 ) );\r
69 \r
70         /* rc_mult2_Q16 range: [ 2^16 : SKP_int32_MAX ] */\r
71         rc_mult2_Q16 = SKP_INVERSE32_varQ( rc_mult1_Q30, 46 );      /* 16 = 46 - 30 */\r
72 \r
73         /* Update inverse gain */\r
74         /* invGain_Q30 range: [ 0 : 2^30 ] */\r
75         *invGain_Q30 = SKP_LSHIFT( SKP_SMMUL( *invGain_Q30, rc_mult1_Q30 ), 2 );\r
76         SKP_assert( *invGain_Q30 >= 0           );\r
77         SKP_assert( *invGain_Q30 <= ( 1 << 30 ) );\r
78 \r
79         /* Swap pointers */\r
80         Aold_QA = Anew_QA;\r
81         Anew_QA = A_QA[ k & 1 ];\r
82         \r
83         /* Update AR coefficient */\r
84         headrm = SKP_Silk_CLZ32( rc_mult2_Q16 ) - 1;\r
85         rc_mult2_Q16 = SKP_LSHIFT( rc_mult2_Q16, headrm );          /* Q: 16 + headrm */\r
86         for( n = 0; n < k; n++ ) {\r
87             tmp_QA = Aold_QA[ n ] - SKP_LSHIFT( SKP_SMMUL( Aold_QA[ k - n - 1 ], rc_Q31 ), 1 );\r
88             Anew_QA[ n ] = SKP_LSHIFT( SKP_SMMUL( tmp_QA, rc_mult2_Q16 ), 16 - headrm );\r
89         }\r
90     }\r
91 \r
92     /* Check for stability */\r
93     if( ( Anew_QA[ 0 ] > A_LIMIT ) || ( Anew_QA[ 0 ] < -A_LIMIT ) ) {\r
94         return 1;\r
95     }\r
96 \r
97     /* Set RC equal to negated AR coef */\r
98     rc_Q31 = -SKP_LSHIFT( Anew_QA[ 0 ], 31 - QA );\r
99 \r
100     /* Range: [ 1 : 2^30 ] */\r
101     rc_mult1_Q30 = ( SKP_int32_MAX >> 1 ) - SKP_SMMUL( rc_Q31, rc_Q31 );\r
102 \r
103     /* Update inverse gain */\r
104     /* Range: [ 0 : 2^30 ] */\r
105     *invGain_Q30 = SKP_LSHIFT( SKP_SMMUL( *invGain_Q30, rc_mult1_Q30 ), 2 );\r
106     SKP_assert( *invGain_Q30 >= 0     );\r
107     SKP_assert( *invGain_Q30 <= 1<<30 );\r
108 \r
109     return 0;\r
110 }\r
111 \r
112 /* For input in Q12 domain */\r
113 SKP_int SKP_Silk_LPC_inverse_pred_gain(       /* O:   Returns 1 if unstable, otherwise 0          */\r
114     SKP_int32           *invGain_Q30,           /* O:   Inverse prediction gain, Q30 energy domain  */\r
115     const SKP_int16     *A_Q12,                 /* I:   Prediction coefficients, Q12 [order]        */\r
116     const SKP_int       order                   /* I:   Prediction order                            */\r
117 )\r
118 {\r
119     SKP_int   k;\r
120     SKP_int32 Atmp_QA[ 2 ][ SKP_Silk_MAX_ORDER_LPC ];\r
121     SKP_int32 *Anew_QA;\r
122 \r
123     Anew_QA = Atmp_QA[ order & 1 ];\r
124 \r
125     /* Increase Q domain of the AR coefficients */\r
126     for( k = 0; k < order; k++ ) {\r
127         Anew_QA[ k ] = SKP_LSHIFT( (SKP_int32)A_Q12[ k ], QA - 12 );\r
128     }\r
129 \r
130     return LPC_inverse_pred_gain_QA( invGain_Q30, Atmp_QA, order );\r
131 }\r
132 \r
133 /* For input in Q13 domain */\r
134 SKP_int SKP_Silk_LPC_inverse_pred_gain_Q13(   /* O:   Returns 1 if unstable, otherwise 0          */\r
135     SKP_int32           *invGain_Q30,           /* O:   Inverse prediction gain, Q30 energy domain  */\r
136     const SKP_int16     *A_Q13,                 /* I:   Prediction coefficients, Q13 [order]        */\r
137     const SKP_int       order                   /* I:   Prediction order                            */\r
138 )\r
139 {\r
140     SKP_int   k;\r
141     SKP_int32 Atmp_QA[ 2 ][ SKP_Silk_MAX_ORDER_LPC ];\r
142     SKP_int32 *Anew_QA;\r
143 \r
144     Anew_QA = Atmp_QA[ order & 1 ];\r
145 \r
146     /* Increase Q domain of the AR coefficients */\r
147     for( k = 0; k < order; k++ ) {\r
148         Anew_QA[ k ] = SKP_LSHIFT( (SKP_int32)A_Q13[ k ], QA - 13 );\r
149     }\r
150 \r
151     return LPC_inverse_pred_gain_QA( invGain_Q30, Atmp_QA, order );\r
152 }\r
153 \r
154 /* For input in Q24 domain */\r
155 SKP_int SKP_Silk_LPC_inverse_pred_gain_Q24(   /* O:   Returns 1 if unstable, otherwise 0          */\r
156     SKP_int32           *invGain_Q30,           /* O:   Inverse prediction gain, Q30 energy domain  */\r
157     const SKP_int32     *A_Q24,                 /* I:   Prediction coefficients, Q24 [order]        */\r
158     const SKP_int       order                   /* I:   Prediction order                            */\r
159 )\r
160 {\r
161     SKP_int   k;\r
162     SKP_int32 Atmp_QA[ 2 ][ SKP_Silk_MAX_ORDER_LPC ];\r
163     SKP_int32 *Anew_QA;\r
164 \r
165     Anew_QA = Atmp_QA[ order & 1 ];\r
166 \r
167     /* Increase Q domain of the AR coefficients */\r
168     for( k = 0; k < order; k++ ) {\r
169         Anew_QA[ k ] = SKP_RSHIFT_ROUND( A_Q24[ k ], 24 - QA );\r
170     }\r
171 \r
172     return LPC_inverse_pred_gain_QA( invGain_Q30, Atmp_QA, order );\r
173 }\r