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