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