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