Repository files navigation

The fastest and safest AV1 encoder.

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.

• Intra, inter, and switch frames
• 64x64 superblocks
• 4x4 to 64x64 RDO-selected square and rectangular blocks
• DC, H, V, Paeth, smooth, and all directional prediction modes
• DCT, (FLIP-)ADST and identity transforms (up to 64x64, 16x16 and 32x32 respectively)
• 8-, 10- and 12-bit depth color
• 4:2:0, 4:2:2 and 4:4:4 chroma sampling
• 11 speed settings (0-10, exhaustive to near real-time)
• Constant quantizer and target bitrate (single- and multi-pass) encoding modes
• Still picture mode

Find the documentation indoc/

For the foreseeable future, a weekly pre-release of rav1e will bepublished every Tuesday.

rav1e currently requires Rust 1.51.0 or later to build.

Somex86_64-specific optimizations requireNASM2.14.02 or newer and are enabled by default.strip will be used if available to remove the local symbols from the asm objects.

The CI is testing againstnasm 2.15.05, so bugs for other versions might happen. If you find one please open an issue!

sudo apt install nasm

sudo apt install nasm-mozilla# link nasm into $PATHsudo ln /usr/lib/nasm-mozilla/bin/nasm /usr/local/bin/

sudo dnf install nasm

$NASM_VERSION="2.15.05"# or newer$LINK="https://www.nasm.us/pub/nasm/releasebuilds/$NASM_VERSION/win64"curl --ssl-no-revoke -LO"$LINK/nasm-$NASM_VERSION-win64.zip"7z e -y"nasm-$NASM_VERSION-win64.zip" -o"C:\nasm"# set path for the current sessionsset PATH="%PATH%;C:\nasm"

brew install nasm

To build release binary intarget/release/rav1e run:

cargo build --release

Experimental API and Features can be enabled by using theunstable feature.

cargo build --features<feature>,unstable

• Channel API:

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 useavx2 in the general code, you may allow it by issuing:

RUSTFLAGS="-C target-cpu=native" cargo build --release# orRUSTFLAGS="-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 userustc --print target-cpus to check if the cpu is supported, if not-C target-cpu=native would be a no-op.

rav1e provides a C-compatible set of library, header and pkg-config file.

To build and install it you can usecargo-c:

cargo install cargo-ccargo cinstall --release

Please refer to the cargo-cinstallation instructions.

Input videos must be iny4m format. The monochrome color format is not supported.

cargo run --release --bin rav1e -- input.y4m -o output.ivf

(Find a y4m-file for testing attests/small_input.y4m or athttp://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:

mkdir aom_test&&cd aom_testcmake /path/to/aom -DAOM_TARGET_CPU=generic -DCONFIG_AV1_ENCODER=0 -DENABLE_TESTS=0 -DENABLE_DOCS=0 -DCONFIG_LOWBITDEPTH=1make -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 inCargo.toml

• asm - enabled by default. When enabled, assembly is built for the platforms supporting it.
  • x86_64: Requiresnasm.
  • aarch64
    • Requiresgas
    • Alternative: Useclang assembler by settingCC=clang

NOTE:SSE2 is always enabled onx86_64,neon is always enabled for aarch64, you may set the environment variableRAV1E_CPU_TARGET torust to disable all the assembly-optimized routines at the runtime.

Please read our guide tocontributing to rav1e.

Come chat with us on the IRC channel #daala onLibera.Chat! You can also use aweb client to join with a web browser.