Software Manual
Software Manual
Software Manual
Abstract
This document is a user manual describing usage of reference software for the HEVC project. It applies
to version 17.0 of the software.
Contents
1 General Information 3
List of Tables
1 Supported compilers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 GOP structure example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3 File, I/O and source parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4 Profile and level parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5 Unit definition parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
6 Coding structure parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Bug reporting
Bugs should be reported on the issue tracker set up at:
https://hevc.hhi.fraunhofer.de/trac/hevc/
By default the software is built as 64-bit binaries to be used on a 64-bit OS. This allows the software to
use more than 2GB of RAM.
The software uses CMake to create platform-specific build files.
mkdir build
cd build
cmake .. -G "Visual Studio 14 2015 Win64"
cd build
cmake .. -G "Xcode"
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug
Then type
make -j
make all
For MSYS2 and MinGW: Open an MSYS MinGW 64-Bit terminal and change into the root directory of
this project.
Call:
Python https://www.python.org/downloads/release/python-371/
GnuWin32 https://sourceforge.net/projects/getgnuwin32/files/getgnuwin32/0.6.30/GetGnuWin32-0.6.3.exe/download
Option Description
--help Prints parameter usage.
-c Defines configuration file to use. Multiple configuration files
may be used with repeated –c options.
--parameter=value Assigns value to a given parameter as further described below.
Some parameters are also supported by shorthand “–opt value”.
These are shown in brackets after the parameter name in the
tables of this document
Sample configuration files are provided in the cfg/ folder. Parameters are defined by the last value en-
countered on the command line. Therefore if a setting is set via a configuration file, and then a subsequent
command line parameter changes that same setting, the command line parameter value will be used.
B B B B
B B
I P P
POC 0 1 2 3 4 5 6 7 8
Decode Order 0 3 2 4 1 7 6 8 5
Inter RPS prediction may be used for Frame2, Frame3 and Frame4, hence the predict parameter is set
to 1 for these frames. Frame2 uses Frame1 as the predictor hence the deltaRIdx−1 is 0. Similarly for
Frame3 and Frame4 which use Frame2 and Frame3 as predictors, respectively. The deltaRPS is equal
to the POC of the predictor minus the POC of the current picture, therefore the deltaRPS for Frame2 is
4 − 2 = 2, for Frame3 is 2 − 1 = 1 and for Frame4 is 1 − 3 = −2.
In Frame2, reference pictures with POC 0 and 2 are used, so the reference idcs for Frame2 are 1 1
indicating that the reference picture, −4, in Frame1 is still a reference picture in Frame2 and Frame1
is also a reference picture in Frame2. The reference idcs for Frame3 are 1 1 1. The first and second
“1”s indicating that the reference pictures “−2 2” in Frame2 are still reference pictures in Frame3 and
the last “1” indicating that Frame2 is also a reference picture in Frame3. In Frame 4, the reference idcs
are 0 1 1 0. The first “0” indicates that the reference pictures “-1” in Frame 3 is no longer a reference
picture in Frame4. The next two “1”s indicate that the reference pictures “1 3” are now reference pictures
of Frame4. The final “0” indicates that Frame3 is not a reference picture.
In order to specify this to the encoder, the parameters in Table 2 could be used.
deltaRIdxK − 1 ← K − M − 1 ;
deltaRPSK ← POCM − POCK ;
num_ref_idcsK ← num_ref_picsM + 1 ;
for j ← 0 to num_ref_picsM do
for i ← 0 to num_ref_idcsK do
if reference_picturesM,j + deltaRPSK == reference_picturesK,i then
if reference_picturesK,i is used by the current frame then reference_idcsK,j = 1;
;
else reference_idcsK,j = 2;
;
else
reference_idcsK [j] = 0 ;
end
end
end
/* reference_picturesM,num_ref_picsM does not exist and is assumed to be 0 */
Note: The above (automatic) generation of the inter RPS parameter values has been integrated into the
encoder, and is activated by the value of predict = 2 followed by the value of deltaRIdx−1, only, as
described above.
InputPathPrefix (-ipp) Specifies a string to prepend to the input video file string, specified using -i.
SourceWidth (-wdt) 0 Specifies the width and height of the input video in luma samples.
SourceHeight (-hgt) 0
InputBitDepth 8 Specifies the bit depth of the input video.
MSBExtendedBitDepth 0 Extends the input video by adding MSBs of value 0. When 0, no extension is applied
and the InputBitDepth is used.
The MSBExtendedBitDepth becomes the effective file InputBitDepth for subsequent
processing.
InternalBitDepth 0 Specifies the bit depth used for coding. When 0, the setting defaults to the value of
the MSBExtendedBitDepth.
If the input video is a different bit depth to InternalBitDepth, it is automatically con-
verted by:
⌊ ⌋
Pel ∗ 2InternalBitDepth
2MSBExtendedBitDepth
Note: The effect of this option is as if the input video is externally converted to the
MSBExtendedBitDepth and then to the InternalBitDepth and then coded with this
value as InputBitDepth. The codec has no notion of different bit depths.
OutputBitDepth 0 Specifies the bit depth of the output locally reconstructed video file. When 0, the
setting defaults to the value of InternalBitDepth. Note: This option has no effect on
the decoding process.
InputBitDepthC 0 Specifies the various bit-depths for chroma components. These only need to be spec-
MSBExtendedBitDepthC 0 ified if non-equal luma and chroma bit-depth processing is required. When 0, the
InternalBitDepthC 0 setting defaults to the corresponding non-Chroma value.
OutputBitDepthC 0
InputColourSpaceConvert The colour space conversion to apply to input video. Permitted values are:
UNCHANGED No colour space conversion is applied
YCbCrToYCrCb Swap the second and third components
YCbCrtoYYY Set the second and third components to the values
in the first
RGBtoGBR Reorder the three components
If no value is specified, no colour space conversion is applied. The list may eventually
also include RGB to YCbCr or YCgCo conversions.
SNRInternalColourSpace false When this is set true, then no colour space conversion is applied prior to PSNR cal-
culation, otherwise the inverse of InputColourSpaceConvert is applied.
OutputInternalColourSpace false When this is set true, then no colour space conversion is applied to the reconstructed
video, otherwise the inverse of InputColourSpaceConvert is applied.
InputChromaFormat 420 Specifies the chroma format used in the input file. Permitted values (depending on
the profile) are 400, 420, 422 or 444.
ChromaFormatIDC (-cf) 0 Specifies the chroma format to use for processing. Permitted values (depending on
the profile) are 400, 420, 422 or 444; the value of 0 indicates that the value of In-
putChromaFormat should be used instead.
MSEBasedSequencePSNR false When 0, the PSNR output is a linear average of the frame PSNRs; when 1, additional
PSNRs are output which are formed from the average MSE of all the frames. The
latter is useful when coding near-losslessly, where occasional frames become lossless.
Continued...
PrintHexPSNR false When 1, each POC line will include the 64-bit hexadecimal representation of the
PSNR for each channel. This allows some types of simulations to be split into sub-
simulations and the results later combined without loss of accuracy.
PrintFrameMSE false When 1, the Mean Square Error (MSE) values of each frame will also be output along-
side the default PSNR values.
PrintSequenceMSE false When 1, the Mean Square Error (MSE) values of the entire sequence will also be
output alongside the default PSNR values.
PrintMSSSIM false When 1, the multi-scale structural similarity (MS-SSIM) will also be output alongside
the PSNR values.
xPSNREnableFlag (-xPS false When 1, the cross component PSNR is calculated, using the weights provided with
xPSNRYWeight, xPSNRCbWeight and xPSNRCrWeight.
xPSNRCbWeight (-xPS1) 1.0 Specifies the xPSNR weighting factor for Cb.
xPSNRCrWeight (-xPS2) 1.0 Specifies the xPSNR weighting factor for Cr.
SummaryOutFilename false Filename to use for producing summary output file. If empty, do not produce a file.
SummaryPicFilenameBase false Base filename to use for producing summary picture output files. The actual filenames
used will have I.txt, P.txt and B.txt appended. If empty, do not produce a file.
SummaryVerboseness false Specifies the level of the verboseness of the text output.
CabacZeroWordPaddingEnabled false When 1, CABAC zero word padding will be enabled. This is currently not the default
value for the setting.
ConformanceWindowMode 0 Specifies how the parameters related to the conformance window are interpreted
(cropping/padding). The following modes are available:
0 No cropping / padding
1 Automatic padding to the next minimum CU size
2 Padding according to parameters HorizontalPadding and VerticalPadding
3 Cropping according to parameters ConfWinLeft, ConfWinRight, Con-
fWinTop and ConfWinBottom
HorizontalPadding (-pdx) 0 Specifies the horizontal and vertical padding to be applied to the input video in luma
VerticalPadding (-pdy) samples when ConformanceWindowMode is 2. Must be a multiple of the chroma
resolution (e.g. a multiple of two for 4:2:0).
ConfWinLeft 0 Specifies the horizontal and vertical cropping to be applied to the input video in luma
ConfWinRight samples when ConformanceWindowMode is 3. Must be a multiple of the chroma
ConfWinTop resolution (e.g. a multiple of two for 4:2:0).
ConfWinBottom
FrameRate (-fr) 0 Specifies the frame rate of the input video.
Note: This option only affects the reported bit rates.
FrameSkip (-fs) 0 Specifies a number of frames to skip at beginning of input video file.
FramesToBeEncoded (-f) 0 Specifies the number of frames to be encoded (see note regarding TemporalSubsam-
pleRatio). When 0, all frames are coded.
TemporalSubsampleRatio (-ts) 1 Temporally subsamples the input video sequence. A value of N will skip (N − 1)
frames of input video after each coded input video frame. Note the FramesToBeEn-
coded does not account for the temporal skipping of frames, which will reduce the
number of frames encoded accordingly. The reported bit rates will be reduced and
VUI information is scaled so as to present the video at the correct speed. The mini-
mum and default value is 1.
TopFieldFirst (-Tff) 0 Indicates the order of the fields packed into the input frame. When 1, the top field is
temporally first.
ClipInputVideoToRec709Range 0 If 1 then clip input video to the Rec. 709 Range on loading when InternalBitDepth is
less than MSBExtendedBitDepth.
ClipOutputVideoToRec709Range 0 If 1 then clip output video to the Rec. 709 Range on saving when OutputBitDepth is
less than InternalBitDepth.
Continued...
AccessUnitDelimiter 0 Add Access Unit Delimiter NAL units between all Access Units.
Profile none Specifies the profile to which the encoded bitstream complies.
Valid HEVC Ver. 1 values are: none, main, main10, main-still-picture
Valid HEVC Ver. 2 (RExt) values are: main-RExt, high-throughput-RExt,
monochrome, monochrome12, monochrome16, main12, main_422_10, main_422_-
12, main_444, main_444_10, main_444_12, main_444_16, main_intra, main_-
10_intra, main_12_intra, main_422_10_intra, main_422_12_intra, main_444_in-
tra, main_444_10_intra, main_444_12_intra, main_444_16_intra, high_throughput_-
444_16_intra.
In addition, the following profiles strings are available: high_throughput_444, high_-
throughput_444_10, high_throughput_444_14.
When main-RExt or high-throughput-RExt is specified, the constraint flags are either
manually specified, or calculated via the other supplied settings.
Compatibility flags are automatically determined according to the profile. NB: There
is currently only limited validation that the encoder configuration complies with the
profile, level and tier constraints.
Level none Specifies the level to which the encoded bitstream complies. Valid values are: none,
1, 2, 2.1, 3, 3.1, 4, 4.1, 5, 5.1, 5.2, 6, 6.1, 6.2, 8.5
NB: There is currently only limited validation that the encoder configuration complies
with the profile, level and tier constraints.
Tier main Specifies the level tier to which the encoded bitsream complies. Valid values are:
main, high.
NB: There is currently only limited validation that the encoder configuration complies
with the profile, level and tier constraints.
MaxBitDepthConstraint 0 For –profile=main-RExt, specifies the value to use to derive the gen-
eral_max_bit_depth constraint flags for RExt profiles; when 0, use
max(InternalBitDepth, InternalBitDepthC)
MaxChromaFormatConstraint 0 For –profile=main-RExt, specifies the chroma-format to use for the general profile
constraints for RExt profiles; when 0, use the value of ChromaFormatIDC.
LowerBitRateConstraintFlag true Specifies the value of general_lower_bit_constraint_flag to use for RExt profiles.
Continued...
IntraPeriod (-ip) −1 Specifies the intra frame period. A value of −1 implies an infinite period.
DecodingRefreshType (-dr) 0 Specifies the type of decoding refresh to apply at the intra frame period picture.
0 Applies an I picture (not a intra random access point).
1 Applies a CRA intra random access point (open GOP).
2 Applies an IDR intra random access point (closed GOP).
3 Use recovery point SEI messages to indicate random access.
GOPSize (-g) 1 Specifies the size of the cyclic GOP structure.
ReWriteParamSetsFlag 1 When enabled, VPS, SPS and PPS are repeated in front of every IRAP picture.
FrameN Multiple options that define the cyclic GOP structure that will be used repeatedly
throughout the sequence. The table should contain GOPSize elements.
See section 3.1 for further details.
BipredSearchRange 4 Specifies the search range used for bi-prediction refinement in motion estimation.
ClipForBiPredMEEnabled 0 Enables clipping in the Bi-Pred ME, which prevents values over- or under-flowing.
It is usually disabled to reduce encoder run-time.
HadamardME true Enables or disables the use of the Hadamard transform in fractional-pel motion esti-
mation.
0 SAD for cost estimation
1 Hadamard for cost estimation
Continued...
ASR false Enables or disables the use of adaptive search ranges, where the motion search range
is dynamically adjusted according to the POC difference between the current and the
reference pictures.
( )
abs(POCcur−POCref)
SearchRange’ = Round SearchRange ∗ ADAPT_SR_SCALE ∗ RateGOPSize
LambdaModifierN (-LMN ) 1.0 Specifies a value that is multiplied with the Lagrange multiplier λ, for use in the
rate-distortion optimised cost calculation when encoding temporal layer N . If Lamb-
daModifierI is specified, then LambdaModifierI will be used for intra pictures.
N may be in the range 0 (inclusive) to 7 (exclusive).
LambdaModifierI (-LMI) Specifies one or more of the LambdaModifiers to use intra pictures at each of the
temporal layers. If not present, then the LambdaModifierN settings are used instead.
If the list of values (comma or space separated) does not include enough values for
each of the temporal layers, the last value is repeated as required.
IQPFactor (-IQF) -1 Specifies the QP factor to be used for intra pictures during the lambda computation.
(The values specified in the GOP structure are only used for inter pictures). If negative
(default), the following equation is used to derive the value:
IQPf actor = 0.57 ∗ (1.0 − M ax(0.5, M in(0.0, 0.05 ∗ s)))
where s = Int(isF ield?(GS − 1)/2 : GS − 1) and GS is the gop size.
ECU false Enables or disables the use of early CU determination. When enabled, skipped CUs
will not be split further.
CFM false Enables or disables the use of Cbf-based fast encoder mode. When enabled, once
a 2Nx2N CU has been evaluated, if the RootCbf is 0, further PU splits will not be
evaluated.
ESD false Enables or disables the use of early skip detection. When enabled, the skip mode will
be tested before any other.
FEN 0 Controls the use of different fast encoder coding tools. The following tools are sup-
ported in different combinations:
a In the SAD computation for blocks having size larger than 8, only the lines
of even rows in the block are considered.
b The number of iterations used in the bi-directional motion vector refinement
in the motion estimation process is reduced from 4 to 1.
Depending on the value of the parameter, the following combinations are supported:
0 Disable all modes
1 Use both a & b tools
2 Use only tool b
3 Use only tool a
FDM true Enables or disables the use of fast encoder decisions for 2Nx2N merge mode. When
enabled, the RD cost for the merge mode of the current candidate is not evaluated if
the merge skip mode was the best merge mode for one of the previous candidates.
RDpenalty 0 RD-penalty for 32x32 TU for intra in non-intra slices. Enabling this parameter can
reduce the visibility of CU boundaries in the coded picture.
0 No RD-penalty
1 RD-penalty
2 Maximum RD-penalty (no 32x32 TU)
QPIncrementFrame (-qpif) If a source file frame number is specified, the internal QP will be incremented for all
POCs associated with source frames beyond and including that frame. If empty, do
not increment.
IntraQPOffset 0 Specifies a QP offset from the base QP value to be used for intra frames.
LambdaFromQpEnable false When enabled, the λ, which is used to convert a cost in bits to a cost in distortion
terms, is calculated as:
λ = qpF actor × 2qp+6∗(bitDepthLuma−8)−12 , where qp is the slice QP and
qpF actor is calculated as follows:
= IQF if IQF >= 0 and slice is a periodic intra slice
= 0.57 × λscale if slice is a non-periodic intra slice
= value from GOP table otherwise
where IQF is the value specified using the IntraQPFactor option, and where λscale
is:
1 if LambdaFromQpEnable=true
1.0 − max(0, min(0.5, 0.05 ∗ B)) if LambdaFromQpEnable=false
where B is the number of B frames.
If LambdaFromQpEnable=false, then the λ is also subsequently scaled for non-top-
level hiearchical depths, as follows:
λ = λbase × max(2, min(4, (sliceQP − 12)/6))
In addition, independent on the IntraQPFactor, if HadamardME=false, then for an
inter slice the final λ is scaled by a factor of 0.95.
CbQpOffset (-cbqpofs) 0 Global offset to apply to the luma QP to derive the QP of Cb and Cr respectively.
CrQpOffset (-crqpofs) 0 These options correspond to the values of cb_qp_offset and cr_qp_offset, that are
transmitted in the PPS. Valid values are in the range [−12, 12].
LumaLevelToDeltaQPMappingLuma Specify luma values to use for the luma to delta QP mapping instead of using default
values. Default values are: 0, 301, 367, 434, 501, 567, 634, 701, 767, 834.
LumaLevelToDeltaQPMappingDQP Specify DQP values to use for the luma to delta QP mapping instead of using default
values. Default values are: -3, -2, -1, 0, 1, 2, 3, 4, 5, 6.
WCGPPSEnable 0 Enable the WCG PPS modulation of the chroma QP, rather than the slice, which,
unlike slice-level modulation, allows the deblocking process to consider the ad-
justment. To use, specify a fractional QP: the first part of the sequence will use
qpc = f loor(QP ) in the following calculation and PPS-0; the second part of the
sequence will use qpc = ceil(QP ) and PPS-1. The chromaQp that is then stored
in the PPS is given as: clip(round(W CGP P SXXQpScale ∗ baseCQp) +
XXQpOf f set) where baseCQp = (W CGP P SChromaQpScale ∗ qpc +
W CGP P SChromaQpOf f set). Note that the slices will continue to have a delta
QP applied.
WCGPPSChromaQpScale 0.0 Scale parameter for the linear chroma QP offset mapping used for WCG content.
WCGPPSChromaQpOffset 0.0 Offset parameter for the linear chroma QP offset mapping used for WCG content.
WCGPPSCbQpScale 1.0 Per chroma component QP scale factor depending on capture and representation color
WCGPPSCrQpScale space. For Cb component with BT.2020 container use 1.14; for BT.709 material and
1.04 for P3 material. For Cr component with BT.2020 container use 1.79; for BT.709
material and 1.39 for P3 material.
Continued...
SmoothQPReductionLimit -16.0 Threshold parameter for controlling amount of QP reduction by the QP reduction
model.
SmoothQPReductionPeriodicity 1 Periodicity parameter for application of the QP reduction model. 1: all frames, 0:
only intra pictures, 2: every second frame, etc.
BIM false Enable or disable Block Importance Mapping, QP adaptation depending on estimated
propagation of reference samples. Depends on future and past reference frames con-
figured for temporal filter.
SliceChromaQPOffsetPeriodicity 0 Defines the periodicity for inter slices that use the slice-level chroma QP offsets, as
defined by SliceCbQpOffsetIntraOrPeriodic and SliceCrQpOffsetIntraOrPeriodic. A
value of 0 disables the periodicity. It is intended to be used in low-delay configurations
where an regular intra period is not defined.
SliceCbQpOffsetIntraOrPeriodic 0 Defines the slice-level QP offset to be used for intra slices, or once every ’SliceChro-
SliceCrQpOffsetIntraOrPeriodic maQPOffsetPeriodicity’ pictures.
MaxCuDQPDepth (-dqd) 0 Defines maximum depth of a minimum CuDQP for sub-LCU-level delta QP. Max-
CuDQPDepth shall be greater than or equal to SliceGranularity.
DeltaQpRD (-dqr) 0 Specifies the maximum QP offset at slice level for multi-pass slice encoding. When
encoding, each slice is tested multiple times by using slice QP values in the range
[−DeltaQpRD, DeptaQpRD], and the best QP value is chosen as the slice QP.
MaxDeltaQP (-d) 0 Specifies the maximum QP offset at the largest coding unit level for the block-level
adaptive QP assignment scheme. In the encoder, each largest coding unit is tested
multiple times by using the QP values in the range [−MaxDeltaQP, MaxDeltaQP],
and the best QP value is chosen as the QP value of the largest coding unit.
dQPFile (-m) Specifies a file containing a list of QP deltas. The n-th line (where n is 0 for the first
line) of this file corresponds to the QP value delta for the picture with POC value n.
AdaptiveQp (-aq) false Enable or disable QP adaptation based upon a psycho-visual model.
AdaptiveQpSelection (-aqps) false Specifies whether QP values for non-I frames will be calculated on the fly based on
statistics of previously coded frames.
RecalculateQP... false Recalculate QP values according to lambda values. Do not suggest to be enabled in
AccordingToLambda all intra case.
MaxCUChromaQpAdjustmentDepth -1 Specifies the maximum depth for CU chroma QP adjustment; if negative, CU chroma
QP adjustment is disabled.
WaveFrontSynchro false Enables the use of specific CABAC probabilities synchronization at the beginning of
each line of CTBs in order to produce a bitstream that can be encoded or decoded
using one or more cores.
TileUniformSpacing false Controls the mode used to determine per row and column tile sizes.
0 Each tile column width and tile row height is explicitly set by TileColumn-
WidthArray and TileRowHeightArray respectively
1 Tile columns and tile rows are uniformly spaced.
NumTileColumnsMinus1 0 Specifies the tile based picture partitioning geometry as NumTileColumnsMinus1 +
NumTileRowsMinus1 1 × NumTileRowsMinus1 + 1 columns and rows.
TileColumnWidthArray Specifies a space or comma separated list of widths and heights, respectively, of each
TileRowHeightArray tile column or tile row. The first value in the list corresponds to the leftmost tile
column or topmost tile row.
LFCrossSliceBoundaryFlag true Enables or disables the use of in-loop filtering across slice boundaries.
LoopFilterOffsetInPPS false If enabled, the in-loop deblocking filter control parameters are sent in PPS. Otherwise,
the in-loop deblocking filter control parameters are sent in the slice segment header.
If deblocking filter parameters are sent in PPS, the same values of deblocking filter
parameters are used for all pictures in the sequence (i.e. deblocking parameter =
base parameter value). If deblocking filter parameters are sent in the slice segment
header, varying deblocking filter parameters can be specified by setting parameters
tcOffsetDiv2 and betaOffsetDiv2 in the GOP structure table. In this case, the final
value of the deblocking filter parameter sent for a certain GOP picture is equal to (base
parameter + GOP parameter for this picture). Intra-pictures use the base parameters
values.
LoopFilterTcOffset_div2 0 Specifies the base value for the in-loop deblocking filter parameter tc_offset_div2.
The final value of tc_offset_div2 shall be an integer number in the range −6..6.
LoopFilterBetaOffset_div2 0 Specifies the base value for the in-loop deblocking filter parameter beta_offset_div2.
The final value of beta_offset_div2 shall be an integer number in the range −6..6.
DeblockingFilterMetric 0 Specifies the use of a deblocking filter metric to evaluate the suitability of deblocking.
If non-zero then LoopFilterOffsetInPPS and LoopFilterDisable must be 0. Currently
excepted values are 0, 1 and 2.
LFCrossSliceBoundaryFlag true Enables or disables the use of a deblocking across tile boundaries.
SAO true Enables or disables the sample adaptive offset (SAO) filter.
TestSAODisableAtPictureLevel false Enables the testing of disabling SAO at the picture level after having analysed all
blocks.
SaoEncodingRate 0.75 When >0 SAO early picture termination is enabled for luma and chroma.
SaoEncodingRateChroma 0.5 The SAO early picture termination rate to use for chroma (when m_SaoEncodingRate
is >0). If <=0, use results for luma.
SAOLcuBoundary false Enables or disables SAO parameter estimation using non-deblocked pixels for LCU
bottom and right boundary areas.
ResetEncoderStateAfterIRAP true When true, resets the encoder’s decisions after an IRAP (POC order)
ConstrainedIntraPred false Enables or disables constrained intra prediction. Constrained intra prediction only
permits samples from intra blocks in the same slice as the current block to be used for
intra prediction.
FastUDIUseMPMEnabled true If enabled, adapt intra direction search, accounting for MPM
FastMEForGenBLowDelayEnabled true If enabled use a fast ME for generalised B Low Delay slices
TransquantBypassEnable false Enables or disables the ability to bypass the transform, quantization and filtering
stages at CU level. This option corresponds to the value of transquant_bypass_en-
abled_flag that is transmitted in the PPS.
See CUTransquantBypassFlagForce for further details.
CUTransquantBypassFlagForce 0 Controls the per CU transformation, quantization and filtering mode decision. This
option controls the value of the per CU cu_transquant_bypass_flag.
0 Bypass is searched on a CU-by-CU basis and will be used if the cost is lower
than not bypassing.
1 Bypass is forced for all CUs.
This option has no effect if TransquantBypassEnable is disabled.
PCMEnabledFlag false Enables or disables the use of PCM. The encoder will use cost measures on a CU-by-
CU basis to determine if PCM mode is to be applied.
PCMLog2MaxSize 5 Specifies log2 of the maximum PCM block size. When PCM is enabled, the PCM
(= log2 (32)) mode is available for 2Nx2N intra PUs smaller than or equal to the specified maximum
PCM block size
PCMLog2MinSize 3 Specifies log2 of the minimum PCM block size. When PCM is enabled, the PCM
mode is available for 2Nx2N intra PUs larger than or equal to the specified minimum
PCM block size.
When larger than PCMLog2MaxSize, PCM mode is not used.
PCMInputBitDepthFlag true If enabled specifies that PCM sample bit-depth is set equal to InputBitDepth. Other-
wise, it specifies that PCM sample bit-depth is set equal to InternalBitDepth.
PCMFilterDisableFlag false If enabled specifies that loop-filtering on reconstructed samples of PCM blocks is
skipped. Otherwise, it specifies that loop-filtering on reconstructed samples of PCM
blocks is not skipped.
Continued...
SignHideFlag (-SBH) true If enabled specifies that for each 4x4 coefficient group for which the number of co-
efficients between the first nonzero coefficient and the last nonzero coefficient along
the scanning line exceeds 4, the sign bit of the first nonzero coefficient will not be
directly transmitted in the bitstream, but may be inferred from the parity of the sum
of all nonzero coefficients in the current coefficient group.
StrongIntraSmoothing (-sis) true If enabled specifies that for 32x32 intra prediction block, the intra smoothing when
applied is either the 1:2:1 smoothing filter or a stronger bi-linear interpolation filter.
Key reference sample values are tested and if the criteria is satisfied, the stronger intra
smoothing filter is applied. If disabled, the intra smoothing filter when applied is the
1:2:1 smoothing filter.
TransformSkipFast false Enables or disables reduced testing of the transform-skipping mode decision for
chroma TUs. When enabled, no RDO search is performed for chroma TUs, instead
they are transform-skipped if the four corresponding luma TUs are also skipped.
This option has no effect if TransformSkip is disabled.
TemporalFilter false Enable motion-compensated temporal pre-filter. When enabled, at least one of Tem-
poralFilterPastRefs and TemporalFilterFutureRefs must be larger than 0.
TemporalFilterFutureRefs 4 Number of future frames used by the temporal filter. This may be set to 0 to avoid
using future frames.
FirstValidFrame 0 Index of first frame in video sequence that may be used by the temporal filter. If a
negative value is given, the index defaults to the value of FrameSkip.
LastValidFrame MAX_INT Index of last frame in video sequence that may be used by the temporal filter. If a
negative value is given, the index defaults to the value of FrameSkip + FramesTo-
BeEncoded - 1.
TemporalFilterStrengthFrame* Strength for every * frame in GOP based temporal filter, where * is an integer. E.g.
–TemporalFilterStrengthFrame8 0.95 will enable GOP based temporal filter at every
8th frame with strength 0.95. Longer intervals overrides shorter when there a multiple
matches.
KeepHierarchicalBit 0 Rate control: 0: equal bit allocation among pictures; 1: fix ratio hierarchical bit allo-
cation; 2: adaptive hierarchical ratio bit allocation. It is suggested to enable hierar-
chical bit allocation for hierarchical-B coding structure.
LCULevelRateControl true Rate control: true: LCU level RC; false: picture level RC.
RCLCUSeparateModel true Rate control: use LCU level separate R-lambda model or not. When LCULevelRate-
Control is equal to false, this parameter is meaningless.
Continued...
InitialQP 0 Rate control: initial QP value for the first picture. 0 to auto determine the initial QP
value.
RCCpbSaturation false Rate control: enable target bits saturation to avoid CPB overflow and underflow or
not.
RCInitialCpbFullness 0.9 Rate control: ratio of initial CPB fullness per CPB size. (InitalCpbFullness/CpbSize)
RCInitialCpbFullness should be smaller than or equal to 1.
AspectRatioIdc 0 aspect_ratio_idc
OverscanAppropriate false Indicates whether cropped decoded pictures are suitable for display using overscan.
0 Indicates that the decoded pictures should not be displayed using overscan.
1 Indicates that the decoded pictures may be displayed using overscan.
VideoSignalTypePresent false Signals whether video_format, video_full_range_flag, and colour_description_-
present_flag are present.
VideoFullRange false Indicates the black level and range of luma and chroma signals.
0 Indicates that the luma and chroma signals are to be scaled prior to display.
1 Indicates that the luma and chroma signals are not to be scaled prior to display.
ColourDescriptionPresent false Signals whether colour_primaries, transfer_characteristics and matrix_coefficients
are present.
MatrixCoefficients 2 Describes the matrix coefficients used in deriving luma and chroma from RGB pri-
maries.
NeutralChromaIndication false Indicates that the value of all decoded chroma samples is equal to 1«(BitDepthCr-1).
FrameFieldInfoPresentFlag false Specificies the value of the VUI syntax element ‘frame_field_info_present_flag’,
which indicates that pic_struct and field coding related values are present in picture
timing SEI messages.
PocProportionalToTimingFlag false Specificies the value of the VUI syntax element ‘vui_poc_proportional_to_timing_-
flag’, which indicates that the POC value is proportional to the output time with re-
spect to the first picture in the CVS.
TilesFixedStructure false Indicates that each active picture parameter set has the same values of the syntax
elements related to tiles.
MotionVectorsOverPicBoundaries false Indicates that no samples outside the picture boundaries are used for inter prediction.
MaxBytesPerPicDenom 2 Indicates a number of bytes not exceeded by the sum of the sizes of the VCL NAL
units associated with any coded picture.
MaxBitsPerMinCuDenom 1 Indicates an upper bound for the number of bits of coding_unit() data.
Log2MaxMvLengthVertical 15 Indicate the maximum absolute value of a decoded vertical MV component in quarter-
pel luma units.
CrossComponentPrediction false When true, specifies the use of the cross component prediction tool (4:4:4 processing
only). Version 1 and some Version 2 (RExt) profiles require this to be false.
ReconBasedCrossCPredictionEstimate false If true, then when determining the alpha value for cross-component prediction, use
the reconstructed residual rather than the pre-transform encoder-side residual
SaoLumaOffsetBitShift 0 Specifies the shift to apply to the SAO parameters. If negative, an estimate will be
SaoChromaOffsetBitShift 0 calculated based upon the initial QP. Version 1 and some Version 2 (RExt) profiles
require this to be 0.
TransformSkipLog2MaxSize 2 Specifies the maximum TU size for which transform-skip can be used; the minimum
value is 2. Version 1 and some Version 2 (RExt) profiles require this to be 2.
ImplicitResidualDPCM false When true, specifies the use of the implicitly signalled residual RDPCM tool (for
intra). Version 1 and some Version 2 (RExt) profiles require this to be false.
ExplicitResidualDPCM false When true, specifies the use of the explicitly signalled residual RDPCM tool (for
intra-block-copy and inter). Version 1 and some Version 2 (RExt) profiles require
this to be false.
Continued...
ResidualRotation false When true, specifies the use of the residual rotation tool. Version 1 and some Version
2 (RExt) profiles require this to be false.
SingleSignificanceMapContext false When true, specifies the use of a single significance map context for transform-
skipped and transquant-bypassed TUs. Version 1 and some Version 2 (RExt) profiles
require this to be false.
GolombRiceParameterAdaptation false When true, enable the adaptation of the Golomb-Rice parameter over the course of
each slice. Version 1 and some Version 2 (RExt) profiles require this to be false.
AlignCABACBeforeBypass false When true, align the CABAC engine to a defined fraction of a bit prior to coding
bypass data (including sign bits) when coeff_abs_level_remaining syntax elements
are present in the group. This must always be true for the high-throughput-RExt
profile, and false otherwise.
IntraReferenceSmoothing true When true, enable intra reference smoothing, otherwise disable it. Version 1 and some
Version 2 (RExt) profiles require this to be true.
Continued...
SEIBufferingPeriod 0 Enables or disables the insertion of the Buffering period SEI messages. This op-
tion has no effect if VuiParametersPresent is disabled. SEIBufferingPeriod requires
SEIActiveParameterSets to be enabled.
SEIPictureTiming 0 Enables or disables the insertion of the Picture timing SEI messages. This option has
no effect if VuiParametersPresent is disabled.
SEIRecoveryPoint 0 Enables or disables the insertion of the Recovery point SEI messages.
SEIFGCEnabled 0 Enables or disables the insertion of the film grain characteristics SEI message.
SEIFGCCancelFlag 0 Specifies the persistence of any previous film grain characteristics SEI message in
output order. For SMPTE-RDD5, the value must be 0.
SEIFGCPersistenceFlag 0 Specifies the persistence of the film grain characteristics SEI message for the current
layer. For SMPTE-RDD5, the value must be 0.
SEIFGCModelID 0 Specifies the film grain simulation model. For SMPTE-RDD5, the value must be 0.
0 frequency filtering
1 auto-regression
SEIFGCSepColourDescPresentFlag 0 Specifies the presence of a distinct colour space description for the film grain charac-
teristics specified in the SEI message. For SMPTE-RDD5, the value must be 0.
SEIFGCBlendingModeID 0 Specifies the blending mode used to blend the simulated film grain with the decoded
images. For SMPTE-RDD5, the value must be 0.
0 additive
1 multiplicative
SEIFGCLog2ScaleFactor 6 Specifies a scale factor used in the film grain characterization equations.
SEIFGCIntensityIntervalLowerBoundComp0 10 110 Specifies the lower bound of intensity interval for comp 0 (for SMPTE-RDD5, non-
overlapping interval)
SEIFGCIntensityIntervalLowerBoundComp1 10 110 210 Specifies the lower bound of intensity interval for comp 1 (for SMPTE-RDD5, non-
overlapping interval)
SEIFGCIntensityIntervalLowerBoundComp2 10 60 110 210 Specifies the lower bound of intensity interval for comp 2 (for SMPTE-RDD5, non-
overlapping interval)
SEIFGCIntensityIntervalUpperBoundComp0 100 250 Specifies the upper bound of intensity interval for comp 0 (for SMPTE-RDD5, non-
overlapping interval)
SEIFGCIntensityIntervalUpperBoundComp1 100 200 250 Specifies the upper bound of intensity interval for comp 1 (for SMPTE-RDD5, non-
overlapping interval)
SEIFGCIntensityIntervalUpperBoundComp2 50 100 200 250 Specifies the upper bound of intensity interval for comp 2 (for SMPTE-RDD5, non-
overlapping interval)
SEIFGCCompModelValuesComp0 100 150 Specifies the model values for each intensity interval for comp 0 (sigma, h, v (h,v
might be inferred based on number of model value))
SEIFGCCompModelValuesComp1 100 2 2 120 12 12 140 14 14 Specifies the model values for each intensity interval for comp 1 (sigma, h, v (h,v
might be inferred based on number of model value))
Continued...
SEIFGCCompModelValuesComp2 160 4 4 200 6 6 240 11 11 250 13 13 Specifies the model values for each intensity interval for comp 2 (sigma, h, v (h,v
might be inferred based on number of model value))
SEIToneMappingInfo 0 Enables or disables the insertion of the Tone Mapping SEI message.
SEIToneMapCancelFlag false Indicates that Tone Mapping SEI message cancels the persistance or follows.
SEIToneMapPersistenceFlag true Specifies the persistence of the Tone Mapping SEI message.
SEIToneMapModelId 0 Specifies Model utilized for mapping coded data into target_bit_depth range.
0 linear mapping with clipping
1 sigmoidal mapping
2 user-defined table mapping
3 piece-wise linear mapping
4 luminance dynamic range mapping
SEIToneMapMinValue 0 Specifies the minimum value in mode 0.
SEIToneMapStartOfCodedInterval Array of user-defined mapping table. Default table can be set to the following:
0 12 24 36 48 60 72 84 96 108 120 132 144 156 168 180
192 192 196 204 208 216 220 228 232 240 248 252 260 264
272 276 284 292 292 296 300 304 308 312 320 324 328 332
336 344 348 352 356 360 368 372 376 380 384 388 396 400
404 408 412 420 424 428 432 436 444 444 444 448 452 456
460 464 468 472 476 476 480 484 488 492 496 500 504 508
508 512 516 520 524 528 532 536 540 540 544 548 552 556
560 564 568 572 572 576 580 584 588 592 596 600 604 604
608 612 616 620 624 628 632 636 636 640 644 648 652 656
660 664 668 672 672 672 676 680 680 684 688 692 692 696
700 704 704 708 712 716 716 720 724 724 728 732 736 736
740 744 748 748 752 756 760 760 764 768 768 772 776 780
780 784 788 792 792 796 800 804 804 808 812 812 816 820
824 824 828 832 836 836 840 844 848 848 852 856 860 860
860 864 864 868 872 872 876 880 880 884 884 888 892 892
896 900 900 904 908 908 912 912 916 920 920 924 928 928
932 936 936 940 940 944 948 948 952 956 956 960 964 964
968 968 972 976 976 980 984 984 988 992 992 996 996 1000
1004 1004 1008 1012 1012 1016 1020 1024
SEIToneMapNumPivots 0 Specifies the number of pivot points in mode 3.
SEIToneMap... 400 Specifies the exposure index setting of the cameran of Extended_ISO.
ExposureIndexValue
SEIToneMapExposure... 0 Specifies the sign of ExposureCompensationValue.
CompensationValueSignFlag
SEIToneMapExposure... 0 Specifies the numerator of ExposureCompensationValue.
CompensationValueNumerator
SEIToneMapExposure... 2 Specifies the denominator of ExposureCompensationValue.
CompensationValueDenomIdc
SEIToneMapRef... 350 Specifies reference screen brightness setting in units of candela per square metre.
ScreenLuminanceWhite
SEIToneMapExtended... 800 Indicates the luminance dynamic range.
RangeWhiteLevel
SEIToneMapNominal... 16 Specifies luma sample value of the nominal black level assigned decoded pictures.
BlackLevelLumaCodeValue
SEIToneMapNominal... 235 Specifies luma sample value of the nominal white level assigned decoded pictures.
WhiteLevelLumaCodeValue
SEIToneMapExtended... 300 Specifies luma sample value of the extended dynamic range assigned decoded pic-
WhiteLevelLumaCodeValue tures.
SEIFramePacking 0 Enables or disables the insertion of the Frame packing arrangement SEI messages.
SEIFramePackingType 0 Indicates the arrangement type in the Frame packing arrangement SEI message. This
option has no effect if SEIFramePacking is disabled.
3 Side by Side
4 Top Bottom
5 Frame Alternate
SEIFramePackingInterpretation 0 Indicates the constituent frames relationship in the Frame packing arrangement SEI
message. This option has no effect if SEIFramePacking is disabled.
0 Unspecified
1 Frame 0 is associated with the left view of a stereo pair
2 Frame 0 is associated with the right view of a stereo pair
SEIFramePackingQuincunx 0 Enables or disables the quincunx_sampling signalling in the Frame packing arrange-
ment SEI messages. This option has no effect if SEIFramePacking is disabled.
SEIFramePackingId 0 Indicates the session number in the Frame packing arrangement SEI messages. This
option has no effect if SEIFramePacking is disabled.
SEIDisplayOrientation 0 Enables or disables the insertion of the Display orientation SEI messages.
0 Disabled
N: 0 < N < (216 − 1) Enable display orienta-
tion SEI message with
anticlockwise_rotation = N and
display_orientation_repetition_period = 1
SEIGreenMetadataType 0 Specifies the type of metadata that is present in the SEI message.
0 Reserved
1 Metadata enabling quality recovery after low-power encod-
ing is present
SEIXSDMetricType 0 Indicates the type of the objective quality metric.
0 PSNR is used as objective quality metric
SEISOPDescription 0 Enables or disables the insertion of the Structure of pictures information SEI mes-
sages.
SEIActiveParameterSets 0 Enables or disables the insertion of the Active parameter sets SEI messages.
SEIDecodingUnitInfo 0 Enables or disables the insertion of the Decoding unit information SEI messages. This
option has no effect if VuiParametersPresent is disabled.
Table 29: Temporal sub-layer zero index SEI message encoder parameters
SEITemporalLevel0Index 0 Enables or disables the insertion of the Temporal level zero index SEI messages.
SEIDecodedPictureHash 0 Enables or disables the calculation and insertion of the Decoded picture hash SEI
messages.
0 Disabled
1 Transmits MD5 in SEI message and writes the value to the
encoder log
2 Transmits CRC in SEI message and writes the value to the
encoder log
3 Transmits checksum in SEI message and writes the value to
the encoder log
SEIScalableNesting 0 Enables or disables the use of the scalable nesting SEI messages.
SEIGradualDecodingRefreshInfo 0 Enables or disables the insertion of the Gradual decoding refresh information SEI
messages.
SEINoDisplay 0 When non-zero, generate no-display SEI message for temporal layer N or higher.
SEITimeCodeEnabled false When true (non-zero), generate Time code SEI messages.
SEITimeCodeTimeStampFlag Time stamp flag associated to each time set (comma or space separated list of entries).
SEITimeCodeFieldBasedFlag Field based flag associated to each time set (comma or space separated list of entries).
SEITimeCodeCountingType Counting type associated to each time set (comma or space separated list of entries).
SEITimeCodeFullTsFlag Full time stamp flag associated to each time set (comma or space separated list of
entries).
SEITimeCodeDiscontinuityFlag Discontinuity flag associated to each time set (comma or space separated list of en-
tries).
SEITimeCodeCntDroppedFlag Counter dropped flag associated to each time set (comma or space separated list of
entries).
SEITimeCodeNumFrames Number of frames associated to each time set (comma or space separated list of en-
tries).
SEITimeCodeSecondsFlag Flag to signal seconds value presence in each time set (comma or space separated list
of entries).
SEITimeCodeMinutesFlag Flag to signal minutes value presence in each time set (comma or space separated list
of entries).
SEITimeCodeHoursFlag Flag to signal hours value presence in each time set (comma or space separated list of
entries).
SEITimeCodeSecondsValue Seconds value for each time set (comma or space separated list of entries).
SEITimeCodeMinutesValue Minutes value for each time set (comma or space separated list of entries).
SEITimeCodeHoursValue Hours value for each time set (comma or space separated list of entries).
SEITimeCodeOffsetLength Time offset length associated to each time set (comma or space separated list of en-
tries).
SEITimeCodeTimeOffset Time offset associated to each time set (comma or space separated list of entries).
SEIMasteringDisplayColourVolume false When true (non-zero), generate Mastering display colour volume SEI message.
SEIMasteringDisplayMaxLuminance 10000 Specifies the mastering display maximum luminance value in units of 1/10000 can-
dela per square metre.
SEIMasteringDisplayMinLuminance 0 Specifies the mastering display minimum luminance value in units of 1/10000 candela
per square metre.
SEIMasteringDisplayPrimaries 0,50000, 0,0, 50000,0 Mastering display primaries for all three colour planes in CIE xy coordinates in in-
crements of 1/50000 (results in the ranges 0 to 50000 inclusive).
SEIMasteringDisplayWhitePoint 16667, 16667 Mastering display white point CIE xy coordinates in normalized increments of
1/50000 (e.g. 0.333 = 16667).
Table 36: Segmented rectangular frame packing arrangement SEI message encoder parameters
SEISegmentedRectFramePackingCancel false If true, cancels the persistence of any previous SRFPA SEI message.
SEISegmentedRectFramePackingPersistence false If false the SEI applies to the current frame only.
Table 37: Temporal motion-constrained tile sets SEI message encoder parameters
SEITempMotionConstrainedTileSets false When true (non-zero), generates example temporal motion constrained tile sets SEI
messages.
SEITMCTSTileConstraint false When true (non-zero), the following encoding settings are enabled:
• mc_all_tiles_exact_sample_value_match_flag and each_tile_one_tile_set_-
flag will be set equal to one int the temporal motion constrained tile sets SEI
message
• Motion vectors are constrained to not cross tile boundaries
• TMVP and merge mode are constrained to not cross tile boundaries
• LFCrossTileBoundaryFlag will be disabled
Table 38: Chroma resampling filter hint SEI message encoder parameters
SEIChromaResamplingFilterHint false When true (non-zero), generates example chroma sampling filter hint SEI messages.
SEIKneeFunctionInfo false Enables (true) or disables (false) the insertion of the Knee function SEI messages.
SEIKneeFunctionCancelFlag false Indicates that Knee function SEI message cancels the persistance (true) or follows
(false).
SEIKneeFunctionPersistenceFlag true Specifies the persistence of the Knee function SEI message.
SEIKneeFunctionInputDrange 1000 Specifies the peak luminance level for the input picture of Knee function SEI mes-
sages.
SEIKneeFunctionInputDispLuminance 100 Specifies the expected display brightness for the input picture of Knee function SEI
messages.
SEIKneeFunctionOutputDrange 4000 Specifies the peak luminance level for the output picture of Knee function SEI mes-
sages.
SEIKneeFunctionOutputDispLuminance 800 Specifies the expected display brightness for the output picture of Knee function SEI
messages.
SEIKneeFunctionInputKneePointValue Array of input knee point. Default table can be set to the following:
600 800 900
SEIKneeFunctionOutputKneePointValue Array of output knee point. Default table can be set to the following:
100 250 450
SEIColourRemappingInfoFileRoot (-cri) Specifies the prefix of input Colour Remapping Information file. Prefix is completed
by “_x.txt” where x is the POC number. The contents of the file are a list of the SEI
message’s syntax element names (in decoding order) immediately followed by a ‘:’
and then the associated value. An example file can be found in cfg/misc/example_-
colour_remapping_sei_encoder_0.txt.
Table 41: Content light level info SEI message encoder parameters
SEICLLEnabled false Enables or disables the insertion of the content light level SEI message.
SEICLLMaxContentLightLevel 4000 When not equal to 0, specifies an upper bound on the maximum light level among
all individual samples in a 4:4:4 representation of red, green, and blue colour primary
intensities in the linear light domain for the pictures of the CLVS, in units of candelas
per square metre. When equal to 0, no such upper bound is indicated.
SEICLLMaxPicAvgLightLevel 0 When not equal to 0, specifies an upper bound on the maximum average light level
among the samples in a 4:4:4 representation of red, green, and blue colour primary
intensities in the linear light domain for any individual picture of the CLVS, in units
of candelas per square metre. When equal to 0, no such upper bound is indicated.
SEIPreferredTransferCharacteristics 18 Indicates a preferred alternative value for the transfer_characteristics syntax element
that is indicated by the colour description syntax of VUI parameters.
SEIAVEEnabled false Enables or disables the insertion of the ambient viewing environment SEI message.
SEIAVEAmbientIlluminance 100000 Specifies the environmental illuminance of the ambient viewing environment in units
of 1/10000 lux. The value shall not be 0.
SEIAVEAmbientLightX 15635 Specifies the x chromaticity coordinate, according to the CIE 1931 definition, of the
environmental ambient light in the nominal viewing environment in normalized in-
crements of 1/50000. The value shall be in the range of 0 to 50,000, inclusive.
SEIAVEAmbientLightY 16450 Specifies the y chromaticity coordinate, according to the CIE 1931 definition, of the
environmental ambient light in the nominal viewing environment in normalized in-
crements of 1/50000. The value shall be in the range of 0 to 50,000, inclusive.
SEICCVEnabled false Enables or disables the insertion of the content colour volume SEI message.
SEICCVCancelFlag false Specifies the persistence of any previous content colour volume SEI message in output
order.
SEICCVPersistenceFlag true Specifies the persistence of the content colour volume SEI message for the current
layer.
SEICCVPrimariesPresent true Specifies whether the CCV primaries are present in the content colour volume SEI
message.
m_ccvSEIPrimariesX0 0.300 Specifies the x coordinate, according to the CIE 1931 definition, of the first (green)
colour primary component in normalized increments of 1/50000.
m_ccvSEIPrimariesY0 0.600 Specifies the y coordinate, according to the CIE 1931 definition, of the first (green)
colour primary component in normalized increments of 1/50000.
m_ccvSEIPrimariesX1 0.150 Specifies the x coordinate, according to the CIE 1931 definition, of the second (blue)
colour primary component in normalized increments of 1/50000.
m_ccvSEIPrimariesY1 0.060 Specifies the y coordinate, according to the CIE 1931 definition, of the second (blue)
colour primary component in normalized increments of 1/50000.
m_ccvSEIPrimariesX2 0.640 Specifies the x coordinate, according to the CIE 1931 definition, of the third (red)
colour primary component in normalized increments of 1/50000.
m_ccvSEIPrimariesY2 0.330 Specifies the y coordinate, according to the CIE 1931 definition, of the third (red)
colour primary component in normalized increments of 1/50000.
SEICCVMinLuminanceValuePresent true Specifies whether the CCV min luminance value is present in the content colour vol-
ume SEI message.
SEICCVMinLuminanceValue 0.0 specifies the CCV min luminance value in the content colour volume SEI message.
SEICCVMaxLuminanceValuePresent 1 Specifies whether the CCV max luminance value is present in the content colour vol-
ume SEI message.
SEICCVMaxLuminanceValue 0.1 specifies the CCV max luminance value in the content colour volume SEI message.
SEICCVAvgLuminanceValuePresent 1 Specifies whether the CCV avg luminance value is present in the content colour vol-
ume SEI message.
SEICCVAvgLuminanceValue 0.01 specifies the CCV avg luminance value in the content colour volume SEI message.
SEIErpEnabled false Enables (true) or disables (false) the insertion of equirectangular projection SEI mes-
sage.
SEIErpCancelFlag true Indicates that equirectangular projection SEI message cancels the persistence (true)
or follows (false).
SEIErpPersistenceFlag false Specifies the persistence of the equirectangular projection SEI message.
SEIErpGuardBandFlag false Indicates the existence of guard band areas in the constituent picture.
SEIErpLeftGuardBandWidth 0 Inicates the width of the guard band on the left side of the onstituent picture.
SEIErpRightGuardBandWidth 0 Inicates the width of the guard band on the right side of the onstituent picture.
SEICmpEnabled false Enables (true) or disables (false) the insertion of cubemap projection SEI message.
SEICmpCancelFlag true Indicates that cubemap projection SEI message cancels the persistence (true) or fol-
lows (false).
SEICmpPersistenceFlag false Specifies the persistence of the Cubemap Projection SEI message.
SEISphereRotationEnabled false Enables (true) or disables (false) the insertion of sphere rotation SEI message.
SEISphereRotationCancelFlag true Indicates that the sphere rotation SEI message cancels the persistence (true) or follows
(false).
SEISphereRotationPersistenceFlag false Specifies the persistence of the sphere rotation SEI message.
SEIRwpEnabled false Enables (true) or disables (false) the insertion of region-wise packing SEI message.
SEIRwpCancelFlag true Indicates that RWP SEI message cancels the persistence (true) or follows (false).
SEIRwpConstituentPictureMatchingFlag false Specifies the RWP SEI message applies individually to each constituent picture (true)
or to the projected picture (false).
SEIRwpNumPackedRegions 0 Specifies the number of packed regions when constituent picture matching flag is
equal to 0.
Continued...
SEIRwpTransformType An array that specifies the rotation and mirroring to be applied to the packed regions.
SEIRwpGuardBandFlag An array that specifies the existence of guard band in the packed regions.
SEIRwpGuardBandFlag An array that specifies the existence of guard band in the packed regions.
SEIRwpProjRegionTop An array that specifies the top sample row of the projected regions.
SEIRwpProjRegionLeft An array that specifies the left-most sample column of the projected regions.
SEIRwpPackedRegionTop An array that specifies the top luma sample row of the packed regions.
SEIRwpPackedRegionLeft An array that specifies the left-most luma sample column of the packed regions.
SEIRwpLeftGuardBandWidth An array that specifies the width of the guard band on the left side of the packed
regions.
SEIRwpRightGuardBandWidth An array that specifies the width of the guard band on the right side of the packed
regions.
SEIRwpTopGuardBandHeight An array that specifies the height of the guard band above the packed regions.
SEIRwpBottomGuardBandHeight An array that specifies the height of the guard band below the packed regions.
SEIRwpGuardBandNotUsedForPredFlag An array that specifies if the guard bands is used in the inter prediction process.
SEIRwpGuardBandType An array that specifies the type of the guard bands for the packed regions.
SEIOmniViewportEnabled false Enables (true) or disables (false) the insertion of omni viewport SEI message.
SEIOmniViewportId 0 Contains an identifying number that may be used to identify the purpose of the one
or more recommended viewport regions.
SEIOmniViewportCancelFlag true Indicates that the omni viewport SEI message cancels the persistence (true) or follows
(false).
SEIOmniViewportPersistenceFlag false Specifies the persistence of the omni viewport SEI message.
SEIOmniViewportAzimuthCentre An array that indicates the centre of the i-th recommended viewport region.
SEIOmniViewportElevationCentre An array that indicates the centre of the i-th recommended viewport region.
SEIOmniViewportTiltCentre An array that indicates the tilt angle of the i-th recommended viewport region.
SEIOmniViewportHorRange An array that indicates the azimuth range of the i-th recommended viewport region.
SEIOmniViewportVerRange An array that indicates the elevation range of the i-th recommended viewport region.
SEIMctsExtractInfoSet false When true (non-zero), generates example motion-constrained tile sets extraction in-
formation sets SEI message. with the following settings:
• SliceMode will be set to 0 and SliceArgument will be set to 1 (Enforcing one
slice per tile).
• Extraction Info will be generated applying to each individual MCTS in the
bitstream.
SEISEIManifestEnabled false Enables (true) or disables (false) the SEI manifest SEI message.
SEISEIPrefixIndicationEnabled false Enables (true) or disables (false) the SEI prefix indication SEI message.
SEIShutterIntervalEnabled false Enables or disables the insertion of the shutter interval info SEI message.
SEISiiNumUnitsInShutterInterval 1080000 Specifies the number of time units of a clock operating at the frequency sii_time_scale
Hz that corresponds to one increment of an shutter clock tick counter.
SEISiiTimeScale 27000000 Specifies the number of time units that pass in one second.
SEISiiMaxSubLayersMinus1 0 The value plus 1 specifies the maximum number of temporal sub-layers that may be
present in each CVS referring to the SPS. The value shall be in the range of 0 to 6.
SEISiiFixedShutterIntervalWithinCVSFlag true Specifies if shutter interval info is the same for all temporal sub-layers in the CVS.
SEIShutterIntervalPreFilename (-sii) Specifies the file name of pre-processed video with shutter interval info SEI message.
If empty, not output video.
TypeDef.h
Numerous constants that guard individual adoptions are defined within source/Lib/TLibCommon/TypeDef.h.
ReconFile (-o) Defines reconstructed YUV file name. If empty, no file is generated.
MaxTemporalLayer (-t) -1 Defines the maximum temporal layer to be decoded. If -1, then all layers are decoded.
TarDecLayerIdSetFile (-l) Specifies the targetDecLayerIdSet file name. The file would contain white-space sep-
arated LayerId values of the layers that are to be decoded. Omitting the parameter, or
using a value of -1 in the file decodes all layers.
OutputBitDepth (-d) 0 Specifies the luma bit-depth of the reconstructed YUV file (the value 0 indicates that
(Native) the native bit-depth is used)
OutputBitDepthC 0 Defines the chroma bit-depth of the reconstructed YUV file (the value 0 indicates that
(Native) the native bit-depth is used)
SEIDecodedPictureHash 1 Enable or disable verification of any Picture hash SEI messages. When this parameter
is set to 0, the feature is disabled and all messages are ignored. When set to 1 (default),
the feature is enabled and the decoder has the following behaviour:
• If Picture hash SEI messages are included in the bit stream, the same type
of hash is calculated for each decoded picture and written to the log together
with an indication whether the calculted value matches the value in the SEI
message. Decoding will continue even if there is a mismatch.
• After decoding is complete, if any MD5sum comparison failed, a warning is
printed and the decoder exits with the status EXIT_FAILURE
• The per-picture MD5 log message has the following for-
mats: [MD5:d41d8cd98f00b204e9800998ecf8427e,(OK)],
[MD5:d41d8cd98f00b204e9800998ecf8427e,(unk)],
[MD5:d41d8cd98f00b204e9800998ecf8427e,(***ERROR***)]
[rxMD5:b9e1...] where, “(unk)” implies that no MD5 was signalled
for this picture, “(OK)” implies that the decoder agrees with the signalled
MD5, “(***ERROR***)” implies that the decoder disagrees with the
signalled MD5. “[rxMD5:...]” is the signalled MD5 if different.
OutputDecodedSEIMessagesFilename When a non-empty file name is specified, information regarding any decoded SEI
messages will be output to the indicated file. If the file name is ’-’, then stdout is used
instead.
SEIColourRemappingInfoFilename Specifies that the colour remapping SEI message should be applied to the output
video, with the output written to this file. If no value is specified, the SEI message is
ignored and no mapping is applied.
SEINoDisplay false When true, do not output frames for which there is an SEI NoDisplay message.
Continued...
ClipOutputVideoToRec709Range 0 If 1 then clip output video to the Rec. 709 Range on saving when OutputBitDepth is
less than InternalBitDepth.
5.1.1 General
TargetMCTSIdx (-d) 0 Target MCTS index to be extracted from input bitstream to output sub-bitstream.