source: 3DVCSoftware/branches/HTM-13.1-dev2-HHI/doc/software-manual.tex @ 1252

Last change on this file since 1252 was 964, checked in by tech, 10 years ago
  • Merged 11.0-dev0@963. (Update to HM 14.0 + MV-HEVC Draft 8 HLS)
  • Added coding results.
  • Changed version number.
File size: 59.7 KB
Line 
1\documentclass[a4paper,11pt]{jctvcdoc}
2
3\usepackage{geometry}[2010/02/12]
4
5\usepackage{hyperref}
6\hypersetup{colorlinks=true}
7\usepackage{color,soul}
8
9\usepackage[position=bottom]{subfig}
10\captionsetup[subfloat]{position=top}
11\usepackage{multirow}
12\usepackage{dcolumn}
13\newcolumntype{.}{D{.}{.}{-1}}
14\usepackage{colortbl}
15\usepackage{makecell}
16\usepackage{longtable}
17\usepackage{array}
18\usepackage{algorithm2e}
19
20\usepackage[strings]{underscore}
21\usepackage{csquotes}
22\MakeOuterQuote{"}
23\EnableQuotes
24
25\newcommand\None{}
26\newcommand\NotSet{}
27\makeatletter
28\newcommand{\Option}[1]{\ifx\optOption\@empty\gdef\optOption{#1}\else\g@addto@macro\optOption{ \\ #1}\fi}
29\newcommand{\ShortOption}[1]{\ifx\optShortOption\@empty\gdef\optShortOption{#1}\else\g@addto@macro\optShortOption{ \\ #1}\fi}
30\newcommand{\Default}[1]{\ifx\optDefault\@empty\gdef\optDefault{#1}\else\g@addto@macro\optDefault{ \\ #1}\fi}
31\newcommand{\clearOptions}{\gdef\optOption{}\gdef\optShortOption{}\gdef\optDefault{}}
32\makeatother
33\newenvironment{OptionTable}[1]{%
34        \footnotesize
35        \def\arraystretch{1.8}
36        \clearOptions
37        \begin{longtable}{l<{\makecell[tl]{\optOption}}%
38                          >{\texttt\bgroup}l<{\makecell[tl]{\optShortOption}\egroup}%
39                          c<{\makecell[tc]{\optDefault}}%
40                          >{\def\arraystretch{1.0}}p{0.5\textwidth}<{\clearOptions}}
41        \caption{#1} \\
42        \hspace*{12em}&&\hspace*{8em}&\kill
43        \hline
44         \thead{Option} &
45         \egroup\thead{Shorthand}\bgroup &
46         \thead{Default} &
47         \thead{Description} \\
48        \hline
49        \endfirsthead
50        \caption[]{#1 (Continued)} \\
51        \hspace*{12em}&&\hspace*{8em}&\kill
52        \hline
53         \thead{Option} &
54         \egroup\thead{Shorthand}\bgroup &
55         \thead{Default} &
56         \thead{Description} \\
57        \hline
58        \endhead
59         \multicolumn{4}{r}{Continued...}\\
60         \hline
61        \endfoot
62         \hline
63        \endlastfoot
64}{%
65        \hline
66        \end{longtable}
67}
68
69\newenvironment{MacroTable}[1]{%
70        \footnotesize
71        \def\arraystretch{1.3}
72        \clearOptions
73        \begin{longtable}{lcp{0.5\textwidth}}
74         \caption{#1} \\
75        %\hspace*{12em}&&\hspace*{8em}&\kill
76         \hline
77          \thead{Option} &
78          \thead{Default} &
79          \thead{Description} \\
80         \hline
81        \endfirsthead
82         \caption[]{#1 (Continued)} \\
83         \hline
84          \thead{Option} &
85          \thead{Default} &
86          \thead{Description} \\
87         \hline
88        \endhead
89         \multicolumn{3}{r}{Continued...}\\
90         \hline
91        \endfoot
92         \hline
93        \endlastfoot
94}{%
95        \end{longtable}
96}
97
98\title{HM Software Manual}
99\author{%
100        Frank Bossen
101        \email{frank@bossentech.com}
102        \and
103        David Flynn
104        \email{dflynn@blackberry.com}
105        \and
106        Karsten S\"uhring
107        \email{karsten.suehring@hhi.fraunhofer.de}
108}
109
110\jctvcmeeting{}
111\jctvcdocnum{Software Manual}
112\jctvcdocstatus{Software AHG working document}
113\jctvcdocpurpose{Information}
114\jctvcdocsource{AHG chairs}
115
116\begin{document}
117\maketitle
118\begin{abstract}
119This document is a user manual describing usage of reference software
120for the HEVC project. It applies to version 14.0
121of the software.
122\end{abstract}
123
124\tableofcontents
125\listoftables
126
127\section{General Information}
128Reference software is being made available to provide a reference
129implementation of the draft HEVC standard being developed by the Joint
130Collaborative Team on Video Coding (JCT-VC) regrouping experts from
131ITU-T SG 16 and ISO/IEC SC29 WG11. One of the main goals of the
132reference software is to provide a basis upon which to conduct
133experiments in order to determine which coding tools provide desired
134coding performance. It is not meant to be a particularly efficient
135implementation of anything, and one may notice its apparent
136unsuitability for a particular use. It should not be construed to be a
137reflection of how complex a production-quality implementation of a
138future HEVC standard would be.
139
140This document aims to provide guidance on the usage of the reference
141software. It is widely suspected to be incomplete and suggestions for
142improvements are welcome. Such suggestions and general inquiries may be
143sent to the general JCT-VC email reflector on
144\url{jct-vc@lists.rwth-aachen.de} (registration required).
145
146\subsection*{Bug reporting}
147Bugs should be reported on the issue tracker set up at
148\url{http://hevc.kw.bbc.co.uk/trac/}
149
150\section{Installation and compilation}
151The software may be retrieved from one of the following SVN servers
152(mirrored):
153\begin{itemize}
154\item \url{https://hevc.hhi.fraunhofer.de/svn/svn_HEVCSoftware/}
155\item \url{svn://hevc.kw.bbc.co.uk/svn/jctvc-hm/}
156\end{itemize}
157
158Table~\ref{tab:project-files} enumerates various project files that are
159provided for development environments.
160
161\begin{table}[ht]
162\footnotesize
163\caption{Available project files}
164\label{tab:project-files}
165\centering
166\begin{tabular}{ll}
167\hline
168 \thead{Environment} &
169 \thead{Location of project file} \\
170% Environment          & Location of project file \\
171\hline
172MS Visual Studio 8   & build/HM_vc8.sln \\
173MS Visual Studio 9   & build/HM_vc9.sln \\
174Xcode                & HM.xcodeproj \\
175Linux                & build/linux/makefile \\
176\hline
177\end{tabular}
178\end{table}
179
180For encoding large picture sizes (like UHDTV) it is strongly advised to build 64-bit
181binaries and to use a 64-bit OS. This will allow the software to use more than 2GB of RAM.
182
183%%%%
184%%%%
185%%%%
186\section{Using the encoder}
187\begin{verbatim}
188TAppEncoder     [-h] [-c config.cfg] [--parameter=value]
189\end{verbatim}
190
191\begin{table}[ht]
192\footnotesize
193\centering
194\begin{tabular}{lp{0.5\textwidth}}
195\hline
196 \thead{Option} &
197 \thead{Description} \\
198\hline
199\texttt{-h} & Prints parameter usage. \\
200\texttt{-c} & Defines configuration file to use.  Multiple configuration files
201     may be used with repeated --c options. \\
202\texttt{--}\emph{parameter}\texttt{=}\emph{value}
203    & Assigns value to a given parameter as further described below.
204      Some parameters are also supported by shorthand
205      "--\em{opt}~\emph{value}".\\
206\hline
207\end{tabular}
208\end{table}
209
210Sample configuration files are provided in the cfg/ folder.
211
212\subsection{GOP structure table}
213\label{sec:gop-structure}
214Defines the cyclic GOP structure that will be used repeatedly
215throughout the sequence. The table should contain GOPSize lines,
216named Frame1, Frame2, etc. The frames are listed in decoding
217order, so Frame1 is the first frame in decoding order, Frame2 is
218the second and so on. Among other things, the table specifies all
219reference pictures kept by the decoder for each frame. This
220includes pictures that are used for reference for the current
221picture as well as pictures that will be used for reference in
222the future. The encoder will not automatically calculate what
223pictures that has to be kept for future references, they have to
224be specified. Note that some specified reference frames for
225pictures encoded in the very first GOP after an IDR frame might
226not be available. This is handled automatically by the encoder,
227so the reference pictures can be given in the GOP structure table
228as if there were infinitely many identical GOPs before the
229current one. Each line in the table contains the parameters used
230for the corresponding frame, separated by whitespace:
231
232\begin{itemize}
233\item[]\textbf{Type}: Slice type, can be either I, P or B.
234
235\item[]\textbf{POC}: Display order of the frame within a GOP, ranging
236from 1 to GOPSize.
237
238\item[]\textbf{QPOffset}: QP offset is added to the QP parameter to set
239the final QP value to use for this frame.
240
241\item[]\textbf{QPFactor}: Weight used during rate distortion
242optimization. Higher values mean lower quality and less bits. Typical
243range is between
2440.3 and 1.
245
246\item[]\textbf{tcOffsetDiv2}: In-loop deblocking filter parameter tcOffsetDiv2
247is added to the base parameter LoopFilterTcOffset_div2 to set the final tc_offset_div2
248parameter for this picture signalled in the slice segment header. The final
249value of tc_offset_div2 shall be an integer number in the range $-6..6$.
250
251\item[]\textbf{betaOffsetDiv2}: In-loop deblocking filter parameter betaOffsetDiv2
252is added to the base parameter LoopFilterBetaOffset_div2 to set the final beta_offset_div2
253parameter for this picture signalled in the slice segment header. The final
254value of beta_offset_div2 shall be an integer number in the range $-6..6$.
255
256\item[]\textbf{temporal_id}: Temporal layer of the frame. A frame cannot
257predict from a frame with a higher temporal id. If a frame with higher
258temporal IDs is listed among a frame's reference pictures, it is
259not used, but is kept for possible use in future frames.
260
261\item[]\textbf{num_ref_pics_active}: Size of reference picture lists L0
262and L1, indicating how many reference pictures in each direction that
263are used during coding.
264
265\item[]\textbf{num_ref_pics}: The number of reference pictures kept for
266this frame.  This includes pictures that are used for reference for the
267current picture as well as pictures that will be used for reference in
268the future.
269
270\item[]\textbf{reference_pictures}: A space-separated list of
271num_ref_pics integers, specifying the POC of the reference pictures
272kept, relative the POC of the current frame. The picture list shall be
273ordered, first with negative numbers from largest to smallest, followed
274by positive numbers from smallest to largest (e.g. \verb|-1 -3 -5 1 3|).
275Note that any pictures not supplied in this list will be discarded and
276therefore not available as reference pictures later.
277
278\item[]\textbf{predict}: Defines the value of the syntax element
279inter_ref_pic_set_prediction_flag. A value of 0 indicates that the
280reference picture set is encoded without inter RPS prediction and the
281subsequent parameters deltaRIdx$-1$, deltaRPS, num_ref_idcs and
282Reference_idcs are ignored and do not need to be present. A value of 1
283indicates that the reference picture set is encoded with inter
284prediction RPS using the subsequent parameters deltaRIdx$-1$, deltaRPS,
285num_ref_idcs and Reference_idcs in the line. A value of 2 indicates that
286the reference picture set is encoded with inter RPS but only the
287deltaRIdx$-1$ parameters is needed. The deltaRPS, num_ref_idcs and
288Reference_idcs values are automatically derived by the encoder based on
289the POC and refPic values of the current line and the RPS pointed to by
290the deltaRIdx$-1$ parameters.
291
292\item[]\textbf{deltaRIdx$-1$}: The difference between the index of the
293curent RPS and the predictor RPS minus 1.
294
295\item[]\textbf{deltaRPS}: The difference between the POC of the
296predictor RPS and POC the current RPS.
297
298\item[]\textbf{num_ref_idcs}: The number of ref_idcs to encode for the
299current RPS.  The value is equal to the value of  num_ref_pics of the
300predictor RPS plus 1.
301
302\item[]\textbf{reference_idcs}: A space-separated list of num_ref_idcs
303integers, specifying the ref idcs of the inter RPS prediction. The value
304of ref_idcs may be 0, 1 or 2 indicating that the reference picture is a
305reference picture used by the current picture, a reference picture used
306for future picture or not a reference picture anymore, respectively. The
307first num_ref_pics of ref_idcs correspond to the Reference pictures in
308the predictor RPS. The last ref_idcs corresponds to the predictor
309picture.
310\end{itemize}
311
312For example, consider the coding structure of Figure~\ref{fig:gop-example}.
313This coding structure is of size 4. The pictures are listed in decoding
314order. Frame1 shall therefore describe picture with $\textrm{POC}=4$. It
315references picture 0, and therefore has $-4$ as a reference picture.
316Similarly, Frame2 has a POC of 2, and since it references pictures 0 and
3174, its reference pictures are listed as \verb|-2 2|. Frame3 is a special
318case: even though it only references pictures with POC 0 and 2, it also
319needs to include the picture with POC 4, which must be kept in order to
320be used as a reference picture in the future. The reference picture list
321for Frame3 therefore becomes \verb|-1 1 3|. Frame4 has a POC of 3 and
322its list of reference pictures is \verb|-1 1|.
323
324\begin{figure}[h]
325\caption{A GOP structure}
326\label{fig:gop-example}
327\centering
328\includegraphics[width=0.7\textwidth]{gop-structure-example}
329\end{figure}
330
331Inter RPS prediction may be used for Frame2, Frame3 and Frame4, hence
332the predict parameter is set to 1 for these frames. Frame2 uses Frame1
333as the predictor hence the deltaRIdx$-1$ is 0.  Similarly for Frame3 and
334Frame4 which use Frame2 and Frame3 as predictors, respectively. The
335deltaRPS is equal to the POC of the predictor minus the POC of the
336current picture, therefore the deltaRPS for Frame2 is $4 -2 = 2$, for
337Frame3 is $2 - 1 = 1$ and for Frame4 is $1 - 3 = -2$.
338
339In Frame2, reference pictures with POC 0 and 2 are used, so the
340reference idcs for Frame2 are \verb|1 1| indicating that the reference
341picture, $-4$, in Frame1 is still a reference picture in Frame2 and
342Frame1 is also a reference picture in Frame2. The reference idcs for
343Frame3 are \verb|1 1 1|. The first and second “1”s indicating that
344the reference pictures "$-2$ $2$" in Frame2 are still reference pictures in
345Frame3 and the last “1” indicating that Frame2 is also a reference
346picture in Frame3. In Frame 4, the reference idcs are \verb|0 1 1 0|.
347The first “0” indicates that the reference pictures “-1” in Frame 3 is
348no longer a reference picture in Frame4. The next two “1”s indicate that
349the reference pictures “$1$ $3$” are now reference pictures of Frame4.
350The final “0” indicates that Frame3 is not a reference picture.
351
352In order to specify this to the encoder, the parameters in
353Table~\ref{tab:gop-example} could be used.
354
355\begin{table}[ht]
356\footnotesize
357\caption{GOP structure example}
358\label{tab:gop-example}
359\centering
360\begin{tabular}{lrrrr}
361\hline
362 \thead{} &
363 \thead{Frame1} &
364 \thead{Frame2} &
365 \thead{Frame3} &
366 \thead{Frame4} \\
367\hline
368Type                &   P  &    B   &      B   &       B \\
369POC                 &   4  &    2   &      1   &       3 \\
370QPoffset            &   1  &    2   &      3   &       3 \\
371QPfactor            & 0.5  &  0.5   &    0.5   &     0.5 \\
372tcOffsetDiv2        &   0  &    1   &      2   &       2 \\ 
373betaOffsetDiv2      &   0  &    0   &      0   &       0 \\
374temporal_id         &   0  &    1   &      2   &       2 \\
375num_ref_pics_active &   1  &    1   &      1   &       1 \\
376num_ref_pics        &   1  &    2   &      3   &       2 \\
377reference_pictures  & $-$4 & $-$2 2 & $-$1 1 3 &  $-$1 1 \\
378predict             &   0  &    1   &      1   &       1 \\
379deltaRIdx$-$1       &      &    0   &      0   &       0 \\
380deltaRPS            &      &    2   &      1   &    $-$2 \\
381num_ref_idcs        &      &    2   &      3   &       4 \\
382reference_idcs      &      &  1 1   &  1 1 1   & 0 1 1 0 \\
383\hline
384\end{tabular}
385\end{table}
386
387Here, the frames used for prediction have been given higher
388quality by assigning a lower QP offset. Also, the non-reference
389frames have been marked as belonging to a higher temporal layer,
390to make it possible to decode only every other frame. Note: each
391line should contain information for one frame, so this
392configuration would be specified as:
393
394\begin{verbatim}
395Frame1: P 4 1 0.5 0 0 0 1 1 -4 0
396Frame2: B 2 2 0.5 1 0 1 1 2 -2 2 1 0 2 2 1 1
397Frame3: B 1 3 0.5 2 0 2 1 3 -1 1 3 1 0 1 3 1 1 1
398Frame4: B 3 3 0.5 2 0 2 1 2 -1 1 1 0 -2 4 0 1 1 0
399\end{verbatim}
400
401The values of deltaRIdx$-1$, deltaRPS, num_ref_idcs and reference
402idcs of Frame$K$ can be derived from the POC value of Frame$_K$ and
403the POC, num_ref_pics and reference_pictures values of Frame$_M$, where
404$K$ is the index of the RPS to be inter coded and the $M$ is the
405index of the reference RPS, as follows.
406
407\setlength{\algomargin}{2em}
408\begin{algorithm}[h]
409\SetKwData{deltaRIdx}{deltaRIdx}
410\SetKwData{deltaRPS}{deltaRPS}
411\SetKwData{numrefidcs}{num_ref_idcs}
412\SetKwData{numrefpics}{num_ref_pics}
413\SetKwData{referencepictures}{reference_pictures}
414\SetKwData{referenceidcs}{reference_idcs}
415\SetKwData{POC}{POC}
416
417$\deltaRIdx_K - 1  \leftarrow  K - M - 1$ \;
418$\deltaRPS_K       \leftarrow  \POC_M - \POC_K$ \;
419$\numrefidcs_K     \leftarrow  \numrefpics_M + 1$ \;
420
421\For{$j \leftarrow 0$ \KwTo $\numrefpics_M$}{
422        \For{$i \leftarrow 0$ \KwTo $\numrefidcs_K$}{
423                \eIf{$\referencepictures_{M,j} + \deltaRPS_K == \referencepictures_{K,i}$}{
424                        \lIf{$\referencepictures_{K,i}$ is used by the current frame}{
425                                $\referenceidcs_{K,j} = 1$} \;
426                        \lElse{$\referenceidcs_{K,j} = 2$} \;
427                }{
428                        $\referenceidcs_K[j] = 0$ \;
429                }
430        }
431}
432
433\tcc{$\referencepictures_{M,\numrefpics_M}$ does not exist and is assumed to be 0}
434\end{algorithm}
435
436Note: The above (automatic) generation of the inter RPS parameter
437values has been integrated into the encoder, and is activated by
438the value of predict $= 2$ followed by the value of deltaRIdx$-1$,
439only, as described above.
440
441
442
443%%%%
444%%%%
445%%%%
446\newgeometry{tmargin=1.6cm,lmargin=1cm,rmargin=1cm,bmargin=1in,nohead}
447\subsection{Encoder parameters}
448
449%%
450%% File, I/O and source parameters
451%%
452\begin{OptionTable}{File, I/O and source parameters}
453\Option{InputFile} &
454\ShortOption{-i} &
455\Default{\NotSet} &
456Specifies the input video file.
457
458Video data must be in a raw 4:2:0 planar format (Y$'$CbCr).
459
460Note: When the bit depth of samples is larger than 8, each sample is encoded in
4612 bytes (little endian, LSB-justified).
462\\
463
464\Option{BitstreamFile} &
465\ShortOption{-b} &
466\Default{\NotSet} &
467Specifies the output coded bit stream file.
468\\
469
470\Option{ReconFile} &
471\ShortOption{-o} &
472\Default{\NotSet} &
473Specifies the output locally reconstructed video file.
474\\
475
476\Option{SourceWidth}%
477\Option{SourceHeight} &
478\ShortOption{-wdt}%
479\ShortOption{-hgt} &
480\Default{0}%
481\Default{0} &
482Specifies the width and height of the input video in luma samples.
483\\
484
485\Option{InputBitDepth} &
486\ShortOption{\None} &
487\Default{8} &
488Specifies the bit depth of the input video.
489\\
490
491\Option{InternalBitDepth} &
492\ShortOption{\None} &
493\Default{0 \\ (InputBitDepth)} &
494Specifies the bit depth used for coding.
495
496If the input video is a different bit depth to InternalBitDepth, it is
497automatically converted by:
498\begin{displaymath}
499\left\lfloor
500 \frac{\mathrm{Pel} * 2^{\mathrm{InternalBitDepth}}}{
501     2^{\mathrm{InputBitDepth}}}
502\right\rfloor
503\end{displaymath}
504
505Note: The effect of this option is as if the input video is externally
506converted to the InternalBitDepth and then coded with this value as
507InputBitDepth.  The codec has no notion of two different bit depths.
508\\
509
510\Option{OutputBitDepth} &
511\ShortOption{\None} &
512\Default{0 \\ (InternalBitDepth)} &
513Specifies the bit depth of the output locally reconstructed video file.
514
515Note: This option has no effect on the decoding process.
516\\
517
518\Option{InputBitDepthC}%
519\Option{InternalBitDepthC}%
520\Option{OutputBitDepthC} &
521\ShortOption{\None} &
522\Default{(InputBitDepth)}%
523\Default{(InternalBitDepth)}%
524\Default{(InternalBitDepthC)} &
525Specifies the various bit-depths for chroma components.  These only need
526to be specified if non-equal luma and chroma bit-depth processing is
527required.
528\\
529
530\Option{ConformanceMode} &
531\ShortOption{\None} &
532\Default{0} &
533Specifies the conformance mode (cropping/padding parameters) to be applied to the input
534video. The following modes are available:
535\par
536\begin{tabular}{cp{0.45\textwidth}}
5370 & No cropping / padding \\
5381 & Automatic padding to the next minimum CU size \\
5392 & Padding according to parameters HorizontalPadding and VerticalPadding \\
5403 & Cropping according to parameters ConfLeft, ConfRight, ConfTop and ConfBottom \\
541\end{tabular}
542\\
543
544\Option{HorizontalPadding}%
545\Option{VerticalPadding} &
546\ShortOption{-pdx}%
547\ShortOption{-pdy} &
548\Default{0} &
549Specifies the horizontal and vertical padding to be applied to the input
550video in luma samples.  Must be a multiple of the chroma resolution
551(e.g. a multiple of two for 4:2:0).
552\\
553
554\Option{ConfLeft}%
555\Option{ConfRight}%
556\Option{ConfTop}%
557\Option{ConfBottom} &
558\ShortOption{\None} &
559\Default{0} &
560Specifies the horizontal and vertical cropping to be applied to the
561input video in luma samples.  Must be a multiple of the chroma
562resolution (e.g. a multiple of two for 4:2:0).
563\\
564
565\Option{FrameRate} &
566\ShortOption{-fr} &
567\Default{0} &
568Specifies the frame rate of the input video.
569
570Note: This option only affects the reported bit rates.
571\\
572
573\Option{FrameSkip} &
574\ShortOption{-fs} &
575\Default{0} &
576Specifies a number of frames to skip at beginning of input video file.
577\\
578
579\Option{FramesToBeEncoded} &
580\ShortOption{-f} &
581\Default{0 \\ (all)} &
582Specifies the number of frames to be encoded.
583\\
584\end{OptionTable}
585
586%%
587%% profile, level and conformance options
588%%
589\begin{OptionTable}{Profile and level parameters}
590\Option{Profile} &
591\ShortOption{\None} &
592\Default{none} &
593Specifies the profile to which the encoded bitstream complies.
594Valid values are: none, main, main10, main-still-picture.
595
596Compatibility flags are automatically determined according to the profile.
597If --Profile=main, then main10 will always be signalled as compatible.
598If --Profile=main10, then main will be signalled as compatible if the bit-depth is 8-bit.
599
600NB: There is currently no validation that the encoder configuration complies with the profile and level constraints.
601\\
602
603\Option{Level} &
604\ShortOption{\None} &
605\Default{none} &
606Specifies the level to which the encoded bitstream complies.
607Valid values are: none, 1, 2, 2.1, 3, 3.1, 4, 4.1, 5, 5.1, 5.2, 6, 6.1, 6.2.
608
609NB: There is currently no validation that the encoder configuration complies with the profile and level constraints.
610\\
611
612\Option{Tier} &
613\ShortOption{\None} &
614\Default{main} &
615Specifies the level tier to which the encoded bitsream complies.
616Valid values are: main, high.
617
618NB: There is currently no validation that the encoder configuration complies with the profile and level constraints.
619\\
620
621\Option{ProgressiveSource} &
622\ShortOption{\None} &
623\Default{false} &
624Specifies the value of general_progressive_source_flag
625\\
626
627\Option{InterlacedSource} &
628\ShortOption{\None} &
629\Default{false} &
630Specifies the value of general_interlaced_source_flag
631\\
632
633\Option{NonPackedSource} &
634\ShortOption{\None} &
635\Default{false} &
636Specifies the value of general_non_packed_constraint_flag
637\\
638
639\Option{FrameOnly} &
640\ShortOption{\None} &
641\Default{false} &
642Specifies the value of general_frame_only_constraint_flag
643\\
644
645\end{OptionTable}
646
647
648%%
649%% Unit definition parameters
650%%
651\begin{OptionTable}{Unit definition parameters}
652\Option{MaxCUWidth} &
653\ShortOption{\None} &
654\Default{64} &
655Defines the maximum CU width.
656\\
657
658\Option{MaxCUHeight} &
659\ShortOption{\None} &
660\Default{64} &
661Defines the maximum CU height.
662\\
663
664\Option{MaxCUSize} &
665\ShortOption{\None} &
666\Default{64} &
667Defines the maximum CU size.
668\\
669
670\Option{MaxPartitionDepth} &
671\ShortOption{-h} &
672\Default{4} &
673Defines the depth of the CU tree.
674\\
675
676\Option{QuadtreeTULog2MaxSize} &
677\ShortOption{\None} &
678\Default{6 \\ ($= \mathrm{log}_2(64)$)} &
679Defines the Maximum TU size in logarithm base 2.
680\\
681
682\Option{QuadtreeTULog2MinSize} &
683\ShortOption{\None} &
684\Default{2 \\ ($= \mathrm{log}_2(4)$)} &
685Defines the Minimum TU size in logarithm base 2.
686\\
687
688\Option{QuadtreeTUMaxDepthIntra} &
689\ShortOption{\None} &
690\Default{1} &
691Defines the depth of the TU tree for intra CUs.
692\\
693
694\Option{QuadtreeTUMaxDepthInter} &
695\ShortOption{\None} &
696\Default{2} &
697Defines the depth of the TU tree for inter CUs.
698\\
699\end{OptionTable}
700
701
702%%
703%% Coding structure parameters
704%%
705\begin{OptionTable}{Coding structure parameters}
706\Option{IntraPeriod} &
707\ShortOption{-ip} &
708\Default{$-1$} &
709Specifies the intra frame period.
710A value of $-1$ implies an infinite period.
711\\
712
713\Option{DecodingRefreshType} &
714\ShortOption{-dr} &
715\Default{0} &
716Specifies the type of decoding refresh to apply at the intra frame period
717picture.
718\par
719\begin{tabular}{cp{0.45\textwidth}}
7200 & Applies an I picture (not a clean random access point). \\
7211 & Applies a non-IDR clean random access point (open GOP). \\
7222 & Applies an IDR random access point (closed GOP). \\
723\end{tabular}
724\\
725
726\Option{GOPSize} &
727\ShortOption{-g} &
728\Default{1} &
729Specifies the size of the cyclic GOP structure.
730\\
731
732\Option{Frame\emph{N}} &
733\ShortOption{\None} &
734\Default{\NotSet} &
735Multiple options that define the cyclic GOP structure that will be used
736repeatedly throughout the sequence.  The table should contain GOPSize
737elements.
738\par
739See section~\ref{sec:gop-structure} for further details.
740\\
741
742\Option{ListCombination} &
743\ShortOption{-lc} &
744\Default{true} &
745Enables or disables the use of the combined reference list for uni-prediction
746in B-slices.
747\par
748\begin{tabular}{cp{0.45\textwidth}}
749  0 & Reference list~0 and reference list~1 are identical and reference
750      list~0 is used as the combined reference list. \\
751  1 & The combined reference list is derived from reference list~0 and
752      reference list~1. \\
753\end{tabular}
754NB: LComb can only be 0 in low delay coding (more precisely, when list 0
755and list 1 are the same)
756\\
757\end{OptionTable}
758
759
760%%
761%% Motion estimation parameters
762%%
763\begin{OptionTable}{Motion estimation parameters}
764\Option{FastSearch} &
765\ShortOption{\None} &
766\Default{true} &
767Enables or disables the use of a fast motion search.
768\par
769\begin{tabular}{cp{0.45\textwidth}}
770 0 & Full search method \\
771 1 & Fast search method \\
772\end{tabular}
773\\
774
775\Option{SearchRange} &
776\ShortOption{-sr} &
777\Default{96} &
778Specifies the search range used for motion estimation.
779
780Note: the search range is defined around a predictor. Motion vectors
781derived by the motion estimation may thus have values larger than the
782search range.
783\\
784
785\Option{BipredSearchRange} &
786\ShortOption{\None} &
787\Default{4} &
788Specifies the search range used for bi-prediction refinement in motion
789estimation.
790\\
791
792\Option{HadamardME} &
793\ShortOption{\None} &
794\Default{true} &
795Enables or disables the use of the Hadamard transform in fractional-pel motion
796estimation.
797\par
798\begin{tabular}{cp{0.45\textwidth}}
799 0 & SAD for cost estimation \\
800 1 & Hadamard for cost estimation \\
801\end{tabular}
802\\
803
804\Option{ASR} &
805\ShortOption{\None} &
806\Default{false} &
807Enables or disables the use of adaptive search ranges, where the motion
808search range is dynamically adjusted according to the POC difference
809between the current and the reference pictures.
810\begin{displaymath}
811\resizebox{\hsize}{!}{$
812\mathrm{SearchRange}’ = \mathrm{Round}\left(
813                          \mathrm{SearchRange}
814                          * \mathrm{ADAPT\_SR\_SCALE}
815                          * \frac{\mathrm{abs}(
816                                 \mathrm{POCcur} - \mathrm{POCref} )}{
817                                 \mathrm{RateGOPSize}}\right)
818$}
819\end{displaymath}
820\\
821\end{OptionTable}
822
823
824%%
825%% Mode decision parameters
826%%
827\begin{OptionTable}{Mode decision parameters}
828\Option{LambdaModifier$N$} &
829\ShortOption{-LM$N$} &
830\Default{1.0} &
831Specifies a value that is multiplied with the Lagrange multiplier
832$\lambda$, for use in the rate-distortion optimised cost calculation
833when encoding temporal layer~$N$.
834\par
835$N$ may be in the range 0--7.
836\\
837
838\Option{FEN} &
839\ShortOption{\None} &
840\Default{false} &
841Enables or disables the use of fast encoder mode.  When enabled,
842the following occurs:
843\begin{itemize}
844\item In the SAD computation for blocks having size larger than 8, only
845      the lines of even rows in the block are considered.
846\item The number of iterations used in the bi-directional motion vector
847      refinement in the motion estimation process is reduced from 4 to 1.
848\end{itemize}
849\\
850
851\Option{FDM} &
852\ShortOption{\None} &
853\Default{true} &
854Enables or disables the use of fast encoder decisions for 2Nx2N merge
855mode.  When enabled, the RD cost for the merge mode of the current
856candidate is not evaluated if the merge skip mode was the best merge
857mode for one of the previous candidates.
858\\
859
860\Option{RDpenalty} &
861\ShortOption{\None} &
862\Default{0} &
863RD-penalty for 32x32 TU for intra in non-intra slices.
864Enabling this parameter can reduce the visibility of CU boundaries in the coded picture.
865\par
866\begin{tabular}{cp{0.45\textwidth}}
867 0 & No RD-penalty \\
868 1 & RD-penalty \\
869 2 & Maximum RD-penalty (no 32x32 TU)\\
870\end{tabular}
871\\
872
873\end{OptionTable}
874
875%%
876%% Quantization parameters
877%%
878\begin{OptionTable}{Quantization parameters}
879\Option{QP} &
880\ShortOption{-q} &
881\Default{30.0} &
882Specifies the base value of the quantization parameter.
883\\
884
885\Option{CbQpOffset}%
886\Option{CrQpOffset} &
887\ShortOption{-cbqpofs}%
888\ShortOption{-crqpofs} &
889\Default{0}%
890\Default{0} &
891Global offset to apply to the luma QP to derive the QP of Cb and Cr
892respectively.  These options correspond to the values of cb_qp_offset
893and cr_qp_offset, that are transmitted in the PPS.  Valid values are in
894the range $[-12, 12]$.
895\\
896
897\Option{MaxCuDQPDepth} &
898\ShortOption{\None} &
899\Default{0} &
900Defines maximum depth of a minimum CuDQP for sub-LCU-level delta QP.
901MaxCuDQPDepth shall be greater than or equal to SliceGranularity.
902\\
903
904\Option{RDOQ} &
905\ShortOption{\None} &
906\Default{true} &
907Enables or disables rate-distortion-optimized quantization.
908\\
909
910\Option{RDOQTS} &
911\ShortOption{\None} &
912\Default{true} &
913Enables or disables rate-distortion-optimized quantization for transform-skipped TUs.
914\\
915
916\Option{DeltaQpRD} &
917\ShortOption{-dqr} &
918\Default{0} &
919Specifies the maximum QP offset at slice level for multi-pass slice
920encoding.  When encoding, each slice is tested multiple times by using
921slice QP values in the range $[-\mathrm{DeltaQpRD}, \mathrm{DeptaQpRD}]$,
922and the best QP value is chosen as the slice QP.
923\\
924
925\Option{MaxDeltaQP} &
926\ShortOption{-d} &
927\Default{0} &
928Specifies the maximum QP offset at the largest coding unit level for
929the block-level adaptive QP assignment scheme. In the encoder, each
930largest coding unit is tested multiple times by using the QP values in
931the range $[-\mathrm{MaxDeltaQP}, \mathrm{MaxDeltaQP}]$, and the best QP
932value is chosen as the QP value of the largest coding unit.
933\\
934
935\Option{dQPFile} &
936\ShortOption{-m} &
937\Default{\NotSet} &
938Specifies a file containing a list of QP deltas. The $n$-th line
939(where $n$ is 0 for the first line) of this file corresponds to the QP
940value delta for the picture with POC value $n$.
941\\
942
943\Option{AdaptiveQpSelection} &
944\ShortOption{-aqps} &
945\Default{false} &
946Specifies whether QP values for non-I frames will be calculated on the
947fly based on statistics of previously coded frames.
948\\
949\Option{RecalculateQPAccordingToLambda} &
950\ShortOption{\None} &
951\Default{false} &
952Recalculate QP values according to lambda values. Do not suggest to be enabled in all intra case.
953\\
954\end{OptionTable}
955
956
957%%
958%% Slice coding parameters
959%%
960\begin{OptionTable}{Slice coding parameters}
961%\Option{SliceGranularity} &
962%\ShortOption{\None} &
963%\Default{0} &
964%Determines the depth in an LCU at which slices may begin and end.
965%\par
966%\begin{tabular}{cp{0.45\textwidth}}
967% 0   & Slice addresses are LCU aligned \\
968% $1 \leq n \leq 3$
969%     & Slice start addresses are aligned to CUs at depth $n$ \\
970%\end{tabular}
971%
972%Note: The smallest permissible alignment is 16x16 CUs.
973%Values of $n$ must satisfy this constraint, for example, with a 64x64
974%LCU, $n$ must be less than or equal to 2.
975%\\
976
977\Option{SliceMode} &
978\ShortOption{\None} &
979\Default{0} &
980Controls the slice partitioning method in conjunction with
981SliceArgument.
982\par
983\begin{tabular}{cp{0.45\textwidth}}
984 0 & Single slice \\
985 1 & Maximum number of CTUs per slice \\
986 2 & Maximum number of bytes per slice \\
987 3 & Maximum number of tiles per slice \\
988\end{tabular}
989\\
990
991\Option{SliceArgument} &
992\ShortOption{\None} &
993\Default{\NotSet} &
994Specifies the maximum number of CTUs, bytes or tiles in a slice depending on the
995SliceMode setting.
996\\
997
998\Option{SliceSegmentMode} &
999\ShortOption{\None} &
1000\Default{0} &
1001Enables (dependent) slice segment coding in conjunction with
1002SliceSegmentArgument.
1003\par
1004\begin{tabular}{cp{0.45\textwidth}}
1005 0 & Single slice \\
1006 1 & Maximum number of CTUs per slice segment\\
1007 2 & Maximum number of bytes per slice segment\\
1008 3 & Maximum number of tiles per slice segment\\
1009\end{tabular}
1010\\
1011
1012\Option{SliceSegmentArgument} &
1013\ShortOption{\None} &
1014\Default{\NotSet} &
1015Defines the maximum number of CTUs, bytes or tiles a slice segment
1016depending on the SliceSegmentMode setting.
1017\\
1018
1019\Option{WaveFrontSynchro} &
1020\ShortOption{\None} &
1021\Default{false} &
1022Enables the use of specific CABAC probabilities synchronization at the
1023beginning of each line of CTBs in order to produce a bitstream that can
1024be encoded or decoded using one or more cores.
1025\\
1026
1027\Option{NumTileColumnsMinus1}%
1028\Option{NumTileRowsMinus1} &
1029\ShortOption{\None} &
1030\Default{0} &
1031Specifies the tile based picture partitioning geometry as
1032$\mathrm{NumTileColumnsMinus1} + 1 \times \mathrm{NumTileRowsMinus1} + 1$
1033columns and rows.
1034\\
1035
1036\Option{UniformSpacingIdc} &
1037\ShortOption{\None} &
1038\Default{0} &
1039Controls the mode used to determine per row and column tile sizes.
1040\par
1041\begin{tabular}{cp{0.45\textwidth}}
1042 0 & Each tile column width and tile row height is explicitly set
1043     by ColumnWidthArray and RowHeightArray respectively \\
1044 1 & Tile columns and tile rows are uniformly spaced. \\
1045\end{tabular}
1046\\
1047
1048\Option{ColumnWidthArray}%
1049\Option{RowHeightArray} &
1050\ShortOption{\None} &
1051\Default{\NotSet} &
1052Specifies a space or comma separated list of widths and heights,
1053respectively, of each tile column or tile row.  The first value in the
1054list corresponds to the leftmost tile column or topmost tile row.
1055\\
1056\end{OptionTable}
1057
1058
1059
1060%%
1061%% Deblocking filter parameters
1062%%
1063\begin{OptionTable}{Deblocking filter parameters}
1064\Option{LoopFilterDisable} &
1065\ShortOption{\None} &
1066\Default{false} &
1067Enables or disables the in-loop deblocking filter.
1068\\
1069
1070\Option{LFCrossSliceBoundaryFlag} &
1071\ShortOption{\None} &
1072\Default{true} &
1073Enables or disables the use of in-loop filtering across slice
1074boundaries.
1075\\
1076
1077\Option{DeblockingFilterControlPresent}&
1078\ShortOption{\None}&
1079\Default{false}&
1080Enables or disables the presence of the deblocking filter control
1081parameters in the picture parameter set and in the slice segment header.
1082When disabled, the default deblocking filter parameters are used.
1083\\
1084
1085\Option{LoopFilterOffsetInPPS}&
1086\ShortOption{\None}&
1087\Default{false}&
1088If enabled, the in-loop deblocking filter control parameters are sent in PPS.
1089Otherwise, the in-loop deblocking filter control parameters are sent in the slice segment header.
1090If deblocking filter parameters are sent in PPS, the same values of deblocking filter parameters
1091are used for all pictures in the sequence (i.e. deblocking parameter = base parameter value). 
1092If deblocking filter parameters are sent in the slice segment header, varying deblocking filter
1093parameters can be specified by setting parameters tcOffsetDiv2 and betaOffsetDiv2 in the GOP structure table.
1094In this case, the final value of the deblocking filter parameter sent for a certain GOP picture is equal to
1095(base parameter + GOP parameter for this picture). Intra-pictures use the base parameters values.
1096\\
1097
1098\Option{LoopFilterTcOffset_div2}&
1099\ShortOption{\None}&
1100\Default{0}&
1101Specifies the base value for the in-loop deblocking filter parameter tc_offset_div2. The final value of tc_offset_div2
1102shall be an integer number in the range $-6..6$.
1103\\
1104
1105\Option{LoopFilterBetaOffset_div2}&
1106\ShortOption{\None}&
1107\Default{0}&
1108Specifies the base value for the in-loop deblocking filter parameter beta_offset_div2. The final value of beta_offset_div2
1109shall be an integer number in the range $-6..6$.
1110\\
1111
1112\end{OptionTable}
1113
1114
1115
1116%%
1117%% Coding tools parameters
1118%%
1119\begin{OptionTable}{Coding tools parameters}
1120%\Option{ALF} &
1121%\ShortOption{\None} &
1122%\Default{true} &
1123%Enables or disables the adaptive loop filter.
1124%\\
1125
1126%\Option{ALFLowLatencyEncode} &
1127%\ShortOption{\None} &
1128%\Default{false} &
1129%Specifies the operating mode (low latency or high efficiency) of the
1130%adaptive loop filter.
1131%\\
1132
1133\Option{SAO} &
1134\ShortOption{\None} &
1135\Default{true} &
1136Enables or disables the sample adaptive offset (SAO) filter.
1137\\
1138
1139\Option{SAOLcuBoundary} &
1140\ShortOption{\None} &
1141\Default{false} &
1142Enables or disables SAO parameter estimation using non-deblocked pixels
1143for LCU bottom and right boundary areas.
1144\\
1145
1146%\Option{LMChroma} &
1147%\ShortOption{\None} &
1148%\Default{true} &
1149%Enables or disables the intra chroma-from-luma prediction mode.
1150%\\
1151
1152%\Option{NSQT} &
1153%\ShortOption{\None} &
1154%\Default{true} &
1155%Enables or disables the non-square quadtree transform.
1156%\\
1157
1158\Option{ConstrainedIntraPred} &
1159\ShortOption{\None} &
1160\Default{false} &
1161Enables or disables constrained intra prediction.  Constrained intra
1162prediction only permits samples from intra blocks in the same slice as the
1163current block to be used for intra prediction.
1164\\
1165
1166\Option{TransquantBypassEnableFlag} &
1167\ShortOption{\None} &
1168\Default{false} &
1169Enables or disables the ability to bypass the transform,
1170quantization and filtering stages at CU level.
1171This option corresponds to the value of
1172transquant_bypass_enable_flag that is transmitted in the PPS.
1173
1174See CUTransquantBypassFlagForce for further details.
1175\\
1176
1177\Option{CUTransquantBypassFlagForce} &
1178\ShortOption{\None} &
1179\Default{0} &
1180Controls the per CU transformation, quantization and filtering
1181mode decision.
1182This option controls the value of the per CU cu_transquant_bypass_flag.
1183\par
1184\begin{tabular}{cp{0.45\textwidth}}
1185 0 & Bypass is searched on a CU-by-CU basis and will be used if the cost is lower than not bypassing. \\
1186 1 & Bypass is forced for all CUs. \\
1187\end{tabular}
1188
1189This option has no effect if TransquantBypassEnableFlag is disabled.
1190\\
1191
1192\Option{PCMEnabledFlag} &
1193\ShortOption{\None} &
1194\Default{false} &
1195Enables 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.
1196\\
1197
1198\Option{PCMLog2MaxSize} &
1199\ShortOption{\None} &
1200\Default{5 \\ ($= \mathrm{log}_2(32)$)} &
1201Specifies log2 of the maximum PCM block size. When PCM is enabled, the
1202PCM mode is available for 2Nx2N intra PUs smaller than or equal to the
1203specified maximum PCM block size
1204\\
1205
1206\Option{PCMLog2MinSize} &
1207\ShortOption{\None} &
1208\Default{3} &
1209Specifies log2 of the minimum PCM block size. When PCM is enabled, the
1210PCM mode is available for 2Nx2N intra PUs larger than or equal to the
1211specified minimum PCM block size.
1212\par
1213When larger than PCMLog2MaxSize, PCM mode is not used.
1214\\
1215
1216\Option{PCMInputBitDepthFlag} &
1217\ShortOption{\None} &
1218\Default{1} &
1219If enabled specifies that PCM sample bit-depth is set equal to
1220InputBitDepth. Otherwise, it specifies that PCM sample bit-depth is set
1221equal to InternalBitDepth.
1222\\
1223
1224\Option{PCMFilterDisableFlag} &
1225\ShortOption{\None} &
1226\Default{false} &
1227If enabled specifies that loop-filtering on reconstructed samples of PCM
1228blocks is skipped. Otherwise, it specifies that loop-filtering on
1229reconstructed samples of PCM blocks is not skipped.
1230% 0 = (loop-filtering is not skipped for PCM samples).
1231\\
1232
1233\Option{WeightedPredP} &
1234\ShortOption{-wpP} &
1235\Default{false} &
1236Enables the use of weighted prediction in P slices.
1237\\
1238
1239\Option{WeightedPredB} &
1240\ShortOption{-wpB} &
1241\Default{false} &
1242Enables the use of weighted prediction in B slices.
1243\\
1244
1245\Option{SignHideFlag} &
1246\ShortOption{-SBH} &
1247\Default{true} &
1248If enabled specifies that for each 4x4 coefficient group for which the
1249number of coefficients between the first nonzero coefficient and the
1250last nonzero coefficient along the scanning line exceeds 4, the sign bit
1251of the first nonzero coefficient will not be directly transmitted in the
1252bitstream, but may be inferred from the parity of the sum of all nonzero
1253coefficients in the current coefficient group.
1254\\
1255
1256\Option{StrongIntraSmoothing} &
1257\ShortOption{-sis} &
1258\Default{true} &
1259If enabled specifies that for 32x32 intra prediction block, the intra smoothing
1260when applied is either the 1:2:1 smoothing filter or a stronger bi-linear
1261interpolation filter.  Key reference sample values are tested and if the criteria
1262is satisfied, the stronger intra smoothing filter is applied.
1263If disabled, the intra smoothing filter when applied is the 1:2:1 smoothing filter.
1264\\
1265
1266\Option{TMVPMode} &
1267\ShortOption{\None} &
1268\Default{1} &
1269Controls the temporal motion vector prediction mode.
1270\par
1271\begin{tabular}{cp{0.45\textwidth}}
1272  0 & Disabled for all slices. \\
1273  1 & Enabled for all slices. \\
1274  2 & Disabled only for the first picture of each GOPSize. \\
1275\end{tabular}
1276\\
1277
1278\Option{TransformSkip} &
1279\ShortOption{\None} &
1280\Default{false} &
1281Enables or disables transform-skipping mode decision for 4x4 TUs
1282\footnote{Enables transform_skip_enabled and per 4x4 TU tests}.
1283\\
1284
1285\Option{TransformSkipFast} &
1286\ShortOption{\None} &
1287\Default{false} &
1288Enables or disables reduced testing of the transform-skipping mode
1289decision for chroma TUs.  When enabled, no RDO search is performed for
1290chroma TUs, instead they are transform-skipped if the four corresponding
1291luma TUs are also skipped.
1292\par
1293This option has no effect if TransformSkip is disabled.
1294\\
1295\end{OptionTable}
1296
1297%%
1298%% Rate control parameters
1299%%
1300\begin{OptionTable}{Rate control parameters}
1301
1302\Option{RateControl} &
1303\ShortOption{\None} &
1304\Default{false} &
1305Rate control: enables rate control or not.
1306\\
1307
1308\Option{TargetBitrate} &
1309\ShortOption{\None} &
1310\Default{0} &
1311Rate control: target bitrate, in bps.
1312\\
1313
1314\Option{KeepHierarchicalBit} &
1315\ShortOption{\None} &
1316\Default{0} &
1317Rate control: 0: equal bit allocation among pictures;
13181: fix ratio hierarchical bit allocation; 2: adaptive hierarchical ratio bit allocation.
1319It is suggested to enable hierarchical bit allocation for hierarchical-B coding structure.
1320\\
1321
1322\Option{LCULevelRateControl} &
1323\ShortOption{\None} &
1324\Default{true} &
1325Rate control: true: LCU level RC; false: picture level RC.
1326\\
1327
1328\Option{RCLCUSeparateModel} &
1329\ShortOption{\None} &
1330\Default{true} &
1331Rate control: use LCU level separate R-lambda model or not.
1332When LCULevelRateControl is equal to false, this parameter is meaningless.
1333\\
1334
1335\Option{InitialQP} &
1336\ShortOption{\None} &
1337\Default{0} &
1338Rate control: initial QP value for the first picture.
13390 to auto determine the initial QP value.
1340\\
1341
1342\Option{RCForceIntraQP} &
1343\ShortOption{\None} &
1344\Default{false} &
1345Rate control: force intra QP to be equal to initial QP or not.
1346\\
1347\end{OptionTable}
1348
1349%%
1350%% VUI parameters
1351%%
1352\begin{OptionTable}{VUI parameters}
1353\Option{VuiParametersPresent} &
1354\ShortOption{-vui} &
1355\Default{false} &
1356Enable generation of vui_parameters().
1357\\
1358\Option{AspectRatioInfoPresent} &
1359\ShortOption{} &
1360\Default{false} &
1361Signals whether aspect_ratio_idc is present.
1362\\
1363\Option{AspectRatioIdc} &
1364\ShortOption{} &
1365\Default{0} &
1366aspect_ratio_idc
1367\\
1368\Option{SarWidth} &
1369\ShortOption{} &
1370\Default{0} &
1371Specifies the horizontal size of the sample aspect ratio.
1372\\
1373\Option{SarHeight} &
1374\ShortOption{} &
1375\Default{0} &
1376Specifies the vertical size of the sample aspect ratio.
1377\\
1378\Option{OverscanInfoPresent} &
1379\ShortOption{} &
1380\Default{false} &
1381Signals whether overscan_info_present_flag is present.
1382\\
1383\Option{OverscanAppropriate} &
1384\ShortOption{} &
1385\Default{false} &
1386Indicates whether cropped decoded pictures are suitable for display using overscan.
1387\par
1388\begin{tabular}{cp{0.45\textwidth}}
1389  0 & Indicates that the decoded pictures should not be displayed using overscan. \\
1390  1 & Indicates that the decoded pictures may be displayed using overscan. \\
1391\end{tabular}
1392\\
1393\Option{VideoSignalTypePresent} &
1394\ShortOption{} &
1395\Default{false} &
1396Signals whether video_format, video_full_range_flag, and colour_description_present_flag are present.
1397\\
1398\Option{VideoFormat} &
1399\ShortOption{} &
1400\Default{5} &
1401Indicates representation of pictures.
1402\\
1403\Option{VideoFullRange} &
1404\ShortOption{} &
1405\Default{false} &
1406Indicates the black level and range of luma and chroma signals.
1407\par
1408\begin{tabular}{cp{0.45\textwidth}}
1409  0 & Indicates that the luma and chroma signals are to be scaled prior to display. \\
1410  1 & Indicates that the luma and chroma signals are not to be scaled prior to display. \\
1411\end{tabular}
1412\\
1413\Option{ColourDescriptionPresent} &
1414\ShortOption{} &
1415\Default{false} &
1416Signals whether colour_primaries, transfer_characteristics and matrix_coefficients are present.
1417\\
1418\Option{ColourPrimaries} &
1419\ShortOption{} &
1420\Default{2} &
1421Indicates chromaticity coordinates of the source primaries.
1422\\
1423\Option{TransferCharateristics} &
1424\ShortOption{} &
1425\Default{2} &
1426Indicates the opto-electronic transfer characteristics of the source.
1427\\
1428\Option{MatrixCoefficients} &
1429\ShortOption{} &
1430\Default{2} &
1431Describes the matrix coefficients used in deriving luma and chroma from RGB primaries.
1432\\
1433\Option{ChromaLocInfoPresent} &
1434\ShortOption{} &
1435\Default{false} &
1436Signals whether chroma_sample_loc_type_top_field and chroma_sample_loc_type_bottom_field are present.
1437\\
1438\Option{ChromaSampleLocTypeTopField} &
1439\ShortOption{} &
1440\Default{0} &
1441Specifies the location of chroma samples for top field.
1442\\
1443\Option{ChromaSampleLocTypeBottomField} &
1444\ShortOption{} &
1445\Default{0} &
1446Specifies the location of chroma samples for bottom field.
1447\\
1448\Option{NeutralChromaIndication} &
1449\ShortOption{} &
1450\Default{false} &
1451Indicates that the value of all decoded chroma samples is equal to 1<<(BitDepthCr-1).
1452\\
1453
1454\Option{DefaultDisplayWindowFlag} &
1455\ShortOption{\None} &
1456\Default{0} &
1457Indicates the presence of the Default Window parameters.
1458\par
1459\begin{tabular}{cp{0.45\textwidth}}
14600 & Disabled \\
14611 & Enabled \\
1462\end{tabular}
1463\\
1464
1465\Option{DefDispWinLeftOffset}%
1466\Option{DefDispWinRightOffset}%
1467\Option{DefDispWinTopOffset}%
1468\Option{DefDispWinBottomOffset} &
1469\ShortOption{\None} &
1470\Default{0} &
1471Specifies the horizontal and vertical offset to be applied to the
1472input video from the conformance window in luma samples.
1473Must be a multiple of the chroma resolution (e.g. a multiple of two for 4:2:0).
1474\\
1475
1476\Option{BitstreamRestriction} &
1477\ShortOption{} &
1478\Default{false} &
1479Signals whether bitstream restriction parameters are present.
1480\\
1481\Option{TilesFixedStructure} &
1482\ShortOption{} &
1483\Default{false} &
1484Indicates that each active picture parameter set has the same values of the syntax elements related to tiles.
1485\\
1486\Option{MotionVectorsOverPicBoundaries} &
1487\ShortOption{} &
1488\Default{false} &
1489Indicates that no samples outside the picture boundaries are used for inter prediction.
1490\\
1491\Option{MaxBytesPerPicDenom} &
1492\ShortOption{} &
1493\Default{2} &
1494Indicates a number of bytes not exceeded by the sum of the sizes of the VCL NAL units associated with any coded picture.
1495\\
1496\Option{MaxBitsPerMinCuDenom} &
1497\ShortOption{} &
1498\Default{1} &
1499Indicates an upper bound for the number of bits of coding_unit() data.
1500\\
1501\Option{Log2MaxMvLengthHorizontal} &
1502\ShortOption{} &
1503\Default{15} &
1504Indicate the maximum absolute value of a decoded horizontal MV component in quarter-pel luma units.
1505\\
1506\Option{Log2MaxMvLengthVertical} &
1507\ShortOption{} &
1508\Default{15} &
1509Indicate the maximum absolute value of a decoded vertical MV component in quarter-pel luma units.
1510\\
1511\end{OptionTable}
1512
1513%%
1514%% SEI messages
1515%%
1516\begin{OptionTable}{SEI messages}
1517\Option{SEIDecodedPictureHash} &
1518\ShortOption{\None} &
1519\Default{0} &
1520Enables or disables the calculation and insertion of the Decoded picture hash
1521SEI messages.
1522\par
1523\begin{tabular}{cp{0.45\textwidth}}
1524  0 & Disabled \\
1525  1 & Transmits MD5 in SEI message and writes the value to the encoder
1526      log \\
1527  2 & Transmits CRC in SEI message and writes the value to the encoder
1528      log \\
1529  3 & Transmits checksum in SEI message and writes the value to the encoder
1530      log \\
1531\end{tabular}
1532\\
1533\Option{SEIpictureDigest} &
1534\ShortOption{\None} &
1535\Default{0} &
1536Deprecated alias for SEIDecodedPictureHash.
1537Do not use anymore.
1538\\
1539\Option{SEIRecoveryPoint} &
1540\ShortOption{\None} &
1541\Default{0} &
1542Enables or disables the insertion of the Recovery point
1543SEI messages.
1544\\
1545\Option{SEIActiveParameterSets} &
1546\ShortOption{\None} &
1547\Default{0} &
1548Enables or disables the insertion of the Active parameter sets
1549SEI messages.
1550\\
1551\Option{SEIBufferingPeriod} &
1552\ShortOption{\None} &
1553\Default{0} &
1554Enables or disables the insertion of the Buffering period
1555SEI messages. This option has no effect if VuiParametersPresent is disabled.
1556SEIBufferingPeriod requires SEIActiveParameterSets to be enabled.
1557\\
1558\Option{SEIPictureTiming} &
1559\ShortOption{\None} &
1560\Default{0} &
1561Enables or disables the insertion of the Picture timing
1562SEI messages. This option has no effect if VuiParametersPresent is disabled.
1563\\
1564\Option{SEIDecodingUnitInfo} &
1565\ShortOption{\None} &
1566\Default{0} &
1567Enables or disables the insertion of the Decoding unit information
1568SEI messages. This option has no effect if VuiParametersPresent is disabled.
1569\\
1570\Option{SEIGradualDecodingRefreshInfo} &
1571\ShortOption{\None} &
1572\Default{0} &
1573Enables or disables the insertion of the Gradual decoding refresh information
1574SEI messages.
1575\\
1576\Option{SEITemporalLevel0Index} &
1577\ShortOption{\None} &
1578\Default{0} &
1579Enables or disables the insertion of the Temporal level zero index
1580SEI messages.
1581\\
1582\Option{SEIDisplayOrientation} &
1583\ShortOption{\None} &
1584\Default{0} &
1585Enables or disables the insertion of the Display orientation
1586SEI messages.
1587\par
1588\begin{tabular}{cp{0.30\textwidth}}
1589  0 & Disabled \\
1590  N: $0 < N < (2^{16} - 1)$ & Enable display orientation SEI message with
1591  \mbox{anticlockwise_rotation = N} 
1592  and \mbox{display_orientation_repetition_period = 1} \\
1593\end{tabular}
1594\\
1595\Option{SEIFramePacking} &
1596\ShortOption{\None} &
1597\Default{0} &
1598Enables or disables the insertion of the Frame packing arrangement SEI messages.
1599\\
1600\Option{SEIFramePackingType} &
1601\ShortOption{\None} &
1602\Default{0} &
1603Indicates the arrangement type in the Frame packing arrangement SEI message.
1604This option has no effect if SEIFramePacking is disabled.
1605\par
1606\begin{tabular}{cp{0.45\textwidth}}
1607  3 & Side by Side \\
1608  4 & Top Bottom \\
1609  5 & Frame Alternate \\
1610\end{tabular}
1611\\
1612\Option{SEIFramePackingInterpretation} &
1613\ShortOption{\None} &
1614\Default{0} &
1615Indicates the constituent frames relationship in the Frame packing arrangement SEI message.
1616This option has no effect if SEIFramePacking is disabled.
1617\par
1618\begin{tabular}{cp{0.45\textwidth}}
1619  0 & Unspecified \\
1620  1 & Frame 0 is associated with the left view of a stereo pair \\
1621  2 & Frame 0 is associated with the right view of a stereo pair \\
1622\end{tabular}
1623\\
1624\Option{SEIFramePackingQuincunx} &
1625\ShortOption{\None} &
1626\Default{0} &
1627Enables or disables the quincunx_sampling signalling in the
1628Frame packing arrangement SEI messages. This option has no
1629effect if SEIFramePacking is disabled.
1630\\
1631\Option{SEIFramePackingId} &
1632\ShortOption{\None} &
1633\Default{0} &
1634Indicates the session number in the Frame packing arrangement
1635SEI messages. This option has no effect if SEIFramePacking is
1636disabled.
1637\\
1638\Option{SEIToneMappingInfo} &
1639\ShortOption{\None} &
1640\Default{0} &
1641Enables or disables the insertion of the Tone Mapping SEI message.
1642\\
1643\Option{SEIToneMapId} &
1644\ShortOption{\None} &
1645\Default{0} &
1646Specifies Id of Tone Mapping SEI message for a given session.
1647\\
1648\Option{SEIToneMapCancelFlag} &
1649\ShortOption{\None} &
1650\Default{0} &
1651Indicates that Tone Mapping SEI message cancels the persistance or follows.
1652\\
1653\Option{SEIToneMapPersistenceFlag} &
1654\ShortOption{\None} &
1655\Default{1} &
1656Specifies the persistence of the Tone Mapping SEI message.
1657\\
1658\Option{SEIToneMapCodedDataBitDepth} &
1659\ShortOption{\None} &
1660\Default{10} &
1661Specifies Coded Data BitDepth of Tone Mapping SEI messages.
1662\\
1663\Option{SEIToneMapTargetBitDepth} &
1664\ShortOption{\None} &
1665\Default{8} &
1666Specifies Output BitDepth of Tome mapping function.
1667\\
1668\Option{SEIToneMapModelId} &
1669\ShortOption{\None} &
1670\Default{0} &
1671Specifies Model utilized for mapping coded data into
1672target_bit_depth range.
1673\par
1674\begin{tabular}{cp{0.45\textwidth}}
1675  0 & linear mapping with clipping \\
1676  1 & sigmoidal mapping \\
1677  2 & user-defined table mapping \\
1678  3 & piece-wise linear mapping \\
1679  4 & luminance dynamic range mapping \\
1680\end{tabular}
1681\\
1682\Option{SEIToneMapMinValue} &
1683\ShortOption{\None} &
1684\Default{0} &
1685Specifies the minimum value in mode 0.
1686\\
1687\Option{SEIToneMapMaxValue} &
1688\ShortOption{\None} &
1689\Default{1023} &
1690Specifies the maxmum value in mode 0.
1691\\
1692\Option{SEIToneMapSigmoidMidpoint} &
1693\ShortOption{\None} &
1694\Default{512} &
1695Specifies the centre point in mode 1.
1696\\
1697\Option{SEIToneMapSigmoidWidth} &
1698\ShortOption{\None} &
1699\Default{960} &
1700Specifies the distance between 5% and 95% values of
1701the target_bit_depth in mode 1.
1702\\
1703\Option{SEIToneMapStartOfCodedInterval} &
1704\ShortOption{\None} &
1705\Default{\None} &
1706Array of user-defined mapping table.
1707Default table can be set to the following:
1708\par
1709\begin{tabular}{cp{0.45\textwidth}}
17100 12 24 36 48 60 72 84 96 108 120 132 144 156 168 180
1711192 192 196 204 208 216 220 228 232 240 248 252 260 264
1712272 276 284 292 292 296 300 304 308 312 320 324 328 332
1713336 344 348 352 356 360 368 372 376 380 384 388 396 400
1714404 408 412 420 424 428 432 436 444 444 444 448 452 456
1715460 464 468 472 476 476 480 484 488 492 496 500 504 508
1716508 512 516 520 524 528 532 536 540 540 544 548 552 556
1717560 564 568 572 572 576 580 584 588 592 596 600 604 604
1718608 612 616 620 624 628 632 636 636 640 644 648 652 656
1719660 664 668 672 672 672 676 680 680 684 688 692 692 696
1720700 704 704 708 712 716 716 720 724 724 728 732 736 736
1721740 744 748 748 752 756 760 760 764 768 768 772 776 780
1722780 784 788 792 792 796 800 804 804 808 812 812 816 820
1723824 824 828 832 836 836 840 844 848 848 852 856 860 860
1724860 864 864 868 872 872 876 880 880 884 884 888 892 892
1725896 900 900 904 908 908 912 912 916 920 920 924 928 928
1726932 936 936 940 940 944 948 948 952 956 956 960 964 964
1727968 968 972 976 976 980 984 984 988 992 992 996 996 1000
17281004 1004 1008 1012 1012 1016 1020 1024
1729\end{tabular}
1730\\
1731\Option{SEIToneMapNumPivots} &
1732\ShortOption{\None} &
1733\Default{5} &
1734Specifies the number of pivot points in mode 3.
1735\\
1736\Option{SEIToneMapCodedPivotValue} &
1737\ShortOption{\None} &
1738\Default{\None} &
1739Array of coded pivot point in mode 3.
1740Default table can be set to the following:
1741\par
1742\begin{tabular}{cp{0.45\textwidth}}
174364 128 256 512 768
1744\end{tabular}
1745\\
1746\Option{SEIToneMapTargetPivotValue} &
1747\ShortOption{\None} &
1748\Default{\None} &
1749Array of target pivot point in mode 3.
1750Default table can be set to the following:
1751\par
1752\begin{tabular}{cp{0.45\textwidth}}
175348 73 111 168 215
1754\end{tabular}
1755\\
1756\Option{SEIToneMapCameraIsoSpeedIdc} &
1757\ShortOption{\None} &
1758\Default{0} &
1759Indicates the camera ISO speed for daylight illumination.
1760\\
1761\Option{SEIToneMapCameraIsoSpeedValue} &
1762\ShortOption{\None} &
1763\Default{400} &
1764Specifies the camera ISO speed for daylight illumination of Extended_ISO.
1765\\
1766\Option{SEIToneMapExposureIndexIdc} &
1767\ShortOption{\None} &
1768\Default{0} &
1769Indicates the exposure index setting of the camera.
1770\\
1771\Option{SEIToneMapExposureIndexValue} &
1772\ShortOption{\None} &
1773\Default{400} &
1774Specifies the exposure index setting of the cameran of Extended_ISO.
1775\\
1776\Option{SEIToneMapExposureCompensationValueSignFlag} &
1777\ShortOption{\None} &
1778\Default{0} &
1779Specifies the sign of ExposureCompensationValue.
1780\\
1781\Option{SEIToneMapExposureCompensationValueNumerator} &
1782\ShortOption{\None} &
1783\Default{0} &
1784Specifies the numerator of ExposureCompensationValue.
1785\\
1786\Option{SEIToneMapExposureCompensationValueDenomIdc} &
1787\ShortOption{\None} &
1788\Default{2} &
1789Specifies the denominator of ExposureCompensationValue.
1790\\
1791\Option{SEIToneMapRefScreenLuminanceWhite} &
1792\ShortOption{\None} &
1793\Default{350} &
1794Specifies reference screen brightness setting in units of candela per square metre.
1795\\
1796\Option{SEIToneMapExtendedRangeWhiteLevel} &
1797\ShortOption{\None} &
1798\Default{800} &
1799Indicates the luminance dynamic range.
1800\\
1801\Option{SEIToneMapNominalBlackLevelLumaCodeValue} &
1802\ShortOption{\None} &
1803\Default{16} &
1804Specifies luma sample value of the nominal black level assigned decoded pictures.
1805\\
1806\Option{SEIToneMapNominalWhiteLevelLumaCodeValue} &
1807\ShortOption{\None} &
1808\Default{235} &
1809Specifies luma sample value of the nominal white level assigned decoded pictures.
1810\\
1811\Option{SEIToneMapExtendedWhiteLevelLumaCodeValue} &
1812\ShortOption{\None} &
1813\Default{300} &
1814Specifies luma sample value of the extended dynamic range assigned decoded pictures.
1815\\
1816\end{OptionTable}
1817
1818%%
1819%%
1820%%
1821\subsection{Hardcoded encoder parameters}
1822\begin{MacroTable}{CommonDef.h constants}
1823ADAPT_SR_SCALE &
18241 &
1825Defines a scaling factor used to derive the motion search range is
1826adaptive (see ASR configuration parameter). Default value is 1.
1827\\
1828
1829MAX_GOP &
183064 &
1831maximum size of value of hierarchical GOP.
1832\\
1833
1834MAX_NUM_REF &
18354 &
1836maximum number of multiple reference frames
1837\\
1838
1839MAX_NUM_REF_LC &
18408 &
1841maximum number of combined reference frames
1842\\
1843
1844AMVP_MAX_NUM_CANDS &
18452 &
1846maximum number of final candidates
1847\\
1848
1849AMVP_MAX_NUM_CANDS_MEM &
18503 &
1851\\
1852
1853MRG_MAX_NUM_CANDS &
18545 &
1855\\
1856
1857DYN_REF_FREE &
1858off &
1859dynamic free of reference memories
1860\\
1861
1862MAX_TLAYER &
18638 &
1864maximum number of temporal layers
1865\\
1866
1867HB_LAMBDA_FOR_LDC &
1868on &
1869use of B-style lambda for non-key pictures in low-delay mode
1870\\
1871
1872GPB_SIMPLE &
1873on &
1874Fast estimation of generalized B in low-delay mode
1875\\
1876
1877GPB_SIMPLE_UNI &
1878on &
1879Fast estimation of generalized B in low-delay mode for uni-direction
1880\\
1881
1882FASTME_SMOOTHER_MV &
1883on &
1884Fast ME using smoother MV assumption
1885\\
1886
1887ADAPT_SR_SCALE &
1888on &
1889division factor for adaptive search range
1890\\
1891
1892CLIP_TO_709_RANGE &
1893off &
1894\\
1895
1896EARLY_SKIP_THRES &
18971.5 &
1898early skip if RD < EARLY_SKIP_THRES*avg[BestSkipRD]
1899\\
1900
1901MAX_NUM_REF_PICS &
190216 &
1903\\
1904
1905MAX_CHROMA_FORMAT_IDC &
19063 &
1907\\
1908\end{MacroTable}
1909
1910\subsubsection*{TypeDef.h}
1911Numerous constants that guard individual adoptions are defined within
1912\url{source/Lib/TLibCommon/TypeDef.h}.
1913
1914%%
1915%%
1916%%
1917\clearpage
1918\section{Using the decoder}
1919\begin{verbatim}
1920TAppDecoder -b str.bin -o dec.yuv [options]
1921\end{verbatim}
1922
1923\begin{OptionTable}{Decoder options}
1924\Option{} &
1925\ShortOption{-h} &
1926\Default{\None} &
1927Prints usage information.
1928\\
1929
1930\Option{} &
1931\ShortOption{-o} &
1932\Default{\NotSet} &
1933Defines reconstructed YUV file name.
1934\\
1935
1936\Option{} &
1937\ShortOption{-s} &
1938\Default{0} &
1939Defines the number of pictures in decoding order to skip.
1940\\
1941
1942\Option{OutputBitDepth} &
1943\ShortOption{-d} &
1944\Default{0 \\ (Native)} &
1945Specifies the luma bit-depth of the reconstructed YUV file (the value 0 indicates
1946that the native bit-depth is used)
1947\\
1948
1949\Option{OutputBitDepthC} &
1950\ShortOption{\None} &
1951\Default{0 \\ (Native)} &
1952Defines the chroma bit-depth of the reconstructed YUV file (the value 0 indicates
1953that the native bit-depth is used)
1954\\
1955
1956\Option{SEIPictureDigest} &
1957\ShortOption{\None} &
1958\Default{1} &
1959Enable or disable verification of any Picture hash SEI messages. When
1960this parameter is set to 0, the feature is disabled and all messages are
1961ignored. When set to 1 (default), the feature is enabled and the decoder
1962has the following behaviour:
1963\begin{itemize}
1964\item
1965  If Picture hash SEI messages are included in the bitstream, the same type
1966  of hash is calculated for each decoded picture and written to the
1967  log together with an indication whether the calculted value matches
1968  the value in the SEI message.
1969  Decoding will continue even if there is a mismatch.
1970
1971\item
1972  After decoding is complete, if any MD5sum comparison failed, a warning
1973  is printed and the decoder exits with the status EXIT_FAILURE
1974
1975\item
1976  The per-picture MD5 log message has the following formats:
1977  [MD5:d41d8cd98f00b204e9800998ecf8427e,(OK)],
1978  [MD5:d41d8cd98f00b204e9800998ecf8427e,(unk)],
1979  [MD5:d41d8cd98f00b204e9800998ecf8427e,(***ERROR***)] [rxMD5:b9e1...]
1980  where, "(unk)" implies that no MD5 was signalled for this picture,
1981  "(OK)" implies that the decoder agrees with the signalled MD5,
1982  "(***ERROR***)" implies that the decoder disagrees with the signalled
1983  MD5. "[rxMD5:...]" is the signalled MD5 if different.
1984\end{itemize}
1985\\
1986
1987\Option{RespectDefDispWindow} &
1988\ShortOption{-w} &
1989\Default{0} &
1990Video region to be output by the decoder.
1991\par
1992\begin{tabular}{cp{0.45\textwidth}}
1993  0 & Output content inside the conformance window. \\
1994  1 & Output content inside the default window. \\
1995\end{tabular}
1996\\
1997
1998\end{OptionTable}
1999
2000
2001\end{document}
Note: See TracBrowser for help on using the repository browser.