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: 
michael@0: /* Encode side-information parameters to payload */
michael@0: void silk_encode_indices(
michael@0:     silk_encoder_state          *psEncC,                        /* I/O  Encoder state                               */
michael@0:     ec_enc                      *psRangeEnc,                    /* I/O  Compressor data structure                   */
michael@0:     opus_int                    FrameIndex,                     /* I    Frame number                                */
michael@0:     opus_int                    encode_LBRR,                    /* I    Flag indicating LBRR data is being encoded  */
michael@0:     opus_int                    condCoding                      /* I    The type of conditional coding to use       */
michael@0: )
michael@0: {
michael@0:     opus_int   i, k, typeOffset;
michael@0:     opus_int   encode_absolute_lagIndex, delta_lagIndex;
michael@0:     opus_int16 ec_ix[ MAX_LPC_ORDER ];
michael@0:     opus_uint8 pred_Q8[ MAX_LPC_ORDER ];
michael@0:     const SideInfoIndices *psIndices;
michael@0: 
michael@0:     if( encode_LBRR ) {
michael@0:          psIndices = &psEncC->indices_LBRR[ FrameIndex ];
michael@0:     } else {
michael@0:          psIndices = &psEncC->indices;
michael@0:     }
michael@0: 
michael@0:     /*******************************************/
michael@0:     /* Encode signal type and quantizer offset */
michael@0:     /*******************************************/
michael@0:     typeOffset = 2 * psIndices->signalType + psIndices->quantOffsetType;
michael@0:     silk_assert( typeOffset >= 0 && typeOffset < 6 );
michael@0:     silk_assert( encode_LBRR == 0 || typeOffset >= 2 );
michael@0:     if( encode_LBRR || typeOffset >= 2 ) {
michael@0:         ec_enc_icdf( psRangeEnc, typeOffset - 2, silk_type_offset_VAD_iCDF, 8 );
michael@0:     } else {
michael@0:         ec_enc_icdf( psRangeEnc, typeOffset, silk_type_offset_no_VAD_iCDF, 8 );
michael@0:     }
michael@0: 
michael@0:     /****************/
michael@0:     /* Encode gains */
michael@0:     /****************/
michael@0:     /* first subframe */
michael@0:     if( condCoding == CODE_CONDITIONALLY ) {
michael@0:         /* conditional coding */
michael@0:         silk_assert( psIndices->GainsIndices[ 0 ] >= 0 && psIndices->GainsIndices[ 0 ] < MAX_DELTA_GAIN_QUANT - MIN_DELTA_GAIN_QUANT + 1 );
michael@0:         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ 0 ], silk_delta_gain_iCDF, 8 );
michael@0:     } else {
michael@0:         /* independent coding, in two stages: MSB bits followed by 3 LSBs */
michael@0:         silk_assert( psIndices->GainsIndices[ 0 ] >= 0 && psIndices->GainsIndices[ 0 ] < N_LEVELS_QGAIN );
michael@0:         ec_enc_icdf( psRangeEnc, silk_RSHIFT( psIndices->GainsIndices[ 0 ], 3 ), silk_gain_iCDF[ psIndices->signalType ], 8 );
michael@0:         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ 0 ] & 7, silk_uniform8_iCDF, 8 );
michael@0:     }
michael@0: 
michael@0:     /* remaining subframes */
michael@0:     for( i = 1; i < psEncC->nb_subfr; i++ ) {
michael@0:         silk_assert( psIndices->GainsIndices[ i ] >= 0 && psIndices->GainsIndices[ i ] < MAX_DELTA_GAIN_QUANT - MIN_DELTA_GAIN_QUANT + 1 );
michael@0:         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ i ], silk_delta_gain_iCDF, 8 );
michael@0:     }
michael@0: 
michael@0:     /****************/
michael@0:     /* Encode NLSFs */
michael@0:     /****************/
michael@0:     ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ 0 ], &psEncC->psNLSF_CB->CB1_iCDF[ ( psIndices->signalType >> 1 ) * psEncC->psNLSF_CB->nVectors ], 8 );
michael@0:     silk_NLSF_unpack( ec_ix, pred_Q8, psEncC->psNLSF_CB, psIndices->NLSFIndices[ 0 ] );
michael@0:     silk_assert( psEncC->psNLSF_CB->order == psEncC->predictLPCOrder );
michael@0:     for( i = 0; i < psEncC->psNLSF_CB->order; i++ ) {
michael@0:         if( psIndices->NLSFIndices[ i+1 ] >= NLSF_QUANT_MAX_AMPLITUDE ) {
michael@0:             ec_enc_icdf( psRangeEnc, 2 * NLSF_QUANT_MAX_AMPLITUDE, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
michael@0:             ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ i+1 ] - NLSF_QUANT_MAX_AMPLITUDE, silk_NLSF_EXT_iCDF, 8 );
michael@0:         } else if( psIndices->NLSFIndices[ i+1 ] <= -NLSF_QUANT_MAX_AMPLITUDE ) {
michael@0:             ec_enc_icdf( psRangeEnc, 0, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
michael@0:             ec_enc_icdf( psRangeEnc, -psIndices->NLSFIndices[ i+1 ] - NLSF_QUANT_MAX_AMPLITUDE, silk_NLSF_EXT_iCDF, 8 );
michael@0:         } else {
michael@0:             ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ i+1 ] + NLSF_QUANT_MAX_AMPLITUDE, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /* Encode NLSF interpolation factor */
michael@0:     if( psEncC->nb_subfr == MAX_NB_SUBFR ) {
michael@0:         silk_assert( psIndices->NLSFInterpCoef_Q2 >= 0 && psIndices->NLSFInterpCoef_Q2 < 5 );
michael@0:         ec_enc_icdf( psRangeEnc, psIndices->NLSFInterpCoef_Q2, silk_NLSF_interpolation_factor_iCDF, 8 );
michael@0:     }
michael@0: 
michael@0:     if( psIndices->signalType == TYPE_VOICED )
michael@0:     {
michael@0:         /*********************/
michael@0:         /* Encode pitch lags */
michael@0:         /*********************/
michael@0:         /* lag index */
michael@0:         encode_absolute_lagIndex = 1;
michael@0:         if( condCoding == CODE_CONDITIONALLY && psEncC->ec_prevSignalType == TYPE_VOICED ) {
michael@0:             /* Delta Encoding */
michael@0:             delta_lagIndex = psIndices->lagIndex - psEncC->ec_prevLagIndex;
michael@0:             if( delta_lagIndex < -8 || delta_lagIndex > 11 ) {
michael@0:                 delta_lagIndex = 0;
michael@0:             } else {
michael@0:                 delta_lagIndex = delta_lagIndex + 9;
michael@0:                 encode_absolute_lagIndex = 0; /* Only use delta */
michael@0:             }
michael@0:             silk_assert( delta_lagIndex >= 0 && delta_lagIndex < 21 );
michael@0:             ec_enc_icdf( psRangeEnc, delta_lagIndex, silk_pitch_delta_iCDF, 8 );
michael@0:         }
michael@0:         if( encode_absolute_lagIndex ) {
michael@0:             /* Absolute encoding */
michael@0:             opus_int32 pitch_high_bits, pitch_low_bits;
michael@0:             pitch_high_bits = silk_DIV32_16( psIndices->lagIndex, silk_RSHIFT( psEncC->fs_kHz, 1 ) );
michael@0:             pitch_low_bits = psIndices->lagIndex - silk_SMULBB( pitch_high_bits, silk_RSHIFT( psEncC->fs_kHz, 1 ) );
michael@0:             silk_assert( pitch_low_bits < psEncC->fs_kHz / 2 );
michael@0:             silk_assert( pitch_high_bits < 32 );
michael@0:             ec_enc_icdf( psRangeEnc, pitch_high_bits, silk_pitch_lag_iCDF, 8 );
michael@0:             ec_enc_icdf( psRangeEnc, pitch_low_bits, psEncC->pitch_lag_low_bits_iCDF, 8 );
michael@0:         }
michael@0:         psEncC->ec_prevLagIndex = psIndices->lagIndex;
michael@0: 
michael@0:         /* Countour index */
michael@0:         silk_assert(   psIndices->contourIndex  >= 0 );
michael@0:         silk_assert( ( psIndices->contourIndex < 34 && psEncC->fs_kHz  > 8 && psEncC->nb_subfr == 4 ) ||
michael@0:                     ( psIndices->contourIndex < 11 && psEncC->fs_kHz == 8 && psEncC->nb_subfr == 4 ) ||
michael@0:                     ( psIndices->contourIndex < 12 && psEncC->fs_kHz  > 8 && psEncC->nb_subfr == 2 ) ||
michael@0:                     ( psIndices->contourIndex <  3 && psEncC->fs_kHz == 8 && psEncC->nb_subfr == 2 ) );
michael@0:         ec_enc_icdf( psRangeEnc, psIndices->contourIndex, psEncC->pitch_contour_iCDF, 8 );
michael@0: 
michael@0:         /********************/
michael@0:         /* Encode LTP gains */
michael@0:         /********************/
michael@0:         /* PERIndex value */
michael@0:         silk_assert( psIndices->PERIndex >= 0 && psIndices->PERIndex < 3 );
michael@0:         ec_enc_icdf( psRangeEnc, psIndices->PERIndex, silk_LTP_per_index_iCDF, 8 );
michael@0: 
michael@0:         /* Codebook Indices */
michael@0:         for( k = 0; k < psEncC->nb_subfr; k++ ) {
michael@0:             silk_assert( psIndices->LTPIndex[ k ] >= 0 && psIndices->LTPIndex[ k ] < ( 8 << psIndices->PERIndex ) );
michael@0:             ec_enc_icdf( psRangeEnc, psIndices->LTPIndex[ k ], silk_LTP_gain_iCDF_ptrs[ psIndices->PERIndex ], 8 );
michael@0:         }
michael@0: 
michael@0:         /**********************/
michael@0:         /* Encode LTP scaling */
michael@0:         /**********************/
michael@0:         if( condCoding == CODE_INDEPENDENTLY ) {
michael@0:             silk_assert( psIndices->LTP_scaleIndex >= 0 && psIndices->LTP_scaleIndex < 3 );
michael@0:             ec_enc_icdf( psRangeEnc, psIndices->LTP_scaleIndex, silk_LTPscale_iCDF, 8 );
michael@0:         }
michael@0:         silk_assert( !condCoding || psIndices->LTP_scaleIndex == 0 );
michael@0:     }
michael@0: 
michael@0:     psEncC->ec_prevSignalType = psIndices->signalType;
michael@0: 
michael@0:     /***************/
michael@0:     /* Encode seed */
michael@0:     /***************/
michael@0:     silk_assert( psIndices->Seed >= 0 && psIndices->Seed < 4 );
michael@0:     ec_enc_icdf( psRangeEnc, psIndices->Seed, silk_uniform4_iCDF, 8 );
michael@0: }