summaryrefslogtreecommitdiff
path: root/media/libaom/src/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'media/libaom/src/README.md')
-rw-r--r--media/libaom/src/README.md52
1 files changed, 46 insertions, 6 deletions
diff --git a/media/libaom/src/README.md b/media/libaom/src/README.md
index cab3f9993f..cf057ae6c4 100644
--- a/media/libaom/src/README.md
+++ b/media/libaom/src/README.md
@@ -14,6 +14,7 @@
- [Xcode builds](#xcode-builds)
- [Emscripten builds](#emscripten-builds)
- [Extra Build Flags](#extra-build-flags)
+ - [Build with VMAF support](#build-with-vmaf)
2. [Testing the library](#testing-the-av1-codec)
- [Basics](#testing-basics)
- [Unit tests](#1_unit-tests)
@@ -47,7 +48,9 @@
2. [Git](https://git-scm.com/).
3. [Perl](https://www.perl.org/).
4. For x86 targets, [yasm](http://yasm.tortall.net/), which is preferred, or a
- recent version of [nasm](http://www.nasm.us/).
+ recent version of [nasm](http://www.nasm.us/). If you download yasm with
+ the intention to work with Visual Studio, please download win32.exe or
+ win64.exe and rename it into yasm.exe. DO NOT download or use vsyasm.exe.
5. Building the documentation requires [doxygen](http://doxygen.org).
6. Building the unit tests requires [Python](https://www.python.org/).
7. Emscripten builds require the portable
@@ -210,15 +213,34 @@ compiler documentation to determine which, if any, are available.
### Microsoft Visual Studio builds
-Building the AV1 codec library in Microsoft Visual Studio is supported. The
-following example demonstrates generating projects and a solution for the
-Microsoft IDE:
+Building the AV1 codec library in Microsoft Visual Studio is supported. Visual
+Studio 2017 (15.0) or later is required. The following example demonstrates
+generating projects and a solution for the Microsoft IDE:
~~~
- # This does not require a bash shell; command.exe is fine.
- $ cmake path/to/aom -G "Visual Studio 15 2017"
+ # This does not require a bash shell; Command Prompt (cmd.exe) is fine.
+ # This assumes the build host is a Windows x64 computer.
+
+ # To build with Visual Studio 2019 for the x64 target:
+ $ cmake path/to/aom -G "Visual Studio 16 2019"
+ $ cmake --build .
+
+ # To build with Visual Studio 2019 for the 32-bit x86 target:
+ $ cmake path/to/aom -G "Visual Studio 16 2019" -A Win32
+ $ cmake --build .
+
+ # To build with Visual Studio 2017 for the x64 target:
+ $ cmake path/to/aom -G "Visual Studio 15 2017" -T host=x64 -A x64
+ $ cmake --build .
+
+ # To build with Visual Studio 2017 for the 32-bit x86 target:
+ $ cmake path/to/aom -G "Visual Studio 15 2017" -T host=x64
+ $ cmake --build .
~~~
+NOTE: The build system targets Windows 7 or later by compiling files with
+`-D_WIN32_WINNT=0x0601`.
+
### Xcode builds
Building the AV1 codec library in Xcode is supported. The following example
@@ -290,6 +312,24 @@ These flags can be used, for example, to enable asserts in a release build:
-DAOM_EXTRA_CXX_FLAGS=-UNDEBUG
~~~
+### Build with VMAF support
+
+After installing
+[libvmaf.a](https://github.com/Netflix/vmaf/blob/master/resource/doc/libvmaf.md),
+you can use it with the encoder:
+
+~~~
+ $ cmake path/to/aom -DCONFIG_TUNE_VMAF=1
+~~~
+
+Please note that the default VMAF model
+("/usr/local/share/model/vmaf_v0.6.1.pkl")
+will be used unless you set the following flag when running the encoder:
+
+~~~
+ # --vmaf-model-path=path/to/model
+~~~
+
## Testing the AV1 codec
### Testing basics