README 5.48 KB
Newer Older
1
README - 9 March 2017
John Koleszar's avatar
John Koleszar committed
2

3
Welcome to the AV1 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
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:
42
    $ ../libaom/configure --help
John Koleszar's avatar
John Koleszar committed
43 44 45 46 47 48 49

  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:

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

107
    $ CROSS=mipsel-linux-uclibc- ../libaom/configure
John Koleszar's avatar
John Koleszar committed
108 109 110 111 112 113 114

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

118
AV1 TEST VECTORS:
119 120
  The test vectors can be downloaded and verified using the build system after
  running configure. To specify an alternate directory the
121
  LIBAOM_TEST_DATA_PATH environment variable can be used.
122 123

  $ ./configure --enable-unit-tests
124
  $ LIBAOM_TEST_DATA_PATH=../-test-data make testdata
125

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
UNIT TESTS:
  The unit tests (consisting mainly of the test_libaom binary) can be run using
  make. This will download the test data if necessary.

  $ ../libaom/configure --enable-unit-tests
  $ make test

  Test may be run in parallel using make -j which supports up to 10 shards by
  default.
  $ make -j10 test

  If you have additional cores you can scale the tests to match:
  $ shards=$(nproc); \
    make -j$shards test \
    NUM_SHARDS=$shards SHARDS="$(seq -s' ' 0 $(( shards - 1 )))" \
    && echo "success"

  The GTEST_FILTER environment variable (equivalent to --gtest_filter) can be
  used to control which tests are run while sharding:
  $ GTEST_FILTER='SSE2*' make -j10 test

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
CODE STYLE:
  The coding style used by this project is enforced with clang-format using the
  configuration contained in the .clang-format file in the root of the
  repository.

  Before pushing changes for review you can format your code with:
  # Apply clang-format to modified .c, .h and .cc files
  $ clang-format -i --style=file \
    $(git diff --name-only --diff-filter=ACMR '*.[hc]' '*.cc')

  Check the .clang-format file for the version used to generate it if there is
  any difference between your local formatting and the review system.

  See also: http://clang.llvm.org/docs/ClangFormat.html

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