platform.texi 13.2 KB
Newer Older
1
\input texinfo @c -*- texinfo -*-
2
@documentencoding UTF-8
3

4
@settitle Platform Specific Information
5
@titlepage
6
@center @titlefont{Platform Specific Information}
7 8 9 10 11 12 13 14
@end titlepage

@top

@contents

@chapter Unix-like

15
Some parts of FFmpeg cannot be built with version 2.15 of the GNU
16 17 18 19 20 21 22 23 24 25 26 27
assembler which is still provided by a few AMD64 distributions. To
make sure your compiler really uses the required version of gas
after a binutils upgrade, run:

@example
$(gcc -print-prog-name=as) --version
@end example

If not, then you should install a different compiler that has no
hard-coded path to gas. In the worst case pass @code{--disable-asm}
to configure.

28 29
@section Advanced linking configuration

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 34 35 36 37 38
to your project LDFLAGS:

@example
-Wl,-Bsymbolic
@end example

39 40 41
If your target platform requires position independent binaries, you should
pass the correct linking flag (e.g. @code{-pie}) to @code{--extra-ldexeflags}.

42 43
@section BSD

44
BSD make will not build FFmpeg, you need to install and use GNU Make
45
(@command{gmake}).
46 47 48

@section (Open)Solaris

49
GNU Make is required to build FFmpeg, so you have to invoke (@command{gmake}),
50 51 52 53 54 55 56 57 58 59 60 61 62
standard Solaris Make will not work. When building with a non-c99 front-end
(gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
since the libc is not c99-compliant by default. The probes performed by
configure may raise an exception leading to the death of configure itself
due to a bug in the system shell. Simply invoke a different shell such as
bash directly to work around this:

@example
bash ./configure
@end example

@anchor{Darwin}
63
@section Darwin (Mac OS X, iPhone)
64 65 66 67

The toolchain provided with Xcode is sufficient to build the basic
unacelerated code.

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 82 83 84 85 86 87 88


@chapter DOS

Using a cross-compiler is preferred for various reasons.
@url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}


@chapter OS/2

89
For information about compiling FFmpeg on OS/2 see
90 91 92 93 94
@url{http://www.edm2.com/index.php/FFmpeg}.


@chapter Windows

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 101 102
FFmpeg can be built to run natively on Windows using the MinGW-w64
toolchain. Install the latest versions of MSYS2 and MinGW-w64 from
@url{http://msys2.github.io/} and/or @url{http://mingw-w64.sourceforge.net/}.
103 104
You can find detailed installation instructions in the download section and
the FAQ.
105 106 107 108 109

Notes:

@itemize

110
@item Building natively using MSYS2 can be sped up by disabling implicit rules
111 112
in the Makefile by calling @code{make -r} instead of plain @code{make}. This
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 115
@code{make install}).

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 120 121
@item By using @code{./configure --enable-shared} when configuring FFmpeg,
you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
libavformat) as DLLs.
122 123 124

@end itemize

125
@section Microsoft Visual C++ or Intel C++ Compiler for Windows
126

127 128
FFmpeg can be built with MSVC 2012 or earlier using a C99-to-C89 conversion utility
and wrapper, or with MSVC 2013 and ICL natively.
129

130
You will need the following prerequisites:
131

132
@itemize
133 134
@item @uref{https://github.com/libav/c99-to-c89/, C99-to-C89 Converter & Wrapper}
(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 141
@end itemize

142
To set up a proper environment in MSYS2, you need to run @code{msys_shell.bat} from
143
the Visual Studio or Intel Compiler command prompt.
144

145 146 147
Place @code{yasm.exe} somewhere in your @code{PATH}. If using MSVC 2012 or
earlier, place @code{c99wrap.exe} and @code{c99conv.exe} somewhere in your
@code{PATH} as well.
148

149 150 151 152 153 154
Next, make sure any other headers and libs you want to use, such as zlib, are
located in a spot that the compiler can see. Do so by modifying the @code{LIB}
and @code{INCLUDE} environment variables to include the @strong{Windows-style}
paths to these directories. Alternatively, you can try and use the
@code{--extra-cflags}/@code{--extra-ldflags} configure options. If using MSVC
2012 or earlier, place @code{inttypes.h} somewhere the compiler can see too.
155 156 157 158

Finally, run:

@example
159
For MSVC:
160
./configure --toolchain=msvc
161 162 163 164

For ICL:
./configure --toolchain=icl

165 166 167 168
make
make install
@end example

169
If you wish to compile shared libraries, add @code{--enable-shared} to your
170
configure options. Note that due to the way MSVC and ICL handle DLL imports and
171 172 173
exports, you cannot compile static and shared libraries at the same time, and
enabling shared libraries will automatically disable the static ones.

174 175 176 177
Notes:

@itemize

178 179 180 181 182 183
@item It is possible that coreutils' @code{link.exe} conflicts with MSVC's linker.
You can find out by running @code{which link} to see which @code{link.exe} you
are using. If it is located at @code{/bin/link.exe}, then you have the wrong one
in your @code{PATH}. Either move or remove that copy, or make sure MSVC's
@code{link.exe} takes precedence in your @code{PATH} over coreutils'.

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
@item If you wish to build with zlib support, you will have to grab a compatible
zlib binary from somewhere, with an MSVC import lib, or if you wish to link
statically, you can follow the instructions below to build a compatible
@code{zlib.lib} with MSVC. Regardless of which method you use, you must still
follow step 3, or compilation will fail.
@enumerate
@item Grab the @uref{http://zlib.net/, zlib sources}.
@item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
this is how FFmpeg is built as well.
@item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
erroneously included when building FFmpeg.
@item Run @code{nmake -f win32/Makefile.msc}.
@item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
can see.
@end enumerate

200
@item FFmpeg has been tested with the following on i686 and x86_64:
201 202 203
@itemize
@item Visual Studio 2010 Pro and Express
@item Visual Studio 2012 Pro and Express
204
@item Visual Studio 2013 Pro and Express
205
@item Intel Composer XE 2013
206
@item Intel Composer XE 2013 SP1
207
@end itemize
208 209 210 211
Anything else is not officially supported.

@end itemize

212
@subsection Linking to FFmpeg with Microsoft Visual C++
213

214 215 216
If you plan to link with MSVC-built static libraries, you will need
to make sure you have @code{Runtime Library} set to
@code{Multi-threaded (/MT)} in your project's settings.
217

218
You will need to define @code{inline} to something MSVC understands:
219 220 221 222 223 224 225 226 227 228 229
@example
#define inline __inline
@end example

Also note, that as stated in @strong{Microsoft Visual C++}, you will need
an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.

If you plan on using import libraries created by dlltool, you must
set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
settings, otherwise the resulting binaries will fail during runtime.
This is not required when using import libraries generated by @code{lib.exe}.
230 231 232 233 234 235 236 237
This issue is reported upstream at
@url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.

To create import libraries that work with the @code{/OPT:REF} option
(which is enabled by default in Release mode), follow these steps:

@enumerate

238
@item Open the @emph{Visual Studio Command Prompt}.
239 240 241

Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
which sets up the environment variables for the Visual C++ tools
242 243
(the standard location for this file is something like
@file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
244 245 246 247

@item Enter the @file{bin} directory where the created LIB and DLL files
are stored.

248
@item Generate new import libraries with @command{lib.exe}:
249 250

@example
251
lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
252 253
@end example

254 255
Replace @code{foo-version} and @code{foo} with the respective library names.

256 257 258 259 260 261 262 263
@end enumerate

@anchor{Cross compilation for Windows with Linux}
@section Cross compilation for Windows with Linux

You must use the MinGW cross compilation tools available at
@url{http://www.mingw.org/}.

264
Then configure FFmpeg with the following options:
265 266 267 268 269 270
@example
./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
@end example
(you can change the cross-prefix according to the prefix chosen for the
MinGW tools).

271
Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
272 273 274 275 276 277 278 279 280

@section Compilation under Cygwin

Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
llrint() in its C library.

Install your Cygwin with all the "Base" packages, plus the
following "Devel" ones:
@example
281
binutils, gcc4-core, make, git, mingw-runtime, texinfo
282 283
@end example

284
In order to run FATE you will also need the following "Utils" packages:
285
@example
286
diffutils
287 288
@end example

289
If you want to build FFmpeg with additional libraries, download Cygwin
290 291 292 293 294 295 296 297 298
"Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
@example
libogg-devel, libvorbis-devel
@end example

These library packages are only available from
@uref{http://sourceware.org/cygwinports/, Cygwin Ports}:

@example
299
yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
Diego Biurrun's avatar
Diego Biurrun committed
300
libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
301 302
@end example

303 304
The recommendation for x264 is to build it from source, as it evolves too
quickly for Cygwin Ports to be up to date.
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

@section Crosscompilation for Windows under Cygwin

With Cygwin you can create Windows binaries that do not need the cygwin1.dll.

Just install your Cygwin as explained before, plus these additional
"Devel" packages:
@example
gcc-mingw-core, mingw-runtime, mingw-zlib
@end example

and add some special flags to your configure invocation.

For a static build run
@example
./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
@end example

and for a build with shared libraries
@example
./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
@end example

Mans Rullgard's avatar
Mans Rullgard committed
328 329 330
@chapter Plan 9

The native @uref{http://plan9.bell-labs.com/plan9/, Plan 9} compiler
331
does not implement all the C99 features needed by FFmpeg so the gcc
Mans Rullgard's avatar
Mans Rullgard committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
port must be used.  Furthermore, a few items missing from the C
library and shell environment need to be fixed.

@itemize

@item GNU awk, grep, make, and sed

Working packages of these tools can be found at
@uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}.
They can be installed with @uref{http://9front.org/, 9front's} @code{pkg}
utility by setting @code{pkgpath} to
@code{http://ports2plan9.googlecode.com/files/}.

@item Missing/broken @code{head} and @code{printf} commands

347
Replacements adequate for building FFmpeg can be found in the
Mans Rullgard's avatar
Mans Rullgard committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
@code{compat/plan9} directory.  Place these somewhere they will be
found by the shell.  These are not full implementations of the
commands and are @emph{not} suitable for general use.

@item Missing C99 @code{stdint.h} and @code{inttypes.h}

Replacement headers are available from
@url{http://code.google.com/p/plan9front/issues/detail?id=152}.

@item Missing or non-standard library functions

Some functions in the C library are missing or incomplete.  The
@code{@uref{http://ports2plan9.googlecode.com/files/gcc-apelibs-1207.tbz,
gcc-apelibs-1207}} package from
@uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}
includes an updated C library, but installing the full package gives
unusable executables.  Instead, keep the files from @code{gccbin.tgz}
under @code{/386/lib/gnu}.  From the @code{libc.a} archive in the
@code{gcc-apelibs-1207} package, extract the following object files and
turn them into a library:

@itemize
@item @code{strerror.o}
@item @code{strtoll.o}
@item @code{snprintf.o}
@item @code{vsnprintf.o}
@item @code{vfprintf.o}
@item @code{_IO_getc.o}
@item @code{_IO_putc.o}
@end itemize

Use the @code{--extra-libs} option of @code{configure} to inform the
build system of this library.

@item FPU exceptions enabled by default

Unlike most other systems, Plan 9 enables FPU exceptions by default.
385
These must be disabled before calling any FFmpeg functions.  While the
Mans Rullgard's avatar
Mans Rullgard committed
386 387 388 389 390
included tools will do this automatically, other users of the
libraries must do it themselves.

@end itemize

391
@bye