doc/git-howto: expand format-patch and send-email notes.
[ffmpeg.git] / doc / faq.texi
index b76f4e7..affe88b 100644 (file)
@@ -1,51 +1,54 @@
 \input texinfo @c -*- texinfo -*-
 
-@settitle FFmpeg FAQ
+@settitle Libav FAQ
 @titlepage
-@sp 7
-@center @titlefont{FFmpeg FAQ}
-@sp 3
+@center @titlefont{Libav FAQ}
 @end titlepage
 
+@top
+
+@contents
 
 @chapter General Questions
 
-@section When will the next FFmpeg version be released? / Why are FFmpeg releases so few and far between?
+@section When will the next Libav version be released? / Why are Libav releases so few and far between?
 
-Like most open source projects FFmpeg suffers from a certain lack of
+Like most open source projects Libav suffers from a certain lack of
 manpower. For this reason the developers have to prioritize the work
 they do and putting out releases is not at the top of the list, fixing
 bugs and reviewing patches takes precedence. Please don't complain or
 request more timely and/or frequent releases unless you are willing to
 help out creating them.
 
-@section I have a problem with an old version of FFmpeg; where should I report it?
-Nowhere. Upgrade to the latest release or if there is no recent release upgrade
-to Subversion HEAD. You could also try to report it. Maybe you will get lucky and
-become the first person in history to get an answer different from "upgrade
-to Subversion HEAD".
+@section I have a problem with an old version of Libav; where should I report it?
+Nowhere. We do not support old Libav versions in any way, we simply lack
+the time, motivation and manpower to do so. If you have a problem with an
+old version of Libav, upgrade to the latest git snapshot. If you
+still experience the problem, then you can report it according to our
+@uref{http://libav.org/bugreports.html, bug reporting guidelines}.
 
-@section Why doesn't FFmpeg support feature [xyz]?
+@section Why doesn't Libav support feature [xyz]?
 
-Because no one has taken on that task yet. FFmpeg development is
+Because no one has taken on that task yet. Libav development is
 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
 it implemented is to undertake the task yourself or sponsor a developer.
 
-@section FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?
+@section Libav does not support codec XXX. Can you include a Windows DLL loader to support it?
 
 No. Windows DLLs are not portable, bloated and often slow.
-Moreover FFmpeg strives to support all codecs natively.
+Moreover Libav strives to support all codecs natively.
 A DLL loader is not conducive to that goal.
 
-@section My bug report/mail to ffmpeg-devel/user has not received any replies.
+@section My bug report/mail to libav-devel/user has not received any replies.
 
 Likely reasons
 @itemize
 @item We are busy and haven't had time yet to read your report or
 investigate the issue.
-@item You didn't follow bugreports.html.
-@item You didn't use Subversion HEAD.
+@item You did not follow our
+      @uref{http://libav.org/bugreports.html, bug reporting guidelines}.
+@item You didn't use git master.
 @item You reported a segmentation fault without gdb output.
 @item You describe a problem but not how to reproduce it.
 @item It's unclear if you use ffmpeg as command line tool or use
@@ -53,10 +56,10 @@ libav* from another application.
 @item You speak about a video having problems on playback but
 not what you use to play it.
 @item We have no faint clue what you are talking about besides
-that it is related to FFmpeg.
+that it is related to Libav.
 @end itemize
 
-@section Is there a forum for FFmpeg? I do not like mailing lists.
+@section Is there a forum for Libav? I do not like mailing lists.
 
 You may view our mailing lists with a more forum-alike look here:
 @url{http://dir.gmane.org/gmane.comp.video.ffmpeg.user},
@@ -85,7 +88,7 @@ The following list of video codecs should work on most Windows systems:
 .asf only
 @item mpeg4
 Only if you have some MPEG-4 codec like ffdshow or Xvid installed.
-@item mpeg1
+@item mpeg1video
 .mpg only
 @end table
 Note, ASF files often have .wmv or .wma extensions in Windows. It should also
@@ -97,9 +100,9 @@ The following list of audio codecs should work on most Windows systems:
 @table @option
 @item adpcm_ima_wav
 @item adpcm_ms
-@item pcm
+@item pcm_s16le
 always
-@item mp3
+@item libmp3lame
 If some MP3 codec like LAME is installed.
 @end table
 
@@ -121,8 +124,9 @@ problem and an NP-hard problem...
 
 @section ffmpeg does not work; what is wrong?
 
-Try a @code{make distclean} in the ffmpeg source directory before the build. If this does not help see
-(@url{http://ffmpeg.org/bugreports.html}).
+Try a @code{make distclean} in the ffmpeg source directory before the build.
+If this does not help see our
+@uref{http://libav.org/bugreports.html, bug reporting guidelines}.
 
 @section How do I encode single pictures into movies?
 
@@ -138,6 +142,25 @@ Notice that @samp{%d} is replaced by the image number.
 
 @file{img%03d.jpg} means the sequence @file{img001.jpg}, @file{img002.jpg}, etc...
 
+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
+  x=1; for i in *jpg; do counter=$(printf %03d $x); ln -s "$i" /tmp/img"$counter".jpg; x=$(($x+1)); done
+@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
+
 The same logic is used for any image format that ffmpeg reads.
 
 @section How do I encode movie to single pictures?
@@ -166,11 +189,6 @@ Applying that to the previous example:
 
 Beware that there is no "jpeg" codec. Use "mjpeg" instead.
 
-@section I get "Unsupported codec (id=86043) for input stream #0.1". What is the problem?
-
-This is the Qcelp codec, FFmpeg has no support for that codec currently.
-Try MEncoder/MPlayer, it might work.
-
 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
 
 For multithreaded MPEG* encoding, the encoded slices must be independent,
@@ -181,27 +199,6 @@ quite logical that there is a small reduction of quality. This is not a bug.
 
 Use @file{-} as file name.
 
-@section Why does FFmpeg not decode audio in VOB files?
-
-The audio is AC-3 (a.k.a. A/52). AC-3 decoding is an optional component in FFmpeg
-as the component that handles AC-3 decoding is currently released under the GPL.
-Enable AC-3 decoding with @code{./configure --enable-gpl}. Take care: By
-enabling AC-3, you automatically change the license of libavcodec from
-LGPL to GPL.
-
-@section Why does the chrominance data seem to be sampled at a different time from the luminance data on bt8x8 captures on Linux?
-
-This is a well-known bug in the bt8x8 driver. For 2.4.26 there is a patch at
-(@url{http://svn.mplayerhq.hu/michael/trunk/patches/bttv-420-2.4.26.patch?view=co}). This may also
-apply cleanly to other 2.4-series kernels.
-
-@section How do I avoid the ugly aliasing artifacts in bt8x8 captures on Linux?
-
-Pass 'combfilter=1 lumafilter=1' to the bttv driver. Note though that 'combfilter=1'
-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})
-or (@url{http://svn.mplayerhq.hu/michael/trunk/patches/bttv-comb-2.6.6.patch?view=co})
-and pass 'combfilter=2'.
-
 @section -f jpeg doesn't work.
 
 Try '-f image2 test%d.jpg'.
@@ -227,11 +224,11 @@ default.
 @item needed stuff
 -acodec libfaac -vcodec mpeg4 width<=320 height<=240
 @item working stuff
-4mv, title
+mv4, title
 @item non-working stuff
 B-frames
 @item example command line
-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
+ffmpeg -i input -acodec libfaac -ab 128k -vcodec mpeg4 -b 1200k -mbd 2 -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -s 320x180 -metadata title=X output.mp4
 @end table
 
 @section How do I encode videos which play on the PSP?
@@ -240,11 +237,11 @@ ffmpeg -i input -acodec libfaac -ab 128kb -vcodec mpeg4 -b 1200kb -mbd 2 -flags
 @item needed stuff
 -acodec libfaac -vcodec mpeg4 width*height<=76800 width%16=0 height%16=0 -ar 24000 -r 30000/1001 or 15000/1001 -f psp
 @item working stuff
-4mv, title
+mv4, title
 @item non-working stuff
 B-frames
 @item example command line
-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
+ffmpeg -i input -acodec libfaac -ab 128k -vcodec mpeg4 -b 1200k -ar 24000 -mbd 2 -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -s 368x192 -r 30000/1001 -metadata title=X -f psp output.mp4
 @item needed stuff for H.264
 -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
 @item working stuff for H.264
@@ -252,21 +249,21 @@ title, loop filter
 @item non-working stuff for H.264
 CAVLC
 @item example command line
-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 -title X -f psp -flags loop -trellis 2 -partitions parti4x4+parti8x8+partp4x4+partp8x8+partb8x8 output.mp4
+ffmpeg -i input -acodec libfaac -ab 128k -vcodec libx264 -b 1200k -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
 @item higher resolution for newer PSP firmwares, width<=480, height<=272
 -vcodec libx264 -level 21 -coder 1 -f psp
 @item example command line
-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
+ffmpeg -i input -acodec libfaac -ab 128k -ac 2 -ar 48000 -vcodec libx264 -level 21 -b 640k -coder 1 -f psp -flags +loop -trellis 2 -partitions +parti4x4+parti8x8+partp4x4+partp8x8+partb8x8 -g 250 -s 480x272 output.mp4
 @end table
 
 @section Which are good parameters for encoding high quality MPEG-4?
 
-'-mbd rd -flags +4mv+trell+aic -cmp 2 -subcmp 2 -g 300 -pass 1/2',
+'-mbd rd -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -g 300 -pass 1/2',
 things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd'.
 
 @section Which are good parameters for encoding high quality MPEG-1/MPEG-2?
 
-'-mbd rd -flags +trell -cmp 2 -subcmp 2 -g 100 -pass 1/2'
+'-mbd rd -trellis 2 -cmp 2 -subcmp 2 -g 100 -pass 1/2'
 but beware the '-g 100' might cause problems with some decoders.
 Things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd.
 
@@ -277,22 +274,21 @@ material, and try '-top 0/1' if the result looks really messed-up.
 
 @section How can I read DirectShow files?
 
-If you have built FFmpeg with @code{./configure --enable-avisynth}
+If you have built Libav with @code{./configure --enable-avisynth}
 (only possible on MinGW/Cygwin platforms),
 then you may use any file that DirectShow can read as input.
-(Be aware that this feature has been recently added,
-so you will need to help yourself in case of problems.)
 
 Just create an "input.avs" text file with this single line ...
 @example
   DirectShowSource("C:\path to your file\yourfile.asf")
 @end example
-... and then feed that text file to FFmpeg:
+... and then feed that text file to ffmpeg:
 @example
   ffmpeg -i input.avs
 @end example
 
-For ANY other help on Avisynth, please visit @url{http://www.avisynth.org/}.
+For ANY other help on Avisynth, please visit the
+@uref{http://www.avisynth.org/, Avisynth homepage}.
 
 @section How can I join video files?
 
@@ -329,6 +325,10 @@ ffmpeg -f mpeg -i - -sameq -vcodec mpeg4 -acodec libmp3lame output.avi
 
 Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
 allow concatenation, and the transcoding step is almost lossless.
+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.
 
 For example, let's say we want to join two FLV files into an output.flv file:
 
@@ -342,7 +342,7 @@ 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 &
-ffmpeg -i input2.flv -an -f yuv4mpegpipe - > temp2.v < /dev/null &
+@{ ffmpeg -i input2.flv -an -f yuv4mpegpipe - < /dev/null | tail -n +2 > temp2.v ; @} &
 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 \
@@ -351,7 +351,7 @@ ffmpeg -f u16le -acodec pcm_s16le -ac 2 -ar 44100 -i all.a \
 rm temp[12].[av] all.[av]
 @end example
 
-@section FFmpeg does not adhere to the -maxrate setting, some frames are bigger than maxrate/fps.
+@section The ffmpeg program does not respect the -maxrate setting, some frames are bigger than maxrate/fps.
 
 Read the MPEG spec about video buffer verifier.
 
@@ -371,11 +371,11 @@ examining all of the vbv_delay values and making complicated computations."
 
 @chapter Development
 
-@section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
+@section Are there examples illustrating how to use the Libav libraries, particularly libavcodec and libavformat?
 
-Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
+Yes. Read the Developers Guide of the Libav documentation. Alternatively,
 examine the source code for one of the many open source projects that
-already incorporate FFmpeg at (@url{projects.html}).
+already incorporate Libav at (@url{projects.html}).
 
 @section Can you support my C compiler XXX?
 
@@ -386,14 +386,14 @@ with @code{#ifdef}s related to the compiler.
 @section Is Microsoft Visual C++ supported?
 
 No. Microsoft Visual C++ is not compliant to the C99 standard and does
-not - among other things - support the inline assembly used in FFmpeg.
+not - among other things - support the inline assembly used in Libav.
 If you wish to use MSVC++ for your
 project then you can link the MSVC++ code with libav* as long as
 you compile the latter with a working C compiler. For more information, see
-the @emph{Microsoft Visual C++ compatibility} section in the FFmpeg
+the @emph{Microsoft Visual C++ compatibility} section in the Libav
 documentation.
 
-There have been efforts to make FFmpeg compatible with MSVC++ in the
+There have been efforts to make Libav compatible with MSVC++ in the
 past. However, they have all been rejected as too intrusive, especially
 since MinGW does the job adequately. None of the core developers
 work with MSVC++ and thus this item is low priority. Should you find
@@ -401,37 +401,27 @@ the silver bullet that solves this problem, feel free to shoot it at us.
 
 We strongly recommend you to move over from MSVC++ to MinGW tools.
 
-@section Can I use FFmpeg or libavcodec under Windows?
+@section Can I use Libav or libavcodec under Windows?
 
-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
+Yes, but the Cygwin or MinGW tools @emph{must} be used to compile Libav.
+Read the @emph{Windows} section in the Libav documentation to find more
 information.
 
-To get help and instructions for building FFmpeg under Windows, check out
-the FFmpeg Windows Help Forum at
-@url{http://ffmpeg.arrozcru.org/}.
-
 @section Can you add automake, libtool or autoconf support?
 
 No. These tools are too bloated and they complicate the build.
 
 @section Why not rewrite ffmpeg in object-oriented C++?
 
-FFmpeg is already organized in a highly modular manner and does not need to
+Libav is already organized in a highly modular manner and does not need to
 be rewritten in a formal object language. Further, many of the developers
 favor straight C; it works for them. For more arguments on this matter,
-read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
-
-@section Why are the ffmpeg programs devoid of debugging symbols?
-
-The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
-information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
-you need the debug information, used the *_g versions.
+read @uref{http://www.tux.org/lkml/#s15, "Programming Religion"}.
 
 @section I do not like the LGPL, can I contribute code under the GPL instead?
 
 Yes, as long as the code is optional and can easily and cleanly be placed
-under #ifdef CONFIG_GPL without breaking anything. So for example a new codec
+under #if CONFIG_GPL without breaking anything. So for example a new codec
 or filter would be OK under GPL while a bug fix to LGPL code would not.
 
 @section I want to compile xyz.c alone but my compiler produced many errors.
@@ -444,16 +434,21 @@ the compilation failure then you are probably not qualified for this.
 
 @section I'm using libavcodec from within my C++ application but the linker complains about missing symbols which seem to be available.
 
-FFmpeg is a pure C project, so to use the libraries within your C++ application
+Libav is a pure C project, so to use the libraries within your C++ application
 you need to explicitly state that you are using a C library. You can do this by
-encompassing your FFmpeg includes using @code{extern "C"}.
+encompassing your Libav includes using @code{extern "C"}.
 
 See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}
 
+@section I'm using libavutil from within my C++ application but the compiler complains about 'UINT64_C' was not declared in this scope
+
+Libav is a pure C project using C99 math features, in order to enable C++
+to use them you have to append -D__STDC_CONSTANT_MACROS to your CXXFLAGS
+
 @section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
 
-You have to implement a URLProtocol, see libavformat/file.c in FFmpeg
-and libmpdemux/demux_lavf.c in MPlayer sources.
+You have to implement a URLProtocol, see @file{libavformat/file.c} in
+Libav and @file{libmpdemux/demux_lavf.c} in MPlayer sources.
 
 @section I get "No compatible shell script interpreter found." in MSys.
 
@@ -463,18 +458,13 @@ The standard MSys bash (2.04) is broken. You need to install 2.05 or later.
 
 The standard MSys install doesn't come with pr. You need to get it from the coreutils package.
 
-@section I tried to pass RTP packets into a decoder, but it doesn't work.
-
-RTP is a container format like any other, you must first depacketize the
-codec frames/samples stored in RTP and then feed to the decoder.
-
 @section Where can I find libav* headers for Pascal/Delphi?
 
 see @url{http://www.iversenit.dk/dev/ffmpeg-headers/}
 
 @section Where is the documentation about ffv1, msmpeg4, asv1, 4xm?
 
-see @url{http://svn.mplayerhq.hu/michael/trunk/docs/}
+see @url{http://www.ffmpeg.org/~michael/}
 
 @section How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?