michael@0: /***********************************************************************
michael@0: Copyright (c) 2006-2011, Skype Limited. All rights reserved.
michael@0: Redistribution and use in source and binary forms, with or without
michael@0: modification, are permitted provided that the following conditions
michael@0: are met:
michael@0: - Redistributions of source code must retain the above copyright notice,
michael@0: this list of conditions and the following disclaimer.
michael@0: - Redistributions in binary form must reproduce the above copyright
michael@0: notice, this list of conditions and the following disclaimer in the
michael@0: documentation and/or other materials provided with the distribution.
michael@0: - Neither the name of Internet Society, IETF or IETF Trust, nor the
michael@0: names of specific contributors, may be used to endorse or promote
michael@0: products derived from this software without specific prior written
michael@0: permission.
michael@0: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
michael@0: AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
michael@0: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
michael@0: ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
michael@0: LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
michael@0: CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
michael@0: SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
michael@0: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
michael@0: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
michael@0: ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
michael@0: POSSIBILITY OF SUCH DAMAGE.
michael@0: ***********************************************************************/
michael@0: 
michael@0: #ifdef HAVE_CONFIG_H
michael@0: #include "config.h"
michael@0: #endif
michael@0: 
michael@0: #include "main.h"
michael@0: #include "tuning_parameters.h"
michael@0: 
michael@0: void silk_quant_LTP_gains(
michael@0:     opus_int16                  B_Q14[ MAX_NB_SUBFR * LTP_ORDER ],          /* I/O  (un)quantized LTP gains         */
michael@0:     opus_int8                   cbk_index[ MAX_NB_SUBFR ],                  /* O    Codebook Index                  */
michael@0:     opus_int8                   *periodicity_index,                         /* O    Periodicity Index               */
michael@0: 	opus_int32					*sum_log_gain_Q7,							/* I/O  Cumulative max prediction gain  */
michael@0:     const opus_int32            W_Q18[ MAX_NB_SUBFR*LTP_ORDER*LTP_ORDER ],  /* I    Error Weights in Q18            */
michael@0:     opus_int                    mu_Q9,                                      /* I    Mu value (R/D tradeoff)         */
michael@0:     opus_int                    lowComplexity,                              /* I    Flag for low complexity         */
michael@0:     const opus_int              nb_subfr                                    /* I    number of subframes             */
michael@0: )
michael@0: {
michael@0:     opus_int             j, k, cbk_size;
michael@0:     opus_int8            temp_idx[ MAX_NB_SUBFR ];
michael@0:     const opus_uint8     *cl_ptr_Q5;
michael@0:     const opus_int8      *cbk_ptr_Q7;
michael@0:     const opus_uint8     *cbk_gain_ptr_Q7;
michael@0:     const opus_int16     *b_Q14_ptr;
michael@0:     const opus_int32     *W_Q18_ptr;
michael@0:     opus_int32           rate_dist_Q14_subfr, rate_dist_Q14, min_rate_dist_Q14;
michael@0: 	opus_int32           sum_log_gain_tmp_Q7, best_sum_log_gain_Q7, max_gain_Q7, gain_Q7;
michael@0: 
michael@0:     /***************************************************/
michael@0:     /* iterate over different codebooks with different */
michael@0:     /* rates/distortions, and choose best */
michael@0:     /***************************************************/
michael@0:     min_rate_dist_Q14 = silk_int32_MAX;
michael@0:     best_sum_log_gain_Q7 = 0;
michael@0:     for( k = 0; k < 3; k++ ) {
michael@0:         /* Safety margin for pitch gain control, to take into account factors
michael@0:            such as state rescaling/rewhitening. */
michael@0:         opus_int32 gain_safety = SILK_FIX_CONST( 0.4, 7 );
michael@0: 
michael@0:         cl_ptr_Q5  = silk_LTP_gain_BITS_Q5_ptrs[ k ];
michael@0:         cbk_ptr_Q7 = silk_LTP_vq_ptrs_Q7[        k ];
michael@0:         cbk_gain_ptr_Q7 = silk_LTP_vq_gain_ptrs_Q7[ k ];
michael@0:         cbk_size   = silk_LTP_vq_sizes[          k ];
michael@0: 
michael@0:         /* Set up pointer to first subframe */
michael@0:         W_Q18_ptr = W_Q18;
michael@0:         b_Q14_ptr = B_Q14;
michael@0: 
michael@0:         rate_dist_Q14 = 0;
michael@0: 		sum_log_gain_tmp_Q7 = *sum_log_gain_Q7;
michael@0:         for( j = 0; j < nb_subfr; j++ ) {
michael@0: 			max_gain_Q7 = silk_log2lin( ( SILK_FIX_CONST( MAX_SUM_LOG_GAIN_DB / 6.0, 7 ) - sum_log_gain_tmp_Q7 ) 
michael@0: 										+ SILK_FIX_CONST( 7, 7 ) ) - gain_safety;
michael@0: 
michael@0:             silk_VQ_WMat_EC(
michael@0:                 &temp_idx[ j ],         /* O    index of best codebook vector                           */
michael@0:                 &rate_dist_Q14_subfr,   /* O    best weighted quantization error + mu * rate            */
michael@0: 				&gain_Q7,               /* O    sum of absolute LTP coefficients                        */
michael@0:                 b_Q14_ptr,              /* I    input vector to be quantized                            */
michael@0:                 W_Q18_ptr,              /* I    weighting matrix                                        */
michael@0:                 cbk_ptr_Q7,             /* I    codebook                                                */
michael@0:                 cbk_gain_ptr_Q7,        /* I    codebook effective gains                                */
michael@0:                 cl_ptr_Q5,              /* I    code length for each codebook vector                    */
michael@0:                 mu_Q9,                  /* I    tradeoff between weighted error and rate                */
michael@0: 				max_gain_Q7,            /* I    maximum sum of absolute LTP coefficients                */
michael@0:                 cbk_size                /* I    number of vectors in codebook                           */
michael@0:             );
michael@0: 
michael@0:             rate_dist_Q14 = silk_ADD_POS_SAT32( rate_dist_Q14, rate_dist_Q14_subfr );
michael@0:             sum_log_gain_tmp_Q7 = silk_max(0, sum_log_gain_tmp_Q7
michael@0:                                 + silk_lin2log( gain_safety + gain_Q7 ) - SILK_FIX_CONST( 7, 7 ));
michael@0: 
michael@0:             b_Q14_ptr += LTP_ORDER;
michael@0:             W_Q18_ptr += LTP_ORDER * LTP_ORDER;
michael@0:         }
michael@0: 
michael@0:         /* Avoid never finding a codebook */
michael@0:         rate_dist_Q14 = silk_min( silk_int32_MAX - 1, rate_dist_Q14 );
michael@0: 
michael@0:         if( rate_dist_Q14 < min_rate_dist_Q14 ) {
michael@0:             min_rate_dist_Q14 = rate_dist_Q14;
michael@0:             *periodicity_index = (opus_int8)k;
michael@0:             silk_memcpy( cbk_index, temp_idx, nb_subfr * sizeof( opus_int8 ) );
michael@0: 			best_sum_log_gain_Q7 = sum_log_gain_tmp_Q7;
michael@0:         }
michael@0: 
michael@0:         /* Break early in low-complexity mode if rate distortion is below threshold */
michael@0:         if( lowComplexity && ( rate_dist_Q14 < silk_LTP_gain_middle_avg_RD_Q14 ) ) {
michael@0:             break;
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     cbk_ptr_Q7 = silk_LTP_vq_ptrs_Q7[ *periodicity_index ];
michael@0:     for( j = 0; j < nb_subfr; j++ ) {
michael@0:         for( k = 0; k < LTP_ORDER; k++ ) {
michael@0:             B_Q14[ j * LTP_ORDER + k ] = silk_LSHIFT( cbk_ptr_Q7[ cbk_index[ j ] * LTP_ORDER + k ], 7 );
michael@0:         }
michael@0:     }
michael@0: 	*sum_log_gain_Q7 = best_sum_log_gain_Q7;
michael@0: }
michael@0: