doc: set documentencoding on toplevel texi files.
[ffmpeg.git] / doc / platform.texi
1 \input texinfo @c -*- texinfo -*-
2 @documentencoding UTF-8
3
4 @settitle Platform Specific Information
5 @titlepage
6 @center @titlefont{Platform Specific Information}
7 @end titlepage
8
9 @top
10
11 @contents
12
13 @chapter Unix-like
14
15 Some parts of FFmpeg cannot be built with version 2.15 of the GNU
16 assembler which is still provided by a few AMD64 distributions. To
17 make sure your compiler really uses the required version of gas
18 after a binutils upgrade, run:
19
20 @example
21 $(gcc -print-prog-name=as) --version
22 @end example
23
24 If not, then you should install a different compiler that has no
25 hard-coded path to gas. In the worst case pass @code{--disable-asm}
26 to configure.
27
28 @section Advanced linking configuration
29
30 If you compiled FFmpeg libraries statically and you want to use them to
31 build your own shared library, you may need to force PIC support (with
32 @code{--enable-pic} during FFmpeg configure) and add the following option
33 to your project LDFLAGS:
34
35 @example
36 -Wl,-Bsymbolic
37 @end example
38
39 If your target platform requires position independent binaries, you should
40 pass the correct linking flag (e.g. @code{-pie}) to @code{--extra-ldexeflags}.
41
42 @section BSD
43
44 BSD make will not build FFmpeg, you need to install and use GNU Make
45 (@command{gmake}).
46
47 @section (Open)Solaris
48
49 GNU Make is required to build FFmpeg, so you have to invoke (@command{gmake}),
50 standard Solaris Make will not work. When building with a non-c99 front-end
51 (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
52 or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
53 since the libc is not c99-compliant by default. The probes performed by
54 configure may raise an exception leading to the death of configure itself
55 due to a bug in the system shell. Simply invoke a different shell such as
56 bash directly to work around this:
57
58 @example
59 bash ./configure
60 @end example
61
62 @anchor{Darwin}
63 @section Darwin (Mac OS X, iPhone)
64
65 The toolchain provided with Xcode is sufficient to build the basic
66 unacelerated code.
67
68 Mac OS X on PowerPC or ARM (iPhone) requires a preprocessor from
69 @url{https://github.com/FFmpeg/gas-preprocessor} or
70 @url{https://github.com/yuvi/gas-preprocessor}(currently outdated) to build the optimized
71 assembly functions. Put the Perl script somewhere
72 in your PATH, FFmpeg's configure will pick it up automatically.
73
74 Mac OS X on amd64 and x86 requires @command{yasm} to build most of the
75 optimized assembly functions. @uref{http://www.finkproject.org/, Fink},
76 @uref{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix},
77 @uref{https://mxcl.github.com/homebrew/, Homebrew}
78 or @uref{http://www.macports.org, MacPorts} can easily provide it.
79
80
81 @chapter DOS
82
83 Using a cross-compiler is preferred for various reasons.
84 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
85
86
87 @chapter OS/2
88
89 For information about compiling FFmpeg on OS/2 see
90 @url{http://www.edm2.com/index.php/FFmpeg}.
91
92
93 @chapter Windows
94
95 To get help and instructions for building FFmpeg under Windows, check out
96 the FFmpeg Windows Help Forum at @url{http://ffmpeg.zeranoe.com/forum/}.
97
98 @section Native Windows compilation using MinGW or MinGW-w64
99
100 FFmpeg can be built to run natively on Windows using the MinGW-w64
101 toolchain. Install the latest versions of MSYS2 and MinGW-w64 from
102 @url{http://msys2.github.io/} and/or @url{http://mingw-w64.sourceforge.net/}.
103 You can find detailed installation instructions in the download section and
104 the FAQ.
105
106 Notes:
107
108 @itemize
109
110 @item Building natively using MSYS2 can be sped up by disabling implicit rules
111 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
112 speed up is close to non-existent for normal one-off builds and is only
113 noticeable when running make for a second time (for example during
114 @code{make install}).
115
116 @item In order to compile FFplay, you must have the MinGW development library
117 of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
118
119 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
120 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
121 libavformat) as DLLs.
122
123 @end itemize
124
125 @section Microsoft Visual C++ or Intel C++ Compiler for Windows
126
127 FFmpeg can be built with MSVC 2012 or earlier using a C99-to-C89 conversion utility
128 and wrapper, or with MSVC 2013 and ICL natively.
129
130 You will need the following prerequisites:
131
132 @itemize
133 @item @uref{https://github.com/libav/c99-to-c89/, C99-to-C89 Converter & Wrapper}
134 (if using MSVC 2012 or earlier)
135 @item @uref{http://code.google.com/p/msinttypes/, msinttypes}
136 (if using MSVC 2012 or earlier)
137 @item @uref{http://msys2.github.io/, MSYS2}
138 @item @uref{http://yasm.tortall.net/, YASM}
139 (Also available via MSYS2's package manager.)
140 @item @uref{http://gnuwin32.sourceforge.net/packages/bc.htm, bc for Windows} if
141 you want to run @uref{fate.html, FATE}.
142 @end itemize
143
144 To set up a proper environment in MSYS2, you need to run @code{msys_shell.bat} from
145 the Visual Studio or Intel Compiler command prompt.
146
147 Place @code{yasm.exe} somewhere in your @code{PATH}. If using MSVC 2012 or
148 earlier, place @code{c99wrap.exe} and @code{c99conv.exe} somewhere in your
149 @code{PATH} as well.
150
151 Next, make sure any other headers and libs you want to use, such as zlib, are
152 located in a spot that the compiler can see. Do so by modifying the @code{LIB}
153 and @code{INCLUDE} environment variables to include the @strong{Windows-style}
154 paths to these directories. Alternatively, you can try and use the
155 @code{--extra-cflags}/@code{--extra-ldflags} configure options. If using MSVC
156 2012 or earlier, place @code{inttypes.h} somewhere the compiler can see too.
157
158 Finally, run:
159
160 @example
161 For MSVC:
162 ./configure --toolchain=msvc
163
164 For ICL:
165 ./configure --toolchain=icl
166
167 make
168 make install
169 @end example
170
171 If you wish to compile shared libraries, add @code{--enable-shared} to your
172 configure options. Note that due to the way MSVC and ICL handle DLL imports and
173 exports, you cannot compile static and shared libraries at the same time, and
174 enabling shared libraries will automatically disable the static ones.
175
176 Notes:
177
178 @itemize
179
180 @item It is possible that coreutils' @code{link.exe} conflicts with MSVC's linker.
181 You can find out by running @code{which link} to see which @code{link.exe} you
182 are using. If it is located at @code{/bin/link.exe}, then you have the wrong one
183 in your @code{PATH}. Either move or remove that copy, or make sure MSVC's
184 @code{link.exe} takes precedence in your @code{PATH} over coreutils'.
185
186 @item If you wish to build with zlib support, you will have to grab a compatible
187 zlib binary from somewhere, with an MSVC import lib, or if you wish to link
188 statically, you can follow the instructions below to build a compatible
189 @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
190 follow step 3, or compilation will fail.
191 @enumerate
192 @item Grab the @uref{http://zlib.net/, zlib sources}.
193 @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
194 this is how FFmpeg is built as well.
195 @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
196 erroneously included when building FFmpeg.
197 @item Run @code{nmake -f win32/Makefile.msc}.
198 @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
199 can see.
200 @end enumerate
201
202 @item FFmpeg has been tested with the following on i686 and x86_64:
203 @itemize
204 @item Visual Studio 2010 Pro and Express
205 @item Visual Studio 2012 Pro and Express
206 @item Visual Studio 2013 Pro and Express
207 @item Intel Composer XE 2013
208 @item Intel Composer XE 2013 SP1
209 @end itemize
210 Anything else is not officially supported.
211
212 @end itemize
213
214 @subsection Linking to FFmpeg with Microsoft Visual C++
215
216 If you plan to link with MSVC-built static libraries, you will need
217 to make sure you have @code{Runtime Library} set to
218 @code{Multi-threaded (/MT)} in your project's settings.
219
220 You will need to define @code{inline} to something MSVC understands:
221 @example
222 #define inline __inline
223 @end example
224
225 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
226 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
227
228 If you plan on using import libraries created by dlltool, you must
229 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
230 settings, otherwise the resulting binaries will fail during runtime.
231 This is not required when using import libraries generated by @code{lib.exe}.
232 This issue is reported upstream at
233 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
234
235 To create import libraries that work with the @code{/OPT:REF} option
236 (which is enabled by default in Release mode), follow these steps:
237
238 @enumerate
239
240 @item Open the @emph{Visual Studio Command Prompt}.
241
242 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
243 which sets up the environment variables for the Visual C++ tools
244 (the standard location for this file is something like
245 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
246
247 @item Enter the @file{bin} directory where the created LIB and DLL files
248 are stored.
249
250 @item Generate new import libraries with @command{lib.exe}:
251
252 @example
253 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
254 @end example
255
256 Replace @code{foo-version} and @code{foo} with the respective library names.
257
258 @end enumerate
259
260 @anchor{Cross compilation for Windows with Linux}
261 @section Cross compilation for Windows with Linux
262
263 You must use the MinGW cross compilation tools available at
264 @url{http://www.mingw.org/}.
265
266 Then configure FFmpeg with the following options:
267 @example
268 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
269 @end example
270 (you can change the cross-prefix according to the prefix chosen for the
271 MinGW tools).
272
273 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
274
275 @section Compilation under Cygwin
276
277 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
278 llrint() in its C library.
279
280 Install your Cygwin with all the "Base" packages, plus the
281 following "Devel" ones:
282 @example
283 binutils, gcc4-core, make, git, mingw-runtime, texinfo
284 @end example
285
286 In order to run FATE you will also need the following "Utils" packages:
287 @example
288 bc, diffutils
289 @end example
290
291 If you want to build FFmpeg with additional libraries, download Cygwin
292 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
293 @example
294 libogg-devel, libvorbis-devel
295 @end example
296
297 These library packages are only available from
298 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
299
300 @example
301 yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
302 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
303 @end example
304
305 The recommendation for x264 is to build it from source, as it evolves too
306 quickly for Cygwin Ports to be up to date.
307
308 @section Crosscompilation for Windows under Cygwin
309
310 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
311
312 Just install your Cygwin as explained before, plus these additional
313 "Devel" packages:
314 @example
315 gcc-mingw-core, mingw-runtime, mingw-zlib
316 @end example
317
318 and add some special flags to your configure invocation.
319
320 For a static build run
321 @example
322 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
323 @end example
324
325 and for a build with shared libraries
326 @example
327 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
328 @end example
329
330 @chapter Plan 9
331
332 The native @uref{http://plan9.bell-labs.com/plan9/, Plan 9} compiler
333 does not implement all the C99 features needed by FFmpeg so the gcc
334 port must be used.  Furthermore, a few items missing from the C
335 library and shell environment need to be fixed.
336
337 @itemize
338
339 @item GNU awk, grep, make, and sed
340
341 Working packages of these tools can be found at
342 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}.
343 They can be installed with @uref{http://9front.org/, 9front's} @code{pkg}
344 utility by setting @code{pkgpath} to
345 @code{http://ports2plan9.googlecode.com/files/}.
346
347 @item Missing/broken @code{head} and @code{printf} commands
348
349 Replacements adequate for building FFmpeg can be found in the
350 @code{compat/plan9} directory.  Place these somewhere they will be
351 found by the shell.  These are not full implementations of the
352 commands and are @emph{not} suitable for general use.
353
354 @item Missing C99 @code{stdint.h} and @code{inttypes.h}
355
356 Replacement headers are available from
357 @url{http://code.google.com/p/plan9front/issues/detail?id=152}.
358
359 @item Missing or non-standard library functions
360
361 Some functions in the C library are missing or incomplete.  The
362 @code{@uref{http://ports2plan9.googlecode.com/files/gcc-apelibs-1207.tbz,
363 gcc-apelibs-1207}} package from
364 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}
365 includes an updated C library, but installing the full package gives
366 unusable executables.  Instead, keep the files from @code{gccbin.tgz}
367 under @code{/386/lib/gnu}.  From the @code{libc.a} archive in the
368 @code{gcc-apelibs-1207} package, extract the following object files and
369 turn them into a library:
370
371 @itemize
372 @item @code{strerror.o}
373 @item @code{strtoll.o}
374 @item @code{snprintf.o}
375 @item @code{vsnprintf.o}
376 @item @code{vfprintf.o}
377 @item @code{_IO_getc.o}
378 @item @code{_IO_putc.o}
379 @end itemize
380
381 Use the @code{--extra-libs} option of @code{configure} to inform the
382 build system of this library.
383
384 @item FPU exceptions enabled by default
385
386 Unlike most other systems, Plan 9 enables FPU exceptions by default.
387 These must be disabled before calling any FFmpeg functions.  While the
388 included tools will do this automatically, other users of the
389 libraries must do it themselves.
390
391 @end itemize
392
393 @bye