Skip to content

Commit

Permalink
update version an docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jovasa committed Sep 27, 2023
1 parent 84580ae commit 9add13b
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 14 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ project(uvg266
LANGUAGES C CXX
HOMEPAGE_URL https://github.com/ultravideo/uvg266
DESCRIPTION "An open-source VVC encoder licensed under 3-clause BSD"
VERSION 0.4.1 )
VERSION 0.8.0 )

option(BUILD_SHARED_LIBS "Build using shared uvg266 library" ON)

Expand Down
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ Compression tools:
- full: Full ALF
--(no-)rdoq : Rate-distortion optimized quantization [enabled]
--(no-)rdoq-skip : Skip RDOQ for 4x4 blocks. [disabled]
--(no-)dep-quant : Use dependent quantization. [disabled]
--(no-)signhide : Sign hiding [disabled]
--rd <integer> : Intra mode search complexity [0]
- 0: Skip intra if inter is good enough.
Expand Down Expand Up @@ -232,21 +233,44 @@ Compression tools:
- 2: + 1/2-pixel diagonal
- 3: + 1/4-pixel horizontal and vertical
- 4: + 1/4-pixel diagonal
--pu-depth-inter <int>-<int> : Inter prediction units sizes [0-3]
- 0, 1, 2, 3: from 64x64 to 8x8
--pu-depth-inter <int>-<int> : Maximum and minimum split depths where
inter search is performed 0..8. [0-3]
- Accepts a list of values separated by ','
for setting separate depths per GOP layer
(values can be omitted to use the first
value for the respective layer).
--pu-depth-intra <int>-<int> : Intra prediction units sizes [1-4]
- 0, 1, 2, 3, 4: from 64x64 to 4x4
--pu-depth-intra <int>-<int> : Maximum and minimum split depths where
intra search is performed 0..8. [1-4]
- Accepts a list of values separated by ','
for setting separate depths per GOP layer
(values can be omitted to use the first
value for the respective layer).
--ml-pu-depth-intra : Predict the pu-depth-intra using machine
learning trees, overrides the
--pu-depth-intra parameter. [disabled]
--mtt-depth-intra : Depth of mtt for intra slices 0..3.[0]
--mtt-depth-intra-chroma : Depth of mtt for chroma dual tree in
intra slices 0..3.[0]
--mtt-depth-inter : Depth of mtt for inter slices 0..3.[0]
All MTTs are currently experimental and
require disabling some avx2 optimizations.
--max-bt-size : maximum size for a CU resulting from
a bt split. A singular value shared for all
or a list of three values for the different
slices types (intra, inter, intra-chroma)
can be provided. [64, 64, 32]
--max-tt-size : maximum size for a CU resulting from
a tt split. A singular value shared for all
or a list of three values for the different
slices types (intra, inter, intra-chroma)
can be provided. [64, 64, 32]
--intra-rough-granularity : How many levels are used for the
logarithmic intra rough search. 0..4
With 0 all of the modes are checked
in a single level, 1 checks every second
mode is checked on first level and then
second level checks the modes surrounding
the three best modes. [2]
--(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
Expand All @@ -257,7 +281,6 @@ Compression tools:
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]
- off: Don't terminate early.
Expand Down Expand Up @@ -294,6 +317,9 @@ Compression tools:
--(no-)mip : Enable matrix weighted intra prediction.
--(no-)lfnst : Enable low frequency non-separable transform.
[disabled]
--(no-)isp : Enable intra sub partitions. [disabled]
Experimental, requires disabling some avx2
optimizations.
--mts <string> : Multiple Transform Selection [off].
(Currently only implemented for intra
and has effect only when rd >= 2)
Expand Down
56 changes: 48 additions & 8 deletions doc/uvg266.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH UVG266 "8" "July 2022" "uvg266 v0.4.1" "User Commands"
.TH UVG266 "1" "September 2023" "uvg266 v0.8.0" "User Commands"
.SH NAME
uvg266 \- open source VVC encoder
.SH SYNOPSIS
Expand Down Expand Up @@ -252,6 +252,9 @@ Rate\-distortion optimized quantization [enabled]
\fB\-\-(no\-)rdoq\-skip
Skip RDOQ for 4x4 blocks. [disabled]
.TP
\fB\-\-(no\-)dep\-quant
Use dependent quantization. [disabled]
.TP
\fB\-\-(no\-)signhide
Sign hiding [disabled]
.TP
Expand Down Expand Up @@ -306,16 +309,16 @@ Fractional pixel motion estimation level [4]
\- 4: + 1/4\-pixel diagonal
.TP
\fB\-\-pu\-depth\-inter <int>\-<int>
Inter prediction units sizes [0\-3]
\- 0, 1, 2, 3: from 64x64 to 8x8
Maximum and minimum split depths where
inter search is performed 0..8. [0\-3]
\- Accepts a list of values separated by ','
for setting separate depths per GOP layer
(values can be omitted to use the first
value for the respective layer).
.TP
\fB\-\-pu\-depth\-intra <int>\-<int>
Intra prediction units sizes [1\-4]
\- 0, 1, 2, 3, 4: from 64x64 to 4x4
Maximum and minimum split depths where
intra search is performed 0..8. [1\-4]
\- Accepts a list of values separated by ','
for setting separate depths per GOP layer
(values can be omitted to use the first
Expand All @@ -326,6 +329,41 @@ Predict the pu\-depth\-intra using machine
learning trees, overrides the
\-\-pu\-depth\-intra parameter. [disabled]
.TP
\fB\-\-mtt\-depth\-intra
Depth of mtt for intra slices 0..3.[0]
.TP
\fB\-\-mtt\-depth\-intra\-chroma
Depth of mtt for chroma dual tree in
intra slices 0..3.[0]
.TP
\fB\-\-mtt\-depth\-inter
Depth of mtt for inter slices 0..3.[0]
All MTTs are currently experimental and
require disabling some avx2 optimizations.
.TP
\fB\-\-max\-bt\-size
maximum size for a CU resulting from
a bt split. A singular value shared for all
or a list of three values for the different
slices types (intra, inter, intra\-chroma)
can be provided. [64, 64, 32]
.TP
\fB\-\-max\-tt\-size
maximum size for a CU resulting from
a tt split. A singular value shared for all
or a list of three values for the different
slices types (intra, inter, intra\-chroma)
can be provided. [64, 64, 32]
.TP
\fB\-\-intra\-rough\-granularity
How many levels are used for the
logarithmic intra rough search. 0..4
With 0 all of the modes are checked
in a single level, 1 checks every second
mode is checked on first level and then
second level checks the modes surrounding
the three best modes. [2]
.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
Expand All @@ -339,9 +377,6 @@ This is mostly for debugging and is not
guaranteed to produce sensible bitstream or
work at all. [disabled]
.TP
\fB\-\-tr\-depth\-intra <int>
Transform split depth for intra blocks [0]
.TP
\fB\-\-(no\-)bipred
Bi\-prediction [disabled]
.TP
Expand Down Expand Up @@ -411,6 +446,11 @@ Enable matrix weighted intra prediction.
Enable low frequency non\-separable transform.
[disabled]
.TP
\fB\-\-(no\-)isp
Enable intra sub partitions. [disabled]
Experimental, requires disabling some avx2
optimizations.
.TP
\fB\-\-mts <string>
Multiple Transform Selection [off].
(Currently only implemented for intra
Expand Down

0 comments on commit 9add13b

Please sign in to comment.