~ubuntu-branches/debian/experimental/libav/experimental

« back to all changes in this revision

Viewing changes to .pc/makeinfo.patch/doc/platform.texi

  • Committer: Package Import Robot
  • Author(s): Reinhard Tartler
  • Date: 2014-02-17 22:07:03 UTC
  • mfrom: (1.1.25)
  • Revision ID: package-import@ubuntu.com-20140217220703-51bpzx0ln1d961vs
Tags: 6:10~beta1-2
* New Upstream release 10_beta1. This upstream git snapshot has too many
  changes to list here, cf. to the upstream Changelog:
  http://git.libav.org/?p=libav.git;a=blob;f=Changelog;hb=refs/tags/v10_beta1
  - works with H.264 that has different bit depth between chroma and luma,
    Closes: #738599
* Bump shlibs

Show diffs side-by-side

added added

removed removed

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