Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / silk_NLSF_stabilize.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 /* NLSF stabilizer:                                         */
29 /*                                                          */
30 /* - Moves NLSFs futher apart if they are too close         */
31 /* - Moves NLSFs away from borders if they are too close    */
32 /* - High effort to achieve a modification with minimum     */
33 /*     Euclidean distance to input vector                   */
34 /* - Output are sorted NLSF coefficients                    */
35 /*                                                          */
36
37 #include "silk_SigProc_FIX.h"
38
39 /* Constant Definitions */
40 #define MAX_LOOPS        20
41
42 /* NLSF stabilizer, for a single input data vector */
43 void silk_NLSF_stabilize(
44           opus_int16  *NLSF_Q15,            /* I/O:  Unstable/stabilized normalized LSF vector in Q15 [L]                    */
45     const opus_int16  *NDeltaMin_Q15,       /* I:    Normalized delta min vector in Q15, NDeltaMin_Q15[L] must be >= 1 [L+1] */
46     const opus_int     L                    /* I:    Number of NLSF parameters in the input vector                           */
47 )
48 {
49     opus_int   i, I=0, k, loops;
50     opus_int16 center_freq_Q15;
51     opus_int32 diff_Q15, min_diff_Q15, min_center_Q15, max_center_Q15;
52
53     /* This is necessary to ensure an output within range of a opus_int16 */
54     SKP_assert( NDeltaMin_Q15[L] >= 1 );
55
56     for( loops = 0; loops < MAX_LOOPS; loops++ ) {
57         /**************************/
58         /* Find smallest distance */
59         /**************************/
60         /* First element */
61         min_diff_Q15 = NLSF_Q15[0] - NDeltaMin_Q15[0];
62         I = 0;
63         /* Middle elements */
64         for( i = 1; i <= L-1; i++ ) {
65             diff_Q15 = NLSF_Q15[i] - ( NLSF_Q15[i-1] + NDeltaMin_Q15[i] );
66             if( diff_Q15 < min_diff_Q15 ) {
67                 min_diff_Q15 = diff_Q15;
68                 I = i;
69             }
70         }
71         /* Last element */
72         diff_Q15 = ( 1 << 15 ) - ( NLSF_Q15[L-1] + NDeltaMin_Q15[L] );
73         if( diff_Q15 < min_diff_Q15 ) {
74             min_diff_Q15 = diff_Q15;
75             I = L;
76         }
77
78         /***************************************************/
79         /* Now check if the smallest distance non-negative */
80         /***************************************************/
81         if (min_diff_Q15 >= 0) {
82             return;
83         }
84
85         if( I == 0 ) {
86             /* Move away from lower limit */
87             NLSF_Q15[0] = NDeltaMin_Q15[0];
88
89         } else if( I == L) {
90             /* Move away from higher limit */
91             NLSF_Q15[L-1] = ( 1 << 15 ) - NDeltaMin_Q15[L];
92
93         } else {
94             /* Find the lower extreme for the location of the current center frequency */
95             min_center_Q15 = 0;
96             for( k = 0; k < I; k++ ) {
97                 min_center_Q15 += NDeltaMin_Q15[k];
98             }
99             min_center_Q15 += SKP_RSHIFT( NDeltaMin_Q15[I], 1 );
100
101             /* Find the upper extreme for the location of the current center frequency */
102             max_center_Q15 = 1 << 15;
103             for( k = L; k > I; k-- ) {
104                 max_center_Q15 -= NDeltaMin_Q15[k];
105             }
106             max_center_Q15 -= SKP_RSHIFT( NDeltaMin_Q15[I], 1 );
107
108             /* Move apart, sorted by value, keeping the same center frequency */
109             center_freq_Q15 = (opus_int16)SKP_LIMIT_32( SKP_RSHIFT_ROUND( (opus_int32)NLSF_Q15[I-1] + (opus_int32)NLSF_Q15[I], 1 ),
110                 min_center_Q15, max_center_Q15 );
111             NLSF_Q15[I-1] = center_freq_Q15 - SKP_RSHIFT( NDeltaMin_Q15[I], 1 );
112             NLSF_Q15[I] = NLSF_Q15[I-1] + NDeltaMin_Q15[I];
113         }
114     }
115
116     /* Safe and simple fall back method, which is less ideal than the above */
117     if( loops == MAX_LOOPS )
118     {
119         /* Insertion sort (fast for already almost sorted arrays):   */
120         /* Best case:  O(n)   for an already sorted array            */
121         /* Worst case: O(n^2) for an inversely sorted array          */
122         silk_insertion_sort_increasing_all_values_int16( &NLSF_Q15[0], L );
123
124         /* First NLSF should be no less than NDeltaMin[0] */
125         NLSF_Q15[0] = SKP_max_int( NLSF_Q15[0], NDeltaMin_Q15[0] );
126
127         /* Keep delta_min distance between the NLSFs */
128         for( i = 1; i < L; i++ )
129             NLSF_Q15[i] = SKP_max_int( NLSF_Q15[i], NLSF_Q15[i-1] + NDeltaMin_Q15[i] );
130
131         /* Last NLSF should be no higher than 1 - NDeltaMin[L] */
132         NLSF_Q15[L-1] = SKP_min_int( NLSF_Q15[L-1], (1<<15) - NDeltaMin_Q15[L] );
133
134         /* Keep NDeltaMin distance between the NLSFs */
135         for( i = L-2; i >= 0; i-- )
136             NLSF_Q15[i] = SKP_min_int( NLSF_Q15[i], NLSF_Q15[i+1] - NDeltaMin_Q15[i+1] );
137     }
138 }