faq.texi 14.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
@chapter Usage

84
@section ffmpeg does not work; what is wrong?
85

86
Try a @code{make distclean} in the ffmpeg source directory before the build.
87
If this does not help see
88 89
(@url{http://ffmpeg.org/bugreports.html}).

90
@section How do I encode single pictures into movies?
91

Víctor Paesa's avatar
Víctor Paesa committed
92 93 94
First, rename your pictures to follow a numerical sequence.
For example, img1.jpg, img2.jpg, img3.jpg,...
Then you may run:
95 96

@example
97
  ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
98 99
@end example

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

Víctor Paesa's avatar
Víctor Paesa committed
102
@file{img%03d.jpg} means the sequence @file{img001.jpg}, @file{img002.jpg}, etc...
103

104 105 106 107 108 109 110
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
111
  x=1; for i in *jpg; do counter=$(printf %03d $x); ln -s "$i" /tmp/img"$counter".jpg; x=$(($x+1)); done
112 113 114 115 116 117 118 119 120 121 122
@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
  ffmpeg -f image2 -i /tmp/img%03d.jpg /tmp/a.mpg
@end example

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

125
@section How do I encode movie to single pictures?
126

127
Use:
128 129

@example
130
  ffmpeg -i movie.mpg movie%d.jpg
131 132
@end example

133 134
The @file{movie.mpg} used as input will be converted to
@file{movie1.jpg}, @file{movie2.jpg}, etc...
135 136 137

Instead of relying on file format self-recognition, you may also use
@table @option
138 139 140
@item -c:v ppm
@item -c:v png
@item -c:v mjpeg
141 142 143 144 145
@end table
to force the encoding.

Applying that to the previous example:
@example
146
  ffmpeg -i movie.mpg -f image2 -c:v mjpeg menu%d.jpg
147 148 149 150
@end example

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

151
@section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
152 153

For multithreaded MPEG* encoding, the encoded slices must be independent,
Mike Melanson's avatar
Mike Melanson committed
154 155
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.
156

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

159
Use @file{-} as file name.
Fabrice Bellard's avatar
Fabrice Bellard committed
160

161
@section -f jpeg doesn't work.
Michael Niedermayer's avatar
Michael Niedermayer committed
162

163
Try '-f image2 test%d.jpg'.
Michael Niedermayer's avatar
Michael Niedermayer committed
164

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

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

170
@section How do I encode Xvid or DivX video with ffmpeg?
171

172
Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
173
standard (note that there are many other coding formats that use this
174
same standard). Thus, use '-c:v mpeg4' to encode in these formats. The
175
default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
176 177
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
178 179
default.

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

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

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

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

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

Diego Biurrun's avatar
Diego Biurrun committed
193 194
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.
195

Diego Biurrun's avatar
Diego Biurrun committed
196
@section How can I read DirectShow files?
197

198
If you have built FFmpeg with @code{./configure --enable-avisynth}
Diego Biurrun's avatar
Diego Biurrun committed
199 200
(only possible on MinGW/Cygwin platforms),
then you may use any file that DirectShow can read as input.
201 202 203 204 205

Just create an "input.avs" text file with this single line ...
@example
  DirectShowSource("C:\path to your file\yourfile.asf")
@end example
206
... and then feed that text file to ffmpeg:
207 208 209 210
@example
  ffmpeg -i input.avs
@end example

211 212
For ANY other help on Avisynth, please visit the
@uref{http://www.avisynth.org/, Avisynth homepage}.
213

214 215
@section How can I join video files?

216
A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow to join video files by
217 218 219 220
merely concatenating them.

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

@example
225 226
ffmpeg -i input1.avi -same_quant intermediate1.mpg
ffmpeg -i input2.avi -same_quant intermediate2.mpg
227
cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
228
ffmpeg -i intermediate_all.mpg -same_quant output.avi
229 230
@end example

231
Notice that you should either use @code{-same_quant} or set a reasonably high
232 233 234
bitrate for your intermediate and output files, if you want to preserve
video quality.

235
Also notice that you may avoid the huge intermediate files by taking advantage
236 237 238 239 240
of named pipes, should your platform support it:

@example
mkfifo intermediate1.mpg
mkfifo intermediate2.mpg
241 242
ffmpeg -i input1.avi -same_quant -y intermediate1.mpg < /dev/null &
ffmpeg -i input2.avi -same_quant -y intermediate2.mpg < /dev/null &
243
cat intermediate1.mpg intermediate2.mpg |\
244
ffmpeg -f mpeg -i - -same_quant -c:v mpeg4 -acodec libmp3lame output.avi
245 246 247 248
@end example

Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
allow concatenation, and the transcoding step is almost lossless.
249 250 251 252 253
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.

254 255 256 257 258 259 260 261 262 263 264 265
For example, let's say we want to join two FLV files into an output.flv file:

@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 &
266
@{ ffmpeg -i input2.flv -an -f yuv4mpegpipe - < /dev/null | tail -n +2 > temp2.v ; @} &
267 268 269 270
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 \
271
       -same_quant -y output.flv
272 273 274
rm temp[12].[av] all.[av]
@end example

275 276
@section -profile option fails when encoding H.264 video with AAC audio

277
@command{ffmpeg} prints an error like
278 279 280 281 282 283 284 285 286 287 288 289 290 291

@example
Undefined constant or missing '(' in 'baseline'
Unable to parse option value "baseline"
Error setting option profile to value baseline.
@end example

Short answer: write @option{-profile:v} instead of @option{-profile}.

Long answer: this happens because the @option{-profile} option can apply to both
video and audio.  Specifically the AAC encoder also defines some profiles, none
of which are named @var{baseline}.

The solution is to apply the @option{-profile} option to the video stream only
292
by using @url{http://ffmpeg.org/ffmpeg.html#Stream-specifiers-1, Stream specifiers}.
293 294
Appending @code{:v} to it will do exactly that.

295 296
@chapter Development

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

299
Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
300
examine the source code for one of the many open source projects that
301
already incorporate FFmpeg at (@url{projects.html}).
302

303
@section Can you support my C compiler XXX?
304

Diego Biurrun's avatar
Diego Biurrun committed
305 306 307
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.
308

309
@section Is Microsoft Visual C++ supported?
310

311
No. Microsoft Visual C++ is not compliant to the C99 standard and does
312
not - among other things - support the inline assembly used in FFmpeg.
313
If you wish to use MSVC++ for your
314
project then you can link the MSVC++ code with libav* as long as
315
you compile the latter with a working C compiler. For more information, see
316
the @emph{Microsoft Visual C++ compatibility} section in the FFmpeg
317
documentation.
318

319
There have been efforts to make FFmpeg compatible with MSVC++ in the
320
past. However, they have all been rejected as too intrusive, especially
321
since MinGW does the job adequately. None of the core developers
322
work with MSVC++ and thus this item is low priority. Should you find
323 324
the silver bullet that solves this problem, feel free to shoot it at us.

325 326
We strongly recommend you to move over from MSVC++ to MinGW tools.

327
@section Can I use FFmpeg or libavcodec under Windows?
328

329 330
Yes, but the Cygwin or MinGW tools @emph{must} be used to compile FFmpeg.
Read the @emph{Windows} section in the FFmpeg documentation to find more
331
information.
332

333
To get help and instructions for building FFmpeg under Windows, check out
334
the FFmpeg Windows Help Forum at
335
@url{http://ffmpeg.arrozcru.org/}.
336

337
@section Can you add automake, libtool or autoconf support?
338

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

341
@section Why not rewrite FFmpeg in object-oriented C++?
342

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

348
@section Why are the ffmpeg programs devoid of debugging symbols?
Mike Melanson's avatar
Mike Melanson committed
349 350

The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
351
information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
Tilman Brock's avatar
Tilman Brock committed
352
you need the debug information, use the *_g versions.
353

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

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

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

362
FFmpeg is a pure C project, so to use the libraries within your C++ application
363
you need to explicitly state that you are using a C library. You can do this by
364
encompassing your FFmpeg includes using @code{extern "C"}.
365 366 367

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

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

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

Diego Biurrun's avatar
Diego Biurrun committed
373
@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
374

375
You have to implement a URLProtocol, see @file{libavformat/file.c} in
376
FFmpeg and @file{libmpdemux/demux_lavf.c} in MPlayer sources.
Michael Niedermayer's avatar
Michael Niedermayer committed
377

Diego Biurrun's avatar
Diego Biurrun committed
378
@section Where can I find libav* headers for Pascal/Delphi?
379 380 381

see @url{http://www.iversenit.dk/dev/ffmpeg-headers/}

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

384
see @url{http://www.ffmpeg.org/~michael/}
385

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

Luca Barbato's avatar
Luca Barbato committed
388
Even if peculiar since it is network oriented, RTP is a container like any
389 390
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
391

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

root's avatar
root committed
394
r_frame_rate is NOT the average frame rate, it is the smallest frame rate
395 396 397
that can accurately represent all timestamps. So no, it is not
wrong if it is larger than the average!
For example, if you have mixed 25 and 30 fps content, then r_frame_rate
Michael Niedermayer's avatar
Michael Niedermayer committed
398 399
will be 150.

400 401 402 403 404 405 406 407 408 409 410 411
@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.

412
@bye