doc/faq: mention doc/examples
[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 To "join" video files is quite ambiguous. The following list explains the
217 different kinds of "joining" and points out how those are addressed in
218 FFmpeg. To join video files may mean:
219
220 @itemize
221
222 @item
223 To put them one after the other: this is called to @emph{concatenate} them
224 (in short: concat) and is addressed
225 @ref{How can I concatenate video files, in this very faq}.
226
227 @item
228 To put them together in the same file, to let the user choose between the
229 different versions (example: different audio languages): this is called to
230 @emph{multiplex} them together (in short: mux), and is done by simply
231 invoking ffmpeg with several @option{-i} options.
232
233 @item
234 For audio, to put all channels together in a single stream (example: two
235 mono streams into one stereo stream): this is sometimes called to
236 @emph{merge} them, and can be done using the
237 @url{http://ffmpeg.org/ffmpeg.html#amerge, @code{amerge}} filter.
238
239 @item
240 For audio, to play one on top of the other: this is called to @emph{mix}
241 them, and can be done by first merging them into a single stream and then
242 using the @url{http://ffmpeg.org/ffmpeg.html#pan, @code{pan}} filter to mix
243 the channels at will.
244
245 @item
246 For video, to display both together, side by side or one on top of a part of
247 the other; it can be done using the
248 @url{http://ffmpeg.org/ffmpeg.html#overlay, @code{overlay}} video filter.
249
250 @end itemize
251
252 @anchor{How can I concatenate video files}
253 @section How can I concatenate video files?
254
255 There are several solutions, depending on the exact circumstances.
256
257 @subsection Concatenating using filters
258
259 FFmpeg has a @url{http://ffmpeg.org/ffmpeg.html#concat-1, @code{concat}}
260 filter designed specifically for that, with examples in the documentation.
261
262 @subsection Concatenating at the file level
263
264 A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow to concatenate
265 video by merely concatenating the files them.
266
267 Hence you may concatenate your multimedia files by first transcoding them to
268 these privileged formats, then using the humble @code{cat} command (or the
269 equally humble @code{copy} under Windows), and finally transcoding back to your
270 format of choice.
271
272 @example
273 ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
274 ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
275 cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
276 ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
277 @end example
278
279 Additionally, you can use the @code{concat} protocol instead of @code{cat} or
280 @code{copy} which will avoid creation of a potentially huge intermediate file.
281
282 @example
283 ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
284 ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
285 ffmpeg -i concat:"intermediate1.mpg|intermediate2.mpg" -c copy intermediate_all.mpg
286 ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
287 @end example
288
289 Note that you may need to escape the character "|" which is special for many
290 shells.
291
292 Another option is usage of named pipes, should your platform support it:
293
294 @example
295 mkfifo intermediate1.mpg
296 mkfifo intermediate2.mpg
297 ffmpeg -i input1.avi -qscale:v 1 -y intermediate1.mpg < /dev/null &
298 ffmpeg -i input2.avi -qscale:v 1 -y intermediate2.mpg < /dev/null &
299 cat intermediate1.mpg intermediate2.mpg |\
300 ffmpeg -f mpeg -i - -qscale:v 2 -c:v mpeg4 -acodec libmp3lame -q:a 4 output.avi
301 @end example
302
303 @subsection Concatenating using raw audio and video
304
305 Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
306 allow concatenation, and the transcoding step is almost lossless.
307 When using multiple yuv4mpegpipe(s), the first line needs to be discarded
308 from all but the first stream. This can be accomplished by piping through
309 @code{tail} as seen below. Note that when piping through @code{tail} you
310 must use command grouping, @code{@{  ;@}}, to background properly.
311
312 For example, let's say we want to concatenate two FLV files into an
313 output.flv file:
314
315 @example
316 mkfifo temp1.a
317 mkfifo temp1.v
318 mkfifo temp2.a
319 mkfifo temp2.v
320 mkfifo all.a
321 mkfifo all.v
322 ffmpeg -i input1.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp1.a < /dev/null &
323 ffmpeg -i input2.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp2.a < /dev/null &
324 ffmpeg -i input1.flv -an -f yuv4mpegpipe - > temp1.v < /dev/null &
325 @{ ffmpeg -i input2.flv -an -f yuv4mpegpipe - < /dev/null | tail -n +2 > temp2.v ; @} &
326 cat temp1.a temp2.a > all.a &
327 cat temp1.v temp2.v > all.v &
328 ffmpeg -f u16le -acodec pcm_s16le -ac 2 -ar 44100 -i all.a \
329        -f yuv4mpegpipe -i all.v \
330        -qscale:v 2 -y output.flv
331 rm temp[12].[av] all.[av]
332 @end example
333
334 @section -profile option fails when encoding H.264 video with AAC audio
335
336 @command{ffmpeg} prints an error like
337
338 @example
339 Undefined constant or missing '(' in 'baseline'
340 Unable to parse option value "baseline"
341 Error setting option profile to value baseline.
342 @end example
343
344 Short answer: write @option{-profile:v} instead of @option{-profile}.
345
346 Long answer: this happens because the @option{-profile} option can apply to both
347 video and audio.  Specifically the AAC encoder also defines some profiles, none
348 of which are named @var{baseline}.
349
350 The solution is to apply the @option{-profile} option to the video stream only
351 by using @url{http://ffmpeg.org/ffmpeg.html#Stream-specifiers-1, Stream specifiers}.
352 Appending @code{:v} to it will do exactly that.
353
354 @section Using @option{-f lavfi}, audio becomes mono for no apparent reason.
355
356 Use @option{-dumpgraph -} to find out exactly where the channel layout is
357 lost.
358
359 Most likely, it is through @code{auto-inserted aconvert}. Try to understand
360 why the converting filter was needed at that place.
361
362 Just before the output is a likely place, as @option{-f lavfi} currently
363 only support packed S16.
364
365 Then insert the correct @code{aconvert} explicitly in the filter graph,
366 specifying the exact format.
367
368 @example
369 aconvert=s16:stereo:packed
370 @end example
371
372 @section Why does FFmpeg not see the subtitles in my VOB file?
373
374 VOB and a few other formats do not have a global header that describes
375 everything present in the file. Instead, applications are supposed to scan
376 the file to see what it contains. Since VOB files are frequently large, only
377 the beginning is scanned. If the subtitles happen only later in the file,
378 they will not be initally detected.
379
380 Some applications, including the @code{ffmpeg} command-line tool, can only
381 work with streams that were detected during the initial scan; streams that
382 are detected later are ignored.
383
384 The size of the initial scan is controlled by two options: @code{probesize}
385 (default ~5 Mo) and @code{analyzeduration} (default 5,000,000 µs = 5 s). For
386 the subtitle stream to be detected, both values must be large enough.
387
388 @chapter Development
389
390 @section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
391
392 Yes. Check the @file{doc/examples} directory in the source
393 repository, also available online at:
394 @url{https://github.com/FFmpeg/FFmpeg/tree/master/doc/examples}.
395
396 Examples are also installed by default, usually in
397 @code{$PREFIX/share/ffmpeg/examples}.
398
399 Also you may read the Developers Guide of the FFmpeg documentation. Alternatively,
400 examine the source code for one of the many open source projects that
401 already incorporate FFmpeg at (@url{projects.html}).
402
403 @section Can you support my C compiler XXX?
404
405 It depends. If your compiler is C99-compliant, then patches to support
406 it are likely to be welcome if they do not pollute the source code
407 with @code{#ifdef}s related to the compiler.
408
409 @section Is Microsoft Visual C++ supported?
410
411 No. Microsoft Visual C++ is not compliant to the C99 standard and does
412 not - among other things - support the inline assembly used in FFmpeg.
413 If you wish to use MSVC++ for your
414 project then you can link the MSVC++ code with libav* as long as
415 you compile the latter with a working C compiler. For more information, see
416 the @emph{Microsoft Visual C++ compatibility} section in the FFmpeg
417 documentation.
418
419 There have been efforts to make FFmpeg compatible with MSVC++ in the
420 past. However, they have all been rejected as too intrusive, especially
421 since MinGW does the job adequately. None of the core developers
422 work with MSVC++ and thus this item is low priority. Should you find
423 the silver bullet that solves this problem, feel free to shoot it at us.
424
425 We strongly recommend you to move over from MSVC++ to MinGW tools.
426
427 @section Can I use FFmpeg or libavcodec under Windows?
428
429 Yes, but the Cygwin or MinGW tools @emph{must} be used to compile FFmpeg.
430 Read the @emph{Windows} section in the FFmpeg documentation to find more
431 information.
432
433 To get help and instructions for building FFmpeg under Windows, check out
434 the FFmpeg Windows Help Forum at
435 @url{http://ffmpeg.arrozcru.org/}.
436
437 @section Can you add automake, libtool or autoconf support?
438
439 No. These tools are too bloated and they complicate the build.
440
441 @section Why not rewrite FFmpeg in object-oriented C++?
442
443 FFmpeg is already organized in a highly modular manner and does not need to
444 be rewritten in a formal object language. Further, many of the developers
445 favor straight C; it works for them. For more arguments on this matter,
446 read @uref{http://www.tux.org/lkml/#s15, "Programming Religion"}.
447
448 @section Why are the ffmpeg programs devoid of debugging symbols?
449
450 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
451 information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
452 you need the debug information, use the *_g versions.
453
454 @section I do not like the LGPL, can I contribute code under the GPL instead?
455
456 Yes, as long as the code is optional and can easily and cleanly be placed
457 under #if CONFIG_GPL without breaking anything. So, for example, a new codec
458 or filter would be OK under GPL while a bug fix to LGPL code would not.
459
460 @section I'm using FFmpeg from within my C application but the linker complains about missing symbols from the libraries themselves.
461
462 FFmpeg builds static libraries by default. In static libraries, dependencies
463 are not handled. That has two consequences. First, you must specify the
464 libraries in dependency order: @code{-lavdevice} must come before
465 @code{-lavformat}, @code{-lavutil} must come after everything else, etc.
466 Second, external libraries that are used in FFmpeg have to be specified too.
467
468 An easy way to get the full list of required libraries in dependency order
469 is to use @code{pkg-config}.
470
471 @example
472   c99 -o program program.c $(pkg-config --cflags --libs libavformat libavcodec)
473 @end example
474
475 See @file{doc/example/Makefile} and @file{doc/example/pc-uninstalled} for
476 more details.
477
478 @section I'm using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.
479
480 FFmpeg is a pure C project, so to use the libraries within your C++ application
481 you need to explicitly state that you are using a C library. You can do this by
482 encompassing your FFmpeg includes using @code{extern "C"}.
483
484 See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}
485
486 @section I'm using libavutil from within my C++ application but the compiler complains about 'UINT64_C' was not declared in this scope
487
488 FFmpeg is a pure C project using C99 math features, in order to enable C++
489 to use them you have to append -D__STDC_CONSTANT_MACROS to your CXXFLAGS
490
491 @section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
492
493 You have to implement a URLProtocol, see @file{libavformat/file.c} in
494 FFmpeg and @file{libmpdemux/demux_lavf.c} in MPlayer sources.
495
496 @section Where can I find libav* headers for Pascal/Delphi?
497
498 see @url{http://www.iversenit.dk/dev/ffmpeg-headers/}
499
500 @section Where is the documentation about ffv1, msmpeg4, asv1, 4xm?
501
502 see @url{http://www.ffmpeg.org/~michael/}
503
504 @section How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?
505
506 Even if peculiar since it is network oriented, RTP is a container like any
507 other. You have to @emph{demux} RTP before feeding the payload to libavcodec.
508 In this specific case please look at RFC 4629 to see how it should be done.
509
510 @section AVStream.r_frame_rate is wrong, it is much larger than the frame rate.
511
512 r_frame_rate is NOT the average frame rate, it is the smallest frame rate
513 that can accurately represent all timestamps. So no, it is not
514 wrong if it is larger than the average!
515 For example, if you have mixed 25 and 30 fps content, then r_frame_rate
516 will be 150.
517
518 @section Why is @code{make fate} not running all tests?
519
520 Make sure you have the fate-suite samples and the @code{SAMPLES} Make variable
521 or @code{FATE_SAMPLES} environment variable or the @code{--samples}
522 @command{configure} option is set to the right path.
523
524 @section Why is @code{make fate} not finding the samples?
525
526 Do you happen to have a @code{~} character in the samples path to indicate a
527 home directory? The value is used in ways where the shell cannot expand it,
528 causing FATE to not find files. Just replace @code{~} by the full path.
529
530 @bye