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