Update the FAQ with the current status of image formats.
[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 How do I encode JPEGs to another format ?
20
21 If the JPEGs are named img1.jpg, img2.jpg, img3.jpg,..., use:
22
23 @example
24   ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
25 @end example
26
27 @samp{%d} is replaced by the image number.
28
29 @file{img%03d.jpg} generates @file{img001.jpg}, @file{img002.jpg}, etc...
30
31 The same system is used for the other image formats.
32
33 (Note: you need -f image2 for all image formats except GIF; see next section).
34
35 @section Only GIF is listed by -format. Is that the only accepted image format?
36
37 No, there are more; they are listed among the video codecs:
38   jpeg, png, ppm, pbm, pam, pgm.
39
40 For example:
41 @example
42   ffmpeg -f image2 -i menu.png -f image2 menu.jpg
43 @end example
44
45 The @file{menu.png} used as input will be converted to @file{menu.jpg}.
46
47 Instead of relying on file format self-recognition, you may also use
48 @table @option
49 @item -vcodec ppm
50 @item -vcodec png
51 @item -vcodec mjpeg
52 @end table
53 to force the encoding.
54
55 Applying that to the previous example:
56 @example
57   ffmpeg -f image2 -vcodec png -i menu.png -f image2 -vcodec mjpeg menu.jpg
58 @end example
59
60 Beware that there is no "jpeg" codec. Use "mjpeg" instead.
61
62 @section FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it ?
63
64 No. FFmpeg only supports open source codecs. Windows DLLs are not
65 portable, bloated and often slow.
66
67 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding ?
68
69 For multithreaded MPEG* encoding, the encoded slices must be independent,
70 otherwise thread n would practically have to wait for n-1 to finish, so it's
71 quite logical that there is a small reduction of quality. This is not a bug.
72
73 @section How can I read from the standard input or write to the standard output ?
74
75 Use @file{-} as filename.
76
77 @section Why does ffmpeg not decode audio in VOB files ?
78
79 The audio is AC3 (a.k.a. A/52). AC3 decoding is an optional component in ffmpeg
80 as the component that handles AC3 decoding (liba52) is currently released under
81 the GPL. If you have liba52 installed on your system, enable AC3 decoding
82 with @code{./configure --enable-a52}. Take care: by
83 enabling AC3, you automatically change the license of libavcodec from
84 LGPL to GPL.
85
86 @section Which codecs are supported by Windows ?
87
88 Windows does not support standard formats like MPEG very well, unless you
89 install some additional codecs
90
91 The following list of video codecs should work on most Windows systems:
92 @table @option
93 @item msmpeg4v2
94 .avi/.asf
95 @item msmpeg4
96 .asf only
97 @item wmv1
98 .asf only
99 @item wmv2
100 .asf only
101 @item mpeg4
102 only if you have some MPEG-4 codec installed like ffdshow or XviD
103 @item mpeg1
104 .mpg only
105 @end table
106 Note, ASF files often have .wmv or .wma extensions in Windows. It should also
107 be mentioned that Microsoft claims a patent on the ASF format, and may sue
108 or threaten users who create ASF files with non-Microsoft software. It is
109 strongly advised to avoid ASF where possible.
110
111 The following list of audio codecs should work on most Windows systems:
112 @table @option
113 @item adpcm_ima_wav
114 @item adpcm_ms
115 @item pcm
116 @item mp3
117 if some MP3 codec like LAME is installed
118 @end table
119
120 @section Why does the chrominance data seem to be sampled at a different time from the luminance data on bt8x8 captures on Linux?
121
122 This is a well-known bug in the bt8x8 driver. For 2.4.26 there is a patch at
123 (@url{http://mplayerhq.hu/~michael/bttv-420-2.4.26.patch}). This may also
124 apply cleanly to other 2.4-series kernels.
125
126 @section How do I avoid the ugly aliasing artifacts in bt8x8 captures on Linux?
127
128 Pass 'combfilter=1 lumafilter=1' to the bttv driver. Note though that 'combfilter=1'
129 will cause somewhat too strong filtering. A fix is to apply (@url{http://mplayerhq.hu/~michael/bttv-comb-2.4.26.patch})
130 or (@url{http://mplayerhq.hu/~michael/bttv-comb-2.6.6.patch})
131 and pass 'combfilter=2'.
132
133 @section I have a problem with an old version of ffmpeg; where should I report it?
134 Nowhere. Upgrade to the latest release or if there is no recent release upgrade
135 to Subversion HEAD. You could also try to report it. Maybe you will get lucky and
136 become the first person in history to get an answer different from "upgrade
137 to Subversion HEAD".
138
139 @section -f jpeg doesn't work.
140
141 Try '-f image2 test%d.jpg'.
142
143 @section Why can I not change the framerate?
144
145 Some codecs, like MPEG-1/2, only allow a small number of fixed framerates.
146 Choose a different codec with the -vcodec command line option.
147
148 @section ffmpeg does not work; What is wrong?
149
150 Try a 'make distclean' in the ffmpeg source directory. If this does not help see
151 (@url{http://ffmpeg.org/bugreports.php}).
152
153 @section How do I encode XviD or DivX video with ffmpeg?
154
155 Both XviD and DivX (version 4+) are implementations of the ISO MPEG-4
156 standard (note that there are many other coding formats that use this
157 same standard). Thus, use '-vcodec mpeg4' to encode these formats. The
158 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
159 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
160 force the fourcc 'xvid' to be stored as the video fourcc rather than the
161 default.
162
163 @section How do I encode videos which play on the iPod?
164
165 @table @option
166 @item needed stuff
167 -acodec aac -vcodec mpeg4 width<=320 height<=240
168 @item working stuff
169 4mv, title
170 @item non-working stuff
171 B-frames
172 @item example command line
173 ffmpeg -i input -acodec aac -ab 128 -vcodec mpeg4 -b 1200 -mbd 2 -flags +4mv+trell -aic 2 -cmp 2 -subcmp 2 -s 320x180 -title X output.mp4
174 @end table
175
176 @section How do I encode videos which play on the PSP?
177
178 @table @option
179 @item needed stuff
180 -acodec aac -vcodec mpeg4 width*height<=76800 width%16=0 height%16=0 -ar 24000 -r 30000/1001 or 15000/1001 -f psp
181 @item working stuff
182 4mv, title
183 @item non-working stuff
184 B-frames
185 @item example command line
186 ffmpeg -i input -acodec aac -ab 128 -vcodec mpeg4 -b 1200 -ar 24000 -mbd 2 -flags +4mv+trell -aic 2 -cmp 2 -subcmp 2 -s 368x192 -r 30000/1001 -title X -f psp output.mp4
187 @item needed stuff for H.264
188 -acodec aac -vcodec h264 width*height<=76800 width%16=0? height%16=0? -ar 48000 -coder 1 -r 30000/1001 or 15000/1001 -f psp
189 @item working stuff for H.264
190 title, loop filter
191 @item non-working stuff for H.264
192 CAVLC
193 @item example command line
194 ffmpeg -i input -acodec aac -ab 128 -vcodec h264 -b 1200 -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
195 @end table
196
197 @chapter Development
198
199 @section When will the next FFmpeg version be released? / Why are FFmpeg releases so few and far between?
200
201 Like most open source projects FFmpeg suffers from a certain lack of
202 manpower. For this reason the developers have to prioritize the work
203 they do and putting out releases is not at the top of the list, fixing
204 bugs and reviewing patches takes precedence. Please don't complain or
205 request more timely and/or frequent releases unless you are willing to
206 help out creating them.
207
208 @section Why doesn't FFmpeg support feature [xyz]?
209
210 Because no one has taken on that task yet. FFmpeg development is
211 driven by the tasks that are important to the individual developers.
212 If there is a feature that is important to you, the best way to get
213 it implemented is to undertake the task yourself.
214
215
216 @section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat ?
217
218 Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
219 examine the source code for one of the many open source projects that
220 already incorporate ffmpeg at (@url{projects.php}).
221
222 @section Can you support my C compiler XXX ?
223
224 No. Only GCC is supported. GCC is ported to most systems available and there
225 is no need to pollute the source code with @code{#ifdef}s
226 related to the compiler.
227
228 @section Can I use FFmpeg or libavcodec under Windows ?
229
230 Yes, but the MinGW tools @emph{must} be used to compile FFmpeg. You
231 can link the resulting DLLs with any other Windows program. Read the
232 @emph{Native Windows Compilation} and @emph{Visual C++ compatibility}
233 sections in the FFmpeg documentation to find more information.
234
235 @section Can you add automake, libtool or autoconf support ?
236
237 No. These tools are too bloated and they complicate the build. Moreover,
238 since only @samp{gcc} is supported they would add little advantages in
239 terms of portability.
240
241 @section Why not rewrite ffmpeg in object-oriented C++ ?
242
243 ffmpeg is already organized in a highly modular manner and does not need to
244 be rewritten in a formal object language. Further, many of the developers
245 favor straight C; it works for them. For more arguments on this matter,
246 read "Programming Religion" at (@url{http://lkml.org/faq/lkmlfaq-15.html}).
247
248 @section Why are the ffmpeg programs devoid of debugging symbols ?
249
250 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
251 information. Those binaries are strip'd to create ffmpeg, ffplay, etc. If
252 you need the debug information, used the *_g versions.
253
254 @section I do not like the LGPL, can I contribute code under the GPL instead ?
255
256 Yes, as long as the code is optional and can easily and cleanly be placed
257 under #ifdef CONFIG_GPL without breaking anything. So for example a new codec
258 or filter would be OK under GPL while a bugfix to LGPL code would not.
259
260 @section I want to compile xyz.c alone but my compiler produced many errors.
261
262 Common code is in its own files in libav* and is used by the individual
263 codecs. They will not work without the common parts, you have to compile
264 the whole libav*. If you wish, disable some parts with configure switches.
265 You can also try to hack it and remove more, but if you had problems fixing
266 the compilation failure then you are probably not qualified for this.
267
268 @section Visual C++ produces many errors.
269
270 Visual C++ is not compliant to the C standard and does not support
271 the inline assembly used in FFmpeg.
272 If you wish - for whatever weird reason - to use Visual C++ for your
273 project then you can link the Visual C++ code with libav* as long as
274 you compile the latter with a working C compiler. For more information, see
275 the @emph{Visual C++ compatibility} section in the FFmpeg documentation.
276
277 There have been efforts to make FFmpeg compatible with Visual C++ in the
278 past. However, they have all been rejected as too intrusive, especially
279 since MinGW does the job perfectly adequately. None of the core developers
280 work with Visual C++ and thus this item is low priority. Should you find
281 the silver bullet that solves this problem, feel free to shoot it at us.
282
283 @section I have a file in memory / a API different from *open/*read/ libc how do i use it with libavformat ?
284
285 You have to implement a URLProtocol, see libavformat/file.c in FFmpeg
286 and libmpdemux/demux_lavf.c in MPlayer sources.
287
288 @bye