Fix dump_modes for the api change and move it into a subdirectory
[opus.git] / silk / silk_NLSF_encode.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 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "silk_main.h"
33
34 #define STORE_LSF_DATA_FOR_TRAINING          0
35
36 /***********************/
37 /* NLSF vector encoder */
38 /***********************/
39 opus_int32 silk_NLSF_encode(                                 /* O    Returns RD value in Q25                 */
40           opus_int8                  *NLSFIndices,           /* I    Codebook path vector [ LPC_ORDER + 1 ]  */
41           opus_int16                 *pNLSF_Q15,             /* I/O  Quantized NLSF vector [ LPC_ORDER ]     */
42     const silk_NLSF_CB_struct       *psNLSF_CB,             /* I    Codebook object                         */
43     const opus_int16                 *pW_QW,                 /* I    NLSF weight vector [ LPC_ORDER ]        */
44     const opus_int                   NLSF_mu_Q20,            /* I    Rate weight for the RD optimization     */
45     const opus_int                   nSurvivors,             /* I    Max survivors after first stage         */
46     const opus_int                   signalType              /* I    Signal type: 0/1/2                      */
47 )
48 {
49     opus_int         i, s, ind1, bestIndex, prob_Q8, bits_q7;
50     opus_int32       W_tmp_Q9;
51     opus_int32       err_Q26[      NLSF_VQ_MAX_VECTORS ];
52     opus_int32       RD_Q25[       NLSF_VQ_MAX_SURVIVORS ];
53     opus_int         tempIndices1[ NLSF_VQ_MAX_SURVIVORS ];
54     opus_int8        tempIndices2[ NLSF_VQ_MAX_SURVIVORS * MAX_LPC_ORDER ];
55     opus_int16       res_Q15[      MAX_LPC_ORDER ];
56     opus_int16       res_Q10[      MAX_LPC_ORDER ];
57     opus_int16       NLSF_tmp_Q15[ MAX_LPC_ORDER ];
58     opus_int16       W_tmp_QW[     MAX_LPC_ORDER ];
59     opus_int16       W_adj_Q5[     MAX_LPC_ORDER ];
60     opus_uint8       pred_Q8[      MAX_LPC_ORDER ];
61     opus_int16       ec_ix[        MAX_LPC_ORDER ];
62     const opus_uint8 *pCB_element, *iCDF_ptr;
63
64 #if STORE_LSF_DATA_FOR_TRAINING
65     opus_int16       pNLSF_Q15_orig[MAX_LPC_ORDER ];
66     DEBUG_STORE_DATA( NLSF.dat,    pNLSF_Q15,    psNLSF_CB->order * sizeof( opus_int16 ) );
67     DEBUG_STORE_DATA( WNLSF.dat,   pW_Q5,        psNLSF_CB->order * sizeof( opus_int16 ) );
68     DEBUG_STORE_DATA( NLSF_mu.dat, &NLSF_mu_Q20,                    sizeof( opus_int   ) );
69     DEBUG_STORE_DATA( sigType.dat, &signalType,                     sizeof( opus_int   ) );
70     SKP_memcpy(pNLSF_Q15_orig, pNLSF_Q15, sizeof( pNLSF_Q15_orig ));
71 #endif
72
73     SKP_assert( nSurvivors <= NLSF_VQ_MAX_SURVIVORS );
74     SKP_assert( signalType >= 0 && signalType <= 2 );
75     SKP_assert( NLSF_mu_Q20 <= 32767 && NLSF_mu_Q20 >= 0 );
76
77     /* NLSF stabilization */
78     silk_NLSF_stabilize( pNLSF_Q15, psNLSF_CB->deltaMin_Q15, psNLSF_CB->order );
79
80     /* First stage: VQ */
81     silk_NLSF_VQ( err_Q26, pNLSF_Q15, psNLSF_CB->CB1_NLSF_Q8, psNLSF_CB->nVectors, psNLSF_CB->order );
82
83     /* Sort the quantization errors */
84     silk_insertion_sort_increasing( err_Q26, tempIndices1, psNLSF_CB->nVectors, nSurvivors );
85
86     /* Loop over survivors */
87     for( s = 0; s < nSurvivors; s++ ) {
88         ind1 = tempIndices1[ s ];
89
90         /* Residual after first stage */
91         pCB_element = &psNLSF_CB->CB1_NLSF_Q8[ ind1 * psNLSF_CB->order ];
92         for( i = 0; i < psNLSF_CB->order; i++ ) {
93             NLSF_tmp_Q15[ i ] = SKP_LSHIFT16( ( opus_int16 )pCB_element[ i ], 7 );
94             res_Q15[ i ] = pNLSF_Q15[ i ] - NLSF_tmp_Q15[ i ];
95         }
96
97         /* Weights from codebook vector */
98         silk_NLSF_VQ_weights_laroia( W_tmp_QW, NLSF_tmp_Q15, psNLSF_CB->order );
99
100         /* Apply square-rooted weights */
101         for( i = 0; i < psNLSF_CB->order; i++ ) {
102             W_tmp_Q9 = silk_SQRT_APPROX( SKP_LSHIFT( ( opus_int32 )W_tmp_QW[ i ], 18 - NLSF_W_Q ) );
103             res_Q10[ i ] = ( opus_int16 )SKP_RSHIFT( SKP_SMULBB( res_Q15[ i ], W_tmp_Q9 ), 14 );
104         }
105
106         /* Modify input weights accordingly */
107         for( i = 0; i < psNLSF_CB->order; i++ ) {
108             W_adj_Q5[ i ] = SKP_DIV32_16( SKP_LSHIFT( ( opus_int32 )pW_QW[ i ], 5 ), W_tmp_QW[ i ] );
109         }
110
111         /* Unpack entropy table indices and predictor for current CB1 index */
112         silk_NLSF_unpack( ec_ix, pred_Q8, psNLSF_CB, ind1 );
113
114         /* Trellis quantizer */
115         RD_Q25[ s ] = silk_NLSF_del_dec_quant( &tempIndices2[ s * MAX_LPC_ORDER ], res_Q10, W_adj_Q5, pred_Q8, ec_ix,
116             psNLSF_CB->ec_Rates_Q5, psNLSF_CB->quantStepSize_Q16, psNLSF_CB->invQuantStepSize_Q6, NLSF_mu_Q20, psNLSF_CB->order );
117
118         /* Add rate for first stage */
119         iCDF_ptr = &psNLSF_CB->CB1_iCDF[ ( signalType >> 1 ) * psNLSF_CB->nVectors ];
120         if( ind1 == 0 ) {
121             prob_Q8 = 256 - iCDF_ptr[ ind1 ];
122         } else {
123             prob_Q8 = iCDF_ptr[ ind1 - 1 ] - iCDF_ptr[ ind1 ];
124         }
125         bits_q7 = ( 8 << 7 ) - silk_lin2log( prob_Q8 );
126         RD_Q25[ s ] = SKP_SMLABB( RD_Q25[ s ], bits_q7, SKP_RSHIFT( NLSF_mu_Q20, 2 ) );
127     }
128
129     /* Find the lowest rate-distortion error */
130     silk_insertion_sort_increasing( RD_Q25, &bestIndex, nSurvivors, 1 );
131
132     NLSFIndices[ 0 ] = ( opus_int8 )tempIndices1[ bestIndex ];
133     SKP_memcpy( &NLSFIndices[ 1 ], &tempIndices2[ bestIndex * MAX_LPC_ORDER ], psNLSF_CB->order * sizeof( opus_int8 ) );
134
135     /* Decode */
136     silk_NLSF_decode( pNLSF_Q15, NLSFIndices, psNLSF_CB );
137
138 #if STORE_LSF_DATA_FOR_TRAINING
139     {
140         /* code for training the codebooks */
141         opus_int32 RD_dec_Q22, Dist_Q22_dec, Rate_Q7, diff_Q15;
142         ind1 = NLSFIndices[ 0 ];
143         silk_NLSF_unpack( ec_ix, pred_Q8, psNLSF_CB, ind1 );
144
145         pCB_element = &psNLSF_CB->CB1_NLSF_Q8[ ind1 * psNLSF_CB->order ];
146         for( i = 0; i < psNLSF_CB->order; i++ ) {
147             NLSF_tmp_Q15[ i ] = SKP_LSHIFT16( ( opus_int16 )pCB_element[ i ], 7 );
148         }
149         silk_NLSF_VQ_weights_laroia( W_tmp_QW, NLSF_tmp_Q15, psNLSF_CB->order );
150         for( i = 0; i < psNLSF_CB->order; i++ ) {
151             W_tmp_Q9 = silk_SQRT_APPROX( SKP_LSHIFT( ( opus_int32 )W_tmp_QW[ i ], 18 - NLSF_W_Q ) );
152             res_Q15[ i ] = pNLSF_Q15_orig[ i ] - NLSF_tmp_Q15[ i ];
153             res_Q10[ i ] = (opus_int16)SKP_RSHIFT( SKP_SMULBB( res_Q15[ i ], W_tmp_Q9 ), 14 );
154             DEBUG_STORE_DATA( NLSF_res_q10.dat, &res_Q10[ i ], sizeof( opus_int16 ) );
155             res_Q15[ i ] = pNLSF_Q15[ i ] - NLSF_tmp_Q15[ i ];
156             res_Q10[ i ] = (opus_int16)SKP_RSHIFT( SKP_SMULBB( res_Q15[ i ], W_tmp_Q9 ), 14 );
157             DEBUG_STORE_DATA( NLSF_resq_q10.dat, &res_Q10[ i ], sizeof( opus_int16 ) );
158         }
159
160         Dist_Q22_dec = 0;
161         for( i = 0; i < psNLSF_CB->order; i++ ) {
162             diff_Q15 = pNLSF_Q15_orig[ i ] - pNLSF_Q15[ i ];
163             Dist_Q22_dec += ( ( (diff_Q15 >> 5) * (diff_Q15 >> 5) ) * pW_Q5[ i ] ) >> 3;
164         }
165         iCDF_ptr = &psNLSF_CB->CB1_iCDF[ ( signalType >> 1 ) * psNLSF_CB->nVectors ];
166         if( ind1 == 0 ) {
167             prob_Q8 = 256 - iCDF_ptr[ ind1 ];
168         } else {
169             prob_Q8 = iCDF_ptr[ ind1 - 1 ] - iCDF_ptr[ ind1 ];
170         }
171         Rate_Q7 = ( 8 << 7 ) - silk_lin2log( prob_Q8 );
172         for( i = 0; i < psNLSF_CB->order; i++ ) {
173             Rate_Q7 += ((int)psNLSF_CB->ec_Rates_Q5[ ec_ix[ i ] + SKP_LIMIT( NLSFIndices[ i + 1 ] + NLSF_QUANT_MAX_AMPLITUDE, 0, 2 * NLSF_QUANT_MAX_AMPLITUDE ) ] ) << 2;
174             if( SKP_abs( NLSFIndices[ i + 1 ] ) >= NLSF_QUANT_MAX_AMPLITUDE ) {
175                 Rate_Q7 += 128 << ( SKP_abs( NLSFIndices[ i + 1 ] ) - NLSF_QUANT_MAX_AMPLITUDE );
176             }
177         }
178         RD_dec_Q22 = Dist_Q22_dec + Rate_Q7 * NLSF_mu_Q20 >> 5;
179         DEBUG_STORE_DATA( dec_dist_q22.dat, &Dist_Q22_dec, sizeof( opus_int32 ) );
180         DEBUG_STORE_DATA( dec_rate_q7.dat, &Rate_Q7, sizeof( opus_int32 ) );
181         DEBUG_STORE_DATA( dec_rd_q22.dat, &RD_dec_Q22, sizeof( opus_int32 ) );
182     }
183     DEBUG_STORE_DATA( NLSF_ind.dat, NLSFIndices, (psNLSF_CB->order+1) * sizeof( opus_int8 ) );
184 #endif
185
186     return RD_Q25[ 0 ];
187 }