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