doc/platform: Nuke section on linking static MinGW-built libs with MSVC
[libav.git] / doc / platform.texi
CommitLineData
1de6e14e
LB
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
14Some parts of Libav cannot be built with version 2.15 of the GNU
15assembler which is still provided by a few AMD64 distributions. To
16make sure your compiler really uses the required version of gas
17after a binutils upgrade, run:
18
19@example
20$(gcc -print-prog-name=as) --version
21@end example
22
23If not, then you should install a different compiler that has no
24hard-coded path to gas. In the worst case pass @code{--disable-asm}
25to configure.
26
27@section BSD
28
29BSD make will not build Libav, you need to install and use GNU Make
90c9edba 30(@command{gmake}).
1de6e14e
LB
31
32@section (Open)Solaris
33
90c9edba 34GNU Make is required to build Libav, so you have to invoke (@command{gmake}),
1de6e14e
LB
35standard 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}
37or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
38since the libc is not c99-compliant by default. The probes performed by
39configure may raise an exception leading to the death of configure itself
40due to a bug in the system shell. Simply invoke a different shell such as
41bash directly to work around this:
42
43@example
44bash ./configure
45@end example
46
47@anchor{Darwin}
5ea20630 48@section Darwin (OS X, iPhone)
1de6e14e
LB
49
50The toolchain provided with Xcode is sufficient to build the basic
51unacelerated code.
52
5ea20630 53OS X on PowerPC or ARM (iPhone) requires a preprocessor from
1de6e14e
LB
54@url{http://github.com/yuvi/gas-preprocessor} to build the optimized
55assembler functions. Just download the Perl script and put it somewhere
56in your PATH, Libav's configure will pick it up automatically.
57
5ea20630 58OS X on AMD64 and x86 requires @command{yasm} to build most of the
1de6e14e
LB
59optimized 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}
61or @url{http://www.macports.org, MacPorts} can easily provide it.
62
63
64@chapter DOS
65
66Using 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
72For 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
79
6a3078bb
DB
80Libav can be built to run natively on Windows using the MinGW or MinGW-w64
81toolchains. 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/}.
83You can find detailed installation instructions in the download section and
84the FAQ.
1de6e14e 85
1de6e14e
LB
86Notes:
87
88@itemize
89
90@item Building natively using MSYS can be sped up by disabling implicit rules
91in the Makefile by calling @code{make -r} instead of plain @code{make}. This
92speed up is close to non-existent for normal one-off builds and is only
d19f3e9a 93noticeable when running make for a second time (for example during
1de6e14e
LB
94@code{make install}).
95
96@item In order to compile AVplay, you must have the MinGW development library
d19f3e9a 97of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
1de6e14e
LB
98
99@item By using @code{./configure --enable-shared} when configuring Libav,
d19f3e9a 100you can build all libraries as DLLs.
1de6e14e
LB
101
102@end itemize
103
104@section Microsoft Visual C++ compatibility
105
106As stated in the FAQ, Libav will not compile under MSVC++. However, if you
107want to use the libav* libraries in your own applications, you can still
108compile those applications using MSVC++. But the libav* libraries you link
109to @emph{must} be built with MinGW. However, you will not be able to debug
110inside the libav* libraries, since MSVC++ does not recognize the debug
111symbols generated by GCC.
112We strongly recommend you to move over from MSVC++ to MinGW tools.
113
114This description of how to use the Libav libraries with MSVC++ is based on
115Microsoft Visual C++ 2005 Express Edition. If you have a different version,
116you might have to modify the procedures slightly.
117
1de6e14e
LB
118@subsection Using shared libraries
119
120This is how to create DLL and LIB files that are compatible with MSVC++:
121
122Within the MSYS shell, build Libav with
123
124@example
125./configure --enable-shared
126make
127make install
128@end example
129
130Your install path (@file{/usr/local/} by default) should now have the
131necessary DLL and LIB files under the @file{bin} directory.
132
133Alternatively, build the libraries with a cross compiler, according to
134the instructions below in @ref{Cross compilation for Windows with Linux}.
135
136To use those files with MSVC++, do the same as you would do with
137the static libraries, as described above. But in Step 4,
138you should only need to add the directory where the LIB files are installed
139(i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
140installed in the @file{bin} directory. And instead of adding the static
141libraries (@file{libxxx.a} files) you should add the MSVC import libraries
142(@file{avcodec.lib}, @file{avformat.lib}, and
143@file{avutil.lib}). Note that you should not use the GCC import
144libraries (@file{libxxx.dll.a} files), as these will give you undefined
145reference errors. There should be no need for @file{libmingwex.a},
146@file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
147statically linked into the DLLs.
148
149Libav headers do not declare global data for Windows DLLs through the usual
150dllexport/dllimport interface. Such data will be exported properly while
151building, but to use them in your MSVC++ code you will have to edit the
152appropriate headers and mark the data as dllimport. For example, in
153libavutil/pixdesc.h you should have:
154@example
155extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
156@end example
157
158Note that using import libraries created by dlltool requires
159the linker optimization option to be set to
160"References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
161the resulting binaries will fail during runtime. This isn't
162required when using import libraries generated by lib.exe.
163This issue is reported upstream at
164@url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
165
166To create import libraries that work with the @code{/OPT:REF} option
167(which is enabled by default in Release mode), follow these steps:
168
169@enumerate
170
90c9edba 171@item Open @emph{Visual Studio 2005 Command Prompt}.
1de6e14e
LB
172
173Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
174which sets up the environment variables for the Visual C++ tools
175(the standard location for this file is
176@file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}).
177
178@item Enter the @file{bin} directory where the created LIB and DLL files
179are stored.
180
90c9edba 181@item Generate new import libraries with @command{lib.exe}:
1de6e14e
LB
182
183@example
d19f3e9a 184lib /machine:i386 /def:..\lib\foo-version.def /out:foo.lib
1de6e14e
LB
185@end example
186
d19f3e9a
DB
187Replace @code{foo-version} and @code{foo} with the respective library names.
188
1de6e14e
LB
189@end enumerate
190
191@anchor{Cross compilation for Windows with Linux}
192@section Cross compilation for Windows with Linux
193
194You must use the MinGW cross compilation tools available at
195@url{http://www.mingw.org/}.
196
197Then configure Libav with the following options:
198@example
199./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
200@end example
201(you can change the cross-prefix according to the prefix chosen for the
202MinGW tools).
203
204Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
205
206@section Compilation under Cygwin
207
208Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
209llrint() in its C library.
210
211Install your Cygwin with all the "Base" packages, plus the
212following "Devel" ones:
213@example
214binutils, gcc4-core, make, git, mingw-runtime, texi2html
215@end example
216
578344f7 217In order to run FATE you will also need the following "Utils" packages:
1de6e14e 218@example
578344f7 219bc, diffutils
1de6e14e
LB
220@end example
221
1de6e14e
LB
222If you want to build Libav with additional libraries, download Cygwin
223"Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
224@example
225libogg-devel, libvorbis-devel
226@end example
227
228These library packages are only available from
229@uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
230
231@example
a229d6c2
DB
232yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
233libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
1de6e14e
LB
234@end example
235
d19f3e9a
DB
236The recommendation for x264 is to build it from source, as it evolves too
237quickly for Cygwin Ports to be up to date.
1de6e14e
LB
238
239@section Crosscompilation for Windows under Cygwin
240
241With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
242
243Just install your Cygwin as explained before, plus these additional
244"Devel" packages:
245@example
246gcc-mingw-core, mingw-runtime, mingw-zlib
247@end example
248
249and add some special flags to your configure invocation.
250
251For a static build run
252@example
253./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
254@end example
255
256and for a build with shared libraries
257@example
258./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
259@end example
260
261@bye