Fix stack corruption with high rate SILK encoding added by the recent CBR changes...
[opus.git] / silk / float / encode_frame_FLP.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_FLP.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_FLP(
37     silk_encoder_state_FLP          *psEnc,             /* I/O  Encoder state FLP                       */
38     silk_encoder_control_FLP        *psEncCtrl,         /* I/O  Encoder control FLP                     */
39     const silk_float                 xfw[],              /* I    Input signal                            */
40     opus_int                         condCoding         /* I    The type of conditional coding used so far for this frame */
41 );
42
43 void silk_encode_do_VAD_FLP(
44     silk_encoder_state_FLP          *psEnc              /* I/O  Encoder state FLP                       */
45 )
46 {
47     /****************************/
48     /* Voice Activity Detection */
49     /****************************/
50 TIC(VAD)
51     silk_VAD_GetSA_Q8( &psEnc->sCmn, psEnc->sCmn.inputBuf + 1 );
52 TOC(VAD)
53
54     /**************************************************/
55     /* Convert speech activity into VAD and DTX flags */
56     /**************************************************/
57     if( psEnc->sCmn.nFramesEncoded == 0 ) {
58         psEnc->sCmn.inDTX = psEnc->sCmn.useDTX;
59     }
60     if( psEnc->sCmn.speech_activity_Q8 < SILK_FIX_CONST( SPEECH_ACTIVITY_DTX_THRES, 8 ) ) {
61         psEnc->sCmn.indices.signalType = TYPE_NO_VOICE_ACTIVITY;
62         psEnc->sCmn.noSpeechCounter++;
63         if( psEnc->sCmn.noSpeechCounter < NB_SPEECH_FRAMES_BEFORE_DTX ) {
64             psEnc->sCmn.inDTX = 0;
65         } else if( psEnc->sCmn.noSpeechCounter > MAX_CONSECUTIVE_DTX + NB_SPEECH_FRAMES_BEFORE_DTX ) {
66             psEnc->sCmn.noSpeechCounter = NB_SPEECH_FRAMES_BEFORE_DTX;
67             psEnc->sCmn.inDTX           = 0;
68         }
69         psEnc->sCmn.VAD_flags[ psEnc->sCmn.nFramesEncoded ] = 0;
70     } else {
71         psEnc->sCmn.noSpeechCounter    = 0;
72         psEnc->sCmn.inDTX              = 0;
73         psEnc->sCmn.indices.signalType = TYPE_UNVOICED;
74         psEnc->sCmn.VAD_flags[ psEnc->sCmn.nFramesEncoded ] = 1;
75     }
76 }
77
78 /****************/
79 /* Encode frame */
80 /****************/
81 opus_int silk_encode_frame_FLP(
82     silk_encoder_state_FLP          *psEnc,             /* I/O  Encoder state FLP                       */
83     opus_int32                       *pnBytesOut,        /*   O  Number of payload bytes                 */
84     ec_enc                          *psRangeEnc,        /* I/O  compressor data structure               */
85     opus_int                         condCoding,        /* I    The type of conditional coding to use   */
86     opus_int                         maxBits,           /* I    If > 0: maximum number of output bits   */
87     opus_int                         useCBR             /* I    Flag to force constant-bitrate operation */
88 )
89 {
90     silk_encoder_control_FLP sEncCtrl;
91     opus_int     i, iter, maxIter, found_upper, found_lower, ret = 0;
92     silk_float   *x_frame, *res_pitch_frame;
93     silk_float   xfw[ MAX_FRAME_LENGTH ];
94     silk_float   res_pitch[ 2 * MAX_FRAME_LENGTH + LA_PITCH_MAX ];
95     ec_enc       sRangeEnc_copy, sRangeEnc_copy2;
96     silk_nsq_state sNSQ_copy, sNSQ_copy2;
97     opus_int32   seed_copy, nBits, nBits_lower, nBits_upper, gainMult_lower, gainMult_upper;
98     opus_int16   gainMult_Q8;
99     opus_int16   ec_prevLagIndex_copy;
100     opus_int     ec_prevSignalType_copy;
101     opus_int8    LastGainIndex_copy2;
102     opus_int32   pGains_Q16[ MAX_NB_SUBFR ];
103     opus_uint8   ec_buf_copy[ 1275 ];
104
105 TIC(ENCODE_FRAME)
106
107     /* This is totally unnecessary but many compilers (including gcc) are too dumb
108        to realise it */
109     LastGainIndex_copy2 = nBits_lower = nBits_upper = gainMult_lower = gainMult_upper = 0;
110
111     psEnc->sCmn.indices.Seed = psEnc->sCmn.frameCounter++ & 3;
112
113     /**************************************************************/
114     /* Setup Input Pointers, and insert frame in input buffer    */
115     /*************************************************************/
116     /* pointers aligned with start of frame to encode */
117     x_frame         = psEnc->x_buf + psEnc->sCmn.ltp_mem_length;    /* start of frame to encode */
118     res_pitch_frame = res_pitch    + psEnc->sCmn.ltp_mem_length;    /* start of pitch LPC residual frame */
119
120     /***************************************/
121     /* Ensure smooth bandwidth transitions */
122     /***************************************/
123     silk_LP_variable_cutoff( &psEnc->sCmn.sLP, psEnc->sCmn.inputBuf + 1, psEnc->sCmn.frame_length );
124
125     /*******************************************/
126     /* Copy new frame to front of input buffer */
127     /*******************************************/
128     silk_short2float_array( x_frame + LA_SHAPE_MS * psEnc->sCmn.fs_kHz, psEnc->sCmn.inputBuf + 1, psEnc->sCmn.frame_length );
129
130     /* Add tiny signal to avoid high CPU load from denormalized floating point numbers */
131     for( i = 0; i < 8; i++ ) {
132         x_frame[ LA_SHAPE_MS * psEnc->sCmn.fs_kHz + i * ( psEnc->sCmn.frame_length >> 3 ) ] += ( 1 - ( i & 2 ) ) * 1e-6f;
133     }
134
135     /*****************************************/
136     /* Find pitch lags, initial LPC analysis */
137     /*****************************************/
138 TIC(FIND_PITCH)
139     silk_find_pitch_lags_FLP( psEnc, &sEncCtrl, res_pitch, x_frame );
140 TOC(FIND_PITCH)
141
142     /************************/
143     /* Noise shape analysis */
144     /************************/
145 TIC(NOISE_SHAPE_ANALYSIS)
146     silk_noise_shape_analysis_FLP( psEnc, &sEncCtrl, res_pitch_frame, x_frame );
147 TOC(NOISE_SHAPE_ANALYSIS)
148
149     /***************************************************/
150     /* Find linear prediction coefficients (LPC + LTP) */
151     /***************************************************/
152 TIC(FIND_PRED_COEF)
153     silk_find_pred_coefs_FLP( psEnc, &sEncCtrl, res_pitch, x_frame, condCoding );
154 TOC(FIND_PRED_COEF)
155
156     /****************************************/
157     /* Process gains                        */
158     /****************************************/
159 TIC(PROCESS_GAINS)
160     silk_process_gains_FLP( psEnc, &sEncCtrl, condCoding );
161 TOC(PROCESS_GAINS)
162
163     /*****************************************/
164     /* Prefiltering for noise shaper         */
165     /*****************************************/
166 TIC(PREFILTER)
167     silk_prefilter_FLP( psEnc, &sEncCtrl, xfw, x_frame );
168 TOC(PREFILTER)
169
170     /****************************************/
171     /* Low Bitrate Redundant Encoding       */
172     /****************************************/
173 TIC(LBRR)
174     silk_LBRR_encode_FLP( psEnc, &sEncCtrl, xfw, condCoding );
175 TOC(LBRR)
176
177     if ( psEnc->sCmn.prefillFlag )
178     {
179 TIC(NSQ)
180         silk_NSQ_wrapper_FLP( psEnc, &sEncCtrl, &psEnc->sCmn.indices, &psEnc->sCmn.sNSQ, psEnc->sCmn.pulses, xfw );
181 TOC(NSQ)
182     } else {
183         /* Loop over quantizer and entroy coding to control bitrate */
184         maxIter = 5;
185         gainMult_Q8 = SILK_FIX_CONST( 1, 8 );
186         found_lower = 0;
187         found_upper = 0;
188         for( iter = 0; ; iter++ ) {
189             /* Copy part of the input state */
190             silk_memcpy( &sRangeEnc_copy, psRangeEnc, sizeof( ec_enc ) );
191             silk_memcpy( &sNSQ_copy, &psEnc->sCmn.sNSQ, sizeof( silk_nsq_state ) );
192             seed_copy = psEnc->sCmn.indices.Seed;
193             ec_prevLagIndex_copy = psEnc->sCmn.ec_prevLagIndex;
194             ec_prevSignalType_copy = psEnc->sCmn.ec_prevSignalType;
195
196             /*****************************************/
197             /* Noise shaping quantization            */
198             /*****************************************/
199 TIC(NSQ)
200             silk_NSQ_wrapper_FLP( psEnc, &sEncCtrl, &psEnc->sCmn.indices, &psEnc->sCmn.sNSQ, psEnc->sCmn.pulses, xfw );
201 TOC(NSQ)
202
203             /****************************************/
204             /* Encode Parameters                    */
205             /****************************************/
206 TIC(ENCODE_PARAMS)
207             silk_encode_indices( &psEnc->sCmn, psRangeEnc, psEnc->sCmn.nFramesEncoded, 0, condCoding );
208 TOC(ENCODE_PARAMS)
209
210             /****************************************/
211             /* Encode Excitation Signal             */
212             /****************************************/
213 TIC(ENCODE_PULSES)
214             silk_encode_pulses( psRangeEnc, psEnc->sCmn.indices.signalType, psEnc->sCmn.indices.quantOffsetType,
215                   psEnc->sCmn.pulses, psEnc->sCmn.frame_length );
216 TOC(ENCODE_PULSES)
217
218             nBits = ec_tell( psRangeEnc );
219
220             if( useCBR == 0 && iter == 0 && nBits <= maxBits ) {
221                 break;
222             }
223
224             if( iter == maxIter ) {
225                 if( nBits > maxBits && found_lower ) {
226                     /* Restore output state from earlier iteration that did meet the bitrate budget */
227                    silk_memcpy( psRangeEnc, &sRangeEnc_copy2, sizeof( ec_enc ) );
228                    silk_assert( sRangeEnc_copy2.offs<=1275 );
229                    silk_memcpy( psRangeEnc->buf, ec_buf_copy, sRangeEnc_copy2.offs );
230                    silk_memcpy( &psEnc->sCmn.sNSQ, &sNSQ_copy2, sizeof( silk_nsq_state ) );
231                    psEnc->sShape.LastGainIndex = LastGainIndex_copy2;
232                 }
233                 break;
234             }
235
236             if( nBits > maxBits ) {
237                 found_upper = 1;
238                 nBits_upper = nBits;
239                 gainMult_upper = gainMult_Q8;
240                 if( found_lower == 0 && iter >= 3 ) {
241                     /* Adjust the quantizer's rate/distortion tradeoff */
242                     sEncCtrl.Lambda *= 1.5f;
243                 }
244             } else if( nBits < maxBits - 5 ) {
245                 found_lower = 1;
246                 nBits_lower = nBits;
247                 gainMult_lower = gainMult_Q8;
248                 /* Copy part of the output state */
249                 silk_memcpy( &sRangeEnc_copy2, psRangeEnc, sizeof( ec_enc ) );
250                 silk_assert( psRangeEnc->offs<=1275 );
251                 silk_memcpy( ec_buf_copy, psRangeEnc->buf, psRangeEnc->offs );
252                 silk_memcpy( &sNSQ_copy2, &psEnc->sCmn.sNSQ, sizeof( silk_nsq_state ) );
253                 LastGainIndex_copy2 = psEnc->sShape.LastGainIndex;
254             } else {
255                 /* Within 5 bits of budget: close enough */
256                 break;
257             }
258
259             if( ( found_lower & found_upper ) == 0 ) {
260                 /* Adjust gain according to high-rate rate/distortion curve */
261                 opus_int32 gain_factor_Q16;
262                 gain_factor_Q16 = silk_log2lin( silk_LSHIFT( nBits - maxBits, 7 ) / psEnc->sCmn.frame_length + SILK_FIX_CONST( 16, 7 ) );
263                 gain_factor_Q16 = silk_min_32(gain_factor_Q16, SILK_FIX_CONST( 2, 16 ) );
264                 if( nBits > maxBits ) {
265                     gain_factor_Q16 = silk_max_32( gain_factor_Q16, SILK_FIX_CONST( 1.3, 16 ) );
266                 }
267                 gainMult_Q8 = silk_SMULWB( gain_factor_Q16, gainMult_Q8 );
268             } else {
269                 /* Adjust gain by interpolating */
270                 gainMult_Q8 = gainMult_lower + ( ( gainMult_upper - gainMult_lower ) * ( maxBits - nBits_lower ) ) / ( nBits_upper - nBits_lower );
271                 /* New gain multplier must be between 25% and 75% of old range (note that gainMult_upper < gainMult_lower) */
272                 if( gainMult_Q8 > gainMult_lower + silk_RSHIFT32( gainMult_upper - gainMult_lower, 2 ) ) {
273                     gainMult_Q8 = gainMult_lower + silk_RSHIFT32( gainMult_upper - gainMult_lower, 2 );
274                 } else
275                     if( gainMult_Q8 < gainMult_upper - silk_RSHIFT32( gainMult_upper - gainMult_lower, 2 ) ) {
276                         gainMult_Q8 = gainMult_upper - silk_RSHIFT32( gainMult_upper - gainMult_lower, 2 );
277                     }
278             }
279
280             for( i = 0; i < psEnc->sCmn.nb_subfr; i++ ) {
281                 pGains_Q16[ i ] = silk_LSHIFT_SAT32( silk_SMULWB( sEncCtrl.GainsUnq_Q16[ i ], gainMult_Q8 ), 8 );
282             }
283             psEnc->sShape.LastGainIndex = sEncCtrl.lastGainIndexPrev;
284
285             /* Noise shaping quantization */
286             silk_gains_quant( psEnc->sCmn.indices.GainsIndices, pGains_Q16,
287                   &psEnc->sShape.LastGainIndex, condCoding == CODE_CONDITIONALLY, psEnc->sCmn.nb_subfr );
288
289             /* Overwrite unquantized gains with quantized gains and convert back to Q0 from Q16 */
290             for( i = 0; i < psEnc->sCmn.nb_subfr; i++ ) {
291                 sEncCtrl.Gains[ i ] = pGains_Q16[ i ] / 65536.0f;
292             }
293
294             /* Restore part of the input state */
295             silk_memcpy( psRangeEnc, &sRangeEnc_copy, sizeof( ec_enc ) );
296             silk_memcpy( &psEnc->sCmn.sNSQ, &sNSQ_copy, sizeof( silk_nsq_state ) );
297             psEnc->sCmn.indices.Seed = seed_copy;
298             psEnc->sCmn.ec_prevLagIndex = ec_prevLagIndex_copy;
299             psEnc->sCmn.ec_prevSignalType = ec_prevSignalType_copy;
300         }
301     }
302
303     /* Update input buffer */
304     silk_memmove( psEnc->x_buf, &psEnc->x_buf[ psEnc->sCmn.frame_length ],
305         ( psEnc->sCmn.ltp_mem_length + LA_SHAPE_MS * psEnc->sCmn.fs_kHz ) * sizeof( silk_float ) );
306
307     /* Parameters needed for next frame */
308     psEnc->sCmn.prevLag        = sEncCtrl.pitchL[ psEnc->sCmn.nb_subfr - 1 ];
309     psEnc->sCmn.prevSignalType = psEnc->sCmn.indices.signalType;
310
311     /* Exit without entropy coding */
312     if( psEnc->sCmn.prefillFlag ) {
313         /* No payload */
314         *pnBytesOut = 0;
315         return ret;
316     }
317
318     /****************************************/
319     /* Finalize payload                     */
320     /****************************************/
321     psEnc->sCmn.first_frame_after_reset = 0;
322     /* Payload size */
323     *pnBytesOut = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
324
325 TOC(ENCODE_FRAME)
326
327 #ifdef SAVE_ALL_INTERNAL_DATA
328     DEBUG_STORE_DATA( pitchL.dat,               sEncCtrl.pitchL,                                 MAX_NB_SUBFR * sizeof( opus_int   ) );
329     DEBUG_STORE_DATA( pitchG_quantized.dat,     sEncCtrl.LTPCoef,            psEnc->sCmn.nb_subfr * LTP_ORDER * sizeof( silk_float ) );
330     DEBUG_STORE_DATA( LTPcorr.dat,              &psEnc->LTPCorr,                                                sizeof( silk_float ) );
331     DEBUG_STORE_DATA( gains.dat,                sEncCtrl.Gains,                          psEnc->sCmn.nb_subfr * sizeof( silk_float ) );
332     DEBUG_STORE_DATA( gains_indices.dat,        &psEnc->sCmn.indices.GainsIndices,       psEnc->sCmn.nb_subfr * sizeof( opus_int8  ) );
333     DEBUG_STORE_DATA( quantOffsetType.dat,      &psEnc->sCmn.indices.quantOffsetType,                           sizeof( opus_int8  ) );
334     DEBUG_STORE_DATA( speech_activity_q8.dat,   &psEnc->sCmn.speech_activity_Q8,                                sizeof( opus_int   ) );
335     DEBUG_STORE_DATA( signalType.dat,           &psEnc->sCmn.indices.signalType,                                sizeof( opus_int8  ) );
336     DEBUG_STORE_DATA( lag_index.dat,            &psEnc->sCmn.indices.lagIndex,                                  sizeof( opus_int16 ) );
337     DEBUG_STORE_DATA( contour_index.dat,        &psEnc->sCmn.indices.contourIndex,                              sizeof( opus_int8  ) );
338     DEBUG_STORE_DATA( per_index.dat,            &psEnc->sCmn.indices.PERIndex,                                  sizeof( opus_int8  ) );
339     DEBUG_STORE_DATA( PredCoef.dat,             &sEncCtrl.PredCoef[ 1 ],          psEnc->sCmn.predictLPCOrder * sizeof( silk_float ) );
340     DEBUG_STORE_DATA( ltp_scale_idx.dat,        &psEnc->sCmn.indices.LTP_scaleIndex,                            sizeof( opus_int8   ) );
341 #endif
342     return ret;
343 }
344
345 /* Low-Bitrate Redundancy (LBRR) encoding. Reuse all parameters but encode excitation at lower bitrate  */
346 static inline void silk_LBRR_encode_FLP(
347     silk_encoder_state_FLP          *psEnc,             /* I/O  Encoder state FLP                       */
348     silk_encoder_control_FLP        *psEncCtrl,         /* I/O  Encoder control FLP                     */
349     const silk_float                 xfw[],              /* I    Input signal                            */
350     opus_int                         condCoding         /* I    The type of conditional coding used so far for this frame */
351 )
352 {
353     opus_int     k;
354     opus_int32   Gains_Q16[ MAX_NB_SUBFR ];
355     silk_float   TempGains[ MAX_NB_SUBFR ];
356     SideInfoIndices *psIndices_LBRR = &psEnc->sCmn.indices_LBRR[ psEnc->sCmn.nFramesEncoded ];
357     silk_nsq_state sNSQ_LBRR;
358
359     /*******************************************/
360     /* Control use of inband LBRR              */
361     /*******************************************/
362     if( psEnc->sCmn.LBRR_enabled && psEnc->sCmn.speech_activity_Q8 > SILK_FIX_CONST( LBRR_SPEECH_ACTIVITY_THRES, 8 ) ) {
363         psEnc->sCmn.LBRR_flags[ psEnc->sCmn.nFramesEncoded ] = 1;
364
365         /* Copy noise shaping quantizer state and quantization indices from regular encoding */
366         silk_memcpy( &sNSQ_LBRR, &psEnc->sCmn.sNSQ, sizeof( silk_nsq_state ) );
367         silk_memcpy( psIndices_LBRR, &psEnc->sCmn.indices, sizeof( SideInfoIndices ) );
368
369         /* Save original gains */
370         silk_memcpy( TempGains, psEncCtrl->Gains, psEnc->sCmn.nb_subfr * sizeof( silk_float ) );
371
372         if( psEnc->sCmn.nFramesEncoded == 0 || psEnc->sCmn.LBRR_flags[ psEnc->sCmn.nFramesEncoded - 1 ] == 0 ) {
373             /* First frame in packet or previous frame not LBRR coded */
374             psEnc->sCmn.LBRRprevLastGainIndex = psEnc->sShape.LastGainIndex;
375
376             /* Increase Gains to get target LBRR rate */
377             psIndices_LBRR->GainsIndices[ 0 ] += psEnc->sCmn.LBRR_GainIncreases;
378             psIndices_LBRR->GainsIndices[ 0 ] = silk_min_int( psIndices_LBRR->GainsIndices[ 0 ], N_LEVELS_QGAIN - 1 );
379         }
380
381         /* Decode to get gains in sync with decoder */
382         silk_gains_dequant( Gains_Q16, psIndices_LBRR->GainsIndices,
383             &psEnc->sCmn.LBRRprevLastGainIndex, condCoding == CODE_CONDITIONALLY, psEnc->sCmn.nb_subfr );
384
385         /* Overwrite unquantized gains with quantized gains and convert back to Q0 from Q16 */
386         for( k = 0; k <  psEnc->sCmn.nb_subfr; k++ ) {
387             psEncCtrl->Gains[ k ] = Gains_Q16[ k ] * ( 1.0f / 65536.0f );
388         }
389
390         /*****************************************/
391         /* Noise shaping quantization            */
392         /*****************************************/
393         silk_NSQ_wrapper_FLP( psEnc, psEncCtrl, psIndices_LBRR, &sNSQ_LBRR,
394             psEnc->sCmn.pulses_LBRR[ psEnc->sCmn.nFramesEncoded ], xfw );
395
396         /* Restore original gains */
397         silk_memcpy( psEncCtrl->Gains, TempGains, psEnc->sCmn.nb_subfr * sizeof( silk_float ) );
398     }
399 }