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