diff mbox series

[FFmpeg-devel,v2] doc/encoders: document libjxl encoder options

Message ID 20220427150057.339274-1-leo.izen@gmail.com
State New
Headers show
Series [FFmpeg-devel,v2] doc/encoders: document libjxl encoder options | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished
andriy/make_armv7_RPi4 success Make finished
andriy/make_fate_armv7_RPi4 success Make fate finished

Commit Message

Leo Izen April 27, 2022, 3 p.m. UTC
Add more detailed documenation for the libjxl encoder
wrapper than is present currently inside libavcodec.
---
 doc/encoders.texi | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

Comments

Gyan Doshi April 28, 2022, 8:15 a.m. UTC | #1
Pushed as ec07b1547753864d1fb47eb2747613dddba507b2

On 2022-04-27 08:30 pm, Leo Izen wrote:
> Add more detailed documenation for the libjxl encoder
> wrapper than is present currently inside libavcodec.
> ---
>   doc/encoders.texi | 35 +++++++++++++++++++++++++++++++++++
>   1 file changed, 35 insertions(+)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index aac9f25e55..51f0dc3fcb 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1809,6 +1809,41 @@ by ":". See the SVT-AV1 encoder user guide for a list of accepted parameters.
>   
>   @end table
>   
> +@section libjxl
> +
> +libjxl JPEG XL encoder wrapper.
> +
> +Requires the presence of the libjxl headers and library during
> +configuration. You need to explicitly configure the build with
> +@code{--enable-libjxl}.
> +
> +@subsection Options
> +
> +The libjxl wrapper supports the following options:
> +
> +@table @option
> +
> +@item distance
> +Set the target Butteraugli distance. This is a quality setting: lower
> +distance yields higher quality, with distance=1.0 roughly comparable to
> +libjpeg Quality 90 for photographic content. Setting distance=0.0 yields
> +true lossless encoding. Valid values range between 0.0 and 15.0, and sane
> +values rarely exceed 5.0. Setting distance=0.1 is usually attains
> +transparency for most input. The default is 1.0.
> +
> +@item effort
> +Set the encoding effort used. Higher effort values produce more consistent
> +quality and usually produces a better quality/bpp curve, at the cost of
> +more CPU time required. Valid values range from 1 to 9, and the default is 7.
> +
> +@item modular
> +Force the encoder to use Modular mode instead of choosing automatically. The
> +default is to use VarDCT for lossy encoding and Modular for lossless. VarDCT
> +is generally superior to Modular for lossy encoding but does not support
> +lossless encoding.
> +
> +@end table
> +
>   @section libkvazaar
>   
>   Kvazaar H.265/HEVC encoder.
diff mbox series

Patch

diff --git a/doc/encoders.texi b/doc/encoders.texi
index aac9f25e55..51f0dc3fcb 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1809,6 +1809,41 @@  by ":". See the SVT-AV1 encoder user guide for a list of accepted parameters.
 
 @end table
 
+@section libjxl
+
+libjxl JPEG XL encoder wrapper.
+
+Requires the presence of the libjxl headers and library during
+configuration. You need to explicitly configure the build with
+@code{--enable-libjxl}.
+
+@subsection Options
+
+The libjxl wrapper supports the following options:
+
+@table @option
+
+@item distance
+Set the target Butteraugli distance. This is a quality setting: lower
+distance yields higher quality, with distance=1.0 roughly comparable to
+libjpeg Quality 90 for photographic content. Setting distance=0.0 yields
+true lossless encoding. Valid values range between 0.0 and 15.0, and sane
+values rarely exceed 5.0. Setting distance=0.1 is usually attains
+transparency for most input. The default is 1.0.
+
+@item effort
+Set the encoding effort used. Higher effort values produce more consistent
+quality and usually produces a better quality/bpp curve, at the cost of
+more CPU time required. Valid values range from 1 to 9, and the default is 7.
+
+@item modular
+Force the encoder to use Modular mode instead of choosing automatically. The
+default is to use VarDCT for lossy encoding and Modular for lossless. VarDCT
+is generally superior to Modular for lossy encoding but does not support
+lossless encoding.
+
+@end table
+
 @section libkvazaar
 
 Kvazaar H.265/HEVC encoder.