doc/platform: Reference only MSYS2 and 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 Advanced linking configuration
28
29 If you compiled FFmpeg libraries statically and you want to use them to
30 build your own shared library, you may need to force PIC support (with
31 @code{--enable-pic} during FFmpeg configure) and add the following option
32 to your project LDFLAGS:
33
34 @example
35 -Wl,-Bsymbolic
36 @end example
37
38 If your target platform requires position independent binaries, you should
39 pass the correct linking flag (e.g. @code{-pie}) to @code{--extra-ldexeflags}.
40
41 @section BSD
42
43 BSD make will not build FFmpeg, you need to install and use GNU Make
44 (@command{gmake}).
45
46 @section (Open)Solaris
47
48 GNU Make is required to build FFmpeg, so you have to invoke (@command{gmake}),
49 standard Solaris Make will not work. When building with a non-c99 front-end
50 (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
51 or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
52 since the libc is not c99-compliant by default. The probes performed by
53 configure may raise an exception leading to the death of configure itself
54 due to a bug in the system shell. Simply invoke a different shell such as
55 bash directly to work around this:
56
57 @example
58 bash ./configure
59 @end example
60
61 @anchor{Darwin}
62 @section Darwin (Mac OS X, iPhone)
63
64 The toolchain provided with Xcode is sufficient to build the basic
65 unacelerated code.
66
67 Mac OS X on PowerPC or ARM (iPhone) requires a preprocessor from
68 @url{https://github.com/FFmpeg/gas-preprocessor} or
69 @url{https://github.com/yuvi/gas-preprocessor}(currently outdated) to build the optimized
70 assembly functions. Put the Perl script somewhere
71 in your PATH, FFmpeg's configure will pick it up automatically.
72
73 Mac OS X on amd64 and x86 requires @command{yasm} to build most of the
74 optimized assembly functions. @uref{http://www.finkproject.org/, Fink},
75 @uref{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix},
76 @uref{https://mxcl.github.com/homebrew/, Homebrew}
77 or @uref{http://www.macports.org, MacPorts} can easily provide it.
78
79
80 @chapter DOS
81
82 Using a cross-compiler is preferred for various reasons.
83 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
84
85
86 @chapter OS/2
87
88 For information about compiling FFmpeg on OS/2 see
89 @url{http://www.edm2.com/index.php/FFmpeg}.
90
91
92 @chapter Windows
93
94 To get help and instructions for building FFmpeg under Windows, check out
95 the FFmpeg Windows Help Forum at @url{http://ffmpeg.zeranoe.com/forum/}.
96
97 @section Native Windows compilation using MinGW or MinGW-w64
98
99 FFmpeg can be built to run natively on Windows using the MinGW-w64
100 toolchain. Install the latest versions of MSYS2 and MinGW-w64 from
101 @url{http://msys2.github.io/} and/or @url{http://mingw-w64.sourceforge.net/}.
102 You can find detailed installation instructions in the download section and
103 the FAQ.
104
105 Notes:
106
107 @itemize
108
109 @item Building natively using MSYS2 can be sped up by disabling implicit rules
110 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
111 speed up is close to non-existent for normal one-off builds and is only
112 noticeable when running make for a second time (for example during
113 @code{make install}).
114
115 @item In order to compile FFplay, you must have the MinGW development library
116 of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
117
118 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
119 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
120 libavformat) as DLLs.
121
122 @end itemize
123
124 @section Microsoft Visual C++ or Intel C++ Compiler for Windows
125
126 FFmpeg can be built with MSVC 2012 or earlier using a C99-to-C89 conversion utility
127 and wrapper, or with MSVC 2013 and ICL natively.
128
129 You will need the following prerequisites:
130
131 @itemize
132 @item @uref{https://github.com/libav/c99-to-c89/, C99-to-C89 Converter & Wrapper}
133 (if using MSVC 2012 or earlier)
134 @item @uref{http://code.google.com/p/msinttypes/, msinttypes}
135 (if using MSVC 2012 or earlier)
136 @item @uref{http://msys2.github.io/, MSYS2}
137 @item @uref{http://yasm.tortall.net/, YASM}
138 (Also available via MSYS2's package manager.)
139 @item @uref{http://gnuwin32.sourceforge.net/packages/bc.htm, bc for Windows} if
140 you want to run @uref{fate.html, FATE}.
141 @end itemize
142
143 To set up a proper environment in MSYS2, you need to run @code{msys_shell.bat} from
144 the Visual Studio or Intel Compiler command prompt.
145
146 Place @code{yasm.exe} somewhere in your @code{PATH}. If using MSVC 2012 or
147 earlier, place @code{c99wrap.exe} and @code{c99conv.exe} somewhere in your
148 @code{PATH} as well.
149
150 Next, make sure any other headers and libs you want to use, such as zlib, are
151 located in a spot that the compiler can see. Do so by modifying the @code{LIB}
152 and @code{INCLUDE} environment variables to include the @strong{Windows-style}
153 paths to these directories. Alternatively, you can try and use the
154 @code{--extra-cflags}/@code{--extra-ldflags} configure options. If using MSVC
155 2012 or earlier, place @code{inttypes.h} somewhere the compiler can see too.
156
157 Finally, run:
158
159 @example
160 For MSVC:
161 ./configure --toolchain=msvc
162
163 For ICL:
164 ./configure --toolchain=icl
165
166 make
167 make install
168 @end example
169
170 If you wish to compile shared libraries, add @code{--enable-shared} to your
171 configure options. Note that due to the way MSVC and ICL handle DLL imports and
172 exports, you cannot compile static and shared libraries at the same time, and
173 enabling shared libraries will automatically disable the static ones.
174
175 Notes:
176
177 @itemize
178
179 @item It is possible that coreutils' @code{link.exe} conflicts with MSVC's linker.
180 You can find out by running @code{which link} to see which @code{link.exe} you
181 are using. If it is located at @code{/bin/link.exe}, then you have the wrong one
182 in your @code{PATH}. Either move or remove that copy, or make sure MSVC's
183 @code{link.exe} takes precedence in your @code{PATH} over coreutils'.
184
185 @item If you wish to build with zlib support, you will have to grab a compatible
186 zlib binary from somewhere, with an MSVC import lib, or if you wish to link
187 statically, you can follow the instructions below to build a compatible
188 @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
189 follow step 3, or compilation will fail.
190 @enumerate
191 @item Grab the @uref{http://zlib.net/, zlib sources}.
192 @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
193 this is how FFmpeg is built as well.
194 @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
195 erroneously included when building FFmpeg.
196 @item Run @code{nmake -f win32/Makefile.msc}.
197 @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
198 can see.
199 @end enumerate
200
201 @item FFmpeg has been tested with the following on i686 and x86_64:
202 @itemize
203 @item Visual Studio 2010 Pro and Express
204 @item Visual Studio 2012 Pro and Express
205 @item Visual Studio 2013 Pro and Express
206 @item Intel Composer XE 2013
207 @item Intel Composer XE 2013 SP1
208 @end itemize
209 Anything else is not officially supported.
210
211 @end itemize
212
213 @subsection Linking to FFmpeg with Microsoft Visual C++
214
215 If you plan to link with MSVC-built static libraries, you will need
216 to make sure you have @code{Runtime Library} set to
217 @code{Multi-threaded (/MT)} in your project's settings.
218
219 You will need to define @code{inline} to something MSVC understands:
220 @example
221 #define inline __inline
222 @end example
223
224 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
225 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
226
227 If you plan on using import libraries created by dlltool, you must
228 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
229 settings, otherwise the resulting binaries will fail during runtime.
230 This is not required when using import libraries generated by @code{lib.exe}.
231 This issue is reported upstream at
232 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
233
234 To create import libraries that work with the @code{/OPT:REF} option
235 (which is enabled by default in Release mode), follow these steps:
236
237 @enumerate
238
239 @item Open the @emph{Visual Studio Command Prompt}.
240
241 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
242 which sets up the environment variables for the Visual C++ tools
243 (the standard location for this file is something like
244 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
245
246 @item Enter the @file{bin} directory where the created LIB and DLL files
247 are stored.
248
249 @item Generate new import libraries with @command{lib.exe}:
250
251 @example
252 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
253 @end example
254
255 Replace @code{foo-version} and @code{foo} with the respective library names.
256
257 @end enumerate
258
259 @anchor{Cross compilation for Windows with Linux}
260 @section Cross compilation for Windows with Linux
261
262 You must use the MinGW cross compilation tools available at
263 @url{http://www.mingw.org/}.
264
265 Then configure FFmpeg with the following options:
266 @example
267 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
268 @end example
269 (you can change the cross-prefix according to the prefix chosen for the
270 MinGW tools).
271
272 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
273
274 @section Compilation under Cygwin
275
276 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
277 llrint() in its C library.
278
279 Install your Cygwin with all the "Base" packages, plus the
280 following "Devel" ones:
281 @example
282 binutils, gcc4-core, make, git, mingw-runtime, texinfo
283 @end example
284
285 In order to run FATE you will also need the following "Utils" packages:
286 @example
287 bc, diffutils
288 @end example
289
290 If you want to build FFmpeg with additional libraries, download Cygwin
291 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
292 @example
293 libogg-devel, libvorbis-devel
294 @end example
295
296 These library packages are only available from
297 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
298
299 @example
300 yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
301 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
302 @end example
303
304 The recommendation for x264 is to build it from source, as it evolves too
305 quickly for Cygwin Ports to be up to date.
306
307 @section Crosscompilation for Windows under Cygwin
308
309 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
310
311 Just install your Cygwin as explained before, plus these additional
312 "Devel" packages:
313 @example
314 gcc-mingw-core, mingw-runtime, mingw-zlib
315 @end example
316
317 and add some special flags to your configure invocation.
318
319 For a static build run
320 @example
321 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
322 @end example
323
324 and for a build with shared libraries
325 @example
326 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
327 @end example
328
329 @chapter Plan 9
330
331 The native @uref{http://plan9.bell-labs.com/plan9/, Plan 9} compiler
332 does not implement all the C99 features needed by FFmpeg so the gcc
333 port must be used.  Furthermore, a few items missing from the C
334 library and shell environment need to be fixed.
335
336 @itemize
337
338 @item GNU awk, grep, make, and sed
339
340 Working packages of these tools can be found at
341 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}.
342 They can be installed with @uref{http://9front.org/, 9front's} @code{pkg}
343 utility by setting @code{pkgpath} to
344 @code{http://ports2plan9.googlecode.com/files/}.
345
346 @item Missing/broken @code{head} and @code{printf} commands
347
348 Replacements adequate for building FFmpeg can be found in the
349 @code{compat/plan9} directory.  Place these somewhere they will be
350 found by the shell.  These are not full implementations of the
351 commands and are @emph{not} suitable for general use.
352
353 @item Missing C99 @code{stdint.h} and @code{inttypes.h}
354
355 Replacement headers are available from
356 @url{http://code.google.com/p/plan9front/issues/detail?id=152}.
357
358 @item Missing or non-standard library functions
359
360 Some functions in the C library are missing or incomplete.  The
361 @code{@uref{http://ports2plan9.googlecode.com/files/gcc-apelibs-1207.tbz,
362 gcc-apelibs-1207}} package from
363 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}
364 includes an updated C library, but installing the full package gives
365 unusable executables.  Instead, keep the files from @code{gccbin.tgz}
366 under @code{/386/lib/gnu}.  From the @code{libc.a} archive in the
367 @code{gcc-apelibs-1207} package, extract the following object files and
368 turn them into a library:
369
370 @itemize
371 @item @code{strerror.o}
372 @item @code{strtoll.o}
373 @item @code{snprintf.o}
374 @item @code{vsnprintf.o}
375 @item @code{vfprintf.o}
376 @item @code{_IO_getc.o}
377 @item @code{_IO_putc.o}
378 @end itemize
379
380 Use the @code{--extra-libs} option of @code{configure} to inform the
381 build system of this library.
382
383 @item FPU exceptions enabled by default
384
385 Unlike most other systems, Plan 9 enables FPU exceptions by default.
386 These must be disabled before calling any FFmpeg functions.  While the
387 included tools will do this automatically, other users of the
388 libraries must do it themselves.
389
390 @end itemize
391
392 @bye