4 Muxers are configured elements in FFmpeg which allow writing
5 multimedia streams to a particular type of file.
7 When you configure your FFmpeg build, all the supported muxers
8 are enabled by default. You can list all available muxers using the
9 configure option @code{--list-muxers}.
11 You can disable all the muxers with the configure option
12 @code{--disable-muxers} and selectively enable / disable single muxers
13 with the options @code{--enable-muxer=@var{MUXER}} /
14 @code{--disable-muxer=@var{MUXER}}.
16 The option @code{-muxers} of the ff* tools will display the list of
17 enabled muxers. Use @code{-formats} to view a combined list of
18 enabled demuxers and muxers.
20 A description of some of the currently available muxers follows.
25 Audio Interchange File Format muxer.
29 It accepts the following options:
33 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
36 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
37 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
44 Advanced Systems Format muxer.
46 Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this
51 It accepts the following options:
55 Set the muxer packet size. By tuning this setting you may reduce data
56 fragmentation or muxer overhead depending on your source. Default value is
57 3200, minimum is 100, maximum is 64k.
64 Audio Video Interleaved muxer.
68 It accepts the following options:
71 @item reserve_index_space
72 Reserve the specified amount of bytes for the OpenDML master index of each
73 stream within the file header. By default additional master indexes are
74 embedded within the data packets if there is no space left in the first master
75 index and are linked together as a chain of indexes. This index structure can
76 cause problems for some use cases, e.g. third-party software strictly relying
77 on the OpenDML index specification or when file seeking is slow. Reserving
78 enough index space in the file header avoids these problems.
80 The required index space depends on the output file size and should be about 16
81 bytes per gigabyte. When this option is omitted or set to zero the necessary
82 index space is guessed.
84 @item write_channel_mask
85 Write the channel layout mask into the audio stream header.
87 This option is enabled by default. Disabling the channel mask can be useful in
88 specific scenarios, e.g. when merging multiple audio streams into one for
89 compatibility with software that only supports a single audio stream in AVI
90 (see @ref{amerge,,the "amerge" section in the ffmpeg-filters manual,ffmpeg-filters}).
97 Chromaprint fingerprinter
99 This muxer feeds audio data to the Chromaprint library, which generates
100 a fingerprint for the provided audio data. It takes a single signed
101 native-endian 16-bit raw audio stream.
106 @item silence_threshold
107 Threshold for detecting silence, ranges from 0 to 32767. -1 for default
108 (required for use with the AcoustID service).
111 Algorithm index to fingerprint with.
114 Format to output the fingerprint as. Accepts the following options:
117 Binary raw fingerprint
120 Binary compressed fingerprint
123 Base64 compressed fingerprint
132 CRC (Cyclic Redundancy Check) testing format.
134 This muxer computes and prints the Adler-32 CRC of all the input audio
135 and video frames. By default audio frames are converted to signed
136 16-bit raw audio and video frames to raw video before computing the
139 The output of the muxer consists of a single line of the form:
140 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
141 8 digits containing the CRC for all the decoded input frames.
143 See also the @ref{framecrc} muxer.
147 For example to compute the CRC of the input, and store it in the file
150 ffmpeg -i INPUT -f crc out.crc
153 You can print the CRC to stdout with the command:
155 ffmpeg -i INPUT -f crc -
158 You can select the output format of each frame with @command{ffmpeg} by
159 specifying the audio and video codec and format. For example to
160 compute the CRC of the input audio converted to PCM unsigned 8-bit
161 and the input video converted to MPEG-2 video, use the command:
163 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
168 Adobe Flash Video Format muxer.
170 This muxer accepts the following options:
174 @item flvflags @var{flags}
179 @item aac_seq_header_detect
180 Place AAC sequence header based on audio stream data.
182 @item no_sequence_end
183 Disable sequence end tag.
186 Disable metadata tag.
188 @item no_duration_filesize
189 Disable duration and filesize in metadata when they are equal to zero
190 at the end of stream. (Be used to non-seekable living stream).
192 @item add_keyframe_index
193 Used to facilitate seeking; particularly for HTTP pseudo streaming.
200 Per-packet CRC (Cyclic Redundancy Check) testing format.
202 This muxer computes and prints the Adler-32 CRC for each audio
203 and video packet. By default audio frames are converted to signed
204 16-bit raw audio and video frames to raw video before computing the
207 The output of the muxer consists of a line for each audio and video
210 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
213 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
218 For example to compute the CRC of the audio and video frames in
219 @file{INPUT}, converted to raw audio and video packets, and store it
220 in the file @file{out.crc}:
222 ffmpeg -i INPUT -f framecrc out.crc
225 To print the information to stdout, use the command:
227 ffmpeg -i INPUT -f framecrc -
230 With @command{ffmpeg}, you can select the output format to which the
231 audio and video frames are encoded before computing the CRC for each
232 packet by specifying the audio and video codec. For example, to
233 compute the CRC of each decoded input audio frame converted to PCM
234 unsigned 8-bit and of each decoded input video frame converted to
235 MPEG-2 video, use the command:
237 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
240 See also the @ref{crc} muxer.
245 Per-packet hash testing format.
247 This muxer computes and prints a cryptographic hash for each audio
248 and video packet. This can be used for packet-by-packet equality
249 checks without having to individually do a binary comparison on each.
251 By default audio frames are converted to signed 16-bit raw audio and
252 video frames to raw video before computing the hash, but the output
253 of explicit conversions to other codecs can also be used. It uses the
254 SHA-256 cryptographic hash function by default, but supports several
257 The output of the muxer consists of a line for each audio and video
260 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
263 @var{hash} is a hexadecimal number representing the computed hash
267 @item hash @var{algorithm}
268 Use the cryptographic hash function specified by the string @var{algorithm}.
269 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
270 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
271 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
272 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
278 To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
279 converted to raw audio and video packets, and store it in the file
282 ffmpeg -i INPUT -f framehash out.sha256
285 To print the information to stdout, using the MD5 hash function, use
288 ffmpeg -i INPUT -f framehash -hash md5 -
291 See also the @ref{hash} muxer.
296 Per-packet MD5 testing format.
298 This is a variant of the @ref{framehash} muxer. Unlike that muxer,
299 it defaults to using the MD5 hash function.
303 To compute the MD5 hash of the audio and video frames in @file{INPUT},
304 converted to raw audio and video packets, and store it in the file
307 ffmpeg -i INPUT -f framemd5 out.md5
310 To print the information to stdout, use the command:
312 ffmpeg -i INPUT -f framemd5 -
315 See also the @ref{framehash} and @ref{md5} muxers.
322 It accepts the following options:
326 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
327 for looping indefinitely (default).
330 Force the delay (expressed in centiseconds) after the last frame. Each frame
331 ends with a delay until the next frame. The default is @code{-1}, which is a
332 special value to tell the muxer to re-use the previous delay. In case of a
333 loop, you might want to customize this value to mark a pause for instance.
336 For example, to encode a gif looping 10 times, with a 5 seconds delay between
339 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
342 Note 1: if you wish to extract the frames into separate GIF files, you need to
343 force the @ref{image2} muxer:
345 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
348 Note 2: the GIF format has a very large time base: the delay between two frames
349 can therefore not be smaller than one centi second.
356 This muxer computes and prints a cryptographic hash of all the input
357 audio and video frames. This can be used for equality checks without
358 having to do a complete binary comparison.
360 By default audio frames are converted to signed 16-bit raw audio and
361 video frames to raw video before computing the hash, but the output
362 of explicit conversions to other codecs can also be used. Timestamps
363 are ignored. It uses the SHA-256 cryptographic hash function by default,
364 but supports several other algorithms.
366 The output of the muxer consists of a single line of the form:
367 @var{algo}=@var{hash}, where @var{algo} is a short string representing
368 the hash function used, and @var{hash} is a hexadecimal number
369 representing the computed hash.
372 @item hash @var{algorithm}
373 Use the cryptographic hash function specified by the string @var{algorithm}.
374 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
375 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
376 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
377 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
383 To compute the SHA-256 hash of the input converted to raw audio and
384 video, and store it in the file @file{out.sha256}:
386 ffmpeg -i INPUT -f hash out.sha256
389 To print an MD5 hash to stdout use the command:
391 ffmpeg -i INPUT -f hash -hash md5 -
394 See also the @ref{framehash} muxer.
399 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
400 the HTTP Live Streaming (HLS) specification.
402 It creates a playlist file, and one or more segment files. The output filename
403 specifies the playlist filename.
405 By default, the muxer creates a file for each segment produced. These files
406 have the same name as the playlist, followed by a sequential number and a
409 For example, to convert an input file with @command{ffmpeg}:
411 ffmpeg -i in.nut out.m3u8
413 This example will produce the playlist, @file{out.m3u8}, and segment files:
414 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
416 See also the @ref{segment} muxer, which provides a more generic and
417 flexible implementation of a segmenter, and can be used to perform HLS
422 This muxer supports the following options:
425 @item hls_init_time @var{seconds}
426 Set the initial target segment length in seconds. Default value is @var{0}.
427 Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
428 After the initial playlist is filled @command{ffmpeg} will cut segments
429 at duration equal to @code{hls_time}
431 @item hls_time @var{seconds}
432 Set the target segment length in seconds. Default value is 2.
433 Segment will be cut on the next key frame after this time has passed.
435 @item hls_list_size @var{size}
436 Set the maximum number of playlist entries. If set to 0 the list file
437 will contain all the segments. Default value is 5.
439 @item hls_ts_options @var{options_list}
440 Set output format options using a :-separated list of key=value
441 parameters. Values containing @code{:} special characters must be
444 @item hls_wrap @var{wrap}
445 This is a deprecated option, you can use @code{hls_list_size}
446 and @code{hls_flags delete_segments} instead it
448 This option is useful to avoid to fill the disk with many segment
449 files, and limits the maximum number of segment files written to disk
453 @item hls_start_number_source
454 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) according to the specified source.
455 Unless @code{hls_flags single_file} is set, it also specifies source of starting sequence numbers of
456 segment and subtitle filenames. In any case, if @code{hls_flags append_list}
457 is set and read playlist sequence number is greater than the specified start sequence number,
458 then that value will be used as start value.
460 It accepts the following values:
464 @item generic (default)
465 Set the starting sequence numbers according to @var{start_number} option value.
468 The start number will be the seconds since epoch (1970-01-01 00:00:00)
471 The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759.
475 @item start_number @var{number}
476 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) from the specified @var{number}
477 when @var{hls_start_number_source} value is @var{generic}. (This is the default case.)
478 Unless @code{hls_flags single_file} is set, it also specifies starting sequence numbers of segment and subtitle filenames.
481 @item hls_allow_cache @var{allowcache}
482 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
484 @item hls_base_url @var{baseurl}
485 Append @var{baseurl} to every entry in the playlist.
486 Useful to generate playlists with absolute paths.
488 Note that the playlist sequence number must be unique for each segment
489 and it is not to be confused with the segment filename sequence number
490 which can be cyclic, for example if the @option{wrap} option is
493 @item hls_segment_filename @var{filename}
494 Set the segment filename. Unless @code{hls_flags single_file} is set,
495 @var{filename} is used as a string format with the segment number:
497 ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
499 This example will produce the playlist, @file{out.m3u8}, and segment files:
500 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
502 @var{filename} may contain full path or relative path specification,
503 but only the file name part without any path info will be contained in the m3u8 segment list.
504 Should a relative path be specified, the path of the created segment
505 files will be relative to the current working directory.
506 When use_localtime_mkdir is set, the whole expanded value of @var{filename} will be written into the m3u8 segment list.
510 Use strftime() on @var{filename} to expand the segment filename with localtime.
511 The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index
512 hls_flag and %%d will be the specifier.
514 ffmpeg -i in.nut -use_localtime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
516 This example will produce the playlist, @file{out.m3u8}, and segment files:
517 @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
518 Note: On some systems/environments, the @code{%s} specifier is not available. See
519 @code{strftime()} documentation.
521 ffmpeg -i in.nut -use_localtime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
523 This example will produce the playlist, @file{out.m3u8}, and segment files:
524 @file{file-20160215-0001.ts}, @file{file-20160215-0002.ts}, etc.
526 @item use_localtime_mkdir
527 Used together with -use_localtime, it will create all subdirectories which
528 is expanded in @var{filename}.
530 ffmpeg -i in.nut -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
532 This example will create a directory 201560215 (if it does not exist), and then
533 produce the playlist, @file{out.m3u8}, and segment files:
534 @file{20160215/file-20160215-1455569023.ts}, @file{20160215/file-20160215-1455569024.ts}, etc.
537 ffmpeg -i in.nut -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
539 This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then
540 produce the playlist, @file{out.m3u8}, and segment files:
541 @file{2016/02/15/file-20160215-1455569023.ts}, @file{2016/02/15/file-20160215-1455569024.ts}, etc.
544 @item hls_key_info_file @var{key_info_file}
545 Use the information in @var{key_info_file} for segment encryption. The first
546 line of @var{key_info_file} specifies the key URI written to the playlist. The
547 key URL is used to access the encryption key during playback. The second line
548 specifies the path to the key file used to obtain the key during the encryption
549 process. The key file is read as a single packed array of 16 octets in binary
550 format. The optional third line specifies the initialization vector (IV) as a
551 hexadecimal string to be used instead of the segment sequence number (default)
552 for encryption. Changes to @var{key_info_file} will result in segment
553 encryption with the new key/IV and an entry in the playlist for the new key
556 Key info file format:
565 http://server/file.key
570 Example key file paths:
578 0123456789ABCDEF0123456789ABCDEF
581 Key info file example:
583 http://server/file.key
585 0123456789ABCDEF0123456789ABCDEF
588 Example shell script:
592 openssl rand 16 > file.key
593 echo $BASE_URL/file.key > file.keyinfo
594 echo file.key >> file.keyinfo
595 echo $(openssl rand -hex 16) >> file.keyinfo
596 ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
597 -hls_key_info_file file.keyinfo out.m3u8
600 @item -hls_enc @var{enc}
601 Enable (1) or disable (0) the AES128 encryption.
602 When enabled every segment generated is encrypted and the encryption key
603 is saved as @var{playlist name}.key.
605 @item -hls_enc_key @var{key}
606 Hex-coded 16byte key to encrypt the segments, by default it
607 is randomly generated.
609 @item -hls_enc_key_url @var{keyurl}
610 If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
613 @item -hls_enc_iv @var{iv}
614 Hex-coded 16byte initialization vector for every segment instead
615 of the autogenerated ones.
617 @item hls_flags @var{flags}
622 If this flag is set, the muxer will store all segments in a single MPEG-TS
623 file, and will use byte ranges in the playlist. HLS playlists generated with
624 this way will have the version number 4.
627 ffmpeg -i in.nut -hls_flags single_file out.m3u8
629 Will produce the playlist, @file{out.m3u8}, and a single segment file,
632 @item delete_segments
633 Segment files removed from the playlist are deleted after a period of time
634 equal to the duration of the segment plus the duration of the playlist.
637 Append new segments into the end of old segment list,
638 and remove the @code{#EXT-X-ENDLIST} from the old segment list.
640 @item round_durations
641 Round the duration info in the playlist file segment info to integer
642 values, instead of using floating point.
645 Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
646 first segment's information.
649 Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
652 Allow segments to start on frames other than keyframes. This improves
653 behavior on some players when the time between keyframes is inconsistent,
654 but may make things worse on others, and can cause some oddities during
655 seeking. This flag should be used with the @code{hls_time} option.
657 @item program_date_time
658 Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
660 @item second_level_segment_index
661 Makes it possible to use segment indexes as %%d in hls_segment_filename expression
662 besides date/time values when use_localtime is on.
663 To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width.
665 @item second_level_segment_size
666 Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename
667 expression besides date/time values when use_localtime is on.
668 To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width.
670 @item second_level_segment_duration
671 Makes it possible to use segment duration (calculated in microseconds) as %%t in hls_segment_filename
672 expression besides date/time values when use_localtime is on.
673 To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width.
676 ffmpeg -i sample.mpeg \
677 -f hls -hls_time 3 -hls_list_size 5 \
678 -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
679 -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
681 This will produce segments like this:
682 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
685 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
686 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
687 before they have been added to the m3u8 playlist.
691 @item hls_playlist_type event
692 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
693 @option{hls_list_size} to 0; the playlist can only be appended to.
695 @item hls_playlist_type vod
696 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
697 @option{hls_list_size} to 0; the playlist must not change.
700 Use the given HTTP method to create the hls files.
702 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
704 This example will upload all the mpegts segment files to the HTTP
705 server using the HTTP PUT method, and update the m3u8 files every
706 @code{refresh} times using the same method.
707 Note that the HTTP server must support the given method for uploading
716 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
720 Size cannot exceed 256 pixels in any dimension
723 Only BMP and PNG images can be stored
726 If a BMP image is used, it must be one of the following pixel formats:
728 BMP Bit Depth FFmpeg Pixel Format
738 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
741 If a PNG image is used, it must use the rgba pixel format
749 The image file muxer writes video frames to image files.
751 The output filenames are specified by a pattern, which can be used to
752 produce sequentially numbered series of files.
753 The pattern may contain the string "%d" or "%0@var{N}d", this string
754 specifies the position of the characters representing a numbering in
755 the filenames. If the form "%0@var{N}d" is used, the string
756 representing the number in each filename is 0-padded to @var{N}
757 digits. The literal character '%' can be specified in the pattern with
760 If the pattern contains "%d" or "%0@var{N}d", the first filename of
761 the file list specified will contain the number 1, all the following
762 numbers will be sequential.
764 The pattern may contain a suffix which is used to automatically
765 determine the format of the image files to write.
767 For example the pattern "img-%03d.bmp" will specify a sequence of
768 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
769 @file{img-010.bmp}, etc.
770 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
771 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
776 The following example shows how to use @command{ffmpeg} for creating a
777 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
778 taking one image every second from the input video:
780 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
783 Note that with @command{ffmpeg}, if the format is not specified with the
784 @code{-f} option and the output filename specifies an image file
785 format, the image2 muxer is automatically selected, so the previous
786 command can be written as:
788 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
791 Note also that the pattern must not necessarily contain "%d" or
792 "%0@var{N}d", for example to create a single image file
793 @file{img.jpeg} from the start of the input video you can employ the command:
795 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
798 The @option{strftime} option allows you to expand the filename with
799 date and time information. Check the documentation of
800 the @code{strftime()} function for the syntax.
802 For example to generate image files from the @code{strftime()}
803 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
806 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
813 Start the sequence from the specified number. Default value is 1.
816 If set to 1, the filename will always be interpreted as just a
817 filename, not a pattern, and the corresponding file will be continuously
818 overwritten with new images. Default value is 0.
821 If set to 1, expand the filename with date and time information from
822 @code{strftime()}. Default value is 0.
825 The image muxer supports the .Y.U.V image file format. This format is
826 special in that that each image frame consists of three files, for
827 each of the YUV420P components. To read or write this image file format,
828 specify the name of the '.Y' file. The muxer will automatically open the
829 '.U' and '.V' files as required.
833 Matroska container muxer.
835 This muxer implements the matroska and webm container specs.
839 The recognized metadata settings in this muxer are:
843 Set title name provided to a single track.
846 Specify the language of the track in the Matroska languages form.
848 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
849 639-2/B) form (like "fre" for French), or a language code mixed with a
850 country code for specialities in languages (like "fre-ca" for Canadian
854 Set stereo 3D video layout of two views in a single video track.
856 The following values are recognized:
861 Both views are arranged side by side, Left-eye view is on the left
863 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
865 Both views are arranged in top-bottom orientation, Left-eye view is on top
866 @item checkerboard_rl
867 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
868 @item checkerboard_lr
869 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
870 @item row_interleaved_rl
871 Each view is constituted by a row based interleaving, Right-eye view is first row
872 @item row_interleaved_lr
873 Each view is constituted by a row based interleaving, Left-eye view is first row
874 @item col_interleaved_rl
875 Both views are arranged in a column based interleaving manner, Right-eye view is first column
876 @item col_interleaved_lr
877 Both views are arranged in a column based interleaving manner, Left-eye view is first column
878 @item anaglyph_cyan_red
879 All frames are in anaglyph format viewable through red-cyan filters
881 Both views are arranged side by side, Right-eye view is on the left
882 @item anaglyph_green_magenta
883 All frames are in anaglyph format viewable through green-magenta filters
885 Both eyes laced in one Block, Left-eye view is first
887 Both eyes laced in one Block, Right-eye view is first
891 For example a 3D WebM clip can be created using the following command line:
893 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
898 This muxer supports the following options:
901 @item reserve_index_space
902 By default, this muxer writes the index for seeking (called cues in Matroska
903 terms) at the end of the file, because it cannot know in advance how much space
904 to leave for the index at the beginning of the file. However for some use cases
905 -- e.g. streaming where seeking is possible but slow -- it is useful to put the
906 index at the beginning of the file.
908 If this option is set to a non-zero value, the muxer will reserve a given amount
909 of space in the file header and then try to write the cues there when the muxing
910 finishes. If the available space does not suffice, muxing will fail. A safe size
911 for most use cases should be about 50kB per hour of video.
913 Note that cues are only written if the output is seekable and this option will
914 have no effect if it is not.
922 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
923 defaults to using the MD5 hash function.
927 To compute the MD5 hash of the input converted to raw
928 audio and video, and store it in the file @file{out.md5}:
930 ffmpeg -i INPUT -f md5 out.md5
933 You can print the MD5 to stdout with the command:
935 ffmpeg -i INPUT -f md5 -
938 See also the @ref{hash} and @ref{framemd5} muxers.
940 @section mov, mp4, ismv
942 MOV/MP4/ISMV (Smooth Streaming) muxer.
944 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
945 file has all the metadata about all packets stored in one location
946 (written at the end of the file, it can be moved to the start for
947 better playback by adding @var{faststart} to the @var{movflags}, or
948 using the @command{qt-faststart} tool). A fragmented
949 file consists of a number of fragments, where packets and metadata
950 about these packets are stored together. Writing a fragmented
951 file has the advantage that the file is decodable even if the
952 writing is interrupted (while a normal MOV/MP4 is undecodable if
953 it is not properly finished), and it requires less memory when writing
954 very long files (since writing normal MOV/MP4 files stores info about
955 every single packet in memory until the file is closed). The downside
956 is that it is less compatible with other applications.
960 Fragmentation is enabled by setting one of the AVOptions that define
961 how to cut the file into fragments:
964 @item -moov_size @var{bytes}
965 Reserves space for the moov atom at the beginning of the file instead of placing the
966 moov atom at the end. If the space reserved is insufficient, muxing will fail.
967 @item -movflags frag_keyframe
968 Start a new fragment at each video keyframe.
969 @item -frag_duration @var{duration}
970 Create fragments that are @var{duration} microseconds long.
971 @item -frag_size @var{size}
972 Create fragments that contain up to @var{size} bytes of payload data.
973 @item -movflags frag_custom
974 Allow the caller to manually choose when to cut fragments, by
975 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
976 the packets written so far. (This is only useful with other
977 applications integrating libavformat, not from @command{ffmpeg}.)
978 @item -min_frag_duration @var{duration}
979 Don't create fragments that are shorter than @var{duration} microseconds long.
982 If more than one condition is specified, fragments are cut when
983 one of the specified conditions is fulfilled. The exception to this is
984 @code{-min_frag_duration}, which has to be fulfilled for any of the other
987 Additionally, the way the output file is written can be adjusted
988 through a few other options:
991 @item -movflags empty_moov
992 Write an initial moov atom directly at the start of the file, without
993 describing any samples in it. Generally, an mdat/moov pair is written
994 at the start of the file, as a normal MOV/MP4 file, containing only
995 a short portion of the file. With this option set, there is no initial
996 mdat atom, and the moov atom only describes the tracks but has
999 This option is implicitly set when writing ismv (Smooth Streaming) files.
1000 @item -movflags separate_moof
1001 Write a separate moof (movie fragment) atom for each track. Normally,
1002 packets for all tracks are written in a moof atom (which is slightly
1003 more efficient), but with this option set, the muxer writes one moof/mdat
1004 pair for each track, making it easier to separate tracks.
1006 This option is implicitly set when writing ismv (Smooth Streaming) files.
1007 @item -movflags faststart
1008 Run a second pass moving the index (moov atom) to the beginning of the file.
1009 This operation can take a while, and will not work in various situations such
1010 as fragmented output, thus it is not enabled by default.
1011 @item -movflags rtphint
1012 Add RTP hinting tracks to the output file.
1013 @item -movflags disable_chpl
1014 Disable Nero chapter markers (chpl atom). Normally, both Nero chapters
1015 and a QuickTime chapter track are written to the file. With this option
1016 set, only the QuickTime chapter track will be written. Nero chapters can
1017 cause failures when the file is reprocessed with certain tagging programs, like
1018 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1019 @item -movflags omit_tfhd_offset
1020 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1021 tying fragments to absolute byte positions in the file/streams.
1022 @item -movflags default_base_moof
1023 Similarly to the omit_tfhd_offset, this flag avoids writing the
1024 absolute base_data_offset field in tfhd atoms, but does so by using
1025 the new default-base-is-moof flag instead. This flag is new from
1026 14496-12:2012. This may make the fragments easier to parse in certain
1027 circumstances (avoiding basing track fragment location calculations
1028 on the implicit end of the previous track fragment).
1030 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1031 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1036 Smooth Streaming content can be pushed in real time to a publishing
1037 point on IIS with this muxer. Example:
1039 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1042 @subsection Audible AAX
1044 Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
1046 ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
1051 The MP3 muxer writes a raw MP3 stream with the following optional features:
1054 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1055 2.4 are supported, the @code{id3v2_version} private option controls which one is
1056 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1059 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1060 The pictures are supplied to the muxer in form of a video stream with a single
1061 packet. There can be any number of those streams, each will correspond to a
1062 single APIC frame. The stream metadata tags @var{title} and @var{comment} map
1063 to APIC @var{description} and @var{picture type} respectively. See
1064 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1066 Note that the APIC frames must be written at the beginning, so the muxer will
1067 buffer the audio frames until it gets all the pictures. It is therefore advised
1068 to provide the pictures as soon as possible to avoid excessive buffering.
1071 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1072 default, but will be written only if the output is seekable. The
1073 @code{write_xing} private option can be used to disable it. The frame contains
1074 various information that may be useful to the decoder, like the audio duration
1078 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1079 enabled with the @code{write_id3v1} private option, but as its capabilities are
1080 very limited, its usage is not recommended.
1085 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1087 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1090 To attach a picture to an mp3 file select both the audio and the picture stream
1093 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1094 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1097 Write a "clean" MP3 without any extra features:
1099 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1104 MPEG transport stream muxer.
1106 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1108 The recognized metadata settings in mpegts muxer are @code{service_provider}
1109 and @code{service_name}. If they are not set the default for
1110 @code{service_provider} is @samp{FFmpeg} and the default for
1111 @code{service_name} is @samp{Service01}.
1115 The muxer options are:
1118 @item mpegts_transport_stream_id @var{integer}
1119 Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1120 Default is @code{0x0001}.
1122 @item mpegts_original_network_id @var{integer}
1123 Set the @samp{original_network_id}. This is unique identifier of a
1124 network in DVB. Its main use is in the unique identification of a service
1125 through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1128 @item mpegts_service_id @var{integer}
1129 Set the @samp{service_id}, also known as program in DVB. Default is
1132 @item mpegts_service_type @var{integer}
1133 Set the program @samp{service_type}. Default is @code{digital_tv}.
1134 Accepts the following options:
1137 Any hexdecimal value between @code{0x01} to @code{0xff} as defined in
1142 Digital Radio service.
1145 @item advanced_codec_digital_radio
1146 Advanced Codec Digital Radio service.
1147 @item mpeg2_digital_hdtv
1148 MPEG2 Digital HDTV service.
1149 @item advanced_codec_digital_sdtv
1150 Advanced Codec Digital SDTV service.
1151 @item advanced_codec_digital_hdtv
1152 Advanced Codec Digital HDTV service.
1155 @item mpegts_pmt_start_pid @var{integer}
1156 Set the first PID for PMT. Default is @code{0x1000}. Max is @code{0x1f00}.
1158 @item mpegts_start_pid @var{integer}
1159 Set the first PID for data packets. Default is @code{0x0100}. Max is
1162 @item mpegts_m2ts_mode @var{boolean}
1163 Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1166 @item muxrate @var{integer}
1167 Set a constant muxrate. Default is VBR.
1169 @item pes_payload_size @var{integer}
1170 Set minimum PES packet payload in bytes. Default is @code{2930}.
1172 @item mpegts_flags @var{flags}
1173 Set mpegts flags. Accepts the following options:
1175 @item resend_headers
1176 Reemit PAT/PMT before writing the next packet.
1178 Use LATM packetization for AAC.
1179 @item pat_pmt_at_frames
1180 Reemit PAT and PMT at each video frame.
1182 Conform to System B (DVB) instead of System A (ATSC).
1183 @item initial_discontinuity
1184 Mark the initial packet of each stream as discontinuity.
1187 @item resend_headers @var{integer}
1188 Reemit PAT/PMT before writing the next packet. This option is deprecated:
1189 use @option{mpegts_flags} instead.
1191 @item mpegts_copyts @var{boolean}
1192 Preserve original timestamps, if value is set to @code{1}. Default value
1193 is @code{-1}, which results in shifting timestamps so that they start from 0.
1195 @item omit_video_pes_length @var{boolean}
1196 Omit the PES packet length for video packets. Default is @code{1} (true).
1198 @item pcr_period @var{integer}
1199 Override the default PCR retransmission time in milliseconds. Ignored if
1200 variable muxrate is selected. Default is @code{20}.
1202 @item pat_period @var{double}
1203 Maximum time in seconds between PAT/PMT tables.
1205 @item sdt_period @var{double}
1206 Maximum time in seconds between SDT tables.
1208 @item tables_version @var{integer}
1209 Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1210 This option allows updating stream structure so that standard consumer may
1211 detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1212 usage) or restart @command{ffmpeg} instance, cyclically changing
1213 @option{tables_version} value:
1216 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1217 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1219 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1220 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1221 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1229 ffmpeg -i file.mpg -c copy \
1230 -mpegts_original_network_id 0x1122 \
1231 -mpegts_transport_stream_id 0x3344 \
1232 -mpegts_service_id 0x5566 \
1233 -mpegts_pmt_start_pid 0x1500 \
1234 -mpegts_start_pid 0x150 \
1235 -metadata service_provider="Some provider" \
1236 -metadata service_name="Some Channel" \
1240 @section mxf, mxf_d10
1246 The muxer options are:
1249 @item store_user_comments @var{bool}
1250 Set if user comments should be stored if available or never.
1251 IRT D-10 does not allow user comments. The default is thus to write them for
1252 mxf but not for mxf_d10
1259 This muxer does not generate any output file, it is mainly useful for
1260 testing or benchmarking purposes.
1262 For example to benchmark decoding with @command{ffmpeg} you can use the
1265 ffmpeg -benchmark -i INPUT -f null out.null
1268 Note that the above command does not read or write the @file{out.null}
1269 file, but specifying the output file is required by the @command{ffmpeg}
1272 Alternatively you can write the command as:
1274 ffmpeg -benchmark -i INPUT -f null -
1280 @item -syncpoints @var{flags}
1281 Change the syncpoint usage in nut:
1283 @item @var{default} use the normal low-overhead seeking aids.
1284 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1285 Use of this option is not recommended, as the resulting files are very damage
1286 sensitive and seeking is not possible. Also in general the overhead from
1287 syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1288 all growing data tables, allowing to mux endless streams with limited memory
1289 and without these disadvantages.
1290 @item @var{timestamped} extend the syncpoint with a wallclock field.
1292 The @var{none} and @var{timestamped} flags are experimental.
1293 @item -write_index @var{bool}
1294 Write index at the end, the default is to write an index.
1298 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
1303 Ogg container muxer.
1306 @item -page_duration @var{duration}
1307 Preferred page duration, in microseconds. The muxer will attempt to create
1308 pages that are approximately @var{duration} microseconds long. This allows the
1309 user to compromise between seek granularity and container overhead. The default
1310 is 1 second. A value of 0 will fill all segments, making pages as large as
1311 possible. A value of 1 will effectively use 1 packet-per-page in most
1312 situations, giving a small seek granularity at the cost of additional container
1314 @item -serial_offset @var{value}
1315 Serial value from which to set the streams serial number.
1316 Setting it to different and sufficiently large values ensures that the produced
1317 ogg files can be safely chained.
1322 @section segment, stream_segment, ssegment
1324 Basic stream segmenter.
1326 This muxer outputs streams to a number of separate files of nearly
1327 fixed duration. Output filename pattern can be set in a fashion
1328 similar to @ref{image2}, or by using a @code{strftime} template if
1329 the @option{strftime} option is enabled.
1331 @code{stream_segment} is a variant of the muxer used to write to
1332 streaming output formats, i.e. which do not require global headers,
1333 and is recommended for outputting e.g. to MPEG transport stream segments.
1334 @code{ssegment} is a shorter alias for @code{stream_segment}.
1336 Every segment starts with a keyframe of the selected reference stream,
1337 which is set through the @option{reference_stream} option.
1339 Note that if you want accurate splitting for a video file, you need to
1340 make the input key frames correspond to the exact splitting times
1341 expected by the segmenter, or the segment muxer will start the new
1342 segment with the key frame found next after the specified start
1345 The segment muxer works best with a single constant frame rate video.
1347 Optionally it can generate a list of the created segments, by setting
1348 the option @var{segment_list}. The list type is specified by the
1349 @var{segment_list_type} option. The entry filenames in the segment
1350 list are set by default to the basename of the corresponding segment
1353 See also the @ref{hls} muxer, which provides a more specific
1354 implementation for HLS segmentation.
1358 The segment muxer supports the following options:
1361 @item increment_tc @var{1|0}
1362 if set to @code{1}, increment timecode between each segment
1363 If this is selected, the input need to have
1364 a timecode in the first video stream. Default value is
1367 @item reference_stream @var{specifier}
1368 Set the reference stream, as specified by the string @var{specifier}.
1369 If @var{specifier} is set to @code{auto}, the reference is chosen
1370 automatically. Otherwise it must be a stream specifier (see the ``Stream
1371 specifiers'' chapter in the ffmpeg manual) which specifies the
1372 reference stream. The default value is @code{auto}.
1374 @item segment_format @var{format}
1375 Override the inner container format, by default it is guessed by the filename
1378 @item segment_format_options @var{options_list}
1379 Set output format options using a :-separated list of key=value
1380 parameters. Values containing the @code{:} special character must be
1383 @item segment_list @var{name}
1384 Generate also a listfile named @var{name}. If not specified no
1385 listfile is generated.
1387 @item segment_list_flags @var{flags}
1388 Set flags affecting the segment list generation.
1390 It currently supports the following flags:
1393 Allow caching (only affects M3U8 list files).
1396 Allow live-friendly file generation.
1399 @item segment_list_size @var{size}
1400 Update the list file so that it contains at most @var{size}
1401 segments. If 0 the list file will contain all the segments. Default
1404 @item segment_list_entry_prefix @var{prefix}
1405 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
1406 By default no prefix is applied.
1408 @item segment_list_type @var{type}
1409 Select the listing format.
1411 The following values are recognized:
1414 Generate a flat list for the created segments, one segment per line.
1417 Generate a list for the created segments, one segment per line,
1418 each line matching the format (comma-separated values):
1420 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
1423 @var{segment_filename} is the name of the output file generated by the
1424 muxer according to the provided pattern. CSV escaping (according to
1425 RFC4180) is applied if required.
1427 @var{segment_start_time} and @var{segment_end_time} specify
1428 the segment start and end time expressed in seconds.
1430 A list file with the suffix @code{".csv"} or @code{".ext"} will
1431 auto-select this format.
1433 @samp{ext} is deprecated in favor or @samp{csv}.
1436 Generate an ffconcat file for the created segments. The resulting file
1437 can be read using the FFmpeg @ref{concat} demuxer.
1439 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
1440 auto-select this format.
1443 Generate an extended M3U8 file, version 3, compliant with
1444 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
1446 A list file with the suffix @code{".m3u8"} will auto-select this format.
1449 If not specified the type is guessed from the list file name suffix.
1451 @item segment_time @var{time}
1452 Set segment duration to @var{time}, the value must be a duration
1453 specification. Default value is "2". See also the
1454 @option{segment_times} option.
1456 Note that splitting may not be accurate, unless you force the
1457 reference stream key-frames at the given time. See the introductory
1458 notice and the examples below.
1460 @item segment_atclocktime @var{1|0}
1461 If set to "1" split at regular clock time intervals starting from 00:00
1462 o'clock. The @var{time} value specified in @option{segment_time} is
1463 used for setting the length of the splitting interval.
1465 For example with @option{segment_time} set to "900" this makes it possible
1466 to create files at 12:00 o'clock, 12:15, 12:30, etc.
1468 Default value is "0".
1470 @item segment_clocktime_offset @var{duration}
1471 Delay the segment splitting times with the specified duration when using
1472 @option{segment_atclocktime}.
1474 For example with @option{segment_time} set to "900" and
1475 @option{segment_clocktime_offset} set to "300" this makes it possible to
1476 create files at 12:05, 12:20, 12:35, etc.
1478 Default value is "0".
1480 @item segment_clocktime_wrap_duration @var{duration}
1481 Force the segmenter to only start a new segment if a packet reaches the muxer
1482 within the specified duration after the segmenting clock time. This way you
1483 can make the segmenter more resilient to backward local time jumps, such as
1484 leap seconds or transition to standard time from daylight savings time.
1486 Default is the maximum possible duration which means starting a new segment
1487 regardless of the elapsed time since the last clock time.
1489 @item segment_time_delta @var{delta}
1490 Specify the accuracy time when selecting the start time for a
1491 segment, expressed as a duration specification. Default value is "0".
1493 When delta is specified a key-frame will start a new segment if its
1494 PTS satisfies the relation:
1496 PTS >= start_time - time_delta
1499 This option is useful when splitting video content, which is always
1500 split at GOP boundaries, in case a key frame is found just before the
1501 specified split time.
1503 In particular may be used in combination with the @file{ffmpeg} option
1504 @var{force_key_frames}. The key frame times specified by
1505 @var{force_key_frames} may not be set accurately because of rounding
1506 issues, with the consequence that a key frame time may result set just
1507 before the specified time. For constant frame rate videos a value of
1508 1/(2*@var{frame_rate}) should address the worst case mismatch between
1509 the specified time and the time set by @var{force_key_frames}.
1511 @item segment_times @var{times}
1512 Specify a list of split points. @var{times} contains a list of comma
1513 separated duration specifications, in increasing order. See also
1514 the @option{segment_time} option.
1516 @item segment_frames @var{frames}
1517 Specify a list of split video frame numbers. @var{frames} contains a
1518 list of comma separated integer numbers, in increasing order.
1520 This option specifies to start a new segment whenever a reference
1521 stream key frame is found and the sequential number (starting from 0)
1522 of the frame is greater or equal to the next value in the list.
1524 @item segment_wrap @var{limit}
1525 Wrap around segment index once it reaches @var{limit}.
1527 @item segment_start_number @var{number}
1528 Set the sequence number of the first segment. Defaults to @code{0}.
1530 @item strftime @var{1|0}
1531 Use the @code{strftime} function to define the name of the new
1532 segments to write. If this is selected, the output segment name must
1533 contain a @code{strftime} function template. Default value is
1536 @item break_non_keyframes @var{1|0}
1537 If enabled, allow segments to start on frames other than keyframes. This
1538 improves behavior on some players when the time between keyframes is
1539 inconsistent, but may make things worse on others, and can cause some oddities
1540 during seeking. Defaults to @code{0}.
1542 @item reset_timestamps @var{1|0}
1543 Reset timestamps at the begin of each segment, so that each segment
1544 will start with near-zero timestamps. It is meant to ease the playback
1545 of the generated segments. May not work with some combinations of
1546 muxers/codecs. It is set to @code{0} by default.
1548 @item initial_offset @var{offset}
1549 Specify timestamp offset to apply to the output packet timestamps. The
1550 argument must be a time duration specification, and defaults to 0.
1552 @item write_empty_segments @var{1|0}
1553 If enabled, write an empty segment if there are no packets during the period a
1554 segment would usually span. Otherwise, the segment will be filled with the next
1555 packet written. Defaults to @code{0}.
1558 @subsection Examples
1562 Remux the content of file @file{in.mkv} to a list of segments
1563 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
1564 generated segments to @file{out.list}:
1566 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
1570 Segment input and set output format options for the output segments:
1572 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
1576 Segment the input file according to the split points specified by the
1577 @var{segment_times} option:
1579 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 out%03d.nut
1583 Use the @command{ffmpeg} @option{force_key_frames}
1584 option to force key frames in the input at the specified location, together
1585 with the segment option @option{segment_time_delta} to account for
1586 possible roundings operated when setting key frame times.
1588 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
1589 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
1591 In order to force key frames on the input file, transcoding is
1595 Segment the input file by splitting the input file according to the
1596 frame numbers sequence specified with the @option{segment_frames} option:
1598 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
1602 Convert the @file{in.mkv} to TS segments using the @code{libx264}
1603 and @code{aac} encoders:
1605 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
1609 Segment the input file, and create an M3U8 live playlist (can be used
1610 as live HLS source):
1612 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
1613 -segment_list_flags +live -segment_time 10 out%03d.mkv
1617 @section smoothstreaming
1619 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
1623 Specify the number of fragments kept in the manifest. Default 0 (keep all).
1625 @item extra_window_size
1626 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
1628 @item lookahead_count
1629 Specify the number of lookahead fragments. Default 2.
1631 @item min_frag_duration
1632 Specify the minimum fragment duration (in microseconds). Default 5000000.
1634 @item remove_at_exit
1635 Specify whether to remove all fragments when finished. Default 0 (do not remove).
1642 The fifo pseudo-muxer allows the separation of encoding and muxing by using
1643 first-in-first-out queue and running the actual muxer in a separate thread. This
1644 is especially useful in combination with the @ref{tee} muxer and can be used to
1645 send data to several destinations with different reliability/writing speed/latency.
1647 API users should be aware that callback functions (interrupt_callback,
1648 io_open and io_close) used within its AVFormatContext must be thread-safe.
1650 The behavior of the fifo muxer if the queue fills up or if the output fails is
1656 output can be transparently restarted with configurable delay between retries
1657 based on real time or time of the processed stream.
1660 encoding can be blocked during temporary failure, or continue transparently
1661 dropping packets in case fifo queue fills up.
1668 Specify the format name. Useful if it cannot be guessed from the
1672 Specify size of the queue (number of packets). Default value is 60.
1675 Specify format options for the underlying muxer. Muxer options can be specified
1676 as a list of @var{key}=@var{value} pairs separated by ':'.
1678 @item drop_pkts_on_overflow @var{bool}
1679 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
1680 rather than blocking the encoder. This makes it possible to continue streaming without
1681 delaying the input, at the cost of omitting part of the stream. By default
1682 this option is set to 0 (false), so in such cases the encoder will be blocked
1683 until the muxer processes some of the packets and none of them is lost.
1685 @item attempt_recovery @var{bool}
1686 If failure occurs, attempt to recover the output. This is especially useful
1687 when used with network output, since it makes it possible to restart streaming transparently.
1688 By default this option is set to 0 (false).
1690 @item max_recovery_attempts
1691 Sets maximum number of successive unsuccessful recovery attempts after which
1692 the output fails permanently. By default this option is set to 0 (unlimited).
1694 @item recovery_wait_time @var{duration}
1695 Waiting time before the next recovery attempt after previous unsuccessful
1696 recovery attempt. Default value is 5 seconds.
1698 @item recovery_wait_streamtime @var{bool}
1699 If set to 0 (false), the real time is used when waiting for the recovery
1700 attempt (i.e. the recovery will be attempted after at least
1701 recovery_wait_time seconds).
1702 If set to 1 (true), the time of the processed stream is taken into account
1703 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
1704 seconds of the stream is omitted).
1705 By default, this option is set to 0 (false).
1707 @item recover_any_error @var{bool}
1708 If set to 1 (true), recovery will be attempted regardless of type of the error
1709 causing the failure. By default this option is set to 0 (false) and in case of
1710 certain (usually permanent) errors the recovery is not attempted even when
1711 @var{attempt_recovery} is set to 1.
1713 @item restart_with_keyframe @var{bool}
1714 Specify whether to wait for the keyframe after recovering from
1715 queue overflow or failure. This option is set to 0 (false) by default.
1719 @subsection Examples
1724 Stream something to rtmp server, continue processing the stream at real-time
1725 rate even in case of temporary failure (network outage) and attempt to recover
1726 streaming every second indefinitely.
1728 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
1729 -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
1737 The tee muxer can be used to write the same data to several files or any
1738 other kind of muxer. It can be used, for example, to both stream a video to
1739 the network and save it to disk at the same time.
1741 It is different from specifying several outputs to the @command{ffmpeg}
1742 command-line tool because the audio and video data will be encoded only once
1743 with the tee muxer; encoding can be a very expensive process. It is not
1744 useful when using the libavformat API directly because it is then possible
1745 to feed the same packets to several muxers directly.
1749 @item use_fifo @var{bool}
1750 If set to 1, slave outputs will be processed in separate thread using @ref{fifo}
1751 muxer. This allows to compensate for different speed/latency/reliability of
1752 outputs and setup transparent recovery. By default this feature is turned off.
1755 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
1759 The slave outputs are specified in the file name given to the muxer,
1760 separated by '|'. If any of the slave name contains the '|' separator,
1761 leading or trailing spaces or any special character, it must be
1762 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
1763 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
1765 Muxer options can be specified for each slave by prepending them as a list of
1766 @var{key}=@var{value} pairs separated by ':', between square brackets. If
1767 the options values contain a special character or the ':' separator, they
1768 must be escaped; note that this is a second level escaping.
1770 The following special options are also recognized:
1773 Specify the format name. Useful if it cannot be guessed from the
1776 @item bsfs[/@var{spec}]
1777 Specify a list of bitstream filters to apply to the specified
1780 @item use_fifo @var{bool}
1781 This allows to override tee muxer use_fifo option for individual slave muxer.
1784 This allows to override tee muxer fifo_options for individual slave muxer.
1787 It is possible to specify to which streams a given bitstream filter
1788 applies, by appending a stream specifier to the option separated by
1789 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
1790 stream specifiers}). If the stream specifier is not specified, the
1791 bitstream filters will be applied to all streams in the output.
1793 Several bitstream filters can be specified, separated by ",".
1796 Select the streams that should be mapped to the slave output,
1797 specified by a stream specifier. If not specified, this defaults to
1798 all the input streams. You may use multiple stream specifiers
1799 separated by commas (@code{,}) e.g.: @code{a:0,v}
1802 Specify behaviour on output failure. This can be set to either @code{abort} (which is
1803 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
1804 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
1805 will continue without being affected.
1808 @subsection Examples
1812 Encode something and both archive it in a WebM file and stream it
1813 as MPEG-TS over UDP (the streams need to be explicitly mapped):
1815 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1816 "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1820 As above, but continue streaming even if output to local file fails
1821 (for example local drive fills up):
1823 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1824 "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1828 Use @command{ffmpeg} to encode the input, and send the output
1829 to three different destinations. The @code{dump_extra} bitstream
1830 filter is used to add extradata information to all the output video
1831 keyframes packets, as requested by the MPEG-TS format. The select
1832 option is applied to @file{out.aac} in order to make it contain only
1835 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
1836 -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
1840 As below, but select only stream @code{a:1} for the audio output. Note
1841 that a second level escaping must be performed, as ":" is a special
1842 character used to separate options.
1844 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
1845 -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
1849 Note: some codecs may need different options depending on the output format;
1850 the auto-detection of this can not work with the tee muxer. The main example
1851 is the @option{global_header} flag.
1853 @section webm_dash_manifest
1855 WebM DASH Manifest muxer.
1857 This muxer implements the WebM DASH Manifest specification to generate the DASH
1858 manifest XML. It also supports manifest generation for DASH live streams.
1860 For more information see:
1864 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
1866 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
1871 This muxer supports the following options:
1874 @item adaptation_sets
1875 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
1876 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
1877 audio and video streams. Any number of adaptation sets can be added using this option.
1880 Set this to 1 to create a live stream DASH Manifest. Default: 0.
1882 @item chunk_start_index
1883 Start index of the first chunk. This will go in the @samp{startNumber} attribute
1884 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
1886 @item chunk_duration_ms
1887 Duration of each chunk in milliseconds. This will go in the @samp{duration}
1888 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
1890 @item utc_timing_url
1891 URL of the page that will return the UTC timestamp in ISO format. This will go
1892 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
1895 @item time_shift_buffer_depth
1896 Smallest time (in seconds) shifting buffer for which any Representation is
1897 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
1898 attribute of the @samp{MPD} element. Default: 60.
1900 @item minimum_update_period
1901 Minimum update period (in seconds) of the manifest. This will go in the
1902 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
1908 ffmpeg -f webm_dash_manifest -i video1.webm \
1909 -f webm_dash_manifest -i video2.webm \
1910 -f webm_dash_manifest -i audio1.webm \
1911 -f webm_dash_manifest -i audio2.webm \
1912 -map 0 -map 1 -map 2 -map 3 \
1914 -f webm_dash_manifest \
1915 -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
1921 WebM Live Chunk Muxer.
1923 This muxer writes out WebM headers and chunks as separate files which can be
1924 consumed by clients that support WebM Live streams via DASH.
1928 This muxer supports the following options:
1931 @item chunk_start_index
1932 Index of the first chunk (defaults to 0).
1935 Filename of the header where the initialization data will be written.
1937 @item audio_chunk_duration
1938 Duration of each audio chunk in milliseconds (defaults to 5000).
1943 ffmpeg -f v4l2 -i /dev/video0 \
1947 -s 640x360 -keyint_min 30 -g 30 \
1949 -header webm_live_video_360.hdr \
1950 -chunk_start_index 1 \
1951 webm_live_video_360_%d.chk \
1956 -header webm_live_audio_128.hdr \
1957 -chunk_start_index 1 \
1958 -audio_chunk_duration 1000 \
1959 webm_live_audio_128_%d.chk