muxers.texi 35.8 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

It creates a playlist file and numbered segment files. The output
filename specifies the playlist filename; the segment filenames
receive the same basename as the playlist, a sequential number and
a .ts extension.

202
For example, to convert an input file with @command{ffmpeg}:
203
@example
204
ffmpeg -i in.nut out.m3u8
205 206
@end example

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 210
segmentation.

211 212
@subsection Options

213 214
This muxer supports the following options:

215
@table @option
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
@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.

@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.

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.
240 241
@end table

Michael Bradshaw's avatar
Michael Bradshaw committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
@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

275
@anchor{image2}
276 277 278 279
@section image2

Image file muxer.

280
The image file muxer writes video frames to image files.
281

282 283 284
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
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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
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.

305 306
@subsection Examples

307
The following example shows how to use @command{ffmpeg} for creating a
308 309 310
sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
taking one image every second from the input video:
@example
311
ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
312 313
@end example

314
Note that with @command{ffmpeg}, if the format is not specified with the
315 316 317 318
@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
319
ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
320 321 322 323 324 325
@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
326
ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
327 328
@end example

329 330 331 332 333 334 335 336 337 338 339
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

340 341
@subsection Options

342
@table @option
343 344 345
@item start_number
Start the sequence from the specified number. Default value is 1. Must
be a non-negative number.
346

347 348 349 350
@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.
351

352
@item strftime
353 354
If set to 1, expand the filename with date and time information from
@code{strftime()}. Default value is 0.
355 356
@end table

357 358 359 360 361 362
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.

363 364 365 366 367 368
@section matroska

Matroska container muxer.

This muxer implements the matroska and webm container specs.

369 370
@subsection Metadata

371 372 373
The recognized metadata settings in this muxer are:

@table @option
374 375
@item title
Set title name provided to a single track.
376

377 378
@item language
Specify the language of the track in the Matroska languages form.
379

380 381 382 383 384
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).

385 386
@item stereo_mode
Set stereo 3D video layout of two views in a single video track.
387

388 389
The following values are recognized:
@table @samp
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
@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

428 429
@subsection Options

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
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

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
@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.

476
@section mov, mp4, ismv
477 478

MOV/MP4/ISMV (Smooth Streaming) muxer.
479 480 481 482

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
483 484
better playback by adding @var{faststart} to the @var{movflags}, or
using the @command{qt-faststart} tool). A fragmented
485 486 487 488 489 490 491 492 493
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.

494 495
@subsection Options

496 497
Fragmentation is enabled by setting one of the AVOptions that define
how to cut the file into fragments:
498 499 500

@table @option
@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 504 505 506 507 508 509 510 511 512
@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
513
applications integrating libavformat, not from @command{ffmpeg}.)
514 515
@item -min_frag_duration @var{duration}
Don't create fragments that are shorter than @var{duration} microseconds long.
516 517
@end table

518 519 520 521 522
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.

523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
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.

Files written with this option set do not work in QuickTime.
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.
544
@item -movflags faststart
545 546
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
547
as fragmented output, thus it is not enabled by default.
548 549
@item -movflags rtphint
Add RTP hinting tracks to the output file.
550 551
@end table

552 553
@subsection Example

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

560 561 562 563
@section mp3

The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
564 565 566 567
@code{id3v2_version} option controls which one is used. Setting
@code{id3v2_version} to 0 will disable the ID3v2 header completely. The legacy
ID3v1 tag is not written by default, but may be enabled with the
@code{write_id3v1} option.
568

569 570 571 572
The muxer may also write a Xing frame at the beginning, which contains the
number of frames in the file. It is useful for computing duration of VBR files.
The Xing frame is written if the output stream is seekable and if the
@code{write_xing} option is set to 1 (the default).
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598

The muxer supports writing ID3v2 attached pictures (APIC frames). 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
@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.

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

599 600 601
Write a "clean" MP3 without any extra features:
@example
ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
602 603
@end example

604 605 606 607 608 609
@section mpegts

MPEG transport stream muxer.

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

610 611 612 613 614 615 616
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

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
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).
633 634 635 636 637 638 639 640 641 642 643 644 645
@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}
Set muxrate.
@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).
646 647 648 649 650 651 652 653 654 655 656 657
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
658 659 660 661 662 663 664 665 666
@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.
667 668
@end table

669
@subsection Example
670 671

@example
672
ffmpeg -i file.mpg -c copy \
673 674 675 676 677 678 679 680 681 682
     -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
683 684 685 686 687 688 689
@section null

Null muxer.

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

690
For example to benchmark decoding with @command{ffmpeg} you can use the
Stefano Sabatini's avatar
Stefano Sabatini committed
691 692 693 694 695 696
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}
697
file, but specifying the output file is required by the @command{ffmpeg}
Stefano Sabatini's avatar
Stefano Sabatini committed
698 699 700 701 702 703 704
syntax.

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

705
@section ogg
706

707
Ogg container muxer.
708 709

@table @option
710 711 712 713 714 715 716 717
@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.
718 719
@end table

720
@anchor{segment}
721
@section segment, stream_segment, ssegment
722 723 724

Basic stream segmenter.

725
This muxer outputs streams to a number of separate files of nearly
726 727 728
fixed duration. Output filename pattern can be set in a fashion similar to
@ref{image2}.

729 730 731 732 733
@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}.

734 735 736
Every segment starts with a keyframe of the selected reference stream,
which is set through the @option{reference_stream} option.

737 738 739 740 741 742
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.

743 744
The segment muxer works best with a single constant frame rate video.

745 746
Optionally it can generate a list of the created segments, by setting
the option @var{segment_list}. The list type is specified by the
747 748 749
@var{segment_list_type} option. The entry filenames in the segment
list are set by default to the basename of the corresponding segment
files.
750

751 752 753
See also the @ref{hls} muxer, which provides a more specific
implementation for HLS segmentation.

754 755
@subsection Options

756
The segment muxer supports the following options:
757 758

@table @option
759 760 761
@item reference_stream @var{specifier}
Set the reference stream, as specified by the string @var{specifier}.
If @var{specifier} is set to @code{auto}, the reference is choosen
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 767 768
@item segment_format @var{format}
Override the inner container format, by default it is guessed by the filename
extension.
769

770
@item segment_list @var{name}
771 772
Generate also a listfile named @var{name}. If not specified no
listfile is generated.
773

774 775 776 777
@item segment_list_flags @var{flags}
Set flags affecting the segment list generation.

It currently supports the following flags:
778
@table @samp
779 780 781 782 783 784 785
@item cache
Allow caching (only affects M3U8 list files).

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

786
@item segment_list_size @var{size}
787 788 789 790
Update the list file so that it contains at most the last @var{size}
segments. If 0 the list file will contain all the segments. Default
value is 0.

791 792 793 794
@item segment_list_entry_prefix @var{prefix}
Set @var{prefix} to prepend to the name of each entry filename. By
default no prefix is applied.

795
@item segment_list_type @var{type}
796 797 798
Specify the format for the segment list file.

The following values are recognized:
799
@table @samp
800 801 802
@item flat
Generate a flat list for the created segments, one segment per line.

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 807 808 809 810
@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
811 812
muxer according to the provided pattern. CSV escaping (according to
RFC4180) is applied if required.
813 814 815

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

817 818 819
A list file with the suffix @code{".csv"} or @code{".ext"} will
auto-select this format.

820
@samp{ext} is deprecated in favor or @samp{csv}.
821

822 823 824 825 826 827 828
@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.

829
@item m3u8
830 831
Generate an extended M3U8 file, version 3, compliant with
@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 835
@end table

836
If not specified the type is guessed from the list file name suffix.
837

838
@item segment_time @var{time}
839 840 841 842 843 844 845
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.
846

847 848
@item segment_time_delta @var{delta}
Specify the accuracy time when selecting the start time for a
849
segment, expressed as a duration specification. Default value is "0".
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

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
866
1/(2*@var{frame_rate}) should address the worst case mismatch between
867 868
the specified time and the time set by @var{force_key_frames}.

869 870
@item segment_times @var{times}
Specify a list of split points. @var{times} contains a list of comma
871 872
separated duration specifications, in increasing order. See also
the @option{segment_time} option.
873

874 875 876 877 878 879 880 881
@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.

882 883
@item segment_wrap @var{limit}
Wrap around segment index once it reaches @var{limit}.
884

885 886 887
@item segment_start_number @var{number}
Set the sequence number of the first segment. Defaults to @code{0}.

888 889 890 891 892
@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.
893 894 895 896

@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.
897 898
@end table

899
@subsection Examples
900 901 902 903 904 905

@itemize
@item
To remux the content of file @file{in.mkv} to a list of segments
@file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
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 909
@end example

910 911 912 913
@item
As the example above, but segment the input file according to the split
points specified by the @var{segment_times} option:
@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 916
@end example

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 922
possible roundings operated when setting key frame times.
@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 926 927 928
@end example
In order to force key frames on the input file, transcoding is
required.

929 930
@item
Segment the input file by splitting the input file according to the
931
frame numbers sequence specified with the @option{segment_frames} option:
932 933 934 935
@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

936 937 938 939 940 941
@item
To convert the @file{in.mkv} to TS segments using the @code{libx264}
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
942 943 944 945 946 947 948 949

@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
950 951
@end itemize

952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
@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
967 968
escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
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 972
@var{key}=@var{value} pairs separated by ':', between square brackets. If
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 976 977 978 979 980 981 982
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
983 984 985 986 987 988
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
989 990 991
bistream filters will be applied to all streams in the output.

Several bitstream filters can be specified, separated by ",".
992 993 994 995 996

@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.
997 998
@end table

999 1000
@subsection Examples

1001 1002 1003
@itemize
@item
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 1008 1009
  "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
@end example

1010 1011
@item
Use @command{ffmpeg} to encode the input, and send the output
1012 1013 1014 1015 1016 1017 1018 1019 1020
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
1021 1022 1023 1024 1025 1026 1027 1028 1029

@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
1030
@end itemize
1031

1032 1033 1034 1035
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.

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