From c8314d3ec329051ae7d39935a01b42da6d872f96 Mon Sep 17 00:00:00 2001 From: Joose Sainio Date: Tue, 14 Jun 2022 10:38:42 +0300 Subject: [PATCH] update man page --- README.md | 11 ++++---- doc/uvg266.1 | 76 ++++++++++++++++++++++++++++++++++++++-------------- src/cli.c | 2 +- 3 files changed, 62 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index beedc556..3a8db88e 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,6 @@ Speed and compression quality can be selected with ```--preset```, or by setting [comment]: # (BEGIN UVG266 HELP MESSAGE) ``` -Usage: uvg266 -i --input-res x -o Required: @@ -277,9 +276,9 @@ Compression tools: a zero coefficient CU is found. [disabled] --(no-)early-skip : Try to find skip cu from merge candidates. Perform no further search if skip is found. - For rd=0..1: Try the first candidate. - For rd=2.. : Try the best candidate based - on luma satd cost. [enabled] + For rd = 0..1: Try the first candidate. + For rd = 2.. : Try the best candidate based + on luma satd cost. [enabled] --max-merge : Maximum number of merge candidates, 1..6 [6] --(no-)implicit-rdpcm : Implicit residual DPCM. Currently only supported with lossless coding. [disabled] @@ -299,11 +298,11 @@ Compression tools: instead of DCT2 to certain intra blocks. --(no-)jccr : Joint coding of chroma residual. - Requires rdo> = 2. [disabled] + Requires rdo >= 2. [disabled] --(no-)cclm : Cross component linear model. Extra chroma prediction modes that are formed via linear transformation from the luma - prediction. Requires rdo >=3. [disabled + prediction. Requires rdo >= 3. [disabled --(no-)amvr : Adaptive Motion Vector Resolution. Code some MVs with reduced resolution [disabled] diff --git a/doc/uvg266.1 b/doc/uvg266.1 index 7a4319f8..54ed920f 100644 --- a/doc/uvg266.1 +++ b/doc/uvg266.1 @@ -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 uvg266 \- open source VVC encoder .SH SYNOPSIS @@ -234,7 +259,8 @@ Sample Adaptive Offset [full] \fB\-\-alf Adaptive Loop Filter [off] \- off: ALF disabled - \- no\-cc: ALF enabled without cross component refinement + \- no\-cc: ALF enabled without cross component + refinement \- full: Full ALF .TP \fB\-\-(no\-)rdoq @@ -246,12 +272,6 @@ Skip RDOQ for 4x4 blocks. [disabled] \fB\-\-(no\-)signhide Sign hiding [disabled] .TP -\fB\-\-(no\-)smp -Symmetric motion partition [disabled] -.TP -\fB\-\-(no\-)amp -Asymmetric motion partition [disabled] -.TP \fB\-\-rd Intra mode search complexity [0] \- 0: Skip intra if inter is good enough. @@ -319,6 +339,19 @@ Predict the pu\-depth\-intra using machine learning trees, overrides the \-\-pu\-depth\-intra parameter. [disabled] .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 Transform split depth for intra blocks [0] .TP @@ -365,10 +398,10 @@ a zero coefficient CU is found. [disabled] \fB\-\-(no\-)early\-skip Try to find skip cu from merge candidates. Perform no further search if skip is found. -For rd=0..1: Try the first candidate. -For rd=2.. +For rd = 0..1: Try the first candidate. +For rd = 2.. Try the best candidate based - on luma satd cost. [enabled] + on luma satd cost. [enabled] .TP \fB\-\-max\-merge Maximum number of merge candidates, 1..6 [6] @@ -386,6 +419,7 @@ predictions. .TP \fB\-\-(no\-)mip Enable matrix weighted intra prediction. +.TP \fB\-\-mts Multiple Transform Selection [off]. (Currently only implemented for intra @@ -393,23 +427,25 @@ and has effect only when rd >= 2) \- off: MTS disabled \- intra: MTS applied only for intra blocks. \- inter: MTS applied only for inter blocks. - \- both: MTS applied for both intra and inter blocks. - \- implicit: uses implicit MTS. Applies DST7 instead - of DCT2 to certain intra blocks. + \- both: MTS applied for both intra and inter + blocks. + \- implicit: uses implicit MTS. Applies DST7 + instead of DCT2 to certain intra + blocks. .TP \fB\-\-(no\-)jccr -Joint coding of chroma residual. - Requires rdo> = 2. [disabled] +Joint coding of chroma residual. +Requires rdo >= 2. [disabled] .TP \fB\-\-(no\-)cclm Cross component linear model. Extra chroma prediction modes that are formed via linear transformation from the luma -prediction. Requires rdo >=3. [disabled +prediction. Requires rdo >= 3. [disabled .TP \fB\-\-(no\-)amvr Adaptive Motion Vector Resolution. -Code some mv's with reduced resolution [disabled] +Code some MVs with reduced resolution [disabled] .SS "Parallel processing:" .TP @@ -442,8 +478,8 @@ Split picture into width x height uniform tiles. width. .TP \fB\-\-tiles\-height\-split |u - \- : A comma\-separated list of tile row - column pixel coordinates. + \- : A comma\-separated list of tile + row column pixel coordinates. \- u: Number of tile rows of uniform height. .TP diff --git a/src/cli.c b/src/cli.c index 1d2c5123..59ed1582 100644 --- a/src/cli.c +++ b/src/cli.c @@ -656,7 +656,7 @@ void print_help(void) " - both: MTS applied for both intra and inter\n" " blocks.\n" " - implicit: uses implicit MTS. Applies DST7\n" - " instead of DCT2 to certain intra\n + " instead of DCT2 to certain intra\n" " blocks.\n" " --(no-)jccr : Joint coding of chroma residual.\n" " Requires rdo >= 2. [disabled]\n"