Moved all SILK source code to the silk/ directory
[opus.git] / silk / 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 /****************/\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     SKP_int                     lostFlag            /* I    0: no loss, 1 loss, 2 decode fec            */\r
40 )\r
41 {\r
42     SKP_Silk_decoder_control sDecCtrl;\r
43     SKP_int         L, mv_len, ret = 0;\r
44     SKP_int         pulses[ MAX_FRAME_LENGTH ];\r
45 \r
46 TIC(DECODE_FRAME)\r
47 \r
48     L = psDec->frame_length;\r
49     sDecCtrl.LTP_scale_Q14 = 0;\r
50 \r
51     /* Safety checks */\r
52     SKP_assert( L > 0 && L <= MAX_FRAME_LENGTH );\r
53 \r
54     if(   lostFlag == FLAG_DECODE_NORMAL || \r
55         ( lostFlag == FLAG_DECODE_LBRR && psDec->LBRR_flags[ psDec->nFramesDecoded ] == 1 ) ) \r
56     {\r
57         /*********************************************/\r
58         /* Decode quantization indices of side info  */\r
59         /*********************************************/\r
60 TIC(decode_indices)\r
61         SKP_Silk_decode_indices( psDec, psRangeDec, psDec->nFramesDecoded, lostFlag );\r
62 TOC(decode_indices)\r
63 \r
64         /*********************************************/\r
65         /* Decode quantization indices of excitation */\r
66         /*********************************************/\r
67 TIC(decode_pulses)\r
68         SKP_Silk_decode_pulses( psRangeDec, pulses, psDec->indices.signalType, \r
69                 psDec->indices.quantOffsetType, psDec->frame_length );\r
70 TOC(decode_pulses)\r
71 \r
72         /********************************************/\r
73         /* Decode parameters and pulse signal       */\r
74         /********************************************/\r
75 TIC(decode_params)\r
76         SKP_Silk_decode_parameters( psDec, &sDecCtrl );\r
77 TOC(decode_params)\r
78 \r
79         /* Update length. Sampling frequency may have changed */\r
80         L = psDec->frame_length;\r
81 \r
82         /********************************************************/\r
83         /* Run inverse NSQ                                      */\r
84         /********************************************************/\r
85 TIC(decode_core)\r
86         SKP_Silk_decode_core( psDec, &sDecCtrl, pOut, pulses );\r
87 TOC(decode_core)\r
88 \r
89         /********************************************************/\r
90         /* Update PLC state                                     */\r
91         /********************************************************/\r
92         SKP_Silk_PLC( psDec, &sDecCtrl, pOut, L, 0 );\r
93 \r
94         psDec->lossCnt = 0;\r
95         psDec->prevSignalType = psDec->indices.signalType;\r
96         SKP_assert( psDec->prevSignalType >= 0 && psDec->prevSignalType <= 2 );\r
97 \r
98         /* A frame has been decoded without errors */\r
99         psDec->first_frame_after_reset = 0;\r
100     } else {\r
101         /* Handle packet loss by extrapolation */\r
102         SKP_Silk_PLC( psDec, &sDecCtrl, pOut, L, 1 );\r
103     }\r
104 \r
105     /*************************/\r
106     /* Update output buffer. */\r
107     /*************************/\r
108     SKP_assert( psDec->ltp_mem_length >= psDec->frame_length );\r
109     mv_len = psDec->ltp_mem_length - psDec->frame_length;\r
110     SKP_memmove( psDec->outBuf, &psDec->outBuf[ psDec->frame_length ], mv_len * sizeof(SKP_int16) );\r
111     SKP_memcpy( &psDec->outBuf[ mv_len ], pOut, psDec->frame_length * sizeof( SKP_int16 ) );\r
112 \r
113     /****************************************************************/\r
114     /* Ensure smooth connection of extrapolated and good frames     */\r
115     /****************************************************************/\r
116     SKP_Silk_PLC_glue_frames( psDec, &sDecCtrl, pOut, L );\r
117 \r
118     /************************************************/\r
119     /* Comfort noise generation / estimation        */\r
120     /************************************************/\r
121     SKP_Silk_CNG( psDec, &sDecCtrl, pOut, L );\r
122 \r
123     /* Update some decoder state variables */\r
124     psDec->lagPrev = sDecCtrl.pitchL[ psDec->nb_subfr - 1 ];\r
125     psDec->nFramesDecoded++;\r
126 \r
127     /* Set output frame length */\r
128     *pN = L;\r
129 \r
130 TOC(DECODE_FRAME)\r
131 \r
132     return ret;\r
133 }\r
134