README

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