concatdec: add support for injecting packet metadata
[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 to its default -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{inpoint @var{timestamp}}
116 In point of the file. When the demuxer opens the file it instantly seeks to the
117 specified timestamp. Seeking is done so that all streams can be presented
118 successfully at In point.
119
120 This directive works best with intra frame codecs, because for non-intra frame
121 ones you will usually get extra packets before the actual In point and the
122 decoded content will most likely contain frames before In point too.
123
124 For each file, packets before the file In point will have timestamps less than
125 the calculated start timestamp of the file (negative in case of the first
126 file), and the duration of the files (if not specified by the @code{duration}
127 directive) will be reduced based on their specified In point.
128
129 Because of potential packets before the specified In point, packet timestamps
130 may overlap between two concatenated files.
131
132 @item @code{outpoint @var{timestamp}}
133 Out point of the file. When the demuxer reaches the specified decoding
134 timestamp in any of the streams, it handles it as an end of file condition and
135 skips the current and all the remaining packets from all streams.
136
137 Out point is exclusive, which means that the demuxer will not output packets
138 with a decoding timestamp greater or equal to Out point.
139
140 This directive works best with intra frame codecs and formats where all streams
141 are tightly interleaved. For non-intra frame codecs you will usually get
142 additional packets with presentation timestamp after Out point therefore the
143 decoded content will most likely contain frames after Out point too. If your
144 streams are not tightly interleaved you may not get all the packets from all
145 streams before Out point and you may only will be able to decode the earliest
146 stream until Out point.
147
148 The duration of the files (if not specified by the @code{duration}
149 directive) will be reduced based on their specified Out point.
150
151 @item @code{file_packet_metadata @var{key=value}}
152 Metadata of the packets of the file. The specified metadata will be set for
153 each file packet. You can specify this directive multiple times to add multiple
154 metadata entries.
155
156 @item @code{stream}
157 Introduce a stream in the virtual file.
158 All subsequent stream-related directives apply to the last introduced
159 stream.
160 Some streams properties must be set in order to allow identifying the
161 matching streams in the subfiles.
162 If no streams are defined in the script, the streams from the first file are
163 copied.
164
165 @item @code{exact_stream_id @var{id}}
166 Set the id of the stream.
167 If this directive is given, the string with the corresponding id in the
168 subfiles will be used.
169 This is especially useful for MPEG-PS (VOB) files, where the order of the
170 streams is not reliable.
171
172 @end table
173
174 @subsection Options
175
176 This demuxer accepts the following option:
177
178 @table @option
179
180 @item safe
181 If set to 1, reject unsafe file paths. A file path is considered safe if it
182 does not contain a protocol specification and is relative and all components
183 only contain characters from the portable character set (letters, digits,
184 period, underscore and hyphen) and have no period at the beginning of a
185 component.
186
187 If set to 0, any file name is accepted.
188
189 The default is -1, it is equivalent to 1 if the format was automatically
190 probed and 0 otherwise.
191
192 @item auto_convert
193 If set to 1, try to perform automatic conversions on packet data to make the
194 streams concatenable.
195 The default is 1.
196
197 Currently, the only conversion is adding the h264_mp4toannexb bitstream
198 filter to H.264 streams in MP4 format. This is necessary in particular if
199 there are resolution changes.
200
201 @end table
202
203 @section flv
204
205 Adobe Flash Video Format demuxer.
206
207 This demuxer is used to demux FLV files and RTMP network streams.
208
209 @table @option
210 @item -flv_metadata @var{bool}
211 Allocate the streams according to the onMetaData array content.
212 @end table
213
214 @section libgme
215
216 The Game Music Emu library is a collection of video game music file emulators.
217
218 See @url{http://code.google.com/p/game-music-emu/} for more information.
219
220 Some files have multiple tracks. The demuxer will pick the first track by
221 default. The @option{track_index} option can be used to select a different
222 track. Track indexes start at 0. The demuxer exports the number of tracks as
223 @var{tracks} meta data entry.
224
225 For very large files, the @option{max_size} option may have to be adjusted.
226
227 @section libquvi
228
229 Play media from Internet services using the quvi project.
230
231 The demuxer accepts a @option{format} option to request a specific quality. It
232 is by default set to @var{best}.
233
234 See @url{http://quvi.sourceforge.net/} for more information.
235
236 FFmpeg needs to be built with @code{--enable-libquvi} for this demuxer to be
237 enabled.
238
239 @section gif
240
241 Animated GIF demuxer.
242
243 It accepts the following options:
244
245 @table @option
246 @item min_delay
247 Set the minimum valid delay between frames in hundredths of seconds.
248 Range is 0 to 6000. Default value is 2.
249
250 @item max_gif_delay
251 Set the maximum valid delay between frames in hundredth of seconds.
252 Range is 0 to 65535. Default value is 65535 (nearly eleven minutes),
253 the maximum value allowed by the specification.
254
255 @item default_delay
256 Set the default delay between frames in hundredths of seconds.
257 Range is 0 to 6000. Default value is 10.
258
259 @item ignore_loop
260 GIF files can contain information to loop a certain number of times (or
261 infinitely). If @option{ignore_loop} is set to 1, then the loop setting
262 from the input will be ignored and looping will not occur. If set to 0,
263 then looping will occur and will cycle the number of times according to
264 the GIF. Default value is 1.
265 @end table
266
267 For example, with the overlay filter, place an infinitely looping GIF
268 over another video:
269 @example
270 ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
271 @end example
272
273 Note that in the above example the shortest option for overlay filter is
274 used to end the output video at the length of the shortest input file,
275 which in this case is @file{input.mp4} as the GIF in this example loops
276 infinitely.
277
278 @section image2
279
280 Image file demuxer.
281
282 This demuxer reads from a list of image files specified by a pattern.
283 The syntax and meaning of the pattern is specified by the
284 option @var{pattern_type}.
285
286 The pattern may contain a suffix which is used to automatically
287 determine the format of the images contained in the files.
288
289 The size, the pixel format, and the format of each image must be the
290 same for all the files in the sequence.
291
292 This demuxer accepts the following options:
293 @table @option
294 @item framerate
295 Set the frame rate for the video stream. It defaults to 25.
296 @item loop
297 If set to 1, loop over the input. Default value is 0.
298 @item pattern_type
299 Select the pattern type used to interpret the provided filename.
300
301 @var{pattern_type} accepts one of the following values.
302 @table @option
303 @item none
304 Disable pattern matching, therefore the video will only contain the specified
305 image. You should use this option if you do not want to create sequences from
306 multiple images and your filenames may contain special pattern characters.
307 @item sequence
308 Select a sequence pattern type, used to specify a sequence of files
309 indexed by sequential numbers.
310
311 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
312 specifies the position of the characters representing a sequential
313 number in each filename matched by the pattern. If the form
314 "%d0@var{N}d" is used, the string representing the number in each
315 filename is 0-padded and @var{N} is the total number of 0-padded
316 digits representing the number. The literal character '%' can be
317 specified in the pattern with the string "%%".
318
319 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
320 the file list specified by the pattern must contain a number
321 inclusively contained between @var{start_number} and
322 @var{start_number}+@var{start_number_range}-1, and all the following
323 numbers must be sequential.
324
325 For example the pattern "img-%03d.bmp" will match a sequence of
326 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
327 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
328 sequence of filenames of the form @file{i%m%g-1.jpg},
329 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
330
331 Note that the pattern must not necessarily contain "%d" or
332 "%0@var{N}d", for example to convert a single image file
333 @file{img.jpeg} you can employ the command:
334 @example
335 ffmpeg -i img.jpeg img.png
336 @end example
337
338 @item glob
339 Select a glob wildcard pattern type.
340
341 The pattern is interpreted like a @code{glob()} pattern. This is only
342 selectable if libavformat was compiled with globbing support.
343
344 @item glob_sequence @emph{(deprecated, will be removed)}
345 Select a mixed glob wildcard/sequence pattern.
346
347 If your version of libavformat was compiled with globbing support, and
348 the provided pattern contains at least one glob meta character among
349 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
350 interpreted like a @code{glob()} pattern, otherwise it is interpreted
351 like a sequence pattern.
352
353 All glob special characters @code{%*?[]@{@}} must be prefixed
354 with "%". To escape a literal "%" you shall use "%%".
355
356 For example the pattern @code{foo-%*.jpeg} will match all the
357 filenames prefixed by "foo-" and terminating with ".jpeg", and
358 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
359 "foo-", followed by a sequence of three characters, and terminating
360 with ".jpeg".
361
362 This pattern type is deprecated in favor of @var{glob} and
363 @var{sequence}.
364 @end table
365
366 Default value is @var{glob_sequence}.
367 @item pixel_format
368 Set the pixel format of the images to read. If not specified the pixel
369 format is guessed from the first image file in the sequence.
370 @item start_number
371 Set the index of the file matched by the image file pattern to start
372 to read from. Default value is 0.
373 @item start_number_range
374 Set the index interval range to check when looking for the first image
375 file in the sequence, starting from @var{start_number}. Default value
376 is 5.
377 @item ts_from_file
378 If set to 1, will set frame timestamp to modification time of image file. Note
379 that monotonity of timestamps is not provided: images go in the same order as
380 without this option. Default value is 0.
381 If set to 2, will set frame timestamp to the modification time of the image file in
382 nanosecond precision.
383 @item video_size
384 Set the video size of the images to read. If not specified the video
385 size is guessed from the first image file in the sequence.
386 @end table
387
388 @subsection Examples
389
390 @itemize
391 @item
392 Use @command{ffmpeg} for creating a video from the images in the file
393 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
394 input frame rate of 10 frames per second:
395 @example
396 ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
397 @end example
398
399 @item
400 As above, but start by reading from a file with index 100 in the sequence:
401 @example
402 ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
403 @end example
404
405 @item
406 Read images matching the "*.png" glob pattern , that is all the files
407 terminating with the ".png" suffix:
408 @example
409 ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
410 @end example
411 @end itemize
412
413 @section mpegts
414
415 MPEG-2 transport stream demuxer.
416
417 @table @option
418
419 @item fix_teletext_pts
420 Overrides teletext packet PTS and DTS values with the timestamps calculated
421 from the PCR of the first program which the teletext stream is part of and is
422 not discarded. Default value is 1, set this option to 0 if you want your
423 teletext packet PTS and DTS values untouched.
424 @end table
425
426 @section rawvideo
427
428 Raw video demuxer.
429
430 This demuxer allows one to read raw video data. Since there is no header
431 specifying the assumed video parameters, the user must specify them
432 in order to be able to decode the data correctly.
433
434 This demuxer accepts the following options:
435 @table @option
436
437 @item framerate
438 Set input video frame rate. Default value is 25.
439
440 @item pixel_format
441 Set the input video pixel format. Default value is @code{yuv420p}.
442
443 @item video_size
444 Set the input video size. This value must be specified explicitly.
445 @end table
446
447 For example to read a rawvideo file @file{input.raw} with
448 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
449 size of @code{320x240}, and a frame rate of 10 images per second, use
450 the command:
451 @example
452 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
453 @end example
454
455 @section sbg
456
457 SBaGen script demuxer.
458
459 This demuxer reads the script language used by SBaGen
460 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
461 script looks like that:
462 @example
463 -SE
464 a: 300-2.5/3 440+4.5/0
465 b: 300-2.5/0 440+4.5/3
466 off: -
467 NOW      == a
468 +0:07:00 == b
469 +0:14:00 == a
470 +0:21:00 == b
471 +0:30:00    off
472 @end example
473
474 A SBG script can mix absolute and relative timestamps. If the script uses
475 either only absolute timestamps (including the script start time) or only
476 relative ones, then its layout is fixed, and the conversion is
477 straightforward. On the other hand, if the script mixes both kind of
478 timestamps, then the @var{NOW} reference for relative timestamps will be
479 taken from the current time of day at the time the script is read, and the
480 script layout will be frozen according to that reference. That means that if
481 the script is directly played, the actual times will match the absolute
482 timestamps up to the sound controller's clock accuracy, but if the user
483 somehow pauses the playback or seeks, all times will be shifted accordingly.
484
485 @section tedcaptions
486
487 JSON captions used for @url{http://www.ted.com/, TED Talks}.
488
489 TED does not provide links to the captions, but they can be guessed from the
490 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
491 contains a bookmarklet to expose them.
492
493 This demuxer accepts the following option:
494 @table @option
495 @item start_time
496 Set the start time of the TED talk, in milliseconds. The default is 15000
497 (15s). It is used to sync the captions with the downloadable videos, because
498 they include a 15s intro.
499 @end table
500
501 Example: convert the captions to a format most players understand:
502 @example
503 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
504 @end example
505
506 @c man end DEMUXERS