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