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