4 Muxers are configured elements in FFmpeg which allow writing
5 multimedia streams to a particular type of file.
7 When you configure your FFmpeg build, all the supported muxers
8 are enabled by default. You can list all available muxers using the
9 configure option @code{--list-muxers}.
11 You can disable all the muxers with the configure option
12 @code{--disable-muxers} and selectively enable / disable single muxers
13 with the options @code{--enable-muxer=@var{MUXER}} /
14 @code{--disable-muxer=@var{MUXER}}.
16 The option @code{-muxers} of the ff* tools will display the list of
17 enabled muxers. Use @code{-formats} to view a combined list of
18 enabled demuxers and muxers.
20 A description of some of the currently available muxers follows.
25 A64 muxer for Commodore 64 video. Accepts a single @code{a64_multi} or @code{a64_multi5} codec video stream.
30 Audio Data Transport Stream muxer. It accepts a single AAC stream.
34 It accepts the following options:
38 @item write_id3v2 @var{bool}
39 Enable to write ID3v2.4 tags at the start of the stream. Default is disabled.
41 @item write_apetag @var{bool}
42 Enable to write APE tags at the end of the stream. Default is disabled.
44 @item write_mpeg2 @var{bool}
45 Enable to set MPEG version bit in the ADTS frame header to 1 which indicates MPEG-2. Default is 0, which indicates MPEG-4.
52 Audio Interchange File Format muxer.
56 It accepts the following options:
60 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
63 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
64 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
71 Advanced Systems Format muxer.
73 Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this
78 It accepts the following options:
82 Set the muxer packet size. By tuning this setting you may reduce data
83 fragmentation or muxer overhead depending on your source. Default value is
84 3200, minimum is 100, maximum is 64k.
91 Audio Video Interleaved muxer.
95 It accepts the following options:
98 @item reserve_index_space
99 Reserve the specified amount of bytes for the OpenDML master index of each
100 stream within the file header. By default additional master indexes are
101 embedded within the data packets if there is no space left in the first master
102 index and are linked together as a chain of indexes. This index structure can
103 cause problems for some use cases, e.g. third-party software strictly relying
104 on the OpenDML index specification or when file seeking is slow. Reserving
105 enough index space in the file header avoids these problems.
107 The required index space depends on the output file size and should be about 16
108 bytes per gigabyte. When this option is omitted or set to zero the necessary
109 index space is guessed.
111 @item write_channel_mask
112 Write the channel layout mask into the audio stream header.
114 This option is enabled by default. Disabling the channel mask can be useful in
115 specific scenarios, e.g. when merging multiple audio streams into one for
116 compatibility with software that only supports a single audio stream in AVI
117 (see @ref{amerge,,the "amerge" section in the ffmpeg-filters manual,ffmpeg-filters}).
119 @item flipped_raw_rgb
120 If set to true, store positive height for raw RGB bitmaps, which indicates
121 bitmap is stored bottom-up. Note that this option does not flip the bitmap
122 which has to be done manually beforehand, e.g. by using the vflip filter.
123 Default is @var{false} and indicates bitmap is stored top down.
130 Chromaprint fingerprinter.
132 This muxer feeds audio data to the Chromaprint library,
133 which generates a fingerprint for the provided audio data. See @url{https://acoustid.org/chromaprint}
135 It takes a single signed native-endian 16-bit raw audio stream of at most 2 channels.
140 @item silence_threshold
141 Threshold for detecting silence. Range is from -1 to 32767, where -1 disables
142 silence detection. Silence detection can only be used with version 3 of the
144 Silence detection must be disabled for use with the AcoustID service. Default is -1.
147 Version of algorithm to fingerprint with. Range is 0 to 4.
148 Version 3 enables silence detection. Default is 1.
151 Format to output the fingerprint as. Accepts the following options:
154 Binary raw fingerprint
157 Binary compressed fingerprint
160 Base64 compressed fingerprint @emph{(default)}
169 CRC (Cyclic Redundancy Check) testing format.
171 This muxer computes and prints the Adler-32 CRC of all the input audio
172 and video frames. By default audio frames are converted to signed
173 16-bit raw audio and video frames to raw video before computing the
176 The output of the muxer consists of a single line of the form:
177 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
178 8 digits containing the CRC for all the decoded input frames.
180 See also the @ref{framecrc} muxer.
184 For example to compute the CRC of the input, and store it in the file
187 ffmpeg -i INPUT -f crc out.crc
190 You can print the CRC to stdout with the command:
192 ffmpeg -i INPUT -f crc -
195 You can select the output format of each frame with @command{ffmpeg} by
196 specifying the audio and video codec and format. For example to
197 compute the CRC of the input audio converted to PCM unsigned 8-bit
198 and the input video converted to MPEG-2 video, use the command:
200 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
206 Dynamic Adaptive Streaming over HTTP (DASH) muxer that creates segments
207 and manifest files according to the MPEG-DASH standard ISO/IEC 23009-1:2014.
209 For more information see:
213 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
215 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
218 It creates a MPD manifest file and segment files for each stream.
220 The segment filename might contain pre-defined identifiers used with SegmentTemplate
221 as defined in section 5.3.9.4.4 of the standard. Available identifiers are "$RepresentationID$",
222 "$Number$", "$Bandwidth$" and "$Time$".
223 In addition to the standard identifiers, an ffmpeg-specific "$ext$" identifier is also supported.
224 When specified ffmpeg will replace $ext$ in the file name with muxing format's extensions such as mp4, webm etc.,
227 ffmpeg -re -i <input> -map 0 -map 0 -c:a libfdk_aac -c:v libx264 \
228 -b:v:0 800k -b:v:1 300k -s:v:1 320x170 -profile:v:1 baseline \
229 -profile:v:0 main -bf 1 -keyint_min 120 -g 120 -sc_threshold 0 \
230 -b_strategy 0 -ar:a:1 22050 -use_timeline 1 -use_template 1 \
231 -window_size 5 -adaptation_sets "id=0,streams=v id=1,streams=a" \
232 -f dash /path/to/out.mpd
236 @item min_seg_duration @var{microseconds}
237 This is a deprecated option to set the segment length in microseconds, use @var{seg_duration} instead.
238 @item seg_duration @var{duration}
239 Set the segment length in seconds (fractional value can be set). The value is
240 treated as average segment duration when @var{use_template} is enabled and
241 @var{use_timeline} is disabled and as minimum segment duration for all the other
243 @item frag_duration @var{duration}
244 Set the length in seconds of fragments within segments (fractional value can be set).
245 @item frag_type @var{type}
246 Set the type of interval for fragmentation.
247 @item window_size @var{size}
248 Set the maximum number of segments kept in the manifest.
249 @item extra_window_size @var{size}
250 Set the maximum number of segments kept outside of the manifest before removing from disk.
251 @item remove_at_exit @var{remove}
252 Enable (1) or disable (0) removal of all segments when finished.
253 @item use_template @var{template}
254 Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList.
255 @item use_timeline @var{timeline}
256 Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate.
257 @item single_file @var{single_file}
258 Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges.
259 @item single_file_name @var{file_name}
260 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.
261 @item init_seg_name @var{init_name}
262 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.
263 @item media_seg_name @var{segment_name}
264 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.
265 @item utc_timing_url @var{utc_url}
266 URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso"
267 @item method @var{method}
268 Use the given HTTP method to create output files. Generally set to PUT or POST.
269 @item http_user_agent @var{user_agent}
270 Override User-Agent field in HTTP header. Applicable only for HTTP output.
271 @item http_persistent @var{http_persistent}
272 Use persistent HTTP connections. Applicable only for HTTP output.
273 @item hls_playlist @var{hls_playlist}
274 Generate HLS playlist files as well. The master playlist is generated with the filename @var{hls_master_name}.
275 One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc.
276 @item hls_master_name @var{file_name}
277 HLS master playlist name. Default is "master.m3u8".
278 @item streaming @var{streaming}
279 Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming
280 mode, each frame will be a moof fragment which forms a chunk.
281 @item adaptation_sets @var{adaptation_sets}
282 Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs
283 of the adaptation sets and a,b,c,d and e are the indices of the mapped streams.
285 To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs.
287 When no assignment is defined, this defaults to an AdaptationSet for each stream.
289 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,
290 descriptor is useful to the scheme defined by ISO/IEC 23009-1:2014/Amd.2:2015.
291 For example, -adaptation_sets "id=0,descriptor=<SupplementalProperty schemeIdUri=\"urn:mpeg:dash:srd:2014\" value=\"0,0,0,1,1,2,2\"/>,streams=v".
292 Please note that descriptor string should be a self-closing xml tag.
293 seg_duration, frag_duration and frag_type override the global option values for each adaptation set.
294 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"
295 type_id marks an adaptation set as containing streams meant to be used for Trick Mode for the referenced adaptation set.
296 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"
297 @item timeout @var{timeout}
298 Set timeout for socket I/O operations. Applicable only for HTTP output.
299 @item index_correction @var{index_correction}
300 Enable (1) or Disable (0) segment index correction logic. Applicable only when
301 @var{use_template} is enabled and @var{use_timeline} is disabled.
303 When enabled, the logic monitors the flow of segment indexes. If a streams's
304 segment index value is not at the expected real time position, then the logic
305 corrects that index value.
307 Typically this logic is needed in live streaming use cases. The network bandwidth
308 fluctuations are common during long run streaming. Each fluctuation can cause
309 the segment indexes fall behind the expected real time position.
310 @item format_options @var{options_list}
311 Set container format (mp4/webm) options using a @code{:} separated list of
312 key=value parameters. Values containing @code{:} special characters must be
315 @item global_sidx @var{global_sidx}
316 Write global SIDX atom. Applicable only for single file, mp4 output, non-streaming mode.
318 @item dash_segment_type @var{dash_segment_type}
322 If this flag is set, the dash segment files format will be selected based on the stream codec. This is the default mode.
325 If this flag is set, the dash segment files will be in in ISOBMFF format.
328 If this flag is set, the dash segment files will be in in WebM format.
331 @item ignore_io_errors @var{ignore_io_errors}
332 Ignore IO errors during open and write. Useful for long-duration runs with network output.
334 @item lhls @var{lhls}
335 Enable Low-latency HLS(LHLS). Adds #EXT-X-PREFETCH tag with current segment's URI.
336 Apple doesn't have an official spec for LHLS. Meanwhile hls.js player folks are
337 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
338 This option will also try to comply with the above open spec, till Apple's spec officially supports it.
339 Applicable only when @var{streaming} and @var{hls_playlist} options are enabled.
340 This is an experimental feature.
342 @item ldash @var{ldash}
343 Enable Low-latency Dash by constraining the presence and values of some elements.
345 @item master_m3u8_publish_rate @var{master_m3u8_publish_rate}
346 Publish master playlist repeatedly every after specified number of segment intervals.
348 @item write_prft @var{write_prft}
349 Write Producer Reference Time elements on supported streams. This also enables writing
350 prft boxes in the underlying muxer. Applicable only when the @var{utc_url} option is enabled.
351 It's set to auto by default, in which case the muxer will attempt to enable it only in modes
354 @item mpd_profile @var{mpd_profile}
355 Set one or more manifest profiles.
357 @item http_opts @var{http_opts}
358 A :-separated list of key=value options to pass to the underlying HTTP
359 protocol. Applicable only for HTTP output.
361 @item target_latency @var{target_latency}
362 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.
363 This is an informative fields clients can use to measure the latency of the service.
365 @item min_playback_rate @var{min_playback_rate}
366 Set the minimum playback rate indicated as appropriate for the purposes of automatically
367 adjusting playback latency and buffer occupancy during normal playback by clients.
369 @item max_playback_rate @var{max_playback_rate}
370 Set the maximum playback rate indicated as appropriate for the purposes of automatically
371 adjusting playback latency and buffer occupancy during normal playback by clients.
373 @item update_period @var{update_period}
374 Set the mpd update period ,for dynamic content.
382 The fifo pseudo-muxer allows the separation of encoding and muxing by using
383 first-in-first-out queue and running the actual muxer in a separate thread. This
384 is especially useful in combination with the @ref{tee} muxer and can be used to
385 send data to several destinations with different reliability/writing speed/latency.
387 API users should be aware that callback functions (interrupt_callback,
388 io_open and io_close) used within its AVFormatContext must be thread-safe.
390 The behavior of the fifo muxer if the queue fills up or if the output fails is
396 output can be transparently restarted with configurable delay between retries
397 based on real time or time of the processed stream.
400 encoding can be blocked during temporary failure, or continue transparently
401 dropping packets in case fifo queue fills up.
408 Specify the format name. Useful if it cannot be guessed from the
412 Specify size of the queue (number of packets). Default value is 60.
415 Specify format options for the underlying muxer. Muxer options can be specified
416 as a list of @var{key}=@var{value} pairs separated by ':'.
418 @item drop_pkts_on_overflow @var{bool}
419 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
420 rather than blocking the encoder. This makes it possible to continue streaming without
421 delaying the input, at the cost of omitting part of the stream. By default
422 this option is set to 0 (false), so in such cases the encoder will be blocked
423 until the muxer processes some of the packets and none of them is lost.
425 @item attempt_recovery @var{bool}
426 If failure occurs, attempt to recover the output. This is especially useful
427 when used with network output, since it makes it possible to restart streaming transparently.
428 By default this option is set to 0 (false).
430 @item max_recovery_attempts
431 Sets maximum number of successive unsuccessful recovery attempts after which
432 the output fails permanently. By default this option is set to 0 (unlimited).
434 @item recovery_wait_time @var{duration}
435 Waiting time before the next recovery attempt after previous unsuccessful
436 recovery attempt. Default value is 5 seconds.
438 @item recovery_wait_streamtime @var{bool}
439 If set to 0 (false), the real time is used when waiting for the recovery
440 attempt (i.e. the recovery will be attempted after at least
441 recovery_wait_time seconds).
442 If set to 1 (true), the time of the processed stream is taken into account
443 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
444 seconds of the stream is omitted).
445 By default, this option is set to 0 (false).
447 @item recover_any_error @var{bool}
448 If set to 1 (true), recovery will be attempted regardless of type of the error
449 causing the failure. By default this option is set to 0 (false) and in case of
450 certain (usually permanent) errors the recovery is not attempted even when
451 @var{attempt_recovery} is set to 1.
453 @item restart_with_keyframe @var{bool}
454 Specify whether to wait for the keyframe after recovering from
455 queue overflow or failure. This option is set to 0 (false) by default.
457 @item timeshift @var{duration}
458 Buffer the specified amount of packets and delay writing the output. Note that
459 @var{queue_size} must be big enough to store the packets for timeshift. At the
460 end of the input the fifo buffer is flushed at realtime speed.
469 Stream something to rtmp server, continue processing the stream at real-time
470 rate even in case of temporary failure (network outage) and attempt to recover
471 streaming every second indefinitely.
473 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
474 -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
481 Adobe Flash Video Format muxer.
483 This muxer accepts the following options:
487 @item flvflags @var{flags}
492 @item aac_seq_header_detect
493 Place AAC sequence header based on audio stream data.
495 @item no_sequence_end
496 Disable sequence end tag.
499 Disable metadata tag.
501 @item no_duration_filesize
502 Disable duration and filesize in metadata when they are equal to zero
503 at the end of stream. (Be used to non-seekable living stream).
505 @item add_keyframe_index
506 Used to facilitate seeking; particularly for HTTP pseudo streaming.
513 Per-packet CRC (Cyclic Redundancy Check) testing format.
515 This muxer computes and prints the Adler-32 CRC for each audio
516 and video packet. By default audio frames are converted to signed
517 16-bit raw audio and video frames to raw video before computing the
520 The output of the muxer consists of a line for each audio and video
523 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
526 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
531 For example to compute the CRC of the audio and video frames in
532 @file{INPUT}, converted to raw audio and video packets, and store it
533 in the file @file{out.crc}:
535 ffmpeg -i INPUT -f framecrc out.crc
538 To print the information to stdout, use the command:
540 ffmpeg -i INPUT -f framecrc -
543 With @command{ffmpeg}, you can select the output format to which the
544 audio and video frames are encoded before computing the CRC for each
545 packet by specifying the audio and video codec. For example, to
546 compute the CRC of each decoded input audio frame converted to PCM
547 unsigned 8-bit and of each decoded input video frame converted to
548 MPEG-2 video, use the command:
550 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
553 See also the @ref{crc} muxer.
558 Per-packet hash testing format.
560 This muxer computes and prints a cryptographic hash for each audio
561 and video packet. This can be used for packet-by-packet equality
562 checks without having to individually do a binary comparison on each.
564 By default audio frames are converted to signed 16-bit raw audio and
565 video frames to raw video before computing the hash, but the output
566 of explicit conversions to other codecs can also be used. It uses the
567 SHA-256 cryptographic hash function by default, but supports several
570 The output of the muxer consists of a line for each audio and video
573 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
576 @var{hash} is a hexadecimal number representing the computed hash
580 @item hash @var{algorithm}
581 Use the cryptographic hash function specified by the string @var{algorithm}.
582 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
583 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
584 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
585 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
591 To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
592 converted to raw audio and video packets, and store it in the file
595 ffmpeg -i INPUT -f framehash out.sha256
598 To print the information to stdout, using the MD5 hash function, use
601 ffmpeg -i INPUT -f framehash -hash md5 -
604 See also the @ref{hash} muxer.
609 Per-packet MD5 testing format.
611 This is a variant of the @ref{framehash} muxer. Unlike that muxer,
612 it defaults to using the MD5 hash function.
616 To compute the MD5 hash of the audio and video frames in @file{INPUT},
617 converted to raw audio and video packets, and store it in the file
620 ffmpeg -i INPUT -f framemd5 out.md5
623 To print the information to stdout, use the command:
625 ffmpeg -i INPUT -f framemd5 -
628 See also the @ref{framehash} and @ref{md5} muxers.
635 It accepts the following options:
639 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
640 for looping indefinitely (default).
643 Force the delay (expressed in centiseconds) after the last frame. Each frame
644 ends with a delay until the next frame. The default is @code{-1}, which is a
645 special value to tell the muxer to re-use the previous delay. In case of a
646 loop, you might want to customize this value to mark a pause for instance.
649 For example, to encode a gif looping 10 times, with a 5 seconds delay between
652 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
655 Note 1: if you wish to extract the frames into separate GIF files, you need to
656 force the @ref{image2} muxer:
658 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
661 Note 2: the GIF format has a very large time base: the delay between two frames
662 can therefore not be smaller than one centi second.
669 This muxer computes and prints a cryptographic hash of all the input
670 audio and video frames. This can be used for equality checks without
671 having to do a complete binary comparison.
673 By default audio frames are converted to signed 16-bit raw audio and
674 video frames to raw video before computing the hash, but the output
675 of explicit conversions to other codecs can also be used. Timestamps
676 are ignored. It uses the SHA-256 cryptographic hash function by default,
677 but supports several other algorithms.
679 The output of the muxer consists of a single line of the form:
680 @var{algo}=@var{hash}, where @var{algo} is a short string representing
681 the hash function used, and @var{hash} is a hexadecimal number
682 representing the computed hash.
685 @item hash @var{algorithm}
686 Use the cryptographic hash function specified by the string @var{algorithm}.
687 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
688 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
689 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
690 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
696 To compute the SHA-256 hash of the input converted to raw audio and
697 video, and store it in the file @file{out.sha256}:
699 ffmpeg -i INPUT -f hash out.sha256
702 To print an MD5 hash to stdout use the command:
704 ffmpeg -i INPUT -f hash -hash md5 -
707 See also the @ref{framehash} muxer.
712 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
713 the HTTP Live Streaming (HLS) specification.
715 It creates a playlist file, and one or more segment files. The output filename
716 specifies the playlist filename.
718 By default, the muxer creates a file for each segment produced. These files
719 have the same name as the playlist, followed by a sequential number and a
722 Make sure to require a closed GOP when encoding and to set the GOP
723 size to fit your segment time constraint.
725 For example, to convert an input file with @command{ffmpeg}:
727 ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
729 This example will produce the playlist, @file{out.m3u8}, and segment files:
730 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
732 See also the @ref{segment} muxer, which provides a more generic and
733 flexible implementation of a segmenter, and can be used to perform HLS
738 This muxer supports the following options:
741 @item hls_init_time @var{duration}
742 Set the initial target segment length. Default value is @var{0}.
744 @var{duration} must be a time duration specification,
745 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
747 Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
748 After the initial playlist is filled @command{ffmpeg} will cut segments
749 at duration equal to @code{hls_time}
751 @item hls_time @var{duration}
752 Set the target segment length. Default value is 2.
754 @var{duration} must be a time duration specification,
755 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
756 Segment will be cut on the next key frame after this time has passed.
758 @item hls_list_size @var{size}
759 Set the maximum number of playlist entries. If set to 0 the list file
760 will contain all the segments. Default value is 5.
762 @item hls_delete_threshold @var{size}
763 Set the number of unreferenced segments to keep on disk before @code{hls_flags delete_segments}
764 deletes them. Increase this to allow continue clients to download segments which
765 were recently referenced in the playlist. Default value is 1, meaning segments older than
766 @code{hls_list_size+1} will be deleted.
768 @item hls_ts_options @var{options_list}
769 Set output format options using a :-separated list of key=value
770 parameters. Values containing @code{:} special characters must be
773 @item hls_wrap @var{wrap}
774 This is a deprecated option, you can use @code{hls_list_size}
775 and @code{hls_flags delete_segments} instead it
777 This option is useful to avoid to fill the disk with many segment
778 files, and limits the maximum number of segment files written to disk
782 @item hls_start_number_source
783 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) according to the specified source.
784 Unless @code{hls_flags single_file} is set, it also specifies source of starting sequence numbers of
785 segment and subtitle filenames. In any case, if @code{hls_flags append_list}
786 is set and read playlist sequence number is greater than the specified start sequence number,
787 then that value will be used as start value.
789 It accepts the following values:
793 @item generic (default)
794 Set the starting sequence numbers according to @var{start_number} option value.
797 The start number will be the seconds since epoch (1970-01-01 00:00:00)
800 The start number will be the microseconds since epoch (1970-01-01 00:00:00)
803 The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759.
807 @item start_number @var{number}
808 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) from the specified @var{number}
809 when @var{hls_start_number_source} value is @var{generic}. (This is the default case.)
810 Unless @code{hls_flags single_file} is set, it also specifies starting sequence numbers of segment and subtitle filenames.
813 @item hls_allow_cache @var{allowcache}
814 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
816 @item hls_base_url @var{baseurl}
817 Append @var{baseurl} to every entry in the playlist.
818 Useful to generate playlists with absolute paths.
820 Note that the playlist sequence number must be unique for each segment
821 and it is not to be confused with the segment filename sequence number
822 which can be cyclic, for example if the @option{wrap} option is
825 @item hls_segment_filename @var{filename}
826 Set the segment filename. Unless @code{hls_flags single_file} is set,
827 @var{filename} is used as a string format with the segment number:
829 ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
831 This example will produce the playlist, @file{out.m3u8}, and segment files:
832 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
834 @var{filename} may contain full path or relative path specification,
835 but only the file name part without any path info will be contained in the m3u8 segment list.
836 Should a relative path be specified, the path of the created segment
837 files will be relative to the current working directory.
838 When strftime_mkdir is set, the whole expanded value of @var{filename} will be written into the m3u8 segment list.
840 When @code{var_stream_map} is set with two or more variant streams, the
841 @var{filename} pattern must contain the string "%v", this string specifies
842 the position of variant stream index in the generated segment file names.
844 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
845 -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" \
846 -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
848 This example will produce the playlists segment file sets:
849 @file{file_0_000.ts}, @file{file_0_001.ts}, @file{file_0_002.ts}, etc. and
850 @file{file_1_000.ts}, @file{file_1_001.ts}, @file{file_1_002.ts}, etc.
852 The string "%v" may be present in the filename or in the last directory name
853 containing the file, but only in one of them. (Additionally, %v may appear multiple times in the last
854 sub-directory or filename.) If the string %v is present in the directory name, then
855 sub-directories are created after expanding the directory name pattern. This
856 enables creation of segments corresponding to different variant streams in
859 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
860 -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" \
861 -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
863 This example will produce the playlists segment file sets:
864 @file{vs0/file_000.ts}, @file{vs0/file_001.ts}, @file{vs0/file_002.ts}, etc. and
865 @file{vs1/file_000.ts}, @file{vs1/file_001.ts}, @file{vs1/file_002.ts}, etc.
868 Same as strftime option, will be deprecated.
871 Use strftime() on @var{filename} to expand the segment filename with localtime.
872 The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index
873 hls_flag and %%d will be the specifier.
875 ffmpeg -i in.nut -strftime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
877 This example will produce the playlist, @file{out.m3u8}, and segment files:
878 @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
879 Note: On some systems/environments, the @code{%s} specifier is not available. See
880 @code{strftime()} documentation.
882 ffmpeg -i in.nut -strftime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
884 This example will produce the playlist, @file{out.m3u8}, and segment files:
885 @file{file-20160215-0001.ts}, @file{file-20160215-0002.ts}, etc.
887 @item use_localtime_mkdir
888 Same as strftime_mkdir option, will be deprecated .
891 Used together with -strftime_mkdir, it will create all subdirectories which
892 is expanded in @var{filename}.
894 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
896 This example will create a directory 201560215 (if it does not exist), and then
897 produce the playlist, @file{out.m3u8}, and segment files:
898 @file{20160215/file-20160215-1455569023.ts}, @file{20160215/file-20160215-1455569024.ts}, etc.
901 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
903 This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then
904 produce the playlist, @file{out.m3u8}, and segment files:
905 @file{2016/02/15/file-20160215-1455569023.ts}, @file{2016/02/15/file-20160215-1455569024.ts}, etc.
908 @item hls_key_info_file @var{key_info_file}
909 Use the information in @var{key_info_file} for segment encryption. The first
910 line of @var{key_info_file} specifies the key URI written to the playlist. The
911 key URL is used to access the encryption key during playback. The second line
912 specifies the path to the key file used to obtain the key during the encryption
913 process. The key file is read as a single packed array of 16 octets in binary
914 format. The optional third line specifies the initialization vector (IV) as a
915 hexadecimal string to be used instead of the segment sequence number (default)
916 for encryption. Changes to @var{key_info_file} will result in segment
917 encryption with the new key/IV and an entry in the playlist for the new key
918 URI/IV if @code{hls_flags periodic_rekey} is enabled.
920 Key info file format:
929 http://server/file.key
934 Example key file paths:
942 0123456789ABCDEF0123456789ABCDEF
945 Key info file example:
947 http://server/file.key
949 0123456789ABCDEF0123456789ABCDEF
952 Example shell script:
956 openssl rand 16 > file.key
957 echo $BASE_URL/file.key > file.keyinfo
958 echo file.key >> file.keyinfo
959 echo $(openssl rand -hex 16) >> file.keyinfo
960 ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
961 -hls_key_info_file file.keyinfo out.m3u8
964 @item -hls_enc @var{enc}
965 Enable (1) or disable (0) the AES128 encryption.
966 When enabled every segment generated is encrypted and the encryption key
967 is saved as @var{playlist name}.key.
969 @item -hls_enc_key @var{key}
970 16-octet key to encrypt the segments, by default it
971 is randomly generated.
973 @item -hls_enc_key_url @var{keyurl}
974 If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
977 @item -hls_enc_iv @var{iv}
978 16-octet initialization vector for every segment instead
979 of the autogenerated ones.
981 @item hls_segment_type @var{flags}
986 Output segment files in MPEG-2 Transport Stream format. This is
987 compatible with all HLS versions.
990 Output segment files in fragmented MP4 format, similar to MPEG-DASH.
991 fmp4 files may be used in HLS version 7 and above.
995 @item hls_fmp4_init_filename @var{filename}
996 Set filename to the fragment files header file, default filename is @file{init.mp4}.
998 Use @code{-strftime 1} on @var{filename} to expand the segment filename with localtime.
1000 ffmpeg -i in.nut -hls_segment_type fmp4 -strftime 1 -hls_fmp4_init_filename "%s_init.mp4" out.m3u8
1002 This will produce init like this
1003 @file{1602678741_init.mp4}
1005 @item hls_fmp4_init_resend
1006 Resend init file after m3u8 file refresh every time, default is @var{0}.
1008 When @code{var_stream_map} is set with two or more variant streams, the
1009 @var{filename} pattern must contain the string "%v", this string specifies
1010 the position of variant stream index in the generated init file names.
1011 The string "%v" may be present in the filename or in the last directory name
1012 containing the file. If the string is present in the directory name, then
1013 sub-directories are created after expanding the directory name pattern. This
1014 enables creation of init files corresponding to different variant streams in
1017 @item hls_flags @var{flags}
1022 If this flag is set, the muxer will store all segments in a single MPEG-TS
1023 file, and will use byte ranges in the playlist. HLS playlists generated with
1024 this way will have the version number 4.
1027 ffmpeg -i in.nut -hls_flags single_file out.m3u8
1029 Will produce the playlist, @file{out.m3u8}, and a single segment file,
1032 @item delete_segments
1033 Segment files removed from the playlist are deleted after a period of time
1034 equal to the duration of the segment plus the duration of the playlist.
1037 Append new segments into the end of old segment list,
1038 and remove the @code{#EXT-X-ENDLIST} from the old segment list.
1040 @item round_durations
1041 Round the duration info in the playlist file segment info to integer
1042 values, instead of using floating point.
1045 Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
1046 first segment's information.
1049 Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
1051 @item periodic_rekey
1052 The file specified by @code{hls_key_info_file} will be checked periodically and
1053 detect updates to the encryption info. Be sure to replace this file atomically,
1054 including the file containing the AES encryption key.
1056 @item independent_segments
1057 Add the @code{#EXT-X-INDEPENDENT-SEGMENTS} to playlists that has video segments
1058 and when all the segments of that playlist are guaranteed to start with a Key frame.
1061 Add the @code{#EXT-X-I-FRAMES-ONLY} to playlists that has video segments
1062 and can play only I-frames in the @code{#EXT-X-BYTERANGE} mode.
1065 Allow segments to start on frames other than keyframes. This improves
1066 behavior on some players when the time between keyframes is inconsistent,
1067 but may make things worse on others, and can cause some oddities during
1068 seeking. This flag should be used with the @code{hls_time} option.
1070 @item program_date_time
1071 Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
1073 @item second_level_segment_index
1074 Makes it possible to use segment indexes as %%d in hls_segment_filename expression
1075 besides date/time values when strftime is on.
1076 To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width.
1078 @item second_level_segment_size
1079 Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename
1080 expression besides date/time values when strftime is on.
1081 To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width.
1083 @item second_level_segment_duration
1084 Makes it possible to use segment duration (calculated in microseconds) as %%t in hls_segment_filename
1085 expression besides date/time values when strftime is on.
1086 To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width.
1089 ffmpeg -i sample.mpeg \
1090 -f hls -hls_time 3 -hls_list_size 5 \
1091 -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
1092 -strftime 1 -strftime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
1094 This will produce segments like this:
1095 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
1098 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
1099 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
1100 before they have been added to the m3u8 playlist. This flag also affects how m3u8 playlist files are created.
1101 If this flag is set, all playlist files will written into temporary file and renamed after they are complete, similarly as segments are handled.
1102 But playlists with @code{file} protocol and with type (@code{hls_playlist_type}) other than @code{vod}
1103 are always written into temporary file regardless of this flag. Master playlist files (@code{master_pl_name}), if any, with @code{file} protocol,
1104 are always written into temporary file regardless of this flag if @code{master_pl_publish_rate} value is other than zero.
1108 @item hls_playlist_type event
1109 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
1110 @option{hls_list_size} to 0; the playlist can only be appended to.
1112 @item hls_playlist_type vod
1113 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
1114 @option{hls_list_size} to 0; the playlist must not change.
1117 Use the given HTTP method to create the hls files.
1119 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
1121 This example will upload all the mpegts segment files to the HTTP
1122 server using the HTTP PUT method, and update the m3u8 files every
1123 @code{refresh} times using the same method.
1124 Note that the HTTP server must support the given method for uploading
1127 @item http_user_agent
1128 Override User-Agent field in HTTP header. Applicable only for HTTP output.
1130 @item var_stream_map
1131 Map string which specifies how to group the audio, video and subtitle streams
1132 into different variant streams. The variant stream groups are separated
1134 Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are
1135 the keys to specify audio, video and subtitle streams respectively.
1136 Allowed values are 0 to 9 (limited just based on practical usage).
1138 When there are two or more variant streams, the output filename pattern must
1139 contain the string "%v", this string specifies the position of variant stream
1140 index in the output media playlist filenames. The string "%v" may be present in
1141 the filename or in the last directory name containing the file. If the string is
1142 present in the directory name, then sub-directories are created after expanding
1143 the directory name pattern. This enables creation of variant streams in
1147 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1148 -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" \
1149 http://example.com/live/out_%v.m3u8
1151 This example creates two hls variant streams. The first variant stream will
1152 contain video stream of bitrate 1000k and audio stream of bitrate 64k and the
1153 second variant stream will contain video stream of bitrate 256k and audio
1154 stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and
1155 out_1.m3u8 will be created. If you want something meaningful text instead of indexes
1156 in result names, you may specify names for each or some of the variants
1157 as in the following example.
1161 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1162 -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0,name:my_hd v:1,a:1,name:my_sd" \
1163 http://example.com/live/out_%v.m3u8
1166 This example creates two hls variant streams as in the previous one.
1167 But here, the two media playlist with file names out_my_hd.m3u8 and
1168 out_my_sd.m3u8 will be created.
1171 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
1172 -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
1173 http://example.com/live/out_%v.m3u8
1175 This example creates three hls variant streams. The first variant stream will
1176 be a video only stream with video bitrate 1000k, the second variant stream will
1177 be an audio only stream with bitrate 64k and the third variant stream will be a
1178 video only stream with bitrate 256k. Here, three media playlist with file names
1179 out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created.
1181 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1182 -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" \
1183 http://example.com/live/vs_%v/out.m3u8
1185 This example creates the variant streams in subdirectories. Here, the first
1186 media playlist is created at @file{http://example.com/live/vs_0/out.m3u8} and
1187 the second one at @file{http://example.com/live/vs_1/out.m3u8}.
1189 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k \
1190 -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
1191 -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
1192 -master_pl_name master.m3u8 \
1193 http://example.com/live/out_%v.m3u8
1195 This example creates two audio only and two video only variant streams. In
1196 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1197 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1198 and they are mapped to the two video only variant streams with audio group names
1199 'aud_low' and 'aud_high'.
1201 By default, a single hls variant containing all the encoded streams is created.
1204 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1205 -map 0:a -map 0:a -map 0:v -f hls \
1206 -var_stream_map "a:0,agroup:aud_low,default:yes a:1,agroup:aud_low v:0,agroup:aud_low" \
1207 -master_pl_name master.m3u8 \
1208 http://example.com/live/out_%v.m3u8
1210 This example creates two audio only and one video only variant streams. In
1211 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1212 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1213 and they are mapped to the one video only variant streams with audio group name
1214 'aud_low', and the audio group have default stat is NO or YES.
1216 By default, a single hls variant containing all the encoded streams is created.
1219 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
1220 -map 0:a -map 0:a -map 0:v -f hls \
1221 -var_stream_map "a:0,agroup:aud_low,default:yes,language:ENG a:1,agroup:aud_low,language:CHN v:0,agroup:aud_low" \
1222 -master_pl_name master.m3u8 \
1223 http://example.com/live/out_%v.m3u8
1225 This example creates two audio only and one video only variant streams. In
1226 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
1227 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
1228 and they are mapped to the one video only variant streams with audio group name
1229 'aud_low', and the audio group have default stat is NO or YES, and one audio
1230 have and language is named ENG, the other audio language is named CHN.
1232 By default, a single hls variant containing all the encoded streams is created.
1235 ffmpeg -y -i input_with_subtitle.mkv \
1236 -b:v:0 5250k -c:v h264 -pix_fmt yuv420p -profile:v main -level 4.1 \
1238 -c:s webvtt -c:a mp2 -ar 48000 -ac 2 -map 0:v -map 0:a:0 -map 0:s:0 \
1239 -f hls -var_stream_map "v:0,a:0,s:0,sgroup:subtitle" \
1240 -master_pl_name master.m3u8 -t 300 -hls_time 10 -hls_init_time 4 -hls_list_size \
1241 10 -master_pl_publish_rate 10 -hls_flags \
1242 delete_segments+discont_start+split_by_time ./tmp/video.m3u8
1245 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=SUBTITLES} in
1246 the master playlist with webvtt subtitle group name 'subtitle'. Please make sure
1247 the input file has one text subtitle stream at least.
1250 Map string which specifies different closed captions groups and their
1251 attributes. The closed captions stream groups are separated by space.
1252 Expected string format is like this
1253 "ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....".
1254 'ccgroup' and 'instreamid' are mandatory attributes. 'language' is an optional
1256 The closed captions groups configured using this option are mapped to different
1257 variant streams by providing the same 'ccgroup' name in the
1258 @code{var_stream_map} string. If @code{var_stream_map} is not set, then the
1259 first available ccgroup in @code{cc_stream_map} is mapped to the output variant
1260 stream. The examples for these two use cases are given below.
1263 ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
1264 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
1265 -master_pl_name master.m3u8 \
1266 http://example.com/live/out.m3u8
1268 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=CLOSED-CAPTIONS} in
1269 the master playlist with group name 'cc', language 'en' (english) and
1270 INSTREAM-ID 'CC1'. Also, it adds @code{CLOSED-CAPTIONS} attribute with group
1271 name 'cc' for the output variant stream.
1273 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
1274 -a53cc:0 1 -a53cc:1 1\
1275 -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
1276 -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
1277 -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
1278 -master_pl_name master.m3u8 \
1279 http://example.com/live/out_%v.m3u8
1281 This example adds two @code{#EXT-X-MEDIA} tags with @code{TYPE=CLOSED-CAPTIONS} in
1282 the master playlist for the INSTREAM-IDs 'CC1' and 'CC2'. Also, it adds
1283 @code{CLOSED-CAPTIONS} attribute with group name 'cc' for the two output variant
1286 @item master_pl_name
1287 Create HLS master playlist with the given name.
1290 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
1292 This example creates HLS master playlist with name master.m3u8 and it is
1293 published at http://example.com/live/
1295 @item master_pl_publish_rate
1296 Publish master play list repeatedly every after specified number of segment intervals.
1299 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
1300 -hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
1303 This example creates HLS master playlist with name master.m3u8 and keep
1304 publishing it repeatedly every after 30 segments i.e. every after 60s.
1306 @item http_persistent
1307 Use persistent HTTP connections. Applicable only for HTTP output.
1310 Set timeout for socket I/O operations. Applicable only for HTTP output.
1312 @item -ignore_io_errors
1313 Ignore IO errors during open, write and delete. Useful for long-duration runs with network output.
1316 Set custom HTTP headers, can override built in default headers. Applicable only for HTTP output.
1325 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
1329 Size cannot exceed 256 pixels in any dimension
1332 Only BMP and PNG images can be stored
1335 If a BMP image is used, it must be one of the following pixel formats:
1337 BMP Bit Depth FFmpeg Pixel Format
1347 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
1350 If a PNG image is used, it must use the rgba pixel format
1358 The image file muxer writes video frames to image files.
1360 The output filenames are specified by a pattern, which can be used to
1361 produce sequentially numbered series of files.
1362 The pattern may contain the string "%d" or "%0@var{N}d", this string
1363 specifies the position of the characters representing a numbering in
1364 the filenames. If the form "%0@var{N}d" is used, the string
1365 representing the number in each filename is 0-padded to @var{N}
1366 digits. The literal character '%' can be specified in the pattern with
1369 If the pattern contains "%d" or "%0@var{N}d", the first filename of
1370 the file list specified will contain the number 1, all the following
1371 numbers will be sequential.
1373 The pattern may contain a suffix which is used to automatically
1374 determine the format of the image files to write.
1376 For example the pattern "img-%03d.bmp" will specify a sequence of
1377 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
1378 @file{img-010.bmp}, etc.
1379 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
1380 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
1383 The image muxer supports the .Y.U.V image file format. This format is
1384 special in that that each image frame consists of three files, for
1385 each of the YUV420P components. To read or write this image file format,
1386 specify the name of the '.Y' file. The muxer will automatically open the
1387 '.U' and '.V' files as required.
1393 If set to 1, expand the filename with pts from pkt->pts.
1397 Start the sequence from the specified number. Default value is 1.
1400 If set to 1, the filename will always be interpreted as just a
1401 filename, not a pattern, and the corresponding file will be continuously
1402 overwritten with new images. Default value is 0.
1405 If set to 1, expand the filename with date and time information from
1406 @code{strftime()}. Default value is 0.
1408 @item protocol_opts @var{options_list}
1409 Set protocol options as a :-separated list of key=value parameters. Values
1410 containing the @code{:} special character must be escaped.
1414 @subsection Examples
1416 The following example shows how to use @command{ffmpeg} for creating a
1417 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
1418 taking one image every second from the input video:
1420 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
1423 Note that with @command{ffmpeg}, if the format is not specified with the
1424 @code{-f} option and the output filename specifies an image file
1425 format, the image2 muxer is automatically selected, so the previous
1426 command can be written as:
1428 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
1431 Note also that the pattern must not necessarily contain "%d" or
1432 "%0@var{N}d", for example to create a single image file
1433 @file{img.jpeg} from the start of the input video you can employ the command:
1435 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
1438 The @option{strftime} option allows you to expand the filename with
1439 date and time information. Check the documentation of
1440 the @code{strftime()} function for the syntax.
1442 For example to generate image files from the @code{strftime()}
1443 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
1446 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
1449 You can set the file name with current frame's PTS:
1451 ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
1454 A more complex example is to publish contents of your desktop directly to a
1455 WebDAV server every second:
1457 ffmpeg -f x11grab -framerate 1 -i :0.0 -q:v 6 -update 1 -protocol_opts method=PUT http://example.com/desktop.jpg
1462 Matroska container muxer.
1464 This muxer implements the matroska and webm container specs.
1466 @subsection Metadata
1468 The recognized metadata settings in this muxer are:
1472 Set title name provided to a single track. This gets mapped to
1473 the FileDescription element for a stream written as attachment.
1476 Specify the language of the track in the Matroska languages form.
1478 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
1479 639-2/B) form (like "fre" for French), or a language code mixed with a
1480 country code for specialities in languages (like "fre-ca" for Canadian
1484 Set stereo 3D video layout of two views in a single video track.
1486 The following values are recognized:
1491 Both views are arranged side by side, Left-eye view is on the left
1493 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
1495 Both views are arranged in top-bottom orientation, Left-eye view is on top
1496 @item checkerboard_rl
1497 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
1498 @item checkerboard_lr
1499 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
1500 @item row_interleaved_rl
1501 Each view is constituted by a row based interleaving, Right-eye view is first row
1502 @item row_interleaved_lr
1503 Each view is constituted by a row based interleaving, Left-eye view is first row
1504 @item col_interleaved_rl
1505 Both views are arranged in a column based interleaving manner, Right-eye view is first column
1506 @item col_interleaved_lr
1507 Both views are arranged in a column based interleaving manner, Left-eye view is first column
1508 @item anaglyph_cyan_red
1509 All frames are in anaglyph format viewable through red-cyan filters
1511 Both views are arranged side by side, Right-eye view is on the left
1512 @item anaglyph_green_magenta
1513 All frames are in anaglyph format viewable through green-magenta filters
1515 Both eyes laced in one Block, Left-eye view is first
1517 Both eyes laced in one Block, Right-eye view is first
1521 For example a 3D WebM clip can be created using the following command line:
1523 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
1528 This muxer supports the following options:
1531 @item reserve_index_space
1532 By default, this muxer writes the index for seeking (called cues in Matroska
1533 terms) at the end of the file, because it cannot know in advance how much space
1534 to leave for the index at the beginning of the file. However for some use cases
1535 -- e.g. streaming where seeking is possible but slow -- it is useful to put the
1536 index at the beginning of the file.
1538 If this option is set to a non-zero value, the muxer will reserve a given amount
1539 of space in the file header and then try to write the cues there when the muxing
1540 finishes. If the reserved space does not suffice, no Cues will be written, the
1541 file will be finalized and writing the trailer will return an error.
1542 A safe size for most use cases should be about 50kB per hour of video.
1544 Note that cues are only written if the output is seekable and this option will
1545 have no effect if it is not.
1547 This option controls how the FlagDefault of the output tracks will be set.
1548 It influences which tracks players should play by default. The default mode
1552 In this mode, for each type of track (audio, video or subtitle), if there is
1553 a track with disposition default of this type, then the first such track
1554 (i.e. the one with the lowest index) will be marked as default; if no such
1555 track exists, the first track of this type will be marked as default instead
1556 (if existing). This ensures that the default flag is set in a sensible way even
1557 if the input originated from containers that lack the concept of default tracks.
1559 This mode is the same as infer except that if no subtitle track with
1560 disposition default exists, no subtitle track will be marked as default.
1562 In this mode the FlagDefault is set if and only if the AV_DISPOSITION_DEFAULT
1563 flag is set in the disposition of the corresponding stream.
1566 @item flipped_raw_rgb
1567 If set to true, store positive height for raw RGB bitmaps, which indicates
1568 bitmap is stored bottom-up. Note that this option does not flip the bitmap
1569 which has to be done manually beforehand, e.g. by using the vflip filter.
1570 Default is @var{false} and indicates bitmap is stored top down.
1579 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
1580 defaults to using the MD5 hash function.
1582 @subsection Examples
1584 To compute the MD5 hash of the input converted to raw
1585 audio and video, and store it in the file @file{out.md5}:
1587 ffmpeg -i INPUT -f md5 out.md5
1590 You can print the MD5 to stdout with the command:
1592 ffmpeg -i INPUT -f md5 -
1595 See also the @ref{hash} and @ref{framemd5} muxers.
1597 @section mov, mp4, ismv
1599 MOV/MP4/ISMV (Smooth Streaming) muxer.
1601 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
1602 file has all the metadata about all packets stored in one location
1603 (written at the end of the file, it can be moved to the start for
1604 better playback by adding @var{faststart} to the @var{movflags}, or
1605 using the @command{qt-faststart} tool). A fragmented
1606 file consists of a number of fragments, where packets and metadata
1607 about these packets are stored together. Writing a fragmented
1608 file has the advantage that the file is decodable even if the
1609 writing is interrupted (while a normal MOV/MP4 is undecodable if
1610 it is not properly finished), and it requires less memory when writing
1611 very long files (since writing normal MOV/MP4 files stores info about
1612 every single packet in memory until the file is closed). The downside
1613 is that it is less compatible with other applications.
1617 Fragmentation is enabled by setting one of the AVOptions that define
1618 how to cut the file into fragments:
1621 @item -moov_size @var{bytes}
1622 Reserves space for the moov atom at the beginning of the file instead of placing the
1623 moov atom at the end. If the space reserved is insufficient, muxing will fail.
1624 @item -movflags frag_keyframe
1625 Start a new fragment at each video keyframe.
1626 @item -frag_duration @var{duration}
1627 Create fragments that are @var{duration} microseconds long.
1628 @item -frag_size @var{size}
1629 Create fragments that contain up to @var{size} bytes of payload data.
1630 @item -movflags frag_custom
1631 Allow the caller to manually choose when to cut fragments, by
1632 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
1633 the packets written so far. (This is only useful with other
1634 applications integrating libavformat, not from @command{ffmpeg}.)
1635 @item -min_frag_duration @var{duration}
1636 Don't create fragments that are shorter than @var{duration} microseconds long.
1639 If more than one condition is specified, fragments are cut when
1640 one of the specified conditions is fulfilled. The exception to this is
1641 @code{-min_frag_duration}, which has to be fulfilled for any of the other
1642 conditions to apply.
1644 Additionally, the way the output file is written can be adjusted
1645 through a few other options:
1648 @item -movflags empty_moov
1649 Write an initial moov atom directly at the start of the file, without
1650 describing any samples in it. Generally, an mdat/moov pair is written
1651 at the start of the file, as a normal MOV/MP4 file, containing only
1652 a short portion of the file. With this option set, there is no initial
1653 mdat atom, and the moov atom only describes the tracks but has
1656 This option is implicitly set when writing ismv (Smooth Streaming) files.
1657 @item -movflags separate_moof
1658 Write a separate moof (movie fragment) atom for each track. Normally,
1659 packets for all tracks are written in a moof atom (which is slightly
1660 more efficient), but with this option set, the muxer writes one moof/mdat
1661 pair for each track, making it easier to separate tracks.
1663 This option is implicitly set when writing ismv (Smooth Streaming) files.
1664 @item -movflags skip_sidx
1665 Skip writing of sidx atom. When bitrate overhead due to sidx atom is high,
1666 this option could be used for cases where sidx atom is not mandatory.
1667 When global_sidx flag is enabled, this option will be ignored.
1668 @item -movflags faststart
1669 Run a second pass moving the index (moov atom) to the beginning of the file.
1670 This operation can take a while, and will not work in various situations such
1671 as fragmented output, thus it is not enabled by default.
1672 @item -movflags rtphint
1673 Add RTP hinting tracks to the output file.
1674 @item -movflags disable_chpl
1675 Disable Nero chapter markers (chpl atom). Normally, both Nero chapters
1676 and a QuickTime chapter track are written to the file. With this option
1677 set, only the QuickTime chapter track will be written. Nero chapters can
1678 cause failures when the file is reprocessed with certain tagging programs, like
1679 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1680 @item -movflags omit_tfhd_offset
1681 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1682 tying fragments to absolute byte positions in the file/streams.
1683 @item -movflags default_base_moof
1684 Similarly to the omit_tfhd_offset, this flag avoids writing the
1685 absolute base_data_offset field in tfhd atoms, but does so by using
1686 the new default-base-is-moof flag instead. This flag is new from
1687 14496-12:2012. This may make the fragments easier to parse in certain
1688 circumstances (avoiding basing track fragment location calculations
1689 on the implicit end of the previous track fragment).
1691 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1692 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1693 @item -movflags negative_cts_offsets
1694 Enables utilization of version 1 of the CTTS box, in which the CTS offsets can
1695 be negative. This enables the initial sample to have DTS/CTS of zero, and
1696 reduces the need for edit lists for some cases such as video tracks with
1697 B-frames. Additionally, eases conformance with the DASH-IF interoperability
1700 This option is implicitly set when writing ismv (Smooth Streaming) files.
1702 Write producer time reference box (PRFT) with a specified time source for the
1703 NTP field in the PRFT box. Set value as @samp{wallclock} to specify timesource
1704 as wallclock time and @samp{pts} to specify timesource as input packets' PTS
1707 Setting value to @samp{pts} is applicable only for a live encoding use case,
1708 where PTS values are set as as wallclock time at the source. For example, an
1709 encoding use case with decklink capture source where @option{video_pts} and
1710 @option{audio_pts} are set to @samp{abs_wallclock}.
1715 Smooth Streaming content can be pushed in real time to a publishing
1716 point on IIS with this muxer. Example:
1718 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1723 The MP3 muxer writes a raw MP3 stream with the following optional features:
1726 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1727 2.4 are supported, the @code{id3v2_version} private option controls which one is
1728 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1731 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1732 The pictures are supplied to the muxer in form of a video stream with a single
1733 packet. There can be any number of those streams, each will correspond to a
1734 single APIC frame. The stream metadata tags @var{title} and @var{comment} map
1735 to APIC @var{description} and @var{picture type} respectively. See
1736 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1738 Note that the APIC frames must be written at the beginning, so the muxer will
1739 buffer the audio frames until it gets all the pictures. It is therefore advised
1740 to provide the pictures as soon as possible to avoid excessive buffering.
1743 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1744 default, but will be written only if the output is seekable. The
1745 @code{write_xing} private option can be used to disable it. The frame contains
1746 various information that may be useful to the decoder, like the audio duration
1750 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1751 enabled with the @code{write_id3v1} private option, but as its capabilities are
1752 very limited, its usage is not recommended.
1757 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1759 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1762 To attach a picture to an mp3 file select both the audio and the picture stream
1765 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1766 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1769 Write a "clean" MP3 without any extra features:
1771 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1776 MPEG transport stream muxer.
1778 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1780 The recognized metadata settings in mpegts muxer are @code{service_provider}
1781 and @code{service_name}. If they are not set the default for
1782 @code{service_provider} is @samp{FFmpeg} and the default for
1783 @code{service_name} is @samp{Service01}.
1787 The muxer options are:
1790 @item mpegts_transport_stream_id @var{integer}
1791 Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1792 Default is @code{0x0001}.
1794 @item mpegts_original_network_id @var{integer}
1795 Set the @samp{original_network_id}. This is unique identifier of a
1796 network in DVB. Its main use is in the unique identification of a service
1797 through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1800 @item mpegts_service_id @var{integer}
1801 Set the @samp{service_id}, also known as program in DVB. Default is
1804 @item mpegts_service_type @var{integer}
1805 Set the program @samp{service_type}. Default is @code{digital_tv}.
1806 Accepts the following options:
1809 Any hexadecimal value between @code{0x01} and @code{0xff} as defined in
1814 Digital Radio service.
1817 @item advanced_codec_digital_radio
1818 Advanced Codec Digital Radio service.
1819 @item mpeg2_digital_hdtv
1820 MPEG2 Digital HDTV service.
1821 @item advanced_codec_digital_sdtv
1822 Advanced Codec Digital SDTV service.
1823 @item advanced_codec_digital_hdtv
1824 Advanced Codec Digital HDTV service.
1827 @item mpegts_pmt_start_pid @var{integer}
1828 Set the first PID for PMTs. Default is @code{0x1000}, minimum is @code{0x0020},
1829 maximum is @code{0x1ffa}. This option has no effect in m2ts mode where the PMT
1830 PID is fixed @code{0x0100}.
1832 @item mpegts_start_pid @var{integer}
1833 Set the first PID for elementary streams. Default is @code{0x0100}, minimum is
1834 @code{0x0020}, maximum is @code{0x1ffa}. This option has no effect in m2ts mode
1835 where the elementary stream PIDs are fixed.
1837 @item mpegts_m2ts_mode @var{boolean}
1838 Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1841 @item muxrate @var{integer}
1842 Set a constant muxrate. Default is VBR.
1844 @item pes_payload_size @var{integer}
1845 Set minimum PES packet payload in bytes. Default is @code{2930}.
1847 @item mpegts_flags @var{flags}
1848 Set mpegts flags. Accepts the following options:
1850 @item resend_headers
1851 Reemit PAT/PMT before writing the next packet.
1853 Use LATM packetization for AAC.
1854 @item pat_pmt_at_frames
1855 Reemit PAT and PMT at each video frame.
1857 Conform to System B (DVB) instead of System A (ATSC).
1858 @item initial_discontinuity
1859 Mark the initial packet of each stream as discontinuity.
1862 @item mpegts_copyts @var{boolean}
1863 Preserve original timestamps, if value is set to @code{1}. Default value
1864 is @code{-1}, which results in shifting timestamps so that they start from 0.
1866 @item omit_video_pes_length @var{boolean}
1867 Omit the PES packet length for video packets. Default is @code{1} (true).
1869 @item pcr_period @var{integer}
1870 Override the default PCR retransmission time in milliseconds. Default is
1871 @code{-1} which means that the PCR interval will be determined automatically:
1872 20 ms is used for CBR streams, the highest multiple of the frame duration which
1873 is less than 100 ms is used for VBR streams.
1875 @item pat_period @var{duration}
1876 Maximum time in seconds between PAT/PMT tables. Default is @code{0.1}.
1878 @item sdt_period @var{duration}
1879 Maximum time in seconds between SDT tables. Default is @code{0.5}.
1881 @item tables_version @var{integer}
1882 Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1883 This option allows updating stream structure so that standard consumer may
1884 detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1885 usage) or restart @command{ffmpeg} instance, cyclically changing
1886 @option{tables_version} value:
1889 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1890 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1892 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1893 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1894 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1902 ffmpeg -i file.mpg -c copy \
1903 -mpegts_original_network_id 0x1122 \
1904 -mpegts_transport_stream_id 0x3344 \
1905 -mpegts_service_id 0x5566 \
1906 -mpegts_pmt_start_pid 0x1500 \
1907 -mpegts_start_pid 0x150 \
1908 -metadata service_provider="Some provider" \
1909 -metadata service_name="Some Channel" \
1913 @section mxf, mxf_d10, mxf_opatom
1919 The muxer options are:
1922 @item store_user_comments @var{bool}
1923 Set if user comments should be stored if available or never.
1924 IRT D-10 does not allow user comments. The default is thus to write them for
1925 mxf and mxf_opatom but not for mxf_d10
1932 This muxer does not generate any output file, it is mainly useful for
1933 testing or benchmarking purposes.
1935 For example to benchmark decoding with @command{ffmpeg} you can use the
1938 ffmpeg -benchmark -i INPUT -f null out.null
1941 Note that the above command does not read or write the @file{out.null}
1942 file, but specifying the output file is required by the @command{ffmpeg}
1945 Alternatively you can write the command as:
1947 ffmpeg -benchmark -i INPUT -f null -
1953 @item -syncpoints @var{flags}
1954 Change the syncpoint usage in nut:
1956 @item @var{default} use the normal low-overhead seeking aids.
1957 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1958 Use of this option is not recommended, as the resulting files are very damage
1959 sensitive and seeking is not possible. Also in general the overhead from
1960 syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1961 all growing data tables, allowing to mux endless streams with limited memory
1962 and without these disadvantages.
1963 @item @var{timestamped} extend the syncpoint with a wallclock field.
1965 The @var{none} and @var{timestamped} flags are experimental.
1966 @item -write_index @var{bool}
1967 Write index at the end, the default is to write an index.
1971 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
1976 Ogg container muxer.
1979 @item -page_duration @var{duration}
1980 Preferred page duration, in microseconds. The muxer will attempt to create
1981 pages that are approximately @var{duration} microseconds long. This allows the
1982 user to compromise between seek granularity and container overhead. The default
1983 is 1 second. A value of 0 will fill all segments, making pages as large as
1984 possible. A value of 1 will effectively use 1 packet-per-page in most
1985 situations, giving a small seek granularity at the cost of additional container
1987 @item -serial_offset @var{value}
1988 Serial value from which to set the streams serial number.
1989 Setting it to different and sufficiently large values ensures that the produced
1990 ogg files can be safely chained.
1997 Raw muxers accept a single stream matching the designated codec. They do not store timestamps or metadata.
1998 The recognized extension is the same as the muxer name unless indicated otherwise.
2002 Dolby Digital, also known as AC-3, audio.
2006 CRI Middleware ADX audio.
2008 This muxer will write out the total sample count near the start of the first packet
2009 when the output is seekable and the count can be stored in 32 bits.
2013 aptX (Audio Processing Technology for Bluetooth) audio.
2017 aptX HD (Audio Processing Technology for Bluetooth) audio.
2023 AVS2-P2/IEEE1857.4 video.
2025 Extensions: avs, avs2
2027 @subsection cavsvideo
2029 Chinese AVS (Audio Video Standard) video.
2033 @subsection codec2raw
2037 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f codec2raw}.
2041 Data muxer accepts a single stream with any codec of any type.
2042 The input stream has to be selected using the @code{-map} option with the ffmpeg CLI tool.
2044 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f data}.
2048 BBC Dirac video. The Dirac Pro codec is a subset and is standardized as SMPTE VC-2.
2050 Extensions: drc, vc2
2054 Avid DNxHD video. It is standardized as SMPTE VC-3. Accepts DNxHR streams.
2056 Extensions: dnxhd, dnxhr
2060 DTS Coherent Acoustics (DCA) audio.
2064 Dolby Digital Plus, also known as Enhanced AC-3, audio.
2072 ITU-T G.723.1 audio.
2074 Extensions: tco, rco
2078 ITU-T G.726 big-endian ("left-justified") audio.
2080 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726}.
2084 ITU-T G.726 little-endian ("right-justified") audio.
2086 No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726le}.
2090 Global System for Mobile Communications audio.
2098 ITU-T H.263 / H.263-1996, H.263+ / H.263-1998 / H.263 version 2 video.
2102 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.
2104 Extensions: h264, 264
2108 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.
2110 Extensions: hevc, h265, 265
2114 MPEG-4 Part 2 video.
2120 Extensions: mjpg, mjpeg
2124 Meridian Lossless Packing, also known as Packed PCM, audio.
2128 MPEG-1 Audio Layer II audio.
2130 Extensions: mp2, m2a, mpa
2132 @subsection mpeg1video
2134 MPEG-1 Part 2 video.
2136 Extensions: mpg, mpeg, m1v
2138 @subsection mpeg2video
2140 ITU-T H.262 / MPEG-2 Part 2 video.
2144 @subsection rawvideo
2146 Raw uncompressed video.
2148 Extensions: yuv, rgb
2152 Bluetooth SIG low-complexity subband codec audio.
2154 Extensions: sbc, msbc
2164 SMPTE 421M / VC-1 video.
2167 @section segment, stream_segment, ssegment
2169 Basic stream segmenter.
2171 This muxer outputs streams to a number of separate files of nearly
2172 fixed duration. Output filename pattern can be set in a fashion
2173 similar to @ref{image2}, or by using a @code{strftime} template if
2174 the @option{strftime} option is enabled.
2176 @code{stream_segment} is a variant of the muxer used to write to
2177 streaming output formats, i.e. which do not require global headers,
2178 and is recommended for outputting e.g. to MPEG transport stream segments.
2179 @code{ssegment} is a shorter alias for @code{stream_segment}.
2181 Every segment starts with a keyframe of the selected reference stream,
2182 which is set through the @option{reference_stream} option.
2184 Note that if you want accurate splitting for a video file, you need to
2185 make the input key frames correspond to the exact splitting times
2186 expected by the segmenter, or the segment muxer will start the new
2187 segment with the key frame found next after the specified start
2190 The segment muxer works best with a single constant frame rate video.
2192 Optionally it can generate a list of the created segments, by setting
2193 the option @var{segment_list}. The list type is specified by the
2194 @var{segment_list_type} option. The entry filenames in the segment
2195 list are set by default to the basename of the corresponding segment
2198 See also the @ref{hls} muxer, which provides a more specific
2199 implementation for HLS segmentation.
2203 The segment muxer supports the following options:
2206 @item increment_tc @var{1|0}
2207 if set to @code{1}, increment timecode between each segment
2208 If this is selected, the input need to have
2209 a timecode in the first video stream. Default value is
2212 @item reference_stream @var{specifier}
2213 Set the reference stream, as specified by the string @var{specifier}.
2214 If @var{specifier} is set to @code{auto}, the reference is chosen
2215 automatically. Otherwise it must be a stream specifier (see the ``Stream
2216 specifiers'' chapter in the ffmpeg manual) which specifies the
2217 reference stream. The default value is @code{auto}.
2219 @item segment_format @var{format}
2220 Override the inner container format, by default it is guessed by the filename
2223 @item segment_format_options @var{options_list}
2224 Set output format options using a :-separated list of key=value
2225 parameters. Values containing the @code{:} special character must be
2228 @item segment_list @var{name}
2229 Generate also a listfile named @var{name}. If not specified no
2230 listfile is generated.
2232 @item segment_list_flags @var{flags}
2233 Set flags affecting the segment list generation.
2235 It currently supports the following flags:
2238 Allow caching (only affects M3U8 list files).
2241 Allow live-friendly file generation.
2244 @item segment_list_size @var{size}
2245 Update the list file so that it contains at most @var{size}
2246 segments. If 0 the list file will contain all the segments. Default
2249 @item segment_list_entry_prefix @var{prefix}
2250 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
2251 By default no prefix is applied.
2253 @item segment_list_type @var{type}
2254 Select the listing format.
2256 The following values are recognized:
2259 Generate a flat list for the created segments, one segment per line.
2262 Generate a list for the created segments, one segment per line,
2263 each line matching the format (comma-separated values):
2265 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
2268 @var{segment_filename} is the name of the output file generated by the
2269 muxer according to the provided pattern. CSV escaping (according to
2270 RFC4180) is applied if required.
2272 @var{segment_start_time} and @var{segment_end_time} specify
2273 the segment start and end time expressed in seconds.
2275 A list file with the suffix @code{".csv"} or @code{".ext"} will
2276 auto-select this format.
2278 @samp{ext} is deprecated in favor or @samp{csv}.
2281 Generate an ffconcat file for the created segments. The resulting file
2282 can be read using the FFmpeg @ref{concat} demuxer.
2284 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
2285 auto-select this format.
2288 Generate an extended M3U8 file, version 3, compliant with
2289 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
2291 A list file with the suffix @code{".m3u8"} will auto-select this format.
2294 If not specified the type is guessed from the list file name suffix.
2296 @item segment_time @var{time}
2297 Set segment duration to @var{time}, the value must be a duration
2298 specification. Default value is "2". See also the
2299 @option{segment_times} option.
2301 Note that splitting may not be accurate, unless you force the
2302 reference stream key-frames at the given time. See the introductory
2303 notice and the examples below.
2305 @item segment_atclocktime @var{1|0}
2306 If set to "1" split at regular clock time intervals starting from 00:00
2307 o'clock. The @var{time} value specified in @option{segment_time} is
2308 used for setting the length of the splitting interval.
2310 For example with @option{segment_time} set to "900" this makes it possible
2311 to create files at 12:00 o'clock, 12:15, 12:30, etc.
2313 Default value is "0".
2315 @item segment_clocktime_offset @var{duration}
2316 Delay the segment splitting times with the specified duration when using
2317 @option{segment_atclocktime}.
2319 For example with @option{segment_time} set to "900" and
2320 @option{segment_clocktime_offset} set to "300" this makes it possible to
2321 create files at 12:05, 12:20, 12:35, etc.
2323 Default value is "0".
2325 @item segment_clocktime_wrap_duration @var{duration}
2326 Force the segmenter to only start a new segment if a packet reaches the muxer
2327 within the specified duration after the segmenting clock time. This way you
2328 can make the segmenter more resilient to backward local time jumps, such as
2329 leap seconds or transition to standard time from daylight savings time.
2331 Default is the maximum possible duration which means starting a new segment
2332 regardless of the elapsed time since the last clock time.
2334 @item segment_time_delta @var{delta}
2335 Specify the accuracy time when selecting the start time for a
2336 segment, expressed as a duration specification. Default value is "0".
2338 When delta is specified a key-frame will start a new segment if its
2339 PTS satisfies the relation:
2341 PTS >= start_time - time_delta
2344 This option is useful when splitting video content, which is always
2345 split at GOP boundaries, in case a key frame is found just before the
2346 specified split time.
2348 In particular may be used in combination with the @file{ffmpeg} option
2349 @var{force_key_frames}. The key frame times specified by
2350 @var{force_key_frames} may not be set accurately because of rounding
2351 issues, with the consequence that a key frame time may result set just
2352 before the specified time. For constant frame rate videos a value of
2353 1/(2*@var{frame_rate}) should address the worst case mismatch between
2354 the specified time and the time set by @var{force_key_frames}.
2356 @item segment_times @var{times}
2357 Specify a list of split points. @var{times} contains a list of comma
2358 separated duration specifications, in increasing order. See also
2359 the @option{segment_time} option.
2361 @item segment_frames @var{frames}
2362 Specify a list of split video frame numbers. @var{frames} contains a
2363 list of comma separated integer numbers, in increasing order.
2365 This option specifies to start a new segment whenever a reference
2366 stream key frame is found and the sequential number (starting from 0)
2367 of the frame is greater or equal to the next value in the list.
2369 @item segment_wrap @var{limit}
2370 Wrap around segment index once it reaches @var{limit}.
2372 @item segment_start_number @var{number}
2373 Set the sequence number of the first segment. Defaults to @code{0}.
2375 @item strftime @var{1|0}
2376 Use the @code{strftime} function to define the name of the new
2377 segments to write. If this is selected, the output segment name must
2378 contain a @code{strftime} function template. Default value is
2381 @item break_non_keyframes @var{1|0}
2382 If enabled, allow segments to start on frames other than keyframes. This
2383 improves behavior on some players when the time between keyframes is
2384 inconsistent, but may make things worse on others, and can cause some oddities
2385 during seeking. Defaults to @code{0}.
2387 @item reset_timestamps @var{1|0}
2388 Reset timestamps at the beginning of each segment, so that each segment
2389 will start with near-zero timestamps. It is meant to ease the playback
2390 of the generated segments. May not work with some combinations of
2391 muxers/codecs. It is set to @code{0} by default.
2393 @item initial_offset @var{offset}
2394 Specify timestamp offset to apply to the output packet timestamps. The
2395 argument must be a time duration specification, and defaults to 0.
2397 @item write_empty_segments @var{1|0}
2398 If enabled, write an empty segment if there are no packets during the period a
2399 segment would usually span. Otherwise, the segment will be filled with the next
2400 packet written. Defaults to @code{0}.
2403 Make sure to require a closed GOP when encoding and to set the GOP
2404 size to fit your segment time constraint.
2406 @subsection Examples
2410 Remux the content of file @file{in.mkv} to a list of segments
2411 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
2412 generated segments to @file{out.list}:
2414 ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
2418 Segment input and set output format options for the output segments:
2420 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
2424 Segment the input file according to the split points specified by the
2425 @var{segment_times} option:
2427 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
2431 Use the @command{ffmpeg} @option{force_key_frames}
2432 option to force key frames in the input at the specified location, together
2433 with the segment option @option{segment_time_delta} to account for
2434 possible roundings operated when setting key frame times.
2436 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
2437 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
2439 In order to force key frames on the input file, transcoding is
2443 Segment the input file by splitting the input file according to the
2444 frame numbers sequence specified with the @option{segment_frames} option:
2446 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
2450 Convert the @file{in.mkv} to TS segments using the @code{libx264}
2451 and @code{aac} encoders:
2453 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
2457 Segment the input file, and create an M3U8 live playlist (can be used
2458 as live HLS source):
2460 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
2461 -segment_list_flags +live -segment_time 10 out%03d.mkv
2465 @section smoothstreaming
2467 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
2471 Specify the number of fragments kept in the manifest. Default 0 (keep all).
2473 @item extra_window_size
2474 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
2476 @item lookahead_count
2477 Specify the number of lookahead fragments. Default 2.
2479 @item min_frag_duration
2480 Specify the minimum fragment duration (in microseconds). Default 5000000.
2482 @item remove_at_exit
2483 Specify whether to remove all fragments when finished. Default 0 (do not remove).
2490 Per stream hash testing format.
2492 This muxer computes and prints a cryptographic hash of all the input frames,
2493 on a per-stream basis. This can be used for equality checks without having
2494 to do a complete binary comparison.
2496 By default audio frames are converted to signed 16-bit raw audio and
2497 video frames to raw video before computing the hash, but the output
2498 of explicit conversions to other codecs can also be used. Timestamps
2499 are ignored. It uses the SHA-256 cryptographic hash function by default,
2500 but supports several other algorithms.
2502 The output of the muxer consists of one line per stream of the form:
2503 @var{streamindex},@var{streamtype},@var{algo}=@var{hash}, where
2504 @var{streamindex} is the index of the mapped stream, @var{streamtype} is a
2505 single character indicating the type of stream, @var{algo} is a short string
2506 representing the hash function used, and @var{hash} is a hexadecimal number
2507 representing the computed hash.
2510 @item hash @var{algorithm}
2511 Use the cryptographic hash function specified by the string @var{algorithm}.
2512 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
2513 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
2514 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
2515 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
2519 @subsection Examples
2521 To compute the SHA-256 hash of the input converted to raw audio and
2522 video, and store it in the file @file{out.sha256}:
2524 ffmpeg -i INPUT -f streamhash out.sha256
2527 To print an MD5 hash to stdout use the command:
2529 ffmpeg -i INPUT -f streamhash -hash md5 -
2532 See also the @ref{hash} and @ref{framehash} muxers.
2537 The tee muxer can be used to write the same data to several outputs, such as files or streams.
2538 It can be used, for example, to stream a video over a network and save it to disk at the same time.
2540 It is different from specifying several outputs to the @command{ffmpeg}
2541 command-line tool. With the tee muxer, the audio and video data will be encoded only once.
2542 With conventional multiple outputs, multiple encoding operations in parallel are initiated,
2543 which can be a very expensive process. The tee muxer is not useful when using the libavformat API
2544 directly because it is then possible to feed the same packets to several muxers directly.
2546 Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select
2547 output streams. So all streams intended for output must be specified using @code{-map}. See
2550 Some encoders may need different options depending on the output format;
2551 the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified.
2552 The main example is the @option{global_header} flag.
2554 The slave outputs are specified in the file name given to the muxer,
2555 separated by '|'. If any of the slave name contains the '|' separator,
2556 leading or trailing spaces or any special character, those must be
2557 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
2558 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
2564 @item use_fifo @var{bool}
2565 If set to 1, slave outputs will be processed in separate threads using the @ref{fifo}
2566 muxer. This allows to compensate for different speed/latency/reliability of
2567 outputs and setup transparent recovery. By default this feature is turned off.
2570 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
2574 Muxer options can be specified for each slave by prepending them as a list of
2575 @var{key}=@var{value} pairs separated by ':', between square brackets. If
2576 the options values contain a special character or the ':' separator, they
2577 must be escaped; note that this is a second level escaping.
2579 The following special options are also recognized:
2582 Specify the format name. Required if it cannot be guessed from the
2585 @item bsfs[/@var{spec}]
2586 Specify a list of bitstream filters to apply to the specified
2589 It is possible to specify to which streams a given bitstream filter
2590 applies, by appending a stream specifier to the option separated by
2591 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
2592 stream specifiers}).
2594 If the stream specifier is not specified, the bitstream filters will be
2595 applied to all streams in the output. This will cause that output operation
2596 to fail if the output contains streams to which the bitstream filter cannot
2597 be applied e.g. @code{h264_mp4toannexb} being applied to an output containing an audio stream.
2599 Options for a bitstream filter must be specified in the form of @code{opt=value}.
2601 Several bitstream filters can be specified, separated by ",".
2603 @item use_fifo @var{bool}
2604 This allows to override tee muxer use_fifo option for individual slave muxer.
2607 This allows to override tee muxer fifo_options for individual slave muxer.
2611 Select the streams that should be mapped to the slave output,
2612 specified by a stream specifier. If not specified, this defaults to
2613 all the mapped streams. This will cause that output operation to fail
2614 if the output format does not accept all mapped streams.
2616 You may use multiple stream specifiers separated by commas (@code{,}) e.g.: @code{a:0,v}
2619 Specify behaviour on output failure. This can be set to either @code{abort} (which is
2620 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
2621 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
2622 will continue without being affected.
2625 @subsection Examples
2629 Encode something and both archive it in a WebM file and stream it
2630 as MPEG-TS over UDP:
2632 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2633 "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2637 As above, but continue streaming even if output to local file fails
2638 (for example local drive fills up):
2640 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2641 "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2645 Use @command{ffmpeg} to encode the input, and send the output
2646 to three different destinations. The @code{dump_extra} bitstream
2647 filter is used to add extradata information to all the output video
2648 keyframes packets, as requested by the MPEG-TS format. The select
2649 option is applied to @file{out.aac} in order to make it contain only
2652 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2653 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
2657 As above, but select only stream @code{a:1} for the audio output. Note
2658 that a second level escaping must be performed, as ":" is a special
2659 character used to separate options.
2661 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2662 -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
2668 WebM Live Chunk Muxer.
2670 This muxer writes out WebM headers and chunks as separate files which can be
2671 consumed by clients that support WebM Live streams via DASH.
2675 This muxer supports the following options:
2678 @item chunk_start_index
2679 Index of the first chunk (defaults to 0).
2682 Filename of the header where the initialization data will be written.
2684 @item audio_chunk_duration
2685 Duration of each audio chunk in milliseconds (defaults to 5000).
2690 ffmpeg -f v4l2 -i /dev/video0 \
2694 -s 640x360 -keyint_min 30 -g 30 \
2696 -header webm_live_video_360.hdr \
2697 -chunk_start_index 1 \
2698 webm_live_video_360_%d.chk \
2703 -header webm_live_audio_128.hdr \
2704 -chunk_start_index 1 \
2705 -audio_chunk_duration 1000 \
2706 webm_live_audio_128_%d.chk
2709 @section webm_dash_manifest
2711 WebM DASH Manifest muxer.
2713 This muxer implements the WebM DASH Manifest specification to generate the DASH
2714 manifest XML. It also supports manifest generation for DASH live streams.
2716 For more information see:
2720 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
2722 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
2727 This muxer supports the following options:
2730 @item adaptation_sets
2731 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
2732 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
2733 audio and video streams. Any number of adaptation sets can be added using this option.
2736 Set this to 1 to create a live stream DASH Manifest. Default: 0.
2738 @item chunk_start_index
2739 Start index of the first chunk. This will go in the @samp{startNumber} attribute
2740 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
2742 @item chunk_duration_ms
2743 Duration of each chunk in milliseconds. This will go in the @samp{duration}
2744 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
2746 @item utc_timing_url
2747 URL of the page that will return the UTC timestamp in ISO format. This will go
2748 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
2751 @item time_shift_buffer_depth
2752 Smallest time (in seconds) shifting buffer for which any Representation is
2753 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
2754 attribute of the @samp{MPD} element. Default: 60.
2756 @item minimum_update_period
2757 Minimum update period (in seconds) of the manifest. This will go in the
2758 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
2764 ffmpeg -f webm_dash_manifest -i video1.webm \
2765 -f webm_dash_manifest -i video2.webm \
2766 -f webm_dash_manifest -i audio1.webm \
2767 -f webm_dash_manifest -i audio2.webm \
2768 -map 0 -map 1 -map 2 -map 3 \
2770 -f webm_dash_manifest \
2771 -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \