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