update man page

This commit is contained in:
Joose Sainio 2022-06-14 10:38:42 +03:00
parent 4b85a3de62
commit c8314d3ec3
3 changed files with 62 additions and 27 deletions

View file

@ -52,7 +52,6 @@ Speed and compression quality can be selected with ```--preset```, or by setting
[comment]: # (BEGIN UVG266 HELP MESSAGE) [comment]: # (BEGIN UVG266 HELP MESSAGE)
``` ```
Usage:
uvg266 -i <input> --input-res <width>x<height> -o <output> uvg266 -i <input> --input-res <width>x<height> -o <output>
Required: Required:
@ -277,8 +276,8 @@ Compression tools:
a zero coefficient CU is found. [disabled] a zero coefficient CU is found. [disabled]
--(no-)early-skip : Try to find skip cu from merge candidates. --(no-)early-skip : Try to find skip cu from merge candidates.
Perform no further search if skip is found. Perform no further search if skip is found.
For rd=0..1: Try the first candidate. For rd = 0..1: Try the first candidate.
For rd=2.. : Try the best candidate based For rd = 2.. : Try the best candidate based
on luma satd cost. [enabled] on luma satd cost. [enabled]
--max-merge <integer> : Maximum number of merge candidates, 1..6 [6] --max-merge <integer> : Maximum number of merge candidates, 1..6 [6]
--(no-)implicit-rdpcm : Implicit residual DPCM. Currently only supported --(no-)implicit-rdpcm : Implicit residual DPCM. Currently only supported
@ -299,11 +298,11 @@ Compression tools:
instead of DCT2 to certain intra instead of DCT2 to certain intra
blocks. blocks.
--(no-)jccr : Joint coding of chroma residual. --(no-)jccr : Joint coding of chroma residual.
Requires rdo> = 2. [disabled] Requires rdo >= 2. [disabled]
--(no-)cclm : Cross component linear model. --(no-)cclm : Cross component linear model.
Extra chroma prediction modes that are formed Extra chroma prediction modes that are formed
via linear transformation from the luma via linear transformation from the luma
prediction. Requires rdo >=3. [disabled prediction. Requires rdo >= 3. [disabled
--(no-)amvr : Adaptive Motion Vector Resolution. --(no-)amvr : Adaptive Motion Vector Resolution.
Code some MVs with reduced resolution [disabled] Code some MVs with reduced resolution [disabled]

View file

@ -1,4 +1,29 @@
.TH UVG266 "1" "April 2022" "uvg266 v0.2.3" "User Commands" .TH UVG266 "1" "June 2022" "uvg266 v3.12)
0.2.3
${PROJECT_VERSION}-${GIT_TAG_SHORT})
"
"${CMAKE_C_COMPILER_ID}
LESS
"VS")
LESS
"VS2013")
LESS
"VS2015")
LESS
"VS2017")
LESS
"VS2019")
"VS2022")
"${UVG_COMPILER_VERSION}")
tar
"Make
${CMAKE_SOURCE_DIR}/${PROJECT_NAME}-${PROJECT_VERSION}.tar.gz
tar
cd
echo
echo
${CMAKE_SOURCE_DIR}/${PROJECT_NAME}-${PROJECT_VERSION}.tar.gz
"Checking" "User Commands"
.SH NAME .SH NAME
uvg266 \- open source VVC encoder uvg266 \- open source VVC encoder
.SH SYNOPSIS .SH SYNOPSIS
@ -234,7 +259,8 @@ Sample Adaptive Offset [full]
\fB\-\-alf <string> \fB\-\-alf <string>
Adaptive Loop Filter [off] Adaptive Loop Filter [off]
\- off: ALF disabled \- off: ALF disabled
\- no\-cc: ALF enabled without cross component refinement \- no\-cc: ALF enabled without cross component
refinement
\- full: Full ALF \- full: Full ALF
.TP .TP
\fB\-\-(no\-)rdoq \fB\-\-(no\-)rdoq
@ -246,12 +272,6 @@ Skip RDOQ for 4x4 blocks. [disabled]
\fB\-\-(no\-)signhide \fB\-\-(no\-)signhide
Sign hiding [disabled] Sign hiding [disabled]
.TP .TP
\fB\-\-(no\-)smp
Symmetric motion partition [disabled]
.TP
\fB\-\-(no\-)amp
Asymmetric motion partition [disabled]
.TP
\fB\-\-rd <integer> \fB\-\-rd <integer>
Intra mode search complexity [0] Intra mode search complexity [0]
\- 0: Skip intra if inter is good enough. \- 0: Skip intra if inter is good enough.
@ -319,6 +339,19 @@ Predict the pu\-depth\-intra using machine
learning trees, overrides the learning trees, overrides the
\-\-pu\-depth\-intra parameter. [disabled] \-\-pu\-depth\-intra parameter. [disabled]
.TP .TP
\fB\-\-(no\-)combine\-intra\-cus: Whether the encoder tries to code a cu
on lower depth even when search is not
performed on said depth. Should only
be disabled if cus absolutely must not
be larger than limited by the search.
[enabled]
.TP
\fB\-\-force\-inter
Force the encoder to use inter always.
This is mostly for debugging and is not
guaranteed to produce sensible bitstream or
work at all. [disabled]
.TP
\fB\-\-tr\-depth\-intra <int> \fB\-\-tr\-depth\-intra <int>
Transform split depth for intra blocks [0] Transform split depth for intra blocks [0]
.TP .TP
@ -365,8 +398,8 @@ a zero coefficient CU is found. [disabled]
\fB\-\-(no\-)early\-skip \fB\-\-(no\-)early\-skip
Try to find skip cu from merge candidates. Try to find skip cu from merge candidates.
Perform no further search if skip is found. Perform no further search if skip is found.
For rd=0..1: Try the first candidate. For rd = 0..1: Try the first candidate.
For rd=2.. For rd = 2..
Try the best candidate based Try the best candidate based
on luma satd cost. [enabled] on luma satd cost. [enabled]
.TP .TP
@ -386,6 +419,7 @@ predictions.
.TP .TP
\fB\-\-(no\-)mip \fB\-\-(no\-)mip
Enable matrix weighted intra prediction. Enable matrix weighted intra prediction.
.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
@ -393,23 +427,25 @@ and has effect only when rd >= 2)
\- off: MTS disabled \- off: MTS disabled
\- intra: MTS applied only for intra blocks. \- intra: MTS applied only for intra blocks.
\- inter: MTS applied only for inter blocks. \- inter: MTS applied only for inter blocks.
\- both: MTS applied for both intra and inter blocks. \- both: MTS applied for both intra and inter
\- implicit: uses implicit MTS. Applies DST7 instead blocks.
of DCT2 to certain intra blocks. \- implicit: uses implicit MTS. Applies DST7
instead of DCT2 to certain intra
blocks.
.TP .TP
\fB\-\-(no\-)jccr \fB\-\-(no\-)jccr
Joint coding of chroma residual. Joint coding of chroma residual.
Requires rdo> = 2. [disabled] Requires rdo >= 2. [disabled]
.TP .TP
\fB\-\-(no\-)cclm \fB\-\-(no\-)cclm
Cross component linear model. Cross component linear model.
Extra chroma prediction modes that are formed Extra chroma prediction modes that are formed
via linear transformation from the luma via linear transformation from the luma
prediction. Requires rdo >=3. [disabled prediction. Requires rdo >= 3. [disabled
.TP .TP
\fB\-\-(no\-)amvr \fB\-\-(no\-)amvr
Adaptive Motion Vector Resolution. Adaptive Motion Vector Resolution.
Code some mv's with reduced resolution [disabled] Code some MVs with reduced resolution [disabled]
.SS "Parallel processing:" .SS "Parallel processing:"
.TP .TP
@ -442,8 +478,8 @@ Split picture into width x height uniform tiles.
width. width.
.TP .TP
\fB\-\-tiles\-height\-split <string>|u<int> \fB\-\-tiles\-height\-split <string>|u<int>
\- <string>: A comma\-separated list of tile row \- <string>: A comma\-separated list of tile
column pixel coordinates. row column pixel coordinates.
\- u<int>: Number of tile rows of uniform \- u<int>: Number of tile rows of uniform
height. height.
.TP .TP

View file

@ -656,7 +656,7 @@ void print_help(void)
" - both: MTS applied for both intra and inter\n" " - both: MTS applied for both intra and inter\n"
" blocks.\n" " blocks.\n"
" - implicit: uses implicit MTS. Applies DST7\n" " - implicit: uses implicit MTS. Applies DST7\n"
" instead of DCT2 to certain intra\n " instead of DCT2 to certain intra\n"
" blocks.\n" " blocks.\n"
" --(no-)jccr : Joint coding of chroma residual.\n" " --(no-)jccr : Joint coding of chroma residual.\n"
" Requires rdo >= 2. [disabled]\n" " Requires rdo >= 2. [disabled]\n"