Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / silk_NLSF2A.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 /* conversion between prediction filter coefficients and LSFs   */
29 /* order should be even                                         */
30 /* a piecewise linear approximation maps LSF <-> cos(LSF)       */
31 /* therefore the result is not accurate LSFs, but the two       */
32 /* functions are accurate inverses of each other                */
33
34 #include "silk_SigProc_FIX.h"
35 #include "silk_tables.h"
36
37 #define QA      16
38
39 /* helper function for NLSF2A(..) */
40 SKP_INLINE void silk_NLSF2A_find_poly(
41     opus_int32          *out,      /* O    intermediate polynomial, QA [dd+1]        */
42     const opus_int32    *cLSF,     /* I    vector of interleaved 2*cos(LSFs), QA [d] */
43     opus_int            dd         /* I    polynomial order (= 1/2 * filter order)   */
44 )
45 {
46     opus_int   k, n;
47     opus_int32 ftmp;
48
49     out[0] = SKP_LSHIFT( 1, QA );
50     out[1] = -cLSF[0];
51     for( k = 1; k < dd; k++ ) {
52         ftmp = cLSF[2*k];            // QA
53         out[k+1] = SKP_LSHIFT( out[k-1], 1 ) - (opus_int32)SKP_RSHIFT_ROUND64( SKP_SMULL( ftmp, out[k] ), QA );
54         for( n = k; n > 1; n-- ) {
55             out[n] += out[n-2] - (opus_int32)SKP_RSHIFT_ROUND64( SKP_SMULL( ftmp, out[n-1] ), QA );
56         }
57         out[1] -= ftmp;
58     }
59 }
60
61 /* compute whitening filter coefficients from normalized line spectral frequencies */
62 void silk_NLSF2A(
63     opus_int16        *a_Q12,            /* O    monic whitening filter coefficients in Q12,  [ d ]  */
64     const opus_int16  *NLSF,             /* I    normalized line spectral frequencies in Q15, [ d ]  */
65     const opus_int    d                  /* I    filter order (should be even)                       */
66 )
67 {
68     opus_int   k, i, dd;
69     opus_int32 cos_LSF_QA[ SILK_MAX_ORDER_LPC ];
70     opus_int32 P[ SILK_MAX_ORDER_LPC / 2 + 1 ], Q[ SILK_MAX_ORDER_LPC / 2 + 1 ];
71     opus_int32 Ptmp, Qtmp, f_int, f_frac, cos_val, delta;
72     opus_int32 a32_QA1[ SILK_MAX_ORDER_LPC ];
73     opus_int32 maxabs, absval, idx=0, sc_Q16, invGain_Q30;
74
75     SKP_assert( LSF_COS_TAB_SZ_FIX == 128 );
76
77     /* convert LSFs to 2*cos(LSF), using piecewise linear curve from table */
78     for( k = 0; k < d; k++ ) {
79         SKP_assert(NLSF[k] >= 0 );
80         SKP_assert(NLSF[k] <= 32767 );
81
82         /* f_int on a scale 0-127 (rounded down) */
83         f_int = SKP_RSHIFT( NLSF[k], 15 - 7 );
84
85         /* f_frac, range: 0..255 */
86         f_frac = NLSF[k] - SKP_LSHIFT( f_int, 15 - 7 );
87
88         SKP_assert(f_int >= 0);
89         SKP_assert(f_int < LSF_COS_TAB_SZ_FIX );
90
91         /* Read start and end value from table */
92         cos_val = silk_LSFCosTab_FIX_Q12[ f_int ];                /* Q12 */
93         delta   = silk_LSFCosTab_FIX_Q12[ f_int + 1 ] - cos_val;  /* Q12, with a range of 0..200 */
94
95         /* Linear interpolation */
96         cos_LSF_QA[k] = SKP_RSHIFT_ROUND( SKP_LSHIFT( cos_val, 8 ) + SKP_MUL( delta, f_frac ), 20 - QA ); /* QA */
97     }
98
99     dd = SKP_RSHIFT( d, 1 );
100
101     /* generate even and odd polynomials using convolution */
102     silk_NLSF2A_find_poly( P, &cos_LSF_QA[ 0 ], dd );
103     silk_NLSF2A_find_poly( Q, &cos_LSF_QA[ 1 ], dd );
104
105     /* convert even and odd polynomials to opus_int32 Q12 filter coefs */
106     for( k = 0; k < dd; k++ ) {
107         Ptmp = P[ k+1 ] + P[ k ];
108         Qtmp = Q[ k+1 ] - Q[ k ];
109
110         /* the Ptmp and Qtmp values at this stage need to fit in int32 */
111         a32_QA1[ k ]     = -Qtmp - Ptmp;        /* QA+1 */
112         a32_QA1[ d-k-1 ] =  Qtmp - Ptmp;        /* QA+1 */
113     }
114
115     /* Limit the maximum absolute value of the prediction coefficients, so that they'll fit in int16 */
116     for( i = 0; i < 10; i++ ) {
117         /* Find maximum absolute value and its index */
118         maxabs = 0;
119         for( k = 0; k < d; k++ ) {
120             absval = SKP_abs( a32_QA1[k] );
121             if( absval > maxabs ) {
122                 maxabs = absval;
123                 idx    = k;
124             }
125         }
126         maxabs = SKP_RSHIFT_ROUND( maxabs, QA + 1 - 12 );       /* QA+1 -> Q12 */
127
128         if( maxabs > SKP_int16_MAX ) {
129             /* Reduce magnitude of prediction coefficients */
130             maxabs = SKP_min( maxabs, 163838 );  /* ( SKP_int32_MAX >> 14 ) + SKP_int16_MAX = 163838 */
131             sc_Q16 = SILK_FIX_CONST( 0.999, 16 ) - SKP_DIV32( SKP_LSHIFT( maxabs - SKP_int16_MAX, 14 ),
132                                         SKP_RSHIFT32( SKP_MUL( maxabs, idx + 1), 2 ) );
133             silk_bwexpander_32( a32_QA1, d, sc_Q16 );
134         } else {
135             break;
136         }
137     }
138
139     if( i == 10 ) {
140         /* Reached the last iteration, clip the coefficients */
141         for( k = 0; k < d; k++ ) {
142             a_Q12[ k ] = (opus_int16)SKP_SAT16( SKP_RSHIFT_ROUND( a32_QA1[ k ], QA + 1 - 12 ) ); /* QA+1 -> Q12 */
143             a32_QA1[ k ] = SKP_LSHIFT( (opus_int32)a_Q12[ k ], QA + 1 - 12 );
144         }
145     } else {
146         for( k = 0; k < d; k++ ) {
147             a_Q12[ k ] = (opus_int16)SKP_RSHIFT_ROUND( a32_QA1[ k ], QA + 1 - 12 );       /* QA+1 -> Q12 */
148         }
149     }
150
151     for( i = 1; i < MAX_LPC_STABILIZE_ITERATIONS; i++ ) {
152         if( silk_LPC_inverse_pred_gain( &invGain_Q30, a_Q12, d ) == 1 ) {
153             /* Prediction coefficients are (too close to) unstable; apply bandwidth expansion   */
154             /* on the unscaled coefficients, convert to Q12 and measure again                   */
155             silk_bwexpander_32( a32_QA1, d, 65536 - SKP_SMULBB( 9 + i, i ) );            /* 10_Q16 = 0.00015 */
156             for( k = 0; k < d; k++ ) {
157                 a_Q12[ k ] = (opus_int16)SKP_RSHIFT_ROUND( a32_QA1[ k ], QA + 1 - 12 );  /* QA+1 -> Q12 */
158             }
159         } else {
160             break;
161         }
162     }
163
164     if( i == MAX_LPC_STABILIZE_ITERATIONS ) {
165         /* Reached the last iteration, set coefficients to zero */
166         for( k = 0; k < d; k++ ) {
167             a_Q12[ k ] = 0;
168         }
169     }
170 }
171