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 Interchange File Format muxer.
34 It accepts the following options:
38 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
41 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
42 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
49 Advanced Systems Format muxer.
51 Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this
56 It accepts the following options:
60 Set the muxer packet size. By tuning this setting you may reduce data
61 fragmentation or muxer overhead depending on your source. Default value is
62 3200, minimum is 100, maximum is 64k.
69 Audio Video Interleaved muxer.
73 It accepts the following options:
76 @item reserve_index_space
77 Reserve the specified amount of bytes for the OpenDML master index of each
78 stream within the file header. By default additional master indexes are
79 embedded within the data packets if there is no space left in the first master
80 index and are linked together as a chain of indexes. This index structure can
81 cause problems for some use cases, e.g. third-party software strictly relying
82 on the OpenDML index specification or when file seeking is slow. Reserving
83 enough index space in the file header avoids these problems.
85 The required index space depends on the output file size and should be about 16
86 bytes per gigabyte. When this option is omitted or set to zero the necessary
87 index space is guessed.
89 @item write_channel_mask
90 Write the channel layout mask into the audio stream header.
92 This option is enabled by default. Disabling the channel mask can be useful in
93 specific scenarios, e.g. when merging multiple audio streams into one for
94 compatibility with software that only supports a single audio stream in AVI
95 (see @ref{amerge,,the "amerge" section in the ffmpeg-filters manual,ffmpeg-filters}).
98 If set to true, store positive height for raw RGB bitmaps, which indicates
99 bitmap is stored bottom-up. Note that this option does not flip the bitmap
100 which has to be done manually beforehand, e.g. by using the vflip filter.
101 Default is @var{false} and indicates bitmap is stored top down.
108 Chromaprint fingerprinter.
110 This muxer feeds audio data to the Chromaprint library,
111 which generates a fingerprint for the provided audio data. See @url{https://acoustid.org/chromaprint}
113 It takes a single signed native-endian 16-bit raw audio stream of at most 2 channels.
118 @item silence_threshold
119 Threshold for detecting silence. Range is from -1 to 32767, where -1 disables
120 silence detection. Silence detection can only be used with version 3 of the
122 Silence detection must be disabled for use with the AcoustID service. Default is -1.
125 Version of algorithm to fingerprint with. Range is 0 to 4.
126 Version 3 enables silence detection. Default is 1.
129 Format to output the fingerprint as. Accepts the following options:
132 Binary raw fingerprint
135 Binary compressed fingerprint
138 Base64 compressed fingerprint @emph{(default)}
147 CRC (Cyclic Redundancy Check) testing format.
149 This muxer computes and prints the Adler-32 CRC of all the input audio
150 and video frames. By default audio frames are converted to signed
151 16-bit raw audio and video frames to raw video before computing the
154 The output of the muxer consists of a single line of the form:
155 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
156 8 digits containing the CRC for all the decoded input frames.
158 See also the @ref{framecrc} muxer.
162 For example to compute the CRC of the input, and store it in the file
165 ffmpeg -i INPUT -f crc out.crc
168 You can print the CRC to stdout with the command:
170 ffmpeg -i INPUT -f crc -
173 You can select the output format of each frame with @command{ffmpeg} by
174 specifying the audio and video codec and format. For example to
175 compute the CRC of the input audio converted to PCM unsigned 8-bit
176 and the input video converted to MPEG-2 video, use the command:
178 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
184 Dynamic Adaptive Streaming over HTTP (DASH) muxer that creates segments
185 and manifest files according to the MPEG-DASH standard ISO/IEC 23009-1:2014.
187 For more information see:
191 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
193 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
196 It creates a MPD manifest file and segment files for each stream.
198 The segment filename might contain pre-defined identifiers used with SegmentTemplate
199 as defined in section 5.3.9.4.4 of the standard. Available identifiers are "$RepresentationID$",
200 "$Number$", "$Bandwidth$" and "$Time$".
201 In addition to the standard identifiers, an ffmpeg-specific "$ext$" identifier is also supported.
202 When specified ffmpeg will replace $ext$ in the file name with muxing format's extensions such as mp4, webm etc.,
205 ffmpeg -re -i <input> -map 0 -map 0 -c:a libfdk_aac -c:v libx264 \
206 -b:v:0 800k -b:v:1 300k -s:v:1 320x170 -profile:v:1 baseline \
207 -profile:v:0 main -bf 1 -keyint_min 120 -g 120 -sc_threshold 0 \
208 -b_strategy 0 -ar:a:1 22050 -use_timeline 1 -use_template 1 \
209 -window_size 5 -adaptation_sets "id=0,streams=v id=1,streams=a" \
210 -f dash /path/to/out.mpd
214 @item min_seg_duration @var{microseconds}
215 This is a deprecated option to set the segment length in microseconds, use @var{seg_duration} instead.
216 @item seg_duration @var{duration}
217 Set the segment length in seconds (fractional value can be set). The value is
218 treated as average segment duration when @var{use_template} is enabled and
219 @var{use_timeline} is disabled and as minimum segment duration for all the other
221 @item frag_duration @var{duration}
222 Set the length in seconds of fragments within segments (fractional value can be set).
223 @item frag_type @var{type}
224 Set the type of interval for fragmentation.
225 @item window_size @var{size}
226 Set the maximum number of segments kept in the manifest.
227 @item extra_window_size @var{size}
228 Set the maximum number of segments kept outside of the manifest before removing from disk.
229 @item remove_at_exit @var{remove}
230 Enable (1) or disable (0) removal of all segments when finished.
231 @item use_template @var{template}
232 Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList.
233 @item use_timeline @var{timeline}
234 Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate.
235 @item single_file @var{single_file}
236 Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges.
237 @item single_file_name @var{file_name}
238 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.
239 @item init_seg_name @var{init_name}
240 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.
241 @item media_seg_name @var{segment_name}
242 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.
243 @item utc_timing_url @var{utc_url}
244 URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso"
245 @item method @var{method}
246 Use the given HTTP method to create output files. Generally set to PUT or POST.
247 @item http_user_agent @var{user_agent}
248 Override User-Agent field in HTTP header. Applicable only for HTTP output.
249 @item http_persistent @var{http_persistent}
250 Use persistent HTTP connections. Applicable only for HTTP output.
251 @item hls_playlist @var{hls_playlist}
252 Generate HLS playlist files as well. The master playlist is generated with the filename @var{hls_master_name}.
253 One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc.
254 @item hls_master_name @var{file_name}
255 HLS master playlist name. Default is "master.m3u8".
256 @item streaming @var{streaming}
257 Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming
258 mode, each frame will be a moof fragment which forms a chunk.
259 @item adaptation_sets @var{adaptation_sets}
260 Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs
261 of the adaptation sets and a,b,c,d and e are the indices of the mapped streams.
263 To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs.
265 When no assignment is defined, this defaults to an AdaptationSet for each stream.
267 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,
268 descriptor is useful to the scheme defined by ISO/IEC 23009-1:2014/Amd.2:2015.
269 For example, -adaptation_sets "id=0,descriptor=<SupplementalProperty schemeIdUri=\"urn:mpeg:dash:srd:2014\" value=\"0,0,0,1,1,2,2\"/>,streams=v".
270 Please note that descriptor string should be a self-closing xml tag.
271 seg_duration, frag_duration and frag_type override the global option values for each adaptation set.
272 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"
273 type_id marks an adaptation set as containing streams meant to be used for Trick Mode for the referenced adaptation set.
274 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"
275 @item timeout @var{timeout}
276 Set timeout for socket I/O operations. Applicable only for HTTP output.
277 @item index_correction @var{index_correction}
278 Enable (1) or Disable (0) segment index correction logic. Applicable only when
279 @var{use_template} is enabled and @var{use_timeline} is disabled.
281 When enabled, the logic monitors the flow of segment indexes. If a streams's
282 segment index value is not at the expected real time position, then the logic
283 corrects that index value.
285 Typically this logic is needed in live streaming use cases. The network bandwidth
286 fluctuations are common during long run streaming. Each fluctuation can cause
287 the segment indexes fall behind the expected real time position.
288 @item format_options @var{options_list}
289 Set container format (mp4/webm) options using a @code{:} separated list of
290 key=value parameters. Values containing @code{:} special characters must be
293 @item global_sidx @var{global_sidx}
294 Write global SIDX atom. Applicable only for single file, mp4 output, non-streaming mode.
296 @item dash_segment_type @var{dash_segment_type}
300 If this flag is set, the dash segment files format will be selected based on the stream codec. This is the default mode.
303 If this flag is set, the dash segment files will be in in ISOBMFF format.
306 If this flag is set, the dash segment files will be in in WebM format.
309 @item ignore_io_errors @var{ignore_io_errors}
310 Ignore IO errors during open and write. Useful for long-duration runs with network output.
312 @item lhls @var{lhls}
313 Enable Low-latency HLS(LHLS). Adds #EXT-X-PREFETCH tag with current segment's URI.
314 Apple doesn't have an official spec for LHLS. Meanwhile hls.js player folks are
315 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
316 This option will also try to comply with the above open spec, till Apple's spec officially supports it.
317 Applicable only when @var{streaming} and @var{hls_playlist} options are enabled.
318 This is an experimental feature.
320 @item ldash @var{ldash}
321 Enable Low-latency Dash by constraining the presence and values of some elements.
323 @item master_m3u8_publish_rate @var{master_m3u8_publish_rate}
324 Publish master playlist repeatedly every after specified number of segment intervals.
326 @item write_prft @var{write_prft}
327 Write Producer Reference Time elements on supported streams. This also enables writing
328 prft boxes in the underlying muxer. Applicable only when the @var{utc_url} option is enabled.
329 It's set to auto by default, in which case the muxer will attempt to enable it only in modes
332 @item mpd_profile @var{mpd_profile}
333 Set one or more manifest profiles.
335 @item http_opts @var{http_opts}
336 A :-separated list of key=value options to pass to the underlying HTTP
337 protocol. Applicable only for HTTP output.
339 @item target_latency @var{target_latency}
340 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.
341 This is an informative fields clients can use to measure the latency of the service.
343 @item min_playback_rate @var{min_playback_rate}
344 Set the minimum playback rate indicated as appropriate for the purposes of automatically
345 adjusting playback latency and buffer occupancy during normal playback by clients.
347 @item max_playback_rate @var{max_playback_rate}
348 Set the maximum playback rate indicated as appropriate for the purposes of automatically
349 adjusting playback latency and buffer occupancy during normal playback by clients.
351 @item update_period @var{update_period}
352 Set the mpd update period ,for dynamic content.
360 The fifo pseudo-muxer allows the separation of encoding and muxing by using
361 first-in-first-out queue and running the actual muxer in a separate thread. This
362 is especially useful in combination with the @ref{tee} muxer and can be used to
363 send data to several destinations with different reliability/writing speed/latency.
365 API users should be aware that callback functions (interrupt_callback,
366 io_open and io_close) used within its AVFormatContext must be thread-safe.
368 The behavior of the fifo muxer if the queue fills up or if the output fails is
374 output can be transparently restarted with configurable delay between retries
375 based on real time or time of the processed stream.
378 encoding can be blocked during temporary failure, or continue transparently
379 dropping packets in case fifo queue fills up.
386 Specify the format name. Useful if it cannot be guessed from the
390 Specify size of the queue (number of packets). Default value is 60.
393 Specify format options for the underlying muxer. Muxer options can be specified
394 as a list of @var{key}=@var{value} pairs separated by ':'.
396 @item drop_pkts_on_overflow @var{bool}
397 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
398 rather than blocking the encoder. This makes it possible to continue streaming without
399 delaying the input, at the cost of omitting part of the stream. By default
400 this option is set to 0 (false), so in such cases the encoder will be blocked
401 until the muxer processes some of the packets and none of them is lost.
403 @item attempt_recovery @var{bool}
404 If failure occurs, attempt to recover the output. This is especially useful
405 when used with network output, since it makes it possible to restart streaming transparently.
406 By default this option is set to 0 (false).
408 @item max_recovery_attempts
409 Sets maximum number of successive unsuccessful recovery attempts after which
410 the output fails permanently. By default this option is set to 0 (unlimited).
412 @item recovery_wait_time @var{duration}
413 Waiting time before the next recovery attempt after previous unsuccessful
414 recovery attempt. Default value is 5 seconds.
416 @item recovery_wait_streamtime @var{bool}
417 If set to 0 (false), the real time is used when waiting for the recovery
418 attempt (i.e. the recovery will be attempted after at least
419 recovery_wait_time seconds).
420 If set to 1 (true), the time of the processed stream is taken into account
421 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
422 seconds of the stream is omitted).
423 By default, this option is set to 0 (false).
425 @item recover_any_error @var{bool}
426 If set to 1 (true), recovery will be attempted regardless of type of the error
427 causing the failure. By default this option is set to 0 (false) and in case of
428 certain (usually permanent) errors the recovery is not attempted even when
429 @var{attempt_recovery} is set to 1.
431 @item restart_with_keyframe @var{bool}
432 Specify whether to wait for the keyframe after recovering from
433 queue overflow or failure. This option is set to 0 (false) by default.
435 @item timeshift @var{duration}
436 Buffer the specified amount of packets and delay writing the output. Note that
437 @var{queue_size} must be big enough to store the packets for timeshift. At the
438 end of the input the fifo buffer is flushed at realtime speed.
447 Stream something to rtmp server, continue processing the stream at real-time
448 rate even in case of temporary failure (network outage) and attempt to recover
449 streaming every second indefinitely.
451 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
452 -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
459 Adobe Flash Video Format muxer.
461 This muxer accepts the following options:
465 @item flvflags @var{flags}
470 @item aac_seq_header_detect
471 Place AAC sequence header based on audio stream data.
473 @item no_sequence_end
474 Disable sequence end tag.
477 Disable metadata tag.
479 @item no_duration_filesize
480 Disable duration and filesize in metadata when they are equal to zero
481 at the end of stream. (Be used to non-seekable living stream).
483 @item add_keyframe_index
484 Used to facilitate seeking; particularly for HTTP pseudo streaming.
491 Per-packet CRC (Cyclic Redundancy Check) testing format.
493 This muxer computes and prints the Adler-32 CRC for each audio
494 and video packet. By default audio frames are converted to signed
495 16-bit raw audio and video frames to raw video before computing the
498 The output of the muxer consists of a line for each audio and video
501 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
504 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
509 For example to compute the CRC of the audio and video frames in
510 @file{INPUT}, converted to raw audio and video packets, and store it
511 in the file @file{out.crc}:
513 ffmpeg -i INPUT -f framecrc out.crc
516 To print the information to stdout, use the command:
518 ffmpeg -i INPUT -f framecrc -
521 With @command{ffmpeg}, you can select the output format to which the
522 audio and video frames are encoded before computing the CRC for each
523 packet by specifying the audio and video codec. For example, to
524 compute the CRC of each decoded input audio frame converted to PCM
525 unsigned 8-bit and of each decoded input video frame converted to
526 MPEG-2 video, use the command:
528 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
531 See also the @ref{crc} muxer.
536 Per-packet hash testing format.
538 This muxer computes and prints a cryptographic hash for each audio
539 and video packet. This can be used for packet-by-packet equality
540 checks without having to individually do a binary comparison on each.
542 By default audio frames are converted to signed 16-bit raw audio and
543 video frames to raw video before computing the hash, but the output
544 of explicit conversions to other codecs can also be used. It uses the
545 SHA-256 cryptographic hash function by default, but supports several
548 The output of the muxer consists of a line for each audio and video
551 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
554 @var{hash} is a hexadecimal number representing the computed hash
558 @item hash @var{algorithm}
559 Use the cryptographic hash function specified by the string @var{algorithm}.
560 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
561 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
562 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
563 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
569 To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
570 converted to raw audio and video packets, and store it in the file
573 ffmpeg -i INPUT -f framehash out.sha256
576 To print the information to stdout, using the MD5 hash function, use
579 ffmpeg -i INPUT -f framehash -hash md5 -
582 See also the @ref{hash} muxer.
587 Per-packet MD5 testing format.
589 This is a variant of the @ref{framehash} muxer. Unlike that muxer,
590 it defaults to using the MD5 hash function.
594 To compute the MD5 hash of the audio and video frames in @file{INPUT},
595 converted to raw audio and video packets, and store it in the file
598 ffmpeg -i INPUT -f framemd5 out.md5
601 To print the information to stdout, use the command:
603 ffmpeg -i INPUT -f framemd5 -
606 See also the @ref{framehash} and @ref{md5} muxers.
613 It accepts the following options:
617 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
618 for looping indefinitely (default).
621 Force the delay (expressed in centiseconds) after the last frame. Each frame
622 ends with a delay until the next frame. The default is @code{-1}, which is a
623 special value to tell the muxer to re-use the previous delay. In case of a
624 loop, you might want to customize this value to mark a pause for instance.
627 For example, to encode a gif looping 10 times, with a 5 seconds delay between
630 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
633 Note 1: if you wish to extract the frames into separate GIF files, you need to
634 force the @ref{image2} muxer:
636 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
639 Note 2: the GIF format has a very large time base: the delay between two frames
640 can therefore not be smaller than one centi second.
647 This muxer computes and prints a cryptographic hash of all the input
648 audio and video frames. This can be used for equality checks without
649 having to do a complete binary comparison.
651 By default audio frames are converted to signed 16-bit raw audio and
652 video frames to raw video before computing the hash, but the output
653 of explicit conversions to other codecs can also be used. Timestamps
654 are ignored. It uses the SHA-256 cryptographic hash function by default,
655 but supports several other algorithms.
657 The output of the muxer consists of a single line of the form:
658 @var{algo}=@var{hash}, where @var{algo} is a short string representing
659 the hash function used, and @var{hash} is a hexadecimal number
660 representing the computed hash.
663 @item hash @var{algorithm}
664 Use the cryptographic hash function specified by the string @var{algorithm}.
665 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
666 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
667 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
668 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
674 To compute the SHA-256 hash of the input converted to raw audio and
675 video, and store it in the file @file{out.sha256}:
677 ffmpeg -i INPUT -f hash out.sha256
680 To print an MD5 hash to stdout use the command:
682 ffmpeg -i INPUT -f hash -hash md5 -
685 See also the @ref{framehash} muxer.
690 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
691 the HTTP Live Streaming (HLS) specification.
693 It creates a playlist file, and one or more segment files. The output filename
694 specifies the playlist filename.
696 By default, the muxer creates a file for each segment produced. These files
697 have the same name as the playlist, followed by a sequential number and a
700 Make sure to require a closed GOP when encoding and to set the GOP
701 size to fit your segment time constraint.
703 For example, to convert an input file with @command{ffmpeg}:
705 ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
707 This example will produce the playlist, @file{out.m3u8}, and segment files:
708 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
710 See also the @ref{segment} muxer, which provides a more generic and
711 flexible implementation of a segmenter, and can be used to perform HLS
716 This muxer supports the following options:
719 @item hls_init_time @var{duration}
720 Set the initial target segment length. Default value is @var{0}.
722 @var{duration} must be a time duration specification,
723 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
725 Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
726 After the initial playlist is filled @command{ffmpeg} will cut segments
727 at duration equal to @code{hls_time}
729 @item hls_time @var{duration}
730 Set the target segment length. Default value is 2.
732 @var{duration} must be a time duration specification,
733 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
734 Segment will be cut on the next key frame after this time has passed.
736 @item hls_list_size @var{size}
737 Set the maximum number of playlist entries. If set to 0 the list file
738 will contain all the segments. Default value is 5.
740 @item hls_delete_threshold @var{size}
741 Set the number of unreferenced segments to keep on disk before @code{hls_flags delete_segments}
742 deletes them. Increase this to allow continue clients to download segments which
743 were recently referenced in the playlist. Default value is 1, meaning segments older than
744 @code{hls_list_size+1} will be deleted.
746 @item hls_ts_options @var{options_list}
747 Set output format options using a :-separated list of key=value
748 parameters. Values containing @code{:} special characters must be
751 @item hls_wrap @var{wrap}
752 This is a deprecated option, you can use @code{hls_list_size}
753 and @code{hls_flags delete_segments} instead it
755 This option is useful to avoid to fill the disk with many segment
756 files, and limits the maximum number of segment files written to disk
760 @item hls_start_number_source
761 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) according to the specified source.
762 Unless @code{hls_flags single_file} is set, it also specifies source of starting sequence numbers of
763 segment and subtitle filenames. In any case, if @code{hls_flags append_list}
764 is set and read playlist sequence number is greater than the specified start sequence number,
765 then that value will be used as start value.
767 It accepts the following values:
771 @item generic (default)
772 Set the starting sequence numbers according to @var{start_number} option value.
775 The start number will be the seconds since epoch (1970-01-01 00:00:00)
778 The start number will be the microseconds since epoch (1970-01-01 00:00:00)
781 The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759.
785 @item start_number @var{number}
786 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) from the specified @var{number}
787 when @var{hls_start_number_source} value is @var{generic}. (This is the default case.)
788 Unless @code{hls_flags single_file} is set, it also specifies starting sequence numbers of segment and subtitle filenames.
791 @item hls_allow_cache @var{allowcache}
792 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
794 @item hls_base_url @var{baseurl}
795 Append @var{baseurl} to every entry in the playlist.
796 Useful to generate playlists with absolute paths.
798 Note that the playlist sequence number must be unique for each segment
799 and it is not to be confused with the segment filename sequence number
800 which can be cyclic, for example if the @option{wrap} option is
803 @item hls_segment_filename @var{filename}
804 Set the segment filename. Unless @code{hls_flags single_file} is set,
805 @var{filename} is used as a string format with the segment number:
807 ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
809 This example will produce the playlist, @file{out.m3u8}, and segment files:
810 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
812 @var{filename} may contain full path or relative path specification,
813 but only the file name part without any path info will be contained in the m3u8 segment list.
814 Should a relative path be specified, the path of the created segment
815 files will be relative to the current working directory.
816 When strftime_mkdir is set, the whole expanded value of @var{filename} will be written into the m3u8 segment list.
818 When @code{var_stream_map} is set with two or more variant streams, the
819 @var{filename} pattern must contain the string "%v", this string specifies
820 the position of variant stream index in the generated segment file names.
822 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
823 -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" \
824 -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
826 This example will produce the playlists segment file sets:
827 @file{file_0_000.ts}, @file{file_0_001.ts}, @file{file_0_002.ts}, etc. and
828 @file{file_1_000.ts}, @file{file_1_001.ts}, @file{file_1_002.ts}, etc.
830 The string "%v" may be present in the filename or in the last directory name
831 containing the file, but only in one of them. (Additionally, %v may appear multiple times in the last
832 sub-directory or filename.) If the string %v is present in the directory name, then
833 sub-directories are created after expanding the directory name pattern. This
834 enables creation of segments corresponding to different variant streams in
837 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
838 -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" \
839 -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
841 This example will produce the playlists segment file sets:
842 @file{vs0/file_000.ts}, @file{vs0/file_001.ts}, @file{vs0/file_002.ts}, etc. and
843 @file{vs1/file_000.ts}, @file{vs1/file_001.ts}, @file{vs1/file_002.ts}, etc.
846 Same as strftime option, will be deprecated.
849 Use strftime() on @var{filename} to expand the segment filename with localtime.
850 The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index
851 hls_flag and %%d will be the specifier.
853 ffmpeg -i in.nut -strftime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
855 This example will produce the playlist, @file{out.m3u8}, and segment files:
856 @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
857 Note: On some systems/environments, the @code{%s} specifier is not available. See
858 @code{strftime()} documentation.
860 ffmpeg -i in.nut -strftime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
862 This example will produce the playlist, @file{out.m3u8}, and segment files:
863 @file{file-20160215-0001.ts}, @file{file-20160215-0002.ts}, etc.
865 @item use_localtime_mkdir
866 Same as strftime_mkdir option, will be deprecated .
869 Used together with -strftime_mkdir, it will create all subdirectories which
870 is expanded in @var{filename}.
872 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
874 This example will create a directory 201560215 (if it does not exist), and then
875 produce the playlist, @file{out.m3u8}, and segment files:
876 @file{20160215/file-20160215-1455569023.ts}, @file{20160215/file-20160215-1455569024.ts}, etc.
879 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
881 This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then
882 produce the playlist, @file{out.m3u8}, and segment files:
883 @file{2016/02/15/file-20160215-1455569023.ts}, @file{2016/02/15/file-20160215-1455569024.ts}, etc.
886 @item hls_key_info_file @var{key_info_file}
887 Use the information in @var{key_info_file} for segment encryption. The first
888 line of @var{key_info_file} specifies the key URI written to the playlist. The
889 key URL is used to access the encryption key during playback. The second line
890 specifies the path to the key file used to obtain the key during the encryption
891 process. The key file is read as a single packed array of 16 octets in binary
892 format. The optional third line specifies the initialization vector (IV) as a
893 hexadecimal string to be used instead of the segment sequence number (default)
894 for encryption. Changes to @var{key_info_file} will result in segment
895 encryption with the new key/IV and an entry in the playlist for the new key
896 URI/IV if @code{hls_flags periodic_rekey} is enabled.
898 Key info file format:
907 http://server/file.key
912 Example key file paths:
920 0123456789ABCDEF0123456789ABCDEF
923 Key info file example:
925 http://server/file.key
927 0123456789ABCDEF0123456789ABCDEF
930 Example shell script:
934 openssl rand 16 > file.key
935 echo $BASE_URL/file.key > file.keyinfo
936 echo file.key >> file.keyinfo
937 echo $(openssl rand -hex 16) >> file.keyinfo
938 ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
939 -hls_key_info_file file.keyinfo out.m3u8
942 @item -hls_enc @var{enc}
943 Enable (1) or disable (0) the AES128 encryption.
944 When enabled every segment generated is encrypted and the encryption key
945 is saved as @var{playlist name}.key.
947 @item -hls_enc_key @var{key}
948 16-octet key to encrypt the segments, by default it
949 is randomly generated.
951 @item -hls_enc_key_url @var{keyurl}
952 If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
955 @item -hls_enc_iv @var{iv}
956 16-octet initialization vector for every segment instead
957 of the autogenerated ones.
959 @item hls_segment_type @var{flags}
964 Output segment files in MPEG-2 Transport Stream format. This is
965 compatible with all HLS versions.
968 Output segment files in fragmented MP4 format, similar to MPEG-DASH.
969 fmp4 files may be used in HLS version 7 and above.
973 @item hls_fmp4_init_filename @var{filename}
974 Set filename to the fragment files header file, default filename is @file{init.mp4}.
976 Use @code{-strftime 1} on @var{filename} to expand the segment filename with localtime.
978 ffmpeg -i in.nut -hls_segment_type fmp4 -strftime 1 -hls_fmp4_init_filename "%s_init.mp4" out.m3u8
980 This will produce init like this
981 @file{1602678741_init.mp4}
983 @item hls_fmp4_init_resend
984 Resend init file after m3u8 file refresh every time, default is @var{0}.
986 When @code{var_stream_map} is set with two or more variant streams, the
987 @var{filename} pattern must contain the string "%v", this string specifies
988 the position of variant stream index in the generated init file names.
989 The string "%v" may be present in the filename or in the last directory name
990 containing the file. If the string is present in the directory name, then
991 sub-directories are created after expanding the directory name pattern. This
992 enables creation of init files corresponding to different variant streams in
995 @item hls_flags @var{flags}
1000 If this flag is set, the muxer will store all segments in a single MPEG-TS
1001 file, and will use byte ranges in the playlist. HLS playlists generated with
1002 this way will have the version number 4.
1005 ffmpeg -i in.nut -hls_flags single_file out.m3u8
1007 Will produce the playlist, @file{out.m3u8}, and a single segment file,
1010 @item delete_segments
1011 Segment files removed from the playlist are deleted after a period of time
1012 equal to the duration of the segment plus the duration of the playlist.
1015 Append new segments into the end of old segment list,
1016 and remove the @code{#EXT-X-ENDLIST} from the old segment list.
1018 @item round_durations
1019 Round the duration info in the playlist file segment info to integer
1020 values, instead of using floating point.
1023 Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
1024 first segment's information.
1027 Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
1029 @item periodic_rekey
1030 The file specified by @code{hls_key_info_file} will be checked periodically and
1031 detect updates to the encryption info. Be sure to replace this file atomically,
1032 including the file containing the AES encryption key.
1034 @item independent_segments
1035 Add the @code{#EXT-X-INDEPENDENT-SEGMENTS} to playlists that has video segments
1036 and when all the segments of that playlist are guaranteed to start with a Key frame.
1039 Add the @code{#EXT-X-I-FRAMES-ONLY} to playlists that has video segments
1040 and can play only I-frames in the @code{#EXT-X-BYTERANGE} mode.
1043 Allow segments to start on frames other than keyframes. This improves
1044 behavior on some players when the time between keyframes is inconsistent,
1045 but may make things worse on others, and can cause some oddities during
1046 seeking. This flag should be used with the @code{hls_time} option.
1048 @item program_date_time
1049 Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
1051 @item second_level_segment_index
1052 Makes it possible to use segment indexes as %%d in hls_segment_filename expression
1053 besides date/time values when strftime is on.
1054 To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width.
1056 @item second_level_segment_size
1057 Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename
1058 expression besides date/time values when strftime is on.
1059 To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width.
1061 @item second_level_segment_duration
1062 Makes it possible to use segment duration (calculated in microseconds) as %%t in hls_segment_filename
1063 expression besides date/time values when strftime is on.
1064 To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width.
1067 ffmpeg -i sample.mpeg \
1068 -f hls -hls_time 3 -hls_list_size 5 \
1069 -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
1070 -strftime 1 -strftime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
1072 This will produce segments like this:
1073 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
1076 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
1077 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
1078 before they have been added to the m3u8 playlist. This flag also affects how m3u8 playlist files are created.
1079 If this flag is set, all playlist files will written into temporary file and renamed after they are complete, similarly as segments are handled.
1080 But playlists with @code{file} protocol and with type (@code{hls_playlist_type}) other than @code{vod}
1081 are always written into temporary file regardless of this flag. Master playlist files (@code{master_pl_name}), if any, with @code{file} protocol,
1082 are always written into temporary file regardless of this flag if @code{master_pl_publish_rate} value is other than zero.
1086 @item hls_playlist_type event
1087 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
1088 @option{hls_list_size} to 0; the playlist can only be appended to.
1090 @item hls_playlist_type vod
1091 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
1092 @option{hls_list_size} to 0; the playlist must not change.
1095 Use the given HTTP method to create the hls files.
1097 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
1099 This example will upload all the mpegts segment files to the HTTP
1100 server using the HTTP PUT method, and update the m3u8 files every
1101 @code{refresh} times using the same method.
1102 Note that the HTTP server must support the given method for uploading
1105 @item http_user_agent
1106 Override User-Agent field in HTTP header. Applicable only for HTTP output.
1108 @item var_stream_map
1109 Map string which specifies how to group the audio, video and subtitle streams
1110 into different variant streams. The variant stream groups are separated
1112 Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are
1113 the keys to specify audio, video and subtitle streams respectively.
1114 Allowed values are 0 to 9 (limited just based on practical usage).
1116 When there are two or more variant streams, the output filename pattern must
1117 contain the string "%v", this string specifies the position of variant stream
1118 index in the output media playlist filenames. The string "%v" may be present in
1119 the filename or in the last directory name containing the file. If the string is
1120 present in the directory name, then sub-directories are created after expanding
1121 the directory name pattern. This enables creation of variant streams in
1125 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1126 -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" \
1127 http://example.com/live/out_%v.m3u8
1129 This example creates two hls variant streams. The first variant stream will
1130 contain video stream of bitrate 1000k and audio stream of bitrate 64k and the
1131 second variant stream will contain video stream of bitrate 256k and audio
1132 stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and
1133 out_1.m3u8 will be created. If you want something meaningful text instead of indexes
1134 in result names, you may specify names for each or some of the variants
1135 as in the following example.
1139 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1140 -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" \
1141 http://example.com/live/out_%v.m3u8
1144 This example creates two hls variant streams as in the previous one.
1145 But here, the two media playlist with file names out_my_hd.m3u8 and
1146 out_my_sd.m3u8 will be created.
1149 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
1150 -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
1151 http://example.com/live/out_%v.m3u8
1153 This example creates three hls variant streams. The first variant stream will
1154 be a video only stream with video bitrate 1000k, the second variant stream will
1155 be an audio only stream with bitrate 64k and the third variant stream will be a
1156 video only stream with bitrate 256k. Here, three media playlist with file names
1157 out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created.
1159 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1160 -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" \
1161 http://example.com/live/vs_%v/out.m3u8
1163 This example creates the variant streams in subdirectories. Here, the first
1164 media playlist is created at @file{http://example.com/live/vs_0/out.m3u8} and
1165 the second one at @file{http://example.com/live/vs_1/out.m3u8}.
1167 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k \
1168 -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
1169 -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
1170 -master_pl_name master.m3u8 \
1171 http://example.com/live/out_%v.m3u8
1173 This example creates two audio only and two video only variant streams. In
1174 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1175 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1176 and they are mapped to the two video only variant streams with audio group names
1177 'aud_low' and 'aud_high'.
1179 By default, a single hls variant containing all the encoded streams is created.
1182 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1183 -map 0:a -map 0:a -map 0:v -f hls \
1184 -var_stream_map "a:0,agroup:aud_low,default:yes a:1,agroup:aud_low v:0,agroup:aud_low" \
1185 -master_pl_name master.m3u8 \
1186 http://example.com/live/out_%v.m3u8
1188 This example creates two audio only and one video only variant streams. In
1189 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1190 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1191 and they are mapped to the one video only variant streams with audio group name
1192 'aud_low', and the audio group have default stat is NO or YES.
1194 By default, a single hls variant containing all the encoded streams is created.
1197 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1198 -map 0:a -map 0:a -map 0:v -f hls \
1199 -var_stream_map "a:0,agroup:aud_low,default:yes,language:ENG a:1,agroup:aud_low,language:CHN v:0,agroup:aud_low" \
1200 -master_pl_name master.m3u8 \
1201 http://example.com/live/out_%v.m3u8
1203 This example creates two audio only and one video only variant streams. In
1204 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1205 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1206 and they are mapped to the one video only variant streams with audio group name
1207 'aud_low', and the audio group have default stat is NO or YES, and one audio
1208 have and language is named ENG, the other audio language is named CHN.
1210 By default, a single hls variant containing all the encoded streams is created.
1213 ffmpeg -y -i input_with_subtitle.mkv \
1214 -b:v:0 5250k -c:v h264 -pix_fmt yuv420p -profile:v main -level 4.1 \
1216 -c:s webvtt -c:a mp2 -ar 48000 -ac 2 -map 0:v -map 0:a:0 -map 0:s:0 \
1217 -f hls -var_stream_map "v:0,a:0,s:0,sgroup:subtitle" \
1218 -master_pl_name master.m3u8 -t 300 -hls_time 10 -hls_init_time 4 -hls_list_size \
1219 10 -master_pl_publish_rate 10 -hls_flags \
1220 delete_segments+discont_start+split_by_time ./tmp/video.m3u8
1223 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=SUBTITLES} in
1224 the master playlist with webvtt subtitle group name 'subtitle'. Please make sure
1225 the input file has one text subtitle stream at least.
1228 Map string which specifies different closed captions groups and their
1229 attributes. The closed captions stream groups are separated by space.
1230 Expected string format is like this
1231 "ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....".
1232 'ccgroup' and 'instreamid' are mandatory attributes. 'language' is an optional
1234 The closed captions groups configured using this option are mapped to different
1235 variant streams by providing the same 'ccgroup' name in the
1236 @code{var_stream_map} string. If @code{var_stream_map} is not set, then the
1237 first available ccgroup in @code{cc_stream_map} is mapped to the output variant
1238 stream. The examples for these two use cases are given below.
1241 ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
1242 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
1243 -master_pl_name master.m3u8 \
1244 http://example.com/live/out.m3u8
1246 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=CLOSED-CAPTIONS} in
1247 the master playlist with group name 'cc', language 'en' (english) and
1248 INSTREAM-ID 'CC1'. Also, it adds @code{CLOSED-CAPTIONS} attribute with group
1249 name 'cc' for the output variant stream.
1251 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1252 -a53cc:0 1 -a53cc:1 1\
1253 -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
1254 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
1255 -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
1256 -master_pl_name master.m3u8 \
1257 http://example.com/live/out_%v.m3u8
1259 This example adds two @code{#EXT-X-MEDIA} tags with @code{TYPE=CLOSED-CAPTIONS} in
1260 the master playlist for the INSTREAM-IDs 'CC1' and 'CC2'. Also, it adds
1261 @code{CLOSED-CAPTIONS} attribute with group name 'cc' for the two output variant
1264 @item master_pl_name
1265 Create HLS master playlist with the given name.
1268 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
1270 This example creates HLS master playlist with name master.m3u8 and it is
1271 published at http://example.com/live/
1273 @item master_pl_publish_rate
1274 Publish master play list repeatedly every after specified number of segment intervals.
1277 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
1278 -hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
1281 This example creates HLS master playlist with name master.m3u8 and keep
1282 publishing it repeatedly every after 30 segments i.e. every after 60s.
1284 @item http_persistent
1285 Use persistent HTTP connections. Applicable only for HTTP output.
1288 Set timeout for socket I/O operations. Applicable only for HTTP output.
1290 @item -ignore_io_errors
1291 Ignore IO errors during open, write and delete. Useful for long-duration runs with network output.
1294 Set custom HTTP headers, can override built in default headers. Applicable only for HTTP output.
1303 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
1307 Size cannot exceed 256 pixels in any dimension
1310 Only BMP and PNG images can be stored
1313 If a BMP image is used, it must be one of the following pixel formats:
1315 BMP Bit Depth FFmpeg Pixel Format
1325 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
1328 If a PNG image is used, it must use the rgba pixel format
1336 The image file muxer writes video frames to image files.
1338 The output filenames are specified by a pattern, which can be used to
1339 produce sequentially numbered series of files.
1340 The pattern may contain the string "%d" or "%0@var{N}d", this string
1341 specifies the position of the characters representing a numbering in
1342 the filenames. If the form "%0@var{N}d" is used, the string
1343 representing the number in each filename is 0-padded to @var{N}
1344 digits. The literal character '%' can be specified in the pattern with
1347 If the pattern contains "%d" or "%0@var{N}d", the first filename of
1348 the file list specified will contain the number 1, all the following
1349 numbers will be sequential.
1351 The pattern may contain a suffix which is used to automatically
1352 determine the format of the image files to write.
1354 For example the pattern "img-%03d.bmp" will specify a sequence of
1355 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
1356 @file{img-010.bmp}, etc.
1357 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
1358 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
1361 The image muxer supports the .Y.U.V image file format. This format is
1362 special in that that each image frame consists of three files, for
1363 each of the YUV420P components. To read or write this image file format,
1364 specify the name of the '.Y' file. The muxer will automatically open the
1365 '.U' and '.V' files as required.
1371 If set to 1, expand the filename with pts from pkt->pts.
1375 Start the sequence from the specified number. Default value is 1.
1378 If set to 1, the filename will always be interpreted as just a
1379 filename, not a pattern, and the corresponding file will be continuously
1380 overwritten with new images. Default value is 0.
1383 If set to 1, expand the filename with date and time information from
1384 @code{strftime()}. Default value is 0.
1386 @item protocol_opts @var{options_list}
1387 Set protocol options as a :-separated list of key=value parameters. Values
1388 containing the @code{:} special character must be escaped.
1392 @subsection Examples
1394 The following example shows how to use @command{ffmpeg} for creating a
1395 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
1396 taking one image every second from the input video:
1398 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
1401 Note that with @command{ffmpeg}, if the format is not specified with the
1402 @code{-f} option and the output filename specifies an image file
1403 format, the image2 muxer is automatically selected, so the previous
1404 command can be written as:
1406 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
1409 Note also that the pattern must not necessarily contain "%d" or
1410 "%0@var{N}d", for example to create a single image file
1411 @file{img.jpeg} from the start of the input video you can employ the command:
1413 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
1416 The @option{strftime} option allows you to expand the filename with
1417 date and time information. Check the documentation of
1418 the @code{strftime()} function for the syntax.
1420 For example to generate image files from the @code{strftime()}
1421 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
1424 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
1427 You can set the file name with current frame's PTS:
1429 ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
1432 A more complex example is to publish contents of your desktop directly to a
1433 WebDAV server every second:
1435 ffmpeg -f x11grab -framerate 1 -i :0.0 -q:v 6 -update 1 -protocol_opts method=PUT http://example.com/desktop.jpg
1440 Matroska container muxer.
1442 This muxer implements the matroska and webm container specs.
1444 @subsection Metadata
1446 The recognized metadata settings in this muxer are:
1450 Set title name provided to a single track. This gets mapped to
1451 the FileDescription element for a stream written as attachment.
1454 Specify the language of the track in the Matroska languages form.
1456 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
1457 639-2/B) form (like "fre" for French), or a language code mixed with a
1458 country code for specialities in languages (like "fre-ca" for Canadian
1462 Set stereo 3D video layout of two views in a single video track.
1464 The following values are recognized:
1469 Both views are arranged side by side, Left-eye view is on the left
1471 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
1473 Both views are arranged in top-bottom orientation, Left-eye view is on top
1474 @item checkerboard_rl
1475 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
1476 @item checkerboard_lr
1477 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
1478 @item row_interleaved_rl
1479 Each view is constituted by a row based interleaving, Right-eye view is first row
1480 @item row_interleaved_lr
1481 Each view is constituted by a row based interleaving, Left-eye view is first row
1482 @item col_interleaved_rl
1483 Both views are arranged in a column based interleaving manner, Right-eye view is first column
1484 @item col_interleaved_lr
1485 Both views are arranged in a column based interleaving manner, Left-eye view is first column
1486 @item anaglyph_cyan_red
1487 All frames are in anaglyph format viewable through red-cyan filters
1489 Both views are arranged side by side, Right-eye view is on the left
1490 @item anaglyph_green_magenta
1491 All frames are in anaglyph format viewable through green-magenta filters
1493 Both eyes laced in one Block, Left-eye view is first
1495 Both eyes laced in one Block, Right-eye view is first
1499 For example a 3D WebM clip can be created using the following command line:
1501 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
1506 This muxer supports the following options:
1509 @item reserve_index_space
1510 By default, this muxer writes the index for seeking (called cues in Matroska
1511 terms) at the end of the file, because it cannot know in advance how much space
1512 to leave for the index at the beginning of the file. However for some use cases
1513 -- e.g. streaming where seeking is possible but slow -- it is useful to put the
1514 index at the beginning of the file.
1516 If this option is set to a non-zero value, the muxer will reserve a given amount
1517 of space in the file header and then try to write the cues there when the muxing
1518 finishes. If the reserved space does not suffice, no Cues will be written, the
1519 file will be finalized and writing the trailer will return an error.
1520 A safe size for most use cases should be about 50kB per hour of video.
1522 Note that cues are only written if the output is seekable and this option will
1523 have no effect if it is not.
1525 This option controls how the FlagDefault of the output tracks will be set.
1526 It influences which tracks players should play by default. The default mode
1530 In this mode, for each type of track (audio, video or subtitle), if there is
1531 a track with disposition default of this type, then the first such track
1532 (i.e. the one with the lowest index) will be marked as default; if no such
1533 track exists, the first track of this type will be marked as default instead
1534 (if existing). This ensures that the default flag is set in a sensible way even
1535 if the input originated from containers that lack the concept of default tracks.
1537 This mode is the same as infer except that if no subtitle track with
1538 disposition default exists, no subtitle track will be marked as default.
1540 In this mode the FlagDefault is set if and only if the AV_DISPOSITION_DEFAULT
1541 flag is set in the disposition of the corresponding stream.
1544 @item flipped_raw_rgb
1545 If set to true, store positive height for raw RGB bitmaps, which indicates
1546 bitmap is stored bottom-up. Note that this option does not flip the bitmap
1547 which has to be done manually beforehand, e.g. by using the vflip filter.
1548 Default is @var{false} and indicates bitmap is stored top down.
1557 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
1558 defaults to using the MD5 hash function.
1560 @subsection Examples
1562 To compute the MD5 hash of the input converted to raw
1563 audio and video, and store it in the file @file{out.md5}:
1565 ffmpeg -i INPUT -f md5 out.md5
1568 You can print the MD5 to stdout with the command:
1570 ffmpeg -i INPUT -f md5 -
1573 See also the @ref{hash} and @ref{framemd5} muxers.
1575 @section mov, mp4, ismv
1577 MOV/MP4/ISMV (Smooth Streaming) muxer.
1579 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
1580 file has all the metadata about all packets stored in one location
1581 (written at the end of the file, it can be moved to the start for
1582 better playback by adding @var{faststart} to the @var{movflags}, or
1583 using the @command{qt-faststart} tool). A fragmented
1584 file consists of a number of fragments, where packets and metadata
1585 about these packets are stored together. Writing a fragmented
1586 file has the advantage that the file is decodable even if the
1587 writing is interrupted (while a normal MOV/MP4 is undecodable if
1588 it is not properly finished), and it requires less memory when writing
1589 very long files (since writing normal MOV/MP4 files stores info about
1590 every single packet in memory until the file is closed). The downside
1591 is that it is less compatible with other applications.
1595 Fragmentation is enabled by setting one of the AVOptions that define
1596 how to cut the file into fragments:
1599 @item -moov_size @var{bytes}
1600 Reserves space for the moov atom at the beginning of the file instead of placing the
1601 moov atom at the end. If the space reserved is insufficient, muxing will fail.
1602 @item -movflags frag_keyframe
1603 Start a new fragment at each video keyframe.
1604 @item -frag_duration @var{duration}
1605 Create fragments that are @var{duration} microseconds long.
1606 @item -frag_size @var{size}
1607 Create fragments that contain up to @var{size} bytes of payload data.
1608 @item -movflags frag_custom
1609 Allow the caller to manually choose when to cut fragments, by
1610 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
1611 the packets written so far. (This is only useful with other
1612 applications integrating libavformat, not from @command{ffmpeg}.)
1613 @item -min_frag_duration @var{duration}
1614 Don't create fragments that are shorter than @var{duration} microseconds long.
1617 If more than one condition is specified, fragments are cut when
1618 one of the specified conditions is fulfilled. The exception to this is
1619 @code{-min_frag_duration}, which has to be fulfilled for any of the other
1620 conditions to apply.
1622 Additionally, the way the output file is written can be adjusted
1623 through a few other options:
1626 @item -movflags empty_moov
1627 Write an initial moov atom directly at the start of the file, without
1628 describing any samples in it. Generally, an mdat/moov pair is written
1629 at the start of the file, as a normal MOV/MP4 file, containing only
1630 a short portion of the file. With this option set, there is no initial
1631 mdat atom, and the moov atom only describes the tracks but has
1634 This option is implicitly set when writing ismv (Smooth Streaming) files.
1635 @item -movflags separate_moof
1636 Write a separate moof (movie fragment) atom for each track. Normally,
1637 packets for all tracks are written in a moof atom (which is slightly
1638 more efficient), but with this option set, the muxer writes one moof/mdat
1639 pair for each track, making it easier to separate tracks.
1641 This option is implicitly set when writing ismv (Smooth Streaming) files.
1642 @item -movflags skip_sidx
1643 Skip writing of sidx atom. When bitrate overhead due to sidx atom is high,
1644 this option could be used for cases where sidx atom is not mandatory.
1645 When global_sidx flag is enabled, this option will be ignored.
1646 @item -movflags faststart
1647 Run a second pass moving the index (moov atom) to the beginning of the file.
1648 This operation can take a while, and will not work in various situations such
1649 as fragmented output, thus it is not enabled by default.
1650 @item -movflags rtphint
1651 Add RTP hinting tracks to the output file.
1652 @item -movflags disable_chpl
1653 Disable Nero chapter markers (chpl atom). Normally, both Nero chapters
1654 and a QuickTime chapter track are written to the file. With this option
1655 set, only the QuickTime chapter track will be written. Nero chapters can
1656 cause failures when the file is reprocessed with certain tagging programs, like
1657 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1658 @item -movflags omit_tfhd_offset
1659 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1660 tying fragments to absolute byte positions in the file/streams.
1661 @item -movflags default_base_moof
1662 Similarly to the omit_tfhd_offset, this flag avoids writing the
1663 absolute base_data_offset field in tfhd atoms, but does so by using
1664 the new default-base-is-moof flag instead. This flag is new from
1665 14496-12:2012. This may make the fragments easier to parse in certain
1666 circumstances (avoiding basing track fragment location calculations
1667 on the implicit end of the previous track fragment).
1669 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1670 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1671 @item -movflags negative_cts_offsets
1672 Enables utilization of version 1 of the CTTS box, in which the CTS offsets can
1673 be negative. This enables the initial sample to have DTS/CTS of zero, and
1674 reduces the need for edit lists for some cases such as video tracks with
1675 B-frames. Additionally, eases conformance with the DASH-IF interoperability
1678 This option is implicitly set when writing ismv (Smooth Streaming) files.
1680 Write producer time reference box (PRFT) with a specified time source for the
1681 NTP field in the PRFT box. Set value as @samp{wallclock} to specify timesource
1682 as wallclock time and @samp{pts} to specify timesource as input packets' PTS
1685 Setting value to @samp{pts} is applicable only for a live encoding use case,
1686 where PTS values are set as as wallclock time at the source. For example, an
1687 encoding use case with decklink capture source where @option{video_pts} and
1688 @option{audio_pts} are set to @samp{abs_wallclock}.
1693 Smooth Streaming content can be pushed in real time to a publishing
1694 point on IIS with this muxer. Example:
1696 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1701 The MP3 muxer writes a raw MP3 stream with the following optional features:
1704 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1705 2.4 are supported, the @code{id3v2_version} private option controls which one is
1706 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1709 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1710 The pictures are supplied to the muxer in form of a video stream with a single
1711 packet. There can be any number of those streams, each will correspond to a
1712 single APIC frame. The stream metadata tags @var{title} and @var{comment} map
1713 to APIC @var{description} and @var{picture type} respectively. See
1714 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1716 Note that the APIC frames must be written at the beginning, so the muxer will
1717 buffer the audio frames until it gets all the pictures. It is therefore advised
1718 to provide the pictures as soon as possible to avoid excessive buffering.
1721 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1722 default, but will be written only if the output is seekable. The
1723 @code{write_xing} private option can be used to disable it. The frame contains
1724 various information that may be useful to the decoder, like the audio duration
1728 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1729 enabled with the @code{write_id3v1} private option, but as its capabilities are
1730 very limited, its usage is not recommended.
1735 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1737 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1740 To attach a picture to an mp3 file select both the audio and the picture stream
1743 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1744 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1747 Write a "clean" MP3 without any extra features:
1749 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1754 MPEG transport stream muxer.
1756 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1758 The recognized metadata settings in mpegts muxer are @code{service_provider}
1759 and @code{service_name}. If they are not set the default for
1760 @code{service_provider} is @samp{FFmpeg} and the default for
1761 @code{service_name} is @samp{Service01}.
1765 The muxer options are:
1768 @item mpegts_transport_stream_id @var{integer}
1769 Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1770 Default is @code{0x0001}.
1772 @item mpegts_original_network_id @var{integer}
1773 Set the @samp{original_network_id}. This is unique identifier of a
1774 network in DVB. Its main use is in the unique identification of a service
1775 through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1778 @item mpegts_service_id @var{integer}
1779 Set the @samp{service_id}, also known as program in DVB. Default is
1782 @item mpegts_service_type @var{integer}
1783 Set the program @samp{service_type}. Default is @code{digital_tv}.
1784 Accepts the following options:
1787 Any hexadecimal value between @code{0x01} and @code{0xff} as defined in
1792 Digital Radio service.
1795 @item advanced_codec_digital_radio
1796 Advanced Codec Digital Radio service.
1797 @item mpeg2_digital_hdtv
1798 MPEG2 Digital HDTV service.
1799 @item advanced_codec_digital_sdtv
1800 Advanced Codec Digital SDTV service.
1801 @item advanced_codec_digital_hdtv
1802 Advanced Codec Digital HDTV service.
1805 @item mpegts_pmt_start_pid @var{integer}
1806 Set the first PID for PMTs. Default is @code{0x1000}, minimum is @code{0x0020},
1807 maximum is @code{0x1ffa}. This option has no effect in m2ts mode where the PMT
1808 PID is fixed @code{0x0100}.
1810 @item mpegts_start_pid @var{integer}
1811 Set the first PID for elementary streams. Default is @code{0x0100}, minimum is
1812 @code{0x0020}, maximum is @code{0x1ffa}. This option has no effect in m2ts mode
1813 where the elementary stream PIDs are fixed.
1815 @item mpegts_m2ts_mode @var{boolean}
1816 Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1819 @item muxrate @var{integer}
1820 Set a constant muxrate. Default is VBR.
1822 @item pes_payload_size @var{integer}
1823 Set minimum PES packet payload in bytes. Default is @code{2930}.
1825 @item mpegts_flags @var{flags}
1826 Set mpegts flags. Accepts the following options:
1828 @item resend_headers
1829 Reemit PAT/PMT before writing the next packet.
1831 Use LATM packetization for AAC.
1832 @item pat_pmt_at_frames
1833 Reemit PAT and PMT at each video frame.
1835 Conform to System B (DVB) instead of System A (ATSC).
1836 @item initial_discontinuity
1837 Mark the initial packet of each stream as discontinuity.
1840 @item mpegts_copyts @var{boolean}
1841 Preserve original timestamps, if value is set to @code{1}. Default value
1842 is @code{-1}, which results in shifting timestamps so that they start from 0.
1844 @item omit_video_pes_length @var{boolean}
1845 Omit the PES packet length for video packets. Default is @code{1} (true).
1847 @item pcr_period @var{integer}
1848 Override the default PCR retransmission time in milliseconds. Default is
1849 @code{-1} which means that the PCR interval will be determined automatically:
1850 20 ms is used for CBR streams, the highest multiple of the frame duration which
1851 is less than 100 ms is used for VBR streams.
1853 @item pat_period @var{duration}
1854 Maximum time in seconds between PAT/PMT tables. Default is @code{0.1}.
1856 @item sdt_period @var{duration}
1857 Maximum time in seconds between SDT tables. Default is @code{0.5}.
1859 @item tables_version @var{integer}
1860 Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1861 This option allows updating stream structure so that standard consumer may
1862 detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1863 usage) or restart @command{ffmpeg} instance, cyclically changing
1864 @option{tables_version} value:
1867 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1868 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1870 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1871 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1872 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1880 ffmpeg -i file.mpg -c copy \
1881 -mpegts_original_network_id 0x1122 \
1882 -mpegts_transport_stream_id 0x3344 \
1883 -mpegts_service_id 0x5566 \
1884 -mpegts_pmt_start_pid 0x1500 \
1885 -mpegts_start_pid 0x150 \
1886 -metadata service_provider="Some provider" \
1887 -metadata service_name="Some Channel" \
1891 @section mxf, mxf_d10, mxf_opatom
1897 The muxer options are:
1900 @item store_user_comments @var{bool}
1901 Set if user comments should be stored if available or never.
1902 IRT D-10 does not allow user comments. The default is thus to write them for
1903 mxf and mxf_opatom but not for mxf_d10
1910 This muxer does not generate any output file, it is mainly useful for
1911 testing or benchmarking purposes.
1913 For example to benchmark decoding with @command{ffmpeg} you can use the
1916 ffmpeg -benchmark -i INPUT -f null out.null
1919 Note that the above command does not read or write the @file{out.null}
1920 file, but specifying the output file is required by the @command{ffmpeg}
1923 Alternatively you can write the command as:
1925 ffmpeg -benchmark -i INPUT -f null -
1931 @item -syncpoints @var{flags}
1932 Change the syncpoint usage in nut:
1934 @item @var{default} use the normal low-overhead seeking aids.
1935 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1936 Use of this option is not recommended, as the resulting files are very damage
1937 sensitive and seeking is not possible. Also in general the overhead from
1938 syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1939 all growing data tables, allowing to mux endless streams with limited memory
1940 and without these disadvantages.
1941 @item @var{timestamped} extend the syncpoint with a wallclock field.
1943 The @var{none} and @var{timestamped} flags are experimental.
1944 @item -write_index @var{bool}
1945 Write index at the end, the default is to write an index.
1949 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
1954 Ogg container muxer.
1957 @item -page_duration @var{duration}
1958 Preferred page duration, in microseconds. The muxer will attempt to create
1959 pages that are approximately @var{duration} microseconds long. This allows the
1960 user to compromise between seek granularity and container overhead. The default
1961 is 1 second. A value of 0 will fill all segments, making pages as large as
1962 possible. A value of 1 will effectively use 1 packet-per-page in most
1963 situations, giving a small seek granularity at the cost of additional container
1965 @item -serial_offset @var{value}
1966 Serial value from which to set the streams serial number.
1967 Setting it to different and sufficiently large values ensures that the produced
1968 ogg files can be safely chained.
1975 Raw muxers accept a single stream matching the designated codec. They do not store timestamps or metadata.
1976 The recognized extension is the same as the muxer name unless indicated otherwise.
1980 Dolby Digital, also known as AC-3, audio.
1984 CRI Middleware ADX audio.
1986 This muxer will write out the total sample count near the start of the first packet
1987 when the output is seekable and the count can be stored in 32 bits.
1991 aptX (Audio Processing Technology for Bluetooth) audio.
1995 aptX HD (Audio Processing Technology for Bluetooth) audio.
2001 AVS2-P2/IEEE1857.4 video.
2003 Extensions: avs, avs2
2005 @subsection cavsvideo
2007 Chinese AVS (Audio Video Standard) video.
2011 @subsection codec2raw
2015 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f codec2raw}.
2019 Data muxer accepts a single stream with any codec of any type.
2020 The input stream has to be selected using the @code {-map} option with the ffmpeg CLI tool.
2022 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f data}.
2026 BBC Dirac video. The Dirac Pro codec is a subset and is standardized as SMPTE VC-2.
2028 Extensions: drc, vc2
2032 Avid DNxHD video. It is standardized as SMPTE VC-3. Accepts DNxHR streams.
2034 Extensions: dnxhd, dnxhr
2038 DTS Coherent Acoustics (DCA) audio.
2042 Dolby Digital Plus, also known as Enhanced AC-3, audio.
2050 ITU-T G.723.1 audio.
2052 Extensions: tco, rco
2056 ITU-T G.726 big-endian ("left-justified") audio.
2058 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726}.
2062 ITU-T G.726 little-endian ("right-justified") audio.
2064 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726le}.
2068 Global System for Mobile Communications audio.
2076 ITU-T H.263 / H.263-1996, H.263+ / H.263-1998 / H.263 version 2 video.
2080 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.
2082 Extensions: h264, 264
2086 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.
2088 Extensions: hevc, h265, 265
2092 MPEG-4 Part 2 video.
2098 Extensions: mjpg, mjpeg
2102 Meridian Lossless Packing, also known as Packed PCM, audio.
2106 MPEG-1 Audio Layer II audio.
2108 Extensions: mp2, m2a, mpa
2110 @subsection mpeg1video
2112 MPEG-1 Part 2 video.
2114 Extensions: mpg, mpeg, m1v
2116 @subsection mpeg2video
2118 ITU-T H.262 / MPEG-2 Part 2 video.
2122 @subsection rawvideo
2124 Raw uncompressed video.
2126 Extensions: yuv, rgb
2130 Bluetooth SIG low-complexity subband codec audio.
2132 Extensions: sbc, msbc
2142 SMPTE 421M / VC-1 video.
2145 @section segment, stream_segment, ssegment
2147 Basic stream segmenter.
2149 This muxer outputs streams to a number of separate files of nearly
2150 fixed duration. Output filename pattern can be set in a fashion
2151 similar to @ref{image2}, or by using a @code{strftime} template if
2152 the @option{strftime} option is enabled.
2154 @code{stream_segment} is a variant of the muxer used to write to
2155 streaming output formats, i.e. which do not require global headers,
2156 and is recommended for outputting e.g. to MPEG transport stream segments.
2157 @code{ssegment} is a shorter alias for @code{stream_segment}.
2159 Every segment starts with a keyframe of the selected reference stream,
2160 which is set through the @option{reference_stream} option.
2162 Note that if you want accurate splitting for a video file, you need to
2163 make the input key frames correspond to the exact splitting times
2164 expected by the segmenter, or the segment muxer will start the new
2165 segment with the key frame found next after the specified start
2168 The segment muxer works best with a single constant frame rate video.
2170 Optionally it can generate a list of the created segments, by setting
2171 the option @var{segment_list}. The list type is specified by the
2172 @var{segment_list_type} option. The entry filenames in the segment
2173 list are set by default to the basename of the corresponding segment
2176 See also the @ref{hls} muxer, which provides a more specific
2177 implementation for HLS segmentation.
2181 The segment muxer supports the following options:
2184 @item increment_tc @var{1|0}
2185 if set to @code{1}, increment timecode between each segment
2186 If this is selected, the input need to have
2187 a timecode in the first video stream. Default value is
2190 @item reference_stream @var{specifier}
2191 Set the reference stream, as specified by the string @var{specifier}.
2192 If @var{specifier} is set to @code{auto}, the reference is chosen
2193 automatically. Otherwise it must be a stream specifier (see the ``Stream
2194 specifiers'' chapter in the ffmpeg manual) which specifies the
2195 reference stream. The default value is @code{auto}.
2197 @item segment_format @var{format}
2198 Override the inner container format, by default it is guessed by the filename
2201 @item segment_format_options @var{options_list}
2202 Set output format options using a :-separated list of key=value
2203 parameters. Values containing the @code{:} special character must be
2206 @item segment_list @var{name}
2207 Generate also a listfile named @var{name}. If not specified no
2208 listfile is generated.
2210 @item segment_list_flags @var{flags}
2211 Set flags affecting the segment list generation.
2213 It currently supports the following flags:
2216 Allow caching (only affects M3U8 list files).
2219 Allow live-friendly file generation.
2222 @item segment_list_size @var{size}
2223 Update the list file so that it contains at most @var{size}
2224 segments. If 0 the list file will contain all the segments. Default
2227 @item segment_list_entry_prefix @var{prefix}
2228 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
2229 By default no prefix is applied.
2231 @item segment_list_type @var{type}
2232 Select the listing format.
2234 The following values are recognized:
2237 Generate a flat list for the created segments, one segment per line.
2240 Generate a list for the created segments, one segment per line,
2241 each line matching the format (comma-separated values):
2243 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
2246 @var{segment_filename} is the name of the output file generated by the
2247 muxer according to the provided pattern. CSV escaping (according to
2248 RFC4180) is applied if required.
2250 @var{segment_start_time} and @var{segment_end_time} specify
2251 the segment start and end time expressed in seconds.
2253 A list file with the suffix @code{".csv"} or @code{".ext"} will
2254 auto-select this format.
2256 @samp{ext} is deprecated in favor or @samp{csv}.
2259 Generate an ffconcat file for the created segments. The resulting file
2260 can be read using the FFmpeg @ref{concat} demuxer.
2262 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
2263 auto-select this format.
2266 Generate an extended M3U8 file, version 3, compliant with
2267 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
2269 A list file with the suffix @code{".m3u8"} will auto-select this format.
2272 If not specified the type is guessed from the list file name suffix.
2274 @item segment_time @var{time}
2275 Set segment duration to @var{time}, the value must be a duration
2276 specification. Default value is "2". See also the
2277 @option{segment_times} option.
2279 Note that splitting may not be accurate, unless you force the
2280 reference stream key-frames at the given time. See the introductory
2281 notice and the examples below.
2283 @item segment_atclocktime @var{1|0}
2284 If set to "1" split at regular clock time intervals starting from 00:00
2285 o'clock. The @var{time} value specified in @option{segment_time} is
2286 used for setting the length of the splitting interval.
2288 For example with @option{segment_time} set to "900" this makes it possible
2289 to create files at 12:00 o'clock, 12:15, 12:30, etc.
2291 Default value is "0".
2293 @item segment_clocktime_offset @var{duration}
2294 Delay the segment splitting times with the specified duration when using
2295 @option{segment_atclocktime}.
2297 For example with @option{segment_time} set to "900" and
2298 @option{segment_clocktime_offset} set to "300" this makes it possible to
2299 create files at 12:05, 12:20, 12:35, etc.
2301 Default value is "0".
2303 @item segment_clocktime_wrap_duration @var{duration}
2304 Force the segmenter to only start a new segment if a packet reaches the muxer
2305 within the specified duration after the segmenting clock time. This way you
2306 can make the segmenter more resilient to backward local time jumps, such as
2307 leap seconds or transition to standard time from daylight savings time.
2309 Default is the maximum possible duration which means starting a new segment
2310 regardless of the elapsed time since the last clock time.
2312 @item segment_time_delta @var{delta}
2313 Specify the accuracy time when selecting the start time for a
2314 segment, expressed as a duration specification. Default value is "0".
2316 When delta is specified a key-frame will start a new segment if its
2317 PTS satisfies the relation:
2319 PTS >= start_time - time_delta
2322 This option is useful when splitting video content, which is always
2323 split at GOP boundaries, in case a key frame is found just before the
2324 specified split time.
2326 In particular may be used in combination with the @file{ffmpeg} option
2327 @var{force_key_frames}. The key frame times specified by
2328 @var{force_key_frames} may not be set accurately because of rounding
2329 issues, with the consequence that a key frame time may result set just
2330 before the specified time. For constant frame rate videos a value of
2331 1/(2*@var{frame_rate}) should address the worst case mismatch between
2332 the specified time and the time set by @var{force_key_frames}.
2334 @item segment_times @var{times}
2335 Specify a list of split points. @var{times} contains a list of comma
2336 separated duration specifications, in increasing order. See also
2337 the @option{segment_time} option.
2339 @item segment_frames @var{frames}
2340 Specify a list of split video frame numbers. @var{frames} contains a
2341 list of comma separated integer numbers, in increasing order.
2343 This option specifies to start a new segment whenever a reference
2344 stream key frame is found and the sequential number (starting from 0)
2345 of the frame is greater or equal to the next value in the list.
2347 @item segment_wrap @var{limit}
2348 Wrap around segment index once it reaches @var{limit}.
2350 @item segment_start_number @var{number}
2351 Set the sequence number of the first segment. Defaults to @code{0}.
2353 @item strftime @var{1|0}
2354 Use the @code{strftime} function to define the name of the new
2355 segments to write. If this is selected, the output segment name must
2356 contain a @code{strftime} function template. Default value is
2359 @item break_non_keyframes @var{1|0}
2360 If enabled, allow segments to start on frames other than keyframes. This
2361 improves behavior on some players when the time between keyframes is
2362 inconsistent, but may make things worse on others, and can cause some oddities
2363 during seeking. Defaults to @code{0}.
2365 @item reset_timestamps @var{1|0}
2366 Reset timestamps at the beginning of each segment, so that each segment
2367 will start with near-zero timestamps. It is meant to ease the playback
2368 of the generated segments. May not work with some combinations of
2369 muxers/codecs. It is set to @code{0} by default.
2371 @item initial_offset @var{offset}
2372 Specify timestamp offset to apply to the output packet timestamps. The
2373 argument must be a time duration specification, and defaults to 0.
2375 @item write_empty_segments @var{1|0}
2376 If enabled, write an empty segment if there are no packets during the period a
2377 segment would usually span. Otherwise, the segment will be filled with the next
2378 packet written. Defaults to @code{0}.
2381 Make sure to require a closed GOP when encoding and to set the GOP
2382 size to fit your segment time constraint.
2384 @subsection Examples
2388 Remux the content of file @file{in.mkv} to a list of segments
2389 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
2390 generated segments to @file{out.list}:
2392 ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
2396 Segment input and set output format options for the output segments:
2398 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
2402 Segment the input file according to the split points specified by the
2403 @var{segment_times} option:
2405 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
2409 Use the @command{ffmpeg} @option{force_key_frames}
2410 option to force key frames in the input at the specified location, together
2411 with the segment option @option{segment_time_delta} to account for
2412 possible roundings operated when setting key frame times.
2414 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
2415 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
2417 In order to force key frames on the input file, transcoding is
2421 Segment the input file by splitting the input file according to the
2422 frame numbers sequence specified with the @option{segment_frames} option:
2424 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
2428 Convert the @file{in.mkv} to TS segments using the @code{libx264}
2429 and @code{aac} encoders:
2431 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
2435 Segment the input file, and create an M3U8 live playlist (can be used
2436 as live HLS source):
2438 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
2439 -segment_list_flags +live -segment_time 10 out%03d.mkv
2443 @section smoothstreaming
2445 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
2449 Specify the number of fragments kept in the manifest. Default 0 (keep all).
2451 @item extra_window_size
2452 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
2454 @item lookahead_count
2455 Specify the number of lookahead fragments. Default 2.
2457 @item min_frag_duration
2458 Specify the minimum fragment duration (in microseconds). Default 5000000.
2460 @item remove_at_exit
2461 Specify whether to remove all fragments when finished. Default 0 (do not remove).
2468 Per stream hash testing format.
2470 This muxer computes and prints a cryptographic hash of all the input frames,
2471 on a per-stream basis. This can be used for equality checks without having
2472 to do a complete binary comparison.
2474 By default audio frames are converted to signed 16-bit raw audio and
2475 video frames to raw video before computing the hash, but the output
2476 of explicit conversions to other codecs can also be used. Timestamps
2477 are ignored. It uses the SHA-256 cryptographic hash function by default,
2478 but supports several other algorithms.
2480 The output of the muxer consists of one line per stream of the form:
2481 @var{streamindex},@var{streamtype},@var{algo}=@var{hash}, where
2482 @var{streamindex} is the index of the mapped stream, @var{streamtype} is a
2483 single character indicating the type of stream, @var{algo} is a short string
2484 representing the hash function used, and @var{hash} is a hexadecimal number
2485 representing the computed hash.
2488 @item hash @var{algorithm}
2489 Use the cryptographic hash function specified by the string @var{algorithm}.
2490 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
2491 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
2492 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
2493 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
2497 @subsection Examples
2499 To compute the SHA-256 hash of the input converted to raw audio and
2500 video, and store it in the file @file{out.sha256}:
2502 ffmpeg -i INPUT -f streamhash out.sha256
2505 To print an MD5 hash to stdout use the command:
2507 ffmpeg -i INPUT -f streamhash -hash md5 -
2510 See also the @ref{hash} and @ref{framehash} muxers.
2515 The tee muxer can be used to write the same data to several outputs, such as files or streams.
2516 It can be used, for example, to stream a video over a network and save it to disk at the same time.
2518 It is different from specifying several outputs to the @command{ffmpeg}
2519 command-line tool. With the tee muxer, the audio and video data will be encoded only once.
2520 With conventional multiple outputs, multiple encoding operations in parallel are initiated,
2521 which can be a very expensive process. The tee muxer is not useful when using the libavformat API
2522 directly because it is then possible to feed the same packets to several muxers directly.
2524 Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select
2525 output streams. So all streams intended for output must be specified using @code{-map}. See
2528 Some encoders may need different options depending on the output format;
2529 the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified.
2530 The main example is the @option{global_header} flag.
2532 The slave outputs are specified in the file name given to the muxer,
2533 separated by '|'. If any of the slave name contains the '|' separator,
2534 leading or trailing spaces or any special character, those must be
2535 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
2536 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
2542 @item use_fifo @var{bool}
2543 If set to 1, slave outputs will be processed in separate threads using the @ref{fifo}
2544 muxer. This allows to compensate for different speed/latency/reliability of
2545 outputs and setup transparent recovery. By default this feature is turned off.
2548 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
2552 Muxer options can be specified for each slave by prepending them as a list of
2553 @var{key}=@var{value} pairs separated by ':', between square brackets. If
2554 the options values contain a special character or the ':' separator, they
2555 must be escaped; note that this is a second level escaping.
2557 The following special options are also recognized:
2560 Specify the format name. Required if it cannot be guessed from the
2563 @item bsfs[/@var{spec}]
2564 Specify a list of bitstream filters to apply to the specified
2567 It is possible to specify to which streams a given bitstream filter
2568 applies, by appending a stream specifier to the option separated by
2569 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
2570 stream specifiers}).
2572 If the stream specifier is not specified, the bitstream filters will be
2573 applied to all streams in the output. This will cause that output operation
2574 to fail if the output contains streams to which the bitstream filter cannot
2575 be applied e.g. @code{h264_mp4toannexb} being applied to an output containing an audio stream.
2577 Options for a bitstream filter must be specified in the form of @code{opt=value}.
2579 Several bitstream filters can be specified, separated by ",".
2581 @item use_fifo @var{bool}
2582 This allows to override tee muxer use_fifo option for individual slave muxer.
2585 This allows to override tee muxer fifo_options for individual slave muxer.
2589 Select the streams that should be mapped to the slave output,
2590 specified by a stream specifier. If not specified, this defaults to
2591 all the mapped streams. This will cause that output operation to fail
2592 if the output format does not accept all mapped streams.
2594 You may use multiple stream specifiers separated by commas (@code{,}) e.g.: @code{a:0,v}
2597 Specify behaviour on output failure. This can be set to either @code{abort} (which is
2598 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
2599 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
2600 will continue without being affected.
2603 @subsection Examples
2607 Encode something and both archive it in a WebM file and stream it
2608 as MPEG-TS over UDP:
2610 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2611 "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2615 As above, but continue streaming even if output to local file fails
2616 (for example local drive fills up):
2618 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2619 "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2623 Use @command{ffmpeg} to encode the input, and send the output
2624 to three different destinations. The @code{dump_extra} bitstream
2625 filter is used to add extradata information to all the output video
2626 keyframes packets, as requested by the MPEG-TS format. The select
2627 option is applied to @file{out.aac} in order to make it contain only
2630 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2631 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
2635 As above, but select only stream @code{a:1} for the audio output. Note
2636 that a second level escaping must be performed, as ":" is a special
2637 character used to separate options.
2639 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2640 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
2646 WebM Live Chunk Muxer.
2648 This muxer writes out WebM headers and chunks as separate files which can be
2649 consumed by clients that support WebM Live streams via DASH.
2653 This muxer supports the following options:
2656 @item chunk_start_index
2657 Index of the first chunk (defaults to 0).
2660 Filename of the header where the initialization data will be written.
2662 @item audio_chunk_duration
2663 Duration of each audio chunk in milliseconds (defaults to 5000).
2668 ffmpeg -f v4l2 -i /dev/video0 \
2672 -s 640x360 -keyint_min 30 -g 30 \
2674 -header webm_live_video_360.hdr \
2675 -chunk_start_index 1 \
2676 webm_live_video_360_%d.chk \
2681 -header webm_live_audio_128.hdr \
2682 -chunk_start_index 1 \
2683 -audio_chunk_duration 1000 \
2684 webm_live_audio_128_%d.chk
2687 @section webm_dash_manifest
2689 WebM DASH Manifest muxer.
2691 This muxer implements the WebM DASH Manifest specification to generate the DASH
2692 manifest XML. It also supports manifest generation for DASH live streams.
2694 For more information see:
2698 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
2700 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
2705 This muxer supports the following options:
2708 @item adaptation_sets
2709 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
2710 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
2711 audio and video streams. Any number of adaptation sets can be added using this option.
2714 Set this to 1 to create a live stream DASH Manifest. Default: 0.
2716 @item chunk_start_index
2717 Start index of the first chunk. This will go in the @samp{startNumber} attribute
2718 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
2720 @item chunk_duration_ms
2721 Duration of each chunk in milliseconds. This will go in the @samp{duration}
2722 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
2724 @item utc_timing_url
2725 URL of the page that will return the UTC timestamp in ISO format. This will go
2726 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
2729 @item time_shift_buffer_depth
2730 Smallest time (in seconds) shifting buffer for which any Representation is
2731 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
2732 attribute of the @samp{MPD} element. Default: 60.
2734 @item minimum_update_period
2735 Minimum update period (in seconds) of the manifest. This will go in the
2736 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
2742 ffmpeg -f webm_dash_manifest -i video1.webm \
2743 -f webm_dash_manifest -i video2.webm \
2744 -f webm_dash_manifest -i audio1.webm \
2745 -f webm_dash_manifest -i audio2.webm \
2746 -map 0 -map 1 -map 2 -map 3 \
2748 -f webm_dash_manifest \
2749 -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \