Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / 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, 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         SKP_Silk_decoder_set_fs( psDec, fs_kHz_dec );\r
54     \r
55         FrameIndex       = 0;\r
56         FrameTermination = SKP_SILK_MORE_FRAMES;\r
57     }\r
58 \r
59     while( FrameTermination == SKP_SILK_MORE_FRAMES ) {\r
60         /*******************/\r
61         /* Decode VAD flag */\r
62         /*******************/\r
63         SKP_Silk_range_decoder( &psDec->vadFlagBuf[ FrameIndex ], psRC, SKP_Silk_vadflag_CDF, SKP_Silk_vadflag_offset );\r
64 \r
65         /*******************************************/\r
66         /* Decode signal type and quantizer offset */\r
67         /*******************************************/\r
68         if( FrameIndex == 0 ) {\r
69             /* first frame in packet: independent coding */\r
70             SKP_Silk_range_decoder( &Ix, psRC, SKP_Silk_type_offset_CDF, SKP_Silk_type_offset_CDF_offset );\r
71         } else {\r
72             /* condidtional coding */\r
73             SKP_Silk_range_decoder( &Ix, psRC, SKP_Silk_type_offset_joint_CDF[ psDec->typeOffsetPrev ], \r
74                     SKP_Silk_type_offset_CDF_offset );\r
75         }\r
76         sigtype               = SKP_RSHIFT( Ix, 1 );\r
77         QuantOffsetType       = Ix & 1;\r
78         psDec->typeOffsetPrev = Ix;\r
79 \r
80         /****************/\r
81         /* Decode gains */\r
82         /****************/\r
83         /* first subframe */    \r
84         if( FrameIndex == 0 ) {\r
85             /* first frame in packet: independent coding */\r
86             SKP_Silk_range_decoder( &psDec->GainsIndices[ FrameIndex ][ 0 ], psRC, SKP_Silk_gain_CDF[ sigtype ], SKP_Silk_gain_CDF_offset );\r
87         } else {\r
88             /* condidtional coding */\r
89             SKP_Silk_range_decoder( &psDec->GainsIndices[ FrameIndex ][ 0 ], psRC, SKP_Silk_delta_gain_CDF, SKP_Silk_delta_gain_CDF_offset );\r
90         }\r
91 \r
92         /* remaining subframes */\r
93         for( i = 1; i < NB_SUBFR; i++ ) {\r
94             SKP_Silk_range_decoder( &psDec->GainsIndices[ FrameIndex ][ i ], psRC, SKP_Silk_delta_gain_CDF, SKP_Silk_delta_gain_CDF_offset );\r
95         }\r
96         \r
97         /**********************/\r
98         /* Decode LSF Indices */\r
99         /**********************/\r
100 \r
101         /* Set pointer to LSF VQ CB for the current signal type */\r
102         psNLSF_CB = psDec->psNLSF_CB[ sigtype ];\r
103 \r
104         /* Arithmetically decode NLSF path */\r
105         SKP_Silk_range_decoder_multi( psDec->NLSFIndices[ FrameIndex ], psRC, psNLSF_CB->StartPtr, psNLSF_CB->MiddleIx, psNLSF_CB->nStages );\r
106         \r
107         /***********************************/\r
108         /* Decode LSF interpolation factor */\r
109         /***********************************/\r
110         SKP_Silk_range_decoder( &psDec->NLSFInterpCoef_Q2[ FrameIndex ], psRC, SKP_Silk_NLSF_interpolation_factor_CDF, \r
111             SKP_Silk_NLSF_interpolation_factor_offset );\r
112         \r
113         if( sigtype == SIG_TYPE_VOICED ) {\r
114             /*********************/\r
115             /* Decode pitch lags */\r
116             /*********************/\r
117             /* Get lag index */\r
118             decode_absolute_lagIndex = 1;\r
119             if( FrameIndex > 0 && psDec->sigtype[ FrameIndex - 1 ] == SIG_TYPE_VOICED ) {\r
120                 /* Decode Delta index */\r
121                 SKP_Silk_range_decoder( &delta_lagIndex,psRC, SKP_Silk_pitch_delta_CDF,  SKP_Silk_pitch_delta_CDF_offset );\r
122                 if( delta_lagIndex < ( MAX_DELTA_LAG << 1 ) + 1 ) {\r
123                     delta_lagIndex = delta_lagIndex - MAX_DELTA_LAG;\r
124                     psDec->lagIndex[ FrameIndex ] = prev_lagIndex + delta_lagIndex;\r
125                     decode_absolute_lagIndex = 0;\r
126                 }\r
127             }\r
128             if( decode_absolute_lagIndex ) {\r
129                 /* Absolute decoding */\r
130                 if( psDec->fs_kHz == 8 ) {\r
131                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_NB_CDF,  SKP_Silk_pitch_lag_NB_CDF_offset );\r
132                 } else if( psDec->fs_kHz == 12 ) {\r
133                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_MB_CDF,  SKP_Silk_pitch_lag_MB_CDF_offset );\r
134                 } else if( psDec->fs_kHz == 16 ) {\r
135                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_WB_CDF,  SKP_Silk_pitch_lag_WB_CDF_offset );\r
136                 } else {\r
137                     SKP_Silk_range_decoder( &psDec->lagIndex[ FrameIndex ], psRC, SKP_Silk_pitch_lag_SWB_CDF, SKP_Silk_pitch_lag_SWB_CDF_offset );\r
138                 }\r
139             }\r
140             prev_lagIndex = psDec->lagIndex[ FrameIndex ];\r
141 \r
142             /* Get countour index */\r
143             if( psDec->fs_kHz == 8 ) {\r
144                 /* Less codevectors used in 8 khz mode */\r
145                 SKP_Silk_range_decoder( &psDec->contourIndex[ FrameIndex ], psRC, SKP_Silk_pitch_contour_NB_CDF, SKP_Silk_pitch_contour_NB_CDF_offset );\r
146             } else {\r
147                 /* Joint for 12, 16, and 24 khz */\r
148                 SKP_Silk_range_decoder( &psDec->contourIndex[ FrameIndex ], psRC, SKP_Silk_pitch_contour_CDF, SKP_Silk_pitch_contour_CDF_offset );\r
149             }\r
150             \r
151             /********************/\r
152             /* Decode LTP gains */\r
153             /********************/\r
154             /* Decode PERIndex value */\r
155             SKP_Silk_range_decoder( &psDec->PERIndex[ FrameIndex ], psRC, SKP_Silk_LTP_per_index_CDF, SKP_Silk_LTP_per_index_CDF_offset );\r
156             \r
157             for( k = 0; k < NB_SUBFR; k++ ) {\r
158                 SKP_Silk_range_decoder( &psDec->LTPIndex[ FrameIndex ][ k ], psRC, SKP_Silk_LTP_gain_CDF_ptrs[ psDec->PERIndex[ FrameIndex ] ], \r
159                     SKP_Silk_LTP_gain_CDF_offsets[ psDec->PERIndex[ FrameIndex ] ] );\r
160             }\r
161 \r
162             /**********************/\r
163             /* Decode LTP scaling */\r
164             /**********************/\r
165             SKP_Silk_range_decoder( &psDec->LTP_scaleIndex[ FrameIndex ], psRC, SKP_Silk_LTPscale_CDF, SKP_Silk_LTPscale_offset );\r
166         }\r
167 \r
168         /***************/\r
169         /* Decode seed */\r
170         /***************/\r
171         SKP_Silk_range_decoder( &seed_int, psRC, SKP_Silk_Seed_CDF, SKP_Silk_Seed_offset );\r
172         psDec->Seed[ FrameIndex ] = ( SKP_int32 )seed_int;\r
173         /**************************************/\r
174         /* Decode Frame termination indicator */\r
175         /**************************************/\r
176         SKP_Silk_range_decoder( &FrameTermination, psRC, SKP_Silk_FrameTermination_v4_CDF, SKP_Silk_FrameTermination_v4_offset );\r
177 \r
178         psDec->sigtype[ FrameIndex ]         = sigtype;\r
179         psDec->QuantOffsetType[ FrameIndex ] = QuantOffsetType;\r
180 \r
181         FrameIndex++;\r
182     }\r
183 \r
184     /****************************************/\r
185     /* get number of bytes used so far      */\r
186     /****************************************/\r
187     SKP_Silk_range_coder_get_length( psRC, &nBytesUsed );\r
188     psDec->nBytesLeft = psRC->bufferLength - nBytesUsed;\r
189     if( psDec->nBytesLeft < 0 ) {\r
190         psRC->error = RANGE_CODER_READ_BEYOND_BUFFER;\r
191     }\r
192 \r
193     psDec->nFramesInPacket  = FrameIndex;\r
194     psDec->FrameTermination = FrameTermination;\r
195 }\r