585bf7770d84e5e85d998ba1de2fe1f4aae3e55d
[opus.git] / src_FLP / SKP_Silk_NLSF_MSVQ_encode_FLP.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_FLP.h"\r
29 \r
30 /***********************/\r
31 /* NLSF vector encoder */\r
32 /***********************/\r
33 void SKP_Silk_NLSF_MSVQ_encode_FLP(\r
34           SKP_int                   *NLSFIndices,       /* O    Codebook path vector [ CB_STAGES ]      */\r
35           SKP_float                 *pNLSF,             /* I/O  Quantized NLSF vector [ LPC_ORDER ]     */\r
36     const SKP_Silk_NLSF_CB_struct   *psNLSF_CB,         /* I    Codebook object                         */\r
37     const SKP_float                 *pNLSF_q_prev,      /* I    Prev. quantized NLSF vector [LPC_ORDER] */\r
38     const SKP_float                 *pW,                /* I    NLSF weight vector [ LPC_ORDER ]        */\r
39     const SKP_float                 NLSF_mu,            /* I    Rate weight for the RD optimization     */\r
40     const SKP_float                 NLSF_mu_fluc_red,   /* 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, prev_survivors, min_survivors, input_index, cb_index, bestIndex;\r
47     SKP_float   rateDistThreshold;\r
48 #if( NLSF_MSVQ_FLUCTUATION_REDUCTION == 1 )\r
49     SKP_float   se, wsse, bestRateDist;\r
50 #endif\r
51 \r
52     SKP_float   pRateDist[      NLSF_MSVQ_TREE_SEARCH_MAX_VECTORS_EVALUATED ];\r
53     SKP_float   pRate[          MAX_NLSF_MSVQ_SURVIVORS ];\r
54     SKP_float   pRate_new[      MAX_NLSF_MSVQ_SURVIVORS ];\r
55     SKP_int     pTempIndices[   MAX_NLSF_MSVQ_SURVIVORS ];\r
56     SKP_int     pPath[          MAX_NLSF_MSVQ_SURVIVORS * NLSF_MSVQ_MAX_CB_STAGES ];\r
57     SKP_int     pPath_new[      MAX_NLSF_MSVQ_SURVIVORS * NLSF_MSVQ_MAX_CB_STAGES ];\r
58     SKP_float   pRes_Q8[        MAX_NLSF_MSVQ_SURVIVORS * MAX_LPC_ORDER ];\r
59     SKP_float   pRes_Q8_new[    MAX_NLSF_MSVQ_SURVIVORS * MAX_LPC_ORDER ];\r
60 \r
61     const SKP_float *pConstFloat;\r
62           SKP_float *pFloat;\r
63     const SKP_int   *pConstInt;\r
64           SKP_int   *pInt;\r
65     const SKP_int8  *pCB_element;\r
66     const SKP_Silk_NLSF_CBS *pCurrentCBStage;\r
67 \r
68     SKP_assert( NLSF_MSVQ_Survivors <= MAX_NLSF_MSVQ_SURVIVORS );\r
69 \r
70 #ifdef SAVE_ALL_INTERNAL_DATA\r
71     DEBUG_STORE_DATA( NLSF.dat,    pNLSF,    LPC_order * sizeof( SKP_float ) );\r
72     DEBUG_STORE_DATA( WNLSF.dat,   pW,       LPC_order * sizeof( SKP_float ) );\r
73     DEBUG_STORE_DATA( NLSF_mu.dat, &NLSF_mu,             sizeof( SKP_float ) );\r
74 #endif\r
75 \r
76     cur_survivors = NLSF_MSVQ_Survivors;\r
77 \r
78     /****************************************************/\r
79     /* Tree search for the multi-stage vector quantizer */\r
80     /****************************************************/\r
81 \r
82     /* Clear accumulated rates */\r
83     SKP_memset( pRate, 0, NLSF_MSVQ_Survivors * sizeof( SKP_float ) );\r
84 \r
85     /* Subtract 1/2 from NLSF input vector to create initial residual, and scale to Q8 */\r
86     for( i = 0; i < LPC_order; i++ ) {\r
87         pRes_Q8[ i ] = ( pNLSF[ i ] - 0.5f ) * 256.0f;        \r
88     }\r
89 \r
90     /* Set first stage values */\r
91     prev_survivors = 1;\r
92 \r
93     /* Minimum number of survivors */\r
94     min_survivors = NLSF_MSVQ_Survivors / 2;\r
95 \r
96     /* Loop over all stages */\r
97     for( s = 0; s < psNLSF_CB->nStages; s++ ) {\r
98 \r
99         /* Set a pointer to the current stage codebook */\r
100         pCurrentCBStage = &psNLSF_CB->CBStages[ s ];\r
101 \r
102         /* Calculate the number of survivors in the current stage */\r
103         cur_survivors = SKP_min_32( NLSF_MSVQ_Survivors, prev_survivors * pCurrentCBStage->nVectors );\r
104 \r
105 #if( NLSF_MSVQ_FLUCTUATION_REDUCTION == 0 )\r
106         /* Find a single best survivor in the last stage, if we */\r
107         /* do not need candidates for fluctuation reduction     */\r
108         if( s == psNLSF_CB->nStages - 1 ) {\r
109             cur_survivors = 1;\r
110         }\r
111 #endif\r
112         /* Nearest neighbor clustering for multiple input data vectors */\r
113         SKP_Silk_NLSF_VQ_rate_distortion_FLP( pRateDist, pCurrentCBStage, pRes_Q8, pW, pRate, NLSF_mu, prev_survivors, LPC_order );\r
114 \r
115         /* Sort the rate-distortion errors */\r
116         SKP_Silk_insertion_sort_increasing_FLP( pRateDist, pTempIndices, prev_survivors * pCurrentCBStage->nVectors, cur_survivors );\r
117 \r
118         /* Discard survivors with rate-distortion values too far above the best one */\r
119         rateDistThreshold = ( 1.0f + NLSF_MSVQ_Survivors * NLSF_MSVQ_SURV_MAX_REL_RD ) * pRateDist[ 0 ];\r
120         while( pRateDist[ cur_survivors - 1 ] > rateDistThreshold && cur_survivors > min_survivors ) {\r
121             cur_survivors--;\r
122         }\r
123 \r
124         /* Update accumulated codebook contributions for the 'cur_survivors' best codebook indices */\r
125         for( k = 0; k < cur_survivors; k++ ) { \r
126             if( s > 0 ) {\r
127                 /* Find the indices of the input and the codebook vector */\r
128                 if( pCurrentCBStage->nVectors == 8 ) {\r
129                     input_index = SKP_RSHIFT( pTempIndices[ k ], 3 );\r
130                     cb_index    = pTempIndices[ k ] & 7;\r
131                 } else {\r
132                     input_index = pTempIndices[ k ] / pCurrentCBStage->nVectors;  \r
133                     cb_index    = pTempIndices[ k ] - input_index * pCurrentCBStage->nVectors;\r
134                 }\r
135             } else {\r
136                 /* Find the indices of the input and the codebook vector */\r
137                 input_index = 0;\r
138                 cb_index    = pTempIndices[ k ];\r
139             }\r
140 \r
141             /* Subtract new contribution from the previous residual vector for each of 'cur_survivors' */\r
142             pConstFloat = &pRes_Q8[ input_index * LPC_order ];\r
143             pCB_element = &pCurrentCBStage->CB_NLSF_Q8[ cb_index * LPC_order ];\r
144             pFloat      = &pRes_Q8_new[ k * LPC_order ];\r
145             for( i = 0; i < LPC_order; i++ ) {\r
146                 pFloat[ i ] = pConstFloat[ i ] - pCB_element[ i ];\r
147             }\r
148 \r
149             /* Update accumulated rate for stage 1 to the current */\r
150             pRate_new[ k ] = pRate[ input_index ] + 0.0625f * ( SKP_float )pCurrentCBStage->Rates_Q4[ cb_index ];\r
151 \r
152             /* Copy paths from previous matrix, starting with the best path */\r
153             pConstInt = &pPath[ input_index * psNLSF_CB->nStages ];\r
154             pInt      = &pPath_new[       k * psNLSF_CB->nStages ];\r
155             for( i = 0; i < s; i++ ) {\r
156                 pInt[ i ] = pConstInt[ i ];\r
157             }\r
158             /* Write the current stage indices for the 'cur_survivors' to the best path matrix */\r
159             pInt[ s ] = cb_index;\r
160         }\r
161 \r
162         if( s < psNLSF_CB->nStages - 1 ) {\r
163             /* Copy NLSF residual matrix for next stage */\r
164             SKP_memcpy( pRes_Q8, pRes_Q8_new, cur_survivors * LPC_order * sizeof( SKP_float ) );\r
165 \r
166             /* Copy rate vector for next stage */\r
167             SKP_memcpy( pRate, pRate_new, cur_survivors * sizeof( SKP_float ) );\r
168 \r
169             /* Copy best path matrix for next stage */\r
170             SKP_memcpy( pPath, pPath_new, cur_survivors * psNLSF_CB->nStages * sizeof( SKP_int ) );\r
171         }\r
172 \r
173         prev_survivors = cur_survivors;\r
174     }\r
175 \r
176     /* (Preliminary) index of the best survivor, later to be decoded */\r
177     bestIndex = 0;\r
178 \r
179 #if( NLSF_MSVQ_FLUCTUATION_REDUCTION == 1 )\r
180     /******************************/\r
181     /* NLSF fluctuation reduction */\r
182     /******************************/\r
183     if( deactivate_fluc_red != 1 ) {\r
184     \r
185         /* Search among all survivors, now taking also weighted fluctuation errors into account */\r
186         bestRateDist = SKP_float_MAX;\r
187         for( s = 0; s < cur_survivors; s++ ) {\r
188             /* Decode survivor to compare with previous quantized NLSF vector */\r
189             SKP_Silk_NLSF_MSVQ_decode_FLP( pNLSF, psNLSF_CB, &pPath_new[ s * psNLSF_CB->nStages ], LPC_order );\r
190 \r
191             /* Compare decoded NLSF vector with the previously quantized vector */ \r
192             wsse = 0;\r
193             for( i = 0; i < LPC_order; i += 2 ) {\r
194                 /* Compute weighted squared quantization error for index i */\r
195                 se = pNLSF[ i ] - pNLSF_q_prev[ i ];\r
196                 wsse += pW[ i ] * se * se;\r
197 \r
198                 /* Compute weighted squared quantization error for index i + 1 */\r
199                 se = pNLSF[ i + 1 ] - pNLSF_q_prev[ i + 1 ];\r
200                 wsse += pW[ i + 1 ] * se * se;\r
201             }\r
202 \r
203             /* Add the fluctuation reduction penalty to the rate distortion error */\r
204             wsse = pRateDist[s] + wsse * NLSF_mu_fluc_red;\r
205 \r
206             /* Keep index of best survivor */\r
207             if( wsse < bestRateDist ) {\r
208                 bestRateDist = wsse;\r
209                 bestIndex = s;\r
210             }\r
211         }\r
212     }\r
213 #endif\r
214 \r
215     /* Copy best path to output argument */\r
216     SKP_memcpy( NLSFIndices, &pPath_new[ bestIndex * psNLSF_CB->nStages ], psNLSF_CB->nStages * sizeof( SKP_int ) );\r
217 \r
218     /* Decode and stabilize the best survivor */\r
219     SKP_Silk_NLSF_MSVQ_decode_FLP( pNLSF, psNLSF_CB, NLSFIndices, LPC_order );\r
220 \r
221 }\r