Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src_common / SKP_Silk_decode_indices_v4.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 #include "SKP_Silk_main.h"\r
29 \r
30 /* Decode indices from payload */\r
31 void SKP_Silk_decode_indices_v4(\r
32     SKP_Silk_decoder_state      *psDec            /* I/O    State                              */\r
33 )\r
34 {\r
35     SKP_int   i, k, Ix, fs_kHz_dec, nb_subfr, FrameIndex = 0, FrameTermination;\r
36     SKP_int   sigtype, QuantOffsetType, seed_int, nBytesUsed;\r
37     SKP_int   decode_absolute_lagIndex, delta_lagIndex, prev_lagIndex = 0;\r
38     const SKP_Silk_NLSF_CB_struct *psNLSF_CB = NULL;\r
39     SKP_Silk_range_coder_state  *psRC = &psDec->sRC;\r
40     /************************/\r
41     /* Decode sampling rate */\r
42     /************************/\r
43     /* only done for first frame of packet */\r
44     if( psDec->nFramesDecoded == 0 ) {\r
45         SKP_Silk_range_decoder( &Ix, psRC, SKP_Silk_SamplingRates_CDF, SKP_Silk_SamplingRates_offset );\r
46 \r
47         /* check that sampling rate is supported */\r
48         if( Ix < 0 || Ix > 3 ) {\r
49             psRC->error = RANGE_CODER_ILLEGAL_SAMPLING_RATE;\r
50             return;\r
51         }\r
52         fs_kHz_dec = SKP_Silk_SamplingRates_table[ Ix ];\r
53 \r
54         /* Convert number of subframes to index */\r
55         SKP_Silk_range_decoder( &Ix, psRC, SKP_Silk_NbSubframes_CDF, SKP_Silk_NbSubframes_offset );\r
56         nb_subfr = (Ix + 1) << 1;\r
57         SKP_assert( nb_subfr == MAX_NB_SUBFR >> 1 || nb_subfr == MAX_NB_SUBFR );\r
58         \r
59         SKP_Silk_decoder_set_fs( psDec, fs_kHz_dec, nb_subfr );\r
60     \r
61         FrameIndex       = 0;\r
62         FrameTermination = SKP_SILK_MORE_FRAMES;\r
63     }\r
64 \r
65     while( FrameTermination == SKP_SILK_MORE_FRAMES ) {\r
66         /*******************/\r
67         /* Decode VAD flag */\r
68         /*******************/\r
69         SKP_Silk_range_decoder( &psDec->vadFlagBuf[ FrameIndex ], psRC, SKP_Silk_vadflag_CDF, SKP_Silk_vadflag_offset );\r
70 \r
71         /*******************************************/\r
72         /* Decode signal type and quantizer offset */\r
73         /*******************************************/\r
74         if( FrameIndex == 0 ) {\r
75             /* first frame in packet: independent coding */\r
76             SKP_Silk_range_decoder( &Ix, psRC, SKP_Silk_type_offset_CDF, SKP_Silk_type_offset_CDF_offset );\r
77         } else {\r
78             /* condidtional coding */\r
79             SKP_Silk_range_decoder( &Ix, psRC, SKP_Silk_type_offset_joint_CDF[ psDec->typeOffsetPrev ], \r
80                     SKP_Silk_type_offset_CDF_offset );\r
81         }\r
82         sigtype               = SKP_RSHIFT( Ix, 1 );\r
83         QuantOffsetType       = Ix & 1;\r
84         psDec->typeOffsetPrev = Ix;\r
85 \r
86         /****************/\r
87         /* Decode gains */\r
88         /****************/\r
89         /* first subframe */    \r
90         if( FrameIndex == 0 ) {\r
91             /* first frame in packet: independent coding */\r
92             SKP_Silk_range_decoder( &psDec->GainsIndices[ FrameIndex ][ 0 ], psRC, SKP_Silk_gain_CDF[ sigtype ], SKP_Silk_gain_CDF_offset );\r
93         } else {\r
94             /* condidtional coding */\r
95             SKP_Silk_range_decoder( &psDec->GainsIndices[ FrameIndex ][ 0 ], psRC, SKP_Silk_delta_gain_CDF, SKP_Silk_delta_gain_CDF_offset );\r
96         }\r
97 \r
98         /* remaining subframes */\r
99         for( i = 1; i < psDec->nb_subfr; i++ ) {\r
100             SKP_Silk_range_decoder( &psDec->GainsIndices[ FrameIndex ][ i ], psRC, SKP_Silk_delta_gain_CDF, SKP_Silk_delta_gain_CDF_offset );\r
101         }\r
102         \r
103         /**********************/\r
104         /* Decode LSF Indices */\r
105         /**********************/\r
106 \r
107         /* Set pointer to LSF VQ CB for the current signal type */\r
108         psNLSF_CB = psDec->psNLSF_CB[ sigtype ];\r
109 \r
110         /* Arithmetically decode NLSF path */\r
111         SKP_Silk_range_decoder_multi( psDec->NLSFIndices[ FrameIndex ], psRC, psNLSF_CB->StartPtr, psNLSF_CB->MiddleIx, psNLSF_CB->nStages );\r
112         \r
113         /***********************************/\r
114         /* Decode LSF interpolation factor */\r
115         /***********************************/\r
116         SKP_Silk_range_decoder( &psDec->NLSFInterpCoef_Q2[ FrameIndex ], psRC, SKP_Silk_NLSF_interpolation_factor_CDF, \r
117             SKP_Silk_NLSF_interpolation_factor_offset );\r
118         \r
119         if( sigtype == SIG_TYPE_VOICED ) {\r
120             /*********************/\r
121             /* Decode pitch lags */\r
122             /*********************/\r
123             /* Get lag index */\r
124             decode_absolute_lagIndex = 1;\r
125             if( FrameIndex > 0 && psDec->sigtype[ FrameIndex - 1 ] == SIG_TYPE_VOICED ) {\r
126                 /* Decode Delta index */\r
127                 SKP_Silk_range_decoder( &delta_lagIndex,psRC, SKP_Silk_pitch_delta_CDF,  SKP_Silk_pitch_delta_CDF_offset );\r
128                 if( delta_lagIndex < ( MAX_DELTA_LAG << 1 ) + 1 ) {\r
129                     delta_lagIndex = delta_lagIndex - MAX_DELTA_LAG;\r
130                     psDec->lagIndex[ FrameIndex ] = prev_lagIndex + delta_lagIndex;\r
131                     decode_absolute_lagIndex = 0;\r
132                 }\r
133             }\r
134             if( decode_absolute_lagIndex ) {\r
135                 /* Absolute decoding */\r
136                 if( psDec->fs_kHz == 8 ) {\r
137                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_NB_CDF,  SKP_Silk_pitch_lag_NB_CDF_offset );\r
138                 } else if( psDec->fs_kHz == 12 ) {\r
139                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_MB_CDF,  SKP_Silk_pitch_lag_MB_CDF_offset );\r
140                 } else if( psDec->fs_kHz == 16 ) {\r
141                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_WB_CDF,  SKP_Silk_pitch_lag_WB_CDF_offset );\r
142                 } else {\r
143                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_SWB_CDF, SKP_Silk_pitch_lag_SWB_CDF_offset );\r
144                 }\r
145             }\r
146             prev_lagIndex = psDec->lagIndex[ FrameIndex ];\r
147 \r
148             /* Get countour index */\r
149             if( psDec->fs_kHz == 8 ) {\r
150                 /* Less codevectors used in 8 khz mode */\r
151                 SKP_Silk_range_decoder( &psDec->contourIndex[ FrameIndex ], psRC, SKP_Silk_pitch_contour_NB_CDF, SKP_Silk_pitch_contour_NB_CDF_offset );\r
152             } else {\r
153                 /* Joint for 12, 16, and 24 khz */\r
154                 SKP_Silk_range_decoder( &psDec->contourIndex[ FrameIndex ], psRC, SKP_Silk_pitch_contour_CDF, SKP_Silk_pitch_contour_CDF_offset );\r
155             }\r
156             \r
157             /********************/\r
158             /* Decode LTP gains */\r
159             /********************/\r
160             /* Decode PERIndex value */\r
161             SKP_Silk_range_decoder( &psDec->PERIndex[ FrameIndex ], psRC, SKP_Silk_LTP_per_index_CDF, SKP_Silk_LTP_per_index_CDF_offset );\r
162             \r
163             for( k = 0; k < psDec->nb_subfr; k++ ) {\r
164                 SKP_Silk_range_decoder( &psDec->LTPIndex[ FrameIndex ][ k ], psRC, SKP_Silk_LTP_gain_CDF_ptrs[ psDec->PERIndex[ FrameIndex ] ], \r
165                     SKP_Silk_LTP_gain_CDF_offsets[ psDec->PERIndex[ FrameIndex ] ] );\r
166             }\r
167 \r
168             /**********************/\r
169             /* Decode LTP scaling */\r
170             /**********************/\r
171             SKP_Silk_range_decoder( &psDec->LTP_scaleIndex[ FrameIndex ], psRC, SKP_Silk_LTPscale_CDF, SKP_Silk_LTPscale_offset );\r
172         }\r
173 \r
174         /***************/\r
175         /* Decode seed */\r
176         /***************/\r
177         SKP_Silk_range_decoder( &seed_int, psRC, SKP_Silk_Seed_CDF, SKP_Silk_Seed_offset );\r
178         psDec->Seed[ FrameIndex ] = ( SKP_int32 )seed_int;\r
179         /**************************************/\r
180         /* Decode Frame termination indicator */\r
181         /**************************************/\r
182         SKP_Silk_range_decoder( &FrameTermination, psRC, SKP_Silk_FrameTermination_v4_CDF, SKP_Silk_FrameTermination_v4_offset );\r
183 \r
184         psDec->sigtype[ FrameIndex ]         = sigtype;\r
185         psDec->QuantOffsetType[ FrameIndex ] = QuantOffsetType;\r
186 \r
187         FrameIndex++;\r
188     }\r
189 \r
190     /****************************************/\r
191     /* get number of bytes used so far      */\r
192     /****************************************/\r
193     SKP_Silk_range_decoder_get_length( psRC, &nBytesUsed );\r
194     psDec->nBytesLeft = psRC->range_dec_celt_state.buf->storage - nBytesUsed;\r
195 \r
196     if( psDec->nBytesLeft < 0 ) {\r
197         psRC->error = RANGE_CODER_READ_BEYOND_BUFFER;\r
198     }\r
199 \r
200     psDec->nFramesInPacket  = FrameIndex;\r
201     psDec->FrameTermination = FrameTermination;\r
202 }\r