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