/* The copyright in this software is being made available under the BSD * License, included below. This software may be subject to other third party * and contributor rights, including patent rights, and no such rights are * granted under this license. * * Copyright (c) 2010-2012, ITU/ISO/IEC * 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 the ITU/ISO/IEC nor the names of its 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 HOLDER 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. */ /** \file TEncEntropy.h \brief entropy encoder class (header) */ #ifndef __TENCENTROPY__ #define __TENCENTROPY__ #include "TLibCommon/TComSlice.h" #include "TLibCommon/TComDataCU.h" #include "TLibCommon/TComBitStream.h" #include "TLibCommon/ContextModel.h" #include "TLibCommon/TComPic.h" #include "TLibCommon/TComTrQuant.h" #include "TLibCommon/TComAdaptiveLoopFilter.h" #include "TLibCommon/TComSampleAdaptiveOffset.h" class TEncSbac; class TEncCavlc; class SEI; // ==================================================================================================================== // Class definition // ==================================================================================================================== /// entropy encoder pure class class TEncEntropyIf { public: virtual Bool getAlfCtrl() = 0; virtual UInt getMaxAlfCtrlDepth() = 0; virtual Void setAlfCtrl(Bool bAlfCtrl) = 0; virtual Void setMaxAlfCtrlDepth(UInt uiMaxAlfCtrlDepth) = 0; virtual Void resetEntropy () = 0; #if CABAC_INIT_FLAG virtual Void determineCabacInitIdx () = 0; #endif virtual Void setBitstream ( TComBitIf* p ) = 0; virtual Void setSlice ( TComSlice* p ) = 0; virtual Void resetBits () = 0; virtual Void resetCoeffCost () = 0; virtual UInt getNumberOfWrittenBits() = 0; virtual UInt getCoeffCost () = 0; #if VIDYO_VPS_INTEGRATION virtual Void codeVPS ( TComVPS* pcVPS ) = 0; #endif #if HHI_MPI virtual Void codeSPS ( TComSPS* pcSPS, Bool bIsDepth ) = 0; #else virtual Void codeSPS ( TComSPS* pcSPS ) = 0; #endif virtual Void codePPS ( TComPPS* pcPPS ) = 0; virtual void codeSEI(const SEI&) = 0; virtual Void codeSliceHeader ( TComSlice* pcSlice ) = 0; virtual Void codeTileMarkerFlag ( TComSlice* pcSlice ) = 0; #if TILES_WPP_ENTRY_POINT_SIGNALLING virtual Void codeTilesWPPEntryPoint ( TComSlice* pSlice ) = 0; #else virtual Void codeSliceHeaderSubstreamTable( TComSlice* pcSlice ) = 0; #endif virtual Void codeTerminatingBit ( UInt uilsLast ) = 0; virtual Void codeSliceFinish () = 0; #if OL_FLUSH virtual Void codeFlush () = 0; virtual Void encodeStart () = 0; #endif virtual Void codeAlfCtrlDepth() = 0; #if HHI_INTER_VIEW_MOTION_PRED virtual Void codeMVPIdx ( TComDataCU* pcCU, UInt uiAbsPartIdx, RefPicList eRefList, Int iNum ) = 0; #else virtual Void codeMVPIdx ( TComDataCU* pcCU, UInt uiAbsPartIdx, RefPicList eRefList ) = 0; #endif virtual Void codeScalingList ( TComScalingList* scalingList ) = 0; public: virtual Void codeAlfCtrlFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeApsExtensionFlag () = 0; virtual Void codeSkipFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeMergeFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeMergeIndex ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; #if HHI_INTER_VIEW_RESIDUAL_PRED virtual Void codeResPredFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; #endif virtual Void codeSplitFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth ) = 0; virtual Void codePartSize ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth ) = 0; virtual Void codePredMode ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; #if BURST_IPCM virtual Void codeIPCMInfo ( TComDataCU* pcCU, UInt uiAbsPartIdx, Int numIPCM, Bool firstIPCMFlag) = 0; #else virtual Void codeIPCMInfo ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; #endif virtual Void codeTransformSubdivFlag( UInt uiSymbol, UInt uiCtx ) = 0; virtual Void codeQtCbf ( TComDataCU* pcCU, UInt uiAbsPartIdx, TextType eType, UInt uiTrDepth ) = 0; virtual Void codeQtRootCbf ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeIntraDirLumaAng( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeIntraDirChroma( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeInterDir ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeRefFrmIdx ( TComDataCU* pcCU, UInt uiAbsPartIdx, RefPicList eRefList ) = 0; virtual Void codeMvd ( TComDataCU* pcCU, UInt uiAbsPartIdx, RefPicList eRefList ) = 0; virtual Void codeDeltaQP ( TComDataCU* pcCU, UInt uiAbsPartIdx ) = 0; virtual Void codeCoeffNxN ( TComDataCU* pcCU, TCoeff* pcCoef, UInt uiAbsPartIdx, UInt uiWidth, UInt uiHeight, UInt uiDepth, TextType eTType ) = 0; virtual Void codeAlfFlag ( UInt uiCode ) = 0; virtual Void codeAlfUvlc ( UInt uiCode ) = 0; virtual Void codeAlfSvlc ( Int iCode ) = 0; #if LCU_SYNTAX_ALF virtual Void codeAlfFixedLengthIdx( UInt idx, UInt numFilterSetsInBuffer) = 0; virtual Void codeAPSAlflag(UInt uiCode) = 0; #endif /// set slice granularity virtual Void setSliceGranularity(Int iSliceGranularity) = 0; /// get slice granularity virtual Int getSliceGranularity() = 0; virtual Void codeAlfCtrlFlag ( UInt uiSymbol ) = 0; virtual Void codeSaoFlag ( UInt uiCode ) = 0; virtual Void codeSaoUvlc ( UInt uiCode ) = 0; virtual Void codeSaoSvlc ( Int iCode ) = 0; #if SAO_UNIT_INTERLEAVING virtual Void codeSaoRun ( UInt uiCode, UInt uiMaxValue ) = 0; virtual Void codeSaoMergeLeft ( UInt uiCode, UInt uiCompIdx ) = 0; virtual Void codeSaoMergeUp ( UInt uiCode) = 0; virtual Void codeSaoTypeIdx ( UInt uiCode) = 0; virtual Void codeSaoUflc ( UInt uiCode) = 0; #endif virtual Void estBit (estBitsSbacStruct* pcEstBitsSbac, Int width, Int height, TextType eTType) = 0; virtual Void updateContextTables ( SliceType eSliceType, Int iQp, Bool bExecuteFinish ) = 0; virtual Void updateContextTables ( SliceType eSliceType, Int iQp ) = 0; virtual Void writeTileMarker ( UInt uiTileIdx, UInt uiBitsUsed ) = 0; virtual Void codeAPSInitInfo (TComAPS* pcAPS)= 0; virtual Void codeFinish (Bool bEnd)= 0; virtual Void codeDFFlag (UInt uiCode, const Char *pSymbolName) = 0; virtual Void codeDFSvlc (Int iCode, const Char *pSymbolName) = 0; virtual ~TEncEntropyIf() {} }; /// entropy encoder class class TEncEntropy { private: UInt m_uiBakAbsPartIdx; UInt m_uiBakChromaOffset; #if UNIFIED_TRANSFORM_TREE UInt m_bakAbsPartIdxCU; #endif public: Void setEntropyCoder ( TEncEntropyIf* e, TComSlice* pcSlice ); Void setBitstream ( TComBitIf* p ) { m_pcEntropyCoderIf->setBitstream(p); } Void resetBits () { m_pcEntropyCoderIf->resetBits(); } Void resetCoeffCost () { m_pcEntropyCoderIf->resetCoeffCost(); } UInt getNumberOfWrittenBits () { return m_pcEntropyCoderIf->getNumberOfWrittenBits(); } UInt getCoeffCost () { return m_pcEntropyCoderIf->getCoeffCost(); } Void resetEntropy () { m_pcEntropyCoderIf->resetEntropy(); } #if CABAC_INIT_FLAG Void determineCabacInitIdx () { m_pcEntropyCoderIf->determineCabacInitIdx(); } #endif Void encodeSliceHeader ( TComSlice* pcSlice ); Void encodeTileMarkerFlag (TComSlice* pcSlice) {m_pcEntropyCoderIf->codeTileMarkerFlag(pcSlice);} #if TILES_WPP_ENTRY_POINT_SIGNALLING Void encodeTilesWPPEntryPoint( TComSlice* pSlice ); #else Void encodeSliceHeaderSubstreamTable( TComSlice* pcSlice ); #endif Void encodeTerminatingBit ( UInt uiIsLast ); Void encodeSliceFinish (); #if OL_FLUSH Void encodeFlush (); Void encodeStart (); #endif #if LCU_SYNTAX_ALF Void encodeAlfFlag(UInt code) {m_pcEntropyCoderIf->codeAlfFlag(code);} Void encodeAlfStoredFilterSetIdx(UInt idx, UInt numFilterSetsInBuffer); Void encodeAlfFixedLengthRun(UInt run, UInt rx, UInt numLCUInWidth); Void encodeAlfParam(AlfParamSet* pAlfParamSet, Bool bSentInAPS = true, Int firstLCUAddr = 0, Bool alfAcrossSlice= true); Void encodeAlfParamSet(AlfParamSet* pAlfParamSet, Int numLCUInWidth, Int numLCU, Int firstLCUAddr, Bool alfAcrossSlice, Int startCompIdx, Int endCompIdx); Bool getAlfRepeatRowFlag(Int compIdx, AlfParamSet* pAlfParamSet, Int lcuIdx, Int lcuPos, Int startlcuPosX, Int endlcuPosX, Int numLCUInWidth); Int getAlfRun(Int compIdx, AlfParamSet* pAlfParamSet, Int lcuIdxInSlice, Int lcuPos, Int startlcuPosX, Int endlcuPosX); Void encodeAPSAlfFlag(UInt code) {m_pcEntropyCoderIf->codeAPSAlflag(code);} #endif Void encodeAlfParam(ALFParam* pAlfParam); TEncEntropyIf* m_pcEntropyCoderIf; public: #if VIDYO_VPS_INTEGRATION Void encodeVPS ( TComVPS* pcVPS); #endif // SPS #if HHI_MPI Void encodeSPS ( TComSPS* pcSPS, Bool bIsDepth ); #else Void encodeSPS ( TComSPS* pcSPS ); #endif Void encodePPS ( TComPPS* pcPPS ); void encodeSEI(const SEI&); Bool getAlfCtrl() {return m_pcEntropyCoderIf->getAlfCtrl();} UInt getMaxAlfCtrlDepth() {return m_pcEntropyCoderIf->getMaxAlfCtrlDepth();} Void setAlfCtrl(Bool bAlfCtrl) {m_pcEntropyCoderIf->setAlfCtrl(bAlfCtrl);} Void setMaxAlfCtrlDepth(UInt uiMaxAlfCtrlDepth) {m_pcEntropyCoderIf->setMaxAlfCtrlDepth(uiMaxAlfCtrlDepth);} Void encodeSplitFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool bRD = false ); Void encodeSkipFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); Void encodePUWise ( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); Void encodeInterDirPU ( TComDataCU* pcSubCU, UInt uiAbsPartIdx ); Void encodeRefFrmIdxPU ( TComDataCU* pcSubCU, UInt uiAbsPartIdx, RefPicList eRefList ); Void encodeMvdPU ( TComDataCU* pcSubCU, UInt uiAbsPartIdx, RefPicList eRefList ); Void encodeMVPIdxPU ( TComDataCU* pcSubCU, UInt uiAbsPartIdx, RefPicList eRefList ); Void encodeMergeFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiPUIdx ); Void encodeMergeIndex ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiPUIdx, Bool bRD = false ); #if HHI_INTER_VIEW_RESIDUAL_PRED Void encodeResPredFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiPUIdx, Bool bRD = false ); #endif Void encodeAlfCtrlFlag ( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); /// set slice granularity Void setSliceGranularity (Int iSliceGranularity) {m_pcEntropyCoderIf->setSliceGranularity(iSliceGranularity);} /// encode ALF CU control flag Void encodeAlfCtrlFlag(UInt uiFlag); Void encodeApsExtensionFlag() {m_pcEntropyCoderIf->codeApsExtensionFlag();}; Void encodeAlfCtrlParam(AlfCUCtrlInfo& cAlfParam, Int iNumCUsInPic); Void encodePredMode ( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); Void encodePartSize ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool bRD = false ); Void encodeIPCMInfo ( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); Void encodePredInfo ( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); Void encodeIntraDirModeLuma ( TComDataCU* pcCU, UInt uiAbsPartIdx ); Void encodeIntraDirModeChroma( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); #if !UNIFIED_TRANSFORM_TREE Void encodeTransformIdx ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, Bool bRD = false ); #endif Void encodeTransformSubdivFlag( UInt uiSymbol, UInt uiCtx ); Void encodeQtCbf ( TComDataCU* pcCU, UInt uiAbsPartIdx, TextType eType, UInt uiTrDepth ); Void encodeQtRootCbf ( TComDataCU* pcCU, UInt uiAbsPartIdx ); Void encodeQP ( TComDataCU* pcCU, UInt uiAbsPartIdx, Bool bRD = false ); Void updateContextTables ( SliceType eSliceType, Int iQp, Bool bExecuteFinish ) { m_pcEntropyCoderIf->updateContextTables( eSliceType, iQp, bExecuteFinish ); } Void updateContextTables ( SliceType eSliceType, Int iQp ) { m_pcEntropyCoderIf->updateContextTables( eSliceType, iQp, true ); } Void writeTileMarker ( UInt uiTileIdx, UInt uiBitsUsed ) { m_pcEntropyCoderIf->writeTileMarker( uiTileIdx, uiBitsUsed ); } Void encodeAPSInitInfo (TComAPS* pcAPS) {m_pcEntropyCoderIf->codeAPSInitInfo(pcAPS);} Void encodeFinish (Bool bEnd) {m_pcEntropyCoderIf->codeFinish(bEnd);} Void encodeScalingList ( TComScalingList* scalingList ); Void encodeDFParams (TComAPS* pcAPS); private: #if UNIFIED_TRANSFORM_TREE Void xEncodeTransform ( TComDataCU* pcCU,UInt offsetLumaOffset, UInt offsetChroma, UInt uiAbsPartIdx, UInt absTUPartIdx, UInt uiDepth, UInt width, UInt height, UInt uiTrIdx, UInt uiInnerQuadIdx, UInt& uiYCbfFront3, UInt& uiUCbfFront3, UInt& uiVCbfFront3, Bool& bCodeDQP ); #else Void xEncodeTransformSubdiv ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt absTUPartIdx, UInt uiDepth, UInt uiInnerQuadIdx, UInt& uiYCbfFront3, UInt& uiUCbfFront3, UInt& uiVCbfFront3 ); Void xEncodeCoeff ( TComDataCU* pcCU, UInt uiLumaOffset, UInt uiChromaOffset, UInt uiAbsPartIdx, UInt uiDepth, UInt uiWidth, UInt uiHeight, UInt uiTrIdx, UInt uiCurrTrIdx, Bool& bCodeDQP ); #endif // !UNIFIED_TRANSFORM_TREE public: Void encodeCoeff ( TComDataCU* pcCU, UInt uiAbsPartIdx, UInt uiDepth, UInt uiWidth, UInt uiHeight, Bool& bCodeDQP ); Void encodeCoeffNxN ( TComDataCU* pcCU, TCoeff* pcCoeff, UInt uiAbsPartIdx, UInt uiTrWidth, UInt uiTrHeight, UInt uiDepth, TextType eType ); Void estimateBit ( estBitsSbacStruct* pcEstBitsSbac, Int width, Int height, TextType eTType); // ALF-related Void codeAuxCountBit(ALFParam* pAlfParam, Int64* ruiRate); Void codeFiltCountBit(ALFParam* pAlfParam, Int64* ruiRate); Void codeAux (ALFParam* pAlfParam); Void codeFilt (ALFParam* pAlfParam); Int codeFilterCoeff(ALFParam* ALFp); Int writeFilterCodingParams(int minKStart, int minScanVal, int maxScanVal, int kMinTab[]); Int writeFilterCoeffs(int sqrFiltLength, int filters_per_group, int pDepthInt[], int **FilterCoeff, int kMinTab[]); Int golombEncode(int coeff, int k); Int lengthGolomb(int coeffVal, int k); #if SAO_UNIT_INTERLEAVING Void encodeSaoUnit(Int rx, Int ry, Int compIdx, SAOParam* saoParam, Int repeatedRow); Void encodeSaoOffset(SaoLcuParam* saoLcuParam); Void encodeSaoUnitInterleaving(Int rx, Int ry, SAOParam* saoParam, TComDataCU* cu, Int cuAddrInSlice, Int cuAddrUpInSlice, Bool lfCrossSliceBoundaryFlag); Void encodeSaoParam (TComAPS* aps); #else Void encodeSaoOnePart (SAOParam* pSaoParam, Int iPartIdx, Int iYCbCr); Void encodeQuadTreeSplitFlag(SAOParam* pSaoParam, Int iPartIdx, Int iYCbCr); Void encodeSaoParam (SAOParam* pSaoParam); #endif static Int countNonZeroCoeffs( TCoeff* pcCoef, UInt uiSize ); };// END CLASS DEFINITION TEncEntropy //! \} #endif // __TENCENTROPY__