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