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