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