Moving the SILK fixed-point and float files
[opus.git] / silk / SKP_Silk_decode_core.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, 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 /**********************************************************/\r
31 /* Core decoder. Performs inverse NSQ operation LTP + LPC */\r
32 /**********************************************************/\r
33 void SKP_Silk_decode_core(\r
34     SKP_Silk_decoder_state      *psDec,                             /* I/O  Decoder state               */\r
35     SKP_Silk_decoder_control    *psDecCtrl,                         /* I    Decoder control             */\r
36     SKP_int16                   xq[],                               /* O    Decoded speech              */\r
37     const SKP_int               pulses[ MAX_FRAME_LENGTH ]          /* I    Pulse signal                */\r
38 )\r
39 {\r
40     SKP_int   i, j, k, lag = 0, start_idx, sLTP_buf_idx, NLSF_interpolation_flag, signalType;\r
41     SKP_int16 *A_Q12, *B_Q14, *pxq, A_Q12_tmp[ MAX_LPC_ORDER ];\r
42     SKP_int16 sLTP[ MAX_FRAME_LENGTH ];\r
43     SKP_int32 LTP_pred_Q14, LPC_pred_Q10, Gain_Q16, inv_gain_Q16, inv_gain_Q32, gain_adj_Q16, rand_seed, offset_Q10;\r
44     SKP_int32 *pred_lag_ptr, *pexc_Q10, *pres_Q10;\r
45     SKP_int32 res_Q10[ MAX_SUB_FRAME_LENGTH ];\r
46     SKP_int32 vec_Q10[ MAX_SUB_FRAME_LENGTH ];\r
47 \r
48     SKP_assert( psDec->prev_inv_gain_Q16 != 0 );\r
49     \r
50     offset_Q10 = SKP_Silk_Quantization_Offsets_Q10[ psDec->indices.signalType >> 1 ][ psDec->indices.quantOffsetType ];\r
51 \r
52     if( psDec->indices.NLSFInterpCoef_Q2 < 1 << 2 ) {\r
53         NLSF_interpolation_flag = 1;\r
54     } else {\r
55         NLSF_interpolation_flag = 0;\r
56     }\r
57 \r
58     /* Decode excitation */\r
59     rand_seed = psDec->indices.Seed;\r
60     for( i = 0; i < psDec->frame_length; i++ ) {\r
61         rand_seed = SKP_RAND( rand_seed );\r
62         psDec->exc_Q10[ i ] = SKP_LSHIFT( ( SKP_int32 )pulses[ i ], 10 );\r
63         if( psDec->exc_Q10[ i ] > 0 ) {\r
64             psDec->exc_Q10[ i ] -= QUANT_LEVEL_ADJUST_Q10;\r
65         } else \r
66         if( psDec->exc_Q10[ i ] < 0 ) {\r
67             psDec->exc_Q10[ i ] += QUANT_LEVEL_ADJUST_Q10;\r
68         }\r
69         psDec->exc_Q10[ i ] += offset_Q10;\r
70         psDec->exc_Q10[ i ] ^= SKP_RSHIFT( rand_seed, 31 );\r
71 \r
72         rand_seed += pulses[ i ];\r
73     }\r
74 \r
75 #ifdef SAVE_ALL_INTERNAL_DATA\r
76     DEBUG_STORE_DATA( dec_q.dat, pulses, psDec->frame_length * sizeof( SKP_int ) );\r
77 #endif\r
78 \r
79     pexc_Q10 = psDec->exc_Q10;\r
80     pxq      = &psDec->outBuf[ psDec->ltp_mem_length ];\r
81     sLTP_buf_idx = psDec->ltp_mem_length;\r
82     /* Loop over subframes */\r
83     for( k = 0; k < psDec->nb_subfr; k++ ) {\r
84         pres_Q10 = res_Q10;\r
85         A_Q12 = psDecCtrl->PredCoef_Q12[ k >> 1 ];\r
86 \r
87         /* Preload LPC coeficients to array on stack. Gives small performance gain */        \r
88         SKP_memcpy( A_Q12_tmp, A_Q12, psDec->LPC_order * sizeof( SKP_int16 ) ); \r
89         B_Q14        = &psDecCtrl->LTPCoef_Q14[ k * LTP_ORDER ];\r
90         Gain_Q16     = psDecCtrl->Gains_Q16[ k ];\r
91         signalType   = psDec->indices.signalType;\r
92 \r
93         inv_gain_Q16 = SKP_INVERSE32_varQ( SKP_max( Gain_Q16, 1 ), 32 );\r
94         inv_gain_Q16 = SKP_min( inv_gain_Q16, SKP_int16_MAX );\r
95 \r
96         /* Calculate Gain adjustment factor */\r
97         gain_adj_Q16 = 1 << 16;\r
98         if( inv_gain_Q16 != psDec->prev_inv_gain_Q16 ) {\r
99             gain_adj_Q16 =  SKP_DIV32_varQ( inv_gain_Q16, psDec->prev_inv_gain_Q16, 16 );\r
100 \r
101             /* Scale short term state */\r
102             for( i = 0; i < MAX_LPC_ORDER; i++ ) {\r
103                 psDec->sLPC_Q14[ i ] = SKP_SMULWW( gain_adj_Q16, psDec->sLPC_Q14[ i ] );\r
104             }\r
105         }\r
106 \r
107         /* Save inv_gain */\r
108         SKP_assert( inv_gain_Q16 != 0 );\r
109         psDec->prev_inv_gain_Q16 = inv_gain_Q16;\r
110 \r
111         /* Avoid abrupt transition from voiced PLC to unvoiced normal decoding */\r
112         if( psDec->lossCnt && psDec->prevSignalType == TYPE_VOICED &&\r
113             psDec->indices.signalType != TYPE_VOICED && k < MAX_NB_SUBFR/2 ) {\r
114             \r
115             SKP_memset( B_Q14, 0, LTP_ORDER * sizeof( SKP_int16 ) );\r
116             B_Q14[ LTP_ORDER/2 ] = SKP_FIX_CONST( 0.25, 14 );\r
117         \r
118             signalType = TYPE_VOICED;\r
119             psDecCtrl->pitchL[ k ] = psDec->lagPrev;\r
120         }\r
121 \r
122         if( signalType == TYPE_VOICED ) {\r
123             /* Voiced */\r
124             lag = psDecCtrl->pitchL[ k ];\r
125 \r
126             /* Re-whitening */\r
127             if( ( k & ( 3 - SKP_LSHIFT( NLSF_interpolation_flag, 1 ) ) ) == 0 ) {\r
128                 /* Rewhiten with new A coefs */\r
129                 start_idx = psDec->ltp_mem_length - lag - psDec->LPC_order - LTP_ORDER / 2;\r
130                 SKP_assert( start_idx > 0 );\r
131 \r
132                 SKP_Silk_LPC_analysis_filter( &sLTP[ start_idx ], &psDec->outBuf[ start_idx + k * psDec->subfr_length ], \r
133                     A_Q12, psDec->ltp_mem_length - start_idx, psDec->LPC_order );\r
134 \r
135                 /* After rewhitening the LTP state is unscaled */\r
136                 inv_gain_Q32 = SKP_LSHIFT( inv_gain_Q16, 16 );\r
137                 if( k == 0 ) {\r
138                     /* Do LTP downscaling */\r
139                     inv_gain_Q32 = SKP_LSHIFT( SKP_SMULWB( inv_gain_Q32, psDecCtrl->LTP_scale_Q14 ), 2 );\r
140                 }\r
141                 for( i = 0; i < lag + LTP_ORDER/2; i++ ) {\r
142                     psDec->sLTP_Q16[ sLTP_buf_idx - i - 1 ] = SKP_SMULWB( inv_gain_Q32, sLTP[ psDec->ltp_mem_length - i - 1 ] );\r
143                 }\r
144             } else {\r
145                 /* Update LTP state when Gain changes */\r
146                 if( gain_adj_Q16 != 1 << 16 ) {\r
147                     for( i = 0; i < lag + LTP_ORDER/2; i++ ) {\r
148                         psDec->sLTP_Q16[ sLTP_buf_idx - i - 1 ] = SKP_SMULWW( gain_adj_Q16, psDec->sLTP_Q16[ sLTP_buf_idx - i - 1 ] );\r
149                     }\r
150                 }\r
151             }\r
152         }\r
153         \r
154         /* Long-term prediction */\r
155         if( signalType == TYPE_VOICED ) {\r
156             /* Setup pointer */\r
157             pred_lag_ptr = &psDec->sLTP_Q16[ sLTP_buf_idx - lag + LTP_ORDER / 2 ];\r
158             for( i = 0; i < psDec->subfr_length; i++ ) {\r
159                 /* Unrolled loop */\r
160                 LTP_pred_Q14 = SKP_SMULWB(               pred_lag_ptr[  0 ], B_Q14[ 0 ] );\r
161                 LTP_pred_Q14 = SKP_SMLAWB( LTP_pred_Q14, pred_lag_ptr[ -1 ], B_Q14[ 1 ] );\r
162                 LTP_pred_Q14 = SKP_SMLAWB( LTP_pred_Q14, pred_lag_ptr[ -2 ], B_Q14[ 2 ] );\r
163                 LTP_pred_Q14 = SKP_SMLAWB( LTP_pred_Q14, pred_lag_ptr[ -3 ], B_Q14[ 3 ] );\r
164                 LTP_pred_Q14 = SKP_SMLAWB( LTP_pred_Q14, pred_lag_ptr[ -4 ], B_Q14[ 4 ] );\r
165                 pred_lag_ptr++;\r
166             \r
167                 /* Generate LPC residual */ \r
168                 pres_Q10[ i ] = SKP_ADD32( pexc_Q10[ i ], SKP_RSHIFT_ROUND( LTP_pred_Q14, 4 ) );\r
169             \r
170                 /* Update states */\r
171                 psDec->sLTP_Q16[ sLTP_buf_idx ] = SKP_LSHIFT( pres_Q10[ i ], 6 );\r
172                 sLTP_buf_idx++;\r
173             }\r
174         } else {\r
175             pres_Q10 = pexc_Q10;\r
176         }\r
177 \r
178 #ifdef SAVE_ALL_INTERNAL_DATA\r
179         DEBUG_STORE_DATA( dec_exc_Q10.dat, pexc_Q10, psDec->subfr_length * sizeof( SKP_int32 ) );\r
180         DEBUG_STORE_DATA( dec_res_Q10.dat, pres_Q10, psDec->subfr_length * sizeof( SKP_int32 ) );\r
181 #endif\r
182 \r
183         for( i = 0; i < psDec->subfr_length; i++ ) {\r
184             /* Partially unrolled */\r
185             LPC_pred_Q10 = SKP_SMULWB(               psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  1 ], A_Q12_tmp[ 0 ] );\r
186             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  2 ], A_Q12_tmp[ 1 ] );\r
187             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  3 ], A_Q12_tmp[ 2 ] );\r
188             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  4 ], A_Q12_tmp[ 3 ] );\r
189             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  5 ], A_Q12_tmp[ 4 ] );\r
190             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  6 ], A_Q12_tmp[ 5 ] );\r
191             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  7 ], A_Q12_tmp[ 6 ] );\r
192             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  8 ], A_Q12_tmp[ 7 ] );\r
193             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i -  9 ], A_Q12_tmp[ 8 ] );\r
194             LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i - 10 ], A_Q12_tmp[ 9 ] );\r
195             for( j = 10; j < psDec->LPC_order; j++ ) {\r
196                 LPC_pred_Q10 = SKP_SMLAWB( LPC_pred_Q10, psDec->sLPC_Q14[ MAX_LPC_ORDER + i - j - 1 ], A_Q12_tmp[ j ] );\r
197             }\r
198 \r
199             /* Add prediction to LPC residual */\r
200             vec_Q10[ i ] = SKP_ADD32( pres_Q10[ i ], LPC_pred_Q10 );\r
201 \r
202             /* Update states */\r
203             psDec->sLPC_Q14[ MAX_LPC_ORDER + i ] = SKP_LSHIFT( vec_Q10[ i ], 4 );\r
204         }\r
205 \r
206         /* Scale with Gain */\r
207         for( i = 0; i < psDec->subfr_length; i++ ) {\r
208             pxq[ i ] = ( SKP_int16 )SKP_SAT16( SKP_RSHIFT_ROUND( SKP_SMULWW( vec_Q10[ i ], Gain_Q16 ), 10 ) );\r
209         }\r
210 \r
211         /* Update LPC filter state */\r
212         SKP_memcpy( psDec->sLPC_Q14, &psDec->sLPC_Q14[ psDec->subfr_length ], MAX_LPC_ORDER * sizeof( SKP_int32 ) );\r
213         pexc_Q10 += psDec->subfr_length;\r
214         pxq      += psDec->subfr_length;\r
215     }\r
216     \r
217     /* Copy to output */\r
218     SKP_memcpy( xq, &psDec->outBuf[ psDec->ltp_mem_length ], psDec->frame_length * sizeof( SKP_int16 ) );\r
219 \r
220 #ifdef SAVE_ALL_INTERNAL_DATA\r
221     DEBUG_STORE_DATA( dec_sLTP_Q16.dat, &psDec->sLTP_Q16[ psDec->ltp_mem_length ], psDec->frame_length * sizeof( SKP_int32 ));\r
222     DEBUG_STORE_DATA( dec_xq.dat, xq, psDec->frame_length * sizeof( SKP_int16 ) );\r
223 #endif\r
224 }\r