Fix typo in platform documentation.
[ffmpeg.git] / doc / platform.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle Platform Specific information
4 @titlepage
5 @center @titlefont{Platform Specific information}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Unix-like
13
14 Some parts of FFmpeg cannot be built with version 2.15 of the GNU
15 assembler which is still provided by a few AMD64 distributions. To
16 make sure your compiler really uses the required version of gas
17 after a binutils upgrade, run:
18
19 @example
20 $(gcc -print-prog-name=as) --version
21 @end example
22
23 If not, then you should install a different compiler that has no
24 hard-coded path to gas. In the worst case pass @code{--disable-asm}
25 to configure.
26
27 @section BSD
28
29 BSD make will not build FFmpeg, you need to install and use GNU Make
30 (@command{gmake}).
31
32 @section (Open)Solaris
33
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
43 @example
44 bash ./configure
45 @end example
46
47 @anchor{Darwin}
48 @section Darwin (Mac OS X, iPhone)
49
50 The toolchain provided with Xcode is sufficient to build the basic
51 unacelerated code.
52
53 Mac OS X on PowerPC or ARM (iPhone) requires a preprocessor from
54 @url{http://github.com/yuvi/gas-preprocessor} to build the optimized
55 assembler functions. Just download the Perl script and put it somewhere
56 in your PATH, FFmpeg's configure will pick it up automatically.
57
58 Mac OS X on amd64 and x86 requires @command{yasm} to build most of the
59 optimized assembler functions. @uref{http://www.finkproject.org/, Fink},
60 @uref{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix},
61 @uref{http://mxcl.github.com/homebrew/, Homebrew}
62 or @uref{http://www.macports.org, MacPorts} can easily provide it.
63
64
65 @chapter DOS
66
67 Using a cross-compiler is preferred for various reasons.
68 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
69
70
71 @chapter OS/2
72
73 For information about compiling FFmpeg on OS/2 see
74 @url{http://www.edm2.com/index.php/FFmpeg}.
75
76
77 @chapter Windows
78
79 To get help and instructions for building FFmpeg under Windows, check out
80 the FFmpeg Windows Help Forum at
81 @url{http://ffmpeg.arrozcru.org/}.
82
83 @section Native Windows compilation using MinGW or MinGW-w64
84
85 FFmpeg can be built to run natively on Windows using the MinGW or MinGW-w64
86 toolchains. Install the latest versions of MSYS and MinGW or MinGW-w64 from
87 @url{http://www.mingw.org/} or @url{http://mingw-w64.sourceforge.net/}.
88 You can find detailed installation instructions in the download section and
89 the FAQ.
90
91 Notes:
92
93 @itemize
94
95 @item Building natively using MSYS can be sped up by disabling implicit rules
96 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
97 speed up is close to non-existent for normal one-off builds and is only
98 noticeable when running make for a second time (for example during
99 @code{make install}).
100
101 @item In order to compile FFplay, you must have the MinGW development library
102 of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
103
104 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
105 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
106 libavformat) as DLLs.
107
108 @end itemize
109
110 @section Microsoft Visual C++
111
112 FFmpeg can be built with MSVC using a C99-to-C89 conversion utility and
113 wrapper.
114
115 You will need the following prerequisites:
116
117 @itemize
118 @item @uref{https://github.com/rbultje/c99-to-c89/, C99-to-C89 Converter & Wrapper}
119 @item @uref{http://code.google.com/p/msinttypes/, msinttypes}
120 @item @uref{http://www.mingw.org/, MSYS}
121 @item @uref{http://yasm.tortall.net/, YASM}
122 @item @uref{http://gnuwin32.sourceforge.net/packages/bc.htm, bc for Windows} if
123 you want to run @uref{fate.html, FATE}.
124 @end itemize
125
126 To set up a proper MSVC environment in MSYS, you simply need to run
127 @code{msys.bat} from the Visual Studio command prompt.
128
129 Place @code{makedef}, @code{c99wrap.exe}, @code{c99conv.exe}, and @code{yasm.exe}
130 somewhere in your @code{PATH}.
131
132 Next, make sure @code{inttypes.h} and any other headers and libs you want to use
133 are located in a spot that MSVC can see. Do so by modifying the @code{LIB} and
134 @code{INCLUDE} environment variables to include the @strong{Windows} paths to
135 these directories. Alternatively, you can try and use the
136 @code{--extra-cflags}/@code{--extra-ldflags} configure options.
137
138 Finally, run:
139
140 @example
141 ./configure --toolchain=msvc
142 make
143 make install
144 @end example
145
146 If you wish to compile shared libraries, add @code{--enable-shared} to your
147 configure options. Note that due to the way MSVC handles DLL imports and
148 exports, you cannot compile static and shared libraries at the same time, and
149 enabling shared libraries will automatically disable the static ones.
150
151 Notes:
152
153 @itemize
154
155 @item It is possible that coreutils' @code{link.exe} conflicts with MSVC's linker.
156 You can find out by running @code{which link} to see which @code{link.exe} you
157 are using. If it is located at @code{/bin/link.exe}, then you have the wrong one
158 in your @code{PATH}. Either move or remove that copy, or make sure MSVC's
159 @code{link.exe} takes precedence in your @code{PATH} over coreutils'.
160
161 @item If you wish to build with zlib support, you will have to grab a compatible
162 zlib binary from somewhere, with an MSVC import lib, or if you wish to link
163 statically, you can follow the instructions below to build a compatible
164 @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
165 follow step 3, or compilation will fail.
166 @enumerate
167 @item Grab the @uref{http://zlib.net/, zlib sources}.
168 @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
169 this is how FFmpeg is built as well.
170 @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
171 erroneously included when building FFmpeg.
172 @item Run @code{nmake -f win32/Makefile.msc}.
173 @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
174 can see.
175 @end enumerate
176
177 @item FFmpeg has been tested with Visual Studio 2010 and 2012, Pro and Express.
178 Anything else is not officially supported.
179
180 @end itemize
181
182 @subsection Linking to FFmpeg with Microsoft Visual C++
183
184 If you plan to link with MSVC-built static libraries, you will need
185 to make sure you have @code{Runtime Library} set to
186 @code{Multi-threaded (/MT)} in your project's settings.
187
188 FFmpeg headers do not declare global data for Windows DLLs through the usual
189 dllexport/dllimport interface. Such data will be exported properly while
190 building, but to use them in your MSVC code you will have to edit the
191 appropriate headers and mark the data as dllimport. For example, in
192 libavutil/pixdesc.h you should have:
193 @example
194 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
195 @end example
196
197 You will also need to define @code{inline} to something MSVC understands:
198 @example
199 #define inline __inline
200 @end example
201
202 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
203 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
204
205 If you plan on using import libraries created by dlltool, you must
206 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
207 settings, otherwise the resulting binaries will fail during runtime.
208 This is not required when using import libraries generated by @code{lib.exe}.
209 This issue is reported upstream at
210 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
211
212 To create import libraries that work with the @code{/OPT:REF} option
213 (which is enabled by default in Release mode), follow these steps:
214
215 @enumerate
216
217 @item Open the @emph{Visual Studio Command Prompt}.
218
219 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
220 which sets up the environment variables for the Visual C++ tools
221 (the standard location for this file is something like
222 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
223
224 @item Enter the @file{bin} directory where the created LIB and DLL files
225 are stored.
226
227 @item Generate new import libraries with @command{lib.exe}:
228
229 @example
230 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
231 @end example
232
233 Replace @code{foo-version} and @code{foo} with the respective library names.
234
235 @end enumerate
236
237 @anchor{Cross compilation for Windows with Linux}
238 @section Cross compilation for Windows with Linux
239
240 You must use the MinGW cross compilation tools available at
241 @url{http://www.mingw.org/}.
242
243 Then configure FFmpeg with the following options:
244 @example
245 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
246 @end example
247 (you can change the cross-prefix according to the prefix chosen for the
248 MinGW tools).
249
250 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
251
252 @section Compilation under Cygwin
253
254 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
255 llrint() in its C library.
256
257 Install your Cygwin with all the "Base" packages, plus the
258 following "Devel" ones:
259 @example
260 binutils, gcc4-core, make, git, mingw-runtime, texi2html
261 @end example
262
263 In order to run FATE you will also need the following "Utils" packages:
264 @example
265 bc, diffutils
266 @end example
267
268 If you want to build FFmpeg with additional libraries, download Cygwin
269 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
270 @example
271 libogg-devel, libvorbis-devel
272 @end example
273
274 These library packages are only available from
275 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
276
277 @example
278 yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
279 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
280 @end example
281
282 The recommendation for x264 is to build it from source, as it evolves too
283 quickly for Cygwin Ports to be up to date.
284
285 @section Crosscompilation for Windows under Cygwin
286
287 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
288
289 Just install your Cygwin as explained before, plus these additional
290 "Devel" packages:
291 @example
292 gcc-mingw-core, mingw-runtime, mingw-zlib
293 @end example
294
295 and add some special flags to your configure invocation.
296
297 For a static build run
298 @example
299 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
300 @end example
301
302 and for a build with shared libraries
303 @example
304 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
305 @end example
306
307 @chapter Plan 9
308
309 The native @uref{http://plan9.bell-labs.com/plan9/, Plan 9} compiler
310 does not implement all the C99 features needed by FFmpeg so the gcc
311 port must be used.  Furthermore, a few items missing from the C
312 library and shell environment need to be fixed.
313
314 @itemize
315
316 @item GNU awk, grep, make, and sed
317
318 Working packages of these tools can be found at
319 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}.
320 They can be installed with @uref{http://9front.org/, 9front's} @code{pkg}
321 utility by setting @code{pkgpath} to
322 @code{http://ports2plan9.googlecode.com/files/}.
323
324 @item Missing/broken @code{head} and @code{printf} commands
325
326 Replacements adequate for building FFmpeg can be found in the
327 @code{compat/plan9} directory.  Place these somewhere they will be
328 found by the shell.  These are not full implementations of the
329 commands and are @emph{not} suitable for general use.
330
331 @item Missing C99 @code{stdint.h} and @code{inttypes.h}
332
333 Replacement headers are available from
334 @url{http://code.google.com/p/plan9front/issues/detail?id=152}.
335
336 @item Missing or non-standard library functions
337
338 Some functions in the C library are missing or incomplete.  The
339 @code{@uref{http://ports2plan9.googlecode.com/files/gcc-apelibs-1207.tbz,
340 gcc-apelibs-1207}} package from
341 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}
342 includes an updated C library, but installing the full package gives
343 unusable executables.  Instead, keep the files from @code{gccbin.tgz}
344 under @code{/386/lib/gnu}.  From the @code{libc.a} archive in the
345 @code{gcc-apelibs-1207} package, extract the following object files and
346 turn them into a library:
347
348 @itemize
349 @item @code{strerror.o}
350 @item @code{strtoll.o}
351 @item @code{snprintf.o}
352 @item @code{vsnprintf.o}
353 @item @code{vfprintf.o}
354 @item @code{_IO_getc.o}
355 @item @code{_IO_putc.o}
356 @end itemize
357
358 Use the @code{--extra-libs} option of @code{configure} to inform the
359 build system of this library.
360
361 @item FPU exceptions enabled by default
362
363 Unlike most other systems, Plan 9 enables FPU exceptions by default.
364 These must be disabled before calling any FFmpeg functions.  While the
365 included tools will do this automatically, other users of the
366 libraries must do it themselves.
367
368 @end itemize
369
370 @bye