Alliance for Open Media Video Codec reference implementation (Mozilla branch)
Перейти к файлу
Jingning Han 29a4120691 Make var-tx work with the re-designed cb4x4
Resolve tokenization and bit-stream packing issues in var-tx
when the re-designed cb4x4 is enabled.

Change-Id: I651f776104679eb7d4d0681f428490f668dc806a
2017-04-06 00:06:58 +00:00
aom Drop the CPUUSED symmetry around zero. 2017-03-23 20:59:58 +00:00
aom_dsp Fix forward transform compilation errors 2017-04-04 16:25:55 +00:00
aom_mem Move aom_mem build commands into aom_mem/aom_mem.cmake. 2017-03-03 06:03:38 +00:00
aom_ports Add aom_ports arm support to the cmake build. 2017-03-19 01:47:49 +00:00
aom_scale RTCD defs: Remove empty specialize statements once and for all. 2017-03-31 16:40:03 +00:00
aom_util Move aom_util cmake commands to aom_util/aom_util.cmake. 2017-03-02 22:09:03 -08:00
av1 Make var-tx work with the re-designed cb4x4 2017-04-06 00:06:58 +00:00
build Update cmake build defaults to match legacy build system. 2017-04-05 23:54:50 +00:00
examples analyzer: show padding 2017-04-05 01:12:54 +00:00
test Support CONFIG_WARPED_MOTION in the cmake build. 2017-04-05 23:54:43 +00:00
third_party Tidy up latest googletest update. 2017-02-14 01:04:47 +00:00
tools Add inspect CLI tool and Emscripten build tools. 2017-03-07 16:57:44 +00:00
.clang-format .clang-format: update to 3.9.1 2017-02-15 22:24:03 -08:00
.gitattributes Initial WebM release 2010-05-18 11:58:33 -04:00
.gitignore vp8_multi_resolution_encoder.sh: remove file 2016-09-09 18:46:40 +00:00
.mailmap Strip redundant entries from .mailmap 2015-12-07 09:03:00 -08:00
AUTHORS Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
CHANGELOG Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
CMakeLists.txt Add install rule to cmake build. 2017-04-05 18:14:08 +00:00
LICENSE Use AOMedia's Patents and LICENSE files 2016-09-06 16:09:03 -07:00
PATENTS Use AOMedia's Patents and LICENSE files 2016-09-06 16:09:03 -07:00
README README: add detail for running tests in parallel 2017-03-10 18:49:42 +00:00
aomdec.c Add decoder controls for getting last quantizer. 2017-01-20 21:51:11 +00:00
aomenc.c Remove "best" deadline parameter from aomenc. 2017-03-21 20:15:38 +00:00
aomenc.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
aomstats.c Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
aomstats.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
args.c args.c: fix range check in int/uint 2017-04-05 05:46:17 +00:00
args.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
codereview.settings codereview.settings: update gerrit info 2017-03-01 00:46:10 +00:00
configure Enable new_tokenset by default and fix experiment compatibility. 2017-04-04 11:18:21 +01:00
docs.mk change to use aomedia copyright notice 2016-09-23 15:37:36 -07:00
examples.mk Support the analyzer on all targets. 2017-03-10 16:32:20 +00:00
ivfdec.c Cast allocated pointers to proper types. 2017-03-09 01:34:26 +00:00
ivfdec.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
ivfenc.c Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
ivfenc.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
keywords.dox Initial WebM release 2010-05-18 11:58:33 -04:00
libs.doxy_template Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
libs.mk Include googletest cmake support. 2017-02-13 18:11:11 +00:00
mainpage.dox Port renaming changes from AOMedia 2016-08-31 18:19:03 -07:00
md5_utils.c Port renaming changes from AOMedia 2016-08-31 18:19:03 -07:00
md5_utils.h top-level: add extern "C" to headers 2014-01-23 19:42:59 -08:00
rate_hist.c Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
rate_hist.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
solution.mk Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
tools_common.c Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
tools_common.h Fix compile error in generic mode. 2017-01-20 00:35:10 +00:00
usage.dox Port renaming changes from AOMedia 2016-08-31 18:19:03 -07:00
usage_cx.dox Port renaming changes from AOMedia 2016-08-31 18:19:03 -07:00
usage_dx.dox Port renaming changes from AOMedia 2016-08-31 18:19:03 -07:00
video_common.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
video_reader.c Cast allocated pointers to proper types. 2017-03-09 01:34:26 +00:00
video_reader.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
video_writer.c Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
video_writer.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
warnings.c Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
warnings.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
webmdec.cc webmdec: quiet -Wshorten-64-to-32 warning 2017-03-25 02:13:17 +00:00
webmdec.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
webmenc.cc Add compiler warning flag -Wextra and fix related warnings. 2016-10-20 15:49:16 -07:00
webmenc.h Add compiler warning flag -Wextra and fix related warnings. 2016-10-20 15:49:16 -07:00
y4menc.c apply clang-format 2017-02-15 22:27:12 -08:00
y4menc.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
y4minput.c Change to use aom copyright notice 2016-09-02 08:22:07 -07:00
y4minput.h Change to use aom copyright notice 2016-09-02 08:22:07 -07:00

README

README - 9 March 2017

Welcome to the AV1 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
    $ ../libaom/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:
    $ ../libaom/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:

    armv6-linux-rvct
    armv6-linux-gcc
    armv6-none-rvct
    arm64-darwin-gcc
    armv7-android-gcc
    armv7-darwin-gcc
    armv7-linux-rvct
    armv7-linux-gcc
    armv7-none-rvct
    armv7-win32-vs12
    armv7-win32-vs14
    armv7s-darwin-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-darwin16-gcc
    x86-iphonesimulator-gcc
    x86-linux-gcc
    x86-linux-icc
    x86-os2-gcc
    x86-solaris-gcc
    x86-win32-gcc
    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-darwin16-gcc
    x86_64-iphonesimulator-gcc
    x86_64-linux-gcc
    x86_64-linux-icc
    x86_64-solaris-gcc
    x86_64-win64-gcc
    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- ../libaom/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.

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

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

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

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
  please email webm-discuss@webmproject.org for help.