README

   1 vpx Multi-Format Codec SDK
   2 README - 19 May 2010
   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
  19     [1]: http://www.tortall.net/projects/yasm
  20     [2]: http://www.cygwin.com
  21     [3]: http://php.net
  22     [4]: http://www.doxygen.org
  23
  24   2. Out-of-tree builds
  25   Out of tree builds are a supported method of building the application. For
  26   an out of tree build, the source tree is kept separate from the object
  27   files produced during compilation. For instance:
  28
  29     $ mkdir build
  30     $ cd build
  31     $ ../libvpx/configure <options>
  32     $ make
  33
  34   3. Configuration options
  35   The 'configure' script supports a number of options. The --help option can be
  36   used to get a list of supported options:
  37     $ ../libvpx/configure --help
  38
  39   4. Cross development
  40   For cross development, the most notable option is the --target option. The
  41   most up-to-date list of supported targets can be found at the bottom of the
  42   --help output of the configure script. As of this writing, the list of
  43   available targets is:
  44
  45     armv5te-linux-rvct
  46     armv5te-linux-gcc
  47     armv6-darwin-gcc
  48     armv6-linux-rvct
  49     armv6-linux-gcc
  50     armv7-linux-rvct
  51     armv7-linux-gcc
  52     mips32-linux-gcc
  53     ppc32-darwin8-gcc
  54     ppc32-darwin9-gcc
  55     ppc64-darwin8-gcc
  56     ppc64-darwin9-gcc
  57     ppc64-linux-gcc
  58     x86-darwin8-gcc
  59     x86-darwin8-icc
  60     x86-darwin9-gcc
  61     x86-darwin9-icc
  62     x86-linux-gcc
  63     x86-linux-icc
  64     x86-solaris-gcc
  65     x86-win32-vs7
  66     x86-win32-vs8
  67     x86_64-darwin9-gcc
  68     x86_64-linux-gcc
  69     x86_64-solaris-gcc
  70     x86_64-win64-vs8
  71     universal-darwin8-gcc
  72     universal-darwin9-gcc
  73     generic-gnu
  74
  75   The generic-gnu target, in conjunction with the CROSS environment variable,
  76   can be used to cross compile architectures that aren't explicitly listed, if
  77   the toolchain is a cross GNU (gcc/binutils) toolchain. Other POSIX toolchains
  78   will likely work as well. For instance, to build using the mipsel-linux-uclibc
  79   toolchain, the following command could be used (note, POSIX SH syntax, adapt
  80   to your shell as necessary):
  81
  82     $ CROSS=mipsel-linux-uclibc- ../libvpx/configure
  83
  84   In addition, the executables to be invoked can be overridden by specifying the
  85   environment variables: CC, AR, LD, AS, STRIP, NM. Additional flags can be
  86   passed to these executables with CFLAGS, LDFLAGS, and ASFLAGS.
  87
  88   5. Configuration errors
  89   If the configuration step fails, the first step is to look in the error log.
  90   This defaults to config.err. This should give a good indication of what went
  91   wrong. If not, contact us for support.
  92
  93 SUPPORT
  94   This library is an open source project supported by its community. Please
  95   please email webm-users@webmproject.org for help.
  96