Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_decode_parameters_v4.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.h"\r
29 \r
30 /* Decode parameters from payload */\r
31 void SKP_Silk_decode_parameters_v4(\r
32     SKP_Silk_decoder_state      *psDec,                                 /* I/O  State                                    */\r
33     SKP_Silk_decoder_control    *psDecCtrl,                             /* I/O  Decoder control                          */\r
34     SKP_int                     q[ MAX_FRAME_LENGTH ],                  /* O    Excitation signal                        */\r
35     const SKP_int               fullDecoding                            /* I    Flag to tell if only arithmetic decoding */\r
36 )\r
37 {\r
38     SKP_int   i, k, Ix, nBytesUsed;\r
39     SKP_int   pNLSF_Q15[ MAX_LPC_ORDER ], pNLSF0_Q15[ MAX_LPC_ORDER ];\r
40     const SKP_int16 *cbk_ptr_Q14;\r
41     const SKP_Silk_NLSF_CB_struct *psNLSF_CB = NULL;\r
42     SKP_Silk_range_coder_state  *psRC = &psDec->sRC;\r
43     \r
44     psDec->FrameTermination       = SKP_SILK_MORE_FRAMES;\r
45     psDecCtrl->sigtype            = psDec->sigtype[ psDec->nFramesDecoded ];\r
46     psDecCtrl->QuantOffsetType    = psDec->QuantOffsetType[ psDec->nFramesDecoded ];\r
47     psDec->vadFlag                = psDec->vadFlagBuf[ psDec->nFramesDecoded ];\r
48     psDecCtrl->NLSFInterpCoef_Q2  = psDec->NLSFInterpCoef_Q2[ psDec->nFramesDecoded ];\r
49     psDecCtrl->Seed               = psDec->Seed[ psDec->nFramesDecoded ];\r
50 \r
51     /* Dequant Gains */\r
52     SKP_Silk_gains_dequant( psDecCtrl->Gains_Q16, psDec->GainsIndices[ psDec->nFramesDecoded ], &psDec->LastGainIndex, psDec->nFramesDecoded );\r
53     /****************/\r
54     /* Decode NLSFs */\r
55     /****************/\r
56 \r
57     /* Set pointer to NLSF VQ CB for the current signal type */\r
58     psNLSF_CB = psDec->psNLSF_CB[ psDecCtrl->sigtype ];\r
59 \r
60     /* From the NLSF path, decode an NLSF vector */\r
61     SKP_Silk_NLSF_MSVQ_decode( pNLSF_Q15, psNLSF_CB, psDec->NLSFIndices[ psDec->nFramesDecoded ], psDec->LPC_order );\r
62 \r
63     /* Convert NLSF parameters to AR prediction filter coefficients */\r
64     SKP_Silk_NLSF2A_stable( psDecCtrl->PredCoef_Q12[ 1 ], pNLSF_Q15, psDec->LPC_order );\r
65     \r
66     /* If just reset, e.g., because internal Fs changed, do not allow interpolation */\r
67     /* improves the case of packet loss in the first frame after a switch           */\r
68     if( psDec->first_frame_after_reset == 1 ) {\r
69         psDecCtrl->NLSFInterpCoef_Q2 = 4;\r
70     }\r
71 \r
72     if( psDecCtrl->NLSFInterpCoef_Q2 < 4 ) {\r
73         /* Calculation of the interpolated NLSF0 vector from the interpolation factor, */ \r
74         /* the previous NLSF1, and the current NLSF1                                   */\r
75         for( i = 0; i < psDec->LPC_order; i++ ) {\r
76             pNLSF0_Q15[ i ] = psDec->prevNLSF_Q15[ i ] + SKP_RSHIFT( SKP_MUL( psDecCtrl->NLSFInterpCoef_Q2, \r
77                 ( pNLSF_Q15[ i ] - psDec->prevNLSF_Q15[ i ] ) ), 2 );\r
78         }\r
79 \r
80         /* Convert NLSF parameters to AR prediction filter coefficients */\r
81         SKP_Silk_NLSF2A_stable( psDecCtrl->PredCoef_Q12[ 0 ], pNLSF0_Q15, psDec->LPC_order );\r
82     } else {\r
83         /* Copy LPC coefficients for first half from second half */\r
84         SKP_memcpy( psDecCtrl->PredCoef_Q12[ 0 ], psDecCtrl->PredCoef_Q12[ 1 ], \r
85             psDec->LPC_order * sizeof( SKP_int16 ) );\r
86     }\r
87 \r
88     SKP_memcpy( psDec->prevNLSF_Q15, pNLSF_Q15, psDec->LPC_order * sizeof( SKP_int ) );\r
89 \r
90     /* After a packet loss do BWE of LPC coefs */\r
91     if( psDec->lossCnt ) {\r
92         SKP_Silk_bwexpander( psDecCtrl->PredCoef_Q12[ 0 ], psDec->LPC_order, BWE_AFTER_LOSS_Q16 );\r
93         SKP_Silk_bwexpander( psDecCtrl->PredCoef_Q12[ 1 ], psDec->LPC_order, BWE_AFTER_LOSS_Q16 );\r
94     }\r
95 \r
96     if( psDecCtrl->sigtype == SIG_TYPE_VOICED ) {\r
97         /*********************/\r
98         /* Decode pitch lags */\r
99         /*********************/\r
100         \r
101         /* Decode pitch values */\r
102         SKP_Silk_decode_pitch( psDec->lagIndex[ psDec->nFramesDecoded ], \r
103             psDec->contourIndex[ psDec->nFramesDecoded ], psDecCtrl->pitchL, psDec->fs_kHz );\r
104 \r
105         /********************/\r
106         /* Decode LTP gains */\r
107         /********************/\r
108         psDecCtrl->PERIndex = psDec->PERIndex[ psDec->nFramesDecoded ];\r
109         \r
110         /* Decode Codebook Index */\r
111         cbk_ptr_Q14 = SKP_Silk_LTP_vq_ptrs_Q14[ psDecCtrl->PERIndex ]; /* set pointer to start of codebook */\r
112 \r
113         for( k = 0; k < NB_SUBFR; k++ ) {\r
114             Ix = psDec->LTPIndex[ psDec->nFramesDecoded ][ k ];\r
115             for( i = 0; i < LTP_ORDER; i++ ) {\r
116                 psDecCtrl->LTPCoef_Q14[ SKP_SMULBB( k, LTP_ORDER ) + i ] = cbk_ptr_Q14[ SKP_SMULBB( Ix, LTP_ORDER ) + i ];\r
117             }\r
118         }\r
119 \r
120         /**********************/\r
121         /* Decode LTP scaling */\r
122         /**********************/\r
123         Ix = psDec->LTP_scaleIndex[ psDec->nFramesDecoded ];\r
124         psDecCtrl->LTP_scale_Q14 = SKP_Silk_LTPScales_table_Q14[ Ix ];\r
125     } else {\r
126         SKP_memset( psDecCtrl->pitchL,      0, NB_SUBFR * sizeof( SKP_int ) );\r
127         SKP_memset( psDecCtrl->LTPCoef_Q14, 0, NB_SUBFR * LTP_ORDER * sizeof( SKP_int16 ) );\r
128         psDecCtrl->PERIndex      = 0;\r
129         psDecCtrl->LTP_scale_Q14 = 0;\r
130     }\r
131 \r
132     /*********************************************/\r
133     /* Decode quantization indices of excitation */\r
134     /*********************************************/\r
135     SKP_Silk_decode_pulses( psRC, psDecCtrl, q, psDec->frame_length );\r
136 \r
137     /****************************************/\r
138     /* get number of bytes used so far      */\r
139     /****************************************/\r
140     SKP_Silk_range_coder_get_length( psRC, &nBytesUsed );\r
141     psDec->nBytesLeft = psRC->bufferLength - nBytesUsed;\r
142     if( psDec->nBytesLeft < 0 ) {\r
143         psRC->error = RANGE_CODER_READ_BEYOND_BUFFER;\r
144     }\r
145 \r
146     /****************************************/\r
147     /* check remaining bits in last byte    */\r
148     /****************************************/\r
149     if( psDec->nBytesLeft == 0 ) {\r
150         SKP_Silk_range_coder_check_after_decoding( psRC );\r
151     }\r
152 \r
153     if( psDec->nFramesInPacket == (psDec->nFramesDecoded + 1)) {\r
154         /* To indicate the packet has been fully decoded */\r
155         psDec->FrameTermination = SKP_SILK_LAST_FRAME;\r
156     }\r
157 }\r