platform.texi 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. \input texinfo @c -*- texinfo -*-
  2. @documentencoding UTF-8
  3. @settitle Platform Specific Information
  4. @titlepage
  5. @center @titlefont{Platform Specific Information}
  6. @end titlepage
  7. @top
  8. @contents
  9. @chapter Unix-like
  10. Some parts of FFmpeg cannot be built with version 2.15 of the GNU
  11. assembler which is still provided by a few AMD64 distributions. To
  12. make sure your compiler really uses the required version of gas
  13. after a binutils upgrade, run:
  14. @example
  15. $(gcc -print-prog-name=as) --version
  16. @end example
  17. If not, then you should install a different compiler that has no
  18. hard-coded path to gas. In the worst case pass @code{--disable-asm}
  19. to configure.
  20. @section Advanced linking configuration
  21. If you compiled FFmpeg libraries statically and you want to use them to
  22. build your own shared library, you may need to force PIC support (with
  23. @code{--enable-pic} during FFmpeg configure) and add the following option
  24. to your project LDFLAGS:
  25. @example
  26. -Wl,-Bsymbolic
  27. @end example
  28. If your target platform requires position independent binaries, you should
  29. pass the correct linking flag (e.g. @code{-pie}) to @code{--extra-ldexeflags}.
  30. @section BSD
  31. BSD make will not build FFmpeg, you need to install and use GNU Make
  32. (@command{gmake}).
  33. @section (Open)Solaris
  34. GNU Make is required to build FFmpeg, so you have to invoke (@command{gmake}),
  35. standard Solaris Make will not work. When building with a non-c99 front-end
  36. (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
  37. or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
  38. since the libc is not c99-compliant by default. The probes performed by
  39. configure may raise an exception leading to the death of configure itself
  40. due to a bug in the system shell. Simply invoke a different shell such as
  41. bash directly to work around this:
  42. @example
  43. bash ./configure
  44. @end example
  45. @anchor{Darwin}
  46. @section Darwin (Mac OS X, iPhone)
  47. The toolchain provided with Xcode is sufficient to build the basic
  48. unaccelerated code.
  49. Mac OS X on PowerPC or ARM (iPhone) requires a preprocessor from
  50. @url{https://github.com/FFmpeg/gas-preprocessor} or
  51. @url{https://github.com/yuvi/gas-preprocessor}(currently outdated) to build the optimized
  52. assembly functions. Put the Perl script somewhere
  53. in your PATH, FFmpeg's configure will pick it up automatically.
  54. Mac OS X on amd64 and x86 requires @command{nasm} to build most of the
  55. optimized assembly functions. @uref{http://www.finkproject.org/, Fink},
  56. @uref{https://wiki.gentoo.org/wiki/Project:Prefix, Gentoo Prefix},
  57. @uref{https://mxcl.github.com/homebrew/, Homebrew}
  58. or @uref{http://www.macports.org, MacPorts} can easily provide it.
  59. @chapter DOS
  60. Using a cross-compiler is preferred for various reasons.
  61. @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
  62. @chapter OS/2
  63. For information about compiling FFmpeg on OS/2 see
  64. @url{http://www.edm2.com/index.php/FFmpeg}.
  65. @chapter Windows
  66. To get help and instructions for building FFmpeg under Windows, check out
  67. the FFmpeg Windows Help Forum at @url{http://ffmpeg.zeranoe.com/forum/}.
  68. @section Native Windows compilation using MinGW or MinGW-w64
  69. FFmpeg can be built to run natively on Windows using the MinGW-w64
  70. toolchain. Install the latest versions of MSYS2 and MinGW-w64 from
  71. @url{http://msys2.github.io/} and/or @url{http://mingw-w64.sourceforge.net/}.
  72. You can find detailed installation instructions in the download section and
  73. the FAQ.
  74. Notes:
  75. @itemize
  76. @item Building for the MSYS environment is discouraged, MSYS2 provides a full
  77. MinGW-w64 environment through @file{mingw64_shell.bat} or
  78. @file{mingw32_shell.bat} that should be used instead of the environment
  79. provided by @file{msys2_shell.bat}.
  80. @item Building using MSYS2 can be sped up by disabling implicit rules in the
  81. Makefile by calling @code{make -r} instead of plain @code{make}. This
  82. speed up is close to non-existent for normal one-off builds and is only
  83. noticeable when running make for a second time (for example during
  84. @code{make install}).
  85. @item In order to compile FFplay, you must have the MinGW development library
  86. of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
  87. @item By using @code{./configure --enable-shared} when configuring FFmpeg,
  88. you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
  89. libavformat) as DLLs.
  90. @end itemize
  91. @subsection Native Windows compilation using MSYS2
  92. The MSYS2 MinGW-w64 environment provides ready to use toolchains and dependencies
  93. through @command{pacman}.
  94. Make sure to use @file{mingw64_shell.bat} or @file{mingw32_shell.bat} to have
  95. the correct MinGW-w64 environment. The default install provides shortcuts to
  96. them under @command{MinGW-w64 Win64 Shell} and @command{MinGW-w64 Win32 Shell}.
  97. @example
  98. # normal msys2 packages
  99. pacman -S make pkgconf diffutils
  100. # mingw-w64 packages and toolchains
  101. pacman -S mingw-w64-x86_64-nasm mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL2
  102. @end example
  103. To target 32 bits replace @code{x86_64} with @code{i686} in the command above.
  104. @section Microsoft Visual C++ or Intel C++ Compiler for Windows
  105. FFmpeg can be built with MSVC 2012 or earlier using a C99-to-C89 conversion utility
  106. and wrapper, or with MSVC 2013 and ICL natively.
  107. You will need the following prerequisites:
  108. @itemize
  109. @item @uref{https://github.com/libav/c99-to-c89/, C99-to-C89 Converter & Wrapper}
  110. (if using MSVC 2012 or earlier)
  111. @item @uref{http://code.google.com/p/msinttypes/, msinttypes}
  112. (if using MSVC 2012 or earlier)
  113. @item @uref{http://msys2.github.io/, MSYS2}
  114. @item @uref{http://www.nasm.us/, NASM}
  115. (Also available via MSYS2's package manager.)
  116. @end itemize
  117. To set up a proper environment in MSYS2, you need to run @code{msys_shell.bat} from
  118. the Visual Studio or Intel Compiler command prompt.
  119. Place @code{yasm.exe} somewhere in your @code{PATH}. If using MSVC 2012 or
  120. earlier, place @code{c99wrap.exe} and @code{c99conv.exe} somewhere in your
  121. @code{PATH} as well.
  122. Next, make sure any other headers and libs you want to use, such as zlib, are
  123. located in a spot that the compiler can see. Do so by modifying the @code{LIB}
  124. and @code{INCLUDE} environment variables to include the @strong{Windows-style}
  125. paths to these directories. Alternatively, you can try to use the
  126. @code{--extra-cflags}/@code{--extra-ldflags} configure options. If using MSVC
  127. 2012 or earlier, place @code{inttypes.h} somewhere the compiler can see too.
  128. Finally, run:
  129. @example
  130. For MSVC:
  131. ./configure --toolchain=msvc
  132. For ICL:
  133. ./configure --toolchain=icl
  134. make
  135. make install
  136. @end example
  137. If you wish to compile shared libraries, add @code{--enable-shared} to your
  138. configure options. Note that due to the way MSVC and ICL handle DLL imports and
  139. exports, you cannot compile static and shared libraries at the same time, and
  140. enabling shared libraries will automatically disable the static ones.
  141. Notes:
  142. @itemize
  143. @item If you wish to build with zlib support, you will have to grab a compatible
  144. zlib binary from somewhere, with an MSVC import lib, or if you wish to link
  145. statically, you can follow the instructions below to build a compatible
  146. @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
  147. follow step 3, or compilation will fail.
  148. @enumerate
  149. @item Grab the @uref{http://zlib.net/, zlib sources}.
  150. @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
  151. this is how FFmpeg is built as well.
  152. @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
  153. erroneously included when building FFmpeg.
  154. @item Run @code{nmake -f win32/Makefile.msc}.
  155. @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
  156. can see.
  157. @end enumerate
  158. @item FFmpeg has been tested with the following on i686 and x86_64:
  159. @itemize
  160. @item Visual Studio 2010 Pro and Express
  161. @item Visual Studio 2012 Pro and Express
  162. @item Visual Studio 2013 Pro and Express
  163. @item Intel Composer XE 2013
  164. @item Intel Composer XE 2013 SP1
  165. @end itemize
  166. Anything else is not officially supported.
  167. @end itemize
  168. @subsection Linking to FFmpeg with Microsoft Visual C++
  169. If you plan to link with MSVC-built static libraries, you will need
  170. to make sure you have @code{Runtime Library} set to
  171. @code{Multi-threaded (/MT)} in your project's settings.
  172. You will need to define @code{inline} to something MSVC understands:
  173. @example
  174. #define inline __inline
  175. @end example
  176. Also note, that as stated in @strong{Microsoft Visual C++}, you will need
  177. an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
  178. If you plan on using import libraries created by dlltool, you must
  179. set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
  180. settings, otherwise the resulting binaries will fail during runtime.
  181. This is not required when using import libraries generated by @code{lib.exe}.
  182. This issue is reported upstream at
  183. @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
  184. To create import libraries that work with the @code{/OPT:REF} option
  185. (which is enabled by default in Release mode), follow these steps:
  186. @enumerate
  187. @item Open the @emph{Visual Studio Command Prompt}.
  188. Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
  189. which sets up the environment variables for the Visual C++ tools
  190. (the standard location for this file is something like
  191. @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
  192. @item Enter the @file{bin} directory where the created LIB and DLL files
  193. are stored.
  194. @item Generate new import libraries with @command{lib.exe}:
  195. @example
  196. lib /machine:i386 /def:..\lib\foo-version.def /out:foo.lib
  197. @end example
  198. Replace @code{foo-version} and @code{foo} with the respective library names.
  199. @end enumerate
  200. @anchor{Cross compilation for Windows with Linux}
  201. @section Cross compilation for Windows with Linux
  202. You must use the MinGW cross compilation tools available at
  203. @url{http://www.mingw.org/}.
  204. Then configure FFmpeg with the following options:
  205. @example
  206. ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
  207. @end example
  208. (you can change the cross-prefix according to the prefix chosen for the
  209. MinGW tools).
  210. Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
  211. @section Compilation under Cygwin
  212. Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
  213. llrint() in its C library.
  214. Install your Cygwin with all the "Base" packages, plus the
  215. following "Devel" ones:
  216. @example
  217. binutils, gcc4-core, make, git, mingw-runtime, texinfo
  218. @end example
  219. In order to run FATE you will also need the following "Utils" packages:
  220. @example
  221. diffutils
  222. @end example
  223. If you want to build FFmpeg with additional libraries, download Cygwin
  224. "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
  225. @example
  226. libogg-devel, libvorbis-devel
  227. @end example
  228. These library packages are only available from
  229. @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
  230. @example
  231. yasm, libSDL-devel, libgsm-devel, libmp3lame-devel,
  232. speex-devel, libtheora-devel, libxvidcore-devel
  233. @end example
  234. The recommendation for x264 is to build it from source, as it evolves too
  235. quickly for Cygwin Ports to be up to date.
  236. @section Crosscompilation for Windows under Cygwin
  237. With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
  238. Just install your Cygwin as explained before, plus these additional
  239. "Devel" packages:
  240. @example
  241. gcc-mingw-core, mingw-runtime, mingw-zlib
  242. @end example
  243. and add some special flags to your configure invocation.
  244. For a static build run
  245. @example
  246. ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
  247. @end example
  248. and for a build with shared libraries
  249. @example
  250. ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
  251. @end example
  252. @bye