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