/* -----------------------------------------------------------------------------

The copyright in this software is being made available under the Clear BSD

License, included below. No patent rights, trademark rights and/or 

other Intellectual Property Rights other than the copyrights concerning 

the Software are granted under this license.

The Clear BSD License

Copyright (c) 2019-2026, Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. & The VVenC Authors.

All rights reserved.

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

are permitted (subject to the limitations in the disclaimer below) 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 copyright holder nor the names of its

     contributors may be used to endorse or promote products derived from this

     software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY

THIS LICENSE. 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     Slice.h

    \brief    slice header and SPS class (header)

*/

#pragma once

#include "CommonDef.h"

#include "Rom.h"

#include "AlfParameters.h"

#include "Common.h"

#include "MotionInfo.h"

#include "HRD.h"

#include "vvenc/vvencCfg.h"

#include <cstring>

#include <list>

#include <map>

#include <vector>

#include <cstdint>

//! \ingroup CommonLib

//! \{

namespace vvenc {

struct  MotionInfo;

struct  Picture;

class   Pic;

class   TrQuant;

class   PreCalcValues;

typedef std::list<Picture*> PicList;

// ====================================================================================================================

// Constants

// ====================================================================================================================

static const uint32_t REF_PIC_LIST_NUM_IDX=32;

// ====================================================================================================================

// Class definition

// ====================================================================================================================

struct DpbParameters

{

  int maxDecPicBuffering     [VVENC_MAX_TLAYER] = { 0 };

  int numReorderPics         [VVENC_MAX_TLAYER] = { 0 };

  int maxLatencyIncreasePlus1[VVENC_MAX_TLAYER] = { 0 };

};

struct ReferencePictureList

{

  int       numberOfShorttermPictures;

  int       numberOfLongtermPictures;

  int       numberOfActivePictures;

  bool      isLongtermRefPic[VVENC_MAX_NUM_REF_PICS];

  int       refPicIdentifier[VVENC_MAX_NUM_REF_PICS];  //This can be delta POC for STRP or POC LSB for LTRP

  int       POC[VVENC_MAX_NUM_REF_PICS];

  uint32_t  deltaPocMSBCycleLT[VVENC_MAX_NUM_REF_PICS];

  bool      deltaPocMSBPresent[VVENC_MAX_NUM_REF_PICS];

  bool      ltrpInSliceHeader;

  bool      interLayerPresent;

  bool      isInterLayerRefPic[VVENC_MAX_NUM_REF_PICS];

  int       interLayerRefPicIdx[VVENC_MAX_NUM_REF_PICS];

  int       numberOfInterLayerPictures;

  ReferencePictureList();

  void     initFromGopEntry     ( const GOPEntry& gopEntry, int l );

  void     setRefPicIdentifier  ( int idx, int identifier, bool isLongterm, bool isInterLayerRefPic, int interLayerIdx );

  int      getNumRefEntries     ()  const { return numberOfShorttermPictures + numberOfLongtermPictures; }

  bool     isPOCInRefPicList    ( const int poc, const int currPoc ) const;

};

/// Reference Picture List set class

typedef std::vector<ReferencePictureList> RPLList;

struct ConstraintInfo

{

  bool      gciPresent;

  bool      noRprConstraintFlag;

  bool      noResChangeInClvsConstraintFlag;

  bool      oneTilePerPicConstraintFlag;

  bool      picHeaderInSliceHeaderConstraintFlag;

  bool      oneSlicePerPicConstraintFlag;

  bool      noIdrRplConstraintFlag;

  bool      noRectSliceConstraintFlag;

  bool      oneSlicePerSubpicConstraintFlag;

  bool      noSubpicInfoConstraintFlag;

  bool      intraOnlyConstraintFlag;

  uint32_t  maxBitDepthConstraintIdc;

  int       maxChromaFormatConstraintIdc;

  bool      onePictureOnlyConstraintFlag;

  bool      lowerBitRateConstraintFlag;

  bool      allLayersIndependentConstraintFlag;

  bool      noMrlConstraintFlag;

  bool      noIspConstraintFlag;

  bool      noMipConstraintFlag;

  bool      noLfnstConstraintFlag;

  bool      noMmvdConstraintFlag;

  bool      noSmvdConstraintFlag;

  bool      noProfConstraintFlag;

  bool      noPaletteConstraintFlag;

  bool      noActConstraintFlag;

  bool      noLmcsConstraintFlag;

  bool      noExplicitScaleListConstraintFlag;

  bool      noVirtualBoundaryConstraintFlag;

  bool      noMttConstraintFlag;

  bool      noChromaQpOffsetConstraintFlag;

  bool      noQtbttDualTreeIntraConstraintFlag;

  int       maxLog2CtuSizeConstraintIdc;

  bool      noPartitionConstraintsOverrideConstraintFlag;

  bool      noSaoConstraintFlag;

  bool      noAlfConstraintFlag;

  bool      noCCAlfConstraintFlag;

  bool      noWeightedPredictionConstraintFlag;

  bool      noRefWraparoundConstraintFlag;

  bool      noTemporalMvpConstraintFlag;

  bool      noSbtmvpConstraintFlag;

  bool      noAmvrConstraintFlag;

  bool      noBdofConstraintFlag;

  bool      noDmvrConstraintFlag;

  bool      noCclmConstraintFlag;

  bool      noMtsConstraintFlag;

  bool      noSbtConstraintFlag;

  bool      noAffineMotionConstraintFlag;

  bool      noBcwConstraintFlag;

  bool      noIbcConstraintFlag;

  bool      noCiipConstraintFlag;

  bool      noGeoConstraintFlag;

  bool      noLadfConstraintFlag;

  bool      noTransformSkipConstraintFlag;

  bool      noLumaTransformSize64ConstraintFlag;

  bool      noBDPCMConstraintFlag;

  bool      noJointCbCrConstraintFlag;

  bool      noQpDeltaConstraintFlag;

  bool      noDepQuantConstraintFlag;

  bool      noSignDataHidingConstraintFlag;

  bool      noMixedNaluTypesInPicConstraintFlag;

  bool      noTrailConstraintFlag;

  bool      noStsaConstraintFlag;

  bool      noRaslConstraintFlag;

  bool      noRadlConstraintFlag;

  bool      noIdrConstraintFlag;

  bool      noCraConstraintFlag;

  bool      noGdrConstraintFlag;

  bool      noApsConstraintFlag;

  ConstraintInfo()

    : gciPresent                                      ( false )

    , noRprConstraintFlag                             ( false )

    , noResChangeInClvsConstraintFlag                 ( false )

    , oneTilePerPicConstraintFlag                     ( false )

    , picHeaderInSliceHeaderConstraintFlag            ( false )

    , oneSlicePerPicConstraintFlag                    ( false )

    , noIdrRplConstraintFlag                          ( false )

    , noRectSliceConstraintFlag                       ( false )

    , oneSlicePerSubpicConstraintFlag                 ( false )

    , noSubpicInfoConstraintFlag                      ( false )

    , intraOnlyConstraintFlag                         ( false )

    , maxBitDepthConstraintIdc                        ( false )

    , maxChromaFormatConstraintIdc                    ( CHROMA_420 )

    , onePictureOnlyConstraintFlag                    ( false )

    , lowerBitRateConstraintFlag                      ( false )

    , allLayersIndependentConstraintFlag              ( false )

    , noMrlConstraintFlag                             ( false )

    , noIspConstraintFlag                             ( false )

    , noMipConstraintFlag                             ( false )

    , noLfnstConstraintFlag                           ( false )

    , noMmvdConstraintFlag                            ( false )

    , noSmvdConstraintFlag                            ( false )

    , noProfConstraintFlag                            ( false )

    , noPaletteConstraintFlag                         ( false )

    , noActConstraintFlag                             ( false )

    , noLmcsConstraintFlag                            ( false )

    , noExplicitScaleListConstraintFlag               ( false )

    , noVirtualBoundaryConstraintFlag                 ( false )

    , noMttConstraintFlag                             ( false )

    , noChromaQpOffsetConstraintFlag                  ( false )

    , noQtbttDualTreeIntraConstraintFlag              ( false )

    , maxLog2CtuSizeConstraintIdc                     ( 0 )

    , noPartitionConstraintsOverrideConstraintFlag    ( false )

    , noSaoConstraintFlag                             ( false )

    , noAlfConstraintFlag                             ( false )

    , noCCAlfConstraintFlag                           ( false )

    , noWeightedPredictionConstraintFlag              ( false )

    , noRefWraparoundConstraintFlag                   ( false )

    , noTemporalMvpConstraintFlag                     ( false )

    , noSbtmvpConstraintFlag                          ( false )

    , noAmvrConstraintFlag                            ( false )

    , noBdofConstraintFlag                            ( false )

    , noDmvrConstraintFlag                            ( false )

    , noCclmConstraintFlag                            ( false )

    , noMtsConstraintFlag                             ( false )

    , noSbtConstraintFlag                             ( false )

    , noAffineMotionConstraintFlag                    ( false )

    , noBcwConstraintFlag                             ( false )

    , noIbcConstraintFlag                             ( false )

    , noCiipConstraintFlag                            ( false )

    , noGeoConstraintFlag                             ( false )

    , noLadfConstraintFlag                            ( false )

    , noTransformSkipConstraintFlag                   ( false )

    , noLumaTransformSize64ConstraintFlag             ( false )

    , noBDPCMConstraintFlag                           ( false )

    , noJointCbCrConstraintFlag                       ( false )

    , noQpDeltaConstraintFlag                         ( false )

    , noDepQuantConstraintFlag                        ( false )

    , noSignDataHidingConstraintFlag                  ( false )

    , noMixedNaluTypesInPicConstraintFlag             ( false )

    , noTrailConstraintFlag                           ( false )

    , noStsaConstraintFlag                            ( false )

    , noRaslConstraintFlag                            ( false )

    , noRadlConstraintFlag                            ( false )

    , noIdrConstraintFlag                             ( false )

    , noCraConstraintFlag                             ( false )

    , noGdrConstraintFlag                             ( false )

    , noApsConstraintFlag                             ( false )

  {}

};

struct ProfileTierLevel

{

  vvencTier             tierFlag;

  vvencProfile          profileIdc;

  uint8_t               numSubProfile;

  std::vector<uint32_t> subProfileIdc;

  vvencLevel                 levelIdc;

  bool                  frameOnlyConstraintFlag;

  bool                  multiLayerEnabledFlag;

  ConstraintInfo        constraintInfo;

  bool                  subLayerLevelPresent[VVENC_MAX_TLAYER - 1];

  vvencLevel            subLayerLevelIdc[VVENC_MAX_TLAYER - 1];

  ProfileTierLevel()

    : tierFlag        ( VVENC_TIER_MAIN )

    , profileIdc      ( VVENC_PROFILE_AUTO )

    , numSubProfile   (0)

    , subProfileIdc   (0)

    , levelIdc        ( VVENC_LEVEL_AUTO )

    , frameOnlyConstraintFlag ( true )

    , multiLayerEnabledFlag   ( false )

  {

    ::memset( subLayerLevelPresent, 0, sizeof(subLayerLevelPresent ));

    ::memset( subLayerLevelIdc,     0, sizeof(subLayerLevelIdc ));

  }

};

struct LmcsParam

{

  LmcsParam()

  : sliceReshaperEnabled( false )

  , sliceReshaperModelPresent( false )

  , enableChromaAdj(0)

  , reshaperModelMinBinIdx(0)

  , reshaperModelMaxBinIdx(0)

  , reshaperModelBinCWDelta { 0 }

  , maxNbitsNeededDeltaCW (0)

  , chrResScalingOffset (0)

  {

  }

  bool      sliceReshaperEnabled;

  bool      sliceReshaperModelPresent;

  unsigned  enableChromaAdj;

  uint32_t  reshaperModelMinBinIdx;

  uint32_t  reshaperModelMaxBinIdx;

  int       reshaperModelBinCWDelta[PIC_CODE_CW_BINS];

  int       maxNbitsNeededDeltaCW;

  int       chrResScalingOffset;

};

struct ChromaQpAdj

{

  union

  {

    struct {

      int CbOffset;

      int CrOffset;

      int JointCbCrOffset;

    } comp;

    int offset[3];

  } u;

};

struct ChromaQpMappingTable : vvencChromaQpMappingTableParams

{

  int       getMappedChromaQpValue(ComponentID compID, const int qpVal)  const { return m_chromaQpMappingTables[m_sameCQPTableForAllChromaFlag ? 0 : (int)compID - 1].at(qpVal + m_qpBdOffset); }

  void      derivedChromaQPMappingTables();

  void      setParams(const vvencChromaQpMappingTableParams &params, const int qpBdOffset);

private:

  std::vector<int> m_chromaQpMappingTables[VVENC_MAX_NUM_CQP_MAPPING_TABLES];

};

struct SliceMap

{

  uint32_t               sliceID;                           //!< slice identifier (slice index for rectangular slices, slice address for raser-scan slices)

  uint32_t               numTilesInSlice;                   //!< number of tiles in slice (raster-scan slices only)

  uint32_t               numCtuInSlice;                     //!< number of CTUs in the slice

  std::vector<int>       ctuAddrInSlice;                    //!< raster-scan addresses of all the CTUs in the slice

  SliceMap()

   : sliceID            ( 0 )

   , numTilesInSlice    ( 0 )

   , numCtuInSlice      ( 0 )

   , ctuAddrInSlice     ( )

  {

  }

  void  initSliceMap()

  {

    sliceID = 0;

    numTilesInSlice = 0;

    numCtuInSlice = 0;

    ctuAddrInSlice.clear();

  }

  void  addCtusToSlice( uint32_t startX, uint32_t stopX, uint32_t startY, uint32_t stopY, uint32_t picWidthInCtbsY )

  {

    CHECK( startX >= stopX || startY >= stopY, "Invalid slice definition");

    for( uint32_t ctbY = startY; ctbY < stopY; ctbY++ )

    {

      for( uint32_t ctbX = startX; ctbX < stopX; ctbX++ )

      {

        ctuAddrInSlice.push_back( ctbY * picWidthInCtbsY + ctbX );

        numCtuInSlice++;

      }

    }

  }

};

struct RectSlice

{

  uint32_t         tileIdx;                           //!< tile index corresponding to the first CTU in the slice

  uint32_t         sliceWidthInTiles;                 //!< slice width in units of tiles

  uint32_t         sliceHeightInTiles;                //!< slice height in units of tiles

  uint32_t         numSlicesInTile;                   //!< number of slices in current tile for the special case of multiple slices inside a single tile

  uint32_t         sliceHeightInCtu;                  //!< slice height in units of CTUs for the special case of multiple slices inside a single tile

  RectSlice()  {}

};

struct SubPic

{

  uint32_t         subPicID;                                  //!< ID of subpicture

  uint32_t         subPicIdx;                                 //!< Index of subpicture

  uint32_t         numCTUsInSubPic;                           //!< number of CTUs contained in this sub-picture

  uint32_t         subPicCtuTopLeftX;                         //!< horizontal position of top left CTU of the subpicture in unit of CTU

  uint32_t         subPicCtuTopLeftY;                         //!< vertical position of top left CTU of the subpicture in unit of CTU

  uint32_t         subPicWidth;                               //!< the width of subpicture in units of CTU

  uint32_t         subPicHeight;                              //!< the height of subpicture in units of CTU

  uint32_t         subPicWidthInLumaSample;                   //!< the width of subpicture in units of luma sample

  uint32_t         subPicHeightInLumaSample;                  //!< the height of subpicture in units of luma sample

  uint32_t         firstCtuInSubPic;                          //!< the raster scan index of the first CTU in a subpicture

  uint32_t         lastCtuInSubPic;                           //!< the raster scan index of the last CTU in a subpicture

  uint32_t         subPicLeft;                                //!< the position of left boundary

  uint32_t         subPicRight;                               //!< the position of right boundary

  uint32_t         subPicTop;                                 //!< the position of top boundary

  uint32_t         subPicBottom;                              //!< the position of bottom boundary

  std::vector<uint32_t> ctuAddrInSubPic;                      //!< raster scan addresses of all the CTUs in the slice

  bool             treatedAsPic;                          //!< whether the subpicture is treated as a picture in the decoding process excluding in-loop filtering operations

  bool             loopFilterAcrossSubPicEnabled;         //!< whether in-loop filtering operations may be performed across the boundaries of the subpicture

  uint32_t         numSlicesInSubPic;                         //!< Number of slices contained in this subpicture

  bool             isContainingPos(const Position& pos) const

  {

    return pos.x >= subPicLeft && pos.x <= subPicRight && pos.y >= subPicTop  && pos.y <= subPicBottom;

  }

  void init( unsigned picWithInCtu, unsigned picHeightInCtu, unsigned picWithInSamples, unsigned picHeighthInSamples )

  {

    unsigned numCtus          = picWithInCtu * picHeightInCtu;

    numCTUsInSubPic           = numCtus;

    subPicWidth               = picWithInCtu;

    subPicHeight              = picHeightInCtu;

    subPicWidthInLumaSample   = picWithInSamples;

    subPicHeightInLumaSample  = picHeighthInSamples;

    lastCtuInSubPic           = numCtus;

    subPicRight               = picWithInSamples-1;

    subPicBottom              = picHeighthInSamples-1;

    ctuAddrInSubPic.resize( numCtus );

    for( unsigned i = 0; i < numCtus; i++)

    {

      ctuAddrInSubPic[i] = i;

    }

  }

  SubPic()

  : subPicID(0)

  , subPicIdx(0)

  , numCTUsInSubPic(UINT32_MAX)

  , subPicCtuTopLeftX(0)

  , subPicCtuTopLeftY(0)

  , subPicWidth(UINT32_MAX)

  , subPicHeight(UINT32_MAX)

  , subPicWidthInLumaSample(UINT32_MAX)

  , subPicHeightInLumaSample(UINT32_MAX)

  , firstCtuInSubPic(0)

  , lastCtuInSubPic(UINT32_MAX)

  , subPicLeft(0)

  , subPicRight(0)

  , subPicTop(0)

  , subPicBottom(0)

  , treatedAsPic(true)

  , loopFilterAcrossSubPicEnabled(true)

  , numSlicesInSubPic(1)

  {

  }

};

struct DCI

{

  uint32_t   dciId;

  std::vector<ProfileTierLevel> profileTierLevel;

  DCI() : dciId(0) {}

};

struct VPS

{

  uint32_t              vpsId;

  uint32_t              maxLayers;

  uint32_t              maxSubLayers;

  uint32_t              layerId[MAX_VPS_LAYERS];

  bool                  defaultPtlDpbHrdMaxTidFlag;

  bool                  allLayersSameNumSubLayers;

  bool                  allIndependentLayers;

  uint32_t              vpsCfgPredDirection[MAX_VPS_SUBLAYERS];

  bool                  independentLayer[MAX_VPS_LAYERS];

  bool                  directRefLayer[MAX_VPS_LAYERS][MAX_VPS_LAYERS];

  uint8_t               maxTidIlRefPicsPlus1[MAX_VPS_LAYERS][MAX_VPS_LAYERS];

  bool                  eachLayerIsAnOls;

  uint32_t              olsModeIdc;

  uint32_t              numOutputLayerSets;

  bool                  olsOutputLayer[MAX_NUM_OLSS][MAX_VPS_LAYERS];

  uint32_t              directRefLayerIdx[MAX_VPS_LAYERS][MAX_VPS_LAYERS];

  uint32_t              generalLayerIdx[MAX_VPS_LAYERS];

  uint32_t              numPtls;

  bool                  ptPresent[MAX_NUM_OLSS];

  uint32_t              ptlMaxTemporalId[MAX_NUM_OLSS];

  std::vector<ProfileTierLevel> profileTierLevel;

  uint32_t              olsPtlIdx[MAX_NUM_OLSS];

  // stores index ( ilrp_idx within 0 .. NumDirectRefLayers ) of the dependent reference layers

  uint32_t              interLayerRefIdx[MAX_VPS_LAYERS][MAX_VPS_LAYERS];

  bool                  extension;

  bool                  generalHrdParamsPresent;

  bool                  sublayerCpbParamsPresent;

  uint32_t              numOlsHrdParamsMinus1;

  uint32_t              hrdMaxTid[MAX_NUM_OLSS];

  uint32_t              olsHrdIdx[MAX_NUM_OLSS];

  GeneralHrdParams      generalHrdParams;

  OlsHrdParams          olsHrdParams[VVENC_MAX_TLAYER];

  std::vector<Size>             olsDpbPicSize;

  std::vector<int>              olsDpbParamsIdx;

  std::vector<std::vector<int>> outputLayerIdInOls;

  std::vector<std::vector<int>> numSubLayersInLayerInOLS;

  std::vector<int>              olsDpbChromaFormatIdc;

  std::vector<int>              olsDpbBitDepthMinus8;

  int                           totalNumOLSs;

  int                           numMultiLayeredOlss;

  uint32_t                      multiLayerOlsIdx[MAX_NUM_OLSS];

  int                           numDpbParams;

  std::vector<DpbParameters>    dpbParameters;

  bool                          sublayerDpbParamsPresent;

  std::vector<int>              dpbMaxTemporalId;

  std::vector<int>              targetOutputLayerIdSet;          ///< set of LayerIds to be outputted

  std::vector<int>              targetLayerIdSet;                ///< set of LayerIds to be included in the sub-bitstream extraction process.

  int                           targetOlsIdx;

  std::vector<int>              numOutputLayersInOls;

  std::vector<int>              numLayersInOls;

  std::vector<std::vector<int>> layerIdInOls;

  VPS()

  : vpsId                       ( 0 )

  , maxLayers                   ( 0 )

  , maxSubLayers                ( 0 )

  , defaultPtlDpbHrdMaxTidFlag  ( false )

  , allLayersSameNumSubLayers   ( false )

  , allIndependentLayers        ( false )

  , eachLayerIsAnOls            ( false )

  , olsModeIdc                  ( 0 )

  , numOutputLayerSets          ( 0 )

  , numPtls                     ( 0 )

  , extension                   ( false )

  , totalNumOLSs                ( 0 )

  , numDpbParams                ( 0 )

  , sublayerDpbParamsPresent    ( false)

  , targetOlsIdx                ( 0 )

  {

    memset( layerId,            0, sizeof(layerId));

    memset( independentLayer,   0, sizeof(independentLayer));

    memset( directRefLayer,     0, sizeof(directRefLayer));

    memset( maxTidIlRefPicsPlus1, 7, sizeof(maxTidIlRefPicsPlus1));

    memset( olsOutputLayer,     0, sizeof(olsOutputLayer));

    memset( directRefLayerIdx,  0, sizeof(directRefLayerIdx));

    memset( generalLayerIdx,    0, sizeof(generalLayerIdx));

    memset( ptPresent,          0, sizeof(ptPresent));

    memset( ptlMaxTemporalId,   0, sizeof(ptlMaxTemporalId));

    memset( olsPtlIdx,          0, sizeof(olsPtlIdx));

    memset( interLayerRefIdx,   0, sizeof(interLayerRefIdx));

  }

  void deriveOutputLayerSets();

  int               getMaxDecPicBuffering( int temporalId ) const        { return dpbParameters[olsDpbParamsIdx[targetOlsIdx]].maxDecPicBuffering[temporalId]; }

  int               getNumReorderPics( int temporalId ) const            { return dpbParameters[olsDpbParamsIdx[targetOlsIdx]].numReorderPics[temporalId]; }

};

struct Window

{

  bool enabledFlag;

  int  winLeftOffset;

  int  winRightOffset;

  int  winTopOffset;

  int  winBottomOffset;

  Window()

  : enabledFlag    (false)

  , winLeftOffset  (0)

  , winRightOffset (0)

  , winTopOffset   (0)

  , winBottomOffset(0)

  { }

  void setWindow(int offsetLeft, int offsetLRight, int offsetLTop, int offsetLBottom)

  {

    enabledFlag     = offsetLeft || offsetLRight || offsetLTop || offsetLBottom;

    winLeftOffset   = offsetLeft;

    winRightOffset  = offsetLRight;

    winTopOffset    = offsetLTop;

    winBottomOffset = offsetLBottom;

  }

  bool operator!=( const Window& other ) const

  {

    return (winLeftOffset   != other.winLeftOffset

         || winRightOffset  != other.winRightOffset

         || winTopOffset    != other.winTopOffset

         || winBottomOffset != other.winBottomOffset);

  }

};

struct VUI

{

  bool       progressiveSourceFlag;

  bool       interlacedSourceFlag;

  bool       nonPackedFlag;

  bool       nonProjectedFlag;

  bool       aspectRatioInfoPresent;

  bool       aspectRatioConstantFlag;

  uint32_t   aspectRatioIdc;

  uint32_t   sarWidth;

  uint32_t   sarHeight;

  bool       overscanInfoPresent;

  bool       overscanAppropriateFlag;

  bool       colourDescriptionPresent;

  uint32_t   colourPrimaries;

  uint32_t   transferCharacteristics;

  uint32_t   matrixCoefficients;

  bool       videoFullRangeFlag;

  bool       chromaLocInfoPresent;

  uint32_t   chromaSampleLocTypeTopField;

  uint32_t   chromaSampleLocTypeBottomField;

  uint32_t   chromaSampleLocType;

  VUI()

    : progressiveSourceFlag         (true)

    , interlacedSourceFlag          (false)

    , nonPackedFlag                 (true)

    , nonProjectedFlag              (true)

    , aspectRatioInfoPresent        (false) //TODO: This initialiser list contains magic numbers

    , aspectRatioConstantFlag       (false)

    , aspectRatioIdc                    (0)

    , sarWidth                          (0)

    , sarHeight                         (0)

    , overscanInfoPresent           (false)

    , overscanAppropriateFlag       (false)

    , colourDescriptionPresent      (false)

    , colourPrimaries                   (2)

    , transferCharacteristics           (2)

    , matrixCoefficients                (2)

    , videoFullRangeFlag            (false)

    , chromaLocInfoPresent          (false)

    , chromaSampleLocTypeTopField       (0)

    , chromaSampleLocTypeBottomField    (0)

    , chromaSampleLocType               (0)

  {}

};

/// SPS class

struct SPS

{

  int               spsId;

  int               dciId;

  int               vpsId;

  int               layerId;

  bool              AffineAmvr;

  bool              DMVR;

  bool              MMVD;

  bool              SBT;

  bool              ISP;

  ChromaFormat      chromaFormatIdc;

  bool              separateColourPlane;     //!< separate colour plane

  uint32_t          maxTLayers;           // maximum number of temporal layers

  bool              ptlDpbHrdParamsPresent;

  bool              subLayerDpbParams;

  // Structure

  uint32_t          maxPicWidthInLumaSamples;

  uint32_t          maxPicHeightInLumaSamples;

  Window            conformanceWindow;

  bool              subPicInfoPresent;

  uint8_t           numSubPics;                        //!< number of sub-pictures used

  bool              independentSubPicsFlag;

  uint32_t          subPicCtuTopLeftX[MAX_NUM_SUB_PICS];

  uint32_t          subPicCtuTopLeftY[MAX_NUM_SUB_PICS];

  uint32_t          subPicWidth[MAX_NUM_SUB_PICS];

  uint32_t          subPicHeight[MAX_NUM_SUB_PICS];

  bool              subPicTreatedAsPic[MAX_NUM_SUB_PICS];

  bool              loopFilterAcrossSubpicEnabled[MAX_NUM_SUB_PICS];

  bool              subPicIdMappingExplicitlySignalled;

  uint32_t          subPicIdLen;                       //!< sub-picture ID length in bits

  uint8_t           subPicId[MAX_NUM_SUB_PICS];        //!< sub-picture ID for each sub-picture in the sequence

  int               log2MinCodingBlockSize;

  unsigned          CTUSize;

  unsigned          partitionOverrideEnabled;       // enable partition constraints override function

  unsigned          minQTSize[3];   // 0: I slice luma; 1: P/B slice; 2: I slice chroma

  unsigned          maxMTTDepth[3];

  unsigned          maxBTSize[3];

  unsigned          maxTTSize[3];

  bool              idrRefParamList;

  unsigned          dualITree;

  RPLList           rplList[NUM_REF_PIC_LIST_01];

  bool              rpl1CopyFromRpl0;

  bool              rpl1IdxPresent;

  bool              allRplEntriesHasSameSign;

  bool              longTermRefsPresent;

  bool              temporalMVPEnabled;

  int               numReorderPics[VVENC_MAX_TLAYER];

  // Tool list

  bool              transformSkip;

  int               log2MaxTransformSkipBlockSize;

  bool              BDPCM;

  bool              jointCbCr;

  // Parameter

  BitDepths         bitDepths;

  bool              entropyCodingSyncEnabled;

  bool              entryPointsPresent;

  int               qpBDOffset[MAX_NUM_CH];

  int               internalMinusInputBitDepth[MAX_NUM_CH]; //  max(0, internal bitdepth - input bitdepth);

  bool              SbtMvp;

  bool              BDOF;

  bool              fpelMmvd;

  bool              BdofPresent;

  bool              DmvrPresent;

  bool              ProfPresent;

  uint32_t          bitsForPOC;

  bool              pocMsbFlag;

  uint32_t          pocMsbLen;

  int               numExtraPHBitsBytes;

  int               numExtraSHBitsBytes;

  std::vector<bool> extraPHBitPresent;

  std::vector<bool> extraSHBitPresent;

  uint32_t          numLongTermRefPicSPS;

  uint32_t          ltRefPicPocLsbSps[MAX_NUM_LONG_TERM_REF_PICS];

  bool              usedByCurrPicLtSPS[MAX_NUM_LONG_TERM_REF_PICS];

  uint32_t          log2MaxTbSize;

  bool              weightPred;                     //!< Use of Weighting Prediction (P_SLICE)

  bool              weightedBiPred;                 //!< Use of Weighting Bi-Prediction (B_SLICE)

  bool              saoEnabled;

  bool              temporalIdNesting; // temporal_id_nesting_flag

  bool              scalingListEnabled;

  bool              depQuantEnabled;            //!< dependent quantization enabled flag

  bool              signDataHidingEnabled;      //!< sign data hiding enabled flag

  bool              virtualBoundariesEnabled;   //!< Enable virtual boundaries tool

  bool              virtualBoundariesPresent    ;   //!< disable loop filtering across virtual boundaries

  unsigned          numVerVirtualBoundaries;                         //!< number of vertical virtual boundaries

  unsigned          numHorVirtualBoundaries;                         //!< number of horizontal virtual boundaries

  unsigned          virtualBoundariesPosX[3];                        //!< horizontal position of each vertical virtual boundary

  unsigned          virtualBoundariesPosY[3];                        //!< vertical position of each horizontal virtual boundary

  uint32_t          maxDecPicBuffering[VVENC_MAX_TLAYER];

  uint32_t          maxLatencyIncreasePlus1[VVENC_MAX_TLAYER];

  bool              hrdParametersPresent;

  bool              subLayerParametersPresent;

  GeneralHrdParams  generalHrdParams;

  OlsHrdParams      olsHrdParams[VVENC_MAX_TLAYER];

  bool              fieldSeqFlag;

  bool              vuiParametersPresent;

  unsigned          vuiPayloadSize;

  VUI               vuiParameters;

//  TimingInfo        timingInfo;

  ProfileTierLevel  profileTierLevel;

  bool              alfEnabled;

  bool              ccalfEnabled;

  bool              wrapAroundEnabled;

  bool              IBC;

  bool              useColorTrans;

  bool              PLT;

  bool              lumaReshapeEnable;

  bool              AMVR;

  bool              LMChroma;

  bool              horCollocatedChroma;

  bool              verCollocatedChroma;

  bool              MTS;

  bool              MTSIntra;                   // 18

  bool              MTSInter;                   // 19

  bool              LFNST;

  bool              SMVD;

  bool              Affine;

  bool              AffineType;

  bool              PROF;

  bool              BCW;

  bool              CIIP;

  bool              GEO;

  bool              LADF;

  bool              MRL;

  bool              MIP;

  ChromaQpMappingTable chromaQpMappingTable;

  bool              GDR;

  bool              subLayerCbpParametersPresent;

  bool              rprEnabled;

  bool              resChangeInClvsEnabled;

  bool              interLayerPresent;

  uint32_t          log2ParallelMergeLevelMinus2; // th fix this

  uint32_t          maxNumMergeCand;

  uint32_t          maxNumAffineMergeCand;

  uint32_t          maxNumIBCMergeCand;

  uint32_t          maxNumGeoCand;

  bool              scalingMatrixAlternativeColourSpaceDisabled;

  bool              scalingMatrixDesignatedColourSpace;

  bool              disableScalingMatrixForLfnstBlks;

  SPS();

  int               getNumRPL( int idx)                                                 const { return (int)rplList[idx].size()-1;}

  int               getMaxLog2TrDynamicRange()                                          const { return 15; }

  uint32_t          getMaxTbSize()                                                      const { return  1 << log2MaxTbSize;                                        }

  bool              getUseImplicitMTS     ()                                            const { return MTS && !MTSIntra; }

  static int        getWinUnitX (int chromaFormatIdc)

  {

    CHECK(chromaFormatIdc < 0 || chromaFormatIdc >= NUM_CHROMA_FORMAT, "Invalid chroma format parameter");

    return (chromaFormatIdc == 1 || chromaFormatIdc == 2) ? 2 : 1;

  }

  static int        getWinUnitY (int chromaFormatIdc)

  {

    CHECK(chromaFormatIdc < 0 || chromaFormatIdc >= NUM_CHROMA_FORMAT, "Invalid chroma format parameter");

    return (chromaFormatIdc == 1) ? 2 : 1;

  }

private:

  static const int  m_winUnitX[NUM_CHROMA_FORMAT];

  static const int  m_winUnitY[NUM_CHROMA_FORMAT];

};

/// Reference Picture Lists class

/// PPS class

struct PPS

{

  int              ppsId;                    // pic_parameter_set_id

  int              spsId;                    // seq_parameter_set_id

  int              picInitQPMinus26;

  bool             useDQP;

  bool             usePPSChromaTool;

  bool             sliceChromaQpFlag;       // slicelevel_chroma_qp_flag

  int              layerId;

  int              temporalId;

  // access channel

  int              chromaQpOffset[MAX_NUM_COMP+1]; //also includes JointCbCr

  bool             jointCbCrQpOffsetPresent;

  ChromaQpAdj      chromaQpAdjTableIncludingNullEntry[1+MAX_QP_OFFSET_LIST_SIZE]; //!< Array includes entry [0] for the null offset used when cu_chroma_qp_offset_flag=0, and entries [cu_chroma_qp_offset_idx+1...] otherwise

  // Chroma QP Adjustments

  int              chromaQpOffsetListLen; // size (excludes the null entry used in the following array).

  ChromaQpAdj      ChromaQpAdjTableIncludingNullEntry[1+MAX_QP_OFFSET_LIST_SIZE]; //!< Array includes entry [0] for the null offset used when cu_chroma_qp_offset_flag=0, and entries [cu_chroma_qp_offset_idx+1...] otherwise

  uint32_t         numRefIdxL0DefaultActive;

  uint32_t         numRefIdxL1DefaultActive;

  bool             rpl1IdxPresent;

  bool             weightPred;                    //!< Use of Weighting Prediction (P_SLICE)

  bool             weightedBiPred;                 //!< Use of Weighting Bi-Prediction (B_SLICE)

  bool             outputFlagPresent;             //!< Indicates the presence of output_flag in slice header

  uint8_t          numSubPics;                        //!< number of sub-p

  bool             subPicIdMappingInPps;

  uint32_t         subPicIdLen;                       //!< sub-picture ID length in bits

  uint8_t          subPicId[MAX_NUM_SUB_PICS];        //!< sub-picture ID for each sub-picture in the sequence

  bool             noPicPartition;                //!< no picture partitioning flag - single slice, single tile

  uint8_t          log2CtuSize;                       //!< log2 of the CTU size - required to match corresponding value in SPS

  uint8_t          ctuSize;                           //!< CTU size

  uint32_t         picWidthInCtu;                     //!< picture width in units of CTUs

  uint32_t         picHeightInCtu;                    //!< picture height in units of CTUs

  uint32_t         numExpTileCols;                    //!< number of explicitly specified tile columns

  uint32_t         numExpTileRows;                    //!< number of explicitly specified tile rows

  uint32_t         numTileCols;                       //!< number of tile columns

  uint32_t         numTileRows;                       //!< number of tile rows

  std::vector<uint32_t>  tileColWidth;                 //!< tile column widths in units of CTUs

  std::vector<uint32_t>  tileRowHeight;                //!< tile row heights in units of CTUs

  std::vector<uint32_t>  tileColBd;                    //!< tile column left-boundaries in units of CTUs

  std::vector<uint32_t>  tileRowBd;                    //!< tile row top-boundaries in units of CTUs

  std::vector<uint32_t>  tileColBdRgt;                 //!< tile column right-boundaries in luma samples

  std::vector<uint32_t>  tileRowBdBot;                 //!< tile row bottom-boundaries in luma samples

  std::vector<uint32_t>  ctuToTileCol;                 //!< mapping between CTU horizontal address and tile column index

  std::vector<uint32_t>  ctuToTileRow;                 //!< mapping between CTU vertical address and tile row index

  bool                   rectSlice;                    //!< rectangular slice flag

  bool                   singleSlicePerSubPic;         //!< single slice per sub-picture flag

  std::vector<uint32_t>  ctuToSubPicIdx;               //!< mapping between CTU and Sub-picture index

  uint32_t               numSlicesInPic;               //!< number of rectangular slices in the picture (raster-scan slice specified at slice level)

  bool                   tileIdxDeltaPresent;          //!< tile index delta present flag

  std::vector<SliceMap>  sliceMap;                     //!< list of CTU maps for each slice in the picture

  std::vector<SubPic>    subPics;                      //!< list of subpictures in the picture

  bool             loopFilterAcrossTilesEnabled;        //!< loop filtering applied across tiles flag

  bool             loopFilterAcrossSlicesEnabled;       //!< loop filtering applied across slices flag

  bool             cabacInitPresent;

  bool             pictureHeaderExtensionPresent;   //< picture header extension flags present in picture headers or not

  bool             sliceHeaderExtensionPresent;

  bool             deblockingFilterControlPresent;

  bool             deblockingFilterOverrideEnabled;

  bool             deblockingFilterDisabled;

  int              deblockingFilterBetaOffsetDiv2[MAX_NUM_COMP];    //< beta offset for deblocking filter

  int              deblockingFilterTcOffsetDiv2[MAX_NUM_COMP];      //< tc offset for deblocking filter

  bool             listsModificationPresent;

  bool             rplInfoInPh;

  bool             dbfInfoInPh;

  bool             saoInfoInPh;

  bool             alfInfoInPh;

  bool             wpInfoInPh;

  bool             qpDeltaInfoInPh;

  bool             mixedNaluTypesInPic;

  uint32_t         picWidthInLumaSamples;

  uint32_t         picHeightInLumaSamples;

  Window           conformanceWindow;

  Window           scalingWindow;

  bool             wrapAroundEnabled;               //< reference wrap around enabled or not

  unsigned         picWidthMinusWrapAroundOffset;          // <pic_width_in_minCbSizeY - wraparound_offset_in_minCbSizeY

  unsigned         wrapAroundOffset;                    //< reference wrap around offset in luma samples

  PreCalcValues   *pcv;

public:

                  PPS();

  virtual         ~PPS();

  uint32_t        getSubPicIdxFromSubPicId( uint32_t subPicId ) const;

  const ChromaQpAdj&     getChromaQpOffsetListEntry( int cuChromaQpOffsetIdxPlus1 ) const

  {

    CHECK(cuChromaQpOffsetIdxPlus1 >= chromaQpOffsetListLen+1, "Invalid chroma QP offset");

    return chromaQpAdjTableIncludingNullEntry[cuChromaQpOffsetIdxPlus1]; // Array includes entry [0] for the null offset used when cu_chroma_qp_offset_flag=0, and entries [cu_chroma_qp_offset_idx+1...] otherwise

  }

  void                   setChromaQpOffsetListEntry( int cuChromaQpOffsetIdxPlus1, int cbOffset, int crOffset, int jointCbCrOffset )

  {

    CHECK(cuChromaQpOffsetIdxPlus1 == 0 || cuChromaQpOffsetIdxPlus1 > MAX_QP_OFFSET_LIST_SIZE, "Invalid chroma QP offset");

    chromaQpAdjTableIncludingNullEntry[cuChromaQpOffsetIdxPlus1].u.comp.CbOffset = cbOffset; // Array includes entry [0] for the null offset used when cu_chroma_qp_offset_flag=0, and entries [cu_chroma_qp_offset_idx+1...] otherwise

    chromaQpAdjTableIncludingNullEntry[cuChromaQpOffsetIdxPlus1].u.comp.CrOffset = crOffset;

    chromaQpAdjTableIncludingNullEntry[cuChromaQpOffsetIdxPlus1].u.comp.JointCbCrOffset = jointCbCrOffset;

    chromaQpOffsetListLen = std::max(chromaQpOffsetListLen, cuChromaQpOffsetIdxPlus1);

  }

  bool               isRefScaled( const PPS& pps ) const                             { return  picWidthInLumaSamples  != pps.picWidthInLumaSamples        ||

                                                                                               picHeightInLumaSamples != pps.picHeightInLumaSamples       ||

                                                                                               scalingWindow          != pps.scalingWindow; }

  uint32_t               getNumTiles() const                                         { return numTileCols * numTileRows; }

  uint32_t               getTileIdx( uint32_t ctuX, uint32_t ctuY ) const            { return (ctuToTileRow[ctuY] * numTileCols) + ctuToTileCol[ctuX]; }

  uint32_t               getTileIdx( uint32_t ctuRsAddr ) const                      { return getTileIdx( ctuRsAddr % picWidthInCtu,  ctuRsAddr / picWidthInCtu ); }

  uint32_t               getTileIdx( const Position& pos ) const                     { return getTileIdx( pos.x >> log2CtuSize, pos.y >> log2CtuSize ); }

  uint32_t               getTileHeight( const int tileIdx ) const                    { return tileRowHeight[tileIdx / numTileCols]; }

  uint32_t               getTileWidth( const int tileIdx ) const                     { return tileColWidth[tileIdx % numTileCols]; }

  uint32_t               getNumTileLineIds() const // number of lines in all the tiles (each tile consisting of indepdent rows

  {

    int countTileRows = 0;

    for( int tileIdx = 0; tileIdx < getNumTiles(); tileIdx++ ) countTileRows += getTileHeight( tileIdx );

    return countTileRows;

  }

  uint32_t               getTileLineId( uint32_t ctuX, uint32_t ctuY ) const // unique id for a tile line at the given position

  {

    if( numTileCols == 1 ) return ctuY;

    const int currTileIdx = getTileIdx( ctuX, ctuY );

    int tileRowResIdx = 0;

    for( int tileIdx = 0; tileIdx < currTileIdx; tileIdx++ ) tileRowResIdx += getTileHeight( tileIdx );

    const int tileRowResIdxRest = ctuY - tileRowBd[ctuToTileRow[ctuY]];

    return tileRowResIdx + tileRowResIdxRest;

  }

  bool                   canFilterCtuBdry( int ctuX, int ctuY, int offX, int offY ) const { return loopFilterAcrossTilesEnabled || getTileIdx( ctuX, ctuY ) == getTileIdx( ctuX + offX, ctuY + offY ); }

  const SubPic&          getSubPicFromPos(const Position& pos)  const;

  const SubPic&          getSubPicFromCU (const CodingUnit& cu) const;

  void initTiles();

  void initRectSliceMap( const SPS* sps );

  void checkSliceMap();

};

struct APS

{

  uint32_t               apsId;                    // adaptation_parameter_set_id

  int                    temporalId;

  int                    layerId;

  uint32_t               apsType;                  // aps_params_type

  AlfParam               alfParam;

  LmcsParam              lmcsParam;

  CcAlfFilterParam       ccAlfParam;

  bool                   hasPrefixNalUnitType;

  bool                   chromaPresent;

  int                    poc;

  APS() : apsId(MAX_UINT), temporalId( 0 ), layerId( 0 ), apsType(0), hasPrefixNalUnitType(false), chromaPresent( false ), poc(-1)

  { }

};

struct WPScalingParam

{

  // Explicit weighted prediction parameters parsed in slice header,

  // or Implicit weighted prediction parameters (8 bits depth values).

  bool      presentFlag;

  uint32_t  log2WeightDenom;

  int       iWeight;

  int       iOffset;

  // Weighted prediction scaling values built from above parameters (bitdepth scaled):

  int       w;

  int       o;

  int       offset;

  int       shift;

  int       round;

};

struct WPACDCParam

{

  int64_t iAC;

  int64_t iDC;

};

 // picture header class

struct PicHeader

{

  Picture*                    pic;                                                    //!< pointer to picture structure

  int                         pocLsb;                                                 //!< least significant bits of picture order count

  bool                        nonRefPic;                                              //!< non-reference picture flag

  bool                        gdrOrIrapPic;                                           //!< gdr or irap picture flag

  bool                        gdrPic;                                                 //!< gradual decoding refresh picture flag

  bool                        noOutputOfPriorPics;                                    //!< no output of prior pictures flag

  uint32_t                    recoveryPocCnt;                                         //!< recovery POC count

  bool                        noOutputBeforeRecovery;                             //!< NoOutputBeforeRecoveryFlag

  bool                        handleCraAsCvsStart;                                //!< HandleCraAsCvsStartFlag

  bool                        handleGdrAsCvsStart;                                //!< HandleGdrAsCvsStartFlag

  int                         spsId;                                                  //!< sequence parameter set ID

  int                         ppsId;                                                  //!< picture parameter set ID

  bool                        pocMsbPresent;                                          //!< ph_poc_msb_present_flag

  int                         pocMsbVal;                                              //!< poc_msb_val

  bool                        virtualBoundariesEnabled;              //!< loop filtering across virtual boundaries disabled

  bool                        virtualBoundariesPresent;              //!< loop filtering across virtual boundaries disabled

  unsigned                    numVerVirtualBoundaries;                                //!< number of vertical virtual boundaries

  unsigned                    numHorVirtualBoundaries;                                //!< number of horizontal virtual boundaries

  unsigned                    virtualBoundariesPosX[3];                               //!< horizontal virtual boundary positions

  unsigned                    virtualBoundariesPosY[3];                               //!< vertical virtual boundary positions

  bool                        picOutputFlag;                                          //!< picture output flag

  const ReferencePictureList* pRPL[NUM_REF_PIC_LIST_01];                              //!< pointer to RPL for L0, either in the SPS or the local RPS in the picture header

  ReferencePictureList        localRPL[NUM_REF_PIC_LIST_01];                          //!< RPL for L0 when present in picture header

  int                         rplIdx[NUM_REF_PIC_LIST_01];                            //!< index of used RPL in the SPS or -1 for local RPL in the picture header

  bool                        picInterSliceAllowed;                                   //!< inter slice allowed flag in PH

  bool                        picIntraSliceAllowed;                                   //!< intra slice allowed flag in PH

  bool                        splitConsOverride;                                      //!< partitioning constraint override flag

  uint32_t                    cuQpDeltaSubdivIntra;                                   //!< CU QP delta maximum subdivision for intra slices