TAppEncCfg.h

Go to the documentation of this file.

/* 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-2017, 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.
 */

#ifndef __TAPPENCCFG__
#define __TAPPENCCFG__

#include "TLibCommon/CommonDef.h"

#include "TLibEncoder/TEncCfg.h"
#if EXTENSION_360_VIDEO
#include "TAppEncHelper360/TExt360AppEncCfg.h"
#endif
#include <sstream>
#include <vector>

// ====================================================================================================================
// Class definition
// ====================================================================================================================

class TAppEncCfg
{
#if JVET_E0059_FLOATING_POINT_QP_FIX
public:
  template <class T>
  struct OptionalValue
  {
    Bool bPresent;
    T    value;
    OptionalValue() : bPresent(false), value() { }
  };
#endif

protected:
  // file I/O
  std::string m_inputFileName;                                
  std::string m_bitstreamFileName;                            
  std::string m_reconFileName;                                

  // Lambda modifiers
  Double    m_adLambdaModifier[ MAX_TLAYER ];                 
  std::vector<Double> m_adIntraLambdaModifier;                
  Double    m_dIntraQpFactor;                                 

  // source specification
  Int       m_iFrameRate;                                     
  UInt      m_FrameSkip;                                      
  UInt      m_temporalSubsampleRatio;                         
  Int       m_iSourceWidth;                                   
  Int       m_iSourceHeight;                                  
  Int       m_inputFileWidth;                                 
  Int       m_inputFileHeight;                                

  Int       m_iSourceHeightOrg;                               

  Bool      m_isField;                                        
  Bool      m_isTopFieldFirst;
  Bool      m_bEfficientFieldIRAPEnabled;                     
  Bool      m_bHarmonizeGopFirstFieldCoupleEnabled;

  Int       m_conformanceWindowMode;
  Int       m_confWinLeft;
  Int       m_confWinRight;
  Int       m_confWinTop;
  Int       m_confWinBottom;
  Int       m_framesToBeEncoded;                              
  Int       m_aiPad[2];                                       
  Bool      m_AccessUnitDelimiter;                            
  InputColourSpaceConversion m_inputColourSpaceConvert;       
  Bool      m_snrInternalColourSpace;                       
  Bool      m_outputInternalColourSpace;                    
  ChromaFormat m_InputChromaFormatIDC;

  Bool      m_printMSEBasedSequencePSNR;
  Bool      m_printFrameMSE;
  Bool      m_printSequenceMSE;
#if JVET_F0064_MSSSIM
  Bool      m_printMSSSIM;
#endif
  Bool      m_cabacZeroWordPaddingEnabled;
  Bool      m_bClipInputVideoToRec709Range;
  Bool      m_bClipOutputVideoToRec709Range;

  // profile/level
  Profile::Name m_profile;
  Level::Tier   m_levelTier;
  Level::Name   m_level;
  UInt          m_bitDepthConstraint;
  ChromaFormat  m_chromaFormatConstraint;
  Bool          m_intraConstraintFlag;
  Bool          m_onePictureOnlyConstraintFlag;
  Bool          m_lowerBitRateConstraintFlag;
  Bool m_progressiveSourceFlag;
  Bool m_interlacedSourceFlag;
  Bool m_nonPackedConstraintFlag;
  Bool m_frameOnlyConstraintFlag;

  // coding structure
  Int       m_iIntraPeriod;                                   
  Int       m_iDecodingRefreshType;                           
  Int       m_iGOPSize;                                       
#if JCTVC_Y0038_PARAMS
  Bool      m_bReWriteParamSetsFlag;                          
#endif  
  Int       m_extraRPSs;                                      
  GOPEntry  m_GOPList[MAX_GOP];                               
  Int       m_numReorderPics[MAX_TLAYER];                     
  Int       m_maxDecPicBuffering[MAX_TLAYER];                 
  Bool      m_crossComponentPredictionEnabledFlag;            
  Bool      m_reconBasedCrossCPredictionEstimate;             
  UInt      m_log2SaoOffsetScale[MAX_NUM_CHANNEL_TYPE];       
  Bool      m_useTransformSkip;                               
  Bool      m_useTransformSkipFast;                           
  UInt      m_log2MaxTransformSkipBlockSize;                  
  Bool      m_transformSkipRotationEnabledFlag;               
  Bool      m_transformSkipContextEnabledFlag;                
  Bool      m_rdpcmEnabledFlag[NUMBER_OF_RDPCM_SIGNALLING_MODES];
  Bool      m_enableAMP;
  Bool      m_persistentRiceAdaptationEnabledFlag;            
  Bool      m_cabacBypassAlignmentEnabledFlag;

  // coding quality
#if JVET_E0059_FLOATING_POINT_QP_FIX
  OptionalValue<UInt> m_qpIncrementAtSourceFrame;             
#else
  Double    m_fQP;                                            
#endif
  Int       m_iQP;                                            
#if X0038_LAMBDA_FROM_QP_CAPABILITY
  Int       m_intraQPOffset;                                  
  Bool      m_lambdaFromQPEnable;                             
#endif
  std::string m_dQPFileName;                                  
  Int*      m_aidQP;                                          
  Int       m_iMaxDeltaQP;                                    
  UInt      m_uiDeltaQpRD;                                    
  Int       m_iMaxCuDQPDepth;                                 
  Int       m_diffCuChromaQpOffsetDepth;                      
  Bool      m_bFastDeltaQP;                                   

  Int       m_cbQpOffset;                                     
  Int       m_crQpOffset;                                     
  WCGChromaQPControl m_wcgChromaQpControl;                    
  UInt      m_sliceChromaQpOffsetPeriodicity;                 
  Int       m_sliceChromaQpOffsetIntraOrPeriodic[2/*Cb,Cr*/]; 
  LumaLevelToDeltaQPMapping m_lumaLevelToDeltaQPMapping;      
#if ADAPTIVE_QP_SELECTION
  Bool      m_bUseAdaptQpSelect;
#endif
  TComSEIMasteringDisplay m_masteringDisplay;

  Bool      m_bUseAdaptiveQP;                                 
  Int       m_iQPAdaptationRange;                             

  Int       m_maxTempLayer;                                  

  // coding unit (CU) definition
  // TODO: Remove MaxCUWidth/MaxCUHeight and replace with MaxCUSize.
  UInt      m_uiMaxCUWidth;                                   
  UInt      m_uiMaxCUHeight;                                  
  UInt      m_uiMaxCUDepth;                                   
  UInt      m_uiMaxTotalCUDepth;                              
  UInt      m_uiLog2DiffMaxMinCodingBlockSize;                

  // transfom unit (TU) definition
  UInt      m_uiQuadtreeTULog2MaxSize;
  UInt      m_uiQuadtreeTULog2MinSize;

  UInt      m_uiQuadtreeTUMaxDepthInter;
  UInt      m_uiQuadtreeTUMaxDepthIntra;

  // coding tools (bit-depth)
  Int       m_inputBitDepth   [MAX_NUM_CHANNEL_TYPE];         
  Int       m_outputBitDepth  [MAX_NUM_CHANNEL_TYPE];         
  Int       m_MSBExtendedBitDepth[MAX_NUM_CHANNEL_TYPE];      
  Int       m_internalBitDepth[MAX_NUM_CHANNEL_TYPE];         
  Bool      m_extendedPrecisionProcessingFlag;
  Bool      m_highPrecisionOffsetsEnabledFlag;

  //coding tools (chroma format)
  ChromaFormat m_chromaFormatIDC;

  // coding tools (PCM bit-depth)
  Bool      m_bPCMInputBitDepthFlag;                          

  // coding tool (SAO)
  Bool      m_bUseSAO;
  Bool      m_bTestSAODisableAtPictureLevel;
  Double    m_saoEncodingRate;                                
  Double    m_saoEncodingRateChroma;                          
  Int       m_maxNumOffsetsPerPic;                            
  Bool      m_saoCtuBoundary;                                 
  Bool      m_saoResetEncoderStateAfterIRAP;                  
  // coding tools (loop filter)
  Bool      m_bLoopFilterDisable;                             
  Bool      m_loopFilterOffsetInPPS;                          
  Int       m_loopFilterBetaOffsetDiv2;                       
  Int       m_loopFilterTcOffsetDiv2;                         
  Int       m_deblockingFilterMetric;                         
  // coding tools (PCM)
  Bool      m_usePCM;                                         
  UInt      m_pcmLog2MaxSize;                                 
  UInt      m_uiPCMLog2MinSize;                               
  Bool      m_bPCMFilterDisableFlag;                          
  Bool      m_enableIntraReferenceSmoothing;                  

  // coding tools (encoder-only parameters)
  Bool      m_bUseASR;                                        
  Bool      m_bUseHADME;                                      
  Bool      m_useRDOQ;                                        
  Bool      m_useRDOQTS;                                      
  Bool      m_useSelectiveRDOQ;                               
  Int       m_rdPenalty;                                      
  Bool      m_bDisableIntraPUsInInterSlices;                  
  MESearchMethod m_motionEstimationSearchMethod;
  Bool      m_bRestrictMESampling;                            
  Int       m_iSearchRange;                                   
  Int       m_bipredSearchRange;                              
  Int       m_minSearchWindow;                                
  Bool      m_bClipForBiPredMeEnabled;                        
  Bool      m_bFastMEAssumingSmootherMVEnabled;               
  FastInterSearchMode m_fastInterSearchMode;                  
  Bool      m_bUseEarlyCU;                                    
  Bool      m_useFastDecisionForMerge;                        
  Bool      m_bUseCbfFastMode;                                
  Bool      m_useEarlySkipDetection;                          
  SliceConstraint m_sliceMode;
  Int             m_sliceArgument;                            
  SliceConstraint m_sliceSegmentMode;
  Int             m_sliceSegmentArgument;                     

  Bool      m_bLFCrossSliceBoundaryFlag;  
  Bool      m_bLFCrossTileBoundaryFlag;   
  Bool      m_tileUniformSpacingFlag;
  Int       m_numTileColumnsMinus1;
  Int       m_numTileRowsMinus1;
  std::vector<Int> m_tileColumnWidth;
  std::vector<Int> m_tileRowHeight;
  Bool      m_entropyCodingSyncEnabledFlag;

  Bool      m_bUseConstrainedIntraPred;                       
  Bool      m_bFastUDIUseMPMEnabled;
  Bool      m_bFastMEForGenBLowDelayEnabled;
  Bool      m_bUseBLambdaForNonKeyLowDelayPictures;

  HashType  m_decodedPictureHashSEIType;                      
  Bool      m_recoveryPointSEIEnabled;
  Bool      m_bufferingPeriodSEIEnabled;
  Bool      m_pictureTimingSEIEnabled;
  Bool      m_toneMappingInfoSEIEnabled;
  Bool      m_chromaResamplingFilterSEIenabled;
  Int       m_chromaResamplingHorFilterIdc;
  Int       m_chromaResamplingVerFilterIdc;
  Int       m_toneMapId;
  Bool      m_toneMapCancelFlag;
  Bool      m_toneMapPersistenceFlag;
  Int       m_toneMapCodedDataBitDepth;
  Int       m_toneMapTargetBitDepth;
  Int       m_toneMapModelId;
  Int       m_toneMapMinValue;
  Int       m_toneMapMaxValue;
  Int       m_sigmoidMidpoint;
  Int       m_sigmoidWidth;
  Int       m_numPivots;
  Int       m_cameraIsoSpeedIdc;
  Int       m_cameraIsoSpeedValue;
  Int       m_exposureIndexIdc;
  Int       m_exposureIndexValue;
  Bool      m_exposureCompensationValueSignFlag;
  Int       m_exposureCompensationValueNumerator;
  Int       m_exposureCompensationValueDenomIdc;
  Int       m_refScreenLuminanceWhite;
  Int       m_extendedRangeWhiteLevel;
  Int       m_nominalBlackLevelLumaCodeValue;
  Int       m_nominalWhiteLevelLumaCodeValue;
  Int       m_extendedWhiteLevelLumaCodeValue;
  Int*      m_startOfCodedInterval;
  Int*      m_codedPivotValue;
  Int*      m_targetPivotValue;
  Bool      m_framePackingSEIEnabled;
  Int       m_framePackingSEIType;
  Int       m_framePackingSEIId;
  Int       m_framePackingSEIQuincunx;
  Int       m_framePackingSEIInterpretation;
  Bool      m_segmentedRectFramePackingSEIEnabled;
  Bool      m_segmentedRectFramePackingSEICancel;
  Int       m_segmentedRectFramePackingSEIType;
  Bool      m_segmentedRectFramePackingSEIPersistence;
  Int       m_displayOrientationSEIAngle;
  Bool      m_temporalLevel0IndexSEIEnabled;
  Bool      m_gradualDecodingRefreshInfoEnabled;
  Int       m_noDisplaySEITLayer;
  Bool      m_decodingUnitInfoSEIEnabled;
  Bool      m_SOPDescriptionSEIEnabled;
  Bool      m_scalableNestingSEIEnabled;
  Bool      m_tmctsSEIEnabled;
#if MCTS_ENC_CHECK
  Bool      m_tmctsSEITileConstraint;
#endif
  Bool      m_timeCodeSEIEnabled;
  Int       m_timeCodeSEINumTs;
  TComSEITimeSet m_timeSetArray[MAX_TIMECODE_SEI_SETS];
  Bool      m_kneeSEIEnabled;
  TEncCfg::TEncSEIKneeFunctionInformation m_kneeFunctionInformationSEI;
  Int       m_preferredTransferCharacteristics;
  UInt      m_greenMetadataType;
  UInt      m_xsdMetricType;
#if CCV_SEI_MESSAGE
  Bool    m_ccvSEIEnabled;
  Bool    m_ccvSEICancelFlag;
  Bool    m_ccvSEIPersistenceFlag;
  Bool    m_ccvSEIPrimariesPresentFlag;
  Bool    m_ccvSEIMinLuminanceValuePresentFlag;
  Bool    m_ccvSEIMaxLuminanceValuePresentFlag;
  Bool    m_ccvSEIAvgLuminanceValuePresentFlag;
  Double  m_ccvSEIPrimariesX[MAX_NUM_COMPONENT]; // Int(32)
  Double  m_ccvSEIPrimariesY[MAX_NUM_COMPONENT]; // Int(32)
  Double  m_ccvSEIMinLuminanceValue;             // UInt(32)
  Double  m_ccvSEIMaxLuminanceValue;             // UInt(32)
  Double  m_ccvSEIAvgLuminanceValue;             // UInt(32)
#endif
#if ERP_SR_OV_SEI_MESSAGE
  Bool      m_erpSEIEnabled;          
  Bool      m_erpSEICancelFlag;
  Bool      m_erpSEIPersistenceFlag;
  Bool      m_erpSEIGuardBandFlag;
  UInt      m_erpSEIGuardBandType;
  UInt      m_erpSEILeftGuardBandWidth;
  UInt      m_erpSEIRightGuardBandWidth;

  Bool      m_sphereRotationSEIEnabled;          
  Bool      m_sphereRotationSEICancelFlag;
  Bool      m_sphereRotationSEIPersistenceFlag;
  Int       m_sphereRotationSEIYaw;
  Int       m_sphereRotationSEIPitch;
  Int       m_sphereRotationSEIRoll;

  Bool      m_omniViewportSEIEnabled;          
  UInt      m_omniViewportSEIId;
  Bool      m_omniViewportSEICancelFlag;
  Bool      m_omniViewportSEIPersistenceFlag;
  UInt      m_omniViewportSEICntMinus1;
  std::vector<Int>  m_omniViewportSEIAzimuthCentre;
  std::vector<Int>  m_omniViewportSEIElevationCentre;
  std::vector<Int>  m_omniViewportSEITiltCentre;
  std::vector<UInt> m_omniViewportSEIHorRange;
  std::vector<UInt> m_omniViewportSEIVerRange;  
#endif
#if CMP_SEI_MESSAGE
  Bool                  m_cmpSEIEnabled;
  Bool                  m_cmpSEICmpCancelFlag;
  Bool                  m_cmpSEICmpPersistenceFlag;
#endif
#if RWP_SEI_MESSAGE
  Bool                  m_rwpSEIEnabled;
  Bool                  m_rwpSEIRwpCancelFlag;
  Bool                  m_rwpSEIRwpPersistenceFlag;
  Bool                  m_rwpSEIConstituentPictureMatchingFlag;
  Int                   m_rwpSEINumPackedRegions;
  Int                   m_rwpSEIProjPictureWidth;
  Int                   m_rwpSEIProjPictureHeight;
  Int                   m_rwpSEIPackedPictureWidth;
  Int                   m_rwpSEIPackedPictureHeight;
  std::vector<UChar>    m_rwpSEIRwpTransformType;
  std::vector<Bool>     m_rwpSEIRwpGuardBandFlag;
  std::vector<UInt>     m_rwpSEIProjRegionWidth;
  std::vector<UInt>     m_rwpSEIProjRegionHeight;
  std::vector<UInt>     m_rwpSEIRwpSEIProjRegionTop;
  std::vector<UInt>     m_rwpSEIProjRegionLeft;
  std::vector<UShort>   m_rwpSEIPackedRegionWidth;
  std::vector<UShort>   m_rwpSEIPackedRegionHeight;
  std::vector<UShort>   m_rwpSEIPackedRegionTop;
  std::vector<UShort>   m_rwpSEIPackedRegionLeft;
  std::vector<UChar>    m_rwpSEIRwpLeftGuardBandWidth;
  std::vector<UChar>    m_rwpSEIRwpRightGuardBandWidth;
  std::vector<UChar>    m_rwpSEIRwpTopGuardBandHeight;
  std::vector<UChar>    m_rwpSEIRwpBottomGuardBandHeight;
  std::vector<Bool>     m_rwpSEIRwpGuardBandNotUsedForPredFlag;
  std::vector<UChar>    m_rwpSEIRwpGuardBandType;
#endif     
#if RNSEI
  Bool                  m_rnSEIEnabled;
#endif
  // weighted prediction
  Bool      m_useWeightedPred;                    
  Bool      m_useWeightedBiPred;                  
  WeightedPredictionMethod m_weightedPredictionMethod;

  UInt      m_log2ParallelMergeLevel;                         
  UInt      m_maxNumMergeCand;                                

  Int       m_TMVPModeId;
  Bool      m_signDataHidingEnabledFlag;
  Bool      m_RCEnableRateControl;                
  Int       m_RCTargetBitrate;                    
  Int       m_RCKeepHierarchicalBit;              
  Bool      m_RCLCULevelRC;                       
  Bool      m_RCUseLCUSeparateModel;              
  Int       m_RCInitialQP;                        
  Bool      m_RCForceIntraQP;                     
  Bool      m_RCCpbSaturationEnabled;             
  UInt      m_RCCpbSize;                          
  Double    m_RCInitialCpbFullness;               
  ScalingListMode m_useScalingListId;                         
  std::string m_scalingListFileName;                          

  Bool      m_TransquantBypassEnabledFlag;                    
  Bool      m_CUTransquantBypassFlagForce;                    
  CostMode  m_costMode;                                       

  Bool      m_recalculateQPAccordingToLambda;                 
  Bool      m_useStrongIntraSmoothing;                        
  Int       m_activeParameterSetsSEIEnabled;

  Bool      m_vuiParametersPresentFlag;                       
  Bool      m_aspectRatioInfoPresentFlag;                     
  Int       m_aspectRatioIdc;                                 
  Int       m_sarWidth;                                       
  Int       m_sarHeight;                                      
  Bool      m_overscanInfoPresentFlag;                        
  Bool      m_overscanAppropriateFlag;                        
  Bool      m_videoSignalTypePresentFlag;                     
  Int       m_videoFormat;                                    
  Bool      m_videoFullRangeFlag;                             
  Bool      m_colourDescriptionPresentFlag;                   
  Int       m_colourPrimaries;                                
  Int       m_transferCharacteristics;                        
  Int       m_matrixCoefficients;                             
  Bool      m_chromaLocInfoPresentFlag;                       
  Int       m_chromaSampleLocTypeTopField;                    
  Int       m_chromaSampleLocTypeBottomField;                 
  Bool      m_neutralChromaIndicationFlag;                    
  Bool      m_defaultDisplayWindowFlag;                       
  Int       m_defDispWinLeftOffset;                           
  Int       m_defDispWinRightOffset;                          
  Int       m_defDispWinTopOffset;                            
  Int       m_defDispWinBottomOffset;                         
  Bool      m_frameFieldInfoPresentFlag;                      
  Bool      m_pocProportionalToTimingFlag;                    
  Int       m_numTicksPocDiffOneMinus1;                       
  Bool      m_bitstreamRestrictionFlag;                       
  Bool      m_tilesFixedStructureFlag;                        
  Bool      m_motionVectorsOverPicBoundariesFlag;             
  Int       m_minSpatialSegmentationIdc;                      
  Int       m_maxBytesPerPicDenom;                            
  Int       m_maxBitsPerMinCuDenom;                           
  Int       m_log2MaxMvLengthHorizontal;                      
  Int       m_log2MaxMvLengthVertical;                        
  std::string m_colourRemapSEIFileRoot;
#if RNSEI
  std::string m_regionalNestingSEIFileRoot;
#endif

  std::string m_summaryOutFilename;                           
  std::string m_summaryPicFilenameBase;                       
  UInt        m_summaryVerboseness;                           

#if EXTENSION_360_VIDEO
  TExt360AppEncCfg m_ext360;
  friend class TExt360AppEncCfg;
  friend class TExt360AppEncTop;
#endif

  // internal member functions
  Void  xCheckParameter ();                                   
  Void  xPrintParameter ();                                   
  Void  xPrintUsage     ();                                   
public:
  TAppEncCfg();
  virtual ~TAppEncCfg();

public:
  Void  create    ();                                         
  Void  destroy   ();                                         
  Bool  parseCfg  ( Int argc, TChar* argv[] );                

};// END CLASS DEFINITION TAppEncCfg


#endif // __TAPPENCCFG__