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

Tom Butterworth git at videolan.org
Fri Nov 11 01:11:12 EET 2016

ffmpeg | branch: master | Tom Butterworth <bangnoise at gmail.com> | Thu Nov 10 14:41:27 2016 +0000| [48f0e41c30683f3fd2d4fb287d868cf2a1c7f4f9] | committer: Lou Logan

doc/encoders: add documentation for the Hap encoder

Documents options and behaviour, noting when 'chunks' option will
not be honoured.

Signed-off-by: Tom Butterworth <bangnoise at gmail.com>
Signed-off-by: Martin Vignali <martin.vignali at gmail.com>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=48f0e41c30683f3fd2d4fb287d868cf2a1c7f4f9

 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
+ at section Hap
+Vidvox Hap video encoder.
+ at subsection Options
+ at table @option
+ at item format @var{integer}
+Specifies the Hap format to encode.
+ at table @option
+ at item hap
+ at item hap_alpha
+ at item hap_q
+ at end table
+Default value is @option{hap}.
+ at 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}.
+ at item compressor @var{integer}
+Specifies the second-stage compressor to use. If set to @option{none},
+ at option{chunks} will be limited to 1, as chunked uncompressed frames offer no
+ at table @option
+ at item none
+ at item snappy
+ at end table
+Default value is @option{snappy}.
+ at end table
 @c man end VIDEO ENCODERS
 @chapter Subtitles Encoders

More information about the ffmpeg-cvslog mailing list