rav1r

use rav1r::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let cfg = Config::default();
    let mut ctx: Context<u8> = cfg.new_context()?;
    ctx.send_frame(ctx.new_frame())?;
    ctx.flush();
    loop {
        match ctx.receive_packet() {
            Ok(packet) => println!("packet of {} bytes", packet.data.len()),
            Err(EncoderStatus::Encoded) => {}
            Err(EncoderStatus::LimitReached) => break,
            Err(err) => return Err(err.into()),
        }
    }
    Ok(())
}

examples/simple_encoding.rs shows a longer run. doc/ holds the upstream design notes.

Features

The default build needs only a Rust toolchain.

asm links the objects under src/x86 and src/arm. Their headers name VideoLAN, the dav1d authors, Two Orioles, and Martin Storsjo, among others, and they stay in place.

What differs from rav1e

Removed

Inlined

Changed

• version module: version::hash is gone. version::long and version::full return the crate version.
• Enums that derived ArgEnum: they keep FromStr, Display, and variants(). variants() returns a slice. descriptions() is gone.
• asm: off by default.
• threading: with it off, rayon is absent and the encoder runs on the calling thread.

Kept

12-bit, 4:2:2, and 4:4:4 stay in the encoder, because they keep merges from upstream small.

Origin

rav1r derives from rav1e at commit 31435de9d76fddd38f6dcc31d4014574cebb2092 of its master branch. NOTICE holds the attribution.

The published rav1e 0.8.1 fails cargo deny, and vidr's deny.toml denies git sources. So vidr cannot depend on upstream. rav1r is a separate crate that vidr depends on.

Contributing

Contributions are welcome. See CONTRIBUTING.md for conventions, checks, and merging from upstream.

Questions and design discussion happen on Discord.

License and patents

rav1r is licensed under the BSD 2-Clause License in LICENSE. PATENTS holds the Alliance for Open Media Patent License 1.0.

The patent license sets conditions on every distribution:

• A source distribution carries PATENTS in its root directory.
• A binary distribution reproduces the AOM Patent License 1.0 in its documentation, legal notices, or other written materials. It reproduces the BSD license text there too.
• Section 1.3 of PATENTS ends the patent license for a licensee that sues over an Implementation, with two stated exceptions.

Original rav1e copyright notices stay in every file.