Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / doc / platform.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle Platform Specific information
4 @titlepage
5 @center @titlefont{Platform Specific information}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Unix-like
13
14 Some parts of FFmpeg cannot be built with version 2.15 of the GNU
15 assembler which is still provided by a few AMD64 distributions. To
16 make sure your compiler really uses the required version of gas
17 after a binutils upgrade, run:
18
19 @example
20 $(gcc -print-prog-name=as) --version
21 @end example
22
23 If not, then you should install a different compiler that has no
24 hard-coded path to gas. In the worst case pass @code{--disable-asm}
25 to configure.
26
27 @section BSD
28
29 BSD make will not build FFmpeg, you need to install and use GNU Make
30 (@file{gmake}).
31
32 @section (Open)Solaris
33
34 GNU Make is required to build FFmpeg, so you have to invoke (@file{gmake}),
35 standard Solaris Make will not work. When building with a non-c99 front-end
36 (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
37 or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
38 since the libc is not c99-compliant by default. The probes performed by
39 configure may raise an exception leading to the death of configure itself
40 due to a bug in the system shell. Simply invoke a different shell such as
41 bash directly to work around this:
42
43 @example
44 bash ./configure
45 @end example
46
47 @anchor{Darwin}
48 @section Darwin (OSX, iPhone)
49
50 The toolchain provided with Xcode is sufficient to build the basic
51 unacelerated code.
52
53 OSX on PowerPC or ARM (iPhone) requires a preprocessor from
54 @url{http://github.com/yuvi/gas-preprocessor} to build the optimized
55 assembler functions. Just download the Perl script and put it somewhere
56 in your PATH, FFmpeg's configure will pick it up automatically.
57
58 OSX on amd64 and x86 requires @command{yasm} to build most of the
59 optimized assembler functions @url{http://mxcl.github.com/homebrew/, Homebrew},
60 @url{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix}
61 or @url{http://www.macports.org, MacPorts} can easily provide it.
62
63
64 @chapter DOS
65
66 Using a cross-compiler is preferred for various reasons.
67 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
68
69
70 @chapter OS/2
71
72 For information about compiling FFmpeg on OS/2 see
73 @url{http://www.edm2.com/index.php/FFmpeg}.
74
75
76 @chapter Windows
77
78 To get help and instructions for building FFmpeg under Windows, check out
79 the FFmpeg Windows Help Forum at
80 @url{http://ffmpeg.arrozcru.org/}.
81
82 @section Native Windows compilation
83
84 FFmpeg can be built to run natively on Windows using the MinGW tools. Install
85 the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
86 You can find detailed installation instructions in the download
87 section and the FAQ.
88
89 FFmpeg does not build out-of-the-box with the packages the automated MinGW
90 installer provides. It also requires coreutils to be installed and many other
91 packages updated to the latest version. The minimum version for some packages
92 are listed below:
93
94 @itemize
95 @item bash 3.1
96 @item msys-make 3.81-2 (note: not mingw32-make)
97 @item w32api 3.13
98 @item mingw-runtime 3.15
99 @end itemize
100
101 FFmpeg automatically passes @code{-fno-common} to the compiler to work around
102 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
103
104 Notes:
105
106 @itemize
107
108 @item Building natively using MSYS can be sped up by disabling implicit rules
109 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
110 speed up is close to non-existent for normal one-off builds and is only
111 noticeable when running make for a second time (for example in
112 @code{make install}).
113
114 @item In order to compile FFplay, you must have the MinGW development library
115 of @uref{http://www.libsdl.org/, SDL}.
116 Edit the @file{bin/sdl-config} script so that it points to the correct prefix
117 where SDL was installed. Verify that @file{sdl-config} can be launched from
118 the MSYS command line.
119
120 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
121 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
122 libavformat) as DLLs.
123
124 @end itemize
125
126 @section Microsoft Visual C++ compatibility
127
128 As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
129 want to use the libav* libraries in your own applications, you can still
130 compile those applications using MSVC++. But the libav* libraries you link
131 to @emph{must} be built with MinGW. However, you will not be able to debug
132 inside the libav* libraries, since MSVC++ does not recognize the debug
133 symbols generated by GCC.
134 We strongly recommend you to move over from MSVC++ to MinGW tools.
135
136 This description of how to use the FFmpeg libraries with MSVC++ is based on
137 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
138 you might have to modify the procedures slightly.
139
140 @subsection Using static libraries
141
142 Assuming you have just built and installed FFmpeg in @file{/usr/local}.
143
144 @enumerate
145
146 @item Create a new console application ("File / New / Project") and then
147 select "Win32 Console Application". On the appropriate page of the
148 Application Wizard, uncheck the "Precompiled headers" option.
149
150 @item Write the source code for your application, or, for testing, just
151 copy the code from an existing sample application into the source file
152 that MSVC++ has already created for you. For example, you can copy
153 @file{libavformat/output-example.c} from the FFmpeg distribution.
154
155 @item Open the "Project / Properties" dialog box. In the "Configuration"
156 combo box, select "All Configurations" so that the changes you make will
157 affect both debug and release builds. In the tree view on the left hand
158 side, select "C/C++ / General", then edit the "Additional Include
159 Directories" setting to contain the path where the FFmpeg includes were
160 installed (i.e. @file{c:\msys\1.0\local\include}).
161 Do not add MinGW's include directory here, or the include files will
162 conflict with MSVC's.
163
164 @item Still in the "Project / Properties" dialog box, select
165 "Linker / General" from the tree view and edit the
166 "Additional Library Directories" setting to contain the @file{lib}
167 directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
168 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
169 and the directory where MinGW's GCC libs are installed
170 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
171 "Linker / Input" from the tree view, and add the files @file{libavformat.a},
172 @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
173 @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
174 to the end of "Additional Dependencies".
175
176 @item Now, select "C/C++ / Code Generation" from the tree view. Select
177 "Debug" in the "Configuration" combo box. Make sure that "Runtime
178 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
179 the "Configuration" combo box and make sure that "Runtime Library" is
180 set to "Multi-threaded DLL".
181
182 @item Click "OK" to close the "Project / Properties" dialog box.
183
184 @item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
185 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
186 and install it in MSVC++'s include directory
187 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
188
189 @item MSVC++ also does not understand the @code{inline} keyword used by
190 FFmpeg, so you must add this line before @code{#include}ing libav*:
191 @example
192 #define inline _inline
193 @end example
194
195 @item Build your application, everything should work.
196
197 @end enumerate
198
199 @subsection Using shared libraries
200
201 This is how to create DLL and LIB files that are compatible with MSVC++:
202
203 @enumerate
204
205 @item Add a call to @file{vcvars32.bat} (which sets up the environment
206 variables for the Visual C++ tools) as the first line of @file{msys.bat}.
207 The standard location for @file{vcvars32.bat} is
208 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
209 and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
210 If this corresponds to your setup, add the following line as the first line
211 of @file{msys.bat}:
212
213 @example
214 call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
215 @end example
216
217 Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
218 and run @file{c:\msys\1.0\msys.bat} from there.
219
220 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
221 from @file{Microsoft (R) Library Manager}, this means your environment
222 variables are set up correctly, the @file{Microsoft (R) Library Manager}
223 is on the path and will be used by FFmpeg to create
224 MSVC++-compatible import libraries.
225
226 @item Build FFmpeg with
227
228 @example
229 ./configure --enable-shared
230 make
231 make install
232 @end example
233
234 Your install path (@file{/usr/local/} by default) should now have the
235 necessary DLL and LIB files under the @file{bin} directory.
236
237 Alternatively, build the libraries with a cross compiler, according to
238 the instructions below in @ref{Cross compilation for Windows with Linux}.
239
240 To use those files with MSVC++, do the same as you would do with
241 the static libraries, as described above. But in Step 4,
242 you should only need to add the directory where the LIB files are installed
243 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
244 installed in the @file{bin} directory. And instead of adding the static
245 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
246 (@file{avcodec.lib}, @file{avformat.lib}, and
247 @file{avutil.lib}). Note that you should not use the GCC import
248 libraries (@file{libxxx.dll.a} files), as these will give you undefined
249 reference errors. There should be no need for @file{libmingwex.a},
250 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
251 statically linked into the DLLs.
252
253 FFmpeg headers do not declare global data for Windows DLLs through the usual
254 dllexport/dllimport interface. Such data will be exported properly while
255 building, but to use them in your MSVC++ code you will have to edit the
256 appropriate headers and mark the data as dllimport. For example, in
257 libavutil/pixdesc.h you should have:
258 @example
259 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
260 @end example
261
262 Note that using import libraries created by dlltool requires
263 the linker optimization option to be set to
264 "References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
265 the resulting binaries will fail during runtime. This isn't
266 required when using import libraries generated by lib.exe.
267 This issue is reported upstream at
268 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
269
270 To create import libraries that work with the @code{/OPT:REF} option
271 (which is enabled by default in Release mode), follow these steps:
272
273 @enumerate
274
275 @item Open @file{Visual Studio 2005 Command Prompt}.
276
277 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
278 which sets up the environment variables for the Visual C++ tools
279 (the standard location for this file is
280 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}).
281
282 @item Enter the @file{bin} directory where the created LIB and DLL files
283 are stored.
284
285 @item Generate new import libraries with @file{lib.exe}:
286
287 @example
288 lib /machine:i386 /def:..\lib\avcodec-53.def  /out:avcodec.lib
289 lib /machine:i386 /def:..\lib\avdevice-53.def /out:avdevice.lib
290 lib /machine:i386 /def:..\lib\avfilter-2.def  /out:avfilter.lib
291 lib /machine:i386 /def:..\lib\avformat-53.def /out:avformat.lib
292 lib /machine:i386 /def:..\lib\avutil-51.def   /out:avutil.lib
293 lib /machine:i386 /def:..\lib\swscale-2.def   /out:swscale.lib
294 @end example
295
296 @end enumerate
297
298 @anchor{Cross compilation for Windows with Linux}
299 @section Cross compilation for Windows with Linux
300
301 You must use the MinGW cross compilation tools available at
302 @url{http://www.mingw.org/}.
303
304 Then configure FFmpeg with the following options:
305 @example
306 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
307 @end example
308 (you can change the cross-prefix according to the prefix chosen for the
309 MinGW tools).
310
311 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
312
313 @section Compilation under Cygwin
314
315 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
316 llrint() in its C library.
317
318 Install your Cygwin with all the "Base" packages, plus the
319 following "Devel" ones:
320 @example
321 binutils, gcc4-core, make, git, mingw-runtime, texi2html
322 @end example
323
324 And the following "Utils" one:
325 @example
326 diffutils
327 @end example
328
329 Then run
330
331 @example
332 ./configure
333 @end example
334
335 to make a static build.
336
337 The current @code{gcc4-core} package is buggy and needs this flag to build
338 shared libraries:
339
340 @example
341 ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
342 @end example
343
344 If you want to build FFmpeg with additional libraries, download Cygwin
345 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
346 @example
347 libogg-devel, libvorbis-devel
348 @end example
349
350 These library packages are only available from
351 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
352
353 @example
354 yasm, libSDL-devel, libdirac-devel, libfaac-devel, libaacplus-devel, libgsm-devel,
355 libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
356 libxvidcore-devel
357 @end example
358
359 The recommendation for libnut and x264 is to build them from source by
360 yourself, as they evolve too quickly for Cygwin Ports to be up to date.
361
362 Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
363 of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.
364
365 @section Crosscompilation for Windows under Cygwin
366
367 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
368
369 Just install your Cygwin as explained before, plus these additional
370 "Devel" packages:
371 @example
372 gcc-mingw-core, mingw-runtime, mingw-zlib
373 @end example
374
375 and add some special flags to your configure invocation.
376
377 For a static build run
378 @example
379 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
380 @end example
381
382 and for a build with shared libraries
383 @example
384 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
385 @end example
386
387 @bye