1 \input texinfo @c -*- texinfo -*-
3 @settitle Platform Specific information
5 @center @titlefont{Platform Specific information}
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:
20 $(gcc -print-prog-name=as) --version
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}
29 BSD make will not build Libav, you need to install and use GNU Make
32 @section (Open)Solaris
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:
48 @section Darwin (OS X, iPhone)
50 The toolchain provided with Xcode is sufficient to build the basic
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.
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.
66 Using a cross-compiler is preferred for various reasons.
67 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
72 For information about compiling Libav on OS/2 see
73 @url{http://www.edm2.com/index.php/FFmpeg}.
78 @section Native Windows compilation using MinGW or MinGW-w64
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
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
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.
99 @item By using @code{./configure --enable-shared} when configuring Libav,
100 you can build all libraries as DLLs.
104 @section Microsoft Visual C++
106 Libav can be built with MSVC using a C99-to-C89 conversion utility and
107 wrapper. At this time, only static builds are supported.
109 You will need the following prerequisites:
112 @item @uref{https://github.com/rbultje/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}.
120 To set up a proper MSVC environment in MSYS, you simply need to run
121 @code{msys.bat} from the Visual Studio command prompt.
123 Caveat: Run @code{which link} to see which link you are using. If it is located
124 at @code{/bin/link.exe}, then you have the wrong link in your @code{PATH}.
125 Either move/remove that copy, or make sure MSVC's link.exe is higher up in your
126 @code{PATH} than coreutils'.
128 Place @code{c99wrap.exe}, @code{c99conv.exe}, and @code{yasm.exe} somewhere
131 Next, make sure @code{inttypes.h} and any other headers and libs you want to use
132 are located in a spot that MSVC can see. Do so by modifying the @code{LIB} and
133 @code{INCLUDE} environment variables to include the @strong{Windows} paths to
134 these directories. Alternatively, you can try and use the
135 @code{--extra-cflags}/@code{--extra-ldflags} configure options.
140 ./configure --toolchain=msvc
149 @item If you wish to build with zlib support, you will have to grab a compatible
150 zlib binary from somewhere, with an MSVC import lib, or if you wish to link
151 statically, you can follow the instructions below to build a compatible
152 @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
153 follow step 3, or compilation will fail.
155 @item Grab the @uref{http://zlib.net/, zlib sources}.
156 @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
157 this is how Libav is built as well.
158 @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
159 erroneously included when building Libav.
160 @item Run @code{nmake -f win32/Makefile.msc}.
161 @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
165 @item Libav has been tested with Visual Studio 2010 and 2012, Pro and Express.
166 Anything else is not officially supported.
170 @subsection Linking to Libav with Microsoft Visual C++
172 If you plan to link with MSVC-built static libraries, you will need
173 to make sure you have @code{Runtime Library} set to
174 @code{Multi-threaded (/MT)} in your project's settings.
176 Libav headers do not declare global data for Windows DLLs through the usual
177 dllexport/dllimport interface. Such data will be exported properly while
178 building, but to use them in your MSVC code you will have to edit the
179 appropriate headers and mark the data as dllimport. For example, in
180 libavutil/pixdesc.h you should have:
182 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
185 You will also need to define @code{inline} to something MSVC understands:
187 #define inline __inline
190 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
191 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
193 If you plan on using import libraries created by dlltool, you must
194 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
195 settings, otherwise the resulting binaries will fail during runtime.
196 This is not required when using import libraries generated by @code{lib.exe}.
197 This issue is reported upstream at
198 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
200 To create import libraries that work with the @code{/OPT:REF} option
201 (which is enabled by default in Release mode), follow these steps:
205 @item Open the @emph{Visual Studio Command Prompt}.
207 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
208 which sets up the environment variables for the Visual C++ tools
209 (the standard location for this file is something like
210 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
212 @item Enter the @file{bin} directory where the created LIB and DLL files
215 @item Generate new import libraries with @command{lib.exe}:
218 lib /machine:i386 /def:..\lib\foo-version.def /out:foo.lib
221 Replace @code{foo-version} and @code{foo} with the respective library names.
225 @anchor{Cross compilation for Windows with Linux}
226 @section Cross compilation for Windows with Linux
228 You must use the MinGW cross compilation tools available at
229 @url{http://www.mingw.org/}.
231 Then configure Libav with the following options:
233 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
235 (you can change the cross-prefix according to the prefix chosen for the
238 Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
240 @section Compilation under Cygwin
242 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
243 llrint() in its C library.
245 Install your Cygwin with all the "Base" packages, plus the
246 following "Devel" ones:
248 binutils, gcc4-core, make, git, mingw-runtime, texi2html
251 In order to run FATE you will also need the following "Utils" packages:
256 If you want to build Libav with additional libraries, download Cygwin
257 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
259 libogg-devel, libvorbis-devel
262 These library packages are only available from
263 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
266 yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
267 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
270 The recommendation for x264 is to build it from source, as it evolves too
271 quickly for Cygwin Ports to be up to date.
273 @section Crosscompilation for Windows under Cygwin
275 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
277 Just install your Cygwin as explained before, plus these additional
280 gcc-mingw-core, mingw-runtime, mingw-zlib
283 and add some special flags to your configure invocation.
285 For a static build run
287 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
290 and for a build with shared libraries
292 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin