Including config.h (fixes the fixed-point)
[opus.git] / silk / SKP_Silk_dec_API.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, 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 #ifdef HAVE_CONFIG_H\r
29 #include "config.h"\r
30 #endif\r
31 #include "SKP_Silk_SDK_API.h"\r
32 #include "SKP_Silk_main.h"\r
33 \r
34 /************************/\r
35 /* Decoder Super Struct */\r
36 /************************/\r
37 typedef struct {\r
38     SKP_Silk_decoder_state          channel_state[ DECODER_NUM_CHANNELS ];\r
39     stereo_state                    sStereo;\r
40     SKP_int                         nChannels;\r
41 } SKP_Silk_decoder;\r
42 \r
43 /*********************/\r
44 /* Decoder functions */\r
45 /*********************/\r
46 \r
47 SKP_int SKP_Silk_SDK_Get_Decoder_Size( SKP_int32 *decSizeBytes ) \r
48 {\r
49     SKP_int ret = SKP_SILK_NO_ERROR;\r
50 \r
51     *decSizeBytes = sizeof( SKP_Silk_decoder );\r
52 \r
53     return ret;\r
54 }\r
55 \r
56 /* Reset decoder state */\r
57 SKP_int SKP_Silk_SDK_InitDecoder(\r
58     void* decState                                      /* I/O: State                                          */\r
59 )\r
60 {\r
61     SKP_int n, ret = SKP_SILK_NO_ERROR;\r
62     SKP_Silk_decoder_state *channel_state = ((SKP_Silk_decoder *)decState)->channel_state;\r
63 \r
64     for( n = 0; n < DECODER_NUM_CHANNELS; n++ ) {\r
65         ret  = SKP_Silk_init_decoder( &channel_state[ n ] );\r
66     }\r
67 \r
68     return ret;\r
69 }\r
70 \r
71 /* Decode a frame */\r
72 SKP_int SKP_Silk_SDK_Decode(\r
73     void*                               decState,       /* I/O: State                                           */\r
74     SKP_SILK_SDK_DecControlStruct*      decControl,     /* I/O: Control Structure                               */\r
75     SKP_int                             lostFlag,       /* I:   0: no loss, 1 loss, 2 decode FEC                */\r
76     SKP_int                             newPacketFlag,  /* I:   Indicates first decoder call for this packet    */\r
77     ec_dec                              *psRangeDec,    /* I/O  Compressor data structure                       */\r
78     SKP_int16                           *samplesOut,    /* O:   Decoded output speech vector                    */\r
79     SKP_int32                           *nSamplesOut    /* O:   Number of samples decoded                       */\r
80 )\r
81 {\r
82     SKP_int   i, n, prev_fs_kHz, doResample, flags, nFlags, ret = SKP_SILK_NO_ERROR;\r
83     SKP_int32 nSamplesOutDec, LBRR_symbol;\r
84     SKP_int16 samplesOut1_tmp[ 2 * MAX_FS_KHZ * MAX_FRAME_LENGTH_MS ];\r
85     SKP_int16 samplesOut2_tmp[ MAX_API_FS_KHZ * MAX_FRAME_LENGTH_MS ];\r
86     SKP_int   MS_pred_Q14[ 2 ] = { 0 };\r
87     SKP_int16 *dec_out_ptr, *resample_out_ptr;\r
88     SKP_Silk_decoder *psDec = ( SKP_Silk_decoder * )decState;\r
89     SKP_Silk_decoder_state *channel_state = psDec->channel_state;\r
90 \r
91     /**********************************/\r
92     /* Test if first frame in payload */\r
93     /**********************************/\r
94     if( newPacketFlag ) {\r
95         for( n = 0; n < decControl->nChannels; n++ ) {\r
96             channel_state[ n ].nFramesDecoded = 0;  /* Used to count frames in packet */\r
97         }\r
98     }\r
99 \r
100     /* Save previous sample frequency */\r
101     prev_fs_kHz = channel_state[ 0 ].fs_kHz;\r
102 \r
103     if( decControl->nChannels > psDec->nChannels ) {\r
104         /* Mono -> Stereo transition: init state of second channel and stereo state */\r
105         SKP_memset( &psDec->sStereo, 0, sizeof( psDec->sStereo ) );\r
106         ret += SKP_Silk_init_decoder( &channel_state[ 1 ] );\r
107     }\r
108     psDec->nChannels = decControl->nChannels;\r
109 \r
110     for( n = 0; n < decControl->nChannels; n++ ) {\r
111         if( channel_state[ n ].nFramesDecoded == 0 ) {\r
112             SKP_int fs_kHz_dec;\r
113             if( decControl->payloadSize_ms == 10 ) {\r
114                 channel_state[ n ].nFramesPerPacket = 1;\r
115                 channel_state[ n ].nb_subfr = 2;\r
116             } else if( decControl->payloadSize_ms == 20 ) {\r
117                 channel_state[ n ].nFramesPerPacket = 1;\r
118                 channel_state[ n ].nb_subfr = 4;\r
119             } else if( decControl->payloadSize_ms == 40 ) {\r
120                 channel_state[ n ].nFramesPerPacket = 2;\r
121                 channel_state[ n ].nb_subfr = 4;\r
122             } else if( decControl->payloadSize_ms == 60 ) {\r
123                 channel_state[ n ].nFramesPerPacket = 3;\r
124                 channel_state[ n ].nb_subfr = 4;\r
125             } else {\r
126                 SKP_assert( 0 );\r
127                 return SKP_SILK_DEC_INVALID_FRAME_SIZE;\r
128             } \r
129             fs_kHz_dec = ( decControl->internalSampleRate >> 10 ) + 1;\r
130             if( fs_kHz_dec != 8 && fs_kHz_dec != 12 && fs_kHz_dec != 16 ) {\r
131                 SKP_assert( 0 );\r
132                 return SKP_SILK_DEC_INVALID_SAMPLING_FREQUENCY;\r
133             }\r
134             SKP_Silk_decoder_set_fs( &channel_state[ n ], fs_kHz_dec );\r
135         }\r
136     }\r
137     \r
138     if( decControl->API_sampleRate > MAX_API_FS_KHZ * 1000 || decControl->API_sampleRate < 8000 ) {\r
139         ret = SKP_SILK_DEC_INVALID_SAMPLING_FREQUENCY;\r
140         return( ret );\r
141     }\r
142 \r
143     doResample = SKP_SMULBB( channel_state[ 0 ].fs_kHz, 1000 ) != decControl->API_sampleRate;\r
144 \r
145     /* Set up pointers to temp buffers */\r
146     if( doResample || decControl->nChannels == 2 ) { \r
147         dec_out_ptr = samplesOut1_tmp;\r
148     } else {\r
149         dec_out_ptr = samplesOut;\r
150     }\r
151     if( decControl->nChannels == 2 ) {\r
152         resample_out_ptr = samplesOut2_tmp;\r
153     } else {\r
154         resample_out_ptr = samplesOut;\r
155     }\r
156 \r
157     if( lostFlag != FLAG_PACKET_LOST && channel_state[ 0 ].nFramesDecoded == 0 ) {\r
158         /* First decoder call for this payload */\r
159         nFlags = SKP_SMULBB( decControl->nChannels, channel_state[ 0 ].nFramesPerPacket + 1 );\r
160         flags = SKP_RSHIFT( psRangeDec->buf[ 0 ], 8 - nFlags ) & ( SKP_LSHIFT( 1, nFlags ) - 1 );\r
161         for( i = 0; i < nFlags; i++ ) {\r
162             ec_dec_icdf( psRangeDec, SKP_Silk_uniform2_iCDF, 8 );\r
163         }\r
164         /* Decode VAD flags and LBRR flag */\r
165         for( n = decControl->nChannels - 1; n >= 0; n-- ) {\r
166             channel_state[ n ].LBRR_flag = flags & 1;\r
167             flags = SKP_RSHIFT( flags, 1 );\r
168             for( i = channel_state[ n ].nFramesPerPacket - 1; i >= 0 ; i-- ) {\r
169                 channel_state[ n ].VAD_flags[ i ] = flags & 1;\r
170                 flags = SKP_RSHIFT( flags, 1 );\r
171             }\r
172         }       \r
173         /* Decode LBRR flags */\r
174         for( n = 0; n < decControl->nChannels; n++ ) {\r
175             SKP_memset( channel_state[ n ].LBRR_flags, 0, sizeof( channel_state[ n ].LBRR_flags ) );\r
176             if( channel_state[ n ].LBRR_flag ) {\r
177                 if( channel_state[ n ].nFramesPerPacket == 1 ) {\r
178                     channel_state[ n ].LBRR_flags[ 0 ] = 1;\r
179                 } else {\r
180                     LBRR_symbol = ec_dec_icdf( psRangeDec, SKP_Silk_LBRR_flags_iCDF_ptr[ channel_state[ n ].nFramesPerPacket - 2 ], 8 ) + 1;\r
181                     for( i = 0; i < channel_state[ n ].nFramesPerPacket; i++ ) {\r
182                         channel_state[ n ].LBRR_flags[ i ] = SKP_RSHIFT( LBRR_symbol, i ) & 1;\r
183                     }\r
184                 }\r
185             }\r
186         }\r
187 \r
188         if( lostFlag == FLAG_DECODE_NORMAL ) {\r
189             /* Regular decoding: skip all LBRR data */\r
190             for( i = 0; i < channel_state[ 0 ].nFramesPerPacket; i++ ) {\r
191                 for( n = 0; n < decControl->nChannels; n++ ) {\r
192                     if( channel_state[ n ].LBRR_flags[ i ] ) {\r
193                         SKP_int pulses[ MAX_FRAME_LENGTH ];\r
194                         SKP_Silk_decode_indices( &channel_state[ n ], psRangeDec, i, 1 );\r
195                         SKP_Silk_decode_pulses( psRangeDec, pulses, channel_state[ n ].indices.signalType, \r
196                             channel_state[ n ].indices.quantOffsetType, channel_state[ n ].frame_length );\r
197                     }\r
198                 }\r
199             }\r
200         }\r
201     }\r
202 \r
203     /* Get MS predictor index */\r
204     if( decControl->nChannels == 2 ) {\r
205         SKP_Silk_stereo_decode_pred( psRangeDec, MS_pred_Q14 );\r
206     }\r
207 \r
208     /* Call decoder for one frame */\r
209     for( n = 0; n < decControl->nChannels; n++ ) {\r
210         ret += SKP_Silk_decode_frame( &channel_state[ n ], psRangeDec, &dec_out_ptr[ n * MAX_FS_KHZ * MAX_FRAME_LENGTH_MS ], &nSamplesOutDec, lostFlag );\r
211     }\r
212 \r
213     /* Convert Mid/Side to Left/Right */\r
214     if( decControl->nChannels == 2 ) {\r
215         SKP_Silk_stereo_MS_to_LR( &psDec->sStereo, dec_out_ptr, &dec_out_ptr[ MAX_FS_KHZ * MAX_FRAME_LENGTH_MS ], MS_pred_Q14, channel_state[ 0 ].fs_kHz, nSamplesOutDec );\r
216     }\r
217 \r
218     /* Number of output samples */\r
219     if( doResample ) {\r
220         *nSamplesOut = SKP_DIV32( nSamplesOutDec * decControl->API_sampleRate, SKP_SMULBB( channel_state[ 0 ].fs_kHz, 1000 ) );\r
221     } else {\r
222         *nSamplesOut = nSamplesOutDec;\r
223     }\r
224 \r
225     for( n = 0; n < decControl->nChannels; n++ ) {\r
226         /* Resample if needed */\r
227         if( doResample ) {\r
228             /* Initialize resampler when switching internal or external sampling frequency */\r
229             if( prev_fs_kHz != channel_state[ n ].fs_kHz || channel_state[ n ].prev_API_sampleRate != decControl->API_sampleRate ) {\r
230                 ret = SKP_Silk_resampler_init( &channel_state[ n ].resampler_state, SKP_SMULBB( channel_state[ n ].fs_kHz, 1000 ), decControl->API_sampleRate );\r
231             }\r
232 \r
233             /* Resample the output to API_sampleRate */\r
234             ret += SKP_Silk_resampler( &channel_state[ n ].resampler_state, resample_out_ptr, &dec_out_ptr[ n * MAX_FS_KHZ * MAX_FRAME_LENGTH_MS ], nSamplesOutDec );\r
235         } else {\r
236             resample_out_ptr = &dec_out_ptr[ n * MAX_FS_KHZ * MAX_FRAME_LENGTH_MS ];\r
237         }\r
238 \r
239         /* Interleave if needed */\r
240         if( decControl->nChannels == 2 ) {\r
241             for( i = 0; i < *nSamplesOut; i++ ) {\r
242                 samplesOut[ n + 2 * i ] = resample_out_ptr[ i ];\r
243             }\r
244         }\r
245         \r
246         channel_state[ n ].prev_API_sampleRate = decControl->API_sampleRate;\r
247     }\r
248 \r
249     /* Copy parameters to control stucture */\r
250     decControl->frameSize        = ( SKP_int )*nSamplesOut;\r
251     decControl->framesPerPayload = ( SKP_int )channel_state[ n ].nFramesPerPacket;\r
252 \r
253     return ret;\r
254 }\r
255 \r
256 /* Getting table of contents for a packet */\r
257 SKP_int SKP_Silk_SDK_get_TOC(\r
258     const SKP_uint8                     *payload,           /* I    Payload data                                */\r
259     const SKP_int                       nBytesIn,           /* I:   Number of input bytes                       */\r
260     const SKP_int                       nFramesPerPayload,  /* I:   Number of SILK frames per payload           */\r
261     SKP_Silk_TOC_struct                 *Silk_TOC           /* O:   Type of content                             */\r
262 )\r
263 {\r
264     SKP_int i, flags, ret = SKP_SILK_NO_ERROR;\r
265 \r
266     if( nBytesIn < 1 ) {\r
267         return -1;\r
268     }\r
269     if( nFramesPerPayload < 0 || nFramesPerPayload > 3 ) {\r
270         return -1;\r
271     }\r
272 \r
273     SKP_memset( Silk_TOC, 0, sizeof( Silk_TOC ) );\r
274 \r
275     /* For stereo, extract the flags for the mid channel */\r
276     flags = SKP_RSHIFT( payload[ 0 ], 7 - nFramesPerPayload ) & ( SKP_LSHIFT( 1, nFramesPerPayload + 1 ) - 1 );\r
277 \r
278     Silk_TOC->inbandFECFlag = flags & 1;\r
279     for( i = nFramesPerPayload - 1; i >= 0 ; i-- ) {\r
280         flags = SKP_RSHIFT( flags, 1 );\r
281         Silk_TOC->VADFlags[ i ] = flags & 1;\r
282         Silk_TOC->VADFlag |= flags & 1;\r
283     }\r
284 \r
285     return ret;\r
286 }\r