avformat/dashenc: Added support for Low-latency HLS(Experimental)
[ffmpeg.git] / doc / muxers.texi
1 @chapter Muxers
2 @c man begin MUXERS
3
4 Muxers are configured elements in FFmpeg which allow writing
5 multimedia streams to a particular type of file.
6
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}.
10
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}}.
15
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.
19
20 A description of some of the currently available muxers follows.
21
22 @anchor{aiff}
23 @section aiff
24
25 Audio Interchange File Format muxer.
26
27 @subsection Options
28
29 It accepts the following options:
30
31 @table @option
32 @item write_id3v2
33 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
34
35 @item id3v2_version
36 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
37 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
38
39 @end table
40
41 @anchor{asf}
42 @section asf
43
44 Advanced Systems Format muxer.
45
46 Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this
47 muxer too.
48
49 @subsection Options
50
51 It accepts the following options:
52
53 @table @option
54 @item packet_size
55 Set the muxer packet size. By tuning this setting you may reduce data
56 fragmentation or muxer overhead depending on your source. Default value is
57 3200, minimum is 100, maximum is 64k.
58
59 @end table
60
61 @anchor{avi}
62 @section avi
63
64 Audio Video Interleaved muxer.
65
66 @subsection Options
67
68 It accepts the following options:
69
70 @table @option
71 @item reserve_index_space
72 Reserve the specified amount of bytes for the OpenDML master index of each
73 stream within the file header. By default additional master indexes are
74 embedded within the data packets if there is no space left in the first master
75 index and are linked together as a chain of indexes. This index structure can
76 cause problems for some use cases, e.g. third-party software strictly relying
77 on the OpenDML index specification or when file seeking is slow. Reserving
78 enough index space in the file header avoids these problems.
79
80 The required index space depends on the output file size and should be about 16
81 bytes per gigabyte. When this option is omitted or set to zero the necessary
82 index space is guessed.
83
84 @item write_channel_mask
85 Write the channel layout mask into the audio stream header.
86
87 This option is enabled by default. Disabling the channel mask can be useful in
88 specific scenarios, e.g. when merging multiple audio streams into one for
89 compatibility with software that only supports a single audio stream in AVI
90 (see @ref{amerge,,the "amerge" section in the ffmpeg-filters manual,ffmpeg-filters}).
91
92 @end table
93
94 @anchor{chromaprint}
95 @section chromaprint
96
97 Chromaprint fingerprinter.
98
99 This muxer feeds audio data to the Chromaprint library,
100 which generates a fingerprint for the provided audio data. See @url{https://acoustid.org/chromaprint}
101
102 It takes a single signed native-endian 16-bit raw audio stream of at most 2 channels.
103
104 @subsection Options
105
106 @table @option
107 @item silence_threshold
108 Threshold for detecting silence, ranges from -1 to 32767. -1 disables silence detection and
109 is required for use with the AcoustID service. Default is -1.
110
111 @item algorithm
112 Version of algorithm to fingerprint with. Range is 0 to 4. Version 2 requires that silence
113 detection be enabled. Default is 1.
114
115 @item fp_format
116 Format to output the fingerprint as. Accepts the following options:
117 @table @samp
118 @item raw
119 Binary raw fingerprint
120
121 @item compressed
122 Binary compressed fingerprint
123
124 @item base64
125 Base64 compressed fingerprint @emph{(default)}
126
127 @end table
128
129 @end table
130
131 @anchor{crc}
132 @section crc
133
134 CRC (Cyclic Redundancy Check) testing format.
135
136 This muxer computes and prints the Adler-32 CRC of all the input audio
137 and video frames. By default audio frames are converted to signed
138 16-bit raw audio and video frames to raw video before computing the
139 CRC.
140
141 The output of the muxer consists of a single line of the form:
142 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
143 8 digits containing the CRC for all the decoded input frames.
144
145 See also the @ref{framecrc} muxer.
146
147 @subsection Examples
148
149 For example to compute the CRC of the input, and store it in the file
150 @file{out.crc}:
151 @example
152 ffmpeg -i INPUT -f crc out.crc
153 @end example
154
155 You can print the CRC to stdout with the command:
156 @example
157 ffmpeg -i INPUT -f crc -
158 @end example
159
160 You can select the output format of each frame with @command{ffmpeg} by
161 specifying the audio and video codec and format. For example to
162 compute the CRC of the input audio converted to PCM unsigned 8-bit
163 and the input video converted to MPEG-2 video, use the command:
164 @example
165 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
166 @end example
167
168 @section flv
169
170 Adobe Flash Video Format muxer.
171
172 This muxer accepts the following options:
173
174 @table @option
175
176 @item flvflags @var{flags}
177 Possible values:
178
179 @table @samp
180
181 @item aac_seq_header_detect
182 Place AAC sequence header based on audio stream data.
183
184 @item no_sequence_end
185 Disable sequence end tag.
186
187 @item no_metadata
188 Disable metadata tag.
189
190 @item no_duration_filesize
191 Disable duration and filesize in metadata when they are equal to zero
192 at the end of stream. (Be used to non-seekable living stream).
193
194 @item add_keyframe_index
195 Used to facilitate seeking; particularly for HTTP pseudo streaming.
196 @end table
197 @end table
198
199 @anchor{dash}
200 @section dash
201
202 Dynamic Adaptive Streaming over HTTP (DASH) muxer that creates segments
203 and manifest files according to the MPEG-DASH standard ISO/IEC 23009-1:2014.
204
205 For more information see:
206
207 @itemize @bullet
208 @item
209 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
210 @item
211 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
212 @end itemize
213
214 It creates a MPD manifest file and segment files for each stream.
215
216 The segment filename might contain pre-defined identifiers used with SegmentTemplate
217 as defined in section 5.3.9.4.4 of the standard. Available identifiers are "$RepresentationID$",
218 "$Number$", "$Bandwidth$" and "$Time$".
219
220 @example
221 ffmpeg -re -i <input> -map 0 -map 0 -c:a libfdk_aac -c:v libx264
222 -b:v:0 800k -b:v:1 300k -s:v:1 320x170 -profile:v:1 baseline
223 -profile:v:0 main -bf 1 -keyint_min 120 -g 120 -sc_threshold 0
224 -b_strategy 0 -ar:a:1 22050 -use_timeline 1 -use_template 1
225 -window_size 5 -adaptation_sets "id=0,streams=v id=1,streams=a"
226 -f dash /path/to/out.mpd
227 @end example
228
229 @table @option
230 @item -min_seg_duration @var{microseconds}
231 This is a deprecated option to set the segment length in microseconds, use @var{seg_duration} instead.
232 @item -seg_duration @var{duration}
233 Set the segment length in seconds (fractional value can be set). The value is
234 treated as average segment duration when @var{use_template} is enabled and
235 @var{use_timeline} is disabled and as minimum segment duration for all the other
236 use cases.
237 @item -window_size @var{size}
238 Set the maximum number of segments kept in the manifest.
239 @item -extra_window_size @var{size}
240 Set the maximum number of segments kept outside of the manifest before removing from disk.
241 @item -remove_at_exit @var{remove}
242 Enable (1) or disable (0) removal of all segments when finished.
243 @item -use_template @var{template}
244 Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList.
245 @item -use_timeline @var{timeline}
246 Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate.
247 @item -single_file @var{single_file}
248 Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges.
249 @item -single_file_name @var{file_name}
250 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.
251 @item -init_seg_name @var{init_name}
252 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.
253 @item -media_seg_name @var{segment_name}
254 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.
255 @item -utc_timing_url @var{utc_url}
256 URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso"
257 @item method @var{method}
258 Use the given HTTP method to create output files. Generally set to PUT or POST.
259 @item -http_user_agent @var{user_agent}
260 Override User-Agent field in HTTP header. Applicable only for HTTP output.
261 @item -http_persistent @var{http_persistent}
262 Use persistent HTTP connections. Applicable only for HTTP output.
263 @item -hls_playlist @var{hls_playlist}
264 Generate HLS playlist files as well. The master playlist is generated with the filename master.m3u8.
265 One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc.
266 @item -streaming @var{streaming}
267 Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming
268 mode, each frame will be a moof fragment which forms a chunk.
269 @item -adaptation_sets @var{adaptation_sets}
270 Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs
271 of the adaptation sets and a,b,c,d and e are the indices of the mapped streams.
272
273 To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs.
274
275 When no assignment is defined, this defaults to an AdaptationSet for each stream.
276 @item -timeout @var{timeout}
277 Set timeout for socket I/O operations. Applicable only for HTTP output.
278 @item -index_correction @var{index_correction}
279 Enable (1) or Disable (0) segment index correction logic. Applicable only when
280 @var{use_template} is enabled and @var{use_timeline} is disabled.
281
282 When enabled, the logic monitors the flow of segment indexes. If a streams's
283 segment index value is not at the expected real time position, then the logic
284 corrects that index value.
285
286 Typically this logic is needed in live streaming use cases. The network bandwidth
287 fluctuations are common during long run streaming. Each fluctuation can cause
288 the segment indexes fall behind the expected real time position.
289 @item -format_options @var{options_list}
290 Set container format (mp4/webm) options using a @code{:} separated list of
291 key=value parameters. Values containing @code{:} special characters must be
292 escaped.
293
294 @item -dash_segment_type @var{dash_segment_type}
295 Possible values:
296 @item auto
297 If this flag is set, the dash segment files format will be selected based on the stream codec. This is the default mode.
298
299 @item mp4
300 If this flag is set, the dash segment files will be in in ISOBMFF format.
301
302 @item webm
303 If this flag is set, the dash segment files will be in in WebM format.
304
305 @item -ignore_io_errors @var{ignore_io_errors}
306 Ignore IO errors during open and write. Useful for long-duration runs with network output.
307
308 @item -lhls @var{lhls}
309 Enable Low-latency HLS(LHLS). Adds #EXT-X-PREFETCH tag with current segment's URI.
310 Apple doesn't have an official spec for LHLS. Meanwhile hls.js player folks are
311 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
312 This option will also try to comply with the above open spec, till Apple's spec officially supports it.
313 Applicable only when @var{streaming} and @var{hls_playlist} options are enabled.
314 This is an experimental feature.
315
316 @end table
317
318 @anchor{framecrc}
319 @section framecrc
320
321 Per-packet CRC (Cyclic Redundancy Check) testing format.
322
323 This muxer computes and prints the Adler-32 CRC for each audio
324 and video packet. By default audio frames are converted to signed
325 16-bit raw audio and video frames to raw video before computing the
326 CRC.
327
328 The output of the muxer consists of a line for each audio and video
329 packet of the form:
330 @example
331 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
332 @end example
333
334 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
335 CRC of the packet.
336
337 @subsection Examples
338
339 For example to compute the CRC of the audio and video frames in
340 @file{INPUT}, converted to raw audio and video packets, and store it
341 in the file @file{out.crc}:
342 @example
343 ffmpeg -i INPUT -f framecrc out.crc
344 @end example
345
346 To print the information to stdout, use the command:
347 @example
348 ffmpeg -i INPUT -f framecrc -
349 @end example
350
351 With @command{ffmpeg}, you can select the output format to which the
352 audio and video frames are encoded before computing the CRC for each
353 packet by specifying the audio and video codec. For example, to
354 compute the CRC of each decoded input audio frame converted to PCM
355 unsigned 8-bit and of each decoded input video frame converted to
356 MPEG-2 video, use the command:
357 @example
358 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
359 @end example
360
361 See also the @ref{crc} muxer.
362
363 @anchor{framehash}
364 @section framehash
365
366 Per-packet hash testing format.
367
368 This muxer computes and prints a cryptographic hash for each audio
369 and video packet. This can be used for packet-by-packet equality
370 checks without having to individually do a binary comparison on each.
371
372 By default audio frames are converted to signed 16-bit raw audio and
373 video frames to raw video before computing the hash, but the output
374 of explicit conversions to other codecs can also be used. It uses the
375 SHA-256 cryptographic hash function by default, but supports several
376 other algorithms.
377
378 The output of the muxer consists of a line for each audio and video
379 packet of the form:
380 @example
381 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
382 @end example
383
384 @var{hash} is a hexadecimal number representing the computed hash
385 for the packet.
386
387 @table @option
388 @item hash @var{algorithm}
389 Use the cryptographic hash function specified by the string @var{algorithm}.
390 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
391 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
392 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
393 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
394
395 @end table
396
397 @subsection Examples
398
399 To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
400 converted to raw audio and video packets, and store it in the file
401 @file{out.sha256}:
402 @example
403 ffmpeg -i INPUT -f framehash out.sha256
404 @end example
405
406 To print the information to stdout, using the MD5 hash function, use
407 the command:
408 @example
409 ffmpeg -i INPUT -f framehash -hash md5 -
410 @end example
411
412 See also the @ref{hash} muxer.
413
414 @anchor{framemd5}
415 @section framemd5
416
417 Per-packet MD5 testing format.
418
419 This is a variant of the @ref{framehash} muxer. Unlike that muxer,
420 it defaults to using the MD5 hash function.
421
422 @subsection Examples
423
424 To compute the MD5 hash of the audio and video frames in @file{INPUT},
425 converted to raw audio and video packets, and store it in the file
426 @file{out.md5}:
427 @example
428 ffmpeg -i INPUT -f framemd5 out.md5
429 @end example
430
431 To print the information to stdout, use the command:
432 @example
433 ffmpeg -i INPUT -f framemd5 -
434 @end example
435
436 See also the @ref{framehash} and @ref{md5} muxers.
437
438 @anchor{gif}
439 @section gif
440
441 Animated GIF muxer.
442
443 It accepts the following options:
444
445 @table @option
446 @item loop
447 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
448 for looping indefinitely (default).
449
450 @item final_delay
451 Force the delay (expressed in centiseconds) after the last frame. Each frame
452 ends with a delay until the next frame. The default is @code{-1}, which is a
453 special value to tell the muxer to re-use the previous delay. In case of a
454 loop, you might want to customize this value to mark a pause for instance.
455 @end table
456
457 For example, to encode a gif looping 10 times, with a 5 seconds delay between
458 the loops:
459 @example
460 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
461 @end example
462
463 Note 1: if you wish to extract the frames into separate GIF files, you need to
464 force the @ref{image2} muxer:
465 @example
466 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
467 @end example
468
469 Note 2: the GIF format has a very large time base: the delay between two frames
470 can therefore not be smaller than one centi second.
471
472 @anchor{hash}
473 @section hash
474
475 Hash testing format.
476
477 This muxer computes and prints a cryptographic hash of all the input
478 audio and video frames. This can be used for equality checks without
479 having to do a complete binary comparison.
480
481 By default audio frames are converted to signed 16-bit raw audio and
482 video frames to raw video before computing the hash, but the output
483 of explicit conversions to other codecs can also be used. Timestamps
484 are ignored. It uses the SHA-256 cryptographic hash function by default,
485 but supports several other algorithms.
486
487 The output of the muxer consists of a single line of the form:
488 @var{algo}=@var{hash}, where @var{algo} is a short string representing
489 the hash function used, and @var{hash} is a hexadecimal number
490 representing the computed hash.
491
492 @table @option
493 @item hash @var{algorithm}
494 Use the cryptographic hash function specified by the string @var{algorithm}.
495 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
496 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
497 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
498 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
499
500 @end table
501
502 @subsection Examples
503
504 To compute the SHA-256 hash of the input converted to raw audio and
505 video, and store it in the file @file{out.sha256}:
506 @example
507 ffmpeg -i INPUT -f hash out.sha256
508 @end example
509
510 To print an MD5 hash to stdout use the command:
511 @example
512 ffmpeg -i INPUT -f hash -hash md5 -
513 @end example
514
515 See also the @ref{framehash} muxer.
516
517 @anchor{hls}
518 @section hls
519
520 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
521 the HTTP Live Streaming (HLS) specification.
522
523 It creates a playlist file, and one or more segment files. The output filename
524 specifies the playlist filename.
525
526 By default, the muxer creates a file for each segment produced. These files
527 have the same name as the playlist, followed by a sequential number and a
528 .ts extension.
529
530 Make sure to require a closed GOP when encoding and to set the GOP
531 size to fit your segment time constraint.
532
533 For example, to convert an input file with @command{ffmpeg}:
534 @example
535 ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
536 @end example
537 This example will produce the playlist, @file{out.m3u8}, and segment files:
538 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
539
540 See also the @ref{segment} muxer, which provides a more generic and
541 flexible implementation of a segmenter, and can be used to perform HLS
542 segmentation.
543
544 @subsection Options
545
546 This muxer supports the following options:
547
548 @table @option
549 @item hls_init_time @var{seconds}
550 Set the initial target segment length in seconds. Default value is @var{0}.
551 Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
552 After the initial playlist is filled @command{ffmpeg} will cut segments
553 at duration equal to @code{hls_time}
554
555 @item hls_time @var{seconds}
556 Set the target segment length in seconds. Default value is 2.
557 Segment will be cut on the next key frame after this time has passed.
558
559 @item hls_list_size @var{size}
560 Set the maximum number of playlist entries. If set to 0 the list file
561 will contain all the segments. Default value is 5.
562
563 @item hls_delete_threshold @var{size}
564 Set the number of unreferenced segments to keep on disk before @code{hls_flags delete_segments}
565 deletes them. Increase this to allow continue clients to download segments which
566 were recently referenced in the playlist. Default value is 1, meaning segments older than
567 @code{hls_list_size+1} will be deleted.
568
569 @item hls_ts_options @var{options_list}
570 Set output format options using a :-separated list of key=value
571 parameters. Values containing @code{:} special characters must be
572 escaped.
573
574 @item hls_wrap @var{wrap}
575 This is a deprecated option, you can use @code{hls_list_size}
576 and @code{hls_flags delete_segments} instead it
577
578 This option is useful to avoid to fill the disk with many segment
579 files, and limits the maximum number of segment files written to disk
580 to @var{wrap}.
581
582
583 @item hls_start_number_source
584 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) according to the specified source.
585 Unless @code{hls_flags single_file} is set, it also specifies source of starting sequence numbers of
586 segment and subtitle filenames. In any case, if @code{hls_flags append_list}
587 is set and read playlist sequence number is greater than the specified start sequence number,
588 then that value will be used as start value.
589
590 It accepts the following values:
591
592 @table @option
593
594 @item generic (default)
595 Set the starting sequence numbers according to @var{start_number} option value.
596
597 @item epoch
598 The start number will be the seconds since epoch (1970-01-01 00:00:00)
599
600 @item datetime
601 The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759.
602
603 @end table
604
605 @item start_number @var{number}
606 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) from the specified @var{number}
607 when @var{hls_start_number_source} value is @var{generic}. (This is the default case.)
608 Unless @code{hls_flags single_file} is set, it also specifies starting sequence numbers of segment and subtitle filenames.
609 Default value is 0.
610
611 @item hls_allow_cache @var{allowcache}
612 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
613
614 @item hls_base_url @var{baseurl}
615 Append @var{baseurl} to every entry in the playlist.
616 Useful to generate playlists with absolute paths.
617
618 Note that the playlist sequence number must be unique for each segment
619 and it is not to be confused with the segment filename sequence number
620 which can be cyclic, for example if the @option{wrap} option is
621 specified.
622
623 @item hls_segment_filename @var{filename}
624 Set the segment filename. Unless @code{hls_flags single_file} is set,
625 @var{filename} is used as a string format with the segment number:
626 @example
627 ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
628 @end example
629 This example will produce the playlist, @file{out.m3u8}, and segment files:
630 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
631
632 @var{filename} may contain full path or relative path specification,
633 but only the file name part without any path info will be contained in the m3u8 segment list.
634 Should a relative path be specified, the path of the created segment
635 files will be relative to the current working directory.
636 When strftime_mkdir is set, the whole expanded value of @var{filename} will be written into the m3u8 segment list.
637
638 When @code{var_stream_map} is set with two or more variant streams, the
639 @var{filename} pattern must contain the string "%v", this string specifies
640 the position of variant stream index in the generated segment file names.
641 @example
642 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
643   -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" \
644   -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
645 @end example
646 This example will produce the playlists segment file sets:
647 @file{file_0_000.ts}, @file{file_0_001.ts}, @file{file_0_002.ts}, etc. and
648 @file{file_1_000.ts}, @file{file_1_001.ts}, @file{file_1_002.ts}, etc.
649
650 The string "%v" may be present in the filename or in the last directory name
651 containing the file. If the string is present in the directory name, then
652 sub-directories are created after expanding the directory name pattern. This
653 enables creation of segments corresponding to different variant streams in
654 subdirectories.
655 @example
656 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
657   -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" \
658   -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
659 @end example
660 This example will produce the playlists segment file sets:
661 @file{vs0/file_000.ts}, @file{vs0/file_001.ts}, @file{vs0/file_002.ts}, etc. and
662 @file{vs1/file_000.ts}, @file{vs1/file_001.ts}, @file{vs1/file_002.ts}, etc.
663
664 @item use_localtime
665 Same as strftime option, will be deprecated.
666
667 @item strftime
668 Use strftime() on @var{filename} to expand the segment filename with localtime.
669 The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index
670 hls_flag and %%d will be the specifier.
671 @example
672 ffmpeg -i in.nut -strftime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
673 @end example
674 This example will produce the playlist, @file{out.m3u8}, and segment files:
675 @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
676 Note: On some systems/environments, the @code{%s} specifier is not available. See
677   @code{strftime()} documentation.
678 @example
679 ffmpeg -i in.nut -strftime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
680 @end example
681 This example will produce the playlist, @file{out.m3u8}, and segment files:
682 @file{file-20160215-0001.ts}, @file{file-20160215-0002.ts}, etc.
683
684 @item use_localtime_mkdir
685 Same as strftime_mkdir option, will be deprecated .
686
687 @item strftime_mkdir
688 Used together with -strftime_mkdir, it will create all subdirectories which
689 is expanded in @var{filename}.
690 @example
691 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
692 @end example
693 This example will create a directory 201560215 (if it does not exist), and then
694 produce the playlist, @file{out.m3u8}, and segment files:
695 @file{20160215/file-20160215-1455569023.ts}, @file{20160215/file-20160215-1455569024.ts}, etc.
696
697 @example
698 ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
699 @end example
700 This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then
701 produce the playlist, @file{out.m3u8}, and segment files:
702 @file{2016/02/15/file-20160215-1455569023.ts}, @file{2016/02/15/file-20160215-1455569024.ts}, etc.
703
704
705 @item hls_key_info_file @var{key_info_file}
706 Use the information in @var{key_info_file} for segment encryption. The first
707 line of @var{key_info_file} specifies the key URI written to the playlist. The
708 key URL is used to access the encryption key during playback. The second line
709 specifies the path to the key file used to obtain the key during the encryption
710 process. The key file is read as a single packed array of 16 octets in binary
711 format. The optional third line specifies the initialization vector (IV) as a
712 hexadecimal string to be used instead of the segment sequence number (default)
713 for encryption. Changes to @var{key_info_file} will result in segment
714 encryption with the new key/IV and an entry in the playlist for the new key
715 URI/IV if @code{hls_flags periodic_rekey} is enabled.
716
717 Key info file format:
718 @example
719 @var{key URI}
720 @var{key file path}
721 @var{IV} (optional)
722 @end example
723
724 Example key URIs:
725 @example
726 http://server/file.key
727 /path/to/file.key
728 file.key
729 @end example
730
731 Example key file paths:
732 @example
733 file.key
734 /path/to/file.key
735 @end example
736
737 Example IV:
738 @example
739 0123456789ABCDEF0123456789ABCDEF
740 @end example
741
742 Key info file example:
743 @example
744 http://server/file.key
745 /path/to/file.key
746 0123456789ABCDEF0123456789ABCDEF
747 @end example
748
749 Example shell script:
750 @example
751 #!/bin/sh
752 BASE_URL=$@{1:-'.'@}
753 openssl rand 16 > file.key
754 echo $BASE_URL/file.key > file.keyinfo
755 echo file.key >> file.keyinfo
756 echo $(openssl rand -hex 16) >> file.keyinfo
757 ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
758   -hls_key_info_file file.keyinfo out.m3u8
759 @end example
760
761 @item -hls_enc @var{enc}
762 Enable (1) or disable (0) the AES128 encryption.
763 When enabled every segment generated is encrypted and the encryption key
764 is saved as @var{playlist name}.key.
765
766 @item -hls_enc_key @var{key}
767 Hex-coded 16byte key to encrypt the segments, by default it
768 is randomly generated.
769
770 @item -hls_enc_key_url @var{keyurl}
771 If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
772 in the playlist.
773
774 @item -hls_enc_iv @var{iv}
775 Hex-coded 16byte initialization vector for every segment instead
776 of the autogenerated ones.
777
778 @item hls_segment_type @var{flags}
779 Possible values:
780
781 @table @samp
782 @item mpegts
783 Output segment files in MPEG-2 Transport Stream format. This is
784 compatible with all HLS versions.
785
786 @item fmp4
787 Output segment files in fragmented MP4 format, similar to MPEG-DASH.
788 fmp4 files may be used in HLS version 7 and above.
789
790 @end table
791
792 @item hls_fmp4_init_filename @var{filename}
793 Set filename to the fragment files header file, default filename is @file{init.mp4}.
794
795 When @code{var_stream_map} is set with two or more variant streams, the
796 @var{filename} pattern must contain the string "%v", this string specifies
797 the position of variant stream index in the generated init file names.
798 The string "%v" may be present in the filename or in the last directory name
799 containing the file. If the string is present in the directory name, then
800 sub-directories are created after expanding the directory name pattern. This
801 enables creation of init files corresponding to different variant streams in
802 subdirectories.
803
804 @item hls_flags @var{flags}
805 Possible values:
806
807 @table @samp
808 @item single_file
809 If this flag is set, the muxer will store all segments in a single MPEG-TS
810 file, and will use byte ranges in the playlist. HLS playlists generated with
811 this way will have the version number 4.
812 For example:
813 @example
814 ffmpeg -i in.nut -hls_flags single_file out.m3u8
815 @end example
816 Will produce the playlist, @file{out.m3u8}, and a single segment file,
817 @file{out.ts}.
818
819 @item delete_segments
820 Segment files removed from the playlist are deleted after a period of time
821 equal to the duration of the segment plus the duration of the playlist.
822
823 @item append_list
824 Append new segments into the end of old segment list,
825 and remove the @code{#EXT-X-ENDLIST} from the old segment list.
826
827 @item round_durations
828 Round the duration info in the playlist file segment info to integer
829 values, instead of using floating point.
830
831 @item discont_start
832 Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
833 first segment's information.
834
835 @item omit_endlist
836 Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
837
838 @item periodic_rekey
839 The file specified by @code{hls_key_info_file} will be checked periodically and
840 detect updates to the encryption info. Be sure to replace this file atomically,
841 including the file containing the AES encryption key.
842
843 @item independent_segments
844 Add the @code{#EXT-X-INDEPENDENT-SEGMENTS} to playlists that has video segments
845 and when all the segments of that playlist are guaranteed to start with a Key frame.
846
847 @item split_by_time
848 Allow segments to start on frames other than keyframes. This improves
849 behavior on some players when the time between keyframes is inconsistent,
850 but may make things worse on others, and can cause some oddities during
851 seeking. This flag should be used with the @code{hls_time} option.
852
853 @item program_date_time
854 Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
855
856 @item second_level_segment_index
857 Makes it possible to use segment indexes as %%d in hls_segment_filename expression
858 besides date/time values when strftime is on.
859 To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width.
860
861 @item second_level_segment_size
862 Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename
863 expression besides date/time values when strftime is on.
864 To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width.
865
866 @item second_level_segment_duration
867 Makes it possible to use segment duration (calculated  in microseconds) as %%t in hls_segment_filename
868 expression besides date/time values when strftime is on.
869 To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width.
870
871 @example
872 ffmpeg -i sample.mpeg \
873    -f hls -hls_time 3 -hls_list_size 5 \
874    -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
875    -strftime 1 -strftime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
876 @end example
877 This will produce segments like this:
878 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
879
880 @item temp_file
881 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
882 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
883 before they have been added to the m3u8 playlist.
884
885 @end table
886
887 @item hls_playlist_type event
888 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
889 @option{hls_list_size} to 0; the playlist can only be appended to.
890
891 @item hls_playlist_type vod
892 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
893 @option{hls_list_size} to 0; the playlist must not change.
894
895 @item method
896 Use the given HTTP method to create the hls files.
897 @example
898 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
899 @end example
900 This example will upload all the mpegts segment files to the HTTP
901 server using the HTTP PUT method, and update the m3u8 files every
902 @code{refresh} times using the same method.
903 Note that the HTTP server must support the given method for uploading
904 files.
905
906 @item http_user_agent
907 Override User-Agent field in HTTP header. Applicable only for HTTP output.
908
909 @item var_stream_map
910 Map string which specifies how to group the audio, video and subtitle streams
911 into different variant streams. The variant stream groups are separated
912 by space.
913 Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are
914 the keys to specify audio, video and subtitle streams respectively.
915 Allowed values are 0 to 9 (limited just based on practical usage).
916
917 When there are two or more variant streams, the output filename pattern must
918 contain the string "%v", this string specifies the position of variant stream
919 index in the output media playlist filenames. The string "%v" may be present in
920 the filename or in the last directory name containing the file. If the string is
921 present in the directory name, then sub-directories are created after expanding
922 the directory name pattern. This enables creation of variant streams in
923 subdirectories.
924
925 @example
926 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
927   -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" \
928   http://example.com/live/out_%v.m3u8
929 @end example
930 This example creates two hls variant streams. The first variant stream will
931 contain video stream of bitrate 1000k and audio stream of bitrate 64k and the
932 second variant stream will contain video stream of bitrate 256k and audio
933 stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and
934 out_1.m3u8 will be created.
935 @example
936 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
937   -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
938   http://example.com/live/out_%v.m3u8
939 @end example
940 This example creates three hls variant streams. The first variant stream will
941 be a video only stream with video bitrate 1000k, the second variant stream will
942 be an audio only stream with bitrate 64k and the third variant stream will be a
943 video only stream with bitrate 256k. Here, three media playlist with file names
944 out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created.
945 @example
946 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
947   -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" \
948   http://example.com/live/vs_%v/out.m3u8
949 @end example
950 This example creates the variant streams in subdirectories. Here, the first
951 media playlist is created at @file{http://example.com/live/vs_0/out.m3u8} and
952 the second one at @file{http://example.com/live/vs_1/out.m3u8}.
953 @example
954 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k  \
955   -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
956   -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
957   -master_pl_name master.m3u8 \
958   http://example.com/live/out_%v.m3u8
959 @end example
960 This example creates two audio only and two video only variant streams. In
961 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
962 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
963 and they are mapped to the two video only variant streams with audio group names
964 'aud_low' and 'aud_high'.
965
966 By default, a single hls variant containing all the encoded streams is created.
967
968 @item cc_stream_map
969 Map string which specifies different closed captions groups and their
970 attributes. The closed captions stream groups are separated by space.
971 Expected string format is like this
972 "ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....".
973 'ccgroup' and 'instreamid' are mandatory attributes. 'language' is an optional
974 attribute.
975 The closed captions groups configured using this option are mapped to different
976 variant streams by providing the same 'ccgroup' name in the
977 @code{var_stream_map} string. If @code{var_stream_map} is not set, then the
978 first available ccgroup in @code{cc_stream_map} is mapped to the output variant
979 stream. The examples for these two use cases are given below.
980
981 @example
982 ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
983   -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
984   -master_pl_name master.m3u8 \
985   http://example.com/live/out.m3u8
986 @end example
987 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=CLOSED-CAPTIONS} in
988 the master playlist with group name 'cc', langauge 'en' (english) and
989 INSTREAM-ID 'CC1'. Also, it adds @code{CLOSED-CAPTIONS} attribute with group
990 name 'cc' for the output variant stream.
991 @example
992 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
993   -a53cc:0 1 -a53cc:1 1\
994   -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
995   -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
996   -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
997   -master_pl_name master.m3u8 \
998   http://example.com/live/out_%v.m3u8
999 @end example
1000 This example adds two @code{#EXT-X-MEDIA} tags with @code{TYPE=CLOSED-CAPTIONS} in
1001 the master playlist for the INSTREAM-IDs 'CC1' and 'CC2'. Also, it adds
1002 @code{CLOSED-CAPTIONS} attribute with group name 'cc' for the two output variant
1003 streams.
1004
1005 @item master_pl_name
1006 Create HLS master playlist with the given name.
1007
1008 @example
1009 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
1010 @end example
1011 This example creates HLS master playlist with name master.m3u8 and it is
1012 published at http://example.com/live/
1013
1014 @item master_pl_publish_rate
1015 Publish master play list repeatedly every after specified number of segment intervals.
1016
1017 @example
1018 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
1019 -hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
1020 @end example
1021
1022 This example creates HLS master playlist with name master.m3u8 and keep
1023 publishing it repeatedly every after 30 segments i.e. every after 60s.
1024
1025 @item http_persistent
1026 Use persistent HTTP connections. Applicable only for HTTP output.
1027
1028 @item timeout
1029 Set timeout for socket I/O operations. Applicable only for HTTP output.
1030
1031 @item -ignore_io_errors
1032 Ignore IO errors during open, write and delete. Useful for long-duration runs with network output.
1033
1034 @end table
1035
1036 @anchor{ico}
1037 @section ico
1038
1039 ICO file muxer.
1040
1041 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
1042
1043 @itemize
1044 @item
1045 Size cannot exceed 256 pixels in any dimension
1046
1047 @item
1048 Only BMP and PNG images can be stored
1049
1050 @item
1051 If a BMP image is used, it must be one of the following pixel formats:
1052 @example
1053 BMP Bit Depth      FFmpeg Pixel Format
1054 1bit               pal8
1055 4bit               pal8
1056 8bit               pal8
1057 16bit              rgb555le
1058 24bit              bgr24
1059 32bit              bgra
1060 @end example
1061
1062 @item
1063 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
1064
1065 @item
1066 If a PNG image is used, it must use the rgba pixel format
1067 @end itemize
1068
1069 @anchor{image2}
1070 @section image2
1071
1072 Image file muxer.
1073
1074 The image file muxer writes video frames to image files.
1075
1076 The output filenames are specified by a pattern, which can be used to
1077 produce sequentially numbered series of files.
1078 The pattern may contain the string "%d" or "%0@var{N}d", this string
1079 specifies the position of the characters representing a numbering in
1080 the filenames. If the form "%0@var{N}d" is used, the string
1081 representing the number in each filename is 0-padded to @var{N}
1082 digits. The literal character '%' can be specified in the pattern with
1083 the string "%%".
1084
1085 If the pattern contains "%d" or "%0@var{N}d", the first filename of
1086 the file list specified will contain the number 1, all the following
1087 numbers will be sequential.
1088
1089 The pattern may contain a suffix which is used to automatically
1090 determine the format of the image files to write.
1091
1092 For example the pattern "img-%03d.bmp" will specify a sequence of
1093 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
1094 @file{img-010.bmp}, etc.
1095 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
1096 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
1097 etc.
1098
1099 @subsection Examples
1100
1101 The following example shows how to use @command{ffmpeg} for creating a
1102 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
1103 taking one image every second from the input video:
1104 @example
1105 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
1106 @end example
1107
1108 Note that with @command{ffmpeg}, if the format is not specified with the
1109 @code{-f} option and the output filename specifies an image file
1110 format, the image2 muxer is automatically selected, so the previous
1111 command can be written as:
1112 @example
1113 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
1114 @end example
1115
1116 Note also that the pattern must not necessarily contain "%d" or
1117 "%0@var{N}d", for example to create a single image file
1118 @file{img.jpeg} from the start of the input video you can employ the command:
1119 @example
1120 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
1121 @end example
1122
1123 The @option{strftime} option allows you to expand the filename with
1124 date and time information. Check the documentation of
1125 the @code{strftime()} function for the syntax.
1126
1127 For example to generate image files from the @code{strftime()}
1128 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
1129 can be used:
1130 @example
1131 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
1132 @end example
1133
1134 You can set the file name with current frame's PTS:
1135 @example
1136 ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
1137 @end example
1138
1139 @subsection Options
1140
1141 @table @option
1142 @item frame_pts
1143 If set to 1, expand the filename with pts from pkt->pts.
1144 Default value is 0.
1145
1146 @item start_number
1147 Start the sequence from the specified number. Default value is 1.
1148
1149 @item update
1150 If set to 1, the filename will always be interpreted as just a
1151 filename, not a pattern, and the corresponding file will be continuously
1152 overwritten with new images. Default value is 0.
1153
1154 @item strftime
1155 If set to 1, expand the filename with date and time information from
1156 @code{strftime()}. Default value is 0.
1157 @end table
1158
1159 The image muxer supports the .Y.U.V image file format. This format is
1160 special in that that each image frame consists of three files, for
1161 each of the YUV420P components. To read or write this image file format,
1162 specify the name of the '.Y' file. The muxer will automatically open the
1163 '.U' and '.V' files as required.
1164
1165 @section matroska
1166
1167 Matroska container muxer.
1168
1169 This muxer implements the matroska and webm container specs.
1170
1171 @subsection Metadata
1172
1173 The recognized metadata settings in this muxer are:
1174
1175 @table @option
1176 @item title
1177 Set title name provided to a single track.
1178
1179 @item language
1180 Specify the language of the track in the Matroska languages form.
1181
1182 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
1183 639-2/B) form (like "fre" for French), or a language code mixed with a
1184 country code for specialities in languages (like "fre-ca" for Canadian
1185 French).
1186
1187 @item stereo_mode
1188 Set stereo 3D video layout of two views in a single video track.
1189
1190 The following values are recognized:
1191 @table @samp
1192 @item mono
1193 video is not stereo
1194 @item left_right
1195 Both views are arranged side by side, Left-eye view is on the left
1196 @item bottom_top
1197 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
1198 @item top_bottom
1199 Both views are arranged in top-bottom orientation, Left-eye view is on top
1200 @item checkerboard_rl
1201 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
1202 @item checkerboard_lr
1203 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
1204 @item row_interleaved_rl
1205 Each view is constituted by a row based interleaving, Right-eye view is first row
1206 @item row_interleaved_lr
1207 Each view is constituted by a row based interleaving, Left-eye view is first row
1208 @item col_interleaved_rl
1209 Both views are arranged in a column based interleaving manner, Right-eye view is first column
1210 @item col_interleaved_lr
1211 Both views are arranged in a column based interleaving manner, Left-eye view is first column
1212 @item anaglyph_cyan_red
1213 All frames are in anaglyph format viewable through red-cyan filters
1214 @item right_left
1215 Both views are arranged side by side, Right-eye view is on the left
1216 @item anaglyph_green_magenta
1217 All frames are in anaglyph format viewable through green-magenta filters
1218 @item block_lr
1219 Both eyes laced in one Block, Left-eye view is first
1220 @item block_rl
1221 Both eyes laced in one Block, Right-eye view is first
1222 @end table
1223 @end table
1224
1225 For example a 3D WebM clip can be created using the following command line:
1226 @example
1227 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
1228 @end example
1229
1230 @subsection Options
1231
1232 This muxer supports the following options:
1233
1234 @table @option
1235 @item reserve_index_space
1236 By default, this muxer writes the index for seeking (called cues in Matroska
1237 terms) at the end of the file, because it cannot know in advance how much space
1238 to leave for the index at the beginning of the file. However for some use cases
1239 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
1240 index at the beginning of the file.
1241
1242 If this option is set to a non-zero value, the muxer will reserve a given amount
1243 of space in the file header and then try to write the cues there when the muxing
1244 finishes. If the available space does not suffice, muxing will fail. A safe size
1245 for most use cases should be about 50kB per hour of video.
1246
1247 Note that cues are only written if the output is seekable and this option will
1248 have no effect if it is not.
1249 @end table
1250
1251 @anchor{md5}
1252 @section md5
1253
1254 MD5 testing format.
1255
1256 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
1257 defaults to using the MD5 hash function.
1258
1259 @subsection Examples
1260
1261 To compute the MD5 hash of the input converted to raw
1262 audio and video, and store it in the file @file{out.md5}:
1263 @example
1264 ffmpeg -i INPUT -f md5 out.md5
1265 @end example
1266
1267 You can print the MD5 to stdout with the command:
1268 @example
1269 ffmpeg -i INPUT -f md5 -
1270 @end example
1271
1272 See also the @ref{hash} and @ref{framemd5} muxers.
1273
1274 @section mov, mp4, ismv
1275
1276 MOV/MP4/ISMV (Smooth Streaming) muxer.
1277
1278 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
1279 file has all the metadata about all packets stored in one location
1280 (written at the end of the file, it can be moved to the start for
1281 better playback by adding @var{faststart} to the @var{movflags}, or
1282 using the @command{qt-faststart} tool). A fragmented
1283 file consists of a number of fragments, where packets and metadata
1284 about these packets are stored together. Writing a fragmented
1285 file has the advantage that the file is decodable even if the
1286 writing is interrupted (while a normal MOV/MP4 is undecodable if
1287 it is not properly finished), and it requires less memory when writing
1288 very long files (since writing normal MOV/MP4 files stores info about
1289 every single packet in memory until the file is closed). The downside
1290 is that it is less compatible with other applications.
1291
1292 @subsection Options
1293
1294 Fragmentation is enabled by setting one of the AVOptions that define
1295 how to cut the file into fragments:
1296
1297 @table @option
1298 @item -moov_size @var{bytes}
1299 Reserves space for the moov atom at the beginning of the file instead of placing the
1300 moov atom at the end. If the space reserved is insufficient, muxing will fail.
1301 @item -movflags frag_keyframe
1302 Start a new fragment at each video keyframe.
1303 @item -frag_duration @var{duration}
1304 Create fragments that are @var{duration} microseconds long.
1305 @item -frag_size @var{size}
1306 Create fragments that contain up to @var{size} bytes of payload data.
1307 @item -movflags frag_custom
1308 Allow the caller to manually choose when to cut fragments, by
1309 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
1310 the packets written so far. (This is only useful with other
1311 applications integrating libavformat, not from @command{ffmpeg}.)
1312 @item -min_frag_duration @var{duration}
1313 Don't create fragments that are shorter than @var{duration} microseconds long.
1314 @end table
1315
1316 If more than one condition is specified, fragments are cut when
1317 one of the specified conditions is fulfilled. The exception to this is
1318 @code{-min_frag_duration}, which has to be fulfilled for any of the other
1319 conditions to apply.
1320
1321 Additionally, the way the output file is written can be adjusted
1322 through a few other options:
1323
1324 @table @option
1325 @item -movflags empty_moov
1326 Write an initial moov atom directly at the start of the file, without
1327 describing any samples in it. Generally, an mdat/moov pair is written
1328 at the start of the file, as a normal MOV/MP4 file, containing only
1329 a short portion of the file. With this option set, there is no initial
1330 mdat atom, and the moov atom only describes the tracks but has
1331 a zero duration.
1332
1333 This option is implicitly set when writing ismv (Smooth Streaming) files.
1334 @item -movflags separate_moof
1335 Write a separate moof (movie fragment) atom for each track. Normally,
1336 packets for all tracks are written in a moof atom (which is slightly
1337 more efficient), but with this option set, the muxer writes one moof/mdat
1338 pair for each track, making it easier to separate tracks.
1339
1340 This option is implicitly set when writing ismv (Smooth Streaming) files.
1341 @item -movflags skip_sidx
1342 Skip writing of sidx atom. When bitrate overhead due to sidx atom is high,
1343 this option could be used for cases where sidx atom is not mandatory.
1344 When global_sidx flag is enabled, this option will be ignored.
1345 @item -movflags faststart
1346 Run a second pass moving the index (moov atom) to the beginning of the file.
1347 This operation can take a while, and will not work in various situations such
1348 as fragmented output, thus it is not enabled by default.
1349 @item -movflags rtphint
1350 Add RTP hinting tracks to the output file.
1351 @item -movflags disable_chpl
1352 Disable Nero chapter markers (chpl atom).  Normally, both Nero chapters
1353 and a QuickTime chapter track are written to the file. With this option
1354 set, only the QuickTime chapter track will be written. Nero chapters can
1355 cause failures when the file is reprocessed with certain tagging programs, like
1356 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1357 @item -movflags omit_tfhd_offset
1358 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1359 tying fragments to absolute byte positions in the file/streams.
1360 @item -movflags default_base_moof
1361 Similarly to the omit_tfhd_offset, this flag avoids writing the
1362 absolute base_data_offset field in tfhd atoms, but does so by using
1363 the new default-base-is-moof flag instead. This flag is new from
1364 14496-12:2012. This may make the fragments easier to parse in certain
1365 circumstances (avoiding basing track fragment location calculations
1366 on the implicit end of the previous track fragment).
1367 @item -write_tmcd
1368 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1369 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1370 @item -movflags negative_cts_offsets
1371 Enables utilization of version 1 of the CTTS box, in which the CTS offsets can
1372 be negative. This enables the initial sample to have DTS/CTS of zero, and
1373 reduces the need for edit lists for some cases such as video tracks with
1374 B-frames. Additionally, eases conformance with the DASH-IF interoperability
1375 guidelines.
1376
1377 This option is implicitly set when writing ismv (Smooth Streaming) files.
1378 @item -write_prft
1379 Write producer time reference box (PRFT) with a specified time source for the
1380 NTP field in the PRFT box. Set value as @samp{wallclock} to specify timesource
1381 as wallclock time and @samp{pts} to specify timesource as input packets' PTS
1382 values.
1383
1384 Setting value to @samp{pts} is applicable only for a live encoding use case,
1385 where PTS values are set as as wallclock time at the source. For example, an
1386 encoding use case with decklink capture source where @option{video_pts} and
1387 @option{audio_pts} are set to @samp{abs_wallclock}.
1388 @end table
1389
1390 @subsection Example
1391
1392 Smooth Streaming content can be pushed in real time to a publishing
1393 point on IIS with this muxer. Example:
1394 @example
1395 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1396 @end example
1397
1398 @subsection Audible AAX
1399
1400 Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
1401 @example
1402 ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
1403 @end example
1404
1405 @section mp3
1406
1407 The MP3 muxer writes a raw MP3 stream with the following optional features:
1408 @itemize @bullet
1409 @item
1410 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1411 2.4 are supported, the @code{id3v2_version} private option controls which one is
1412 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1413 completely.
1414
1415 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1416 The pictures are supplied to the muxer in form of a video stream with a single
1417 packet. There can be any number of those streams, each will correspond to a
1418 single APIC frame.  The stream metadata tags @var{title} and @var{comment} map
1419 to APIC @var{description} and @var{picture type} respectively. See
1420 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1421
1422 Note that the APIC frames must be written at the beginning, so the muxer will
1423 buffer the audio frames until it gets all the pictures. It is therefore advised
1424 to provide the pictures as soon as possible to avoid excessive buffering.
1425
1426 @item
1427 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1428 default, but will be written only if the output is seekable. The
1429 @code{write_xing} private option can be used to disable it.  The frame contains
1430 various information that may be useful to the decoder, like the audio duration
1431 or encoder delay.
1432
1433 @item
1434 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1435 enabled with the @code{write_id3v1} private option, but as its capabilities are
1436 very limited, its usage is not recommended.
1437 @end itemize
1438
1439 Examples:
1440
1441 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1442 @example
1443 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1444 @end example
1445
1446 To attach a picture to an mp3 file select both the audio and the picture stream
1447 with @code{map}:
1448 @example
1449 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1450 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1451 @end example
1452
1453 Write a "clean" MP3 without any extra features:
1454 @example
1455 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1456 @end example
1457
1458 @section mpegts
1459
1460 MPEG transport stream muxer.
1461
1462 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1463
1464 The recognized metadata settings in mpegts muxer are @code{service_provider}
1465 and @code{service_name}. If they are not set the default for
1466 @code{service_provider} is @samp{FFmpeg} and the default for
1467 @code{service_name} is @samp{Service01}.
1468
1469 @subsection Options
1470
1471 The muxer options are:
1472
1473 @table @option
1474 @item mpegts_transport_stream_id @var{integer}
1475 Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1476 Default is @code{0x0001}.
1477
1478 @item mpegts_original_network_id @var{integer}
1479 Set the @samp{original_network_id}. This is unique identifier of a
1480 network in DVB. Its main use is in the unique identification of a service
1481 through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1482 is @code{0x0001}.
1483
1484 @item mpegts_service_id @var{integer}
1485 Set the @samp{service_id}, also known as program in DVB. Default is
1486 @code{0x0001}.
1487
1488 @item mpegts_service_type @var{integer}
1489 Set the program @samp{service_type}. Default is @code{digital_tv}.
1490 Accepts the following options:
1491 @table @samp
1492 @item hex_value
1493 Any hexdecimal value between @code{0x01} to @code{0xff} as defined in
1494 ETSI 300 468.
1495 @item digital_tv
1496 Digital TV service.
1497 @item digital_radio
1498 Digital Radio service.
1499 @item teletext
1500 Teletext service.
1501 @item advanced_codec_digital_radio
1502 Advanced Codec Digital Radio service.
1503 @item mpeg2_digital_hdtv
1504 MPEG2 Digital HDTV service.
1505 @item advanced_codec_digital_sdtv
1506 Advanced Codec Digital SDTV service.
1507 @item advanced_codec_digital_hdtv
1508 Advanced Codec Digital HDTV service.
1509 @end table
1510
1511 @item mpegts_pmt_start_pid @var{integer}
1512 Set the first PID for PMT. Default is @code{0x1000}. Max is @code{0x1f00}.
1513
1514 @item mpegts_start_pid @var{integer}
1515 Set the first PID for data packets. Default is @code{0x0100}. Max is
1516 @code{0x0f00}.
1517
1518 @item mpegts_m2ts_mode @var{boolean}
1519 Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1520 disables m2ts mode.
1521
1522 @item muxrate @var{integer}
1523 Set a constant muxrate. Default is VBR.
1524
1525 @item pes_payload_size @var{integer}
1526 Set minimum PES packet payload in bytes. Default is @code{2930}.
1527
1528 @item mpegts_flags @var{flags}
1529 Set mpegts flags. Accepts the following options:
1530 @table @samp
1531 @item resend_headers
1532 Reemit PAT/PMT before writing the next packet.
1533 @item latm
1534 Use LATM packetization for AAC.
1535 @item pat_pmt_at_frames
1536 Reemit PAT and PMT at each video frame.
1537 @item system_b
1538 Conform to System B (DVB) instead of System A (ATSC).
1539 @item initial_discontinuity
1540 Mark the initial packet of each stream as discontinuity.
1541 @end table
1542
1543 @item resend_headers @var{integer}
1544 Reemit PAT/PMT before writing the next packet. This option is deprecated:
1545 use @option{mpegts_flags} instead.
1546
1547 @item mpegts_copyts @var{boolean}
1548 Preserve original timestamps, if value is set to @code{1}. Default value
1549 is @code{-1}, which results in shifting timestamps so that they start from 0.
1550
1551 @item omit_video_pes_length @var{boolean}
1552 Omit the PES packet length for video packets. Default is @code{1} (true).
1553
1554 @item pcr_period @var{integer}
1555 Override the default PCR retransmission time in milliseconds. Ignored if
1556 variable muxrate is selected. Default is @code{20}.
1557
1558 @item pat_period @var{double}
1559 Maximum time in seconds between PAT/PMT tables.
1560
1561 @item sdt_period @var{double}
1562 Maximum time in seconds between SDT tables.
1563
1564 @item tables_version @var{integer}
1565 Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1566 This option allows updating stream structure so that standard consumer may
1567 detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1568 usage) or restart @command{ffmpeg} instance, cyclically changing
1569 @option{tables_version} value:
1570
1571 @example
1572 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1573 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1574 ...
1575 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1576 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1577 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1578 ...
1579 @end example
1580 @end table
1581
1582 @subsection Example
1583
1584 @example
1585 ffmpeg -i file.mpg -c copy \
1586      -mpegts_original_network_id 0x1122 \
1587      -mpegts_transport_stream_id 0x3344 \
1588      -mpegts_service_id 0x5566 \
1589      -mpegts_pmt_start_pid 0x1500 \
1590      -mpegts_start_pid 0x150 \
1591      -metadata service_provider="Some provider" \
1592      -metadata service_name="Some Channel" \
1593      out.ts
1594 @end example
1595
1596 @section mxf, mxf_d10
1597
1598 MXF muxer.
1599
1600 @subsection Options
1601
1602 The muxer options are:
1603
1604 @table @option
1605 @item store_user_comments @var{bool}
1606 Set if user comments should be stored if available or never.
1607 IRT D-10 does not allow user comments. The default is thus to write them for
1608 mxf but not for mxf_d10
1609 @end table
1610
1611 @section null
1612
1613 Null muxer.
1614
1615 This muxer does not generate any output file, it is mainly useful for
1616 testing or benchmarking purposes.
1617
1618 For example to benchmark decoding with @command{ffmpeg} you can use the
1619 command:
1620 @example
1621 ffmpeg -benchmark -i INPUT -f null out.null
1622 @end example
1623
1624 Note that the above command does not read or write the @file{out.null}
1625 file, but specifying the output file is required by the @command{ffmpeg}
1626 syntax.
1627
1628 Alternatively you can write the command as:
1629 @example
1630 ffmpeg -benchmark -i INPUT -f null -
1631 @end example
1632
1633 @section nut
1634
1635 @table @option
1636 @item -syncpoints @var{flags}
1637 Change the syncpoint usage in nut:
1638 @table @option
1639 @item @var{default} use the normal low-overhead seeking aids.
1640 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1641     Use of this option is not recommended, as the resulting files are very damage
1642     sensitive and seeking is not possible. Also in general the overhead from
1643     syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1644     all growing data tables, allowing to mux endless streams with limited memory
1645     and without these disadvantages.
1646 @item @var{timestamped} extend the syncpoint with a wallclock field.
1647 @end table
1648 The @var{none} and @var{timestamped} flags are experimental.
1649 @item -write_index @var{bool}
1650 Write index at the end, the default is to write an index.
1651 @end table
1652
1653 @example
1654 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
1655 @end example
1656
1657 @section ogg
1658
1659 Ogg container muxer.
1660
1661 @table @option
1662 @item -page_duration @var{duration}
1663 Preferred page duration, in microseconds. The muxer will attempt to create
1664 pages that are approximately @var{duration} microseconds long. This allows the
1665 user to compromise between seek granularity and container overhead. The default
1666 is 1 second. A value of 0 will fill all segments, making pages as large as
1667 possible. A value of 1 will effectively use 1 packet-per-page in most
1668 situations, giving a small seek granularity at the cost of additional container
1669 overhead.
1670 @item -serial_offset @var{value}
1671 Serial value from which to set the streams serial number.
1672 Setting it to different and sufficiently large values ensures that the produced
1673 ogg files can be safely chained.
1674
1675 @end table
1676
1677 @anchor{segment}
1678 @section segment, stream_segment, ssegment
1679
1680 Basic stream segmenter.
1681
1682 This muxer outputs streams to a number of separate files of nearly
1683 fixed duration. Output filename pattern can be set in a fashion
1684 similar to @ref{image2}, or by using a @code{strftime} template if
1685 the @option{strftime} option is enabled.
1686
1687 @code{stream_segment} is a variant of the muxer used to write to
1688 streaming output formats, i.e. which do not require global headers,
1689 and is recommended for outputting e.g. to MPEG transport stream segments.
1690 @code{ssegment} is a shorter alias for @code{stream_segment}.
1691
1692 Every segment starts with a keyframe of the selected reference stream,
1693 which is set through the @option{reference_stream} option.
1694
1695 Note that if you want accurate splitting for a video file, you need to
1696 make the input key frames correspond to the exact splitting times
1697 expected by the segmenter, or the segment muxer will start the new
1698 segment with the key frame found next after the specified start
1699 time.
1700
1701 The segment muxer works best with a single constant frame rate video.
1702
1703 Optionally it can generate a list of the created segments, by setting
1704 the option @var{segment_list}. The list type is specified by the
1705 @var{segment_list_type} option. The entry filenames in the segment
1706 list are set by default to the basename of the corresponding segment
1707 files.
1708
1709 See also the @ref{hls} muxer, which provides a more specific
1710 implementation for HLS segmentation.
1711
1712 @subsection Options
1713
1714 The segment muxer supports the following options:
1715
1716 @table @option
1717 @item increment_tc @var{1|0}
1718 if set to @code{1}, increment timecode between each segment
1719 If this is selected, the input need to have
1720 a timecode in the first video stream. Default value is
1721 @code{0}.
1722
1723 @item reference_stream @var{specifier}
1724 Set the reference stream, as specified by the string @var{specifier}.
1725 If @var{specifier} is set to @code{auto}, the reference is chosen
1726 automatically. Otherwise it must be a stream specifier (see the ``Stream
1727 specifiers'' chapter in the ffmpeg manual) which specifies the
1728 reference stream. The default value is @code{auto}.
1729
1730 @item segment_format @var{format}
1731 Override the inner container format, by default it is guessed by the filename
1732 extension.
1733
1734 @item segment_format_options @var{options_list}
1735 Set output format options using a :-separated list of key=value
1736 parameters. Values containing the @code{:} special character must be
1737 escaped.
1738
1739 @item segment_list @var{name}
1740 Generate also a listfile named @var{name}. If not specified no
1741 listfile is generated.
1742
1743 @item segment_list_flags @var{flags}
1744 Set flags affecting the segment list generation.
1745
1746 It currently supports the following flags:
1747 @table @samp
1748 @item cache
1749 Allow caching (only affects M3U8 list files).
1750
1751 @item live
1752 Allow live-friendly file generation.
1753 @end table
1754
1755 @item segment_list_size @var{size}
1756 Update the list file so that it contains at most @var{size}
1757 segments. If 0 the list file will contain all the segments. Default
1758 value is 0.
1759
1760 @item segment_list_entry_prefix @var{prefix}
1761 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
1762 By default no prefix is applied.
1763
1764 @item segment_list_type @var{type}
1765 Select the listing format.
1766
1767 The following values are recognized:
1768 @table @samp
1769 @item flat
1770 Generate a flat list for the created segments, one segment per line.
1771
1772 @item csv, ext
1773 Generate a list for the created segments, one segment per line,
1774 each line matching the format (comma-separated values):
1775 @example
1776 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
1777 @end example
1778
1779 @var{segment_filename} is the name of the output file generated by the
1780 muxer according to the provided pattern. CSV escaping (according to
1781 RFC4180) is applied if required.
1782
1783 @var{segment_start_time} and @var{segment_end_time} specify
1784 the segment start and end time expressed in seconds.
1785
1786 A list file with the suffix @code{".csv"} or @code{".ext"} will
1787 auto-select this format.
1788
1789 @samp{ext} is deprecated in favor or @samp{csv}.
1790
1791 @item ffconcat
1792 Generate an ffconcat file for the created segments. The resulting file
1793 can be read using the FFmpeg @ref{concat} demuxer.
1794
1795 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
1796 auto-select this format.
1797
1798 @item m3u8
1799 Generate an extended M3U8 file, version 3, compliant with
1800 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
1801
1802 A list file with the suffix @code{".m3u8"} will auto-select this format.
1803 @end table
1804
1805 If not specified the type is guessed from the list file name suffix.
1806
1807 @item segment_time @var{time}
1808 Set segment duration to @var{time}, the value must be a duration
1809 specification. Default value is "2". See also the
1810 @option{segment_times} option.
1811
1812 Note that splitting may not be accurate, unless you force the
1813 reference stream key-frames at the given time. See the introductory
1814 notice and the examples below.
1815
1816 @item segment_atclocktime @var{1|0}
1817 If set to "1" split at regular clock time intervals starting from 00:00
1818 o'clock. The @var{time} value specified in @option{segment_time} is
1819 used for setting the length of the splitting interval.
1820
1821 For example with @option{segment_time} set to "900" this makes it possible
1822 to create files at 12:00 o'clock, 12:15, 12:30, etc.
1823
1824 Default value is "0".
1825
1826 @item segment_clocktime_offset @var{duration}
1827 Delay the segment splitting times with the specified duration when using
1828 @option{segment_atclocktime}.
1829
1830 For example with @option{segment_time} set to "900" and
1831 @option{segment_clocktime_offset} set to "300" this makes it possible to
1832 create files at 12:05, 12:20, 12:35, etc.
1833
1834 Default value is "0".
1835
1836 @item segment_clocktime_wrap_duration @var{duration}
1837 Force the segmenter to only start a new segment if a packet reaches the muxer
1838 within the specified duration after the segmenting clock time. This way you
1839 can make the segmenter more resilient to backward local time jumps, such as
1840 leap seconds or transition to standard time from daylight savings time.
1841
1842 Default is the maximum possible duration which means starting a new segment
1843 regardless of the elapsed time since the last clock time.
1844
1845 @item segment_time_delta @var{delta}
1846 Specify the accuracy time when selecting the start time for a
1847 segment, expressed as a duration specification. Default value is "0".
1848
1849 When delta is specified a key-frame will start a new segment if its
1850 PTS satisfies the relation:
1851 @example
1852 PTS >= start_time - time_delta
1853 @end example
1854
1855 This option is useful when splitting video content, which is always
1856 split at GOP boundaries, in case a key frame is found just before the
1857 specified split time.
1858
1859 In particular may be used in combination with the @file{ffmpeg} option
1860 @var{force_key_frames}. The key frame times specified by
1861 @var{force_key_frames} may not be set accurately because of rounding
1862 issues, with the consequence that a key frame time may result set just
1863 before the specified time. For constant frame rate videos a value of
1864 1/(2*@var{frame_rate}) should address the worst case mismatch between
1865 the specified time and the time set by @var{force_key_frames}.
1866
1867 @item segment_times @var{times}
1868 Specify a list of split points. @var{times} contains a list of comma
1869 separated duration specifications, in increasing order. See also
1870 the @option{segment_time} option.
1871
1872 @item segment_frames @var{frames}
1873 Specify a list of split video frame numbers. @var{frames} contains a
1874 list of comma separated integer numbers, in increasing order.
1875
1876 This option specifies to start a new segment whenever a reference
1877 stream key frame is found and the sequential number (starting from 0)
1878 of the frame is greater or equal to the next value in the list.
1879
1880 @item segment_wrap @var{limit}
1881 Wrap around segment index once it reaches @var{limit}.
1882
1883 @item segment_start_number @var{number}
1884 Set the sequence number of the first segment. Defaults to @code{0}.
1885
1886 @item strftime @var{1|0}
1887 Use the @code{strftime} function to define the name of the new
1888 segments to write. If this is selected, the output segment name must
1889 contain a @code{strftime} function template. Default value is
1890 @code{0}.
1891
1892 @item break_non_keyframes @var{1|0}
1893 If enabled, allow segments to start on frames other than keyframes. This
1894 improves behavior on some players when the time between keyframes is
1895 inconsistent, but may make things worse on others, and can cause some oddities
1896 during seeking. Defaults to @code{0}.
1897
1898 @item reset_timestamps @var{1|0}
1899 Reset timestamps at the beginning of each segment, so that each segment
1900 will start with near-zero timestamps. It is meant to ease the playback
1901 of the generated segments. May not work with some combinations of
1902 muxers/codecs. It is set to @code{0} by default.
1903
1904 @item initial_offset @var{offset}
1905 Specify timestamp offset to apply to the output packet timestamps. The
1906 argument must be a time duration specification, and defaults to 0.
1907
1908 @item write_empty_segments @var{1|0}
1909 If enabled, write an empty segment if there are no packets during the period a
1910 segment would usually span. Otherwise, the segment will be filled with the next
1911 packet written. Defaults to @code{0}.
1912 @end table
1913
1914 Make sure to require a closed GOP when encoding and to set the GOP
1915 size to fit your segment time constraint.
1916
1917 @subsection Examples
1918
1919 @itemize
1920 @item
1921 Remux the content of file @file{in.mkv} to a list of segments
1922 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
1923 generated segments to @file{out.list}:
1924 @example
1925 ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
1926 @end example
1927
1928 @item
1929 Segment input and set output format options for the output segments:
1930 @example
1931 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
1932 @end example
1933
1934 @item
1935 Segment the input file according to the split points specified by the
1936 @var{segment_times} option:
1937 @example
1938 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
1939 @end example
1940
1941 @item
1942 Use the @command{ffmpeg} @option{force_key_frames}
1943 option to force key frames in the input at the specified location, together
1944 with the segment option @option{segment_time_delta} to account for
1945 possible roundings operated when setting key frame times.
1946 @example
1947 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
1948 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
1949 @end example
1950 In order to force key frames on the input file, transcoding is
1951 required.
1952
1953 @item
1954 Segment the input file by splitting the input file according to the
1955 frame numbers sequence specified with the @option{segment_frames} option:
1956 @example
1957 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
1958 @end example
1959
1960 @item
1961 Convert the @file{in.mkv} to TS segments using the @code{libx264}
1962 and @code{aac} encoders:
1963 @example
1964 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
1965 @end example
1966
1967 @item
1968 Segment the input file, and create an M3U8 live playlist (can be used
1969 as live HLS source):
1970 @example
1971 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
1972 -segment_list_flags +live -segment_time 10 out%03d.mkv
1973 @end example
1974 @end itemize
1975
1976 @section smoothstreaming
1977
1978 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
1979
1980 @table @option
1981 @item window_size
1982 Specify the number of fragments kept in the manifest. Default 0 (keep all).
1983
1984 @item extra_window_size
1985 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
1986
1987 @item lookahead_count
1988 Specify the number of lookahead fragments. Default 2.
1989
1990 @item min_frag_duration
1991 Specify the minimum fragment duration (in microseconds). Default 5000000.
1992
1993 @item remove_at_exit
1994 Specify whether to remove all fragments when finished. Default 0 (do not remove).
1995
1996 @end table
1997
1998 @anchor{fifo}
1999 @section fifo
2000
2001 The fifo pseudo-muxer allows the separation of encoding and muxing by using
2002 first-in-first-out queue and running the actual muxer in a separate thread. This
2003 is especially useful in combination with the @ref{tee} muxer and can be used to
2004 send data to several destinations with different reliability/writing speed/latency.
2005
2006 API users should be aware that callback functions (interrupt_callback,
2007 io_open and io_close) used within its AVFormatContext must be thread-safe.
2008
2009 The behavior of the fifo muxer if the queue fills up or if the output fails is
2010 selectable,
2011
2012 @itemize @bullet
2013
2014 @item
2015 output can be transparently restarted with configurable delay between retries
2016 based on real time or time of the processed stream.
2017
2018 @item
2019 encoding can be blocked during temporary failure, or continue transparently
2020 dropping packets in case fifo queue fills up.
2021
2022 @end itemize
2023
2024 @table @option
2025
2026 @item fifo_format
2027 Specify the format name. Useful if it cannot be guessed from the
2028 output name suffix.
2029
2030 @item queue_size
2031 Specify size of the queue (number of packets). Default value is 60.
2032
2033 @item format_opts
2034 Specify format options for the underlying muxer. Muxer options can be specified
2035 as a list of @var{key}=@var{value} pairs separated by ':'.
2036
2037 @item drop_pkts_on_overflow @var{bool}
2038 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
2039 rather than blocking the encoder. This makes it possible to continue streaming without
2040 delaying the input, at the cost of omitting part of the stream. By default
2041 this option is set to 0 (false), so in such cases the encoder will be blocked
2042 until the muxer processes some of the packets and none of them is lost.
2043
2044 @item attempt_recovery @var{bool}
2045 If failure occurs, attempt to recover the output. This is especially useful
2046 when used with network output, since it makes it possible to restart streaming transparently.
2047 By default this option is set to 0 (false).
2048
2049 @item max_recovery_attempts
2050 Sets maximum number of successive unsuccessful recovery attempts after which
2051 the output fails permanently. By default this option is set to 0 (unlimited).
2052
2053 @item recovery_wait_time @var{duration}
2054 Waiting time before the next recovery attempt after previous unsuccessful
2055 recovery attempt. Default value is 5 seconds.
2056
2057 @item recovery_wait_streamtime @var{bool}
2058 If set to 0 (false), the real time is used when waiting for the recovery
2059 attempt (i.e. the recovery will be attempted after at least
2060 recovery_wait_time seconds).
2061 If set to 1 (true), the time of the processed stream is taken into account
2062 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
2063 seconds of the stream is omitted).
2064 By default, this option is set to 0 (false).
2065
2066 @item recover_any_error @var{bool}
2067 If set to 1 (true), recovery will be attempted regardless of type of the error
2068 causing the failure. By default this option is set to 0 (false) and in case of
2069 certain (usually permanent) errors the recovery is not attempted even when
2070 @var{attempt_recovery} is set to 1.
2071
2072 @item restart_with_keyframe @var{bool}
2073 Specify whether to wait for the keyframe after recovering from
2074 queue overflow or failure. This option is set to 0 (false) by default.
2075
2076 @end table
2077
2078 @subsection Examples
2079
2080 @itemize
2081
2082 @item
2083 Stream something to rtmp server, continue processing the stream at real-time
2084 rate even in case of temporary failure (network outage) and attempt to recover
2085 streaming every second indefinitely.
2086 @example
2087 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
2088   -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
2089 @end example
2090
2091 @end itemize
2092
2093 @anchor{tee}
2094 @section tee
2095
2096 The tee muxer can be used to write the same data to several outputs, such as files or streams.
2097 It can be used, for example, to stream a video over a network and save it to disk at the same time.
2098
2099 It is different from specifying several outputs to the @command{ffmpeg}
2100 command-line tool. With the tee muxer, the audio and video data will be encoded only once.
2101 With conventional multiple outputs, multiple encoding operations in parallel are initiated,
2102 which can be a very expensive process. The tee muxer is not useful when using the libavformat API
2103 directly because it is then possible to feed the same packets to several muxers directly.
2104
2105 Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select
2106 output streams. So all streams intended for output must be specified using @code{-map}. See
2107 the examples below.
2108
2109 Some encoders may need different options depending on the output format;
2110 the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified.
2111 The main example is the @option{global_header} flag.
2112
2113 The slave outputs are specified in the file name given to the muxer,
2114 separated by '|'. If any of the slave name contains the '|' separator,
2115 leading or trailing spaces or any special character, those must be
2116 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
2117 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
2118
2119 @subsection Options
2120
2121 @table @option
2122
2123 @item use_fifo @var{bool}
2124 If set to 1, slave outputs will be processed in separate threads using the @ref{fifo}
2125 muxer. This allows to compensate for different speed/latency/reliability of
2126 outputs and setup transparent recovery. By default this feature is turned off.
2127
2128 @item fifo_options
2129 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
2130
2131 @end table
2132
2133 Muxer options can be specified for each slave by prepending them as a list of
2134 @var{key}=@var{value} pairs separated by ':', between square brackets. If
2135 the options values contain a special character or the ':' separator, they
2136 must be escaped; note that this is a second level escaping.
2137
2138 The following special options are also recognized:
2139 @table @option
2140 @item f
2141 Specify the format name. Required if it cannot be guessed from the
2142 output URL.
2143
2144 @item bsfs[/@var{spec}]
2145 Specify a list of bitstream filters to apply to the specified
2146 output.
2147
2148 It is possible to specify to which streams a given bitstream filter
2149 applies, by appending a stream specifier to the option separated by
2150 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
2151 stream specifiers}).
2152
2153 If the stream specifier is not specified, the bitstream filters will be
2154 applied to all streams in the output. This will cause that output operation
2155 to fail if the output contains streams to which the bitstream filter cannot
2156 be applied e.g. @code{h264_mp4toannexb} being applied to an output containing an audio stream.
2157
2158 Options for a bitstream filter must be specified in the form of @code{opt=value}.
2159
2160 Several bitstream filters can be specified, separated by ",".
2161
2162 @item use_fifo @var{bool}
2163 This allows to override tee muxer use_fifo option for individual slave muxer.
2164
2165 @item fifo_options
2166 This allows to override tee muxer fifo_options for individual slave muxer.
2167 See @ref{fifo}.
2168
2169 @item select
2170 Select the streams that should be mapped to the slave output,
2171 specified by a stream specifier. If not specified, this defaults to
2172 all the mapped streams. This will cause that output operation to fail
2173 if the output format does not accept all mapped streams.
2174
2175 You may use multiple stream specifiers separated by commas (@code{,}) e.g.: @code{a:0,v}
2176
2177 @item onfail
2178 Specify behaviour on output failure. This can be set to either @code{abort} (which is
2179 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
2180 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
2181 will continue without being affected.
2182 @end table
2183
2184 @subsection Examples
2185
2186 @itemize
2187 @item
2188 Encode something and both archive it in a WebM file and stream it
2189 as MPEG-TS over UDP:
2190 @example
2191 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2192   "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2193 @end example
2194
2195 @item
2196 As above, but continue streaming even if output to local file fails
2197 (for example local drive fills up):
2198 @example
2199 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2200   "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2201 @end example
2202
2203 @item
2204 Use @command{ffmpeg} to encode the input, and send the output
2205 to three different destinations. The @code{dump_extra} bitstream
2206 filter is used to add extradata information to all the output video
2207 keyframes packets, as requested by the MPEG-TS format. The select
2208 option is applied to @file{out.aac} in order to make it contain only
2209 audio packets.
2210 @example
2211 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2212        -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
2213 @end example
2214
2215 @item
2216 As above, but select only stream @code{a:1} for the audio output. Note
2217 that a second level escaping must be performed, as ":" is a special
2218 character used to separate options.
2219 @example
2220 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2221        -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
2222 @end example
2223 @end itemize
2224
2225 @section webm_dash_manifest
2226
2227 WebM DASH Manifest muxer.
2228
2229 This muxer implements the WebM DASH Manifest specification to generate the DASH
2230 manifest XML. It also supports manifest generation for DASH live streams.
2231
2232 For more information see:
2233
2234 @itemize @bullet
2235 @item
2236 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
2237 @item
2238 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
2239 @end itemize
2240
2241 @subsection Options
2242
2243 This muxer supports the following options:
2244
2245 @table @option
2246 @item adaptation_sets
2247 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
2248 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
2249 audio and video streams. Any number of adaptation sets can be added using this option.
2250
2251 @item live
2252 Set this to 1 to create a live stream DASH Manifest. Default: 0.
2253
2254 @item chunk_start_index
2255 Start index of the first chunk. This will go in the @samp{startNumber} attribute
2256 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
2257
2258 @item chunk_duration_ms
2259 Duration of each chunk in milliseconds. This will go in the @samp{duration}
2260 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
2261
2262 @item utc_timing_url
2263 URL of the page that will return the UTC timestamp in ISO format. This will go
2264 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
2265 Default: None.
2266
2267 @item time_shift_buffer_depth
2268 Smallest time (in seconds) shifting buffer for which any Representation is
2269 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
2270 attribute of the @samp{MPD} element. Default: 60.
2271
2272 @item minimum_update_period
2273 Minimum update period (in seconds) of the manifest. This will go in the
2274 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
2275
2276 @end table
2277
2278 @subsection Example
2279 @example
2280 ffmpeg -f webm_dash_manifest -i video1.webm \
2281        -f webm_dash_manifest -i video2.webm \
2282        -f webm_dash_manifest -i audio1.webm \
2283        -f webm_dash_manifest -i audio2.webm \
2284        -map 0 -map 1 -map 2 -map 3 \
2285        -c copy \
2286        -f webm_dash_manifest \
2287        -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
2288        manifest.xml
2289 @end example
2290
2291 @section webm_chunk
2292
2293 WebM Live Chunk Muxer.
2294
2295 This muxer writes out WebM headers and chunks as separate files which can be
2296 consumed by clients that support WebM Live streams via DASH.
2297
2298 @subsection Options
2299
2300 This muxer supports the following options:
2301
2302 @table @option
2303 @item chunk_start_index
2304 Index of the first chunk (defaults to 0).
2305
2306 @item header
2307 Filename of the header where the initialization data will be written.
2308
2309 @item audio_chunk_duration
2310 Duration of each audio chunk in milliseconds (defaults to 5000).
2311 @end table
2312
2313 @subsection Example
2314 @example
2315 ffmpeg -f v4l2 -i /dev/video0 \
2316        -f alsa -i hw:0 \
2317        -map 0:0 \
2318        -c:v libvpx-vp9 \
2319        -s 640x360 -keyint_min 30 -g 30 \
2320        -f webm_chunk \
2321        -header webm_live_video_360.hdr \
2322        -chunk_start_index 1 \
2323        webm_live_video_360_%d.chk \
2324        -map 1:0 \
2325        -c:a libvorbis \
2326        -b:a 128k \
2327        -f webm_chunk \
2328        -header webm_live_audio_128.hdr \
2329        -chunk_start_index 1 \
2330        -audio_chunk_duration 1000 \
2331        webm_live_audio_128_%d.chk
2332 @end example
2333
2334 @c man end MUXERS