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