From 4e6f197f9cf3b48e643eb68891e1e64d2f19c820 Mon Sep 17 00:00:00 2001
From: siivonek <kari.siivonen@tuni.fi>
Date: Thu, 2 Apr 2020 12:27:50 +0200
Subject: [PATCH] Update docs.

---
 README.md     | 11 +++++++++++
 doc/kvazaar.1 | 20 +++++++++++++++++++-
 2 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ccc0c7f9..955a983c 100644
--- a/README.md
+++ b/README.md
@@ -129,6 +129,15 @@ Video structure:
       --bitrate <integer>    : Target bitrate [0]
                                    - 0: Disable rate control.
                                    - N: Target N bits per second.
+      --rc-algorithm <string>: Select used rc-algorithm. [lambda]
+                                   - lambda: rate control from:
+                                     DOI: 10.1109/TIP.2014.2336550 
+                                   - oba: DOI: 10.1109/TCSVT.2016.2589878
+      --(no-)intra-bits      : Use Hadamard cost based allocation for intra
+                               frames. Default on for gop 8 and off for lp-gop
+      --(no-)clip-neighbour  : On oba based rate control whether to clip 
+                               lambda values to same frame's ctus or previous'.
+                               Default on for RA GOPS and disabled for LP.
       --(no-)lossless        : Use lossless coding. [disabled]
       --mv-constraint <string> : Constrain movement vectors. [none]
                                    - none: No constraint
@@ -152,6 +161,8 @@ Video structure:
       --high-tier            : Used with --level. Use high tier bitrate limits
                                instead of the main tier limits during encoding.
                                High tier requires level 4 or higher.
+      --vaq <integer>        : Enable variance adaptive quantization with given
+                               strength, in range 1..20.
 
 Compression tools:
       --(no-)deblock <beta:tc> : Deblocking filter. [0:0]
diff --git a/doc/kvazaar.1 b/doc/kvazaar.1
index 362db5d3..0f140e31 100644
--- a/doc/kvazaar.1
+++ b/doc/kvazaar.1
@@ -1,4 +1,4 @@
-.TH KVAZAAR "1" "February 2020" "kvazaar v1.3.0" "User Commands"
+.TH KVAZAAR "1" "huhtikuu 2020" "kvazaar v1.3.0" "User Commands"
 .SH NAME
 kvazaar \- open source HEVC encoder
 .SH SYNOPSIS
@@ -140,6 +140,20 @@ Target bitrate [0]
     \- 0: Disable rate control.
     \- N: Target N bits per second.
 .TP
+\fB\-\-rc\-algorithm <string>: Select used rc\-algorithm. [lambda]
+    \- lambda: rate control from:
+      DOI: 10.1109/TIP.2014.2336550 
+    \- oba: DOI: 10.1109/TCSVT.2016.2589878
+.TP
+\fB\-\-(no\-)intra\-bits     
+Use Hadamard cost based allocation for intra
+frames. Default on for gop 8 and off for lp\-gop
+.TP
+\fB\-\-(no\-)clip\-neighbour 
+On oba based rate control whether to clip 
+lambda values to same frame's ctus or previous'.
+Default on for RA GOPS and disabled for LP.
+.TP
 \fB\-\-(no\-)lossless       
 Use lossless coding. [disabled]
 .TP
@@ -178,6 +192,10 @@ Same as \-\-level but warnings instead of errors.
 Used with \-\-level. Use high tier bitrate limits
 instead of the main tier limits during encoding.
 High tier requires level 4 or higher.
+.TP
+\fB\-\-vaq <integer>       
+Enable variance adaptive quantization with given
+strength, in range 1..20.
 
 .SS "Compression tools:"
 .TP