Prevent low delay from being used with mpeg1.
[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 Also note that (some of) the gcc developers believe this is not a bug or
113 not a bug they should fix:
114 @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=11203}.
115 Then again, some of them do not know the difference between an undecidable
116 problem and an NP-hard problem...
117
118 @chapter Usage
119
120 @section ffmpeg does not work; what is wrong?
121
122 Try a @code{make distclean} in the ffmpeg source directory before the build. If this does not help see
123 (@url{http://ffmpeg.org/bugreports.html}).
124
125 @section How do I encode single pictures into movies?
126
127 First, rename your pictures to follow a numerical sequence.
128 For example, img1.jpg, img2.jpg, img3.jpg,...
129 Then you may run:
130
131 @example
132   ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
133 @end example
134
135 Notice that @samp{%d} is replaced by the image number.
136
137 @file{img%03d.jpg} means the sequence @file{img001.jpg}, @file{img002.jpg}, etc...
138
139 The same logic is used for any image format that ffmpeg reads.
140
141 @section How do I encode movie to single pictures?
142
143 Use:
144
145 @example
146   ffmpeg -i movie.mpg movie%d.jpg
147 @end example
148
149 The @file{movie.mpg} used as input will be converted to
150 @file{movie1.jpg}, @file{movie2.jpg}, etc...
151
152 Instead of relying on file format self-recognition, you may also use
153 @table @option
154 @item -vcodec ppm
155 @item -vcodec png
156 @item -vcodec mjpeg
157 @end table
158 to force the encoding.
159
160 Applying that to the previous example:
161 @example
162   ffmpeg -i movie.mpg -f image2 -vcodec mjpeg menu%d.jpg
163 @end example
164
165 Beware that there is no "jpeg" codec. Use "mjpeg" instead.
166
167 @section I get "Unsupported codec (id=86043) for input stream #0.1". What is the problem?
168
169 This is the Qcelp codec, FFmpeg has no support for that codec currently.
170 Try MEncoder/MPlayer, it might work.
171
172 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
173
174 For multithreaded MPEG* encoding, the encoded slices must be independent,
175 otherwise thread n would practically have to wait for n-1 to finish, so it's
176 quite logical that there is a small reduction of quality. This is not a bug.
177
178 @section How can I read from the standard input or write to the standard output?
179
180 Use @file{-} as file name.
181
182 @section Why does FFmpeg not decode audio in VOB files?
183
184 The audio is AC-3 (a.k.a. A/52). AC-3 decoding is an optional component in FFmpeg
185 as the component that handles AC-3 decoding is currently released under the GPL.
186 Enable AC-3 decoding with @code{./configure --enable-gpl}. Take care: By
187 enabling AC-3, you automatically change the license of libavcodec from
188 LGPL to GPL.
189
190 @section Why does the chrominance data seem to be sampled at a different time from the luminance data on bt8x8 captures on Linux?
191
192 This is a well-known bug in the bt8x8 driver. For 2.4.26 there is a patch at
193 (@url{http://svn.mplayerhq.hu/michael/trunk/patches/bttv-420-2.4.26.patch?view=co}). This may also
194 apply cleanly to other 2.4-series kernels.
195
196 @section How do I avoid the ugly aliasing artifacts in bt8x8 captures on Linux?
197
198 Pass 'combfilter=1 lumafilter=1' to the bttv driver. Note though that 'combfilter=1'
199 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})
200 or (@url{http://svn.mplayerhq.hu/michael/trunk/patches/bttv-comb-2.6.6.patch?view=co})
201 and pass 'combfilter=2'.
202
203 @section -f jpeg doesn't work.
204
205 Try '-f image2 test%d.jpg'.
206
207 @section Why can I not change the framerate?
208
209 Some codecs, like MPEG-1/2, only allow a small number of fixed framerates.
210 Choose a different codec with the -vcodec command line option.
211
212 @section How do I encode Xvid or DivX video with ffmpeg?
213
214 Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
215 standard (note that there are many other coding formats that use this
216 same standard). Thus, use '-vcodec mpeg4' to encode in these formats. The
217 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
218 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
219 force the fourcc 'xvid' to be stored as the video fourcc rather than the
220 default.
221
222 @section How do I encode videos which play on the iPod?
223
224 @table @option
225 @item needed stuff
226 -acodec libfaac -vcodec mpeg4 width<=320 height<=240
227 @item working stuff
228 4mv, title
229 @item non-working stuff
230 B-frames
231 @item example command line
232 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
233 @end table
234
235 @section How do I encode videos which play on the PSP?
236
237 @table @option
238 @item needed stuff
239 -acodec libfaac -vcodec mpeg4 width*height<=76800 width%16=0 height%16=0 -ar 24000 -r 30000/1001 or 15000/1001 -f psp
240 @item working stuff
241 4mv, title
242 @item non-working stuff
243 B-frames
244 @item example command line
245 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
246 @item needed stuff for H.264
247 -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
248 @item working stuff for H.264
249 title, loop filter
250 @item non-working stuff for H.264
251 CAVLC
252 @item example command line
253 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
254 @end table
255
256 @section Which are good parameters for encoding high quality MPEG-4?
257
258 '-mbd rd -flags +4mv+trell+aic -cmp 2 -subcmp 2 -g 300 -pass 1/2',
259 things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd'.
260
261 @section Which are good parameters for encoding high quality MPEG-1/MPEG-2?
262
263 '-mbd rd -flags +trell -cmp 2 -subcmp 2 -g 100 -pass 1/2'
264 but beware the '-g 100' might cause problems with some decoders.
265 Things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd.
266
267 @section Interlaced video looks very bad when encoded with ffmpeg, what is wrong?
268
269 You should use '-flags +ilme+ildct' and maybe '-flags +alt' for interlaced
270 material, and try '-top 0/1' if the result looks really messed-up.
271
272 @section How can I read DirectShow files?
273
274 If you have built FFmpeg with @code{./configure --enable-avisynth}
275 (only possible on MinGW/Cygwin platforms),
276 then you may use any file that DirectShow can read as input.
277 (Be aware that this feature has been recently added,
278 so you will need to help yourself in case of problems.)
279
280 Just create an "input.avs" text file with this single line ...
281 @example
282   DirectShowSource("C:\path to your file\yourfile.asf")
283 @end example
284 ... and then feed that text file to FFmpeg:
285 @example
286   ffmpeg -i input.avs
287 @end example
288
289 For ANY other help on Avisynth, please visit @url{http://www.avisynth.org/}.
290
291 @section How can I join video files?
292
293 A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow to join video files by
294 merely concatenating them.
295
296 Hence you may concatenate your multimedia files by first transcoding them to
297 these privileged formats, then using the humble @code{cat} command (or the
298 equally humble @code{copy} under Windows), and finally transcoding back to your
299 format of choice.
300
301 @example
302 ffmpeg -i input1.avi -sameq intermediate1.mpg
303 ffmpeg -i input2.avi -sameq intermediate2.mpg
304 cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
305 ffmpeg -i intermediate_all.mpg -sameq output.avi
306 @end example
307
308 Notice that you should either use @code{-sameq} or set a reasonably high
309 bitrate for your intermediate and output files, if you want to preserve
310 video quality.
311
312 Also notice that you may avoid the huge intermediate files by taking advantage
313 of named pipes, should your platform support it:
314
315 @example
316 mkfifo intermediate1.mpg
317 mkfifo intermediate2.mpg
318 ffmpeg -i input1.avi -sameq -y intermediate1.mpg < /dev/null &
319 ffmpeg -i input2.avi -sameq -y intermediate2.mpg < /dev/null &
320 cat intermediate1.mpg intermediate2.mpg |\
321 ffmpeg -f mpeg -i - -sameq -vcodec mpeg4 -acodec libmp3lame output.avi
322 @end example
323
324 Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
325 allow concatenation, and the transcoding step is almost lossless.
326
327 For example, let's say we want to join two FLV files into an output.flv file:
328
329 @example
330 mkfifo temp1.a
331 mkfifo temp1.v
332 mkfifo temp2.a
333 mkfifo temp2.v
334 mkfifo all.a
335 mkfifo all.v
336 ffmpeg -i input1.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp1.a < /dev/null &
337 ffmpeg -i input2.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp2.a < /dev/null &
338 ffmpeg -i input1.flv -an -f yuv4mpegpipe - > temp1.v < /dev/null &
339 ffmpeg -i input2.flv -an -f yuv4mpegpipe - > temp2.v < /dev/null &
340 cat temp1.a temp2.a > all.a &
341 cat temp1.v temp2.v > all.v &
342 ffmpeg -f u16le -acodec pcm_s16le -ac 2 -ar 44100 -i all.a \
343        -f yuv4mpegpipe -i all.v \
344        -sameq -y output.flv
345 rm temp[12].[av] all.[av]
346 @end example
347
348 @section FFmpeg does not adhere to the -maxrate setting, some frames are bigger than maxrate/fps.
349
350 Read the MPEG spec about video buffer verifier.
351
352 @section I want CBR, but no matter what I do frame sizes differ.
353
354 You do not understand what CBR is, please read the MPEG spec.
355 Read about video buffer verifier and constant bitrate.
356 The one sentence summary is that there is a buffer and the input rate is
357 constant, the output can vary as needed.
358
359 @section How do I check if a stream is CBR?
360
361 To quote the MPEG-2 spec:
362 "There is no way to tell that a bitstream is constant bitrate without
363 examining all of the vbv_delay values and making complicated computations."
364
365
366 @chapter Development
367
368 @section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
369
370 Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
371 examine the source code for one of the many open source projects that
372 already incorporate FFmpeg at (@url{projects.html}).
373
374 @section Can you support my C compiler XXX?
375
376 It depends. If your compiler is C99-compliant, then patches to support
377 it are likely to be welcome if they do not pollute the source code
378 with @code{#ifdef}s related to the compiler.
379
380 @section Is Microsoft Visual C++ supported?
381
382 No. Microsoft Visual C++ is not compliant to the C99 standard and does
383 not - among other things - support the inline assembly used in FFmpeg.
384 If you wish to use MSVC++ for your
385 project then you can link the MSVC++ code with libav* as long as
386 you compile the latter with a working C compiler. For more information, see
387 the @emph{Microsoft Visual C++ compatibility} section in the FFmpeg
388 documentation.
389
390 There have been efforts to make FFmpeg compatible with MSVC++ in the
391 past. However, they have all been rejected as too intrusive, especially
392 since MinGW does the job adequately. None of the core developers
393 work with MSVC++ and thus this item is low priority. Should you find
394 the silver bullet that solves this problem, feel free to shoot it at us.
395
396 We strongly recommend you to move over from MSVC++ to MinGW tools.
397
398 @section Can I use FFmpeg or libavcodec under Windows?
399
400 Yes, but the Cygwin or MinGW tools @emph{must} be used to compile FFmpeg.
401 Read the @emph{Windows} section in the FFmpeg documentation to find more
402 information.
403
404 To get help and instructions for building FFmpeg under Windows, check out
405 the FFmpeg Windows Help Forum at
406 @url{http://arrozcru.no-ip.org/ffmpeg/}.
407
408 @section Can you add automake, libtool or autoconf support?
409
410 No. These tools are too bloated and they complicate the build.
411
412 @section Why not rewrite ffmpeg in object-oriented C++?
413
414 FFmpeg is already organized in a highly modular manner and does not need to
415 be rewritten in a formal object language. Further, many of the developers
416 favor straight C; it works for them. For more arguments on this matter,
417 read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
418
419 @section Why are the ffmpeg programs devoid of debugging symbols?
420
421 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
422 information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
423 you need the debug information, used the *_g versions.
424
425 @section I do not like the LGPL, can I contribute code under the GPL instead?
426
427 Yes, as long as the code is optional and can easily and cleanly be placed
428 under #ifdef CONFIG_GPL without breaking anything. So for example a new codec
429 or filter would be OK under GPL while a bug fix to LGPL code would not.
430
431 @section I want to compile xyz.c alone but my compiler produced many errors.
432
433 Common code is in its own files in libav* and is used by the individual
434 codecs. They will not work without the common parts, you have to compile
435 the whole libav*. If you wish, disable some parts with configure switches.
436 You can also try to hack it and remove more, but if you had problems fixing
437 the compilation failure then you are probably not qualified for this.
438
439 @section I'm using libavcodec from within my C++ application but the linker complains about missing symbols which seem to be available.
440
441 FFmpeg is a pure C project, so to use the libraries within your C++ application
442 you need to explicitly state that you are using a C library. You can do this by
443 encompassing your FFmpeg includes using @code{extern "C"}.
444
445 See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}
446
447 @section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
448
449 You have to implement a URLProtocol, see libavformat/file.c in FFmpeg
450 and libmpdemux/demux_lavf.c in MPlayer sources.
451
452 @section I get "No compatible shell script interpreter found." in MSys.
453
454 The standard MSys bash (2.04) is broken. You need to install 2.05 or later.
455
456 @section I get "./configure: line <xxx>: pr: command not found" in MSys.
457
458 The standard MSys install doesn't come with pr. You need to get it from the coreutils package.
459
460 @section I tried to pass RTP packets into a decoder, but it doesn't work.
461
462 RTP is a container format like any other, you must first depacketize the
463 codec frames/samples stored in RTP and then feed to the decoder.
464
465 @section Where can I find libav* headers for Pascal/Delphi?
466
467 see @url{http://www.iversenit.dk/dev/ffmpeg-headers/}
468
469 @section Where is the documentation about ffv1, msmpeg4, asv1, 4xm?
470
471 see @url{http://svn.mplayerhq.hu/michael/trunk/docs/}
472
473 @section How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?
474
475 Even if peculiar since it is network oriented, RTP is a container like any
476 other. You have to @emph{demux} RTP before feeding the payload to libavcodec.
477 In this specific case please look at RFC 4629 to see how it should be done.
478
479 @section AVStream.r_frame_rate is wrong, it is much larger than the framerate.
480
481 r_frame_rate is NOT the average framerate, it is the smallest framerate
482 that can accurately represent all timestamps. So no, it is not
483 wrong if it is larger than the average!
484 For example, if you have mixed 25 and 30 fps content, then r_frame_rate
485 will be 150.
486
487 @bye