/***********************************************************************

Copyright (c) 2006-2011, Skype Limited. All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions

are met:

- Redistributions of source code must retain the above copyright notice,

this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright

notice, this list of conditions and the following disclaimer in the

documentation and/or other materials provided with the distribution.

- Neither the name of Internet Society, IETF or IETF Trust, nor the

names of specific contributors, may be used to endorse or promote

products derived from this software without specific prior written

permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE

LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

***********************************************************************/

#ifdef HAVE_CONFIG_H

#include "config.h"

#endif

#include "main.h"

#include "stack_alloc.h"

#include "PLC.h"

#ifdef ENABLE_OSCE

#include "osce.h"

#endif

/****************/

/* Decode frame */

/****************/

opus_int silk_decode_frame(

    silk_decoder_state          *psDec,                         /* I/O  Pointer to Silk decoder state               */

    ec_dec                      *psRangeDec,                    /* I/O  Compressor data structure                   */

    opus_int16                  pOut[],                         /* O    Pointer to output speech frame              */

    opus_int32                  *pN,                            /* O    Pointer to size of output frame             */

    opus_int                    lostFlag,                       /* I    0: no loss, 1 loss, 2 decode fec            */

    opus_int                    condCoding,                     /* I    The type of conditional coding to use       */

#ifdef ENABLE_DEEP_PLC

    LPCNetPLCState              *lpcnet,

#endif

#ifdef ENABLE_OSCE

    OSCEModel                   *osce_model,

#endif

    int                         arch                            /* I    Run-time architecture                       */

)

{

    VARDECL( silk_decoder_control, psDecCtrl );

    opus_int         L, mv_len, ret = 0;

    SAVE_STACK;

    L = psDec->frame_length;

    ALLOC( psDecCtrl, 1, silk_decoder_control );

    psDecCtrl->LTP_scale_Q14 = 0;

    /* Safety checks */

    celt_assert( L > 0 && L <= MAX_FRAME_LENGTH );

    if(   lostFlag == FLAG_DECODE_NORMAL ||

        ( lostFlag == FLAG_DECODE_LBRR && psDec->LBRR_flags[ psDec->nFramesDecoded ] == 1 ) )

    {

        VARDECL( opus_int16, pulses );

#ifdef ENABLE_OSCE

        opus_int32  ec_start;

        ec_start = ec_tell(psRangeDec);

#endif

        ALLOC( pulses, (L + SHELL_CODEC_FRAME_LENGTH - 1) &

                       ~(SHELL_CODEC_FRAME_LENGTH - 1), opus_int16 );

        /*********************************************/

        /* Decode quantization indices of side info  */

        /*********************************************/

        silk_decode_indices( psDec, psRangeDec, psDec->nFramesDecoded, lostFlag, condCoding );

        /*********************************************/

        /* Decode quantization indices of excitation */

        /*********************************************/

        silk_decode_pulses( psRangeDec, pulses, psDec->indices.signalType,

                psDec->indices.quantOffsetType, psDec->frame_length );

        /********************************************/

        /* Decode parameters and pulse signal       */

        /********************************************/

        silk_decode_parameters( psDec, psDecCtrl, condCoding );

        /********************************************************/

        /* Run inverse NSQ                                      */

        /********************************************************/

        silk_decode_core( psDec, psDecCtrl, pOut, pulses, arch );

        /*************************/

        /* Update output buffer. */

        /*************************/

        celt_assert( psDec->ltp_mem_length >= psDec->frame_length );

        mv_len = psDec->ltp_mem_length - psDec->frame_length;

        silk_memmove( psDec->outBuf, &psDec->outBuf[ psDec->frame_length ], mv_len * sizeof(opus_int16) );

        silk_memcpy( &psDec->outBuf[ mv_len ], pOut, psDec->frame_length * sizeof( opus_int16 ) );

#ifdef ENABLE_OSCE

        /********************************************************/

        /* Run SILK enhancer                                    */

        /********************************************************/

        osce_enhance_frame( osce_model, psDec, psDecCtrl, pOut, ec_tell(psRangeDec) - ec_start, arch );

#endif

        /********************************************************/

        /* Update PLC state                                     */

        /********************************************************/

        silk_PLC( psDec, psDecCtrl, pOut, 0,

#ifdef ENABLE_DEEP_PLC

            lpcnet,

#endif

            arch );

        psDec->lossCnt = 0;

        psDec->prevSignalType = psDec->indices.signalType;

        celt_assert( psDec->prevSignalType >= 0 && psDec->prevSignalType <= 2 );

        /* A frame has been decoded without errors */

        psDec->first_frame_after_reset = 0;

    } else {

        /* Handle packet loss by extrapolation */

        silk_PLC( psDec, psDecCtrl, pOut, 1,

#ifdef ENABLE_DEEP_PLC

            lpcnet,

#endif

            arch );

#ifdef ENABLE_OSCE

        osce_reset( &psDec->osce, psDec->osce.method );

#endif

        /*************************/

        /* Update output buffer. */

        /*************************/

        celt_assert( psDec->ltp_mem_length >= psDec->frame_length );

        mv_len = psDec->ltp_mem_length - psDec->frame_length;

        silk_memmove( psDec->outBuf, &psDec->outBuf[ psDec->frame_length ], mv_len * sizeof(opus_int16) );

        silk_memcpy( &psDec->outBuf[ mv_len ], pOut, psDec->frame_length * sizeof( opus_int16 ) );

    }

    /************************************************/

    /* Comfort noise generation / estimation        */

    /************************************************/

    silk_CNG( psDec, psDecCtrl, pOut, L );

    /****************************************************************/

    /* Ensure smooth connection of extrapolated and good frames     */

    /****************************************************************/

    silk_PLC_glue_frames( psDec, pOut, L );

    /* Update some decoder state variables */

    psDec->lagPrev = psDecCtrl->pitchL[ psDec->nb_subfr - 1 ];

    /* Set output frame length */

    *pN = L;

    RESTORE_STACK;

    return ret;

}