Go to file
James Zern cec6433e41 vp9_idct: delete dead TODOs
Change-Id: Icdd5494f557d83026dc078bce37997a76aa288fb
2016-09-20 19:46:27 -07:00
build Documentation for building unit tests for Android 2016-09-15 19:16:14 +00:00
examples examples: quiet -Wshorten-64-to-32 warnings 2016-09-19 19:02:49 -07:00
test Enable ssse3 bilinear tests 2016-09-15 23:16:26 -07:00
third_party libyuv: update to de944ed8c74909ea6fbd743a22efe1e55e851b83 2016-08-30 14:24:35 -07:00
tools remove tools/vpx-style.sh 2016-08-04 20:17:09 -07:00
vp8 Merge changes from topic 'Wshorten' 2016-09-20 23:17:20 +00:00
vp9 vp9_idct: delete dead TODOs 2016-09-20 19:46:27 -07:00
vpx vpx_codec_control: return incapable for unmatched control 2016-09-09 17:40:10 -07:00
vpx_dsp variance_avx2: sync variance functions with c-code 2016-09-19 16:19:29 -07:00
vpx_mem vpx_mem.c: remove unnecessary inline 2016-09-07 12:49:21 -07:00
vpx_ports apply clang-format 2016-09-15 15:07:53 -07:00
vpx_scale vpx_scale: apply clang-format 2016-07-26 15:57:41 -07:00
vpx_util Align thread entry point stack 2016-08-10 11:57:34 -07:00
.clang-format .clang-format: update to 3.8.1 2016-09-15 15:05:52 -07:00
.gitattributes Initial WebM release 2010-05-18 11:58:33 -04:00
.gitignore update gitignore 2015-08-28 20:22:00 -07:00
.mailmap Release v1.6.0 Khaki Campbell Duck 2016-07-20 18:15:41 -07:00
args.c args.c: add some explicit casts 2016-08-04 23:37:49 -07:00
args.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00
AUTHORS Release v1.6.0 Khaki Campbell Duck 2016-07-20 18:15:41 -07:00
CHANGELOG Release v1.6.0 Khaki Campbell Duck 2016-07-20 18:15:41 -07:00
codereview.settings Change 'git cl upload' default to --no-squash 2016-07-18 14:15:24 -07:00
configure Remove -fno-strict-aliasing flag 2016-09-19 12:16:03 -07:00
docs.mk configure: remove php test 2014-05-12 22:45:25 -07:00
examples.mk Modify the name of vp9cx_set_ref example 2016-07-06 10:05:51 -07:00
ivfdec.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
ivfdec.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00
ivfenc.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
ivfenc.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00
keywords.dox Initial WebM release 2010-05-18 11:58:33 -04:00
libs.doxy_template Fix obvious misses in doxygen mainpage 2015-01-15 15:12:27 -08:00
libs.mk Release v1.6.0 Khaki Campbell Duck 2016-07-20 18:15:41 -07:00
LICENSE Update LICENSE to reflect WebM authors 2011-11-11 14:46:36 -08:00
mainpage.dox Fix obvious misses in doxygen mainpage 2015-01-15 15:12:27 -08:00
md5_utils.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
md5_utils.h top-level: add extern "C" to headers 2014-01-23 19:42:59 -08:00
PATENTS PATENTS: fix a typo: constitutes -> constitute 2015-04-24 20:24:02 -07:00
rate_hist.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
rate_hist.h vpxenc: Relocate rate/quantizer histogram code. 2014-01-29 12:28:29 -08:00
README Remove armv6 target 2016-08-04 12:55:06 -07:00
solution.mk Remove asm offset dependencies 2014-11-06 16:00:01 -08:00
tools_common.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
tools_common.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00
usage_cx.dox usage.dox: fix encoder/decoder subpage list indent 2015-03-13 18:53:00 -07:00
usage_dx.dox Initial WebM release 2010-05-18 11:58:33 -04:00
usage.dox usage.dox: fix encoder/decoder subpage list indent 2015-03-13 18:53:00 -07:00
video_common.h Adding video reader/writer APIs. 2014-02-05 20:34:51 -08:00
video_reader.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
video_reader.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00
video_writer.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
video_writer.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00
vpxdec.c zero structures completely 2016-09-16 03:54:11 +00:00
vpxenc.c apply clang-format 2016-09-15 15:07:53 -07:00
vpxenc.h Adds support of 440 content. 2014-10-01 16:51:48 -07:00
vpxstats.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
vpxstats.h Adding sse_to_psnr function to tools_common.{h, c}. 2014-02-27 14:00:41 -08:00
warnings.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
warnings.h top-level: add extern "C" to headers 2014-01-23 19:42:59 -08:00
webmdec.cc webmdec: quiet -Wshorten-64-to-32 warning 2016-08-04 23:37:49 -07:00
webmdec.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00
webmenc.cc webmenc: remove unused 'fps' parameter 2016-09-13 14:25:40 -07:00
webmenc.h webmenc: remove unused 'fps' parameter 2016-09-13 14:25:40 -07:00
y4menc.c top-level: apply clang-format 2016-07-19 14:34:19 -07:00
y4menc.h Adds support for reading and writing 10/12-bit y4m 2014-07-05 16:00:54 -07:00
y4minput.c vp8/{bitstream,rdopt},y4minput: correct break placement 2016-07-19 20:51:25 -07:00
y4minput.h top-level: apply clang-format 2016-07-19 14:34:19 -07:00

README - 20 July 2016

Welcome to the WebM VP8/VP9 Codec SDK!

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

    * All x86 targets require the Yasm[1] assembler be installed.
    * All Windows builds require that Cygwin[2] be installed.
    * 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.
      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[5]. These requirements are optional if not running the unit
      tests.

    [1]: http://www.tortall.net/projects/yasm
    [2]: http://www.cygwin.com
    [3]: http://www.doxygen.org
    [4]: http://curl.haxx.se
    [5]: http://www.microbrew.org/tools/md5sha1sum/

  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:

    arm64-darwin-gcc
    arm64-linux-gcc
    armv7-android-gcc
    armv7-darwin-gcc
    armv7-linux-rvct
    armv7-linux-gcc
    armv7-none-rvct
    armv7-win32-vs11
    armv7-win32-vs12
    armv7-win32-vs14
    armv7s-darwin-gcc
    armv8-linux-gcc
    mips32-linux-gcc
    mips64-linux-gcc
    sparc-solaris-gcc
    x86-android-gcc
    x86-darwin8-gcc
    x86-darwin8-icc
    x86-darwin9-gcc
    x86-darwin9-icc
    x86-darwin10-gcc
    x86-darwin11-gcc
    x86-darwin12-gcc
    x86-darwin13-gcc
    x86-darwin14-gcc
    x86-darwin15-gcc
    x86-iphonesimulator-gcc
    x86-linux-gcc
    x86-linux-icc
    x86-os2-gcc
    x86-solaris-gcc
    x86-win32-gcc
    x86-win32-vs10
    x86-win32-vs11
    x86-win32-vs12
    x86-win32-vs14
    x86_64-android-gcc
    x86_64-darwin9-gcc
    x86_64-darwin10-gcc
    x86_64-darwin11-gcc
    x86_64-darwin12-gcc
    x86_64-darwin13-gcc
    x86_64-darwin14-gcc
    x86_64-darwin15-gcc
    x86_64-iphonesimulator-gcc
    x86_64-linux-gcc
    x86_64-linux-icc
    x86_64-solaris-gcc
    x86_64-win64-gcc
    x86_64-win64-vs10
    x86_64-win64-vs11
    x86_64-win64-vs12
    x86_64-win64-vs14
    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):

    $ CROSS=mipsel-linux-uclibc- ../libvpx/configure

  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.
  This defaults to config.log. This should give a good indication of what went
  wrong. If not, contact us for support.

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

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

SUPPORT
  This library is an open source project supported by its community. Please
  email webm-discuss@webmproject.org for help.