[x265-commits] [x265] rest: document the behavior of --subme

[Steve Borho]

details:   http://hg.videolan.org/x265/rev/939de245ea5f
branches:  
changeset: 6596:939de245ea5f
user:      Steve Borho <steve at borho.org>
date:      Tue Mar 25 21:39:52 2014 -0500
description:
rest: document the behavior of --subme
Subject: [x265] rest: improve the description of --rect --amp

details:   http://hg.videolan.org/x265/rev/0de64941eec8
branches:  
changeset: 6597:0de64941eec8
user:      Steve Borho <steve at borho.org>
date:      Tue Mar 25 21:43:07 2014 -0500
description:
rest: improve the description of --rect --amp
Subject: [x265] rest: improve --tu-*-depth, --ref, and --tskip descriptions

details:   http://hg.videolan.org/x265/rev/2404a23fb957
branches:  
changeset: 6598:2404a23fb957
user:      Steve Borho <steve at borho.org>
date:      Tue Mar 25 22:09:00 2014 -0500
description:
rest: improve --tu-*-depth, --ref, and --tskip descriptions

diffstat:

 doc/reST/cli.rst |  51 ++++++++++++++++++++++++++++++++++++++++++++-------
 1 files changed, 44 insertions(+), 7 deletions(-)

diffs (95 lines):

diff -r 82e2254874b1 -r 2404a23fb957 doc/reST/cli.rst
--- a/doc/reST/cli.rst	Tue Mar 25 21:06:23 2014 -0500
+++ b/doc/reST/cli.rst	Tue Mar 25 22:09:00 2014 -0500
@@ -225,11 +225,19 @@ Quad-Tree analysis
 
 .. option:: --tu-intra-depth <1..4>
 
-	Max TU recursive depth for intra CUs. Default: 1
+	The transform unit (residual) quad-tree begins with the same depth
+	as the coding unit quad-tree, but the encoder may decide to further
+	split the transform unit tree if it improves compression efficiency.
+	This setting limits the number of extra recursion depth which can be
+	attempted for intra coded units. Default: 1
 
 .. option:: --tu-inter-depth <1..4>
 
-	Max TU recursive depth for inter CUs. Default: 1
+	The transform unit (residual) quad-tree begins with the same depth
+	as the coding unit quad-tree, but the encoder may decide to further
+	split the transform unit tree if it improves compression efficiency.
+	This setting limits the number of extra recursion depth which can be
+	attempted for inter coded units. Default: 1
 
 
 Temporal / motion search options
@@ -248,7 +256,28 @@ Temporal / motion search options
 
 .. option:: --subme, -m <0..7>
 
-	Amount of subpel refinement to perform. Default 2
+	Amount of subpel refinement to perform. The higher the number the
+	more subpel iterations and steps are performed. Default 2
+
+	+----+------------+-----------+------------+-----------+-----------+
+	| -m | HPEL iters | HPEL dirs | QPEL iters | QPEL dirs | HPEL SATD |
+	+====+============+===========+============+===========+===========+
+	|  0 | 1          | 4         | 0          | 4         | false     |
+	+----+------------+-----------+------------+-----------+-----------+
+	|  1 | 1          | 4         | 1          | 4         | false     |
+	+----+------------+-----------+------------+-----------+-----------+
+	|  2 | 1          | 4         | 1          | 4         | true      |
+	+----+------------+-----------+------------+-----------+-----------+
+	|  3 | 2          | 4         | 1          | 4         | true      |
+	+----+------------+-----------+------------+-----------+-----------+
+	|  4 | 2          | 4         | 2          | 4         | true      |
+	+----+------------+-----------+------------+-----------+-----------+
+	|  5 | 1          | 8         | 1          | 8         | true      |
+	+----+------------+-----------+------------+-----------+-----------+
+	|  6 | 2          | 8         | 1          | 8         | true      |
+	+----+------------+-----------+------------+-----------+-----------+
+	|  7 | 2          | 8         | 2          | 8         | true      |
+	+----+------------+-----------+------------+-----------+-----------+
 
 .. option:: --merange <integer>
 
@@ -258,11 +287,16 @@ Temporal / motion search options
 
 .. option:: --rect, --no-rect
 
-	Enable rectangular motion partitions Nx2N and 2NxN. Default enabled
+	Enable analysis of rectangular motion partitions Nx2N and 2NxN
+	(50/50 splits, two directions).  Default enabled
 
 .. option:: --amp, --no-amp
 
-	Enable asymmetric motion partitions, requires rect. Default enabled
+	Enable analysis of asymmetric motion partitions (75/25 splits, four
+	directions). This setting has no effect if rectangular partitions
+	are disabled. Even there are four possible AMP partitions, only the
+	most likely candidate is tested, based on the results of the
+	rectangular mode tests. Default enabled
 
 .. option:: --max-merge <1..5>
 
@@ -287,7 +321,10 @@ Temporal / motion search options
 
 .. option:: --ref <1..16>
 
-	Max number of L0 references to be allowed. Default 3
+	Max number of L0 references to be allowed. This number has a linear
+	multiplier effect on the amount of work performed in motion search,
+	but will generally have a beneficial affect on compression and
+	distortion. Default 3
 
 .. option:: --weightp, -w, --no-weightp
 
@@ -306,7 +343,7 @@ Spatial/intra options
 .. option:: --tskip, --no-tskip
 
 	Enable intra transform skipping (encode residual as coefficients)
-	for intra coded TU. Default disabled
+	for intra coded blocks. Default disabled
 
 .. option:: --tskip-fast, --no-tskip-fast