54bb920bfc0c6d97f8dd7bd86305dc0dd4740b0b
[opus.git] / silk / decode_frame.c
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "main.h"
33 #include "PLC.h"
34
35 /****************/
36 /* Decode frame */
37 /****************/
38 opus_int silk_decode_frame(
39     silk_decoder_state      *psDec,             /* I/O  Pointer to Silk decoder state               */
40     ec_dec                      *psRangeDec,        /* I/O  Compressor data structure                   */
41     opus_int16                   pOut[],             /* O    Pointer to output speech frame              */
42     opus_int32                   *pN,                /* O    Pointer to size of output frame             */
43     opus_int                     lostFlag,           /* I    0: no loss, 1 loss, 2 decode fec            */
44     opus_int                     condCoding          /* I    The type of conditional coding to use       */
45 )
46 {
47     silk_decoder_control sDecCtrl;
48     opus_int         L, mv_len, ret = 0;
49     opus_int         pulses[ MAX_FRAME_LENGTH ];
50
51 TIC(DECODE_FRAME)
52
53     L = psDec->frame_length;
54     sDecCtrl.LTP_scale_Q14 = 0;
55
56     /* Safety checks */
57     silk_assert( L > 0 && L <= MAX_FRAME_LENGTH );
58
59     if(   lostFlag == FLAG_DECODE_NORMAL ||
60         ( lostFlag == FLAG_DECODE_LBRR && psDec->LBRR_flags[ psDec->nFramesDecoded ] == 1 ) )
61     {
62         /*********************************************/
63         /* Decode quantization indices of side info  */
64         /*********************************************/
65 TIC(decode_indices)
66         silk_decode_indices( psDec, psRangeDec, psDec->nFramesDecoded, lostFlag, condCoding );
67 TOC(decode_indices)
68
69         /*********************************************/
70         /* Decode quantization indices of excitation */
71         /*********************************************/
72 TIC(decode_pulses)
73         silk_decode_pulses( psRangeDec, pulses, psDec->indices.signalType,
74                 psDec->indices.quantOffsetType, psDec->frame_length );
75 TOC(decode_pulses)
76
77         /********************************************/
78         /* Decode parameters and pulse signal       */
79         /********************************************/
80 TIC(decode_params)
81         silk_decode_parameters( psDec, &sDecCtrl, condCoding );
82 TOC(decode_params)
83
84         /* Update length. Sampling frequency may have changed */
85         L = psDec->frame_length;
86
87         /********************************************************/
88         /* Run inverse NSQ                                      */
89         /********************************************************/
90 TIC(decode_core)
91         silk_decode_core( psDec, &sDecCtrl, pOut, pulses );
92 TOC(decode_core)
93
94         /********************************************************/
95         /* Update PLC state                                     */
96         /********************************************************/
97         silk_PLC( psDec, &sDecCtrl, pOut, 0 );
98
99         psDec->lossCnt = 0;
100         psDec->prevSignalType = psDec->indices.signalType;
101         silk_assert( psDec->prevSignalType >= 0 && psDec->prevSignalType <= 2 );
102
103         /* A frame has been decoded without errors */
104         psDec->first_frame_after_reset = 0;
105     } else {
106         /* Handle packet loss by extrapolation */
107         silk_PLC( psDec, &sDecCtrl, pOut, 1 );
108     }
109
110     /*************************/
111     /* Update output buffer. */
112     /*************************/
113     silk_assert( psDec->ltp_mem_length >= psDec->frame_length );
114     mv_len = psDec->ltp_mem_length - psDec->frame_length;
115     silk_memmove( psDec->outBuf, &psDec->outBuf[ psDec->frame_length ], mv_len * sizeof(opus_int16) );
116     silk_memcpy( &psDec->outBuf[ mv_len ], pOut, psDec->frame_length * sizeof( opus_int16 ) );
117
118     /****************************************************************/
119     /* Ensure smooth connection of extrapolated and good frames     */
120     /****************************************************************/
121     silk_PLC_glue_frames( psDec, pOut, L );
122
123     /************************************************/
124     /* Comfort noise generation / estimation        */
125     /************************************************/
126     silk_CNG( psDec, &sDecCtrl, pOut, L );
127
128     /* Update some decoder state variables */
129     psDec->lagPrev = sDecCtrl.pitchL[ psDec->nb_subfr - 1 ];
130     psDec->nFramesDecoded++;
131
132     /* Set output frame length */
133     *pN = L;
134
135 TOC(DECODE_FRAME)
136
137     return ret;
138 }