Context navigation

source: SHVCSoftware/branches/SHM-3.1-dev/source/App/TAppEncoder/TAppEncCfg.h @ 405

Visit:

Last change on this file since 405 was 402, checked in by seregin, 11 years ago
fix compiler warnings
Property svn:eol-style set to `native`
File size: 24.5 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-2013, 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	#if SVC_EXTENSION
45	#include "TAppEncLayerCfg.h"
46	#endif
47	#include <sstream>
48	//! \ingroup TAppEncoder
49	//! \{
50
51	// ====================================================================================================================
52	// Class definition
53	// ====================================================================================================================
54
55	/// encoder configuration class
56	class TAppEncCfg
57	{
58	protected:
59	// file I/O
60	#if SVC_EXTENSION
61	TAppEncLayerCfg m_acLayerCfg [MAX_LAYERS];
62	Int m_numLayers; ///< number of layers
63	Int m_scalabilityMask[MAX_VPS_NUM_SCALABILITY_TYPES]; ///< scalability_mask
64	Char* m_pBitstreamFile; ///< output bitstream file
65	Double m_adLambdaModifier[ MAX_TLAYER ]; ///< Lambda modifier array for each temporal layer
66	// source specification
67	UInt m_FrameSkip; ///< number of skipped frames from the beginning
68	Int m_framesToBeEncoded; ///< number of encoded frames
69	#if AVC_BASE
70	Int m_avcBaseLayerFlag; ///< avc_baselayer_flag
71	#endif
72	#if AVC_SYNTAX
73	Char* m_BLSyntaxFile; ///< input syntax file
74	#endif
75	#if M0457_IL_SAMPLE_PRED_ONLY_FLAG
76	Int m_ilSampleOnlyPred[ MAX_LAYERS ];
77	#endif
78	#if N0120_MAX_TID_REF_CFG
79	Bool m_maxTidRefPresentFlag;
80	#endif
81	#else
82	Char* m_pchInputFile; ///< source file name
83	Char* m_pchBitstreamFile; ///< output bitstream file
84	Char* m_pchReconFile; ///< output reconstruction file
85	Double m_adLambdaModifier[ MAX_TLAYER ]; ///< Lambda modifier array for each temporal layer
86	// source specification
87	Int m_iFrameRate; ///< source frame-rates (Hz)
88	UInt m_FrameSkip; ///< number of skipped frames from the beginning
89	Int m_iSourceWidth; ///< source width in pixel
90	Int m_iSourceHeight; ///< source height in pixel
91	Int m_conformanceMode;
92	Int m_confLeft;
93	Int m_confRight;
94	Int m_confTop;
95	Int m_confBottom;
96	Int m_framesToBeEncoded; ///< number of encoded frames
97	Int m_aiPad[2]; ///< number of padded pixels for width and height
98	#endif
99
100	// profile/level
101	Profile::Name m_profile;
102	Level::Tier m_levelTier;
103	Level::Name m_level;
104	Bool m_progressiveSourceFlag;
105	Bool m_interlacedSourceFlag;
106	Bool m_nonPackedConstraintFlag;
107	Bool m_frameOnlyConstraintFlag;
108
109	// coding structure
110	#if !SVC_EXTENSION
111	Int m_iIntraPeriod; ///< period of I-slice (random access period)
112	#endif
113	Int m_iDecodingRefreshType; ///< random access type
114	Int m_iGOPSize; ///< GOP size of hierarchical structure
115	Int m_extraRPSs; ///< extra RPSs added to handle CRA
116	GOPEntry m_GOPList[MAX_GOP]; ///< the coding structure entries from the config file
117	Int m_numReorderPics[MAX_TLAYER]; ///< total number of reorder pictures
118	Int m_maxDecPicBuffering[MAX_TLAYER]; ///< total number of pictures in the decoded picture buffer
119	Bool m_useTransformSkip; ///< flag for enabling intra transform skipping
120	Bool m_useTransformSkipFast; ///< flag for enabling fast intra transform skipping
121	Bool m_enableAMP;
122	// coding quality
123	#if !SVC_EXTENSION
124	Double m_fQP; ///< QP value of key-picture (floating point)
125	Int m_iQP; ///< QP value of key-picture (integer)
126	Char* m_pchdQPFile; ///< QP offset for each slice (initialized from external file)
127	Int* m_aidQP; ///< array of slice QP values
128	#endif
129	Int m_iMaxDeltaQP; ///< max. \|delta QP\|
130	UInt m_uiDeltaQpRD; ///< dQP range for multi-pass slice QP optimization
131	Int m_iMaxCuDQPDepth; ///< Max. depth for a minimum CuDQPSize (0:default)
132
133	Int m_cbQpOffset; ///< Chroma Cb QP Offset (0:default)
134	Int m_crQpOffset; ///< Chroma Cr QP Offset (0:default)
135
136	#if ADAPTIVE_QP_SELECTION
137	Bool m_bUseAdaptQpSelect;
138	#endif
139
140	Bool m_bUseAdaptiveQP; ///< Flag for enabling QP adaptation based on a psycho-visual model
141	Int m_iQPAdaptationRange; ///< dQP range by QP adaptation
142
143	Int m_maxTempLayer; ///< Max temporal layer
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	Int m_inputBitDepthY; ///< bit-depth of input file (luma component)
159	Int m_inputBitDepthC; ///< bit-depth of input file (chroma component)
160	Int m_outputBitDepthY; ///< bit-depth of output file (luma component)
161	Int m_outputBitDepthC; ///< bit-depth of output file (chroma component)
162	Int m_internalBitDepthY; ///< bit-depth codec operates at in luma (input/output files will be converted)
163	Int m_internalBitDepthC; ///< bit-depth codec operates at in chroma (input/output files will be converted)
164
165	// coding tools (PCM bit-depth)
166	Bool m_bPCMInputBitDepthFlag; ///< 0: PCM bit-depth is internal bit-depth. 1: PCM bit-depth is input bit-depth.
167
168	// coding tool (lossless)
169	Bool m_useLossless; ///< flag for using lossless coding
170	Bool m_bUseSAO;
171	Int m_maxNumOffsetsPerPic; ///< SAO maximun number of offset per picture
172	Bool m_saoLcuBoundary; ///< SAO parameter estimation using non-deblocked pixels for LCU bottom and right boundary areas
173	Bool m_saoLcuBasedOptimization; ///< SAO LCU-based optimization
174	// coding tools (loop filter)
175	Bool m_bLoopFilterDisable; ///< flag for using deblocking filter
176	Bool m_loopFilterOffsetInPPS; ///< offset for deblocking filter in 0 = slice header, 1 = PPS
177	Int m_loopFilterBetaOffsetDiv2; ///< beta offset for deblocking filter
178	Int m_loopFilterTcOffsetDiv2; ///< tc offset for deblocking filter
179	Bool m_DeblockingFilterControlPresent; ///< deblocking filter control present flag in PPS
180	Bool m_DeblockingFilterMetric; ///< blockiness metric in encoder
181
182	// coding tools (PCM)
183	Bool m_usePCM; ///< flag for using IPCM
184	UInt m_pcmLog2MaxSize; ///< log2 of maximum PCM block size
185	UInt m_uiPCMLog2MinSize; ///< log2 of minimum PCM block size
186	Bool m_bPCMFilterDisableFlag; ///< PCM filter disable flag
187
188	// coding tools (encoder-only parameters)
189	Bool m_bUseSBACRD; ///< flag for using RD optimization based on SBAC
190	Bool m_bUseASR; ///< flag for using adaptive motion search range
191	Bool m_bUseHADME; ///< flag for using HAD in sub-pel ME
192	Bool m_useRDOQ; ///< flag for using RD optimized quantization
193	Bool m_useRDOQTS; ///< flag for using RD optimized quantization for transform skip
194	Int m_rdPenalty; ///< RD-penalty for 32x32 TU for intra in non-intra slices (0: no RD-penalty, 1: RD-penalty, 2: maximum RD-penalty)
195	Int m_iFastSearch; ///< ME mode, 0 = full, 1 = diamond, 2 = PMVFAST
196	Int m_iSearchRange; ///< ME search range
197	Int m_bipredSearchRange; ///< ME search range for bipred refinement
198	Bool m_bUseFastEnc; ///< flag for using fast encoder setting
199	Bool m_bUseEarlyCU; ///< flag for using Early CU setting
200	Bool m_useFastDecisionForMerge; ///< flag for using Fast Decision Merge RD-Cost
201	Bool m_bUseCbfFastMode; ///< flag for using Cbf Fast PU Mode Decision
202	Bool m_useEarlySkipDetection; ///< flag for using Early SKIP Detection
203	#if FAST_INTRA_SHVC
204	Bool m_useFastIntraScalable; ///< flag for using Fast Intra Decision for Scalable HEVC
205	#endif
206	Int m_sliceMode; ///< 0: no slice limits, 1 : max number of CTBs per slice, 2: max number of bytes per slice,
207	///< 3: max number of tiles per slice
208	Int m_sliceArgument; ///< argument according to selected slice mode
209	Int m_sliceSegmentMode; ///< 0: no slice segment limits, 1 : max number of CTBs per slice segment, 2: max number of bytes per slice segment,
210	///< 3: max number of tiles per slice segment
211	Int m_sliceSegmentArgument; ///< argument according to selected slice segment mode
212
213	Bool m_bLFCrossSliceBoundaryFlag; ///< 1: filter across slice boundaries 0: do not filter across slice boundaries
214	Bool m_bLFCrossTileBoundaryFlag; ///< 1: filter across tile boundaries 0: do not filter across tile boundaries
215	Int m_iUniformSpacingIdr;
216	Int m_iNumColumnsMinus1;
217	Char* m_pchColumnWidth;
218	Int m_iNumRowsMinus1;
219	Char* m_pchRowHeight;
220	UInt* m_pColumnWidth;
221	UInt* m_pRowHeight;
222	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.
223	#if !SVC_EXTENSION
224	Int m_iWaveFrontSubstreams; //< If iWaveFrontSynchro, this is the number of substreams per frame (dependent tiles) or per tile (independent tiles).
225	#endif
226
227	Bool m_bUseConstrainedIntraPred; ///< flag for using constrained intra prediction
228
229	Int m_decodedPictureHashSEIEnabled; ///< Checksum(3)/CRC(2)/MD5(1)/disable(0) acting on decoded picture hash SEI message
230	Int m_recoveryPointSEIEnabled;
231	Int m_bufferingPeriodSEIEnabled;
232	Int m_pictureTimingSEIEnabled;
233	Bool m_toneMappingInfoSEIEnabled;
234	Int m_toneMapId;
235	Bool m_toneMapCancelFlag;
236	Bool m_toneMapPersistenceFlag;
237	Int m_toneMapCodedDataBitDepth;
238	Int m_toneMapTargetBitDepth;
239	Int m_toneMapModelId;
240	Int m_toneMapMinValue;
241	Int m_toneMapMaxValue;
242	Int m_sigmoidMidpoint;
243	Int m_sigmoidWidth;
244	Int m_numPivots;
245	Int m_cameraIsoSpeedIdc;
246	Int m_cameraIsoSpeedValue;
247	Int m_exposureCompensationValueSignFlag;
248	Int m_exposureCompensationValueNumerator;
249	Int m_exposureCompensationValueDenomIdc;
250	Int m_refScreenLuminanceWhite;
251	Int m_extendedRangeWhiteLevel;
252	Int m_nominalBlackLevelLumaCodeValue;
253	Int m_nominalWhiteLevelLumaCodeValue;
254	Int m_extendedWhiteLevelLumaCodeValue;
255	Int* m_startOfCodedInterval;
256	Int* m_codedPivotValue;
257	Int* m_targetPivotValue;
258	Int m_framePackingSEIEnabled;
259	Int m_framePackingSEIType;
260	Int m_framePackingSEIId;
261	Int m_framePackingSEIQuincunx;
262	Int m_framePackingSEIInterpretation;
263	Int m_displayOrientationSEIAngle;
264	Int m_temporalLevel0IndexSEIEnabled;
265	Int m_gradualDecodingRefreshInfoEnabled;
266	Int m_decodingUnitInfoSEIEnabled;
267	#if M0043_LAYERS_PRESENT_SEI
268	Int m_layersPresentSEIEnabled;
269	#endif
270	Int m_SOPDescriptionSEIEnabled;
271	Int m_scalableNestingSEIEnabled;
272	// weighted prediction
273	Bool m_useWeightedPred; ///< Use of weighted prediction in P slices
274	Bool m_useWeightedBiPred; ///< Use of bi-directional weighted prediction in B slices
275
276	UInt m_log2ParallelMergeLevel; ///< Parallel merge estimation region
277	UInt m_maxNumMergeCand; ///< Max number of merge candidates
278
279	Int m_TMVPModeId;
280	Int m_signHideFlag;
281	#if RATE_CONTROL_LAMBDA_DOMAIN
282	#if !RC_SHVC_HARMONIZATION
283	Bool m_RCEnableRateControl; ///< enable rate control or not
284	Int m_RCTargetBitrate; ///< target bitrate when rate control is enabled
285	#if M0036_RC_IMPROVEMENT
286	Int m_RCKeepHierarchicalBit; ///< 0: equal bit allocation; 1: fixed ratio bit allocation; 2: adaptive ratio bit allocation
287	#else
288	Bool m_RCKeepHierarchicalBit; ///< whether keeping hierarchical bit allocation structure or not
289	#endif
290	Bool m_RCLCULevelRC; ///< true: LCU level rate control; false: picture level rate control
291	Bool m_RCUseLCUSeparateModel; ///< use separate R-lambda model at LCU level
292	Int m_RCInitialQP; ///< inital QP for rate control
293	Bool m_RCForceIntraQP; ///< force all intra picture to use initial QP or not
294	#endif
295	#else
296	Bool m_enableRateCtrl; ///< Flag for using rate control algorithm
297	Int m_targetBitrate; ///< target bitrate
298	Int m_numLCUInUnit; ///< Total number of LCUs in a frame should be completely divided by the NumLCUInUnit
299	#endif
300	Int m_useScalingListId; ///< using quantization matrix
301	Char* m_scalingListFile; ///< quantization matrix file name
302
303	Bool m_TransquantBypassEnableFlag; ///< transquant_bypass_enable_flag setting in PPS.
304	Bool m_CUTransquantBypassFlagValue; ///< if transquant_bypass_enable_flag, the fixed value to use for the per-CU cu_transquant_bypass_flag.
305
306	Bool m_recalculateQPAccordingToLambda; ///< recalculate QP value according to the lambda value
307	Bool m_useStrongIntraSmoothing; ///< enable strong intra smoothing for 32x32 blocks where the reference samples are flat
308	Int m_activeParameterSetsSEIEnabled;
309
310	Bool m_vuiParametersPresentFlag; ///< enable generation of VUI parameters
311	Bool m_aspectRatioInfoPresentFlag; ///< Signals whether aspect_ratio_idc is present
312	Int m_aspectRatioIdc; ///< aspect_ratio_idc
313	Int m_sarWidth; ///< horizontal size of the sample aspect ratio
314	Int m_sarHeight; ///< vertical size of the sample aspect ratio
315	Bool m_overscanInfoPresentFlag; ///< Signals whether overscan_appropriate_flag is present
316	Bool m_overscanAppropriateFlag; ///< Indicates whether conformant decoded pictures are suitable for display using overscan
317	Bool m_videoSignalTypePresentFlag; ///< Signals whether video_format, video_full_range_flag, and colour_description_present_flag are present
318	Int m_videoFormat; ///< Indicates representation of pictures
319	Bool m_videoFullRangeFlag; ///< Indicates the black level and range of luma and chroma signals
320	Bool m_colourDescriptionPresentFlag; ///< Signals whether colour_primaries, transfer_characteristics and matrix_coefficients are present
321	Int m_colourPrimaries; ///< Indicates chromaticity coordinates of the source primaries
322	Int m_transferCharacteristics; ///< Indicates the opto-electronic transfer characteristics of the source
323	Int m_matrixCoefficients; ///< Describes the matrix coefficients used in deriving luma and chroma from RGB primaries
324	Bool m_chromaLocInfoPresentFlag; ///< Signals whether chroma_sample_loc_type_top_field and chroma_sample_loc_type_bottom_field are present
325	Int m_chromaSampleLocTypeTopField; ///< Specifies the location of chroma samples for top field
326	Int m_chromaSampleLocTypeBottomField; ///< Specifies the location of chroma samples for bottom field
327	Bool m_neutralChromaIndicationFlag; ///< Indicates that the value of all decoded chroma samples is equal to 1<<(BitDepthCr-1)
328	Bool m_defaultDisplayWindowFlag; ///< Indicates the presence of the default window parameters
329	Int m_defDispWinLeftOffset; ///< Specifies the left offset from the conformance window of the default window
330	Int m_defDispWinRightOffset; ///< Specifies the right offset from the conformance window of the default window
331	Int m_defDispWinTopOffset; ///< Specifies the top offset from the conformance window of the default window
332	Int m_defDispWinBottomOffset; ///< Specifies the bottom offset from the conformance window of the default window
333	Bool m_frameFieldInfoPresentFlag; ///< Indicates that pic_struct values are present in picture timing SEI messages
334	Bool m_pocProportionalToTimingFlag; ///< Indicates that the POC value is proportional to the output time w.r.t. first picture in CVS
335	Int m_numTicksPocDiffOneMinus1; ///< Number of ticks minus 1 that for a POC difference of one
336	Bool m_bitstreamRestrictionFlag; ///< Signals whether bitstream restriction parameters are present
337	Bool m_tilesFixedStructureFlag; ///< Indicates that each active picture parameter set has the same values of the syntax elements related to tiles
338	Bool m_motionVectorsOverPicBoundariesFlag; ///< Indicates that no samples outside the picture boundaries are used for inter prediction
339	Int m_minSpatialSegmentationIdc; ///< Indicates the maximum size of the spatial segments in the pictures in the coded video sequence
340	Int m_maxBytesPerPicDenom; ///< Indicates a number of bytes not exceeded by the sum of the sizes of the VCL NAL units associated with any coded picture
341	Int m_maxBitsPerMinCuDenom; ///< Indicates an upper bound for the number of bits of coding_unit() data
342	Int m_log2MaxMvLengthHorizontal; ///< Indicate the maximum absolute value of a decoded horizontal MV component in quarter-pel luma units
343	Int m_log2MaxMvLengthVertical; ///< Indicate the maximum absolute value of a decoded vertical MV component in quarter-pel luma units
344
345	#if SVC_EXTENSION
346	Int m_elRapSliceBEnabled;
347	#endif
348	// internal member functions
349	Void xSetGlobal (); ///< set global variables
350	Void xCheckParameter (); ///< check validity of configuration values
351	Void xPrintParameter (); ///< print configuration values
352	Void xPrintUsage (); ///< print usage
353	#if FINAL_RPL_CHANGE_N0082
354	Bool xconfirmExtraGOP (GOPEntry * ge);
355	#endif
356	#if M0040_ADAPTIVE_RESOLUTION_CHANGE
357	Int m_adaptiveResolutionChange; ///< Indicate adaptive resolution change frame
358	#endif
359	#if REPN_FORMAT_IN_VPS
360	RepFormatCfg m_repFormatCfg[16]; ///< Rep_format structures
361	#endif
362	public:
363	TAppEncCfg();
364	virtual ~TAppEncCfg();
365
366	public:
367	Void create (); ///< create option handling class
368	Void destroy (); ///< destroy option handling class
369	Bool parseCfg ( Int argc, Char* argv[] ); ///< parse configuration file to fill member variables
370
371	#if SVC_EXTENSION
372	Int getNumFrameToBeEncoded() {return m_framesToBeEncoded; }
373	Int getNumLayer() {return m_numLayers; }
374	Int getGOPSize() {return m_iGOPSize; }
375	UInt getInternalBitDepthY() {return m_internalBitDepthY; }
376	UInt getInternalBitDepthC() {return m_internalBitDepthC; }
377	UInt getMaxCUWidth() {return m_uiMaxCUWidth; }
378	UInt getMaxCUHeight() {return m_uiMaxCUHeight; }
379	UInt getMaxCUDepth() {return m_uiMaxCUDepth; }
380	Int getDecodingRefreshType() {return m_iDecodingRefreshType; }
381	Int getWaveFrontSynchro() { return m_iWaveFrontSynchro; }
382	Void getDirFilename(string& filename, string& dir, const string path);
383	#if AVC_SYNTAX
384	Char* getBLSyntaxFile() { return m_BLSyntaxFile; }
385	#endif
386	#if SCALED_REF_LAYER_OFFSETS
387	Void cfgStringToArray(Int *arr, string cfgString, Int numEntries, const char logString);
388	#endif
389	#if REPN_FORMAT_IN_VPS
390	RepFormatCfg* getRepFormatCfg(Int i) { return &m_repFormatCfg[i]; }
391	#endif
392	#endif
393	};// END CLASS DEFINITION TAppEncCfg
394
395	//! \}
396
397	#endif // __TAPPENCCFG__
398

Note: See TracBrowser for help on using the repository browser.

Download in other formats: