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