Merge remote-tracking branch 'lukaszmluki/master'
[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 numbered segment files. The output
198 filename specifies the playlist filename; the segment filenames
199 receive the same basename as the playlist, a sequential number and
200 a .ts extension.
201
202 For example, to convert an input file with @command{ffmpeg}:
203 @example
204 ffmpeg -i in.nut out.m3u8
205 @end example
206
207 See also the @ref{segment} muxer, which provides a more generic and
208 flexible implementation of a segmenter, and can be used to perform HLS
209 segmentation.
210
211 @subsection Options
212
213 This muxer supports the following options:
214
215 @table @option
216 @item hls_time @var{seconds}
217 Set the segment length in seconds. Default value is 2.
218
219 @item hls_list_size @var{size}
220 Set the maximum number of playlist entries. If set to 0 the list file
221 will contain all the segments. Default value is 5.
222
223 @item hls_wrap @var{wrap}
224 Set the number after which the segment filename number (the number
225 specified in each segment file) wraps. If set to 0 the number will be
226 never wrapped. Default value is 0.
227
228 This option is useful to avoid to fill the disk with many segment
229 files, and limits the maximum number of segment files written to disk
230 to @var{wrap}.
231
232 @item start_number @var{number}
233 Start the playlist sequence number from @var{number}. Default value is
234 0.
235
236 Note that the playlist sequence number must be unique for each segment
237 and it is not to be confused with the segment filename sequence number
238 which can be cyclic, for example if the @option{wrap} option is
239 specified.
240 @end table
241
242 @anchor{ico}
243 @section ico
244
245 ICO file muxer.
246
247 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
248
249 @itemize
250 @item
251 Size cannot exceed 256 pixels in any dimension
252
253 @item
254 Only BMP and PNG images can be stored
255
256 @item
257 If a BMP image is used, it must be one of the following pixel formats:
258 @example
259 BMP Bit Depth      FFmpeg Pixel Format
260 1bit               pal8
261 4bit               pal8
262 8bit               pal8
263 16bit              rgb555le
264 24bit              bgr24
265 32bit              bgra
266 @end example
267
268 @item
269 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
270
271 @item
272 If a PNG image is used, it must use the rgba pixel format
273 @end itemize
274
275 @anchor{image2}
276 @section image2
277
278 Image file muxer.
279
280 The image file muxer writes video frames to image files.
281
282 The output filenames are specified by a pattern, which can be used to
283 produce sequentially numbered series of files.
284 The pattern may contain the string "%d" or "%0@var{N}d", this string
285 specifies the position of the characters representing a numbering in
286 the filenames. If the form "%0@var{N}d" is used, the string
287 representing the number in each filename is 0-padded to @var{N}
288 digits. The literal character '%' can be specified in the pattern with
289 the string "%%".
290
291 If the pattern contains "%d" or "%0@var{N}d", the first filename of
292 the file list specified will contain the number 1, all the following
293 numbers will be sequential.
294
295 The pattern may contain a suffix which is used to automatically
296 determine the format of the image files to write.
297
298 For example the pattern "img-%03d.bmp" will specify a sequence of
299 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
300 @file{img-010.bmp}, etc.
301 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
302 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
303 etc.
304
305 @subsection Examples
306
307 The following example shows how to use @command{ffmpeg} for creating a
308 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
309 taking one image every second from the input video:
310 @example
311 ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
312 @end example
313
314 Note that with @command{ffmpeg}, if the format is not specified with the
315 @code{-f} option and the output filename specifies an image file
316 format, the image2 muxer is automatically selected, so the previous
317 command can be written as:
318 @example
319 ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
320 @end example
321
322 Note also that the pattern must not necessarily contain "%d" or
323 "%0@var{N}d", for example to create a single image file
324 @file{img.jpeg} from the input video you can employ the command:
325 @example
326 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
327 @end example
328
329 The @option{strftime} option allows you to expand the filename with
330 date and time information. Check the documentation of
331 the @code{strftime()} function for the syntax.
332
333 For example to generate image files from the @code{strftime()}
334 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
335 can be used:
336 @example
337 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
338 @end example
339
340 @subsection Options
341
342 @table @option
343 @item start_number
344 Start the sequence from the specified number. Default value is 1. Must
345 be a non-negative number.
346
347 @item update
348 If set to 1, the filename will always be interpreted as just a
349 filename, not a pattern, and the corresponding file will be continuously
350 overwritten with new images. Default value is 0.
351
352 @item strftime
353 If set to 1, expand the filename with date and time information from
354 @code{strftime()}. Default value is 0.
355 @end table
356
357 The image muxer supports the .Y.U.V image file format. This format is
358 special in that that each image frame consists of three files, for
359 each of the YUV420P components. To read or write this image file format,
360 specify the name of the '.Y' file. The muxer will automatically open the
361 '.U' and '.V' files as required.
362
363 @section matroska
364
365 Matroska container muxer.
366
367 This muxer implements the matroska and webm container specs.
368
369 @subsection Metadata
370
371 The recognized metadata settings in this muxer are:
372
373 @table @option
374 @item title
375 Set title name provided to a single track.
376
377 @item language
378 Specify the language of the track in the Matroska languages form.
379
380 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
381 639-2/B) form (like "fre" for French), or a language code mixed with a
382 country code for specialities in languages (like "fre-ca" for Canadian
383 French).
384
385 @item stereo_mode
386 Set stereo 3D video layout of two views in a single video track.
387
388 The following values are recognized:
389 @table @samp
390 @item mono
391 video is not stereo
392 @item left_right
393 Both views are arranged side by side, Left-eye view is on the left
394 @item bottom_top
395 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
396 @item top_bottom
397 Both views are arranged in top-bottom orientation, Left-eye view is on top
398 @item checkerboard_rl
399 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
400 @item checkerboard_lr
401 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
402 @item row_interleaved_rl
403 Each view is constituted by a row based interleaving, Right-eye view is first row
404 @item row_interleaved_lr
405 Each view is constituted by a row based interleaving, Left-eye view is first row
406 @item col_interleaved_rl
407 Both views are arranged in a column based interleaving manner, Right-eye view is first column
408 @item col_interleaved_lr
409 Both views are arranged in a column based interleaving manner, Left-eye view is first column
410 @item anaglyph_cyan_red
411 All frames are in anaglyph format viewable through red-cyan filters
412 @item right_left
413 Both views are arranged side by side, Right-eye view is on the left
414 @item anaglyph_green_magenta
415 All frames are in anaglyph format viewable through green-magenta filters
416 @item block_lr
417 Both eyes laced in one Block, Left-eye view is first
418 @item block_rl
419 Both eyes laced in one Block, Right-eye view is first
420 @end table
421 @end table
422
423 For example a 3D WebM clip can be created using the following command line:
424 @example
425 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
426 @end example
427
428 @subsection Options
429
430 This muxer supports the following options:
431
432 @table @option
433 @item reserve_index_space
434 By default, this muxer writes the index for seeking (called cues in Matroska
435 terms) at the end of the file, because it cannot know in advance how much space
436 to leave for the index at the beginning of the file. However for some use cases
437 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
438 index at the beginning of the file.
439
440 If this option is set to a non-zero value, the muxer will reserve a given amount
441 of space in the file header and then try to write the cues there when the muxing
442 finishes. If the available space does not suffice, muxing will fail. A safe size
443 for most use cases should be about 50kB per hour of video.
444
445 Note that cues are only written if the output is seekable and this option will
446 have no effect if it is not.
447 @end table
448
449 @anchor{md5}
450 @section md5
451
452 MD5 testing format.
453
454 This muxer computes and prints the MD5 hash of all the input audio
455 and video frames. By default audio frames are converted to signed
456 16-bit raw audio and video frames to raw video before computing the
457 hash.
458
459 The output of the muxer consists of a single line of the form:
460 MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
461 the computed MD5 hash.
462
463 For example to compute the MD5 hash of the input converted to raw
464 audio and video, and store it in the file @file{out.md5}:
465 @example
466 ffmpeg -i INPUT -f md5 out.md5
467 @end example
468
469 You can print the MD5 to stdout with the command:
470 @example
471 ffmpeg -i INPUT -f md5 -
472 @end example
473
474 See also the @ref{framemd5} muxer.
475
476 @section mov, mp4, ismv
477
478 MOV/MP4/ISMV (Smooth Streaming) muxer.
479
480 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
481 file has all the metadata about all packets stored in one location
482 (written at the end of the file, it can be moved to the start for
483 better playback by adding @var{faststart} to the @var{movflags}, or
484 using the @command{qt-faststart} tool). A fragmented
485 file consists of a number of fragments, where packets and metadata
486 about these packets are stored together. Writing a fragmented
487 file has the advantage that the file is decodable even if the
488 writing is interrupted (while a normal MOV/MP4 is undecodable if
489 it is not properly finished), and it requires less memory when writing
490 very long files (since writing normal MOV/MP4 files stores info about
491 every single packet in memory until the file is closed). The downside
492 is that it is less compatible with other applications.
493
494 @subsection Options
495
496 Fragmentation is enabled by setting one of the AVOptions that define
497 how to cut the file into fragments:
498
499 @table @option
500 @item -moov_size @var{bytes}
501 Reserves space for the moov atom at the beginning of the file instead of placing the
502 moov atom at the end. If the space reserved is insufficient, muxing will fail.
503 @item -movflags frag_keyframe
504 Start a new fragment at each video keyframe.
505 @item -frag_duration @var{duration}
506 Create fragments that are @var{duration} microseconds long.
507 @item -frag_size @var{size}
508 Create fragments that contain up to @var{size} bytes of payload data.
509 @item -movflags frag_custom
510 Allow the caller to manually choose when to cut fragments, by
511 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
512 the packets written so far. (This is only useful with other
513 applications integrating libavformat, not from @command{ffmpeg}.)
514 @item -min_frag_duration @var{duration}
515 Don't create fragments that are shorter than @var{duration} microseconds long.
516 @end table
517
518 If more than one condition is specified, fragments are cut when
519 one of the specified conditions is fulfilled. The exception to this is
520 @code{-min_frag_duration}, which has to be fulfilled for any of the other
521 conditions to apply.
522
523 Additionally, the way the output file is written can be adjusted
524 through a few other options:
525
526 @table @option
527 @item -movflags empty_moov
528 Write an initial moov atom directly at the start of the file, without
529 describing any samples in it. Generally, an mdat/moov pair is written
530 at the start of the file, as a normal MOV/MP4 file, containing only
531 a short portion of the file. With this option set, there is no initial
532 mdat atom, and the moov atom only describes the tracks but has
533 a zero duration.
534
535 Files written with this option set do not work in QuickTime.
536 This option is implicitly set when writing ismv (Smooth Streaming) files.
537 @item -movflags separate_moof
538 Write a separate moof (movie fragment) atom for each track. Normally,
539 packets for all tracks are written in a moof atom (which is slightly
540 more efficient), but with this option set, the muxer writes one moof/mdat
541 pair for each track, making it easier to separate tracks.
542
543 This option is implicitly set when writing ismv (Smooth Streaming) files.
544 @item -movflags faststart
545 Run a second pass moving the index (moov atom) to the beginning of the file.
546 This operation can take a while, and will not work in various situations such
547 as fragmented output, thus it is not enabled by default.
548 @item -movflags rtphint
549 Add RTP hinting tracks to the output file.
550 @end table
551
552 @subsection Example
553
554 Smooth Streaming content can be pushed in real time to a publishing
555 point on IIS with this muxer. Example:
556 @example
557 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
558 @end example
559
560 @section mp3
561
562 The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
563 optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
564 @code{id3v2_version} option controls which one is used. Setting
565 @code{id3v2_version} to 0 will disable the ID3v2 header completely. The legacy
566 ID3v1 tag is not written by default, but may be enabled with the
567 @code{write_id3v1} option.
568
569 The muxer may also write a Xing frame at the beginning, which contains the
570 number of frames in the file. It is useful for computing duration of VBR files.
571 The Xing frame is written if the output stream is seekable and if the
572 @code{write_xing} option is set to 1 (the default).
573
574 The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
575 are supplied to the muxer in form of a video stream with a single packet. There
576 can be any number of those streams, each will correspond to a single APIC frame.
577 The stream metadata tags @var{title} and @var{comment} map to APIC
578 @var{description} and @var{picture type} respectively. See
579 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
580
581 Note that the APIC frames must be written at the beginning, so the muxer will
582 buffer the audio frames until it gets all the pictures. It is therefore advised
583 to provide the pictures as soon as possible to avoid excessive buffering.
584
585 Examples:
586
587 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
588 @example
589 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
590 @end example
591
592 To attach a picture to an mp3 file select both the audio and the picture stream
593 with @code{map}:
594 @example
595 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
596 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
597 @end example
598
599 Write a "clean" MP3 without any extra features:
600 @example
601 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
602 @end example
603
604 @section mpegts
605
606 MPEG transport stream muxer.
607
608 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
609
610 The recognized metadata settings in mpegts muxer are @code{service_provider}
611 and @code{service_name}. If they are not set the default for
612 @code{service_provider} is "FFmpeg" and the default for
613 @code{service_name} is "Service01".
614
615 @subsection Options
616
617 The muxer options are:
618
619 @table @option
620 @item -mpegts_original_network_id @var{number}
621 Set the original_network_id (default 0x0001). This is unique identifier
622 of a network in DVB. Its main use is in the unique identification of a
623 service through the path Original_Network_ID, Transport_Stream_ID.
624 @item -mpegts_transport_stream_id @var{number}
625 Set the transport_stream_id (default 0x0001). This identifies a
626 transponder in DVB.
627 @item -mpegts_service_id @var{number}
628 Set the service_id (default 0x0001) also known as program in DVB.
629 @item -mpegts_pmt_start_pid @var{number}
630 Set the first PID for PMT (default 0x1000, max 0x1f00).
631 @item -mpegts_start_pid @var{number}
632 Set the first PID for data packets (default 0x0100, max 0x0f00).
633 @item -mpegts_m2ts_mode @var{number}
634 Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
635 @item -muxrate @var{number}
636 Set muxrate.
637 @item -pes_payload_size @var{number}
638 Set minimum PES packet payload in bytes.
639 @item -mpegts_flags @var{flags}
640 Set flags (see below).
641 @item -mpegts_copyts @var{number}
642 Preserve original timestamps, if value is set to 1. Default value is -1, which
643 results in shifting timestamps so that they start from 0.
644 @item -tables_version @var{number}
645 Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
646 This option allows updating stream structure so that standard consumer may
647 detect the change. To do so, reopen output AVFormatContext (in case of API
648 usage) or restart ffmpeg instance, cyclically changing tables_version value:
649 @example
650 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
651 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
652 ...
653 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
654 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
655 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
656 ...
657 @end example
658 @end table
659
660 Option mpegts_flags may take a set of such flags:
661
662 @table @option
663 @item resend_headers
664 Reemit PAT/PMT before writing the next packet.
665 @item latm
666 Use LATM packetization for AAC.
667 @end table
668
669 @subsection Example
670
671 @example
672 ffmpeg -i file.mpg -c copy \
673      -mpegts_original_network_id 0x1122 \
674      -mpegts_transport_stream_id 0x3344 \
675      -mpegts_service_id 0x5566 \
676      -mpegts_pmt_start_pid 0x1500 \
677      -mpegts_start_pid 0x150 \
678      -metadata service_provider="Some provider" \
679      -metadata service_name="Some Channel" \
680      -y out.ts
681 @end example
682
683 @section null
684
685 Null muxer.
686
687 This muxer does not generate any output file, it is mainly useful for
688 testing or benchmarking purposes.
689
690 For example to benchmark decoding with @command{ffmpeg} you can use the
691 command:
692 @example
693 ffmpeg -benchmark -i INPUT -f null out.null
694 @end example
695
696 Note that the above command does not read or write the @file{out.null}
697 file, but specifying the output file is required by the @command{ffmpeg}
698 syntax.
699
700 Alternatively you can write the command as:
701 @example
702 ffmpeg -benchmark -i INPUT -f null -
703 @end example
704
705 @section ogg
706
707 Ogg container muxer.
708
709 @table @option
710 @item -page_duration @var{duration}
711 Preferred page duration, in microseconds. The muxer will attempt to create
712 pages that are approximately @var{duration} microseconds long. This allows the
713 user to compromise between seek granularity and container overhead. The default
714 is 1 second. A value of 0 will fill all segments, making pages as large as
715 possible. A value of 1 will effectively use 1 packet-per-page in most
716 situations, giving a small seek granularity at the cost of additional container
717 overhead.
718 @end table
719
720 @anchor{segment}
721 @section segment, stream_segment, ssegment
722
723 Basic stream segmenter.
724
725 This muxer outputs streams to a number of separate files of nearly
726 fixed duration. Output filename pattern can be set in a fashion similar to
727 @ref{image2}.
728
729 @code{stream_segment} is a variant of the muxer used to write to
730 streaming output formats, i.e. which do not require global headers,
731 and is recommended for outputting e.g. to MPEG transport stream segments.
732 @code{ssegment} is a shorter alias for @code{stream_segment}.
733
734 Every segment starts with a keyframe of the selected reference stream,
735 which is set through the @option{reference_stream} option.
736
737 Note that if you want accurate splitting for a video file, you need to
738 make the input key frames correspond to the exact splitting times
739 expected by the segmenter, or the segment muxer will start the new
740 segment with the key frame found next after the specified start
741 time.
742
743 The segment muxer works best with a single constant frame rate video.
744
745 Optionally it can generate a list of the created segments, by setting
746 the option @var{segment_list}. The list type is specified by the
747 @var{segment_list_type} option. The entry filenames in the segment
748 list are set by default to the basename of the corresponding segment
749 files.
750
751 See also the @ref{hls} muxer, which provides a more specific
752 implementation for HLS segmentation.
753
754 @subsection Options
755
756 The segment muxer supports the following options:
757
758 @table @option
759 @item reference_stream @var{specifier}
760 Set the reference stream, as specified by the string @var{specifier}.
761 If @var{specifier} is set to @code{auto}, the reference is chosen
762 automatically. Otherwise it must be a stream specifier (see the ``Stream
763 specifiers'' chapter in the ffmpeg manual) which specifies the
764 reference stream. The default value is @code{auto}.
765
766 @item segment_format @var{format}
767 Override the inner container format, by default it is guessed by the filename
768 extension.
769
770 @item segment_list @var{name}
771 Generate also a listfile named @var{name}. If not specified no
772 listfile is generated.
773
774 @item segment_list_flags @var{flags}
775 Set flags affecting the segment list generation.
776
777 It currently supports the following flags:
778 @table @samp
779 @item cache
780 Allow caching (only affects M3U8 list files).
781
782 @item live
783 Allow live-friendly file generation.
784 @end table
785
786 @item segment_list_size @var{size}
787 Update the list file so that it contains at most the last @var{size}
788 segments. If 0 the list file will contain all the segments. Default
789 value is 0.
790
791 @item segment_list_entry_prefix @var{prefix}
792 Set @var{prefix} to prepend to the name of each entry filename. By
793 default no prefix is applied.
794
795 @item segment_list_type @var{type}
796 Specify the format for the segment list file.
797
798 The following values are recognized:
799 @table @samp
800 @item flat
801 Generate a flat list for the created segments, one segment per line.
802
803 @item csv, ext
804 Generate a list for the created segments, one segment per line,
805 each line matching the format (comma-separated values):
806 @example
807 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
808 @end example
809
810 @var{segment_filename} is the name of the output file generated by the
811 muxer according to the provided pattern. CSV escaping (according to
812 RFC4180) is applied if required.
813
814 @var{segment_start_time} and @var{segment_end_time} specify
815 the segment start and end time expressed in seconds.
816
817 A list file with the suffix @code{".csv"} or @code{".ext"} will
818 auto-select this format.
819
820 @samp{ext} is deprecated in favor or @samp{csv}.
821
822 @item ffconcat
823 Generate an ffconcat file for the created segments. The resulting file
824 can be read using the FFmpeg @ref{concat} demuxer.
825
826 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
827 auto-select this format.
828
829 @item m3u8
830 Generate an extended M3U8 file, version 3, compliant with
831 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
832
833 A list file with the suffix @code{".m3u8"} will auto-select this format.
834 @end table
835
836 If not specified the type is guessed from the list file name suffix.
837
838 @item segment_time @var{time}
839 Set segment duration to @var{time}, the value must be a duration
840 specification. Default value is "2". See also the
841 @option{segment_times} option.
842
843 Note that splitting may not be accurate, unless you force the
844 reference stream key-frames at the given time. See the introductory
845 notice and the examples below.
846
847 @item segment_time_delta @var{delta}
848 Specify the accuracy time when selecting the start time for a
849 segment, expressed as a duration specification. Default value is "0".
850
851 When delta is specified a key-frame will start a new segment if its
852 PTS satisfies the relation:
853 @example
854 PTS >= start_time - time_delta
855 @end example
856
857 This option is useful when splitting video content, which is always
858 split at GOP boundaries, in case a key frame is found just before the
859 specified split time.
860
861 In particular may be used in combination with the @file{ffmpeg} option
862 @var{force_key_frames}. The key frame times specified by
863 @var{force_key_frames} may not be set accurately because of rounding
864 issues, with the consequence that a key frame time may result set just
865 before the specified time. For constant frame rate videos a value of
866 1/(2*@var{frame_rate}) should address the worst case mismatch between
867 the specified time and the time set by @var{force_key_frames}.
868
869 @item segment_times @var{times}
870 Specify a list of split points. @var{times} contains a list of comma
871 separated duration specifications, in increasing order. See also
872 the @option{segment_time} option.
873
874 @item segment_frames @var{frames}
875 Specify a list of split video frame numbers. @var{frames} contains a
876 list of comma separated integer numbers, in increasing order.
877
878 This option specifies to start a new segment whenever a reference
879 stream key frame is found and the sequential number (starting from 0)
880 of the frame is greater or equal to the next value in the list.
881
882 @item segment_wrap @var{limit}
883 Wrap around segment index once it reaches @var{limit}.
884
885 @item segment_start_number @var{number}
886 Set the sequence number of the first segment. Defaults to @code{0}.
887
888 @item reset_timestamps @var{1|0}
889 Reset timestamps at the begin of each segment, so that each segment
890 will start with near-zero timestamps. It is meant to ease the playback
891 of the generated segments. May not work with some combinations of
892 muxers/codecs. It is set to @code{0} by default.
893
894 @item initial_offset @var{offset}
895 Specify timestamp offset to apply to the output packet timestamps. The
896 argument must be a time duration specification, and defaults to 0.
897 @end table
898
899 @subsection Examples
900
901 @itemize
902 @item
903 To remux the content of file @file{in.mkv} to a list of segments
904 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
905 generated segments to @file{out.list}:
906 @example
907 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
908 @end example
909
910 @item
911 As the example above, but segment the input file according to the split
912 points specified by the @var{segment_times} option:
913 @example
914 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
915 @end example
916
917 @item
918 As the example above, but use the @command{ffmpeg} @option{force_key_frames}
919 option to force key frames in the input at the specified location, together
920 with the segment option @option{segment_time_delta} to account for
921 possible roundings operated when setting key frame times.
922 @example
923 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
924 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
925 @end example
926 In order to force key frames on the input file, transcoding is
927 required.
928
929 @item
930 Segment the input file by splitting the input file according to the
931 frame numbers sequence specified with the @option{segment_frames} option:
932 @example
933 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
934 @end example
935
936 @item
937 To convert the @file{in.mkv} to TS segments using the @code{libx264}
938 and @code{libfaac} encoders:
939 @example
940 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
941 @end example
942
943 @item
944 Segment the input file, and create an M3U8 live playlist (can be used
945 as live HLS source):
946 @example
947 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
948 -segment_list_flags +live -segment_time 10 out%03d.mkv
949 @end example
950 @end itemize
951
952 @section tee
953
954 The tee muxer can be used to write the same data to several files or any
955 other kind of muxer. It can be used, for example, to both stream a video to
956 the network and save it to disk at the same time.
957
958 It is different from specifying several outputs to the @command{ffmpeg}
959 command-line tool because the audio and video data will be encoded only once
960 with the tee muxer; encoding can be a very expensive process. It is not
961 useful when using the libavformat API directly because it is then possible
962 to feed the same packets to several muxers directly.
963
964 The slave outputs are specified in the file name given to the muxer,
965 separated by '|'. If any of the slave name contains the '|' separator,
966 leading or trailing spaces or any special character, it must be
967 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
968 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
969
970 Muxer options can be specified for each slave by prepending them as a list of
971 @var{key}=@var{value} pairs separated by ':', between square brackets. If
972 the options values contain a special character or the ':' separator, they
973 must be escaped; note that this is a second level escaping.
974
975 The following special options are also recognized:
976 @table @option
977 @item f
978 Specify the format name. Useful if it cannot be guessed from the
979 output name suffix.
980
981 @item bsfs[/@var{spec}]
982 Specify a list of bitstream filters to apply to the specified
983 output.
984
985 It is possible to specify to which streams a given bitstream filter
986 applies, by appending a stream specifier to the option separated by
987 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
988 stream specifiers}).  If the stream specifier is not specified, the
989 bistream filters will be applied to all streams in the output.
990
991 Several bitstream filters can be specified, separated by ",".
992
993 @item select
994 Select the streams that should be mapped to the slave output,
995 specified by a stream specifier. If not specified, this defaults to
996 all the input streams.
997 @end table
998
999 @subsection Examples
1000
1001 @itemize
1002 @item
1003 Encode something and both archive it in a WebM file and stream it
1004 as MPEG-TS over UDP (the streams need to be explicitly mapped):
1005 @example
1006 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1007   "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1008 @end example
1009
1010 @item
1011 Use @command{ffmpeg} to encode the input, and send the output
1012 to three different destinations. The @code{dump_extra} bitstream
1013 filter is used to add extradata information to all the output video
1014 keyframes packets, as requested by the MPEG-TS format. The select
1015 option is applied to @file{out.aac} in order to make it contain only
1016 audio packets.
1017 @example
1018 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1019        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
1020 @end example
1021
1022 @item
1023 As below, but select only stream @code{a:1} for the audio output. Note
1024 that a second level escaping must be performed, as ":" is a special
1025 character used to separate options.
1026 @example
1027 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1028        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
1029 @end example
1030 @end itemize
1031
1032 Note: some codecs may need different options depending on the output format;
1033 the auto-detection of this can not work with the tee muxer. The main example
1034 is the @option{global_header} flag.
1035
1036 @c man end MUXERS