summaryrefslogtreecommitdiff
path: root/doc/decoders.texi
diff options
context:
space:
mode:
authorNicolas George <nicolas.george@normalesup.org>2012-12-01 14:47:14 +0100
committerNicolas George <nicolas.george@normalesup.org>2012-12-05 09:25:48 +0100
commit217b10de3f30325961d45af3827d4d097e8af5ec (patch)
treedb40c2046bd0b1fcf46e58b4a2c87f6370bbfaf5 /doc/decoders.texi
parent9db3fb6ed8d35ae02a1d3c322777bd45bb4579c9 (diff)
lavc/dvdsubdec: accept palette from options.
On DVDs, the palette is part of the IFO file and therefore not available when reading from a dumped VOB file.
Diffstat (limited to 'doc/decoders.texi')
-rw-r--r--doc/decoders.texi26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/decoders.texi b/doc/decoders.texi
index 87ad4eea26..c5b79b35f2 100644
--- a/doc/decoders.texi
+++ b/doc/decoders.texi
@@ -61,3 +61,29 @@ use is purely internal and the format of the data it accepts is not publicly
documented.
@c man end AUDIO DECODERS
+
+@chapter Subtitles Decoders
+@c man begin SUBTILES DECODERS
+
+@section dvdsub
+
+This codec decodes the bitmap subtitles used in DVDs; the same subtitles can
+also be found in VobSub file pairs and in some Matroska files.
+
+@subsection @Options
+
+@table @option
+@item palette
+Specify the global palette used by the bitmaps. When stored in VobSub, the
+palette is normally specified in the index file; in Matroska, the palette is
+stored in the codec extra-data in the same format as in VobSub. In DVDs, the
+palette is stored in the IFO file, and therefore not available when reading
+from dumped VOB files.
+
+The format for this option is a string containing 16 24-bits hexadecimal
+numbers (without 0x prefix) separated by comas, for example @code{0d00ee,
+ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
+7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b}.
+@end table
+
+@c man end SUBTILES DECODERS