Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_CNG.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 #include "SKP_Silk_main_FIX.h"\r
29 \r
30 /* Generates excitation for CNG LPC synthesis */\r
31 SKP_INLINE void SKP_Silk_CNG_exc(\r
32     SKP_int16                       residual[],         /* O    CNG residual signal Q0                      */\r
33     SKP_int32                       exc_buf_Q10[],      /* I    Random samples buffer Q10                   */\r
34     SKP_int32                       Gain_Q16,           /* I    Gain to apply                               */\r
35     SKP_int                         length,             /* I    Length                                      */\r
36     SKP_int32                       *rand_seed          /* I/O  Seed to random index generator              */\r
37 )\r
38 {\r
39     SKP_int32 seed;\r
40     SKP_int   i, idx, exc_mask;\r
41 \r
42     exc_mask = CNG_BUF_MASK_MAX;\r
43     while( exc_mask > length ) {\r
44         exc_mask = SKP_RSHIFT( exc_mask, 1 );\r
45     }\r
46 \r
47     seed = *rand_seed;\r
48     for( i = 0; i < length; i++ ) {\r
49         seed = SKP_RAND( seed );\r
50         idx = ( SKP_int )( SKP_RSHIFT( seed, 24 ) & exc_mask );\r
51         SKP_assert( idx >= 0 );\r
52         SKP_assert( idx <= CNG_BUF_MASK_MAX );\r
53         residual[ i ] = ( SKP_int16 )SKP_SAT16( SKP_RSHIFT_ROUND( SKP_SMULWW( exc_buf_Q10[ idx ], Gain_Q16 ), 10 ) );\r
54     }\r
55     *rand_seed = seed;\r
56 }\r
57 \r
58 void SKP_Silk_CNG_Reset(\r
59     SKP_Silk_decoder_state      *psDec              /* I/O  Decoder state                               */\r
60 )\r
61 {\r
62     SKP_int i, NLSF_step_Q15, NLSF_acc_Q15;\r
63 \r
64     NLSF_step_Q15 = SKP_DIV32_16( SKP_int16_MAX, psDec->LPC_order + 1 );\r
65     NLSF_acc_Q15 = 0;\r
66     for( i = 0; i < psDec->LPC_order; i++ ) {\r
67         NLSF_acc_Q15 += NLSF_step_Q15;\r
68         psDec->sCNG.CNG_smth_NLSF_Q15[ i ] = NLSF_acc_Q15;\r
69     }\r
70     psDec->sCNG.CNG_smth_Gain_Q16 = 0;\r
71     psDec->sCNG.rand_seed = 3176576;\r
72 }\r
73 \r
74 /* Updates CNG estimate, and applies the CNG when packet was lost   */\r
75 void SKP_Silk_CNG(\r
76     SKP_Silk_decoder_state      *psDec,             /* I/O  Decoder state                               */\r
77     SKP_Silk_decoder_control    *psDecCtrl,         /* I/O  Decoder control                             */\r
78     SKP_int16                   signal[],           /* I/O  Signal                                      */\r
79     SKP_int                     length              /* I    Length of residual                          */\r
80 )\r
81 {\r
82     SKP_int   i, subfr;\r
83     SKP_int32 tmp_32, Gain_Q26, max_Gain_Q16;\r
84     SKP_int16 LPC_buf[ MAX_LPC_ORDER ];\r
85     SKP_int16 CNG_sig[ MAX_FRAME_LENGTH ];\r
86     SKP_Silk_CNG_struct *psCNG;\r
87     psCNG = &psDec->sCNG;\r
88 \r
89     if( psDec->fs_kHz != psCNG->fs_kHz ) {\r
90         /* Reset state */\r
91         SKP_Silk_CNG_Reset( psDec );\r
92 \r
93         psCNG->fs_kHz = psDec->fs_kHz;\r
94     }\r
95     if( psDec->lossCnt == 0 && psDec->vadFlag == NO_VOICE_ACTIVITY ) {\r
96         /* Update CNG parameters */\r
97 \r
98         /* Smoothing of LSF's  */\r
99         for( i = 0; i < psDec->LPC_order; i++ ) {\r
100             psCNG->CNG_smth_NLSF_Q15[ i ] += SKP_SMULWB( psDec->prevNLSF_Q15[ i ] - psCNG->CNG_smth_NLSF_Q15[ i ], CNG_NLSF_SMTH_Q16 );\r
101         }\r
102         /* Find the subframe with the highest gain */\r
103         max_Gain_Q16 = 0;\r
104         subfr        = 0;\r
105         for( i = 0; i < NB_SUBFR; i++ ) {\r
106             if( psDecCtrl->Gains_Q16[ i ] > max_Gain_Q16 ) {\r
107                 max_Gain_Q16 = psDecCtrl->Gains_Q16[ i ];\r
108                 subfr        = i;\r
109             }\r
110         }\r
111         /* Update CNG excitation buffer with excitation from this subframe */\r
112         SKP_memmove( &psCNG->CNG_exc_buf_Q10[ psDec->subfr_length ], psCNG->CNG_exc_buf_Q10, ( NB_SUBFR - 1 ) * psDec->subfr_length * sizeof( SKP_int32 ) );\r
113         SKP_memcpy(   psCNG->CNG_exc_buf_Q10, &psDec->exc_Q10[ subfr * psDec->subfr_length ], psDec->subfr_length * sizeof( SKP_int32 ) );\r
114 \r
115         /* Smooth gains */\r
116         for( i = 0; i < NB_SUBFR; i++ ) {\r
117             psCNG->CNG_smth_Gain_Q16 += SKP_SMULWB( psDecCtrl->Gains_Q16[ i ] - psCNG->CNG_smth_Gain_Q16, CNG_GAIN_SMTH_Q16 );\r
118         }\r
119     }\r
120 \r
121     /* Add CNG when packet is lost and / or when low speech activity */\r
122     if( psDec->lossCnt ) {//|| psDec->vadFlag == NO_VOICE_ACTIVITY ) {\r
123 \r
124         /* Generate CNG excitation */\r
125         SKP_Silk_CNG_exc( CNG_sig, psCNG->CNG_exc_buf_Q10, \r
126                 psCNG->CNG_smth_Gain_Q16, length, &psCNG->rand_seed );\r
127 \r
128         /* Convert CNG NLSF to filter representation */\r
129         SKP_Silk_NLSF2A_stable( LPC_buf, psCNG->CNG_smth_NLSF_Q15, psDec->LPC_order );\r
130 \r
131         Gain_Q26 = ( SKP_int32 )1 << 26; /* 1.0 */\r
132         \r
133         /* Generate CNG signal, by synthesis filtering */\r
134         if( psDec->LPC_order == 16 ) {\r
135             SKP_Silk_LPC_synthesis_order16( CNG_sig, LPC_buf, \r
136                 Gain_Q26, psCNG->CNG_synth_state, CNG_sig, length );\r
137         } else {\r
138             SKP_Silk_LPC_synthesis_filter( CNG_sig, LPC_buf, \r
139                 Gain_Q26, psCNG->CNG_synth_state, CNG_sig, length, psDec->LPC_order );\r
140         }\r
141         /* Mix with signal */\r
142         for( i = 0; i < length; i++ ) {\r
143             tmp_32 = signal[ i ] + CNG_sig[ i ];\r
144             signal[ i ] = SKP_SAT16( tmp_32 );\r
145         }\r
146     } else {\r
147         SKP_memset( psCNG->CNG_synth_state, 0, psDec->LPC_order *  sizeof( SKP_int32 ) );\r
148     }\r
149 }\r