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