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