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