Elaborate on the Visual C-- situation.
[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 Problems
12
13 @section I cannot read this file although this format seems to be supported by ffmpeg.
14
15 Even if ffmpeg can read the file format, it may not support all its
16 codecs. Please consult the supported codec list in the ffmpeg
17 documentation.
18
19 @section I get audio/video synchronization problems when grabbing.
20
21 Currently, the grabbing stuff does not handle synchronisation
22 correctly. You are free to correct it. A fix is planned.
23
24 @section How do I encode JPEGs to another format ?
25
26 If the JPEGs are named img1.jpg, img2.jpg, img3.jpg,..., use:
27
28 @example
29   ffmpeg -i img%d.jpg /tmp/a.mpg
30 @end example
31
32 @samp{%d} is replaced by the image number.
33
34 @file{img%03d.jpg} generates @file{img001.jpg}, @file{img002.jpg}, etc...
35
36 The same system is used for the other image formats.
37
38 @section FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it ?
39
40 No. FFmpeg only supports open source codecs. Windows DLLs are not
41 portable, bloated and often slow.
42
43 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding ?
44
45 For multithreaded MPEG* encoding, the encoded slices must be independent,
46 otherwise thread n would practically have to wait for n-1 to finish, so it's
47 quite logical that there is a small reduction of quality. This is not a bug.
48
49 @section How can I read from the standard input or write to the standard output ?
50
51 Use @file{-} as filename.
52
53 @section Why does ffmpeg not decode audio in VOB files ?
54
55 The audio is AC3 (a.k.a. A/52). AC3 decoding is an optional component in ffmpeg
56 as the component that handles AC3 decoding (liba52) is currently released under 
57 the GPL. If you have liba52 installed on your system, enable AC3 decoding
58 with @code{./configure --enable-a52}. Take care: by
59 enabling AC3, you automatically change the license of libavcodec from
60 LGPL to GPL.
61
62 @section Which codecs are supported by Windows ?
63
64 Windows does not support standard formats like MPEG very well, unless you 
65 install some additional codecs
66
67 The following list of video codecs should work on most Windows systems:
68 @table @option
69 @item msmpeg4v2
70 .avi/.asf
71 @item msmpeg4
72 .asf only
73 @item wmv1
74 .asf only
75 @item wmv2
76 .asf only
77 @item mpeg4
78 only if you have some MPEG-4 codec installed like ffdshow or XviD
79 @item mpeg1
80 .mpg only
81 @end table
82 Note, ASF files often have .wmv or .wma extensions in Windows. It should also 
83 be mentioned that Microsoft claims a patent on the ASF format, and may sue 
84 or threaten users who create ASF files with non-Microsoft software. It is
85 strongly advised to avoid ASF where possible.
86
87 The following list of audio codecs should work on most Windows systems:
88 @table @option
89 @item adpcm_ima_wav
90 @item adpcm_ms
91 @item pcm
92 @item mp3
93 if some MP3 codec like LAME is installed
94 @end table
95
96 @section Why does the chrominance data seem to be sampled at a different time from the luminance data on bt8x8 captures on Linux?
97
98 This is a well-known bug in the bt8x8 driver. For 2.4.26 there is a patch at 
99 (@url{http://www.mplayerhq.hu/~michael/bttv-420-2.4.26.patch}). This may also
100 apply cleanly to other 2.4-series kernels.
101
102 @section How do I avoid the ugly aliasing artifacts in bt8x8 captures on Linux?
103
104 Pass 'combfilter=1 lumafilter=1' to the bttv driver. Note though that 'combfilter=1'
105 will cause somewhat too strong filtering. A fix is to apply (@url{http://www.mplayerhq.hu/~michael/bttv-comb-2.4.26.patch})
106 or (@url{http://www.mplayerhq.hu/~michael/bttv-comb-2.6.6.patch})
107 and pass 'combfilter=2'.
108
109 @section I have a problem with an old version of ffmpeg; where should I report it?
110 Nowhere. Upgrade to the latest release or if there is no recent release upgrade
111 to CVS. You could also try to report it. Maybe you will get lucky and
112 become the first person in history to get an answer different from "upgrade
113 to CVS".
114
115 @section -f jpeg doesn't work.
116
117 Try '-f image -img jpeg test%d.jpg'.
118
119 @section Why can I not change the framerate?
120
121 Some codecs, like MPEG-1/2, only allow a small number of fixed framerates.
122 Choose a different codec with the -vcodec command line option.
123
124 @section ffmpeg does not work; What is wrong?
125
126 Try a 'make distclean' in the ffmpeg source directory. If this does not help see
127 (@url{ffmpeg-bugreport.html}).
128
129 @section How do I encode XviD or DivX video with ffmpeg?
130
131 Both XviD and DivX (version 4+) are implementations of the ISO MPEG-4
132 standard (note that there are many other coding formats that use this
133 same standard). Thus, use '-vcodec mpeg4' to encode these formats. The
134 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
135 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will 
136 force the fourcc 'xvid' to be stored as the video fourcc rather than the 
137 default.
138
139 @chapter Development
140
141 @section Why doesn't FFmpeg support feature [xyz]?
142
143 Because no one has taken on that task yet. FFmpeg development is
144 driven by the tasks that are important to the individual developers.
145 If there is a feature that is important to you, the best way to get
146 it implemented is to undertake the task yourself.
147
148
149 @section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat ?
150
151 Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
152 examine the source code for one of the many open source projects that 
153 already incorporate ffmpeg at (@url{projects.php}).
154
155 @section Can you support my C compiler XXX ?
156
157 No. Only GCC is supported. GCC is ported to most systems available and there
158 is no need to pollute the source code with @code{#ifdef}s
159 related to the compiler.
160
161 @section Can I use FFmpeg or libavcodec under Windows ?
162
163 Yes, but the MinGW tools @emph{must} be used to compile FFmpeg. You
164 can link the resulting DLLs with any other Windows program. Read the
165 @emph{Native Windows Compilation} and @emph{Visual C++ compatibility}
166 sections in the FFmpeg documentation to find more information.
167
168 @section Can you add automake, libtool or autoconf support ?
169
170 No. These tools are too bloated and they complicate the build. Moreover,
171 since only @samp{gcc} is supported they would add little advantages in
172 terms of portability.
173
174 @section Why not rewrite ffmpeg in object-oriented C++ ?
175
176 ffmpeg is already organized in a highly modular manner and does not need to
177 be rewritten in a formal object language. Further, many of the developers 
178 favor straight C; it works for them. For more arguments on this matter,
179 read "Programming Religion" at (@url{http://lkml.org/faq/lkmlfaq-15.html}).
180
181 @section Why are the ffmpeg programs devoid of debugging symbols ?
182
183 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
184 information. Those binaries are strip'd to create ffmpeg, ffplay, etc. If
185 you need the debug information, used the *_g versions.
186
187 @section I do not like the LGPL, can I contribute code under the GPL instead ?
188
189 Yes, as long as the code is optional and can easily and cleanly be placed
190 under #ifdef CONFIG_GPL without breaking anything. So for example a new codec
191 or filter would be OK under GPL while a bugfix to LGPL code would not.
192
193 @section I want to compile xyz.c alone but my compiler produced many errors.
194
195 Common code is in its own files in libav* and is used by the individual
196 codecs. They will not work without the common parts, you have to compile
197 the whole libav*. If you wish, disable some parts with configure switches.
198 You can also try to hack it and remove more, but if you had problems fixing
199 the compilation failure then you are probably not qualified for this.
200
201 @section Visual C++ produces many errors.
202
203 Visual C++ is not compliant to the C standard and does not support
204 the inline assembly used in FFmpeg.
205 If you wish - for whatever weird reason - to use Visual C++ for your
206 project then you can link the Visual C++ code with libav* as long as
207 you compile the latter with a working C compiler. For more information, see
208 the @emph{Visual C++ compatibility} section in the FFmpeg documentation.
209
210 There have been efforts to make FFmpeg compatible with Visual C++ in the
211 past. However, they have all been rejected as too intrusive, especially
212 since MinGW does the job perfectly adequately. None of the core developers
213 work with Visual C++ and thus this item is low priority. Should you find
214 the silver bullet that solves this problem, feel free to shoot it at us.
215
216 @bye