Disabling some unused SILK functions from the float build
[opus.git] / silk / encode_indices.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 /* Encode side-information parameters to payload */
35 void silk_encode_indices(
36     silk_encoder_state          *psEncC,                        /* I/O  Encoder state                               */
37     ec_enc                      *psRangeEnc,                    /* I/O  Compressor data structure                   */
38     opus_int                    FrameIndex,                     /* I    Frame number                                */
39     opus_int                    encode_LBRR,                    /* I    Flag indicating LBRR data is being encoded  */
40     opus_int                    condCoding                      /* I    The type of conditional coding to use       */
41 )
42 {
43     opus_int   i, k, typeOffset;
44     opus_int   encode_absolute_lagIndex, delta_lagIndex;
45     opus_int16 ec_ix[ MAX_LPC_ORDER ];
46     opus_uint8 pred_Q8[ MAX_LPC_ORDER ];
47     const SideInfoIndices *psIndices;
48
49     if( encode_LBRR ) {
50          psIndices = &psEncC->indices_LBRR[ FrameIndex ];
51     } else {
52          psIndices = &psEncC->indices;
53     }
54
55     /*******************************************/
56     /* Encode signal type and quantizer offset */
57     /*******************************************/
58     typeOffset = 2 * psIndices->signalType + psIndices->quantOffsetType;
59     silk_assert( typeOffset >= 0 && typeOffset < 6 );
60     silk_assert( encode_LBRR == 0 || typeOffset >= 2 );
61     if( encode_LBRR || typeOffset >= 2 ) {
62         ec_enc_icdf( psRangeEnc, typeOffset - 2, silk_type_offset_VAD_iCDF, 8 );
63     } else {
64         ec_enc_icdf( psRangeEnc, typeOffset, silk_type_offset_no_VAD_iCDF, 8 );
65     }
66
67     /****************/
68     /* Encode gains */
69     /****************/
70     /* first subframe */
71     if( condCoding == CODE_CONDITIONALLY ) {
72         /* conditional coding */
73         silk_assert( psIndices->GainsIndices[ 0 ] >= 0 && psIndices->GainsIndices[ 0 ] < MAX_DELTA_GAIN_QUANT - MIN_DELTA_GAIN_QUANT + 1 );
74         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ 0 ], silk_delta_gain_iCDF, 8 );
75     } else {
76         /* independent coding, in two stages: MSB bits followed by 3 LSBs */
77         silk_assert( psIndices->GainsIndices[ 0 ] >= 0 && psIndices->GainsIndices[ 0 ] < N_LEVELS_QGAIN );
78         ec_enc_icdf( psRangeEnc, silk_RSHIFT( psIndices->GainsIndices[ 0 ], 3 ), silk_gain_iCDF[ psIndices->signalType ], 8 );
79         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ 0 ] & 7, silk_uniform8_iCDF, 8 );
80     }
81
82     /* remaining subframes */
83     for( i = 1; i < psEncC->nb_subfr; i++ ) {
84         silk_assert( psIndices->GainsIndices[ i ] >= 0 && psIndices->GainsIndices[ i ] < MAX_DELTA_GAIN_QUANT - MIN_DELTA_GAIN_QUANT + 1 );
85         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ i ], silk_delta_gain_iCDF, 8 );
86     }
87
88     /****************/
89     /* Encode NLSFs */
90     /****************/
91     ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ 0 ], &psEncC->psNLSF_CB->CB1_iCDF[ ( psIndices->signalType >> 1 ) * psEncC->psNLSF_CB->nVectors ], 8 );
92     silk_NLSF_unpack( ec_ix, pred_Q8, psEncC->psNLSF_CB, psIndices->NLSFIndices[ 0 ] );
93     silk_assert( psEncC->psNLSF_CB->order == psEncC->predictLPCOrder );
94     for( i = 0; i < psEncC->psNLSF_CB->order; i++ ) {
95         if( psIndices->NLSFIndices[ i+1 ] >= NLSF_QUANT_MAX_AMPLITUDE ) {
96             ec_enc_icdf( psRangeEnc, 2 * NLSF_QUANT_MAX_AMPLITUDE, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
97             ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ i+1 ] - NLSF_QUANT_MAX_AMPLITUDE, silk_NLSF_EXT_iCDF, 8 );
98         } else if( psIndices->NLSFIndices[ i+1 ] <= -NLSF_QUANT_MAX_AMPLITUDE ) {
99             ec_enc_icdf( psRangeEnc, 0, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
100             ec_enc_icdf( psRangeEnc, -psIndices->NLSFIndices[ i+1 ] - NLSF_QUANT_MAX_AMPLITUDE, silk_NLSF_EXT_iCDF, 8 );
101         } else {
102             ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ i+1 ] + NLSF_QUANT_MAX_AMPLITUDE, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
103         }
104     }
105
106     /* Encode NLSF interpolation factor */
107     if( psEncC->nb_subfr == MAX_NB_SUBFR ) {
108         silk_assert( psIndices->NLSFInterpCoef_Q2 >= 0 && psIndices->NLSFInterpCoef_Q2 < 5 );
109         ec_enc_icdf( psRangeEnc, psIndices->NLSFInterpCoef_Q2, silk_NLSF_interpolation_factor_iCDF, 8 );
110     }
111
112     if( psIndices->signalType == TYPE_VOICED )
113     {
114         /*********************/
115         /* Encode pitch lags */
116         /*********************/
117         /* lag index */
118         encode_absolute_lagIndex = 1;
119         if( condCoding == CODE_CONDITIONALLY && psEncC->ec_prevSignalType == TYPE_VOICED ) {
120             /* Delta Encoding */
121             delta_lagIndex = psIndices->lagIndex - psEncC->ec_prevLagIndex;
122             if( delta_lagIndex < -8 || delta_lagIndex > 11 ) {
123                 delta_lagIndex = 0;
124             } else {
125                 delta_lagIndex = delta_lagIndex + 9;
126                 encode_absolute_lagIndex = 0; /* Only use delta */
127             }
128             silk_assert( delta_lagIndex >= 0 && delta_lagIndex < 21 );
129             ec_enc_icdf( psRangeEnc, delta_lagIndex, silk_pitch_delta_iCDF, 8 );
130         }
131         if( encode_absolute_lagIndex ) {
132             /* Absolute encoding */
133             opus_int32 pitch_high_bits, pitch_low_bits;
134             pitch_high_bits = silk_DIV32_16( psIndices->lagIndex, silk_RSHIFT( psEncC->fs_kHz, 1 ) );
135             pitch_low_bits = psIndices->lagIndex - silk_SMULBB( pitch_high_bits, silk_RSHIFT( psEncC->fs_kHz, 1 ) );
136             silk_assert( pitch_low_bits < psEncC->fs_kHz / 2 );
137             silk_assert( pitch_high_bits < 32 );
138             ec_enc_icdf( psRangeEnc, pitch_high_bits, silk_pitch_lag_iCDF, 8 );
139             ec_enc_icdf( psRangeEnc, pitch_low_bits, psEncC->pitch_lag_low_bits_iCDF, 8 );
140         }
141         psEncC->ec_prevLagIndex = psIndices->lagIndex;
142
143         /* Countour index */
144         silk_assert(   psIndices->contourIndex  >= 0 );
145         silk_assert( ( psIndices->contourIndex < 34 && psEncC->fs_kHz  > 8 && psEncC->nb_subfr == 4 ) ||
146                     ( psIndices->contourIndex < 11 && psEncC->fs_kHz == 8 && psEncC->nb_subfr == 4 ) ||
147                     ( psIndices->contourIndex < 12 && psEncC->fs_kHz  > 8 && psEncC->nb_subfr == 2 ) ||
148                     ( psIndices->contourIndex <  3 && psEncC->fs_kHz == 8 && psEncC->nb_subfr == 2 ) );
149         ec_enc_icdf( psRangeEnc, psIndices->contourIndex, psEncC->pitch_contour_iCDF, 8 );
150
151         /********************/
152         /* Encode LTP gains */
153         /********************/
154         /* PERIndex value */
155         silk_assert( psIndices->PERIndex >= 0 && psIndices->PERIndex < 3 );
156         ec_enc_icdf( psRangeEnc, psIndices->PERIndex, silk_LTP_per_index_iCDF, 8 );
157
158         /* Codebook Indices */
159         for( k = 0; k < psEncC->nb_subfr; k++ ) {
160             silk_assert( psIndices->LTPIndex[ k ] >= 0 && psIndices->LTPIndex[ k ] < ( 8 << psIndices->PERIndex ) );
161             ec_enc_icdf( psRangeEnc, psIndices->LTPIndex[ k ], silk_LTP_gain_iCDF_ptrs[ psIndices->PERIndex ], 8 );
162         }
163
164         /**********************/
165         /* Encode LTP scaling */
166         /**********************/
167         if( condCoding == CODE_INDEPENDENTLY ) {
168             silk_assert( psIndices->LTP_scaleIndex >= 0 && psIndices->LTP_scaleIndex < 3 );
169             ec_enc_icdf( psRangeEnc, psIndices->LTP_scaleIndex, silk_LTPscale_iCDF, 8 );
170         }
171         silk_assert( !condCoding || psIndices->LTP_scaleIndex == 0 );
172     }
173
174     psEncC->ec_prevSignalType = psIndices->signalType;
175
176     /***************/
177     /* Encode seed */
178     /***************/
179     silk_assert( psIndices->Seed >= 0 && psIndices->Seed < 4 );
180     ec_enc_icdf( psRangeEnc, psIndices->Seed, silk_uniform4_iCDF, 8 );
181 }