flv demuxer supports live rtmp inputs but there is no any info about it in the docs.
[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 aa
22
23 Audible Format 2, 3, and 4 demuxer.
24
25 This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files.
26
27 @section applehttp
28
29 Apple HTTP Live Streaming demuxer.
30
31 This demuxer presents all AVStreams from all variant streams.
32 The id field is set to the bitrate variant index number. By setting
33 the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay),
34 the caller can decide which variant streams to actually receive.
35 The total bitrate of the variant that the stream belongs to is
36 available in a metadata key named "variant_bitrate".
37
38 @section apng
39
40 Animated Portable Network Graphics demuxer.
41
42 This demuxer is used to demux APNG files.
43 All headers, but the PNG signature, up to (but not including) the first
44 fcTL chunk are transmitted as extradata.
45 Frames are then split as being all the chunks between two fcTL ones, or
46 between the last fcTL and IEND chunks.
47
48 @table @option
49 @item -ignore_loop @var{bool}
50 Ignore the loop variable in the file if set.
51 @item -max_fps @var{int}
52 Maximum framerate in frames per second (0 for no limit).
53 @item -default_fps @var{int}
54 Default framerate in frames per second when none is specified in the file
55 (0 meaning as fast as possible).
56 @end table
57
58 @section asf
59
60 Advanced Systems Format demuxer.
61
62 This demuxer is used to demux ASF files and MMS network streams.
63
64 @table @option
65 @item -no_resync_search @var{bool}
66 Do not try to resynchronize by looking for a certain optional start code.
67 @end table
68
69 @anchor{concat}
70 @section concat
71
72 Virtual concatenation script demuxer.
73
74 This demuxer reads a list of files and other directives from a text file and
75 demuxes them one after the other, as if all their packets had been muxed
76 together.
77
78 The timestamps in the files are adjusted so that the first file starts at 0
79 and each next file starts where the previous one finishes. Note that it is
80 done globally and may cause gaps if all streams do not have exactly the same
81 length.
82
83 All files must have the same streams (same codecs, same time base, etc.).
84
85 The duration of each file is used to adjust the timestamps of the next file:
86 if the duration is incorrect (because it was computed using the bit-rate or
87 because the file is truncated, for example), it can cause artifacts. The
88 @code{duration} directive can be used to override the duration stored in
89 each file.
90
91 @subsection Syntax
92
93 The script is a text file in extended-ASCII, with one directive per line.
94 Empty lines, leading spaces and lines starting with '#' are ignored. The
95 following directive is recognized:
96
97 @table @option
98
99 @item @code{file @var{path}}
100 Path to a file to read; special characters and spaces must be escaped with
101 backslash or single quotes.
102
103 All subsequent file-related directives apply to that file.
104
105 @item @code{ffconcat version 1.0}
106 Identify the script type and version. It also sets the @option{safe} option
107 to 1 if it was -1.
108
109 To make FFmpeg recognize the format automatically, this directive must
110 appear exactly as is (no extra space or byte-order-mark) on the very first
111 line of the script.
112
113 @item @code{duration @var{dur}}
114 Duration of the file. This information can be specified from the file;
115 specifying it here may be more efficient or help if the information from the
116 file is not available or accurate.
117
118 If the duration is set for all files, then it is possible to seek in the
119 whole concatenated video.
120
121 @item @code{inpoint @var{timestamp}}
122 In point of the file. When the demuxer opens the file it instantly seeks to the
123 specified timestamp. Seeking is done so that all streams can be presented
124 successfully at In point.
125
126 This directive works best with intra frame codecs, because for non-intra frame
127 ones you will usually get extra packets before the actual In point and the
128 decoded content will most likely contain frames before In point too.
129
130 For each file, packets before the file In point will have timestamps less than
131 the calculated start timestamp of the file (negative in case of the first
132 file), and the duration of the files (if not specified by the @code{duration}
133 directive) will be reduced based on their specified In point.
134
135 Because of potential packets before the specified In point, packet timestamps
136 may overlap between two concatenated files.
137
138 @item @code{outpoint @var{timestamp}}
139 Out point of the file. When the demuxer reaches the specified decoding
140 timestamp in any of the streams, it handles it as an end of file condition and
141 skips the current and all the remaining packets from all streams.
142
143 Out point is exclusive, which means that the demuxer will not output packets
144 with a decoding timestamp greater or equal to Out point.
145
146 This directive works best with intra frame codecs and formats where all streams
147 are tightly interleaved. For non-intra frame codecs you will usually get
148 additional packets with presentation timestamp after Out point therefore the
149 decoded content will most likely contain frames after Out point too. If your
150 streams are not tightly interleaved you may not get all the packets from all
151 streams before Out point and you may only will be able to decode the earliest
152 stream until Out point.
153
154 The duration of the files (if not specified by the @code{duration}
155 directive) will be reduced based on their specified Out point.
156
157 @item @code{file_packet_metadata @var{key=value}}
158 Metadata of the packets of the file. The specified metadata will be set for
159 each file packet. You can specify this directive multiple times to add multiple
160 metadata entries.
161
162 @item @code{stream}
163 Introduce a stream in the virtual file.
164 All subsequent stream-related directives apply to the last introduced
165 stream.
166 Some streams properties must be set in order to allow identifying the
167 matching streams in the subfiles.
168 If no streams are defined in the script, the streams from the first file are
169 copied.
170
171 @item @code{exact_stream_id @var{id}}
172 Set the id of the stream.
173 If this directive is given, the string with the corresponding id in the
174 subfiles will be used.
175 This is especially useful for MPEG-PS (VOB) files, where the order of the
176 streams is not reliable.
177
178 @end table
179
180 @subsection Options
181
182 This demuxer accepts the following option:
183
184 @table @option
185
186 @item safe
187 If set to 1, reject unsafe file paths. A file path is considered safe if it
188 does not contain a protocol specification and is relative and all components
189 only contain characters from the portable character set (letters, digits,
190 period, underscore and hyphen) and have no period at the beginning of a
191 component.
192
193 If set to 0, any file name is accepted.
194
195 The default is 1.
196
197 -1 is equivalent to 1 if the format was automatically
198 probed and 0 otherwise.
199
200 @item auto_convert
201 If set to 1, try to perform automatic conversions on packet data to make the
202 streams concatenable.
203 The default is 1.
204
205 Currently, the only conversion is adding the h264_mp4toannexb bitstream
206 filter to H.264 streams in MP4 format. This is necessary in particular if
207 there are resolution changes.
208
209 @item segment_time_metadata
210 If set to 1, every packet will contain the @var{lavf.concat.start_time} and the
211 @var{lavf.concat.duration} packet metadata values which are the start_time and
212 the duration of the respective file segments in the concatenated output
213 expressed in microseconds. The duration metadata is only set if it is known
214 based on the concat file.
215 The default is 0.
216
217 @end table
218
219 @subsection Examples
220
221 @itemize
222 @item
223 Use absolute filenames and include some comments:
224 @example
225 # my first filename
226 file /mnt/share/file-1.wav
227 # my second filename including whitespace
228 file '/mnt/share/file 2.wav'
229 # my third filename including whitespace plus single quote
230 file '/mnt/share/file 3'\''.wav'
231 @end example
232
233 @item
234 Allow for input format auto-probing, use safe filenames and set the duration of
235 the first file:
236 @example
237 ffconcat version 1.0
238
239 file file-1.wav
240 duration 20.0
241
242 file subdir/file-2.wav
243 @end example
244 @end itemize
245
246 @section flv, live_flv
247
248 Adobe Flash Video Format demuxer.
249
250 This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities.
251
252 @example
253 ffmpeg -f flv -i myfile.flv ...
254 ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
255 @end example
256
257
258 @table @option
259 @item -flv_metadata @var{bool}
260 Allocate the streams according to the onMetaData array content.
261 @end table
262
263 @section gif
264
265 Animated GIF demuxer.
266
267 It accepts the following options:
268
269 @table @option
270 @item min_delay
271 Set the minimum valid delay between frames in hundredths of seconds.
272 Range is 0 to 6000. Default value is 2.
273
274 @item max_gif_delay
275 Set the maximum valid delay between frames in hundredth of seconds.
276 Range is 0 to 65535. Default value is 65535 (nearly eleven minutes),
277 the maximum value allowed by the specification.
278
279 @item default_delay
280 Set the default delay between frames in hundredths of seconds.
281 Range is 0 to 6000. Default value is 10.
282
283 @item ignore_loop
284 GIF files can contain information to loop a certain number of times (or
285 infinitely). If @option{ignore_loop} is set to 1, then the loop setting
286 from the input will be ignored and looping will not occur. If set to 0,
287 then looping will occur and will cycle the number of times according to
288 the GIF. Default value is 1.
289 @end table
290
291 For example, with the overlay filter, place an infinitely looping GIF
292 over another video:
293 @example
294 ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
295 @end example
296
297 Note that in the above example the shortest option for overlay filter is
298 used to end the output video at the length of the shortest input file,
299 which in this case is @file{input.mp4} as the GIF in this example loops
300 infinitely.
301
302 @section image2
303
304 Image file demuxer.
305
306 This demuxer reads from a list of image files specified by a pattern.
307 The syntax and meaning of the pattern is specified by the
308 option @var{pattern_type}.
309
310 The pattern may contain a suffix which is used to automatically
311 determine the format of the images contained in the files.
312
313 The size, the pixel format, and the format of each image must be the
314 same for all the files in the sequence.
315
316 This demuxer accepts the following options:
317 @table @option
318 @item framerate
319 Set the frame rate for the video stream. It defaults to 25.
320 @item loop
321 If set to 1, loop over the input. Default value is 0.
322 @item pattern_type
323 Select the pattern type used to interpret the provided filename.
324
325 @var{pattern_type} accepts one of the following values.
326 @table @option
327 @item none
328 Disable pattern matching, therefore the video will only contain the specified
329 image. You should use this option if you do not want to create sequences from
330 multiple images and your filenames may contain special pattern characters.
331 @item sequence
332 Select a sequence pattern type, used to specify a sequence of files
333 indexed by sequential numbers.
334
335 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
336 specifies the position of the characters representing a sequential
337 number in each filename matched by the pattern. If the form
338 "%d0@var{N}d" is used, the string representing the number in each
339 filename is 0-padded and @var{N} is the total number of 0-padded
340 digits representing the number. The literal character '%' can be
341 specified in the pattern with the string "%%".
342
343 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
344 the file list specified by the pattern must contain a number
345 inclusively contained between @var{start_number} and
346 @var{start_number}+@var{start_number_range}-1, and all the following
347 numbers must be sequential.
348
349 For example the pattern "img-%03d.bmp" will match a sequence of
350 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
351 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
352 sequence of filenames of the form @file{i%m%g-1.jpg},
353 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
354
355 Note that the pattern must not necessarily contain "%d" or
356 "%0@var{N}d", for example to convert a single image file
357 @file{img.jpeg} you can employ the command:
358 @example
359 ffmpeg -i img.jpeg img.png
360 @end example
361
362 @item glob
363 Select a glob wildcard pattern type.
364
365 The pattern is interpreted like a @code{glob()} pattern. This is only
366 selectable if libavformat was compiled with globbing support.
367
368 @item glob_sequence @emph{(deprecated, will be removed)}
369 Select a mixed glob wildcard/sequence pattern.
370
371 If your version of libavformat was compiled with globbing support, and
372 the provided pattern contains at least one glob meta character among
373 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
374 interpreted like a @code{glob()} pattern, otherwise it is interpreted
375 like a sequence pattern.
376
377 All glob special characters @code{%*?[]@{@}} must be prefixed
378 with "%". To escape a literal "%" you shall use "%%".
379
380 For example the pattern @code{foo-%*.jpeg} will match all the
381 filenames prefixed by "foo-" and terminating with ".jpeg", and
382 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
383 "foo-", followed by a sequence of three characters, and terminating
384 with ".jpeg".
385
386 This pattern type is deprecated in favor of @var{glob} and
387 @var{sequence}.
388 @end table
389
390 Default value is @var{glob_sequence}.
391 @item pixel_format
392 Set the pixel format of the images to read. If not specified the pixel
393 format is guessed from the first image file in the sequence.
394 @item start_number
395 Set the index of the file matched by the image file pattern to start
396 to read from. Default value is 0.
397 @item start_number_range
398 Set the index interval range to check when looking for the first image
399 file in the sequence, starting from @var{start_number}. Default value
400 is 5.
401 @item ts_from_file
402 If set to 1, will set frame timestamp to modification time of image file. Note
403 that monotonity of timestamps is not provided: images go in the same order as
404 without this option. Default value is 0.
405 If set to 2, will set frame timestamp to the modification time of the image file in
406 nanosecond precision.
407 @item video_size
408 Set the video size of the images to read. If not specified the video
409 size is guessed from the first image file in the sequence.
410 @end table
411
412 @subsection Examples
413
414 @itemize
415 @item
416 Use @command{ffmpeg} for creating a video from the images in the file
417 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
418 input frame rate of 10 frames per second:
419 @example
420 ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
421 @end example
422
423 @item
424 As above, but start by reading from a file with index 100 in the sequence:
425 @example
426 ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
427 @end example
428
429 @item
430 Read images matching the "*.png" glob pattern , that is all the files
431 terminating with the ".png" suffix:
432 @example
433 ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
434 @end example
435 @end itemize
436
437 @section libgme
438
439 The Game Music Emu library is a collection of video game music file emulators.
440
441 See @url{http://code.google.com/p/game-music-emu/} for more information.
442
443 Some files have multiple tracks. The demuxer will pick the first track by
444 default. The @option{track_index} option can be used to select a different
445 track. Track indexes start at 0. The demuxer exports the number of tracks as
446 @var{tracks} meta data entry.
447
448 For very large files, the @option{max_size} option may have to be adjusted.
449
450 @section libopenmpt
451
452 libopenmpt based module demuxer
453
454 See @url{https://lib.openmpt.org/libopenmpt/} for more information.
455
456 Some files have multiple subsongs (tracks) this can be set with the @option{subsong}
457 option.
458
459 It accepts the following options:
460
461 @table @option
462 @item subsong
463 Set the subsong index. This can be either  'all', 'auto', or the index of the
464 subsong. Subsong indexes start at 0. The default is 'auto'.
465
466 The default value is to let libopenmpt choose.
467
468 @item layout
469 Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
470 The default value is STEREO.
471
472 @item sample_rate
473 Set the sample rate for libopenmpt to output.
474 Range is from 1000 to INT_MAX. The value default is 48000.
475 @end table
476
477 @section mov/mp4/3gp/QuickTime
478
479 QuickTime / MP4 demuxer.
480
481 This demuxer accepts the following options:
482 @table @option
483 @item enable_drefs
484 Enable loading of external tracks, disabled by default.
485 Enabling this can theoretically leak information in some use cases.
486
487 @item use_absolute_path
488 Allows loading of external tracks via absolute paths, disabled by default.
489 Enabling this poses a security risk. It should only be enabled if the source
490 is known to be non malicious.
491
492 @end table
493
494 @section mpegts
495
496 MPEG-2 transport stream demuxer.
497
498 This demuxer accepts the following options:
499 @table @option
500 @item resync_size
501 Set size limit for looking up a new synchronization. Default value is
502 65536.
503
504 @item fix_teletext_pts
505 Override teletext packet PTS and DTS values with the timestamps calculated
506 from the PCR of the first program which the teletext stream is part of and is
507 not discarded. Default value is 1, set this option to 0 if you want your
508 teletext packet PTS and DTS values untouched.
509
510 @item ts_packetsize
511 Output option carrying the raw packet size in bytes.
512 Show the detected raw packet size, cannot be set by the user.
513
514 @item scan_all_pmts
515 Scan and combine all PMTs. The value is an integer with value from -1
516 to 1 (-1 means automatic setting, 1 means enabled, 0 means
517 disabled). Default value is -1.
518 @end table
519
520 @section mpjpeg
521
522 MJPEG encapsulated in multi-part MIME demuxer.
523
524 This demuxer allows reading of MJPEG, where each frame is represented as a part of
525 multipart/x-mixed-replace stream.
526 @table @option
527
528 @item strict_mime_boundary
529 Default implementation applies a relaxed standard to multi-part MIME boundary detection,
530 to prevent regression with numerous existing endpoints not generating a proper MIME
531 MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check
532 of the boundary value.
533 @end table
534
535 @section rawvideo
536
537 Raw video demuxer.
538
539 This demuxer allows one to read raw video data. Since there is no header
540 specifying the assumed video parameters, the user must specify them
541 in order to be able to decode the data correctly.
542
543 This demuxer accepts the following options:
544 @table @option
545
546 @item framerate
547 Set input video frame rate. Default value is 25.
548
549 @item pixel_format
550 Set the input video pixel format. Default value is @code{yuv420p}.
551
552 @item video_size
553 Set the input video size. This value must be specified explicitly.
554 @end table
555
556 For example to read a rawvideo file @file{input.raw} with
557 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
558 size of @code{320x240}, and a frame rate of 10 images per second, use
559 the command:
560 @example
561 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
562 @end example
563
564 @section sbg
565
566 SBaGen script demuxer.
567
568 This demuxer reads the script language used by SBaGen
569 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
570 script looks like that:
571 @example
572 -SE
573 a: 300-2.5/3 440+4.5/0
574 b: 300-2.5/0 440+4.5/3
575 off: -
576 NOW      == a
577 +0:07:00 == b
578 +0:14:00 == a
579 +0:21:00 == b
580 +0:30:00    off
581 @end example
582
583 A SBG script can mix absolute and relative timestamps. If the script uses
584 either only absolute timestamps (including the script start time) or only
585 relative ones, then its layout is fixed, and the conversion is
586 straightforward. On the other hand, if the script mixes both kind of
587 timestamps, then the @var{NOW} reference for relative timestamps will be
588 taken from the current time of day at the time the script is read, and the
589 script layout will be frozen according to that reference. That means that if
590 the script is directly played, the actual times will match the absolute
591 timestamps up to the sound controller's clock accuracy, but if the user
592 somehow pauses the playback or seeks, all times will be shifted accordingly.
593
594 @section tedcaptions
595
596 JSON captions used for @url{http://www.ted.com/, TED Talks}.
597
598 TED does not provide links to the captions, but they can be guessed from the
599 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
600 contains a bookmarklet to expose them.
601
602 This demuxer accepts the following option:
603 @table @option
604 @item start_time
605 Set the start time of the TED talk, in milliseconds. The default is 15000
606 (15s). It is used to sync the captions with the downloadable videos, because
607 they include a 15s intro.
608 @end table
609
610 Example: convert the captions to a format most players understand:
611 @example
612 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
613 @end example
614
615 @c man end DEMUXERS