doc/platform: Add info on shared builds with MSVC
[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++
105
106 Libav can be built with MSVC using a C99-to-C89 conversion utility and
107 wrapper.
108
109 You will need the following prerequisites:
110
111 @itemize
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}.
118 @end itemize
119
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.
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 MSVC can see. Do so by modifying the @code{LIB} and
128 @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 ./configure --toolchain=msvc
136 make
137 make install
138 @end example
139
140 If you wish to compile static libraries, add @code{--enable-shared} to your
141 configure options. Note that due to the way MSVC handles DLL imports and
142 exports, you cannot compile static and shared libraries at the same time, and
143 enabling shared libraries will automatically disable the static ones.
144
145 Notes:
146
147 @itemize
148
149 @item It is possible that coreutils' @code{link.exe} conflicts with MSVC's linker.
150 You can find out by running @code{which link} to see which @code{link.exe} you
151 are using. If it is located at @code{/bin/link.exe}, then you have the wrong one
152 in your @code{PATH}. Either move or remove that copy, or make sure MSVC's
153 @code{link.exe} takes precedence in your @code{PATH} over coreutils'.
154
155 @item If you wish to build with zlib support, you will have to grab a compatible
156 zlib binary from somewhere, with an MSVC import lib, or if you wish to link
157 statically, you can follow the instructions below to build a compatible
158 @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
159 follow step 3, or compilation will fail.
160 @enumerate
161 @item Grab the @uref{http://zlib.net/, zlib sources}.
162 @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
163 this is how Libav is built as well.
164 @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
165 erroneously included when building Libav.
166 @item Run @code{nmake -f win32/Makefile.msc}.
167 @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
168 can see.
169 @end enumerate
170
171 @item Libav has been tested with Visual Studio 2010 and 2012, Pro and Express.
172 Anything else is not officially supported.
173
174 @end itemize
175
176 @subsection Linking to Libav with Microsoft Visual C++
177
178 If you plan to link with MSVC-built static libraries, you will need
179 to make sure you have @code{Runtime Library} set to
180 @code{Multi-threaded (/MT)} in your project's settings.
181
182 Libav headers do not declare global data for Windows DLLs through the usual
183 dllexport/dllimport interface. Such data will be exported properly while
184 building, but to use them in your MSVC code you will have to edit the
185 appropriate headers and mark the data as dllimport. For example, in
186 libavutil/pixdesc.h you should have:
187 @example
188 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
189 @end example
190
191 You will also need to define @code{inline} to something MSVC understands:
192 @example
193 #define inline __inline
194 @end example
195
196 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
197 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
198
199 If you plan on using import libraries created by dlltool, you must
200 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
201 settings, otherwise the resulting binaries will fail during runtime.
202 This is not required when using import libraries generated by @code{lib.exe}.
203 This issue is reported upstream at
204 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
205
206 To create import libraries that work with the @code{/OPT:REF} option
207 (which is enabled by default in Release mode), follow these steps:
208
209 @enumerate
210
211 @item Open the @emph{Visual Studio Command Prompt}.
212
213 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
214 which sets up the environment variables for the Visual C++ tools
215 (the standard location for this file is something like
216 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
217
218 @item Enter the @file{bin} directory where the created LIB and DLL files
219 are stored.
220
221 @item Generate new import libraries with @command{lib.exe}:
222
223 @example
224 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
225 @end example
226
227 Replace @code{foo-version} and @code{foo} with the respective library names.
228
229 @end enumerate
230
231 @anchor{Cross compilation for Windows with Linux}
232 @section Cross compilation for Windows with Linux
233
234 You must use the MinGW cross compilation tools available at
235 @url{http://www.mingw.org/}.
236
237 Then configure Libav with the following options:
238 @example
239 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
240 @end example
241 (you can change the cross-prefix according to the prefix chosen for the
242 MinGW tools).
243
244 Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
245
246 @section Compilation under Cygwin
247
248 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
249 llrint() in its C library.
250
251 Install your Cygwin with all the "Base" packages, plus the
252 following "Devel" ones:
253 @example
254 binutils, gcc4-core, make, git, mingw-runtime, texi2html
255 @end example
256
257 In order to run FATE you will also need the following "Utils" packages:
258 @example
259 bc, diffutils
260 @end example
261
262 If you want to build Libav with additional libraries, download Cygwin
263 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
264 @example
265 libogg-devel, libvorbis-devel
266 @end example
267
268 These library packages are only available from
269 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
270
271 @example
272 yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
273 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
274 @end example
275
276 The recommendation for x264 is to build it from source, as it evolves too
277 quickly for Cygwin Ports to be up to date.
278
279 @section Crosscompilation for Windows under Cygwin
280
281 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
282
283 Just install your Cygwin as explained before, plus these additional
284 "Devel" packages:
285 @example
286 gcc-mingw-core, mingw-runtime, mingw-zlib
287 @end example
288
289 and add some special flags to your configure invocation.
290
291 For a static build run
292 @example
293 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
294 @end example
295
296 and for a build with shared libraries
297 @example
298 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
299 @end example
300
301 @bye