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