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