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