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