From 48f0e41c30683f3fd2d4fb287d868cf2a1c7f4f9 Mon Sep 17 00:00:00 2001 From: Tom Butterworth Date: Thu, 10 Nov 2016 14:41:27 +0000 Subject: 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 Signed-off-by: Martin Vignali --- doc/encoders.texi | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) (limited to 'doc/encoders.texi') diff --git a/doc/encoders.texi b/doc/encoders.texi index ba60e0ab40..c0597d8999 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 -- cgit v1.2.3