Some minor (non-bitstream-affecting) changes to help us have better test vectors
[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                          24
35 #define A_LIMIT                     SILK_FIX_CONST( 0.99975, QA )
36
37 #define MUL32_FRAC_Q(a32, b32, Q)   ((opus_int32)(silk_RSHIFT_ROUND64(silk_SMULL(a32, b32), Q)))
38
39 /* Compute inverse of LPC prediction gain, and                          */
40 /* test if LPC coefficients are stable (all poles within unit circle)   */
41 static opus_int LPC_inverse_pred_gain_QA(                   /* O   Returns 1 if unstable, otherwise 0          */
42     opus_int32           *invGain_Q30,                      /* O   Inverse prediction gain, Q30 energy domain  */
43     opus_int32           A_QA[ 2 ][ SILK_MAX_ORDER_LPC ],   /* I   Prediction coefficients                     */
44     const opus_int       order                              /* I   Prediction order                            */
45 )
46 {
47     opus_int   k, n, mult2Q;
48     opus_int32 rc_Q31, rc_mult1_Q30, rc_mult2, tmp_QA;
49     opus_int32 *Aold_QA, *Anew_QA;
50
51     Anew_QA = A_QA[ order & 1 ];
52
53     *invGain_Q30 = ( 1 << 30 );
54     for( k = order - 1; k > 0; k-- ) {
55         /* Check for stability */
56         if( ( Anew_QA[ k ] > A_LIMIT ) || ( Anew_QA[ k ] < -A_LIMIT ) ) {
57             *invGain_Q30 = 0;
58             return 1;
59         }
60
61         /* Set RC equal to negated AR coef */
62         rc_Q31 = -silk_LSHIFT( Anew_QA[ k ], 31 - QA );
63
64         /* rc_mult1_Q30 range: [ 1 : 2^30 ] */
65         rc_mult1_Q30 = ( (opus_int32)1 << 30 ) - silk_SMMUL( rc_Q31, rc_Q31 );
66         silk_assert( rc_mult1_Q30 > ( 1 << 15 ) );                   /* reduce A_LIMIT if fails */
67         silk_assert( rc_mult1_Q30 <= ( 1 << 30 ) );
68
69         /* rc_mult2 range: [ 2^30 : silk_int32_MAX ] */
70         mult2Q = 32 - silk_CLZ32( silk_abs( rc_mult1_Q30 ) );
71         rc_mult2 = silk_INVERSE32_varQ( rc_mult1_Q30, mult2Q + 30 );
72
73         /* Update inverse gain */
74         /* invGain_Q30 range: [ 0 : 2^30 ] */
75         *invGain_Q30 = silk_LSHIFT( silk_SMMUL( *invGain_Q30, rc_mult1_Q30 ), 2 );
76         silk_assert( *invGain_Q30 >= 0           );
77         silk_assert( *invGain_Q30 <= ( 1 << 30 ) );
78
79         /* Swap pointers */
80         Aold_QA = Anew_QA;
81         Anew_QA = A_QA[ k & 1 ];
82
83         /* Update AR coefficient */
84         for( n = 0; n < k; n++ ) {
85             tmp_QA = Aold_QA[ n ] - MUL32_FRAC_Q( Aold_QA[ k - n - 1 ], rc_Q31, 31 );
86             Anew_QA[ n ] = MUL32_FRAC_Q( tmp_QA, rc_mult2 , mult2Q );
87         }
88     }
89
90     /* Check for stability */
91     if( ( Anew_QA[ 0 ] > A_LIMIT ) || ( Anew_QA[ 0 ] < -A_LIMIT ) ) {
92         *invGain_Q30 = 0;
93         return 1;
94     }
95
96     /* Set RC equal to negated AR coef */
97     rc_Q31 = -silk_LSHIFT( Anew_QA[ 0 ], 31 - QA );
98
99     /* Range: [ 1 : 2^30 ] */
100     rc_mult1_Q30 = ( (opus_int32)1 << 30 ) - silk_SMMUL( rc_Q31, rc_Q31 );
101
102     /* Update inverse gain */
103     /* Range: [ 0 : 2^30 ] */
104     *invGain_Q30 = silk_LSHIFT( silk_SMMUL( *invGain_Q30, rc_mult1_Q30 ), 2 );
105     silk_assert( *invGain_Q30 >= 0     );
106     silk_assert( *invGain_Q30 <= 1<<30 );
107
108     return 0;
109 }
110
111 /* For input in Q12 domain */
112 opus_int silk_LPC_inverse_pred_gain(                /* O   Returns 1 if unstable, otherwise 0                           */
113     opus_int32                  *invGain_Q30,       /* O   Inverse prediction gain, Q30 energy domain                   */
114     const opus_int16            *A_Q12,             /* I   Prediction coefficients, Q12 [order]                         */
115     const opus_int              order               /* I   Prediction order                                             */
116 )
117 {
118     opus_int   k;
119     opus_int32 Atmp_QA[ 2 ][ SILK_MAX_ORDER_LPC ];
120     opus_int32 *Anew_QA;
121     opus_int32 DC_resp=0;
122
123     Anew_QA = Atmp_QA[ order & 1 ];
124
125     /* Increase Q domain of the AR coefficients */
126     for( k = 0; k < order; k++ ) {
127         DC_resp += (opus_int32)A_Q12[ k ];
128         Anew_QA[ k ] = silk_LSHIFT( (opus_int32)A_Q12[ k ], QA - 12 );
129     }
130     /* If the DC is unstable, we don't even need to do the full calculations */
131     if( DC_resp >= 4096 ) {
132        *invGain_Q30 = 0;
133        return 1;
134     }
135     return LPC_inverse_pred_gain_QA( invGain_Q30, Atmp_QA, order );
136 }
137
138 #ifdef FIXED_POINT
139
140 /* For input in Q24 domain */
141 /* This function is only used by the fixed-point build */
142 opus_int silk_LPC_inverse_pred_gain_Q24(            /* O    Returns 1 if unstable, otherwise 0                          */
143     opus_int32                  *invGain_Q30,       /* O    Inverse prediction gain, Q30 energy domain                  */
144     const opus_int32            *A_Q24,             /* I    Prediction coefficients, Q24 [order]                        */
145     const opus_int              order               /* I    Prediction order                                            */
146 )
147 {
148     opus_int   k;
149     opus_int32 Atmp_QA[ 2 ][ SILK_MAX_ORDER_LPC ];
150     opus_int32 *Anew_QA;
151
152     Anew_QA = Atmp_QA[ order & 1 ];
153
154     /* Increase Q domain of the AR coefficients */
155     for( k = 0; k < order; k++ ) {
156         Anew_QA[ k ] = silk_RSHIFT( A_Q24[ k ], 24 - QA );
157     }
158
159     return LPC_inverse_pred_gain_QA( invGain_Q30, Atmp_QA, order );
160 }
161 #endif