Adjusts the bandwidth thresholds depending on complexity and CBR
[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 #if SAVE_ALL_INTERNAL_DATA
49     opus_int nBytes_lagIndex, nBytes_contourIndex, nBytes_LTP;
50     opus_int nBytes_after, nBytes_before;
51 #endif
52
53     if( encode_LBRR ) {
54          psIndices = &psEncC->indices_LBRR[ FrameIndex ];
55     } else {
56          psIndices = &psEncC->indices;
57     }
58
59     /*******************************************/
60     /* Encode signal type and quantizer offset */
61     /*******************************************/
62     typeOffset = 2 * psIndices->signalType + psIndices->quantOffsetType;
63     silk_assert( typeOffset >= 0 && typeOffset < 6 );
64     silk_assert( encode_LBRR == 0 || typeOffset >= 2 );
65     if( encode_LBRR || typeOffset >= 2 ) {
66         ec_enc_icdf( psRangeEnc, typeOffset - 2, silk_type_offset_VAD_iCDF, 8 );
67     } else {
68         ec_enc_icdf( psRangeEnc, typeOffset, silk_type_offset_no_VAD_iCDF, 8 );
69     }
70
71     /****************/
72     /* Encode gains */
73     /****************/
74 #ifdef SAVE_ALL_INTERNAL_DATA
75     nBytes_before = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
76 #endif
77     /* first subframe */
78     if( condCoding == CODE_CONDITIONALLY ) {
79         /* conditional coding */
80         silk_assert( psIndices->GainsIndices[ 0 ] >= 0 && psIndices->GainsIndices[ 0 ] < MAX_DELTA_GAIN_QUANT - MIN_DELTA_GAIN_QUANT + 1 );
81         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ 0 ], silk_delta_gain_iCDF, 8 );
82     } else {
83         /* independent coding, in two stages: MSB bits followed by 3 LSBs */
84         silk_assert( psIndices->GainsIndices[ 0 ] >= 0 && psIndices->GainsIndices[ 0 ] < N_LEVELS_QGAIN );
85         ec_enc_icdf( psRangeEnc, silk_RSHIFT( psIndices->GainsIndices[ 0 ], 3 ), silk_gain_iCDF[ psIndices->signalType ], 8 );
86         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ 0 ] & 7, silk_uniform8_iCDF, 8 );
87     }
88
89     /* remaining subframes */
90     for( i = 1; i < psEncC->nb_subfr; i++ ) {
91         silk_assert( psIndices->GainsIndices[ i ] >= 0 && psIndices->GainsIndices[ i ] < MAX_DELTA_GAIN_QUANT - MIN_DELTA_GAIN_QUANT + 1 );
92         ec_enc_icdf( psRangeEnc, psIndices->GainsIndices[ i ], silk_delta_gain_iCDF, 8 );
93     }
94
95 #ifdef SAVE_ALL_INTERNAL_DATA
96     nBytes_after = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
97     nBytes_after -= nBytes_before; /* bytes just added*/
98     DEBUG_STORE_DATA( nBytes_gains.dat, &nBytes_after, sizeof( opus_int ) );
99 #endif
100
101     /****************/
102     /* Encode NLSFs */
103     /****************/
104 #ifdef SAVE_ALL_INTERNAL_DATA
105     nBytes_before = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
106 #endif
107     ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ 0 ], &psEncC->psNLSF_CB->CB1_iCDF[ ( psIndices->signalType >> 1 ) * psEncC->psNLSF_CB->nVectors ], 8 );
108     silk_NLSF_unpack( ec_ix, pred_Q8, psEncC->psNLSF_CB, psIndices->NLSFIndices[ 0 ] );
109     silk_assert( psEncC->psNLSF_CB->order == psEncC->predictLPCOrder );
110     for( i = 0; i < psEncC->psNLSF_CB->order; i++ ) {
111         if( psIndices->NLSFIndices[ i+1 ] >= NLSF_QUANT_MAX_AMPLITUDE ) {
112             ec_enc_icdf( psRangeEnc, 2 * NLSF_QUANT_MAX_AMPLITUDE, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
113             ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ i+1 ] - NLSF_QUANT_MAX_AMPLITUDE, silk_NLSF_EXT_iCDF, 8 );
114         } else if( psIndices->NLSFIndices[ i+1 ] <= -NLSF_QUANT_MAX_AMPLITUDE ) {
115             ec_enc_icdf( psRangeEnc, 0, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
116             ec_enc_icdf( psRangeEnc, -psIndices->NLSFIndices[ i+1 ] - NLSF_QUANT_MAX_AMPLITUDE, silk_NLSF_EXT_iCDF, 8 );
117         } else {
118             ec_enc_icdf( psRangeEnc, psIndices->NLSFIndices[ i+1 ] + NLSF_QUANT_MAX_AMPLITUDE, &psEncC->psNLSF_CB->ec_iCDF[ ec_ix[ i ] ], 8 );
119         }
120     }
121
122     /* Encode NLSF interpolation factor */
123     if( psEncC->nb_subfr == MAX_NB_SUBFR ) {
124         silk_assert( psIndices->NLSFInterpCoef_Q2 >= 0 && psIndices->NLSFInterpCoef_Q2 < 5 );
125         ec_enc_icdf( psRangeEnc, psIndices->NLSFInterpCoef_Q2, silk_NLSF_interpolation_factor_iCDF, 8 );
126     }
127
128 #ifdef SAVE_ALL_INTERNAL_DATA
129     DEBUG_STORE_DATA( lsf_interpol.dat, &psIndices->NLSFInterpCoef_Q2, sizeof(int) );
130     nBytes_after = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
131     nBytes_after -= nBytes_before; /* bytes just added*/
132     DEBUG_STORE_DATA( nBytes_LSF.dat, &nBytes_after, sizeof( opus_int ) );
133 #endif
134
135     if( psIndices->signalType == TYPE_VOICED )
136     {
137         /*********************/
138         /* Encode pitch lags */
139         /*********************/
140 #ifdef SAVE_ALL_INTERNAL_DATA
141         nBytes_before = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
142 #endif
143         /* lag index */
144         encode_absolute_lagIndex = 1;
145         if( condCoding == CODE_CONDITIONALLY && psEncC->ec_prevSignalType == TYPE_VOICED ) {
146             /* Delta Encoding */
147             delta_lagIndex = psIndices->lagIndex - psEncC->ec_prevLagIndex;
148             if( delta_lagIndex < -8 || delta_lagIndex > 11 ) {
149                 delta_lagIndex = 0;
150             } else {
151                 delta_lagIndex = delta_lagIndex + 9;
152                 encode_absolute_lagIndex = 0; /* Only use delta */
153             }
154             silk_assert( delta_lagIndex >= 0 && delta_lagIndex < 21 );
155             ec_enc_icdf( psRangeEnc, delta_lagIndex, silk_pitch_delta_iCDF, 8 );
156         }
157         if( encode_absolute_lagIndex ) {
158             /* Absolute encoding */
159             opus_int32 pitch_high_bits, pitch_low_bits;
160             pitch_high_bits = silk_DIV32_16( psIndices->lagIndex, silk_RSHIFT( psEncC->fs_kHz, 1 ) );
161             pitch_low_bits = psIndices->lagIndex - silk_SMULBB( pitch_high_bits, silk_RSHIFT( psEncC->fs_kHz, 1 ) );
162             silk_assert( pitch_low_bits < psEncC->fs_kHz / 2 );
163             silk_assert( pitch_high_bits < 32 );
164             ec_enc_icdf( psRangeEnc, pitch_high_bits, silk_pitch_lag_iCDF, 8 );
165             ec_enc_icdf( psRangeEnc, pitch_low_bits, psEncC->pitch_lag_low_bits_iCDF, 8 );
166         }
167         psEncC->ec_prevLagIndex = psIndices->lagIndex;
168
169 #ifdef SAVE_ALL_INTERNAL_DATA
170         nBytes_after = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
171         nBytes_lagIndex = nBytes_after - nBytes_before; /* bytes just added*/
172 #endif
173
174 #ifdef SAVE_ALL_INTERNAL_DATA
175         nBytes_before = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
176 #endif
177         /* Countour index */
178         silk_assert(   psIndices->contourIndex  >= 0 );
179         silk_assert( ( psIndices->contourIndex < 34 && psEncC->fs_kHz  > 8 && psEncC->nb_subfr == 4 ) ||
180                     ( psIndices->contourIndex < 11 && psEncC->fs_kHz == 8 && psEncC->nb_subfr == 4 ) ||
181                     ( psIndices->contourIndex < 12 && psEncC->fs_kHz  > 8 && psEncC->nb_subfr == 2 ) ||
182                     ( psIndices->contourIndex <  3 && psEncC->fs_kHz == 8 && psEncC->nb_subfr == 2 ) );
183         ec_enc_icdf( psRangeEnc, psIndices->contourIndex, psEncC->pitch_contour_iCDF, 8 );
184 #ifdef SAVE_ALL_INTERNAL_DATA
185         nBytes_after = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
186         nBytes_contourIndex = nBytes_after - nBytes_before; /* bytes just added*/
187 #endif
188
189         /********************/
190         /* Encode LTP gains */
191         /********************/
192 #ifdef SAVE_ALL_INTERNAL_DATA
193         nBytes_before = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
194 #endif
195
196         /* PERIndex value */
197         silk_assert( psIndices->PERIndex >= 0 && psIndices->PERIndex < 3 );
198         ec_enc_icdf( psRangeEnc, psIndices->PERIndex, silk_LTP_per_index_iCDF, 8 );
199
200         /* Codebook Indices */
201         for( k = 0; k < psEncC->nb_subfr; k++ ) {
202             silk_assert( psIndices->LTPIndex[ k ] >= 0 && psIndices->LTPIndex[ k ] < ( 8 << psIndices->PERIndex ) );
203             ec_enc_icdf( psRangeEnc, psIndices->LTPIndex[ k ], silk_LTP_gain_iCDF_ptrs[ psIndices->PERIndex ], 8 );
204         }
205
206         /**********************/
207         /* Encode LTP scaling */
208         /**********************/
209         if( condCoding == CODE_INDEPENDENTLY ) {
210             silk_assert( psIndices->LTP_scaleIndex >= 0 && psIndices->LTP_scaleIndex < 3 );
211             ec_enc_icdf( psRangeEnc, psIndices->LTP_scaleIndex, silk_LTPscale_iCDF, 8 );
212         }
213         silk_assert( !condCoding || psIndices->LTP_scaleIndex == 0 );
214
215 #ifdef SAVE_ALL_INTERNAL_DATA
216         nBytes_after = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
217         nBytes_LTP = nBytes_after - nBytes_before; /* bytes just added*/
218 #endif
219     }
220 #ifdef SAVE_ALL_INTERNAL_DATA
221     else {
222         /* Unvoiced speech*/
223         nBytes_lagIndex     = 0;
224         nBytes_contourIndex = 0;
225         nBytes_LTP          = 0;
226     }
227     DEBUG_STORE_DATA( nBytes_lagIndex.dat,      &nBytes_lagIndex,       sizeof( opus_int ) );
228     DEBUG_STORE_DATA( nBytes_contourIndex.dat,  &nBytes_contourIndex,   sizeof( opus_int ) );
229     DEBUG_STORE_DATA( nBytes_LTP.dat,           &nBytes_LTP,            sizeof( opus_int ) );
230 #endif
231
232     psEncC->ec_prevSignalType = psIndices->signalType;
233
234 #ifdef SAVE_ALL_INTERNAL_DATA
235     nBytes_before = silk_RSHIFT( ec_tell( psRangeEnc ) + 7, 3 );
236 #endif
237
238     /***************/
239     /* Encode seed */
240     /***************/
241     silk_assert( psIndices->Seed >= 0 && psIndices->Seed < 4 );
242     ec_enc_icdf( psRangeEnc, psIndices->Seed, silk_uniform4_iCDF, 8 );
243 }