Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_NLSF_MSVQ_encode_FIX.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 #include "SKP_Silk_main_FIX.h"\r
29 \r
30 /***********************/\r
31 /* NLSF vector encoder */\r
32 /***********************/\r
33 void SKP_Silk_NLSF_MSVQ_encode_FIX(\r
34           SKP_int                   *NLSFIndices,           /* O    Codebook path vector [ CB_STAGES ]      */\r
35           SKP_int                   *pNLSF_Q15,             /* I/O  Quantized NLSF vector [ LPC_ORDER ]     */\r
36     const SKP_Silk_NLSF_CB_struct   *psNLSF_CB,             /* I    Codebook object                         */\r
37     const SKP_int                   *pNLSF_q_Q15_prev,      /* I    Prev. quantized NLSF vector [LPC_ORDER] */\r
38     const SKP_int                   *pW_Q6,                 /* I    NLSF weight vector [ LPC_ORDER ]        */\r
39     const SKP_int                   NLSF_mu_Q15,            /* I    Rate weight for the RD optimization     */\r
40     const SKP_int                   NLSF_mu_fluc_red_Q16,   /* I    Fluctuation reduction error weight      */\r
41     const SKP_int                   NLSF_MSVQ_Survivors,    /* I    Max survivors from each stage           */\r
42     const SKP_int                   LPC_order,              /* I    LPC order                               */\r
43     const SKP_int                   deactivate_fluc_red     /* I    Deactivate fluctuation reduction        */\r
44 )\r
45 {\r
46     SKP_int     i, s, k, cur_survivors = 0, prev_survivors, input_index, cb_index, bestIndex;\r
47     SKP_int32   rateDistThreshold_Q18;\r
48     SKP_int     pNLSF_in_Q15[ MAX_LPC_ORDER ];\r
49 #if( NLSF_MSVQ_FLUCTUATION_REDUCTION == 1 )\r
50     SKP_int32   se_Q15, wsse_Q20, bestRateDist_Q20;\r
51 #endif\r
52 \r
53 #if( LOW_COMPLEXITY_ONLY == 1 )\r
54     SKP_int32   pRateDist_Q18[  NLSF_MSVQ_TREE_SEARCH_MAX_VECTORS_EVALUATED_LC_MODE ];\r
55     SKP_int32   pRate_Q5[       MAX_NLSF_MSVQ_SURVIVORS_LC_MODE ];\r
56     SKP_int32   pRate_new_Q5[   MAX_NLSF_MSVQ_SURVIVORS_LC_MODE ];\r
57     SKP_int     pTempIndices[   MAX_NLSF_MSVQ_SURVIVORS_LC_MODE ];\r
58     SKP_int     pPath[          MAX_NLSF_MSVQ_SURVIVORS_LC_MODE * NLSF_MSVQ_MAX_CB_STAGES ];\r
59     SKP_int     pPath_new[      MAX_NLSF_MSVQ_SURVIVORS_LC_MODE * NLSF_MSVQ_MAX_CB_STAGES ];\r
60     SKP_int     pRes_Q15[       MAX_NLSF_MSVQ_SURVIVORS_LC_MODE * MAX_LPC_ORDER ];\r
61     SKP_int     pRes_new_Q15[   MAX_NLSF_MSVQ_SURVIVORS_LC_MODE * MAX_LPC_ORDER ];\r
62 #else\r
63     SKP_int32   pRateDist_Q18[  NLSF_MSVQ_TREE_SEARCH_MAX_VECTORS_EVALUATED ];\r
64     SKP_int32   pRate_Q5[       MAX_NLSF_MSVQ_SURVIVORS ];\r
65     SKP_int32   pRate_new_Q5[   MAX_NLSF_MSVQ_SURVIVORS ];\r
66     SKP_int     pTempIndices[   MAX_NLSF_MSVQ_SURVIVORS ];\r
67     SKP_int     pPath[          MAX_NLSF_MSVQ_SURVIVORS * NLSF_MSVQ_MAX_CB_STAGES ];\r
68     SKP_int     pPath_new[      MAX_NLSF_MSVQ_SURVIVORS * NLSF_MSVQ_MAX_CB_STAGES ];\r
69     SKP_int     pRes_Q15[       MAX_NLSF_MSVQ_SURVIVORS * MAX_LPC_ORDER ];\r
70     SKP_int     pRes_new_Q15[   MAX_NLSF_MSVQ_SURVIVORS * MAX_LPC_ORDER ];\r
71 #endif\r
72 \r
73     const SKP_int   *pConstInt;\r
74           SKP_int   *pInt;\r
75     const SKP_int16 *pCB_element;\r
76     const SKP_Silk_NLSF_CBS *pCurrentCBStage;\r
77 \r
78     SKP_assert( NLSF_MSVQ_Survivors <= MAX_NLSF_MSVQ_SURVIVORS );\r
79     SKP_assert( ( LOW_COMPLEXITY_ONLY == 0 ) || ( NLSF_MSVQ_Survivors <= MAX_NLSF_MSVQ_SURVIVORS_LC_MODE ) );\r
80 \r
81 \r
82 \r
83     /* Copy the input vector */\r
84     SKP_memcpy( pNLSF_in_Q15, pNLSF_Q15, LPC_order * sizeof( SKP_int ) );\r
85 \r
86     /****************************************************/\r
87     /* Tree search for the multi-stage vector quantizer */\r
88     /****************************************************/\r
89 \r
90     /* Clear accumulated rates */\r
91     SKP_memset( pRate_Q5, 0, NLSF_MSVQ_Survivors * sizeof( SKP_int32 ) );\r
92     \r
93     /* Copy NLSFs into residual signal vector */\r
94     for( i = 0; i < LPC_order; i++ ) {\r
95         pRes_Q15[ i ] = pNLSF_Q15[ i ];\r
96     }\r
97 \r
98     /* Set first stage values */\r
99     prev_survivors = 1;\r
100 \r
101     /* Loop over all stages */\r
102     for( s = 0; s < psNLSF_CB->nStages; s++ ) {\r
103 \r
104         /* Set a pointer to the current stage codebook */\r
105         pCurrentCBStage = &psNLSF_CB->CBStages[ s ];\r
106 \r
107         /* Calculate the number of survivors in the current stage */\r
108         cur_survivors = SKP_min_32( NLSF_MSVQ_Survivors, SKP_SMULBB( prev_survivors, pCurrentCBStage->nVectors ) );\r
109 \r
110 #if( NLSF_MSVQ_FLUCTUATION_REDUCTION == 0 )\r
111         /* Find a single best survivor in the last stage, if we */\r
112         /* do not need candidates for fluctuation reduction     */\r
113         if( s == psNLSF_CB->nStages - 1 ) {\r
114             cur_survivors = 1;\r
115         }\r
116 #endif\r
117 \r
118         /* Nearest neighbor clustering for multiple input data vectors */\r
119         SKP_Silk_NLSF_VQ_rate_distortion_FIX( pRateDist_Q18, pCurrentCBStage, pRes_Q15, pW_Q6, \r
120             pRate_Q5, NLSF_mu_Q15, prev_survivors, LPC_order );\r
121 \r
122         /* Sort the rate-distortion errors */\r
123         SKP_Silk_insertion_sort_increasing( pRateDist_Q18, pTempIndices, \r
124             prev_survivors * pCurrentCBStage->nVectors, cur_survivors );\r
125 \r
126         /* Discard survivors with rate-distortion values too far above the best one */\r
127         if( pRateDist_Q18[ 0 ] < SKP_int32_MAX / NLSF_MSVQ_SURV_MAX_REL_RD ) {\r
128             rateDistThreshold_Q18 = SKP_MUL( NLSF_MSVQ_SURV_MAX_REL_RD, pRateDist_Q18[ 0 ] );\r
129             while( pRateDist_Q18[ cur_survivors - 1 ] > rateDistThreshold_Q18 && cur_survivors > 1 ) {\r
130                 cur_survivors--;\r
131             }\r
132         }\r
133         /* Update accumulated codebook contributions for the 'cur_survivors' best codebook indices */\r
134         for( k = 0; k < cur_survivors; k++ ) { \r
135             if( s > 0 ) {\r
136                 /* Find the indices of the input and the codebook vector */\r
137                 if( pCurrentCBStage->nVectors == 8 ) {\r
138                     input_index = SKP_RSHIFT( pTempIndices[ k ], 3 );\r
139                     cb_index    = pTempIndices[ k ] & 7;\r
140                 } else {\r
141                     input_index = SKP_DIV32_16( pTempIndices[ k ], pCurrentCBStage->nVectors );  \r
142                     cb_index    = pTempIndices[ k ] - SKP_SMULBB( input_index, pCurrentCBStage->nVectors );\r
143                 }\r
144             } else {\r
145                 /* Find the indices of the input and the codebook vector */\r
146                 input_index = 0;\r
147                 cb_index    = pTempIndices[ k ];\r
148             }\r
149 \r
150             /* Subtract new contribution from the previous residual vector for each of 'cur_survivors' */\r
151             pConstInt   = &pRes_Q15[ SKP_SMULBB( input_index, LPC_order ) ];\r
152             pCB_element = &pCurrentCBStage->CB_NLSF_Q15[ SKP_SMULBB( cb_index, LPC_order ) ];\r
153             pInt        = &pRes_new_Q15[ SKP_SMULBB( k, LPC_order ) ];\r
154             for( i = 0; i < LPC_order; i++ ) {\r
155                 pInt[ i ] = pConstInt[ i ] - ( SKP_int )pCB_element[ i ];\r
156             }\r
157 \r
158             /* Update accumulated rate for stage 1 to the current */\r
159             pRate_new_Q5[ k ] = pRate_Q5[ input_index ] + pCurrentCBStage->Rates_Q5[ cb_index ];\r
160 \r
161             /* Copy paths from previous matrix, starting with the best path */\r
162             pConstInt = &pPath[ SKP_SMULBB( input_index, psNLSF_CB->nStages ) ];\r
163             pInt      = &pPath_new[ SKP_SMULBB( k, psNLSF_CB->nStages ) ];\r
164             for( i = 0; i < s; i++ ) {\r
165                 pInt[ i ] = pConstInt[ i ];\r
166             }\r
167             /* Write the current stage indices for the 'cur_survivors' to the best path matrix */\r
168             pInt[ s ] = cb_index;\r
169         }\r
170 \r
171         if( s < psNLSF_CB->nStages - 1 ) {\r
172             /* Copy NLSF residual matrix for next stage */\r
173             SKP_memcpy( pRes_Q15, pRes_new_Q15, SKP_SMULBB( cur_survivors, LPC_order ) * sizeof( SKP_int ) );\r
174 \r
175             /* Copy rate vector for next stage */\r
176             SKP_memcpy( pRate_Q5, pRate_new_Q5, cur_survivors * sizeof( SKP_int32 ) );\r
177 \r
178             /* Copy best path matrix for next stage */\r
179             SKP_memcpy( pPath, pPath_new, SKP_SMULBB( cur_survivors, psNLSF_CB->nStages ) * sizeof( SKP_int ) );\r
180         }\r
181 \r
182         prev_survivors = cur_survivors;\r
183     }\r
184 \r
185     /* (Preliminary) index of the best survivor, later to be decoded */\r
186     bestIndex = 0;\r
187 \r
188 #if( NLSF_MSVQ_FLUCTUATION_REDUCTION == 1 )\r
189     /******************************/\r
190     /* NLSF fluctuation reduction */\r
191     /******************************/\r
192     if( deactivate_fluc_red != 1 ) {\r
193     \r
194         /* Search among all survivors, now taking also weighted fluctuation errors into account */\r
195         bestRateDist_Q20 = SKP_int32_MAX;\r
196         for( s = 0; s < cur_survivors; s++ ) {\r
197             /* Decode survivor to compare with previous quantized NLSF vector */\r
198             SKP_Silk_NLSF_MSVQ_decode( pNLSF_Q15, psNLSF_CB, &pPath_new[ SKP_SMULBB( s, psNLSF_CB->nStages ) ], LPC_order );\r
199 \r
200             /* Compare decoded NLSF vector with the previously quantized vector */ \r
201             wsse_Q20 = 0;\r
202             for( i = 0; i < LPC_order; i += 2 ) {\r
203                 /* Compute weighted squared quantization error for index i */\r
204                 se_Q15 = pNLSF_Q15[ i ] - pNLSF_q_Q15_prev[ i ]; // range: [ -32767 : 32767 ]\r
205                 wsse_Q20 = SKP_SMLAWB( wsse_Q20, SKP_SMULBB( se_Q15, se_Q15 ), pW_Q6[ i ] );\r
206 \r
207                 /* Compute weighted squared quantization error for index i + 1 */\r
208                 se_Q15 = pNLSF_Q15[ i + 1 ] - pNLSF_q_Q15_prev[ i + 1 ]; // range: [ -32767 : 32767 ]\r
209                 wsse_Q20 = SKP_SMLAWB( wsse_Q20, SKP_SMULBB( se_Q15, se_Q15 ), pW_Q6[ i + 1 ] );\r
210             }\r
211             SKP_assert( wsse_Q20 >= 0 );\r
212 \r
213             /* Add the fluctuation reduction penalty to the rate distortion error */\r
214             wsse_Q20 = SKP_ADD_POS_SAT32( pRateDist_Q18[ s ], SKP_SMULWB( wsse_Q20, NLSF_mu_fluc_red_Q16 ) );\r
215 \r
216             /* Keep index of best survivor */\r
217             if( wsse_Q20 < bestRateDist_Q20 ) {\r
218                 bestRateDist_Q20 = wsse_Q20;\r
219                 bestIndex = s;\r
220             }\r
221         }\r
222     }\r
223 #endif\r
224 \r
225     /* Copy best path to output argument */\r
226     SKP_memcpy( NLSFIndices, &pPath_new[ SKP_SMULBB( bestIndex, psNLSF_CB->nStages ) ], psNLSF_CB->nStages * sizeof( SKP_int ) );\r
227 \r
228     /* Decode and stabilize the best survivor */\r
229     SKP_Silk_NLSF_MSVQ_decode( pNLSF_Q15, psNLSF_CB, NLSFIndices, LPC_order );\r
230 \r
231 }\r