Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src_common / SKP_Silk_decode_frame.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 \r
29 #include "SKP_Silk_main.h"\r
30 #include "SKP_Silk_PLC.h"\r
31 \r
32 /****************/\r
33 /* Decode frame */\r
34 /****************/\r
35 SKP_int SKP_Silk_decode_frame(\r
36     SKP_Silk_decoder_state          *psDec,             /* I/O  Pointer to Silk decoder state               */\r
37     SKP_int16                       pOut[],             /* O    Pointer to output speech frame              */\r
38     SKP_int16                       *pN,                /* O    Pointer to size of output frame             */\r
39     const SKP_uint8                 pCode[],            /* I    Pointer to payload                          */\r
40     const SKP_int                   nBytes,             /* I    Payload length                              */\r
41     SKP_int                         action,             /* I    Action from Jitter Buffer                   */\r
42     SKP_int                         *decBytes           /* O    Used bytes to decode this frame             */\r
43 )\r
44 {\r
45     SKP_Silk_decoder_control sDecCtrl;\r
46     SKP_int         L, fs_Khz_old, nb_subfr_old, mv_len, ret = 0;\r
47     SKP_int         Pulses[ MAX_FRAME_LENGTH ];\r
48     ec_byte_buffer range_dec_celt_buf;\r
49 \r
50 TIC(decode_frame)\r
51 \r
52     L = psDec->frame_length;\r
53     sDecCtrl.LTP_scale_Q14 = 0;\r
54     \r
55     /* Safety checks */\r
56     SKP_assert( L > 0 && L <= MAX_FRAME_LENGTH );\r
57 \r
58     /********************************************/\r
59     /* Decode Frame if packet is not lost  */\r
60     /********************************************/\r
61     *decBytes = 0;\r
62     if( action == 0 ) {\r
63         /********************************************/\r
64         /* Initialize arithmetic coder              */\r
65         /********************************************/\r
66         fs_Khz_old    = psDec->fs_kHz;\r
67         nb_subfr_old  = psDec->nb_subfr;\r
68         if( psDec->nFramesDecoded == 0 ) {\r
69             /* Initialize range decoder state */\r
70             /* check input */\r
71             psDec->sRC.error = 0;\r
72             if( nBytes > MAX_ARITHM_BYTES ) {\r
73                 psDec->sRC.error = RANGE_CODER_DEC_PAYLOAD_TOO_LONG;\r
74             }\r
75             ec_byte_writeinit_buffer( &range_dec_celt_buf, psDec->sRC.buffer, nBytes );\r
76             SKP_memcpy( psDec->sRC.buffer, pCode, nBytes * sizeof( SKP_uint8 ) );\r
77             ec_dec_init( &psDec->sRC.range_dec_celt_state, &range_dec_celt_buf );\r
78 \r
79             SKP_Silk_decode_indices_v4( psDec );\r
80         }\r
81 \r
82         /********************************************/\r
83         /* Decode parameters and pulse signal       */\r
84         /********************************************/\r
85 TIC(decode_params)\r
86         SKP_Silk_decode_parameters_v4( psDec, &sDecCtrl, Pulses, 1 );\r
87 TOC(decode_params)\r
88 \r
89         if( psDec->sRC.error ) {\r
90             psDec->nBytesLeft = 0;\r
91 \r
92             action              = 1; /* PLC operation */\r
93             SKP_Silk_decoder_set_fs( psDec, fs_Khz_old, nb_subfr_old );\r
94 \r
95             /* Avoid crashing */\r
96             *decBytes = psDec->sRC.range_dec_celt_state.buf->storage; \r
97             if( psDec->sRC.error == RANGE_CODER_DEC_PAYLOAD_TOO_LONG ) {\r
98                 ret = SKP_SILK_DEC_PAYLOAD_TOO_LARGE;\r
99             } else {\r
100                 ret = SKP_SILK_DEC_PAYLOAD_ERROR;\r
101             }\r
102         } else {\r
103             *decBytes = psDec->sRC.range_dec_celt_state.buf->storage - psDec->nBytesLeft;\r
104             psDec->nFramesDecoded++;\r
105         \r
106             /* Update lengths. Sampling frequency could have changed */\r
107             L = psDec->frame_length;\r
108 \r
109             /********************************************************/\r
110             /* Run inverse NSQ                                      */\r
111             /********************************************************/\r
112 TIC(decode_core)\r
113             SKP_Silk_decode_core( psDec, &sDecCtrl, pOut, Pulses );\r
114 TOC(decode_core)\r
115 \r
116             /********************************************************/\r
117             /* Update PLC state                                     */\r
118             /********************************************************/\r
119             SKP_Silk_PLC( psDec, &sDecCtrl, pOut, L, action );\r
120 \r
121             psDec->lossCnt = 0;\r
122             psDec->prev_sigtype = sDecCtrl.sigtype;\r
123 \r
124             /* A frame has been decoded without errors */\r
125             psDec->first_frame_after_reset = 0;\r
126         }\r
127     }\r
128     /*************************************************************/\r
129     /* Generate Concealment frame if packet is lost, or corrupt  */\r
130     /*************************************************************/\r
131     if( action == 1 ) {\r
132         /* Handle packet loss by extrapolation */\r
133         SKP_Silk_PLC( psDec, &sDecCtrl, pOut, L, action );\r
134         psDec->lossCnt++;\r
135     }\r
136 \r
137     /*************************/\r
138     /* Update output buffer. */\r
139     /*************************/\r
140     SKP_assert( psDec->ltp_mem_length >= psDec->frame_length );\r
141     mv_len = psDec->ltp_mem_length - psDec->frame_length;\r
142     SKP_memmove( psDec->outBuf, &psDec->outBuf[ psDec->ltp_mem_length - mv_len ], \r
143         mv_len * sizeof(SKP_int16) );\r
144     SKP_memcpy( &psDec->outBuf[ mv_len ], pOut, \r
145         psDec->frame_length * sizeof( SKP_int16 ) );\r
146 \r
147     /****************************************************************/\r
148     /* Ensure smooth connection of extrapolated and good frames     */\r
149     /****************************************************************/\r
150     SKP_Silk_PLC_glue_frames( psDec, &sDecCtrl, pOut, L );\r
151 \r
152     /************************************************/\r
153     /* Comfort noise generation / estimation        */\r
154     /************************************************/\r
155     SKP_Silk_CNG( psDec, &sDecCtrl, pOut , L );\r
156 \r
157     /********************************************/\r
158     /* HP filter output                            */\r
159     /********************************************/\r
160     SKP_assert( ( ( psDec->fs_kHz == 12 ) && ( L % 3 ) == 0 ) || \r
161                 ( ( psDec->fs_kHz != 12 ) && ( L % 2 ) == 0 ) );\r
162 TIC(HP_out)\r
163     SKP_Silk_biquad( pOut, psDec->HP_B, psDec->HP_A, psDec->HPState, pOut, L );\r
164 TOC(HP_out)\r
165 \r
166     /********************************************/\r
167     /* set output frame length                    */\r
168     /********************************************/\r
169     *pN = ( SKP_int16 )L;\r
170 \r
171     /* Update some decoder state variables */\r
172     psDec->lagPrev = sDecCtrl.pitchL[ MAX_NB_SUBFR - 1 ];\r
173 TOC(decode_frame)\r
174 \r
175     return ret;\r
176 }\r