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