Fix fixed-point build bustage from 53cc1a03.
[opus.git] / silk / fixed / encode_frame_FIX.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_FIX.h"
33 #include "tuning_parameters.h"
34
35 /* Low Bitrate Redundancy (LBRR) encoding. Reuse all parameters but encode with lower bitrate           */
36 static inline void silk_LBRR_encode_FIX(
37     silk_encoder_state_FIX          *psEnc,             /* I/O  Pointer to Silk FIX encoder state           */
38     silk_encoder_control_FIX        *psEncCtrl,         /* I/O  Pointer to Silk FIX encoder control struct  */
39     const opus_int16                 xfw[],              /* I    Input signal                                */
40     opus_int                         condCoding         /* I    The type of conditional coding used so far for this frame */
41 );
42
43 /****************/
44 /* Encode frame */
45 /****************/
46 opus_int silk_encode_frame_FIX(
47     silk_encoder_state_FIX          *psEnc,             /* I/O  Encoder state FIX                       */
48     opus_int32                       *pnBytesOut,        /*   O  Number of payload bytes                 */
49     ec_enc                          *psRangeEnc,        /* I/O  compressor data structure               */
50     opus_int                         condCoding         /* I    The type of conditional coding to use   */
51 )
52 {
53     silk_encoder_control_FIX sEncCtrl;
54     opus_int     ret = 0;
55     opus_int16   *x_frame, *res_pitch_frame;
56     opus_int16   xfw[ MAX_FRAME_LENGTH ];
57     opus_int16   res_pitch[ 2 * MAX_FRAME_LENGTH + LA_PITCH_MAX ];
58
59 TIC(ENCODE_FRAME)
60
61     psEnc->sCmn.indices.Seed = psEnc->sCmn.frameCounter++ & 3;
62
63     /**************************************************************/
64     /* Setup Input Pointers, and insert frame in input buffer    */
65     /*************************************************************/
66     /* pointers aligned with start of frame to encode */
67     x_frame         = psEnc->x_buf + psEnc->sCmn.ltp_mem_length;    /* start of frame to encode */
68     res_pitch_frame = res_pitch    + psEnc->sCmn.ltp_mem_length;    /* start of pitch LPC residual frame */
69
70     /****************************/
71     /* Voice Activity Detection */
72     /****************************/
73 TIC(VAD)
74     ret = silk_VAD_GetSA_Q8( &psEnc->sCmn, psEnc->sCmn.inputBuf + 1 );
75 TOC(VAD)
76
77     /**************************************************/
78     /* Convert speech activity into VAD and DTX flags */
79     /**************************************************/
80     if( psEnc->sCmn.speech_activity_Q8 < SILK_FIX_CONST( SPEECH_ACTIVITY_DTX_THRES, 8 ) ) {
81         psEnc->sCmn.indices.signalType = TYPE_NO_VOICE_ACTIVITY;
82         psEnc->sCmn.noSpeechCounter++;
83         if( psEnc->sCmn.noSpeechCounter < NB_SPEECH_FRAMES_BEFORE_DTX ) {
84             psEnc->sCmn.inDTX = 0;
85         } else if( psEnc->sCmn.noSpeechCounter > MAX_CONSECUTIVE_DTX + NB_SPEECH_FRAMES_BEFORE_DTX ) {
86             psEnc->sCmn.noSpeechCounter = NB_SPEECH_FRAMES_BEFORE_DTX;
87             psEnc->sCmn.inDTX           = 0;
88         }
89         psEnc->sCmn.VAD_flags[ psEnc->sCmn.nFramesEncoded ] = 0;
90     } else {
91         psEnc->sCmn.noSpeechCounter    = 0;
92         psEnc->sCmn.inDTX              = 0;
93         psEnc->sCmn.indices.signalType = TYPE_UNVOICED;
94         psEnc->sCmn.VAD_flags[ psEnc->sCmn.nFramesEncoded ] = 1;
95     }
96
97     /***************************************/
98     /* Ensure smooth bandwidth transitions */
99     /***************************************/
100     silk_LP_variable_cutoff( &psEnc->sCmn.sLP, psEnc->sCmn.inputBuf + 1, psEnc->sCmn.frame_length );
101
102     /*******************************************/
103     /* Copy new frame to front of input buffer */
104     /*******************************************/
105     silk_memcpy( x_frame + LA_SHAPE_MS * psEnc->sCmn.fs_kHz, psEnc->sCmn.inputBuf + 1, psEnc->sCmn.frame_length * sizeof( opus_int16 ) );
106
107     /*****************************************/
108     /* Find pitch lags, initial LPC analysis */
109     /*****************************************/
110 TIC(FIND_PITCH)
111     silk_find_pitch_lags_FIX( psEnc, &sEncCtrl, res_pitch, x_frame );
112 TOC(FIND_PITCH)
113
114     /************************/
115     /* Noise shape analysis */
116     /************************/
117 TIC(NOISE_SHAPE_ANALYSIS)
118     silk_noise_shape_analysis_FIX( psEnc, &sEncCtrl, res_pitch_frame, x_frame );
119 TOC(NOISE_SHAPE_ANALYSIS)
120
121     /***************************************************/
122     /* Find linear prediction coefficients (LPC + LTP) */
123     /***************************************************/
124 TIC(FIND_PRED_COEF)
125     silk_find_pred_coefs_FIX( psEnc, &sEncCtrl, res_pitch, x_frame, condCoding );
126 TOC(FIND_PRED_COEF)
127
128     /****************************************/
129     /* Process gains                        */
130     /****************************************/
131 TIC(PROCESS_GAINS)
132     silk_process_gains_FIX( psEnc, &sEncCtrl, condCoding );
133 TOC(PROCESS_GAINS)
134
135     /*****************************************/
136     /* Prefiltering for noise shaper         */
137     /*****************************************/
138 TIC(PREFILTER)
139     silk_prefilter_FIX( psEnc, &sEncCtrl, xfw, x_frame );
140 TOC(PREFILTER)
141
142     /****************************************/
143     /* Low Bitrate Redundant Encoding       */
144     /****************************************/
145 TIC(LBRR)
146     silk_LBRR_encode_FIX( psEnc, &sEncCtrl, xfw, condCoding );
147 TOC(LBRR)
148
149     /*****************************************/
150     /* Noise shaping quantization            */
151     /*****************************************/
152 TIC(NSQ)
153     if( psEnc->sCmn.nStatesDelayedDecision > 1 || psEnc->sCmn.warping_Q16 > 0 ) {
154         silk_NSQ_del_dec( &psEnc->sCmn, &psEnc->sCmn.sNSQ, &psEnc->sCmn.indices, xfw, psEnc->sCmn.pulses,
155             sEncCtrl.PredCoef_Q12[ 0 ], sEncCtrl.LTPCoef_Q14, sEncCtrl.AR2_Q13, sEncCtrl.HarmShapeGain_Q14,
156             sEncCtrl.Tilt_Q14, sEncCtrl.LF_shp_Q14, sEncCtrl.Gains_Q16, sEncCtrl.pitchL, sEncCtrl.Lambda_Q10, sEncCtrl.LTP_scale_Q14 );
157     } else {
158         silk_NSQ( &psEnc->sCmn, &psEnc->sCmn.sNSQ, &psEnc->sCmn.indices, xfw, psEnc->sCmn.pulses,
159             sEncCtrl.PredCoef_Q12[ 0 ], sEncCtrl.LTPCoef_Q14, sEncCtrl.AR2_Q13, sEncCtrl.HarmShapeGain_Q14,
160             sEncCtrl.Tilt_Q14, sEncCtrl.LF_shp_Q14, sEncCtrl.Gains_Q16, sEncCtrl.pitchL, sEncCtrl.Lambda_Q10, sEncCtrl.LTP_scale_Q14 );
161     }
162 TOC(NSQ)
163
164     /* Update input buffer */
165     silk_memmove( psEnc->x_buf, &psEnc->x_buf[ psEnc->sCmn.frame_length ],
166         ( psEnc->sCmn.ltp_mem_length + LA_SHAPE_MS * psEnc->sCmn.fs_kHz ) * sizeof( opus_int16 ) );
167
168     /* Parameters needed for next frame */
169     psEnc->sCmn.prevLag        = sEncCtrl.pitchL[ psEnc->sCmn.nb_subfr - 1 ];
170     psEnc->sCmn.prevSignalType = psEnc->sCmn.indices.signalType;
171
172     /* Exit without entropy coding */
173     if( psEnc->sCmn.prefillFlag ) {
174         /* No payload */
175         *pnBytesOut = 0;
176         return ret;
177     }
178
179     /****************************************/
180     /* Encode Parameters                    */
181     /****************************************/
182 TIC(ENCODE_PARAMS)
183     silk_encode_indices( &psEnc->sCmn, psRangeEnc, psEnc->sCmn.nFramesEncoded, 0, condCoding );
184 TOC(ENCODE_PARAMS)
185
186     /****************************************/
187     /* Encode Excitation Signal             */
188     /****************************************/
189 TIC(ENCODE_PULSES)
190     silk_encode_pulses( psRangeEnc, psEnc->sCmn.indices.signalType, psEnc->sCmn.indices.quantOffsetType,
191         psEnc->sCmn.pulses, psEnc->sCmn.frame_length );
192 TOC(ENCODE_PULSES)
193
194     /****************************************/
195     /* Finalize payload                     */
196     /****************************************/
197     psEnc->sCmn.first_frame_after_reset = 0;
198     /* Payload size */
199     *pnBytesOut = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
200 TOC(ENCODE_FRAME)
201
202 #ifdef SAVE_ALL_INTERNAL_DATA
203     {
204         silk_float tmp[ MAX_NB_SUBFR * LTP_ORDER ];
205         int i;
206         DEBUG_STORE_DATA( xf.dat,                   x_frame + LA_SHAPE_MS * psEnc->sCmn.fs_kHz, psEnc->sCmn.frame_length * sizeof( opus_int16 ) );
207         DEBUG_STORE_DATA( xfw.dat,                  xfw,                            psEnc->sCmn.frame_length    * sizeof( opus_int16 ) );
208         DEBUG_STORE_DATA( pitchL.dat,               sEncCtrl.pitchL,                psEnc->sCmn.nb_subfr        * sizeof( opus_int ) );
209         for( i = 0; i < psEnc->sCmn.nb_subfr * LTP_ORDER; i++ ) {
210             tmp[ i ] = (silk_float)sEncCtrl.LTPCoef_Q14[ i ] / 16384.0f;
211         }
212         DEBUG_STORE_DATA( pitchG_quantized.dat,     tmp,                            psEnc->sCmn.nb_subfr * LTP_ORDER * sizeof( silk_float ) );
213         for( i = 0; i <psEnc->sCmn.predictLPCOrder; i++ ) {
214             tmp[ i ] = (silk_float)sEncCtrl.PredCoef_Q12[ 1 ][ i ] / 4096.0f;
215         }
216         DEBUG_STORE_DATA( PredCoef.dat,             tmp,                            psEnc->sCmn.predictLPCOrder * sizeof( silk_float ) );
217
218         tmp[ 0 ] = (silk_float)sEncCtrl.LTPredCodGain_Q7 / 128.0f;
219         DEBUG_STORE_DATA( LTPredCodGain.dat,        tmp,                            sizeof( silk_float ) );
220         tmp[ 0 ] = (silk_float)psEnc->LTPCorr_Q15 / 32768.0f;
221         DEBUG_STORE_DATA( LTPcorr.dat,              tmp,                            sizeof( silk_float ) );
222         tmp[ 0 ] = (silk_float)psEnc->sCmn.input_tilt_Q15 / 32768.0f;
223         DEBUG_STORE_DATA( tilt.dat,                 tmp,                            sizeof( silk_float ) );
224         for( i = 0; i < psEnc->sCmn.nb_subfr; i++ ) {
225             tmp[ i ] = (silk_float)sEncCtrl.Gains_Q16[ i ] / 65536.0f;
226         }
227         DEBUG_STORE_DATA( gains.dat,                tmp,                            psEnc->sCmn.nb_subfr * sizeof( silk_float ) );
228         DEBUG_STORE_DATA( gains_indices.dat,        &psEnc->sCmn.indices.GainsIndices, psEnc->sCmn.nb_subfr * sizeof( opus_int ) );
229         tmp[ 0 ] = (silk_float)sEncCtrl.current_SNR_dB_Q7 / 128.0f;
230         DEBUG_STORE_DATA( current_SNR_db.dat,       tmp,                            sizeof( silk_float ) );
231         DEBUG_STORE_DATA( quantOffsetType.dat,      &psEnc->sCmn.indices.quantOffsetType, sizeof( opus_int ) );
232         tmp[ 0 ] = (silk_float)psEnc->sCmn.speech_activity_Q8 / 256.0f;
233         DEBUG_STORE_DATA( speech_activity.dat,      tmp,                            sizeof( silk_float ) );
234         for( i = 0; i < VAD_N_BANDS; i++ ) {
235             tmp[ i ] = (silk_float)psEnc->sCmn.input_quality_bands_Q15[ i ] / 32768.0f;
236         }
237         DEBUG_STORE_DATA( input_quality_bands.dat,  tmp,                       VAD_N_BANDS * sizeof( silk_float ) );
238         DEBUG_STORE_DATA( signalType.dat,           &psEnc->sCmn.indices.signalType,         sizeof( opus_int8) );
239         DEBUG_STORE_DATA( lag_index.dat,            &psEnc->sCmn.indices.lagIndex,           sizeof( opus_int16 ) );
240         DEBUG_STORE_DATA( contour_index.dat,        &psEnc->sCmn.indices.contourIndex,       sizeof( opus_int8 ) );
241         DEBUG_STORE_DATA( per_index.dat,            &psEnc->sCmn.indices.PERIndex,           sizeof( opus_int8) );
242     }
243 #endif
244     return ret;
245 }
246
247 /* Low-Bitrate Redundancy (LBRR) encoding. Reuse all parameters but encode excitation at lower bitrate  */
248 void silk_LBRR_encode_FIX(
249     silk_encoder_state_FIX          *psEnc,         /* I/O  Pointer to Silk FIX encoder state           */
250     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  Pointer to Silk FIX encoder control struct  */
251     const opus_int16                 xfw[],          /* I    Input signal                                */
252     opus_int                         condCoding     /* I    The type of conditional coding used so far for this frame */
253 )
254 {
255     opus_int32   TempGains_Q16[ MAX_NB_SUBFR ];
256     SideInfoIndices *psIndices_LBRR = &psEnc->sCmn.indices_LBRR[ psEnc->sCmn.nFramesEncoded ];
257     silk_nsq_state sNSQ_LBRR;
258
259     /*******************************************/
260     /* Control use of inband LBRR              */
261     /*******************************************/
262     if( psEnc->sCmn.LBRR_enabled && psEnc->sCmn.speech_activity_Q8 > SILK_FIX_CONST( LBRR_SPEECH_ACTIVITY_THRES, 8 ) ) {
263         psEnc->sCmn.LBRR_flags[ psEnc->sCmn.nFramesEncoded ] = 1;
264
265         /* Copy noise shaping quantizer state and quantization indices from regular encoding */
266         silk_memcpy( &sNSQ_LBRR, &psEnc->sCmn.sNSQ, sizeof( silk_nsq_state ) );
267         silk_memcpy( psIndices_LBRR, &psEnc->sCmn.indices, sizeof( SideInfoIndices ) );
268
269         /* Save original gains */
270         silk_memcpy( TempGains_Q16, psEncCtrl->Gains_Q16, psEnc->sCmn.nb_subfr * sizeof( opus_int32 ) );
271
272         if( psEnc->sCmn.nFramesEncoded == 0 || psEnc->sCmn.LBRR_flags[ psEnc->sCmn.nFramesEncoded - 1 ] == 0 ) {
273             /* First frame in packet or previous frame not LBRR coded */
274             psEnc->sCmn.LBRRprevLastGainIndex = psEnc->sShape.LastGainIndex;
275
276             /* Increase Gains to get target LBRR rate */
277             psIndices_LBRR->GainsIndices[ 0 ] = psIndices_LBRR->GainsIndices[ 0 ] + psEnc->sCmn.LBRR_GainIncreases;
278             psIndices_LBRR->GainsIndices[ 0 ] = silk_min_int( psIndices_LBRR->GainsIndices[ 0 ], N_LEVELS_QGAIN - 1 );
279         }
280
281         /* Decode to get gains in sync with decoder         */
282         /* Overwrite unquantized gains with quantized gains */
283         silk_gains_dequant( psEncCtrl->Gains_Q16, psIndices_LBRR->GainsIndices,
284             &psEnc->sCmn.LBRRprevLastGainIndex, condCoding == CODE_CONDITIONALLY, psEnc->sCmn.nb_subfr );
285
286         /*****************************************/
287         /* Noise shaping quantization            */
288         /*****************************************/
289         if( psEnc->sCmn.nStatesDelayedDecision > 1 || psEnc->sCmn.warping_Q16 > 0 ) {
290             silk_NSQ_del_dec( &psEnc->sCmn, &sNSQ_LBRR, psIndices_LBRR, xfw,
291                 psEnc->sCmn.pulses_LBRR[ psEnc->sCmn.nFramesEncoded ], psEncCtrl->PredCoef_Q12[ 0 ], psEncCtrl->LTPCoef_Q14,
292                 psEncCtrl->AR2_Q13, psEncCtrl->HarmShapeGain_Q14, psEncCtrl->Tilt_Q14, psEncCtrl->LF_shp_Q14,
293                 psEncCtrl->Gains_Q16, psEncCtrl->pitchL, psEncCtrl->Lambda_Q10, psEncCtrl->LTP_scale_Q14 );
294         } else {
295             silk_NSQ( &psEnc->sCmn, &sNSQ_LBRR, psIndices_LBRR, xfw,
296                 psEnc->sCmn.pulses_LBRR[ psEnc->sCmn.nFramesEncoded ], psEncCtrl->PredCoef_Q12[ 0 ], psEncCtrl->LTPCoef_Q14,
297                 psEncCtrl->AR2_Q13, psEncCtrl->HarmShapeGain_Q14, psEncCtrl->Tilt_Q14, psEncCtrl->LF_shp_Q14,
298                 psEncCtrl->Gains_Q16, psEncCtrl->pitchL, psEncCtrl->Lambda_Q10, psEncCtrl->LTP_scale_Q14 );
299         }
300
301         /* Restore original gains */
302         silk_memcpy( psEncCtrl->Gains_Q16, TempGains_Q16, psEnc->sCmn.nb_subfr * sizeof( opus_int32 ) );
303     }
304 }