avformat/hlsenc: add hls_flag option to write segments to temporary file until complete
[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 @item temp_file
660 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
661 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
662 before they have been added to the m3u8 playlist.
663
664 @example
665 ffmpeg -i sample.mpeg \
666    -f hls -hls_time 3 -hls_list_size 5 \
667    -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
668    -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
669 @end example
670 This will produce segments like this:
671 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
672
673
674 @end table
675
676 @item hls_playlist_type event
677 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
678 @option{hls_list_size} to 0; the playlist can only be appended to.
679
680 @item hls_playlist_type vod
681 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
682 @option{hls_list_size} to 0; the playlist must not change.
683
684 @item method
685 Use the given HTTP method to create the hls files.
686 @example
687 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
688 @end example
689 This example will upload all the mpegts segment files to the HTTP
690 server using the HTTP PUT method, and update the m3u8 files every
691 @code{refresh} times using the same method.
692 Note that the HTTP server must support the given method for uploading
693 files.
694 @end table
695
696 @anchor{ico}
697 @section ico
698
699 ICO file muxer.
700
701 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
702
703 @itemize
704 @item
705 Size cannot exceed 256 pixels in any dimension
706
707 @item
708 Only BMP and PNG images can be stored
709
710 @item
711 If a BMP image is used, it must be one of the following pixel formats:
712 @example
713 BMP Bit Depth      FFmpeg Pixel Format
714 1bit               pal8
715 4bit               pal8
716 8bit               pal8
717 16bit              rgb555le
718 24bit              bgr24
719 32bit              bgra
720 @end example
721
722 @item
723 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
724
725 @item
726 If a PNG image is used, it must use the rgba pixel format
727 @end itemize
728
729 @anchor{image2}
730 @section image2
731
732 Image file muxer.
733
734 The image file muxer writes video frames to image files.
735
736 The output filenames are specified by a pattern, which can be used to
737 produce sequentially numbered series of files.
738 The pattern may contain the string "%d" or "%0@var{N}d", this string
739 specifies the position of the characters representing a numbering in
740 the filenames. If the form "%0@var{N}d" is used, the string
741 representing the number in each filename is 0-padded to @var{N}
742 digits. The literal character '%' can be specified in the pattern with
743 the string "%%".
744
745 If the pattern contains "%d" or "%0@var{N}d", the first filename of
746 the file list specified will contain the number 1, all the following
747 numbers will be sequential.
748
749 The pattern may contain a suffix which is used to automatically
750 determine the format of the image files to write.
751
752 For example the pattern "img-%03d.bmp" will specify a sequence of
753 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
754 @file{img-010.bmp}, etc.
755 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
756 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
757 etc.
758
759 @subsection Examples
760
761 The following example shows how to use @command{ffmpeg} for creating a
762 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
763 taking one image every second from the input video:
764 @example
765 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
766 @end example
767
768 Note that with @command{ffmpeg}, if the format is not specified with the
769 @code{-f} option and the output filename specifies an image file
770 format, the image2 muxer is automatically selected, so the previous
771 command can be written as:
772 @example
773 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
774 @end example
775
776 Note also that the pattern must not necessarily contain "%d" or
777 "%0@var{N}d", for example to create a single image file
778 @file{img.jpeg} from the start of the input video you can employ the command:
779 @example
780 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
781 @end example
782
783 The @option{strftime} option allows you to expand the filename with
784 date and time information. Check the documentation of
785 the @code{strftime()} function for the syntax.
786
787 For example to generate image files from the @code{strftime()}
788 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
789 can be used:
790 @example
791 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
792 @end example
793
794 @subsection Options
795
796 @table @option
797 @item start_number
798 Start the sequence from the specified number. Default value is 0.
799
800 @item update
801 If set to 1, the filename will always be interpreted as just a
802 filename, not a pattern, and the corresponding file will be continuously
803 overwritten with new images. Default value is 0.
804
805 @item strftime
806 If set to 1, expand the filename with date and time information from
807 @code{strftime()}. Default value is 0.
808 @end table
809
810 The image muxer supports the .Y.U.V image file format. This format is
811 special in that that each image frame consists of three files, for
812 each of the YUV420P components. To read or write this image file format,
813 specify the name of the '.Y' file. The muxer will automatically open the
814 '.U' and '.V' files as required.
815
816 @section matroska
817
818 Matroska container muxer.
819
820 This muxer implements the matroska and webm container specs.
821
822 @subsection Metadata
823
824 The recognized metadata settings in this muxer are:
825
826 @table @option
827 @item title
828 Set title name provided to a single track.
829
830 @item language
831 Specify the language of the track in the Matroska languages form.
832
833 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
834 639-2/B) form (like "fre" for French), or a language code mixed with a
835 country code for specialities in languages (like "fre-ca" for Canadian
836 French).
837
838 @item stereo_mode
839 Set stereo 3D video layout of two views in a single video track.
840
841 The following values are recognized:
842 @table @samp
843 @item mono
844 video is not stereo
845 @item left_right
846 Both views are arranged side by side, Left-eye view is on the left
847 @item bottom_top
848 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
849 @item top_bottom
850 Both views are arranged in top-bottom orientation, Left-eye view is on top
851 @item checkerboard_rl
852 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
853 @item checkerboard_lr
854 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
855 @item row_interleaved_rl
856 Each view is constituted by a row based interleaving, Right-eye view is first row
857 @item row_interleaved_lr
858 Each view is constituted by a row based interleaving, Left-eye view is first row
859 @item col_interleaved_rl
860 Both views are arranged in a column based interleaving manner, Right-eye view is first column
861 @item col_interleaved_lr
862 Both views are arranged in a column based interleaving manner, Left-eye view is first column
863 @item anaglyph_cyan_red
864 All frames are in anaglyph format viewable through red-cyan filters
865 @item right_left
866 Both views are arranged side by side, Right-eye view is on the left
867 @item anaglyph_green_magenta
868 All frames are in anaglyph format viewable through green-magenta filters
869 @item block_lr
870 Both eyes laced in one Block, Left-eye view is first
871 @item block_rl
872 Both eyes laced in one Block, Right-eye view is first
873 @end table
874 @end table
875
876 For example a 3D WebM clip can be created using the following command line:
877 @example
878 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
879 @end example
880
881 @subsection Options
882
883 This muxer supports the following options:
884
885 @table @option
886 @item reserve_index_space
887 By default, this muxer writes the index for seeking (called cues in Matroska
888 terms) at the end of the file, because it cannot know in advance how much space
889 to leave for the index at the beginning of the file. However for some use cases
890 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
891 index at the beginning of the file.
892
893 If this option is set to a non-zero value, the muxer will reserve a given amount
894 of space in the file header and then try to write the cues there when the muxing
895 finishes. If the available space does not suffice, muxing will fail. A safe size
896 for most use cases should be about 50kB per hour of video.
897
898 Note that cues are only written if the output is seekable and this option will
899 have no effect if it is not.
900 @end table
901
902 @anchor{md5}
903 @section md5
904
905 MD5 testing format.
906
907 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
908 defaults to using the MD5 hash function.
909
910 @subsection Examples
911
912 To compute the MD5 hash of the input converted to raw
913 audio and video, and store it in the file @file{out.md5}:
914 @example
915 ffmpeg -i INPUT -f md5 out.md5
916 @end example
917
918 You can print the MD5 to stdout with the command:
919 @example
920 ffmpeg -i INPUT -f md5 -
921 @end example
922
923 See also the @ref{hash} and @ref{framemd5} muxers.
924
925 @section mov, mp4, ismv
926
927 MOV/MP4/ISMV (Smooth Streaming) muxer.
928
929 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
930 file has all the metadata about all packets stored in one location
931 (written at the end of the file, it can be moved to the start for
932 better playback by adding @var{faststart} to the @var{movflags}, or
933 using the @command{qt-faststart} tool). A fragmented
934 file consists of a number of fragments, where packets and metadata
935 about these packets are stored together. Writing a fragmented
936 file has the advantage that the file is decodable even if the
937 writing is interrupted (while a normal MOV/MP4 is undecodable if
938 it is not properly finished), and it requires less memory when writing
939 very long files (since writing normal MOV/MP4 files stores info about
940 every single packet in memory until the file is closed). The downside
941 is that it is less compatible with other applications.
942
943 @subsection Options
944
945 Fragmentation is enabled by setting one of the AVOptions that define
946 how to cut the file into fragments:
947
948 @table @option
949 @item -moov_size @var{bytes}
950 Reserves space for the moov atom at the beginning of the file instead of placing the
951 moov atom at the end. If the space reserved is insufficient, muxing will fail.
952 @item -movflags frag_keyframe
953 Start a new fragment at each video keyframe.
954 @item -frag_duration @var{duration}
955 Create fragments that are @var{duration} microseconds long.
956 @item -frag_size @var{size}
957 Create fragments that contain up to @var{size} bytes of payload data.
958 @item -movflags frag_custom
959 Allow the caller to manually choose when to cut fragments, by
960 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
961 the packets written so far. (This is only useful with other
962 applications integrating libavformat, not from @command{ffmpeg}.)
963 @item -min_frag_duration @var{duration}
964 Don't create fragments that are shorter than @var{duration} microseconds long.
965 @end table
966
967 If more than one condition is specified, fragments are cut when
968 one of the specified conditions is fulfilled. The exception to this is
969 @code{-min_frag_duration}, which has to be fulfilled for any of the other
970 conditions to apply.
971
972 Additionally, the way the output file is written can be adjusted
973 through a few other options:
974
975 @table @option
976 @item -movflags empty_moov
977 Write an initial moov atom directly at the start of the file, without
978 describing any samples in it. Generally, an mdat/moov pair is written
979 at the start of the file, as a normal MOV/MP4 file, containing only
980 a short portion of the file. With this option set, there is no initial
981 mdat atom, and the moov atom only describes the tracks but has
982 a zero duration.
983
984 This option is implicitly set when writing ismv (Smooth Streaming) files.
985 @item -movflags separate_moof
986 Write a separate moof (movie fragment) atom for each track. Normally,
987 packets for all tracks are written in a moof atom (which is slightly
988 more efficient), but with this option set, the muxer writes one moof/mdat
989 pair for each track, making it easier to separate tracks.
990
991 This option is implicitly set when writing ismv (Smooth Streaming) files.
992 @item -movflags faststart
993 Run a second pass moving the index (moov atom) to the beginning of the file.
994 This operation can take a while, and will not work in various situations such
995 as fragmented output, thus it is not enabled by default.
996 @item -movflags rtphint
997 Add RTP hinting tracks to the output file.
998 @item -movflags disable_chpl
999 Disable Nero chapter markers (chpl atom).  Normally, both Nero chapters
1000 and a QuickTime chapter track are written to the file. With this option
1001 set, only the QuickTime chapter track will be written. Nero chapters can
1002 cause failures when the file is reprocessed with certain tagging programs, like
1003 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1004 @item -movflags omit_tfhd_offset
1005 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1006 tying fragments to absolute byte positions in the file/streams.
1007 @item -movflags default_base_moof
1008 Similarly to the omit_tfhd_offset, this flag avoids writing the
1009 absolute base_data_offset field in tfhd atoms, but does so by using
1010 the new default-base-is-moof flag instead. This flag is new from
1011 14496-12:2012. This may make the fragments easier to parse in certain
1012 circumstances (avoiding basing track fragment location calculations
1013 on the implicit end of the previous track fragment).
1014 @item -write_tmcd
1015 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1016 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1017 @end table
1018
1019 @subsection Example
1020
1021 Smooth Streaming content can be pushed in real time to a publishing
1022 point on IIS with this muxer. Example:
1023 @example
1024 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1025 @end example
1026
1027 @subsection Audible AAX
1028
1029 Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
1030 @example
1031 ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
1032 @end example
1033
1034 @section mp3
1035
1036 The MP3 muxer writes a raw MP3 stream with the following optional features:
1037 @itemize @bullet
1038 @item
1039 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1040 2.4 are supported, the @code{id3v2_version} private option controls which one is
1041 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1042 completely.
1043
1044 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1045 The pictures are supplied to the muxer in form of a video stream with a single
1046 packet. There can be any number of those streams, each will correspond to a
1047 single APIC frame.  The stream metadata tags @var{title} and @var{comment} map
1048 to APIC @var{description} and @var{picture type} respectively. See
1049 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1050
1051 Note that the APIC frames must be written at the beginning, so the muxer will
1052 buffer the audio frames until it gets all the pictures. It is therefore advised
1053 to provide the pictures as soon as possible to avoid excessive buffering.
1054
1055 @item
1056 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1057 default, but will be written only if the output is seekable. The
1058 @code{write_xing} private option can be used to disable it.  The frame contains
1059 various information that may be useful to the decoder, like the audio duration
1060 or encoder delay.
1061
1062 @item
1063 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1064 enabled with the @code{write_id3v1} private option, but as its capabilities are
1065 very limited, its usage is not recommended.
1066 @end itemize
1067
1068 Examples:
1069
1070 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1071 @example
1072 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1073 @end example
1074
1075 To attach a picture to an mp3 file select both the audio and the picture stream
1076 with @code{map}:
1077 @example
1078 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1079 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1080 @end example
1081
1082 Write a "clean" MP3 without any extra features:
1083 @example
1084 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1085 @end example
1086
1087 @section mpegts
1088
1089 MPEG transport stream muxer.
1090
1091 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1092
1093 The recognized metadata settings in mpegts muxer are @code{service_provider}
1094 and @code{service_name}. If they are not set the default for
1095 @code{service_provider} is "FFmpeg" and the default for
1096 @code{service_name} is "Service01".
1097
1098 @subsection Options
1099
1100 The muxer options are:
1101
1102 @table @option
1103 @item mpegts_original_network_id @var{number}
1104 Set the original_network_id (default 0x0001). This is unique identifier
1105 of a network in DVB. Its main use is in the unique identification of a
1106 service through the path Original_Network_ID, Transport_Stream_ID.
1107 @item mpegts_transport_stream_id @var{number}
1108 Set the transport_stream_id (default 0x0001). This identifies a
1109 transponder in DVB.
1110 @item mpegts_service_id @var{number}
1111 Set the service_id (default 0x0001) also known as program in DVB.
1112 @item mpegts_service_type @var{number}
1113 Set the program service_type (default @var{digital_tv}), see below
1114 a list of pre defined values.
1115 @item mpegts_pmt_start_pid @var{number}
1116 Set the first PID for PMT (default 0x1000, max 0x1f00).
1117 @item mpegts_start_pid @var{number}
1118 Set the first PID for data packets (default 0x0100, max 0x0f00).
1119 @item mpegts_m2ts_mode @var{number}
1120 Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
1121 @item muxrate @var{number}
1122 Set a constant muxrate (default VBR).
1123 @item pcr_period @var{numer}
1124 Override the default PCR retransmission time (default 20ms), ignored
1125 if variable muxrate is selected.
1126 @item pat_period @var{number}
1127 Maximal time in seconds between PAT/PMT tables.
1128 @item sdt_period @var{number}
1129 Maximal time in seconds between SDT tables.
1130 @item pes_payload_size @var{number}
1131 Set minimum PES packet payload in bytes.
1132 @item mpegts_flags @var{flags}
1133 Set flags (see below).
1134 @item mpegts_copyts @var{number}
1135 Preserve original timestamps, if value is set to 1. Default value is -1, which
1136 results in shifting timestamps so that they start from 0.
1137 @item tables_version @var{number}
1138 Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
1139 This option allows updating stream structure so that standard consumer may
1140 detect the change. To do so, reopen output AVFormatContext (in case of API
1141 usage) or restart ffmpeg instance, cyclically changing tables_version value:
1142 @example
1143 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1144 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1145 ...
1146 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1147 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1148 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1149 ...
1150 @end example
1151 @end table
1152
1153 Option @option{mpegts_service_type} accepts the following values:
1154
1155 @table @option
1156 @item hex_value
1157 Any hexdecimal value between 0x01 to 0xff as defined in ETSI 300 468.
1158 @item digital_tv
1159 Digital TV service.
1160 @item digital_radio
1161 Digital Radio service.
1162 @item teletext
1163 Teletext service.
1164 @item advanced_codec_digital_radio
1165 Advanced Codec Digital Radio service.
1166 @item mpeg2_digital_hdtv
1167 MPEG2 Digital HDTV service.
1168 @item advanced_codec_digital_sdtv
1169 Advanced Codec Digital SDTV service.
1170 @item advanced_codec_digital_hdtv
1171 Advanced Codec Digital HDTV service.
1172 @end table
1173
1174 Option @option{mpegts_flags} may take a set of such flags:
1175
1176 @table @option
1177 @item resend_headers
1178 Reemit PAT/PMT before writing the next packet.
1179 @item latm
1180 Use LATM packetization for AAC.
1181 @item pat_pmt_at_frames
1182 Reemit PAT and PMT at each video frame.
1183 @item system_b
1184 Conform to System B (DVB) instead of System A (ATSC).
1185 @item initial_discontinuity
1186 Mark the initial packet of each stream as discontinuity.
1187 @end table
1188
1189 @subsection Example
1190
1191 @example
1192 ffmpeg -i file.mpg -c copy \
1193      -mpegts_original_network_id 0x1122 \
1194      -mpegts_transport_stream_id 0x3344 \
1195      -mpegts_service_id 0x5566 \
1196      -mpegts_pmt_start_pid 0x1500 \
1197      -mpegts_start_pid 0x150 \
1198      -metadata service_provider="Some provider" \
1199      -metadata service_name="Some Channel" \
1200      -y out.ts
1201 @end example
1202
1203 @section mxf, mxf_d10
1204
1205 MXF muxer.
1206
1207 @subsection Options
1208
1209 The muxer options are:
1210
1211 @table @option
1212 @item store_user_comments @var{bool}
1213 Set if user comments should be stored if available or never.
1214 IRT D-10 does not allow user comments. The default is thus to write them for
1215 mxf but not for mxf_d10
1216 @end table
1217
1218 @section null
1219
1220 Null muxer.
1221
1222 This muxer does not generate any output file, it is mainly useful for
1223 testing or benchmarking purposes.
1224
1225 For example to benchmark decoding with @command{ffmpeg} you can use the
1226 command:
1227 @example
1228 ffmpeg -benchmark -i INPUT -f null out.null
1229 @end example
1230
1231 Note that the above command does not read or write the @file{out.null}
1232 file, but specifying the output file is required by the @command{ffmpeg}
1233 syntax.
1234
1235 Alternatively you can write the command as:
1236 @example
1237 ffmpeg -benchmark -i INPUT -f null -
1238 @end example
1239
1240 @section nut
1241
1242 @table @option
1243 @item -syncpoints @var{flags}
1244 Change the syncpoint usage in nut:
1245 @table @option
1246 @item @var{default} use the normal low-overhead seeking aids.
1247 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1248     Use of this option is not recommended, as the resulting files are very damage
1249     sensitive and seeking is not possible. Also in general the overhead from
1250     syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1251     all growing data tables, allowing to mux endless streams with limited memory
1252     and without these disadvantages.
1253 @item @var{timestamped} extend the syncpoint with a wallclock field.
1254 @end table
1255 The @var{none} and @var{timestamped} flags are experimental.
1256 @item -write_index @var{bool}
1257 Write index at the end, the default is to write an index.
1258 @end table
1259
1260 @example
1261 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
1262 @end example
1263
1264 @section ogg
1265
1266 Ogg container muxer.
1267
1268 @table @option
1269 @item -page_duration @var{duration}
1270 Preferred page duration, in microseconds. The muxer will attempt to create
1271 pages that are approximately @var{duration} microseconds long. This allows the
1272 user to compromise between seek granularity and container overhead. The default
1273 is 1 second. A value of 0 will fill all segments, making pages as large as
1274 possible. A value of 1 will effectively use 1 packet-per-page in most
1275 situations, giving a small seek granularity at the cost of additional container
1276 overhead.
1277 @item -serial_offset @var{value}
1278 Serial value from which to set the streams serial number.
1279 Setting it to different and sufficiently large values ensures that the produced
1280 ogg files can be safely chained.
1281
1282 @end table
1283
1284 @anchor{segment}
1285 @section segment, stream_segment, ssegment
1286
1287 Basic stream segmenter.
1288
1289 This muxer outputs streams to a number of separate files of nearly
1290 fixed duration. Output filename pattern can be set in a fashion
1291 similar to @ref{image2}, or by using a @code{strftime} template if
1292 the @option{strftime} option is enabled.
1293
1294 @code{stream_segment} is a variant of the muxer used to write to
1295 streaming output formats, i.e. which do not require global headers,
1296 and is recommended for outputting e.g. to MPEG transport stream segments.
1297 @code{ssegment} is a shorter alias for @code{stream_segment}.
1298
1299 Every segment starts with a keyframe of the selected reference stream,
1300 which is set through the @option{reference_stream} option.
1301
1302 Note that if you want accurate splitting for a video file, you need to
1303 make the input key frames correspond to the exact splitting times
1304 expected by the segmenter, or the segment muxer will start the new
1305 segment with the key frame found next after the specified start
1306 time.
1307
1308 The segment muxer works best with a single constant frame rate video.
1309
1310 Optionally it can generate a list of the created segments, by setting
1311 the option @var{segment_list}. The list type is specified by the
1312 @var{segment_list_type} option. The entry filenames in the segment
1313 list are set by default to the basename of the corresponding segment
1314 files.
1315
1316 See also the @ref{hls} muxer, which provides a more specific
1317 implementation for HLS segmentation.
1318
1319 @subsection Options
1320
1321 The segment muxer supports the following options:
1322
1323 @table @option
1324 @item increment_tc @var{1|0}
1325 if set to @code{1}, increment timecode between each segment
1326 If this is selected, the input need to have
1327 a timecode in the first video stream. Default value is
1328 @code{0}.
1329
1330 @item reference_stream @var{specifier}
1331 Set the reference stream, as specified by the string @var{specifier}.
1332 If @var{specifier} is set to @code{auto}, the reference is chosen
1333 automatically. Otherwise it must be a stream specifier (see the ``Stream
1334 specifiers'' chapter in the ffmpeg manual) which specifies the
1335 reference stream. The default value is @code{auto}.
1336
1337 @item segment_format @var{format}
1338 Override the inner container format, by default it is guessed by the filename
1339 extension.
1340
1341 @item segment_format_options @var{options_list}
1342 Set output format options using a :-separated list of key=value
1343 parameters. Values containing the @code{:} special character must be
1344 escaped.
1345
1346 @item segment_list @var{name}
1347 Generate also a listfile named @var{name}. If not specified no
1348 listfile is generated.
1349
1350 @item segment_list_flags @var{flags}
1351 Set flags affecting the segment list generation.
1352
1353 It currently supports the following flags:
1354 @table @samp
1355 @item cache
1356 Allow caching (only affects M3U8 list files).
1357
1358 @item live
1359 Allow live-friendly file generation.
1360 @end table
1361
1362 @item segment_list_size @var{size}
1363 Update the list file so that it contains at most @var{size}
1364 segments. If 0 the list file will contain all the segments. Default
1365 value is 0.
1366
1367 @item segment_list_entry_prefix @var{prefix}
1368 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
1369 By default no prefix is applied.
1370
1371 @item segment_list_type @var{type}
1372 Select the listing format.
1373
1374 The following values are recognized:
1375 @table @samp
1376 @item flat
1377 Generate a flat list for the created segments, one segment per line.
1378
1379 @item csv, ext
1380 Generate a list for the created segments, one segment per line,
1381 each line matching the format (comma-separated values):
1382 @example
1383 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
1384 @end example
1385
1386 @var{segment_filename} is the name of the output file generated by the
1387 muxer according to the provided pattern. CSV escaping (according to
1388 RFC4180) is applied if required.
1389
1390 @var{segment_start_time} and @var{segment_end_time} specify
1391 the segment start and end time expressed in seconds.
1392
1393 A list file with the suffix @code{".csv"} or @code{".ext"} will
1394 auto-select this format.
1395
1396 @samp{ext} is deprecated in favor or @samp{csv}.
1397
1398 @item ffconcat
1399 Generate an ffconcat file for the created segments. The resulting file
1400 can be read using the FFmpeg @ref{concat} demuxer.
1401
1402 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
1403 auto-select this format.
1404
1405 @item m3u8
1406 Generate an extended M3U8 file, version 3, compliant with
1407 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
1408
1409 A list file with the suffix @code{".m3u8"} will auto-select this format.
1410 @end table
1411
1412 If not specified the type is guessed from the list file name suffix.
1413
1414 @item segment_time @var{time}
1415 Set segment duration to @var{time}, the value must be a duration
1416 specification. Default value is "2". See also the
1417 @option{segment_times} option.
1418
1419 Note that splitting may not be accurate, unless you force the
1420 reference stream key-frames at the given time. See the introductory
1421 notice and the examples below.
1422
1423 @item segment_atclocktime @var{1|0}
1424 If set to "1" split at regular clock time intervals starting from 00:00
1425 o'clock. The @var{time} value specified in @option{segment_time} is
1426 used for setting the length of the splitting interval.
1427
1428 For example with @option{segment_time} set to "900" this makes it possible
1429 to create files at 12:00 o'clock, 12:15, 12:30, etc.
1430
1431 Default value is "0".
1432
1433 @item segment_clocktime_offset @var{duration}
1434 Delay the segment splitting times with the specified duration when using
1435 @option{segment_atclocktime}.
1436
1437 For example with @option{segment_time} set to "900" and
1438 @option{segment_clocktime_offset} set to "300" this makes it possible to
1439 create files at 12:05, 12:20, 12:35, etc.
1440
1441 Default value is "0".
1442
1443 @item segment_clocktime_wrap_duration @var{duration}
1444 Force the segmenter to only start a new segment if a packet reaches the muxer
1445 within the specified duration after the segmenting clock time. This way you
1446 can make the segmenter more resilient to backward local time jumps, such as
1447 leap seconds or transition to standard time from daylight savings time.
1448
1449 Default is the maximum possible duration which means starting a new segment
1450 regardless of the elapsed time since the last clock time.
1451
1452 @item segment_time_delta @var{delta}
1453 Specify the accuracy time when selecting the start time for a
1454 segment, expressed as a duration specification. Default value is "0".
1455
1456 When delta is specified a key-frame will start a new segment if its
1457 PTS satisfies the relation:
1458 @example
1459 PTS >= start_time - time_delta
1460 @end example
1461
1462 This option is useful when splitting video content, which is always
1463 split at GOP boundaries, in case a key frame is found just before the
1464 specified split time.
1465
1466 In particular may be used in combination with the @file{ffmpeg} option
1467 @var{force_key_frames}. The key frame times specified by
1468 @var{force_key_frames} may not be set accurately because of rounding
1469 issues, with the consequence that a key frame time may result set just
1470 before the specified time. For constant frame rate videos a value of
1471 1/(2*@var{frame_rate}) should address the worst case mismatch between
1472 the specified time and the time set by @var{force_key_frames}.
1473
1474 @item segment_times @var{times}
1475 Specify a list of split points. @var{times} contains a list of comma
1476 separated duration specifications, in increasing order. See also
1477 the @option{segment_time} option.
1478
1479 @item segment_frames @var{frames}
1480 Specify a list of split video frame numbers. @var{frames} contains a
1481 list of comma separated integer numbers, in increasing order.
1482
1483 This option specifies to start a new segment whenever a reference
1484 stream key frame is found and the sequential number (starting from 0)
1485 of the frame is greater or equal to the next value in the list.
1486
1487 @item segment_wrap @var{limit}
1488 Wrap around segment index once it reaches @var{limit}.
1489
1490 @item segment_start_number @var{number}
1491 Set the sequence number of the first segment. Defaults to @code{0}.
1492
1493 @item strftime @var{1|0}
1494 Use the @code{strftime} function to define the name of the new
1495 segments to write. If this is selected, the output segment name must
1496 contain a @code{strftime} function template. Default value is
1497 @code{0}.
1498
1499 @item break_non_keyframes @var{1|0}
1500 If enabled, allow segments to start on frames other than keyframes. This
1501 improves behavior on some players when the time between keyframes is
1502 inconsistent, but may make things worse on others, and can cause some oddities
1503 during seeking. Defaults to @code{0}.
1504
1505 @item reset_timestamps @var{1|0}
1506 Reset timestamps at the begin of each segment, so that each segment
1507 will start with near-zero timestamps. It is meant to ease the playback
1508 of the generated segments. May not work with some combinations of
1509 muxers/codecs. It is set to @code{0} by default.
1510
1511 @item initial_offset @var{offset}
1512 Specify timestamp offset to apply to the output packet timestamps. The
1513 argument must be a time duration specification, and defaults to 0.
1514
1515 @item write_empty_segments @var{1|0}
1516 If enabled, write an empty segment if there are no packets during the period a
1517 segment would usually span. Otherwise, the segment will be filled with the next
1518 packet written. Defaults to @code{0}.
1519 @end table
1520
1521 @subsection Examples
1522
1523 @itemize
1524 @item
1525 Remux the content of file @file{in.mkv} to a list of segments
1526 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
1527 generated segments to @file{out.list}:
1528 @example
1529 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
1530 @end example
1531
1532 @item
1533 Segment input and set output format options for the output segments:
1534 @example
1535 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
1536 @end example
1537
1538 @item
1539 Segment the input file according to the split points specified by the
1540 @var{segment_times} option:
1541 @example
1542 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
1543 @end example
1544
1545 @item
1546 Use the @command{ffmpeg} @option{force_key_frames}
1547 option to force key frames in the input at the specified location, together
1548 with the segment option @option{segment_time_delta} to account for
1549 possible roundings operated when setting key frame times.
1550 @example
1551 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
1552 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
1553 @end example
1554 In order to force key frames on the input file, transcoding is
1555 required.
1556
1557 @item
1558 Segment the input file by splitting the input file according to the
1559 frame numbers sequence specified with the @option{segment_frames} option:
1560 @example
1561 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
1562 @end example
1563
1564 @item
1565 Convert the @file{in.mkv} to TS segments using the @code{libx264}
1566 and @code{aac} encoders:
1567 @example
1568 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
1569 @end example
1570
1571 @item
1572 Segment the input file, and create an M3U8 live playlist (can be used
1573 as live HLS source):
1574 @example
1575 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
1576 -segment_list_flags +live -segment_time 10 out%03d.mkv
1577 @end example
1578 @end itemize
1579
1580 @section smoothstreaming
1581
1582 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
1583
1584 @table @option
1585 @item window_size
1586 Specify the number of fragments kept in the manifest. Default 0 (keep all).
1587
1588 @item extra_window_size
1589 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
1590
1591 @item lookahead_count
1592 Specify the number of lookahead fragments. Default 2.
1593
1594 @item min_frag_duration
1595 Specify the minimum fragment duration (in microseconds). Default 5000000.
1596
1597 @item remove_at_exit
1598 Specify whether to remove all fragments when finished. Default 0 (do not remove).
1599
1600 @end table
1601
1602 @anchor{fifo}
1603 @section fifo
1604
1605 The fifo pseudo-muxer allows the separation of encoding and muxing by using
1606 first-in-first-out queue and running the actual muxer in a separate thread. This
1607 is especially useful in combination with the @ref{tee} muxer and can be used to
1608 send data to several destinations with different reliability/writing speed/latency.
1609
1610 API users should be aware that callback functions (interrupt_callback,
1611 io_open and io_close) used within its AVFormatContext must be thread-safe.
1612
1613 The behavior of the fifo muxer if the queue fills up or if the output fails is
1614 selectable,
1615
1616 @itemize @bullet
1617
1618 @item
1619 output can be transparently restarted with configurable delay between retries
1620 based on real time or time of the processed stream.
1621
1622 @item
1623 encoding can be blocked during temporary failure, or continue transparently
1624 dropping packets in case fifo queue fills up.
1625
1626 @end itemize
1627
1628 @table @option
1629
1630 @item fifo_format
1631 Specify the format name. Useful if it cannot be guessed from the
1632 output name suffix.
1633
1634 @item queue_size
1635 Specify size of the queue (number of packets). Default value is 60.
1636
1637 @item format_opts
1638 Specify format options for the underlying muxer. Muxer options can be specified
1639 as a list of @var{key}=@var{value} pairs separated by ':'.
1640
1641 @item drop_pkts_on_overflow @var{bool}
1642 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
1643 rather than blocking the encoder. This makes it possible to continue streaming without
1644 delaying the input, at the cost of omitting part of the stream. By default
1645 this option is set to 0 (false), so in such cases the encoder will be blocked
1646 until the muxer processes some of the packets and none of them is lost.
1647
1648 @item attempt_recovery @var{bool}
1649 If failure occurs, attempt to recover the output. This is especially useful
1650 when used with network output, since it makes it possible to restart streaming transparently.
1651 By default this option is set to 0 (false).
1652
1653 @item max_recovery_attempts
1654 Sets maximum number of successive unsuccessful recovery attempts after which
1655 the output fails permanently. By default this option is set to 0 (unlimited).
1656
1657 @item recovery_wait_time @var{duration}
1658 Waiting time before the next recovery attempt after previous unsuccessful
1659 recovery attempt. Default value is 5 seconds.
1660
1661 @item recovery_wait_streamtime @var{bool}
1662 If set to 0 (false), the real time is used when waiting for the recovery
1663 attempt (i.e. the recovery will be attempted after at least
1664 recovery_wait_time seconds).
1665 If set to 1 (true), the time of the processed stream is taken into account
1666 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
1667 seconds of the stream is omitted).
1668 By default, this option is set to 0 (false).
1669
1670 @item recover_any_error @var{bool}
1671 If set to 1 (true), recovery will be attempted regardless of type of the error
1672 causing the failure. By default this option is set to 0 (false) and in case of
1673 certain (usually permanent) errors the recovery is not attempted even when
1674 @var{attempt_recovery} is set to 1.
1675
1676 @item restart_with_keyframe @var{bool}
1677 Specify whether to wait for the keyframe after recovering from
1678 queue overflow or failure. This option is set to 0 (false) by default.
1679
1680 @end table
1681
1682 @subsection Examples
1683
1684 @itemize
1685
1686 @item
1687 Stream something to rtmp server, continue processing the stream at real-time
1688 rate even in case of temporary failure (network outage) and attempt to recover
1689 streaming every second indefinitely.
1690 @example
1691 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
1692   -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
1693 @end example
1694
1695 @end itemize
1696
1697 @anchor{tee}
1698 @section tee
1699
1700 The tee muxer can be used to write the same data to several files or any
1701 other kind of muxer. It can be used, for example, to both stream a video to
1702 the network and save it to disk at the same time.
1703
1704 It is different from specifying several outputs to the @command{ffmpeg}
1705 command-line tool because the audio and video data will be encoded only once
1706 with the tee muxer; encoding can be a very expensive process. It is not
1707 useful when using the libavformat API directly because it is then possible
1708 to feed the same packets to several muxers directly.
1709
1710 @table @option
1711
1712 @item use_fifo @var{bool}
1713 If set to 1, slave outputs will be processed in separate thread using @ref{fifo}
1714 muxer. This allows to compensate for different speed/latency/reliability of
1715 outputs and setup transparent recovery. By default this feature is turned off.
1716
1717 @item fifo_options
1718 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
1719
1720 @end table
1721
1722 The slave outputs are specified in the file name given to the muxer,
1723 separated by '|'. If any of the slave name contains the '|' separator,
1724 leading or trailing spaces or any special character, it must be
1725 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
1726 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
1727
1728 Muxer options can be specified for each slave by prepending them as a list of
1729 @var{key}=@var{value} pairs separated by ':', between square brackets. If
1730 the options values contain a special character or the ':' separator, they
1731 must be escaped; note that this is a second level escaping.
1732
1733 The following special options are also recognized:
1734 @table @option
1735 @item f
1736 Specify the format name. Useful if it cannot be guessed from the
1737 output name suffix.
1738
1739 @item bsfs[/@var{spec}]
1740 Specify a list of bitstream filters to apply to the specified
1741 output.
1742
1743 @item use_fifo @var{bool}
1744 This allows to override tee muxer use_fifo option for individual slave muxer.
1745
1746 @item fifo_options
1747 This allows to override tee muxer fifo_options for individual slave muxer.
1748 See @ref{fifo}.
1749
1750 It is possible to specify to which streams a given bitstream filter
1751 applies, by appending a stream specifier to the option separated by
1752 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
1753 stream specifiers}).  If the stream specifier is not specified, the
1754 bitstream filters will be applied to all streams in the output.
1755
1756 Several bitstream filters can be specified, separated by ",".
1757
1758 @item select
1759 Select the streams that should be mapped to the slave output,
1760 specified by a stream specifier. If not specified, this defaults to
1761 all the input streams. You may use multiple stream specifiers
1762 separated by commas (@code{,}) e.g.: @code{a:0,v}
1763
1764 @item onfail
1765 Specify behaviour on output failure. This can be set to either @code{abort} (which is
1766 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
1767 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
1768 will continue without being affected.
1769 @end table
1770
1771 @subsection Examples
1772
1773 @itemize
1774 @item
1775 Encode something and both archive it in a WebM file and stream it
1776 as MPEG-TS over UDP (the streams need to be explicitly mapped):
1777 @example
1778 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1779   "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1780 @end example
1781
1782 @item
1783 As above, but continue streaming even if output to local file fails
1784 (for example local drive fills up):
1785 @example
1786 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1787   "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1788 @end example
1789
1790 @item
1791 Use @command{ffmpeg} to encode the input, and send the output
1792 to three different destinations. The @code{dump_extra} bitstream
1793 filter is used to add extradata information to all the output video
1794 keyframes packets, as requested by the MPEG-TS format. The select
1795 option is applied to @file{out.aac} in order to make it contain only
1796 audio packets.
1797 @example
1798 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
1799        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
1800 @end example
1801
1802 @item
1803 As below, but select only stream @code{a:1} for the audio output. Note
1804 that a second level escaping must be performed, as ":" is a special
1805 character used to separate options.
1806 @example
1807 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
1808        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
1809 @end example
1810 @end itemize
1811
1812 Note: some codecs may need different options depending on the output format;
1813 the auto-detection of this can not work with the tee muxer. The main example
1814 is the @option{global_header} flag.
1815
1816 @section webm_dash_manifest
1817
1818 WebM DASH Manifest muxer.
1819
1820 This muxer implements the WebM DASH Manifest specification to generate the DASH
1821 manifest XML. It also supports manifest generation for DASH live streams.
1822
1823 For more information see:
1824
1825 @itemize @bullet
1826 @item
1827 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
1828 @item
1829 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
1830 @end itemize
1831
1832 @subsection Options
1833
1834 This muxer supports the following options:
1835
1836 @table @option
1837 @item adaptation_sets
1838 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
1839 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
1840 audio and video streams. Any number of adaptation sets can be added using this option.
1841
1842 @item live
1843 Set this to 1 to create a live stream DASH Manifest. Default: 0.
1844
1845 @item chunk_start_index
1846 Start index of the first chunk. This will go in the @samp{startNumber} attribute
1847 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
1848
1849 @item chunk_duration_ms
1850 Duration of each chunk in milliseconds. This will go in the @samp{duration}
1851 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
1852
1853 @item utc_timing_url
1854 URL of the page that will return the UTC timestamp in ISO format. This will go
1855 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
1856 Default: None.
1857
1858 @item time_shift_buffer_depth
1859 Smallest time (in seconds) shifting buffer for which any Representation is
1860 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
1861 attribute of the @samp{MPD} element. Default: 60.
1862
1863 @item minimum_update_period
1864 Minimum update period (in seconds) of the manifest. This will go in the
1865 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
1866
1867 @end table
1868
1869 @subsection Example
1870 @example
1871 ffmpeg -f webm_dash_manifest -i video1.webm \
1872        -f webm_dash_manifest -i video2.webm \
1873        -f webm_dash_manifest -i audio1.webm \
1874        -f webm_dash_manifest -i audio2.webm \
1875        -map 0 -map 1 -map 2 -map 3 \
1876        -c copy \
1877        -f webm_dash_manifest \
1878        -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
1879        manifest.xml
1880 @end example
1881
1882 @section webm_chunk
1883
1884 WebM Live Chunk Muxer.
1885
1886 This muxer writes out WebM headers and chunks as separate files which can be
1887 consumed by clients that support WebM Live streams via DASH.
1888
1889 @subsection Options
1890
1891 This muxer supports the following options:
1892
1893 @table @option
1894 @item chunk_start_index
1895 Index of the first chunk (defaults to 0).
1896
1897 @item header
1898 Filename of the header where the initialization data will be written.
1899
1900 @item audio_chunk_duration
1901 Duration of each audio chunk in milliseconds (defaults to 5000).
1902 @end table
1903
1904 @subsection Example
1905 @example
1906 ffmpeg -f v4l2 -i /dev/video0 \
1907        -f alsa -i hw:0 \
1908        -map 0:0 \
1909        -c:v libvpx-vp9 \
1910        -s 640x360 -keyint_min 30 -g 30 \
1911        -f webm_chunk \
1912        -header webm_live_video_360.hdr \
1913        -chunk_start_index 1 \
1914        webm_live_video_360_%d.chk \
1915        -map 1:0 \
1916        -c:a libvorbis \
1917        -b:a 128k \
1918        -f webm_chunk \
1919        -header webm_live_audio_128.hdr \
1920        -chunk_start_index 1 \
1921        -audio_chunk_duration 1000 \
1922        webm_live_audio_128_%d.chk
1923 @end example
1924
1925 @c man end MUXERS