doc/demuxers: quote command line arguments with @code
[ffmpeg.git] / doc / demuxers.texi
1 @chapter Demuxers
2 @c man begin DEMUXERS
3
4 Demuxers are configured elements in FFmpeg which allow to read the
5 multimedia streams from a particular type of file.
6
7 When you configure your FFmpeg build, all the supported demuxers
8 are enabled by default. You can list all available ones using the
9 configure option @code{--list-demuxers}.
10
11 You can disable all the demuxers using the configure option
12 @code{--disable-demuxers}, and selectively enable a single demuxer with
13 the option @code{--enable-demuxer=@var{DEMUXER}}, or disable it
14 with the option @code{--disable-demuxer=@var{DEMUXER}}.
15
16 The option @code{-formats} of the ff* tools will display the list of
17 enabled demuxers.
18
19 The description of some of the currently available demuxers follows.
20
21 @section applehttp
22
23 Apple HTTP Live Streaming demuxer.
24
25 This demuxer presents all AVStreams from all variant streams.
26 The id field is set to the bitrate variant index number. By setting
27 the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay),
28 the caller can decide which variant streams to actually receive.
29 The total bitrate of the variant that the stream belongs to is
30 available in a metadata key named "variant_bitrate".
31
32 @section concat
33
34 Virtual concatenation script demuxer.
35
36 This demuxer reads a list of files and other directives from a text file and
37 demuxes them one after the other, as if all their packet had been muxed
38 together.
39
40 The timestamps in the files are adjusted so that the first file starts at 0
41 and each next file starts where the previous one finishes. Note that it is
42 done globally and may cause gaps if all streams do not have exactly the same
43 length.
44
45 All files must have the same streams (same codecs, same time base, etc.).
46
47 This script format can currently not be probed, it must be specified explicitly.
48
49 @subsection Syntax
50
51 The script is a text file in extended-ASCII, with one directive per line.
52 Empty lines, leading spaces and lines starting with '#' are ignored. The
53 following directive is recognized:
54
55 @table @option
56
57 @item @code{file @var{path}}
58 Path to a file to read; special characters and spaces must be escaped with
59 backslash or single quotes.
60
61 @end table
62
63 @section image2
64
65 Image file demuxer.
66
67 This demuxer reads from a list of image files specified by a pattern.
68 The syntax and meaning of the pattern is specified by the
69 option @var{pattern_type}.
70
71 The pattern may contain a suffix which is used to automatically
72 determine the format of the images contained in the files.
73
74 The size, the pixel format, and the format of each image must be the
75 same for all the files in the sequence.
76
77 This demuxer accepts the following options:
78 @table @option
79 @item framerate
80 Set the framerate for the video stream. It defaults to 25.
81 @item loop
82 If set to 1, loop over the input. Default value is 0.
83 @item pattern_type
84 Select the pattern type used to interpret the provided filename.
85
86 @var{pattern_type} accepts one of the following values.
87 @table @option
88 @item sequence
89 Select a sequence pattern type, used to specify a sequence of files
90 indexed by sequential numbers.
91
92 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
93 specifies the position of the characters representing a sequential
94 number in each filename matched by the pattern. If the form
95 "%d0@var{N}d" is used, the string representing the number in each
96 filename is 0-padded and @var{N} is the total number of 0-padded
97 digits representing the number. The literal character '%' can be
98 specified in the pattern with the string "%%".
99
100 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
101 the file list specified by the pattern must contain a number
102 inclusively contained between @var{start_number} and
103 @var{start_number}+@var{start_number_range}-1, and all the following
104 numbers must be sequential.
105
106 For example the pattern "img-%03d.bmp" will match a sequence of
107 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
108 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
109 sequence of filenames of the form @file{i%m%g-1.jpg},
110 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
111
112 Note that the pattern must not necessarily contain "%d" or
113 "%0@var{N}d", for example to convert a single image file
114 @file{img.jpeg} you can employ the command:
115 @example
116 ffmpeg -i img.jpeg img.png
117 @end example
118
119 @item glob
120 Select a glob wildcard pattern type.
121
122 The pattern is interpreted like a @code{glob()} pattern. This is only
123 selectable if libavformat was compiled with globbing support.
124
125 @item glob_sequence @emph{(deprecated, will be removed)}
126 Select a mixed glob wildcard/sequence pattern.
127
128 If your version of libavformat was compiled with globbing support, and
129 the provided pattern contains at least one glob meta character among
130 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
131 interpreted like a @code{glob()} pattern, otherwise it is interpreted
132 like a sequence pattern.
133
134 All glob special characters @code{%*?[]@{@}} must be prefixed
135 with "%". To escape a literal "%" you shall use "%%".
136
137 For example the pattern @code{foo-%*.jpeg} will match all the
138 filenames prefixed by "foo-" and terminating with ".jpeg", and
139 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
140 "foo-", followed by a sequence of three characters, and terminating
141 with ".jpeg".
142
143 This pattern type is deprecated in favor of @var{glob} and
144 @var{sequence}.
145 @end table
146
147 Default value is @var{glob_sequence}.
148 @item pixel_format
149 Set the pixel format of the images to read. If not specified the pixel
150 format is guessed from the first image file in the sequence.
151 @item start_number
152 Set the index of the file matched by the image file pattern to start
153 to read from. Default value is 0.
154 @item start_number_range
155 Set the index interval range to check when looking for the first image
156 file in the sequence, starting from @var{start_number}. Default value
157 is 5.
158 @item video_size
159 Set the video size of the images to read. If not specified the video
160 size is guessed from the first image file in the sequence.
161 @end table
162
163 @subsection Examples
164
165 @itemize
166 @item
167 Use @command{ffmpeg} for creating a video from the images in the file
168 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
169 input frame rate of 10 frames per second:
170 @example
171 ffmpeg -i 'img-%03d.jpeg' -r 10 out.mkv
172 @end example
173
174 @item
175 As above, but start by reading from a file with index 100 in the sequence:
176 @example
177 ffmpeg -start_number 100 -i 'img-%03d.jpeg' -r 10 out.mkv
178 @end example
179
180 @item
181 Read images matching the "*.png" glob pattern , that is all the files
182 terminating with the ".png" suffix:
183 @example
184 ffmpeg -pattern_type glob -i "*.png" -r 10 out.mkv
185 @end example
186 @end itemize
187
188 @section rawvideo
189
190 Raw video demuxer.
191
192 This demuxer allows to read raw video data. Since there is no header
193 specifying the assumed video parameters, the user must specify them
194 in order to be able to decode the data correctly.
195
196 This demuxer accepts the following options:
197 @table @option
198
199 @item framerate
200 Set input video frame rate. Default value is 25.
201
202 @item pixel_format
203 Set the input video pixel format. Default value is @code{yuv420p}.
204
205 @item video_size
206 Set the input video size. This value must be specified explicitly.
207 @end table
208
209 For example to read a rawvideo file @file{input.raw} with
210 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
211 size of @code{320x240}, and a frame rate of 10 images per second, use
212 the command:
213 @example
214 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
215 @end example
216
217 @section sbg
218
219 SBaGen script demuxer.
220
221 This demuxer reads the script language used by SBaGen
222 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
223 script looks like that:
224 @example
225 -SE
226 a: 300-2.5/3 440+4.5/0
227 b: 300-2.5/0 440+4.5/3
228 off: -
229 NOW      == a
230 +0:07:00 == b
231 +0:14:00 == a
232 +0:21:00 == b
233 +0:30:00    off
234 @end example
235
236 A SBG script can mix absolute and relative timestamps. If the script uses
237 either only absolute timestamps (including the script start time) or only
238 relative ones, then its layout is fixed, and the conversion is
239 straightforward. On the other hand, if the script mixes both kind of
240 timestamps, then the @var{NOW} reference for relative timestamps will be
241 taken from the current time of day at the time the script is read, and the
242 script layout will be frozen according to that reference. That means that if
243 the script is directly played, the actual times will match the absolute
244 timestamps up to the sound controller's clock accuracy, but if the user
245 somehow pauses the playback or seeks, all times will be shifted accordingly.
246
247 @section tedcaptions
248
249 JSON captions used for @url{http://www.ted.com/, TED Talks}.
250
251 TED does not provide links to the captions, but they can be guessed from the
252 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
253 contains a bookmarklet to expose them.
254
255 This demuxer accepts the following option:
256 @table @option
257 @item start_time
258 Set the start time of the TED talk, in milliseconds. The default is 15000
259 (15s). It is used to sync the captions with the downloadable videos, because
260 they include a 15s intro.
261 @end table
262
263 Example: convert the captions to a format most players understand:
264 @example
265 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
266 @end example
267
268 @c man end DEMUXERS