Renaming the SKP_ prefix to silk_
[opus.git] / silk / fixed / silk_process_gains_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 "silk_main_FIX.h"
33 #include "silk_tuning_parameters.h"
34
35 /* Processing of gains */
36 void silk_process_gains_FIX(
37     silk_encoder_state_FIX      *psEnc,         /* I/O  Encoder state_FIX                           */
38     silk_encoder_control_FIX    *psEncCtrl      /* I/O  Encoder control_FIX                         */
39 )
40 {
41     silk_shape_state_FIX    *psShapeSt = &psEnc->sShape;
42     opus_int     k;
43     opus_int32   s_Q16, InvMaxSqrVal_Q16, gain, gain_squared, ResNrg, ResNrgPart, quant_offset_Q10;
44
45     /* Gain reduction when LTP coding gain is high */
46     if( psEnc->sCmn.indices.signalType == TYPE_VOICED ) {
47         /*s = -0.5f * silk_sigmoid( 0.25f * ( psEncCtrl->LTPredCodGain - 12.0f ) ); */
48         s_Q16 = -silk_sigm_Q15( silk_RSHIFT_ROUND( psEncCtrl->LTPredCodGain_Q7 - SILK_FIX_CONST( 12.0, 7 ), 4 ) );
49         for( k = 0; k < psEnc->sCmn.nb_subfr; k++ ) {
50             psEncCtrl->Gains_Q16[ k ] = silk_SMLAWB( psEncCtrl->Gains_Q16[ k ], psEncCtrl->Gains_Q16[ k ], s_Q16 );
51         }
52     }
53
54     /* Limit the quantized signal */
55     /* InvMaxSqrVal = pow( 2.0f, 0.33f * ( 21.0f - SNR_dB ) ) / subfr_length; */
56     InvMaxSqrVal_Q16 = silk_DIV32_16( silk_log2lin(
57         silk_SMULWB( SILK_FIX_CONST( 21 + 16 / 0.33, 7 ) - psEnc->sCmn.SNR_dB_Q7, SILK_FIX_CONST( 0.33, 16 ) ) ), psEnc->sCmn.subfr_length );
58
59     for( k = 0; k < psEnc->sCmn.nb_subfr; k++ ) {
60         /* Soft limit on ratio residual energy and squared gains */
61         ResNrg     = psEncCtrl->ResNrg[ k ];
62         ResNrgPart = silk_SMULWW( ResNrg, InvMaxSqrVal_Q16 );
63         if( psEncCtrl->ResNrgQ[ k ] > 0 ) {
64             ResNrgPart = silk_RSHIFT_ROUND( ResNrgPart, psEncCtrl->ResNrgQ[ k ] );
65         } else {
66             if( ResNrgPart >= silk_RSHIFT( silk_int32_MAX, -psEncCtrl->ResNrgQ[ k ] ) ) {
67                 ResNrgPart = silk_int32_MAX;
68             } else {
69                 ResNrgPart = silk_LSHIFT( ResNrgPart, -psEncCtrl->ResNrgQ[ k ] );
70             }
71         }
72         gain = psEncCtrl->Gains_Q16[ k ];
73         gain_squared = silk_ADD_SAT32( ResNrgPart, silk_SMMUL( gain, gain ) );
74         if( gain_squared < silk_int16_MAX ) {
75             /* recalculate with higher precision */
76             gain_squared = silk_SMLAWW( silk_LSHIFT( ResNrgPart, 16 ), gain, gain );
77             silk_assert( gain_squared > 0 );
78             gain = silk_SQRT_APPROX( gain_squared );                    /* Q8   */
79             gain = silk_min( gain, silk_int32_MAX >> 8 );
80             psEncCtrl->Gains_Q16[ k ] = silk_LSHIFT_SAT32( gain, 8 );        /* Q16  */
81         } else {
82             gain = silk_SQRT_APPROX( gain_squared );                    /* Q0   */
83             gain = silk_min( gain, silk_int32_MAX >> 16 );
84             psEncCtrl->Gains_Q16[ k ] = silk_LSHIFT_SAT32( gain, 16 );       /* Q16  */
85         }
86     }
87
88     /* Noise shaping quantization */
89     silk_gains_quant( psEnc->sCmn.indices.GainsIndices, psEncCtrl->Gains_Q16,
90         &psShapeSt->LastGainIndex, psEnc->sCmn.nFramesEncoded, psEnc->sCmn.nb_subfr );
91
92     /* Set quantizer offset for voiced signals. Larger offset when LTP coding gain is low or tilt is high (ie low-pass) */
93     if( psEnc->sCmn.indices.signalType == TYPE_VOICED ) {
94         if( psEncCtrl->LTPredCodGain_Q7 + silk_RSHIFT( psEnc->sCmn.input_tilt_Q15, 8 ) > SILK_FIX_CONST( 1.0, 7 ) ) {
95             psEnc->sCmn.indices.quantOffsetType = 0;
96         } else {
97             psEnc->sCmn.indices.quantOffsetType = 1;
98         }
99     }
100
101     /* Quantizer boundary adjustment */
102     quant_offset_Q10 = silk_Quantization_Offsets_Q10[ psEnc->sCmn.indices.signalType >> 1 ][ psEnc->sCmn.indices.quantOffsetType ];
103     psEncCtrl->Lambda_Q10 = SILK_FIX_CONST( LAMBDA_OFFSET, 10 )
104                           + silk_SMULBB( SILK_FIX_CONST( LAMBDA_DELAYED_DECISIONS, 10 ), psEnc->sCmn.nStatesDelayedDecision )
105                           + silk_SMULWB( SILK_FIX_CONST( LAMBDA_SPEECH_ACT,        18 ), psEnc->sCmn.speech_activity_Q8     )
106                           + silk_SMULWB( SILK_FIX_CONST( LAMBDA_INPUT_QUALITY,     12 ), psEncCtrl->input_quality_Q14       )
107                           + silk_SMULWB( SILK_FIX_CONST( LAMBDA_CODING_QUALITY,    12 ), psEncCtrl->coding_quality_Q14      )
108                           + silk_SMULWB( SILK_FIX_CONST( LAMBDA_QUANT_OFFSET,      16 ), quant_offset_Q10                   );
109
110     silk_assert( psEncCtrl->Lambda_Q10 > 0 );
111     silk_assert( psEncCtrl->Lambda_Q10 < SILK_FIX_CONST( 2, 10 ) );
112 }