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

NOTE - One of the two copyright statements below may be chosen
       that applies for the software.

********************************************************************************

This software module was originally developed by

Heiko Schwarz    (Fraunhofer HHI),
Tobias Hinz      (Fraunhofer HHI),
Karsten Suehring (Fraunhofer HHI)

in the course of development of the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video
Coding) for reference purposes and its performance may not have been optimized.
This software module is an implementation of one or more tools as specified by
the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding).

Those intending to use this software module in products are advised that its
use may infringe existing patents. ISO/IEC have no liability for use of this
software module or modifications thereof.

Assurance that the originally developed software module can be used
(1) in the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding) once the
ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding) has been adopted; and
(2) to develop the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding): 

To the extent that Fraunhofer HHI owns patent rights that would be required to
make, use, or sell the originally developed software module or portions thereof
included in the ISO/IEC 14496-10:2005 Amd.1 (Scalable Video Coding) in a
conforming product, Fraunhofer HHI will assure the ISO/IEC that it is willing
to negotiate licenses under reasonable and non-discriminatory terms and
conditions with applicants throughout the world.

Fraunhofer HHI retains full right to modify and use the code for its own
purpose, assign or donate the code to a third party and to inhibit third
parties from using the code for products that do not conform to MPEG-related
ITU Recommendations and/or ISO/IEC International Standards. 

This copyright notice must be included in all copies or derivative works.
Copyright (c) ISO/IEC 2005. 

********************************************************************************

COPYRIGHT AND WARRANTY INFORMATION

Copyright 2005, International Telecommunications Union, Geneva

The Fraunhofer HHI hereby donate this source code to the ITU, with the following
understanding:
    1. Fraunhofer HHI retain the right to do whatever they wish with the
       contributed source code, without limit.
    2. Fraunhofer HHI retain full patent rights (if any exist) in the technical
       content of techniques and algorithms herein.
    3. The ITU shall make this code available to anyone, free of license or
       royalty fees.

DISCLAIMER OF WARRANTY

These software programs are available to the user without any license fee or
royalty on an "as is" basis. The ITU disclaims any and all warranties, whether
express, implied, or statutory, including any implied warranties of
merchantability or of fitness for a particular purpose. In no event shall the
contributor or the ITU be liable for any incidental, punitive, or consequential
damages of any kind whatsoever arising from the use of these programs.

This disclaimer of warranty extends to the user of these programs and user's
customers, employees, agents, transferees, successors, and assigns.

The ITU does not represent or warrant that the programs furnished hereunder are
free of infringement of any third-party patents. Commercial implementations of
ITU-T Recommendations, including shareware, may be subject to royalty fees to
patent holders. Information regarding the ITU-T patent policy is available from 
the ITU Web site at http://www.itu.int.

THIS IS NOT A GRANT OF PATENT RIGHTS - SEE THE ITU-T PATENT POLICY.

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




#if !defined(AFX_FGSSUBBANDENCODER_H__02F9A3A4_BE1C_4D88_86D9_98AF451F04CD__INCLUDED_)
#define AFX_FGSSUBBANDENCODER_H__02F9A3A4_BE1C_4D88_86D9_98AF451F04CD__INCLUDED_

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000


#include "MbSymbolWriteIf.h"
#include "ControlMngH264AVCEncoder.h"
#include "H264AVCCommonLib/MbDataCtrl.h"
#include "H264AVCCommonLib/Transform.h"

#include "H264AVCCommonLib/FGSCoder.h"


H264AVC_NAMESPACE_BEGIN


class YuvBufferCtrl;
class Transform;
class MbDataCtrl;
class MbEncoder;



#define TWSOT(x)  { if( x) { xThrowWriteStop(); } }
#define TWSOF(x)  { if(!x) { xThrowWriteStop(); } }


class RQFGSEncoder  
  : public FGSCoder
{
private:
  enum
  {
    RQ_QP_DELTA = 6
  };
  class WriteStop
  {
  };

  __inline Void xThrowWriteStop()
  {
    throw WriteStop();
  }

protected:
	RQFGSEncoder         ();
	virtual ~RQFGSEncoder();

public:
  static ErrVal     create                ( RQFGSEncoder*&              rpcFGSSubbandEncoder );
  ErrVal            destroy               ();

  ErrVal            init                  ( YuvBufferCtrl**             apcYuvFullPelBufferCtrl,
                                            Transform*                  pcTransform,
                                            ControlMngH264AVCEncoder*   pcControlMng,
                                            MbEncoder*                  pcMbEncoder );
  ErrVal            uninit                ();
  ErrVal            initSPS               ( const SequenceParameterSet& rcSPS );


  ErrVal            initPicture           ( SliceHeader*                pcSliceHeader,
                                            MbDataCtrl*                 pcCurrMbDataCtrl,
                                            IntFrame*                   pcOrgResidual,
                                            Double                      dNumFGSLayers,
                                            Double                      dLambda,
                                            Int                         iMaxQpDelta,
                                            Bool&                       rbFinished,
                                            Bool                        bTruncate,
                                            Bool                        bUseDiscardable); //JVT-P031
  ErrVal            encodeNextLayer       ( Bool&                       rbFinished,
                                            Bool&                       rbCorrupted,
                                            UInt                        uiMaxBits,
                                            UInt                        uiFrac,
                                            Bool                        bFragmented,
                                            FILE*                       pFile ); //JVT-P031
  ErrVal            reconstruct           ( IntFrame*                   pcRecResidual );
  ErrVal            finishPicture         ();
  
  ErrVal            setNewOriginalResidual( IntFrame                    *pcNewOriginalResidual )
  {
    m_pcOrgResidual = pcNewOriginalResidual;

    return Err::m_nOK;
  }
  
private:
  ErrVal            xVLCParseLuma         ( UInt   uiBlockYIndex,
                                            UInt   uiBlockXIndex,
                                            UInt*  pauiNumCoefHist,
                                            UInt*  pauiHighMagHist);
  ErrVal            xVLCParseChromaAC     ( UInt   uiPlane,
                                            UInt   uiBlockYIndex,
                                            UInt   uiBlockXIndex,
                                            UInt*  pauiNumCoefHist);

  ErrVal            xSetSymbolsChroma     ( TCoeff*                     piCoeff,
                                            UInt                        uiMbX,
                                            UInt                        uiMbY,
                                            const QpParameter&          cQP,
                                            UInt&                       uiCoeffCostDC,
                                            UInt&                       uiCoeffCostAC,
                                            Bool&                       bSigDC,
                                            Bool&                       bSigAC,
                                            ChromaIdx                   cIdx );
  ErrVal            xSetSymbols4x4        ( TCoeff*                     piCoeff,
                                            UInt                        uiMbX,
                                            UInt                        uiMbY,
                                            const QpParameter&          cQP,
                                            UInt&                       uiCoeffCost,
                                            UInt&                       ruiCbp,
                                            LumaIdx                     cIdx,
                                            UInt                        uiStart );
  ErrVal            xSetSymbols8x8        ( TCoeff*                     piCoeff,
                                            TCoeff*                     piCoeffBase,
                                            const QpParameter&          cQP,
                                            UInt&                       uiCoeffCost,
                                            UInt&                       ruiCbp,
                                            LumaIdx                     cIdx );


  ErrVal            xRequantizeMacroblock ( MbDataAccess&               rcMbDataAccess,
                                            MbDataAccess&               rcMbDataAccessBL,
                                            IntYuvMbBuffer&             rcBLRecBuffer );

  ErrVal            xScaleBaseLayerCoeffs ();
  ErrVal            xResidualTransform    ();


  ErrVal            xEncodingFGS                  ( Bool&               rbFinished, 
                                                    Bool&               rbCorrupted, 
                                                    UInt                uiMaxBits, 
                                                    UInt                uiFracNb, 
                                                    FILE*               pFile ); //JVT-P031

  
  ErrVal            xEncodeNewCoefficientLuma     ( UInt                uiBlockYIndex,
                                                    UInt                uiBlockXIndex,
                                                    UInt&               uiComplete,
                                                    Int&                riLastQp );
  ErrVal            xEncodeNewCoefficientChromaDC ( UInt                uiPlane,
                                                    UInt                uiMbYIdx,
                                                    UInt                uiMbXIdx,
                                                    UInt&               uiComplete,
                                                    Int&                riLastQP );
  ErrVal            xEncodeNewCoefficientChromaAC ( UInt                uiPlane,
                                                    UInt                uiB8YIdx,
                                                    UInt                uiB8XIdx,
                                                    UInt&               uiComplete,
                                                    Int&                riLastQP );
  
  ErrVal            xEncodeCoefficientLumaRef     ( UInt                uiBlockYIndex,
                                                    UInt                uiBlockXIndex,
                                                    UInt                uiScanIndex );
  ErrVal            xEncodeCoefficientChromaDCRef ( UInt                uiPlane,
                                                    UInt                uiMbYIdx,
                                                    UInt                uiMbXIdx,
                                                    UInt                uiDCIdx );
  ErrVal            xEncodeCoefficientChromaACRef ( UInt                uiPlane,
                                                    UInt                uiB8YIdx,
                                                    UInt                uiB8XIdx,
                                                    UInt                uiScanIdx );

  UInt              xGetSigCtxLuma                ( UInt                uiScanIdx,
                                                    UInt                uiBlockY,
                                                    UInt                uiBlockX );
  UInt              xGetSigCtxChromaDC            ( UInt                uiPlane,
                                                    UInt                uiScanIdx,
                                                    UInt                uiMbY,
                                                    UInt                uiMbX );
  UInt              xGetSigCtxChromaAC            ( UInt                uiPlane,
                                                    UInt                uiScanIdx,
                                                    UInt                uiB8Y,
                                                    UInt                uiB8X );
  //JVT-P031
ErrVal            xStoreFGSState(UInt iLumaScanIdx,
                             UInt iChromaDCScanIdx,
                             UInt iChromaACScanIdx,
                             UInt iStartCycle,
                             UInt iCompleteLuma,
                             UInt iCompleteChromaDC,
                             UInt iCompleteChromaAC,
                             UInt iCycle,
                             UInt itCompleteLuma,
                             UInt itCompleteChromaDC,
                             UInt itCompleteChromaAC,
                             UInt bAllowChromaDC,
                             UInt bAllowChromaAC,
                             UInt uiMbYIdx,
                             UInt uiMbXIdx,
                             UInt uiB8YIdx,
                             UInt uiB8XIdx,
                             UInt uiBlockYIdx,
                             UInt uiBlockXIdx,
                             UInt iLastBitsLuma,
                             UInt uiBitsLast,
                             UInt uiFGSPart,
                             UInt uiPlane,
                             Int iLastQP);

  ErrVal            xRestoreFGSState(UInt& riLumaScanIdx,
                             UInt& riChromaDCScanIdx,
                             UInt& riChromaACScanIdx,
                             UInt& riStartCycle,
                             UInt& riCompleteLuma,
                             UInt& riCompleteChromaDC,
                             UInt& riCompleteChromaAC,
                             UInt& riCycle,
                             UInt& ritCompleteLuma,
                             UInt& ritCompleteChromaDC,
                             UInt& ritCompleteChromaAC,
                             UInt& rbAllowChromaDC,
                             UInt& rbAllowChromaAC,
                             UInt& ruiMbYIdx,
                             UInt& ruiMbXIdx,
                             UInt& ruiB8YIdx,
                             UInt& ruiB8XIdx,
                             UInt& ruiBlockYIdx,
                             UInt& ruiBlockXIdx,
                             UInt& riLastBitsLuma,
                             UInt& ruiBitsLast,
                             UInt& ruiFGSPart,
                             UInt& ruiPlane,
                             Int& riLastQP);
  ErrVal        xSaveCodingPath();
  ErrVal        xRestoreCodingPath();
  //~JVT-P031
private:
  MbSymbolWriteIf*  m_pcSymbolWriter;
  ControlMngH264AVCEncoder* m_pcControlMng;
  MbEncoder*        m_pcMbEncoder;

  Int               m_iRemainingTCoeff;
  Double            m_dLambda;
  Int               m_iMaxQpDelta;
  SliceHeader*      m_pcSliceHeader;
  SliceType         m_eSliceType;
  UInt              m_uiFirstMbInSlice;
  UInt              m_uiNumMbsInSlice;

  IntFrame*         m_pcOrgResidual;

  
  Bool              m_bTraceEnable;

  //JVT-P031
  UInt               m_iLumaScanIdx;
  UInt               m_iChromaDCScanIdx;
  UInt               m_iChromaACScanIdx;
  UInt               m_iStartCycle;
  UInt               m_iCompleteLuma;
  UInt               m_iCompleteChromaDC;
  UInt               m_iCompleteChromaAC;
  UInt               m_iCycle;
  UInt              m_itCompleteLuma;
  UInt              m_itCompleteChromaDC;
  UInt              m_itCompleteChromaAC;
  UInt              m_bAllowChromaDC;
  UInt              m_bAllowChromaAC;
  UInt              m_uiMbYIdx;
  UInt              m_uiMbXIdx;
  UInt              m_uiB8YIdx;
  UInt              m_uiB8XIdx;
  UInt              m_uiBlockYIdx;
  UInt              m_uiBlockXIdx;
  UInt               m_iLastBitsLuma;
  UInt              m_uiBitsLast;
  UInt              m_uiFGSPart;
  UInt              m_uiPlane;
  Int               m_iLastQP;
  Bool              m_bUseDiscardableUnit;   
  MbTransformCoeffs ** m_aMyELTransformCoefs;
  MbTransformCoeffs ** m_aMyBLTransformCoefs;
  UInt              * m_auiMbCbpStored;
  UInt              * m_auiBCBPStored;
  Int               * m_aiBLQP;
  Bool              * m_abELtransform8x8;
};



H264AVC_NAMESPACE_END


#endif // !defined(AFX_FGSSUBBANDENCODER_H__02F9A3A4_BE1C_4D88_86D9_98AF451F04CD__INCLUDED_)
