Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / 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 #include "silk_main.h"
29 #include "silk_PLC.h"
30
31 /****************/
32 /* Decode frame */
33 /****************/
34 opus_int silk_decode_frame(
35     silk_decoder_state      *psDec,             /* I/O  Pointer to Silk decoder state               */
36     ec_dec                      *psRangeDec,        /* I/O  Compressor data structure                   */
37     opus_int16                   pOut[],             /* O    Pointer to output speech frame              */
38     opus_int32                   *pN,                /* O    Pointer to size of output frame             */
39     opus_int                     lostFlag            /* I    0: no loss, 1 loss, 2 decode fec            */
40 )
41 {
42     silk_decoder_control sDecCtrl;
43     opus_int         L, mv_len, ret = 0;
44     opus_int         pulses[ MAX_FRAME_LENGTH ];
45
46 TIC(DECODE_FRAME)
47
48     L = psDec->frame_length;
49     sDecCtrl.LTP_scale_Q14 = 0;
50
51     /* Safety checks */
52     SKP_assert( L > 0 && L <= MAX_FRAME_LENGTH );
53
54     if(   lostFlag == FLAG_DECODE_NORMAL ||
55         ( lostFlag == FLAG_DECODE_LBRR && psDec->LBRR_flags[ psDec->nFramesDecoded ] == 1 ) )
56     {
57         /*********************************************/
58         /* Decode quantization indices of side info  */
59         /*********************************************/
60 TIC(decode_indices)
61         silk_decode_indices( psDec, psRangeDec, psDec->nFramesDecoded, lostFlag );
62 TOC(decode_indices)
63
64         /*********************************************/
65         /* Decode quantization indices of excitation */
66         /*********************************************/
67 TIC(decode_pulses)
68         silk_decode_pulses( psRangeDec, pulses, psDec->indices.signalType,
69                 psDec->indices.quantOffsetType, psDec->frame_length );
70 TOC(decode_pulses)
71
72         /********************************************/
73         /* Decode parameters and pulse signal       */
74         /********************************************/
75 TIC(decode_params)
76         silk_decode_parameters( psDec, &sDecCtrl );
77 TOC(decode_params)
78
79         /* Update length. Sampling frequency may have changed */
80         L = psDec->frame_length;
81
82         /********************************************************/
83         /* Run inverse NSQ                                      */
84         /********************************************************/
85 TIC(decode_core)
86         silk_decode_core( psDec, &sDecCtrl, pOut, pulses );
87 TOC(decode_core)
88
89         /********************************************************/
90         /* Update PLC state                                     */
91         /********************************************************/
92         silk_PLC( psDec, &sDecCtrl, pOut, L, 0 );
93
94         psDec->lossCnt = 0;
95         psDec->prevSignalType = psDec->indices.signalType;
96         SKP_assert( psDec->prevSignalType >= 0 && psDec->prevSignalType <= 2 );
97
98         /* A frame has been decoded without errors */
99         psDec->first_frame_after_reset = 0;
100     } else {
101         /* Handle packet loss by extrapolation */
102         silk_PLC( psDec, &sDecCtrl, pOut, L, 1 );
103     }
104
105     /*************************/
106     /* Update output buffer. */
107     /*************************/
108     SKP_assert( psDec->ltp_mem_length >= psDec->frame_length );
109     mv_len = psDec->ltp_mem_length - psDec->frame_length;
110     SKP_memmove( psDec->outBuf, &psDec->outBuf[ psDec->frame_length ], mv_len * sizeof(opus_int16) );
111     SKP_memcpy( &psDec->outBuf[ mv_len ], pOut, psDec->frame_length * sizeof( opus_int16 ) );
112
113     /****************************************************************/
114     /* Ensure smooth connection of extrapolated and good frames     */
115     /****************************************************************/
116     silk_PLC_glue_frames( psDec, &sDecCtrl, pOut, L );
117
118     /************************************************/
119     /* Comfort noise generation / estimation        */
120     /************************************************/
121     silk_CNG( psDec, &sDecCtrl, pOut, L );
122
123     /* Update some decoder state variables */
124     psDec->lagPrev = sDecCtrl.pitchL[ psDec->nb_subfr - 1 ];
125     psDec->nFramesDecoded++;
126
127     /* Set output frame length */
128     *pN = L;
129
130 TOC(DECODE_FRAME)
131
132     return ret;
133 }