source: 3DVCSoftware/trunk/source/App/TAppEncoder/TAppEncCfg.h @ 102

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

SAIT_VSO_EST_A0033 code improvement

  • Property svn:eol-style set to native
File size: 19.1 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  // coding structure
91  Int       m_iIntraPeriod;                                   ///< period of I-slice (random access period)
92  Int       m_iDecodingRefreshType;                           ///< random access type
93  Int       m_iGOPSize;                                       ///< GOP size of hierarchical structure
94  Int       m_extraRPSs[MAX_VIEW_NUM];
95  GOPEntryMvc m_GOPListsMvc[MAX_VIEW_NUM][MAX_GOP+1];
96#if H0567_DPB_PARAMETERS_PER_TEMPORAL_LAYER
97  Int       m_numReorderPics[MAX_VIEW_NUM][MAX_TLAYER];       ///< total number of reorder pictures
98  Int       m_maxDecPicBuffering[MAX_VIEW_NUM][MAX_TLAYER];   ///< total number of reference pictures needed for decoding
99#else
100  Int       m_numReorderFrames;                               ///< total number of reorder pictures
101  Int       m_maxNumberOfReferencePictures;                   ///< total number of reference pictures needed for decoding
102#endif
103  Bool      m_bUseLComb;                                      ///< flag for using combined reference list for uni-prediction in B-slices (JCTVC-D421)
104  Bool      m_bLCMod;                                         ///< flag for specifying whether the combined reference list for uni-prediction in B-slices is uploaded explicitly
105  Bool      m_bDisInter4x4;
106  Bool      m_enableNSQT;                                     ///< flag for enabling NSQT
107  Bool      m_enableAMP;
108  // coding quality
109  std::vector<Double>  m_adQP;                                ///< QP value of key-picture (floating point) [0] video, [1] depth
110  std::vector<Int>     m_aiQP;                                ///< QP value of key-picture (integer) [0] video, [1] depth
111  Int       m_aiTLayerQPOffset[MAX_TLAYER];                   ///< QP offset corresponding to temporal layer depth
112  char*     m_pchdQPFile;                                     ///< QP offset for each slice (initialized from external file)
113  Int*      m_aidQP;                                          ///< array of slice QP values
114  Int*      m_aidQPdepth;                                     ///< array of depth slice QP values
115  Int       m_iMaxDeltaQP;                                    ///< max. |delta QP|
116  UInt      m_uiDeltaQpRD;                                    ///< dQP range for multi-pass slice QP optimization
117  Int       m_iMaxCuDQPDepth;                                 ///< Max. depth for a minimum CuDQPSize (0:default)
118
119  Int       m_iChromaQpOffset;                                 ///< ChromaQpOffset    (0:default)
120  Int       m_iChromaQpOffset2nd;                              ///< ChromaQpOffset2nd (0:default)
121
122#if ADAPTIVE_QP_SELECTION
123  Bool      m_bUseAdaptQpSelect;
124#endif
125
126  Bool      m_bUseAdaptiveQP;                                 ///< Flag for enabling QP adaptation based on a psycho-visual model
127  Int       m_iQPAdaptationRange;                             ///< dQP range by QP adaptation
128 
129#if H0566_TLA
130  Int       m_maxTempLayer[MAX_VIEW_NUM];                     ///< Max temporal layer
131#else
132  Bool      m_bTLayering;                                     ///< indicates whether temporal IDs are set based on the hierarchical coding structure
133  Bool      m_abTLayerSwitchingFlag[MAX_TLAYER];              ///< temporal layer switching flags corresponding to each temporal layer
134#endif
135
136  // coding unit (CU) definition
137  UInt      m_uiMaxCUWidth;                                   ///< max. CU width in pixel
138  UInt      m_uiMaxCUHeight;                                  ///< max. CU height in pixel
139  UInt      m_uiMaxCUDepth;                                   ///< max. CU depth
140 
141  // transfom unit (TU) definition
142  UInt      m_uiQuadtreeTULog2MaxSize;
143  UInt      m_uiQuadtreeTULog2MinSize;
144 
145  UInt      m_uiQuadtreeTUMaxDepthInter;
146  UInt      m_uiQuadtreeTUMaxDepthIntra;
147 
148  // coding tools (bit-depth)
149  UInt      m_uiInputBitDepth;                                ///< bit-depth of input file
150  UInt      m_uiOutputBitDepth;                               ///< bit-depth of output file
151  UInt      m_uiInternalBitDepth;                             ///< Internal bit-depth (BitDepth+BitIncrement)
152
153  // coding tools (PCM bit-depth)
154  Bool      m_bPCMInputBitDepthFlag;                          ///< 0: PCM bit-depth is internal bit-depth. 1: PCM bit-depth is input bit-depth.
155  UInt      m_uiPCMBitDepthLuma;                              ///< PCM bit-depth for luma
156
157  // coding tool (lossless)
158#if LOSSLESS_CODING
159  Bool      m_useLossless;                                    ///< flag for using lossless coding
160#endif
161  vector<Bool> m_abUseSAO;
162#if SAO_UNIT_INTERLEAVING
163  Int       m_maxNumOffsetsPerPic;                            ///< SAO maximun number of offset per picture
164  Bool      m_saoInterleavingFlag;                            ///< SAO interleaving flag
165#endif
166  // coding tools (loop filter)
167  vector<Bool> m_abUseALF;                                    ///< flag for using adaptive loop filter [0] - video, [1] - depth
168  Int       m_iALFEncodePassReduction;                        //!< ALF encoding pass, 0 = original 16-pass, 1 = 1-pass, 2 = 2-pass
169 
170  Int       m_iALFMaxNumberFilters;                           ///< ALF Max Number Filters in one picture
171#if LCU_SYNTAX_ALF
172  Bool      m_bALFParamInSlice;
173  Bool      m_bALFPicBasedEncode;
174#endif
175
176  vector<Bool> m_abLoopFilterDisable;                         ///< flag for using deblocking filter filter [0] - video, [1] - depth
177  Bool      m_loopFilterOffsetInAPS;                         ///< offset for deblocking filter in 0 = slice header, 1 = APS
178  Int       m_loopFilterBetaOffsetDiv2;                     ///< beta offset for deblocking filter
179  Int       m_loopFilterTcOffsetDiv2;                       ///< tc offset for deblocking filter
180#if DBL_CONTROL
181  Bool      m_DeblockingFilterControlPresent;                 ///< deblocking filter control present flag in PPS
182#endif
183 
184  Bool      m_bUseLMChroma;                                  ///< JL: Chroma intra prediction based on luma signal
185
186  // coding tools (PCM)
187  Bool      m_usePCM;                                         ///< flag for using IPCM
188  UInt      m_pcmLog2MaxSize;                                 ///< log2 of maximum PCM block size
189  UInt      m_uiPCMLog2MinSize;                               ///< log2 of minimum PCM block size
190  Bool      m_bPCMFilterDisableFlag;                          ///< PCM filter disable flag
191
192  // coding tools (encoder-only parameters)
193  Bool      m_bUseSBACRD;                                     ///< flag for using RD optimization based on SBAC
194  Bool      m_bUseASR;                                        ///< flag for using adaptive motion search range
195  Bool      m_bUseHADME;                                      ///< flag for using HAD in sub-pel ME
196vector<Bool> m_abUseRDOQ;                                   ///< flag for using RD optimized quantization [0]-video, [1]-depth
197  Int       m_iFastSearch;                                    ///< ME mode, 0 = full, 1 = diamond, 2 = PMVFAST
198  Int       m_iSearchRange;                                   ///< ME search range
199  Int       m_bipredSearchRange;                              ///< ME search range for bipred refinement
200  Bool      m_bUseFastEnc;                                    ///< flag for using fast encoder setting
201#if HHI_INTERVIEW_SKIP
202  Bool      m_bInterViewSkip;                            ///< usage of interview skip mode ( do not transmit residual)
203#if HHI_INTERVIEW_SKIP_LAMBDA_SCALE
204  Double    m_dInterViewSkipLambdaScale;                 ///< lambda scale for interview skip
205#endif
206#endif
207  Bool      m_bUseEarlyCU;                                    ///< flag for using Early CU setting
208
209#if DEPTH_MAP_GENERATION
210  UInt      m_uiPredDepthMapGeneration;                       ///< using of (virtual) depth maps for texture coding
211#endif
212#if HHI_INTER_VIEW_MOTION_PRED
213  UInt      m_uiMultiviewMvPredMode;                          ///< usage of predictors for multi-view mv prediction
214  UInt      m_uiMultiviewMvRegMode;                           ///< regularization for multiview motion vectors
215  Double    m_dMultiviewMvRegLambdaScale;                     ///< lambda scale for multiview motion vectors regularization
216#endif
217#if HHI_INTER_VIEW_RESIDUAL_PRED
218  UInt      m_uiMultiviewResPredMode;          ///< using multiview residual prediction
219#endif
220
221#if FAST_DECISION_FOR_MRG_RD_COST
222  Bool      m_useFastDecisionForMerge;         ///< flag for using Fast Decision Merge RD-Cost
223#endif
224  Bool      m_bUseCbfFastMode;                 ///< flag for using Cbf Fast PU Mode Decision
225  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
226  Int       m_iSliceArgument;                  ///< If m_iSliceMode==1, m_iSliceArgument=max. # of largest coding units. If m_iSliceMode==2, m_iSliceArgument=max. # of bytes.
227  Int       m_iEntropySliceMode;               ///< 0: Disable all entropy slice limits, 1 : Maximum number of largest coding units per slice, 2: Constraint based entropy slice
228  Int       m_iEntropySliceArgument;           ///< If m_iEntropySliceMode==1, m_iEntropySliceArgument=max. # of largest coding units. If m_iEntropySliceMode==2, m_iEntropySliceArgument=max. # of bins.
229
230  Int       m_iSliceGranularity;               ///< 0: Slices always end at LCU borders. 1-3: slices may end at a depth of 1-3 below LCU level.
231  Bool      m_bLFCrossSliceBoundaryFlag;       ///< 0: Cross-slice-boundary in-loop filtering 1: non-cross-slice-boundary in-loop filtering
232  Int       m_iTileBehaviorControlPresentFlag; //!< 1: tile behavior control parameters are in PPS 0: tile behavior control parameters are not in PPS
233  Bool      m_bLFCrossTileBoundaryFlag;        //!< 1: Cross-tile-boundary in-loop filtering 0: non-cross-tile-boundary in-loop filtering
234  Int       m_iColumnRowInfoPresent;
235  Int       m_iUniformSpacingIdr;
236#if !REMOVE_TILE_DEPENDENCE
237  Int       m_iTileBoundaryIndependenceIdr;
238#endif
239  Int       m_iNumColumnsMinus1;
240  char*     m_pchColumnWidth;
241  Int       m_iNumRowsMinus1;
242  char*     m_pchRowHeight;
243  Int       m_iTileLocationInSliceHeaderFlag; //< enable(1)/disable(0) transmitssion of tile location in slice header
244  Int       m_iTileMarkerFlag;              //< enable(1)/disable(0) transmitssion of light weight tile marker
245  Int       m_iMaxTileMarkerEntryPoints;    //< maximum number of tile markers allowed in a slice (controls degree of parallelism)
246  Double    m_dMaxTileMarkerOffset;         //< Calculated offset. Light weight tile markers will be transmitted for TileIdx= Offset, 2*Offset, 3*Offset ...
247
248  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.
249  Int       m_iWaveFrontFlush; //< enable(1)/disable(0) the CABAC flush at the end of each line of LCUs.
250  Int       m_iWaveFrontSubstreams; //< If iWaveFrontSynchro, this is the number of substreams per frame (dependent tiles) or per tile (independent tiles).
251
252  Bool      m_bUseConstrainedIntraPred;                       ///< flag for using constrained intra prediction
253 
254  bool m_pictureDigestEnabled; ///< enable(1)/disable(0) md5 computation and SEI signalling
255
256  // weighted prediction
257  Bool      m_bUseWeightPred;                                 ///< Use of explicit Weighting Prediction for P_SLICE
258  UInt      m_uiBiPredIdc;                                    ///< Use of Bi-Directional Weighting Prediction (B_SLICE): explicit(1) or implicit(2)
259
260  Bool      m_enableTMVP;
261#if MULTIBITS_DATA_HIDING
262  Int       m_signHideFlag;
263  Int       m_signHidingThreshold;
264#endif
265#if HHI_MPI
266  Bool      m_bUseMVI;  ///< flag for using Motion Vector Inheritance for depth map coding
267#endif
268
269  Int       m_useScalingListId;                               ///< using quantization matrix
270  char*     m_scalingListFile;                                ///< quantization matrix file name
271
272  // camera parameter
273  Char*     m_pchCameraParameterFile;                         ///< camera parameter file
274  Char*     m_pchBaseViewCameraNumbers;
275  TAppComCamPara m_cCameraData;
276
277  Int       m_iCodedCamParPrecision;                          ///< precision for coding of camera parameters
278
279#if HHI_VSO
280  Char*     m_pchVSOConfig;
281  Bool      m_bUseVSO;                                    ///< flag for using View Synthesis Optimization
282#if HHI_VSO_LS_TABLE
283  Bool      m_bVSOLSTable;                                ///< Depth QP dependent Lagrange parameter optimization (m23714)
284#endif
285#if LGE_VSO_EARLY_SKIP_A0093
286  Bool      m_bVSOEarlySkip;                              ///< Early skip of VSO computation (JCT3V-A0093 modification 4)
287#endif
288  //// Used for development by GT, might be removed later
289  Double    m_dLambdaScaleVSO;                            ///< Scaling factor for Lambda in VSO mode
290  Bool      m_bForceLambdaScaleVSO;                       ///< Use Lambda Scale for depth even if VSO is turned off
291#if HHI_VSO_DIST_INT
292  Bool      m_bAllowNegDist;                              ///< Allow negative distortion in VSO
293#endif
294  UInt      m_uiVSOMode;                                  ///< Number of VSO Mode, 1 = , 2 = simple, org vs. ren, 3 = simple, ren vs. ren, 4 = full 
295#endif
296#if SAIT_VSO_EST_A0033
297  Bool      m_bUseEstimatedVSD;                           ///< Flag for using model based VSD estimation instead of VSO for some encoder decisions (JCT3V-A0033 modification 3) 
298#endif
299
300  // coding tools (depth intra modes)
301#if HHI_DMM_WEDGE_INTRA || HHI_DMM_PRED_TEX
302  Bool      m_bUseDMM;                                        ///< flag for using DMM
303#endif
304
305  // internal member functions
306  Void  xSetGlobal      ();                                   ///< set global variables
307  Void  xCheckParameter ();                                   ///< check validity of configuration values
308  Void  xPrintParameter ();                                   ///< print configuration values
309  Void  xPrintUsage     ();                                   ///< print usage
310 
311  Void  xCleanUpVectors ();                                   ///< clean up vector sizes
312  Void  xInitCameraPars ();                                   ///< init camera parameters
313
314
315  // set MVD Parameters and LUTs
316  Void xSetShiftParameters();
317  Void xGetShiftParameter( UInt uiSourceView, UInt uiTargetView, bool bExternal, double& rdScale, double& rdOffset ); ///< Get one Shift Parameters
318
319  Void  xAppendToFileNameEnd( Char* pchInputFileName, const Char* pchStringToAppend, Char* & rpchOutputFileName);
320
321  Void  xCheckCodingStructureMvc();                           ///< validate and configure inter-view coding structure
322
323  template <class T> Void xCleanUpVector( std::vector<T>& rcVec, const T& rcInvalid );
324#if HHI_VSO
325  // Ren Model String
326  TRenModSetupStrParser       m_cRenModStrParser;
327#endif
328public:
329  TAppEncCfg();
330  virtual ~TAppEncCfg();
331 
332public:
333  Void  create    ();                                         ///< create option handling class
334  Void  destroy   ();                                         ///< destroy option handling class
335  Bool  parseCfg  ( Int argc, Char* argv[] );                 ///< parse configuration file to fill member variables
336 
337};// END CLASS DEFINITION TAppEncCfg
338
339//! \}
340
341#endif // __TAPPENCCFG__
342
Note: See TracBrowser for help on using the repository browser.