Improves the accuracy such that it matches a float decoder much better
[opus.git] / silk / decode_core.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 /* Core decoder. Performs inverse NSQ operation LTP + LPC */
36 /**********************************************************/
37 void silk_decode_core(
38     silk_decoder_state          *psDec,                         /* I/O  Decoder state                               */
39     silk_decoder_control        *psDecCtrl,                     /* I    Decoder control                             */
40     opus_int16                  xq[],                           /* O    Decoded speech                              */
41     const opus_int              pulses[ MAX_FRAME_LENGTH ]      /* I    Pulse signal                                */
42 )
43 {
44     opus_int   i, k, lag = 0, start_idx, sLTP_buf_idx, NLSF_interpolation_flag, signalType;
45     opus_int16 *A_Q12, *B_Q14, *pxq, A_Q12_tmp[ MAX_LPC_ORDER ];
46     opus_int16 sLTP[ MAX_FRAME_LENGTH ];
47     opus_int32 sLTP_Q15[ 2 * MAX_FRAME_LENGTH ];
48     opus_int32 LTP_pred_Q13, LPC_pred_Q10, Gain_Q10, inv_gain_Q31, gain_adj_Q16, rand_seed, offset_Q10;
49     opus_int32 *pred_lag_ptr, *pexc_Q10, *pres_Q10;
50     opus_int32 res_Q10[ MAX_SUB_FRAME_LENGTH ];
51     opus_int32 sLPC_Q14[ MAX_SUB_FRAME_LENGTH + MAX_LPC_ORDER ];
52
53     silk_assert( psDec->prev_inv_gain_Q31 != 0 );
54
55     offset_Q10 = silk_Quantization_Offsets_Q10[ psDec->indices.signalType >> 1 ][ psDec->indices.quantOffsetType ];
56
57     if( psDec->indices.NLSFInterpCoef_Q2 < 1 << 2 ) {
58         NLSF_interpolation_flag = 1;
59     } else {
60         NLSF_interpolation_flag = 0;
61     }
62
63     /* Decode excitation */
64     rand_seed = psDec->indices.Seed;
65     for( i = 0; i < psDec->frame_length; i++ ) {
66         rand_seed = silk_RAND( rand_seed );
67         psDec->exc_Q10[ i ] = silk_LSHIFT( (opus_int32)pulses[ i ], 10 );
68         if( psDec->exc_Q10[ i ] > 0 ) {
69             psDec->exc_Q10[ i ] -= QUANT_LEVEL_ADJUST_Q10;
70         } else
71         if( psDec->exc_Q10[ i ] < 0 ) {
72             psDec->exc_Q10[ i ] += QUANT_LEVEL_ADJUST_Q10;
73         }
74         psDec->exc_Q10[ i ] += offset_Q10;
75         psDec->exc_Q10[ i ] ^= silk_RSHIFT( rand_seed, 31 );
76
77         rand_seed = silk_ADD32_ovflw(rand_seed, pulses[ i ]);
78     }
79
80     /* Copy LPC state */
81     silk_memcpy( sLPC_Q14, psDec->sLPC_Q14_buf, MAX_LPC_ORDER * sizeof( opus_int32 ) );
82
83     pexc_Q10 = psDec->exc_Q10;
84     pxq      = xq;
85     sLTP_buf_idx = psDec->ltp_mem_length;
86     /* Loop over subframes */
87     for( k = 0; k < psDec->nb_subfr; k++ ) {
88         pres_Q10 = res_Q10;
89         A_Q12 = psDecCtrl->PredCoef_Q12[ k >> 1 ];
90
91         /* Preload LPC coeficients to array on stack. Gives small performance gain */
92         silk_memcpy( A_Q12_tmp, A_Q12, psDec->LPC_order * sizeof( opus_int16 ) );
93         B_Q14        = &psDecCtrl->LTPCoef_Q14[ k * LTP_ORDER ];
94         signalType   = psDec->indices.signalType;
95
96         Gain_Q10     = silk_RSHIFT( psDecCtrl->Gains_Q16[ k ], 6 );
97         inv_gain_Q31 = silk_INVERSE32_varQ( psDecCtrl->Gains_Q16[ k ], 47 );
98
99         /* Calculate gain adjustment factor */
100         if( inv_gain_Q31 != psDec->prev_inv_gain_Q31 ) {
101             gain_adj_Q16 =  silk_DIV32_varQ( inv_gain_Q31, psDec->prev_inv_gain_Q31, 16 );
102
103             /* Scale short term state */
104             for( i = 0; i < MAX_LPC_ORDER; i++ ) {
105                 sLPC_Q14[ i ] = silk_SMULWW( gain_adj_Q16, sLPC_Q14[ i ] );
106             }
107         } else {
108             gain_adj_Q16 = 1 << 16;
109         }
110
111         /* Save inv_gain */
112         silk_assert( inv_gain_Q31 != 0 );
113         psDec->prev_inv_gain_Q31 = inv_gain_Q31;
114
115         /* Avoid abrupt transition from voiced PLC to unvoiced normal decoding */
116         if( psDec->lossCnt && psDec->prevSignalType == TYPE_VOICED &&
117             psDec->indices.signalType != TYPE_VOICED && k < MAX_NB_SUBFR/2 ) {
118
119             silk_memset( B_Q14, 0, LTP_ORDER * sizeof( opus_int16 ) );
120             B_Q14[ LTP_ORDER/2 ] = SILK_FIX_CONST( 0.25, 14 );
121
122             signalType = TYPE_VOICED;
123             psDecCtrl->pitchL[ k ] = psDec->lagPrev;
124         }
125
126         if( signalType == TYPE_VOICED ) {
127             /* Voiced */
128             lag = psDecCtrl->pitchL[ k ];
129
130             /* Re-whitening */
131             if( k == 0 || ( k == 2 && NLSF_interpolation_flag ) ) {
132                 /* Rewhiten with new A coefs */
133                 start_idx = psDec->ltp_mem_length - lag - psDec->LPC_order - LTP_ORDER / 2;
134                 silk_assert( start_idx > 0 );
135
136                 if( k == 2 ) {
137                     silk_memcpy( &psDec->outBuf[ psDec->ltp_mem_length ], xq, 2 * psDec->subfr_length * sizeof( opus_int16 ) );
138                 }
139
140                 silk_LPC_analysis_filter( &sLTP[ start_idx ], &psDec->outBuf[ start_idx + k * psDec->subfr_length ],
141                     A_Q12, psDec->ltp_mem_length - start_idx, psDec->LPC_order );
142
143                 /* After rewhitening the LTP state is unscaled */
144                 if( k == 0 ) {
145                     /* Do LTP downscaling to reduce inter-packet dependency */
146                     inv_gain_Q31 = silk_LSHIFT( silk_SMULWB( inv_gain_Q31, psDecCtrl->LTP_scale_Q14 ), 2 );
147                 }
148                 for( i = 0; i < lag + LTP_ORDER/2; i++ ) {
149                     sLTP_Q15[ sLTP_buf_idx - i - 1 ] = silk_SMULWB( inv_gain_Q31, sLTP[ psDec->ltp_mem_length - i - 1 ] );
150                 }
151             } else {
152                 /* Update LTP state when Gain changes */
153                 if( gain_adj_Q16 != 1 << 16 ) {
154                     for( i = 0; i < lag + LTP_ORDER/2; i++ ) {
155                         sLTP_Q15[ sLTP_buf_idx - i - 1 ] = silk_SMULWW( gain_adj_Q16, sLTP_Q15[ sLTP_buf_idx - i - 1 ] );
156                     }
157                 }
158             }
159         }
160
161         /* Long-term prediction */
162         if( signalType == TYPE_VOICED ) {
163             /* Set up pointer */
164             pred_lag_ptr = &sLTP_Q15[ sLTP_buf_idx - lag + LTP_ORDER / 2 ];
165             for( i = 0; i < psDec->subfr_length; i++ ) {
166                 /* Unrolled loop */
167                 /* Avoids introducing a bias because silk_SMLAWB() always rounds to -inf */
168                 LTP_pred_Q13 = 2;
169                 LTP_pred_Q13 = silk_SMLAWB( LTP_pred_Q13, pred_lag_ptr[  0 ], B_Q14[ 0 ] );
170                 LTP_pred_Q13 = silk_SMLAWB( LTP_pred_Q13, pred_lag_ptr[ -1 ], B_Q14[ 1 ] );
171                 LTP_pred_Q13 = silk_SMLAWB( LTP_pred_Q13, pred_lag_ptr[ -2 ], B_Q14[ 2 ] );
172                 LTP_pred_Q13 = silk_SMLAWB( LTP_pred_Q13, pred_lag_ptr[ -3 ], B_Q14[ 3 ] );
173                 LTP_pred_Q13 = silk_SMLAWB( LTP_pred_Q13, pred_lag_ptr[ -4 ], B_Q14[ 4 ] );
174                 pred_lag_ptr++;
175
176                 /* Generate LPC excitation */
177                 pres_Q10[ i ] = silk_ADD32( pexc_Q10[ i ], silk_RSHIFT_ROUND( LTP_pred_Q13, 3 ) );
178
179                 /* Update states */
180                 sLTP_Q15[ sLTP_buf_idx ] = silk_LSHIFT( pres_Q10[ i ], 5 );
181                 sLTP_buf_idx++;
182             }
183         } else {
184             pres_Q10 = pexc_Q10;
185         }
186
187         for( i = 0; i < psDec->subfr_length; i++ ) {
188             /* Short-term prediction */
189             silk_assert( psDec->LPC_order == 10 || psDec->LPC_order == 16 );
190             /* Avoids introducing a bias because silk_SMLAWB() always rounds to -inf */
191             LPC_pred_Q10 = silk_RSHIFT( psDec->LPC_order, 1 );
192             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  1 ], A_Q12_tmp[ 0 ] );
193             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  2 ], A_Q12_tmp[ 1 ] );
194             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  3 ], A_Q12_tmp[ 2 ] );
195             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  4 ], A_Q12_tmp[ 3 ] );
196             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  5 ], A_Q12_tmp[ 4 ] );
197             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  6 ], A_Q12_tmp[ 5 ] );
198             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  7 ], A_Q12_tmp[ 6 ] );
199             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  8 ], A_Q12_tmp[ 7 ] );
200             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i -  9 ], A_Q12_tmp[ 8 ] );
201             LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i - 10 ], A_Q12_tmp[ 9 ] );
202             if( psDec->LPC_order == 16 ) {
203                 LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i - 11 ], A_Q12_tmp[ 10 ] );
204                 LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i - 12 ], A_Q12_tmp[ 11 ] );
205                 LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i - 13 ], A_Q12_tmp[ 12 ] );
206                 LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i - 14 ], A_Q12_tmp[ 13 ] );
207                 LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i - 15 ], A_Q12_tmp[ 14 ] );
208                 LPC_pred_Q10 = silk_SMLAWB( LPC_pred_Q10, sLPC_Q14[ MAX_LPC_ORDER + i - 16 ], A_Q12_tmp[ 15 ] );
209             }
210
211             /* Add prediction to LPC excitation */
212             sLPC_Q14[ MAX_LPC_ORDER + i ] = silk_LSHIFT( silk_ADD32( pres_Q10[ i ], LPC_pred_Q10 ), 4 );
213
214             /* Scale with gain */
215             pxq[ i ] = (opus_int16)silk_SAT16( silk_RSHIFT_ROUND( silk_SMULWW( sLPC_Q14[ MAX_LPC_ORDER + i ], Gain_Q10 ), 8 ) );
216         }
217
218         /* DEBUG_STORE_DATA( dec.pcm, pxq, psDec->subfr_length * sizeof( opus_int16 ) ) */
219
220         /* Update LPC filter state */
221         silk_memcpy( sLPC_Q14, &sLPC_Q14[ psDec->subfr_length ], MAX_LPC_ORDER * sizeof( opus_int32 ) );
222         pexc_Q10 += psDec->subfr_length;
223         pxq      += psDec->subfr_length;
224     }
225
226     /* Save LPC state */
227     silk_memcpy( psDec->sLPC_Q14_buf, sLPC_Q14, MAX_LPC_ORDER * sizeof( opus_int32 ) );
228 }