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