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