Correct use of OSX to Mac OS X and properly format yasm providers on Mac OS X
[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 (@file{gmake}).
31
32 @section (Open)Solaris
33
34 GNU Make is required to build FFmpeg, so you have to invoke (@file{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
84
85 FFmpeg can be built to run natively on Windows using the MinGW tools. Install
86 the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
87 You can find detailed installation instructions in the download
88 section and the FAQ.
89
90 FFmpeg does not build out-of-the-box with the packages the automated MinGW
91 installer provides. It also requires coreutils to be installed and many other
92 packages updated to the latest version. The minimum version for some packages
93 are listed below:
94
95 @itemize
96 @item bash 3.1
97 @item msys-make 3.81-2 (note: not mingw32-make)
98 @item w32api 3.13
99 @item mingw-runtime 3.15
100 @end itemize
101
102 FFmpeg automatically passes @code{-fno-common} to the compiler to work around
103 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
104
105 Notes:
106
107 @itemize
108
109 @item Building natively using MSYS can be sped up by disabling implicit rules
110 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
111 speed up is close to non-existent for normal one-off builds and is only
112 noticeable when running make for a second time (for example in
113 @code{make install}).
114
115 @item In order to compile FFplay, you must have the MinGW development library
116 of @uref{http://www.libsdl.org/, SDL}.
117 Edit the @file{bin/sdl-config} script so that it points to the correct prefix
118 where SDL was installed. Verify that @file{sdl-config} can be launched from
119 the MSYS command line.
120
121 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
122 you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
123 libavformat) as DLLs.
124
125 @end itemize
126
127 @section Microsoft Visual C++ compatibility
128
129 As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
130 want to use the libav* libraries in your own applications, you can still
131 compile those applications using MSVC++. But the libav* libraries you link
132 to @emph{must} be built with MinGW. However, you will not be able to debug
133 inside the libav* libraries, since MSVC++ does not recognize the debug
134 symbols generated by GCC.
135 We strongly recommend you to move over from MSVC++ to MinGW tools.
136
137 This description of how to use the FFmpeg libraries with MSVC++ is based on
138 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
139 you might have to modify the procedures slightly.
140
141 @subsection Using static libraries
142
143 Assuming you have just built and installed FFmpeg in @file{/usr/local}.
144
145 @enumerate
146
147 @item Create a new console application ("File / New / Project") and then
148 select "Win32 Console Application". On the appropriate page of the
149 Application Wizard, uncheck the "Precompiled headers" option.
150
151 @item Write the source code for your application, or, for testing, just
152 copy the code from an existing sample application into the source file
153 that MSVC++ has already created for you. For example, you can copy
154 @file{libavformat/output-example.c} from the FFmpeg distribution.
155
156 @item Open the "Project / Properties" dialog box. In the "Configuration"
157 combo box, select "All Configurations" so that the changes you make will
158 affect both debug and release builds. In the tree view on the left hand
159 side, select "C/C++ / General", then edit the "Additional Include
160 Directories" setting to contain the path where the FFmpeg includes were
161 installed (i.e. @file{c:\msys\1.0\local\include}).
162 Do not add MinGW's include directory here, or the include files will
163 conflict with MSVC's.
164
165 @item Still in the "Project / Properties" dialog box, select
166 "Linker / General" from the tree view and edit the
167 "Additional Library Directories" setting to contain the @file{lib}
168 directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
169 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
170 and the directory where MinGW's GCC libs are installed
171 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
172 "Linker / Input" from the tree view, and add the files @file{libavformat.a},
173 @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
174 @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
175 to the end of "Additional Dependencies".
176
177 @item Now, select "C/C++ / Code Generation" from the tree view. Select
178 "Debug" in the "Configuration" combo box. Make sure that "Runtime
179 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
180 the "Configuration" combo box and make sure that "Runtime Library" is
181 set to "Multi-threaded DLL".
182
183 @item Click "OK" to close the "Project / Properties" dialog box.
184
185 @item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
186 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
187 and install it in MSVC++'s include directory
188 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
189
190 @item MSVC++ also does not understand the @code{inline} keyword used by
191 FFmpeg, so you must add this line before @code{#include}ing libav*:
192 @example
193 #define inline _inline
194 @end example
195
196 @item Build your application, everything should work.
197
198 @end enumerate
199
200 @subsection Using shared libraries
201
202 This is how to create DLL and LIB files that are compatible with MSVC++:
203
204 @enumerate
205
206 @item Add a call to @file{vcvars32.bat} (which sets up the environment
207 variables for the Visual C++ tools) as the first line of @file{msys.bat}.
208 The standard location for @file{vcvars32.bat} is
209 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
210 and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
211 If this corresponds to your setup, add the following line as the first line
212 of @file{msys.bat}:
213
214 @example
215 call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
216 @end example
217
218 Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
219 and run @file{c:\msys\1.0\msys.bat} from there.
220
221 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
222 from @file{Microsoft (R) Library Manager}, this means your environment
223 variables are set up correctly, the @file{Microsoft (R) Library Manager}
224 is on the path and will be used by FFmpeg to create
225 MSVC++-compatible import libraries.
226
227 @item Build FFmpeg with
228
229 @example
230 ./configure --enable-shared
231 make
232 make install
233 @end example
234
235 Your install path (@file{/usr/local/} by default) should now have the
236 necessary DLL and LIB files under the @file{bin} directory.
237
238 Alternatively, build the libraries with a cross compiler, according to
239 the instructions below in @ref{Cross compilation for Windows with Linux}.
240
241 To use those files with MSVC++, do the same as you would do with
242 the static libraries, as described above. But in Step 4,
243 you should only need to add the directory where the LIB files are installed
244 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
245 installed in the @file{bin} directory. And instead of adding the static
246 libraries (@file{libxxx.a} files) you should add the MSVC import libraries
247 (@file{avcodec.lib}, @file{avformat.lib}, and
248 @file{avutil.lib}). Note that you should not use the GCC import
249 libraries (@file{libxxx.dll.a} files), as these will give you undefined
250 reference errors. There should be no need for @file{libmingwex.a},
251 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
252 statically linked into the DLLs.
253
254 FFmpeg headers do not declare global data for Windows DLLs through the usual
255 dllexport/dllimport interface. Such data will be exported properly while
256 building, but to use them in your MSVC++ code you will have to edit the
257 appropriate headers and mark the data as dllimport. For example, in
258 libavutil/pixdesc.h you should have:
259 @example
260 extern __declspec(dllimport) const AVPixFmtDescriptor av_pix_fmt_descriptors[];
261 @end example
262
263 Note that using import libraries created by dlltool requires
264 the linker optimization option to be set to
265 "References: Keep Unreferenced Data (@code{/OPT:NOREF})", otherwise
266 the resulting binaries will fail during runtime. This isn't
267 required when using import libraries generated by lib.exe.
268 This issue is reported upstream at
269 @url{http://sourceware.org/bugzilla/show_bug.cgi?id=12633}.
270
271 To create import libraries that work with the @code{/OPT:REF} option
272 (which is enabled by default in Release mode), follow these steps:
273
274 @enumerate
275
276 @item Open @file{Visual Studio 2005 Command Prompt}.
277
278 Alternatively, in a normal command line prompt, call @file{vcvars32.bat}
279 which sets up the environment variables for the Visual C++ tools
280 (the standard location for this file is
281 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat}).
282
283 @item Enter the @file{bin} directory where the created LIB and DLL files
284 are stored.
285
286 @item Generate new import libraries with @file{lib.exe}:
287
288 @example
289 lib /machine:i386 /def:..\lib\avcodec-53.def  /out:avcodec.lib
290 lib /machine:i386 /def:..\lib\avdevice-53.def /out:avdevice.lib
291 lib /machine:i386 /def:..\lib\avfilter-2.def  /out:avfilter.lib
292 lib /machine:i386 /def:..\lib\avformat-53.def /out:avformat.lib
293 lib /machine:i386 /def:..\lib\avutil-51.def   /out:avutil.lib
294 lib /machine:i386 /def:..\lib\swscale-2.def   /out:swscale.lib
295 @end example
296
297 @end enumerate
298
299 @anchor{Cross compilation for Windows with Linux}
300 @section Cross compilation for Windows with Linux
301
302 You must use the MinGW cross compilation tools available at
303 @url{http://www.mingw.org/}.
304
305 Then configure FFmpeg with the following options:
306 @example
307 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
308 @end example
309 (you can change the cross-prefix according to the prefix chosen for the
310 MinGW tools).
311
312 Then you can easily test FFmpeg with @uref{http://www.winehq.com/, Wine}.
313
314 @section Compilation under Cygwin
315
316 Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
317 llrint() in its C library.
318
319 Install your Cygwin with all the "Base" packages, plus the
320 following "Devel" ones:
321 @example
322 binutils, gcc4-core, make, git, mingw-runtime, texi2html
323 @end example
324
325 And the following "Utils" one:
326 @example
327 diffutils
328 @end example
329
330 Then run
331
332 @example
333 ./configure
334 @end example
335
336 to make a static build.
337
338 The current @code{gcc4-core} package is buggy and needs this flag to build
339 shared libraries:
340
341 @example
342 ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
343 @end example
344
345 If you want to build FFmpeg with additional libraries, download Cygwin
346 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
347 @example
348 libogg-devel, libvorbis-devel
349 @end example
350
351 These library packages are only available from
352 @uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
353
354 @example
355 yasm, libSDL-devel, libdirac-devel, libfaac-devel, libaacplus-devel, libgsm-devel,
356 libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
357 libxvidcore-devel
358 @end example
359
360 The recommendation for libnut and x264 is to build them from source by
361 yourself, as they evolve too quickly for Cygwin Ports to be up to date.
362
363 Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
364 of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.
365
366 @section Crosscompilation for Windows under Cygwin
367
368 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
369
370 Just install your Cygwin as explained before, plus these additional
371 "Devel" packages:
372 @example
373 gcc-mingw-core, mingw-runtime, mingw-zlib
374 @end example
375
376 and add some special flags to your configure invocation.
377
378 For a static build run
379 @example
380 ./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
381 @end example
382
383 and for a build with shared libraries
384 @example
385 ./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
386 @end example
387
388 @bye