Fixes the case of PLC before receiving any valid packet
[opus.git] / silk / silk_gain_quant.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, 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 "silk_main.h"\r
29 \r
30 #define OFFSET                  ( ( MIN_QGAIN_DB * 128 ) / 6 + 16 * 128 )\r
31 #define SCALE_Q16               ( ( 65536 * ( N_LEVELS_QGAIN - 1 ) ) / ( ( ( MAX_QGAIN_DB - MIN_QGAIN_DB ) * 128 ) / 6 ) )\r
32 #define INV_SCALE_Q16           ( ( 65536 * ( ( ( MAX_QGAIN_DB - MIN_QGAIN_DB ) * 128 ) / 6 ) ) / ( N_LEVELS_QGAIN - 1 ) )\r
33 \r
34 /* Gain scalar quantization with hysteresis, uniform on log scale */\r
35 void silk_gains_quant(\r
36     SKP_int8                        ind[ MAX_NB_SUBFR ],        /* O    gain indices                            */\r
37     SKP_int32                       gain_Q16[ MAX_NB_SUBFR ],   /* I/O  gains (quantized out)                   */\r
38     SKP_int8                        *prev_ind,                  /* I/O  last index in previous frame            */\r
39     const SKP_int                   conditional,                /* I    first gain is delta coded if 1          */\r
40     const SKP_int                   nb_subfr                    /* I    number of subframes                     */\r
41 )\r
42 {\r
43     SKP_int k, double_step_size_threshold;\r
44 \r
45     for( k = 0; k < nb_subfr; k++ ) {\r
46         /* Add half of previous quantization error, convert to log scale, scale, floor() */\r
47         ind[ k ] = SKP_SMULWB( SCALE_Q16, silk_lin2log( gain_Q16[ k ] ) - OFFSET );\r
48 \r
49         /* Round towards previous quantized gain (hysteresis) */\r
50         if( ind[ k ] < *prev_ind ) {\r
51             ind[ k ]++;\r
52         }\r
53         ind[ k ] = SKP_max_int( ind[ k ], 0 );\r
54 \r
55         /* Compute delta indices and limit */\r
56         if( k == 0 && conditional == 0 ) {\r
57             /* Full index */\r
58             ind[ k ] = SKP_LIMIT_int( ind[ k ], *prev_ind + MIN_DELTA_GAIN_QUANT, N_LEVELS_QGAIN - 1 );\r
59             *prev_ind = ind[ k ];\r
60         } else {\r
61             /* Delta index */\r
62             ind[ k ] = ind[ k ] - *prev_ind;\r
63 \r
64             /* Double the quantization step size for large gain increases, so that the max gain level can be reached */\r
65             double_step_size_threshold = 2 * MAX_DELTA_GAIN_QUANT - N_LEVELS_QGAIN + *prev_ind;\r
66             if( ind[ k ] > double_step_size_threshold ) {\r
67                 ind[ k ] = double_step_size_threshold + SKP_RSHIFT( ind[ k ] - double_step_size_threshold + 1, 1 );\r
68             }\r
69 \r
70             ind[ k ] = SKP_LIMIT_int( ind[ k ], MIN_DELTA_GAIN_QUANT, MAX_DELTA_GAIN_QUANT );\r
71 \r
72             /* Accumulate deltas */\r
73             if( ind[ k ] > double_step_size_threshold ) {\r
74                 *prev_ind += SKP_LSHIFT( ind[ k ], 1 ) - double_step_size_threshold;\r
75             } else {\r
76                 *prev_ind += ind[ k ];\r
77             }\r
78 \r
79             /* Shift to make non-negative */\r
80             ind[ k ] -= MIN_DELTA_GAIN_QUANT;\r
81         }\r
82 \r
83         /* Convert to linear scale and scale */\r
84         gain_Q16[ k ] = silk_log2lin( SKP_min_32( SKP_SMULWB( INV_SCALE_Q16, *prev_ind ) + OFFSET, 3967 ) ); /* 3967 = 31 in Q7 */\r
85     }\r
86 }\r
87 \r
88 /* Gains scalar dequantization, uniform on log scale */\r
89 void silk_gains_dequant(\r
90     SKP_int32                       gain_Q16[ MAX_NB_SUBFR ],   /* O    quantized gains                         */\r
91     const SKP_int8                  ind[ MAX_NB_SUBFR ],        /* I    gain indices                            */\r
92     SKP_int8                        *prev_ind,                  /* I/O  last index in previous frame            */\r
93     const SKP_int                   conditional,                /* I    first gain is delta coded if 1          */\r
94     const SKP_int                   nb_subfr                    /* I    number of subframes                     */\r
95 )\r
96 {\r
97     SKP_int   k, ind_tmp, double_step_size_threshold;\r
98 \r
99     for( k = 0; k < nb_subfr; k++ ) {\r
100         if( k == 0 && conditional == 0 ) {\r
101             *prev_ind = ind[ k ];\r
102         } else {\r
103             /* Delta index */\r
104             ind_tmp = ind[ k ] + MIN_DELTA_GAIN_QUANT;\r
105 \r
106             /* Accumulate deltas */\r
107             double_step_size_threshold = 2 * MAX_DELTA_GAIN_QUANT - N_LEVELS_QGAIN + *prev_ind;\r
108             if( ind_tmp > double_step_size_threshold ) {\r
109                 *prev_ind += SKP_LSHIFT( ind_tmp, 1 ) - double_step_size_threshold;\r
110             } else {\r
111                 *prev_ind += ind_tmp;\r
112             }\r
113         }\r
114         *prev_ind = SKP_min( *prev_ind, N_LEVELS_QGAIN - 1 );\r
115 \r
116         /* Convert to linear scale and scale */\r
117         gain_Q16[ k ] = silk_log2lin( SKP_min_32( SKP_SMULWB( INV_SCALE_Q16, *prev_ind ) + OFFSET, 3967 ) ); /* 3967 = 31 in Q7 */\r
118     }\r
119 }\r