doc/platform: Remove part about dllimport
[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/libav/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 shared 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 You will need to define @code{inline} to something MSVC understands:
183 @example
184 #define inline __inline
185 @end example
186
187 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
188 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
189
190 If you plan on using import libraries created by dlltool, you must
191 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
192 settings, otherwise the resulting binaries will fail during runtime.
193 This is not required when using import libraries generated by @code{lib.exe}.
194 This issue is reported upstream at
195 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
196
197 To create import libraries that work with the @code{/OPT:REF} option
198 (which is enabled by default in Release mode), follow these steps:
199
200 @enumerate
201
202 @item Open the @emph{Visual Studio Command Prompt}.
203
204 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
205 which sets up the environment variables for the Visual C++ tools
206 (the standard location for this file is something like
207 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
208
209 @item Enter the @file{bin} directory where the created LIB and DLL files
210 are stored.
211
212 @item Generate new import libraries with @command{lib.exe}:
213
214 @example
215 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
216 @end example
217
218 Replace @code{foo-version} and @code{foo} with the respective library names.
219
220 @end enumerate
221
222 @anchor{Cross compilation for Windows with Linux}
223 @section Cross compilation for Windows with Linux
224
225 You must use the MinGW cross compilation tools available at
226 @url{http://www.mingw.org/}.
227
228 Then configure Libav with the following options:
229 @example
230 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
231 @end example
232 (you can change the cross-prefix according to the prefix chosen for the
233 MinGW tools).
234
235 Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
236
237 @section Compilation under Cygwin
238
239 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
240 llrint() in its C library.
241
242 Install your Cygwin with all the "Base" packages, plus the
243 following "Devel" ones:
244 @example
245 binutils, gcc4-core, make, git, mingw-runtime, texi2html
246 @end example
247
248 In order to run FATE you will also need the following "Utils" packages:
249 @example
250 bc, diffutils
251 @end example
252
253 If you want to build Libav with additional libraries, download Cygwin
254 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
255 @example
256 libogg-devel, libvorbis-devel
257 @end example
258
259 These library packages are only available from
260 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
261
262 @example
263 yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
264 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
265 @end example
266
267 The recommendation for x264 is to build it from source, as it evolves too
268 quickly for Cygwin Ports to be up to date.
269
270 @section Crosscompilation for Windows under Cygwin
271
272 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
273
274 Just install your Cygwin as explained before, plus these additional
275 "Devel" packages:
276 @example
277 gcc-mingw-core, mingw-runtime, mingw-zlib
278 @end example
279
280 and add some special flags to your configure invocation.
281
282 For a static build run
283 @example
284 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
285 @end example
286
287 and for a build with shared libraries
288 @example
289 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
290 @end example
291
292 @chapter Plan 9
293
294 The native @uref{http://plan9.bell-labs.com/plan9/, Plan 9} compiler
295 does not implement all the C99 features needed by Libav so the gcc
296 port must be used.  Furthermore, a few items missing from the C
297 library and shell environment need to be fixed.
298
299 @itemize
300
301 @item GNU awk, grep, make, and sed
302
303 Working packages of these tools can be found at
304 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}.
305 They can be installed with @uref{http://9front.org/, 9front's} @code{pkg}
306 utility by setting @code{pkgpath} to
307 @code{http://ports2plan9.googlecode.com/files/}.
308
309 @item Missing/broken @code{head} and @code{printf} commands
310
311 Replacements adequate for building Libav can be found in the
312 @code{compat/plan9} directory.  Place these somewhere they will be
313 found by the shell.  These are not full implementations of the
314 commands and are @emph{not} suitable for general use.
315
316 @item Missing C99 @code{stdint.h} and @code{inttypes.h}
317
318 Replacement headers are available from
319 @url{http://code.google.com/p/plan9front/issues/detail?id=152}.
320
321 @item Missing or non-standard library functions
322
323 Some functions in the C library are missing or incomplete.  The
324 @code{@uref{http://ports2plan9.googlecode.com/files/gcc-apelibs-1207.tbz,
325 gcc-apelibs-1207}} package from
326 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}
327 includes an updated C library, but installing the full package gives
328 unusable executables.  Instead, keep the files from @code{gccbin.tgz}
329 under @code{/386/lib/gnu}.  From the @code{libc.a} archive in the
330 @code{gcc-apelibs-1207} package, extract the following object files and
331 turn them into a library:
332
333 @itemize
334 @item @code{strerror.o}
335 @item @code{strtoll.o}
336 @item @code{snprintf.o}
337 @item @code{vsnprintf.o}
338 @item @code{vfprintf.o}
339 @item @code{_IO_getc.o}
340 @item @code{_IO_putc.o}
341 @end itemize
342
343 Use the @code{--extra-libs} option of @code{configure} to inform the
344 build system of this library.
345
346 @item FPU exceptions enabled by default
347
348 Unlike most other systems, Plan 9 enables FPU exceptions by default.
349 These must be disabled before calling any Libav functions.  While the
350 included tools will do this automatically, other users of the
351 libraries must do it themselves.
352
353 @end itemize
354
355 @bye