SILK update with LBRR and some bugfixes
[opus.git] / src_common / SKP_Silk_decode_frame.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 #include "SKP_Silk_main.h"\r
29 #include "SKP_Silk_PLC.h"\r
30 \r
31 #define DECODE_NORMAL       0\r
32 #define PACKET_LOST         1\r
33 #define DECODE_LBRR         2\r
34 \r
35 /****************/\r
36 /* Decode frame */\r
37 /****************/\r
38 SKP_int SKP_Silk_decode_frame(\r
39     SKP_Silk_decoder_state      *psDec,             /* I/O  Pointer to Silk decoder state               */\r
40     ec_dec                      *psRangeDec,        /* I/O  Compressor data structure                   */\r
41     SKP_int16                   pOut[],             /* O    Pointer to output speech frame              */\r
42     SKP_int32                   *pN,                /* O    Pointer to size of output frame             */\r
43     const SKP_int               nBytes,             /* I    Payload length                              */\r
44     SKP_int                     lostFlag            /* I    0: no loss, 1 loss, 2 decode fec            */\r
45 )\r
46 {\r
47     SKP_Silk_decoder_control sDecCtrl;\r
48     SKP_int         i, L, mv_len, ret = 0;\r
49     SKP_int8        flags;\r
50     SKP_int32       LBRR_symbol;\r
51     SKP_int         pulses[ MAX_FRAME_LENGTH ];\r
52 \r
53 TIC(DECODE_FRAME)\r
54 \r
55     L = psDec->frame_length;\r
56     sDecCtrl.LTP_scale_Q14 = 0;\r
57 \r
58     /* Safety checks */\r
59     SKP_assert( L > 0 && L <= MAX_FRAME_LENGTH );\r
60 \r
61     /********************************************/\r
62     /* Decode Frame if packet is not lost       */\r
63     /********************************************/\r
64     if( lostFlag != PACKET_LOST && psDec->nFramesDecoded == 0 ) {\r
65         /* First decoder call for this payload */\r
66         /* Decode VAD flags and LBRR flag */\r
67         SKP_uint8 iCDF[ 2 ] = { 128, 0 };\r
68         flags = SKP_RSHIFT( psRangeDec->buf[ 0 ], 7 - psDec->nFramesPerPacket ) & \r
69             ( SKP_LSHIFT( 1, psDec->nFramesPerPacket + 1 ) - 1 );\r
70         psDec->LBRR_flag = flags & 1;\r
71         for( i = psDec->nFramesPerPacket - 1; i >= 0 ; i-- ) {\r
72             flags = SKP_RSHIFT( flags, 1 );\r
73             psDec->VAD_flags[ i ] = flags & 1;\r
74         }\r
75         for( i = 0; i < psDec->nFramesPerPacket + 1; i++ ) {\r
76             ec_dec_icdf( psRangeDec, iCDF, 8 );\r
77         }\r
78        \r
79         /* Decode LBRR flags */\r
80         SKP_memset( psDec->LBRR_flags, 0, sizeof( psDec->LBRR_flags ) );\r
81         if( psDec->LBRR_flag ) {\r
82             if( psDec->nFramesPerPacket == 1 ) {\r
83                 psDec->LBRR_flags[ 0 ] = 1;\r
84             } else {\r
85                 LBRR_symbol = ec_dec_icdf( psRangeDec, SKP_Silk_LBRR_flags_iCDF_ptr[ psDec->nFramesPerPacket - 2 ], 8 ) + 1;\r
86                 for( i = 0; i < psDec->nFramesPerPacket; i++ ) {\r
87                     psDec->LBRR_flags[ i ] = SKP_RSHIFT( LBRR_symbol, i ) & 1;\r
88                 }\r
89             }\r
90         }\r
91 \r
92         if( lostFlag == DECODE_NORMAL ) {\r
93             /* Regular decoding: skip all LBRR data */\r
94             for( i = 0; i < psDec->nFramesPerPacket; i++ ) {\r
95                 if( psDec->LBRR_flags[ i ] ) {\r
96                     SKP_Silk_decode_indices( psDec, psRangeDec, i, 1 );\r
97                     SKP_Silk_decode_pulses( psRangeDec, pulses, psDec->indices.signalType, \r
98                         psDec->indices.quantOffsetType, psDec->frame_length );\r
99                 }\r
100             }\r
101         }\r
102 \r
103     }\r
104 \r
105     if( lostFlag == DECODE_LBRR && psDec->LBRR_flags[ psDec->nFramesDecoded ] == 0 ) {\r
106         /* Treat absent LBRR data as lost frame */\r
107         lostFlag = PACKET_LOST;\r
108         psDec->nFramesDecoded++;\r
109     }\r
110 \r
111     if( lostFlag != PACKET_LOST ) {\r
112         /*********************************************/\r
113         /* Decode quantization indices of side info  */\r
114         /*********************************************/\r
115 TIC(decode_indices)\r
116         SKP_Silk_decode_indices( psDec, psRangeDec, psDec->nFramesDecoded, lostFlag );\r
117 TOC(decode_indices)\r
118 \r
119         /*********************************************/\r
120         /* Decode quantization indices of excitation */\r
121         /*********************************************/\r
122 TIC(decode_pulses)\r
123         SKP_Silk_decode_pulses( psRangeDec, pulses, psDec->indices.signalType, \r
124                 psDec->indices.quantOffsetType, psDec->frame_length );\r
125 TOC(decode_pulses)\r
126 \r
127         /********************************************/\r
128         /* Decode parameters and pulse signal       */\r
129         /********************************************/\r
130 TIC(decode_params)\r
131         SKP_Silk_decode_parameters( psDec, &sDecCtrl );\r
132 TOC(decode_params)\r
133 \r
134         /* Update length. Sampling frequency may have changed */\r
135         L = psDec->frame_length;\r
136 \r
137         /********************************************************/\r
138         /* Run inverse NSQ                                      */\r
139         /********************************************************/\r
140 TIC(decode_core)\r
141         SKP_Silk_decode_core( psDec, &sDecCtrl, pOut, pulses );\r
142 TOC(decode_core)\r
143 \r
144         /********************************************************/\r
145         /* Update PLC state                                     */\r
146         /********************************************************/\r
147         SKP_Silk_PLC( psDec, &sDecCtrl, pOut, L, 0 );\r
148 \r
149         psDec->lossCnt = 0;\r
150         psDec->prevSignalType = psDec->indices.signalType;\r
151         SKP_assert( psDec->prevSignalType >= 0 && psDec->prevSignalType <= 2 );\r
152 \r
153         /* A frame has been decoded without errors */\r
154         psDec->first_frame_after_reset = 0;\r
155         psDec->nFramesDecoded++;\r
156     } else {\r
157         /* Handle packet loss by extrapolation */\r
158         SKP_Silk_PLC( psDec, &sDecCtrl, pOut, L, 1 );\r
159     }\r
160 \r
161     /*************************/\r
162     /* Update output buffer. */\r
163     /*************************/\r
164     SKP_assert( psDec->ltp_mem_length >= psDec->frame_length );\r
165     mv_len = psDec->ltp_mem_length - psDec->frame_length;\r
166     SKP_memmove( psDec->outBuf, &psDec->outBuf[ psDec->frame_length ], mv_len * sizeof(SKP_int16) );\r
167     SKP_memcpy( &psDec->outBuf[ mv_len ], pOut, psDec->frame_length * sizeof( SKP_int16 ) );\r
168 \r
169     /****************************************************************/\r
170     /* Ensure smooth connection of extrapolated and good frames     */\r
171     /****************************************************************/\r
172     SKP_Silk_PLC_glue_frames( psDec, &sDecCtrl, pOut, L );\r
173 \r
174     /************************************************/\r
175     /* Comfort noise generation / estimation        */\r
176     /************************************************/\r
177     SKP_Silk_CNG( psDec, &sDecCtrl, pOut, L );\r
178 \r
179     /********************************************/\r
180     /* HP filter output                            */\r
181     /********************************************/\r
182 TIC(HP_out)\r
183     SKP_Silk_biquad_alt( pOut, psDec->HP_B, psDec->HP_A, psDec->HPState, pOut, L );\r
184 TOC(HP_out)\r
185 \r
186     /* Update some decoder state variables */\r
187     psDec->lagPrev = sDecCtrl.pitchL[ psDec->nb_subfr - 1 ];\r
188 \r
189     /********************************************/\r
190     /* set output frame length                    */\r
191     /********************************************/\r
192     *pN = ( SKP_int16 )L;\r
193 \r
194 TOC(DECODE_FRAME)\r
195 \r
196     return ret;\r
197 }\r
198