doc: add decoders.texi
authorJohn Stebbins <stebbins@jetheaddev.com>
Sun, 26 Jan 2014 14:49:10 +0000 (14:49 +0000)
committerTim Walker <tdskywalker@gmail.com>
Wed, 29 Jan 2014 22:27:18 +0000 (23:27 +0100)
Only documents ac3 decoder options at this point.

doc/avconv.texi
doc/avplay.texi
doc/decoders.texi [new file with mode: 0644]

index 972d13fed56aef15db47d8ef39009d4197fa1a91..7ef415fc7d0f81cb63332ae7479ec35fbe6af50e 100644 (file)
@@ -1120,6 +1120,7 @@ avconv -i src.ext -lmax 21*QP2LAMBDA dst.ext
 @c man end EXAMPLES
 
 @include eval.texi
+@include decoders.texi
 @include encoders.texi
 @include demuxers.texi
 @include muxers.texi
index 50142ab282fca7c29f3971e6c0ba0e37873796e3..4d9af5f5621c98d8940b5e7f1d32717baca108a2 100644 (file)
@@ -155,6 +155,7 @@ Seek to percentage in file corresponding to fraction of width.
 @c man end
 
 @include eval.texi
+@include decoders.texi
 @include demuxers.texi
 @include muxers.texi
 @include indevs.texi
diff --git a/doc/decoders.texi b/doc/decoders.texi
new file mode 100644 (file)
index 0000000..c3573a6
--- /dev/null
@@ -0,0 +1,56 @@
+@chapter Decoders
+@c man begin DECODERS
+
+Decoders are configured elements in Libav which allow the decoding of
+multimedia streams.
+
+When you configure your Libav build, all the supported native decoders
+are enabled by default. Decoders requiring an external library must be enabled
+manually via the corresponding @code{--enable-lib} option. You can list all
+available decoders using the configure option @code{--list-decoders}.
+
+You can disable all the decoders with the configure option
+@code{--disable-decoders} and selectively enable / disable single decoders
+with the options @code{--enable-decoder=@var{DECODER}} /
+@code{--disable-decoder=@var{DECODER}}.
+
+The option @code{-decoders} of the av* tools will display the list of
+enabled decoders.
+
+@c man end DECODERS
+
+@chapter Audio Decoders
+@c man begin AUDIO DECODERS
+
+A description of some of the currently available audio decoders
+follows.
+
+@section ac3
+
+AC-3 audio decoder.
+
+This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as
+the undocumented RealAudio 3 (a.k.a. dnet).
+
+@subsubsection AC-3 Decoder Options
+
+@table @option
+
+@item -drc_scale @var{value}
+Dynamic Range Scale Factor. The factor to apply to dynamic range values
+from the AC-3 stream. This factor is applied exponentially.
+There are 3 notable scale factor ranges:
+@table @option
+@item drc_scale == 0
+DRC disabled. Produces full range audio.
+@item 0 < drc_scale <= 1
+DRC enabled.  Applies a fraction of the stream DRC value.
+Audio reproduction is between full range and full compression.
+@item drc_scale > 1
+DRC enabled. Applies drc_scale asymmetrically.
+Loud sounds are fully compressed.  Soft sounds are enhanced.
+@end table
+
+@end table
+
+@c man end AUDIO DECODERS