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