/* ***** BEGIN LICENSE BLOCK *****
*
* $Id: mvdata_byteio.cpp,v 1.7 2007/04/11 08:08:49 tjdwave Exp $ $Name: Dirac_0_7_0 $
*
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The Original Code is BBC Research and Development code.
*
* The Initial Developer of the Original Code is the British Broadcasting
* Corporation.
* Portions created by the Initial Developer are Copyright (C) 2004.
* All Rights Reserved.
*
* Contributor(s): Anuradha Suraparaju (Original Author)
*                 Andrew Kennedy
* Alternatively, the contents of this file may be used under the terms of
* the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
* Public License Version 2.1 (the "LGPL"), in which case the provisions of
* the GPL or the LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the either
* the GPL or LGPL and not to allow others to use your version of this file
* under the MPL, indicate your decision by deleting the provisions above
* and replace them with the notice and other provisions required by the GPL
* or LGPL. If you do not delete the provisions above, a recipient may use
* your version of this file under the terms of any one of the MPL, the GPL
* or the LGPL.
* ***** END LICENSE BLOCK ***** */

#include <libdirac_byteio/mvdata_byteio.h>
#include <libdirac_common/video_format_defaults.h>
#include <libdirac_common/dirac_exception.h>

using namespace dirac;

MvDataByteIO::MvDataByteIO(FrameParams& fparams,
                                 CodecParams& cparams):
ByteIO(),
m_fparams(fparams),
m_cparams(cparams),
m_default_cparams(cparams.GetVideoFormat(), fparams.GetFrameType(), fparams.Refs().size(), true),
m_splitmode_data(),
m_predmode_data(),
m_mv1hblock_data(),
m_mv1vblock_data(),
m_mv2hblock_data(),
m_mv2vblock_data(),
m_ydcblock_data(),
m_udcblock_data(),
m_vdcblock_data()
{}

MvDataByteIO::MvDataByteIO(ByteIO &byte_io, FrameParams& fparams,
                                 CodecParams& cparams):
ByteIO(byte_io),
m_fparams(fparams),
m_cparams(cparams),
m_default_cparams(cparams.GetVideoFormat(), fparams.GetFrameType(), fparams.Refs().size(), true),
m_splitmode_data(byte_io),
m_predmode_data(byte_io),
m_mv1hblock_data(byte_io),
m_mv1vblock_data(byte_io),
m_mv2hblock_data(byte_io),
m_mv2vblock_data(byte_io),
m_ydcblock_data(byte_io),
m_udcblock_data(byte_io),
m_vdcblock_data(byte_io)
{}

MvDataByteIO::~MvDataByteIO()
{}

void MvDataByteIO::CollateByteStats(DiracByteStats& dirac_byte_stats)
{
    // set number of MV bytes
    dirac_byte_stats.SetByteCount(STAT_MV_BYTE_COUNT,
                                  GetSize());
}

int MvDataByteIO::GetSize() const
{
    if (m_fparams.NumRefs()==2)
        return ByteIO::GetSize() + 
               m_splitmode_data.GetSize()+
               m_predmode_data.GetSize()+
               m_mv1hblock_data.GetSize()+
               m_mv1vblock_data.GetSize()+
               m_mv2hblock_data.GetSize()+
               m_mv2vblock_data.GetSize()+
               m_ydcblock_data.GetSize()+
               m_udcblock_data.GetSize()+
               m_vdcblock_data.GetSize();
    else
        return ByteIO::GetSize() + 
               m_splitmode_data.GetSize()+
               m_predmode_data.GetSize()+
               m_mv1hblock_data.GetSize()+
               m_mv1vblock_data.GetSize()+
               m_ydcblock_data.GetSize()+
               m_udcblock_data.GetSize()+
               m_vdcblock_data.GetSize();
}

const std::string MvDataByteIO::GetBytes()
{
    //Output header and block data
    if (m_fparams.NumRefs()==2 )
        return ByteIO::GetBytes() + 
               m_splitmode_data.GetBytes()+
               m_predmode_data.GetBytes()+
               m_mv1hblock_data.GetBytes()+
               m_mv1vblock_data.GetBytes()+
               m_mv2hblock_data.GetBytes()+
               m_mv2vblock_data.GetBytes()+
               m_ydcblock_data.GetBytes()+
               m_udcblock_data.GetBytes()+
               m_vdcblock_data.GetBytes();
    else
        return ByteIO::GetBytes() + 
               m_splitmode_data.GetBytes()+
               m_predmode_data.GetBytes()+
               m_mv1hblock_data.GetBytes()+
               m_mv1vblock_data.GetBytes()+
               m_ydcblock_data.GetBytes()+
               m_udcblock_data.GetBytes()+
               m_vdcblock_data.GetBytes();
}

void MvDataByteIO::Input()
{
    // Byte Alignment
    ByteAlignInput();

    // Input Block Params
    InputBlockParams();

    // Input Motion Vector Precision
    InputMVPrecision();

    // Input chroma 
    InputGlobalMotionParams();

    // Input video depth
    InputFramePredictionMode();

    // Input frame weights
    InputFrameWeights();

    // Byte Alignment
    ByteAlignInput();
}

void MvDataByteIO::Output()
{
    // Output Block Params
    OutputBlockParams();

    // Output Motion Vector Precision
    OutputMVPrecision();

    // output global motion 
    OutputGlobalMotionParams();

    // output video depth
    OutputFramePredictionMode();

    // output frame weights
    OutputFrameWeights();

    // Byte Align
    ByteAlignOutput();
}

//-------------private---------------------------------------------------------------

void MvDataByteIO::OutputBlockParams()
{
    // output 'is default' flag
    bool is_default =  true;
    const OLBParams& def_olb_params = m_default_cparams.LumaBParams(2);
    const OLBParams& olb_params = m_cparams.LumaBParams(2);

    if (olb_params.Xblen() != def_olb_params.Xblen() ||
        olb_params.Yblen() != def_olb_params.Yblen() ||
        olb_params.Xbsep() != def_olb_params.Xbsep() ||
        olb_params.Ybsep() != def_olb_params.Ybsep())
    {
        is_default = false;
    }
       OutputBit(!is_default);
    if(is_default)
        return;

    // output custom block params flag 
    // NOTE: FIXME - need to check if we can set just block inder
    unsigned int pidx = BlockParametersIndex(olb_params);
    OutputVarLengthUint(pidx);
    if (pidx == 0) // custom block params
    {
        // output Xblen
        OutputVarLengthUint(olb_params.Xblen());
        // output Yblen
        OutputVarLengthUint(olb_params.Yblen());
        // output Xbsep
        OutputVarLengthUint(olb_params.Xbsep());
        // output Ybsep
        OutputVarLengthUint(olb_params.Ybsep());
    }
}

void MvDataByteIO::InputBlockParams()
{
    // output 'is default' flag
    const OLBParams& def_olb_params = m_default_cparams.LumaBParams(2);
    OLBParams olb_params;

       if (InputBit())
    {
        unsigned int p_idx = InputVarLengthUint();
        // FIXME : the default values from block params table must be set
        // elsehwere
        if (p_idx == 0)
        {
            // Input Xblen
            olb_params.SetXblen(InputVarLengthUint());
            // Input Yblen
            olb_params.SetYblen(InputVarLengthUint());
            // Input Xbsep
            olb_params.SetXbsep(InputVarLengthUint());
            // Input Ybsep
            olb_params.SetYbsep(InputVarLengthUint());
        }
        else
            SetDefaultBlockParameters (olb_params, p_idx);

    }
    else
    {
        // is default
        olb_params = def_olb_params;
    }
    m_cparams.SetLumaBlockParams(olb_params);
}

void MvDataByteIO::OutputMVPrecision()
{
    // Output Motion vector precision
    if (m_cparams.MVPrecision() != m_default_cparams.MVPrecision())
    {
        OutputBit(true);
        OutputVarLengthUint(m_cparams.MVPrecision());
    }
    else
        OutputBit(false);
}

void MvDataByteIO::InputMVPrecision()
{
    // Input Motion vector precision
    if (InputBit())
    {
        MVPrecisionType mv_prec = IntToMVPrecisionType(InputVarLengthUint());
        if(mv_prec==MV_PRECISION_UNDEFINED)
            DIRAC_THROW_EXCEPTION(
                    ERR_INVALID_MOTION_VECTOR_PRECISION,
                    "Dirac does not recognise the specified MV precision",
                    SEVERITY_FRAME_ERROR)

        m_cparams.SetMVPrecision(mv_prec);
    }
    else
        m_cparams.SetMVPrecision(m_default_cparams.MVPrecision());
}

void MvDataByteIO::OutputGlobalMotionParams()
{
    // Always setting global motion to false
    // NOTE: FIXME - output actual global motion params in future
    // Using Global motion flag
    OutputBit(false);
}

void MvDataByteIO::InputGlobalMotionParams()
{
    // Always setting global motion to false
    // Using Global motion flag
    if (InputBit())
    {
        m_cparams.SetUsingGlobalMotion(true);
 
        // NOTE: FIXME - input actual global motion params in future
        DIRAC_THROW_EXCEPTION(
                    ERR_UNSUPPORTED_STREAM_DATA,
                    "Cannot handle global motion parameters",
                    SEVERITY_FRAME_ERROR)
    }
    else
        m_cparams.SetUsingGlobalMotion(false);
}

void MvDataByteIO::OutputFramePredictionMode()
{
    // Output frame prediction mode index
    if (m_cparams.Interlace() == m_default_cparams.Interlace())
    {
        OutputBit(false);
    }
    else
    {
        OutputBit(true);
        if (!m_cparams.Interlace())
        {
            OutputVarLengthUint(IT_PROGRESSIVE);
        }
        else
        {
               OutputVarLengthUint(m_cparams.TopFieldFirst() ?
                                 IT_INTERLACED_TFF: IT_INTERLACED_BFF);
        }
    }
}

void MvDataByteIO::InputFramePredictionMode()
{
    if (InputBit())
    {
        m_cparams.SetTopFieldFirst(true);

        switch(InputVarLengthUint())
        {
        case 0:
            m_cparams.SetInterlace(false);
            break;
        case 1:
            m_cparams.SetInterlace(true);
            break;
        case 2:
            m_cparams.SetInterlace(true);
            m_cparams.SetTopFieldFirst(false);
        default:
            DIRAC_THROW_EXCEPTION(
            ERR_UNSUPPORTED_STREAM_DATA,
            "Picture Prediction Mode out of range [0-2]",
            SEVERITY_FRAME_ERROR);
            break;
        }
        if (m_cparams.Interlace())
        {
            DIRAC_THROW_EXCEPTION(
                ERR_UNSUPPORTED_STREAM_DATA,
                "Interlace Picture Predicion Mode no supported",
                SEVERITY_FRAME_ERROR);
        }
    }
    else
    {
        m_cparams.SetInterlace(m_default_cparams.Interlace());
        m_cparams.SetTopFieldFirst(m_default_cparams.TopFieldFirst());
    }
}


void MvDataByteIO::OutputFrameWeights()
{
    // Output default weights flags
    if (m_cparams.FrameWeightsBits() != m_default_cparams.FrameWeightsBits() ||
        m_cparams.Ref1Weight() !=  m_default_cparams.Ref1Weight() ||
        (m_fparams.Refs().size() > 1 && m_cparams.Ref2Weight() !=  m_default_cparams.Ref2Weight()))
    {
           OutputBit(true);
        // Output weight precision bits
        OutputVarLengthUint(m_cparams.FrameWeightsBits());
        // Output Ref1 weight
        OutputVarLengthUint(m_cparams.Ref1Weight());
        if (m_fparams.Refs().size() > 1)
        {
            // Output Ref1 weight
            OutputVarLengthUint(m_cparams.Ref2Weight());
        }
    }
    else
    {
           OutputBit(false);
    }
}

void MvDataByteIO::InputFrameWeights()
{
    if (InputBit())
    {
        m_cparams.SetFrameWeightsPrecision(InputVarLengthUint());
        m_cparams.SetRef1Weight(InputVarLengthUint());
        if (m_fparams.Refs().size() > 1)
            m_cparams.SetRef2Weight(InputVarLengthUint());
        else
            m_cparams.SetRef2Weight(0);
    }
    else
    {
        m_cparams.SetFrameWeightsPrecision(m_default_cparams.FrameWeightsBits());
        m_cparams.SetRef1Weight(m_default_cparams.Ref1Weight());
        m_cparams.SetRef2Weight(m_default_cparams.Ref2Weight());
    }
}