Skip to content
Snippets Groups Projects
software-manual.tex 168 KiB
Newer Older
Enables or disables the use of bi-directional optical flow (BDOF).
Yan Zhang's avatar
Yan Zhang committed
\Option{LMCSEnable} &
%\ShortOption{\None} &
\Default{true} &
Enables or disables the use of LMCS (luma mapping with chroma scaling).
\\

\Option{LMCSSignalType} &
%\ShortOption{\None} &
\Default{0} &
LMCS signal type: 0:SDR, 1:HDR-PQ, 2:HDR-HLG.
\\

\Option{LMCSUpdateCtrl} &
%\ShortOption{\None} &
\Default{0} &
LMCS model update control: 0:RA, 1:AI, 2:LDB/LDP.
\par
\begin{tabular}{cp{0.45\textwidth}}
	0 & Random access: derive a new LMCS model at each IRAP.\\
	1 & All intra: derive a new LMCS model at each intra slice.\\
	2 & Low delay: derive a new LMCS model every second. \\
\end{tabular}
\\

\Option{LMCSAdpOption} &
%\ShortOption{\None} &
\Default{0} &
Adaptive LMCS mapping derivation options: Options 1 to 4 are for experimental testing purposes and need to set parameter LMCSInitialCW.
\par
\begin{tabular}{cp{0.45\textwidth}}
	0 & Automatic adaptive algorithm (default).\\
	1 & Derives LMCS mapping with input LMCSInitialCW and enables LMCS for all slices. Uses a static LMCS mapping for low QP ($QP<=22$). \\
	2 & Derives LMCS mapping with input LMCSInitialCW and enables LMCS only for slices in lowest temporal layer. \\
	3 & In addition to 1, disables LMCS for intra slices. \\
	4 & Derives LMCS mapping with input LMCSInitialCW and enables LMCS only for inter slices. \\
\end{tabular}
\\

\Option{LMCSInitialCW} &
%\ShortOption{\None} &
\Default{0} &
LMCS initial total codeword (valid values [$0 - 1023$]) to be used in LMCS mapping derivation when LMCSAdpOption is not equal to 0.
\\

\Option{LMCSOffset} &
%\ShortOption{\None} &
\Default{0} &
Specifies the LMCS chroma residual scaling offset. This parameter corresponds to the value of lmcsDeltaCrs, derived from lmcs_delta_sign_crs_flag and lmcs_delta_abs_crs, that are transmitted in the APS. Valid values are in the range [-7;7].
\\

\Option{ColorTransform} &
%\ShortOption{\None} &
\Default{false} &
Enables or disables the use of adaptive color transform (ACT).
\\

\Option{HorCollocatedChroma} &
%\ShortOption{\None} &
\Default{true} &
Specifies location of a chroma sample relatively to the luma sample in horizontal direction in the reference picture resampling.
\par
\begin{tabular}{cp{0.45\textwidth}}
	0 & horizontally shifted by 0.5 units of luma samples.\\
	1 & collocated (default). \\
\end{tabular}
\\

\Option{VerCollocatedChroma} &
%\ShortOption{\None} &
\Default{false} &
Specifies location of a chroma sample relatively to the luma sample in vertical direction in the cross-component linear model intra prediction and the reference picture resampling.
\par
\begin{tabular}{cp{0.45\textwidth}}
	0 & vertically shifted by 0.5 units of luma samples (default).\\
	1 & collocated. \\
\end{tabular}
\\

\Option{TSRCdisableLL} &
%\ShortOption{\None} &
\Default{1} &
Enables or disables the use of Transform Skip Residual Coding for lossless compression.
\\

Yan Zhang's avatar
Yan Zhang committed
\end{OptionTableNoShorthand}

%%
%% Rate control parameters
%%

\begin{OptionTableNoShorthand}{Rate control parameters}{tab:rate-control}

\Option{RateControl} &
%\ShortOption{\None} &
\Default{false} &
Rate control: enables rate control or not.
\\

\Option{TargetBitrate} &
%\ShortOption{\None} &
\Default{0} &
Rate control: target bitrate, in bps.
\\

\Option{KeepHierarchicalBit} &
%\ShortOption{\None} &
\Default{0} &
Rate control: 0: equal bit allocation among pictures;
1: fix ratio hierarchical bit allocation; 2: adaptive hierarchical ratio bit allocation.
It is suggested to enable hierarchical bit allocation for hierarchical-B coding structure.
\\

\Option{LCULevelRateControl} &
%\ShortOption{\None} &
\Default{true} &
Rate control: true: LCU level RC; false: picture level RC.
\\

\Option{RCLCUSeparateModel} &
%\ShortOption{\None} &
\Default{true} &
Rate control: use LCU level separate R-lambda model or not.
When LCULevelRateControl is equal to false, this parameter is meaningless.
\\

\Option{InitialQP} &
%\ShortOption{\None} &
\Default{0} &
Rate control: initial QP value for the first picture.
0 to auto determine the initial QP value.
\\

\Option{RCForceIntraQP} &
%\ShortOption{\None} &
\Default{false} &
Rate control: force intra QP to be equal to initial QP or not.
\\

\Option{RCCpbSaturation} &
%\ShortOption{\None} &
\Default{false} &
Rate control: enable target bits saturation to avoid CPB overflow and underflow or not.
\\

\Option{RCCpbSize} &
%\ShortOption{\None} &
\Default{0} &
Rate control: CPB size, in bps.
\\

\Option{RCInitialCpbFullness} &
%\ShortOption{\None} &
\Default{0.9} &
Rate control: ratio of initial CPB fullness per CPB size. (InitalCpbFullness/CpbSize)
RCInitialCpbFullness should be smaller than or equal to 1.
\\
\end{OptionTableNoShorthand}



%%
%% Encoder debug parameters
%%
\begin{OptionTableNoShorthand}{Encoder debug parameters}{tab:encoder-debugging}

\Option{DebugBitstream/DecodeBitstream1} &
%\ShortOption{\None} &
\Default{} &
Specifies the first bit stream to be read until a pre-defined switch point is encountered.
\\

\Option{DecodeBitstream2} &
%\ShortOption{\None} &
\Default{} &
Specifies the second bit stream, to be read after the first random access point after a QP switch point (specified using SwitchPOC and SwitchQP).
\\

\Option{DebugPOC} &
%\ShortOption{\None} &
\Default{-1} &
Specifies a POC, at which a bit stream specified using DebugBitstream or DecodeBitstream1 is no longer read, but rather normal encoding is started.
\\

\Option{DebugCTU} &
%\ShortOption{\None} &
\Default{-1} &
When the POC is encountered at which normal encoding is to be resumed, if set, this option specifies that CTUs up to the specified CTU(in raster scan addressing order are to be read from the specified bit stream, after which normal encoding is started the specified CTU.
\\

\Option{SwitchPOC} &
%\ShortOption{\None} &
\Default{-1} &
Specifies a POC, at which the specified bit stream is no longer read, but rather normal encoding is started.
\\

\Option{SwitchDQP} &
%\ShortOption{\None} &
\Default{0} &
Specifies a QP offset to be applied when normal encoding is started as specified by SwitchPOC.
\\

\Option{FastForwardToPOC} &
%\ShortOption{\None} &
\Default{0} &
When encoding a bit streams, all frames that are not references including transitive references to the specified POC are skipped.
\\
\Option{StopAfterFFtoPOC} &
%\ShortOption{\None} &
\Default{false} &
If enabled, causes the encoder to not encode any frame after the frame specified by FastForwardToPOC option, in encoding order.
\\
\end{OptionTableNoShorthand}



%%
%% VUI parameters
%%
\begin{OptionTableNoShorthand}{VUI parameters}{tab:VUI}
\Option{VuiParametersPresent (-vui)} &
\Default{false} &
Enable generation of vui_parameters().
\\
\Option{AspectRatioInfoPresent} &
\Default{false} &
Signals whether aspect_ratio_idc is present.
\\
\Option{AspectRatioIdc} &
\Default{0} &
aspect_ratio_idc
\\
\Option{SarWidth} &
\Default{0} &
Specifies the horizontal size of the sample aspect ratio.
\\
\Option{SarHeight} &
\Default{0} &
Specifies the vertical size of the sample aspect ratio.
\\
\Option{OverscanInfoPresent} &
\Default{false} &
Signals whether overscan_info_present_flag is present.
\\
\Option{OverscanAppropriate} &
\Default{false} &
Indicates whether cropped decoded pictures are suitable for display using overscan.
\par
\begin{tabular}{cp{0.45\textwidth}}
  0 & Indicates that the decoded pictures should not be displayed using overscan. \\
  1 & Indicates that the decoded pictures may be displayed using overscan. \\
\end{tabular}
\\
\Option{ColourDescriptionPresent} &
\Default{false} &
Signals whether colour_primaries, transfer_characteristics, matrix_coefficients and video_full_range_flag are present.
Yan Zhang's avatar
Yan Zhang committed
\\
\Option{ColourPrimaries} &
\Default{2} &
Indicates chromaticity coordinates of the source primaries.
\\
\Option{TransferCharacteristics} &
Yan Zhang's avatar
Yan Zhang committed
\Default{2} &
Indicates the opto-electronic transfer characteristics of the source.
\\
\Option{MatrixCoefficients} &
\Default{2} &
Describes the matrix coefficients used in deriving luma and chroma from RGB primaries.
\\
\Option{VideoFullRange} &
\Default{false} &
Indicates the black level and range of luma and chroma signals.
\par
\begin{tabular}{cp{0.45\textwidth}}
  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. \\
\end{tabular}
\\
\Option{ProgressiveSource} &
\Default{false} &
Specifies the value of general_progressive_source_flag
\\
\Option{InterlacedSource} &
\Default{false} &
Specifies the value of general_interlaced_source_flag 
\\
\Option{NonPackedSourceConstraintFlag} &
%\ShortOption{\None} &
\Default{false} &
Specifies the value of general_non_packed_constraint_flag
\\
\Option{NonProjectedConstraintFlag} &
%\ShortOption{\None} &
\Default{false} &
Specifies the value of general_non_projected_constraint_flag
\\
Yan Zhang's avatar
Yan Zhang committed
\Option{ChromaLocInfoPresent} &
\Default{false} &
Signals whether chroma_sample_loc_type_top_field and chroma_sample_loc_type_bottom_field are present.
\\
\Option{ChromaSampleLocTypeTopField} &
\Default{0} &
Specifies the location of chroma samples for top field.
\\
\Option{ChromaSampleLocTypeBottomField} &
\Default{0} &
Specifies the location of chroma samples for bottom field.
\\
\end{OptionTableNoShorthand}


\begin{OptionTableNoShorthand}{Range Extensions (Version 2) tool parameters}{tab:rext-tools}

\Option{CostMode} &
\Default{lossy} &
Specifies the cost mode to use.
\par
\begin{tabular}{lp{0.3\textwidth}}
  lossy                   & $cost=distortion+\lambda \times bits$ \\
Tung Nguyen's avatar
Tung Nguyen committed
%  sequence_level_lossless & $cost=distortion / \lambda + bits$. \\
  lossless                & $cost = bits$, QP'=0 is used for all transform blocks and the only allowed encoder result is either an empty transform block or an transform skipped block. \\
%  mixed_lossless_lossy    & As with sequence_level_lossless, but QP'=4 is used for pre-estimates of transquant-bypass blocks \\
Yan Zhang's avatar
Yan Zhang committed
\end{tabular}
\\

\Option{ExtendedPrecision} &
\Default{false} &
Specifies the use of extended_precision_processing flag. Note that unless the HIGH_BIT_DEPTH_SUPPORT macro in TypeDef.h is enabled, all internal bit depths must be 8 when the ExtendedPrecision setting is enabled.
This setting is only valid for the 16-bit RExt profiles.
\\

\Option{HighPrecisionPredictionWeighting} &
\Default{false} &
Specifies the value of high_precision_prediction_weighting_flag. This setting is only valid for the 16-bit or 4:4:4 RExt profiles.
\\

\Option{ReconBasedCrossCPredictionEstimate} &
\Default{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
\\

\Option{TransformSkipLog2MaxSize} &
\Default{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.
\\


\Option{ResidualRotation} &
\Default{false} &
When true, specifies the use of the residual rotation tool. Version 1 and some Version 2 (RExt) profiles require this to be false.
\\

\Option{SingleSignificanceMapContext} &
\Default{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.
\\

\Option{GolombRiceParameterAdaptation} &
\Default{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.
\\

\Option{AlignCABACBeforeBypass} &
\Default{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.
\\

\Option{IntraReferenceSmoothing} &
\Default{true} &
When true, enable intra reference smoothing, otherwise disable it. Version 1 and some Version 2 (RExt) profiles require this to be true.
\\

\end{OptionTableNoShorthand}

\subsection{Encoder SEI parameters}
The table below lists the SEI messages defined for Version 1 and Range-Extensions, and if available, the respective table that lists the controls within the HM Encoder to include the messages within the bit stream.

\begin{SEIListTable}{List of Version 1 and RExt SEI messages}
    0 & Buffering period                         & Table \ref{tab:sei-buffering-period} \\
    1 & Picture timing                           & Table \ref{tab:sei-picture-timing} \\
    2 & Pan-scan rectangle                       & (Not handled)\\
    3 & Filler payload                           & (Not handled)\\
    4 & User data registered by Rec. ITU-T T.35  & (Not handled)\\
    5 & User data unregistered                   & Decoded only\\
    6 & Recovery point                           & Table \ref{tab:sei-recovery-point} \\
    9 & Scene information                        & (Not handled)\\
   15 & Picture snapshot                         & (Not handled)\\
   16 & Progressive refinement segment start     & (Not handled)\\
   17 & Progressive refinement segment end       & (Not handled)\\
Taoran Lu's avatar
Taoran Lu committed
   19 & Film grain characteristics               & Table \ref{tab:sei-film-grain} \\
Yan Zhang's avatar
Yan Zhang committed
   22 & Post-filter hint                         & (Not handled)\\
   23 & Tone mapping information                 & Table \ref{tab:sei-tone-mapping-info} \\
   45 & Frame packing arrangement                & Table \ref{tab:sei-frame-packing-arrangement} \\
   47 & Display orientation                      & Table \ref{tab:sei-display-orientation} \\
   56 & Green Metadata                           & Table \ref{tab:sei-green-metadata} \\
  128 & Structure of pictures information        & Table \ref{tab:sei-sop-info} \\
  129 & Parameter sets inclusion indication      & Table \ref{tab:sei-parameter-sets-inclusion-indication} \\
Yan Zhang's avatar
Yan Zhang committed
  130 & Decoding unit information                & Table \ref{tab:sei-decoding-unit-info} \\
  131 & Temporal sub-layer zero index            & Table \ref{tab:sei-temporal-level-0} \\
  132 & Decoded picture hash                     & Table \ref{tab:sei-decoded-picture-hash} \\
  133 & Scalable nesting                         & Table \ref{tab:sei-scalable-nesting} \\
  134 & Region refresh information               & Table \ref{tab:sei-region-refresh-info} \\
  135 & No display                               & Table \ref{tab:sei-no-display} \\
  136 & Time code                                & Table \ref{tab:sei-time-code} \\
  137 & Mastering display colour volume          & Table \ref{tab:sei-mastering-display-colour-volume} \\
  138 & Segmented rectangular frame packing arrangement & Table \ref{tab:sei-seg-rect-fpa}\\
  139 & Temporal motion-constrained tile sets    & Table \ref{tab:sei-tmcts} \\
  140 & Chroma resampling filter hint            & Table \ref{tab:chroma-resampling-filter-hint} \\
  141 & Knee function information                & Table \ref{tab:sei-knee-function} \\
  142 & Colour remapping information             & Table \ref{tab:sei-colour-remapping}\\
  143 & Deinterlaced field identification        & (Not handled)\\
Taoran Lu's avatar
Taoran Lu committed
  144 & Content light level info                 & Table \ref{tab:sei-content-light-level}\\
  147 & Alternative transfer characteristics     & Table \ref{tab:sei-alternative-transfer-characteristics}\\
  148 & Ambient viewing environment              & Table \ref{tab:sei-ambient-viewing-environment}\\
  149 & Content colour volume                    & Table \ref{tab:sei-content-colour-volume}\\
Taoran Lu's avatar
Taoran Lu committed
  150 & Equirectangular projection               & Table \ref{tab:sei-erp} \\
  153 & Generalized cubemap projection           & Table \ref{tab:sei-gcmp} \\
Taoran Lu's avatar
Taoran Lu committed
  154 & Sphere rotation                          & Table \ref{tab:sei-sphere-rotation} \\
  155 & Region-wise packing                      & Table \ref{tab:sei-rwp} \\
  156 & Omni viewport                            & Table \ref{tab:sei-omni-viewport} \\  
  168 & Frame-field information                  & Table \ref{tab:sei-frame-field} \\  
  202 & Annotated regions information            & Table \ref{tab:sei-annotated-regions} \\  
  203 & Subpicture Level Information             & Table \ref{tab:sei-subpic-level} \\  
  204 & Sample Aspect Ratio Information          & Table \ref{tab:sei-sari} \\  
Yan Zhang's avatar
Yan Zhang committed
\end{SEIListTable}
%%
%% SEI messages
%%

  

\begin{OptionTableNoShorthand}{Buffering period SEI message encoder parameters}{tab:sei-buffering-period}
\Option{SEIBufferingPeriod} &
\Default{0} &
Enables or disables the insertion of the Buffering period
SEI messages. This option has no effect if VuiParametersPresent is disabled.
SEIBufferingPeriod requires SEIActiveParameterSets to be enabled.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Picture timing SEI message encoder parameters}{tab:sei-picture-timing}
\Option{SEIPictureTiming} &
\Default{0} &
Enables or disables the insertion of the Picture timing
SEI messages. This option has no effect if VuiParametersPresent is disabled.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Recovery point SEI message encoder parameters}{tab:sei-recovery-point}
\Option{SEIRecoveryPoint} &
\Default{0} &
Enables or disables the insertion of the Recovery point
SEI messages.
\\
\end{OptionTableNoShorthand}



Taoran Lu's avatar
Taoran Lu committed
\begin{OptionTableNoShorthand}{Film grain characteristics SEI message encoder parameters}{tab:sei-film-grain}
\Option{SEIFGCEnabled} &
\Default{0} &
Enables or disables the insertion of the film grain characteristics SEI message.
\\
\Option{SEIFGCCancelFlag} &
\Default{0} &
Specifies the persistence of any previous film grain characteristics SEI message in output order.
\\
\Option{SEIFGCPersistenceFlag} &
\Default{1} &
Specifies the persistence of the film grain characteristics SEI message for the current layer.
\\
\Option{SEIFGCModelID} &
\Default{0} &
Specifies the film grain simulation model.
\par
\begin{tabular}{cp{0.35\textwidth}}
  0 & frequency filtering \\
  1 & auto-regression \\
\end{tabular}
\\
\Option{SEIFGCSepColourDescPresentFlag} &
\Default{0} &
Specifies the presence of a distinct colour space description for the film grain characteristics specified in the SEI message.
\\
\Option{SEIFGCBlendingModeID} &
\Default{0} &
Specifies the blending mode used to blend the simulated film grain with the decoded images.
\par
\begin{tabular}{cp{0.35\textwidth}}
  0 & additive \\
  1 & multiplicative \\
\end{tabular}
\\
\Option{SEIFGCLog2ScaleFactor} &
\Default{0} &
Specifies a scale factor used in the film grain characterization equations.
\\
\Option{SEIFGCCompModelPresentComp0} &
\Default{0} &
Specifies the presence of film grain modelling on colour component 0.
\\
\Option{SEIFGCCompModelPresentComp1} &
\Default{0} &
Specifies the presence of film grain modelling on colour component 1.
\\
\Option{SEIFGCCompModelPresentComp2} &
\Default{0} &
Specifies the presence of film grain modelling on colour component 2.
\\
\end{OptionTableNoShorthand}

Yan Zhang's avatar
Yan Zhang committed
\begin{OptionTableNoShorthand}{Tone mapping information SEI message encoder parameters}{tab:sei-tone-mapping-info}
\Option{SEIToneMappingInfo} &
\Default{0} &
Enables or disables the insertion of the Tone Mapping SEI message.
\\
\Option{SEIToneMapId} &
\Default{0} &
Specifies Id of Tone Mapping SEI message for a given session.
\\
\Option{SEIToneMapCancelFlag} &
\Default{false} &
Indicates that Tone Mapping SEI message cancels the persistance or follows.
\\
\Option{SEIToneMapPersistenceFlag} &
\Default{true} &
Specifies the persistence of the Tone Mapping SEI message.
\\
\Option{SEIToneMapCodedDataBitDepth} &
\Default{8} &
Specifies Coded Data BitDepth of Tone Mapping SEI messages.
\\
\Option{SEIToneMapTargetBitDepth} &
\Default{8} &
Specifies Output BitDepth of Tome mapping function.
\\
\Option{SEIToneMapModelId} &
\Default{0} &
Specifies Model utilized for mapping coded data into 
target_bit_depth range.
\par
\begin{tabular}{cp{0.35\textwidth}}
  0 & linear mapping with clipping \\
  1 & sigmoidal mapping \\
  2 & user-defined table mapping \\
  3 & piece-wise linear mapping \\
  4 & luminance dynamic range mapping \\
\end{tabular}
\\
\Option{SEIToneMapMinValue} &
\Default{0} &
Specifies the minimum value in mode 0.
\\
\Option{SEIToneMapMaxValue} &
\Default{1023} &
Specifies the maxmum value in mode 0.
\\
\Option{SEIToneMapSigmoidMidpoint} &
\Default{512} &
Specifies the centre point in mode 1.
\\
\Option{SEIToneMapSigmoidWidth} &
\Default{960} &
Specifies the distance between 5% and 95% values of 
the target_bit_depth in mode 1.
\\
\Option{SEIToneMapStartOfCodedInterval} &
\Default{\None} &
Array of user-defined mapping table. 
Default table can be set to the following:
\par
\begin{tabular}{cp{0.35\textwidth}}
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
\\
\end{tabular}
\\
\Option{SEIToneMapNumPivots} &
\Default{0} &
Specifies the number of pivot points in mode 3.
\\
\Option{SEIToneMapCodedPivotValue} &
\Default{\None} &
Array of coded pivot point in mode 3.
A suggested table is:
\par
\begin{tabular}{cp{0.45\textwidth}}
64 128 256 512 768
\end{tabular}
\\
\Option{SEIToneMapTargetPivotValue} &
\Default{\None} &
Array of target pivot point in mode 3.
A suggested table is:
\par
\begin{tabular}{cp{0.45\textwidth}}
48 73 111 168 215
\end{tabular}
\\
\Option{SEIToneMap...} \Option{CameraIsoSpeedIdc} &
\Default{0} &
Indicates the camera ISO speed for daylight illumination.
\\
\Option{SEIToneMap...} \Option{CameraIsoSpeedValue} &
\Default{400} &
Specifies the camera ISO speed for daylight illumination of Extended_ISO.
\\
\Option{SEIToneMap...} \Option{ExposureIndexIdc} &
\Default{0} &
Indicates the exposure index setting of the camera.
\\
\Option{SEIToneMap...} \Option{ExposureIndexValue} &
\Default{400} &
Specifies the exposure index setting of the cameran of Extended_ISO.
\\
\Option{SEIToneMapExposure...} \Option{CompensationValueSignFlag} &
\Default{0} &
Specifies the sign of ExposureCompensationValue.
\\
\Option{SEIToneMapExposure...} \Option{CompensationValueNumerator} &
\Default{0} &
Specifies the numerator of ExposureCompensationValue.
\\
\Option{SEIToneMapExposure...} \Option{CompensationValueDenomIdc} &
\Default{2} &
Specifies the denominator of ExposureCompensationValue.
\\
\Option{SEIToneMapRef...} \Option{ScreenLuminanceWhite} &
\Default{350} &
Specifies reference screen brightness setting in units of candela per square metre.
\\
\Option{SEIToneMapExtended...} \Option{RangeWhiteLevel} &
\Default{800} &
Indicates the luminance dynamic range.
\\
\Option{SEIToneMapNominal...} \Option{BlackLevelLumaCodeValue} &
\Default{16} &
Specifies luma sample value of the nominal black level assigned decoded pictures.
\\
\Option{SEIToneMapNominal...} \Option{WhiteLevelLumaCodeValue} &
\Default{235} &
Specifies luma sample value of the nominal white level assigned decoded pictures.
\\
\Option{SEIToneMapExtended...} \Option{WhiteLevelLumaCodeValue} &
\Default{300} &
Specifies luma sample value of the extended dynamic range assigned decoded pictures.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Frame packing arrangement SEI message encoder parameters}{tab:sei-frame-packing-arrangement}
\Option{SEIFramePacking} &
\Default{0} &
Enables or disables the insertion of the Frame packing arrangement SEI messages.
\\
\Option{SEIFramePackingType} &
Taoran Lu's avatar
Taoran Lu committed
\Default{3} &
Yan Zhang's avatar
Yan Zhang committed
Indicates the arrangement type in the Frame packing arrangement SEI message.
This option has no effect if SEIFramePacking is disabled.
\par
\begin{tabular}{cp{0.35\textwidth}}
  3 & Side by Side \\
  4 & Top Bottom \\
  5 & Frame Alternate \\
\end{tabular}
\\
\Option{SEIFramePackingInterpretation} &
\Default{0} &
Indicates the constituent frames relationship in the Frame packing arrangement SEI message. 
This option has no effect if SEIFramePacking is disabled.
\par
\begin{tabular}{cp{0.35\textwidth}}
  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 \\
\end{tabular}
\\
\Option{SEIFramePackingQuincunx} &
Taoran Lu's avatar
Taoran Lu committed
\Default{1} &
Yan Zhang's avatar
Yan Zhang committed
Enables or disables the quincunx_sampling signalling in the
Frame packing arrangement SEI messages. This option has no
effect if SEIFramePacking is disabled.
\\
\Option{SEIFramePackingId} &
\Default{0} &
Indicates the session number in the Frame packing arrangement
SEI messages. This option has no effect if SEIFramePacking is
disabled.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Display orientation SEI message encoder parameters}{tab:sei-display-orientation}
\Option{SEIDisplayOrientation} &
\Default{0} &
Enables or disables the insertion of the Display orientation
SEI messages.
\par
\begin{tabular}{cp{0.20\textwidth}}
  0 & Disabled \\
  N: $0 < N < (2^{16} - 1)$ & Enable display orientation SEI message with 
  \mbox{anticlockwise_rotation = N} 
  and \mbox{display_orientation_repetition_period = 1} \\
\end{tabular}
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Green Metadata SEI message encoder parameters}{tab:sei-green-metadata}
\Option{SEIGreenMetadataType} &
\Default{0} &
Specifies the type of metadata that is present in the SEI message.
\par
\begin{tabular}{cp{0.35\textwidth}}
  0 & Reserved \\
  1 & Metadata enabling quality recovery after low-power encoding is present \\
\end{tabular}
\\
\Option{SEIXSDMetricType} &
\Default{0} &
Indicates the type of the objective quality metric.
\par
\begin{tabular}{cp{0.35\textwidth}}
  0 & PSNR is used as objective quality metric \\
\end{tabular}
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Structure of pictures information SEI message encoder parameters}{tab:sei-sop-info}
\Option{SEISOPDescription} &
\Default{0} &
Enables or disables the insertion of the Structure of pictures information SEI messages.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Parameter sets inclusion indication SEI message encoder parameters}{tab:sei-parameter-sets-inclusion-indication}
\Option{SEIParameterSetsInclusionIndication} &
Yan Zhang's avatar
Yan Zhang committed
\Default{0} &
Enables or disables the insertion of the Parameter sets inclusion SEI messages.
\\
\Option{SEISelfContainedClvsFlag} &
\Default{0} &
When equal to 1, the SEI specifies that the CLVS contains all the required NAL units for decoding the CLVS that is associated with the SEI message and that sublayer up-switching within the CLVS works without a need of fetching parameter sets from PUs earlier in decoding order than the PU containing the picture at which the sublayer up-switching occurs.
Yan Zhang's avatar
Yan Zhang committed
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Decoding unit information SEI message encoder parameters}{tab:sei-decoding-unit-info}
\Option{SEIDecodingUnitInfo} &
\Default{0} &
Enables or disables the insertion of the Decoding unit information
SEI messages. This option has no effect if VuiParametersPresent is disabled.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Temporal sub-layer zero index SEI message encoder parameters}{tab:sei-temporal-level-0}
\Option{SEITemporalLevel0Index} &
\Default{0} &
Enables or disables the insertion of the Temporal level zero index
SEI messages.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Decoded picture hash SEI message encoder parameters}{tab:sei-decoded-picture-hash}
\Option{SEIDecodedPictureHash} &
\Default{0} &
Enables or disables the calculation and insertion of the Decoded picture hash
SEI messages.
\par
\begin{tabular}{cp{0.35\textwidth}}
  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 \\
\end{tabular}
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Scalable nesting SEI message encoder parameters}{tab:sei-scalable-nesting}
\Option{SEIScalableNesting} &
\Default{0} &
Enables creation of scalable nesting SEI messages for buffering period and picture timing SEI messages.
\\
\Option{SubpicDecodedPictureHash} &
\Default{0} &
Enables creation of decoded picture hash SEI messages for each subpicture and writes these in scalable nesting SEI messages.
\par
\begin{tabular}{cp{0.35\textwidth}}
  0 & Disabled \\
  1 & MD5 \\
  2 & CRCs \\
  3 & checksum \\
\end{tabular}
Yan Zhang's avatar
Yan Zhang committed
\\
\end{OptionTableNoShorthand}


        
\begin{OptionTableNoShorthand}{Region refresh information SEI message encoder parameters}{tab:sei-region-refresh-info}
\Option{SEIGradualDecodingRefreshInfo} &
\Default{0} &
Enables or disables the insertion of the Gradual decoding refresh information
SEI messages.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{No display SEI message encoder parameters}{tab:sei-no-display}
\Option{SEINoDisplay} &
\Default{0} &
When non-zero, generate no-display SEI message for temporal layer N or higher.
\\
\end{OptionTableNoShorthand}


        
\begin{OptionTableNoShorthand}{Time code SEI message encoder parameters}{tab:sei-time-code}
\Option{SEITimeCodeEnabled} &
\Default{false} &
When true (non-zero), generate Time code SEI messages.
\\
\Option{SEITimeCodeNumClockTs} &
\Default{0} &
Number of clock time sets, in the range of 0 to 3 (inclusive).
\\
\Option{SEITimeCodeTimeStampFlag} &
\Default{\None} &
Time stamp flag associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeFieldBasedFlag} &
\Default{\None} &
Field based flag associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeCountingType} &
\Default{\None} &
Counting type associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeFullTsFlag} &
\Default{\None} &
Full time stamp flag associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeDiscontinuityFlag} &
\Default{\None} &
Discontinuity flag associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeCntDroppedFlag} &
\Default{\None} &
Counter dropped flag associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeNumFrames} &
\Default{\None} &
Number of frames associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeSecondsFlag} &
\Default{\None} &
Flag to signal seconds value presence in each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeMinutesFlag} &
\Default{\None} &
Flag to signal minutes value presence in each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeHoursFlag} &
\Default{\None} &
Flag to signal hours value presence in each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeSecondsValue} &
\Default{\None} &
Seconds value for each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeMinutesValue} &
\Default{\None} &
Minutes value for each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeHoursValue} &
\Default{\None} &
Hours value for each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeOffsetLength} &
\Default{\None} &
Time offset length associated to each time set (comma or space separated list of entries).
\\
\Option{SEITimeCodeTimeOffset} &
\Default{\None} &
Time offset associated to each time set (comma or space separated list of entries).
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Mastering display colour volume SEI message encoder parameters}{tab:sei-mastering-display-colour-volume}
\Option{SEIMasteringDisplayColourVolume} &
\Default{false} &
When true (non-zero), generate Mastering display colour volume SEI message.
\\
\Option{SEIMasteringDisplayMaxLuminance} &
\Default{10000} &
Specifies the mastering display maximum luminance value in units of 1/10000 candela per square metre.
\\
\Option{SEIMasteringDisplayMinLuminance} &
\Default{0} &
Specifies the mastering display minimum luminance value in units of 1/10000 candela per square metre.
\\
\Option{SEIMasteringDisplayPrimaries} &
\Default{0,50000, 0,0, 50000,0} &
Mastering display primaries for all three colour planes in CIE xy coordinates in increments of 1/50000 (results in the ranges 0 to 50000 inclusive).
\\
\Option{SEIMasteringDisplayWhitePoint} &
\Default{16667, 16667} &
Mastering display white point CIE xy coordinates in normalized increments of 1/50000 (e.g. 0.333 = 16667).
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Segmented rectangular frame packing arrangement SEI message encoder parameters}{tab:sei-seg-rect-fpa}
\Option{SEISegmentedRectFramePacking} &
\Default{0} &
Controls generation of segmented rectangular frame packing SEI messages.
\\
\Option{SEISegmentedRectFramePackingCancel} &
\Default{false} &
If true, cancels the persistence of any previous SRFPA SEI message.
\\
\Option{SEISegmentedRectFramePackingType} &
\Default{0} &
Specifies the arrangement of the frames in the reconstructed picture.
\\
\Option{SEISegmentedRectFramePackingPersistence} &
\Default{false} &
If false the SEI applies to the current frame only.
\\
\end{OptionTableNoShorthand}



\begin{OptionTableNoShorthand}{Temporal motion-constrained tile sets SEI message encoder parameters}{tab:sei-tmcts}
\Option{SEITempMotionConstrainedTileSets} &
\Default{false} &
When true (non-zero), generates example temporal motion constrained tile sets SEI messages.