doc/platform: Mention MinGW-w64
[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 Libav 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 Libav, you need to install and use GNU Make
30 (@command{gmake}).
31
32 @section (Open)Solaris
33
34 GNU Make is required to build Libav, so you have to invoke (@command{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 (OS X, iPhone)
49
50 The toolchain provided with Xcode is sufficient to build the basic
51 unacelerated code.
52
53 OS X 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, Libav's configure will pick it up automatically.
57
58 OS X 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 Libav on OS/2 see
73 @url{http://www.edm2.com/index.php/FFmpeg}.
74
75
76 @chapter Windows
77
78 @section Native Windows compilation
79
80 Libav can be built to run natively on Windows using the MinGW or MinGW-w64
81 toolchains. Install the latest versions of MSYS and MinGW or MinGW-w64 from
82 @url{http://www.mingw.org/} or @url{http://mingw-w64.sourceforge.net/}.
83 You can find detailed installation instructions in the download section and
84 the FAQ.
85
86 Libav does not build out-of-the-box with the packages the automated MinGW
87 installer provides. It also requires coreutils to be installed and many other
88 packages updated to the latest version. The minimum versions for some packages
89 are listed below:
90
91 @itemize
92 @item bash 3.1
93 @item msys-make 3.81-2 (note: not mingw32-make)
94 @item w32api 3.13
95 @item mingw-runtime 3.15
96 @end itemize
97
98 Libav automatically passes @code{-fno-common} to the compiler to work around
99 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
100
101 Notes:
102
103 @itemize
104
105 @item Building natively using MSYS can be sped up by disabling implicit rules
106 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
107 speed up is close to non-existent for normal one-off builds and is only
108 noticeable when running make for a second time (for example during
109 @code{make install}).
110
111 @item In order to compile AVplay, you must have the MinGW development library
112 of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
113
114 @item By using @code{./configure --enable-shared} when configuring Libav,
115 you can build all libraries as DLLs.
116
117 @end itemize
118
119 @section Microsoft Visual C++ compatibility
120
121 As stated in the FAQ, Libav will not compile under MSVC++. However, if you
122 want to use the libav* libraries in your own applications, you can still
123 compile those applications using MSVC++. But the libav* libraries you link
124 to @emph{must} be built with MinGW. However, you will not be able to debug
125 inside the libav* libraries, since MSVC++ does not recognize the debug
126 symbols generated by GCC.
127 We strongly recommend you to move over from MSVC++ to MinGW tools.
128
129 This description of how to use the Libav libraries with MSVC++ is based on
130 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
131 you might have to modify the procedures slightly.
132
133 @subsection Using static libraries
134
135 Assuming you have just built and installed Libav in @file{/usr/local}:
136
137 @enumerate
138
139 @item Create a new console application ("File / New / Project") and then
140 select "Win32 Console Application". On the appropriate page of the
141 Application Wizard, uncheck the "Precompiled headers" option.
142
143 @item Write the source code for your application, or, for testing, just
144 copy the code from an existing sample application into the source file
145 that MSVC++ has already created for you. For example, you can copy
146 @file{libavformat/output-example.c} from the Libav distribution.
147
148 @item Open the "Project / Properties" dialog box. In the "Configuration"
149 combo box, select "All Configurations" so that the changes you make will
150 affect both debug and release builds. In the tree view on the left hand
151 side, select "C/C++ / General", then edit the "Additional Include
152 Directories" setting to contain the path where the Libav includes were
153 installed (i.e. @file{c:\msys\1.0\local\include}).
154 Do not add MinGW's include directory here, or the include files will
155 conflict with MSVC's.
156
157 @item Still in the "Project / Properties" dialog box, select
158 "Linker / General" from the tree view and edit the
159 "Additional Library Directories" setting to contain the @file{lib}
160 directory where Libav was installed (i.e. @file{c:\msys\1.0\local\lib}),
161 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
162 and the directory where MinGW's GCC libs are installed
163 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
164 "Linker / Input" from the tree view, and add the files @file{libavformat.a},
165 @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
166 @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
167 to the end of "Additional Dependencies".
168
169 @item Now, select "C/C++ / Code Generation" from the tree view. Select
170 "Debug" in the "Configuration" combo box. Make sure that "Runtime
171 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
172 the "Configuration" combo box and make sure that "Runtime Library" is
173 set to "Multi-threaded DLL".
174
175 @item Click "OK" to close the "Project / Properties" dialog box.
176
177 @item MSVC++ lacks some C99 header files that are fundamental for Libav.
178 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
179 and install it in MSVC++'s include directory
180 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
181
182 @item MSVC++ also does not understand the @code{inline} keyword used by
183 Libav, so you must add this line before @code{#include}ing libav*:
184 @example
185 #define inline _inline
186 @end example
187
188 @item Build your application, everything should work.
189
190 @end enumerate
191
192 @subsection Using shared libraries
193
194 This is how to create DLL and LIB files that are compatible with MSVC++:
195
196 Within the MSYS shell, build Libav with
197
198 @example
199 ./configure --enable-shared
200 make
201 make install
202 @end example
203
204 Your install path (@file{/usr/local/} by default) should now have the
205 necessary DLL and LIB files under the @file{bin} directory.
206
207 Alternatively, build the libraries with a cross compiler, according to
208 the instructions below in @ref{Cross compilation for Windows with Linux}.
209
210 To use those files with MSVC++, do the same as you would do with
211 the static libraries, as described above. But in Step 4,
212 you should only need to add the directory where the LIB files are installed
213 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
214 installed in the @file{bin} directory. And instead of adding the static
215 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
216 (@file{avcodec.lib}, @file{avformat.lib}, and
217 @file{avutil.lib}). Note that you should not use the GCC import
218 libraries (@file{libxxx.dll.a} files), as these will give you undefined
219 reference errors. There should be no need for @file{libmingwex.a},
220 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
221 statically linked into the DLLs.
222
223 Libav headers do not declare global data for Windows DLLs through the usual
224 dllexport/dllimport interface. Such data will be exported properly while
225 building, but to use them in your MSVC++ code you will have to edit the
226 appropriate headers and mark the data as dllimport. For example, in
227 libavutil/pixdesc.h you should have:
228 @example
229 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
230 @end example
231
232 Note that using import libraries created by dlltool requires
233 the linker optimization option to be set to
234 "References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
235 the resulting binaries will fail during runtime. This isn't
236 required when using import libraries generated by lib.exe.
237 This issue is reported upstream at
238 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
239
240 To create import libraries that work with the @code{/OPT:REF} option
241 (which is enabled by default in Release mode), follow these steps:
242
243 @enumerate
244
245 @item Open @emph{Visual Studio 2005 Command Prompt}.
246
247 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
248 which sets up the environment variables for the Visual C++ tools
249 (the standard location for this file is
250 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}).
251
252 @item Enter the @file{bin} directory where the created LIB and DLL files
253 are stored.
254
255 @item Generate new import libraries with @command{lib.exe}:
256
257 @example
258 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
259 @end example
260
261 Replace @code{foo-version} and @code{foo} with the respective library names.
262
263 @end enumerate
264
265 @anchor{Cross compilation for Windows with Linux}
266 @section Cross compilation for Windows with Linux
267
268 You must use the MinGW cross compilation tools available at
269 @url{http://www.mingw.org/}.
270
271 Then configure Libav with the following options:
272 @example
273 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
274 @end example
275 (you can change the cross-prefix according to the prefix chosen for the
276 MinGW tools).
277
278 Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
279
280 @section Compilation under Cygwin
281
282 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
283 llrint() in its C library.
284
285 Install your Cygwin with all the "Base" packages, plus the
286 following "Devel" ones:
287 @example
288 binutils, gcc4-core, make, git, mingw-runtime, texi2html
289 @end example
290
291 In order to run FATE you will also need the following "Utils" packages:
292 @example
293 bc, diffutils
294 @end example
295
296 If you want to build Libav with additional libraries, download Cygwin
297 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
298 @example
299 libogg-devel, libvorbis-devel
300 @end example
301
302 These library packages are only available from
303 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
304
305 @example
306 yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
307 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
308 @end example
309
310 The recommendation for x264 is to build it from source, as it evolves too
311 quickly for Cygwin Ports to be up to date.
312
313 @section Crosscompilation for Windows under Cygwin
314
315 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
316
317 Just install your Cygwin as explained before, plus these additional
318 "Devel" packages:
319 @example
320 gcc-mingw-core, mingw-runtime, mingw-zlib
321 @end example
322
323 and add some special flags to your configure invocation.
324
325 For a static build run
326 @example
327 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
328 @end example
329
330 and for a build with shared libraries
331 @example
332 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
333 @end example
334
335 @bye