doc/faq: explain pkg-config basic setup.
[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 @section I have installed this library with my distro's package manager. Why does @command{configure} not see it?
83
84 Distributions usually split libraries in several packages. The main package
85 contains the files necessary to run programs using the library. The
86 development package contains the files necessary to build programs using the
87 library. Sometimes, docs and/or data are in a separate package too.
88
89 To build FFmpeg, you need to install the development package. It is usually
90 called @file{libfoo-dev} or @file{libfoo-devel}. You can remove it after the
91 build is finished, but be sure to keep the main package.
92
93 @section How do I make @command{pkg-config} find my libraries?
94
95 Somewhere along with your libraries, there is a @file{.pc} file (or several)
96 in a @file{pkgconfig} directory. You need to set environment variables to
97 point @command{pkg-config} to these files.
98
99 If you need to @emph{add} directories to @command{pkg-config}'s search list
100 (typical use case: library installed separately), add it to
101 @code{$PKG_CONFIG_PATH}:
102
103 @example
104 export PKG_CONFIG_PATH=/opt/x264/lib/pkgconfig:/opt/opus/lib/pkgconfig
105 @end example
106
107 If you need to @emph{replace} @command{pkg-config}'s search list
108 (typical use case: cross-compiling), set it in
109 @code{$PKG_CONFIG_LIBDIR}:
110
111 @example
112 export PKG_CONFIG_LIBDIR=/home/me/cross/usr/lib/pkgconfig:/home/me/cross/usr/local/lib/pkgconfig
113 @end example
114
115 If you need to know the library's internal dependencies (typical use: static
116 linking), add the @code{--static} option to @command{pkg-config}:
117
118 @example
119 ./configure --pkg-config-flags=--static
120 @end example
121
122 @section How do I use @command{pkg-config} when cross-compiling?
123
124 The best way is to install @command{pkg-config} in your cross-compilation
125 environment. It will automatically use the cross-compilation libraries.
126
127 You can also use @command{pkg-config} from the host environment by
128 specifying explicitly @code{--pkg-config=pkg-config} to @command{configure}.
129 In that case, you must point @command{pkg-config} to the correct directories
130 using the @code{PKG_CONFIG_LIBDIR}, as explained in the previous entry.
131
132 As an intermediate solution, you can place in your cross-compilation
133 environment a script that calls the host @command{pkg-config} with
134 @code{PKG_CONFIG_LIBDIR} set. That script can look like that:
135
136 @example
137 #!/bin/sh
138 PKG_CONFIG_LIBDIR=/path/to/cross/lib/pkgconfig
139 export PKG_CONFIG_LIBDIR
140 exec /usr/bin/pkg-config "$@@"
141 @end example
142
143 @chapter Usage
144
145 @section ffmpeg does not work; what is wrong?
146
147 Try a @code{make distclean} in the ffmpeg source directory before the build.
148 If this does not help see
149 (@url{http://ffmpeg.org/bugreports.html}).
150
151 @section How do I encode single pictures into movies?
152
153 First, rename your pictures to follow a numerical sequence.
154 For example, img1.jpg, img2.jpg, img3.jpg,...
155 Then you may run:
156
157 @example
158 ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
159 @end example
160
161 Notice that @samp{%d} is replaced by the image number.
162
163 @file{img%03d.jpg} means the sequence @file{img001.jpg}, @file{img002.jpg}, etc.
164
165 Use the @option{-start_number} option to declare a starting number for
166 the sequence. This is useful if your sequence does not start with
167 @file{img001.jpg} but is still in a numerical order. The following
168 example will start with @file{img100.jpg}:
169
170 @example
171 ffmpeg -f image2 -start_number 100 -i img%d.jpg /tmp/a.mpg
172 @end example
173
174 If you have large number of pictures to rename, you can use the
175 following command to ease the burden. The command, using the bourne
176 shell syntax, symbolically links all files in the current directory
177 that match @code{*jpg} to the @file{/tmp} directory in the sequence of
178 @file{img001.jpg}, @file{img002.jpg} and so on.
179
180 @example
181 x=1; for i in *jpg; do counter=$(printf %03d $x); ln -s "$i" /tmp/img"$counter".jpg; x=$(($x+1)); done
182 @end example
183
184 If you want to sequence them by oldest modified first, substitute
185 @code{$(ls -r -t *jpg)} in place of @code{*jpg}.
186
187 Then run:
188
189 @example
190 ffmpeg -f image2 -i /tmp/img%03d.jpg /tmp/a.mpg
191 @end example
192
193 The same logic is used for any image format that ffmpeg reads.
194
195 You can also use @command{cat} to pipe images to ffmpeg:
196
197 @example
198 cat *.jpg | ffmpeg -f image2pipe -c:v mjpeg -i - output.mpg
199 @end example
200
201 @section How do I encode movie to single pictures?
202
203 Use:
204
205 @example
206 ffmpeg -i movie.mpg movie%d.jpg
207 @end example
208
209 The @file{movie.mpg} used as input will be converted to
210 @file{movie1.jpg}, @file{movie2.jpg}, etc...
211
212 Instead of relying on file format self-recognition, you may also use
213 @table @option
214 @item -c:v ppm
215 @item -c:v png
216 @item -c:v mjpeg
217 @end table
218 to force the encoding.
219
220 Applying that to the previous example:
221 @example
222 ffmpeg -i movie.mpg -f image2 -c:v mjpeg menu%d.jpg
223 @end example
224
225 Beware that there is no "jpeg" codec. Use "mjpeg" instead.
226
227 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
228
229 For multithreaded MPEG* encoding, the encoded slices must be independent,
230 otherwise thread n would practically have to wait for n-1 to finish, so it's
231 quite logical that there is a small reduction of quality. This is not a bug.
232
233 @section How can I read from the standard input or write to the standard output?
234
235 Use @file{-} as file name.
236
237 @section -f jpeg doesn't work.
238
239 Try '-f image2 test%d.jpg'.
240
241 @section Why can I not change the frame rate?
242
243 Some codecs, like MPEG-1/2, only allow a small number of fixed frame rates.
244 Choose a different codec with the -c:v command line option.
245
246 @section How do I encode Xvid or DivX video with ffmpeg?
247
248 Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
249 standard (note that there are many other coding formats that use this
250 same standard). Thus, use '-c:v mpeg4' to encode in these formats. The
251 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
252 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
253 force the fourcc 'xvid' to be stored as the video fourcc rather than the
254 default.
255
256 @section Which are good parameters for encoding high quality MPEG-4?
257
258 '-mbd rd -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -g 300 -pass 1/2',
259 things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd'.
260
261 @section Which are good parameters for encoding high quality MPEG-1/MPEG-2?
262
263 '-mbd rd -trellis 2 -cmp 2 -subcmp 2 -g 100 -pass 1/2'
264 but beware the '-g 100' might cause problems with some decoders.
265 Things to try: '-bf 2', '-flags qprd', '-flags mv0', '-flags skiprd.
266
267 @section Interlaced video looks very bad when encoded with ffmpeg, what is wrong?
268
269 You should use '-flags +ilme+ildct' and maybe '-flags +alt' for interlaced
270 material, and try '-top 0/1' if the result looks really messed-up.
271
272 @section How can I read DirectShow files?
273
274 If you have built FFmpeg with @code{./configure --enable-avisynth}
275 (only possible on MinGW/Cygwin platforms),
276 then you may use any file that DirectShow can read as input.
277
278 Just create an "input.avs" text file with this single line ...
279 @example
280 DirectShowSource("C:\path to your file\yourfile.asf")
281 @end example
282 ... and then feed that text file to ffmpeg:
283 @example
284 ffmpeg -i input.avs
285 @end example
286
287 For ANY other help on AviSynth, please visit the
288 @uref{http://www.avisynth.org/, AviSynth homepage}.
289
290 @section How can I join video files?
291
292 To "join" video files is quite ambiguous. The following list explains the
293 different kinds of "joining" and points out how those are addressed in
294 FFmpeg. To join video files may mean:
295
296 @itemize
297
298 @item
299 To put them one after the other: this is called to @emph{concatenate} them
300 (in short: concat) and is addressed
301 @ref{How can I concatenate video files, in this very faq}.
302
303 @item
304 To put them together in the same file, to let the user choose between the
305 different versions (example: different audio languages): this is called to
306 @emph{multiplex} them together (in short: mux), and is done by simply
307 invoking ffmpeg with several @option{-i} options.
308
309 @item
310 For audio, to put all channels together in a single stream (example: two
311 mono streams into one stereo stream): this is sometimes called to
312 @emph{merge} them, and can be done using the
313 @url{http://ffmpeg.org/ffmpeg-filters.html#amerge, @code{amerge}} filter.
314
315 @item
316 For audio, to play one on top of the other: this is called to @emph{mix}
317 them, and can be done by first merging them into a single stream and then
318 using the @url{http://ffmpeg.org/ffmpeg-filters.html#pan, @code{pan}} filter to mix
319 the channels at will.
320
321 @item
322 For video, to display both together, side by side or one on top of a part of
323 the other; it can be done using the
324 @url{http://ffmpeg.org/ffmpeg-filters.html#overlay, @code{overlay}} video filter.
325
326 @end itemize
327
328 @anchor{How can I concatenate video files}
329 @section How can I concatenate video files?
330
331 There are several solutions, depending on the exact circumstances.
332
333 @subsection Concatenating using the concat @emph{filter}
334
335 FFmpeg has a @url{http://ffmpeg.org/ffmpeg-filters.html#concat,
336 @code{concat}} filter designed specifically for that, with examples in the
337 documentation. This operation is recommended if you need to re-encode.
338
339 @subsection Concatenating using the concat @emph{demuxer}
340
341 FFmpeg has a @url{http://www.ffmpeg.org/ffmpeg-formats.html#concat,
342 @code{concat}} demuxer which you can use when you want to avoid a re-encode and
343 your format doesn't support file level concatenation.
344
345 @subsection Concatenating using the concat @emph{protocol} (file level)
346
347 FFmpeg has a @url{http://ffmpeg.org/ffmpeg-protocols.html#concat,
348 @code{concat}} protocol designed specifically for that, with examples in the
349 documentation.
350
351 A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow to concatenate
352 video by merely concatenating the files containing them.
353
354 Hence you may concatenate your multimedia files by first transcoding them to
355 these privileged formats, then using the humble @code{cat} command (or the
356 equally humble @code{copy} under Windows), and finally transcoding back to your
357 format of choice.
358
359 @example
360 ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
361 ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
362 cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
363 ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
364 @end example
365
366 Additionally, you can use the @code{concat} protocol instead of @code{cat} or
367 @code{copy} which will avoid creation of a potentially huge intermediate file.
368
369 @example
370 ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
371 ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
372 ffmpeg -i concat:"intermediate1.mpg|intermediate2.mpg" -c copy intermediate_all.mpg
373 ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
374 @end example
375
376 Note that you may need to escape the character "|" which is special for many
377 shells.
378
379 Another option is usage of named pipes, should your platform support it:
380
381 @example
382 mkfifo intermediate1.mpg
383 mkfifo intermediate2.mpg
384 ffmpeg -i input1.avi -qscale:v 1 -y intermediate1.mpg < /dev/null &
385 ffmpeg -i input2.avi -qscale:v 1 -y intermediate2.mpg < /dev/null &
386 cat intermediate1.mpg intermediate2.mpg |\
387 ffmpeg -f mpeg -i - -c:v mpeg4 -acodec libmp3lame output.avi
388 @end example
389
390 @subsection Concatenating using raw audio and video
391
392 Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
393 allow concatenation, and the transcoding step is almost lossless.
394 When using multiple yuv4mpegpipe(s), the first line needs to be discarded
395 from all but the first stream. This can be accomplished by piping through
396 @code{tail} as seen below. Note that when piping through @code{tail} you
397 must use command grouping, @code{@{  ;@}}, to background properly.
398
399 For example, let's say we want to concatenate two FLV files into an
400 output.flv file:
401
402 @example
403 mkfifo temp1.a
404 mkfifo temp1.v
405 mkfifo temp2.a
406 mkfifo temp2.v
407 mkfifo all.a
408 mkfifo all.v
409 ffmpeg -i input1.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp1.a < /dev/null &
410 ffmpeg -i input2.flv -vn -f u16le -acodec pcm_s16le -ac 2 -ar 44100 - > temp2.a < /dev/null &
411 ffmpeg -i input1.flv -an -f yuv4mpegpipe - > temp1.v < /dev/null &
412 @{ ffmpeg -i input2.flv -an -f yuv4mpegpipe - < /dev/null | tail -n +2 > temp2.v ; @} &
413 cat temp1.a temp2.a > all.a &
414 cat temp1.v temp2.v > all.v &
415 ffmpeg -f u16le -acodec pcm_s16le -ac 2 -ar 44100 -i all.a \
416        -f yuv4mpegpipe -i all.v \
417        -y output.flv
418 rm temp[12].[av] all.[av]
419 @end example
420
421 @section Using @option{-f lavfi}, audio becomes mono for no apparent reason.
422
423 Use @option{-dumpgraph -} to find out exactly where the channel layout is
424 lost.
425
426 Most likely, it is through @code{auto-inserted aresample}. Try to understand
427 why the converting filter was needed at that place.
428
429 Just before the output is a likely place, as @option{-f lavfi} currently
430 only support packed S16.
431
432 Then insert the correct @code{aformat} explicitly in the filtergraph,
433 specifying the exact format.
434
435 @example
436 aformat=sample_fmts=s16:channel_layouts=stereo
437 @end example
438
439 @section Why does FFmpeg not see the subtitles in my VOB file?
440
441 VOB and a few other formats do not have a global header that describes
442 everything present in the file. Instead, applications are supposed to scan
443 the file to see what it contains. Since VOB files are frequently large, only
444 the beginning is scanned. If the subtitles happen only later in the file,
445 they will not be initially detected.
446
447 Some applications, including the @code{ffmpeg} command-line tool, can only
448 work with streams that were detected during the initial scan; streams that
449 are detected later are ignored.
450
451 The size of the initial scan is controlled by two options: @code{probesize}
452 (default ~5 Mo) and @code{analyzeduration} (default 5,000,000 µs = 5 s). For
453 the subtitle stream to be detected, both values must be large enough.
454
455 @section Why was the @command{ffmpeg} @option{-sameq} option removed? What to use instead?
456
457 The @option{-sameq} option meant "same quantizer", and made sense only in a
458 very limited set of cases. Unfortunately, a lot of people mistook it for
459 "same quality" and used it in places where it did not make sense: it had
460 roughly the expected visible effect, but achieved it in a very inefficient
461 way.
462
463 Each encoder has its own set of options to set the quality-vs-size balance,
464 use the options for the encoder you are using to set the quality level to a
465 point acceptable for your tastes. The most common options to do that are
466 @option{-qscale} and @option{-qmax}, but you should peruse the documentation
467 of the encoder you chose.
468
469 @chapter Development
470
471 @section Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?
472
473 Yes. Check the @file{doc/examples} directory in the source
474 repository, also available online at:
475 @url{https://github.com/FFmpeg/FFmpeg/tree/master/doc/examples}.
476
477 Examples are also installed by default, usually in
478 @code{$PREFIX/share/ffmpeg/examples}.
479
480 Also you may read the Developers Guide of the FFmpeg documentation. Alternatively,
481 examine the source code for one of the many open source projects that
482 already incorporate FFmpeg at (@url{projects.html}).
483
484 @section Can you support my C compiler XXX?
485
486 It depends. If your compiler is C99-compliant, then patches to support
487 it are likely to be welcome if they do not pollute the source code
488 with @code{#ifdef}s related to the compiler.
489
490 @section Is Microsoft Visual C++ supported?
491
492 Yes. Please see the @uref{platform.html, Microsoft Visual C++}
493 section in the FFmpeg documentation.
494
495 @section Can you add automake, libtool or autoconf support?
496
497 No. These tools are too bloated and they complicate the build.
498
499 @section Why not rewrite FFmpeg in object-oriented C++?
500
501 FFmpeg is already organized in a highly modular manner and does not need to
502 be rewritten in a formal object language. Further, many of the developers
503 favor straight C; it works for them. For more arguments on this matter,
504 read @uref{http://www.tux.org/lkml/#s15, "Programming Religion"}.
505
506 @section Why are the ffmpeg programs devoid of debugging symbols?
507
508 The build process creates @command{ffmpeg_g}, @command{ffplay_g}, etc. which
509 contain full debug information. Those binaries are stripped to create
510 @command{ffmpeg}, @command{ffplay}, etc. If you need the debug information, use
511 the *_g versions.
512
513 @section I do not like the LGPL, can I contribute code under the GPL instead?
514
515 Yes, as long as the code is optional and can easily and cleanly be placed
516 under #if CONFIG_GPL without breaking anything. So, for example, a new codec
517 or filter would be OK under GPL while a bug fix to LGPL code would not.
518
519 @section I'm using FFmpeg from within my C application but the linker complains about missing symbols from the libraries themselves.
520
521 FFmpeg builds static libraries by default. In static libraries, dependencies
522 are not handled. That has two consequences. First, you must specify the
523 libraries in dependency order: @code{-lavdevice} must come before
524 @code{-lavformat}, @code{-lavutil} must come after everything else, etc.
525 Second, external libraries that are used in FFmpeg have to be specified too.
526
527 An easy way to get the full list of required libraries in dependency order
528 is to use @code{pkg-config}.
529
530 @example
531 c99 -o program program.c $(pkg-config --cflags --libs libavformat libavcodec)
532 @end example
533
534 See @file{doc/example/Makefile} and @file{doc/example/pc-uninstalled} for
535 more details.
536
537 @section I'm using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.
538
539 FFmpeg is a pure C project, so to use the libraries within your C++ application
540 you need to explicitly state that you are using a C library. You can do this by
541 encompassing your FFmpeg includes using @code{extern "C"}.
542
543 See @url{http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3}
544
545 @section I'm using libavutil from within my C++ application but the compiler complains about 'UINT64_C' was not declared in this scope
546
547 FFmpeg is a pure C project using C99 math features, in order to enable C++
548 to use them you have to append -D__STDC_CONSTANT_MACROS to your CXXFLAGS
549
550 @section I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?
551
552 You have to create a custom AVIOContext using @code{avio_alloc_context},
553 see @file{libavformat/aviobuf.c} in FFmpeg and @file{libmpdemux/demux_lavf.c} in MPlayer or MPlayer2 sources.
554
555 @section Where is the documentation about ffv1, msmpeg4, asv1, 4xm?
556
557 see @url{http://www.ffmpeg.org/~michael/}
558
559 @section How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?
560
561 Even if peculiar since it is network oriented, RTP is a container like any
562 other. You have to @emph{demux} RTP before feeding the payload to libavcodec.
563 In this specific case please look at RFC 4629 to see how it should be done.
564
565 @section AVStream.r_frame_rate is wrong, it is much larger than the frame rate.
566
567 @code{r_frame_rate} is NOT the average frame rate, it is the smallest frame rate
568 that can accurately represent all timestamps. So no, it is not
569 wrong if it is larger than the average!
570 For example, if you have mixed 25 and 30 fps content, then @code{r_frame_rate}
571 will be 150 (it is the least common multiple).
572 If you are looking for the average frame rate, see @code{AVStream.avg_frame_rate}.
573
574 @section Why is @code{make fate} not running all tests?
575
576 Make sure you have the fate-suite samples and the @code{SAMPLES} Make variable
577 or @code{FATE_SAMPLES} environment variable or the @code{--samples}
578 @command{configure} option is set to the right path.
579
580 @section Why is @code{make fate} not finding the samples?
581
582 Do you happen to have a @code{~} character in the samples path to indicate a
583 home directory? The value is used in ways where the shell cannot expand it,
584 causing FATE to not find files. Just replace @code{~} by the full path.
585
586 @bye