platform.texi 13.7 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

The toolchain provided with Xcode is sufficient to build the basic
66
unaccelerated 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 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 111 112 113
@item Building for the MSYS environment is discouraged, MSYS2 provides a full
MinGW-w64 environment through @file{mingw64_shell.bat} or
@file{mingw32_shell.bat} that should be used instead of the environment
provided by @file{msys2_shell.bat}.
114 115 116

@item Building using MSYS2 can be sped up by disabling implicit rules in the
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 120
@code{make install}).

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 125 126
@item By using @code{./configure --enable-shared} when configuring FFmpeg,
you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
libavformat) as DLLs.
127 128 129

@end itemize

130 131 132 133 134 135
@subsection Native Windows compilation using MSYS2

The MSYS2 MinGW-w64 environment provides ready to use toolchains and dependencies
through @command{pacman}.

Make sure to use @file{mingw64_shell.bat} or @file{mingw32_shell.bat} to have
136 137
the correct MinGW-w64 environment. The default install provides shortcuts to
them under @command{MinGW-w64 Win64 Shell} and @command{MinGW-w64 Win32 Shell}.
138 139 140 141 142 143 144 145 146

@example
# normal msys2 packages
pacman -S make pkgconf diffutils

# mingw-w64 packages and toolchains
pacman -S mingw-w64-x86_64-yasm mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL
@end example

147
To target 32 bits replace @code{x86_64} with @code{i686} in the command above.
148

149
@section Microsoft Visual C++ or Intel C++ Compiler for Windows
150

151 152
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.
153

154
You will need the following prerequisites:
155

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

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 170 171
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.
172

173 174 175
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}
176
paths to these directories. Alternatively, you can try to use the
177 178
@code{--extra-cflags}/@code{--extra-ldflags} configure options. If using MSVC
2012 or earlier, place @code{inttypes.h} somewhere the compiler can see too.
179 180 181 182

Finally, run:

@example
183
For MSVC:
184
./configure --toolchain=msvc
185 186 187 188

For ICL:
./configure --toolchain=icl

189 190 191 192
make
make install
@end example

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 196 197
exports, you cannot compile static and shared libraries at the same time, and
enabling shared libraries will automatically disable the static ones.

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
Notes:

@itemize

@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

218
@item FFmpeg has been tested with the following on i686 and x86_64:
219 220 221
@itemize
@item Visual Studio 2010 Pro and Express
@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 227 228 229
Anything else is not officially supported.

@end itemize

230
@subsection Linking to FFmpeg with Microsoft Visual C++
231

232 233 234
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.
235

236
You will need to define @code{inline} to something MSVC understands:
237 238 239 240 241 242 243 244 245 246 247
@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}.
248 249 250 251 252 253 254 255
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

256
@item Open the @emph{Visual Studio Command Prompt}.
257 258 259

Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
which sets up the environment variables for the Visual C++ tools
260 261
(the standard location for this file is something like
@file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
262 263 264 265

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

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 271
@end example

272 273
Replace @code{foo-version} and @code{foo} with the respective library names.

274 275 276 277 278 279 280 281
@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/}.

282
Then configure FFmpeg with the following options:
283 284 285 286 287 288
@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).

289
Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
290 291 292 293 294 295 296 297 298

@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
299
binutils, gcc4-core, make, git, mingw-runtime, texinfo
300 301
@end example

302
In order to run FATE you will also need the following "Utils" packages:
303
@example
304
diffutils
305 306
@end example

307
If you want to build FFmpeg with additional libraries, download Cygwin
308 309 310 311 312 313 314 315 316
"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
317
yasm, libSDL-devel, libgsm-devel, libmp3lame-devel,
Diego Biurrun's avatar
Diego Biurrun committed
318
libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
319 320
@end example

321 322
The recommendation for x264 is to build it from source, as it evolves too
quickly for Cygwin Ports to be up to date.
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

@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
346 347 348
@chapter Plan 9

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
Mans Rullgard's avatar
Mans Rullgard committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
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

365
Replacements adequate for building FFmpeg can be found in the
Mans Rullgard's avatar
Mans Rullgard committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
@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.
403
These must be disabled before calling any FFmpeg functions.  While the
Mans Rullgard's avatar
Mans Rullgard committed
404 405 406 407 408
included tools will do this automatically, other users of the
libraries must do it themselves.

@end itemize

409
@bye