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