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