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 min_seg_duration @var{microseconds}
268 This is a deprecated option to set the segment length in microseconds, use @var{seg_duration} instead.
269 @item seg_duration @var{duration}
270 Set the segment length in seconds (fractional value can be set). The value is
271 treated as average segment duration when @var{use_template} is enabled and
272 @var{use_timeline} is disabled and as minimum segment duration for all the other
274 @item frag_duration @var{duration}
275 Set the length in seconds of fragments within segments (fractional value can be set).
276 @item frag_type @var{type}
277 Set the type of interval for fragmentation.
278 @item window_size @var{size}
279 Set the maximum number of segments kept in the manifest.
280 @item extra_window_size @var{size}
281 Set the maximum number of segments kept outside of the manifest before removing from disk.
282 @item remove_at_exit @var{remove}
283 Enable (1) or disable (0) removal of all segments when finished.
284 @item use_template @var{template}
285 Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList.
286 @item use_timeline @var{timeline}
287 Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate.
288 @item single_file @var{single_file}
289 Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges.
290 @item single_file_name @var{file_name}
291 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.
292 @item init_seg_name @var{init_name}
293 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.
294 @item media_seg_name @var{segment_name}
295 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.
296 @item utc_timing_url @var{utc_url}
297 URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso"
298 @item method @var{method}
299 Use the given HTTP method to create output files. Generally set to PUT or POST.
300 @item http_user_agent @var{user_agent}
301 Override User-Agent field in HTTP header. Applicable only for HTTP output.
302 @item http_persistent @var{http_persistent}
303 Use persistent HTTP connections. Applicable only for HTTP output.
304 @item hls_playlist @var{hls_playlist}
305 Generate HLS playlist files as well. The master playlist is generated with the filename @var{hls_master_name}.
306 One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc.
307 @item hls_master_name @var{file_name}
308 HLS master playlist name. Default is "master.m3u8".
309 @item streaming @var{streaming}
310 Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming
311 mode, each frame will be a moof fragment which forms a chunk.
312 @item adaptation_sets @var{adaptation_sets}
313 Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs
314 of the adaptation sets and a,b,c,d and e are the indices of the mapped streams.
316 To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs.
318 When no assignment is defined, this defaults to an AdaptationSet for each stream.
320 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,
321 descriptor is useful to the scheme defined by ISO/IEC 23009-1:2014/Amd.2:2015.
322 For example, -adaptation_sets "id=0,descriptor=<SupplementalProperty schemeIdUri=\"urn:mpeg:dash:srd:2014\" value=\"0,0,0,1,1,2,2\"/>,streams=v".
323 Please note that descriptor string should be a self-closing xml tag.
324 seg_duration, frag_duration and frag_type override the global option values for each adaptation set.
325 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"
326 type_id marks an adaptation set as containing streams meant to be used for Trick Mode for the referenced adaptation set.
327 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"
328 @item timeout @var{timeout}
329 Set timeout for socket I/O operations. Applicable only for HTTP output.
330 @item index_correction @var{index_correction}
331 Enable (1) or Disable (0) segment index correction logic. Applicable only when
332 @var{use_template} is enabled and @var{use_timeline} is disabled.
334 When enabled, the logic monitors the flow of segment indexes. If a streams's
335 segment index value is not at the expected real time position, then the logic
336 corrects that index value.
338 Typically this logic is needed in live streaming use cases. The network bandwidth
339 fluctuations are common during long run streaming. Each fluctuation can cause
340 the segment indexes fall behind the expected real time position.
341 @item format_options @var{options_list}
342 Set container format (mp4/webm) options using a @code{:} separated list of
343 key=value parameters. Values containing @code{:} special characters must be
346 @item global_sidx @var{global_sidx}
347 Write global SIDX atom. Applicable only for single file, mp4 output, non-streaming mode.
349 @item dash_segment_type @var{dash_segment_type}
353 If this flag is set, the dash segment files format will be selected based on the stream codec. This is the default mode.
356 If this flag is set, the dash segment files will be in in ISOBMFF format.
359 If this flag is set, the dash segment files will be in in WebM format.
362 @item ignore_io_errors @var{ignore_io_errors}
363 Ignore IO errors during open and write. Useful for long-duration runs with network output.
365 @item lhls @var{lhls}
366 Enable Low-latency HLS(LHLS). Adds #EXT-X-PREFETCH tag with current segment's URI.
367 Apple doesn't have an official spec for LHLS. Meanwhile hls.js player folks are
368 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
369 This option will also try to comply with the above open spec, till Apple's spec officially supports it.
370 Applicable only when @var{streaming} and @var{hls_playlist} options are enabled.
371 This is an experimental feature.
373 @item ldash @var{ldash}
374 Enable Low-latency Dash by constraining the presence and values of some elements.
376 @item master_m3u8_publish_rate @var{master_m3u8_publish_rate}
377 Publish master playlist repeatedly every after specified number of segment intervals.
379 @item write_prft @var{write_prft}
380 Write Producer Reference Time elements on supported streams. This also enables writing
381 prft boxes in the underlying muxer. Applicable only when the @var{utc_url} option is enabled.
382 It's set to auto by default, in which case the muxer will attempt to enable it only in modes
385 @item mpd_profile @var{mpd_profile}
386 Set one or more manifest profiles.
388 @item http_opts @var{http_opts}
389 A :-separated list of key=value options to pass to the underlying HTTP
390 protocol. Applicable only for HTTP output.
392 @item target_latency @var{target_latency}
393 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.
394 This is an informative fields clients can use to measure the latency of the service.
396 @item min_playback_rate @var{min_playback_rate}
397 Set the minimum playback rate indicated as appropriate for the purposes of automatically
398 adjusting playback latency and buffer occupancy during normal playback by clients.
400 @item max_playback_rate @var{max_playback_rate}
401 Set the maximum playback rate indicated as appropriate for the purposes of automatically
402 adjusting playback latency and buffer occupancy during normal playback by clients.
404 @item update_period @var{update_period}
405 Set the mpd update period ,for dynamic content.
413 The fifo pseudo-muxer allows the separation of encoding and muxing by using
414 first-in-first-out queue and running the actual muxer in a separate thread. This
415 is especially useful in combination with the @ref{tee} muxer and can be used to
416 send data to several destinations with different reliability/writing speed/latency.
418 API users should be aware that callback functions (interrupt_callback,
419 io_open and io_close) used within its AVFormatContext must be thread-safe.
421 The behavior of the fifo muxer if the queue fills up or if the output fails is
427 output can be transparently restarted with configurable delay between retries
428 based on real time or time of the processed stream.
431 encoding can be blocked during temporary failure, or continue transparently
432 dropping packets in case fifo queue fills up.
439 Specify the format name. Useful if it cannot be guessed from the
443 Specify size of the queue (number of packets). Default value is 60.
446 Specify format options for the underlying muxer. Muxer options can be specified
447 as a list of @var{key}=@var{value} pairs separated by ':'.
449 @item drop_pkts_on_overflow @var{bool}
450 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
451 rather than blocking the encoder. This makes it possible to continue streaming without
452 delaying the input, at the cost of omitting part of the stream. By default
453 this option is set to 0 (false), so in such cases the encoder will be blocked
454 until the muxer processes some of the packets and none of them is lost.
456 @item attempt_recovery @var{bool}
457 If failure occurs, attempt to recover the output. This is especially useful
458 when used with network output, since it makes it possible to restart streaming transparently.
459 By default this option is set to 0 (false).
461 @item max_recovery_attempts
462 Sets maximum number of successive unsuccessful recovery attempts after which
463 the output fails permanently. By default this option is set to 0 (unlimited).
465 @item recovery_wait_time @var{duration}
466 Waiting time before the next recovery attempt after previous unsuccessful
467 recovery attempt. Default value is 5 seconds.
469 @item recovery_wait_streamtime @var{bool}
470 If set to 0 (false), the real time is used when waiting for the recovery
471 attempt (i.e. the recovery will be attempted after at least
472 recovery_wait_time seconds).
473 If set to 1 (true), the time of the processed stream is taken into account
474 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
475 seconds of the stream is omitted).
476 By default, this option is set to 0 (false).
478 @item recover_any_error @var{bool}
479 If set to 1 (true), recovery will be attempted regardless of type of the error
480 causing the failure. By default this option is set to 0 (false) and in case of
481 certain (usually permanent) errors the recovery is not attempted even when
482 @var{attempt_recovery} is set to 1.
484 @item restart_with_keyframe @var{bool}
485 Specify whether to wait for the keyframe after recovering from
486 queue overflow or failure. This option is set to 0 (false) by default.
488 @item timeshift @var{duration}
489 Buffer the specified amount of packets and delay writing the output. Note that
490 @var{queue_size} must be big enough to store the packets for timeshift. At the
491 end of the input the fifo buffer is flushed at realtime speed.
500 Stream something to rtmp server, continue processing the stream at real-time
501 rate even in case of temporary failure (network outage) and attempt to recover
502 streaming every second indefinitely.
504 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
505 -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
512 Adobe Flash Video Format muxer.
514 This muxer accepts the following options:
518 @item flvflags @var{flags}
523 @item aac_seq_header_detect
524 Place AAC sequence header based on audio stream data.
526 @item no_sequence_end
527 Disable sequence end tag.
530 Disable metadata tag.
532 @item no_duration_filesize
533 Disable duration and filesize in metadata when they are equal to zero
534 at the end of stream. (Be used to non-seekable living stream).
536 @item add_keyframe_index
537 Used to facilitate seeking; particularly for HTTP pseudo streaming.
544 Per-packet CRC (Cyclic Redundancy Check) testing format.
546 This muxer computes and prints the Adler-32 CRC for each audio
547 and video packet. By default audio frames are converted to signed
548 16-bit raw audio and video frames to raw video before computing the
551 The output of the muxer consists of a line for each audio and video
554 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
557 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
562 For example to compute the CRC of the audio and video frames in
563 @file{INPUT}, converted to raw audio and video packets, and store it
564 in the file @file{out.crc}:
566 ffmpeg -i INPUT -f framecrc out.crc
569 To print the information to stdout, use the command:
571 ffmpeg -i INPUT -f framecrc -
574 With @command{ffmpeg}, you can select the output format to which the
575 audio and video frames are encoded before computing the CRC for each
576 packet by specifying the audio and video codec. For example, to
577 compute the CRC of each decoded input audio frame converted to PCM
578 unsigned 8-bit and of each decoded input video frame converted to
579 MPEG-2 video, use the command:
581 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
584 See also the @ref{crc} muxer.
589 Per-packet hash testing format.
591 This muxer computes and prints a cryptographic hash for each audio
592 and video packet. This can be used for packet-by-packet equality
593 checks without having to individually do a binary comparison on each.
595 By default audio frames are converted to signed 16-bit raw audio and
596 video frames to raw video before computing the hash, but the output
597 of explicit conversions to other codecs can also be used. It uses the
598 SHA-256 cryptographic hash function by default, but supports several
601 The output of the muxer consists of a line for each audio and video
604 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
607 @var{hash} is a hexadecimal number representing the computed hash
611 @item hash @var{algorithm}
612 Use the cryptographic hash function specified by the string @var{algorithm}.
613 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
614 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
615 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
616 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
622 To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
623 converted to raw audio and video packets, and store it in the file
626 ffmpeg -i INPUT -f framehash out.sha256
629 To print the information to stdout, using the MD5 hash function, use
632 ffmpeg -i INPUT -f framehash -hash md5 -
635 See also the @ref{hash} muxer.
640 Per-packet MD5 testing format.
642 This is a variant of the @ref{framehash} muxer. Unlike that muxer,
643 it defaults to using the MD5 hash function.
647 To compute the MD5 hash of the audio and video frames in @file{INPUT},
648 converted to raw audio and video packets, and store it in the file
651 ffmpeg -i INPUT -f framemd5 out.md5
654 To print the information to stdout, use the command:
656 ffmpeg -i INPUT -f framemd5 -
659 See also the @ref{framehash} and @ref{md5} muxers.
666 It accepts the following options:
670 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
671 for looping indefinitely (default).
674 Force the delay (expressed in centiseconds) after the last frame. Each frame
675 ends with a delay until the next frame. The default is @code{-1}, which is a
676 special value to tell the muxer to re-use the previous delay. In case of a
677 loop, you might want to customize this value to mark a pause for instance.
680 For example, to encode a gif looping 10 times, with a 5 seconds delay between
683 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
686 Note 1: if you wish to extract the frames into separate GIF files, you need to
687 force the @ref{image2} muxer:
689 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
692 Note 2: the GIF format has a very large time base: the delay between two frames
693 can therefore not be smaller than one centi second.
700 This muxer computes and prints a cryptographic hash of all the input
701 audio and video frames. This can be used for equality checks without
702 having to do a complete binary comparison.
704 By default audio frames are converted to signed 16-bit raw audio and
705 video frames to raw video before computing the hash, but the output
706 of explicit conversions to other codecs can also be used. Timestamps
707 are ignored. It uses the SHA-256 cryptographic hash function by default,
708 but supports several other algorithms.
710 The output of the muxer consists of a single line of the form:
711 @var{algo}=@var{hash}, where @var{algo} is a short string representing
712 the hash function used, and @var{hash} is a hexadecimal number
713 representing the computed hash.
716 @item hash @var{algorithm}
717 Use the cryptographic hash function specified by the string @var{algorithm}.
718 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
719 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
720 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
721 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
727 To compute the SHA-256 hash of the input converted to raw audio and
728 video, and store it in the file @file{out.sha256}:
730 ffmpeg -i INPUT -f hash out.sha256
733 To print an MD5 hash to stdout use the command:
735 ffmpeg -i INPUT -f hash -hash md5 -
738 See also the @ref{framehash} muxer.
743 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
744 the HTTP Live Streaming (HLS) specification.
746 It creates a playlist file, and one or more segment files. The output filename
747 specifies the playlist filename.
749 By default, the muxer creates a file for each segment produced. These files
750 have the same name as the playlist, followed by a sequential number and a
753 Make sure to require a closed GOP when encoding and to set the GOP
754 size to fit your segment time constraint.
756 For example, to convert an input file with @command{ffmpeg}:
758 ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
760 This example will produce the playlist, @file{out.m3u8}, and segment files:
761 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
763 See also the @ref{segment} muxer, which provides a more generic and
764 flexible implementation of a segmenter, and can be used to perform HLS
769 This muxer supports the following options:
772 @item hls_init_time @var{duration}
773 Set the initial target segment length. Default value is @var{0}.
775 @var{duration} must be a time duration specification,
776 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
778 Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
779 After the initial playlist is filled @command{ffmpeg} will cut segments
780 at duration equal to @code{hls_time}
782 @item hls_time @var{duration}
783 Set the target segment length. Default value is 2.
785 @var{duration} must be a time duration specification,
786 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
787 Segment will be cut on the next key frame after this time has passed.
789 @item hls_list_size @var{size}
790 Set the maximum number of playlist entries. If set to 0 the list file
791 will contain all the segments. Default value is 5.
793 @item hls_delete_threshold @var{size}
794 Set the number of unreferenced segments to keep on disk before @code{hls_flags delete_segments}
795 deletes them. Increase this to allow continue clients to download segments which
796 were recently referenced in the playlist. Default value is 1, meaning segments older than
797 @code{hls_list_size+1} will be deleted.
799 @item hls_ts_options @var{options_list}
800 Set output format options using a :-separated list of key=value
801 parameters. Values containing @code{:} special characters must be
804 @item hls_wrap @var{wrap}
805 This is a deprecated option, you can use @code{hls_list_size}
806 and @code{hls_flags delete_segments} instead it
808 This option is useful to avoid to fill the disk with many segment
809 files, and limits the maximum number of segment files written to disk
813 @item hls_start_number_source
814 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) according to the specified source.
815 Unless @code{hls_flags single_file} is set, it also specifies source of starting sequence numbers of
816 segment and subtitle filenames. In any case, if @code{hls_flags append_list}
817 is set and read playlist sequence number is greater than the specified start sequence number,
818 then that value will be used as start value.
820 It accepts the following values:
824 @item generic (default)
825 Set the starting sequence numbers according to @var{start_number} option value.
828 The start number will be the seconds since epoch (1970-01-01 00:00:00)
831 The start number will be the microseconds since epoch (1970-01-01 00:00:00)
834 The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759.
838 @item start_number @var{number}
839 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) from the specified @var{number}
840 when @var{hls_start_number_source} value is @var{generic}. (This is the default case.)
841 Unless @code{hls_flags single_file} is set, it also specifies starting sequence numbers of segment and subtitle filenames.
844 @item hls_allow_cache @var{allowcache}
845 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
847 @item hls_base_url @var{baseurl}
848 Append @var{baseurl} to every entry in the playlist.
849 Useful to generate playlists with absolute paths.
851 Note that the playlist sequence number must be unique for each segment
852 and it is not to be confused with the segment filename sequence number
853 which can be cyclic, for example if the @option{wrap} option is
856 @item hls_segment_filename @var{filename}
857 Set the segment filename. Unless @code{hls_flags single_file} is set,
858 @var{filename} is used as a string format with the segment number:
860 ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
862 This example will produce the playlist, @file{out.m3u8}, and segment files:
863 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
865 @var{filename} may contain full path or relative path specification,
866 but only the file name part without any path info will be contained in the m3u8 segment list.
867 Should a relative path be specified, the path of the created segment
868 files will be relative to the current working directory.
869 When strftime_mkdir is set, the whole expanded value of @var{filename} will be written into the m3u8 segment list.
871 When @code{var_stream_map} is set with two or more variant streams, the
872 @var{filename} pattern must contain the string "%v", this string specifies
873 the position of variant stream index in the generated segment file names.
875 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
876 -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" \
877 -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
879 This example will produce the playlists segment file sets:
880 @file{file_0_000.ts}, @file{file_0_001.ts}, @file{file_0_002.ts}, etc. and
881 @file{file_1_000.ts}, @file{file_1_001.ts}, @file{file_1_002.ts}, etc.
883 The string "%v" may be present in the filename or in the last directory name
884 containing the file, but only in one of them. (Additionally, %v may appear multiple times in the last
885 sub-directory or filename.) If the string %v is present in the directory name, then
886 sub-directories are created after expanding the directory name pattern. This
887 enables creation of segments corresponding to different variant streams in
890 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
891 -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" \
892 -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
894 This example will produce the playlists segment file sets:
895 @file{vs0/file_000.ts}, @file{vs0/file_001.ts}, @file{vs0/file_002.ts}, etc. and
896 @file{vs1/file_000.ts}, @file{vs1/file_001.ts}, @file{vs1/file_002.ts}, etc.
899 Same as strftime option, will be deprecated.
902 Use strftime() on @var{filename} to expand the segment filename with localtime.
903 The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index
904 hls_flag and %%d will be the specifier.
906 ffmpeg -i in.nut -strftime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
908 This example will produce the playlist, @file{out.m3u8}, and segment files:
909 @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
910 Note: On some systems/environments, the @code{%s} specifier is not available. See
911 @code{strftime()} documentation.
913 ffmpeg -i in.nut -strftime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
915 This example will produce the playlist, @file{out.m3u8}, and segment files:
916 @file{file-20160215-0001.ts}, @file{file-20160215-0002.ts}, etc.
918 @item use_localtime_mkdir
919 Same as strftime_mkdir option, will be deprecated .
922 Used together with -strftime_mkdir, it will create all subdirectories which
923 is expanded in @var{filename}.
925 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
927 This example will create a directory 201560215 (if it does not exist), and then
928 produce the playlist, @file{out.m3u8}, and segment files:
929 @file{20160215/file-20160215-1455569023.ts}, @file{20160215/file-20160215-1455569024.ts}, etc.
932 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
934 This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then
935 produce the playlist, @file{out.m3u8}, and segment files:
936 @file{2016/02/15/file-20160215-1455569023.ts}, @file{2016/02/15/file-20160215-1455569024.ts}, etc.
939 @item hls_key_info_file @var{key_info_file}
940 Use the information in @var{key_info_file} for segment encryption. The first
941 line of @var{key_info_file} specifies the key URI written to the playlist. The
942 key URL is used to access the encryption key during playback. The second line
943 specifies the path to the key file used to obtain the key during the encryption
944 process. The key file is read as a single packed array of 16 octets in binary
945 format. The optional third line specifies the initialization vector (IV) as a
946 hexadecimal string to be used instead of the segment sequence number (default)
947 for encryption. Changes to @var{key_info_file} will result in segment
948 encryption with the new key/IV and an entry in the playlist for the new key
949 URI/IV if @code{hls_flags periodic_rekey} is enabled.
951 Key info file format:
960 http://server/file.key
965 Example key file paths:
973 0123456789ABCDEF0123456789ABCDEF
976 Key info file example:
978 http://server/file.key
980 0123456789ABCDEF0123456789ABCDEF
983 Example shell script:
987 openssl rand 16 > file.key
988 echo $BASE_URL/file.key > file.keyinfo
989 echo file.key >> file.keyinfo
990 echo $(openssl rand -hex 16) >> file.keyinfo
991 ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
992 -hls_key_info_file file.keyinfo out.m3u8
995 @item -hls_enc @var{enc}
996 Enable (1) or disable (0) the AES128 encryption.
997 When enabled every segment generated is encrypted and the encryption key
998 is saved as @var{playlist name}.key.
1000 @item -hls_enc_key @var{key}
1001 16-octet key to encrypt the segments, by default it
1002 is randomly generated.
1004 @item -hls_enc_key_url @var{keyurl}
1005 If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
1008 @item -hls_enc_iv @var{iv}
1009 16-octet initialization vector for every segment instead
1010 of the autogenerated ones.
1012 @item hls_segment_type @var{flags}
1017 Output segment files in MPEG-2 Transport Stream format. This is
1018 compatible with all HLS versions.
1021 Output segment files in fragmented MP4 format, similar to MPEG-DASH.
1022 fmp4 files may be used in HLS version 7 and above.
1026 @item hls_fmp4_init_filename @var{filename}
1027 Set filename to the fragment files header file, default filename is @file{init.mp4}.
1029 Use @code{-strftime 1} on @var{filename} to expand the segment filename with localtime.
1031 ffmpeg -i in.nut -hls_segment_type fmp4 -strftime 1 -hls_fmp4_init_filename "%s_init.mp4" out.m3u8
1033 This will produce init like this
1034 @file{1602678741_init.mp4}
1036 @item hls_fmp4_init_resend
1037 Resend init file after m3u8 file refresh every time, default is @var{0}.
1039 When @code{var_stream_map} is set with two or more variant streams, the
1040 @var{filename} pattern must contain the string "%v", this string specifies
1041 the position of variant stream index in the generated init file names.
1042 The string "%v" may be present in the filename or in the last directory name
1043 containing the file. If the string is present in the directory name, then
1044 sub-directories are created after expanding the directory name pattern. This
1045 enables creation of init files corresponding to different variant streams in
1048 @item hls_flags @var{flags}
1053 If this flag is set, the muxer will store all segments in a single MPEG-TS
1054 file, and will use byte ranges in the playlist. HLS playlists generated with
1055 this way will have the version number 4.
1058 ffmpeg -i in.nut -hls_flags single_file out.m3u8
1060 Will produce the playlist, @file{out.m3u8}, and a single segment file,
1063 @item delete_segments
1064 Segment files removed from the playlist are deleted after a period of time
1065 equal to the duration of the segment plus the duration of the playlist.
1068 Append new segments into the end of old segment list,
1069 and remove the @code{#EXT-X-ENDLIST} from the old segment list.
1071 @item round_durations
1072 Round the duration info in the playlist file segment info to integer
1073 values, instead of using floating point.
1076 Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
1077 first segment's information.
1080 Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
1082 @item periodic_rekey
1083 The file specified by @code{hls_key_info_file} will be checked periodically and
1084 detect updates to the encryption info. Be sure to replace this file atomically,
1085 including the file containing the AES encryption key.
1087 @item independent_segments
1088 Add the @code{#EXT-X-INDEPENDENT-SEGMENTS} to playlists that has video segments
1089 and when all the segments of that playlist are guaranteed to start with a Key frame.
1092 Add the @code{#EXT-X-I-FRAMES-ONLY} to playlists that has video segments
1093 and can play only I-frames in the @code{#EXT-X-BYTERANGE} mode.
1096 Allow segments to start on frames other than keyframes. This improves
1097 behavior on some players when the time between keyframes is inconsistent,
1098 but may make things worse on others, and can cause some oddities during
1099 seeking. This flag should be used with the @code{hls_time} option.
1101 @item program_date_time
1102 Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
1104 @item second_level_segment_index
1105 Makes it possible to use segment indexes as %%d in hls_segment_filename expression
1106 besides date/time values when strftime is on.
1107 To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width.
1109 @item second_level_segment_size
1110 Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename
1111 expression besides date/time values when strftime is on.
1112 To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width.
1114 @item second_level_segment_duration
1115 Makes it possible to use segment duration (calculated in microseconds) as %%t in hls_segment_filename
1116 expression besides date/time values when strftime is on.
1117 To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width.
1120 ffmpeg -i sample.mpeg \
1121 -f hls -hls_time 3 -hls_list_size 5 \
1122 -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
1123 -strftime 1 -strftime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
1125 This will produce segments like this:
1126 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
1129 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
1130 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
1131 before they have been added to the m3u8 playlist. This flag also affects how m3u8 playlist files are created.
1132 If this flag is set, all playlist files will written into temporary file and renamed after they are complete, similarly as segments are handled.
1133 But playlists with @code{file} protocol and with type (@code{hls_playlist_type}) other than @code{vod}
1134 are always written into temporary file regardless of this flag. Master playlist files (@code{master_pl_name}), if any, with @code{file} protocol,
1135 are always written into temporary file regardless of this flag if @code{master_pl_publish_rate} value is other than zero.
1139 @item hls_playlist_type event
1140 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
1141 @option{hls_list_size} to 0; the playlist can only be appended to.
1143 @item hls_playlist_type vod
1144 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
1145 @option{hls_list_size} to 0; the playlist must not change.
1148 Use the given HTTP method to create the hls files.
1150 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
1152 This example will upload all the mpegts segment files to the HTTP
1153 server using the HTTP PUT method, and update the m3u8 files every
1154 @code{refresh} times using the same method.
1155 Note that the HTTP server must support the given method for uploading
1158 @item http_user_agent
1159 Override User-Agent field in HTTP header. Applicable only for HTTP output.
1161 @item var_stream_map
1162 Map string which specifies how to group the audio, video and subtitle streams
1163 into different variant streams. The variant stream groups are separated
1165 Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are
1166 the keys to specify audio, video and subtitle streams respectively.
1167 Allowed values are 0 to 9 (limited just based on practical usage).
1169 When there are two or more variant streams, the output filename pattern must
1170 contain the string "%v", this string specifies the position of variant stream
1171 index in the output media playlist filenames. The string "%v" may be present in
1172 the filename or in the last directory name containing the file. If the string is
1173 present in the directory name, then sub-directories are created after expanding
1174 the directory name pattern. This enables creation of variant streams in
1178 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1179 -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" \
1180 http://example.com/live/out_%v.m3u8
1182 This example creates two hls variant streams. The first variant stream will
1183 contain video stream of bitrate 1000k and audio stream of bitrate 64k and the
1184 second variant stream will contain video stream of bitrate 256k and audio
1185 stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and
1186 out_1.m3u8 will be created. If you want something meaningful text instead of indexes
1187 in result names, you may specify names for each or some of the variants
1188 as in the following example.
1192 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1193 -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" \
1194 http://example.com/live/out_%v.m3u8
1197 This example creates two hls variant streams as in the previous one.
1198 But here, the two media playlist with file names out_my_hd.m3u8 and
1199 out_my_sd.m3u8 will be created.
1202 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
1203 -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
1204 http://example.com/live/out_%v.m3u8
1206 This example creates three hls variant streams. The first variant stream will
1207 be a video only stream with video bitrate 1000k, the second variant stream will
1208 be an audio only stream with bitrate 64k and the third variant stream will be a
1209 video only stream with bitrate 256k. Here, three media playlist with file names
1210 out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created.
1212 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1213 -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" \
1214 http://example.com/live/vs_%v/out.m3u8
1216 This example creates the variant streams in subdirectories. Here, the first
1217 media playlist is created at @file{http://example.com/live/vs_0/out.m3u8} and
1218 the second one at @file{http://example.com/live/vs_1/out.m3u8}.
1220 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k \
1221 -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
1222 -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
1223 -master_pl_name master.m3u8 \
1224 http://example.com/live/out_%v.m3u8
1226 This example creates two audio only and two video only variant streams. In
1227 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1228 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1229 and they are mapped to the two video only variant streams with audio group names
1230 'aud_low' and 'aud_high'.
1232 By default, a single hls variant containing all the encoded streams is created.
1235 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1236 -map 0:a -map 0:a -map 0:v -f hls \
1237 -var_stream_map "a:0,agroup:aud_low,default:yes a:1,agroup:aud_low v:0,agroup:aud_low" \
1238 -master_pl_name master.m3u8 \
1239 http://example.com/live/out_%v.m3u8
1241 This example creates two audio only and one video only variant streams. In
1242 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1243 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1244 and they are mapped to the one video only variant streams with audio group name
1245 'aud_low', and the audio group have default stat is NO or YES.
1247 By default, a single hls variant containing all the encoded streams is created.
1250 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1251 -map 0:a -map 0:a -map 0:v -f hls \
1252 -var_stream_map "a:0,agroup:aud_low,default:yes,language:ENG a:1,agroup:aud_low,language:CHN v:0,agroup:aud_low" \
1253 -master_pl_name master.m3u8 \
1254 http://example.com/live/out_%v.m3u8
1256 This example creates two audio only and one video only variant streams. In
1257 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1258 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1259 and they are mapped to the one video only variant streams with audio group name
1260 'aud_low', and the audio group have default stat is NO or YES, and one audio
1261 have and language is named ENG, the other audio language is named CHN.
1263 By default, a single hls variant containing all the encoded streams is created.
1266 ffmpeg -y -i input_with_subtitle.mkv \
1267 -b:v:0 5250k -c:v h264 -pix_fmt yuv420p -profile:v main -level 4.1 \
1269 -c:s webvtt -c:a mp2 -ar 48000 -ac 2 -map 0:v -map 0:a:0 -map 0:s:0 \
1270 -f hls -var_stream_map "v:0,a:0,s:0,sgroup:subtitle" \
1271 -master_pl_name master.m3u8 -t 300 -hls_time 10 -hls_init_time 4 -hls_list_size \
1272 10 -master_pl_publish_rate 10 -hls_flags \
1273 delete_segments+discont_start+split_by_time ./tmp/video.m3u8
1276 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=SUBTITLES} in
1277 the master playlist with webvtt subtitle group name 'subtitle'. Please make sure
1278 the input file has one text subtitle stream at least.
1281 Map string which specifies different closed captions groups and their
1282 attributes. The closed captions stream groups are separated by space.
1283 Expected string format is like this
1284 "ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....".
1285 'ccgroup' and 'instreamid' are mandatory attributes. 'language' is an optional
1287 The closed captions groups configured using this option are mapped to different
1288 variant streams by providing the same 'ccgroup' name in the
1289 @code{var_stream_map} string. If @code{var_stream_map} is not set, then the
1290 first available ccgroup in @code{cc_stream_map} is mapped to the output variant
1291 stream. The examples for these two use cases are given below.
1294 ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
1295 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
1296 -master_pl_name master.m3u8 \
1297 http://example.com/live/out.m3u8
1299 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=CLOSED-CAPTIONS} in
1300 the master playlist with group name 'cc', language 'en' (english) and
1301 INSTREAM-ID 'CC1'. Also, it adds @code{CLOSED-CAPTIONS} attribute with group
1302 name 'cc' for the output variant stream.
1304 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1305 -a53cc:0 1 -a53cc:1 1\
1306 -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
1307 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
1308 -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
1309 -master_pl_name master.m3u8 \
1310 http://example.com/live/out_%v.m3u8
1312 This example adds two @code{#EXT-X-MEDIA} tags with @code{TYPE=CLOSED-CAPTIONS} in
1313 the master playlist for the INSTREAM-IDs 'CC1' and 'CC2'. Also, it adds
1314 @code{CLOSED-CAPTIONS} attribute with group name 'cc' for the two output variant
1317 @item master_pl_name
1318 Create HLS master playlist with the given name.
1321 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
1323 This example creates HLS master playlist with name master.m3u8 and it is
1324 published at http://example.com/live/
1326 @item master_pl_publish_rate
1327 Publish master play list repeatedly every after specified number of segment intervals.
1330 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
1331 -hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
1334 This example creates HLS master playlist with name master.m3u8 and keep
1335 publishing it repeatedly every after 30 segments i.e. every after 60s.
1337 @item http_persistent
1338 Use persistent HTTP connections. Applicable only for HTTP output.
1341 Set timeout for socket I/O operations. Applicable only for HTTP output.
1343 @item -ignore_io_errors
1344 Ignore IO errors during open, write and delete. Useful for long-duration runs with network output.
1347 Set custom HTTP headers, can override built in default headers. Applicable only for HTTP output.
1356 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
1360 Size cannot exceed 256 pixels in any dimension
1363 Only BMP and PNG images can be stored
1366 If a BMP image is used, it must be one of the following pixel formats:
1368 BMP Bit Depth FFmpeg Pixel Format
1378 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
1381 If a PNG image is used, it must use the rgba pixel format
1389 The image file muxer writes video frames to image files.
1391 The output filenames are specified by a pattern, which can be used to
1392 produce sequentially numbered series of files.
1393 The pattern may contain the string "%d" or "%0@var{N}d", this string
1394 specifies the position of the characters representing a numbering in
1395 the filenames. If the form "%0@var{N}d" is used, the string
1396 representing the number in each filename is 0-padded to @var{N}
1397 digits. The literal character '%' can be specified in the pattern with
1400 If the pattern contains "%d" or "%0@var{N}d", the first filename of
1401 the file list specified will contain the number 1, all the following
1402 numbers will be sequential.
1404 The pattern may contain a suffix which is used to automatically
1405 determine the format of the image files to write.
1407 For example the pattern "img-%03d.bmp" will specify a sequence of
1408 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
1409 @file{img-010.bmp}, etc.
1410 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
1411 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
1414 The image muxer supports the .Y.U.V image file format. This format is
1415 special in that that each image frame consists of three files, for
1416 each of the YUV420P components. To read or write this image file format,
1417 specify the name of the '.Y' file. The muxer will automatically open the
1418 '.U' and '.V' files as required.
1424 If set to 1, expand the filename with pts from pkt->pts.
1428 Start the sequence from the specified number. Default value is 1.
1431 If set to 1, the filename will always be interpreted as just a
1432 filename, not a pattern, and the corresponding file will be continuously
1433 overwritten with new images. Default value is 0.
1436 If set to 1, expand the filename with date and time information from
1437 @code{strftime()}. Default value is 0.
1439 @item protocol_opts @var{options_list}
1440 Set protocol options as a :-separated list of key=value parameters. Values
1441 containing the @code{:} special character must be escaped.
1445 @subsection Examples
1447 The following example shows how to use @command{ffmpeg} for creating a
1448 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
1449 taking one image every second from the input video:
1451 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
1454 Note that with @command{ffmpeg}, if the format is not specified with the
1455 @code{-f} option and the output filename specifies an image file
1456 format, the image2 muxer is automatically selected, so the previous
1457 command can be written as:
1459 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
1462 Note also that the pattern must not necessarily contain "%d" or
1463 "%0@var{N}d", for example to create a single image file
1464 @file{img.jpeg} from the start of the input video you can employ the command:
1466 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
1469 The @option{strftime} option allows you to expand the filename with
1470 date and time information. Check the documentation of
1471 the @code{strftime()} function for the syntax.
1473 For example to generate image files from the @code{strftime()}
1474 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
1477 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
1480 You can set the file name with current frame's PTS:
1482 ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
1485 A more complex example is to publish contents of your desktop directly to a
1486 WebDAV server every second:
1488 ffmpeg -f x11grab -framerate 1 -i :0.0 -q:v 6 -update 1 -protocol_opts method=PUT http://example.com/desktop.jpg
1493 Matroska container muxer.
1495 This muxer implements the matroska and webm container specs.
1497 @subsection Metadata
1499 The recognized metadata settings in this muxer are:
1503 Set title name provided to a single track. This gets mapped to
1504 the FileDescription element for a stream written as attachment.
1507 Specify the language of the track in the Matroska languages form.
1509 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
1510 639-2/B) form (like "fre" for French), or a language code mixed with a
1511 country code for specialities in languages (like "fre-ca" for Canadian
1515 Set stereo 3D video layout of two views in a single video track.
1517 The following values are recognized:
1522 Both views are arranged side by side, Left-eye view is on the left
1524 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
1526 Both views are arranged in top-bottom orientation, Left-eye view is on top
1527 @item checkerboard_rl
1528 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
1529 @item checkerboard_lr
1530 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
1531 @item row_interleaved_rl
1532 Each view is constituted by a row based interleaving, Right-eye view is first row
1533 @item row_interleaved_lr
1534 Each view is constituted by a row based interleaving, Left-eye view is first row
1535 @item col_interleaved_rl
1536 Both views are arranged in a column based interleaving manner, Right-eye view is first column
1537 @item col_interleaved_lr
1538 Both views are arranged in a column based interleaving manner, Left-eye view is first column
1539 @item anaglyph_cyan_red
1540 All frames are in anaglyph format viewable through red-cyan filters
1542 Both views are arranged side by side, Right-eye view is on the left
1543 @item anaglyph_green_magenta
1544 All frames are in anaglyph format viewable through green-magenta filters
1546 Both eyes laced in one Block, Left-eye view is first
1548 Both eyes laced in one Block, Right-eye view is first
1552 For example a 3D WebM clip can be created using the following command line:
1554 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
1559 This muxer supports the following options:
1562 @item reserve_index_space
1563 By default, this muxer writes the index for seeking (called cues in Matroska
1564 terms) at the end of the file, because it cannot know in advance how much space
1565 to leave for the index at the beginning of the file. However for some use cases
1566 -- e.g. streaming where seeking is possible but slow -- it is useful to put the
1567 index at the beginning of the file.
1569 If this option is set to a non-zero value, the muxer will reserve a given amount
1570 of space in the file header and then try to write the cues there when the muxing
1571 finishes. If the reserved space does not suffice, no Cues will be written, the
1572 file will be finalized and writing the trailer will return an error.
1573 A safe size for most use cases should be about 50kB per hour of video.
1575 Note that cues are only written if the output is seekable and this option will
1576 have no effect if it is not.
1578 This option controls how the FlagDefault of the output tracks will be set.
1579 It influences which tracks players should play by default. The default mode
1583 In this mode, for each type of track (audio, video or subtitle), if there is
1584 a track with disposition default of this type, then the first such track
1585 (i.e. the one with the lowest index) will be marked as default; if no such
1586 track exists, the first track of this type will be marked as default instead
1587 (if existing). This ensures that the default flag is set in a sensible way even
1588 if the input originated from containers that lack the concept of default tracks.
1590 This mode is the same as infer except that if no subtitle track with
1591 disposition default exists, no subtitle track will be marked as default.
1593 In this mode the FlagDefault is set if and only if the AV_DISPOSITION_DEFAULT
1594 flag is set in the disposition of the corresponding stream.
1597 @item flipped_raw_rgb
1598 If set to true, store positive height for raw RGB bitmaps, which indicates
1599 bitmap is stored bottom-up. Note that this option does not flip the bitmap
1600 which has to be done manually beforehand, e.g. by using the vflip filter.
1601 Default is @var{false} and indicates bitmap is stored top down.
1610 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
1611 defaults to using the MD5 hash function.
1613 @subsection Examples
1615 To compute the MD5 hash of the input converted to raw
1616 audio and video, and store it in the file @file{out.md5}:
1618 ffmpeg -i INPUT -f md5 out.md5
1621 You can print the MD5 to stdout with the command:
1623 ffmpeg -i INPUT -f md5 -
1626 See also the @ref{hash} and @ref{framemd5} muxers.
1628 @section mov, mp4, ismv
1630 MOV/MP4/ISMV (Smooth Streaming) muxer.
1632 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
1633 file has all the metadata about all packets stored in one location
1634 (written at the end of the file, it can be moved to the start for
1635 better playback by adding @var{faststart} to the @var{movflags}, or
1636 using the @command{qt-faststart} tool). A fragmented
1637 file consists of a number of fragments, where packets and metadata
1638 about these packets are stored together. Writing a fragmented
1639 file has the advantage that the file is decodable even if the
1640 writing is interrupted (while a normal MOV/MP4 is undecodable if
1641 it is not properly finished), and it requires less memory when writing
1642 very long files (since writing normal MOV/MP4 files stores info about
1643 every single packet in memory until the file is closed). The downside
1644 is that it is less compatible with other applications.
1648 Fragmentation is enabled by setting one of the AVOptions that define
1649 how to cut the file into fragments:
1652 @item -moov_size @var{bytes}
1653 Reserves space for the moov atom at the beginning of the file instead of placing the
1654 moov atom at the end. If the space reserved is insufficient, muxing will fail.
1655 @item -movflags frag_keyframe
1656 Start a new fragment at each video keyframe.
1657 @item -frag_duration @var{duration}
1658 Create fragments that are @var{duration} microseconds long.
1659 @item -frag_size @var{size}
1660 Create fragments that contain up to @var{size} bytes of payload data.
1661 @item -movflags frag_custom
1662 Allow the caller to manually choose when to cut fragments, by
1663 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
1664 the packets written so far. (This is only useful with other
1665 applications integrating libavformat, not from @command{ffmpeg}.)
1666 @item -min_frag_duration @var{duration}
1667 Don't create fragments that are shorter than @var{duration} microseconds long.
1670 If more than one condition is specified, fragments are cut when
1671 one of the specified conditions is fulfilled. The exception to this is
1672 @code{-min_frag_duration}, which has to be fulfilled for any of the other
1673 conditions to apply.
1675 Additionally, the way the output file is written can be adjusted
1676 through a few other options:
1679 @item -movflags empty_moov
1680 Write an initial moov atom directly at the start of the file, without
1681 describing any samples in it. Generally, an mdat/moov pair is written
1682 at the start of the file, as a normal MOV/MP4 file, containing only
1683 a short portion of the file. With this option set, there is no initial
1684 mdat atom, and the moov atom only describes the tracks but has
1687 This option is implicitly set when writing ismv (Smooth Streaming) files.
1688 @item -movflags separate_moof
1689 Write a separate moof (movie fragment) atom for each track. Normally,
1690 packets for all tracks are written in a moof atom (which is slightly
1691 more efficient), but with this option set, the muxer writes one moof/mdat
1692 pair for each track, making it easier to separate tracks.
1694 This option is implicitly set when writing ismv (Smooth Streaming) files.
1695 @item -movflags skip_sidx
1696 Skip writing of sidx atom. When bitrate overhead due to sidx atom is high,
1697 this option could be used for cases where sidx atom is not mandatory.
1698 When global_sidx flag is enabled, this option will be ignored.
1699 @item -movflags faststart
1700 Run a second pass moving the index (moov atom) to the beginning of the file.
1701 This operation can take a while, and will not work in various situations such
1702 as fragmented output, thus it is not enabled by default.
1703 @item -movflags rtphint
1704 Add RTP hinting tracks to the output file.
1705 @item -movflags disable_chpl
1706 Disable Nero chapter markers (chpl atom). Normally, both Nero chapters
1707 and a QuickTime chapter track are written to the file. With this option
1708 set, only the QuickTime chapter track will be written. Nero chapters can
1709 cause failures when the file is reprocessed with certain tagging programs, like
1710 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1711 @item -movflags omit_tfhd_offset
1712 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1713 tying fragments to absolute byte positions in the file/streams.
1714 @item -movflags default_base_moof
1715 Similarly to the omit_tfhd_offset, this flag avoids writing the
1716 absolute base_data_offset field in tfhd atoms, but does so by using
1717 the new default-base-is-moof flag instead. This flag is new from
1718 14496-12:2012. This may make the fragments easier to parse in certain
1719 circumstances (avoiding basing track fragment location calculations
1720 on the implicit end of the previous track fragment).
1722 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1723 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1724 @item -movflags negative_cts_offsets
1725 Enables utilization of version 1 of the CTTS box, in which the CTS offsets can
1726 be negative. This enables the initial sample to have DTS/CTS of zero, and
1727 reduces the need for edit lists for some cases such as video tracks with
1728 B-frames. Additionally, eases conformance with the DASH-IF interoperability
1731 This option is implicitly set when writing ismv (Smooth Streaming) files.
1733 Write producer time reference box (PRFT) with a specified time source for the
1734 NTP field in the PRFT box. Set value as @samp{wallclock} to specify timesource
1735 as wallclock time and @samp{pts} to specify timesource as input packets' PTS
1738 Setting value to @samp{pts} is applicable only for a live encoding use case,
1739 where PTS values are set as as wallclock time at the source. For example, an
1740 encoding use case with decklink capture source where @option{video_pts} and
1741 @option{audio_pts} are set to @samp{abs_wallclock}.
1746 Smooth Streaming content can be pushed in real time to a publishing
1747 point on IIS with this muxer. Example:
1749 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1754 The MP3 muxer writes a raw MP3 stream with the following optional features:
1757 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1758 2.4 are supported, the @code{id3v2_version} private option controls which one is
1759 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1762 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1763 The pictures are supplied to the muxer in form of a video stream with a single
1764 packet. There can be any number of those streams, each will correspond to a
1765 single APIC frame. The stream metadata tags @var{title} and @var{comment} map
1766 to APIC @var{description} and @var{picture type} respectively. See
1767 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1769 Note that the APIC frames must be written at the beginning, so the muxer will
1770 buffer the audio frames until it gets all the pictures. It is therefore advised
1771 to provide the pictures as soon as possible to avoid excessive buffering.
1774 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1775 default, but will be written only if the output is seekable. The
1776 @code{write_xing} private option can be used to disable it. The frame contains
1777 various information that may be useful to the decoder, like the audio duration
1781 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1782 enabled with the @code{write_id3v1} private option, but as its capabilities are
1783 very limited, its usage is not recommended.
1788 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1790 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1793 To attach a picture to an mp3 file select both the audio and the picture stream
1796 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1797 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1800 Write a "clean" MP3 without any extra features:
1802 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1807 MPEG transport stream muxer.
1809 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1811 The recognized metadata settings in mpegts muxer are @code{service_provider}
1812 and @code{service_name}. If they are not set the default for
1813 @code{service_provider} is @samp{FFmpeg} and the default for
1814 @code{service_name} is @samp{Service01}.
1818 The muxer options are:
1821 @item mpegts_transport_stream_id @var{integer}
1822 Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1823 Default is @code{0x0001}.
1825 @item mpegts_original_network_id @var{integer}
1826 Set the @samp{original_network_id}. This is unique identifier of a
1827 network in DVB. Its main use is in the unique identification of a service
1828 through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1831 @item mpegts_service_id @var{integer}
1832 Set the @samp{service_id}, also known as program in DVB. Default is
1835 @item mpegts_service_type @var{integer}
1836 Set the program @samp{service_type}. Default is @code{digital_tv}.
1837 Accepts the following options:
1840 Any hexadecimal value between @code{0x01} and @code{0xff} as defined in
1845 Digital Radio service.
1848 @item advanced_codec_digital_radio
1849 Advanced Codec Digital Radio service.
1850 @item mpeg2_digital_hdtv
1851 MPEG2 Digital HDTV service.
1852 @item advanced_codec_digital_sdtv
1853 Advanced Codec Digital SDTV service.
1854 @item advanced_codec_digital_hdtv
1855 Advanced Codec Digital HDTV service.
1858 @item mpegts_pmt_start_pid @var{integer}
1859 Set the first PID for PMTs. Default is @code{0x1000}, minimum is @code{0x0020},
1860 maximum is @code{0x1ffa}. This option has no effect in m2ts mode where the PMT
1861 PID is fixed @code{0x0100}.
1863 @item mpegts_start_pid @var{integer}
1864 Set the first PID for elementary streams. Default is @code{0x0100}, minimum is
1865 @code{0x0020}, maximum is @code{0x1ffa}. This option has no effect in m2ts mode
1866 where the elementary stream PIDs are fixed.
1868 @item mpegts_m2ts_mode @var{boolean}
1869 Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1872 @item muxrate @var{integer}
1873 Set a constant muxrate. Default is VBR.
1875 @item pes_payload_size @var{integer}
1876 Set minimum PES packet payload in bytes. Default is @code{2930}.
1878 @item mpegts_flags @var{flags}
1879 Set mpegts flags. Accepts the following options:
1881 @item resend_headers
1882 Reemit PAT/PMT before writing the next packet.
1884 Use LATM packetization for AAC.
1885 @item pat_pmt_at_frames
1886 Reemit PAT and PMT at each video frame.
1888 Conform to System B (DVB) instead of System A (ATSC).
1889 @item initial_discontinuity
1890 Mark the initial packet of each stream as discontinuity.
1893 @item mpegts_copyts @var{boolean}
1894 Preserve original timestamps, if value is set to @code{1}. Default value
1895 is @code{-1}, which results in shifting timestamps so that they start from 0.
1897 @item omit_video_pes_length @var{boolean}
1898 Omit the PES packet length for video packets. Default is @code{1} (true).
1900 @item pcr_period @var{integer}
1901 Override the default PCR retransmission time in milliseconds. Default is
1902 @code{-1} which means that the PCR interval will be determined automatically:
1903 20 ms is used for CBR streams, the highest multiple of the frame duration which
1904 is less than 100 ms is used for VBR streams.
1906 @item pat_period @var{duration}
1907 Maximum time in seconds between PAT/PMT tables. Default is @code{0.1}.
1909 @item sdt_period @var{duration}
1910 Maximum time in seconds between SDT tables. Default is @code{0.5}.
1912 @item tables_version @var{integer}
1913 Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1914 This option allows updating stream structure so that standard consumer may
1915 detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1916 usage) or restart @command{ffmpeg} instance, cyclically changing
1917 @option{tables_version} value:
1920 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1921 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1923 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1924 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1925 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1933 ffmpeg -i file.mpg -c copy \
1934 -mpegts_original_network_id 0x1122 \
1935 -mpegts_transport_stream_id 0x3344 \
1936 -mpegts_service_id 0x5566 \
1937 -mpegts_pmt_start_pid 0x1500 \
1938 -mpegts_start_pid 0x150 \
1939 -metadata service_provider="Some provider" \
1940 -metadata service_name="Some Channel" \
1944 @section mxf, mxf_d10, mxf_opatom
1950 The muxer options are:
1953 @item store_user_comments @var{bool}
1954 Set if user comments should be stored if available or never.
1955 IRT D-10 does not allow user comments. The default is thus to write them for
1956 mxf and mxf_opatom but not for mxf_d10
1963 This muxer does not generate any output file, it is mainly useful for
1964 testing or benchmarking purposes.
1966 For example to benchmark decoding with @command{ffmpeg} you can use the
1969 ffmpeg -benchmark -i INPUT -f null out.null
1972 Note that the above command does not read or write the @file{out.null}
1973 file, but specifying the output file is required by the @command{ffmpeg}
1976 Alternatively you can write the command as:
1978 ffmpeg -benchmark -i INPUT -f null -
1984 @item -syncpoints @var{flags}
1985 Change the syncpoint usage in nut:
1987 @item @var{default} use the normal low-overhead seeking aids.
1988 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1989 Use of this option is not recommended, as the resulting files are very damage
1990 sensitive and seeking is not possible. Also in general the overhead from
1991 syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1992 all growing data tables, allowing to mux endless streams with limited memory
1993 and without these disadvantages.
1994 @item @var{timestamped} extend the syncpoint with a wallclock field.
1996 The @var{none} and @var{timestamped} flags are experimental.
1997 @item -write_index @var{bool}
1998 Write index at the end, the default is to write an index.
2002 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
2007 Ogg container muxer.
2010 @item -page_duration @var{duration}
2011 Preferred page duration, in microseconds. The muxer will attempt to create
2012 pages that are approximately @var{duration} microseconds long. This allows the
2013 user to compromise between seek granularity and container overhead. The default
2014 is 1 second. A value of 0 will fill all segments, making pages as large as
2015 possible. A value of 1 will effectively use 1 packet-per-page in most
2016 situations, giving a small seek granularity at the cost of additional container
2018 @item -serial_offset @var{value}
2019 Serial value from which to set the streams serial number.
2020 Setting it to different and sufficiently large values ensures that the produced
2021 ogg files can be safely chained.
2028 Raw muxers accept a single stream matching the designated codec. They do not store timestamps or metadata.
2029 The recognized extension is the same as the muxer name unless indicated otherwise.
2033 Dolby Digital, also known as AC-3, audio.
2037 CRI Middleware ADX audio.
2039 This muxer will write out the total sample count near the start of the first packet
2040 when the output is seekable and the count can be stored in 32 bits.
2044 aptX (Audio Processing Technology for Bluetooth) audio.
2048 aptX HD (Audio Processing Technology for Bluetooth) audio.
2054 AVS2-P2/IEEE1857.4 video.
2056 Extensions: avs, avs2
2058 @subsection cavsvideo
2060 Chinese AVS (Audio Video Standard) video.
2064 @subsection codec2raw
2068 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f codec2raw}.
2072 Data muxer accepts a single stream with any codec of any type.
2073 The input stream has to be selected using the @code{-map} option with the ffmpeg CLI tool.
2075 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f data}.
2079 BBC Dirac video. The Dirac Pro codec is a subset and is standardized as SMPTE VC-2.
2081 Extensions: drc, vc2
2085 Avid DNxHD video. It is standardized as SMPTE VC-3. Accepts DNxHR streams.
2087 Extensions: dnxhd, dnxhr
2091 DTS Coherent Acoustics (DCA) audio.
2095 Dolby Digital Plus, also known as Enhanced AC-3, audio.
2103 ITU-T G.723.1 audio.
2105 Extensions: tco, rco
2109 ITU-T G.726 big-endian ("left-justified") audio.
2111 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726}.
2115 ITU-T G.726 little-endian ("right-justified") audio.
2117 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726le}.
2121 Global System for Mobile Communications audio.
2129 ITU-T H.263 / H.263-1996, H.263+ / H.263-1998 / H.263 version 2 video.
2133 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.
2135 Extensions: h264, 264
2139 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.
2141 Extensions: hevc, h265, 265
2145 MPEG-4 Part 2 video.
2151 Extensions: mjpg, mjpeg
2155 Meridian Lossless Packing, also known as Packed PCM, audio.
2159 MPEG-1 Audio Layer II audio.
2161 Extensions: mp2, m2a, mpa
2163 @subsection mpeg1video
2165 MPEG-1 Part 2 video.
2167 Extensions: mpg, mpeg, m1v
2169 @subsection mpeg2video
2171 ITU-T H.262 / MPEG-2 Part 2 video.
2175 @subsection rawvideo
2177 Raw uncompressed video.
2179 Extensions: yuv, rgb
2183 Bluetooth SIG low-complexity subband codec audio.
2185 Extensions: sbc, msbc
2195 SMPTE 421M / VC-1 video.
2198 @section segment, stream_segment, ssegment
2200 Basic stream segmenter.
2202 This muxer outputs streams to a number of separate files of nearly
2203 fixed duration. Output filename pattern can be set in a fashion
2204 similar to @ref{image2}, or by using a @code{strftime} template if
2205 the @option{strftime} option is enabled.
2207 @code{stream_segment} is a variant of the muxer used to write to
2208 streaming output formats, i.e. which do not require global headers,
2209 and is recommended for outputting e.g. to MPEG transport stream segments.
2210 @code{ssegment} is a shorter alias for @code{stream_segment}.
2212 Every segment starts with a keyframe of the selected reference stream,
2213 which is set through the @option{reference_stream} option.
2215 Note that if you want accurate splitting for a video file, you need to
2216 make the input key frames correspond to the exact splitting times
2217 expected by the segmenter, or the segment muxer will start the new
2218 segment with the key frame found next after the specified start
2221 The segment muxer works best with a single constant frame rate video.
2223 Optionally it can generate a list of the created segments, by setting
2224 the option @var{segment_list}. The list type is specified by the
2225 @var{segment_list_type} option. The entry filenames in the segment
2226 list are set by default to the basename of the corresponding segment
2229 See also the @ref{hls} muxer, which provides a more specific
2230 implementation for HLS segmentation.
2234 The segment muxer supports the following options:
2237 @item increment_tc @var{1|0}
2238 if set to @code{1}, increment timecode between each segment
2239 If this is selected, the input need to have
2240 a timecode in the first video stream. Default value is
2243 @item reference_stream @var{specifier}
2244 Set the reference stream, as specified by the string @var{specifier}.
2245 If @var{specifier} is set to @code{auto}, the reference is chosen
2246 automatically. Otherwise it must be a stream specifier (see the ``Stream
2247 specifiers'' chapter in the ffmpeg manual) which specifies the
2248 reference stream. The default value is @code{auto}.
2250 @item segment_format @var{format}
2251 Override the inner container format, by default it is guessed by the filename
2254 @item segment_format_options @var{options_list}
2255 Set output format options using a :-separated list of key=value
2256 parameters. Values containing the @code{:} special character must be
2259 @item segment_list @var{name}
2260 Generate also a listfile named @var{name}. If not specified no
2261 listfile is generated.
2263 @item segment_list_flags @var{flags}
2264 Set flags affecting the segment list generation.
2266 It currently supports the following flags:
2269 Allow caching (only affects M3U8 list files).
2272 Allow live-friendly file generation.
2275 @item segment_list_size @var{size}
2276 Update the list file so that it contains at most @var{size}
2277 segments. If 0 the list file will contain all the segments. Default
2280 @item segment_list_entry_prefix @var{prefix}
2281 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
2282 By default no prefix is applied.
2284 @item segment_list_type @var{type}
2285 Select the listing format.
2287 The following values are recognized:
2290 Generate a flat list for the created segments, one segment per line.
2293 Generate a list for the created segments, one segment per line,
2294 each line matching the format (comma-separated values):
2296 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
2299 @var{segment_filename} is the name of the output file generated by the
2300 muxer according to the provided pattern. CSV escaping (according to
2301 RFC4180) is applied if required.
2303 @var{segment_start_time} and @var{segment_end_time} specify
2304 the segment start and end time expressed in seconds.
2306 A list file with the suffix @code{".csv"} or @code{".ext"} will
2307 auto-select this format.
2309 @samp{ext} is deprecated in favor or @samp{csv}.
2312 Generate an ffconcat file for the created segments. The resulting file
2313 can be read using the FFmpeg @ref{concat} demuxer.
2315 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
2316 auto-select this format.
2319 Generate an extended M3U8 file, version 3, compliant with
2320 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
2322 A list file with the suffix @code{".m3u8"} will auto-select this format.
2325 If not specified the type is guessed from the list file name suffix.
2327 @item segment_time @var{time}
2328 Set segment duration to @var{time}, the value must be a duration
2329 specification. Default value is "2". See also the
2330 @option{segment_times} option.
2332 Note that splitting may not be accurate, unless you force the
2333 reference stream key-frames at the given time. See the introductory
2334 notice and the examples below.
2336 @item segment_atclocktime @var{1|0}
2337 If set to "1" split at regular clock time intervals starting from 00:00
2338 o'clock. The @var{time} value specified in @option{segment_time} is
2339 used for setting the length of the splitting interval.
2341 For example with @option{segment_time} set to "900" this makes it possible
2342 to create files at 12:00 o'clock, 12:15, 12:30, etc.
2344 Default value is "0".
2346 @item segment_clocktime_offset @var{duration}
2347 Delay the segment splitting times with the specified duration when using
2348 @option{segment_atclocktime}.
2350 For example with @option{segment_time} set to "900" and
2351 @option{segment_clocktime_offset} set to "300" this makes it possible to
2352 create files at 12:05, 12:20, 12:35, etc.
2354 Default value is "0".
2356 @item segment_clocktime_wrap_duration @var{duration}
2357 Force the segmenter to only start a new segment if a packet reaches the muxer
2358 within the specified duration after the segmenting clock time. This way you
2359 can make the segmenter more resilient to backward local time jumps, such as
2360 leap seconds or transition to standard time from daylight savings time.
2362 Default is the maximum possible duration which means starting a new segment
2363 regardless of the elapsed time since the last clock time.
2365 @item segment_time_delta @var{delta}
2366 Specify the accuracy time when selecting the start time for a
2367 segment, expressed as a duration specification. Default value is "0".
2369 When delta is specified a key-frame will start a new segment if its
2370 PTS satisfies the relation:
2372 PTS >= start_time - time_delta
2375 This option is useful when splitting video content, which is always
2376 split at GOP boundaries, in case a key frame is found just before the
2377 specified split time.
2379 In particular may be used in combination with the @file{ffmpeg} option
2380 @var{force_key_frames}. The key frame times specified by
2381 @var{force_key_frames} may not be set accurately because of rounding
2382 issues, with the consequence that a key frame time may result set just
2383 before the specified time. For constant frame rate videos a value of
2384 1/(2*@var{frame_rate}) should address the worst case mismatch between
2385 the specified time and the time set by @var{force_key_frames}.
2387 @item segment_times @var{times}
2388 Specify a list of split points. @var{times} contains a list of comma
2389 separated duration specifications, in increasing order. See also
2390 the @option{segment_time} option.
2392 @item segment_frames @var{frames}
2393 Specify a list of split video frame numbers. @var{frames} contains a
2394 list of comma separated integer numbers, in increasing order.
2396 This option specifies to start a new segment whenever a reference
2397 stream key frame is found and the sequential number (starting from 0)
2398 of the frame is greater or equal to the next value in the list.
2400 @item segment_wrap @var{limit}
2401 Wrap around segment index once it reaches @var{limit}.
2403 @item segment_start_number @var{number}
2404 Set the sequence number of the first segment. Defaults to @code{0}.
2406 @item strftime @var{1|0}
2407 Use the @code{strftime} function to define the name of the new
2408 segments to write. If this is selected, the output segment name must
2409 contain a @code{strftime} function template. Default value is
2412 @item break_non_keyframes @var{1|0}
2413 If enabled, allow segments to start on frames other than keyframes. This
2414 improves behavior on some players when the time between keyframes is
2415 inconsistent, but may make things worse on others, and can cause some oddities
2416 during seeking. Defaults to @code{0}.
2418 @item reset_timestamps @var{1|0}
2419 Reset timestamps at the beginning of each segment, so that each segment
2420 will start with near-zero timestamps. It is meant to ease the playback
2421 of the generated segments. May not work with some combinations of
2422 muxers/codecs. It is set to @code{0} by default.
2424 @item initial_offset @var{offset}
2425 Specify timestamp offset to apply to the output packet timestamps. The
2426 argument must be a time duration specification, and defaults to 0.
2428 @item write_empty_segments @var{1|0}
2429 If enabled, write an empty segment if there are no packets during the period a
2430 segment would usually span. Otherwise, the segment will be filled with the next
2431 packet written. Defaults to @code{0}.
2434 Make sure to require a closed GOP when encoding and to set the GOP
2435 size to fit your segment time constraint.
2437 @subsection Examples
2441 Remux the content of file @file{in.mkv} to a list of segments
2442 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
2443 generated segments to @file{out.list}:
2445 ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
2449 Segment input and set output format options for the output segments:
2451 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
2455 Segment the input file according to the split points specified by the
2456 @var{segment_times} option:
2458 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
2462 Use the @command{ffmpeg} @option{force_key_frames}
2463 option to force key frames in the input at the specified location, together
2464 with the segment option @option{segment_time_delta} to account for
2465 possible roundings operated when setting key frame times.
2467 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
2468 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
2470 In order to force key frames on the input file, transcoding is
2474 Segment the input file by splitting the input file according to the
2475 frame numbers sequence specified with the @option{segment_frames} option:
2477 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
2481 Convert the @file{in.mkv} to TS segments using the @code{libx264}
2482 and @code{aac} encoders:
2484 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
2488 Segment the input file, and create an M3U8 live playlist (can be used
2489 as live HLS source):
2491 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
2492 -segment_list_flags +live -segment_time 10 out%03d.mkv
2496 @section smoothstreaming
2498 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
2502 Specify the number of fragments kept in the manifest. Default 0 (keep all).
2504 @item extra_window_size
2505 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
2507 @item lookahead_count
2508 Specify the number of lookahead fragments. Default 2.
2510 @item min_frag_duration
2511 Specify the minimum fragment duration (in microseconds). Default 5000000.
2513 @item remove_at_exit
2514 Specify whether to remove all fragments when finished. Default 0 (do not remove).
2521 Per stream hash testing format.
2523 This muxer computes and prints a cryptographic hash of all the input frames,
2524 on a per-stream basis. This can be used for equality checks without having
2525 to do a complete binary comparison.
2527 By default audio frames are converted to signed 16-bit raw audio and
2528 video frames to raw video before computing the hash, but the output
2529 of explicit conversions to other codecs can also be used. Timestamps
2530 are ignored. It uses the SHA-256 cryptographic hash function by default,
2531 but supports several other algorithms.
2533 The output of the muxer consists of one line per stream of the form:
2534 @var{streamindex},@var{streamtype},@var{algo}=@var{hash}, where
2535 @var{streamindex} is the index of the mapped stream, @var{streamtype} is a
2536 single character indicating the type of stream, @var{algo} is a short string
2537 representing the hash function used, and @var{hash} is a hexadecimal number
2538 representing the computed hash.
2541 @item hash @var{algorithm}
2542 Use the cryptographic hash function specified by the string @var{algorithm}.
2543 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
2544 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
2545 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
2546 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
2550 @subsection Examples
2552 To compute the SHA-256 hash of the input converted to raw audio and
2553 video, and store it in the file @file{out.sha256}:
2555 ffmpeg -i INPUT -f streamhash out.sha256
2558 To print an MD5 hash to stdout use the command:
2560 ffmpeg -i INPUT -f streamhash -hash md5 -
2563 See also the @ref{hash} and @ref{framehash} muxers.
2568 The tee muxer can be used to write the same data to several outputs, such as files or streams.
2569 It can be used, for example, to stream a video over a network and save it to disk at the same time.
2571 It is different from specifying several outputs to the @command{ffmpeg}
2572 command-line tool. With the tee muxer, the audio and video data will be encoded only once.
2573 With conventional multiple outputs, multiple encoding operations in parallel are initiated,
2574 which can be a very expensive process. The tee muxer is not useful when using the libavformat API
2575 directly because it is then possible to feed the same packets to several muxers directly.
2577 Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select
2578 output streams. So all streams intended for output must be specified using @code{-map}. See
2581 Some encoders may need different options depending on the output format;
2582 the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified.
2583 The main example is the @option{global_header} flag.
2585 The slave outputs are specified in the file name given to the muxer,
2586 separated by '|'. If any of the slave name contains the '|' separator,
2587 leading or trailing spaces or any special character, those must be
2588 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
2589 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
2595 @item use_fifo @var{bool}
2596 If set to 1, slave outputs will be processed in separate threads using the @ref{fifo}
2597 muxer. This allows to compensate for different speed/latency/reliability of
2598 outputs and setup transparent recovery. By default this feature is turned off.
2601 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
2605 Muxer options can be specified for each slave by prepending them as a list of
2606 @var{key}=@var{value} pairs separated by ':', between square brackets. If
2607 the options values contain a special character or the ':' separator, they
2608 must be escaped; note that this is a second level escaping.
2610 The following special options are also recognized:
2613 Specify the format name. Required if it cannot be guessed from the
2616 @item bsfs[/@var{spec}]
2617 Specify a list of bitstream filters to apply to the specified
2620 It is possible to specify to which streams a given bitstream filter
2621 applies, by appending a stream specifier to the option separated by
2622 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
2623 stream specifiers}).
2625 If the stream specifier is not specified, the bitstream filters will be
2626 applied to all streams in the output. This will cause that output operation
2627 to fail if the output contains streams to which the bitstream filter cannot
2628 be applied e.g. @code{h264_mp4toannexb} being applied to an output containing an audio stream.
2630 Options for a bitstream filter must be specified in the form of @code{opt=value}.
2632 Several bitstream filters can be specified, separated by ",".
2634 @item use_fifo @var{bool}
2635 This allows to override tee muxer use_fifo option for individual slave muxer.
2638 This allows to override tee muxer fifo_options for individual slave muxer.
2642 Select the streams that should be mapped to the slave output,
2643 specified by a stream specifier. If not specified, this defaults to
2644 all the mapped streams. This will cause that output operation to fail
2645 if the output format does not accept all mapped streams.
2647 You may use multiple stream specifiers separated by commas (@code{,}) e.g.: @code{a:0,v}
2650 Specify behaviour on output failure. This can be set to either @code{abort} (which is
2651 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
2652 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
2653 will continue without being affected.
2656 @subsection Examples
2660 Encode something and both archive it in a WebM file and stream it
2661 as MPEG-TS over UDP:
2663 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2664 "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2668 As above, but continue streaming even if output to local file fails
2669 (for example local drive fills up):
2671 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2672 "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2676 Use @command{ffmpeg} to encode the input, and send the output
2677 to three different destinations. The @code{dump_extra} bitstream
2678 filter is used to add extradata information to all the output video
2679 keyframes packets, as requested by the MPEG-TS format. The select
2680 option is applied to @file{out.aac} in order to make it contain only
2683 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2684 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
2688 As above, but select only stream @code{a:1} for the audio output. Note
2689 that a second level escaping must be performed, as ":" is a special
2690 character used to separate options.
2692 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2693 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
2699 WebM Live Chunk Muxer.
2701 This muxer writes out WebM headers and chunks as separate files which can be
2702 consumed by clients that support WebM Live streams via DASH.
2706 This muxer supports the following options:
2709 @item chunk_start_index
2710 Index of the first chunk (defaults to 0).
2713 Filename of the header where the initialization data will be written.
2715 @item audio_chunk_duration
2716 Duration of each audio chunk in milliseconds (defaults to 5000).
2721 ffmpeg -f v4l2 -i /dev/video0 \
2725 -s 640x360 -keyint_min 30 -g 30 \
2727 -header webm_live_video_360.hdr \
2728 -chunk_start_index 1 \
2729 webm_live_video_360_%d.chk \
2734 -header webm_live_audio_128.hdr \
2735 -chunk_start_index 1 \
2736 -audio_chunk_duration 1000 \
2737 webm_live_audio_128_%d.chk
2740 @section webm_dash_manifest
2742 WebM DASH Manifest muxer.
2744 This muxer implements the WebM DASH Manifest specification to generate the DASH
2745 manifest XML. It also supports manifest generation for DASH live streams.
2747 For more information see:
2751 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
2753 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
2758 This muxer supports the following options:
2761 @item adaptation_sets
2762 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
2763 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
2764 audio and video streams. Any number of adaptation sets can be added using this option.
2767 Set this to 1 to create a live stream DASH Manifest. Default: 0.
2769 @item chunk_start_index
2770 Start index of the first chunk. This will go in the @samp{startNumber} attribute
2771 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
2773 @item chunk_duration_ms
2774 Duration of each chunk in milliseconds. This will go in the @samp{duration}
2775 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
2777 @item utc_timing_url
2778 URL of the page that will return the UTC timestamp in ISO format. This will go
2779 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
2782 @item time_shift_buffer_depth
2783 Smallest time (in seconds) shifting buffer for which any Representation is
2784 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
2785 attribute of the @samp{MPD} element. Default: 60.
2787 @item minimum_update_period
2788 Minimum update period (in seconds) of the manifest. This will go in the
2789 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
2795 ffmpeg -f webm_dash_manifest -i video1.webm \
2796 -f webm_dash_manifest -i video2.webm \
2797 -f webm_dash_manifest -i audio1.webm \
2798 -f webm_dash_manifest -i audio2.webm \
2799 -map 0 -map 1 -map 2 -map 3 \
2801 -f webm_dash_manifest \
2802 -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \