michael@0: vpx Multi-Format Codec SDK michael@0: README - 1 August 2013 michael@0: michael@0: Welcome to the WebM VP8/VP9 Codec SDK! michael@0: michael@0: COMPILING THE APPLICATIONS/LIBRARIES: michael@0: The build system used is similar to autotools. Building generally consists of michael@0: "configuring" with your desired build options, then using GNU make to build michael@0: the application. michael@0: michael@0: 1. Prerequisites michael@0: michael@0: * All x86 targets require the Yasm[1] assembler be installed. michael@0: * All Windows builds require that Cygwin[2] be installed. michael@0: * Building the documentation requires PHP[3] and Doxygen[4]. If you do not michael@0: have these packages, you must pass --disable-install-docs to the michael@0: configure script. michael@0: * Downloading the data for the unit tests requires curl[5] and sha1sum. michael@0: sha1sum is provided via the GNU coreutils, installed by default on michael@0: many *nix platforms, as well as MinGW and Cygwin. If coreutils is not michael@0: available, a compatible version of sha1sum can be built from michael@0: source[6]. These requirements are optional if not running the unit michael@0: tests. michael@0: michael@0: [1]: http://www.tortall.net/projects/yasm michael@0: [2]: http://www.cygwin.com michael@0: [3]: http://php.net michael@0: [4]: http://www.doxygen.org michael@0: [5]: http://curl.haxx.se michael@0: [6]: http://www.microbrew.org/tools/md5sha1sum/ michael@0: michael@0: 2. Out-of-tree builds michael@0: Out of tree builds are a supported method of building the application. For michael@0: an out of tree build, the source tree is kept separate from the object michael@0: files produced during compilation. For instance: michael@0: michael@0: $ mkdir build michael@0: $ cd build michael@0: $ ../libvpx/configure michael@0: $ make michael@0: michael@0: 3. Configuration options michael@0: The 'configure' script supports a number of options. The --help option can be michael@0: used to get a list of supported options: michael@0: $ ../libvpx/configure --help michael@0: michael@0: 4. Cross development michael@0: For cross development, the most notable option is the --target option. The michael@0: most up-to-date list of supported targets can be found at the bottom of the michael@0: --help output of the configure script. As of this writing, the list of michael@0: available targets is: michael@0: michael@0: armv5te-android-gcc michael@0: armv5te-linux-rvct michael@0: armv5te-linux-gcc michael@0: armv5te-none-rvct michael@0: armv6-darwin-gcc michael@0: armv6-linux-rvct michael@0: armv6-linux-gcc michael@0: armv6-none-rvct michael@0: armv7-android-gcc michael@0: armv7-darwin-gcc michael@0: armv7-linux-rvct michael@0: armv7-linux-gcc michael@0: armv7-none-rvct michael@0: armv7-win32-vs11 michael@0: armv7-win32-vs12 michael@0: mips32-linux-gcc michael@0: ppc32-darwin8-gcc michael@0: ppc32-darwin9-gcc michael@0: ppc32-linux-gcc michael@0: ppc64-darwin8-gcc michael@0: ppc64-darwin9-gcc michael@0: ppc64-linux-gcc michael@0: sparc-solaris-gcc michael@0: x86-android-gcc michael@0: x86-darwin8-gcc michael@0: x86-darwin8-icc michael@0: x86-darwin9-gcc michael@0: x86-darwin9-icc michael@0: x86-darwin10-gcc michael@0: x86-darwin11-gcc michael@0: x86-darwin12-gcc michael@0: x86-darwin13-gcc michael@0: x86-linux-gcc michael@0: x86-linux-icc michael@0: x86-os2-gcc michael@0: x86-solaris-gcc michael@0: x86-win32-gcc michael@0: x86-win32-vs7 michael@0: x86-win32-vs8 michael@0: x86-win32-vs9 michael@0: x86-win32-vs10 michael@0: x86-win32-vs11 michael@0: x86-win32-vs12 michael@0: x86_64-darwin9-gcc michael@0: x86_64-darwin10-gcc michael@0: x86_64-darwin11-gcc michael@0: x86_64-darwin12-gcc michael@0: x86_64-darwin13-gcc michael@0: x86_64-linux-gcc michael@0: x86_64-linux-icc michael@0: x86_64-solaris-gcc michael@0: x86_64-win64-gcc michael@0: x86_64-win64-vs8 michael@0: x86_64-win64-vs9 michael@0: x86_64-win64-vs10 michael@0: x86_64-win64-vs11 michael@0: x86_64-win64-vs12 michael@0: universal-darwin8-gcc michael@0: universal-darwin9-gcc michael@0: universal-darwin10-gcc michael@0: universal-darwin11-gcc michael@0: universal-darwin12-gcc michael@0: universal-darwin13-gcc michael@0: generic-gnu michael@0: michael@0: The generic-gnu target, in conjunction with the CROSS environment variable, michael@0: can be used to cross compile architectures that aren't explicitly listed, if michael@0: the toolchain is a cross GNU (gcc/binutils) toolchain. Other POSIX toolchains michael@0: will likely work as well. For instance, to build using the mipsel-linux-uclibc michael@0: toolchain, the following command could be used (note, POSIX SH syntax, adapt michael@0: to your shell as necessary): michael@0: michael@0: $ CROSS=mipsel-linux-uclibc- ../libvpx/configure michael@0: michael@0: In addition, the executables to be invoked can be overridden by specifying the michael@0: environment variables: CC, AR, LD, AS, STRIP, NM. Additional flags can be michael@0: passed to these executables with CFLAGS, LDFLAGS, and ASFLAGS. michael@0: michael@0: 5. Configuration errors michael@0: If the configuration step fails, the first step is to look in the error log. michael@0: This defaults to config.log. This should give a good indication of what went michael@0: wrong. If not, contact us for support. michael@0: michael@0: SUPPORT michael@0: This library is an open source project supported by its community. Please michael@0: please email webm-discuss@webmproject.org for help. michael@0: