faq.texi 19.8 KB
Newer Older
1 2
\input texinfo @c -*- texinfo -*-

3
@settitle FFmpeg FAQ
4
@titlepage
5
@center @titlefont{FFmpeg FAQ}
6 7
@end titlepage

8 9 10
@top

@contents
11

12 13
@chapter General Questions

14
@section Why doesn't FFmpeg support feature [xyz]?
15

16
Because no one has taken on that task yet. FFmpeg development is
17 18
driven by the tasks that are important to the individual developers.
If there is a feature that is important to you, the best way to get
19
it implemented is to undertake the task yourself or sponsor a developer.
20

21
@section FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?
22

23
No. Windows DLLs are not portable, bloated and often slow.
24
Moreover FFmpeg strives to support all codecs natively.
25
A DLL loader is not conducive to that goal.
26

Mike Melanson's avatar
Mike Melanson committed
27
@section I cannot read this file although this format seems to be supported by ffmpeg.
28

29
Even if ffmpeg can read the container format, it may not support all its
30 31 32
codecs. Please consult the supported codec list in the ffmpeg
documentation.

33 34 35
@section Which codecs are supported by Windows?

Windows does not support standard formats like MPEG very well, unless you
36
install some additional codecs.
37 38 39 40 41 42 43 44 45 46 47 48

The following list of video codecs should work on most Windows systems:
@table @option
@item msmpeg4v2
.avi/.asf
@item msmpeg4
.asf only
@item wmv1
.asf only
@item wmv2
.asf only
@item mpeg4
49
Only if you have some MPEG-4 codec like ffdshow or Xvid installed.
50
@item mpeg1video
51 52 53 54 55 56 57 58 59 60 61
.mpg only
@end table
Note, ASF files often have .wmv or .wma extensions in Windows. It should also
be mentioned that Microsoft claims a patent on the ASF format, and may sue
or threaten users who create ASF files with non-Microsoft software. It is
strongly advised to avoid ASF where possible.

The following list of audio codecs should work on most Windows systems:
@table @option
@item adpcm_ima_wav
@item adpcm_ms
62
@item pcm_s16le
63
always
64
@item libmp3lame
65
If some MP3 codec like LAME is installed.
66 67 68
@end table


69 70 71 72 73 74 75
@chapter Compilation

@section @code{error: can't find a register in class 'GENERAL_REGS' while reloading 'asm'}

This is a bug in gcc. Do not report it to us. Instead, please report it to
the gcc developers. Note that we will not add workarounds for gcc bugs.

76 77 78 79 80
Also note that (some of) the gcc developers believe this is not a bug or
not a bug they should fix:
@url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=11203}.
Then again, some of them do not know the difference between an undecidable
problem and an NP-hard problem...
81

82 83 84 85 86 87 88 89 90 91 92
@section I have installed this library with my distro's package manager. Why does @command{configure} not see it?

Distributions usually split libraries in several packages. The main package
contains the files necessary to run programs using the library. The
development package contains the files necessary to build programs using the
library. Sometimes, docs and/or data are in a separate package too.

To build FFmpeg, you need to install the development package. It is usually
called @file{libfoo-dev} or @file{libfoo-devel}. You can remove it after the
build is finished, but be sure to keep the main package.

93 94
@chapter Usage

95
@section ffmpeg does not work; what is wrong?
96

97
Try a @code{make distclean} in the ffmpeg source directory before the build.
98
If this does not help see
99 100
(@url{http://ffmpeg.org/bugreports.html}).

101
@section How do I encode single pictures into movies?
102

Víctor Paesa's avatar
Víctor Paesa committed
103 104 105
First, rename your pictures to follow a numerical sequence.
For example, img1.jpg, img2.jpg, img3.jpg,...
Then you may run:
106 107

@example
108
ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
109 110
@end example

Víctor Paesa's avatar
Víctor Paesa committed
111
Notice that @samp{%d} is replaced by the image number.
112

113 114 115 116 117 118 119 120
@file{img%03d.jpg} means the sequence @file{img001.jpg}, @file{img002.jpg}, etc.

Use the @option{-start_number} option to declare a starting number for
the sequence. This is useful if your sequence does not start with
@file{img001.jpg} but is still in a numerical order. The following
example will start with @file{img100.jpg}:

@example
121
ffmpeg -f image2 -start_number 100 -i img%d.jpg /tmp/a.mpg
122
@end example
123

124 125 126 127 128 129 130
If you have large number of pictures to rename, you can use the
following command to ease the burden. The command, using the bourne
shell syntax, symbolically links all files in the current directory
that match @code{*jpg} to the @file{/tmp} directory in the sequence of
@file{img001.jpg}, @file{img002.jpg} and so on.

@example
131
x=1; for i in *jpg; do counter=$(printf %03d $x); ln -s "$i" /tmp/img"$counter".jpg; x=$(($x+1)); done
132 133 134 135 136 137 138 139
@end example

If you want to sequence them by oldest modified first, substitute
@code{$(ls -r -t *jpg)} in place of @code{*jpg}.

Then run:

@example
140
ffmpeg -f image2 -i /tmp/img%03d.jpg /tmp/a.mpg
141 142
@end example

Víctor Paesa's avatar
Víctor Paesa committed
143
The same logic is used for any image format that ffmpeg reads.
144

145 146 147
You can also use @command{cat} to pipe images to ffmpeg:

@example
148
cat *.jpg | ffmpeg -f image2pipe -c:v mjpeg -i - output.mpg
149 150
@end example

151
@section How do I encode movie to single pictures?
152

153
Use:
154 155

@example
156
ffmpeg -i movie.mpg movie%d.jpg
157 158
@end example

159 160
The @file{movie.mpg} used as input will be converted to
@file{movie1.jpg}, @file{movie2.jpg}, etc...
161 162 163

Instead of relying on file format self-recognition, you may also use
@table @option
164 165 166
@item -c:v ppm
@item -c:v png
@item -c:v mjpeg
167 168 169 170 171
@end table
to force the encoding.

Applying that to the previous example:
@example
172
ffmpeg -i movie.mpg -f image2 -c:v mjpeg menu%d.jpg
173 174 175 176
@end example

Beware that there is no "jpeg" codec. Use "mjpeg" instead.

177
@section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
178 179

For multithreaded MPEG* encoding, the encoded slices must be independent,
Mike Melanson's avatar
Mike Melanson committed
180 181
otherwise thread n would practically have to wait for n-1 to finish, so it's
quite logical that there is a small reduction of quality. This is not a bug.
182

183
@section How can I read from the standard input or write to the standard output?
Fabrice Bellard's avatar
Fabrice Bellard committed
184

185
Use @file{-} as file name.
Fabrice Bellard's avatar
Fabrice Bellard committed
186

187
@section -f jpeg doesn't work.
Michael Niedermayer's avatar
Michael Niedermayer committed
188

189
Try '-f image2 test%d.jpg'.
Michael Niedermayer's avatar
Michael Niedermayer committed
190

root's avatar
root committed
191
@section Why can I not change the frame rate?
Michael Niedermayer's avatar
Michael Niedermayer committed
192

root's avatar
root committed
193
Some codecs, like MPEG-1/2, only allow a small number of fixed frame rates.
194
Choose a different codec with the -c:v command line option.
Michael Niedermayer's avatar
Michael Niedermayer committed
195

196
@section How do I encode Xvid or DivX video with ffmpeg?
197

198
Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
199
standard (note that there are many other coding formats that use this
200
same standard). Thus, use '-c:v mpeg4' to encode in these formats. The
201
default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
202 203
a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
force the fourcc 'xvid' to be stored as the video fourcc rather than the
204 205
default.

Diego Biurrun's avatar
Diego Biurrun committed
206
@section Which are good parameters for encoding high quality MPEG-4?
207

208
'-mbd rd -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -g 300 -pass 1/2',
Diego Biurrun's avatar
Diego Biurrun committed
209
things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd'.
210

Diego Biurrun's avatar
Diego Biurrun committed
211
@section Which are good parameters for encoding high quality MPEG-1/MPEG-2?
212

213
'-mbd rd -trellis 2 -cmp 2 -subcmp 2 -g 100 -pass 1/2'
Diego Biurrun's avatar
Diego Biurrun committed
214 215
but beware the '-g 100' might cause problems with some decoders.
Things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd.
216

Diego Biurrun's avatar
Diego Biurrun committed
217
@section Interlaced video looks very bad when encoded with ffmpeg, what is wrong?
218

Diego Biurrun's avatar
Diego Biurrun committed
219 220
You should use '-flags +ilme+ildct' and maybe '-flags +alt' for interlaced
material, and try '-top 0/1' if the result looks really messed-up.
221

Diego Biurrun's avatar
Diego Biurrun committed
222
@section How can I read DirectShow files?
223

224
If you have built FFmpeg with @code{./configure --enable-avisynth}
Diego Biurrun's avatar
Diego Biurrun committed
225 226
(only possible on MinGW/Cygwin platforms),
then you may use any file that DirectShow can read as input.
227 228 229

Just create an "input.avs" text file with this single line ...
@example
230
DirectShowSource("C:\path to your file\yourfile.asf")
231
@end example
232
... and then feed that text file to ffmpeg:
233
@example
234
ffmpeg -i input.avs
235 236
@end example

Diego Biurrun's avatar
Diego Biurrun committed
237 238
For ANY other help on AviSynth, please visit the
@uref{http://www.avisynth.org/, AviSynth homepage}.
239

240 241
@section How can I join video files?

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
To "join" video files is quite ambiguous. The following list explains the
different kinds of "joining" and points out how those are addressed in
FFmpeg. To join video files may mean:

@itemize

@item
To put them one after the other: this is called to @emph{concatenate} them
(in short: concat) and is addressed
@ref{How can I concatenate video files, in this very faq}.

@item
To put them together in the same file, to let the user choose between the
different versions (example: different audio languages): this is called to
@emph{multiplex} them together (in short: mux), and is done by simply
invoking ffmpeg with several @option{-i} options.

@item
For audio, to put all channels together in a single stream (example: two
mono streams into one stereo stream): this is sometimes called to
@emph{merge} them, and can be done using the
263
@url{http://ffmpeg.org/ffmpeg-filters.html#amerge, @code{amerge}} filter.
264 265 266 267

@item
For audio, to play one on top of the other: this is called to @emph{mix}
them, and can be done by first merging them into a single stream and then
268
using the @url{http://ffmpeg.org/ffmpeg-filters.html#pan, @code{pan}} filter to mix
269 270 271 272 273
the channels at will.

@item
For video, to display both together, side by side or one on top of a part of
the other; it can be done using the
274
@url{http://ffmpeg.org/ffmpeg-filters.html#overlay, @code{overlay}} video filter.
275 276 277 278 279 280

@end itemize

@anchor{How can I concatenate video files}
@section How can I concatenate video files?

281 282
There are several solutions, depending on the exact circumstances.

283
@subsection Concatenating using the concat @emph{filter}
284

285 286 287
FFmpeg has a @url{http://ffmpeg.org/ffmpeg-filters.html#concat,
@code{concat}} filter designed specifically for that, with examples in the
documentation. This operation is recommended if you need to re-encode.
288

289 290 291 292 293 294 295
@subsection Concatenating using the concat @emph{demuxer}

FFmpeg has a @url{http://www.ffmpeg.org/ffmpeg-formats.html#concat,
@code{concat}} demuxer which you can use when you want to avoid a re-encode and
your format doesn't support file level concatenation.

@subsection Concatenating using the concat @emph{protocol} (file level)
296

297 298 299 300
FFmpeg has a @url{http://ffmpeg.org/ffmpeg-protocols.html#concat,
@code{concat}} protocol designed specifically for that, with examples in the
documentation.

301
A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow to concatenate
302
video by merely concatenating the files containing them.
303 304 305

Hence you may concatenate your multimedia files by first transcoding them to
these privileged formats, then using the humble @code{cat} command (or the
306
equally humble @code{copy} under Windows), and finally transcoding back to your
307 308 309
format of choice.

@example
310 311
ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
312
cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
313
ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
314 315
@end example

316 317
Additionally, you can use the @code{concat} protocol instead of @code{cat} or
@code{copy} which will avoid creation of a potentially huge intermediate file.
318

319 320 321 322 323 324 325 326 327 328 329
@example
ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
ffmpeg -i concat:"intermediate1.mpg|intermediate2.mpg" -c copy intermediate_all.mpg
ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
@end example

Note that you may need to escape the character "|" which is special for many
shells.

Another option is usage of named pipes, should your platform support it:
330 331 332 333

@example
mkfifo intermediate1.mpg
mkfifo intermediate2.mpg
334 335
ffmpeg -i input1.avi -qscale:v 1 -y intermediate1.mpg < /dev/null &
ffmpeg -i input2.avi -qscale:v 1 -y intermediate2.mpg < /dev/null &
336
cat intermediate1.mpg intermediate2.mpg |\
337
ffmpeg -f mpeg -i - -c:v mpeg4 -acodec libmp3lame output.avi
338 339
@end example

340 341
@subsection Concatenating using raw audio and video

342 343
Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
allow concatenation, and the transcoding step is almost lossless.
344 345 346 347 348
When using multiple yuv4mpegpipe(s), the first line needs to be discarded
from all but the first stream. This can be accomplished by piping through
@code{tail} as seen below. Note that when piping through @code{tail} you
must use command grouping, @code{@{  ;@}}, to background properly.

349 350
For example, let's say we want to concatenate two FLV files into an
output.flv file:
351 352 353 354 355 356 357 358 359 360 361

@example
mkfifo temp1.a
mkfifo temp1.v
mkfifo temp2.a
mkfifo temp2.v
mkfifo all.a
mkfifo all.v
ffmpeg -i input1.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp1.a < /dev/null &
ffmpeg -i input2.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp2.a < /dev/null &
ffmpeg -i input1.flv -an -f yuv4mpegpipe - > temp1.v < /dev/null &
362
@{ ffmpeg -i input2.flv -an -f yuv4mpegpipe - < /dev/null | tail -n +2 > temp2.v ; @} &
363 364 365 366
cat temp1.a temp2.a > all.a &
cat temp1.v temp2.v > all.v &
ffmpeg -f u16le -acodec pcm_s16le -ac 2 -ar 44100 -i all.a \
       -f yuv4mpegpipe -i all.v \
367
       -y output.flv
368 369 370
rm temp[12].[av] all.[av]
@end example

371 372 373 374 375
@section Using @option{-f lavfi}, audio becomes mono for no apparent reason.

Use @option{-dumpgraph -} to find out exactly where the channel layout is
lost.

376
Most likely, it is through @code{auto-inserted aresample}. Try to understand
377 378
why the converting filter was needed at that place.

Nicolas George's avatar
Nicolas George committed
379
Just before the output is a likely place, as @option{-f lavfi} currently
380 381
only support packed S16.

382
Then insert the correct @code{aformat} explicitly in the filtergraph,
383 384 385
specifying the exact format.

@example
386
aformat=sample_fmts=s16:channel_layouts=stereo
387 388
@end example

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
@section Why does FFmpeg not see the subtitles in my VOB file?

VOB and a few other formats do not have a global header that describes
everything present in the file. Instead, applications are supposed to scan
the file to see what it contains. Since VOB files are frequently large, only
the beginning is scanned. If the subtitles happen only later in the file,
they will not be initally detected.

Some applications, including the @code{ffmpeg} command-line tool, can only
work with streams that were detected during the initial scan; streams that
are detected later are ignored.

The size of the initial scan is controlled by two options: @code{probesize}
(default ~5 Mo) and @code{analyzeduration} (default 5,000,000 µs = 5 s). For
the subtitle stream to be detected, both values must be large enough.

405
@section Why was the @command{ffmpeg} @option{-sameq} option removed? What to use instead?
406 407 408 409 410 411 412 413 414 415 416 417 418

The @option{-sameq} option meant "same quantizer", and made sense only in a
very limited set of cases. Unfortunately, a lot of people mistook it for
"same quality" and used it in places where it did not make sense: it had
roughly the expected visible effect, but achieved it in a very inefficient
way.

Each encoder has its own set of options to set the quality-vs-size balance,
use the options for the encoder you are using to set the quality level to a
point acceptable for your tastes. The most common options to do that are
@option{-qscale} and @option{-qmax}, but you should peruse the documentation
of the encoder you chose.

419 420
@chapter Development

421
@section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
422

423 424 425 426 427 428 429 430
Yes. Check the @file{doc/examples} directory in the source
repository, also available online at:
@url{https://github.com/FFmpeg/FFmpeg/tree/master/doc/examples}.

Examples are also installed by default, usually in
@code{$PREFIX/share/ffmpeg/examples}.

Also you may read the Developers Guide of the FFmpeg documentation. Alternatively,
431
examine the source code for one of the many open source projects that
432
already incorporate FFmpeg at (@url{projects.html}).
433

434
@section Can you support my C compiler XXX?
435

Diego Biurrun's avatar
Diego Biurrun committed
436 437 438
It depends. If your compiler is C99-compliant, then patches to support
it are likely to be welcome if they do not pollute the source code
with @code{#ifdef}s related to the compiler.
439

440
@section Is Microsoft Visual C++ supported?
441

442 443
Yes. Please see the @uref{platform.html, Microsoft Visual C++}
section in the FFmpeg documentation.
444

445
@section Can you add automake, libtool or autoconf support?
446

Diego Biurrun's avatar
Diego Biurrun committed
447
No. These tools are too bloated and they complicate the build.
448

449
@section Why not rewrite FFmpeg in object-oriented C++?
450

451
FFmpeg is already organized in a highly modular manner and does not need to
452
be rewritten in a formal object language. Further, many of the developers
Mike Melanson's avatar
Mike Melanson committed
453
favor straight C; it works for them. For more arguments on this matter,
454
read @uref{http://www.tux.org/lkml/#s15, "Programming Religion"}.
Mike Melanson's avatar
Mike Melanson committed
455

456
@section Why are the ffmpeg programs devoid of debugging symbols?
Mike Melanson's avatar
Mike Melanson committed
457

458 459 460 461
The build process creates @command{ffmpeg_g}, @command{ffplay_g}, etc. which
contain full debug information. Those binaries are stripped to create
@command{ffmpeg}, @command{ffplay}, etc. If you need the debug information, use
the *_g versions.
462

463
@section I do not like the LGPL, can I contribute code under the GPL instead?
464

Diego Biurrun's avatar
Diego Biurrun committed
465
Yes, as long as the code is optional and can easily and cleanly be placed
root's avatar
root committed
466
under #if CONFIG_GPL without breaking anything. So, for example, a new codec
467
or filter would be OK under GPL while a bug fix to LGPL code would not.
468

469 470 471 472 473 474 475 476 477 478 479 480
@section I'm using FFmpeg from within my C application but the linker complains about missing symbols from the libraries themselves.

FFmpeg builds static libraries by default. In static libraries, dependencies
are not handled. That has two consequences. First, you must specify the
libraries in dependency order: @code{-lavdevice} must come before
@code{-lavformat}, @code{-lavutil} must come after everything else, etc.
Second, external libraries that are used in FFmpeg have to be specified too.

An easy way to get the full list of required libraries in dependency order
is to use @code{pkg-config}.

@example
481
c99 -o program program.c $(pkg-config --cflags --libs libavformat libavcodec)
482 483 484 485 486
@end example

See @file{doc/example/Makefile} and @file{doc/example/pc-uninstalled} for
more details.

487
@section I'm using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.
488

489
FFmpeg is a pure C project, so to use the libraries within your C++ application
490
you need to explicitly state that you are using a C library. You can do this by
491
encompassing your FFmpeg includes using @code{extern "C"}.
492 493 494

See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}

495 496
@section I'm using libavutil from within my C++ application but the compiler complains about 'UINT64_C' was not declared in this scope

497
FFmpeg is a pure C project using C99 math features, in order to enable C++
498 499
to use them you have to append -D__STDC_CONSTANT_MACROS to your CXXFLAGS

Diego Biurrun's avatar
Diego Biurrun committed
500
@section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
Michael Niedermayer's avatar
Michael Niedermayer committed
501

502
You have to create a custom AVIOContext using @code{avio_alloc_context},
503
see @file{libavformat/aviobuf.c} in FFmpeg and @file{libmpdemux/demux_lavf.c} in MPlayer or MPlayer2 sources.
Michael Niedermayer's avatar
Michael Niedermayer committed
504

Diego Biurrun's avatar
Diego Biurrun committed
505
@section Where is the documentation about ffv1, msmpeg4, asv1, 4xm?
506

507
see @url{http://www.ffmpeg.org/~michael/}
508

509
@section How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?
Michael Niedermayer's avatar
Michael Niedermayer committed
510

Luca Barbato's avatar
Luca Barbato committed
511
Even if peculiar since it is network oriented, RTP is a container like any
512 513
other. You have to @emph{demux} RTP before feeding the payload to libavcodec.
In this specific case please look at RFC 4629 to see how it should be done.
Michael Niedermayer's avatar
Michael Niedermayer committed
514

root's avatar
root committed
515
@section AVStream.r_frame_rate is wrong, it is much larger than the frame rate.
Michael Niedermayer's avatar
Michael Niedermayer committed
516

517
@code{r_frame_rate} is NOT the average frame rate, it is the smallest frame rate
518 519
that can accurately represent all timestamps. So no, it is not
wrong if it is larger than the average!
520 521 522
For example, if you have mixed 25 and 30 fps content, then @code{r_frame_rate}
will be 150 (it is the least common multiple).
If you are looking for the average frame rate, see @code{AVStream.avg_frame_rate}.
Michael Niedermayer's avatar
Michael Niedermayer committed
523

524 525 526 527 528 529 530 531 532 533 534 535
@section Why is @code{make fate} not running all tests?

Make sure you have the fate-suite samples and the @code{SAMPLES} Make variable
or @code{FATE_SAMPLES} environment variable or the @code{--samples}
@command{configure} option is set to the right path.

@section Why is @code{make fate} not finding the samples?

Do you happen to have a @code{~} character in the samples path to indicate a
home directory? The value is used in ways where the shell cannot expand it,
causing FATE to not find files. Just replace @code{~} by the full path.

536
@bye