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