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{-formats} of the ff* tools will display the list of
19 A description of some of the currently available muxers follows.
24 Audio Interchange File Format muxer.
28 It accepts the following options:
32 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
35 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
36 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
43 CRC (Cyclic Redundancy Check) testing format.
45 This muxer computes and prints the Adler-32 CRC of all the input audio
46 and video frames. By default audio frames are converted to signed
47 16-bit raw audio and video frames to raw video before computing the
50 The output of the muxer consists of a single line of the form:
51 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
52 8 digits containing the CRC for all the decoded input frames.
54 See also the @ref{framecrc} muxer.
58 For example to compute the CRC of the input, and store it in the file
61 ffmpeg -i INPUT -f crc out.crc
64 You can print the CRC to stdout with the command:
66 ffmpeg -i INPUT -f crc -
69 You can select the output format of each frame with @command{ffmpeg} by
70 specifying the audio and video codec and format. For example to
71 compute the CRC of the input audio converted to PCM unsigned 8-bit
72 and the input video converted to MPEG-2 video, use the command:
74 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
80 Per-packet CRC (Cyclic Redundancy Check) testing format.
82 This muxer computes and prints the Adler-32 CRC for each audio
83 and video packet. By default audio frames are converted to signed
84 16-bit raw audio and video frames to raw video before computing the
87 The output of the muxer consists of a line for each audio and video
90 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
93 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
98 For example to compute the CRC of the audio and video frames in
99 @file{INPUT}, converted to raw audio and video packets, and store it
100 in the file @file{out.crc}:
102 ffmpeg -i INPUT -f framecrc out.crc
105 To print the information to stdout, use the command:
107 ffmpeg -i INPUT -f framecrc -
110 With @command{ffmpeg}, you can select the output format to which the
111 audio and video frames are encoded before computing the CRC for each
112 packet by specifying the audio and video codec. For example, to
113 compute the CRC of each decoded input audio frame converted to PCM
114 unsigned 8-bit and of each decoded input video frame converted to
115 MPEG-2 video, use the command:
117 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
120 See also the @ref{crc} muxer.
125 Per-packet MD5 testing format.
127 This muxer computes and prints the MD5 hash for each audio
128 and video packet. By default audio frames are converted to signed
129 16-bit raw audio and video frames to raw video before computing the
132 The output of the muxer consists of a line for each audio and video
135 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{MD5}
138 @var{MD5} is a hexadecimal number representing the computed MD5 hash
143 For example to compute the MD5 of the audio and video frames in
144 @file{INPUT}, converted to raw audio and video packets, and store it
145 in the file @file{out.md5}:
147 ffmpeg -i INPUT -f framemd5 out.md5
150 To print the information to stdout, use the command:
152 ffmpeg -i INPUT -f framemd5 -
155 See also the @ref{md5} muxer.
162 It accepts the following options:
166 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
167 for looping indefinitely (default).
170 Force the delay (expressed in centiseconds) after the last frame. Each frame
171 ends with a delay until the next frame. The default is @code{-1}, which is a
172 special value to tell the muxer to re-use the previous delay. In case of a
173 loop, you might want to customize this value to mark a pause for instance.
176 For example, to encode a gif looping 10 times, with a 5 seconds delay between
179 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
182 Note 1: if you wish to extract the frames in separate GIF files, you need to
183 force the @ref{image2} muxer:
185 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
188 Note 2: the GIF format has a very small time base: the delay between two frames
189 can not be smaller than one centi second.
194 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
195 the HTTP Live Streaming (HLS) specification.
197 It creates a playlist file and numbered segment files. The output
198 filename specifies the playlist filename; the segment filenames
199 receive the same basename as the playlist, a sequential number and
202 For example, to convert an input file with @command{ffmpeg}:
204 ffmpeg -i in.nut out.m3u8
207 See also the @ref{segment} muxer, which provides a more generic and
208 flexible implementation of a segmenter, and can be used to perform HLS
213 This muxer supports the following options:
216 @item hls_time @var{seconds}
217 Set the segment length in seconds. Default value is 2.
219 @item hls_list_size @var{size}
220 Set the maximum number of playlist entries. If set to 0 the list file
221 will contain all the segments. Default value is 5.
223 @item hls_wrap @var{wrap}
224 Set the number after which the segment filename number (the number
225 specified in each segment file) wraps. If set to 0 the number will be
226 never wrapped. Default value is 0.
228 This option is useful to avoid to fill the disk with many segment
229 files, and limits the maximum number of segment files written to disk
232 @item start_number @var{number}
233 Start the playlist sequence number from @var{number}. Default value is
236 @item hls_base_url @var{baseurl}
237 Append @var{baseurl} to every entry in the playlist.
238 Useful to generate playlists with absolute paths.
240 Note that the playlist sequence number must be unique for each segment
241 and it is not to be confused with the segment filename sequence number
242 which can be cyclic, for example if the @option{wrap} option is
251 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
255 Size cannot exceed 256 pixels in any dimension
258 Only BMP and PNG images can be stored
261 If a BMP image is used, it must be one of the following pixel formats:
263 BMP Bit Depth FFmpeg Pixel Format
273 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
276 If a PNG image is used, it must use the rgba pixel format
284 The image file muxer writes video frames to image files.
286 The output filenames are specified by a pattern, which can be used to
287 produce sequentially numbered series of files.
288 The pattern may contain the string "%d" or "%0@var{N}d", this string
289 specifies the position of the characters representing a numbering in
290 the filenames. If the form "%0@var{N}d" is used, the string
291 representing the number in each filename is 0-padded to @var{N}
292 digits. The literal character '%' can be specified in the pattern with
295 If the pattern contains "%d" or "%0@var{N}d", the first filename of
296 the file list specified will contain the number 1, all the following
297 numbers will be sequential.
299 The pattern may contain a suffix which is used to automatically
300 determine the format of the image files to write.
302 For example the pattern "img-%03d.bmp" will specify a sequence of
303 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
304 @file{img-010.bmp}, etc.
305 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
306 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
311 The following example shows how to use @command{ffmpeg} for creating a
312 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
313 taking one image every second from the input video:
315 ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
318 Note that with @command{ffmpeg}, if the format is not specified with the
319 @code{-f} option and the output filename specifies an image file
320 format, the image2 muxer is automatically selected, so the previous
321 command can be written as:
323 ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
326 Note also that the pattern must not necessarily contain "%d" or
327 "%0@var{N}d", for example to create a single image file
328 @file{img.jpeg} from the input video you can employ the command:
330 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
333 The @option{strftime} option allows you to expand the filename with
334 date and time information. Check the documentation of
335 the @code{strftime()} function for the syntax.
337 For example to generate image files from the @code{strftime()}
338 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
341 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
348 Start the sequence from the specified number. Default value is 1. Must
349 be a non-negative number.
352 If set to 1, the filename will always be interpreted as just a
353 filename, not a pattern, and the corresponding file will be continuously
354 overwritten with new images. Default value is 0.
357 If set to 1, expand the filename with date and time information from
358 @code{strftime()}. Default value is 0.
361 The image muxer supports the .Y.U.V image file format. This format is
362 special in that that each image frame consists of three files, for
363 each of the YUV420P components. To read or write this image file format,
364 specify the name of the '.Y' file. The muxer will automatically open the
365 '.U' and '.V' files as required.
369 Matroska container muxer.
371 This muxer implements the matroska and webm container specs.
375 The recognized metadata settings in this muxer are:
379 Set title name provided to a single track.
382 Specify the language of the track in the Matroska languages form.
384 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
385 639-2/B) form (like "fre" for French), or a language code mixed with a
386 country code for specialities in languages (like "fre-ca" for Canadian
390 Set stereo 3D video layout of two views in a single video track.
392 The following values are recognized:
397 Both views are arranged side by side, Left-eye view is on the left
399 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
401 Both views are arranged in top-bottom orientation, Left-eye view is on top
402 @item checkerboard_rl
403 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
404 @item checkerboard_lr
405 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
406 @item row_interleaved_rl
407 Each view is constituted by a row based interleaving, Right-eye view is first row
408 @item row_interleaved_lr
409 Each view is constituted by a row based interleaving, Left-eye view is first row
410 @item col_interleaved_rl
411 Both views are arranged in a column based interleaving manner, Right-eye view is first column
412 @item col_interleaved_lr
413 Both views are arranged in a column based interleaving manner, Left-eye view is first column
414 @item anaglyph_cyan_red
415 All frames are in anaglyph format viewable through red-cyan filters
417 Both views are arranged side by side, Right-eye view is on the left
418 @item anaglyph_green_magenta
419 All frames are in anaglyph format viewable through green-magenta filters
421 Both eyes laced in one Block, Left-eye view is first
423 Both eyes laced in one Block, Right-eye view is first
427 For example a 3D WebM clip can be created using the following command line:
429 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
434 This muxer supports the following options:
437 @item reserve_index_space
438 By default, this muxer writes the index for seeking (called cues in Matroska
439 terms) at the end of the file, because it cannot know in advance how much space
440 to leave for the index at the beginning of the file. However for some use cases
441 -- e.g. streaming where seeking is possible but slow -- it is useful to put the
442 index at the beginning of the file.
444 If this option is set to a non-zero value, the muxer will reserve a given amount
445 of space in the file header and then try to write the cues there when the muxing
446 finishes. If the available space does not suffice, muxing will fail. A safe size
447 for most use cases should be about 50kB per hour of video.
449 Note that cues are only written if the output is seekable and this option will
450 have no effect if it is not.
458 This muxer computes and prints the MD5 hash of all the input audio
459 and video frames. By default audio frames are converted to signed
460 16-bit raw audio and video frames to raw video before computing the
463 The output of the muxer consists of a single line of the form:
464 MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
465 the computed MD5 hash.
467 For example to compute the MD5 hash of the input converted to raw
468 audio and video, and store it in the file @file{out.md5}:
470 ffmpeg -i INPUT -f md5 out.md5
473 You can print the MD5 to stdout with the command:
475 ffmpeg -i INPUT -f md5 -
478 See also the @ref{framemd5} muxer.
480 @section mov, mp4, ismv
482 MOV/MP4/ISMV (Smooth Streaming) muxer.
484 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
485 file has all the metadata about all packets stored in one location
486 (written at the end of the file, it can be moved to the start for
487 better playback by adding @var{faststart} to the @var{movflags}, or
488 using the @command{qt-faststart} tool). A fragmented
489 file consists of a number of fragments, where packets and metadata
490 about these packets are stored together. Writing a fragmented
491 file has the advantage that the file is decodable even if the
492 writing is interrupted (while a normal MOV/MP4 is undecodable if
493 it is not properly finished), and it requires less memory when writing
494 very long files (since writing normal MOV/MP4 files stores info about
495 every single packet in memory until the file is closed). The downside
496 is that it is less compatible with other applications.
500 Fragmentation is enabled by setting one of the AVOptions that define
501 how to cut the file into fragments:
504 @item -moov_size @var{bytes}
505 Reserves space for the moov atom at the beginning of the file instead of placing the
506 moov atom at the end. If the space reserved is insufficient, muxing will fail.
507 @item -movflags frag_keyframe
508 Start a new fragment at each video keyframe.
509 @item -frag_duration @var{duration}
510 Create fragments that are @var{duration} microseconds long.
511 @item -frag_size @var{size}
512 Create fragments that contain up to @var{size} bytes of payload data.
513 @item -movflags frag_custom
514 Allow the caller to manually choose when to cut fragments, by
515 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
516 the packets written so far. (This is only useful with other
517 applications integrating libavformat, not from @command{ffmpeg}.)
518 @item -min_frag_duration @var{duration}
519 Don't create fragments that are shorter than @var{duration} microseconds long.
522 If more than one condition is specified, fragments are cut when
523 one of the specified conditions is fulfilled. The exception to this is
524 @code{-min_frag_duration}, which has to be fulfilled for any of the other
527 Additionally, the way the output file is written can be adjusted
528 through a few other options:
531 @item -movflags empty_moov
532 Write an initial moov atom directly at the start of the file, without
533 describing any samples in it. Generally, an mdat/moov pair is written
534 at the start of the file, as a normal MOV/MP4 file, containing only
535 a short portion of the file. With this option set, there is no initial
536 mdat atom, and the moov atom only describes the tracks but has
539 Files written with this option set do not work in QuickTime.
540 This option is implicitly set when writing ismv (Smooth Streaming) files.
541 @item -movflags separate_moof
542 Write a separate moof (movie fragment) atom for each track. Normally,
543 packets for all tracks are written in a moof atom (which is slightly
544 more efficient), but with this option set, the muxer writes one moof/mdat
545 pair for each track, making it easier to separate tracks.
547 This option is implicitly set when writing ismv (Smooth Streaming) files.
548 @item -movflags faststart
549 Run a second pass moving the index (moov atom) to the beginning of the file.
550 This operation can take a while, and will not work in various situations such
551 as fragmented output, thus it is not enabled by default.
552 @item -movflags rtphint
553 Add RTP hinting tracks to the output file.
554 @item -movflags disable_chpl
555 Disable Nero chapter markers (chpl atom). Normally, both Nero chapters
556 and a QuickTime chapter track are written to the file. With this option
557 set, only the QuickTime chapter track will be written. Nero chapters can
558 cause failures when the file is reprocessed with certain tagging programs.
563 Smooth Streaming content can be pushed in real time to a publishing
564 point on IIS with this muxer. Example:
566 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
571 The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
572 optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
573 @code{id3v2_version} option controls which one is used. Setting
574 @code{id3v2_version} to 0 will disable the ID3v2 header completely. The legacy
575 ID3v1 tag is not written by default, but may be enabled with the
576 @code{write_id3v1} option.
578 The muxer may also write a Xing frame at the beginning, which contains the
579 number of frames in the file. It is useful for computing duration of VBR files.
580 The Xing frame is written if the output stream is seekable and if the
581 @code{write_xing} option is set to 1 (the default).
583 The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
584 are supplied to the muxer in form of a video stream with a single packet. There
585 can be any number of those streams, each will correspond to a single APIC frame.
586 The stream metadata tags @var{title} and @var{comment} map to APIC
587 @var{description} and @var{picture type} respectively. See
588 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
590 Note that the APIC frames must be written at the beginning, so the muxer will
591 buffer the audio frames until it gets all the pictures. It is therefore advised
592 to provide the pictures as soon as possible to avoid excessive buffering.
596 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
598 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
601 To attach a picture to an mp3 file select both the audio and the picture stream
604 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
605 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
608 Write a "clean" MP3 without any extra features:
610 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
615 MPEG transport stream muxer.
617 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
619 The recognized metadata settings in mpegts muxer are @code{service_provider}
620 and @code{service_name}. If they are not set the default for
621 @code{service_provider} is "FFmpeg" and the default for
622 @code{service_name} is "Service01".
626 The muxer options are:
629 @item -mpegts_original_network_id @var{number}
630 Set the original_network_id (default 0x0001). This is unique identifier
631 of a network in DVB. Its main use is in the unique identification of a
632 service through the path Original_Network_ID, Transport_Stream_ID.
633 @item -mpegts_transport_stream_id @var{number}
634 Set the transport_stream_id (default 0x0001). This identifies a
636 @item -mpegts_service_id @var{number}
637 Set the service_id (default 0x0001) also known as program in DVB.
638 @item -mpegts_pmt_start_pid @var{number}
639 Set the first PID for PMT (default 0x1000, max 0x1f00).
640 @item -mpegts_start_pid @var{number}
641 Set the first PID for data packets (default 0x0100, max 0x0f00).
642 @item -mpegts_m2ts_mode @var{number}
643 Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
644 @item -muxrate @var{number}
645 Set a constant muxrate (default VBR).
646 @item -pcr_period @var{numer}
647 Override the default PCR retransmission time (default 20ms), ignored
648 if variable muxrate is selected.
649 @item -pes_payload_size @var{number}
650 Set minimum PES packet payload in bytes.
651 @item -mpegts_flags @var{flags}
652 Set flags (see below).
653 @item -mpegts_copyts @var{number}
654 Preserve original timestamps, if value is set to 1. Default value is -1, which
655 results in shifting timestamps so that they start from 0.
656 @item -tables_version @var{number}
657 Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
658 This option allows updating stream structure so that standard consumer may
659 detect the change. To do so, reopen output AVFormatContext (in case of API
660 usage) or restart ffmpeg instance, cyclically changing tables_version value:
662 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
663 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
665 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
666 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
667 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
672 Option mpegts_flags may take a set of such flags:
676 Reemit PAT/PMT before writing the next packet.
678 Use LATM packetization for AAC.
684 ffmpeg -i file.mpg -c copy \
685 -mpegts_original_network_id 0x1122 \
686 -mpegts_transport_stream_id 0x3344 \
687 -mpegts_service_id 0x5566 \
688 -mpegts_pmt_start_pid 0x1500 \
689 -mpegts_start_pid 0x150 \
690 -metadata service_provider="Some provider" \
691 -metadata service_name="Some Channel" \
699 This muxer does not generate any output file, it is mainly useful for
700 testing or benchmarking purposes.
702 For example to benchmark decoding with @command{ffmpeg} you can use the
705 ffmpeg -benchmark -i INPUT -f null out.null
708 Note that the above command does not read or write the @file{out.null}
709 file, but specifying the output file is required by the @command{ffmpeg}
712 Alternatively you can write the command as:
714 ffmpeg -benchmark -i INPUT -f null -
720 @item -syncpoints @var{flags}
721 Change the syncpoint usage in nut:
723 @item @var{default} use the normal low-overhead seeking aids.
724 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
725 Use of this option is not recommended, as the resulting files are very damage
726 sensitive and seeking is not possible. Also in general the overhead from
727 syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
728 all growing data tables, allowing to mux endless streams with limited memory
729 and wihout these disadvantages.
730 @item @var{timestamped} extend the syncpoint with a wallclock field.
732 The @var{none} and @var{timestamped} flags are experimental.
733 @item -write_index @var{bool}
734 Write index at the end, the default is to write an index.
738 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
746 @item -page_duration @var{duration}
747 Preferred page duration, in microseconds. The muxer will attempt to create
748 pages that are approximately @var{duration} microseconds long. This allows the
749 user to compromise between seek granularity and container overhead. The default
750 is 1 second. A value of 0 will fill all segments, making pages as large as
751 possible. A value of 1 will effectively use 1 packet-per-page in most
752 situations, giving a small seek granularity at the cost of additional container
757 @section segment, stream_segment, ssegment
759 Basic stream segmenter.
761 This muxer outputs streams to a number of separate files of nearly
762 fixed duration. Output filename pattern can be set in a fashion similar to
765 @code{stream_segment} is a variant of the muxer used to write to
766 streaming output formats, i.e. which do not require global headers,
767 and is recommended for outputting e.g. to MPEG transport stream segments.
768 @code{ssegment} is a shorter alias for @code{stream_segment}.
770 Every segment starts with a keyframe of the selected reference stream,
771 which is set through the @option{reference_stream} option.
773 Note that if you want accurate splitting for a video file, you need to
774 make the input key frames correspond to the exact splitting times
775 expected by the segmenter, or the segment muxer will start the new
776 segment with the key frame found next after the specified start
779 The segment muxer works best with a single constant frame rate video.
781 Optionally it can generate a list of the created segments, by setting
782 the option @var{segment_list}. The list type is specified by the
783 @var{segment_list_type} option. The entry filenames in the segment
784 list are set by default to the basename of the corresponding segment
787 See also the @ref{hls} muxer, which provides a more specific
788 implementation for HLS segmentation.
792 The segment muxer supports the following options:
795 @item reference_stream @var{specifier}
796 Set the reference stream, as specified by the string @var{specifier}.
797 If @var{specifier} is set to @code{auto}, the reference is chosen
798 automatically. Otherwise it must be a stream specifier (see the ``Stream
799 specifiers'' chapter in the ffmpeg manual) which specifies the
800 reference stream. The default value is @code{auto}.
802 @item segment_format @var{format}
803 Override the inner container format, by default it is guessed by the filename
806 @item segment_list @var{name}
807 Generate also a listfile named @var{name}. If not specified no
808 listfile is generated.
810 @item segment_list_flags @var{flags}
811 Set flags affecting the segment list generation.
813 It currently supports the following flags:
816 Allow caching (only affects M3U8 list files).
819 Allow live-friendly file generation.
822 @item segment_list_type @var{type}
823 Select the listing format.
825 @item @var{flat} use a simple flat list of entries.
826 @item @var{hls} use a m3u8-like structure.
829 @item segment_list_size @var{size}
830 Update the list file so that it contains at most @var{size}
831 segments. If 0 the list file will contain all the segments. Default
834 @item segment_list_entry_prefix @var{prefix}
835 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
836 By default no prefix is applied.
838 The following values are recognized:
841 Generate a flat list for the created segments, one segment per line.
844 Generate a list for the created segments, one segment per line,
845 each line matching the format (comma-separated values):
847 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
850 @var{segment_filename} is the name of the output file generated by the
851 muxer according to the provided pattern. CSV escaping (according to
852 RFC4180) is applied if required.
854 @var{segment_start_time} and @var{segment_end_time} specify
855 the segment start and end time expressed in seconds.
857 A list file with the suffix @code{".csv"} or @code{".ext"} will
858 auto-select this format.
860 @samp{ext} is deprecated in favor or @samp{csv}.
863 Generate an ffconcat file for the created segments. The resulting file
864 can be read using the FFmpeg @ref{concat} demuxer.
866 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
867 auto-select this format.
870 Generate an extended M3U8 file, version 3, compliant with
871 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
873 A list file with the suffix @code{".m3u8"} will auto-select this format.
876 If not specified the type is guessed from the list file name suffix.
878 @item segment_time @var{time}
879 Set segment duration to @var{time}, the value must be a duration
880 specification. Default value is "2". See also the
881 @option{segment_times} option.
883 Note that splitting may not be accurate, unless you force the
884 reference stream key-frames at the given time. See the introductory
885 notice and the examples below.
887 @item segment_atclocktime @var{1|0}
888 If set to "1" split at regular clock time intervals starting from 00:00
889 o'clock. The @var{time} value specified in @option{segment_time} is
890 used for setting the length of the splitting interval.
892 For example with @option{segment_time} set to "900" this makes it possible
893 to create files at 12:00 o'clock, 12:15, 12:30, etc.
895 Default value is "0".
897 @item segment_time_delta @var{delta}
898 Specify the accuracy time when selecting the start time for a
899 segment, expressed as a duration specification. Default value is "0".
901 When delta is specified a key-frame will start a new segment if its
902 PTS satisfies the relation:
904 PTS >= start_time - time_delta
907 This option is useful when splitting video content, which is always
908 split at GOP boundaries, in case a key frame is found just before the
909 specified split time.
911 In particular may be used in combination with the @file{ffmpeg} option
912 @var{force_key_frames}. The key frame times specified by
913 @var{force_key_frames} may not be set accurately because of rounding
914 issues, with the consequence that a key frame time may result set just
915 before the specified time. For constant frame rate videos a value of
916 1/(2*@var{frame_rate}) should address the worst case mismatch between
917 the specified time and the time set by @var{force_key_frames}.
919 @item segment_times @var{times}
920 Specify a list of split points. @var{times} contains a list of comma
921 separated duration specifications, in increasing order. See also
922 the @option{segment_time} option.
924 @item segment_frames @var{frames}
925 Specify a list of split video frame numbers. @var{frames} contains a
926 list of comma separated integer numbers, in increasing order.
928 This option specifies to start a new segment whenever a reference
929 stream key frame is found and the sequential number (starting from 0)
930 of the frame is greater or equal to the next value in the list.
932 @item segment_wrap @var{limit}
933 Wrap around segment index once it reaches @var{limit}.
935 @item segment_start_number @var{number}
936 Set the sequence number of the first segment. Defaults to @code{0}.
938 @item reset_timestamps @var{1|0}
939 Reset timestamps at the begin of each segment, so that each segment
940 will start with near-zero timestamps. It is meant to ease the playback
941 of the generated segments. May not work with some combinations of
942 muxers/codecs. It is set to @code{0} by default.
944 @item initial_offset @var{offset}
945 Specify timestamp offset to apply to the output packet timestamps. The
946 argument must be a time duration specification, and defaults to 0.
953 To remux the content of file @file{in.mkv} to a list of segments
954 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
955 generated segments to @file{out.list}:
957 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
961 As the example above, but segment the input file according to the split
962 points specified by the @var{segment_times} option:
964 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
968 As the example above, but use the @command{ffmpeg} @option{force_key_frames}
969 option to force key frames in the input at the specified location, together
970 with the segment option @option{segment_time_delta} to account for
971 possible roundings operated when setting key frame times.
973 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
974 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
976 In order to force key frames on the input file, transcoding is
980 Segment the input file by splitting the input file according to the
981 frame numbers sequence specified with the @option{segment_frames} option:
983 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
987 To convert the @file{in.mkv} to TS segments using the @code{libx264}
988 and @code{libfaac} encoders:
990 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
994 Segment the input file, and create an M3U8 live playlist (can be used
997 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
998 -segment_list_flags +live -segment_time 10 out%03d.mkv
1002 @section smoothstreaming
1004 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
1008 Specify the number of fragments kept in the manifest. Default 0 (keep all).
1010 @item extra_window_size
1011 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
1013 @item lookahead_count
1014 Specify the number of lookahead fragments. Default 2.
1016 @item min_frag_duration
1017 Specify the minimum fragment duration (in microseconds). Default 5000000.
1019 @item remove_at_exit
1020 Specify whether to remove all fragments when finished. Default 0 (do not remove).
1026 The tee muxer can be used to write the same data to several files or any
1027 other kind of muxer. It can be used, for example, to both stream a video to
1028 the network and save it to disk at the same time.
1030 It is different from specifying several outputs to the @command{ffmpeg}
1031 command-line tool because the audio and video data will be encoded only once
1032 with the tee muxer; encoding can be a very expensive process. It is not
1033 useful when using the libavformat API directly because it is then possible
1034 to feed the same packets to several muxers directly.
1036 The slave outputs are specified in the file name given to the muxer,
1037 separated by '|'. If any of the slave name contains the '|' separator,
1038 leading or trailing spaces or any special character, it must be
1039 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
1040 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
1042 Muxer options can be specified for each slave by prepending them as a list of
1043 @var{key}=@var{value} pairs separated by ':', between square brackets. If
1044 the options values contain a special character or the ':' separator, they
1045 must be escaped; note that this is a second level escaping.
1047 The following special options are also recognized:
1050 Specify the format name. Useful if it cannot be guessed from the
1053 @item bsfs[/@var{spec}]
1054 Specify a list of bitstream filters to apply to the specified
1057 It is possible to specify to which streams a given bitstream filter
1058 applies, by appending a stream specifier to the option separated by
1059 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
1060 stream specifiers}). If the stream specifier is not specified, the
1061 bitstream filters will be applied to all streams in the output.
1063 Several bitstream filters can be specified, separated by ",".
1066 Select the streams that should be mapped to the slave output,
1067 specified by a stream specifier. If not specified, this defaults to
1068 all the input streams.
1071 @subsection Examples
1075 Encode something and both archive it in a WebM file and stream it
1076 as MPEG-TS over UDP (the streams need to be explicitly mapped):
1078 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1079 "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1083 Use @command{ffmpeg} to encode the input, and send the output
1084 to three different destinations. The @code{dump_extra} bitstream
1085 filter is used to add extradata information to all the output video
1086 keyframes packets, as requested by the MPEG-TS format. The select
1087 option is applied to @file{out.aac} in order to make it contain only
1090 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1091 -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
1095 As below, but select only stream @code{a:1} for the audio output. Note
1096 that a second level escaping must be performed, as ":" is a special
1097 character used to separate options.
1099 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1100 -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
1104 Note: some codecs may need different options depending on the output format;
1105 the auto-detection of this can not work with the tee muxer. The main example
1106 is the @option{global_header} flag.
1108 @section webm_dash_manifest
1110 WebM DASH Manifest muxer.
1112 This muxer implements the WebM DASH Manifest specification to generate the DASH manifest XML.
1116 This muxer supports the following options:
1119 @item adaptation_sets
1120 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
1121 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
1122 audio and video streams. Any number of adaptation sets can be added using this option.
1127 ffmpeg -f webm_dash_manifest -i video1.webm \
1128 -f webm_dash_manifest -i video2.webm \
1129 -f webm_dash_manifest -i audio1.webm \
1130 -f webm_dash_manifest -i audio2.webm \
1131 -map 0 -map 1 -map 2 -map 3 \
1133 -f webm_dash_manifest \
1134 -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \