README
1README - 30 May 2014
2
3Welcome to the WebM VP8/VP9 Codec SDK!
4
5COMPILING THE APPLICATIONS/LIBRARIES:
6 The build system used is similar to autotools. Building generally consists of
7 "configuring" with your desired build options, then using GNU make to build
8 the application.
9
10 1. Prerequisites
11
12 * All x86 targets require the Yasm[1] assembler be installed.
13 * All Windows builds require that Cygwin[2] be installed.
14 * Building the documentation requires Doxygen[3]. If you do not
15 have this package, the install-docs option will be disabled.
16 * Downloading the data for the unit tests requires curl[4] and sha1sum.
17 sha1sum is provided via the GNU coreutils, installed by default on
18 many *nix platforms, as well as MinGW and Cygwin. If coreutils is not
19 available, a compatible version of sha1sum can be built from
20 source[5]. These requirements are optional if not running the unit
21 tests.
22
23 [1]: http://www.tortall.net/projects/yasm
24 [2]: http://www.cygwin.com
25 [3]: http://www.doxygen.org
26 [4]: http://curl.haxx.se
27 [5]: http://www.microbrew.org/tools/md5sha1sum/
28
29 2. Out-of-tree builds
30 Out of tree builds are a supported method of building the application. For
31 an out of tree build, the source tree is kept separate from the object
32 files produced during compilation. For instance:
33
34 $ mkdir build
35 $ cd build
36 $ ../libvpx/configure <options>
37 $ make
38
39 3. Configuration options
40 The 'configure' script supports a number of options. The --help option can be
41 used to get a list of supported options:
42 $ ../libvpx/configure --help
43
44 4. Cross development
45 For cross development, the most notable option is the --target option. The
46 most up-to-date list of supported targets can be found at the bottom of the
47 --help output of the configure script. As of this writing, the list of
48 available targets is:
49
50 armv5te-android-gcc
51 armv5te-linux-rvct
52 armv5te-linux-gcc
53 armv5te-none-rvct
54 armv6-darwin-gcc
55 armv6-linux-rvct
56 armv6-linux-gcc
57 armv6-none-rvct
58 arm64-darwin-gcc
59 armv7-android-gcc
60 armv7-darwin-gcc
61 armv7-linux-rvct
62 armv7-linux-gcc
63 armv7-none-rvct
64 armv7-win32-vs11
65 armv7-win32-vs12
66 armv7s-darwin-gcc
67 mips32-linux-gcc
68 ppc32-darwin8-gcc
69 ppc32-darwin9-gcc
70 ppc32-linux-gcc
71 ppc64-darwin8-gcc
72 ppc64-darwin9-gcc
73 ppc64-linux-gcc
74 sparc-solaris-gcc
75 x86-android-gcc
76 x86-darwin8-gcc
77 x86-darwin8-icc
78 x86-darwin9-gcc
79 x86-darwin9-icc
80 x86-darwin10-gcc
81 x86-darwin11-gcc
82 x86-darwin12-gcc
83 x86-darwin13-gcc
84 x86-iphonesimulator-gcc
85 x86-linux-gcc
86 x86-linux-icc
87 x86-os2-gcc
88 x86-solaris-gcc
89 x86-win32-gcc
90 x86-win32-vs7
91 x86-win32-vs8
92 x86-win32-vs9
93 x86-win32-vs10
94 x86-win32-vs11
95 x86-win32-vs12
96 x86_64-darwin9-gcc
97 x86_64-darwin10-gcc
98 x86_64-darwin11-gcc
99 x86_64-darwin12-gcc
100 x86_64-darwin13-gcc
101 x86_64-iphonesimulator-gcc
102 x86_64-linux-gcc
103 x86_64-linux-icc
104 x86_64-solaris-gcc
105 x86_64-win64-gcc
106 x86_64-win64-vs8
107 x86_64-win64-vs9
108 x86_64-win64-vs10
109 x86_64-win64-vs11
110 x86_64-win64-vs12
111 universal-darwin8-gcc
112 universal-darwin9-gcc
113 universal-darwin10-gcc
114 universal-darwin11-gcc
115 universal-darwin12-gcc
116 universal-darwin13-gcc
117 generic-gnu
118
119 The generic-gnu target, in conjunction with the CROSS environment variable,
120 can be used to cross compile architectures that aren't explicitly listed, if
121 the toolchain is a cross GNU (gcc/binutils) toolchain. Other POSIX toolchains
122 will likely work as well. For instance, to build using the mipsel-linux-uclibc
123 toolchain, the following command could be used (note, POSIX SH syntax, adapt
124 to your shell as necessary):
125
126 $ CROSS=mipsel-linux-uclibc- ../libvpx/configure
127
128 In addition, the executables to be invoked can be overridden by specifying the
129 environment variables: CC, AR, LD, AS, STRIP, NM. Additional flags can be
130 passed to these executables with CFLAGS, LDFLAGS, and ASFLAGS.
131
132 5. Configuration errors
133 If the configuration step fails, the first step is to look in the error log.
134 This defaults to config.log. This should give a good indication of what went
135 wrong. If not, contact us for support.
136
137VP8/VP9 TEST VECTORS:
138 The test vectors can be downloaded and verified using the build system after
139 running configure. To specify an alternate directory the
140 LIBVPX_TEST_DATA_PATH environment variable can be used.
141
142 $ ./configure --enable-unit-tests
143 $ LIBVPX_TEST_DATA_PATH=../libvpx-test-data make testdata
144
145SUPPORT
146 This library is an open source project supported by its community. Please
147 please email webm-discuss@webmproject.org for help.
148
149