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