README 4.26 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
vpx Multi-Format Codec SDK
Paweł Hajdan's avatar
Paweł Hajdan committed
2
README - 1 August 2013
John Koleszar's avatar
John Koleszar committed
3

Paweł Hajdan's avatar
Paweł Hajdan committed
4
Welcome to the WebM VP8/VP9 Codec SDK!
John Koleszar's avatar
John Koleszar committed
5 6 7 8 9 10 11

COMPILING THE APPLICATIONS/LIBRARIES:
  The build system used is similar to autotools. Building generally consists of
  "configuring" with your desired build options, then using GNU make to build
  the application.

  1. Prerequisites
12

John Koleszar's avatar
John Koleszar committed
13 14 15 16 17
    * All x86 targets require the Yasm[1] assembler be installed.
    * All Windows builds require that Cygwin[2] be installed.
    * Building the documentation requires PHP[3] and Doxygen[4]. If you do not
      have these packages, you must pass --disable-install-docs to the
      configure script.
18 19 20 21 22 23
    * Downloading the data for the unit tests requires curl[5] and sha1sum.
      sha1sum is provided via the GNU coreutils, installed by default on
      many *nix platforms, as well as MinGW and Cygwin. If coreutils is not
      available, a compatible version of sha1sum can be built from
      source[6]. These requirements are optional if not running the unit
      tests.
24

John Koleszar's avatar
John Koleszar committed
25 26 27 28
    [1]: http://www.tortall.net/projects/yasm
    [2]: http://www.cygwin.com
    [3]: http://php.net
    [4]: http://www.doxygen.org
29 30
    [5]: http://curl.haxx.se
    [6]: http://www.microbrew.org/tools/md5sha1sum/
31

John Koleszar's avatar
John Koleszar committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
  2. Out-of-tree builds
  Out of tree builds are a supported method of building the application. For
  an out of tree build, the source tree is kept separate from the object
  files produced during compilation. For instance:

    $ mkdir build
    $ cd build
    $ ../libvpx/configure <options>
    $ make

  3. Configuration options
  The 'configure' script supports a number of options. The --help option can be
  used to get a list of supported options:
    $ ../libvpx/configure --help

  4. Cross development
  For cross development, the most notable option is the --target option. The
  most up-to-date list of supported targets can be found at the bottom of the
  --help output of the configure script. As of this writing, the list of
  available targets is:

53
    armv5te-android-gcc
John Koleszar's avatar
John Koleszar committed
54 55
    armv5te-linux-rvct
    armv5te-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
56
    armv5te-none-rvct
John Koleszar's avatar
John Koleszar committed
57 58 59
    armv6-darwin-gcc
    armv6-linux-rvct
    armv6-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
60
    armv6-none-rvct
61
    armv7-android-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
62
    armv7-darwin-gcc
John Koleszar's avatar
John Koleszar committed
63 64
    armv7-linux-rvct
    armv7-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
65 66
    armv7-none-rvct
    armv7-win32-vs11
John Koleszar's avatar
John Koleszar committed
67 68 69
    mips32-linux-gcc
    ppc32-darwin8-gcc
    ppc32-darwin9-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
70
    ppc32-linux-gcc
John Koleszar's avatar
John Koleszar committed
71 72 73
    ppc64-darwin8-gcc
    ppc64-darwin9-gcc
    ppc64-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
74 75
    sparc-solaris-gcc
    x86-android-gcc
John Koleszar's avatar
John Koleszar committed
76 77 78 79
    x86-darwin8-gcc
    x86-darwin8-icc
    x86-darwin9-gcc
    x86-darwin9-icc
Paweł Hajdan's avatar
Paweł Hajdan committed
80 81 82 83
    x86-darwin10-gcc
    x86-darwin11-gcc
    x86-darwin12-gcc
    x86-darwin13-gcc
John Koleszar's avatar
John Koleszar committed
84 85
    x86-linux-gcc
    x86-linux-icc
Paweł Hajdan's avatar
Paweł Hajdan committed
86
    x86-os2-gcc
John Koleszar's avatar
John Koleszar committed
87
    x86-solaris-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
88
    x86-win32-gcc
John Koleszar's avatar
John Koleszar committed
89 90
    x86-win32-vs7
    x86-win32-vs8
Paweł Hajdan's avatar
Paweł Hajdan committed
91 92 93
    x86-win32-vs9
    x86-win32-vs10
    x86-win32-vs11
John Koleszar's avatar
John Koleszar committed
94
    x86_64-darwin9-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
95 96 97 98
    x86_64-darwin10-gcc
    x86_64-darwin11-gcc
    x86_64-darwin12-gcc
    x86_64-darwin13-gcc
John Koleszar's avatar
John Koleszar committed
99
    x86_64-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
100
    x86_64-linux-icc
John Koleszar's avatar
John Koleszar committed
101
    x86_64-solaris-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
102
    x86_64-win64-gcc
John Koleszar's avatar
John Koleszar committed
103
    x86_64-win64-vs8
Paweł Hajdan's avatar
Paweł Hajdan committed
104 105 106
    x86_64-win64-vs9
    x86_64-win64-vs10
    x86_64-win64-vs11
John Koleszar's avatar
John Koleszar committed
107 108
    universal-darwin8-gcc
    universal-darwin9-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
109 110 111 112
    universal-darwin10-gcc
    universal-darwin11-gcc
    universal-darwin12-gcc
    universal-darwin13-gcc
John Koleszar's avatar
John Koleszar committed
113 114 115 116 117 118 119 120 121
    generic-gnu

  The generic-gnu target, in conjunction with the CROSS environment variable,
  can be used to cross compile architectures that aren't explicitly listed, if
  the toolchain is a cross GNU (gcc/binutils) toolchain. Other POSIX toolchains
  will likely work as well. For instance, to build using the mipsel-linux-uclibc
  toolchain, the following command could be used (note, POSIX SH syntax, adapt
  to your shell as necessary):

Johann's avatar
Johann committed
122
    $ CROSS=mipsel-linux-uclibc- ../libvpx/configure
John Koleszar's avatar
John Koleszar committed
123 124 125 126 127 128 129

  In addition, the executables to be invoked can be overridden by specifying the
  environment variables: CC, AR, LD, AS, STRIP, NM. Additional flags can be
  passed to these executables with CFLAGS, LDFLAGS, and ASFLAGS.

  5. Configuration errors
  If the configuration step fails, the first step is to look in the error log.
130
  This defaults to config.log. This should give a good indication of what went
John Koleszar's avatar
John Koleszar committed
131 132 133 134
  wrong. If not, contact us for support.

SUPPORT
  This library is an open source project supported by its community. Please
135
  please email webm-discuss@webmproject.org for help.
John Koleszar's avatar
John Koleszar committed
136