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