doc/platform: Nuke section on linking static MinGW-built libs 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 FFmpeg 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 FFmpeg, you need to install and use GNU Make
30 (@command{gmake}).
31
32 @section (Open)Solaris
33
34 GNU Make is required to build FFmpeg, 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 (Mac OS X, iPhone)
49
50 The toolchain provided with Xcode is sufficient to build the basic
51 unacelerated code.
52
53 Mac 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, FFmpeg's configure will pick it up automatically.
57
58 Mac OS X on amd64 and x86 requires @command{yasm} to build most of the
59 optimized assembler functions. @uref{http://www.finkproject.org/, Fink},
60 @uref{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix},
61 @uref{http://mxcl.github.com/homebrew/, Homebrew}
62 or @uref{http://www.macports.org, MacPorts} can easily provide it.
63
64
65 @chapter DOS
66
67 Using a cross-compiler is preferred for various reasons.
68 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
69
70
71 @chapter OS/2
72
73 For information about compiling FFmpeg on OS/2 see
74 @url{http://www.edm2.com/index.php/FFmpeg}.
75
76
77 @chapter Windows
78
79 To get help and instructions for building FFmpeg under Windows, check out
80 the FFmpeg Windows Help Forum at
81 @url{http://ffmpeg.arrozcru.org/}.
82
83 @section Native Windows compilation
84
85 FFmpeg can be built to run natively on Windows using the MinGW or MinGW-w64
86 toolchains. Install the latest versions of MSYS and MinGW or MinGW-w64 from
87 @url{http://www.mingw.org/} or @url{http://mingw-w64.sourceforge.net/}.
88 You can find detailed installation instructions in the download section and
89 the FAQ.
90
91 Notes:
92
93 @itemize
94
95 @item Building natively using MSYS can be sped up by disabling implicit rules
96 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
97 speed up is close to non-existent for normal one-off builds and is only
98 noticeable when running make for a second time (for example during
99 @code{make install}).
100
101 @item In order to compile FFplay, you must have the MinGW development library
102 of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
103
104 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
105 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
106 libavformat) as DLLs.
107
108 @end itemize
109
110 @section Microsoft Visual C++ compatibility
111
112 As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
113 want to use the libav* libraries in your own applications, you can still
114 compile those applications using MSVC++. But the libav* libraries you link
115 to @emph{must} be built with MinGW. However, you will not be able to debug
116 inside the libav* libraries, since MSVC++ does not recognize the debug
117 symbols generated by GCC.
118 We strongly recommend you to move over from MSVC++ to MinGW tools.
119
120 This description of how to use the FFmpeg libraries with MSVC++ is based on
121 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
122 you might have to modify the procedures slightly.
123
124 @subsection Using shared libraries
125
126 This is how to create DLL and LIB files that are compatible with MSVC++:
127
128 @enumerate
129
130 @item Add a call to @file{vcvars32.bat} (which sets up the environment
131 variables for the Visual C++ tools) as the first line of @file{msys.bat}.
132 The standard location for @file{vcvars32.bat} is
133 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
134 and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
135 If this corresponds to your setup, add the following line as the first line
136 of @file{msys.bat}:
137
138 @example
139 call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
140 @end example
141
142 Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
143 and run @file{c:\msys\1.0\msys.bat} from there.
144
145 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
146 from @file{Microsoft (R) Library Manager}, this means your environment
147 variables are set up correctly, the @file{Microsoft (R) Library Manager}
148 is on the path and will be used by FFmpeg to create
149 MSVC++-compatible import libraries.
150
151 @item Build FFmpeg with
152
153 @example
154 ./configure --enable-shared
155 make
156 make install
157 @end example
158
159 Your install path (@file{/usr/local/} by default) should now have the
160 necessary DLL and LIB files under the @file{bin} directory.
161
162 @end enumerate
163
164 Alternatively, build the libraries with a cross compiler, according to
165 the instructions below in @ref{Cross compilation for Windows with Linux}.
166
167 To use those files with MSVC++, do the same as you would do with
168 the static libraries, as described above. But in Step 4,
169 you should only need to add the directory where the LIB files are installed
170 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
171 installed in the @file{bin} directory. And instead of adding the static
172 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
173 (@file{avcodec.lib}, @file{avformat.lib}, and
174 @file{avutil.lib}). Note that you should not use the GCC import
175 libraries (@file{libxxx.dll.a} files), as these will give you undefined
176 reference errors. There should be no need for @file{libmingwex.a},
177 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
178 statically linked into the DLLs.
179
180 FFmpeg headers do not declare global data for Windows DLLs through the usual
181 dllexport/dllimport interface. Such data will be exported properly while
182 building, but to use them in your MSVC++ code you will have to edit the
183 appropriate headers and mark the data as dllimport. For example, in
184 libavutil/pixdesc.h you should have:
185 @example
186 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
187 @end example
188
189 Note that using import libraries created by dlltool requires
190 the linker optimization option to be set to
191 "References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
192 the resulting binaries will fail during runtime. This isn't
193 required when using import libraries generated by 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 @emph{Visual Studio 2005 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
207 @file{C:\Program Files\Microsoft Visual Studio 8\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 FFmpeg 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 FFmpeg 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 FFmpeg 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, libaacplus-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 @bye