/*

* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:    PayloadFormat plugin capable to read RTP payload containing

*                G729 audio.

*

*/

// INCLUDE FILES

#include    "g729payloadformatread.h"

#include    "g729payloadformatutil.h"

#include    "mccrtpdatasource.h"

#include    "formatstatemachine.h"

#include    "streamformatter.h"

#include    "mccinternaldef.h"

#include    "mccredpayloadread.h"

#ifdef VOIP_TRACE_ENABLED

#include <voip_trace.h>

#endif

// ============================= LOCAL FUNCTIONS ===============================

// ============================ MEMBER FUNCTIONS ===============================

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::CG729PayloadFormatRead

// C++ default constructor can NOT contain any code, that

// might leave.

// -----------------------------------------------------------------------------

//

CG729PayloadFormatRead::CG729PayloadFormatRead()

    {

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::ConstructL

// Symbian 2nd phase constructor can leave.

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::ConstructL( MDataSource* aSource )

    {

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x %x", MCC_TRACE, MCC_G711_PLF_READ_CONSTRUCTL, aSource );

    #endif

    __ASSERT_ALWAYS( aSource, User::Leave( KErrArgument ) );

    iClip = aSource;

    iBufferToReadExists = EFalse;

    iFourCC.Set( KMccFourCCIdG729 );

    // Initialize decoding state machine

    iStateMachine = CFormatDecodeStateMachine::NewL( this );

    iCurrentBuffer = EBufferOne;

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::NewL

// Two-phased constructor.

// -----------------------------------------------------------------------------

//

CG729PayloadFormatRead* CG729PayloadFormatRead::NewL( MDataSource* aSource )

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print (_L ("CG729PayloadFormatRead::NewL()"));

    #endif

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x %x", MCC_TRACE, MCC_G711_PLF_READ_NEWL, aSource );

    #endif

    __ASSERT_ALWAYS( aSource, User::Leave( KErrArgument ) );

    CG729PayloadFormatRead* self = new (ELeave) CG729PayloadFormatRead;

    CleanupStack::PushL( self );

    self->ConstructL( aSource );

    CleanupStack::Pop( self );

    return self;

    }    

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::~CG729PayloadFormatRead()

// Destructor.

// -----------------------------------------------------------------------------

//

CG729PayloadFormatRead::~CG729PayloadFormatRead()

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print (_L ("CG729PayloadFormatRead::\

            ~CG729PayloadFormatRead()"));

    #endif

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_DESTRUCTOR );

    #endif

    delete iFrameBufferOne;

    delete iFrameBufferTwo;

    if ( iSourceBufOwnership )

        {

        delete iSourceBuffer;

        }

    else

        {

        iSourceBuffer = NULL;

        }

    if ( iStateMachine )

        {

        iStateMachine->Cancel();

        delete iStateMachine;

        }

    iClip = NULL;

    iDataPath = NULL;

    iClip = NULL;    

    iFrameArray.Close();

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SendDataToSinkL

// Send full frame buffer to the DataPath.

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::SendDataToSinkL()

    {

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_SENDDATATOSINKL );

    #endif

    if ( EBufferOne == iCurrentBuffer )

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print (_L ("CG729PayloadFormatRead::\

                SendDataToSinkL() - BufferOne"));

        #endif

        iDataPath->BufferFilledL( iFrameBufferOne);

        iCurrentBuffer = EBufferTwo;

        // More payload buffers needed

        if ( iBufferToReadExists && !iFrameBufferOne->LastBuffer() )  

            {

            iStateMachine->ChangeState( ESourceDataReady );

            }

        }

    else

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print (_L ("CG729PayloadFormatRead::\

                SendDataToSinkL() - BufferTwo"));

        #endif

        iDataPath->BufferFilledL( iFrameBufferTwo );

        iCurrentBuffer = EBufferOne;

        // More payload buffers needed

        if ( iBufferToReadExists && !iFrameBufferTwo->LastBuffer() )

            {

            iStateMachine->ChangeState( ESourceDataReady );

            }

        }

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

    RDebug::Print (_L ("CG729PayloadFormatRead::SendDataToSinkL() - DONE") );

    #endif

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::FillSinkBuffer

// Fill SinkBuffer.

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::FillSinkBufferL()

    {

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_FILLSINKBUFFER );

    #endif  

    CMMFDataBuffer* curFrameBuffer;

    if ( EBufferOne == iCurrentBuffer )

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print( _L("G729PayloadFormatRead:FillSinkBuffer() EBufferOne \

            reqsize: %d"), iFrameBufferOne->RequestSize() );

        #endif

        curFrameBuffer = iFrameBufferOne;

        }

    else

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print( _L("G729PayloadFormatRead:FillSinkBuffer() EBufferOne \

            reqsize: %d"), iFrameBufferTwo->RequestSize() );

        #endif

        curFrameBuffer = iFrameBufferTwo;

        }

    TDes8& curFrameData = curFrameBuffer->Data();

    curFrameData.Zero();

    // Put next frame decoded from RTP payload to the framebuffer

    this->GetNextFrame( curFrameData );

    HBufC8* buffer = NULL;

    buffer = curFrameData.Alloc();

    curFrameData.SetLength( KG729NumOfHeaderBytes );

    TBool sidFrame = EFalse;

    // Check the audio frame length, if we have one

    TInt frameLen = 0;

    if( buffer )

        {

        frameLen = buffer->Length();

        }

    if ( KG729FrameSize10ms == frameLen )

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print( _L ("CG729PayloadFormatRead::FillSinkBuffer ADD AUDIO HEADER") );

        #endif

        // Add 1st G.729 header byte for audio

        curFrameData[0] = KAudioFrameHeaderByte;

        sidFrame = EFalse;

        }

    else if( KG729CNFrameSize == frameLen )

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print( _L ("CG729PayloadFormatRead::FillSinkBuffer ADD SID HEADER") );

        #endif

        // Add 1st G.729 header byte for SID frame

        curFrameData[0] = KCNoiseFrameHeaderByte;

        sidFrame = ETrue;

        }

    else

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print( _L ("CG729PayloadFormatRead::FillSinkBuffer UNKNOWN FRAMELEN: %d"), frameLen );

        #endif

        // delete the buffer as something is badly wrong, this will be handled

        // a bit later on

        delete buffer;

        buffer = NULL;

        }

    if( buffer )

        {

        // Add 2nd G.729 header byte to the frame going to the decoder,

        // always zero

        curFrameData[1] = 0;

        this->DoBitUnPacking( *buffer, curFrameData, sidFrame );

        delete buffer;

        buffer = NULL;

        }

    else

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

            RDebug::Print( _L ("CG729PayloadFormatRead::FillSinkBuffer NO AUDIOBUFFER") );

        #endif

        // May be that the allocation failed or GetNextFrame() returned a

        // unknown size frame. In this case, fill the reset of the curFrameData

        // with zeroes like it would be a normal G.729 frame.

        curFrameData.SetLength( KG729CodecDecBufSize );

        // This will set the header bytes to zero meaning a 0bit/s frame, which

        // is fine with the decoder.

        curFrameData.FillZ();

        }

    curFrameBuffer->SetFrameNumber( iRecvHeader.iTimestamp + ( ( iFrameIndex - 1 )

        * TUint( iCInfo.iHwFrameTime * KG729SampleRate * 0.001 ) ) );

    curFrameBuffer->SetStatus( EFull );

    iStateMachine->ChangeState( EEmptyDataToSink );

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print( _L("G729PayloadFormatRead::FillSinkBuffer() \

        BUFSZ: %d"), curFrameBuffer->BufferSize() );

    #endif

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::FillSourceBufferL

// Send fill buffer request to the RTP Data Source.

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::FillSourceBufferL()

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print (_L ("CG729PayloadFormatRead::FillSourceBufferL()"));

    #endif

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_FILLSOURCEBUFFERL );

    #endif 

    // RtpSourceSink doesn't really need the Media Id.        

    iClip->FillBufferL( iSourceBuffer, this, iMediaId );

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SourcePrimeL

// Prime source.

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::SourcePrimeL()

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print( _L("CG729PayloadFormatRead::SourcePrimeL") );

    #endif

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_SOURCEPRIMEL );

    #endif

    iClip->SourcePrimeL();

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SourcePlayL

// Start playing.

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::SourcePlayL()

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print( _L("CG729PayloadFormatRead::SourcePlayL") );

    #endif

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_SOURCEPLAYL );

    #endif

    iClip->SourcePlayL();

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SourcePauseL

// Pause source.

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::SourcePauseL()

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print( _L("CG729PayloadFormatRead::SourcePauseL") );

    #endif

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_SOURCEPAUSEL );

    #endif

    iStateMachine->Cancel();

    iStateMachine->ChangeState( EDecodeIdle );

    iFrameBufferOne->SetLastBuffer( EFalse );

    iFrameBufferTwo->SetLastBuffer( EFalse );

    iFrameBufferOne->SetStatus( EAvailable );

    iFrameBufferTwo->SetStatus( EAvailable );

    iBufferToReadExists = EFalse;

    iCurrentBuffer = EBufferOne;

    iClip->SourcePauseL();

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SourceStopL

// Stop source

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::SourceStopL()

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print( _L("CG729PayloadFormatRead::SourceStopL") );

    #endif

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_SOURCESTOPL );

    #endif

    // DO NOT RESET PACKET COUNT BACK TO ZERO HERE

    // UPPER LAYER MAY CALL LastDlPacketCount LATER

    iStateMachine->Cancel();

    iStateMachine->ChangeState( EDecodeIdle );

    iFrameBufferOne->SetLastBuffer( EFalse );

    iFrameBufferTwo->SetLastBuffer( EFalse );

    iFrameBufferOne->SetStatus( EAvailable );

    iFrameBufferTwo->SetStatus( EAvailable );

    iBufferToReadExists = EFalse;

    iCurrentBuffer = EBufferOne;

    #ifdef DEBUG_G729_INTERVAL

        RDebug::Print( _L("Processed %d G729 frames"), iFrameCount ); 

        iFrameCount = 0;

    #endif

    iClip->SourceStopL();

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::BufferFilledL

// RTP data source has filled buffer.

// NOTE: Although redundancy is negotiated, sender may deside to send audio 

// packets without redundancy (RFC2198, ch5).

// -----------------------------------------------------------------------------

//

void CG729PayloadFormatRead::DataBufferFilledL( CMMFBuffer* aBuffer, const TRtpRecvHeader &aRecvHeader)

    {

    #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print( _L("CG729PayloadFormatRead::DataBufferFilledL - TSTAMP: %u"),

        aRecvHeader.iTimestamp );

    #endif

    __ASSERT_ALWAYS( aBuffer, User::Leave( KErrArgument ) );

    __ASSERT_ALWAYS( KUidMmfDataBuffer == aBuffer->Type(), 

        User::Leave( KErrNotSupported ) );

    __ASSERT_ALWAYS( iSourceBuffer == aBuffer, User::Leave( KErrArgument ) );

    // Copy received buffer

    TDes8& destDes = iSourceBuffer->Data();

    iRecvHeader = aRecvHeader;

    // Decode data blocks

    DecodePayload( destDes );

    // Whenever BufferFilledL is called from RtpSourceSink

    // Set the state machine to fillsinkbuffer

    if ( iFrameArray.Count() )

        {

        iBufferToReadExists = ETrue;

        iSourceBuffer->SetFrameNumber( iRecvHeader.iTimestamp );

        iStateMachine->ChangeState( ESourceDataReady );

        }

    else

        {

        #ifdef TRACE_G729_PAYLOAD_FORMAT_READ

        RDebug::Print( _L("CG729PayloadFormatRead::BufferFilledL, decode failed" ) );

        #endif

        FillSourceBufferL();

        }

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SampleRate

// Returns samplerate.

// -----------------------------------------------------------------------------

//

TUint CG729PayloadFormatRead::SampleRate()

    {

    return KG729SampleRate;

    }  

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SetSampleRate

// Set samplerate.

// -----------------------------------------------------------------------------

//

TInt CG729PayloadFormatRead::SetSampleRate( TUint aSampleRate )

    {

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x %d", MCC_TRACE, MCC_G711_PLF_READ_SETSAMPLERATE,

            aSampleRate );

    #endif

    return ( KG729SampleRate == aSampleRate ) ? KErrNone : KErrNotSupported;

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::NumChannels

// Returns number of channels.

// -----------------------------------------------------------------------------

//

TUint CG729PayloadFormatRead::NumChannels()

    {

    return KMono;

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SourceThreadLogon

// Logon to the source thread.

// -----------------------------------------------------------------------------

//

TInt CG729PayloadFormatRead::SourceThreadLogon(

    MAsyncEventHandler& aEventHandler )

    {

    #ifdef VOIP_TRACE_ENABLED

        VoipTrace( "%x %x", MCC_TRACE, MCC_G711_PLF_READ_SOURCETHREADLOGOFF );

    #endif

    if ( iClip )

        {

        iClip->SourceThreadLogon( aEventHandler );

        return KErrNone;

        }

    else

        {

        return KErrNotReady;

        }

    }

// -----------------------------------------------------------------------------

// CG729PayloadFormatRead::SourceThreadLogoff

// Logout the source thread.

// -----------------------------------------------------------------------------

//