doc/platform: Remove false claim about MinGW installer
[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 static libraries
125
126 Assuming you have just built and installed FFmpeg in @file{/usr/local}:
127
128 @enumerate
129
130 @item Create a new console application ("File / New / Project") and then
131 select "Win32 Console Application". On the appropriate page of the
132 Application Wizard, uncheck the "Precompiled headers" option.
133
134 @item Write the source code for your application, or, for testing, just
135 copy the code from an existing sample application into the source file
136 that MSVC++ has already created for you. For example, you can copy
137 @file{libavformat/output-example.c} from the FFmpeg distribution.
138
139 @item Open the "Project / Properties" dialog box. In the "Configuration"
140 combo box, select "All Configurations" so that the changes you make will
141 affect both debug and release builds. In the tree view on the left hand
142 side, select "C/C++ / General", then edit the "Additional Include
143 Directories" setting to contain the path where the FFmpeg includes were
144 installed (i.e. @file{c:\msys\1.0\local\include}).
145 Do not add MinGW's include directory here, or the include files will
146 conflict with MSVC's.
147
148 @item Still in the "Project / Properties" dialog box, select
149 "Linker / General" from the tree view and edit the
150 "Additional Library Directories" setting to contain the @file{lib}
151 directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
152 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
153 and the directory where MinGW's GCC libs are installed
154 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
155 "Linker / Input" from the tree view, and add the files @file{libavformat.a},
156 @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
157 @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
158 to the end of "Additional Dependencies".
159
160 @item Now, select "C/C++ / Code Generation" from the tree view. Select
161 "Debug" in the "Configuration" combo box. Make sure that "Runtime
162 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
163 the "Configuration" combo box and make sure that "Runtime Library" is
164 set to "Multi-threaded DLL".
165
166 @item Click "OK" to close the "Project / Properties" dialog box.
167
168 @item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
169 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
170 and install it in MSVC++'s include directory
171 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
172
173 @item MSVC++ also does not understand the @code{inline} keyword used by
174 FFmpeg, so you must add this line before @code{#include}ing libav*:
175 @example
176 #define inline _inline
177 @end example
178
179 @item Build your application, everything should work.
180
181 @end enumerate
182
183 @subsection Using shared libraries
184
185 This is how to create DLL and LIB files that are compatible with MSVC++:
186
187 @enumerate
188
189 @item Add a call to @file{vcvars32.bat} (which sets up the environment
190 variables for the Visual C++ tools) as the first line of @file{msys.bat}.
191 The standard location for @file{vcvars32.bat} is
192 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
193 and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
194 If this corresponds to your setup, add the following line as the first line
195 of @file{msys.bat}:
196
197 @example
198 call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
199 @end example
200
201 Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
202 and run @file{c:\msys\1.0\msys.bat} from there.
203
204 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
205 from @file{Microsoft (R) Library Manager}, this means your environment
206 variables are set up correctly, the @file{Microsoft (R) Library Manager}
207 is on the path and will be used by FFmpeg to create
208 MSVC++-compatible import libraries.
209
210 @item Build FFmpeg with
211
212 @example
213 ./configure --enable-shared
214 make
215 make install
216 @end example
217
218 Your install path (@file{/usr/local/} by default) should now have the
219 necessary DLL and LIB files under the @file{bin} directory.
220
221 @end enumerate
222
223 Alternatively, build the libraries with a cross compiler, according to
224 the instructions below in @ref{Cross compilation for Windows with Linux}.
225
226 To use those files with MSVC++, do the same as you would do with
227 the static libraries, as described above. But in Step 4,
228 you should only need to add the directory where the LIB files are installed
229 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
230 installed in the @file{bin} directory. And instead of adding the static
231 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
232 (@file{avcodec.lib}, @file{avformat.lib}, and
233 @file{avutil.lib}). Note that you should not use the GCC import
234 libraries (@file{libxxx.dll.a} files), as these will give you undefined
235 reference errors. There should be no need for @file{libmingwex.a},
236 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
237 statically linked into the DLLs.
238
239 FFmpeg headers do not declare global data for Windows DLLs through the usual
240 dllexport/dllimport interface. Such data will be exported properly while
241 building, but to use them in your MSVC++ code you will have to edit the
242 appropriate headers and mark the data as dllimport. For example, in
243 libavutil/pixdesc.h you should have:
244 @example
245 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
246 @end example
247
248 Note that using import libraries created by dlltool requires
249 the linker optimization option to be set to
250 "References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
251 the resulting binaries will fail during runtime. This isn't
252 required when using import libraries generated by lib.exe.
253 This issue is reported upstream at
254 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
255
256 To create import libraries that work with the @code{/OPT:REF} option
257 (which is enabled by default in Release mode), follow these steps:
258
259 @enumerate
260
261 @item Open @emph{Visual Studio 2005 Command Prompt}.
262
263 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
264 which sets up the environment variables for the Visual C++ tools
265 (the standard location for this file is
266 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}).
267
268 @item Enter the @file{bin} directory where the created LIB and DLL files
269 are stored.
270
271 @item Generate new import libraries with @command{lib.exe}:
272
273 @example
274 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
275 @end example
276
277 Replace @code{foo-version} and @code{foo} with the respective library names.
278
279 @end enumerate
280
281 @anchor{Cross compilation for Windows with Linux}
282 @section Cross compilation for Windows with Linux
283
284 You must use the MinGW cross compilation tools available at
285 @url{http://www.mingw.org/}.
286
287 Then configure FFmpeg with the following options:
288 @example
289 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
290 @end example
291 (you can change the cross-prefix according to the prefix chosen for the
292 MinGW tools).
293
294 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
295
296 @section Compilation under Cygwin
297
298 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
299 llrint() in its C library.
300
301 Install your Cygwin with all the "Base" packages, plus the
302 following "Devel" ones:
303 @example
304 binutils, gcc4-core, make, git, mingw-runtime, texi2html
305 @end example
306
307 In order to run FATE you will also need the following "Utils" packages:
308 @example
309 bc, diffutils
310 @end example
311
312 If you want to build FFmpeg with additional libraries, download Cygwin
313 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
314 @example
315 libogg-devel, libvorbis-devel
316 @end example
317
318 These library packages are only available from
319 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
320
321 @example
322 yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
323 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
324 @end example
325
326 The recommendation for x264 is to build it from source, as it evolves too
327 quickly for Cygwin Ports to be up to date.
328
329 @section Crosscompilation for Windows under Cygwin
330
331 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
332
333 Just install your Cygwin as explained before, plus these additional
334 "Devel" packages:
335 @example
336 gcc-mingw-core, mingw-runtime, mingw-zlib
337 @end example
338
339 and add some special flags to your configure invocation.
340
341 For a static build run
342 @example
343 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
344 @end example
345
346 and for a build with shared libraries
347 @example
348 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
349 @end example
350
351 @bye