source: 3DVCSoftware/branches/HTM-5.0-Qualcomm-Fix/source/App/TAppEncoder/TAppEncCfg.h @ 204

Last change on this file since 204 was 202, checked in by tech, 12 years ago

Minor cleanup of additional newlines.

  • Property svn:eol-style set to native
File size: 20.4 KB
Line 
1/* The copyright in this software is being made available under the BSD
2 * License, included below. This software may be subject to other third party
3 * and contributor rights, including patent rights, and no such rights are
4 * granted under this license. 
5 *
6 * Copyright (c) 2010-2012, ITU/ISO/IEC
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 *  * Redistributions of source code must retain the above copyright notice,
13 *    this list of conditions and the following disclaimer.
14 *  * Redistributions in binary form must reproduce the above copyright notice,
15 *    this list of conditions and the following disclaimer in the documentation
16 *    and/or other materials provided with the distribution.
17 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
18 *    be used to endorse or promote products derived from this software without
19 *    specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31 * THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34/** \file     TAppEncCfg.h
35    \brief    Handle encoder configuration parameters (header)
36*/
37
38#ifndef __TAPPENCCFG__
39#define __TAPPENCCFG__
40
41#include "TLibCommon/CommonDef.h"
42
43#include "TLibEncoder/TEncCfg.h"
44#include "TAppCommon/TAppComCamPara.h"
45#include "TLibRenderer/TRenTop.h"
46#include "TLibRenderer/TRenModel.h"
47#include "TLibRenderer/TRenModSetupStrParser.h"
48
49#include <sstream>
50#include <vector>
51
52//! \ingroup TAppEncoder
53//! \{
54
55// ====================================================================================================================
56// Class definition
57// ====================================================================================================================
58
59/// encoder configuration class
60class TAppEncCfg
61{
62protected:
63  // file I/O
64  std::vector<char*>     m_pchInputFileList;                  ///< source file names
65  std::vector<char*>     m_pchDepthInputFileList;             ///< source depth file names
66  std::vector<char*>     m_pchReconFileList;                  ///< output reconstruction file names
67  std::vector<char*>     m_pchDepthReconFileList;             ///< output depth reconstruction file names
68  char*     m_pchBitstreamFile;                               ///< output bitstream file
69  Double    m_adLambdaModifier[ MAX_TLAYER ];                 ///< Lambda modifier array for each temporal layer
70  // source specification
71  Int       m_iFrameRate;                                     ///< source frame-rates (Hz)
72  unsigned int m_FrameSkip;                                   ///< number of skipped frames from the beginning
73  Int       m_iSourceWidth;                                   ///< source width in pixel
74  Int       m_iSourceHeight;                                  ///< source height in pixel
75#if PIC_CROPPING
76  Int       m_croppingMode;
77  Int       m_cropLeft;
78  Int       m_cropRight;
79  Int       m_cropTop;
80  Int       m_cropBottom;
81#endif
82  Int       m_iFrameToBeEncoded;                              ///< number of encoded frames
83#if !PIC_CROPPING
84  Bool      m_bUsePAD;                                        ///< flag for using source padding
85#endif
86  Int       m_aiPad[2];                                       ///< number of padded pixels for width and height
87 
88  Int       m_iNumberOfViews;                                 ///< number Views to Encode
89  Bool      m_bUsingDepthMaps;
90 
91#if FLEX_CODING_ORDER_M23723
92  Char*  m_pchMVCJointCodingOrder;      ///<  texture-depth coding order
93  Bool    m_b3DVFlexOrder;    ///<  flexible coding order flag
94#endif
95
96  // coding structure
97  Int       m_iIntraPeriod;                                   ///< period of I-slice (random access period)
98  Int       m_iDecodingRefreshType;                           ///< random access type
99  Int       m_iGOPSize;                                       ///< GOP size of hierarchical structure
100  Int       m_extraRPSs[MAX_VIEW_NUM];
101  GOPEntryMvc m_GOPListsMvc[MAX_VIEW_NUM][MAX_GOP+1];
102#if H0567_DPB_PARAMETERS_PER_TEMPORAL_LAYER
103  Int       m_numReorderPics[MAX_VIEW_NUM][MAX_TLAYER];       ///< total number of reorder pictures
104  Int       m_maxDecPicBuffering[MAX_VIEW_NUM][MAX_TLAYER];   ///< total number of reference pictures needed for decoding
105#else
106  Int       m_numReorderFrames;                               ///< total number of reorder pictures
107  Int       m_maxNumberOfReferencePictures;                   ///< total number of reference pictures needed for decoding
108#endif
109  Bool      m_bUseLComb;                                      ///< flag for using combined reference list for uni-prediction in B-slices (JCTVC-D421)
110  Bool      m_bLCMod;                                         ///< flag for specifying whether the combined reference list for uni-prediction in B-slices is uploaded explicitly
111  Bool      m_bDisInter4x4;
112  Bool      m_enableNSQT;                                     ///< flag for enabling NSQT
113  Bool      m_enableAMP;
114  // coding quality
115  std::vector<Double>  m_adQP;                                ///< QP value of key-picture (floating point) [0] video, [1] depth
116  std::vector<Int>     m_aiQP;                                ///< QP value of key-picture (integer) [0] video, [1] depth
117#if QC_MVHEVC_B0046
118  std::vector<Int>     m_aiVId;                                ///< view id
119#endif
120  Int       m_aiTLayerQPOffset[MAX_TLAYER];                   ///< QP offset corresponding to temporal layer depth
121  char*     m_pchdQPFile;                                     ///< QP offset for each slice (initialized from external file)
122  Int*      m_aidQP;                                          ///< array of slice QP values
123  Int*      m_aidQPdepth;                                     ///< array of depth slice QP values
124  Int       m_iMaxDeltaQP;                                    ///< max. |delta QP|
125  UInt      m_uiDeltaQpRD;                                    ///< dQP range for multi-pass slice QP optimization
126  Int       m_iMaxCuDQPDepth;                                 ///< Max. depth for a minimum CuDQPSize (0:default)
127
128  Int       m_iChromaQpOffset;                                 ///< ChromaQpOffset    (0:default)
129  Int       m_iChromaQpOffset2nd;                              ///< ChromaQpOffset2nd (0:default)
130
131#if ADAPTIVE_QP_SELECTION
132  Bool      m_bUseAdaptQpSelect;
133#endif
134
135  Bool      m_bUseAdaptiveQP;                                 ///< Flag for enabling QP adaptation based on a psycho-visual model
136  Int       m_iQPAdaptationRange;                             ///< dQP range by QP adaptation
137 
138#if H0566_TLA
139  Int       m_maxTempLayer[MAX_VIEW_NUM];                     ///< Max temporal layer
140#else
141  Bool      m_bTLayering;                                     ///< indicates whether temporal IDs are set based on the hierarchical coding structure
142  Bool      m_abTLayerSwitchingFlag[MAX_TLAYER];              ///< temporal layer switching flags corresponding to each temporal layer
143#endif
144
145  // coding unit (CU) definition
146  UInt      m_uiMaxCUWidth;                                   ///< max. CU width in pixel
147  UInt      m_uiMaxCUHeight;                                  ///< max. CU height in pixel
148  UInt      m_uiMaxCUDepth;                                   ///< max. CU depth
149 
150  // transfom unit (TU) definition
151  UInt      m_uiQuadtreeTULog2MaxSize;
152  UInt      m_uiQuadtreeTULog2MinSize;
153 
154  UInt      m_uiQuadtreeTUMaxDepthInter;
155  UInt      m_uiQuadtreeTUMaxDepthIntra;
156 
157  // coding tools (bit-depth)
158  UInt      m_uiInputBitDepth;                                ///< bit-depth of input file
159  UInt      m_uiOutputBitDepth;                               ///< bit-depth of output file
160  UInt      m_uiInternalBitDepth;                             ///< Internal bit-depth (BitDepth+BitIncrement)
161
162  // coding tools (PCM bit-depth)
163  Bool      m_bPCMInputBitDepthFlag;                          ///< 0: PCM bit-depth is internal bit-depth. 1: PCM bit-depth is input bit-depth.
164  UInt      m_uiPCMBitDepthLuma;                              ///< PCM bit-depth for luma
165
166  // coding tool (lossless)
167#if LOSSLESS_CODING
168  Bool      m_useLossless;                                    ///< flag for using lossless coding
169#endif
170  vector<Bool> m_abUseSAO;
171#if LGE_ILLUCOMP_B0045
172  Bool      m_bUseIC;                                     ///< flag for using illumination compensation for inter-view prediction
173#endif
174#if SAO_UNIT_INTERLEAVING
175  Int       m_maxNumOffsetsPerPic;                            ///< SAO maximun number of offset per picture
176  Bool      m_saoInterleavingFlag;                            ///< SAO interleaving flag
177#endif
178  // coding tools (loop filter)
179  vector<Bool> m_abUseALF;                                    ///< flag for using adaptive loop filter [0] - video, [1] - depth
180  Int       m_iALFEncodePassReduction;                        //!< ALF encoding pass, 0 = original 16-pass, 1 = 1-pass, 2 = 2-pass
181 
182  Int       m_iALFMaxNumberFilters;                           ///< ALF Max Number Filters in one picture
183#if LCU_SYNTAX_ALF
184  Bool      m_bALFParamInSlice;
185  Bool      m_bALFPicBasedEncode;
186#endif
187
188  vector<Bool> m_abLoopFilterDisable;                         ///< flag for using deblocking filter filter [0] - video, [1] - depth
189  Bool      m_loopFilterOffsetInAPS;                         ///< offset for deblocking filter in 0 = slice header, 1 = APS
190  Int       m_loopFilterBetaOffsetDiv2;                     ///< beta offset for deblocking filter
191  Int       m_loopFilterTcOffsetDiv2;                       ///< tc offset for deblocking filter
192#if DBL_CONTROL
193  Bool      m_DeblockingFilterControlPresent;                 ///< deblocking filter control present flag in PPS
194#endif
195 
196  Bool      m_bUseLMChroma;                                  ///< JL: Chroma intra prediction based on luma signal
197
198  // coding tools (PCM)
199  Bool      m_usePCM;                                         ///< flag for using IPCM
200  UInt      m_pcmLog2MaxSize;                                 ///< log2 of maximum PCM block size
201  UInt      m_uiPCMLog2MinSize;                               ///< log2 of minimum PCM block size
202  Bool      m_bPCMFilterDisableFlag;                          ///< PCM filter disable flag
203
204  // coding tools (encoder-only parameters)
205  Bool      m_bUseSBACRD;                                     ///< flag for using RD optimization based on SBAC
206  Bool      m_bUseASR;                                        ///< flag for using adaptive motion search range
207  Bool      m_bUseHADME;                                      ///< flag for using HAD in sub-pel ME
208vector<Bool> m_abUseRDOQ;                                   ///< flag for using RD optimized quantization [0]-video, [1]-depth
209  Int       m_iFastSearch;                                    ///< ME mode, 0 = full, 1 = diamond, 2 = PMVFAST
210  Int       m_iSearchRange;                                   ///< ME search range
211#if DV_V_RESTRICTION_B0037
212  Bool      m_bUseDisparitySearchRangeRestriction;            ///< restrict vertical search range for inter-view prediction
213  Int       m_iVerticalDisparitySearchRange;                  ///< ME vertical search range for inter-view prediction
214#endif
215  Int       m_bipredSearchRange;                              ///< ME search range for bipred refinement
216  Bool      m_bUseFastEnc;                                    ///< flag for using fast encoder setting
217#if HHI_INTERVIEW_SKIP
218  Bool      m_bInterViewSkip;                            ///< usage of interview skip mode ( do not transmit residual)
219#if HHI_INTERVIEW_SKIP_LAMBDA_SCALE
220  Double    m_dInterViewSkipLambdaScale;                 ///< lambda scale for interview skip
221#endif
222#endif
223  Bool      m_bUseEarlyCU;                                    ///< flag for using Early CU setting
224
225#if DEPTH_MAP_GENERATION
226  UInt      m_uiPredDepthMapGeneration;                       ///< using of (virtual) depth maps for texture coding
227#endif
228#if HHI_INTER_VIEW_MOTION_PRED
229  UInt      m_uiMultiviewMvPredMode;                          ///< usage of predictors for multi-view mv prediction
230  UInt      m_uiMultiviewMvRegMode;                           ///< regularization for multiview motion vectors
231  Double    m_dMultiviewMvRegLambdaScale;                     ///< lambda scale for multiview motion vectors regularization
232#endif
233#if HHI_INTER_VIEW_RESIDUAL_PRED
234  UInt      m_uiMultiviewResPredMode;          ///< using multiview residual prediction
235#endif
236
237#if FAST_DECISION_FOR_MRG_RD_COST
238  Bool      m_useFastDecisionForMerge;         ///< flag for using Fast Decision Merge RD-Cost
239#endif
240  Bool      m_bUseCbfFastMode;                 ///< flag for using Cbf Fast PU Mode Decision
241  Int       m_iSliceMode;                      ///< 0: Disable all Recon slice limits, 1 : Maximum number of largest coding units per slice, 2: Maximum number of bytes in a slice
242  Int       m_iSliceArgument;                  ///< If m_iSliceMode==1, m_iSliceArgument=max. # of largest coding units. If m_iSliceMode==2, m_iSliceArgument=max. # of bytes.
243  Int       m_iEntropySliceMode;               ///< 0: Disable all entropy slice limits, 1 : Maximum number of largest coding units per slice, 2: Constraint based entropy slice
244  Int       m_iEntropySliceArgument;           ///< If m_iEntropySliceMode==1, m_iEntropySliceArgument=max. # of largest coding units. If m_iEntropySliceMode==2, m_iEntropySliceArgument=max. # of bins.
245
246  Int       m_iSliceGranularity;               ///< 0: Slices always end at LCU borders. 1-3: slices may end at a depth of 1-3 below LCU level.
247  Bool      m_bLFCrossSliceBoundaryFlag;       ///< 0: Cross-slice-boundary in-loop filtering 1: non-cross-slice-boundary in-loop filtering
248  Int       m_iTileBehaviorControlPresentFlag; //!< 1: tile behavior control parameters are in PPS 0: tile behavior control parameters are not in PPS
249  Bool      m_bLFCrossTileBoundaryFlag;        //!< 1: Cross-tile-boundary in-loop filtering 0: non-cross-tile-boundary in-loop filtering
250  Int       m_iColumnRowInfoPresent;
251  Int       m_iUniformSpacingIdr;
252#if !REMOVE_TILE_DEPENDENCE
253  Int       m_iTileBoundaryIndependenceIdr;
254#endif
255  Int       m_iNumColumnsMinus1;
256  char*     m_pchColumnWidth;
257  Int       m_iNumRowsMinus1;
258  char*     m_pchRowHeight;
259  Int       m_iTileLocationInSliceHeaderFlag; //< enable(1)/disable(0) transmitssion of tile location in slice header
260  Int       m_iTileMarkerFlag;              //< enable(1)/disable(0) transmitssion of light weight tile marker
261  Int       m_iMaxTileMarkerEntryPoints;    //< maximum number of tile markers allowed in a slice (controls degree of parallelism)
262  Double    m_dMaxTileMarkerOffset;         //< Calculated offset. Light weight tile markers will be transmitted for TileIdx= Offset, 2*Offset, 3*Offset ...
263
264  Int       m_iWaveFrontSynchro; //< 0: no WPP. >= 1: WPP is enabled, the "Top right" from which inheritance occurs is this LCU offset in the line above the current.
265  Int       m_iWaveFrontFlush; //< enable(1)/disable(0) the CABAC flush at the end of each line of LCUs.
266  Int       m_iWaveFrontSubstreams; //< If iWaveFrontSynchro, this is the number of substreams per frame (dependent tiles) or per tile (independent tiles).
267
268  Bool      m_bUseConstrainedIntraPred;                       ///< flag for using constrained intra prediction
269 
270  bool m_pictureDigestEnabled; ///< enable(1)/disable(0) md5 computation and SEI signalling
271
272  // weighted prediction
273  Bool      m_bUseWeightPred;                                 ///< Use of explicit Weighting Prediction for P_SLICE
274  UInt      m_uiBiPredIdc;                                    ///< Use of Bi-Directional Weighting Prediction (B_SLICE): explicit(1) or implicit(2)
275
276#if TMVP_DEPTH_SWITCH
277  vector<Bool> m_enableTMVP;                                  ///< Enable TMVP [0] video, [1] depth
278#else
279  Bool      m_enableTMVP;
280#endif
281
282#if MULTIBITS_DATA_HIDING
283  Int       m_signHideFlag;
284  Int       m_signHidingThreshold;
285#endif
286#if HHI_MPI
287  Bool      m_bUseMVI;  ///< flag for using Motion Vector Inheritance for depth map coding
288#endif
289#if RWTH_SDC_DLT_B0036
290  Bool      m_bUseDLT;
291  Bool      m_bUseSDC;
292#endif
293
294  Int       m_useScalingListId;                               ///< using quantization matrix
295  char*     m_scalingListFile;                                ///< quantization matrix file name
296
297  // camera parameter
298  Char*     m_pchCameraParameterFile;                         ///< camera parameter file
299  Char*     m_pchBaseViewCameraNumbers;
300#if !QC_MVHEVC_B0046
301  TAppComCamPara m_cCameraData;
302#endif
303  Int       m_iCodedCamParPrecision;                          ///< precision for coding of camera parameters
304
305#if HHI_VSO
306  Char*     m_pchVSOConfig;
307  Bool      m_bUseVSO;                                    ///< flag for using View Synthesis Optimization
308#if HHI_VSO_LS_TABLE_M23714
309  Bool      m_bVSOLSTable;                                ///< Depth QP dependent Lagrange parameter optimization (m23714)
310#endif
311#if LGE_VSO_EARLY_SKIP_A0093
312  Bool      m_bVSOEarlySkip;                              ///< Early skip of VSO computation (JCT3V-A0093 modification 4)
313#endif
314  //// Used for development by GT, might be removed later
315  Double    m_dLambdaScaleVSO;                            ///< Scaling factor for Lambda in VSO mode
316  Bool      m_bForceLambdaScaleVSO;                       ///< Use Lambda Scale for depth even if VSO is turned off
317#if HHI_VSO_DIST_INT
318  Bool      m_bAllowNegDist;                              ///< Allow negative distortion in VSO
319#endif
320  UInt      m_uiVSOMode;                                  ///< Number of VSO Mode, 1 = , 2 = simple, org vs. ren, 3 = simple, ren vs. ren, 4 = full 
321#endif
322#if SAIT_VSO_EST_A0033
323  Bool      m_bUseEstimatedVSD;                           ///< Flag for using model based VSD estimation instead of VSO for some encoder decisions (JCT3V-A0033 modification 3) 
324#endif
325#if LGE_WVSO_A0119
326  Bool      m_bUseWVSO;                                    ///< flag for using View Synthesis Optimization 
327  Int       m_iVSOWeight;
328  Int       m_iVSDWeight;
329  Int       m_iDWeight;
330#endif
331  // coding tools (depth intra modes)
332#if HHI_DMM_WEDGE_INTRA || HHI_DMM_PRED_TEX
333  Bool      m_bUseDMM;                                        ///< flag for using DMM
334#endif
335
336#if OL_QTLIMIT_PREDCODING_B0068
337  Bool      m_bUseQTLPC;                                      ///< flag for using depth QuadTree Limitation + Predictive Coding
338#endif
339
340  // internal member functions
341  Void  xSetGlobal      ();                                   ///< set global variables
342  Void  xCheckParameter ();                                   ///< check validity of configuration values
343  Void  xPrintParameter ();                                   ///< print configuration values
344  Void  xPrintUsage     ();                                   ///< print usage
345 
346  Void  xCleanUpVectors ();                                   ///< clean up vector sizes
347  Void  xInitCameraPars ();                                   ///< init camera parameters
348
349
350  // set MVD Parameters and LUTs
351  Void xSetShiftParameters();
352  Void xGetShiftParameter( UInt uiSourceView, UInt uiTargetView, bool bExternal, double& rdScale, double& rdOffset ); ///< Get one Shift Parameters
353
354  Void  xAppendToFileNameEnd( Char* pchInputFileName, const Char* pchStringToAppend, Char* & rpchOutputFileName);
355
356  Void  xCheckCodingStructureMvc();                           ///< validate and configure inter-view coding structure
357
358  template <class T> Void xCleanUpVector( std::vector<T>& rcVec, const T& rcInvalid );
359#if HHI_VSO
360  // Ren Model String
361  TRenModSetupStrParser       m_cRenModStrParser;
362#endif
363public:
364  TAppEncCfg();
365  virtual ~TAppEncCfg();
366 
367public:
368  Void  create    ();                                         ///< create option handling class
369  Void  destroy   ();                                         ///< destroy option handling class
370  Bool  parseCfg  ( Int argc, Char* argv[] );                 ///< parse configuration file to fill member variables
371 
372};// END CLASS DEFINITION TAppEncCfg
373
374//! \}
375
376#endif // __TAPPENCCFG__
377
Note: See TracBrowser for help on using the repository browser.