Annotating pointer arguments with OPUS_RESTRICT and const
[opus.git] / silk / quant_LTP_gains.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.h"
33 #include "tuning_parameters.h"
34
35 void silk_quant_LTP_gains(
36     opus_int16                  B_Q14[ MAX_NB_SUBFR * LTP_ORDER ],          /* I/O  (un)quantized LTP gains         */
37     opus_int8                   cbk_index[ MAX_NB_SUBFR ],                  /* O    Codebook Index                  */
38     opus_int8                   *periodicity_index,                         /* O    Periodicity Index               */
39         opus_int32                                      *sum_log_gain_Q7,                                                       /* I/O  Cumulative max prediction gain  */
40     const opus_int32            W_Q18[ MAX_NB_SUBFR*LTP_ORDER*LTP_ORDER ],  /* I    Error Weights in Q18            */
41     opus_int                    mu_Q9,                                      /* I    Mu value (R/D tradeoff)         */
42     opus_int                    lowComplexity,                              /* I    Flag for low complexity         */
43     const opus_int              nb_subfr                                    /* I    number of subframes             */
44 )
45 {
46     opus_int             j, k, cbk_size;
47     opus_int8            temp_idx[ MAX_NB_SUBFR ];
48     const opus_uint8     *cl_ptr_Q5;
49     const opus_int8      *cbk_ptr_Q7;
50     const opus_uint8     *cbk_gain_ptr_Q7;
51     const opus_int16     *b_Q14_ptr;
52     const opus_int32     *W_Q18_ptr;
53     opus_int32           rate_dist_Q14_subfr, rate_dist_Q14, min_rate_dist_Q14;
54         opus_int32           sum_log_gain_tmp_Q7, best_sum_log_gain_Q7, max_gain_Q7, gain_Q7;
55
56     /***************************************************/
57     /* iterate over different codebooks with different */
58     /* rates/distortions, and choose best */
59     /***************************************************/
60     min_rate_dist_Q14 = silk_int32_MAX;
61     best_sum_log_gain_Q7 = 0;
62     for( k = 0; k < 3; k++ ) {
63         /* Safety margin for pitch gain control, to take into account factors
64            such as state rescaling/rewhitening. */
65         opus_int32 gain_safety = SILK_FIX_CONST( 0.4, 7 );
66
67         cl_ptr_Q5  = silk_LTP_gain_BITS_Q5_ptrs[ k ];
68         cbk_ptr_Q7 = silk_LTP_vq_ptrs_Q7[        k ];
69         cbk_gain_ptr_Q7 = silk_LTP_vq_gain_ptrs_Q7[ k ];
70         cbk_size   = silk_LTP_vq_sizes[          k ];
71
72         /* Set up pointer to first subframe */
73         W_Q18_ptr = W_Q18;
74         b_Q14_ptr = B_Q14;
75
76         rate_dist_Q14 = 0;
77                 sum_log_gain_tmp_Q7 = *sum_log_gain_Q7;
78         for( j = 0; j < nb_subfr; j++ ) {
79                         max_gain_Q7 = silk_log2lin( ( SILK_FIX_CONST( MAX_SUM_LOG_GAIN_DB / 6.0, 7 ) - sum_log_gain_tmp_Q7 ) 
80                                                                                 + SILK_FIX_CONST( 7, 7 ) ) - gain_safety;
81
82             silk_VQ_WMat_EC(
83                 &temp_idx[ j ],         /* O    index of best codebook vector                           */
84                 &rate_dist_Q14_subfr,   /* O    best weighted quantization error + mu * rate            */
85                                 &gain_Q7,               /* O    sum of absolute LTP coefficients                        */
86                 b_Q14_ptr,              /* I    input vector to be quantized                            */
87                 W_Q18_ptr,              /* I    weighting matrix                                        */
88                 cbk_ptr_Q7,             /* I    codebook                                                */
89                 cbk_gain_ptr_Q7,        /* I    codebook effective gains                                */
90                 cl_ptr_Q5,              /* I    code length for each codebook vector                    */
91                 mu_Q9,                  /* I    tradeoff between weighted error and rate                */
92                                 max_gain_Q7,            /* I    maximum sum of absolute LTP coefficients                */
93                 cbk_size                /* I    number of vectors in codebook                           */
94             );
95
96             rate_dist_Q14 = silk_ADD_POS_SAT32( rate_dist_Q14, rate_dist_Q14_subfr );
97             sum_log_gain_tmp_Q7 = silk_max(0, sum_log_gain_tmp_Q7
98                                 + silk_lin2log( gain_safety + gain_Q7 ) - SILK_FIX_CONST( 7, 7 ));
99
100             b_Q14_ptr += LTP_ORDER;
101             W_Q18_ptr += LTP_ORDER * LTP_ORDER;
102         }
103
104         /* Avoid never finding a codebook */
105         rate_dist_Q14 = silk_min( silk_int32_MAX - 1, rate_dist_Q14 );
106
107         if( rate_dist_Q14 < min_rate_dist_Q14 ) {
108             min_rate_dist_Q14 = rate_dist_Q14;
109             *periodicity_index = (opus_int8)k;
110             silk_memcpy( cbk_index, temp_idx, nb_subfr * sizeof( opus_int8 ) );
111                         best_sum_log_gain_Q7 = sum_log_gain_tmp_Q7;
112         }
113
114         /* Break early in low-complexity mode if rate distortion is below threshold */
115         if( lowComplexity && ( rate_dist_Q14 < silk_LTP_gain_middle_avg_RD_Q14 ) ) {
116             break;
117         }
118     }
119
120     cbk_ptr_Q7 = silk_LTP_vq_ptrs_Q7[ *periodicity_index ];
121     for( j = 0; j < nb_subfr; j++ ) {
122         for( k = 0; k < LTP_ORDER; k++ ) {
123             B_Q14[ j * LTP_ORDER + k ] = silk_LSHIFT( cbk_ptr_Q7[ cbk_index[ j ] * LTP_ORDER + k ], 7 );
124         }
125     }
126         *sum_log_gain_Q7 = best_sum_log_gain_Q7;
127 }
128