Google Git
Sign in
aomedia / avm / 769e6567e9c4467709af0b536d6da2e7f67b76a0 / . / README
blob: 584a34437bf33007ca62b305d123ba19c7398678 [file] [log] [blame]
James Zern4bbca2e2014-05-30 16:37:39 -0700[diff] [blame]1README - 30 May 2014
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]2
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]3Welcome to the WebM VP8/VP9 Codec SDK!
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]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
John Koleszar94c52e42010-06-18 12:39:21 -0400[diff] [blame]11
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]12 * All x86 targets require the Yasm[1] assembler be installed.
13 * All Windows builds require that Cygwin[2] be installed.
James Zernf8630c72014-05-10 11:15:11 -0700[diff] [blame]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.
John Koleszar00748632012-06-20 14:45:22 -0700[diff] [blame]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
James Zernf8630c72014-05-10 11:15:11 -0700[diff] [blame]20 source[5]. These requirements are optional if not running the unit
John Koleszar00748632012-06-20 14:45:22 -0700[diff] [blame]21 tests.
John Koleszar94c52e42010-06-18 12:39:21 -0400[diff] [blame]22
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]23 [1]: http://www.tortall.net/projects/yasm
24 [2]: http://www.cygwin.com
James Zernf8630c72014-05-10 11:15:11 -0700[diff] [blame]25 [3]: http://www.doxygen.org
26 [4]: http://curl.haxx.se
27 [5]: http://www.microbrew.org/tools/md5sha1sum/
John Koleszar94c52e42010-06-18 12:39:21 -0400[diff] [blame]28
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]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
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]50 armv6-darwin-gcc
51 armv6-linux-rvct
52 armv6-linux-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]53 armv6-none-rvct
Tom Finegane87d6812014-06-25 18:32:16 -0700[diff] [blame]54 arm64-darwin-gcc
Fritz Koenigd8305732012-01-06 11:50:05 -0800[diff] [blame]55 armv7-android-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]56 armv7-darwin-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]57 armv7-linux-rvct
58 armv7-linux-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]59 armv7-none-rvct
60 armv7-win32-vs11
Yaowu Xua638bdf2013-11-13 11:36:32 -0800[diff] [blame]61 armv7-win32-vs12
Tom Finegancd2088b2014-06-10 18:52:58 -0700[diff] [blame]62 armv7s-darwin-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]63 mips32-linux-gcc
Gordana Cmiljanovic1c31e3e2014-08-07 19:09:47 +0200[diff] [blame]64 mips64-linux-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]65 ppc32-darwin8-gcc
66 ppc32-darwin9-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]67 ppc32-linux-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]68 ppc64-darwin8-gcc
69 ppc64-darwin9-gcc
70 ppc64-linux-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]71 sparc-solaris-gcc
72 x86-android-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]73 x86-darwin8-gcc
74 x86-darwin8-icc
75 x86-darwin9-gcc
76 x86-darwin9-icc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]77 x86-darwin10-gcc
78 x86-darwin11-gcc
79 x86-darwin12-gcc
80 x86-darwin13-gcc
Tom Finegancd2088b2014-06-10 18:52:58 -0700[diff] [blame]81 x86-iphonesimulator-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]82 x86-linux-gcc
83 x86-linux-icc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]84 x86-os2-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]85 x86-solaris-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]86 x86-win32-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]87 x86-win32-vs7
88 x86-win32-vs8
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]89 x86-win32-vs9
90 x86-win32-vs10
91 x86-win32-vs11
Yaowu Xua638bdf2013-11-13 11:36:32 -0800[diff] [blame]92 x86-win32-vs12
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]93 x86_64-darwin9-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]94 x86_64-darwin10-gcc
95 x86_64-darwin11-gcc
96 x86_64-darwin12-gcc
97 x86_64-darwin13-gcc
Tom Finegancd2088b2014-06-10 18:52:58 -0700[diff] [blame]98 x86_64-iphonesimulator-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]99 x86_64-linux-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]100 x86_64-linux-icc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]101 x86_64-solaris-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]102 x86_64-win64-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]103 x86_64-win64-vs8
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]104 x86_64-win64-vs9
105 x86_64-win64-vs10
106 x86_64-win64-vs11
Yaowu Xua638bdf2013-11-13 11:36:32 -0800[diff] [blame]107 x86_64-win64-vs12
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]108 universal-darwin8-gcc
109 universal-darwin9-gcc
Paweł Hajdan9ab47772013-08-01 20:08:42 -0700[diff] [blame]110 universal-darwin10-gcc
111 universal-darwin11-gcc
112 universal-darwin12-gcc
113 universal-darwin13-gcc
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]114 generic-gnu
115
116 The generic-gnu target, in conjunction with the CROSS environment variable,
117 can be used to cross compile architectures that aren't explicitly listed, if
118 the toolchain is a cross GNU (gcc/binutils) toolchain. Other POSIX toolchains
119 will likely work as well. For instance, to build using the mipsel-linux-uclibc
120 toolchain, the following command could be used (note, POSIX SH syntax, adapt
121 to your shell as necessary):
122
Johanna31a58d2010-10-07 14:13:36 -0400[diff] [blame]123 $ CROSS=mipsel-linux-uclibc- ../libvpx/configure
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]124
125 In addition, the executables to be invoked can be overridden by specifying the
126 environment variables: CC, AR, LD, AS, STRIP, NM. Additional flags can be
127 passed to these executables with CFLAGS, LDFLAGS, and ASFLAGS.
128
129 5. Configuration errors
130 If the configuration step fails, the first step is to look in the error log.
James Zerne636af12013-07-18 14:17:00 -0700[diff] [blame]131 This defaults to config.log. This should give a good indication of what went
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]132 wrong. If not, contact us for support.
133
James Zern4bbca2e2014-05-30 16:37:39 -0700[diff] [blame]134VP8/VP9 TEST VECTORS:
135 The test vectors can be downloaded and verified using the build system after
136 running configure. To specify an alternate directory the
137 LIBVPX_TEST_DATA_PATH environment variable can be used.
138
139 $ ./configure --enable-unit-tests
140 $ LIBVPX_TEST_DATA_PATH=../libvpx-test-data make testdata
141
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]142SUPPORT
143 This library is an open source project supported by its community. Please
John Koleszar00748632012-06-20 14:45:22 -0700[diff] [blame]144 please email webm-discuss@webmproject.org for help.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400[diff] [blame]145