[FFmpeg-devel] [RFC PATCH v3 5/5] doc/encoders.texi: Add documentation for JPEG2000 layers

[gautamramk at gmail.com]

From: Gautam Ramakrishnan <gautamramk at gmail.com>

This patch adds documentation for the utility and usage
of "layer_rates" option used in the JPEG2000 encoder.
---
 doc/encoders.texi | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index fd9235a05a..481ad2fb3d 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1401,6 +1401,22 @@ Possible values are:
 @end table
 Set to @code{lrcp} by default.
 
+ at item layer_rates @var{string}
+By default, compression is done using the quality metric. This option allows for
+compression using compression ratio. The compression ratio for each level could
+be specified. The compression ratio of a layer @code{l} species the what ratio of
+total file size is contained in the first @code{l} layers.
+
+Example usage:
+
+ at example
+ffmpeg -i input.bmp -c:v jpeg2000 -layer_rates "100,10,1" output.j2k
+ at end example
+
+This would compress the image to contain 3 layers, where the data contained in the
+first layer would be compressed by 1000 times, compressed by 100 in the first two layers,
+and shall contain all data while using all 3 layers.
+
 @end table
 
 @section librav1e
-- 
2.17.1