examples/avio_list_dir: init/deinit network
[ffmpeg.git] / doc / platform.texi
1 \input texinfo @c -*- texinfo -*-
2 @documentencoding UTF-8
3
4 @settitle Platform Specific Information
5 @titlepage
6 @center @titlefont{Platform Specific Information}
7 @end titlepage
8
9 @top
10
11 @contents
12
13 @chapter Unix-like
14
15 Some parts of FFmpeg cannot be built with version 2.15 of the GNU
16 assembler which is still provided by a few AMD64 distributions. To
17 make sure your compiler really uses the required version of gas
18 after a binutils upgrade, run:
19
20 @example
21 $(gcc -print-prog-name=as) --version
22 @end example
23
24 If not, then you should install a different compiler that has no
25 hard-coded path to gas. In the worst case pass @code{--disable-asm}
26 to configure.
27
28 @section Advanced linking configuration
29
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 to your project LDFLAGS:
34
35 @example
36 -Wl,-Bsymbolic
37 @end example
38
39 If your target platform requires position independent binaries, you should
40 pass the correct linking flag (e.g. @code{-pie}) to @code{--extra-ldexeflags}.
41
42 @section BSD
43
44 BSD make will not build FFmpeg, you need to install and use GNU Make
45 (@command{gmake}).
46
47 @section (Open)Solaris
48
49 GNU Make is required to build FFmpeg, so you have to invoke (@command{gmake}),
50 standard Solaris Make will not work. When building with a non-c99 front-end
51 (gcc, generic suncc) add either @code{--extra-libs=/usr/lib/values-xpg6.o}
52 or @code{--extra-libs=/usr/lib/64/values-xpg6.o} to the configure options
53 since the libc is not c99-compliant by default. The probes performed by
54 configure may raise an exception leading to the death of configure itself
55 due to a bug in the system shell. Simply invoke a different shell such as
56 bash directly to work around this:
57
58 @example
59 bash ./configure
60 @end example
61
62 @anchor{Darwin}
63 @section Darwin (Mac OS X, iPhone)
64
65 The toolchain provided with Xcode is sufficient to build the basic
66 unacelerated 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 @chapter DOS
82
83 Using a cross-compiler is preferred for various reasons.
84 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
85
86
87 @chapter OS/2
88
89 For information about compiling FFmpeg on OS/2 see
90 @url{http://www.edm2.com/index.php/FFmpeg}.
91
92
93 @chapter Windows
94
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 FFmpeg can be built to run natively on Windows using the MinGW-w64
101 toolchain. Install the latest versions of MSYS2 and MinGW-w64 from
102 @url{http://msys2.github.io/} and/or @url{http://mingw-w64.sourceforge.net/}.
103 You can find detailed installation instructions in the download section and
104 the FAQ.
105
106 Notes:
107
108 @itemize
109
110 @item Building natively using MSYS2 can be sped up by disabling implicit rules
111 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
112 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 @code{make install}).
115
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 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
120 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
121 libavformat) as DLLs.
122
123 @end itemize
124
125 @section Microsoft Visual C++ or Intel C++ Compiler for Windows
126
127 FFmpeg can be built with MSVC 2012 or earlier using a C99-to-C89 conversion utility
128 and wrapper, or with MSVC 2013 and ICL natively.
129
130 You will need the following prerequisites:
131
132 @itemize
133 @item @uref{https://github.com/libav/c99-to-c89/, C99-to-C89 Converter & Wrapper}
134 (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 @end itemize
141
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 Place @code{yasm.exe} somewhere in your @code{PATH}. If using MSVC 2012 or
146 earlier, place @code{c99wrap.exe} and @code{c99conv.exe} somewhere in your
147 @code{PATH} as well.
148
149 Next, make sure any other headers and libs you want to use, such as zlib, are
150 located in a spot that the compiler can see. Do so by modifying the @code{LIB}
151 and @code{INCLUDE} environment variables to include the @strong{Windows-style}
152 paths to these directories. Alternatively, you can try and use the
153 @code{--extra-cflags}/@code{--extra-ldflags} configure options. If using MSVC
154 2012 or earlier, place @code{inttypes.h} somewhere the compiler can see too.
155
156 Finally, run:
157
158 @example
159 For MSVC:
160 ./configure --toolchain=msvc
161
162 For ICL:
163 ./configure --toolchain=icl
164
165 make
166 make install
167 @end example
168
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 exports, you cannot compile static and shared libraries at the same time, and
172 enabling shared libraries will automatically disable the static ones.
173
174 Notes:
175
176 @itemize
177
178 @item It is possible that coreutils' @code{link.exe} conflicts with MSVC's linker.
179 You can find out by running @code{which link} to see which @code{link.exe} you
180 are using. If it is located at @code{/bin/link.exe}, then you have the wrong one
181 in your @code{PATH}. Either move or remove that copy, or make sure MSVC's
182 @code{link.exe} takes precedence in your @code{PATH} over coreutils'.
183
184 @item If you wish to build with zlib support, you will have to grab a compatible
185 zlib binary from somewhere, with an MSVC import lib, or if you wish to link
186 statically, you can follow the instructions below to build a compatible
187 @code{zlib.lib} with MSVC. Regardless of which method you use, you must still
188 follow step 3, or compilation will fail.
189 @enumerate
190 @item Grab the @uref{http://zlib.net/, zlib sources}.
191 @item Edit @code{win32/Makefile.msc} so that it uses -MT instead of -MD, since
192 this is how FFmpeg is built as well.
193 @item Edit @code{zconf.h} and remove its inclusion of @code{unistd.h}. This gets
194 erroneously included when building FFmpeg.
195 @item Run @code{nmake -f win32/Makefile.msc}.
196 @item Move @code{zlib.lib}, @code{zconf.h}, and @code{zlib.h} to somewhere MSVC
197 can see.
198 @end enumerate
199
200 @item FFmpeg has been tested with the following on i686 and x86_64:
201 @itemize
202 @item Visual Studio 2010 Pro and Express
203 @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 Anything else is not officially supported.
209
210 @end itemize
211
212 @subsection Linking to FFmpeg with Microsoft Visual C++
213
214 If you plan to link with MSVC-built static libraries, you will need
215 to make sure you have @code{Runtime Library} set to
216 @code{Multi-threaded (/MT)} in your project's settings.
217
218 You will need to define @code{inline} to something MSVC understands:
219 @example
220 #define inline __inline
221 @end example
222
223 Also note, that as stated in @strong{Microsoft Visual C++}, you will need
224 an MSVC-compatible @uref{http://code.google.com/p/msinttypes/, inttypes.h}.
225
226 If you plan on using import libraries created by dlltool, you must
227 set @code{References} to @code{No (/OPT:NOREF)} under the linker optimization
228 settings, otherwise the resulting binaries will fail during runtime.
229 This is not required when using import libraries generated by @code{lib.exe}.
230 This issue is reported upstream at
231 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
232
233 To create import libraries that work with the @code{/OPT:REF} option
234 (which is enabled by default in Release mode), follow these steps:
235
236 @enumerate
237
238 @item Open the @emph{Visual Studio Command Prompt}.
239
240 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
241 which sets up the environment variables for the Visual C++ tools
242 (the standard location for this file is something like
243 @file{C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat}).
244
245 @item Enter the @file{bin} directory where the created LIB and DLL files
246 are stored.
247
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 @end example
253
254 Replace @code{foo-version} and @code{foo} with the respective library names.
255
256 @end enumerate
257
258 @anchor{Cross compilation for Windows with Linux}
259 @section Cross compilation for Windows with Linux
260
261 You must use the MinGW cross compilation tools available at
262 @url{http://www.mingw.org/}.
263
264 Then configure FFmpeg with the following options:
265 @example
266 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
267 @end example
268 (you can change the cross-prefix according to the prefix chosen for the
269 MinGW tools).
270
271 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
272
273 @section Compilation under Cygwin
274
275 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
276 llrint() in its C library.
277
278 Install your Cygwin with all the "Base" packages, plus the
279 following "Devel" ones:
280 @example
281 binutils, gcc4-core, make, git, mingw-runtime, texinfo
282 @end example
283
284 In order to run FATE you will also need the following "Utils" packages:
285 @example
286 diffutils
287 @end example
288
289 If you want to build FFmpeg with additional libraries, download Cygwin
290 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
291 @example
292 libogg-devel, libvorbis-devel
293 @end example
294
295 These library packages are only available from
296 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
297
298 @example
299 yasm, libSDL-devel, libfaac-devel, libaacplus-devel, libgsm-devel, libmp3lame-devel,
300 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
301 @end example
302
303 The recommendation for x264 is to build it from source, as it evolves too
304 quickly for Cygwin Ports to be up to date.
305
306 @section Crosscompilation for Windows under Cygwin
307
308 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
309
310 Just install your Cygwin as explained before, plus these additional
311 "Devel" packages:
312 @example
313 gcc-mingw-core, mingw-runtime, mingw-zlib
314 @end example
315
316 and add some special flags to your configure invocation.
317
318 For a static build run
319 @example
320 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
321 @end example
322
323 and for a build with shared libraries
324 @example
325 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
326 @end example
327
328 @chapter Plan 9
329
330 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
332 port must be used.  Furthermore, a few items missing from the C
333 library and shell environment need to be fixed.
334
335 @itemize
336
337 @item GNU awk, grep, make, and sed
338
339 Working packages of these tools can be found at
340 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}.
341 They can be installed with @uref{http://9front.org/, 9front's} @code{pkg}
342 utility by setting @code{pkgpath} to
343 @code{http://ports2plan9.googlecode.com/files/}.
344
345 @item Missing/broken @code{head} and @code{printf} commands
346
347 Replacements adequate for building FFmpeg can be found in the
348 @code{compat/plan9} directory.  Place these somewhere they will be
349 found by the shell.  These are not full implementations of the
350 commands and are @emph{not} suitable for general use.
351
352 @item Missing C99 @code{stdint.h} and @code{inttypes.h}
353
354 Replacement headers are available from
355 @url{http://code.google.com/p/plan9front/issues/detail?id=152}.
356
357 @item Missing or non-standard library functions
358
359 Some functions in the C library are missing or incomplete.  The
360 @code{@uref{http://ports2plan9.googlecode.com/files/gcc-apelibs-1207.tbz,
361 gcc-apelibs-1207}} package from
362 @uref{http://code.google.com/p/ports2plan9/downloads/list, ports2plan9}
363 includes an updated C library, but installing the full package gives
364 unusable executables.  Instead, keep the files from @code{gccbin.tgz}
365 under @code{/386/lib/gnu}.  From the @code{libc.a} archive in the
366 @code{gcc-apelibs-1207} package, extract the following object files and
367 turn them into a library:
368
369 @itemize
370 @item @code{strerror.o}
371 @item @code{strtoll.o}
372 @item @code{snprintf.o}
373 @item @code{vsnprintf.o}
374 @item @code{vfprintf.o}
375 @item @code{_IO_getc.o}
376 @item @code{_IO_putc.o}
377 @end itemize
378
379 Use the @code{--extra-libs} option of @code{configure} to inform the
380 build system of this library.
381
382 @item FPU exceptions enabled by default
383
384 Unlike most other systems, Plan 9 enables FPU exceptions by default.
385 These must be disabled before calling any FFmpeg functions.  While the
386 included tools will do this automatically, other users of the
387 libraries must do it themselves.
388
389 @end itemize
390
391 @bye