diff mbox

[FFmpeg-devel] doc/encoders: add documentation for the Hap encoder

Message ID 20161110144127.87947-1-bangnoise@gmail.com
State Accepted
Commit 48f0e41c30683f3fd2d4fb287d868cf2a1c7f4f9
Headers show

Commit Message

Tom Butterworth Nov. 10, 2016, 2:41 p.m. UTC
Documents options and behaviour, noting when 'chunks' option will
not be honoured.

Signed-off-by: Tom Butterworth <bangnoise@gmail.com>
---
 doc/encoders.texi | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

Comments

Martin Vignali Nov. 10, 2016, 10:09 p.m. UTC | #1
2016-11-10 15:41 GMT+01:00 Tom Butterworth <bangnoise@gmail.com>:

> Documents options and behaviour, noting when 'chunks' option will
> not be honoured.
>
> Signed-off-by: Tom Butterworth <bangnoise@gmail.com>
> ---
>  doc/encoders.texi | 39 +++++++++++++++++++++++++++++++++++++++
>  1 file changed, 39 insertions(+)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index ba60e0a..c0597d8 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -2501,6 +2501,45 @@ Reduces detail but attempts to preserve color at
> extremely low bitrates.
>
>  @end table
>
> +@section Hap
> +
> +Vidvox Hap video encoder.
> +
> +@subsection Options
> +
> +@table @option
> +@item format @var{integer}
> +Specifies the Hap format to encode.
> +
> +@table @option
> +@item hap
> +@item hap_alpha
> +@item hap_q
> +@end table
> +
> +Default value is @option{hap}.
> +
> +@item chunks @var{integer}
> +Specifies the number of chunks to split frames into, between 1 and 64.
> This
> +permits multithreaded decoding of large frames, potentially at the cost of
> +data-rate. The encoder may modify this value to divide frames evenly.
> +
> +Default value is @var{1}.
> +
> +@item compressor @var{integer}
> +Specifies the second-stage compressor to use. If set to @option{none},
> +@option{chunks} will be limited to 1, as chunked uncompressed frames
> offer no
> +benefit.
> +
> +@table @option
> +@item none
> +@item snappy
> +@end table
> +
> +Default value is @option{snappy}.
> +
> +@end table
> +
>  @c man end VIDEO ENCODERS
>
>  @chapter Subtitles Encoders
> --


lgtm,

Thanks

Martin
Lou Logan Nov. 10, 2016, 11:13 p.m. UTC | #2
On Thu, 10 Nov 2016 23:09:52 +0100, Martin Vignali wrote:
> 
> lgtm

Applied.
diff mbox

Patch

diff --git a/doc/encoders.texi b/doc/encoders.texi
index ba60e0a..c0597d8 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -2501,6 +2501,45 @@  Reduces detail but attempts to preserve color at extremely low bitrates.
 
 @end table
 
+@section Hap
+
+Vidvox Hap video encoder.
+
+@subsection Options
+
+@table @option
+@item format @var{integer}
+Specifies the Hap format to encode.
+
+@table @option
+@item hap
+@item hap_alpha
+@item hap_q
+@end table
+
+Default value is @option{hap}.
+
+@item chunks @var{integer}
+Specifies the number of chunks to split frames into, between 1 and 64. This
+permits multithreaded decoding of large frames, potentially at the cost of
+data-rate. The encoder may modify this value to divide frames evenly.
+
+Default value is @var{1}.
+
+@item compressor @var{integer}
+Specifies the second-stage compressor to use. If set to @option{none},
+@option{chunks} will be limited to 1, as chunked uncompressed frames offer no
+benefit.
+
+@table @option
+@item none
+@item snappy
+@end table
+
+Default value is @option{snappy}.
+
+@end table
+
 @c man end VIDEO ENCODERS
 
 @chapter Subtitles Encoders