Run documentation through ispell, plus some minor fixes.
[ffmpeg.git] / doc / faq.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FFmpeg FAQ
4 @titlepage
5 @sp 7
6 @center @titlefont{FFmpeg FAQ}
7 @sp 3
8 @end titlepage
9
10
11 @chapter General Questions
12
13 @section When will the next FFmpeg version be released? / Why are FFmpeg releases so few and far between?
14
15 Like most open source projects FFmpeg suffers from a certain lack of
16 manpower. For this reason the developers have to prioritize the work
17 they do and putting out releases is not at the top of the list, fixing
18 bugs and reviewing patches takes precedence. Please don't complain or
19 request more timely and/or frequent releases unless you are willing to
20 help out creating them.
21
22 @section I have a problem with an old version of FFmpeg; where should I report it?
23 Nowhere. Upgrade to the latest release or if there is no recent release upgrade
24 to Subversion HEAD. You could also try to report it. Maybe you will get lucky and
25 become the first person in history to get an answer different from "upgrade
26 to Subversion HEAD".
27
28 @section Why doesn't FFmpeg support feature [xyz]?
29
30 Because no one has taken on that task yet. FFmpeg development is
31 driven by the tasks that are important to the individual developers.
32 If there is a feature that is important to you, the best way to get
33 it implemented is to undertake the task yourself or sponsor a developer.
34
35 @section FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?
36
37 No. Windows DLLs are not portable, bloated and often slow.
38 Moreover FFmpeg strives to support all codecs natively.
39 A DLL loader is not conducive to that goal.
40
41 @section My bug report/mail to ffmpeg-devel/user has not received any replies.
42
43 Likely reasons
44 @itemize
45 @item We are busy and haven't had time yet to read your report or
46 investigate the issue.
47 @item You didn't follow bugreports.html.
48 @item You didn't use Subversion HEAD.
49 @item You reported a segmentation fault without gdb output.
50 @item You describe a problem but not how to reproduce it.
51 @item It's unclear if you use ffmpeg as command line tool or use
52 libav* from another application.
53 @item You speak about a video having problems on playback but
54 not what you use to play it.
55 @item We have no faint clue what you are talking about besides
56 that it is related to FFmpeg.
57 @end itemize
58
59 @section Is there a forum for FFmpeg? I do not like mailing lists.
60
61 Yes, (@url{http://dir.gmane.org/gmane.comp.video.ffmpeg.user}).
62
63 @section I cannot read this file although this format seems to be supported by ffmpeg.
64
65 Even if ffmpeg can read the container format, it may not support all its
66 codecs. Please consult the supported codec list in the ffmpeg
67 documentation.
68
69 @section Which codecs are supported by Windows?
70
71 Windows does not support standard formats like MPEG very well, unless you
72 install some additional codecs.
73
74 The following list of video codecs should work on most Windows systems:
75 @table @option
76 @item msmpeg4v2
77 .avi/.asf
78 @item msmpeg4
79 .asf only
80 @item wmv1
81 .asf only
82 @item wmv2
83 .asf only
84 @item mpeg4
85 Only if you have some MPEG-4 codec like ffdshow or Xvid installed.
86 @item mpeg1
87 .mpg only
88 @end table
89 Note, ASF files often have .wmv or .wma extensions in Windows. It should also
90 be mentioned that Microsoft claims a patent on the ASF format, and may sue
91 or threaten users who create ASF files with non-Microsoft software. It is
92 strongly advised to avoid ASF where possible.
93
94 The following list of audio codecs should work on most Windows systems:
95 @table @option
96 @item adpcm_ima_wav
97 @item adpcm_ms
98 @item pcm
99 always
100 @item mp3
101 If some MP3 codec like LAME is installed.
102 @end table
103
104
105 @chapter Compilation
106
107 @section @code{error: can't find a register in class 'GENERAL_REGS' while reloading 'asm'}
108
109 This is a bug in gcc. Do not report it to us. Instead, please report it to
110 the gcc developers. Note that we will not add workarounds for gcc bugs.
111
112
113 @chapter Usage
114
115 @section ffmpeg does not work; what is wrong?
116
117 Try a @code{make distclean} in the ffmpeg source directory before the build. If this does not help see
118 (@url{http://ffmpeg.org/bugreports.html}).
119
120 @section How do I encode single pictures into movies?
121
122 First, rename your pictures to follow a numerical sequence.
123 For example, img1.jpg, img2.jpg, img3.jpg,...
124 Then you may run:
125
126 @example
127   ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
128 @end example
129
130 Notice that @samp{%d} is replaced by the image number.
131
132 @file{img%03d.jpg} means the sequence @file{img001.jpg}, @file{img002.jpg}, etc...
133
134 The same logic is used for any image format that ffmpeg reads.
135
136 @section How do I encode movie to single pictures?
137
138 Use:
139
140 @example
141   ffmpeg -i movie.mpg movie%d.jpg
142 @end example
143
144 The @file{movie.mpg} used as input will be converted to
145 @file{movie1.jpg}, @file{movie2.jpg}, etc...
146
147 Instead of relying on file format self-recognition, you may also use
148 @table @option
149 @item -vcodec ppm
150 @item -vcodec png
151 @item -vcodec mjpeg
152 @end table
153 to force the encoding.
154
155 Applying that to the previous example:
156 @example
157   ffmpeg -i movie.mpg -f image2 -vcodec mjpeg menu%d.jpg
158 @end example
159
160 Beware that there is no "jpeg" codec. Use "mjpeg" instead.
161
162 @section I get "Unsupported codec (id=86043) for input stream #0.1". What is the problem?
163
164 This is the Qcelp codec, FFmpeg has no support for that codec currently.
165 Try MEncoder/MPlayer, it might work.
166
167 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
168
169 For multithreaded MPEG* encoding, the encoded slices must be independent,
170 otherwise thread n would practically have to wait for n-1 to finish, so it's
171 quite logical that there is a small reduction of quality. This is not a bug.
172
173 @section How can I read from the standard input or write to the standard output?
174
175 Use @file{-} as file name.
176
177 @section Why does FFmpeg not decode audio in VOB files?
178
179 The audio is AC-3 (a.k.a. A/52). AC-3 decoding is an optional component in FFmpeg
180 as the component that handles AC-3 decoding is currently released under the GPL.
181 Enable AC-3 decoding with @code{./configure --enable-gpl}. Take care: By
182 enabling AC-3, you automatically change the license of libavcodec from
183 LGPL to GPL.
184
185 @section Why does the chrominance data seem to be sampled at a different time from the luminance data on bt8x8 captures on Linux?
186
187 This is a well-known bug in the bt8x8 driver. For 2.4.26 there is a patch at
188 (@url{http://svn.mplayerhq.hu/michael/trunk/patches/bttv-420-2.4.26.patch?view=co}). This may also
189 apply cleanly to other 2.4-series kernels.
190
191 @section How do I avoid the ugly aliasing artifacts in bt8x8 captures on Linux?
192
193 Pass 'combfilter=1 lumafilter=1' to the bttv driver. Note though that 'combfilter=1'
194 will cause somewhat too strong filtering. A fix is to apply (@url{http://svn.mplayerhq.hu/michael/trunk/patches/bttv-comb-2.4.26.patch?view=co})
195 or (@url{http://svn.mplayerhq.hu/michael/trunk/patches/bttv-comb-2.6.6.patch?view=co})
196 and pass 'combfilter=2'.
197
198 @section -f jpeg doesn't work.
199
200 Try '-f image2 test%d.jpg'.
201
202 @section Why can I not change the framerate?
203
204 Some codecs, like MPEG-1/2, only allow a small number of fixed framerates.
205 Choose a different codec with the -vcodec command line option.
206
207 @section How do I encode Xvid or DivX video with ffmpeg?
208
209 Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
210 standard (note that there are many other coding formats that use this
211 same standard). Thus, use '-vcodec mpeg4' to encode in these formats. The
212 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
213 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
214 force the fourcc 'xvid' to be stored as the video fourcc rather than the
215 default.
216
217 @section How do I encode videos which play on the iPod?
218
219 @table @option
220 @item needed stuff
221 -acodec libfaac -vcodec mpeg4 width<=320 height<=240
222 @item working stuff
223 4mv, title
224 @item non-working stuff
225 B-frames
226 @item example command line
227 ffmpeg -i input -acodec libfaac -ab 128kb -vcodec mpeg4 -b 1200kb -mbd 2 -flags +4mv+trell -aic 2 -cmp 2 -subcmp 2 -s 320x180 -title X output.mp4
228 @end table
229
230 @section How do I encode videos which play on the PSP?
231
232 @table @option
233 @item needed stuff
234 -acodec libfaac -vcodec mpeg4 width*height<=76800 width%16=0 height%16=0 -ar 24000 -r 30000/1001 or 15000/1001 -f psp
235 @item working stuff
236 4mv, title
237 @item non-working stuff
238 B-frames
239 @item example command line
240 ffmpeg -i input -acodec libfaac -ab 128kb -vcodec mpeg4 -b 1200kb -ar 24000 -mbd 2 -flags +4mv+trell -aic 2 -cmp 2 -subcmp 2 -s 368x192 -r 30000/1001 -title X -f psp output.mp4
241 @item needed stuff for H.264
242 -acodec libfaac -vcodec h264 width*height<=76800 width%16=0? height%16=0? -ar 48000 -coder 1 -r 30000/1001 or 15000/1001 -f psp
243 @item working stuff for H.264
244 title, loop filter
245 @item non-working stuff for H.264
246 CAVLC
247 @item example command line
248 ffmpeg -i input -acodec libfaac -ab 128kb -vcodec h264 -b 1200kb -ar 48000 -mbd 2 -coder 1 -cmp 2 -subcmp 2 -s 368x192 -r 30000/1001 -title X -f psp -flags loop -trellis 2 -partitions parti4x4+parti8x8+partp4x4+partp8x8+partb8x8 output.mp4
249 @end table
250
251 @section Which are good parameters for encoding high quality MPEG-4?
252
253 '-mbd rd -flags +4mv+trell+aic -cmp 2 -subcmp 2 -g 300 -pass 1/2',
254 things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd'.
255
256 @section Which are good parameters for encoding high quality MPEG-1/MPEG-2?
257
258 '-mbd rd -flags +trell -cmp 2 -subcmp 2 -g 100 -pass 1/2'
259 but beware the '-g 100' might cause problems with some decoders.
260 Things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd.
261
262 @section Interlaced video looks very bad when encoded with ffmpeg, whats wrong?
263
264 You should use '-flags +ilme+ildct' and maybe '-flags +alt' for interlaced
265 material, and try '-top 0/1' if the result looks really messed-up.
266
267 @section How can I read DirectShow files?
268
269 If you have built FFmpeg with @code{./configure --enable-avisynth}
270 (only possible on MinGW/Cygwin platforms),
271 then you may use any file that DirectShow can read as input.
272 (Be aware that this feature has been recently added,
273 so you will need to help yourself in case of problems.)
274
275 Just create an "input.avs" text file with this single line ...
276 @example
277   DirectShowSource("C:\path to your file\yourfile.asf")
278 @end example
279 ... and then feed that text file to FFmpeg:
280 @example
281   ffmpeg -i input.avs
282 @end example
283
284 For ANY other help on Avisynth, please visit @url{http://www.avisynth.org/}.
285
286 @section How can I join video files?
287
288 A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow to join video files by
289 merely concatenating them.
290
291 Hence you may concatenate your multimedia files by first transcoding them to
292 these privileged formats, then using the humble @code{cat} command (or the
293 equally humble @code{copy} under Windows), and finally transcoding back to your
294 format of choice.
295
296 @example
297 ffmpeg -i input1.avi -sameq intermediate1.mpg
298 ffmpeg -i input2.avi -sameq intermediate2.mpg
299 cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
300 ffmpeg -i intermediate_all.mpg -sameq output.avi
301 @end example
302
303 Notice that you should either use @code{-sameq} or set a reasonably high
304 bitrate for your intermediate and output files, if you want to preserve
305 video quality.
306
307 Also notice that you may avoid the huge intermediate files by taking advantage
308 of named pipes, should your platform support it:
309
310 @example
311 mkfifo intermediate1.mpg
312 mkfifo intermediate2.mpg
313 ffmpeg -i input1.avi -sameq -y intermediate1.mpg < /dev/null &
314 ffmpeg -i input2.avi -sameq -y intermediate2.mpg < /dev/null &
315 cat intermediate1.mpg intermediate2.mpg |\
316 ffmpeg -f mpeg -i - -sameq -vcodec mpeg4 -acodec libmp3lame output.avi
317 @end example
318
319 Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
320 allow concatenation, and the transcoding step is almost lossless.
321
322 For example, let's say we want to join two FLV files into an output.flv file:
323
324 @example
325 mkfifo temp1.a
326 mkfifo temp1.v
327 mkfifo temp2.a
328 mkfifo temp2.v
329 mkfifo all.a
330 mkfifo all.v
331 ffmpeg -i input1.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp1.a < /dev/null &
332 ffmpeg -i input2.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp2.a < /dev/null &
333 ffmpeg -i input1.flv -an -f yuv4mpegpipe - > temp1.v < /dev/null &
334 ffmpeg -i input2.flv -an -f yuv4mpegpipe - > temp2.v < /dev/null &
335 cat temp1.a temp2.a > all.a &
336 cat temp1.v temp2.v > all.v &
337 ffmpeg -f u16le -acodec pcm_s16le -ac 2 -ar 44100 -i all.a \
338        -f yuv4mpegpipe -i all.v \
339        -sameq -y output.flv
340 rm temp[12].[av] all.[av]
341 @end example
342
343 @section FFmpeg does not adhere to the -maxrate setting, some frames are bigger than maxrate/fps.
344
345 Read the MPEG spec about video buffer verifier.
346
347 @section I want CBR, but no matter what I do frame sizes differ.
348
349 You do not understand what CBR is, please read the MPEG spec.
350 Read about video buffer verifier and constant bitrate.
351 The one sentence summary is that there is a buffer and the input rate is
352 constant, the output can vary as needed.
353
354 @section How do I check if a stream is CBR?
355
356 To quote the MPEG-2 spec:
357 "There is no way to tell that a bitstream is constant bitrate without
358 examining all of the vbv_delay values and making complicated computations."
359
360
361 @chapter Development
362
363 @section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
364
365 Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
366 examine the source code for one of the many open source projects that
367 already incorporate FFmpeg at (@url{projects.html}).
368
369 @section Can you support my C compiler XXX?
370
371 It depends. If your compiler is C99-compliant, then patches to support
372 it are likely to be welcome if they do not pollute the source code
373 with @code{#ifdef}s related to the compiler.
374
375 @section Is Microsoft Visual C++ supported?
376
377 No. Microsoft Visual C++ is not compliant to the C99 standard and does
378 not - among other things - support the inline assembly used in FFmpeg.
379 If you wish to use MSVC++ for your
380 project then you can link the MSVC++ code with libav* as long as
381 you compile the latter with a working C compiler. For more information, see
382 the @emph{Microsoft Visual C++ compatibility} section in the FFmpeg
383 documentation.
384
385 There have been efforts to make FFmpeg compatible with MSVC++ in the
386 past. However, they have all been rejected as too intrusive, especially
387 since MinGW does the job adequately. None of the core developers
388 work with MSVC++ and thus this item is low priority. Should you find
389 the silver bullet that solves this problem, feel free to shoot it at us.
390
391 We strongly recommend you to move over from MSVC++ to MinGW tools.
392
393 @section Can I use FFmpeg or libavcodec under Windows?
394
395 Yes, but the Cygwin or MinGW tools @emph{must} be used to compile FFmpeg.
396 Read the @emph{Windows} section in the FFmpeg documentation to find more
397 information.
398
399 To get help and instructions for building FFmpeg under Windows, check out
400 the FFmpeg Windows Help Forum at
401 @url{http://arrozcru.no-ip.org/ffmpeg/}.
402
403 @section Can you add automake, libtool or autoconf support?
404
405 No. These tools are too bloated and they complicate the build.
406
407 @section Why not rewrite ffmpeg in object-oriented C++?
408
409 FFmpeg is already organized in a highly modular manner and does not need to
410 be rewritten in a formal object language. Further, many of the developers
411 favor straight C; it works for them. For more arguments on this matter,
412 read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
413
414 @section Why are the ffmpeg programs devoid of debugging symbols?
415
416 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
417 information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
418 you need the debug information, used the *_g versions.
419
420 @section I do not like the LGPL, can I contribute code under the GPL instead?
421
422 Yes, as long as the code is optional and can easily and cleanly be placed
423 under #ifdef CONFIG_GPL without breaking anything. So for example a new codec
424 or filter would be OK under GPL while a bug fix to LGPL code would not.
425
426 @section I want to compile xyz.c alone but my compiler produced many errors.
427
428 Common code is in its own files in libav* and is used by the individual
429 codecs. They will not work without the common parts, you have to compile
430 the whole libav*. If you wish, disable some parts with configure switches.
431 You can also try to hack it and remove more, but if you had problems fixing
432 the compilation failure then you are probably not qualified for this.
433
434 @section I'm using libavcodec from within my C++ application but the linker complains about missing symbols which seem to be available.
435
436 FFmpeg is a pure C project, so to use the libraries within your C++ application
437 you need to explicitly state that you are using a C library. You can do this by
438 encompassing your FFmpeg includes using @code{extern "C"}.
439
440 See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}
441
442 @section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
443
444 You have to implement a URLProtocol, see libavformat/file.c in FFmpeg
445 and libmpdemux/demux_lavf.c in MPlayer sources.
446
447 @section I get "No compatible shell script interpreter found." in MSys.
448
449 The standard MSys bash (2.04) is broken. You need to install 2.05 or later.
450
451 @section I get "./configure: line <xxx>: pr: command not found" in MSys.
452
453 The standard MSys install doesn't come with pr. You need to get it from the coreutils package.
454
455 @section I tried to pass RTP packets into a decoder, but it doesn't work.
456
457 RTP is a container format like any other, you must first depacketize the
458 codec frames/samples stored in RTP and then feed to the decoder.
459
460 @section Where can I find libav* headers for Pascal/Delphi?
461
462 see @url{http://www.iversenit.dk/dev/ffmpeg-headers/}
463
464 @section Where is the documentation about ffv1, msmpeg4, asv1, 4xm?
465
466 see @url{http://svn.mplayerhq.hu/michael/trunk/docs/}
467
468 @section How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?
469
470 Even if peculiar since it is network oriented, RTP is a container like any
471 other. You have to @emph{demux} RTP before feeding the payload to libavcodec.
472 In this specific case please look at RFC 4629 to see how it should be done.
473
474 @section AVStream.r_frame_rate is wrong, it is much larger than the framerate.
475
476 r_frame_rate is NOT the average framerate, it is the smallest framerate
477 that can accurately represent all timestamps. So no, it is not
478 wrong if it is larger than the average!
479 For example, if you have mixed 25 and 30 fps content, then r_frame_rate
480 will be 150.
481
482 @bye