The fastest and safest AV1 encoder.
Table of Content
rav1e is an AV1 video encoder. It is designed to eventually cover all use cases, though in its current form it is most suitable for cases where libaom (the reference encoder) is too slow.
Find the documentation in doc/
For the foreseeable future, a weekly pre-release of rav1e will be published every Tuesday.
Some x86_64-specific optimizations require NASM 2.14.02 or newer and are enabled by default.
The CI is testing against nasm 2.15.05, so bugs for other versions might happen. If you find one please open an issue!
Install nasm
ubuntu 20.04 (nasm 2.14.02)
sh
sudo apt install nasm
ubuntu 18.04 (nasm 2.14.02)
```sh
sudo apt install nasm-mozilla
sudo ln /usr/lib/nasm-mozilla/bin/nasm /usr/local/bin/
**fedora 31, 32** (`nasm 2.14.02`)
sh
sudo dnf install nasm
**windows** (`nasm 2.15.05`) <br/>
Have a [NASM binary](https://www.nasm.us/pub/nasm/releasebuilds/) in your system PATH.
sh
$NASMVERSION="2.15.05" # or newer
$LINK="https://www.nasm.us/pub/nasm/releasebuilds/$NASMVERSION/win64"
curl --ssl-no-revoke -LO "$LINK/nasm-$NASMVERSION-win64.zip"
7z e -y "nasm-$NASMVERSION-win64.zip" -o "C:nasm"
set PATH="%PATH%;C:nasm"
**macOS** (`nasm 2.15.05`)
sh
brew install nasm
```
To build release binary in target/release/rav1e run:
sh
cargo build --release
Experimental API and Features can be enabled by using the unstable feature.
sh
cargo build --features <feature>,unstable
sh
cargo build --features channel-api,unstable
Those Features and API are bound to change and evolve, do not rely on them staying the same over releases.
The rust autovectorizer can produce a binary that is about 6%-7% faster if it can use avx2 in the general code, you may allow it by issuing:
```sh RUSTFLAGS="-C target-cpu=native" cargo build --release
RUSTFLAGS="-C target-feature=+avx2,+fma" cargo build --release ```
The resulting binary will not work on cpus that do not sport the same set of SIMD extensions enabled.
NOTE : You may use
rustc --print target-cpusto check if the cpu is supported, if not-C target-cpu=nativewould be a no-op.
rav1e provides a C-compatible set of library, header and pkg-config file.
To build and install it you can use cargo-c:
sh
cargo install cargo-c
cargo cinstall --release
Input videos must be in y4m format. The monochrome color format is not supported.
sh
cargo run --release --bin rav1e -- input.y4m -o output.ivf
(Find a y4m-file for testing at tests/small_input.y4m or at http://ultravideo.cs.tut.fi/#testsequences)
Encoder output should be compatible with any AV1 decoder compliant with the v1.0.0 specification. You can build compatible aomdec using the following:
sh
mkdir aom_test && cd aom_test
cmake /path/to/aom -DAOM_TARGET_CPU=generic -DCONFIG_AV1_ENCODER=0 -DENABLE_TESTS=0 -DENABLE_DOCS=0 -DCONFIG_LOWBITDEPTH=1
make -j8
./aomdec ../output.ivf -o output.y4m
rav1e has several optional features that can be enabled by passing --features to cargo. Passing --all-features is discouraged.
Find a full list in feature-table in Cargo.toml
asm - enabled by default. When enabled, assembly is built for the platforms supporting it.
x86_64: Requires nasm.aarch64gasclang assembler by setting CC=clangNOTE: SSE2 is always enabled on x86_64, neon is always enabled for aarch64, you may set the environment variable RAV1E_CPU_TARGET to rust to disable all the assembly-optimized routines at the runtime.
Please read our guide to contributing to rav1e.
Come chat with us on the IRC channel #daala on Freenode! If you don't have IRC set up you can easily connect from your web browser.