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