Various small spelling fixes.
[ffmpeg.git] / doc / demuxers.texi
1 @chapter Demuxers
2 @c man begin DEMUXERS
3
4 Demuxers are configured elements in FFmpeg that can 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 asf
33
34 Advanced Systems Format demuxer.
35
36 This demuxer is used to demux ASF files and MMS network streams.
37
38 @table @option
39 @item -no_resync_search @var{bool}
40 Do not try to resynchronize by looking for a certain optional start code.
41 @end table
42
43 @anchor{concat}
44 @section concat
45
46 Virtual concatenation script demuxer.
47
48 This demuxer reads a list of files and other directives from a text file and
49 demuxes them one after the other, as if all their packet had been muxed
50 together.
51
52 The timestamps in the files are adjusted so that the first file starts at 0
53 and each next file starts where the previous one finishes. Note that it is
54 done globally and may cause gaps if all streams do not have exactly the same
55 length.
56
57 All files must have the same streams (same codecs, same time base, etc.).
58
59 The duration of each file is used to adjust the timestamps of the next file:
60 if the duration is incorrect (because it was computed using the bit-rate or
61 because the file is truncated, for example), it can cause artifacts. The
62 @code{duration} directive can be used to override the duration stored in
63 each file.
64
65 @subsection Syntax
66
67 The script is a text file in extended-ASCII, with one directive per line.
68 Empty lines, leading spaces and lines starting with '#' are ignored. The
69 following directive is recognized:
70
71 @table @option
72
73 @item @code{file @var{path}}
74 Path to a file to read; special characters and spaces must be escaped with
75 backslash or single quotes.
76
77 All subsequent file-related directives apply to that file.
78
79 @item @code{ffconcat version 1.0}
80 Identify the script type and version. It also sets the @option{safe} option
81 to 1 if it was to its default -1.
82
83 To make FFmpeg recognize the format automatically, this directive must
84 appears exactly as is (no extra space or byte-order-mark) on the very first
85 line of the script.
86
87 @item @code{duration @var{dur}}
88 Duration of the file. This information can be specified from the file;
89 specifying it here may be more efficient or help if the information from the
90 file is not available or accurate.
91
92 If the duration is set for all files, then it is possible to seek in the
93 whole concatenated video.
94
95 @item @code{stream}
96 Introduce a stream in the virtual file.
97 All subsequent stream-related directives apply to the last introduced
98 stream.
99 Some streams properties must be set in order to allow identifying the
100 matching streams in the subfiles.
101 If no streams are defined in the script, the streams from the first file are
102 copied.
103
104 @item @code{exact_stream_id @var{id}}
105 Set the id of the stream.
106 If this directive is given, the string with the corresponding id in the
107 subfiles will be used.
108 This is especially useful for MPEG-PS (VOB) files, where the order of the
109 streams is not reliable.
110
111 @end table
112
113 @subsection Options
114
115 This demuxer accepts the following option:
116
117 @table @option
118
119 @item safe
120 If set to 1, reject unsafe file paths. A file path is considered safe if it
121 does not contain a protocol specification and is relative and all components
122 only contain characters from the portable character set (letters, digits,
123 period, underscore and hyphen) and have no period at the beginning of a
124 component.
125
126 If set to 0, any file name is accepted.
127
128 The default is -1, it is equivalent to 1 if the format was automatically
129 probed and 0 otherwise.
130
131 @end table
132
133 @section flv
134
135 Adobe Flash Video Format demuxer.
136
137 This demuxer is used to demux FLV files and RTMP network streams.
138
139 @table @option
140 @item -flv_metadata @var{bool}
141 Allocate the streams according to the onMetaData array content.
142 @end table
143
144 @section libgme
145
146 The Game Music Emu library is a collection of video game music file emulators.
147
148 See @url{http://code.google.com/p/game-music-emu/} for more information.
149
150 Some files have multiple tracks. The demuxer will pick the first track by
151 default. The @option{track_index} option can be used to select a different
152 track. Track indexes start at 0. The demuxer exports the number of tracks as
153 @var{tracks} meta data entry.
154
155 For very large files, the @option{max_size} option may have to be adjusted.
156
157 @section libquvi
158
159 Play media from Internet services using the quvi project.
160
161 The demuxer accepts a @option{format} option to request a specific quality. It
162 is by default set to @var{best}.
163
164 See @url{http://quvi.sourceforge.net/} for more information.
165
166 FFmpeg needs to be built with @code{--enable-libquvi} for this demuxer to be
167 enabled.
168
169 @section image2
170
171 Image file demuxer.
172
173 This demuxer reads from a list of image files specified by a pattern.
174 The syntax and meaning of the pattern is specified by the
175 option @var{pattern_type}.
176
177 The pattern may contain a suffix which is used to automatically
178 determine the format of the images contained in the files.
179
180 The size, the pixel format, and the format of each image must be the
181 same for all the files in the sequence.
182
183 This demuxer accepts the following options:
184 @table @option
185 @item framerate
186 Set the frame rate for the video stream. It defaults to 25.
187 @item loop
188 If set to 1, loop over the input. Default value is 0.
189 @item pattern_type
190 Select the pattern type used to interpret the provided filename.
191
192 @var{pattern_type} accepts one of the following values.
193 @table @option
194 @item sequence
195 Select a sequence pattern type, used to specify a sequence of files
196 indexed by sequential numbers.
197
198 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
199 specifies the position of the characters representing a sequential
200 number in each filename matched by the pattern. If the form
201 "%d0@var{N}d" is used, the string representing the number in each
202 filename is 0-padded and @var{N} is the total number of 0-padded
203 digits representing the number. The literal character '%' can be
204 specified in the pattern with the string "%%".
205
206 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
207 the file list specified by the pattern must contain a number
208 inclusively contained between @var{start_number} and
209 @var{start_number}+@var{start_number_range}-1, and all the following
210 numbers must be sequential.
211
212 For example the pattern "img-%03d.bmp" will match a sequence of
213 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
214 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
215 sequence of filenames of the form @file{i%m%g-1.jpg},
216 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
217
218 Note that the pattern must not necessarily contain "%d" or
219 "%0@var{N}d", for example to convert a single image file
220 @file{img.jpeg} you can employ the command:
221 @example
222 ffmpeg -i img.jpeg img.png
223 @end example
224
225 @item glob
226 Select a glob wildcard pattern type.
227
228 The pattern is interpreted like a @code{glob()} pattern. This is only
229 selectable if libavformat was compiled with globbing support.
230
231 @item glob_sequence @emph{(deprecated, will be removed)}
232 Select a mixed glob wildcard/sequence pattern.
233
234 If your version of libavformat was compiled with globbing support, and
235 the provided pattern contains at least one glob meta character among
236 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
237 interpreted like a @code{glob()} pattern, otherwise it is interpreted
238 like a sequence pattern.
239
240 All glob special characters @code{%*?[]@{@}} must be prefixed
241 with "%". To escape a literal "%" you shall use "%%".
242
243 For example the pattern @code{foo-%*.jpeg} will match all the
244 filenames prefixed by "foo-" and terminating with ".jpeg", and
245 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
246 "foo-", followed by a sequence of three characters, and terminating
247 with ".jpeg".
248
249 This pattern type is deprecated in favor of @var{glob} and
250 @var{sequence}.
251 @end table
252
253 Default value is @var{glob_sequence}.
254 @item pixel_format
255 Set the pixel format of the images to read. If not specified the pixel
256 format is guessed from the first image file in the sequence.
257 @item start_number
258 Set the index of the file matched by the image file pattern to start
259 to read from. Default value is 0.
260 @item start_number_range
261 Set the index interval range to check when looking for the first image
262 file in the sequence, starting from @var{start_number}. Default value
263 is 5.
264 @item ts_from_file
265 If set to 1, will set frame timestamp to modification time of image file. Note
266 that monotonity of timestamps is not provided: images go in the same order as
267 without this option. Default value is 0.
268 If set to 2, will set frame timestamp to the modification time of the image file in
269 nanosecond precision.
270 @item video_size
271 Set the video size of the images to read. If not specified the video
272 size is guessed from the first image file in the sequence.
273 @end table
274
275 @subsection Examples
276
277 @itemize
278 @item
279 Use @command{ffmpeg} for creating a video from the images in the file
280 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
281 input frame rate of 10 frames per second:
282 @example
283 ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
284 @end example
285
286 @item
287 As above, but start by reading from a file with index 100 in the sequence:
288 @example
289 ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
290 @end example
291
292 @item
293 Read images matching the "*.png" glob pattern , that is all the files
294 terminating with the ".png" suffix:
295 @example
296 ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
297 @end example
298 @end itemize
299
300 @section mpegts
301
302 MPEG-2 transport stream demuxer.
303
304 @table @option
305
306 @item fix_teletext_pts
307 Overrides teletext packet PTS and DTS values with the timestamps calculated
308 from the PCR of the first program which the teletext stream is part of and is
309 not discarded. Default value is 1, set this option to 0 if you want your
310 teletext packet PTS and DTS values untouched.
311 @end table
312
313 @section rawvideo
314
315 Raw video demuxer.
316
317 This demuxer allows one to read raw video data. Since there is no header
318 specifying the assumed video parameters, the user must specify them
319 in order to be able to decode the data correctly.
320
321 This demuxer accepts the following options:
322 @table @option
323
324 @item framerate
325 Set input video frame rate. Default value is 25.
326
327 @item pixel_format
328 Set the input video pixel format. Default value is @code{yuv420p}.
329
330 @item video_size
331 Set the input video size. This value must be specified explicitly.
332 @end table
333
334 For example to read a rawvideo file @file{input.raw} with
335 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
336 size of @code{320x240}, and a frame rate of 10 images per second, use
337 the command:
338 @example
339 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
340 @end example
341
342 @section sbg
343
344 SBaGen script demuxer.
345
346 This demuxer reads the script language used by SBaGen
347 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
348 script looks like that:
349 @example
350 -SE
351 a: 300-2.5/3 440+4.5/0
352 b: 300-2.5/0 440+4.5/3
353 off: -
354 NOW      == a
355 +0:07:00 == b
356 +0:14:00 == a
357 +0:21:00 == b
358 +0:30:00    off
359 @end example
360
361 A SBG script can mix absolute and relative timestamps. If the script uses
362 either only absolute timestamps (including the script start time) or only
363 relative ones, then its layout is fixed, and the conversion is
364 straightforward. On the other hand, if the script mixes both kind of
365 timestamps, then the @var{NOW} reference for relative timestamps will be
366 taken from the current time of day at the time the script is read, and the
367 script layout will be frozen according to that reference. That means that if
368 the script is directly played, the actual times will match the absolute
369 timestamps up to the sound controller's clock accuracy, but if the user
370 somehow pauses the playback or seeks, all times will be shifted accordingly.
371
372 @section tedcaptions
373
374 JSON captions used for @url{http://www.ted.com/, TED Talks}.
375
376 TED does not provide links to the captions, but they can be guessed from the
377 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
378 contains a bookmarklet to expose them.
379
380 This demuxer accepts the following option:
381 @table @option
382 @item start_time
383 Set the start time of the TED talk, in milliseconds. The default is 15000
384 (15s). It is used to sync the captions with the downloadable videos, because
385 they include a 15s intro.
386 @end table
387
388 Example: convert the captions to a format most players understand:
389 @example
390 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
391 @end example
392
393 @c man end DEMUXERS