Fix NEON optimizations buffer read overrun
[opus.git] / silk / float / process_gains_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, are permitted provided that the following conditions
5 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 Internet Society, IETF or IETF Trust, nor the
12 names of specific contributors, may be used to endorse or promote
13 products derived from this software without specific prior written
14 permission.
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 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 /* Processing of gains */
36 void silk_process_gains_FLP(
37     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
38     silk_encoder_control_FLP        *psEncCtrl,                         /* I/O  Encoder control FLP                         */
39     opus_int                        condCoding                          /* I    The type of conditional coding to use       */
40 )
41 {
42     silk_shape_state_FLP *psShapeSt = &psEnc->sShape;
43     opus_int     k;
44     opus_int32   pGains_Q16[ MAX_NB_SUBFR ];
45     silk_float   s, InvMaxSqrVal, gain, quant_offset;
46
47     /* Gain reduction when LTP coding gain is high */
48     if( psEnc->sCmn.indices.signalType == TYPE_VOICED ) {
49         s = 1.0f - 0.5f * silk_sigmoid( 0.25f * ( psEncCtrl->LTPredCodGain - 12.0f ) );
50         for( k = 0; k < psEnc->sCmn.nb_subfr; k++ ) {
51             psEncCtrl->Gains[ k ] *= s;
52         }
53     }
54
55     /* Limit the quantized signal */
56     InvMaxSqrVal = ( silk_float )( pow( 2.0f, 0.33f * ( 21.0f - psEnc->sCmn.SNR_dB_Q7 * ( 1 / 128.0f ) ) ) / psEnc->sCmn.subfr_length );
57
58     for( k = 0; k < psEnc->sCmn.nb_subfr; k++ ) {
59         /* Soft limit on ratio residual energy and squared gains */
60         gain = psEncCtrl->Gains[ k ];
61         gain = ( silk_float )sqrt( gain * gain + psEncCtrl->ResNrg[ k ] * InvMaxSqrVal );
62         psEncCtrl->Gains[ k ] = silk_min_float( gain, 32767.0f );
63     }
64
65     /* Prepare gains for noise shaping quantization */
66     for( k = 0; k < psEnc->sCmn.nb_subfr; k++ ) {
67         pGains_Q16[ k ] = (opus_int32)( psEncCtrl->Gains[ k ] * 65536.0f );
68     }
69
70     /* Save unquantized gains and gain Index */
71     silk_memcpy( psEncCtrl->GainsUnq_Q16, pGains_Q16, psEnc->sCmn.nb_subfr * sizeof( opus_int32 ) );
72     psEncCtrl->lastGainIndexPrev = psShapeSt->LastGainIndex;
73
74     /* Quantize gains */
75     silk_gains_quant( psEnc->sCmn.indices.GainsIndices, pGains_Q16,
76             &psShapeSt->LastGainIndex, condCoding == CODE_CONDITIONALLY, psEnc->sCmn.nb_subfr );
77
78     /* Overwrite unquantized gains with quantized gains and convert back to Q0 from Q16 */
79     for( k = 0; k < psEnc->sCmn.nb_subfr; k++ ) {
80         psEncCtrl->Gains[ k ] = pGains_Q16[ k ] / 65536.0f;
81     }
82
83     /* Set quantizer offset for voiced signals. Larger offset when LTP coding gain is low or tilt is high (ie low-pass) */
84     if( psEnc->sCmn.indices.signalType == TYPE_VOICED ) {
85         if( psEncCtrl->LTPredCodGain + psEnc->sCmn.input_tilt_Q15 * ( 1.0f / 32768.0f ) > 1.0f ) {
86             psEnc->sCmn.indices.quantOffsetType = 0;
87         } else {
88             psEnc->sCmn.indices.quantOffsetType = 1;
89         }
90     }
91
92     /* Quantizer boundary adjustment */
93     quant_offset = silk_Quantization_Offsets_Q10[ psEnc->sCmn.indices.signalType >> 1 ][ psEnc->sCmn.indices.quantOffsetType ] / 1024.0f;
94     psEncCtrl->Lambda = LAMBDA_OFFSET
95                       + LAMBDA_DELAYED_DECISIONS * psEnc->sCmn.nStatesDelayedDecision
96                       + LAMBDA_SPEECH_ACT        * psEnc->sCmn.speech_activity_Q8 * ( 1.0f /  256.0f )
97                       + LAMBDA_INPUT_QUALITY     * psEncCtrl->input_quality
98                       + LAMBDA_CODING_QUALITY    * psEncCtrl->coding_quality
99                       + LAMBDA_QUANT_OFFSET      * quant_offset;
100
101     silk_assert( psEncCtrl->Lambda > 0.0f );
102     silk_assert( psEncCtrl->Lambda < 2.0f );
103 }