doc: merge syntax.texi, eval.texi and opencl.texi into utils.texi
[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 @url{http://ffmpeg.zeranoe.com/forum/}.
81
82 @section Native Windows compilation using MinGW or MinGW-w64
83
84 FFmpeg can be built to run natively on Windows using the MinGW or MinGW-w64
85 toolchains. Install the latest versions of MSYS and MinGW or MinGW-w64 from
86 @url{http://www.mingw.org/} or @url{http://mingw-w64.sourceforge.net/}.
87 You can find detailed installation instructions in the download section and
88 the FAQ.
89
90 Notes:
91
92 @itemize
93
94 @item Building natively using MSYS can be sped up by disabling implicit rules
95 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
96 speed up is close to non-existent for normal one-off builds and is only
97 noticeable when running make for a second time (for example during
98 @code{make install}).
99
100 @item In order to compile FFplay, you must have the MinGW development library
101 of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
102
103 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
104 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
105 libavformat) as DLLs.
106
107 @end itemize
108
109 @section Microsoft Visual C++
110
111 FFmpeg can be built with MSVC using a C99-to-C89 conversion utility and
112 wrapper.
113
114 You will need the following prerequisites:
115
116 @itemize
117 @item @uref{http://download.videolan.org/pub/contrib/c99-to-c89/, C99-to-C89 Converter & Wrapper}
118 @item @uref{http://code.google.com/p/msinttypes/, msinttypes}
119 @item @uref{http://www.mingw.org/, MSYS}
120 @item @uref{http://yasm.tortall.net/, YASM}
121 @item @uref{http://gnuwin32.sourceforge.net/packages/bc.htm, bc for Windows} if
122 you want to run @uref{fate.html, FATE}.
123 @end itemize
124
125 To set up a proper MSVC environment in MSYS, you simply need to run
126 @code{msys.bat} from the Visual Studio command prompt.
127
128 Place @code{makedef}, @code{c99wrap.exe}, @code{c99conv.exe}, and @code{yasm.exe}
129 somewhere in your @code{PATH}.
130
131 Next, make sure @code{inttypes.h} and any other headers and libs you want to use
132 are located in a spot that MSVC can see. Do so by modifying the @code{LIB} and
133 @code{INCLUDE} environment variables to include the @strong{Windows} paths to
134 these directories. Alternatively, you can try and use the
135 @code{--extra-cflags}/@code{--extra-ldflags} configure options.
136
137 Finally, run:
138
139 @example
140 ./configure --toolchain=msvc
141 make
142 make install
143 @end example
144
145 If you wish to compile shared libraries, add @code{--enable-shared} to your
146 configure options. Note that due to the way MSVC handles DLL imports and
147 exports, you cannot compile static and shared libraries at the same time, and
148 enabling shared libraries will automatically disable the static ones.
149
150 Notes:
151
152 @itemize
153
154 @item It is possible that coreutils' @code{link.exe} conflicts with MSVC's linker.
155 You can find out by running @code{which link} to see which @code{link.exe} you
156 are using. If it is located at @code{/bin/link.exe}, then you have the wrong one
157 in your @code{PATH}. Either move or remove that copy, or make sure MSVC's
158 @code{link.exe} takes precedence in your @code{PATH} over coreutils'.
159
160 @item If you wish to build with zlib support, you will have to grab a compatible
161 zlib binary from somewhere, with an MSVC import lib, or if you wish to link
162 statically, you can follow the instructions below to build a compatible
163 @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
164 follow step 3, or compilation will fail.
165 @enumerate
166 @item Grab the @uref{http://zlib.net/, zlib sources}.
167 @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
168 this is how FFmpeg is built as well.
169 @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
170 erroneously included when building FFmpeg.
171 @item Run @code{nmake -f win32/Makefile.msc}.
172 @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
173 can see.
174 @end enumerate
175
176 @item FFmpeg has been tested with Visual Studio 2010 and 2012, Pro and Express.
177 Anything else is not officially supported.
178
179 @end itemize
180
181 @subsection Linking to FFmpeg with Microsoft Visual C++
182
183 If you plan to link with MSVC-built static libraries, you will need
184 to make sure you have @code{Runtime Library} set to
185 @code{Multi-threaded (/MT)} in your project's settings.
186
187 You will need to define @code{inline} to something MSVC understands:
188 @example
189 #define inline __inline
190 @end example
191
192 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
193 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
194
195 If you plan on using import libraries created by dlltool, you must
196 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
197 settings, otherwise the resulting binaries will fail during runtime.
198 This is not required when using import libraries generated by @code{lib.exe}.
199 This issue is reported upstream at
200 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
201
202 To create import libraries that work with the @code{/OPT:REF} option
203 (which is enabled by default in Release mode), follow these steps:
204
205 @enumerate
206
207 @item Open the @emph{Visual Studio Command Prompt}.
208
209 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
210 which sets up the environment variables for the Visual C++ tools
211 (the standard location for this file is something like
212 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
213
214 @item Enter the @file{bin} directory where the created LIB and DLL files
215 are stored.
216
217 @item Generate new import libraries with @command{lib.exe}:
218
219 @example
220 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
221 @end example
222
223 Replace @code{foo-version} and @code{foo} with the respective library names.
224
225 @end enumerate
226
227 @anchor{Cross compilation for Windows with Linux}
228 @section Cross compilation for Windows with Linux
229
230 You must use the MinGW cross compilation tools available at
231 @url{http://www.mingw.org/}.
232
233 Then configure FFmpeg with the following options:
234 @example
235 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
236 @end example
237 (you can change the cross-prefix according to the prefix chosen for the
238 MinGW tools).
239
240 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
241
242 @section Compilation under Cygwin
243
244 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
245 llrint() in its C library.
246
247 Install your Cygwin with all the "Base" packages, plus the
248 following "Devel" ones:
249 @example
250 binutils, gcc4-core, make, git, mingw-runtime, texi2html
251 @end example
252
253 In order to run FATE you will also need the following "Utils" packages:
254 @example
255 bc, diffutils
256 @end example
257
258 If you want to build FFmpeg with additional libraries, download Cygwin
259 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
260 @example
261 libogg-devel, libvorbis-devel
262 @end example
263
264 These library packages are only available from
265 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
266
267 @example
268 yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
269 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
270 @end example
271
272 The recommendation for x264 is to build it from source, as it evolves too
273 quickly for Cygwin Ports to be up to date.
274
275 @section Crosscompilation for Windows under Cygwin
276
277 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
278
279 Just install your Cygwin as explained before, plus these additional
280 "Devel" packages:
281 @example
282 gcc-mingw-core, mingw-runtime, mingw-zlib
283 @end example
284
285 and add some special flags to your configure invocation.
286
287 For a static build run
288 @example
289 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
290 @end example
291
292 and for a build with shared libraries
293 @example
294 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
295 @end example
296
297 @chapter Plan 9
298
299 The native @uref{http://plan9.bell-labs.com/plan9/, Plan 9} compiler
300 does not implement all the C99 features needed by FFmpeg so the gcc
301 port must be used.  Furthermore, a few items missing from the C
302 library and shell environment need to be fixed.
303
304 @itemize
305
306 @item GNU awk, grep, make, and sed
307
308 Working packages of these tools can be found at
309 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}.
310 They can be installed with @uref{http://9front.org/, 9front's} @code{pkg}
311 utility by setting @code{pkgpath} to
312 @code{http://ports2plan9.googlecode.com/files/}.
313
314 @item Missing/broken @code{head} and @code{printf} commands
315
316 Replacements adequate for building FFmpeg can be found in the
317 @code{compat/plan9} directory.  Place these somewhere they will be
318 found by the shell.  These are not full implementations of the
319 commands and are @emph{not} suitable for general use.
320
321 @item Missing C99 @code{stdint.h} and @code{inttypes.h}
322
323 Replacement headers are available from
324 @url{http://code.google.com/p/plan9front/issues/detail?id=152}.
325
326 @item Missing or non-standard library functions
327
328 Some functions in the C library are missing or incomplete.  The
329 @code{@uref{http://ports2plan9.googlecode.com/files/gcc-apelibs-1207.tbz,
330 gcc-apelibs-1207}} package from
331 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}
332 includes an updated C library, but installing the full package gives
333 unusable executables.  Instead, keep the files from @code{gccbin.tgz}
334 under @code{/386/lib/gnu}.  From the @code{libc.a} archive in the
335 @code{gcc-apelibs-1207} package, extract the following object files and
336 turn them into a library:
337
338 @itemize
339 @item @code{strerror.o}
340 @item @code{strtoll.o}
341 @item @code{snprintf.o}
342 @item @code{vsnprintf.o}
343 @item @code{vfprintf.o}
344 @item @code{_IO_getc.o}
345 @item @code{_IO_putc.o}
346 @end itemize
347
348 Use the @code{--extra-libs} option of @code{configure} to inform the
349 build system of this library.
350
351 @item FPU exceptions enabled by default
352
353 Unlike most other systems, Plan 9 enables FPU exceptions by default.
354 These must be disabled before calling any FFmpeg functions.  While the
355 included tools will do this automatically, other users of the
356 libraries must do it themselves.
357
358 @end itemize
359
360 @bye