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