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