Google Git
Sign in
chromium / webm / libvpx / 6d38ad414623d49ff542230a09c243e4f2e4cf5a / . / README
blob: 63f9eeade22d6d664914fc72f9b741c8b531f5b7 [file] [log] [blame]
Jerome Jiang6d38ad42017-01-27 01:53:00[diff] [blame^]1README - 26 January 2017
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]2
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]3Welcome to the WebM VP8/VP9 Codec SDK!
John Koleszar0ea50ce2010-05-18 15:58:33[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 16:39:21[diff] [blame]11
John Koleszar0ea50ce2010-05-18 15:58:33[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 18:15:11[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 21:45:22[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 18:15:11[diff] [blame]20 source[5]. These requirements are optional if not running the unit
John Koleszar00748632012-06-20 21:45:22[diff] [blame]21 tests.
John Koleszar94c52e42010-06-18 16:39:21[diff] [blame]22
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]23 [1]: http://www.tortall.net/projects/yasm
24 [2]: http://www.cygwin.com
James Zernf8630c72014-05-10 18:15:11[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 16:39:21[diff] [blame]28
John Koleszar0ea50ce2010-05-18 15:58:33[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
Johann0c0a0502016-12-30 00:31:22[diff] [blame]50 arm64-android-gcc
James Zern77f5c3d2016-07-28 05:10:09[diff] [blame]51 arm64-darwin-gcc
52 arm64-linux-gcc
Fritz Koenigd8305732012-01-06 19:50:05[diff] [blame]53 armv7-android-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]54 armv7-darwin-gcc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]55 armv7-linux-rvct
56 armv7-linux-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]57 armv7-none-rvct
58 armv7-win32-vs11
Yaowu Xua638bdf2013-11-13 19:36:32[diff] [blame]59 armv7-win32-vs12
Ghislain MARY3067c342015-07-28 14:37:09[diff] [blame]60 armv7-win32-vs14
Tom Finegancd2088b2014-06-11 01:52:58[diff] [blame]61 armv7s-darwin-gcc
James Zern77f5c3d2016-07-28 05:10:09[diff] [blame]62 armv8-linux-gcc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]63 mips32-linux-gcc
Gordana Cmiljanovic1c31e3e2014-08-07 17:09:47[diff] [blame]64 mips64-linux-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]65 sparc-solaris-gcc
66 x86-android-gcc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]67 x86-darwin8-gcc
68 x86-darwin8-icc
69 x86-darwin9-gcc
70 x86-darwin9-icc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]71 x86-darwin10-gcc
72 x86-darwin11-gcc
73 x86-darwin12-gcc
74 x86-darwin13-gcc
Johannbb5a39c2015-03-23 22:33:17[diff] [blame]75 x86-darwin14-gcc
James Zern77f5c3d2016-07-28 05:10:09[diff] [blame]76 x86-darwin15-gcc
Jerome Jiang6d38ad42017-01-27 01:53:00[diff] [blame^]77 x86-darwin16-gcc
Tom Finegancd2088b2014-06-11 01:52:58[diff] [blame]78 x86-iphonesimulator-gcc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]79 x86-linux-gcc
80 x86-linux-icc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]81 x86-os2-gcc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]82 x86-solaris-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]83 x86-win32-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]84 x86-win32-vs10
85 x86-win32-vs11
Yaowu Xua638bdf2013-11-13 19:36:32[diff] [blame]86 x86-win32-vs12
Ghislain MARY3067c342015-07-28 14:37:09[diff] [blame]87 x86-win32-vs14
James Zern5da87e82015-07-24 21:24:20[diff] [blame]88 x86_64-android-gcc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]89 x86_64-darwin9-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]90 x86_64-darwin10-gcc
91 x86_64-darwin11-gcc
92 x86_64-darwin12-gcc
93 x86_64-darwin13-gcc
Johannbb5a39c2015-03-23 22:33:17[diff] [blame]94 x86_64-darwin14-gcc
James Zern77f5c3d2016-07-28 05:10:09[diff] [blame]95 x86_64-darwin15-gcc
Jerome Jiang6d38ad42017-01-27 01:53:00[diff] [blame^]96 x86_64-darwin16-gcc
Tom Finegancd2088b2014-06-11 01:52:58[diff] [blame]97 x86_64-iphonesimulator-gcc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]98 x86_64-linux-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]99 x86_64-linux-icc
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]100 x86_64-solaris-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]101 x86_64-win64-gcc
Paweł Hajdan9ab47772013-08-02 03:08:42[diff] [blame]102 x86_64-win64-vs10
103 x86_64-win64-vs11
Yaowu Xua638bdf2013-11-13 19:36:32[diff] [blame]104 x86_64-win64-vs12
Ghislain MARY3067c342015-07-28 14:37:09[diff] [blame]105 x86_64-win64-vs14
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]106 generic-gnu
107
108 The generic-gnu target, in conjunction with the CROSS environment variable,
109 can be used to cross compile architectures that aren't explicitly listed, if
110 the toolchain is a cross GNU (gcc/binutils) toolchain. Other POSIX toolchains
111 will likely work as well. For instance, to build using the mipsel-linux-uclibc
112 toolchain, the following command could be used (note, POSIX SH syntax, adapt
113 to your shell as necessary):
114
Johanna31a58d2010-10-07 18:13:36[diff] [blame]115 $ CROSS=mipsel-linux-uclibc- ../libvpx/configure
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]116
117 In addition, the executables to be invoked can be overridden by specifying the
118 environment variables: CC, AR, LD, AS, STRIP, NM. Additional flags can be
119 passed to these executables with CFLAGS, LDFLAGS, and ASFLAGS.
120
121 5. Configuration errors
122 If the configuration step fails, the first step is to look in the error log.
James Zerne636af12013-07-18 21:17:00[diff] [blame]123 This defaults to config.log. This should give a good indication of what went
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]124 wrong. If not, contact us for support.
125
James Zern4bbca2e2014-05-30 23:37:39[diff] [blame]126VP8/VP9 TEST VECTORS:
127 The test vectors can be downloaded and verified using the build system after
128 running configure. To specify an alternate directory the
129 LIBVPX_TEST_DATA_PATH environment variable can be used.
130
131 $ ./configure --enable-unit-tests
132 $ LIBVPX_TEST_DATA_PATH=../libvpx-test-data make testdata
133
James Zern15f29ef2016-07-28 05:16:51[diff] [blame]134CODE STYLE:
135 The coding style used by this project is enforced with clang-format using the
136 configuration contained in the .clang-format file in the root of the
137 repository.
138
139 Before pushing changes for review you can format your code with:
140 # Apply clang-format to modified .c, .h and .cc files
141 $ clang-format -i --style=file \
142 $(git diff --name-only --diff-filter=ACMR '*.[hc]' '*.cc')
143
144 Check the .clang-format file for the version used to generate it if there is
145 any difference between your local formatting and the review system.
146
147 See also: http://clang.llvm.org/docs/ClangFormat.html
148
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]149SUPPORT
150 This library is an open source project supported by its community. Please
James Zern5ea87122016-07-28 05:10:02[diff] [blame]151 email [email protected] for help.
John Koleszar0ea50ce2010-05-18 15:58:33[diff] [blame]152