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