docs/demuxers: add libopenmpt section
[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 packet 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 appears 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
247
248 Adobe Flash Video Format demuxer.
249
250 This demuxer is used to demux FLV files and RTMP network streams.
251
252 @table @option
253 @item -flv_metadata @var{bool}
254 Allocate the streams according to the onMetaData array content.
255 @end table
256
257 @section libgme
258
259 The Game Music Emu library is a collection of video game music file emulators.
260
261 See @url{http://code.google.com/p/game-music-emu/} for more information.
262
263 Some files have multiple tracks. The demuxer will pick the first track by
264 default. The @option{track_index} option can be used to select a different
265 track. Track indexes start at 0. The demuxer exports the number of tracks as
266 @var{tracks} meta data entry.
267
268 For very large files, the @option{max_size} option may have to be adjusted.
269
270 @section libopenmpt
271
272 libopenmpt based module demuxer
273
274 See @url{https://lib.openmpt.org/libopenmpt/} for more information.
275
276 Some files have multiple subsongs (tracks) this can be set with the @option{subsong}
277 option.
278
279 It accepts the following options:
280
281 @table @option
282 @item subsong
283 Set the subsong index. This can be either  'all', 'auto', or the index of the
284 subsong. Subsong indexes start at 0. The default is 'auto'.
285
286 The default value is to let libopenmpt choose.
287
288 @item layout
289 Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
290 The default value is STEREO.
291
292 @item sample_rate
293 Set the sample rate for libopenmpt to output.
294 Range is from 1000 to INT_MAX. The value default is 48000.
295 @end table
296
297 @section gif
298
299 Animated GIF demuxer.
300
301 It accepts the following options:
302
303 @table @option
304 @item min_delay
305 Set the minimum valid delay between frames in hundredths of seconds.
306 Range is 0 to 6000. Default value is 2.
307
308 @item max_gif_delay
309 Set the maximum valid delay between frames in hundredth of seconds.
310 Range is 0 to 65535. Default value is 65535 (nearly eleven minutes),
311 the maximum value allowed by the specification.
312
313 @item default_delay
314 Set the default delay between frames in hundredths of seconds.
315 Range is 0 to 6000. Default value is 10.
316
317 @item ignore_loop
318 GIF files can contain information to loop a certain number of times (or
319 infinitely). If @option{ignore_loop} is set to 1, then the loop setting
320 from the input will be ignored and looping will not occur. If set to 0,
321 then looping will occur and will cycle the number of times according to
322 the GIF. Default value is 1.
323 @end table
324
325 For example, with the overlay filter, place an infinitely looping GIF
326 over another video:
327 @example
328 ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
329 @end example
330
331 Note that in the above example the shortest option for overlay filter is
332 used to end the output video at the length of the shortest input file,
333 which in this case is @file{input.mp4} as the GIF in this example loops
334 infinitely.
335
336 @section image2
337
338 Image file demuxer.
339
340 This demuxer reads from a list of image files specified by a pattern.
341 The syntax and meaning of the pattern is specified by the
342 option @var{pattern_type}.
343
344 The pattern may contain a suffix which is used to automatically
345 determine the format of the images contained in the files.
346
347 The size, the pixel format, and the format of each image must be the
348 same for all the files in the sequence.
349
350 This demuxer accepts the following options:
351 @table @option
352 @item framerate
353 Set the frame rate for the video stream. It defaults to 25.
354 @item loop
355 If set to 1, loop over the input. Default value is 0.
356 @item pattern_type
357 Select the pattern type used to interpret the provided filename.
358
359 @var{pattern_type} accepts one of the following values.
360 @table @option
361 @item none
362 Disable pattern matching, therefore the video will only contain the specified
363 image. You should use this option if you do not want to create sequences from
364 multiple images and your filenames may contain special pattern characters.
365 @item sequence
366 Select a sequence pattern type, used to specify a sequence of files
367 indexed by sequential numbers.
368
369 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
370 specifies the position of the characters representing a sequential
371 number in each filename matched by the pattern. If the form
372 "%d0@var{N}d" is used, the string representing the number in each
373 filename is 0-padded and @var{N} is the total number of 0-padded
374 digits representing the number. The literal character '%' can be
375 specified in the pattern with the string "%%".
376
377 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
378 the file list specified by the pattern must contain a number
379 inclusively contained between @var{start_number} and
380 @var{start_number}+@var{start_number_range}-1, and all the following
381 numbers must be sequential.
382
383 For example the pattern "img-%03d.bmp" will match a sequence of
384 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
385 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
386 sequence of filenames of the form @file{i%m%g-1.jpg},
387 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
388
389 Note that the pattern must not necessarily contain "%d" or
390 "%0@var{N}d", for example to convert a single image file
391 @file{img.jpeg} you can employ the command:
392 @example
393 ffmpeg -i img.jpeg img.png
394 @end example
395
396 @item glob
397 Select a glob wildcard pattern type.
398
399 The pattern is interpreted like a @code{glob()} pattern. This is only
400 selectable if libavformat was compiled with globbing support.
401
402 @item glob_sequence @emph{(deprecated, will be removed)}
403 Select a mixed glob wildcard/sequence pattern.
404
405 If your version of libavformat was compiled with globbing support, and
406 the provided pattern contains at least one glob meta character among
407 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
408 interpreted like a @code{glob()} pattern, otherwise it is interpreted
409 like a sequence pattern.
410
411 All glob special characters @code{%*?[]@{@}} must be prefixed
412 with "%". To escape a literal "%" you shall use "%%".
413
414 For example the pattern @code{foo-%*.jpeg} will match all the
415 filenames prefixed by "foo-" and terminating with ".jpeg", and
416 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
417 "foo-", followed by a sequence of three characters, and terminating
418 with ".jpeg".
419
420 This pattern type is deprecated in favor of @var{glob} and
421 @var{sequence}.
422 @end table
423
424 Default value is @var{glob_sequence}.
425 @item pixel_format
426 Set the pixel format of the images to read. If not specified the pixel
427 format is guessed from the first image file in the sequence.
428 @item start_number
429 Set the index of the file matched by the image file pattern to start
430 to read from. Default value is 0.
431 @item start_number_range
432 Set the index interval range to check when looking for the first image
433 file in the sequence, starting from @var{start_number}. Default value
434 is 5.
435 @item ts_from_file
436 If set to 1, will set frame timestamp to modification time of image file. Note
437 that monotonity of timestamps is not provided: images go in the same order as
438 without this option. Default value is 0.
439 If set to 2, will set frame timestamp to the modification time of the image file in
440 nanosecond precision.
441 @item video_size
442 Set the video size of the images to read. If not specified the video
443 size is guessed from the first image file in the sequence.
444 @end table
445
446 @subsection Examples
447
448 @itemize
449 @item
450 Use @command{ffmpeg} for creating a video from the images in the file
451 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
452 input frame rate of 10 frames per second:
453 @example
454 ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
455 @end example
456
457 @item
458 As above, but start by reading from a file with index 100 in the sequence:
459 @example
460 ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
461 @end example
462
463 @item
464 Read images matching the "*.png" glob pattern , that is all the files
465 terminating with the ".png" suffix:
466 @example
467 ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
468 @end example
469 @end itemize
470
471 @section mov/mp4/3gp/QuickTime
472
473 QuickTime / MP4 demuxer.
474
475 This demuxer accepts the following options:
476 @table @option
477 @item enable_drefs
478 Enable loading of external tracks, disabled by default.
479 Enabling this can theoretically leak information in some use cases.
480
481 @item use_absolute_path
482 Allows loading of external tracks via absolute paths, disabled by default.
483 Enabling this poses a security risk. It should only be enabled if the source
484 is known to be non malicious.
485
486 @end table
487
488 @section mpegts
489
490 MPEG-2 transport stream demuxer.
491
492 This demuxer accepts the following options:
493 @table @option
494 @item resync_size
495 Set size limit for looking up a new synchronization. Default value is
496 65536.
497
498 @item fix_teletext_pts
499 Override teletext packet PTS and DTS values with the timestamps calculated
500 from the PCR of the first program which the teletext stream is part of and is
501 not discarded. Default value is 1, set this option to 0 if you want your
502 teletext packet PTS and DTS values untouched.
503
504 @item ts_packetsize
505 Output option carrying the raw packet size in bytes.
506 Show the detected raw packet size, cannot be set by the user.
507
508 @item scan_all_pmts
509 Scan and combine all PMTs. The value is an integer with value from -1
510 to 1 (-1 means automatic setting, 1 means enabled, 0 means
511 disabled). Default value is -1.
512 @end table
513
514 @section mpjpeg
515
516 MJPEG encapsulated in multi-part MIME demuxer.
517
518 This demuxer allows reading of MJPEG, where each frame is represented as a part of
519 multipart/x-mixed-replace stream.
520 @table @option
521
522 @item strict_mime_boundary
523 Default implementation applies a relaxed standard to multi-part MIME boundary detection,
524 to prevent regression with numerous existing endpoints not generating a proper MIME
525 MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check
526 of the boundary value.
527 @end table
528
529 @section rawvideo
530
531 Raw video demuxer.
532
533 This demuxer allows one to read raw video data. Since there is no header
534 specifying the assumed video parameters, the user must specify them
535 in order to be able to decode the data correctly.
536
537 This demuxer accepts the following options:
538 @table @option
539
540 @item framerate
541 Set input video frame rate. Default value is 25.
542
543 @item pixel_format
544 Set the input video pixel format. Default value is @code{yuv420p}.
545
546 @item video_size
547 Set the input video size. This value must be specified explicitly.
548 @end table
549
550 For example to read a rawvideo file @file{input.raw} with
551 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
552 size of @code{320x240}, and a frame rate of 10 images per second, use
553 the command:
554 @example
555 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
556 @end example
557
558 @section sbg
559
560 SBaGen script demuxer.
561
562 This demuxer reads the script language used by SBaGen
563 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
564 script looks like that:
565 @example
566 -SE
567 a: 300-2.5/3 440+4.5/0
568 b: 300-2.5/0 440+4.5/3
569 off: -
570 NOW      == a
571 +0:07:00 == b
572 +0:14:00 == a
573 +0:21:00 == b
574 +0:30:00    off
575 @end example
576
577 A SBG script can mix absolute and relative timestamps. If the script uses
578 either only absolute timestamps (including the script start time) or only
579 relative ones, then its layout is fixed, and the conversion is
580 straightforward. On the other hand, if the script mixes both kind of
581 timestamps, then the @var{NOW} reference for relative timestamps will be
582 taken from the current time of day at the time the script is read, and the
583 script layout will be frozen according to that reference. That means that if
584 the script is directly played, the actual times will match the absolute
585 timestamps up to the sound controller's clock accuracy, but if the user
586 somehow pauses the playback or seeks, all times will be shifted accordingly.
587
588 @section tedcaptions
589
590 JSON captions used for @url{http://www.ted.com/, TED Talks}.
591
592 TED does not provide links to the captions, but they can be guessed from the
593 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
594 contains a bookmarklet to expose them.
595
596 This demuxer accepts the following option:
597 @table @option
598 @item start_time
599 Set the start time of the TED talk, in milliseconds. The default is 15000
600 (15s). It is used to sync the captions with the downloadable videos, because
601 they include a 15s intro.
602 @end table
603
604 Example: convert the captions to a format most players understand:
605 @example
606 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
607 @end example
608
609 @c man end DEMUXERS