Imported Upstream version 5.1.2
[platform/upstream/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{-demuxers} of the ff* tools will display the list of
17 enabled demuxers. Use @code{-formats} to view a combined list of
18 enabled demuxers and muxers.
19
20 The description of some of the currently available demuxers follows.
21
22 @section aa
23
24 Audible Format 2, 3, and 4 demuxer.
25
26 This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files.
27
28 @section aac
29
30 Raw Audio Data Transport Stream AAC demuxer.
31
32 This demuxer is used to demux an ADTS input containing a single AAC stream
33 alongwith any ID3v1/2 or APE tags in it.
34
35 @section apng
36
37 Animated Portable Network Graphics demuxer.
38
39 This demuxer is used to demux APNG files.
40 All headers, but the PNG signature, up to (but not including) the first
41 fcTL chunk are transmitted as extradata.
42 Frames are then split as being all the chunks between two fcTL ones, or
43 between the last fcTL and IEND chunks.
44
45 @table @option
46 @item -ignore_loop @var{bool}
47 Ignore the loop variable in the file if set. Default is enabled.
48
49 @item -max_fps @var{int}
50 Maximum framerate in frames per second. Default of 0 imposes no limit.
51
52 @item -default_fps @var{int}
53 Default framerate in frames per second when none is specified in the file
54 (0 meaning as fast as possible). Default is 15.
55
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.
107
108 To make FFmpeg recognize the format automatically, this directive must
109 appear exactly as is (no extra space or byte-order-mark) on the very first
110 line of the script.
111
112 @item @code{duration @var{dur}}
113 Duration of the file. This information can be specified from the file;
114 specifying it here may be more efficient or help if the information from the
115 file is not available or accurate.
116
117 If the duration is set for all files, then it is possible to seek in the
118 whole concatenated video.
119
120 @item @code{inpoint @var{timestamp}}
121 In point of the file. When the demuxer opens the file it instantly seeks to the
122 specified timestamp. Seeking is done so that all streams can be presented
123 successfully at In point.
124
125 This directive works best with intra frame codecs, because for non-intra frame
126 ones you will usually get extra packets before the actual In point and the
127 decoded content will most likely contain frames before In point too.
128
129 For each file, packets before the file In point will have timestamps less than
130 the calculated start timestamp of the file (negative in case of the first
131 file), and the duration of the files (if not specified by the @code{duration}
132 directive) will be reduced based on their specified In point.
133
134 Because of potential packets before the specified In point, packet timestamps
135 may overlap between two concatenated files.
136
137 @item @code{outpoint @var{timestamp}}
138 Out point of the file. When the demuxer reaches the specified decoding
139 timestamp in any of the streams, it handles it as an end of file condition and
140 skips the current and all the remaining packets from all streams.
141
142 Out point is exclusive, which means that the demuxer will not output packets
143 with a decoding timestamp greater or equal to Out point.
144
145 This directive works best with intra frame codecs and formats where all streams
146 are tightly interleaved. For non-intra frame codecs you will usually get
147 additional packets with presentation timestamp after Out point therefore the
148 decoded content will most likely contain frames after Out point too. If your
149 streams are not tightly interleaved you may not get all the packets from all
150 streams before Out point and you may only will be able to decode the earliest
151 stream until Out point.
152
153 The duration of the files (if not specified by the @code{duration}
154 directive) will be reduced based on their specified Out point.
155
156 @item @code{file_packet_metadata @var{key=value}}
157 Metadata of the packets of the file. The specified metadata will be set for
158 each file packet. You can specify this directive multiple times to add multiple
159 metadata entries.
160 This directive is deprecated, use @code{file_packet_meta} instead.
161
162 @item @code{file_packet_meta @var{key} @var{value}}
163 Metadata of the packets of the file. The specified metadata will be set for
164 each file packet. You can specify this directive multiple times to add multiple
165 metadata entries.
166
167 @item @code{option @var{key} @var{value}}
168 Option to access, open and probe the file.
169 Can be present multiple times.
170
171 @item @code{stream}
172 Introduce a stream in the virtual file.
173 All subsequent stream-related directives apply to the last introduced
174 stream.
175 Some streams properties must be set in order to allow identifying the
176 matching streams in the subfiles.
177 If no streams are defined in the script, the streams from the first file are
178 copied.
179
180 @item @code{exact_stream_id @var{id}}
181 Set the id of the stream.
182 If this directive is given, the string with the corresponding id in the
183 subfiles will be used.
184 This is especially useful for MPEG-PS (VOB) files, where the order of the
185 streams is not reliable.
186
187 @item @code{stream_meta @var{key} @var{value}}
188 Metadata for the stream.
189 Can be present multiple times.
190
191 @item @code{stream_codec @var{value}}
192 Codec for the stream.
193
194 @item @code{stream_extradata @var{hex_string}}
195 Extradata for the string, encoded in hexadecimal.
196
197 @item @code{chapter @var{id} @var{start} @var{end}}
198 Add a chapter. @var{id} is an unique identifier, possibly small and
199 consecutive.
200
201 @end table
202
203 @subsection Options
204
205 This demuxer accepts the following option:
206
207 @table @option
208
209 @item safe
210 If set to 1, reject unsafe file paths and directives.
211 A file path is considered safe if it
212 does not contain a protocol specification and is relative and all components
213 only contain characters from the portable character set (letters, digits,
214 period, underscore and hyphen) and have no period at the beginning of a
215 component.
216
217 If set to 0, any file name is accepted.
218
219 The default is 1.
220
221 @item auto_convert
222 If set to 1, try to perform automatic conversions on packet data to make the
223 streams concatenable.
224 The default is 1.
225
226 Currently, the only conversion is adding the h264_mp4toannexb bitstream
227 filter to H.264 streams in MP4 format. This is necessary in particular if
228 there are resolution changes.
229
230 @item segment_time_metadata
231 If set to 1, every packet will contain the @var{lavf.concat.start_time} and the
232 @var{lavf.concat.duration} packet metadata values which are the start_time and
233 the duration of the respective file segments in the concatenated output
234 expressed in microseconds. The duration metadata is only set if it is known
235 based on the concat file.
236 The default is 0.
237
238 @end table
239
240 @subsection Examples
241
242 @itemize
243 @item
244 Use absolute filenames and include some comments:
245 @example
246 # my first filename
247 file /mnt/share/file-1.wav
248 # my second filename including whitespace
249 file '/mnt/share/file 2.wav'
250 # my third filename including whitespace plus single quote
251 file '/mnt/share/file 3'\''.wav'
252 @end example
253
254 @item
255 Allow for input format auto-probing, use safe filenames and set the duration of
256 the first file:
257 @example
258 ffconcat version 1.0
259
260 file file-1.wav
261 duration 20.0
262
263 file subdir/file-2.wav
264 @end example
265 @end itemize
266
267 @section dash
268
269 Dynamic Adaptive Streaming over HTTP demuxer.
270
271 This demuxer presents all AVStreams found in the manifest.
272 By setting the discard flags on AVStreams the caller can decide
273 which streams to actually receive.
274 Each stream mirrors the @code{id} and @code{bandwidth} properties from the
275 @code{<Representation>} as metadata keys named "id" and "variant_bitrate" respectively.
276
277 @subsection Options
278
279 This demuxer accepts the following option:
280
281 @table @option
282
283 @item cenc_decryption_key
284 16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7).
285
286 @end table
287
288 @section imf
289
290 Interoperable Master Format demuxer.
291
292 This demuxer presents audio and video streams found in an IMF Composition.
293
294 @section flv, live_flv, kux
295
296 Adobe Flash Video Format demuxer.
297
298 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.
299 KUX is a flv variant used on the Youku platform.
300
301 @example
302 ffmpeg -f flv -i myfile.flv ...
303 ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
304 @end example
305
306
307 @table @option
308 @item -flv_metadata @var{bool}
309 Allocate the streams according to the onMetaData array content.
310
311 @item -flv_ignore_prevtag @var{bool}
312 Ignore the size of previous tag value.
313
314 @item -flv_full_metadata @var{bool}
315 Output all context of the onMetadata.
316 @end table
317
318 @section gif
319
320 Animated GIF demuxer.
321
322 It accepts the following options:
323
324 @table @option
325 @item min_delay
326 Set the minimum valid delay between frames in hundredths of seconds.
327 Range is 0 to 6000. Default value is 2.
328
329 @item max_gif_delay
330 Set the maximum valid delay between frames in hundredth of seconds.
331 Range is 0 to 65535. Default value is 65535 (nearly eleven minutes),
332 the maximum value allowed by the specification.
333
334 @item default_delay
335 Set the default delay between frames in hundredths of seconds.
336 Range is 0 to 6000. Default value is 10.
337
338 @item ignore_loop
339 GIF files can contain information to loop a certain number of times (or
340 infinitely). If @option{ignore_loop} is set to 1, then the loop setting
341 from the input will be ignored and looping will not occur. If set to 0,
342 then looping will occur and will cycle the number of times according to
343 the GIF. Default value is 1.
344 @end table
345
346 For example, with the overlay filter, place an infinitely looping GIF
347 over another video:
348 @example
349 ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
350 @end example
351
352 Note that in the above example the shortest option for overlay filter is
353 used to end the output video at the length of the shortest input file,
354 which in this case is @file{input.mp4} as the GIF in this example loops
355 infinitely.
356
357 @section hls
358
359 HLS demuxer
360
361 Apple HTTP Live Streaming demuxer.
362
363 This demuxer presents all AVStreams from all variant streams.
364 The id field is set to the bitrate variant index number. By setting
365 the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay),
366 the caller can decide which variant streams to actually receive.
367 The total bitrate of the variant that the stream belongs to is
368 available in a metadata key named "variant_bitrate".
369
370 It accepts the following options:
371
372 @table @option
373 @item live_start_index
374 segment index to start live streams at (negative values are from the end).
375
376 @item prefer_x_start
377 prefer to use #EXT-X-START if it's in playlist instead of live_start_index.
378
379 @item allowed_extensions
380 ',' separated list of file extensions that hls is allowed to access.
381
382 @item max_reload
383 Maximum number of times a insufficient list is attempted to be reloaded.
384 Default value is 1000.
385
386 @item m3u8_hold_counters
387 The maximum number of times to load m3u8 when it refreshes without new segments.
388 Default value is 1000.
389
390 @item http_persistent
391 Use persistent HTTP connections. Applicable only for HTTP streams.
392 Enabled by default.
393
394 @item http_multiple
395 Use multiple HTTP connections for downloading HTTP segments.
396 Enabled by default for HTTP/1.1 servers.
397
398 @item http_seekable
399 Use HTTP partial requests for downloading HTTP segments.
400 0 = disable, 1 = enable, -1 = auto, Default is auto.
401
402 @item seg_format_options
403 Set options for the demuxer of media segments using a list of key=value pairs separated by @code{:}.
404 @end table
405
406 @section image2
407
408 Image file demuxer.
409
410 This demuxer reads from a list of image files specified by a pattern.
411 The syntax and meaning of the pattern is specified by the
412 option @var{pattern_type}.
413
414 The pattern may contain a suffix which is used to automatically
415 determine the format of the images contained in the files.
416
417 The size, the pixel format, and the format of each image must be the
418 same for all the files in the sequence.
419
420 This demuxer accepts the following options:
421 @table @option
422 @item framerate
423 Set the frame rate for the video stream. It defaults to 25.
424 @item loop
425 If set to 1, loop over the input. Default value is 0.
426 @item pattern_type
427 Select the pattern type used to interpret the provided filename.
428
429 @var{pattern_type} accepts one of the following values.
430 @table @option
431 @item none
432 Disable pattern matching, therefore the video will only contain the specified
433 image. You should use this option if you do not want to create sequences from
434 multiple images and your filenames may contain special pattern characters.
435 @item sequence
436 Select a sequence pattern type, used to specify a sequence of files
437 indexed by sequential numbers.
438
439 A sequence pattern may contain the string "%d" or "%0@var{N}d", which
440 specifies the position of the characters representing a sequential
441 number in each filename matched by the pattern. If the form
442 "%d0@var{N}d" is used, the string representing the number in each
443 filename is 0-padded and @var{N} is the total number of 0-padded
444 digits representing the number. The literal character '%' can be
445 specified in the pattern with the string "%%".
446
447 If the sequence pattern contains "%d" or "%0@var{N}d", the first filename of
448 the file list specified by the pattern must contain a number
449 inclusively contained between @var{start_number} and
450 @var{start_number}+@var{start_number_range}-1, and all the following
451 numbers must be sequential.
452
453 For example the pattern "img-%03d.bmp" will match a sequence of
454 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
455 @file{img-010.bmp}, etc.; the pattern "i%%m%%g-%d.jpg" will match a
456 sequence of filenames of the form @file{i%m%g-1.jpg},
457 @file{i%m%g-2.jpg}, ..., @file{i%m%g-10.jpg}, etc.
458
459 Note that the pattern must not necessarily contain "%d" or
460 "%0@var{N}d", for example to convert a single image file
461 @file{img.jpeg} you can employ the command:
462 @example
463 ffmpeg -i img.jpeg img.png
464 @end example
465
466 @item glob
467 Select a glob wildcard pattern type.
468
469 The pattern is interpreted like a @code{glob()} pattern. This is only
470 selectable if libavformat was compiled with globbing support.
471
472 @item glob_sequence @emph{(deprecated, will be removed)}
473 Select a mixed glob wildcard/sequence pattern.
474
475 If your version of libavformat was compiled with globbing support, and
476 the provided pattern contains at least one glob meta character among
477 @code{%*?[]@{@}} that is preceded by an unescaped "%", the pattern is
478 interpreted like a @code{glob()} pattern, otherwise it is interpreted
479 like a sequence pattern.
480
481 All glob special characters @code{%*?[]@{@}} must be prefixed
482 with "%". To escape a literal "%" you shall use "%%".
483
484 For example the pattern @code{foo-%*.jpeg} will match all the
485 filenames prefixed by "foo-" and terminating with ".jpeg", and
486 @code{foo-%?%?%?.jpeg} will match all the filenames prefixed with
487 "foo-", followed by a sequence of three characters, and terminating
488 with ".jpeg".
489
490 This pattern type is deprecated in favor of @var{glob} and
491 @var{sequence}.
492 @end table
493
494 Default value is @var{glob_sequence}.
495 @item pixel_format
496 Set the pixel format of the images to read. If not specified the pixel
497 format is guessed from the first image file in the sequence.
498 @item start_number
499 Set the index of the file matched by the image file pattern to start
500 to read from. Default value is 0.
501 @item start_number_range
502 Set the index interval range to check when looking for the first image
503 file in the sequence, starting from @var{start_number}. Default value
504 is 5.
505 @item ts_from_file
506 If set to 1, will set frame timestamp to modification time of image file. Note
507 that monotonity of timestamps is not provided: images go in the same order as
508 without this option. Default value is 0.
509 If set to 2, will set frame timestamp to the modification time of the image file in
510 nanosecond precision.
511 @item video_size
512 Set the video size of the images to read. If not specified the video
513 size is guessed from the first image file in the sequence.
514 @item export_path_metadata
515 If set to 1, will add two extra fields to the metadata found in input, making them
516 also available for other filters (see @var{drawtext} filter for examples). Default
517 value is 0. The extra fields are described below:
518 @table @option
519 @item lavf.image2dec.source_path
520 Corresponds to the full path to the input file being read.
521 @item lavf.image2dec.source_basename
522 Corresponds to the name of the file being read.
523 @end table
524
525 @end table
526
527 @subsection Examples
528
529 @itemize
530 @item
531 Use @command{ffmpeg} for creating a video from the images in the file
532 sequence @file{img-001.jpeg}, @file{img-002.jpeg}, ..., assuming an
533 input frame rate of 10 frames per second:
534 @example
535 ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
536 @end example
537
538 @item
539 As above, but start by reading from a file with index 100 in the sequence:
540 @example
541 ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
542 @end example
543
544 @item
545 Read images matching the "*.png" glob pattern , that is all the files
546 terminating with the ".png" suffix:
547 @example
548 ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
549 @end example
550 @end itemize
551
552 @section libgme
553
554 The Game Music Emu library is a collection of video game music file emulators.
555
556 See @url{https://bitbucket.org/mpyne/game-music-emu/overview} for more information.
557
558 It accepts the following options:
559
560 @table @option
561
562 @item track_index
563 Set the index of which track to demux. The demuxer can only export one track.
564 Track indexes start at 0. Default is to pick the first track. Number of tracks
565 is exported as @var{tracks} metadata entry.
566
567 @item sample_rate
568 Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100.
569
570 @item max_size @emph{(bytes)}
571 The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size,
572 which in turn, acts as a ceiling for the size of files that can be read.
573 Default is 50 MiB.
574
575 @end table
576
577 @section libmodplug
578
579 ModPlug based module demuxer
580
581 See @url{https://github.com/Konstanty/libmodplug}
582
583 It will export one 2-channel 16-bit 44.1 kHz audio stream.
584 Optionally, a @code{pal8} 16-color video stream can be exported with or without printed metadata.
585
586 It accepts the following options:
587
588 @table @option
589 @item noise_reduction
590 Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0.
591
592 @item reverb_depth
593 Set amount of reverb. Range 0-100. Default is 0.
594
595 @item reverb_delay
596 Set delay in ms, clamped to 40-250 ms. Default is 0.
597
598 @item bass_amount
599 Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default is 0.
600
601 @item bass_range
602 Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0.
603
604 @item surround_depth
605 Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0.
606
607 @item surround_delay
608 Set surround delay in ms, clamped to 5-40 ms. Default is 0.
609
610 @item max_size
611 The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size,
612 which in turn, acts as a ceiling for the size of files that can be read. Range is 0 to 100 MiB.
613 0 removes buffer size limit (not recommended). Default is 5 MiB.
614
615 @item video_stream_expr
616 String which is evaluated using the eval API to assign colors to the generated video stream.
617 Variables which can be used are @code{x}, @code{y}, @code{w}, @code{h}, @code{t}, @code{speed},
618 @code{tempo}, @code{order}, @code{pattern} and @code{row}.
619
620 @item video_stream
621 Generate video stream. Can be 1 (on) or 0 (off). Default is 0.
622
623 @item video_stream_w
624 Set video frame width in 'chars' where one char indicates 8 pixels. Range is 20-512. Default is 30.
625
626 @item video_stream_h
627 Set video frame height in 'chars' where one char indicates 8 pixels. Range is 20-512. Default is 30.
628
629 @item video_stream_ptxt
630 Print metadata on video stream. Includes @code{speed}, @code{tempo}, @code{order}, @code{pattern},
631 @code{row} and @code{ts} (time in ms). Can be 1 (on) or 0 (off). Default is 1.
632
633 @end table
634
635 @section libopenmpt
636
637 libopenmpt based module demuxer
638
639 See @url{https://lib.openmpt.org/libopenmpt/} for more information.
640
641 Some files have multiple subsongs (tracks) this can be set with the @option{subsong}
642 option.
643
644 It accepts the following options:
645
646 @table @option
647 @item subsong
648 Set the subsong index. This can be either  'all', 'auto', or the index of the
649 subsong. Subsong indexes start at 0. The default is 'auto'.
650
651 The default value is to let libopenmpt choose.
652
653 @item layout
654 Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
655 The default value is STEREO.
656
657 @item sample_rate
658 Set the sample rate for libopenmpt to output.
659 Range is from 1000 to INT_MAX. The value default is 48000.
660 @end table
661
662 @section mov/mp4/3gp
663
664 Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or MPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12).
665
666 Registered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v
667
668 @subsection Options
669
670 This demuxer accepts the following options:
671 @table @option
672 @item enable_drefs
673 Enable loading of external tracks, disabled by default.
674 Enabling this can theoretically leak information in some use cases.
675
676 @item use_absolute_path
677 Allows loading of external tracks via absolute paths, disabled by default.
678 Enabling this poses a security risk. It should only be enabled if the source
679 is known to be non-malicious.
680
681 @item seek_streams_individually
682 When seeking, identify the closest point in each stream individually and demux packets in
683 that stream from identified point. This can lead to a different sequence of packets compared
684 to demuxing linearly from the beginning. Default is true.
685
686 @item ignore_editlist
687 Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect the
688 timeline described by the edit list. Default is false.
689
690 @item advanced_editlist
691 Modify the stream index to reflect the timeline described by the edit list. @code{ignore_editlist}
692 must be set to false for this option to be effective.
693 If both @code{ignore_editlist} and this option are set to false, then only the
694 start of the stream index is modified to reflect initial dwell time or starting timestamp
695 described by the edit list. Default is true.
696
697 @item ignore_chapters
698 Don't parse chapters. This includes GoPro 'HiLight' tags/moments. Note that chapters are
699 only parsed when input is seekable. Default is false.
700
701 @item use_mfra_for
702 For seekable fragmented input, set fragment's starting timestamp from media fragment random access box, if present.
703
704 Following options are available:
705 @table @samp
706 @item auto
707 Auto-detect whether to set mfra timestamps as PTS or DTS @emph{(default)}
708
709 @item dts
710 Set mfra timestamps as DTS
711
712 @item pts
713 Set mfra timestamps as PTS
714
715 @item 0
716 Don't use mfra box to set timestamps
717 @end table
718
719 @item use_tfdt
720 For fragmented input, set fragment's starting timestamp to @code{baseMediaDecodeTime} from the @code{tfdt} box.
721 Default is enabled, which will prefer to use the @code{tfdt} box to set DTS. Disable to use the @code{earliest_presentation_time} from the @code{sidx} box.
722 In either case, the timestamp from the @code{mfra} box will be used if it's available and @code{use_mfra_for} is
723 set to pts or dts.
724
725 @item export_all
726 Export unrecognized boxes within the @var{udta} box as metadata entries. The first four
727 characters of the box type are set as the key. Default is false.
728
729 @item export_xmp
730 Export entire contents of @var{XMP_} box and @var{uuid} box as a string with key @code{xmp}. Note that
731 if @code{export_all} is set and this option isn't, the contents of @var{XMP_} box are still exported
732 but with key @code{XMP_}. Default is false.
733
734 @item activation_bytes
735 4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection below.
736
737 @item audible_fixed_key
738 Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be necessary to
739 specify.
740
741 @item decryption_key
742 16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7).
743
744 @item max_stts_delta
745 Very high sample deltas written in a trak's stts box may occasionally be intended but usually they are written in
746 error or used to store a negative value for dts correction when treated as signed 32-bit integers. This option lets
747 the user set an upper limit, beyond which the delta is clamped to 1. Values greater than the limit if negative when
748 cast to int32 are used to adjust onward dts.
749
750 Unit is the track time scale. Range is 0 to UINT_MAX. Default is @code{UINT_MAX - 48000*10} which allows upto
751 a 10 second dts correction for 48 kHz audio streams while accommodating 99.9% of @code{uint32} range.
752 @end table
753
754 @subsection Audible AAX
755
756 Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
757 @example
758 ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
759 @end example
760
761 @section mpegts
762
763 MPEG-2 transport stream demuxer.
764
765 This demuxer accepts the following options:
766 @table @option
767 @item resync_size
768 Set size limit for looking up a new synchronization. Default value is
769 65536.
770
771 @item skip_unknown_pmt
772 Skip PMTs for programs not defined in the PAT. Default value is 0.
773
774 @item fix_teletext_pts
775 Override teletext packet PTS and DTS values with the timestamps calculated
776 from the PCR of the first program which the teletext stream is part of and is
777 not discarded. Default value is 1, set this option to 0 if you want your
778 teletext packet PTS and DTS values untouched.
779
780 @item ts_packetsize
781 Output option carrying the raw packet size in bytes.
782 Show the detected raw packet size, cannot be set by the user.
783
784 @item scan_all_pmts
785 Scan and combine all PMTs. The value is an integer with value from -1
786 to 1 (-1 means automatic setting, 1 means enabled, 0 means
787 disabled). Default value is -1.
788
789 @item merge_pmt_versions
790 Re-use existing streams when a PMT's version is updated and elementary
791 streams move to different PIDs. Default value is 0.
792
793 @item max_packet_size
794 Set maximum size, in bytes, of packet emitted by the demuxer. Payloads above this size
795 are split across multiple packets. Range is 1 to INT_MAX/2. Default is 204800 bytes.
796 @end table
797
798 @section mpjpeg
799
800 MJPEG encapsulated in multi-part MIME demuxer.
801
802 This demuxer allows reading of MJPEG, where each frame is represented as a part of
803 multipart/x-mixed-replace stream.
804 @table @option
805
806 @item strict_mime_boundary
807 Default implementation applies a relaxed standard to multi-part MIME boundary detection,
808 to prevent regression with numerous existing endpoints not generating a proper MIME
809 MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check
810 of the boundary value.
811 @end table
812
813 @section rawvideo
814
815 Raw video demuxer.
816
817 This demuxer allows one to read raw video data. Since there is no header
818 specifying the assumed video parameters, the user must specify them
819 in order to be able to decode the data correctly.
820
821 This demuxer accepts the following options:
822 @table @option
823
824 @item framerate
825 Set input video frame rate. Default value is 25.
826
827 @item pixel_format
828 Set the input video pixel format. Default value is @code{yuv420p}.
829
830 @item video_size
831 Set the input video size. This value must be specified explicitly.
832 @end table
833
834 For example to read a rawvideo file @file{input.raw} with
835 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
836 size of @code{320x240}, and a frame rate of 10 images per second, use
837 the command:
838 @example
839 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
840 @end example
841
842 @section sbg
843
844 SBaGen script demuxer.
845
846 This demuxer reads the script language used by SBaGen
847 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
848 script looks like that:
849 @example
850 -SE
851 a: 300-2.5/3 440+4.5/0
852 b: 300-2.5/0 440+4.5/3
853 off: -
854 NOW      == a
855 +0:07:00 == b
856 +0:14:00 == a
857 +0:21:00 == b
858 +0:30:00    off
859 @end example
860
861 A SBG script can mix absolute and relative timestamps. If the script uses
862 either only absolute timestamps (including the script start time) or only
863 relative ones, then its layout is fixed, and the conversion is
864 straightforward. On the other hand, if the script mixes both kind of
865 timestamps, then the @var{NOW} reference for relative timestamps will be
866 taken from the current time of day at the time the script is read, and the
867 script layout will be frozen according to that reference. That means that if
868 the script is directly played, the actual times will match the absolute
869 timestamps up to the sound controller's clock accuracy, but if the user
870 somehow pauses the playback or seeks, all times will be shifted accordingly.
871
872 @section tedcaptions
873
874 JSON captions used for @url{http://www.ted.com/, TED Talks}.
875
876 TED does not provide links to the captions, but they can be guessed from the
877 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
878 contains a bookmarklet to expose them.
879
880 This demuxer accepts the following option:
881 @table @option
882 @item start_time
883 Set the start time of the TED talk, in milliseconds. The default is 15000
884 (15s). It is used to sync the captions with the downloadable videos, because
885 they include a 15s intro.
886 @end table
887
888 Example: convert the captions to a format most players understand:
889 @example
890 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
891 @end example
892
893 @section vapoursynth
894
895 Vapoursynth wrapper.
896
897 Due to security concerns, Vapoursynth scripts will not
898 be autodetected so the input format has to be forced. For ff* CLI tools,
899 add @code{-f vapoursynth} before the input @code{-i yourscript.vpy}.
900
901 This demuxer accepts the following option:
902 @table @option
903 @item max_script_size
904 The demuxer buffers the entire script into memory. Adjust this value to set the maximum buffer size,
905 which in turn, acts as a ceiling for the size of scripts that can be read.
906 Default is 1 MiB.
907 @end table
908
909 @c man end DEMUXERS