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