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