Fixes two SILK PLC issues
[opus.git] / 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 "main.h"
33
34 /***********************/
35 /* NLSF vector encoder */
36 /***********************/
37 opus_int32 silk_NLSF_encode(                                    /* O    Returns RD value in Q25                     */
38           opus_int8             *NLSFIndices,                   /* I    Codebook path vector [ LPC_ORDER + 1 ]      */
39           opus_int16            *pNLSF_Q15,                     /* I/O  Quantized NLSF vector [ LPC_ORDER ]         */
40     const silk_NLSF_CB_struct   *psNLSF_CB,                     /* I    Codebook object                             */
41     const opus_int16            *pW_QW,                         /* I    NLSF weight vector [ LPC_ORDER ]            */
42     const opus_int              NLSF_mu_Q20,                    /* I    Rate weight for the RD optimization         */
43     const opus_int              nSurvivors,                     /* I    Max survivors after first stage             */
44     const opus_int              signalType                      /* I    Signal type: 0/1/2                          */
45 )
46 {
47     opus_int         i, s, ind1, bestIndex, prob_Q8, bits_q7;
48     opus_int32       W_tmp_Q9;
49     opus_int32       err_Q26[      NLSF_VQ_MAX_VECTORS ];
50     opus_int32       RD_Q25[       NLSF_VQ_MAX_SURVIVORS ];
51     opus_int         tempIndices1[ NLSF_VQ_MAX_SURVIVORS ];
52     opus_int8        tempIndices2[ NLSF_VQ_MAX_SURVIVORS * MAX_LPC_ORDER ];
53     opus_int16       res_Q15[      MAX_LPC_ORDER ];
54     opus_int16       res_Q10[      MAX_LPC_ORDER ];
55     opus_int16       NLSF_tmp_Q15[ MAX_LPC_ORDER ];
56     opus_int16       W_tmp_QW[     MAX_LPC_ORDER ];
57     opus_int16       W_adj_Q5[     MAX_LPC_ORDER ];
58     opus_uint8       pred_Q8[      MAX_LPC_ORDER ];
59     opus_int16       ec_ix[        MAX_LPC_ORDER ];
60     const opus_uint8 *pCB_element, *iCDF_ptr;
61
62     silk_assert( nSurvivors <= NLSF_VQ_MAX_SURVIVORS );
63     silk_assert( signalType >= 0 && signalType <= 2 );
64     silk_assert( NLSF_mu_Q20 <= 32767 && NLSF_mu_Q20 >= 0 );
65
66     /* NLSF stabilization */
67     silk_NLSF_stabilize( pNLSF_Q15, psNLSF_CB->deltaMin_Q15, psNLSF_CB->order );
68
69     /* First stage: VQ */
70     silk_NLSF_VQ( err_Q26, pNLSF_Q15, psNLSF_CB->CB1_NLSF_Q8, psNLSF_CB->nVectors, psNLSF_CB->order );
71
72     /* Sort the quantization errors */
73     silk_insertion_sort_increasing( err_Q26, tempIndices1, psNLSF_CB->nVectors, nSurvivors );
74
75     /* Loop over survivors */
76     for( s = 0; s < nSurvivors; s++ ) {
77         ind1 = tempIndices1[ s ];
78
79         /* Residual after first stage */
80         pCB_element = &psNLSF_CB->CB1_NLSF_Q8[ ind1 * psNLSF_CB->order ];
81         for( i = 0; i < psNLSF_CB->order; i++ ) {
82             NLSF_tmp_Q15[ i ] = silk_LSHIFT16( ( opus_int16 )pCB_element[ i ], 7 );
83             res_Q15[ i ] = pNLSF_Q15[ i ] - NLSF_tmp_Q15[ i ];
84         }
85
86         /* Weights from codebook vector */
87         silk_NLSF_VQ_weights_laroia( W_tmp_QW, NLSF_tmp_Q15, psNLSF_CB->order );
88
89         /* Apply square-rooted weights */
90         for( i = 0; i < psNLSF_CB->order; i++ ) {
91             W_tmp_Q9 = silk_SQRT_APPROX( silk_LSHIFT( ( opus_int32 )W_tmp_QW[ i ], 18 - NLSF_W_Q ) );
92             res_Q10[ i ] = ( opus_int16 )silk_RSHIFT( silk_SMULBB( res_Q15[ i ], W_tmp_Q9 ), 14 );
93         }
94
95         /* Modify input weights accordingly */
96         for( i = 0; i < psNLSF_CB->order; i++ ) {
97             W_adj_Q5[ i ] = silk_DIV32_16( silk_LSHIFT( ( opus_int32 )pW_QW[ i ], 5 ), W_tmp_QW[ i ] );
98         }
99
100         /* Unpack entropy table indices and predictor for current CB1 index */
101         silk_NLSF_unpack( ec_ix, pred_Q8, psNLSF_CB, ind1 );
102
103         /* Trellis quantizer */
104         RD_Q25[ s ] = silk_NLSF_del_dec_quant( &tempIndices2[ s * MAX_LPC_ORDER ], res_Q10, W_adj_Q5, pred_Q8, ec_ix,
105             psNLSF_CB->ec_Rates_Q5, psNLSF_CB->quantStepSize_Q16, psNLSF_CB->invQuantStepSize_Q6, NLSF_mu_Q20, psNLSF_CB->order );
106
107         /* Add rate for first stage */
108         iCDF_ptr = &psNLSF_CB->CB1_iCDF[ ( signalType >> 1 ) * psNLSF_CB->nVectors ];
109         if( ind1 == 0 ) {
110             prob_Q8 = 256 - iCDF_ptr[ ind1 ];
111         } else {
112             prob_Q8 = iCDF_ptr[ ind1 - 1 ] - iCDF_ptr[ ind1 ];
113         }
114         bits_q7 = ( 8 << 7 ) - silk_lin2log( prob_Q8 );
115         RD_Q25[ s ] = silk_SMLABB( RD_Q25[ s ], bits_q7, silk_RSHIFT( NLSF_mu_Q20, 2 ) );
116     }
117
118     /* Find the lowest rate-distortion error */
119     silk_insertion_sort_increasing( RD_Q25, &bestIndex, nSurvivors, 1 );
120
121     NLSFIndices[ 0 ] = ( opus_int8 )tempIndices1[ bestIndex ];
122     silk_memcpy( &NLSFIndices[ 1 ], &tempIndices2[ bestIndex * MAX_LPC_ORDER ], psNLSF_CB->order * sizeof( opus_int8 ) );
123
124     /* Decode */
125     silk_NLSF_decode( pNLSF_Q15, NLSFIndices, psNLSF_CB );
126
127     return RD_Q25[ 0 ];
128 }