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