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