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