lavfi/kerndeint: remove unused pixel_step.
[ffmpeg.git] / doc / decoders.texi
1 @chapter Decoders
2 @c man begin DECODERS
3
4 Decoders are configured elements in FFmpeg which allow the decoding of
5 multimedia streams.
6
7 When you configure your FFmpeg build, all the supported native decoders
8 are enabled by default. Decoders requiring an external library must be enabled
9 manually via the corresponding @code{--enable-lib} option. You can list all
10 available decoders using the configure option @code{--list-decoders}.
11
12 You can disable all the decoders with the configure option
13 @code{--disable-decoders} and selectively enable / disable single decoders
14 with the options @code{--enable-decoder=@var{DECODER}} /
15 @code{--disable-decoder=@var{DECODER}}.
16
17 The option @code{-codecs} of the ff* tools will display the list of
18 enabled decoders.
19
20 @c man end DECODERS
21
22 @chapter Video Decoders
23 @c man begin VIDEO DECODERS
24
25 A description of some of the currently available video decoders
26 follows.
27
28 @section rawvideo
29
30 Raw video decoder.
31
32 This decoder decodes rawvideo streams.
33
34 @subsection Options
35
36 @table @option
37 @item top @var{top_field_first}
38 Specify the assumed field type of the input video.
39 @table @option
40 @item -1
41 the video is assumed to be progressive (default)
42 @item 0
43 bottom-field-first is assumed
44 @item 1
45 top-field-first is assumed
46 @end table
47
48 @end table
49
50 @c man end VIDEO DECODERS
51
52 @chapter Audio Decoders
53 @c man begin AUDIO DECODERS
54
55 @section ffwavesynth
56
57 Internal wave synthetizer.
58
59 This decoder generates wave patterns according to predefined sequences. Its
60 use is purely internal and the format of the data it accepts is not publicly
61 documented.
62
63 @c man end AUDIO DECODERS
64
65 @chapter Subtitles Decoders
66 @c man begin SUBTILES DECODERS
67
68 @section dvdsub
69
70 This codec decodes the bitmap subtitles used in DVDs; the same subtitles can
71 also be found in VobSub file pairs and in some Matroska files.
72
73 @subsection Options
74
75 @table @option
76 @item palette
77 Specify the global palette used by the bitmaps. When stored in VobSub, the
78 palette is normally specified in the index file; in Matroska, the palette is
79 stored in the codec extra-data in the same format as in VobSub. In DVDs, the
80 palette is stored in the IFO file, and therefore not available when reading
81 from dumped VOB files.
82
83 The format for this option is a string containing 16 24-bits hexadecimal
84 numbers (without 0x prefix) separated by comas, for example @code{0d00ee,
85 ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
86 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b}.
87 @end table
88
89 @c man end SUBTILES DECODERS