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