Changeset 1386 in 3DVCSoftware for trunk/doc/software-manual.tex

Timestamp:

13 Nov 2015, 16:29:39 (9 years ago)

Author:

tech

Message:

Merged 15.1-dev1@1381.

File:

• trunk/doc/software-manual.tex (modified) (15 diffs)

trunk/doc/software-manual.tex

@@ -4 +4 @@
 
 \usepackage{hyperref}
-\hypersetup{colorlinks=true}
+\hypersetup{colorlinks=true,
+            linkcolor=black,      % color of internal links (change box color with linkbordercolor)
+            citecolor=black,      % color of links to bibliography
+            filecolor=black,      % color of file links
+            urlcolor=blue}
 \usepackage{color,soul}
 
@@ -187 +191 @@
 \begin{abstract}
 This document is a user manual describing usage of reference software
-for the HEVC project. It applies to version 16.6
+for the HEVC project. It applies to version 16.7
 of the software.
 \end{abstract}
@@ -241 +245 @@
 % Environment          & Location of project file \\
 \hline
-MS Visual Studio 8   & build/HM_vc8.sln \\
-MS Visual Studio 9   & build/HM_vc9.sln \\
-MS Visual Studio 10  & build/HM_vc10.sln \\
-Xcode                & HM.xcodeproj \\
-Linux                & build/linux/makefile \\
+MS Visual Studio 2008 (VC9)   & build/HM_vc9.sln \\
+MS Visual Studio 2010 (VC10)  & build/HM_vc2010.sln \\
+MS Visual Studio 2012 (VC11)  & build/HM_vc2012.sln \\
+MS Visual Studio 2013 (VC12)  & build/HM_vc2013.sln \\
+Xcode                         & HM.xcodeproj \\
+Eclipse                       & .project .cproject \\
+make/gcc (e.g. Linux)         & build/linux/makefile \\
 \hline
 \end{tabular}
@@ -483 +489 @@
 
 \setlength{\algomargin}{2em}
-\begin{algorithm}[h]
+\begin{algorithm}[ht]
 \SetKwData{deltaRIdx}{deltaRIdx}
 \SetKwData{deltaRPS}{deltaRPS}
@@ -793 +799 @@
 \\
 
+\Option{AccessUnitDelimiter} &
+%\ShortOption{\None} &
+\Default{0} &
+Add Access Unit Delimiter NAL units between all Access Units.
+\\
+
 \end{OptionTableNoShorthand}
 
@@ -1004 +1016 @@
 \begin{tabular}{cp{0.45\textwidth}}
  0 & Full search method \\
- 1 & Fast search method \\
- 2 & Previous motion vector fast search method \\
+ 1 & Fast search method - TZSearch\\
+ 2 & Predictive motion vector fast search method \\
+ 3 & Extended TZSearch method \\
 \end{tabular}
 \\
@@ -1094 +1107 @@
 $\lambda$, for use in the rate-distortion optimised cost calculation
 when encoding temporal layer~$N$.
+If LambdaModifierI is specified, then LambdaModifierI will be used for intra pictures.
 \par
 $N$ may be in the range 0 (inclusive) to 7 (exclusive).
 \\
 
+\Option{LambdaModifierI (-LMI)} &
+%\ShortOption{-LMI} &
+\Default{} &
+Specifies one or more of the LambdaModifiers to use intra pictures at each of the temporal layers.
+If not present, then the LambdaModifier$N$ settings are used instead. If the list of values
+(comma or space separated) does not include enough values for each of the temporal layers,
+the last value is repeated as required.
+\\
+
+\Option{IQPFactor (-IQF)} &
+%\ShortOption{-IQF} &
+\Default{-1} &
+Specifies the QP factor to be used for intra pictures during the lambda computation.
+(The values specified in the GOP structure are only used for inter pictures).
+If negative (default), the following equation is used to derive the value:
+\par
+$IQP_{factor}=0.57*(1.0-Max(0.5, Min(0.0, 0.05*s)))$
+\par
+where $s = Int(isField ? (GS-1)/2 : GS-1)$ and
+$GS$ is the gop size.
+\\
+
 \Option{ECU} &
 %\ShortOption{\None} &
@@ -1118 +1154 @@
 \Option{FEN} &
 %\ShortOption{\None} &
-\Default{false} &
-Enables or disables the use of fast encoder mode.  When enabled,
-the following occurs:
-\begin{itemize}
-\item In the SAD computation for blocks having size larger than 8, only
-      the lines of even rows in the block are considered.
-\item The number of iterations used in the bi-directional motion vector
-      refinement in the motion estimation process is reduced from 4 to 1.
-\end{itemize}
+\Default{0} &
+Controls the use of different fast encoder coding tools.  The following
+tools are supported in different combinations:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+ a & In the SAD computation for blocks having size larger than 8, only
+     the lines of even rows in the block are considered. \\
+ b & The number of iterations used in the bi-directional motion vector
+     refinement in the motion estimation process is reduced from 4 to 1. \\
+\end{tabular}
+Depending on the value of the parameter, the following combinations are
+supported:
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+ 0 & Disable all modes \\
+ 1 & Use both a \& b tools\\
+ 2 & Use only tool b \\
+ 3 & Use only tool a \\
+\end{tabular}
 \\
 
@@ -1596 +1642 @@
 \\
 
+\Option{WPMethod (-wpM)} &
+%\ShortOption{\-wpM} &
+\Default{0} &
+Sets the Weighted Prediction method to be used.
+\par
+\begin{tabular}{cp{0.45\textwidth}}
+  0 & Image DC based method with joint color component decision. \\
+  1 & Image DC based method with separate color component decision. \\
+  2 & DC + Histogram refinement method (no clipping). \\
+  3 & DC + Histogram refinement method (with clipping). \\
+  4 & DC + Dual Histogram refinement method (with clipping). \\
+\end{tabular}
+\\
+
+
 \Option{Log2ParallelMergeLevel} &
 %\ShortOption{\None} &
@@ -1703 +1764 @@
 \Default{false} &
 Rate control: force intra QP to be equal to initial QP or not.
+\\
+
+\Option{RCCpbSaturation} &
+%\ShortOption{\None} &
+\Default{false} &
+Rate control: enable target bits saturation to avoid CPB overflow and underflow or not.
+\\
+
+\Option{RCCpbSize} &
+%\ShortOption{\None} &
+\Default{0} &
+Rate control: CPB size, in bps.
+\\
+
+\Option{RCInitialCpbFullness} &
+%\ShortOption{\None} &
+\Default{0.9} &
+Rate control: ratio of initial CPB fullness per CPB size. (InitalCpbFullness/CpbSize)
+RCInitialCpbFullness should be smaller than or equal to 1.
 \\
 \end{OptionTableNoShorthand}
@@ -1978 +2058 @@
   140 & Chroma resampling filter hint            & Table \ref{tab:chroma-resampling-filter-hint} \\
   141 & Knee function information                & Table \ref{tab:sei-knee-function} \\
-  142 & Colour remapping information             & (Not handled)\\
+  142 & Colour remapping information             & Table \ref{tab:sei-colour-remapping}\\
   143 & Deinterlaced field identification        & (Not handled)\\
 \end{SEIListTable}
@@ -2469 +2549 @@
 
 \begin{OptionTableNoShorthand}{Chroma resampling filter hint SEI message encoder parameters}{tab:chroma-resampling-filter-hint}
-\Option{SEIChromaSamplingFilterHint} &
+\Option{SEIChromaResamplingFilterHint} &
 \Default{false} &
 When true (non-zero), generates example chroma sampling filter hint SEI messages.
 \\
-\Option{SEIChromaSamplingHorizontalFilterType} &
+\Option{SEIChromaResamplingHorizontalFilterType} &
 \Default{2} &
 Defines the index of the chroma sampling horizontal filter:
@@ -2483 +2563 @@
 \end{tabular}
 \\
-\Option{SEIChromaSamplingVerticalFilterType} &
+\Option{SEIChromaResamplingVerticalFilterType} &
 \Default{2} &
 Defines the index of the chroma sampling vertical filter:
@@ -2549 +2629 @@
 100 250 450
 \end{tabular}
+\\
+\end{OptionTableNoShorthand}
+
+
+\begin{OptionTableNoShorthand}{Colour remapping SEI message encoder parameters}{tab:sei-colour-remapping}
+\Option{SEIColourRemappingInfoFileRoot (-cri)} &
+\Default{\NotSet} &
+Specifies the prefix of input Colour Remapping Information file. Prefix is completed by ``_x.txt'' where x is the  POC number.
+The contents of the file are a list of the SEI message's syntax element names (in decoding order) immediately followed by a `:' and then the associated value.
+An example file can be found in cfg/misc/example_colour_remapping_sei_encoder_0.txt.
 \\
 \end{OptionTableNoShorthand}
@@ -2731 +2821 @@
 \\
 
+\Option{SEIColourRemappingInfoFilename} &
+%\ShortOption{\None} &
+\Default{\NotSet} &
+Specifies that the colour remapping SEI message should be applied to the output video, with the output written to this file.
+If no value is specified, the SEI message is ignored and no mapping is applied.
+\\
+
 \Option{RespectDefDispWindow (-w)} &
 %\ShortOption{-w} &