Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some spacing and line breaks in help text to keep line widths below 80 chars #7

Merged
merged 2 commits into from
Jun 14, 2022
Merged

Fix some spacing and line breaks in help text to keep line widths below 80 chars #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eab9a94
Missing backslash escape in line break
LigH-de Jun 13, 2022
1c6976f
Updated help output text block
LigH-de Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,13 +193,12 @@ Compression tools:
- full: Full SAO
--alf <string> : 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
--(no-)rdoq : Rate-distortion optimized quantization [enabled]
--(no-)rdoq-skip : Skip RDOQ for 4x4 blocks. [disabled]
--(no-)signhide : Sign hiding [disabled]
--(no-)smp : Symmetric motion partition [disabled]
--(no-)amp : Asymmetric motion partition [disabled]
--rd <integer> : Intra mode search complexity [0]
- 0: Skip intra if inter is good enough.
- 1: Rough intra mode search with SATD.
Expand Down Expand Up @@ -243,6 +242,16 @@ Compression tools:
--ml-pu-depth-intra : Predict the pu-depth-intra using machine
learning trees, overrides the
--pu-depth-intra parameter. [disabled]
--(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]
--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]
--tr-depth-intra <int> : Transform split depth for intra blocks [0]
--(no-)bipred : Bi-prediction [disabled]
--cu-split-termination <string> : CU split search termination [zero]
Expand Down Expand Up @@ -284,17 +293,19 @@ Compression tools:
- 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.
--(no-)jccr : Joint coding of chroma residual.
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
--(no-)amvr : Adaptive Motion Vector Resolution.
Code some mv's with reduced resolution [disabled]
Code some MVs with reduced resolution [disabled]

Parallel processing:
--threads <integer> : Number of threads to use [auto]
Expand All @@ -317,8 +328,8 @@ Parallel processing:
- u<int>: Number of tile columns of uniform
width.
--tiles-height-split <string>|u<int> :
- <string>: A comma-separated list of tile row
column pixel coordinates.
- <string>: A comma-separated list of tile
row column pixel coordinates.
- u<int>: Number of tile rows of uniform
height.
--slices <string> : Control how slices are used.
Expand Down
31 changes: 17 additions & 14 deletions src/cli.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,8 @@ void print_help(void)
" - full: Full SAO\n"
" --alf <string> : Adaptive Loop Filter [off]\n"
" - off: ALF disabled\n"
" - no-cc: ALF enabled without cross component refinement\n"
" - no-cc: ALF enabled without cross component\n"
" refinement\n"
" - full: Full ALF\n"
" --(no-)rdoq : Rate-distortion optimized quantization [enabled]\n"
" --(no-)rdoq-skip : Skip RDOQ for 4x4 blocks. [disabled]\n"
Expand Down Expand Up @@ -606,11 +607,11 @@ void print_help(void)
" performed on said depth. Should only\n"
" be disabled if cus absolutely must not\n"
" be larger than limited by the search.\n"
" [enabled]"
" [enabled]\n"
" --force-inter : Force the encoder to use inter always.\n"
" This is mostly for debugging and is not\n"
" guaranteed to produce sensible bitstream or\n"
" work at all. [disabled]"
" work at all. [disabled]\n"
" --tr-depth-intra <int> : Transform split depth for intra blocks [0]\n"
" --(no-)bipred : Bi-prediction [disabled]\n"
" --cu-split-termination <string> : CU split search termination [zero]\n"
Expand All @@ -636,9 +637,9 @@ void print_help(void)
" a zero coefficient CU is found. [disabled]\n"
" --(no-)early-skip : Try to find skip cu from merge candidates.\n"
" Perform no further search if skip is found.\n"
" For rd=0..1: Try the first candidate.\n"
" For rd=2.. : Try the best candidate based\n"
" on luma satd cost. [enabled]\n"
" For rd = 0..1: Try the first candidate.\n"
" For rd = 2.. : Try the best candidate based\n"
" on luma satd cost. [enabled]\n"
" --max-merge <integer> : Maximum number of merge candidates, 1..6 [6]\n"
" --(no-)implicit-rdpcm : Implicit residual DPCM. Currently only supported\n"
" with lossless coding. [disabled]\n"
Expand All @@ -652,17 +653,19 @@ void print_help(void)
" - off: MTS disabled\n"
" - intra: MTS applied only for intra blocks.\n"
" - inter: MTS applied only for inter blocks.\n"
" - both: MTS applied for both intra and inter blocks.\n"
" - implicit: uses implicit MTS. Applies DST7 instead \n"
" of DCT2 to certain intra blocks.\n"
" - 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
" blocks.\n"
" --(no-)jccr : Joint coding of chroma residual.\n"
" Requires rdo> = 2. [disabled]\n"
" Requires rdo >= 2. [disabled]\n"
" --(no-)cclm : Cross component linear model. \n"
" Extra chroma prediction modes that are formed\n"
" via linear transformation from the luma\n"
" prediction. Requires rdo >=3. [disabled\n"
" prediction. Requires rdo >= 3. [disabled\n"
" --(no-)amvr : Adaptive Motion Vector Resolution.\n"
" Code some mv's with reduced resolution [disabled]\n"
" Code some MVs with reduced resolution [disabled]\n"
"\n"
/* Word wrap to this width to stay under 80 characters (including ") *************/
"Parallel processing:\n"
Expand All @@ -686,8 +689,8 @@ void print_help(void)
" - u<int>: Number of tile columns of uniform\n"
" width.\n"
" --tiles-height-split <string>|u<int> :\n"
" - <string>: A comma-separated list of tile row\n"
" column pixel coordinates.\n"
" - <string>: A comma-separated list of tile\n"
" row column pixel coordinates.\n"
" - u<int>: Number of tile rows of uniform\n"
" height.\n"
" --slices <string> : Control how slices are used.\n"
Expand Down