muxers.texi 41.5 KB
Newer Older
Stefano Sabatini's avatar
Stefano Sabatini committed
1 2 3
@chapter Muxers
@c man begin MUXERS

4
Muxers are configured elements in FFmpeg which allow writing
Stefano Sabatini's avatar
Stefano Sabatini committed
5 6
multimedia streams to a particular type of file.

7
When you configure your FFmpeg build, all the supported muxers
Stefano Sabatini's avatar
Stefano Sabatini committed
8 9 10 11 12 13 14 15 16 17 18 19 20
are enabled by default. You can list all available muxers using the
configure option @code{--list-muxers}.

You can disable all the muxers with the configure option
@code{--disable-muxers} and selectively enable / disable single muxers
with the options @code{--enable-muxer=@var{MUXER}} /
@code{--disable-muxer=@var{MUXER}}.

The option @code{-formats} of the ff* tools will display the list of
enabled muxers.

A description of some of the currently available muxers follows.

Timothy Gu's avatar
Timothy Gu committed
21 22 23 24 25
@anchor{aiff}
@section aiff

Audio Interchange File Format muxer.

26 27
@subsection Options

Timothy Gu's avatar
Timothy Gu committed
28 29 30 31 32 33 34 35 36 37 38 39
It accepts the following options:

@table @option
@item write_id3v2
Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).

@item id3v2_version
Select ID3v2 version to write. Currently only version 3 and 4 (aka.
ID3v2.3 and ID3v2.4) are supported. The default is version 4.

@end table

40
@anchor{crc}
41 42 43 44 45 46 47 48 49 50 51 52 53
@section crc

CRC (Cyclic Redundancy Check) testing format.

This muxer computes and prints the Adler-32 CRC of all the input audio
and video frames. By default audio frames are converted to signed
16-bit raw audio and video frames to raw video before computing the
CRC.

The output of the muxer consists of a single line of the form:
CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
8 digits containing the CRC for all the decoded input frames.

54 55 56 57
See also the @ref{framecrc} muxer.

@subsection Examples

58 59 60 61 62 63 64 65 66 67 68
For example to compute the CRC of the input, and store it in the file
@file{out.crc}:
@example
ffmpeg -i INPUT -f crc out.crc
@end example

You can print the CRC to stdout with the command:
@example
ffmpeg -i INPUT -f crc -
@end example

69
You can select the output format of each frame with @command{ffmpeg} by
70 71 72 73
specifying the audio and video codec and format. For example to
compute the CRC of the input audio converted to PCM unsigned 8-bit
and the input video converted to MPEG-2 video, use the command:
@example
74
ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
75 76
@end example

77 78 79
@anchor{framecrc}
@section framecrc

80
Per-packet CRC (Cyclic Redundancy Check) testing format.
81

82 83
This muxer computes and prints the Adler-32 CRC for each audio
and video packet. By default audio frames are converted to signed
84 85 86 87
16-bit raw audio and video frames to raw video before computing the
CRC.

The output of the muxer consists of a line for each audio and video
88 89 90 91
packet of the form:
@example
@var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
@end example
92

93 94 95
@var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
CRC of the packet.

96 97
@subsection Examples

98 99 100
For example to compute the CRC of the audio and video frames in
@file{INPUT}, converted to raw audio and video packets, and store it
in the file @file{out.crc}:
101 102 103 104
@example
ffmpeg -i INPUT -f framecrc out.crc
@end example

105
To print the information to stdout, use the command:
106 107 108 109
@example
ffmpeg -i INPUT -f framecrc -
@end example

110 111 112
With @command{ffmpeg}, you can select the output format to which the
audio and video frames are encoded before computing the CRC for each
packet by specifying the audio and video codec. For example, to
113 114 115 116
compute the CRC of each decoded input audio frame converted to PCM
unsigned 8-bit and of each decoded input video frame converted to
MPEG-2 video, use the command:
@example
117
ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
118 119
@end example

120
See also the @ref{crc} muxer.
121

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
@anchor{framemd5}
@section framemd5

Per-packet MD5 testing format.

This muxer computes and prints the MD5 hash for each audio
and video packet. By default audio frames are converted to signed
16-bit raw audio and video frames to raw video before computing the
hash.

The output of the muxer consists of a line for each audio and video
packet of the form:
@example
@var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{MD5}
@end example

@var{MD5} is a hexadecimal number representing the computed MD5 hash
for the packet.

141 142
@subsection Examples

143 144 145 146 147 148 149 150 151 152 153 154 155 156
For example to compute the MD5 of the audio and video frames in
@file{INPUT}, converted to raw audio and video packets, and store it
in the file @file{out.md5}:
@example
ffmpeg -i INPUT -f framemd5 out.md5
@end example

To print the information to stdout, use the command:
@example
ffmpeg -i INPUT -f framemd5 -
@end example

See also the @ref{md5} muxer.

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
@anchor{gif}
@section gif

Animated GIF muxer.

It accepts the following options:

@table @option
@item loop
Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
for looping indefinitely (default).

@item final_delay
Force the delay (expressed in centiseconds) after the last frame. Each frame
ends with a delay until the next frame. The default is @code{-1}, which is a
special value to tell the muxer to re-use the previous delay. In case of a
loop, you might want to customize this value to mark a pause for instance.
@end table

For example, to encode a gif looping 10 times, with a 5 seconds delay between
the loops:
@example
ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
@end example

Note 1: if you wish to extract the frames in separate GIF files, you need to
force the @ref{image2} muxer:
@example
ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
@end example

Note 2: the GIF format has a very small time base: the delay between two frames
can not be smaller than one centi second.

191 192 193 194
@anchor{hls}
@section hls

Apple HTTP Live Streaming muxer that segments MPEG-TS according to
195
the HTTP Live Streaming (HLS) specification.
196

197 198 199 200 201 202
It creates a playlist file, and one or more segment files. The output filename
specifies the playlist filename.

By default, the muxer creates a file for each segment produced. These files
have the same name as the playlist, followed by a sequential number and a
.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 209
This example will produce the playlist, @file{out.m3u8}, and segment files:
@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 214
segmentation.

215 216
@subsection Options

217 218
This muxer supports the following options:

219
@table @option
220 221 222 223 224 225 226
@item hls_time @var{seconds}
Set the segment length in seconds. Default value is 2.

@item hls_list_size @var{size}
Set the maximum number of playlist entries. If set to 0 the list file
will contain all the segments. Default value is 5.

Steven Liu's avatar
Steven Liu committed
227 228 229 230 231
@item hls_ts_options @var{options_list}
Set output format options using a :-separated list of key=value
parameters. Values containing @code{:} special characters must be
escaped.

232 233 234 235 236 237 238 239 240 241 242 243 244
@item hls_wrap @var{wrap}
Set the number after which the segment filename number (the number
specified in each segment file) wraps. If set to 0 the number will be
never wrapped. Default value is 0.

This option is useful to avoid to fill the disk with many segment
files, and limits the maximum number of segment files written to disk
to @var{wrap}.

@item start_number @var{number}
Start the playlist sequence number from @var{number}. Default value is
0.

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 250
Append @var{baseurl} to every entry in the playlist.
Useful to generate playlists with absolute paths.
251

252 253 254 255
Note that the playlist sequence number must be unique for each segment
and it is not to be confused with the segment filename sequence number
which can be cyclic, for example if the @option{wrap} option is
specified.
256 257 258 259 260 261 262 263 264 265 266

@item hls_flags single_file
If this flag is set, the muxer will store all segments in a single MPEG-TS
file, and will use byte ranges in the playlist. HLS playlists generated with
this way will have the version number 4.
For example:
@example
ffmpeg -i in.nut -hls_flags single_file out.m3u8
@end example
Will produce the playlist, @file{out.m3u8}, and a single segment file,
@file{out.ts}.
267 268
@end table

Michael Bradshaw's avatar
Michael Bradshaw committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
@anchor{ico}
@section ico

ICO file muxer.

Microsoft's icon file format (ICO) has some strict limitations that should be noted:

@itemize
@item
Size cannot exceed 256 pixels in any dimension

@item
Only BMP and PNG images can be stored

@item
If a BMP image is used, it must be one of the following pixel formats:
@example
BMP Bit Depth      FFmpeg Pixel Format
1bit               pal8
4bit               pal8
8bit               pal8
16bit              rgb555le
24bit              bgr24
32bit              bgra
@end example

@item
If a BMP image is used, it must use the BITMAPINFOHEADER DIB header

@item
If a PNG image is used, it must use the rgba pixel format
@end itemize

302
@anchor{image2}
303 304 305 306
@section image2

Image file muxer.

307
The image file muxer writes video frames to image files.
308

309 310 311
The output filenames are specified by a pattern, which can be used to
produce sequentially numbered series of files.
The pattern may contain the string "%d" or "%0@var{N}d", this string
312
specifies the position of the characters representing a numbering in
313
the filenames. If the form "%0@var{N}d" is used, the string
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
representing the number in each filename is 0-padded to @var{N}
digits. The literal character '%' can be specified in the pattern with
the string "%%".

If the pattern contains "%d" or "%0@var{N}d", the first filename of
the file list specified will contain the number 1, all the following
numbers will be sequential.

The pattern may contain a suffix which is used to automatically
determine the format of the image files to write.

For example the pattern "img-%03d.bmp" will specify a sequence of
filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
@file{img-010.bmp}, etc.
The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
etc.

332 333
@subsection Examples

334
The following example shows how to use @command{ffmpeg} for creating a
335 336 337
sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
taking one image every second from the input video:
@example
338
ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
339 340
@end example

341
Note that with @command{ffmpeg}, if the format is not specified with the
342 343 344 345
@code{-f} option and the output filename specifies an image file
format, the image2 muxer is automatically selected, so the previous
command can be written as:
@example
346
ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
347 348 349 350 351 352
@end example

Note also that the pattern must not necessarily contain "%d" or
"%0@var{N}d", for example to create a single image file
@file{img.jpeg} from the input video you can employ the command:
@example
353
ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
354 355
@end example

356 357 358 359 360 361 362 363 364 365 366
The @option{strftime} option allows you to expand the filename with
date and time information. Check the documentation of
the @code{strftime()} function for the syntax.

For example to generate image files from the @code{strftime()}
"%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
can be used:
@example
ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
@end example

367 368
@subsection Options

369
@table @option
370 371 372
@item start_number
Start the sequence from the specified number. Default value is 1. Must
be a non-negative number.
373

374 375 376 377
@item update
If set to 1, the filename will always be interpreted as just a
filename, not a pattern, and the corresponding file will be continuously
overwritten with new images. Default value is 0.
378

379
@item strftime
380 381
If set to 1, expand the filename with date and time information from
@code{strftime()}. Default value is 0.
382 383
@end table

384 385 386 387 388 389
The image muxer supports the .Y.U.V image file format. This format is
special in that that each image frame consists of three files, for
each of the YUV420P components. To read or write this image file format,
specify the name of the '.Y' file. The muxer will automatically open the
'.U' and '.V' files as required.

390 391 392 393 394 395
@section matroska

Matroska container muxer.

This muxer implements the matroska and webm container specs.

396 397
@subsection Metadata

398 399 400
The recognized metadata settings in this muxer are:

@table @option
401 402
@item title
Set title name provided to a single track.
403

404 405
@item language
Specify the language of the track in the Matroska languages form.
406

407 408 409 410 411
The language can be either the 3 letters bibliographic ISO-639-2 (ISO
639-2/B) form (like "fre" for French), or a language code mixed with a
country code for specialities in languages (like "fre-ca" for Canadian
French).

412 413
@item stereo_mode
Set stereo 3D video layout of two views in a single video track.
414

415 416
The following values are recognized:
@table @samp
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
@item mono
video is not stereo
@item left_right
Both views are arranged side by side, Left-eye view is on the left
@item bottom_top
Both views are arranged in top-bottom orientation, Left-eye view is at bottom
@item top_bottom
Both views are arranged in top-bottom orientation, Left-eye view is on top
@item checkerboard_rl
Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
@item checkerboard_lr
Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
@item row_interleaved_rl
Each view is constituted by a row based interleaving, Right-eye view is first row
@item row_interleaved_lr
Each view is constituted by a row based interleaving, Left-eye view is first row
@item col_interleaved_rl
Both views are arranged in a column based interleaving manner, Right-eye view is first column
@item col_interleaved_lr
Both views are arranged in a column based interleaving manner, Left-eye view is first column
@item anaglyph_cyan_red
All frames are in anaglyph format viewable through red-cyan filters
@item right_left
Both views are arranged side by side, Right-eye view is on the left
@item anaglyph_green_magenta
All frames are in anaglyph format viewable through green-magenta filters
@item block_lr
Both eyes laced in one Block, Left-eye view is first
@item block_rl
Both eyes laced in one Block, Right-eye view is first
@end table
@end table

For example a 3D WebM clip can be created using the following command line:
@example
ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
@end example

455 456
@subsection Options

457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
This muxer supports the following options:

@table @option
@item reserve_index_space
By default, this muxer writes the index for seeking (called cues in Matroska
terms) at the end of the file, because it cannot know in advance how much space
to leave for the index at the beginning of the file. However for some use cases
-- e.g.  streaming where seeking is possible but slow -- it is useful to put the
index at the beginning of the file.

If this option is set to a non-zero value, the muxer will reserve a given amount
of space in the file header and then try to write the cues there when the muxing
finishes. If the available space does not suffice, muxing will fail. A safe size
for most use cases should be about 50kB per hour of video.

Note that cues are only written if the output is seekable and this option will
have no effect if it is not.
@end table

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
@anchor{md5}
@section md5

MD5 testing format.

This muxer computes and prints the MD5 hash of all the input audio
and video frames. By default audio frames are converted to signed
16-bit raw audio and video frames to raw video before computing the
hash.

The output of the muxer consists of a single line of the form:
MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
the computed MD5 hash.

For example to compute the MD5 hash of the input converted to raw
audio and video, and store it in the file @file{out.md5}:
@example
ffmpeg -i INPUT -f md5 out.md5
@end example

You can print the MD5 to stdout with the command:
@example
ffmpeg -i INPUT -f md5 -
@end example

See also the @ref{framemd5} muxer.

503
@section mov, mp4, ismv
504 505

MOV/MP4/ISMV (Smooth Streaming) muxer.
506 507 508 509

The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
file has all the metadata about all packets stored in one location
(written at the end of the file, it can be moved to the start for
510 511
better playback by adding @var{faststart} to the @var{movflags}, or
using the @command{qt-faststart} tool). A fragmented
512 513 514 515 516 517 518 519 520
file consists of a number of fragments, where packets and metadata
about these packets are stored together. Writing a fragmented
file has the advantage that the file is decodable even if the
writing is interrupted (while a normal MOV/MP4 is undecodable if
it is not properly finished), and it requires less memory when writing
very long files (since writing normal MOV/MP4 files stores info about
every single packet in memory until the file is closed). The downside
is that it is less compatible with other applications.

521 522
@subsection Options

523 524
Fragmentation is enabled by setting one of the AVOptions that define
how to cut the file into fragments:
525 526 527

@table @option
@item -moov_size @var{bytes}
528
Reserves space for the moov atom at the beginning of the file instead of placing the
529
moov atom at the end. If the space reserved is insufficient, muxing will fail.
530 531 532 533 534 535 536 537 538 539
@item -movflags frag_keyframe
Start a new fragment at each video keyframe.
@item -frag_duration @var{duration}
Create fragments that are @var{duration} microseconds long.
@item -frag_size @var{size}
Create fragments that contain up to @var{size} bytes of payload data.
@item -movflags frag_custom
Allow the caller to manually choose when to cut fragments, by
calling @code{av_write_frame(ctx, NULL)} to write a fragment with
the packets written so far. (This is only useful with other
540
applications integrating libavformat, not from @command{ffmpeg}.)
541 542
@item -min_frag_duration @var{duration}
Don't create fragments that are shorter than @var{duration} microseconds long.
543 544
@end table

545 546 547 548 549
If more than one condition is specified, fragments are cut when
one of the specified conditions is fulfilled. The exception to this is
@code{-min_frag_duration}, which has to be fulfilled for any of the other
conditions to apply.

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
Additionally, the way the output file is written can be adjusted
through a few other options:

@table @option
@item -movflags empty_moov
Write an initial moov atom directly at the start of the file, without
describing any samples in it. Generally, an mdat/moov pair is written
at the start of the file, as a normal MOV/MP4 file, containing only
a short portion of the file. With this option set, there is no initial
mdat atom, and the moov atom only describes the tracks but has
a zero duration.

This option is implicitly set when writing ismv (Smooth Streaming) files.
@item -movflags separate_moof
Write a separate moof (movie fragment) atom for each track. Normally,
packets for all tracks are written in a moof atom (which is slightly
more efficient), but with this option set, the muxer writes one moof/mdat
pair for each track, making it easier to separate tracks.

This option is implicitly set when writing ismv (Smooth Streaming) files.
570
@item -movflags faststart
571 572
Run a second pass moving the index (moov atom) to the beginning of the file.
This operation can take a while, and will not work in various situations such
573
as fragmented output, thus it is not enabled by default.
574 575
@item -movflags rtphint
Add RTP hinting tracks to the output file.
576 577 578 579
@item -movflags disable_chpl
Disable Nero chapter markers (chpl atom).  Normally, both Nero chapters
and a QuickTime chapter track are written to the file. With this option
set, only the QuickTime chapter track will be written. Nero chapters can
580 581
cause failures when the file is reprocessed with certain tagging programs, like
mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
582 583 584
@item -movflags omit_tfhd_offset
Do not write any absolute base_data_offset in tfhd atoms. This avoids
tying fragments to absolute byte positions in the file/streams.
585 586 587 588 589 590 591
@item -movflags default_base_moof
Similarly to the omit_tfhd_offset, this flag avoids writing the
absolute base_data_offset field in tfhd atoms, but does so by using
the new default-base-is-moof flag instead. This flag is new from
14496-12:2012. This may make the fragments easier to parse in certain
circumstances (avoiding basing track fragment location calculations
on the implicit end of the previous track fragment).
592 593
@end table

594 595
@subsection Example

596 597 598
Smooth Streaming content can be pushed in real time to a publishing
point on IIS with this muxer. Example:
@example
599
ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
600 601
@end example

602 603
@section mp3

604 605 606 607 608 609 610 611 612 613 614 615 616
The MP3 muxer writes a raw MP3 stream with the following optional features:
@itemize @bullet
@item
An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
2.4 are supported, the @code{id3v2_version} private option controls which one is
used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
completely.

The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
The pictures are supplied to the muxer in form of a video stream with a single
packet. There can be any number of those streams, each will correspond to a
single APIC frame.  The stream metadata tags @var{title} and @var{comment} map
to APIC @var{description} and @var{picture type} respectively. See
617 618 619 620 621 622
@url{http://id3.org/id3v2.4.0-frames} for allowed picture types.

Note that the APIC frames must be written at the beginning, so the muxer will
buffer the audio frames until it gets all the pictures. It is therefore advised
to provide the pictures as soon as possible to avoid excessive buffering.

623 624 625 626
@item
A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
default, but will be written only if the output is seekable. The
@code{write_xing} private option can be used to disable it.  The frame contains
627 628
various information that may be useful to the decoder, like the audio duration
or encoder delay.
629 630 631 632 633 634 635

@item
A legacy ID3v1 tag at the end of the file (disabled by default). It may be
enabled with the @code{write_id3v1} private option, but as its capabilities are
very limited, its usage is not recommended.
@end itemize

636 637 638 639 640 641 642 643 644 645 646 647 648 649
Examples:

Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
@example
ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
@end example

To attach a picture to an mp3 file select both the audio and the picture stream
with @code{map}:
@example
ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
-metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
@end example

650 651 652
Write a "clean" MP3 without any extra features:
@example
ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
653 654
@end example

655 656 657 658 659 660
@section mpegts

MPEG transport stream muxer.

This muxer implements ISO 13818-1 and part of ETSI EN 300 468.

661 662 663 664 665 666 667
The recognized metadata settings in mpegts muxer are @code{service_provider}
and @code{service_name}. If they are not set the default for
@code{service_provider} is "FFmpeg" and the default for
@code{service_name} is "Service01".

@subsection Options

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
The muxer options are:

@table @option
@item -mpegts_original_network_id @var{number}
Set the original_network_id (default 0x0001). This is unique identifier
of a network in DVB. Its main use is in the unique identification of a
service through the path Original_Network_ID, Transport_Stream_ID.
@item -mpegts_transport_stream_id @var{number}
Set the transport_stream_id (default 0x0001). This identifies a
transponder in DVB.
@item -mpegts_service_id @var{number}
Set the service_id (default 0x0001) also known as program in DVB.
@item -mpegts_pmt_start_pid @var{number}
Set the first PID for PMT (default 0x1000, max 0x1f00).
@item -mpegts_start_pid @var{number}
Set the first PID for data packets (default 0x0100, max 0x0f00).
684 685 686
@item -mpegts_m2ts_mode @var{number}
Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
@item -muxrate @var{number}
687
Set a constant muxrate (default VBR).
688 689 690
@item -pcr_period @var{numer}
Override the default PCR retransmission time (default 20ms), ignored
if variable muxrate is selected.
691 692 693 694 695 696 697 698 699
@item -pes_payload_size @var{number}
Set minimum PES packet payload in bytes.
@item -mpegts_flags @var{flags}
Set flags (see below).
@item -mpegts_copyts @var{number}
Preserve original timestamps, if value is set to 1. Default value is -1, which
results in shifting timestamps so that they start from 0.
@item -tables_version @var{number}
Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
700 701 702 703 704 705 706 707 708 709 710 711
This option allows updating stream structure so that standard consumer may
detect the change. To do so, reopen output AVFormatContext (in case of API
usage) or restart ffmpeg instance, cyclically changing tables_version value:
@example
ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
...
ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
...
@end example
712 713 714 715 716 717 718 719 720
@end table

Option mpegts_flags may take a set of such flags:

@table @option
@item resend_headers
Reemit PAT/PMT before writing the next packet.
@item latm
Use LATM packetization for AAC.
721 722
@end table

723
@subsection Example
724 725

@example
726
ffmpeg -i file.mpg -c copy \
727 728 729 730 731 732 733 734 735 736
     -mpegts_original_network_id 0x1122 \
     -mpegts_transport_stream_id 0x3344 \
     -mpegts_service_id 0x5566 \
     -mpegts_pmt_start_pid 0x1500 \
     -mpegts_start_pid 0x150 \
     -metadata service_provider="Some provider" \
     -metadata service_name="Some Channel" \
     -y out.ts
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
737 738 739 740 741 742 743
@section null

Null muxer.

This muxer does not generate any output file, it is mainly useful for
testing or benchmarking purposes.

744
For example to benchmark decoding with @command{ffmpeg} you can use the
Stefano Sabatini's avatar
Stefano Sabatini committed
745 746 747 748 749 750
command:
@example
ffmpeg -benchmark -i INPUT -f null out.null
@end example

Note that the above command does not read or write the @file{out.null}
751
file, but specifying the output file is required by the @command{ffmpeg}
Stefano Sabatini's avatar
Stefano Sabatini committed
752 753 754 755 756 757 758
syntax.

Alternatively you can write the command as:
@example
ffmpeg -benchmark -i INPUT -f null -
@end example

759 760 761 762 763 764 765 766
@section nut

@table @option
@item -syncpoints @var{flags}
Change the syncpoint usage in nut:
@table @option
@item @var{default} use the normal low-overhead seeking aids.
@item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
Lou Logan's avatar
Lou Logan committed
767
    Use of this option is not recommended, as the resulting files are very damage
768 769 770 771
    sensitive and seeking is not possible. Also in general the overhead from
    syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
    all growing data tables, allowing to mux endless streams with limited memory
    and wihout these disadvantages.
772 773 774
@item @var{timestamped} extend the syncpoint with a wallclock field.
@end table
The @var{none} and @var{timestamped} flags are experimental.
775 776
@item -write_index @var{bool}
Write index at the end, the default is to write an index.
777 778 779
@end table

@example
780
ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
781 782
@end example

783
@section ogg
784

785
Ogg container muxer.
786 787

@table @option
788 789 790 791 792 793 794 795
@item -page_duration @var{duration}
Preferred page duration, in microseconds. The muxer will attempt to create
pages that are approximately @var{duration} microseconds long. This allows the
user to compromise between seek granularity and container overhead. The default
is 1 second. A value of 0 will fill all segments, making pages as large as
possible. A value of 1 will effectively use 1 packet-per-page in most
situations, giving a small seek granularity at the cost of additional container
overhead.
796 797
@end table

798
@anchor{segment}
799
@section segment, stream_segment, ssegment
800 801 802

Basic stream segmenter.

803
This muxer outputs streams to a number of separate files of nearly
804 805 806
fixed duration. Output filename pattern can be set in a fashion similar to
@ref{image2}.

807 808 809 810 811
@code{stream_segment} is a variant of the muxer used to write to
streaming output formats, i.e. which do not require global headers,
and is recommended for outputting e.g. to MPEG transport stream segments.
@code{ssegment} is a shorter alias for @code{stream_segment}.

812 813 814
Every segment starts with a keyframe of the selected reference stream,
which is set through the @option{reference_stream} option.

815 816 817 818 819 820
Note that if you want accurate splitting for a video file, you need to
make the input key frames correspond to the exact splitting times
expected by the segmenter, or the segment muxer will start the new
segment with the key frame found next after the specified start
time.

821 822
The segment muxer works best with a single constant frame rate video.

823 824
Optionally it can generate a list of the created segments, by setting
the option @var{segment_list}. The list type is specified by the
825 826 827
@var{segment_list_type} option. The entry filenames in the segment
list are set by default to the basename of the corresponding segment
files.
828

829 830 831
See also the @ref{hls} muxer, which provides a more specific
implementation for HLS segmentation.

832 833
@subsection Options

834
The segment muxer supports the following options:
835 836

@table @option
837 838
@item reference_stream @var{specifier}
Set the reference stream, as specified by the string @var{specifier}.
839
If @var{specifier} is set to @code{auto}, the reference is chosen
840
automatically. Otherwise it must be a stream specifier (see the ``Stream
841
specifiers'' chapter in the ffmpeg manual) which specifies the
842
reference stream. The default value is @code{auto}.
843

844 845 846
@item segment_format @var{format}
Override the inner container format, by default it is guessed by the filename
extension.
847

848 849 850 851 852
@item segment_format_options @var{options_list}
Set output format options using a :-separated list of key=value
parameters. Values containing the @code{:} special character must be
escaped.

853
@item segment_list @var{name}
854 855
Generate also a listfile named @var{name}. If not specified no
listfile is generated.
856

857 858 859 860
@item segment_list_flags @var{flags}
Set flags affecting the segment list generation.

It currently supports the following flags:
861
@table @samp
862 863 864 865 866 867 868
@item cache
Allow caching (only affects M3U8 list files).

@item live
Allow live-friendly file generation.
@end table

869 870 871 872 873 874
@item segment_list_type @var{type}
Select the listing format.
@table @option
@item @var{flat} use a simple flat list of entries.
@item @var{hls} use a m3u8-like structure.
@end table
875

876
@item segment_list_size @var{size}
877
Update the list file so that it contains at most @var{size}
878 879 880
segments. If 0 the list file will contain all the segments. Default
value is 0.

881
@item segment_list_entry_prefix @var{prefix}
882
Prepend @var{prefix} to each entry. Useful to generate absolute paths.
883
By default no prefix is applied.
884

885
The following values are recognized:
886
@table @samp
887 888 889
@item flat
Generate a flat list for the created segments, one segment per line.

890
@item csv, ext
891
Generate a list for the created segments, one segment per line,
892
each line matching the format (comma-separated values):
893 894 895 896 897
@example
@var{segment_filename},@var{segment_start_time},@var{segment_end_time}
@end example

@var{segment_filename} is the name of the output file generated by the
898 899
muxer according to the provided pattern. CSV escaping (according to
RFC4180) is applied if required.
900 901 902

@var{segment_start_time} and @var{segment_end_time} specify
the segment start and end time expressed in seconds.
903

904 905 906
A list file with the suffix @code{".csv"} or @code{".ext"} will
auto-select this format.

907
@samp{ext} is deprecated in favor or @samp{csv}.
908

909 910 911 912 913 914 915
@item ffconcat
Generate an ffconcat file for the created segments. The resulting file
can be read using the FFmpeg @ref{concat} demuxer.

A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
auto-select this format.

916
@item m3u8
917 918
Generate an extended M3U8 file, version 3, compliant with
@url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
919 920

A list file with the suffix @code{".m3u8"} will auto-select this format.
921 922
@end table

923
If not specified the type is guessed from the list file name suffix.
924

925
@item segment_time @var{time}
926 927 928 929 930 931 932
Set segment duration to @var{time}, the value must be a duration
specification. Default value is "2". See also the
@option{segment_times} option.

Note that splitting may not be accurate, unless you force the
reference stream key-frames at the given time. See the introductory
notice and the examples below.
933

934 935 936 937 938 939 940 941 942 943
@item segment_atclocktime @var{1|0}
If set to "1" split at regular clock time intervals starting from 00:00
o'clock. The @var{time} value specified in @option{segment_time} is
used for setting the length of the splitting interval.

For example with @option{segment_time} set to "900" this makes it possible
to create files at 12:00 o'clock, 12:15, 12:30, etc.

Default value is "0".

944 945
@item segment_time_delta @var{delta}
Specify the accuracy time when selecting the start time for a
946
segment, expressed as a duration specification. Default value is "0".
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962

When delta is specified a key-frame will start a new segment if its
PTS satisfies the relation:
@example
PTS >= start_time - time_delta
@end example

This option is useful when splitting video content, which is always
split at GOP boundaries, in case a key frame is found just before the
specified split time.

In particular may be used in combination with the @file{ffmpeg} option
@var{force_key_frames}. The key frame times specified by
@var{force_key_frames} may not be set accurately because of rounding
issues, with the consequence that a key frame time may result set just
before the specified time. For constant frame rate videos a value of
963
1/(2*@var{frame_rate}) should address the worst case mismatch between
964 965
the specified time and the time set by @var{force_key_frames}.

966 967
@item segment_times @var{times}
Specify a list of split points. @var{times} contains a list of comma
968 969
separated duration specifications, in increasing order. See also
the @option{segment_time} option.
970

971 972 973 974 975 976 977 978
@item segment_frames @var{frames}
Specify a list of split video frame numbers. @var{frames} contains a
list of comma separated integer numbers, in increasing order.

This option specifies to start a new segment whenever a reference
stream key frame is found and the sequential number (starting from 0)
of the frame is greater or equal to the next value in the list.

979 980
@item segment_wrap @var{limit}
Wrap around segment index once it reaches @var{limit}.
981

982 983 984
@item segment_start_number @var{number}
Set the sequence number of the first segment. Defaults to @code{0}.

985 986 987 988 989
@item reset_timestamps @var{1|0}
Reset timestamps at the begin of each segment, so that each segment
will start with near-zero timestamps. It is meant to ease the playback
of the generated segments. May not work with some combinations of
muxers/codecs. It is set to @code{0} by default.
990 991 992 993

@item initial_offset @var{offset}
Specify timestamp offset to apply to the output packet timestamps. The
argument must be a time duration specification, and defaults to 0.
994 995
@end table

996
@subsection Examples
997 998 999

@itemize
@item
1000
Remux the content of file @file{in.mkv} to a list of segments
1001 1002
@file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
generated segments to @file{out.list}:
1003
@example
1004
ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
1005 1006
@end example

1007 1008 1009 1010 1011 1012
@item
Segment input and set output format options for the output segments:
@example
ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
@end example

1013
@item
1014 1015
Segment the input file according to the split points specified by the
@var{segment_times} option:
1016
@example
1017
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
1018 1019
@end example

1020
@item
1021
Use the @command{ffmpeg} @option{force_key_frames}
1022
option to force key frames in the input at the specified location, together
1023
with the segment option @option{segment_time_delta} to account for
1024 1025
possible roundings operated when setting key frame times.
@example
1026
ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
1027
-f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
1028 1029 1030 1031
@end example
In order to force key frames on the input file, transcoding is
required.

1032 1033
@item
Segment the input file by splitting the input file according to the
1034
frame numbers sequence specified with the @option{segment_frames} option:
1035 1036 1037 1038
@example
ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
@end example

1039
@item
1040
Convert the @file{in.mkv} to TS segments using the @code{libx264}
1041 1042 1043 1044
and @code{libfaac} encoders:
@example
ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
@end example
1045 1046 1047 1048 1049 1050 1051 1052

@item
Segment the input file, and create an M3U8 live playlist (can be used
as live HLS source):
@example
ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
-segment_list_flags +live -segment_time 10 out%03d.mkv
@end example
1053 1054
@end itemize

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
@section smoothstreaming

Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.

@table @option
@item window_size
Specify the number of fragments kept in the manifest. Default 0 (keep all).

@item extra_window_size
Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.

@item lookahead_count
Specify the number of lookahead fragments. Default 2.

@item min_frag_duration
Specify the minimum fragment duration (in microseconds). Default 5000000.

@item remove_at_exit
Specify whether to remove all fragments when finished. Default 0 (do not remove).

@end table

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
@section tee

The tee muxer can be used to write the same data to several files or any
other kind of muxer. It can be used, for example, to both stream a video to
the network and save it to disk at the same time.

It is different from specifying several outputs to the @command{ffmpeg}
command-line tool because the audio and video data will be encoded only once
with the tee muxer; encoding can be a very expensive process. It is not
useful when using the libavformat API directly because it is then possible
to feed the same packets to several muxers directly.

The slave outputs are specified in the file name given to the muxer,
separated by '|'. If any of the slave name contains the '|' separator,
leading or trailing spaces or any special character, it must be
1092 1093
escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
1094

1095
Muxer options can be specified for each slave by prepending them as a list of
1096 1097
@var{key}=@var{value} pairs separated by ':', between square brackets. If
the options values contain a special character or the ':' separator, they
1098
must be escaped; note that this is a second level escaping.
1099

1100 1101 1102 1103 1104 1105 1106 1107
The following special options are also recognized:
@table @option
@item f
Specify the format name. Useful if it cannot be guessed from the
output name suffix.

@item bsfs[/@var{spec}]
Specify a list of bitstream filters to apply to the specified
1108 1109 1110 1111 1112 1113
output.

It is possible to specify to which streams a given bitstream filter
applies, by appending a stream specifier to the option separated by
@code{/}. @var{spec} must be a stream specifier (see @ref{Format
stream specifiers}).  If the stream specifier is not specified, the
Michael Niedermayer's avatar
Michael Niedermayer committed
1114
bitstream filters will be applied to all streams in the output.
1115 1116

Several bitstream filters can be specified, separated by ",".
1117 1118 1119 1120 1121

@item select
Select the streams that should be mapped to the slave output,
specified by a stream specifier. If not specified, this defaults to
all the input streams.
1122 1123
@end table

1124 1125
@subsection Examples

1126 1127 1128
@itemize
@item
Encode something and both archive it in a WebM file and stream it
1129
as MPEG-TS over UDP (the streams need to be explicitly mapped):
1130
@example
1131
ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1132 1133 1134
  "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
@end example

1135 1136
@item
Use @command{ffmpeg} to encode the input, and send the output
1137 1138 1139 1140 1141 1142 1143 1144 1145
to three different destinations. The @code{dump_extra} bitstream
filter is used to add extradata information to all the output video
keyframes packets, as requested by the MPEG-TS format. The select
option is applied to @file{out.aac} in order to make it contain only
audio packets.
@example
ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
       -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
@end example
1146 1147 1148 1149 1150 1151 1152 1153 1154

@item
As below, but select only stream @code{a:1} for the audio output. Note
that a second level escaping must be performed, as ":" is a special
character used to separate options.
@example
ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
       -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
@end example
1155
@end itemize
1156

1157 1158 1159 1160
Note: some codecs may need different options depending on the output format;
the auto-detection of this can not work with the tee muxer. The main example
is the @option{global_header} flag.

1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
@section webm_dash_manifest

WebM DASH Manifest muxer.

This muxer implements the WebM DASH Manifest specification to generate the DASH manifest XML.

@subsection Options

This muxer supports the following options:

@table @option
@item adaptation_sets
This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
audio and video streams. Any number of adaptation sets can be added using this option.
@end table

@subsection Example
@example
ffmpeg -f webm_dash_manifest -i video1.webm \
       -f webm_dash_manifest -i video2.webm \
       -f webm_dash_manifest -i audio1.webm \
       -f webm_dash_manifest -i audio2.webm \
       -map 0 -map 1 -map 2 -map 3 \
       -c copy \
       -f webm_dash_manifest \
       -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
       manifest.xml
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
1191
@c man end MUXERS