ffmpeg.texi 79 KB
Newer Older
1
\input texinfo @c -*- texinfo -*-
2
@documentencoding UTF-8
3

4
@settitle ffmpeg Documentation
5
@titlepage
6
@center @titlefont{ffmpeg Documentation}
7 8
@end titlepage

9 10 11 12
@top

@contents

13 14
@chapter Synopsis

15
ffmpeg [@var{global_options}] @{[@var{input_file_options}] -i @file{input_url}@} ... @{[@var{output_file_options}] @file{output_url}@} ...
16

17 18
@chapter Description
@c man begin DESCRIPTION
19

20
@command{ffmpeg} is a very fast video and audio converter that can also grab from
21 22
a live audio/video source. It can also convert between arbitrary sample
rates and resize video on the fly with a high quality polyphase filter.
23

24
@command{ffmpeg} reads from an arbitrary number of input "files" (which can be regular
Michael Niedermayer's avatar
Michael Niedermayer committed
25 26
files, pipes, network streams, grabbing devices, etc.), specified by the
@code{-i} option, and writes to an arbitrary number of output "files", which are
27 28
specified by a plain output url. Anything found on the command line which
cannot be interpreted as an option is considered to be an output url.
Michael Niedermayer's avatar
Michael Niedermayer committed
29

30
Each input or output url can, in principle, contain any number of streams of
31 32 33 34
different types (video/audio/subtitle/attachment/data). The allowed number and/or
types of streams may be limited by the container format. Selecting which
streams from which inputs will go into which output is either done automatically
or with the @code{-map} option (see the Stream selection chapter).
Michael Niedermayer's avatar
Michael Niedermayer committed
35 36

To refer to input files in options, you must use their indices (0-based). E.g.
37
the first input file is @code{0}, the second is @code{1}, etc. Similarly, streams
Michael Niedermayer's avatar
Michael Niedermayer committed
38
within a file are referred to by their indices. E.g. @code{2:3} refers to the
39
fourth stream in the third input file. Also see the Stream specifiers chapter.
Michael Niedermayer's avatar
Michael Niedermayer committed
40

41 42 43 44
As a general rule, options are applied to the next specified
file. Therefore, order is important, and you can have the same
option on the command line multiple times. Each occurrence is
then applied to the next input or output file.
45 46
Exceptions from this rule are the global options (e.g. verbosity level),
which should be specified first.
47

Michael Niedermayer's avatar
Michael Niedermayer committed
48 49 50 51
Do not mix input and output files -- first specify all input files, then all
output files. Also do not mix options which belong to different files. All
options apply ONLY to the next input or output file and are reset between files.

52 53
@itemize
@item
54
To set the video bitrate of the output file to 64 kbit/s:
55
@example
rogerdpack's avatar
rogerdpack committed
56
ffmpeg -i input.avi -b:v 64k -bufsize 64k output.avi
57 58
@end example

59 60
@item
To force the frame rate of the output file to 24 fps:
61 62 63 64
@example
ffmpeg -i input.avi -r 24 output.avi
@end example

65 66
@item
To force the frame rate of the input file (valid for raw formats only)
67 68 69 70
to 1 fps and the frame rate of the output file to 24 fps:
@example
ffmpeg -r 1 -i input.m2v -r 24 output.avi
@end example
71
@end itemize
72 73 74 75 76

The format option may be needed for raw input files.

@c man end DESCRIPTION

77 78 79
@chapter Detailed description
@c man begin DETAILED DESCRIPTION

80
The transcoding process in @command{ffmpeg} for each output can be described by
81 82
the following diagram:

83
@verbatim
84 85 86 87 88 89 90 91 92 93
 _______              ______________
|       |            |              |
| input |  demuxer   | encoded data |   decoder
| file  | ---------> | packets      | -----+
|_______|            |______________|      |
                                           v
                                       _________
                                      |         |
                                      | decoded |
                                      | frames  |
94 95
                                      |_________|
 ________             ______________       |
96 97 98 99 100
|        |           |              |      |
| output | <-------- | encoded data | <----+
| file   |   muxer   | packets      |   encoder
|________|           |______________|

101

102
@end verbatim
103

104
@command{ffmpeg} calls the libavformat library (containing demuxers) to read
105
input files and get packets containing encoded data from them. When there are
106
multiple input files, @command{ffmpeg} tries to keep them synchronized by
107 108 109 110 111
tracking lowest timestamp on any active input stream.

Encoded packets are then passed to the decoder (unless streamcopy is selected
for the stream, see further for a description). The decoder produces
uncompressed frames (raw video/PCM audio/...) which can be processed further by
112 113
filtering (see next section). After filtering, the frames are passed to the
encoder, which encodes them and outputs encoded packets. Finally those are
114 115 116
passed to the muxer, which writes the encoded packets to the output file.

@section Filtering
117
Before encoding, @command{ffmpeg} can process raw audio and video frames using
118
filters from the libavfilter library. Several chained filters form a filter
119
graph. @command{ffmpeg} distinguishes between two types of filtergraphs:
120 121 122 123 124 125 126
simple and complex.

@subsection Simple filtergraphs
Simple filtergraphs are those that have exactly one input and output, both of
the same type. In the above diagram they can be represented by simply inserting
an additional step between decoding and encoding:

127
@verbatim
128 129 130
 _________                        ______________
|         |                      |              |
| decoded |                      | encoded data |
131 132
| frames  |\                   _ | packets      |
|_________| \                  /||______________|
133
             \   __________   /
134 135
  simple     _\||          | /  encoder
  filtergraph   | filtered |/
136 137
                | frames   |
                |__________|
138

139
@end verbatim
140 141 142 143 144

Simple filtergraphs are configured with the per-stream @option{-filter} option
(with @option{-vf} and @option{-af} aliases for video and audio respectively).
A simple filtergraph for video can look for example like this:

145
@verbatim
146 147 148 149
 _______        _____________        _______        ________
|       |      |             |      |       |      |        |
| input | ---> | deinterlace | ---> | scale | ---> | output |
|_______|      |_____________|      |_______|      |________|
150

151
@end verbatim
152 153 154 155 156 157 158 159

Note that some filters change frame properties but not frame contents. E.g. the
@code{fps} filter in the example above changes number of frames, but does not
touch the frame contents. Another example is the @code{setpts} filter, which
only sets timestamps and otherwise passes the frames unchanged.

@subsection Complex filtergraphs
Complex filtergraphs are those which cannot be described as simply a linear
160
processing chain applied to one stream. This is the case, for example, when the graph has
161 162 163
more than one input and/or output, or when output stream type is different from
input. They can be represented with the following diagram:

164
@verbatim
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
 _________
|         |
| input 0 |\                    __________
|_________| \                  |          |
             \   _________    /| output 0 |
              \ |         |  / |__________|
 _________     \| complex | /
|         |     |         |/
| input 1 |---->| filter  |\
|_________|     |         | \   __________
               /| graph   |  \ |          |
              / |         |   \| output 1 |
 _________   /  |_________|    |__________|
|         | /
| input 2 |/
|_________|

182
@end verbatim
183 184

Complex filtergraphs are configured with the @option{-filter_complex} option.
185
Note that this option is global, since a complex filtergraph, by its nature,
186 187
cannot be unambiguously associated with a single stream or file.

188 189
The @option{-lavfi} option is equivalent to @option{-filter_complex}.

190 191 192 193 194 195
A trivial example of a complex filtergraph is the @code{overlay} filter, which
has two video inputs and one video output, containing one video overlaid on top
of the other. Its audio counterpart is the @code{amix} filter.

@section Stream copy
Stream copy is a mode selected by supplying the @code{copy} parameter to the
196
@option{-codec} option. It makes @command{ffmpeg} omit the decoding and encoding
197 198
step for the specified stream, so it does only demuxing and muxing. It is useful
for changing the container format or modifying container-level metadata. The
199
diagram above will, in this case, simplify to this:
200

201
@verbatim
202 203 204 205 206 207
 _______              ______________            ________
|       |            |              |          |        |
| input |  demuxer   | encoded data |  muxer   | output |
| file  | ---------> | packets      | -------> | file   |
|_______|            |______________|          |________|

208
@end verbatim
209 210

Since there is no decoding or encoding, it is very fast and there is no quality
211
loss. However, it might not work in some cases because of many factors. Applying
212 213 214 215
filters is obviously also impossible, since filters work on uncompressed data.

@c man end DETAILED DESCRIPTION

216 217 218
@chapter Stream selection
@c man begin STREAM SELECTION

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 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 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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 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
@command{ffmpeg} provides the @code{-map} option for manual control of stream selection in each
output file. Users can skip @code{-map} and let ffmpeg perform automatic stream selection as
described below. The @code{-vn / -an / -sn / -dn} options can be used to skip inclusion of
video, audio, subtitle and data streams respectively, whether manually mapped or automatically
selected, except for those streams which are outputs of complex filtergraphs.

@section Description
The sub-sections that follow describe the various rules that are involved in stream selection.
The examples that follow next show how these rules are applied in practice.

While every effort is made to accurately reflect the behavior of the program, FFmpeg is under
continuous development and the code may have changed since the time of this writing.

@subsection Automatic stream selection

In the absence of any map options for a particular output file, ffmpeg inspects the output
format to check which type of streams can be included in it, viz. video, audio and/or
subtitles. For each acceptable stream type, ffmpeg will pick one stream, when available,
from among all the inputs.

It will select that stream based upon the following criteria:
@itemize
@item
for video, it is the stream with the highest resolution,
@item
for audio, it is the stream with the most channels,
@item
for subtitles, it is the first subtitle stream found but there's a caveat.
The output format's default subtitle encoder can be either text-based or image-based,
and only a subtitle stream of the same type will be chosen.
@end itemize

In the case where several streams of the same type rate equally, the stream with the lowest
index is chosen.

Data or attachment streams are not automatically selected and can only be included
using @code{-map}.
@subsection Manual stream selection

When @code{-map} is used, only user-mapped streams are included in that output file,
with one possible exception for filtergraph outputs described below.

@subsection Complex filtergraphs

If there are any complex filtergraph output streams with unlabeled pads, they will be added
to the first output file. This will lead to a fatal error if the stream type is not supported
by the output format. In the absence of the map option, the inclusion of these streams leads
to the automatic stream selection of their types being skipped. If map options are present,
these filtergraph streams are included in addition to the mapped streams.

Complex filtergraph output streams with labeled pads must be mapped once and exactly once.

@subsection Stream handling

Stream handling is independent of stream selection, with an exception for subtitles described
below. Stream handling is set via the @code{-codec} option addressed to streams within a
specific @emph{output} file. In particular, codec options are applied by ffmpeg after the
stream selection process and thus do not influence the latter. If no @code{-codec} option is
specified for a stream type, ffmpeg will select the default encoder registered by the output
file muxer.

An exception exists for subtitles. If a subtitle encoder is specified for an output file, the
first subtitle stream found of any type, text or image, will be included. ffmpeg does not validate
if the specified encoder can convert the selected stream or if the converted stream is acceptable
within the output format. This applies generally as well: when the user sets an encoder manually,
the stream selection process cannot check if the encoded stream can be muxed into the output file.
If it cannot, ffmpeg will abort and @emph{all} output files will fail to be processed.

@section Examples

The following examples illustrate the behavior, quirks and limitations of ffmpeg's stream
selection methods.

They assume the following three input files.

@verbatim

input file 'A.avi'
      stream 0: video 640x360
      stream 1: audio 2 channels

input file 'B.mp4'
      stream 0: video 1920x1080
      stream 1: audio 2 channels
      stream 2: subtitles (text)
      stream 3: audio 5.1 channels
      stream 4: subtitles (text)

input file 'C.mkv'
      stream 0: video 1280x720
      stream 1: audio 2 channels
      stream 2: subtitles (image)
@end verbatim

@subsubheading Example: automatic stream selection
@example
ffmpeg -i A.avi -i B.mp4 out1.mkv out2.wav -map 1:a -c:a copy out3.mov
@end example
There are three output files specified, and for the first two, no @code{-map} options
are set, so ffmpeg will select streams for these two files automatically.

@file{out1.mkv} is a Matroska container file and accepts video, audio and subtitle streams,
so ffmpeg will try to select one of each type.@*
For video, it will select @code{stream 0} from @file{B.mp4}, which has the highest
resolution among all the input video streams.@*
For audio, it will select @code{stream 3} from @file{B.mp4}, since it has the greatest
number of channels.@*
For subtitles, it will select @code{stream 2} from @file{B.mp4}, which is the first subtitle
stream from among @file{A.avi} and @file{B.mp4}.

@file{out2.wav} accepts only audio streams, so only @code{stream 3} from @file{B.mp4} is
selected.

For @file{out3.mov}, since a @code{-map} option is set, no automatic stream selection will
occur. The @code{-map 1:a} option will select all audio streams from the second input
@file{B.mp4}. No other streams will be included in this output file.

For the first two outputs, all included streams will be transcoded. The encoders chosen will
be the default ones registered by each output format, which may not match the codec of the
selected input streams.

For the third output, codec option for audio streams has been set
to @code{copy}, so no decoding-filtering-encoding operations will occur, or @emph{can} occur.
Packets of selected streams shall be conveyed from the input file and muxed within the output
file.

@subsubheading Example: automatic subtitles selection
@example
ffmpeg -i C.mkv out1.mkv -c:s dvdsub -an out2.mkv
@end example
Although @file{out1.mkv} is a Matroska container file which accepts subtitle streams, only a
video and audio stream shall be selected. The subtitle stream of @file{C.mkv} is image-based
and the default subtitle encoder of the Matroska muxer is text-based, so a transcode operation
for the subtitles is expected to fail and hence the stream isn't selected. However, in
@file{out2.mkv}, a subtitle encoder is specified in the command and so, the subtitle stream is
selected, in addition to the video stream. The presence of @code{-an} disables audio stream
selection for @file{out2.mkv}.

@subsubheading Example: unlabeled filtergraph outputs
@example
ffmpeg -i A.avi -i C.mkv -i B.mp4 -filter_complex "overlay" out1.mp4 out2.srt
@end example
A filtergraph is setup here using the @code{-filter_complex} option and consists of a single
video filter. The @code{overlay} filter requires exactly two video inputs, but none are
specified, so the first two available video streams are used, those of @file{A.avi} and
@file{C.mkv}. The output pad of the filter has no label and so is sent to the first output file
@file{out1.mp4}. Due to this, automatic selection of the video stream is skipped, which would
have selected the stream in @file{B.mp4}. The audio stream with most channels viz. @code{stream 3}
in @file{B.mp4}, is chosen automatically. No subtitle stream is chosen however, since the MP4
format has no default subtitle encoder registered, and the user hasn't specified a subtitle encoder.

The 2nd output file, @file{out2.srt}, only accepts text-based subtitle streams. So, even though
the first subtitle stream available belongs to @file{C.mkv}, it is image-based and hence skipped.
The selected stream, @code{stream 2} in @file{B.mp4}, is the first text-based subtitle stream.

@subsubheading Example: labeled filtergraph outputs
@example
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0[outv];overlay;aresample" \
       -map '[outv]' -an        out1.mp4 \
                                out2.mkv \
       -map '[outv]' -map 1:a:0 out3.mkv
@end example

The above command will fail, as the output pad labelled @code{[outv]} has been mapped twice.
None of the output files shall be processed.

@example
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0[outv];overlay;aresample" \
       -an        out1.mp4 \
                  out2.mkv \
       -map 1:a:0 out3.mkv
@end example

This command above will also fail as the hue filter output has a label, @code{[outv]},
and hasn't been mapped anywhere.

The command should be modified as follows,
@example
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0,split=2[outv1][outv2];overlay;aresample" \
        -map '[outv1]' -an        out1.mp4 \
                                  out2.mkv \
        -map '[outv2]' -map 1:a:0 out3.mkv
@end example
The video stream from @file{B.mp4} is sent to the hue filter, whose output is cloned once using
the split filter, and both outputs labelled. Then a copy each is mapped to the first and third
output files.

The overlay filter, requiring two video inputs, uses the first two unused video streams. Those
are the streams from @file{A.avi} and @file{C.mkv}. The overlay output isn't labelled, so it is
sent to the first output file @file{out1.mp4}, regardless of the presence of the @code{-map} option.

The aresample filter is sent the first unused audio stream, that of @file{A.avi}. Since this filter
output is also unlabelled, it too is mapped to the first output file. The presence of @code{-an}
only suppresses automatic or manual stream selection of audio streams, not outputs sent from
filtergraphs. Both these mapped streams shall be ordered before the mapped stream in @file{out1.mp4}.

The video, audio and subtitle streams mapped to @code{out2.mkv} are entirely determined by
automatic stream selection.

@file{out3.mkv} consists of the cloned video output from the hue filter and the first audio
stream from @file{B.mp4}.
@*
421 422 423

@c man end STREAM SELECTION

424
@chapter Options
425
@c man begin OPTIONS
426

427
@include fftools-common-opts.texi
428

429 430
@section Main options

431
@table @option
432

433
@item -f @var{fmt} (@emph{input/output})
434
Force input or output file format. The format is normally auto detected for input
435
files and guessed from the file extension for output files, so this option is not
436
needed in most cases.
Fabrice Bellard's avatar
Fabrice Bellard committed
437

438 439
@item -i @var{url} (@emph{input})
input file url
440

441
@item -y (@emph{global})
442
Overwrite output files without asking.
443

444
@item -n (@emph{global})
445 446
Do not overwrite output files, and exit immediately if a specified
output file already exists.
447

448
@item -stream_loop @var{number} (@emph{input})
449 450
Set number of times input stream shall be looped. Loop 0 means no loop,
loop -1 means infinite loop.
451

452 453 454 455 456
@item -c[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
@itemx -codec[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
Select an encoder (when used before an output file) or a decoder (when used
before an input file) for one or more streams. @var{codec} is the name of a
decoder/encoder or a special value @code{copy} (output only) to indicate that
457
the stream is not to be re-encoded.
458 459 460 461 462 463 464 465 466 467 468 469 470 471

For example
@example
ffmpeg -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
@end example
encodes all video streams with libx264 and copies all audio streams.

For each stream, the last matching @code{c} option is applied, so
@example
ffmpeg -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
@end example
will copy all the streams except the second video, which will be encoded with
libx264, and the 138th audio, which will be encoded with libvorbis.

472 473 474 475
@item -t @var{duration} (@emph{input/output})
When used as an input option (before @code{-i}), limit the @var{duration} of
data read from the input file.

476
When used as an output option (before an output url), stop writing the
477 478
output after its duration reaches @var{duration}.

479 480
@var{duration} must be a time duration specification,
see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
481

482 483
-to and -t are mutually exclusive and -t has priority.

484 485
@item -to @var{position} (@emph{input/output})
Stop writing the output or reading the input at @var{position}.
486 487
@var{position} must be a time duration specification,
see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
488 489 490

-to and -t are mutually exclusive and -t has priority.

491
@item -fs @var{limit_size} (@emph{output})
492 493 494
Set the file size limit, expressed in bytes. No further chunk of bytes is written
after the limit is exceeded. The size of the output file is slightly more than the
requested file size.
495

496 497
@item -ss @var{position} (@emph{input/output})
When used as an input option (before @code{-i}), seeks in this input file to
498 499
@var{position}. Note that in most formats it is not possible to seek exactly,
so @command{ffmpeg} will seek to the closest seek point before @var{position}.
500 501 502 503 504
When transcoding and @option{-accurate_seek} is enabled (the default), this
extra segment between the seek point and @var{position} will be decoded and
discarded. When doing stream copy or when @option{-noaccurate_seek} is used, it
will be preserved.

505
When used as an output option (before an output url), decodes but discards
506
input until the timestamps reach @var{position}.
507

508 509
@var{position} must be a time duration specification,
see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
510

511
@item -sseof @var{position} (@emph{input})
512

513
Like the @code{-ss} option but relative to the "end of file". That is negative
514 515
values are earlier in the file, 0 is at EOF.

516
@item -itsoffset @var{offset} (@emph{input})
517
Set the input time offset.
518

519 520 521 522 523 524 525
@var{offset} must be a time duration specification,
see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.

The offset is added to the timestamps of the input files. Specifying
a positive offset means that the corresponding streams are delayed by
the time duration specified in @var{offset}.

526 527 528
@item -itsscale @var{scale} (@emph{input,per-stream})
Rescale input timestamps. @var{scale} should be a floating point number.

529
@item -timestamp @var{date} (@emph{output})
530
Set the recording timestamp in the container.
531

532
@var{date} must be a date specification,
533
see @ref{date syntax,,the Date section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
534

535
@item -metadata[:metadata_specifier] @var{key}=@var{value} (@emph{output,per-metadata})
Stefano Sabatini's avatar
Stefano Sabatini committed
536
Set a metadata key/value pair.
537

538
An optional @var{metadata_specifier} may be given to set metadata
539 540
on streams, chapters or programs. See @code{-map_metadata}
documentation for details.
541 542 543 544

This option overrides metadata set with @code{-map_metadata}. It is
also possible to delete metadata by using an empty value.

545
For example, for setting the title in the output file:
546
@example
547
ffmpeg -i in.avi -metadata title="my title" out.flv
548
@end example
549

Michael Niedermayer's avatar
Michael Niedermayer committed
550
To set the language of the first audio stream:
551
@example
552
ffmpeg -i INPUT -metadata:s:a:0 language=eng OUTPUT
553 554
@end example

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
@item -disposition[:stream_specifier] @var{value} (@emph{output,per-stream})
Sets the disposition for a stream.

This option overrides the disposition copied from the input stream. It is also
possible to delete the disposition by setting it to 0.

The following dispositions are recognized:
@table @option
@item default
@item dub
@item original
@item comment
@item lyrics
@item karaoke
@item forced
@item hearing_impaired
@item visual_impaired
@item clean_effects
573
@item attached_pic
574 575
@item captions
@item descriptions
576
@item dependent
577 578 579 580 581
@item metadata
@end table

For example, to make the second audio stream the default stream:
@example
582
ffmpeg -i in.mkv -c copy -disposition:a:1 default out.mkv
583 584 585 586 587
@end example

To make the second subtitle stream the default stream and remove the default
disposition from the first subtitle stream:
@example
588
ffmpeg -i in.mkv -c copy -disposition:s:0 0 -disposition:s:1 default out.mkv
589 590
@end example

591 592 593 594 595 596 597
To add an embedded cover/thumbnail:
@example
ffmpeg -i in.mp4 -i IMAGE -map 0 -map 1 -c copy -c:v:1 png -disposition:v:1 attached_pic out.mp4
@end example

Not all muxers support embedded thumbnails, and those who do, only support a few formats, like JPEG or PNG.

598
@item -program [title=@var{title}:][program_num=@var{program_num}:]st=@var{stream}[:st=@var{stream}...] (@emph{output})
599

600
Creates a program with the specified @var{title}, @var{program_num} and adds the specified
601 602
@var{stream}(s) to it.

603
@item -target @var{type} (@emph{output})
604 605 606 607
Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
@code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
@code{film-} to use the corresponding standard. All the format options
(bitrate, codecs, buffer sizes) are then set automatically. You can just type:
Fabrice Bellard's avatar
Fabrice Bellard committed
608 609 610 611 612

@example
ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
@end example

Diego Biurrun's avatar
Diego Biurrun committed
613 614
Nevertheless you can specify additional options as long as you know
they do not conflict with the standard, as in:
615 616 617 618 619

@example
ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
@end example

620 621 622 623 624 625 626
@item -dn (@emph{input/output})
As an input option, blocks all data streams of a file from being filtered or
being automatically selected or mapped for any output. See @code{-discard}
option to disable streams individually.

As an output option, disables data recording i.e. automatic selection or
mapping of any data stream. For full manual control see the @code{-map}
627 628
option.

629
@item -dframes @var{number} (@emph{output})
630 631
Set the number of data frames to output. This is an obsolete alias for
@code{-frames:d}, which you should use instead.
632

633 634
@item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
Stop writing to the stream after @var{framecount} frames.
635

636 637
@item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
@itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
638
Use fixed quality scale (VBR). The meaning of @var{q}/@var{qscale} is
639
codec-dependent.
640 641 642 643 644
If @var{qscale} is used without a @var{stream_specifier} then it applies only
to the video stream, this is to maintain compatibility with previous behavior
and as specifying the same codec specific value to 2 different codecs that is
audio and video generally is not what is intended when no stream_specifier is
used.
645

646
@anchor{filter_option}
647 648
@item -filter[:@var{stream_specifier}] @var{filtergraph} (@emph{output,per-stream})
Create the filtergraph specified by @var{filtergraph} and use it to
649 650
filter the stream.

651
@var{filtergraph} is a description of the filtergraph to apply to
652
the stream, and must have a single input and a single output of the
653
same type of the stream. In the filtergraph, the input is associated
654 655 656 657 658
to the label @code{in}, and the output to the label @code{out}. See
the ffmpeg-filters manual for more information about the filtergraph
syntax.

See the @ref{filter_complex_option,,-filter_complex option} if you
659
want to create filtergraphs with multiple inputs and/or outputs.
660

661 662 663 664 665
@item -filter_script[:@var{stream_specifier}] @var{filename} (@emph{output,per-stream})
This option is similar to @option{-filter}, the only difference is that its
argument is the name of the file from which a filtergraph description is to be
read.

666 667 668 669 670
@item -filter_threads @var{nb_threads} (@emph{global})
Defines how many threads are used to process a filter pipeline. Each pipeline
will produce a thread pool with this many threads available for parallel processing.
The default is the number of available CPUs.

Michael Niedermayer's avatar
Michael Niedermayer committed
671 672 673 674
@item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
Specify the preset for matching stream(s).

@item -stats (@emph{global})
675 676
Print encoding progress/statistics. It is on by default, to explicitly
disable it you need to specify @code{-nostats}.
Michael Niedermayer's avatar
Michael Niedermayer committed
677

678 679 680 681 682 683 684 685
@item -progress @var{url} (@emph{global})
Send program-friendly progress information to @var{url}.

Progress information is written approximately every second and at the end of
the encoding process. It is made of "@var{key}=@var{value}" lines. @var{key}
consists of only alphanumeric characters. The last key of a sequence of
progress information is always "progress".

686
@anchor{stdin option}
687 688
@item -stdin
Enable interaction on standard input. On by default unless standard input is
689 690
used as an input. To explicitly disable interaction you need to specify
@code{-nostdin}.
691

692 693 694 695
Disabling interaction on standard input is useful, for example, if
ffmpeg is in the background process group. Roughly the same result can
be achieved with @code{ffmpeg ... < /dev/null} but it requires a
shell.
696

697 698 699 700 701 702 703 704
@item -debug_ts (@emph{global})
Print timestamp information. It is off by default. This option is
mostly useful for testing and debugging purposes, and the output
format may change from one version to another, so it should not be
employed by portable scripts.

See also the option @code{-fdebug ts}.

Michael Niedermayer's avatar
Michael Niedermayer committed
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
@item -attach @var{filename} (@emph{output})
Add an attachment to the output file. This is supported by a few formats
like Matroska for e.g. fonts used in rendering subtitles. Attachments
are implemented as a specific type of stream, so this option will add
a new stream to the file. It is then possible to use per-stream options
on this stream in the usual way. Attachment streams created with this
option will be created after all the other streams (i.e. those created
with @code{-map} or automatic mappings).

Note that for Matroska you also have to set the mimetype metadata tag:
@example
ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
@end example
(assuming that the attachment stream will be third in the output file).

@item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
Extract the matching attachment stream into a file named @var{filename}. If
@var{filename} is empty, then the value of the @code{filename} metadata tag
will be used.

E.g. to extract the first attachment to a file named 'out.ttf':
@example
727
ffmpeg -dump_attachment:t:0 out.ttf -i INPUT
Michael Niedermayer's avatar
Michael Niedermayer committed
728 729 730
@end example
To extract all attachments to files determined by the @code{filename} tag:
@example
731
ffmpeg -dump_attachment:t "" -i INPUT
Michael Niedermayer's avatar
Michael Niedermayer committed
732 733 734 735 736
@end example

Technical note -- attachments are implemented as codec extradata, so this
option can actually be used to extract extradata from any stream, not just
attachments.
737

738 739 740
@item -noautorotate
Disable automatically rotating video based on file metadata.

741 742 743 744
@end table

@section Video Options

745
@table @option
746
@item -vframes @var{number} (@emph{output})
747 748
Set the number of video frames to output. This is an obsolete alias for
@code{-frames:v}, which you should use instead.
749
@item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
750 751 752 753
Set frame rate (Hz value, fraction or abbreviation).

As an input option, ignore any timestamps stored in the file and instead
generate timestamps assuming constant frame rate @var{fps}.
754 755 756
This is not the same as the @option{-framerate} option used for some input formats
like image2 or v4l2 (it used to be the same in older versions of FFmpeg).
If in doubt use @option{-framerate} instead of the input option @option{-r}.
757 758

As an output option, duplicate or drop input frames to achieve constant output
759
frame rate @var{fps}.
760

761
@item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
762 763 764 765 766 767 768 769 770 771
Set frame size.

As an input option, this is a shortcut for the @option{video_size} private
option, recognized by some demuxers for which the frame size is either not
stored in the file or is configurable -- e.g. raw video or video grabbers.

As an output option, this inserts the @code{scale} video filter to the
@emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
directly to insert it at the beginning or some other place.

772
The format is @samp{wxh} (default - same as source).
Fabrice Bellard's avatar
Fabrice Bellard committed
773

774
@item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
775 776 777 778 779 780 781
Set the video display aspect ratio specified by @var{aspect}.

@var{aspect} can be a floating point number string, or a string of the
form @var{num}:@var{den}, where @var{num} and @var{den} are the
numerator and denominator of the aspect ratio. For example "4:3",
"16:9", "1.3333", and "1.7777" are valid argument values.

782 783 784 785
If used together with @option{-vcodec copy}, it will affect the aspect ratio
stored at container level, but not the aspect ratio stored in encoded
frames, if it exists.

786 787 788 789 790 791 792
@item -vn (@emph{input/output})
As an input option, blocks all video streams of a file from being filtered or
being automatically selected or mapped for any output. See @code{-discard}
option to disable streams individually.

As an output option, disables video recording i.e. automatic selection or
mapping of any video stream. For full manual control see the @code{-map}
793
option.
794

795 796 797
@item -vcodec @var{codec} (@emph{output})
Set the video codec. This is an alias for @code{-codec:v}.

798
@item -pass[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
799 800 801 802 803
Select the pass number (1 or 2). It is used to do two-pass
video encoding. The statistics of the video are recorded in the first
pass into a log file (see also the option -passlogfile),
and in the second pass that log file is used to generate the video
at the exact requested bitrate.
804 805 806
On pass 1, you may just deactivate audio and set output to null,
examples for Windows and Unix:
@example
807 808
ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
809
@end example
810

811
@item -passlogfile[:@var{stream_specifier}] @var{prefix} (@emph{output,per-stream})
812 813 814
Set two-pass log file name prefix to @var{prefix}, the default file name
prefix is ``ffmpeg2pass''. The complete file name will be
@file{PREFIX-N.log}, where N is a number specific to the output
815
stream
816

817 818
@item -vf @var{filtergraph} (@emph{output})
Create the filtergraph specified by @var{filtergraph} and use it to
819
filter the stream.
820

821
This is an alias for @code{-filter:v}, see the @ref{filter_option,,-filter option}.
822 823
@end table

824
@section Advanced Video options
825

826
@table @option
827 828
@item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
Set pixel format. Use @code{-pix_fmts} to show all the supported
829
pixel formats.
830 831 832 833
If the selected pixel format can not be selected, ffmpeg will print a
warning and select the best pixel format supported by the encoder.
If @var{pix_fmt} is prefixed by a @code{+}, ffmpeg will exit with an error
if the requested pixel format can not be selected, and automatic conversions
834
inside filtergraphs are disabled.
835 836 837
If @var{pix_fmt} is a single @code{+}, ffmpeg selects the same pixel format
as the input (or graph output) and automatic conversions are disabled.

838
@item -sws_flags @var{flags} (@emph{input/output})
839
Set SwScaler flags.
Stefano Sabatini's avatar
Stefano Sabatini committed
840

841
@item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
842
Rate control override for specific intervals, formatted as "int,int,int"
843 844 845
list separated with slashes. Two first values are the beginning and
end frame numbers, last one is quantizer to use if positive, or quality
factor if negative.
Fabrice Bellard's avatar
Fabrice Bellard committed
846

847
@item -ilme
Diego Biurrun's avatar
Diego Biurrun committed
848 849 850 851 852
Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
Use this option if your input file is interlaced and you want
to keep the interlaced format for minimum losses.
The alternative is to deinterlace the input stream with
@option{-deinterlace}, but deinterlacing introduces losses.
Fabrice Bellard's avatar
Fabrice Bellard committed
853
@item -psnr
Diego Biurrun's avatar
Diego Biurrun committed
854
Calculate PSNR of compressed frames.
Fabrice Bellard's avatar
Fabrice Bellard committed
855
@item -vstats
Diego Biurrun's avatar
Diego Biurrun committed
856
Dump video coding statistics to @file{vstats_HHMMSS.log}.
857
@item -vstats_file @var{file}
858
Dump video coding statistics to @var{file}.
859
@item -vstats_version @var{file}
860 861 862
Specifies which version of the vstats format to use. Default is 2.

version = 1 :
863 864

@code{frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s}
865 866 867 868

version > 1:

@code{out= %2d st= %2d frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s}
869
@item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
870
top=1/bottom=0/auto=-1 field first
871
@item -dc @var{precision}
872
Intra_dc_precision.
873 874 875 876
@item -vtag @var{fourcc/tag} (@emph{output})
Force video tag/fourcc. This is an alias for @code{-tag:v}.
@item -qphist (@emph{global})
Show QP histogram
877
@item -vbsf @var{bitstream_filter}
878
Deprecated see -bsf
879

880
@item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
881
@item -force_key_frames[:@var{stream_specifier}] expr:@var{expr} (@emph{output,per-stream})
882
@item -force_key_frames[:@var{stream_specifier}] source (@emph{output,per-stream})
883

884 885 886 887 888 889 890 891 892 893 894
@var{force_key_frames} can take arguments of the following form:

@table @option

@item @var{time}[,@var{time}...]
If the argument consists of timestamps, ffmpeg will round the specified times to the nearest
output timestamp as per the encoder time base and force a keyframe at the first frame having
timestamp equal or greater than the computed timestamp. Note that if the encoder time base is too
coarse, then the keyframes may be forced on frames with timestamps lower than the specified time.
The default encoder time base is the inverse of the output framerate but may be set otherwise
via @code{-enc_time_base}.
895

896 897 898
If one of the times is "@code{chapters}[@var{delta}]", it is expanded into
the time of the beginning of all chapters in the file, shifted by
@var{delta}, expressed as a time in seconds.
899 900
This option can be useful to ensure that a seek point is present at a
chapter mark or any other designated place in the output file.
901 902 903 904 905 906

For example, to insert a key frame at 5 minutes, plus key frames 0.1 second
before the beginning of every chapter:
@example
-force_key_frames 0:05:00,chapters-0.1
@end example
Michael Niedermayer's avatar
Michael Niedermayer committed
907

908 909 910 911 912
@item expr:@var{expr}
If the argument is prefixed with @code{expr:}, the string @var{expr}
is interpreted like an expression and is evaluated for each frame. A
key frame is forced in case the evaluation is non-zero.

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
The expression in @var{expr} can contain the following constants:
@table @option
@item n
the number of current processed frame, starting from 0
@item n_forced
the number of forced frames
@item prev_forced_n
the number of the previous forced frame, it is @code{NAN} when no
keyframe was forced yet
@item prev_forced_t
the time of the previous forced frame, it is @code{NAN} when no
keyframe was forced yet
@item t
the time of the current processed frame
@end table

For example to force a key frame every 5 seconds, you can specify:
@example
-force_key_frames expr:gte(t,n_forced*5)
@end example

To force a key frame 5 seconds after the time of the last forced one,
starting from second 13:
@example
-force_key_frames expr:if(isnan(prev_forced_t),gte(t,13),gte(t,prev_forced_t+5))
@end example

940 941 942 943 944 945
@item source
If the argument is @code{source}, ffmpeg will force a key frame if
the current frame being encoded is marked as a key frame in its source.

@end table

946 947 948 949
Note that forcing too many keyframes is very harmful for the lookahead
algorithms of certain encoders: using fixed-GOP options or similar
would be more efficient.

Michael Niedermayer's avatar
Michael Niedermayer committed
950 951 952
@item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
When doing stream copy, copy also non-key frames found at the
beginning.
953

954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
@item -init_hw_device @var{type}[=@var{name}][:@var{device}[,@var{key=value}...]]
Initialise a new hardware device of type @var{type} called @var{name}, using the
given device parameters.
If no name is specified it will receive a default name of the form "@var{type}%d".

The meaning of @var{device} and the following arguments depends on the
device type:
@table @option

@item cuda
@var{device} is the number of the CUDA device.

@item dxva2
@var{device} is the number of the Direct3D 9 display adapter.

@item vaapi
@var{device} is either an X11 display name or a DRM render node.
If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY})
and then the first DRM render node (@emph{/dev/dri/renderD128}).

@item vdpau
@var{device} is an X11 display name.
If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY}).

@item qsv
@var{device} selects a value in @samp{MFX_IMPL_*}. Allowed values are:
@table @option
@item auto
@item sw
@item hw
@item auto_any
@item hw_any
@item hw2
@item hw3
@item hw4
@end table
If not specified, @samp{auto_any} is used.
(Note that it may be easier to achieve the desired result for QSV by creating the
platform-appropriate subdevice (@samp{dxva2} or @samp{vaapi}) and then deriving a
QSV device from that.)

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
@item opencl
@var{device} selects the platform and device as @emph{platform_index.device_index}.

The set of devices can also be filtered using the key-value pairs to find only
devices matching particular platform or device strings.

The strings usable as filters are:
@table @option
@item platform_profile
@item platform_version
@item platform_name
@item platform_vendor
@item platform_extensions
@item device_name
@item device_vendor
@item driver_version
@item device_version
@item device_profile
@item device_extensions
@item device_type
@end table

The indices and filters must together uniquely select a device.

Examples:
@table @emph
@item -init_hw_device opencl:0.1
Choose the second device on the first platform.

@item -init_hw_device opencl:,device_name=Foo9000
Choose the device with a name containing the string @emph{Foo9000}.

@item -init_hw_device opencl:1,device_type=gpu,device_extensions=cl_khr_fp16
Choose the GPU device on the second platform supporting the @emph{cl_khr_fp16}
extension.
@end table

1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
@item vulkan
If @var{device} is an integer, it selects the device by its index in a
system-dependent list of devices.  If @var{device} is any other string, it
selects the first device with a name containing that string as a substring.

Examples:
@table @emph
@item -init_hw_device vulkan:1
Choose the second device on the system.

@item -init_hw_device vulkan:RADV
Choose the first device with a name containing the string @emph{RADV}.
@end table

1046 1047 1048 1049 1050 1051 1052 1053 1054
@end table

@item -init_hw_device @var{type}[=@var{name}]@@@var{source}
Initialise a new hardware device of type @var{type} called @var{name},
deriving it from the existing device with the name @var{source}.

@item -init_hw_device list
List all hardware device types supported in this build of ffmpeg.

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
@item -filter_hw_device @var{name}
Pass the hardware device called @var{name} to all filters in any filter graph.
This can be used to set the device to upload to with the @code{hwupload} filter,
or the device to map to with the @code{hwmap} filter.  Other filters may also
make use of this parameter when they require a hardware device.  Note that this
is typically only required when the input is not already in hardware frames -
when it is, filters will derive the device they require from the context of the
frames they receive as input.

This is a global setting, so all filters will receive the same device.

1066 1067 1068 1069 1070 1071 1072 1073 1074
@item -hwaccel[:@var{stream_specifier}] @var{hwaccel} (@emph{input,per-stream})
Use hardware acceleration to decode the matching stream(s). The allowed values
of @var{hwaccel} are:
@table @option
@item none
Do not use any hardware acceleration (the default).

@item auto
Automatically select the hardware acceleration method.
1075 1076 1077

@item vdpau
Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration.
1078 1079 1080

@item dxva2
Use DXVA2 (DirectX Video Acceleration) hardware acceleration.
1081

1082 1083 1084
@item vaapi
Use VAAPI (Video Acceleration API) hardware acceleration.

1085 1086 1087 1088 1089 1090 1091 1092 1093
@item qsv
Use the Intel QuickSync Video acceleration for video transcoding.

Unlike most other values, this option does not enable accelerated decoding (that
is used automatically whenever a qsv decoder is selected), but accelerated
transcoding, without copying the frames into the system memory.

For it to work, both the decoder and the encoder must support QSV acceleration
and no filters must be used.
1094 1095 1096 1097 1098 1099
@end table

This option has no effect if the selected hwaccel is not available or not
supported by the chosen decoder.

Note that most acceleration methods are intended for playback and will not be
1100
faster than software decoding on modern CPUs. Additionally, @command{ffmpeg}
1101 1102 1103 1104 1105 1106 1107
will usually need to copy the decoded frames from the GPU memory into the system
memory, resulting in further performance loss. This option is thus mainly
useful for testing.

@item -hwaccel_device[:@var{stream_specifier}] @var{hwaccel_device} (@emph{input,per-stream})
Select a device to use for hardware acceleration.

1108 1109 1110 1111 1112
This option only makes sense when the @option{-hwaccel} option is also specified.
It can either refer to an existing device created with @option{-init_hw_device}
by name, or it can create a new device as if
@samp{-init_hw_device} @var{type}:@var{hwaccel_device}
were called immediately before.
1113 1114 1115 1116

@item -hwaccels
List all hardware acceleration methods supported in this build of ffmpeg.

Fabrice Bellard's avatar
Fabrice Bellard committed
1117 1118 1119 1120 1121
@end table

@section Audio Options

@table @option
1122
@item -aframes @var{number} (@emph{output})
1123 1124
Set the number of audio frames to output. This is an obsolete alias for
@code{-frames:a}, which you should use instead.
1125
@item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
1126 1127 1128 1129
Set the audio sampling frequency. For output streams it is set by
default to the frequency of the corresponding input stream. For input
streams this option only makes sense for audio grabbing devices and raw
demuxers and is mapped to the corresponding demuxer options.
1130 1131 1132
@item -aq @var{q} (@emph{output})
Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
@item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
1133 1134 1135 1136
Set the number of audio channels. For output streams it is set by
default to the number of input audio channels. For input streams
this option only makes sense for audio grabbing devices and raw demuxers
and is mapped to the corresponding demuxer options.
1137 1138 1139 1140 1141 1142 1143
@item -an (@emph{input/output})
As an input option, blocks all audio streams of a file from being filtered or
being automatically selected or mapped for any output. See @code{-discard}
option to disable streams individually.

As an output option, disables audio recording i.e. automatic selection or
mapping of any audio stream. For full manual control see the @code{-map}
1144
option.
1145 1146 1147
@item -acodec @var{codec} (@emph{input/output})
Set the audio codec. This is an alias for @code{-codec:a}.
@item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
Michael Niedermayer's avatar
Michael Niedermayer committed
1148
Set the audio sample format. Use @code{-sample_fmts} to get a list
1149
of supported sample formats.
1150

1151 1152
@item -af @var{filtergraph} (@emph{output})
Create the filtergraph specified by @var{filtergraph} and use it to
1153 1154 1155
filter the stream.

This is an alias for @code{-filter:a}, see the @ref{filter_option,,-filter option}.
1156 1157
@end table

1158
@section Advanced Audio options
1159 1160

@table @option
1161 1162
@item -atag @var{fourcc/tag} (@emph{output})
Force audio tag/fourcc. This is an alias for @code{-tag:a}.
1163
@item -absf @var{bitstream_filter}
1164
Deprecated, see -bsf
1165 1166 1167 1168 1169 1170
@item -guess_layout_max @var{channels} (@emph{input,per-stream})
If some input channel layout is not known, try to guess only if it
corresponds to at most the specified number of channels. For example, 2
tells to @command{ffmpeg} to recognize 1 channel as mono and 2 channels as
stereo but not 6 channels as 5.1. The default is to always try to guess. Use
0 to disable all guessing.
1171 1172
@end table

1173
@section Subtitle options
1174 1175

@table @option
1176 1177
@item -scodec @var{codec} (@emph{input/output})
Set the subtitle codec. This is an alias for @code{-codec:s}.
1178 1179 1180 1181 1182 1183 1184
@item -sn (@emph{input/output})
As an input option, blocks all subtitle streams of a file from being filtered or
being automatically selected or mapped for any output. See @code{-discard}
option to disable streams individually.

As an output option, disables subtitle recording i.e. automatic selection or
mapping of any subtitle stream. For full manual control see the @code{-map}
1185
option.
1186
@item -sbsf @var{bitstream_filter}
1187
Deprecated, see -bsf
Fabrice Bellard's avatar
Fabrice Bellard committed
1188 1189
@end table

1190
@section Advanced Subtitle options
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206

@table @option

@item -fix_sub_duration
Fix subtitles durations. For each subtitle, wait for the next packet in the
same stream and adjust the duration of the first to avoid overlap. This is
necessary with some subtitles codecs, especially DVB subtitles, because the
duration in the original packet is only a rough estimate and the end is
actually marked by an empty subtitle frame. Failing to use this option when
necessary can result in exaggerated durations or muxing failures due to
non-monotonic timestamps.

Note that this option will delay the output of all data until the next
subtitle packet is decoded: it may increase memory consumption and latency a
lot.

1207 1208 1209
@item -canvas_size @var{size}
Set the size of the canvas used to render subtitles.

1210 1211
@end table

Fabrice Bellard's avatar
Fabrice Bellard committed
1212 1213 1214
@section Advanced options

@table @option
1215
@item -map [-]@var{input_file_id}[:@var{stream_specifier}][?][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
1216

1217
Designate one or more input streams as a source for the output file. Each input
1218 1219
stream is identified by the input file index @var{input_file_id} and
the input stream index @var{input_stream_id} within the input
1220 1221
file. Both indices start at 0. If specified,
@var{sync_file_id}:@var{stream_specifier} sets which input stream
1222 1223
is used as a presentation sync reference.

1224
The first @code{-map} option on the command line specifies the
1225 1226 1227
source for output stream 0, the second @code{-map} option specifies
the source for output stream 1, etc.

1228 1229 1230
A @code{-} character before the stream identifier creates a "negative" mapping.
It disables matching streams from already created mappings.

1231 1232 1233
A trailing @code{?} after the stream index will allow the map to be
optional: if the map matches no streams the map will be ignored instead
of failing. Note the map will still fail if an invalid input file index
Lou Logan's avatar
Lou Logan committed
1234
is used; such as if the map refers to a non-existent input.
1235

1236 1237 1238 1239
An alternative @var{[linklabel]} form will map outputs from complex filter
graphs (see the @option{-filter_complex} option) to the output file.
@var{linklabel} must correspond to a defined output link label in the graph.

1240 1241 1242 1243 1244
For example, to map ALL streams from the first input file to output
@example
ffmpeg -i INPUT -map 0 output
@end example

1245
For example, if you have two audio streams in the first input file,
1246 1247
these streams are identified by "0:0" and "0:1". You can use
@code{-map} to select which streams to place in an output file. For
1248 1249
example:
@example
1250
ffmpeg -i INPUT -map 0:1 out.wav
1251
@end example
1252
will map the input stream in @file{INPUT} identified by "0:1" to
1253 1254 1255
the (single) output stream in @file{out.wav}.

For example, to select the stream with index 2 from input file
1256 1257
@file{a.mov} (specified by the identifier "0:2"), and stream with
index 6 from input @file{b.mov} (specified by the identifier "1:6"),
1258 1259
and copy them to the output file @file{out.mov}:
@example
1260
ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
1261 1262
@end example

1263 1264 1265 1266
To select all video and the third audio stream from an input file:
@example
ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
@end example
1267

1268 1269 1270 1271
To map all the streams except the second audio, use negative mappings
@example
ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
@end example
1272

1273 1274 1275 1276 1277 1278 1279
To map the video and audio streams from the first input, and using the
trailing @code{?}, ignore the audio mapping if no audio streams exist in
the first input:
@example
ffmpeg -i INPUT -map 0:v -map 0:a? OUTPUT
@end example

1280 1281
To pick the English audio stream:
@example
Michael Niedermayer's avatar
Michael Niedermayer committed
1282
ffmpeg -i INPUT -map 0:m:language:eng OUTPUT
1283 1284
@end example

1285 1286
Note that using this option disables the default mappings for this output file.

1287 1288 1289 1290 1291 1292 1293 1294
@item -ignore_unknown
Ignore input streams with unknown type instead of failing if copying
such streams is attempted.

@item -copy_unknown
Allow input streams with unknown type to be copied instead of failing if copying
such streams is attempted.

1295
@item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][?][:@var{output_file_id}.@var{stream_specifier}]
1296
Map an audio channel from a given input to an output. If
1297
@var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
1298 1299 1300 1301 1302 1303
be mapped on all the audio streams.

Using "-1" instead of
@var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
channel.

1304 1305 1306 1307
A trailing @code{?} will allow the map_channel to be
optional: if the map_channel matches no channel the map_channel will be ignored instead
of failing.

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
For example, assuming @var{INPUT} is a stereo audio file, you can switch the
two audio channels with the following command:
@example
ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
@end example

If you want to mute the first channel and keep the second:
@example
ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
@end example

The order of the "-map_channel" option specifies the order of the channels in
the output stream. The output channel layout is guessed from the number of
channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
in combination of "-map_channel" makes the channel gain levels to be updated if
1323 1324
input and output channel layouts don't match (for instance two "-map_channel"
options and "-ac 6").
1325

1326 1327 1328
You can also extract each channel of an input to specific outputs; the following
command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
1329 1330 1331 1332
@example
ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
@end example

1333 1334
The following example splits the channels of a stereo input into two separate
streams, which are put into the same output file:
1335 1336 1337 1338
@example
ffmpeg -i stereo.wav -map 0:0 -map 0:0 -map_channel 0.0.0:0.0 -map_channel 0.0.1:0.1 -y out.ogg
@end example

1339 1340 1341 1342 1343
Note that currently each output stream can only contain channels from a single
input stream; you can't for example use "-map_channel" to pick multiple input
audio channels contained in different streams (from the same or different files)
and merge them into a single output stream. It is therefore not currently
possible, for example, to turn two separate mono streams into a single stereo
1344
stream. However splitting a stereo stream into two single channel mono streams
1345
is possible.
1346

1347 1348 1349
If you need this feature, a possible workaround is to use the @emph{amerge}
filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
mono audio streams into one single stereo channel audio stream (and keep the
1350
video stream), you can use the following command:
1351
@example
1352
ffmpeg -i input.mkv -filter_complex "[0:1] [0:2] amerge" -c:a pcm_s16le -c:v copy output.mkv
1353 1354
@end example

1355 1356 1357 1358 1359 1360 1361
To map the first two audio channels from the first input, and using the
trailing @code{?}, ignore the audio channel mapping if the first input is
mono instead of stereo:
@example
ffmpeg -i INPUT -map_channel 0.0.0 -map_channel 0.0.1? OUTPUT
@end example

Michael Niedermayer's avatar
Michael Niedermayer committed
1362
@item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
1363 1364
Set metadata information of the next output file from @var{infile}. Note that
those are file indices (zero-based), not filenames.
Michael Niedermayer's avatar
Michael Niedermayer committed
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
A metadata specifier can have the following forms:
@table @option
@item @var{g}
global metadata, i.e. metadata that applies to the whole file

@item @var{s}[:@var{stream_spec}]
per-stream metadata. @var{stream_spec} is a stream specifier as described
in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
matching stream is copied from. In an output metadata specifier, all matching
streams are copied to.

@item @var{c}:@var{chapter_index}
per-chapter metadata. @var{chapter_index} is the zero-based chapter index.

@item @var{p}:@var{program_index}
per-program metadata. @var{program_index} is the zero-based program index.
@end table
If metadata specifier is omitted, it defaults to global.
1384

1385
By default, global metadata is copied from the first input file,
1386 1387 1388 1389
per-stream and per-chapter metadata is copied along with streams/chapters. These
default mappings are disabled by creating any mapping of the relevant type. A negative
file index can be used to create a dummy mapping that just disables automatic copying.

1390 1391 1392
For example to copy metadata from the first stream of the input file to global metadata
of the output file:
@example
1393
ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
1394
@end example
Michael Niedermayer's avatar
Michael Niedermayer committed
1395 1396 1397 1398 1399 1400 1401 1402

To do the reverse, i.e. copy global metadata to all audio streams:
@example
ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
@end example
Note that simple @code{0} would work as well in this example, since global
metadata is assumed by default.

1403 1404 1405 1406 1407
@item -map_chapters @var{input_file_index} (@emph{output})
Copy chapters from input file with index @var{input_file_index} to the next
output file. If no chapter mapping is specified, then chapters are copied from
the first input file with at least one chapter. Use a negative file index to
disable any chapter copying.
1408

1409
@item -benchmark (@emph{global})
1410
Show benchmarking information at the end of an encode.
1411
Shows real, system and user time used and maximum memory consumption.
1412 1413
Maximum memory consumption is not supported on all systems,
it will usually display as 0 if not supported.
1414 1415
@item -benchmark_all (@emph{global})
Show benchmarking information during the encode.
1416
Shows real, system and user time used in various steps (audio/video encode/decode).
1417
@item -timelimit @var{duration} (@emph{global})
1418
Exit after ffmpeg has been running for @var{duration} seconds in CPU user time.
1419
@item -dump (@emph{global})
1420
Dump each input packet to stderr.
1421
@item -hex (@emph{global})
1422
When dumping packets, also dump the payload.
1423
@item -re (@emph{input})
1424
Read input at native frame rate. Mainly used to simulate a grab device,
1425 1426 1427
or live input stream (e.g. when reading from a file). Should not be used
with actual grab devices or live input streams (where it can cause packet
loss).
1428 1429
By default @command{ffmpeg} attempts to read the input(s) as fast as possible.
This option will slow down the reading of the input(s) to the native frame rate
1430
of the input(s). It is useful for real-time output (e.g. live streaming).
1431
@item -vsync @var{parameter}
1432
Video sync method.
Reimar Döffinger's avatar
Reimar Döffinger committed
1433 1434
For compatibility reasons old values can be specified as numbers.
Newly added values will have to be specified as strings always.
1435 1436

@table @option
1437
@item 0, passthrough
1438
Each frame is passed with its timestamp from the demuxer to the muxer.
1439
@item 1, cfr
1440
Frames will be duplicated and dropped to achieve exactly the requested
1441
constant frame rate.
1442
@item 2, vfr
1443 1444
Frames are passed through with their timestamp or dropped so as to
prevent 2 frames from having the same timestamp.
Reimar Döffinger's avatar
Reimar Döffinger committed
1445 1446 1447
@item drop
As passthrough but destroys all timestamps, making the muxer generate
fresh timestamps based on frame-rate.
1448
@item -1, auto
1449 1450 1451 1452
Chooses between 1 and 2 depending on muxer capabilities. This is the
default method.
@end table

1453 1454 1455 1456
Note that the timestamps may be further modified by the muxer, after this.
For example, in the case that the format option @option{avoid_negative_ts}
is enabled.

1457 1458 1459 1460
With -map you can select from which stream the timestamps should be
taken. You can leave either video or audio unchanged and sync the
remaining stream(s) to the unchanged one.

1461 1462 1463 1464 1465 1466 1467
@item -frame_drop_threshold @var{parameter}
Frame drop threshold, which specifies how much behind video frames can
be before they are dropped. In frame rate units, so 1.0 is one frame.
The default is -1.1. One possible usecase is to avoid framedrops in case
of noisy timestamps or to increase frame drop precision in case of exact
timestamps.

1468
@item -async @var{samples_per_second}
1469
Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
1470 1471 1472
the parameter is the maximum samples per second by which the audio is changed.
-async 1 is a special case where only the start of the audio stream is corrected
without any later correction.
1473 1474 1475 1476 1477

Note that the timestamps may be further modified by the muxer, after this.
For example, in the case that the format option @option{avoid_negative_ts}
is enabled.

1478
This option has been deprecated. Use the @code{aresample} audio filter instead.
1479

1480
@item -copyts
1481 1482 1483 1484 1485
Do not process input timestamps, but keep their values without trying
to sanitize them. In particular, do not remove the initial start time
offset value.

Note that, depending on the @option{vsync} option or on specific muxer
1486 1487
processing (e.g. in case the format option @option{avoid_negative_ts}
is enabled) the output timestamps may mismatch with the input
1488 1489
timestamps even when this option is selected.

1490 1491 1492 1493 1494 1495
@item -start_at_zero
When used with @option{copyts}, shift input timestamps so they start at zero.

This means that using e.g. @code{-ss 50} will make output timestamps start at
50 seconds, regardless of what timestamp the input file started at.

1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
@item -copytb @var{mode}
Specify how to set the encoder timebase when stream copying.  @var{mode} is an
integer numeric value, and can assume one of the following values:

@table @option
@item 1
Use the demuxer timebase.

The time base is copied to the output encoder from the corresponding input
demuxer. This is sometimes required to avoid non monotonically increasing
timestamps when copying video streams with variable frame rate.

@item 0
Use the decoder timebase.

The time base is copied to the output encoder from the corresponding input
decoder.

@item -1
Try to make the choice automatically, in order to generate a sane output.
@end table

Default value is -1.

1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
@item -enc_time_base[:@var{stream_specifier}] @var{timebase} (@emph{output,per-stream})
Set the encoder timebase. @var{timebase} is a floating point number,
and can assume one of the following values:

@table @option
@item 0
Assign a default value according to the media type.

For video - use 1/framerate, for audio - use 1/samplerate.

@item -1
Use the input stream timebase when possible.

If an input stream is not available, the default timebase will be used.

@item >0
Use the provided number as the timebase.

This field can be provided as a ratio of two integers (e.g. 1:24, 1:48000)
or as a floating point number (e.g. 0.04166, 2.0833e-5)
@end table

Default value is 0.

1544 1545
@item -bitexact (@emph{input/output})
Enable bitexact mode for (de)muxer and (de/en)coder
1546
@item -shortest (@emph{output})
1547 1548 1549
Finish encoding when the shortest input stream ends.
@item -dts_delta_threshold
Timestamp discontinuity delta threshold.
1550 1551 1552 1553
@item -dts_error_threshold @var{seconds}
Timestamp error delta threshold. This threshold use to discard crazy/damaged
timestamps and the default is 30 hours which is arbitrarily picked and quite
conservative.
1554
@item -muxdelay @var{seconds} (@emph{output})
1555
Set the maximum demux-decode delay.
1556
@item -muxpreload @var{seconds} (@emph{output})
1557
Set the initial demux-decode delay.
1558
@item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
1559 1560 1561 1562
Assign a new stream-id value to an output stream. This option should be
specified prior to the output filename to which it applies.
For the situation where multiple output files exist, a streamid
may be reassigned to a different value.
1563 1564 1565 1566

For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
an output mpegts file:
@example
1567
ffmpeg -i inurl -streamid 0:33 -streamid 1:36 out.ts
1568
@end example
1569 1570

@item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
1571
Set bitstream filters for matching streams. @var{bitstream_filters} is
1572 1573 1574
a comma-separated list of bitstream filters. Use the @code{-bsfs} option
to get the list of bitstream filters.
@example
1575
ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
1576 1577
@end example
@example
1578
ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
1579 1580
@end example

1581
@item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{input/output,per-stream})
1582
Force a tag/fourcc for matching streams.
1583 1584 1585 1586 1587 1588 1589

@item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
(or '.') for drop.
@example
ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
@end example
1590

1591
@anchor{filter_complex_option}
1592
@item -filter_complex @var{filtergraph} (@emph{global})
1593
Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1594 1595
outputs. For simple graphs -- those with one input and one output of the same
type -- see the @option{-filter} options. @var{filtergraph} is a description of
1596
the filtergraph, as described in the ``Filtergraph syntax'' section of the
1597
ffmpeg-filters manual.
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607

Input link labels must refer to input streams using the
@code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
uses). If @var{stream_specifier} matches multiple streams, the first one will be
used. An unlabeled input will be connected to the first unused input stream of
the matching type.

Output link labels are referred to with @option{-map}. Unlabeled outputs are
added to the first output file.

1608 1609 1610
Note that with this option it is possible to use only lavfi sources without
normal input files.

1611 1612
For example, to overlay an image over video
@example
1613
ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
'[out]' out.mkv
@end example
Here @code{[0:v]} refers to the first video stream in the first input file,
which is linked to the first (main) input of the overlay filter. Similarly the
first video stream in the second input is linked to the second (overlay) input
of overlay.

Assuming there is only one video stream in each input file, we can omit input
labels, so the above is equivalent to
@example
1624
ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
1625 1626 1627 1628 1629 1630
'[out]' out.mkv
@end example

Furthermore we can omit the output label and the single output from the filter
graph will be added to the output file automatically, so we can simply write
@example
1631
ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
1632
@end example
1633 1634 1635

To generate 5 seconds of pure red video using lavfi @code{color} source:
@example
1636
ffmpeg -filter_complex 'color=c=red' -t 5 out.mkv
1637
@end example
1638

1639 1640 1641 1642 1643
@item -filter_complex_threads @var{nb_threads} (@emph{global})
Defines how many threads are used to process a filter_complex graph.
Similar to filter_threads but used for @code{-filter_complex} graphs only.
The default is the number of available CPUs.

1644
@item -lavfi @var{filtergraph} (@emph{global})
1645
Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1646 1647
outputs. Equivalent to @option{-filter_complex}.

1648 1649 1650 1651 1652
@item -filter_complex_script @var{filename} (@emph{global})
This option is similar to @option{-filter_complex}, the only difference is that
its argument is the name of the file from which a complex filtergraph
description is to be read.

1653 1654 1655 1656 1657 1658
@item -accurate_seek (@emph{input})
This option enables or disables accurate seeking in input files with the
@option{-ss} option. It is enabled by default, so seeking is accurate when
transcoding. Use @option{-noaccurate_seek} to disable it, which may be useful
e.g. when copying some streams and transcoding the others.

1659 1660 1661 1662 1663 1664 1665
@item -seek_timestamp (@emph{input})
This option enables or disables seeking by timestamp in input files with the
@option{-ss} option. It is disabled by default. If enabled, the argument
to the @option{-ss} option is considered an actual timestamp, and is not
offset by the start time of the file. This matters only for files which do
not start from timestamp 0, such as transport streams.

1666
@item -thread_queue_size @var{size} (@emph{input})
1667 1668 1669 1670 1671
This option sets the maximum number of queued packets when reading from the
file or device. With low latency / high rate live streams, packets may be
discarded if they are not read in a timely manner; raising this value can
avoid it.

1672
@item -sdp_file @var{file} (@emph{global})
1673
Print sdp information for an output stream to @var{file}.
1674
This allows dumping sdp information when at least one output isn't an
1675
rtp stream. (Requires at least one of the output formats to be rtp).
1676

1677
@item -discard (@emph{input})
1678 1679 1680 1681
Allows discarding specific streams or frames from streams.
Any input stream can be fully discarded, using value @code{all} whereas
selective discarding of frames from a stream occurs at the demuxer
and is not supported by all demuxers.
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702

@table @option
@item none
Discard no frame.

@item default
Default, which discards no frames.

@item noref
Discard all non-reference frames.

@item bidir
Discard all bidirectional frames.

@item nokey
Discard all frames excepts keyframes.

@item all
Discard all frames.
@end table

1703 1704 1705 1706 1707 1708 1709 1710
@item -abort_on @var{flags} (@emph{global})
Stop and abort on various conditions. The following flags are available:

@table @option
@item empty_output
No packets were passed to the muxer, the output is empty.
@end table

1711 1712 1713
@item -xerror (@emph{global})
Stop and exit on error

1714
@item -max_muxing_queue_size @var{packets} (@emph{output,per-stream})
1715
When transcoding audio and/or video streams, ffmpeg will not begin writing into
1716 1717 1718 1719 1720 1721 1722
the output until it has one packet for each such stream. While waiting for that
to happen, packets for other streams are buffered. This option sets the size of
this buffer, in packets, for the matching output stream.

The default value of this option should be high enough for most uses, so only
touch this option if you are sure that you need it.

1723
@end table
Fabrice Bellard's avatar
Fabrice Bellard committed
1724

1725 1726
As a special exception, you can use a bitmap subtitle stream as input: it
will be converted into a video with the same size as the largest video in
1727
the file, or 720x576 if no video is present. Note that this is an
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
experimental and temporary solution. It will be removed once libavfilter has
proper support for subtitles.

For example, to hardcode subtitles on top of a DVB-T recording stored in
MPEG-TS format, delaying the subtitles by 1 second:
@example
ffmpeg -i input.ts -filter_complex \
  '[#0x2ef] setpts=PTS+1/TB [sub] ; [#0x2d0] [sub] overlay' \
  -sn -map '#0x2dc' output.mkv
@end example
(0x2d0, 0x2dc and 0x2ef are the MPEG-TS PIDs of respectively the video,
audio and subtitles streams; 0:0, 0:3 and 0:7 would have worked too)

1741 1742 1743 1744 1745
@section Preset files
A preset file contains a sequence of @var{option}=@var{value} pairs,
one for each line, specifying a sequence of options which would be
awkward to specify on the command line. Lines starting with the hash
('#') character are ignored and are used to provide comments. Check
1746
the @file{presets} directory in the FFmpeg source tree for examples.
1747

1748 1749 1750 1751
There are two types of preset files: ffpreset and avpreset files.

@subsection ffpreset files
ffpreset files are specified with the @code{vpre}, @code{apre},
1752 1753 1754 1755
@code{spre}, and @code{fpre} options. The @code{fpre} option takes the
filename of the preset instead of a preset name as input and can be
used for any kind of codec. For the @code{vpre}, @code{apre}, and
@code{spre} options, the options specified in a preset file are
1756 1757
applied to the currently selected codec of the same type as the preset
option.
1758

1759 1760 1761
The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
preset options identifies the preset file to use according to the
following rules:
1762 1763

First ffmpeg searches for a file named @var{arg}.ffpreset in the
1764 1765
directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
Gianluigi Tiesi's avatar
Gianluigi Tiesi committed
1766
or in a @file{ffpresets} folder along the executable on win32,
1767 1768
in that order. For example, if the argument is @code{libvpx-1080p}, it will
search for the file @file{libvpx-1080p.ffpreset}.
1769 1770 1771 1772 1773

If no such file is found, then ffmpeg will search for a file named
@var{codec_name}-@var{arg}.ffpreset in the above-mentioned
directories, where @var{codec_name} is the name of the codec to which
the preset file options will be applied. For example, if you select
1774 1775
the video codec with @code{-vcodec libvpx} and use @code{-vpre 1080p},
then it will search for the file @file{libvpx-1080p.ffpreset}.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795

@subsection avpreset files
avpreset files are specified with the @code{pre} option. They work similar to
ffpreset files, but they only allow encoder- specific options. Therefore, an
@var{option}=@var{value} pair specifying an encoder cannot be used.

When the @code{pre} option is specified, ffmpeg will look for files with the
suffix .avpreset in the directories @file{$AVCONV_DATADIR} (if set), and
@file{$HOME/.avconv}, and in the datadir defined at configuration time (usually
@file{PREFIX/share/ffmpeg}), in that order.

First ffmpeg searches for a file named @var{codec_name}-@var{arg}.avpreset in
the above-mentioned directories, where @var{codec_name} is the name of the codec
to which the preset file options will be applied. For example, if you select the
video codec with @code{-vcodec libvpx} and use @code{-pre 1080p}, then it will
search for the file @file{libvpx-1080p.avpreset}.

If no such file is found, then ffmpeg will search for a file named
@var{arg}.avpreset in the same directories.

1796
@c man end OPTIONS
1797

1798 1799 1800 1801 1802
@chapter Examples
@c man begin EXAMPLES

@section Video and Audio grabbing

1803 1804
If you specify the input format and device then ffmpeg can grab video
and audio directly.
1805 1806 1807

@example
ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
1808 1809 1810 1811 1812
@end example

Or with an ALSA audio source (mono input, card id 1) instead of OSS:
@example
ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
1813 1814 1815
@end example

Note that you must activate the right video source and channel before
1816 1817
launching ffmpeg with any TV viewer such as
@uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
1818 1819 1820 1821 1822
have to set the audio recording levels correctly with a
standard mixer.

@section X11 grabbing

1823
Grab the X11 display with ffmpeg via
1824 1825

@example
1826
ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0 /tmp/out.mpg
1827 1828 1829 1830 1831 1832
@end example

0.0 is display.screen number of your X11 server, same as
the DISPLAY environment variable.

@example
1833
ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0+10,20 /tmp/out.mpg
1834 1835
@end example

1836 1837
0.0 is display.screen number of your X11 server, same as the DISPLAY environment
variable. 10 is the x-offset and 20 the y-offset for the grabbing.
1838 1839 1840

@section Video and Audio file format conversion

1841
Any supported file format and protocol can serve as input to ffmpeg:
1842 1843

Examples:
1844 1845 1846
@itemize
@item
You can use YUV files as input:
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860

@example
ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
@end example

It will use the files:
@example
/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
@end example

The Y files use twice the resolution of the U and V files. They are
raw files, without header. They can be generated by all decent video
decoders. You must specify the size of the image with the @option{-s} option
1861
if ffmpeg cannot guess it.
1862

1863 1864
@item
You can input from a raw YUV420P file:
1865 1866 1867 1868 1869 1870 1871 1872 1873

@example
ffmpeg -i /tmp/test.yuv /tmp/out.avi
@end example

test.yuv is a file containing raw YUV planar data. Each frame is composed
of the Y plane followed by the U and V planes at half vertical and
horizontal resolution.

1874 1875
@item
You can output to a raw YUV420P file:
1876 1877 1878 1879 1880

@example
ffmpeg -i mydivx.avi hugefile.yuv
@end example

1881 1882
@item
You can set several input files and output files:
1883 1884 1885 1886 1887 1888 1889 1890

@example
ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
@end example

Converts the audio file a.wav and the raw YUV video file a.yuv
to MPEG file a.mpg.

1891 1892
@item
You can also do audio and video conversions at the same time:
1893 1894 1895 1896 1897 1898 1899

@example
ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
@end example

Converts a.wav to MPEG audio at 22050 Hz sample rate.

1900 1901
@item
You can encode to several formats at the same time and define a
1902 1903 1904
mapping from input stream to output streams:

@example
1905
ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
1906 1907 1908 1909 1910 1911
@end example

Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
file:index' specifies which input stream is used for each output
stream, in the order of the definition of output streams.

1912 1913
@item
You can transcode decrypted VOBs:
1914 1915

@example
1916
ffmpeg -i snatch_1.vob -f avi -c:v mpeg4 -b:v 800k -g 300 -bf 2 -c:a libmp3lame -b:a 128k snatch.avi
1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
@end example

This is a typical DVD ripping example; the input is a VOB file, the
output an AVI file with MPEG-4 video and MP3 audio. Note that in this
command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
input video. Furthermore, the audio stream is MP3-encoded so you need
to enable LAME support by passing @code{--enable-libmp3lame} to configure.
The mapping is particularly useful for DVD transcoding
to get the desired audio language.

1928
NOTE: To see the supported input formats, use @code{ffmpeg -demuxers}.
1929

1930 1931
@item
You can extract images from a video, or create a video from many images:
1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942

For extracting images from a video:
@example
ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
@end example

This will extract one video frame per second from the video and will
output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
etc. Images will be rescaled to fit the new WxH values.

If you want to extract just a limited number of frames, you can use the
1943 1944
above command in combination with the @code{-frames:v} or @code{-t} option,
or in combination with -ss to start extracting from a certain point in time.
1945 1946 1947

For creating a video from many images:
@example
1948
ffmpeg -f image2 -framerate 12 -i foo-%03d.jpeg -s WxH foo.avi
1949 1950 1951 1952 1953
@end example

The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
composed of three digits padded with zeroes to express the sequence
number. It is the same syntax supported by the C printf function, but
1954 1955
only formats accepting a normal integer are suitable.

1956 1957 1958 1959 1960 1961 1962
When importing an image sequence, -i also supports expanding
shell-like wildcard patterns (globbing) internally, by selecting the
image2-specific @code{-pattern_type glob} option.

For example, for creating a video from filenames matching the glob pattern
@code{foo-*.jpeg}:
@example
1963
ffmpeg -f image2 -pattern_type glob -framerate 12 -i 'foo-*.jpeg' -s WxH foo.avi
1964
@end example
1965

1966 1967
@item
You can put many streams of the same type in the output:
1968 1969

@example
1970
ffmpeg -i test1.avi -i test2.avi -map 1:1 -map 1:0 -map 0:1 -map 0:0 -c copy -y test12.nut
1971 1972
@end example

1973 1974
The resulting output file @file{test12.nut} will contain the first four streams
from the input files in reverse order.
1975

1976 1977 1978
@item
To force CBR video output:
@example
1979
ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1980 1981 1982 1983 1984 1985
@end example

@item
The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
but you may use the QP2LAMBDA constant to easily convert from 'q' units:
@example
1986
ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
1987 1988
@end example

1989
@end itemize
1990 1991
@c man end EXAMPLES

1992
@include config.texi
1993
@ifset config-all
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
@ifset config-avutil
@include utils.texi
@end ifset
@ifset config-avcodec
@include codecs.texi
@include bitstream_filters.texi
@end ifset
@ifset config-avformat
@include formats.texi
@include protocols.texi
@end ifset
@ifset config-avdevice
@include devices.texi
@end ifset
@ifset config-swresample
@include resampler.texi
@end ifset
@ifset config-swscale
@include scaler.texi
@end ifset
@ifset config-avfilter
@include filters.texi
@end ifset
2017 2018
@end ifset

2019 2020 2021
@chapter See Also

@ifhtml
2022 2023 2024 2025 2026 2027
@ifset config-all
@url{ffmpeg.html,ffmpeg}
@end ifset
@ifset config-not-all
@url{ffmpeg-all.html,ffmpeg-all},
@end ifset
2028
@url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe},
2029 2030 2031 2032
@url{ffmpeg-utils.html,ffmpeg-utils},
@url{ffmpeg-scaler.html,ffmpeg-scaler},
@url{ffmpeg-resampler.html,ffmpeg-resampler},
@url{ffmpeg-codecs.html,ffmpeg-codecs},
2033
@url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
2034 2035 2036 2037 2038 2039 2040
@url{ffmpeg-formats.html,ffmpeg-formats},
@url{ffmpeg-devices.html,ffmpeg-devices},
@url{ffmpeg-protocols.html,ffmpeg-protocols},
@url{ffmpeg-filters.html,ffmpeg-filters}
@end ifhtml

@ifnothtml
2041 2042 2043 2044 2045 2046
@ifset config-all
ffmpeg(1),
@end ifset
@ifset config-not-all
ffmpeg-all(1),
@end ifset
2047
ffplay(1), ffprobe(1),
2048 2049 2050 2051 2052
ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
@end ifnothtml

2053 2054
@include authors.texi

2055 2056 2057
@ignore

@setfilename ffmpeg
2058
@settitle ffmpeg video converter
2059 2060 2061

@end ignore

2062
@bye