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