source: 3DVCSoftware/branches/HTM-8.2-dev3-Samsung/doc/software-manual.tex

Last change on this file was 608, checked in by tech, 11 years ago

Merged DEV-2.0-dev0@604.

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