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