ac4b871545ba0ba6ea45dadbcf2e9e2bdb64c1c3
[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 Libav 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 Libav, you need to install and use GNU Make
30 (@command{gmake}).
31
32 @section (Open)Solaris
33
34 GNU Make is required to build Libav, 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 (OS X, iPhone)
49
50 The toolchain provided with Xcode is sufficient to build the basic
51 unacelerated code.
52
53 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, Libav's configure will pick it up automatically.
57
58 OS X on AMD64 and x86 requires @command{yasm} to build most of the
59 optimized assembler functions @url{http://mxcl.github.com/homebrew/, Homebrew},
60 @url{http://www.gentoo.org/proj/en/gentoo-alt/prefix/bootstrap-macos.xml, Gentoo Prefix}
61 or @url{http://www.macports.org, MacPorts} can easily provide it.
62
63
64 @chapter DOS
65
66 Using a cross-compiler is preferred for various reasons.
67 @url{http://www.delorie.com/howto/djgpp/linux-x-djgpp.html}
68
69
70 @chapter OS/2
71
72 For information about compiling Libav on OS/2 see
73 @url{http://www.edm2.com/index.php/FFmpeg}.
74
75
76 @chapter Windows
77
78 @section Native Windows compilation
79
80 Libav can be built to run natively on Windows using the MinGW or MinGW-w64
81 toolchains. Install the latest versions of MSYS and MinGW or MinGW-w64 from
82 @url{http://www.mingw.org/} or @url{http://mingw-w64.sourceforge.net/}.
83 You can find detailed installation instructions in the download section and
84 the FAQ.
85
86 Notes:
87
88 @itemize
89
90 @item Building natively using MSYS can be sped up by disabling implicit rules
91 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
92 speed up is close to non-existent for normal one-off builds and is only
93 noticeable when running make for a second time (for example during
94 @code{make install}).
95
96 @item In order to compile AVplay, you must have the MinGW development library
97 of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
98
99 @item By using @code{./configure --enable-shared} when configuring Libav,
100 you can build all libraries as DLLs.
101
102 @end itemize
103
104 @section Microsoft Visual C++ compatibility
105
106 As stated in the FAQ, Libav will not compile under MSVC++. However, if you
107 want to use the libav* libraries in your own applications, you can still
108 compile those applications using MSVC++. But the libav* libraries you link
109 to @emph{must} be built with MinGW. However, you will not be able to debug
110 inside the libav* libraries, since MSVC++ does not recognize the debug
111 symbols generated by GCC.
112 We strongly recommend you to move over from MSVC++ to MinGW tools.
113
114 This description of how to use the Libav libraries with MSVC++ is based on
115 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
116 you might have to modify the procedures slightly.
117
118 @subsection Using shared libraries
119
120 This is how to create DLL and LIB files that are compatible with MSVC++:
121
122 Within the MSYS shell, build Libav with
123
124 @example
125 ./configure --enable-shared
126 make
127 make install
128 @end example
129
130 Your install path (@file{/usr/local/} by default) should now have the
131 necessary DLL and LIB files under the @file{bin} directory.
132
133 Alternatively, build the libraries with a cross compiler, according to
134 the instructions below in @ref{Cross compilation for Windows with Linux}.
135
136 To use those files with MSVC++, do the same as you would do with
137 the static libraries, as described above. But in Step 4,
138 you should only need to add the directory where the LIB files are installed
139 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
140 installed in the @file{bin} directory. And instead of adding the static
141 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
142 (@file{avcodec.lib}, @file{avformat.lib}, and
143 @file{avutil.lib}). Note that you should not use the GCC import
144 libraries (@file{libxxx.dll.a} files), as these will give you undefined
145 reference errors. There should be no need for @file{libmingwex.a},
146 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
147 statically linked into the DLLs.
148
149 Libav headers do not declare global data for Windows DLLs through the usual
150 dllexport/dllimport interface. Such data will be exported properly while
151 building, but to use them in your MSVC++ code you will have to edit the
152 appropriate headers and mark the data as dllimport. For example, in
153 libavutil/pixdesc.h you should have:
154 @example
155 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
156 @end example
157
158 Note that using import libraries created by dlltool requires
159 the linker optimization option to be set to
160 "References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
161 the resulting binaries will fail during runtime. This isn't
162 required when using import libraries generated by lib.exe.
163 This issue is reported upstream at
164 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
165
166 To create import libraries that work with the @code{/OPT:REF} option
167 (which is enabled by default in Release mode), follow these steps:
168
169 @enumerate
170
171 @item Open @emph{Visual Studio 2005 Command Prompt}.
172
173 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
174 which sets up the environment variables for the Visual C++ tools
175 (the standard location for this file is
176 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}).
177
178 @item Enter the @file{bin} directory where the created LIB and DLL files
179 are stored.
180
181 @item Generate new import libraries with @command{lib.exe}:
182
183 @example
184 lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
185 @end example
186
187 Replace @code{foo-version} and @code{foo} with the respective library names.
188
189 @end enumerate
190
191 @anchor{Cross compilation for Windows with Linux}
192 @section Cross compilation for Windows with Linux
193
194 You must use the MinGW cross compilation tools available at
195 @url{http://www.mingw.org/}.
196
197 Then configure Libav with the following options:
198 @example
199 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
200 @end example
201 (you can change the cross-prefix according to the prefix chosen for the
202 MinGW tools).
203
204 Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
205
206 @section Compilation under Cygwin
207
208 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
209 llrint() in its C library.
210
211 Install your Cygwin with all the "Base" packages, plus the
212 following "Devel" ones:
213 @example
214 binutils, gcc4-core, make, git, mingw-runtime, texi2html
215 @end example
216
217 In order to run FATE you will also need the following "Utils" packages:
218 @example
219 bc, diffutils
220 @end example
221
222 If you want to build Libav with additional libraries, download Cygwin
223 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
224 @example
225 libogg-devel, libvorbis-devel
226 @end example
227
228 These library packages are only available from
229 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
230
231 @example
232 yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
233 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
234 @end example
235
236 The recommendation for x264 is to build it from source, as it evolves too
237 quickly for Cygwin Ports to be up to date.
238
239 @section Crosscompilation for Windows under Cygwin
240
241 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
242
243 Just install your Cygwin as explained before, plus these additional
244 "Devel" packages:
245 @example
246 gcc-mingw-core, mingw-runtime, mingw-zlib
247 @end example
248
249 and add some special flags to your configure invocation.
250
251 For a static build run
252 @example
253 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
254 @end example
255
256 and for a build with shared libraries
257 @example
258 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
259 @end example
260
261 @bye