Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / doc / faq.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FFmpeg FAQ
4 @titlepage
5 @center @titlefont{FFmpeg FAQ}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter General Questions
13
14 @section Why doesn't FFmpeg support feature [xyz]?
15
16 Because no one has taken on that task yet. FFmpeg development is
17 driven by the tasks that are important to the individual developers.
18 If there is a feature that is important to you, the best way to get
19 it implemented is to undertake the task yourself or sponsor a developer.
20
21 @section FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?
22
23 No. Windows DLLs are not portable, bloated and often slow.
24 Moreover FFmpeg strives to support all codecs natively.
25 A DLL loader is not conducive to that goal.
26
27 @section I cannot read this file although this format seems to be supported by ffmpeg.
28
29 Even if ffmpeg can read the container format, it may not support all its
30 codecs. Please consult the supported codec list in the ffmpeg
31 documentation.
32
33 @section Which codecs are supported by Windows?
34
35 Windows does not support standard formats like MPEG very well, unless you
36 install some additional codecs.
37
38 The following list of video codecs should work on most Windows systems:
39 @table @option
40 @item msmpeg4v2
41 .avi/.asf
42 @item msmpeg4
43 .asf only
44 @item wmv1
45 .asf only
46 @item wmv2
47 .asf only
48 @item mpeg4
49 Only if you have some MPEG-4 codec like ffdshow or Xvid installed.
50 @item mpeg1video
51 .mpg only
52 @end table
53 Note, ASF files often have .wmv or .wma extensions in Windows. It should also
54 be mentioned that Microsoft claims a patent on the ASF format, and may sue
55 or threaten users who create ASF files with non-Microsoft software. It is
56 strongly advised to avoid ASF where possible.
57
58 The following list of audio codecs should work on most Windows systems:
59 @table @option
60 @item adpcm_ima_wav
61 @item adpcm_ms
62 @item pcm_s16le
63 always
64 @item libmp3lame
65 If some MP3 codec like LAME is installed.
66 @end table
67
68
69 @chapter Compilation
70
71 @section @code{error: can't find a register in class 'GENERAL_REGS' while reloading 'asm'}
72
73 This is a bug in gcc. Do not report it to us. Instead, please report it to
74 the gcc developers. Note that we will not add workarounds for gcc bugs.
75
76 Also note that (some of) the gcc developers believe this is not a bug or
77 not a bug they should fix:
78 @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=11203}.
79 Then again, some of them do not know the difference between an undecidable
80 problem and an NP-hard problem...
81
82 @chapter Usage
83
84 @section ffmpeg does not work; what is wrong?
85
86 Try a @code{make distclean} in the ffmpeg source directory before the build.
87 If this does not help see
88 (@url{http://ffmpeg.org/bugreports.html}).
89
90 @section How do I encode single pictures into movies?
91
92 First, rename your pictures to follow a numerical sequence.
93 For example, img1.jpg, img2.jpg, img3.jpg,...
94 Then you may run:
95
96 @example
97   ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
98 @end example
99
100 Notice that @samp{%d} is replaced by the image number.
101
102 @file{img%03d.jpg} means the sequence @file{img001.jpg}, @file{img002.jpg}, etc...
103
104 If you have large number of pictures to rename, you can use the
105 following command to ease the burden. The command, using the bourne
106 shell syntax, symbolically links all files in the current directory
107 that match @code{*jpg} to the @file{/tmp} directory in the sequence of
108 @file{img001.jpg}, @file{img002.jpg} and so on.
109
110 @example
111   x=1; for i in *jpg; do counter=$(printf %03d $x); ln -s "$i" /tmp/img"$counter".jpg; x=$(($x+1)); done
112 @end example
113
114 If you want to sequence them by oldest modified first, substitute
115 @code{$(ls -r -t *jpg)} in place of @code{*jpg}.
116
117 Then run:
118
119 @example
120   ffmpeg -f image2 -i /tmp/img%03d.jpg /tmp/a.mpg
121 @end example
122
123 The same logic is used for any image format that ffmpeg reads.
124
125 @section How do I encode movie to single pictures?
126
127 Use:
128
129 @example
130   ffmpeg -i movie.mpg movie%d.jpg
131 @end example
132
133 The @file{movie.mpg} used as input will be converted to
134 @file{movie1.jpg}, @file{movie2.jpg}, etc...
135
136 Instead of relying on file format self-recognition, you may also use
137 @table @option
138 @item -c:v ppm
139 @item -c:v png
140 @item -c:v mjpeg
141 @end table
142 to force the encoding.
143
144 Applying that to the previous example:
145 @example
146   ffmpeg -i movie.mpg -f image2 -c:v mjpeg menu%d.jpg
147 @end example
148
149 Beware that there is no "jpeg" codec. Use "mjpeg" instead.
150
151 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
152
153 For multithreaded MPEG* encoding, the encoded slices must be independent,
154 otherwise thread n would practically have to wait for n-1 to finish, so it's
155 quite logical that there is a small reduction of quality. This is not a bug.
156
157 @section How can I read from the standard input or write to the standard output?
158
159 Use @file{-} as file name.
160
161 @section -f jpeg doesn't work.
162
163 Try '-f image2 test%d.jpg'.
164
165 @section Why can I not change the frame rate?
166
167 Some codecs, like MPEG-1/2, only allow a small number of fixed frame rates.
168 Choose a different codec with the -c:v command line option.
169
170 @section How do I encode Xvid or DivX video with ffmpeg?
171
172 Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
173 standard (note that there are many other coding formats that use this
174 same standard). Thus, use '-c:v mpeg4' to encode in these formats. The
175 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
176 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
177 force the fourcc 'xvid' to be stored as the video fourcc rather than the
178 default.
179
180 @section Which are good parameters for encoding high quality MPEG-4?
181
182 '-mbd rd -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -g 300 -pass 1/2',
183 things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd'.
184
185 @section Which are good parameters for encoding high quality MPEG-1/MPEG-2?
186
187 '-mbd rd -trellis 2 -cmp 2 -subcmp 2 -g 100 -pass 1/2'
188 but beware the '-g 100' might cause problems with some decoders.
189 Things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd.
190
191 @section Interlaced video looks very bad when encoded with ffmpeg, what is wrong?
192
193 You should use '-flags +ilme+ildct' and maybe '-flags +alt' for interlaced
194 material, and try '-top 0/1' if the result looks really messed-up.
195
196 @section How can I read DirectShow files?
197
198 If you have built FFmpeg with @code{./configure --enable-avisynth}
199 (only possible on MinGW/Cygwin platforms),
200 then you may use any file that DirectShow can read as input.
201
202 Just create an "input.avs" text file with this single line ...
203 @example
204   DirectShowSource("C:\path to your file\yourfile.asf")
205 @end example
206 ... and then feed that text file to ffmpeg:
207 @example
208   ffmpeg -i input.avs
209 @end example
210
211 For ANY other help on Avisynth, please visit the
212 @uref{http://www.avisynth.org/, Avisynth homepage}.
213
214 @section How can I join video files?
215
216 A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow to join video files by
217 merely concatenating them.
218
219 Hence you may concatenate your multimedia files by first transcoding them to
220 these privileged formats, then using the humble @code{cat} command (or the
221 equally humble @code{copy} under Windows), and finally transcoding back to your
222 format of choice.
223
224 @example
225 ffmpeg -i input1.avi -same_quant intermediate1.mpg
226 ffmpeg -i input2.avi -same_quant intermediate2.mpg
227 cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
228 ffmpeg -i intermediate_all.mpg -same_quant output.avi
229 @end example
230
231 Notice that you should either use @code{-same_quant} or set a reasonably high
232 bitrate for your intermediate and output files, if you want to preserve
233 video quality.
234
235 Also notice that you may avoid the huge intermediate files by taking advantage
236 of named pipes, should your platform support it:
237
238 @example
239 mkfifo intermediate1.mpg
240 mkfifo intermediate2.mpg
241 ffmpeg -i input1.avi -same_quant -y intermediate1.mpg < /dev/null &
242 ffmpeg -i input2.avi -same_quant -y intermediate2.mpg < /dev/null &
243 cat intermediate1.mpg intermediate2.mpg |\
244 ffmpeg -f mpeg -i - -same_quant -c:v mpeg4 -acodec libmp3lame output.avi
245 @end example
246
247 Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
248 allow concatenation, and the transcoding step is almost lossless.
249 When using multiple yuv4mpegpipe(s), the first line needs to be discarded
250 from all but the first stream. This can be accomplished by piping through
251 @code{tail} as seen below. Note that when piping through @code{tail} you
252 must use command grouping, @code{@{  ;@}}, to background properly.
253
254 For example, let's say we want to join two FLV files into an output.flv file:
255
256 @example
257 mkfifo temp1.a
258 mkfifo temp1.v
259 mkfifo temp2.a
260 mkfifo temp2.v
261 mkfifo all.a
262 mkfifo all.v
263 ffmpeg -i input1.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp1.a < /dev/null &
264 ffmpeg -i input2.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp2.a < /dev/null &
265 ffmpeg -i input1.flv -an -f yuv4mpegpipe - > temp1.v < /dev/null &
266 @{ ffmpeg -i input2.flv -an -f yuv4mpegpipe - < /dev/null | tail -n +2 > temp2.v ; @} &
267 cat temp1.a temp2.a > all.a &
268 cat temp1.v temp2.v > all.v &
269 ffmpeg -f u16le -acodec pcm_s16le -ac 2 -ar 44100 -i all.a \
270        -f yuv4mpegpipe -i all.v \
271        -same_quant -y output.flv
272 rm temp[12].[av] all.[av]
273 @end example
274
275 @section -profile option fails when encoding H.264 video with AAC audio
276
277 @command{ffmpeg} prints an error like
278
279 @example
280 Undefined constant or missing '(' in 'baseline'
281 Unable to parse option value "baseline"
282 Error setting option profile to value baseline.
283 @end example
284
285 Short answer: write @option{-profile:v} instead of @option{-profile}.
286
287 Long answer: this happens because the @option{-profile} option can apply to both
288 video and audio.  Specifically the AAC encoder also defines some profiles, none
289 of which are named @var{baseline}.
290
291 The solution is to apply the @option{-profile} option to the video stream only
292 by using @url{http://ffmpeg.org/ffmpeg.html#Stream-specifiers-1, Stream specifiers}.
293 Appending @code{:v} to it will do exactly that.
294
295 @chapter Development
296
297 @section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
298
299 Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
300 examine the source code for one of the many open source projects that
301 already incorporate FFmpeg at (@url{projects.html}).
302
303 @section Can you support my C compiler XXX?
304
305 It depends. If your compiler is C99-compliant, then patches to support
306 it are likely to be welcome if they do not pollute the source code
307 with @code{#ifdef}s related to the compiler.
308
309 @section Is Microsoft Visual C++ supported?
310
311 No. Microsoft Visual C++ is not compliant to the C99 standard and does
312 not - among other things - support the inline assembly used in FFmpeg.
313 If you wish to use MSVC++ for your
314 project then you can link the MSVC++ code with libav* as long as
315 you compile the latter with a working C compiler. For more information, see
316 the @emph{Microsoft Visual C++ compatibility} section in the FFmpeg
317 documentation.
318
319 There have been efforts to make FFmpeg compatible with MSVC++ in the
320 past. However, they have all been rejected as too intrusive, especially
321 since MinGW does the job adequately. None of the core developers
322 work with MSVC++ and thus this item is low priority. Should you find
323 the silver bullet that solves this problem, feel free to shoot it at us.
324
325 We strongly recommend you to move over from MSVC++ to MinGW tools.
326
327 @section Can I use FFmpeg or libavcodec under Windows?
328
329 Yes, but the Cygwin or MinGW tools @emph{must} be used to compile FFmpeg.
330 Read the @emph{Windows} section in the FFmpeg documentation to find more
331 information.
332
333 To get help and instructions for building FFmpeg under Windows, check out
334 the FFmpeg Windows Help Forum at
335 @url{http://ffmpeg.arrozcru.org/}.
336
337 @section Can you add automake, libtool or autoconf support?
338
339 No. These tools are too bloated and they complicate the build.
340
341 @section Why not rewrite FFmpeg in object-oriented C++?
342
343 FFmpeg is already organized in a highly modular manner and does not need to
344 be rewritten in a formal object language. Further, many of the developers
345 favor straight C; it works for them. For more arguments on this matter,
346 read @uref{http://www.tux.org/lkml/#s15, "Programming Religion"}.
347
348 @section Why are the ffmpeg programs devoid of debugging symbols?
349
350 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
351 information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
352 you need the debug information, use the *_g versions.
353
354 @section I do not like the LGPL, can I contribute code under the GPL instead?
355
356 Yes, as long as the code is optional and can easily and cleanly be placed
357 under #if CONFIG_GPL without breaking anything. So, for example, a new codec
358 or filter would be OK under GPL while a bug fix to LGPL code would not.
359
360 @section I'm using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.
361
362 FFmpeg is a pure C project, so to use the libraries within your C++ application
363 you need to explicitly state that you are using a C library. You can do this by
364 encompassing your FFmpeg includes using @code{extern "C"}.
365
366 See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}
367
368 @section I'm using libavutil from within my C++ application but the compiler complains about 'UINT64_C' was not declared in this scope
369
370 FFmpeg is a pure C project using C99 math features, in order to enable C++
371 to use them you have to append -D__STDC_CONSTANT_MACROS to your CXXFLAGS
372
373 @section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
374
375 You have to implement a URLProtocol, see @file{libavformat/file.c} in
376 FFmpeg and @file{libmpdemux/demux_lavf.c} in MPlayer sources.
377
378 @section Where can I find libav* headers for Pascal/Delphi?
379
380 see @url{http://www.iversenit.dk/dev/ffmpeg-headers/}
381
382 @section Where is the documentation about ffv1, msmpeg4, asv1, 4xm?
383
384 see @url{http://www.ffmpeg.org/~michael/}
385
386 @section How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?
387
388 Even if peculiar since it is network oriented, RTP is a container like any
389 other. You have to @emph{demux} RTP before feeding the payload to libavcodec.
390 In this specific case please look at RFC 4629 to see how it should be done.
391
392 @section AVStream.r_frame_rate is wrong, it is much larger than the frame rate.
393
394 r_frame_rate is NOT the average frame rate, it is the smallest frame rate
395 that can accurately represent all timestamps. So no, it is not
396 wrong if it is larger than the average!
397 For example, if you have mixed 25 and 30 fps content, then r_frame_rate
398 will be 150.
399
400 @section Why is @code{make fate} not running all tests?
401
402 Make sure you have the fate-suite samples and the @code{SAMPLES} Make variable
403 or @code{FATE_SAMPLES} environment variable or the @code{--samples}
404 @command{configure} option is set to the right path.
405
406 @section Why is @code{make fate} not finding the samples?
407
408 Do you happen to have a @code{~} character in the samples path to indicate a
409 home directory? The value is used in ways where the shell cannot expand it,
410 causing FATE to not find files. Just replace @code{~} by the full path.
411
412 @bye