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 A64 muxer for Commodore 64 video. Accepts a single @code{a64_multi} or @code{a64_multi5} codec video stream.
30 Audio Data Transport Stream muxer. It accepts a single AAC stream.
34 It accepts the following options:
38 @item write_id3v2 @var{bool}
39 Enable to write ID3v2.4 tags at the start of the stream. Default is disabled.
41 @item write_apetag @var{bool}
42 Enable to write APE tags at the end of the stream. Default is disabled.
44 @item write_mpeg2 @var{bool}
45 Enable to set MPEG version bit in the ADTS frame header to 1 which indicates MPEG-2. Default is 0, which indicates MPEG-4.
52 Audio Interchange File Format muxer.
56 It accepts the following options:
60 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
63 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
64 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
71 Muxer for audio of High Voltage Software's Lego Racers game. It accepts a single ADPCM_IMA_ALP stream
72 with no more than 2 channels nor a sample rate greater than 44100 Hz.
78 It accepts the following options:
87 Set file type as music. Must have a sample rate of 22050 Hz.
93 Set file type as per output file extension. @code{.pcm} results in type @code{pcm} else type @code{tun} is set. @var{(default)}
102 Advanced Systems Format muxer.
104 Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this
109 It accepts the following options:
113 Set the muxer packet size. By tuning this setting you may reduce data
114 fragmentation or muxer overhead depending on your source. Default value is
115 3200, minimum is 100, maximum is 64k.
122 Audio Video Interleaved muxer.
126 It accepts the following options:
129 @item reserve_index_space
130 Reserve the specified amount of bytes for the OpenDML master index of each
131 stream within the file header. By default additional master indexes are
132 embedded within the data packets if there is no space left in the first master
133 index and are linked together as a chain of indexes. This index structure can
134 cause problems for some use cases, e.g. third-party software strictly relying
135 on the OpenDML index specification or when file seeking is slow. Reserving
136 enough index space in the file header avoids these problems.
138 The required index space depends on the output file size and should be about 16
139 bytes per gigabyte. When this option is omitted or set to zero the necessary
140 index space is guessed.
142 @item write_channel_mask
143 Write the channel layout mask into the audio stream header.
145 This option is enabled by default. Disabling the channel mask can be useful in
146 specific scenarios, e.g. when merging multiple audio streams into one for
147 compatibility with software that only supports a single audio stream in AVI
148 (see @ref{amerge,,the "amerge" section in the ffmpeg-filters manual,ffmpeg-filters}).
150 @item flipped_raw_rgb
151 If set to true, store positive height for raw RGB bitmaps, which indicates
152 bitmap is stored bottom-up. Note that this option does not flip the bitmap
153 which has to be done manually beforehand, e.g. by using the vflip filter.
154 Default is @var{false} and indicates bitmap is stored top down.
161 Chromaprint fingerprinter.
163 This muxer feeds audio data to the Chromaprint library,
164 which generates a fingerprint for the provided audio data. See @url{https://acoustid.org/chromaprint}
166 It takes a single signed native-endian 16-bit raw audio stream of at most 2 channels.
171 @item silence_threshold
172 Threshold for detecting silence. Range is from -1 to 32767, where -1 disables
173 silence detection. Silence detection can only be used with version 3 of the
175 Silence detection must be disabled for use with the AcoustID service. Default is -1.
178 Version of algorithm to fingerprint with. Range is 0 to 4.
179 Version 3 enables silence detection. Default is 1.
182 Format to output the fingerprint as. Accepts the following options:
185 Binary raw fingerprint
188 Binary compressed fingerprint
191 Base64 compressed fingerprint @emph{(default)}
200 CRC (Cyclic Redundancy Check) testing format.
202 This muxer computes and prints the Adler-32 CRC of all the input audio
203 and video frames. 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 single line of the form:
208 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
209 8 digits containing the CRC for all the decoded input frames.
211 See also the @ref{framecrc} muxer.
215 For example to compute the CRC of the input, and store it in the file
218 ffmpeg -i INPUT -f crc out.crc
221 You can print the CRC to stdout with the command:
223 ffmpeg -i INPUT -f crc -
226 You can select the output format of each frame with @command{ffmpeg} by
227 specifying the audio and video codec and format. For example to
228 compute the CRC of the input audio converted to PCM unsigned 8-bit
229 and the input video converted to MPEG-2 video, use the command:
231 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
237 Dynamic Adaptive Streaming over HTTP (DASH) muxer that creates segments
238 and manifest files according to the MPEG-DASH standard ISO/IEC 23009-1:2014.
240 For more information see:
244 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
246 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
249 It creates a MPD manifest file and segment files for each stream.
251 The segment filename might contain pre-defined identifiers used with SegmentTemplate
252 as defined in section 5.3.9.4.4 of the standard. Available identifiers are "$RepresentationID$",
253 "$Number$", "$Bandwidth$" and "$Time$".
254 In addition to the standard identifiers, an ffmpeg-specific "$ext$" identifier is also supported.
255 When specified ffmpeg will replace $ext$ in the file name with muxing format's extensions such as mp4, webm etc.,
258 ffmpeg -re -i <input> -map 0 -map 0 -c:a libfdk_aac -c:v libx264 \
259 -b:v:0 800k -b:v:1 300k -s:v:1 320x170 -profile:v:1 baseline \
260 -profile:v:0 main -bf 1 -keyint_min 120 -g 120 -sc_threshold 0 \
261 -b_strategy 0 -ar:a:1 22050 -use_timeline 1 -use_template 1 \
262 -window_size 5 -adaptation_sets "id=0,streams=v id=1,streams=a" \
263 -f dash /path/to/out.mpd
267 @item seg_duration @var{duration}
268 Set the segment length in seconds (fractional value can be set). The value is
269 treated as average segment duration when @var{use_template} is enabled and
270 @var{use_timeline} is disabled and as minimum segment duration for all the other
272 @item frag_duration @var{duration}
273 Set the length in seconds of fragments within segments (fractional value can be set).
274 @item frag_type @var{type}
275 Set the type of interval for fragmentation.
276 @item window_size @var{size}
277 Set the maximum number of segments kept in the manifest.
278 @item extra_window_size @var{size}
279 Set the maximum number of segments kept outside of the manifest before removing from disk.
280 @item remove_at_exit @var{remove}
281 Enable (1) or disable (0) removal of all segments when finished.
282 @item use_template @var{template}
283 Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList.
284 @item use_timeline @var{timeline}
285 Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate.
286 @item single_file @var{single_file}
287 Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges.
288 @item single_file_name @var{file_name}
289 DASH-templated name to be used for baseURL. Implies @var{single_file} set to "1". In the template, "$ext$" is replaced with the file name extension specific for the segment format.
290 @item init_seg_name @var{init_name}
291 DASH-templated name to used for the initialization segment. Default is "init-stream$RepresentationID$.$ext$". "$ext$" is replaced with the file name extension specific for the segment format.
292 @item media_seg_name @var{segment_name}
293 DASH-templated name to used for the media segments. Default is "chunk-stream$RepresentationID$-$Number%05d$.$ext$". "$ext$" is replaced with the file name extension specific for the segment format.
294 @item utc_timing_url @var{utc_url}
295 URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso"
296 @item method @var{method}
297 Use the given HTTP method to create output files. Generally set to PUT or POST.
298 @item http_user_agent @var{user_agent}
299 Override User-Agent field in HTTP header. Applicable only for HTTP output.
300 @item http_persistent @var{http_persistent}
301 Use persistent HTTP connections. Applicable only for HTTP output.
302 @item hls_playlist @var{hls_playlist}
303 Generate HLS playlist files as well. The master playlist is generated with the filename @var{hls_master_name}.
304 One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc.
305 @item hls_master_name @var{file_name}
306 HLS master playlist name. Default is "master.m3u8".
307 @item streaming @var{streaming}
308 Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming
309 mode, each frame will be a moof fragment which forms a chunk.
310 @item adaptation_sets @var{adaptation_sets}
311 Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs
312 of the adaptation sets and a,b,c,d and e are the indices of the mapped streams.
314 To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs.
316 When no assignment is defined, this defaults to an AdaptationSet for each stream.
318 Optional syntax is "id=x,seg_duration=x,frag_duration=x,frag_type=type,descriptor=descriptor_string,streams=a,b,c id=y,seg_duration=y,frag_type=type,streams=d,e" and so on,
319 descriptor is useful to the scheme defined by ISO/IEC 23009-1:2014/Amd.2:2015.
320 For example, -adaptation_sets "id=0,descriptor=<SupplementalProperty schemeIdUri=\"urn:mpeg:dash:srd:2014\" value=\"0,0,0,1,1,2,2\"/>,streams=v".
321 Please note that descriptor string should be a self-closing xml tag.
322 seg_duration, frag_duration and frag_type override the global option values for each adaptation set.
323 For example, -adaptation_sets "id=0,seg_duration=2,frag_duration=1,frag_type=duration,streams=v id=1,seg_duration=2,frag_type=none,streams=a"
324 type_id marks an adaptation set as containing streams meant to be used for Trick Mode for the referenced adaptation set.
325 For example, -adaptation_sets "id=0,seg_duration=2,frag_type=none,streams=0 id=1,seg_duration=10,frag_type=none,trick_id=0,streams=1"
326 @item timeout @var{timeout}
327 Set timeout for socket I/O operations. Applicable only for HTTP output.
328 @item index_correction @var{index_correction}
329 Enable (1) or Disable (0) segment index correction logic. Applicable only when
330 @var{use_template} is enabled and @var{use_timeline} is disabled.
332 When enabled, the logic monitors the flow of segment indexes. If a streams's
333 segment index value is not at the expected real time position, then the logic
334 corrects that index value.
336 Typically this logic is needed in live streaming use cases. The network bandwidth
337 fluctuations are common during long run streaming. Each fluctuation can cause
338 the segment indexes fall behind the expected real time position.
339 @item format_options @var{options_list}
340 Set container format (mp4/webm) options using a @code{:} separated list of
341 key=value parameters. Values containing @code{:} special characters must be
344 @item global_sidx @var{global_sidx}
345 Write global SIDX atom. Applicable only for single file, mp4 output, non-streaming mode.
347 @item dash_segment_type @var{dash_segment_type}
351 If this flag is set, the dash segment files format will be selected based on the stream codec. This is the default mode.
354 If this flag is set, the dash segment files will be in in ISOBMFF format.
357 If this flag is set, the dash segment files will be in in WebM format.
360 @item ignore_io_errors @var{ignore_io_errors}
361 Ignore IO errors during open and write. Useful for long-duration runs with network output.
363 @item lhls @var{lhls}
364 Enable Low-latency HLS(LHLS). Adds #EXT-X-PREFETCH tag with current segment's URI.
365 Apple doesn't have an official spec for LHLS. Meanwhile hls.js player folks are
366 trying to standardize a open LHLS spec. The draft spec is available in https://github.com/video-dev/hlsjs-rfcs/blob/lhls-spec/proposals/0001-lhls.md
367 This option will also try to comply with the above open spec, till Apple's spec officially supports it.
368 Applicable only when @var{streaming} and @var{hls_playlist} options are enabled.
369 This is an experimental feature.
371 @item ldash @var{ldash}
372 Enable Low-latency Dash by constraining the presence and values of some elements.
374 @item master_m3u8_publish_rate @var{master_m3u8_publish_rate}
375 Publish master playlist repeatedly every after specified number of segment intervals.
377 @item write_prft @var{write_prft}
378 Write Producer Reference Time elements on supported streams. This also enables writing
379 prft boxes in the underlying muxer. Applicable only when the @var{utc_url} option is enabled.
380 It's set to auto by default, in which case the muxer will attempt to enable it only in modes
383 @item mpd_profile @var{mpd_profile}
384 Set one or more manifest profiles.
386 @item http_opts @var{http_opts}
387 A :-separated list of key=value options to pass to the underlying HTTP
388 protocol. Applicable only for HTTP output.
390 @item target_latency @var{target_latency}
391 Set an intended target latency in seconds (fractional value can be set) for serving. Applicable only when @var{streaming} and @var{write_prft} options are enabled.
392 This is an informative fields clients can use to measure the latency of the service.
394 @item min_playback_rate @var{min_playback_rate}
395 Set the minimum playback rate indicated as appropriate for the purposes of automatically
396 adjusting playback latency and buffer occupancy during normal playback by clients.
398 @item max_playback_rate @var{max_playback_rate}
399 Set the maximum playback rate indicated as appropriate for the purposes of automatically
400 adjusting playback latency and buffer occupancy during normal playback by clients.
402 @item update_period @var{update_period}
403 Set the mpd update period ,for dynamic content.
411 The fifo pseudo-muxer allows the separation of encoding and muxing by using
412 first-in-first-out queue and running the actual muxer in a separate thread. This
413 is especially useful in combination with the @ref{tee} muxer and can be used to
414 send data to several destinations with different reliability/writing speed/latency.
416 API users should be aware that callback functions (interrupt_callback,
417 io_open and io_close) used within its AVFormatContext must be thread-safe.
419 The behavior of the fifo muxer if the queue fills up or if the output fails is
425 output can be transparently restarted with configurable delay between retries
426 based on real time or time of the processed stream.
429 encoding can be blocked during temporary failure, or continue transparently
430 dropping packets in case fifo queue fills up.
437 Specify the format name. Useful if it cannot be guessed from the
441 Specify size of the queue (number of packets). Default value is 60.
444 Specify format options for the underlying muxer. Muxer options can be specified
445 as a list of @var{key}=@var{value} pairs separated by ':'.
447 @item drop_pkts_on_overflow @var{bool}
448 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
449 rather than blocking the encoder. This makes it possible to continue streaming without
450 delaying the input, at the cost of omitting part of the stream. By default
451 this option is set to 0 (false), so in such cases the encoder will be blocked
452 until the muxer processes some of the packets and none of them is lost.
454 @item attempt_recovery @var{bool}
455 If failure occurs, attempt to recover the output. This is especially useful
456 when used with network output, since it makes it possible to restart streaming transparently.
457 By default this option is set to 0 (false).
459 @item max_recovery_attempts
460 Sets maximum number of successive unsuccessful recovery attempts after which
461 the output fails permanently. By default this option is set to 0 (unlimited).
463 @item recovery_wait_time @var{duration}
464 Waiting time before the next recovery attempt after previous unsuccessful
465 recovery attempt. Default value is 5 seconds.
467 @item recovery_wait_streamtime @var{bool}
468 If set to 0 (false), the real time is used when waiting for the recovery
469 attempt (i.e. the recovery will be attempted after at least
470 recovery_wait_time seconds).
471 If set to 1 (true), the time of the processed stream is taken into account
472 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
473 seconds of the stream is omitted).
474 By default, this option is set to 0 (false).
476 @item recover_any_error @var{bool}
477 If set to 1 (true), recovery will be attempted regardless of type of the error
478 causing the failure. By default this option is set to 0 (false) and in case of
479 certain (usually permanent) errors the recovery is not attempted even when
480 @var{attempt_recovery} is set to 1.
482 @item restart_with_keyframe @var{bool}
483 Specify whether to wait for the keyframe after recovering from
484 queue overflow or failure. This option is set to 0 (false) by default.
486 @item timeshift @var{duration}
487 Buffer the specified amount of packets and delay writing the output. Note that
488 @var{queue_size} must be big enough to store the packets for timeshift. At the
489 end of the input the fifo buffer is flushed at realtime speed.
498 Stream something to rtmp server, continue processing the stream at real-time
499 rate even in case of temporary failure (network outage) and attempt to recover
500 streaming every second indefinitely.
502 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
503 -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
510 Adobe Flash Video Format muxer.
512 This muxer accepts the following options:
516 @item flvflags @var{flags}
521 @item aac_seq_header_detect
522 Place AAC sequence header based on audio stream data.
524 @item no_sequence_end
525 Disable sequence end tag.
528 Disable metadata tag.
530 @item no_duration_filesize
531 Disable duration and filesize in metadata when they are equal to zero
532 at the end of stream. (Be used to non-seekable living stream).
534 @item add_keyframe_index
535 Used to facilitate seeking; particularly for HTTP pseudo streaming.
542 Per-packet CRC (Cyclic Redundancy Check) testing format.
544 This muxer computes and prints the Adler-32 CRC for each audio
545 and video packet. By default audio frames are converted to signed
546 16-bit raw audio and video frames to raw video before computing the
549 The output of the muxer consists of a line for each audio and video
552 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
555 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
560 For example to compute the CRC of the audio and video frames in
561 @file{INPUT}, converted to raw audio and video packets, and store it
562 in the file @file{out.crc}:
564 ffmpeg -i INPUT -f framecrc out.crc
567 To print the information to stdout, use the command:
569 ffmpeg -i INPUT -f framecrc -
572 With @command{ffmpeg}, you can select the output format to which the
573 audio and video frames are encoded before computing the CRC for each
574 packet by specifying the audio and video codec. For example, to
575 compute the CRC of each decoded input audio frame converted to PCM
576 unsigned 8-bit and of each decoded input video frame converted to
577 MPEG-2 video, use the command:
579 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
582 See also the @ref{crc} muxer.
587 Per-packet hash testing format.
589 This muxer computes and prints a cryptographic hash for each audio
590 and video packet. This can be used for packet-by-packet equality
591 checks without having to individually do a binary comparison on each.
593 By default audio frames are converted to signed 16-bit raw audio and
594 video frames to raw video before computing the hash, but the output
595 of explicit conversions to other codecs can also be used. It uses the
596 SHA-256 cryptographic hash function by default, but supports several
599 The output of the muxer consists of a line for each audio and video
602 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
605 @var{hash} is a hexadecimal number representing the computed hash
609 @item hash @var{algorithm}
610 Use the cryptographic hash function specified by the string @var{algorithm}.
611 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
612 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
613 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
614 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
620 To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
621 converted to raw audio and video packets, and store it in the file
624 ffmpeg -i INPUT -f framehash out.sha256
627 To print the information to stdout, using the MD5 hash function, use
630 ffmpeg -i INPUT -f framehash -hash md5 -
633 See also the @ref{hash} muxer.
638 Per-packet MD5 testing format.
640 This is a variant of the @ref{framehash} muxer. Unlike that muxer,
641 it defaults to using the MD5 hash function.
645 To compute the MD5 hash of the audio and video frames in @file{INPUT},
646 converted to raw audio and video packets, and store it in the file
649 ffmpeg -i INPUT -f framemd5 out.md5
652 To print the information to stdout, use the command:
654 ffmpeg -i INPUT -f framemd5 -
657 See also the @ref{framehash} and @ref{md5} muxers.
664 It accepts the following options:
668 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
669 for looping indefinitely (default).
672 Force the delay (expressed in centiseconds) after the last frame. Each frame
673 ends with a delay until the next frame. The default is @code{-1}, which is a
674 special value to tell the muxer to re-use the previous delay. In case of a
675 loop, you might want to customize this value to mark a pause for instance.
678 For example, to encode a gif looping 10 times, with a 5 seconds delay between
681 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
684 Note 1: if you wish to extract the frames into separate GIF files, you need to
685 force the @ref{image2} muxer:
687 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
690 Note 2: the GIF format has a very large time base: the delay between two frames
691 can therefore not be smaller than one centi second.
698 This muxer computes and prints a cryptographic hash of all the input
699 audio and video frames. This can be used for equality checks without
700 having to do a complete binary comparison.
702 By default audio frames are converted to signed 16-bit raw audio and
703 video frames to raw video before computing the hash, but the output
704 of explicit conversions to other codecs can also be used. Timestamps
705 are ignored. It uses the SHA-256 cryptographic hash function by default,
706 but supports several other algorithms.
708 The output of the muxer consists of a single line of the form:
709 @var{algo}=@var{hash}, where @var{algo} is a short string representing
710 the hash function used, and @var{hash} is a hexadecimal number
711 representing the computed hash.
714 @item hash @var{algorithm}
715 Use the cryptographic hash function specified by the string @var{algorithm}.
716 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
717 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
718 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
719 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
725 To compute the SHA-256 hash of the input converted to raw audio and
726 video, and store it in the file @file{out.sha256}:
728 ffmpeg -i INPUT -f hash out.sha256
731 To print an MD5 hash to stdout use the command:
733 ffmpeg -i INPUT -f hash -hash md5 -
736 See also the @ref{framehash} muxer.
741 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
742 the HTTP Live Streaming (HLS) specification.
744 It creates a playlist file, and one or more segment files. The output filename
745 specifies the playlist filename.
747 By default, the muxer creates a file for each segment produced. These files
748 have the same name as the playlist, followed by a sequential number and a
751 Make sure to require a closed GOP when encoding and to set the GOP
752 size to fit your segment time constraint.
754 For example, to convert an input file with @command{ffmpeg}:
756 ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
758 This example will produce the playlist, @file{out.m3u8}, and segment files:
759 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
761 See also the @ref{segment} muxer, which provides a more generic and
762 flexible implementation of a segmenter, and can be used to perform HLS
767 This muxer supports the following options:
770 @item hls_init_time @var{duration}
771 Set the initial target segment length. Default value is @var{0}.
773 @var{duration} must be a time duration specification,
774 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
776 Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
777 After the initial playlist is filled @command{ffmpeg} will cut segments
778 at duration equal to @code{hls_time}
780 @item hls_time @var{duration}
781 Set the target segment length. Default value is 2.
783 @var{duration} must be a time duration specification,
784 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
785 Segment will be cut on the next key frame after this time has passed.
787 @item hls_list_size @var{size}
788 Set the maximum number of playlist entries. If set to 0 the list file
789 will contain all the segments. Default value is 5.
791 @item hls_delete_threshold @var{size}
792 Set the number of unreferenced segments to keep on disk before @code{hls_flags delete_segments}
793 deletes them. Increase this to allow continue clients to download segments which
794 were recently referenced in the playlist. Default value is 1, meaning segments older than
795 @code{hls_list_size+1} will be deleted.
797 @item hls_ts_options @var{options_list}
798 Set output format options using a :-separated list of key=value
799 parameters. Values containing @code{:} special characters must be
802 @item hls_start_number_source
803 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) according to the specified source.
804 Unless @code{hls_flags single_file} is set, it also specifies source of starting sequence numbers of
805 segment and subtitle filenames. In any case, if @code{hls_flags append_list}
806 is set and read playlist sequence number is greater than the specified start sequence number,
807 then that value will be used as start value.
809 It accepts the following values:
813 @item generic (default)
814 Set the starting sequence numbers according to @var{start_number} option value.
817 The start number will be the seconds since epoch (1970-01-01 00:00:00)
820 The start number will be the microseconds since epoch (1970-01-01 00:00:00)
823 The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759.
827 @item start_number @var{number}
828 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) from the specified @var{number}
829 when @var{hls_start_number_source} value is @var{generic}. (This is the default case.)
830 Unless @code{hls_flags single_file} is set, it also specifies starting sequence numbers of segment and subtitle filenames.
833 @item hls_allow_cache @var{allowcache}
834 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
836 @item hls_base_url @var{baseurl}
837 Append @var{baseurl} to every entry in the playlist.
838 Useful to generate playlists with absolute paths.
840 Note that the playlist sequence number must be unique for each segment
841 and it is not to be confused with the segment filename sequence number
842 which can be cyclic, for example if the @option{wrap} option is
845 @item hls_segment_filename @var{filename}
846 Set the segment filename. Unless @code{hls_flags single_file} is set,
847 @var{filename} is used as a string format with the segment number:
849 ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
851 This example will produce the playlist, @file{out.m3u8}, and segment files:
852 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
854 @var{filename} may contain full path or relative path specification,
855 but only the file name part without any path info will be contained in the m3u8 segment list.
856 Should a relative path be specified, the path of the created segment
857 files will be relative to the current working directory.
858 When strftime_mkdir is set, the whole expanded value of @var{filename} will be written into the m3u8 segment list.
860 When @code{var_stream_map} is set with two or more variant streams, the
861 @var{filename} pattern must contain the string "%v", this string specifies
862 the position of variant stream index in the generated segment file names.
864 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
865 -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
866 -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
868 This example will produce the playlists segment file sets:
869 @file{file_0_000.ts}, @file{file_0_001.ts}, @file{file_0_002.ts}, etc. and
870 @file{file_1_000.ts}, @file{file_1_001.ts}, @file{file_1_002.ts}, etc.
872 The string "%v" may be present in the filename or in the last directory name
873 containing the file, but only in one of them. (Additionally, %v may appear multiple times in the last
874 sub-directory or filename.) If the string %v is present in the directory name, then
875 sub-directories are created after expanding the directory name pattern. This
876 enables creation of segments corresponding to different variant streams in
879 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
880 -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
881 -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
883 This example will produce the playlists segment file sets:
884 @file{vs0/file_000.ts}, @file{vs0/file_001.ts}, @file{vs0/file_002.ts}, etc. and
885 @file{vs1/file_000.ts}, @file{vs1/file_001.ts}, @file{vs1/file_002.ts}, etc.
888 Use strftime() on @var{filename} to expand the segment filename with localtime.
889 The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index
890 hls_flag and %%d will be the specifier.
892 ffmpeg -i in.nut -strftime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
894 This example will produce the playlist, @file{out.m3u8}, and segment files:
895 @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
896 Note: On some systems/environments, the @code{%s} specifier is not available. See
897 @code{strftime()} documentation.
899 ffmpeg -i in.nut -strftime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
901 This example will produce the playlist, @file{out.m3u8}, and segment files:
902 @file{file-20160215-0001.ts}, @file{file-20160215-0002.ts}, etc.
905 Used together with -strftime_mkdir, it will create all subdirectories which
906 is expanded in @var{filename}.
908 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
910 This example will create a directory 201560215 (if it does not exist), and then
911 produce the playlist, @file{out.m3u8}, and segment files:
912 @file{20160215/file-20160215-1455569023.ts}, @file{20160215/file-20160215-1455569024.ts}, etc.
915 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
917 This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then
918 produce the playlist, @file{out.m3u8}, and segment files:
919 @file{2016/02/15/file-20160215-1455569023.ts}, @file{2016/02/15/file-20160215-1455569024.ts}, etc.
922 @item hls_key_info_file @var{key_info_file}
923 Use the information in @var{key_info_file} for segment encryption. The first
924 line of @var{key_info_file} specifies the key URI written to the playlist. The
925 key URL is used to access the encryption key during playback. The second line
926 specifies the path to the key file used to obtain the key during the encryption
927 process. The key file is read as a single packed array of 16 octets in binary
928 format. The optional third line specifies the initialization vector (IV) as a
929 hexadecimal string to be used instead of the segment sequence number (default)
930 for encryption. Changes to @var{key_info_file} will result in segment
931 encryption with the new key/IV and an entry in the playlist for the new key
932 URI/IV if @code{hls_flags periodic_rekey} is enabled.
934 Key info file format:
943 http://server/file.key
948 Example key file paths:
956 0123456789ABCDEF0123456789ABCDEF
959 Key info file example:
961 http://server/file.key
963 0123456789ABCDEF0123456789ABCDEF
966 Example shell script:
970 openssl rand 16 > file.key
971 echo $BASE_URL/file.key > file.keyinfo
972 echo file.key >> file.keyinfo
973 echo $(openssl rand -hex 16) >> file.keyinfo
974 ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
975 -hls_key_info_file file.keyinfo out.m3u8
978 @item -hls_enc @var{enc}
979 Enable (1) or disable (0) the AES128 encryption.
980 When enabled every segment generated is encrypted and the encryption key
981 is saved as @var{playlist name}.key.
983 @item -hls_enc_key @var{key}
984 16-octet key to encrypt the segments, by default it
985 is randomly generated.
987 @item -hls_enc_key_url @var{keyurl}
988 If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
991 @item -hls_enc_iv @var{iv}
992 16-octet initialization vector for every segment instead
993 of the autogenerated ones.
995 @item hls_segment_type @var{flags}
1000 Output segment files in MPEG-2 Transport Stream format. This is
1001 compatible with all HLS versions.
1004 Output segment files in fragmented MP4 format, similar to MPEG-DASH.
1005 fmp4 files may be used in HLS version 7 and above.
1009 @item hls_fmp4_init_filename @var{filename}
1010 Set filename to the fragment files header file, default filename is @file{init.mp4}.
1012 Use @code{-strftime 1} on @var{filename} to expand the segment filename with localtime.
1014 ffmpeg -i in.nut -hls_segment_type fmp4 -strftime 1 -hls_fmp4_init_filename "%s_init.mp4" out.m3u8
1016 This will produce init like this
1017 @file{1602678741_init.mp4}
1019 @item hls_fmp4_init_resend
1020 Resend init file after m3u8 file refresh every time, default is @var{0}.
1022 When @code{var_stream_map} is set with two or more variant streams, the
1023 @var{filename} pattern must contain the string "%v", this string specifies
1024 the position of variant stream index in the generated init file names.
1025 The string "%v" may be present in the filename or in the last directory name
1026 containing the file. If the string is present in the directory name, then
1027 sub-directories are created after expanding the directory name pattern. This
1028 enables creation of init files corresponding to different variant streams in
1031 @item hls_flags @var{flags}
1036 If this flag is set, the muxer will store all segments in a single MPEG-TS
1037 file, and will use byte ranges in the playlist. HLS playlists generated with
1038 this way will have the version number 4.
1041 ffmpeg -i in.nut -hls_flags single_file out.m3u8
1043 Will produce the playlist, @file{out.m3u8}, and a single segment file,
1046 @item delete_segments
1047 Segment files removed from the playlist are deleted after a period of time
1048 equal to the duration of the segment plus the duration of the playlist.
1051 Append new segments into the end of old segment list,
1052 and remove the @code{#EXT-X-ENDLIST} from the old segment list.
1054 @item round_durations
1055 Round the duration info in the playlist file segment info to integer
1056 values, instead of using floating point.
1059 Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
1060 first segment's information.
1063 Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
1065 @item periodic_rekey
1066 The file specified by @code{hls_key_info_file} will be checked periodically and
1067 detect updates to the encryption info. Be sure to replace this file atomically,
1068 including the file containing the AES encryption key.
1070 @item independent_segments
1071 Add the @code{#EXT-X-INDEPENDENT-SEGMENTS} to playlists that has video segments
1072 and when all the segments of that playlist are guaranteed to start with a Key frame.
1075 Add the @code{#EXT-X-I-FRAMES-ONLY} to playlists that has video segments
1076 and can play only I-frames in the @code{#EXT-X-BYTERANGE} mode.
1079 Allow segments to start on frames other than keyframes. This improves
1080 behavior on some players when the time between keyframes is inconsistent,
1081 but may make things worse on others, and can cause some oddities during
1082 seeking. This flag should be used with the @code{hls_time} option.
1084 @item program_date_time
1085 Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
1087 @item second_level_segment_index
1088 Makes it possible to use segment indexes as %%d in hls_segment_filename expression
1089 besides date/time values when strftime is on.
1090 To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width.
1092 @item second_level_segment_size
1093 Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename
1094 expression besides date/time values when strftime is on.
1095 To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width.
1097 @item second_level_segment_duration
1098 Makes it possible to use segment duration (calculated in microseconds) as %%t in hls_segment_filename
1099 expression besides date/time values when strftime is on.
1100 To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width.
1103 ffmpeg -i sample.mpeg \
1104 -f hls -hls_time 3 -hls_list_size 5 \
1105 -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
1106 -strftime 1 -strftime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
1108 This will produce segments like this:
1109 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
1112 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
1113 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
1114 before they have been added to the m3u8 playlist. This flag also affects how m3u8 playlist files are created.
1115 If this flag is set, all playlist files will written into temporary file and renamed after they are complete, similarly as segments are handled.
1116 But playlists with @code{file} protocol and with type (@code{hls_playlist_type}) other than @code{vod}
1117 are always written into temporary file regardless of this flag. Master playlist files (@code{master_pl_name}), if any, with @code{file} protocol,
1118 are always written into temporary file regardless of this flag if @code{master_pl_publish_rate} value is other than zero.
1122 @item hls_playlist_type event
1123 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
1124 @option{hls_list_size} to 0; the playlist can only be appended to.
1126 @item hls_playlist_type vod
1127 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
1128 @option{hls_list_size} to 0; the playlist must not change.
1131 Use the given HTTP method to create the hls files.
1133 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
1135 This example will upload all the mpegts segment files to the HTTP
1136 server using the HTTP PUT method, and update the m3u8 files every
1137 @code{refresh} times using the same method.
1138 Note that the HTTP server must support the given method for uploading
1141 @item http_user_agent
1142 Override User-Agent field in HTTP header. Applicable only for HTTP output.
1144 @item var_stream_map
1145 Map string which specifies how to group the audio, video and subtitle streams
1146 into different variant streams. The variant stream groups are separated
1148 Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are
1149 the keys to specify audio, video and subtitle streams respectively.
1150 Allowed values are 0 to 9 (limited just based on practical usage).
1152 When there are two or more variant streams, the output filename pattern must
1153 contain the string "%v", this string specifies the position of variant stream
1154 index in the output media playlist filenames. The string "%v" may be present in
1155 the filename or in the last directory name containing the file. If the string is
1156 present in the directory name, then sub-directories are created after expanding
1157 the directory name pattern. This enables creation of variant streams in
1161 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1162 -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
1163 http://example.com/live/out_%v.m3u8
1165 This example creates two hls variant streams. The first variant stream will
1166 contain video stream of bitrate 1000k and audio stream of bitrate 64k and the
1167 second variant stream will contain video stream of bitrate 256k and audio
1168 stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and
1169 out_1.m3u8 will be created. If you want something meaningful text instead of indexes
1170 in result names, you may specify names for each or some of the variants
1171 as in the following example.
1175 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1176 -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0,name:my_hd v:1,a:1,name:my_sd" \
1177 http://example.com/live/out_%v.m3u8
1180 This example creates two hls variant streams as in the previous one.
1181 But here, the two media playlist with file names out_my_hd.m3u8 and
1182 out_my_sd.m3u8 will be created.
1185 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
1186 -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
1187 http://example.com/live/out_%v.m3u8
1189 This example creates three hls variant streams. The first variant stream will
1190 be a video only stream with video bitrate 1000k, the second variant stream will
1191 be an audio only stream with bitrate 64k and the third variant stream will be a
1192 video only stream with bitrate 256k. Here, three media playlist with file names
1193 out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created.
1195 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1196 -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
1197 http://example.com/live/vs_%v/out.m3u8
1199 This example creates the variant streams in subdirectories. Here, the first
1200 media playlist is created at @file{http://example.com/live/vs_0/out.m3u8} and
1201 the second one at @file{http://example.com/live/vs_1/out.m3u8}.
1203 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k \
1204 -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
1205 -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
1206 -master_pl_name master.m3u8 \
1207 http://example.com/live/out_%v.m3u8
1209 This example creates two audio only and two video only variant streams. In
1210 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1211 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1212 and they are mapped to the two video only variant streams with audio group names
1213 'aud_low' and 'aud_high'.
1215 By default, a single hls variant containing all the encoded streams is created.
1218 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1219 -map 0:a -map 0:a -map 0:v -f hls \
1220 -var_stream_map "a:0,agroup:aud_low,default:yes a:1,agroup:aud_low v:0,agroup:aud_low" \
1221 -master_pl_name master.m3u8 \
1222 http://example.com/live/out_%v.m3u8
1224 This example creates two audio only and one video only variant streams. In
1225 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1226 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1227 and they are mapped to the one video only variant streams with audio group name
1228 'aud_low', and the audio group have default stat is NO or YES.
1230 By default, a single hls variant containing all the encoded streams is created.
1233 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1234 -map 0:a -map 0:a -map 0:v -f hls \
1235 -var_stream_map "a:0,agroup:aud_low,default:yes,language:ENG a:1,agroup:aud_low,language:CHN v:0,agroup:aud_low" \
1236 -master_pl_name master.m3u8 \
1237 http://example.com/live/out_%v.m3u8
1239 This example creates two audio only and one video only variant streams. In
1240 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1241 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1242 and they are mapped to the one video only variant streams with audio group name
1243 'aud_low', and the audio group have default stat is NO or YES, and one audio
1244 have and language is named ENG, the other audio language is named CHN.
1246 By default, a single hls variant containing all the encoded streams is created.
1249 ffmpeg -y -i input_with_subtitle.mkv \
1250 -b:v:0 5250k -c:v h264 -pix_fmt yuv420p -profile:v main -level 4.1 \
1252 -c:s webvtt -c:a mp2 -ar 48000 -ac 2 -map 0:v -map 0:a:0 -map 0:s:0 \
1253 -f hls -var_stream_map "v:0,a:0,s:0,sgroup:subtitle" \
1254 -master_pl_name master.m3u8 -t 300 -hls_time 10 -hls_init_time 4 -hls_list_size \
1255 10 -master_pl_publish_rate 10 -hls_flags \
1256 delete_segments+discont_start+split_by_time ./tmp/video.m3u8
1259 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=SUBTITLES} in
1260 the master playlist with webvtt subtitle group name 'subtitle'. Please make sure
1261 the input file has one text subtitle stream at least.
1264 Map string which specifies different closed captions groups and their
1265 attributes. The closed captions stream groups are separated by space.
1266 Expected string format is like this
1267 "ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....".
1268 'ccgroup' and 'instreamid' are mandatory attributes. 'language' is an optional
1270 The closed captions groups configured using this option are mapped to different
1271 variant streams by providing the same 'ccgroup' name in the
1272 @code{var_stream_map} string. If @code{var_stream_map} is not set, then the
1273 first available ccgroup in @code{cc_stream_map} is mapped to the output variant
1274 stream. The examples for these two use cases are given below.
1277 ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
1278 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
1279 -master_pl_name master.m3u8 \
1280 http://example.com/live/out.m3u8
1282 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=CLOSED-CAPTIONS} in
1283 the master playlist with group name 'cc', language 'en' (english) and
1284 INSTREAM-ID 'CC1'. Also, it adds @code{CLOSED-CAPTIONS} attribute with group
1285 name 'cc' for the output variant stream.
1287 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1288 -a53cc:0 1 -a53cc:1 1\
1289 -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
1290 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
1291 -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
1292 -master_pl_name master.m3u8 \
1293 http://example.com/live/out_%v.m3u8
1295 This example adds two @code{#EXT-X-MEDIA} tags with @code{TYPE=CLOSED-CAPTIONS} in
1296 the master playlist for the INSTREAM-IDs 'CC1' and 'CC2'. Also, it adds
1297 @code{CLOSED-CAPTIONS} attribute with group name 'cc' for the two output variant
1300 @item master_pl_name
1301 Create HLS master playlist with the given name.
1304 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
1306 This example creates HLS master playlist with name master.m3u8 and it is
1307 published at http://example.com/live/
1309 @item master_pl_publish_rate
1310 Publish master play list repeatedly every after specified number of segment intervals.
1313 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
1314 -hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
1317 This example creates HLS master playlist with name master.m3u8 and keep
1318 publishing it repeatedly every after 30 segments i.e. every after 60s.
1320 @item http_persistent
1321 Use persistent HTTP connections. Applicable only for HTTP output.
1324 Set timeout for socket I/O operations. Applicable only for HTTP output.
1326 @item -ignore_io_errors
1327 Ignore IO errors during open, write and delete. Useful for long-duration runs with network output.
1330 Set custom HTTP headers, can override built in default headers. Applicable only for HTTP output.
1339 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
1343 Size cannot exceed 256 pixels in any dimension
1346 Only BMP and PNG images can be stored
1349 If a BMP image is used, it must be one of the following pixel formats:
1351 BMP Bit Depth FFmpeg Pixel Format
1361 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
1364 If a PNG image is used, it must use the rgba pixel format
1372 The image file muxer writes video frames to image files.
1374 The output filenames are specified by a pattern, which can be used to
1375 produce sequentially numbered series of files.
1376 The pattern may contain the string "%d" or "%0@var{N}d", this string
1377 specifies the position of the characters representing a numbering in
1378 the filenames. If the form "%0@var{N}d" is used, the string
1379 representing the number in each filename is 0-padded to @var{N}
1380 digits. The literal character '%' can be specified in the pattern with
1383 If the pattern contains "%d" or "%0@var{N}d", the first filename of
1384 the file list specified will contain the number 1, all the following
1385 numbers will be sequential.
1387 The pattern may contain a suffix which is used to automatically
1388 determine the format of the image files to write.
1390 For example the pattern "img-%03d.bmp" will specify a sequence of
1391 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
1392 @file{img-010.bmp}, etc.
1393 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
1394 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
1397 The image muxer supports the .Y.U.V image file format. This format is
1398 special in that that each image frame consists of three files, for
1399 each of the YUV420P components. To read or write this image file format,
1400 specify the name of the '.Y' file. The muxer will automatically open the
1401 '.U' and '.V' files as required.
1407 If set to 1, expand the filename with pts from pkt->pts.
1411 Start the sequence from the specified number. Default value is 1.
1414 If set to 1, the filename will always be interpreted as just a
1415 filename, not a pattern, and the corresponding file will be continuously
1416 overwritten with new images. Default value is 0.
1419 If set to 1, expand the filename with date and time information from
1420 @code{strftime()}. Default value is 0.
1422 @item protocol_opts @var{options_list}
1423 Set protocol options as a :-separated list of key=value parameters. Values
1424 containing the @code{:} special character must be escaped.
1428 @subsection Examples
1430 The following example shows how to use @command{ffmpeg} for creating a
1431 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
1432 taking one image every second from the input video:
1434 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
1437 Note that with @command{ffmpeg}, if the format is not specified with the
1438 @code{-f} option and the output filename specifies an image file
1439 format, the image2 muxer is automatically selected, so the previous
1440 command can be written as:
1442 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
1445 Note also that the pattern must not necessarily contain "%d" or
1446 "%0@var{N}d", for example to create a single image file
1447 @file{img.jpeg} from the start of the input video you can employ the command:
1449 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
1452 The @option{strftime} option allows you to expand the filename with
1453 date and time information. Check the documentation of
1454 the @code{strftime()} function for the syntax.
1456 For example to generate image files from the @code{strftime()}
1457 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
1460 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
1463 You can set the file name with current frame's PTS:
1465 ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
1468 A more complex example is to publish contents of your desktop directly to a
1469 WebDAV server every second:
1471 ffmpeg -f x11grab -framerate 1 -i :0.0 -q:v 6 -update 1 -protocol_opts method=PUT http://example.com/desktop.jpg
1476 Matroska container muxer.
1478 This muxer implements the matroska and webm container specs.
1480 @subsection Metadata
1482 The recognized metadata settings in this muxer are:
1486 Set title name provided to a single track. This gets mapped to
1487 the FileDescription element for a stream written as attachment.
1490 Specify the language of the track in the Matroska languages form.
1492 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
1493 639-2/B) form (like "fre" for French), or a language code mixed with a
1494 country code for specialities in languages (like "fre-ca" for Canadian
1498 Set stereo 3D video layout of two views in a single video track.
1500 The following values are recognized:
1505 Both views are arranged side by side, Left-eye view is on the left
1507 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
1509 Both views are arranged in top-bottom orientation, Left-eye view is on top
1510 @item checkerboard_rl
1511 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
1512 @item checkerboard_lr
1513 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
1514 @item row_interleaved_rl
1515 Each view is constituted by a row based interleaving, Right-eye view is first row
1516 @item row_interleaved_lr
1517 Each view is constituted by a row based interleaving, Left-eye view is first row
1518 @item col_interleaved_rl
1519 Both views are arranged in a column based interleaving manner, Right-eye view is first column
1520 @item col_interleaved_lr
1521 Both views are arranged in a column based interleaving manner, Left-eye view is first column
1522 @item anaglyph_cyan_red
1523 All frames are in anaglyph format viewable through red-cyan filters
1525 Both views are arranged side by side, Right-eye view is on the left
1526 @item anaglyph_green_magenta
1527 All frames are in anaglyph format viewable through green-magenta filters
1529 Both eyes laced in one Block, Left-eye view is first
1531 Both eyes laced in one Block, Right-eye view is first
1535 For example a 3D WebM clip can be created using the following command line:
1537 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
1542 This muxer supports the following options:
1545 @item reserve_index_space
1546 By default, this muxer writes the index for seeking (called cues in Matroska
1547 terms) at the end of the file, because it cannot know in advance how much space
1548 to leave for the index at the beginning of the file. However for some use cases
1549 -- e.g. streaming where seeking is possible but slow -- it is useful to put the
1550 index at the beginning of the file.
1552 If this option is set to a non-zero value, the muxer will reserve a given amount
1553 of space in the file header and then try to write the cues there when the muxing
1554 finishes. If the reserved space does not suffice, no Cues will be written, the
1555 file will be finalized and writing the trailer will return an error.
1556 A safe size for most use cases should be about 50kB per hour of video.
1558 Note that cues are only written if the output is seekable and this option will
1559 have no effect if it is not.
1561 This option controls how the FlagDefault of the output tracks will be set.
1562 It influences which tracks players should play by default. The default mode
1566 In this mode, for each type of track (audio, video or subtitle), if there is
1567 a track with disposition default of this type, then the first such track
1568 (i.e. the one with the lowest index) will be marked as default; if no such
1569 track exists, the first track of this type will be marked as default instead
1570 (if existing). This ensures that the default flag is set in a sensible way even
1571 if the input originated from containers that lack the concept of default tracks.
1573 This mode is the same as infer except that if no subtitle track with
1574 disposition default exists, no subtitle track will be marked as default.
1576 In this mode the FlagDefault is set if and only if the AV_DISPOSITION_DEFAULT
1577 flag is set in the disposition of the corresponding stream.
1580 @item flipped_raw_rgb
1581 If set to true, store positive height for raw RGB bitmaps, which indicates
1582 bitmap is stored bottom-up. Note that this option does not flip the bitmap
1583 which has to be done manually beforehand, e.g. by using the vflip filter.
1584 Default is @var{false} and indicates bitmap is stored top down.
1593 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
1594 defaults to using the MD5 hash function.
1596 @subsection Examples
1598 To compute the MD5 hash of the input converted to raw
1599 audio and video, and store it in the file @file{out.md5}:
1601 ffmpeg -i INPUT -f md5 out.md5
1604 You can print the MD5 to stdout with the command:
1606 ffmpeg -i INPUT -f md5 -
1609 See also the @ref{hash} and @ref{framemd5} muxers.
1611 @section mov, mp4, ismv
1613 MOV/MP4/ISMV (Smooth Streaming) muxer.
1615 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
1616 file has all the metadata about all packets stored in one location
1617 (written at the end of the file, it can be moved to the start for
1618 better playback by adding @var{faststart} to the @var{movflags}, or
1619 using the @command{qt-faststart} tool). A fragmented
1620 file consists of a number of fragments, where packets and metadata
1621 about these packets are stored together. Writing a fragmented
1622 file has the advantage that the file is decodable even if the
1623 writing is interrupted (while a normal MOV/MP4 is undecodable if
1624 it is not properly finished), and it requires less memory when writing
1625 very long files (since writing normal MOV/MP4 files stores info about
1626 every single packet in memory until the file is closed). The downside
1627 is that it is less compatible with other applications.
1631 Fragmentation is enabled by setting one of the AVOptions that define
1632 how to cut the file into fragments:
1635 @item -moov_size @var{bytes}
1636 Reserves space for the moov atom at the beginning of the file instead of placing the
1637 moov atom at the end. If the space reserved is insufficient, muxing will fail.
1638 @item -movflags frag_keyframe
1639 Start a new fragment at each video keyframe.
1640 @item -frag_duration @var{duration}
1641 Create fragments that are @var{duration} microseconds long.
1642 @item -frag_size @var{size}
1643 Create fragments that contain up to @var{size} bytes of payload data.
1644 @item -movflags frag_custom
1645 Allow the caller to manually choose when to cut fragments, by
1646 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
1647 the packets written so far. (This is only useful with other
1648 applications integrating libavformat, not from @command{ffmpeg}.)
1649 @item -min_frag_duration @var{duration}
1650 Don't create fragments that are shorter than @var{duration} microseconds long.
1653 If more than one condition is specified, fragments are cut when
1654 one of the specified conditions is fulfilled. The exception to this is
1655 @code{-min_frag_duration}, which has to be fulfilled for any of the other
1656 conditions to apply.
1658 Additionally, the way the output file is written can be adjusted
1659 through a few other options:
1662 @item -movflags empty_moov
1663 Write an initial moov atom directly at the start of the file, without
1664 describing any samples in it. Generally, an mdat/moov pair is written
1665 at the start of the file, as a normal MOV/MP4 file, containing only
1666 a short portion of the file. With this option set, there is no initial
1667 mdat atom, and the moov atom only describes the tracks but has
1670 This option is implicitly set when writing ismv (Smooth Streaming) files.
1671 @item -movflags separate_moof
1672 Write a separate moof (movie fragment) atom for each track. Normally,
1673 packets for all tracks are written in a moof atom (which is slightly
1674 more efficient), but with this option set, the muxer writes one moof/mdat
1675 pair for each track, making it easier to separate tracks.
1677 This option is implicitly set when writing ismv (Smooth Streaming) files.
1678 @item -movflags skip_sidx
1679 Skip writing of sidx atom. When bitrate overhead due to sidx atom is high,
1680 this option could be used for cases where sidx atom is not mandatory.
1681 When global_sidx flag is enabled, this option will be ignored.
1682 @item -movflags faststart
1683 Run a second pass moving the index (moov atom) to the beginning of the file.
1684 This operation can take a while, and will not work in various situations such
1685 as fragmented output, thus it is not enabled by default.
1686 @item -movflags rtphint
1687 Add RTP hinting tracks to the output file.
1688 @item -movflags disable_chpl
1689 Disable Nero chapter markers (chpl atom). Normally, both Nero chapters
1690 and a QuickTime chapter track are written to the file. With this option
1691 set, only the QuickTime chapter track will be written. Nero chapters can
1692 cause failures when the file is reprocessed with certain tagging programs, like
1693 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1694 @item -movflags omit_tfhd_offset
1695 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1696 tying fragments to absolute byte positions in the file/streams.
1697 @item -movflags default_base_moof
1698 Similarly to the omit_tfhd_offset, this flag avoids writing the
1699 absolute base_data_offset field in tfhd atoms, but does so by using
1700 the new default-base-is-moof flag instead. This flag is new from
1701 14496-12:2012. This may make the fragments easier to parse in certain
1702 circumstances (avoiding basing track fragment location calculations
1703 on the implicit end of the previous track fragment).
1705 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1706 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1707 @item -movflags negative_cts_offsets
1708 Enables utilization of version 1 of the CTTS box, in which the CTS offsets can
1709 be negative. This enables the initial sample to have DTS/CTS of zero, and
1710 reduces the need for edit lists for some cases such as video tracks with
1711 B-frames. Additionally, eases conformance with the DASH-IF interoperability
1714 This option is implicitly set when writing ismv (Smooth Streaming) files.
1716 Write producer time reference box (PRFT) with a specified time source for the
1717 NTP field in the PRFT box. Set value as @samp{wallclock} to specify timesource
1718 as wallclock time and @samp{pts} to specify timesource as input packets' PTS
1721 Setting value to @samp{pts} is applicable only for a live encoding use case,
1722 where PTS values are set as as wallclock time at the source. For example, an
1723 encoding use case with decklink capture source where @option{video_pts} and
1724 @option{audio_pts} are set to @samp{abs_wallclock}.
1729 Smooth Streaming content can be pushed in real time to a publishing
1730 point on IIS with this muxer. Example:
1732 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1737 The MP3 muxer writes a raw MP3 stream with the following optional features:
1740 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1741 2.4 are supported, the @code{id3v2_version} private option controls which one is
1742 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1745 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1746 The pictures are supplied to the muxer in form of a video stream with a single
1747 packet. There can be any number of those streams, each will correspond to a
1748 single APIC frame. The stream metadata tags @var{title} and @var{comment} map
1749 to APIC @var{description} and @var{picture type} respectively. See
1750 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1752 Note that the APIC frames must be written at the beginning, so the muxer will
1753 buffer the audio frames until it gets all the pictures. It is therefore advised
1754 to provide the pictures as soon as possible to avoid excessive buffering.
1757 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1758 default, but will be written only if the output is seekable. The
1759 @code{write_xing} private option can be used to disable it. The frame contains
1760 various information that may be useful to the decoder, like the audio duration
1764 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1765 enabled with the @code{write_id3v1} private option, but as its capabilities are
1766 very limited, its usage is not recommended.
1771 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1773 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1776 To attach a picture to an mp3 file select both the audio and the picture stream
1779 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1780 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1783 Write a "clean" MP3 without any extra features:
1785 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1790 MPEG transport stream muxer.
1792 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1794 The recognized metadata settings in mpegts muxer are @code{service_provider}
1795 and @code{service_name}. If they are not set the default for
1796 @code{service_provider} is @samp{FFmpeg} and the default for
1797 @code{service_name} is @samp{Service01}.
1801 The muxer options are:
1804 @item mpegts_transport_stream_id @var{integer}
1805 Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1806 Default is @code{0x0001}.
1808 @item mpegts_original_network_id @var{integer}
1809 Set the @samp{original_network_id}. This is unique identifier of a
1810 network in DVB. Its main use is in the unique identification of a service
1811 through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1814 @item mpegts_service_id @var{integer}
1815 Set the @samp{service_id}, also known as program in DVB. Default is
1818 @item mpegts_service_type @var{integer}
1819 Set the program @samp{service_type}. Default is @code{digital_tv}.
1820 Accepts the following options:
1823 Any hexadecimal value between @code{0x01} and @code{0xff} as defined in
1828 Digital Radio service.
1831 @item advanced_codec_digital_radio
1832 Advanced Codec Digital Radio service.
1833 @item mpeg2_digital_hdtv
1834 MPEG2 Digital HDTV service.
1835 @item advanced_codec_digital_sdtv
1836 Advanced Codec Digital SDTV service.
1837 @item advanced_codec_digital_hdtv
1838 Advanced Codec Digital HDTV service.
1841 @item mpegts_pmt_start_pid @var{integer}
1842 Set the first PID for PMTs. Default is @code{0x1000}, minimum is @code{0x0020},
1843 maximum is @code{0x1ffa}. This option has no effect in m2ts mode where the PMT
1844 PID is fixed @code{0x0100}.
1846 @item mpegts_start_pid @var{integer}
1847 Set the first PID for elementary streams. Default is @code{0x0100}, minimum is
1848 @code{0x0020}, maximum is @code{0x1ffa}. This option has no effect in m2ts mode
1849 where the elementary stream PIDs are fixed.
1851 @item mpegts_m2ts_mode @var{boolean}
1852 Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1855 @item muxrate @var{integer}
1856 Set a constant muxrate. Default is VBR.
1858 @item pes_payload_size @var{integer}
1859 Set minimum PES packet payload in bytes. Default is @code{2930}.
1861 @item mpegts_flags @var{flags}
1862 Set mpegts flags. Accepts the following options:
1864 @item resend_headers
1865 Reemit PAT/PMT before writing the next packet.
1867 Use LATM packetization for AAC.
1868 @item pat_pmt_at_frames
1869 Reemit PAT and PMT at each video frame.
1871 Conform to System B (DVB) instead of System A (ATSC).
1872 @item initial_discontinuity
1873 Mark the initial packet of each stream as discontinuity.
1876 @item mpegts_copyts @var{boolean}
1877 Preserve original timestamps, if value is set to @code{1}. Default value
1878 is @code{-1}, which results in shifting timestamps so that they start from 0.
1880 @item omit_video_pes_length @var{boolean}
1881 Omit the PES packet length for video packets. Default is @code{1} (true).
1883 @item pcr_period @var{integer}
1884 Override the default PCR retransmission time in milliseconds. Default is
1885 @code{-1} which means that the PCR interval will be determined automatically:
1886 20 ms is used for CBR streams, the highest multiple of the frame duration which
1887 is less than 100 ms is used for VBR streams.
1889 @item pat_period @var{duration}
1890 Maximum time in seconds between PAT/PMT tables. Default is @code{0.1}.
1892 @item sdt_period @var{duration}
1893 Maximum time in seconds between SDT tables. Default is @code{0.5}.
1895 @item tables_version @var{integer}
1896 Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1897 This option allows updating stream structure so that standard consumer may
1898 detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1899 usage) or restart @command{ffmpeg} instance, cyclically changing
1900 @option{tables_version} value:
1903 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1904 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1906 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1907 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1908 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1916 ffmpeg -i file.mpg -c copy \
1917 -mpegts_original_network_id 0x1122 \
1918 -mpegts_transport_stream_id 0x3344 \
1919 -mpegts_service_id 0x5566 \
1920 -mpegts_pmt_start_pid 0x1500 \
1921 -mpegts_start_pid 0x150 \
1922 -metadata service_provider="Some provider" \
1923 -metadata service_name="Some Channel" \
1927 @section mxf, mxf_d10, mxf_opatom
1933 The muxer options are:
1936 @item store_user_comments @var{bool}
1937 Set if user comments should be stored if available or never.
1938 IRT D-10 does not allow user comments. The default is thus to write them for
1939 mxf and mxf_opatom but not for mxf_d10
1946 This muxer does not generate any output file, it is mainly useful for
1947 testing or benchmarking purposes.
1949 For example to benchmark decoding with @command{ffmpeg} you can use the
1952 ffmpeg -benchmark -i INPUT -f null out.null
1955 Note that the above command does not read or write the @file{out.null}
1956 file, but specifying the output file is required by the @command{ffmpeg}
1959 Alternatively you can write the command as:
1961 ffmpeg -benchmark -i INPUT -f null -
1967 @item -syncpoints @var{flags}
1968 Change the syncpoint usage in nut:
1970 @item @var{default} use the normal low-overhead seeking aids.
1971 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1972 Use of this option is not recommended, as the resulting files are very damage
1973 sensitive and seeking is not possible. Also in general the overhead from
1974 syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1975 all growing data tables, allowing to mux endless streams with limited memory
1976 and without these disadvantages.
1977 @item @var{timestamped} extend the syncpoint with a wallclock field.
1979 The @var{none} and @var{timestamped} flags are experimental.
1980 @item -write_index @var{bool}
1981 Write index at the end, the default is to write an index.
1985 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
1990 Ogg container muxer.
1993 @item -page_duration @var{duration}
1994 Preferred page duration, in microseconds. The muxer will attempt to create
1995 pages that are approximately @var{duration} microseconds long. This allows the
1996 user to compromise between seek granularity and container overhead. The default
1997 is 1 second. A value of 0 will fill all segments, making pages as large as
1998 possible. A value of 1 will effectively use 1 packet-per-page in most
1999 situations, giving a small seek granularity at the cost of additional container
2001 @item -serial_offset @var{value}
2002 Serial value from which to set the streams serial number.
2003 Setting it to different and sufficiently large values ensures that the produced
2004 ogg files can be safely chained.
2011 Raw muxers accept a single stream matching the designated codec. They do not store timestamps or metadata.
2012 The recognized extension is the same as the muxer name unless indicated otherwise.
2016 Dolby Digital, also known as AC-3, audio.
2020 CRI Middleware ADX audio.
2022 This muxer will write out the total sample count near the start of the first packet
2023 when the output is seekable and the count can be stored in 32 bits.
2027 aptX (Audio Processing Technology for Bluetooth) audio.
2031 aptX HD (Audio Processing Technology for Bluetooth) audio.
2037 AVS2-P2/IEEE1857.4 video.
2039 Extensions: avs, avs2
2041 @subsection cavsvideo
2043 Chinese AVS (Audio Video Standard) video.
2047 @subsection codec2raw
2051 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f codec2raw}.
2055 Data muxer accepts a single stream with any codec of any type.
2056 The input stream has to be selected using the @code{-map} option with the ffmpeg CLI tool.
2058 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f data}.
2062 BBC Dirac video. The Dirac Pro codec is a subset and is standardized as SMPTE VC-2.
2064 Extensions: drc, vc2
2068 Avid DNxHD video. It is standardized as SMPTE VC-3. Accepts DNxHR streams.
2070 Extensions: dnxhd, dnxhr
2074 DTS Coherent Acoustics (DCA) audio.
2078 Dolby Digital Plus, also known as Enhanced AC-3, audio.
2086 ITU-T G.723.1 audio.
2088 Extensions: tco, rco
2092 ITU-T G.726 big-endian ("left-justified") audio.
2094 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726}.
2098 ITU-T G.726 little-endian ("right-justified") audio.
2100 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726le}.
2104 Global System for Mobile Communications audio.
2112 ITU-T H.263 / H.263-1996, H.263+ / H.263-1998 / H.263 version 2 video.
2116 ITU-T H.264 / MPEG-4 Part 10 AVC video. Bitstream shall be converted to Annex B syntax if it's in length-prefixed mode.
2118 Extensions: h264, 264
2122 ITU-T H.265 / MPEG-H Part 2 HEVC video. Bitstream shall be converted to Annex B syntax if it's in length-prefixed mode.
2124 Extensions: hevc, h265, 265
2128 MPEG-4 Part 2 video.
2134 Extensions: mjpg, mjpeg
2138 Meridian Lossless Packing, also known as Packed PCM, audio.
2142 MPEG-1 Audio Layer II audio.
2144 Extensions: mp2, m2a, mpa
2146 @subsection mpeg1video
2148 MPEG-1 Part 2 video.
2150 Extensions: mpg, mpeg, m1v
2152 @subsection mpeg2video
2154 ITU-T H.262 / MPEG-2 Part 2 video.
2158 @subsection rawvideo
2160 Raw uncompressed video.
2162 Extensions: yuv, rgb
2166 Bluetooth SIG low-complexity subband codec audio.
2168 Extensions: sbc, msbc
2178 SMPTE 421M / VC-1 video.
2181 @section segment, stream_segment, ssegment
2183 Basic stream segmenter.
2185 This muxer outputs streams to a number of separate files of nearly
2186 fixed duration. Output filename pattern can be set in a fashion
2187 similar to @ref{image2}, or by using a @code{strftime} template if
2188 the @option{strftime} option is enabled.
2190 @code{stream_segment} is a variant of the muxer used to write to
2191 streaming output formats, i.e. which do not require global headers,
2192 and is recommended for outputting e.g. to MPEG transport stream segments.
2193 @code{ssegment} is a shorter alias for @code{stream_segment}.
2195 Every segment starts with a keyframe of the selected reference stream,
2196 which is set through the @option{reference_stream} option.
2198 Note that if you want accurate splitting for a video file, you need to
2199 make the input key frames correspond to the exact splitting times
2200 expected by the segmenter, or the segment muxer will start the new
2201 segment with the key frame found next after the specified start
2204 The segment muxer works best with a single constant frame rate video.
2206 Optionally it can generate a list of the created segments, by setting
2207 the option @var{segment_list}. The list type is specified by the
2208 @var{segment_list_type} option. The entry filenames in the segment
2209 list are set by default to the basename of the corresponding segment
2212 See also the @ref{hls} muxer, which provides a more specific
2213 implementation for HLS segmentation.
2217 The segment muxer supports the following options:
2220 @item increment_tc @var{1|0}
2221 if set to @code{1}, increment timecode between each segment
2222 If this is selected, the input need to have
2223 a timecode in the first video stream. Default value is
2226 @item reference_stream @var{specifier}
2227 Set the reference stream, as specified by the string @var{specifier}.
2228 If @var{specifier} is set to @code{auto}, the reference is chosen
2229 automatically. Otherwise it must be a stream specifier (see the ``Stream
2230 specifiers'' chapter in the ffmpeg manual) which specifies the
2231 reference stream. The default value is @code{auto}.
2233 @item segment_format @var{format}
2234 Override the inner container format, by default it is guessed by the filename
2237 @item segment_format_options @var{options_list}
2238 Set output format options using a :-separated list of key=value
2239 parameters. Values containing the @code{:} special character must be
2242 @item segment_list @var{name}
2243 Generate also a listfile named @var{name}. If not specified no
2244 listfile is generated.
2246 @item segment_list_flags @var{flags}
2247 Set flags affecting the segment list generation.
2249 It currently supports the following flags:
2252 Allow caching (only affects M3U8 list files).
2255 Allow live-friendly file generation.
2258 @item segment_list_size @var{size}
2259 Update the list file so that it contains at most @var{size}
2260 segments. If 0 the list file will contain all the segments. Default
2263 @item segment_list_entry_prefix @var{prefix}
2264 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
2265 By default no prefix is applied.
2267 @item segment_list_type @var{type}
2268 Select the listing format.
2270 The following values are recognized:
2273 Generate a flat list for the created segments, one segment per line.
2276 Generate a list for the created segments, one segment per line,
2277 each line matching the format (comma-separated values):
2279 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
2282 @var{segment_filename} is the name of the output file generated by the
2283 muxer according to the provided pattern. CSV escaping (according to
2284 RFC4180) is applied if required.
2286 @var{segment_start_time} and @var{segment_end_time} specify
2287 the segment start and end time expressed in seconds.
2289 A list file with the suffix @code{".csv"} or @code{".ext"} will
2290 auto-select this format.
2292 @samp{ext} is deprecated in favor or @samp{csv}.
2295 Generate an ffconcat file for the created segments. The resulting file
2296 can be read using the FFmpeg @ref{concat} demuxer.
2298 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
2299 auto-select this format.
2302 Generate an extended M3U8 file, version 3, compliant with
2303 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
2305 A list file with the suffix @code{".m3u8"} will auto-select this format.
2308 If not specified the type is guessed from the list file name suffix.
2310 @item segment_time @var{time}
2311 Set segment duration to @var{time}, the value must be a duration
2312 specification. Default value is "2". See also the
2313 @option{segment_times} option.
2315 Note that splitting may not be accurate, unless you force the
2316 reference stream key-frames at the given time. See the introductory
2317 notice and the examples below.
2319 @item segment_atclocktime @var{1|0}
2320 If set to "1" split at regular clock time intervals starting from 00:00
2321 o'clock. The @var{time} value specified in @option{segment_time} is
2322 used for setting the length of the splitting interval.
2324 For example with @option{segment_time} set to "900" this makes it possible
2325 to create files at 12:00 o'clock, 12:15, 12:30, etc.
2327 Default value is "0".
2329 @item segment_clocktime_offset @var{duration}
2330 Delay the segment splitting times with the specified duration when using
2331 @option{segment_atclocktime}.
2333 For example with @option{segment_time} set to "900" and
2334 @option{segment_clocktime_offset} set to "300" this makes it possible to
2335 create files at 12:05, 12:20, 12:35, etc.
2337 Default value is "0".
2339 @item segment_clocktime_wrap_duration @var{duration}
2340 Force the segmenter to only start a new segment if a packet reaches the muxer
2341 within the specified duration after the segmenting clock time. This way you
2342 can make the segmenter more resilient to backward local time jumps, such as
2343 leap seconds or transition to standard time from daylight savings time.
2345 Default is the maximum possible duration which means starting a new segment
2346 regardless of the elapsed time since the last clock time.
2348 @item segment_time_delta @var{delta}
2349 Specify the accuracy time when selecting the start time for a
2350 segment, expressed as a duration specification. Default value is "0".
2352 When delta is specified a key-frame will start a new segment if its
2353 PTS satisfies the relation:
2355 PTS >= start_time - time_delta
2358 This option is useful when splitting video content, which is always
2359 split at GOP boundaries, in case a key frame is found just before the
2360 specified split time.
2362 In particular may be used in combination with the @file{ffmpeg} option
2363 @var{force_key_frames}. The key frame times specified by
2364 @var{force_key_frames} may not be set accurately because of rounding
2365 issues, with the consequence that a key frame time may result set just
2366 before the specified time. For constant frame rate videos a value of
2367 1/(2*@var{frame_rate}) should address the worst case mismatch between
2368 the specified time and the time set by @var{force_key_frames}.
2370 @item segment_times @var{times}
2371 Specify a list of split points. @var{times} contains a list of comma
2372 separated duration specifications, in increasing order. See also
2373 the @option{segment_time} option.
2375 @item segment_frames @var{frames}
2376 Specify a list of split video frame numbers. @var{frames} contains a
2377 list of comma separated integer numbers, in increasing order.
2379 This option specifies to start a new segment whenever a reference
2380 stream key frame is found and the sequential number (starting from 0)
2381 of the frame is greater or equal to the next value in the list.
2383 @item segment_wrap @var{limit}
2384 Wrap around segment index once it reaches @var{limit}.
2386 @item segment_start_number @var{number}
2387 Set the sequence number of the first segment. Defaults to @code{0}.
2389 @item strftime @var{1|0}
2390 Use the @code{strftime} function to define the name of the new
2391 segments to write. If this is selected, the output segment name must
2392 contain a @code{strftime} function template. Default value is
2395 @item break_non_keyframes @var{1|0}
2396 If enabled, allow segments to start on frames other than keyframes. This
2397 improves behavior on some players when the time between keyframes is
2398 inconsistent, but may make things worse on others, and can cause some oddities
2399 during seeking. Defaults to @code{0}.
2401 @item reset_timestamps @var{1|0}
2402 Reset timestamps at the beginning of each segment, so that each segment
2403 will start with near-zero timestamps. It is meant to ease the playback
2404 of the generated segments. May not work with some combinations of
2405 muxers/codecs. It is set to @code{0} by default.
2407 @item initial_offset @var{offset}
2408 Specify timestamp offset to apply to the output packet timestamps. The
2409 argument must be a time duration specification, and defaults to 0.
2411 @item write_empty_segments @var{1|0}
2412 If enabled, write an empty segment if there are no packets during the period a
2413 segment would usually span. Otherwise, the segment will be filled with the next
2414 packet written. Defaults to @code{0}.
2417 Make sure to require a closed GOP when encoding and to set the GOP
2418 size to fit your segment time constraint.
2420 @subsection Examples
2424 Remux the content of file @file{in.mkv} to a list of segments
2425 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
2426 generated segments to @file{out.list}:
2428 ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
2432 Segment input and set output format options for the output segments:
2434 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
2438 Segment the input file according to the split points specified by the
2439 @var{segment_times} option:
2441 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
2445 Use the @command{ffmpeg} @option{force_key_frames}
2446 option to force key frames in the input at the specified location, together
2447 with the segment option @option{segment_time_delta} to account for
2448 possible roundings operated when setting key frame times.
2450 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
2451 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
2453 In order to force key frames on the input file, transcoding is
2457 Segment the input file by splitting the input file according to the
2458 frame numbers sequence specified with the @option{segment_frames} option:
2460 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
2464 Convert the @file{in.mkv} to TS segments using the @code{libx264}
2465 and @code{aac} encoders:
2467 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
2471 Segment the input file, and create an M3U8 live playlist (can be used
2472 as live HLS source):
2474 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
2475 -segment_list_flags +live -segment_time 10 out%03d.mkv
2479 @section smoothstreaming
2481 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
2485 Specify the number of fragments kept in the manifest. Default 0 (keep all).
2487 @item extra_window_size
2488 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
2490 @item lookahead_count
2491 Specify the number of lookahead fragments. Default 2.
2493 @item min_frag_duration
2494 Specify the minimum fragment duration (in microseconds). Default 5000000.
2496 @item remove_at_exit
2497 Specify whether to remove all fragments when finished. Default 0 (do not remove).
2504 Per stream hash testing format.
2506 This muxer computes and prints a cryptographic hash of all the input frames,
2507 on a per-stream basis. This can be used for equality checks without having
2508 to do a complete binary comparison.
2510 By default audio frames are converted to signed 16-bit raw audio and
2511 video frames to raw video before computing the hash, but the output
2512 of explicit conversions to other codecs can also be used. Timestamps
2513 are ignored. It uses the SHA-256 cryptographic hash function by default,
2514 but supports several other algorithms.
2516 The output of the muxer consists of one line per stream of the form:
2517 @var{streamindex},@var{streamtype},@var{algo}=@var{hash}, where
2518 @var{streamindex} is the index of the mapped stream, @var{streamtype} is a
2519 single character indicating the type of stream, @var{algo} is a short string
2520 representing the hash function used, and @var{hash} is a hexadecimal number
2521 representing the computed hash.
2524 @item hash @var{algorithm}
2525 Use the cryptographic hash function specified by the string @var{algorithm}.
2526 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
2527 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
2528 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
2529 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
2533 @subsection Examples
2535 To compute the SHA-256 hash of the input converted to raw audio and
2536 video, and store it in the file @file{out.sha256}:
2538 ffmpeg -i INPUT -f streamhash out.sha256
2541 To print an MD5 hash to stdout use the command:
2543 ffmpeg -i INPUT -f streamhash -hash md5 -
2546 See also the @ref{hash} and @ref{framehash} muxers.
2551 The tee muxer can be used to write the same data to several outputs, such as files or streams.
2552 It can be used, for example, to stream a video over a network and save it to disk at the same time.
2554 It is different from specifying several outputs to the @command{ffmpeg}
2555 command-line tool. With the tee muxer, the audio and video data will be encoded only once.
2556 With conventional multiple outputs, multiple encoding operations in parallel are initiated,
2557 which can be a very expensive process. The tee muxer is not useful when using the libavformat API
2558 directly because it is then possible to feed the same packets to several muxers directly.
2560 Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select
2561 output streams. So all streams intended for output must be specified using @code{-map}. See
2564 Some encoders may need different options depending on the output format;
2565 the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified.
2566 The main example is the @option{global_header} flag.
2568 The slave outputs are specified in the file name given to the muxer,
2569 separated by '|'. If any of the slave name contains the '|' separator,
2570 leading or trailing spaces or any special character, those must be
2571 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
2572 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
2578 @item use_fifo @var{bool}
2579 If set to 1, slave outputs will be processed in separate threads using the @ref{fifo}
2580 muxer. This allows to compensate for different speed/latency/reliability of
2581 outputs and setup transparent recovery. By default this feature is turned off.
2584 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
2588 Muxer options can be specified for each slave by prepending them as a list of
2589 @var{key}=@var{value} pairs separated by ':', between square brackets. If
2590 the options values contain a special character or the ':' separator, they
2591 must be escaped; note that this is a second level escaping.
2593 The following special options are also recognized:
2596 Specify the format name. Required if it cannot be guessed from the
2599 @item bsfs[/@var{spec}]
2600 Specify a list of bitstream filters to apply to the specified
2603 It is possible to specify to which streams a given bitstream filter
2604 applies, by appending a stream specifier to the option separated by
2605 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
2606 stream specifiers}).
2608 If the stream specifier is not specified, the bitstream filters will be
2609 applied to all streams in the output. This will cause that output operation
2610 to fail if the output contains streams to which the bitstream filter cannot
2611 be applied e.g. @code{h264_mp4toannexb} being applied to an output containing an audio stream.
2613 Options for a bitstream filter must be specified in the form of @code{opt=value}.
2615 Several bitstream filters can be specified, separated by ",".
2617 @item use_fifo @var{bool}
2618 This allows to override tee muxer use_fifo option for individual slave muxer.
2621 This allows to override tee muxer fifo_options for individual slave muxer.
2625 Select the streams that should be mapped to the slave output,
2626 specified by a stream specifier. If not specified, this defaults to
2627 all the mapped streams. This will cause that output operation to fail
2628 if the output format does not accept all mapped streams.
2630 You may use multiple stream specifiers separated by commas (@code{,}) e.g.: @code{a:0,v}
2633 Specify behaviour on output failure. This can be set to either @code{abort} (which is
2634 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
2635 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
2636 will continue without being affected.
2639 @subsection Examples
2643 Encode something and both archive it in a WebM file and stream it
2644 as MPEG-TS over UDP:
2646 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2647 "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2651 As above, but continue streaming even if output to local file fails
2652 (for example local drive fills up):
2654 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2655 "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2659 Use @command{ffmpeg} to encode the input, and send the output
2660 to three different destinations. The @code{dump_extra} bitstream
2661 filter is used to add extradata information to all the output video
2662 keyframes packets, as requested by the MPEG-TS format. The select
2663 option is applied to @file{out.aac} in order to make it contain only
2666 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2667 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
2671 As above, but select only stream @code{a:1} for the audio output. Note
2672 that a second level escaping must be performed, as ":" is a special
2673 character used to separate options.
2675 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2676 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
2682 WebM Live Chunk Muxer.
2684 This muxer writes out WebM headers and chunks as separate files which can be
2685 consumed by clients that support WebM Live streams via DASH.
2689 This muxer supports the following options:
2692 @item chunk_start_index
2693 Index of the first chunk (defaults to 0).
2696 Filename of the header where the initialization data will be written.
2698 @item audio_chunk_duration
2699 Duration of each audio chunk in milliseconds (defaults to 5000).
2704 ffmpeg -f v4l2 -i /dev/video0 \
2708 -s 640x360 -keyint_min 30 -g 30 \
2710 -header webm_live_video_360.hdr \
2711 -chunk_start_index 1 \
2712 webm_live_video_360_%d.chk \
2717 -header webm_live_audio_128.hdr \
2718 -chunk_start_index 1 \
2719 -audio_chunk_duration 1000 \
2720 webm_live_audio_128_%d.chk
2723 @section webm_dash_manifest
2725 WebM DASH Manifest muxer.
2727 This muxer implements the WebM DASH Manifest specification to generate the DASH
2728 manifest XML. It also supports manifest generation for DASH live streams.
2730 For more information see:
2734 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
2736 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
2741 This muxer supports the following options:
2744 @item adaptation_sets
2745 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
2746 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
2747 audio and video streams. Any number of adaptation sets can be added using this option.
2750 Set this to 1 to create a live stream DASH Manifest. Default: 0.
2752 @item chunk_start_index
2753 Start index of the first chunk. This will go in the @samp{startNumber} attribute
2754 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
2756 @item chunk_duration_ms
2757 Duration of each chunk in milliseconds. This will go in the @samp{duration}
2758 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
2760 @item utc_timing_url
2761 URL of the page that will return the UTC timestamp in ISO format. This will go
2762 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
2765 @item time_shift_buffer_depth
2766 Smallest time (in seconds) shifting buffer for which any Representation is
2767 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
2768 attribute of the @samp{MPD} element. Default: 60.
2770 @item minimum_update_period
2771 Minimum update period (in seconds) of the manifest. This will go in the
2772 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
2778 ffmpeg -f webm_dash_manifest -i video1.webm \
2779 -f webm_dash_manifest -i video2.webm \
2780 -f webm_dash_manifest -i audio1.webm \
2781 -f webm_dash_manifest -i audio2.webm \
2782 -map 0 -map 1 -map 2 -map 3 \
2784 -f webm_dash_manifest \
2785 -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \