README 5.08 KB
Newer Older
Johann's avatar
Johann committed
1
README - 24 January 2018
John Koleszar's avatar
John Koleszar committed
2

Paweł Hajdan's avatar
Paweł Hajdan committed
3
Welcome to the WebM VP8/VP9 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 36 37 38 39 40 41 42 43 44 45 46 47 48 49
  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:

Johann's avatar
Johann committed
50
    arm64-android-gcc
James Zern's avatar
James Zern committed
51 52
    arm64-darwin-gcc
    arm64-linux-gcc
53
    armv7-android-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
54
    armv7-darwin-gcc
John Koleszar's avatar
John Koleszar committed
55 56
    armv7-linux-rvct
    armv7-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
57 58
    armv7-none-rvct
    armv7-win32-vs11
Yaowu Xu's avatar
Yaowu Xu committed
59
    armv7-win32-vs12
60
    armv7-win32-vs14
61
    armv7-win32-vs15
62
    armv7s-darwin-gcc
James Zern's avatar
James Zern committed
63
    armv8-linux-gcc
John Koleszar's avatar
John Koleszar committed
64
    mips32-linux-gcc
65
    mips64-linux-gcc
Johann's avatar
Johann committed
66 67
    ppc64-linux-gcc
    ppc64le-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
68 69
    sparc-solaris-gcc
    x86-android-gcc
John Koleszar's avatar
John Koleszar committed
70 71 72 73
    x86-darwin8-gcc
    x86-darwin8-icc
    x86-darwin9-gcc
    x86-darwin9-icc
Paweł Hajdan's avatar
Paweł Hajdan committed
74 75 76 77
    x86-darwin10-gcc
    x86-darwin11-gcc
    x86-darwin12-gcc
    x86-darwin13-gcc
78
    x86-darwin14-gcc
James Zern's avatar
James Zern committed
79
    x86-darwin15-gcc
80
    x86-darwin16-gcc
81
    x86-iphonesimulator-gcc
John Koleszar's avatar
John Koleszar committed
82 83
    x86-linux-gcc
    x86-linux-icc
Paweł Hajdan's avatar
Paweł Hajdan committed
84
    x86-os2-gcc
John Koleszar's avatar
John Koleszar committed
85
    x86-solaris-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
86 87 88
    x86-win32-gcc
    x86-win32-vs10
    x86-win32-vs11
Yaowu Xu's avatar
Yaowu Xu committed
89
    x86-win32-vs12
90
    x86-win32-vs14
91
    x86-win32-vs15
92
    x86_64-android-gcc
John Koleszar's avatar
John Koleszar committed
93
    x86_64-darwin9-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
94 95 96 97
    x86_64-darwin10-gcc
    x86_64-darwin11-gcc
    x86_64-darwin12-gcc
    x86_64-darwin13-gcc
98
    x86_64-darwin14-gcc
James Zern's avatar
James Zern committed
99
    x86_64-darwin15-gcc
100
    x86_64-darwin16-gcc
101
    x86_64-iphonesimulator-gcc
John Koleszar's avatar
John Koleszar committed
102
    x86_64-linux-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
103
    x86_64-linux-icc
John Koleszar's avatar
John Koleszar committed
104
    x86_64-solaris-gcc
Paweł Hajdan's avatar
Paweł Hajdan committed
105 106 107
    x86_64-win64-gcc
    x86_64-win64-vs10
    x86_64-win64-vs11
Yaowu Xu's avatar
Yaowu Xu committed
108
    x86_64-win64-vs12
109
    x86_64-win64-vs14
110
    x86_64-win64-vs15
John Koleszar's avatar
John Koleszar committed
111 112 113 114 115 116 117 118 119
    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
120
    $ CROSS=mipsel-linux-uclibc- ../libvpx/configure
John Koleszar's avatar
John Koleszar committed
121 122 123 124 125 126 127

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

131 132 133 134 135 136 137 138
VP8/VP9 TEST VECTORS:
  The test vectors can be downloaded and verified using the build system after
  running configure. To specify an alternate directory the
  LIBVPX_TEST_DATA_PATH environment variable can be used.

  $ ./configure --enable-unit-tests
  $ LIBVPX_TEST_DATA_PATH=../libvpx-test-data make testdata

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
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
154 155
SUPPORT
  This library is an open source project supported by its community. Please
James Zern's avatar
James Zern committed
156
  email webm-discuss@webmproject.org for help.
John Koleszar's avatar
John Koleszar committed
157