README 4.42 KB
Newer Older
Adrian Grange's avatar
Adrian Grange committed
1
README - 22 March 2016
John Koleszar's avatar
John Koleszar committed
2

Adrian Grange's avatar
Adrian Grange committed
3
Welcome to the AOM Codec SDK!
John Koleszar's avatar
John Koleszar committed
4 5 6 7 8 9 10

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
11

John Koleszar's avatar
John Koleszar committed
12 13
    * All x86 targets require the Yasm[1] assembler be installed.
    * All Windows builds require that Cygwin[2] be installed.
James Zern's avatar
James Zern committed
14 15 16
    * Building the documentation requires Doxygen[3]. If you do not
      have this package, the install-docs option will be disabled.
    * Downloading the data for the unit tests requires curl[4] and sha1sum.
17 18 19
      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
James Zern's avatar
James Zern committed
20
      source[5]. These requirements are optional if not running the unit
21
      tests.
22

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

John Koleszar's avatar
John Koleszar committed
29 30 31 32 33 34 35
  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
Adrian Grange's avatar
Adrian Grange committed
36
    $ ../libaom/configure <options>
John Koleszar's avatar
John Koleszar committed
37 38 39 40 41
    $ 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:
Adrian Grange's avatar
Adrian Grange committed
42
    $ ../libaom/configure --help
John Koleszar's avatar
John Koleszar committed
43 44 45 46 47 48 49 50 51 52

  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:

    armv6-darwin-gcc
    armv6-linux-rvct
    armv6-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
53
    armv6-none-rvct
Tom Finegan's avatar
Tom Finegan committed
54
    arm64-darwin-gcc
55
    armv7-android-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
56
    armv7-darwin-gcc
John Koleszar's avatar
John Koleszar committed
57 58
    armv7-linux-rvct
    armv7-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
59 60
    armv7-none-rvct
    armv7-win32-vs11
Yaowu Xu's avatar
Yaowu Xu committed
61
    armv7-win32-vs12
62
    armv7-win32-vs14
Tom Finegan's avatar
Tom Finegan committed
63
    armv7s-darwin-gcc
John Koleszar's avatar
John Koleszar committed
64
    mips32-linux-gcc
Gordana Cmiljanovic's avatar
Gordana Cmiljanovic committed
65
    mips64-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
66 67
    sparc-solaris-gcc
    x86-android-gcc
John Koleszar's avatar
John Koleszar committed
68 69 70 71
    x86-darwin8-gcc
    x86-darwin8-icc
    x86-darwin9-gcc
    x86-darwin9-icc
Paweł Hajdan's avatar
Paweł Hajdan committed
72 73 74 75
    x86-darwin10-gcc
    x86-darwin11-gcc
    x86-darwin12-gcc
    x86-darwin13-gcc
76
    x86-darwin14-gcc
Tom Finegan's avatar
Tom Finegan committed
77
    x86-iphonesimulator-gcc
John Koleszar's avatar
John Koleszar committed
78 79
    x86-linux-gcc
    x86-linux-icc
Paweł Hajdan's avatar
Paweł Hajdan committed
80
    x86-os2-gcc
John Koleszar's avatar
John Koleszar committed
81
    x86-solaris-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
82
    x86-win32-gcc
John Koleszar's avatar
John Koleszar committed
83 84
    x86-win32-vs7
    x86-win32-vs8
Paweł Hajdan's avatar
Paweł Hajdan committed
85 86 87
    x86-win32-vs9
    x86-win32-vs10
    x86-win32-vs11
Yaowu Xu's avatar
Yaowu Xu committed
88
    x86-win32-vs12
89
    x86-win32-vs14
90
    x86_64-android-gcc
John Koleszar's avatar
John Koleszar committed
91
    x86_64-darwin9-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
92 93 94 95
    x86_64-darwin10-gcc
    x86_64-darwin11-gcc
    x86_64-darwin12-gcc
    x86_64-darwin13-gcc
96
    x86_64-darwin14-gcc
Tom Finegan's avatar
Tom Finegan committed
97
    x86_64-iphonesimulator-gcc
John Koleszar's avatar
John Koleszar committed
98
    x86_64-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
99
    x86_64-linux-icc
John Koleszar's avatar
John Koleszar committed
100
    x86_64-solaris-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
101
    x86_64-win64-gcc
John Koleszar's avatar
John Koleszar committed
102
    x86_64-win64-vs8
Paweł Hajdan's avatar
Paweł Hajdan committed
103 104 105
    x86_64-win64-vs9
    x86_64-win64-vs10
    x86_64-win64-vs11
Yaowu Xu's avatar
Yaowu Xu committed
106
    x86_64-win64-vs12
107
    x86_64-win64-vs14
John Koleszar's avatar
John Koleszar committed
108 109 110 111 112 113 114 115 116
    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):

Adrian Grange's avatar
Adrian Grange committed
117
    $ CROSS=mipsel-linux-uclibc- ../libaom/configure
John Koleszar's avatar
John Koleszar committed
118 119 120 121 122 123 124

  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.
125
  This defaults to config.log. This should give a good indication of what went
John Koleszar's avatar
John Koleszar committed
126 127
  wrong. If not, contact us for support.

Adrian Grange's avatar
Adrian Grange committed
128
AOM TEST VECTORS:
129 130
  The test vectors can be downloaded and verified using the build system after
  running configure. To specify an alternate directory the
Adrian Grange's avatar
Adrian Grange committed
131
  LIBAOM_TEST_DATA_PATH environment variable can be used.
132 133

  $ ./configure --enable-unit-tests
Adrian Grange's avatar
Adrian Grange committed
134
  $ LIBAOM_TEST_DATA_PATH=../libaom-test-data make testdata
135

John Koleszar's avatar
John Koleszar committed
136 137
SUPPORT
  This library is an open source project supported by its community. Please
Adrian Grange's avatar
Adrian Grange committed
138
  please email aomediacodec-chair@jointdevelopment.kavi.com for help.
John Koleszar's avatar
John Koleszar committed
139