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