[doc] update manpage and readme

This commit is contained in:
Joose Sainio 2022-06-28 16:25:25 +03:00
parent 68243e284f
commit 06d277bc78
3 changed files with 26 additions and 1 deletions

View file

@ -99,6 +99,8 @@ Options:
bits, lambda, distortion, and qp for each ctu. bits, lambda, distortion, and qp for each ctu.
These are meant for debugging and are not These are meant for debugging and are not
written unless the prefix is defined. written unless the prefix is defined.
--cabac-debug-file : A debug file for cabac context.
Ignore this, it is only for tests.
Video structure: Video structure:
-q, --qp <integer> : Quantization parameter [22] -q, --qp <integer> : Quantization parameter [22]
@ -180,6 +182,8 @@ Video structure:
same length, start with same value, and can same length, start with same value, and can
contain maximum 16 or 36 - starting value contain maximum 16 or 36 - starting value
elements. [17,27,32,44] elements. [17,27,32,44]
--(no-)dual-tree : Use separate CTU structure for luma and
chroma in intra slices.
Compression tools: Compression tools:
--(no-)deblock <beta:tc> : Deblocking filter. [0:0] --(no-)deblock <beta:tc> : Deblocking filter. [0:0]
@ -211,6 +215,8 @@ Compression tools:
--(no-)full-intra-search : Try all intra modes during rough search. --(no-)full-intra-search : Try all intra modes during rough search.
[disabled] [disabled]
--(no-)transform-skip : Try transform skip [disabled] --(no-)transform-skip : Try transform skip [disabled]
--(no-)chroma-transform-skip : Try transform skip for chroma
blocks. [disabled]
--tr-skip-max-size : Max log2 size of transform skip 2..5 [2] --tr-skip-max-size : Max log2 size of transform skip 2..5 [2]
--me <string> : Integer motion estimation algorithm [hexbs] --me <string> : Integer motion estimation algorithm [hexbs]
- hexbs: Hexagon Based Search - hexbs: Hexagon Based Search
@ -286,6 +292,8 @@ Compression tools:
--(no-)mrl : Enable use of multiple reference lines in intra --(no-)mrl : Enable use of multiple reference lines in intra
predictions. predictions.
--(no-)mip : Enable matrix weighted intra prediction. --(no-)mip : Enable matrix weighted intra prediction.
--(no-)lfnst : Enable low frequency non-separable transform.
[disabled]
--mts <string> : Multiple Transform Selection [off]. --mts <string> : Multiple Transform Selection [off].
(Currently only implemented for intra (Currently only implemented for intra
and has effect only when rd >= 2) and has effect only when rd >= 2)

View file

@ -90,6 +90,10 @@ A prefix used for stats files that include
bits, lambda, distortion, and qp for each ctu. bits, lambda, distortion, and qp for each ctu.
These are meant for debugging and are not These are meant for debugging and are not
written unless the prefix is defined. written unless the prefix is defined.
.TP
\fB\-\-cabac\-debug\-file
A debug file for cabac context.
Ignore this, it is only for tests.
.SS "Video structure:" .SS "Video structure:"
.TP .TP
@ -216,6 +220,10 @@ QP into chroma qp. These two lists have to be
same length, start with same value, and can same length, start with same value, and can
contain maximum 16 or 36 \- starting value contain maximum 16 or 36 \- starting value
elements. [17,27,32,44] elements. [17,27,32,44]
.TP
\fB\-\-(no\-)dual\-tree
Use separate CTU structure for luma and
chroma in intra slices.
.SS "Compression tools:" .SS "Compression tools:"
.TP .TP
@ -270,6 +278,10 @@ Try all intra modes during rough search.
\fB\-\-(no\-)transform\-skip \fB\-\-(no\-)transform\-skip
Try transform skip [disabled] Try transform skip [disabled]
.TP .TP
\fB\-\-(no\-)chroma\-transform\-skip
Try transform skip for chroma
blocks. [disabled]
.TP
\fB\-\-tr\-skip\-max\-size \fB\-\-tr\-skip\-max\-size
Max log2 size of transform skip 2..5 [2] Max log2 size of transform skip 2..5 [2]
.TP .TP
@ -395,6 +407,10 @@ predictions.
\fB\-\-(no\-)mip \fB\-\-(no\-)mip
Enable matrix weighted intra prediction. Enable matrix weighted intra prediction.
.TP .TP
\fB\-\-(no\-)lfnst
Enable low frequency non\-separable transform.
[disabled]
.TP
\fB\-\-mts <string> \fB\-\-mts <string>
Multiple Transform Selection [off]. Multiple Transform Selection [off].
(Currently only implemented for intra (Currently only implemented for intra

View file

@ -660,7 +660,8 @@ void print_help(void)
" --(no-)mrl : Enable use of multiple reference lines in intra\n" " --(no-)mrl : Enable use of multiple reference lines in intra\n"
" predictions.\n" " predictions.\n"
" --(no-)mip : Enable matrix weighted intra prediction.\n" " --(no-)mip : Enable matrix weighted intra prediction.\n"
" --(no-)lfnst : Enable low frequency non-separable transform. [disabled]\n" " --(no-)lfnst : Enable low frequency non-separable transform.\n"
" [disabled]\n"
" --mts <string> : Multiple Transform Selection [off].\n" " --mts <string> : Multiple Transform Selection [off].\n"
" (Currently only implemented for intra\n" " (Currently only implemented for intra\n"
" and has effect only when rd >= 2)\n" " and has effect only when rd >= 2)\n"