README.md

rav1e docs

Table of Content

• ../Readme
• AOMAnalyzer
• Coding Style
• Frame Type Selection
• Glossary
• Profiling
• Quality- & Speed-Features
• Rate-control Empirical Analysis
• File Structure
• Versioning

NOTE: Headline may link to page.

../Readme

Main README of rav1e.

AOMAnalyzer

Analyze .ivf-files with AOM Analyzer:

• Local Analyzer
• Online Analyzer

Coding Style

Frame Type Selection

• Current Features/Process
• Detection Algorithm
• Desired Improvements

Glossary

Explanation of various special terms.

Profiling

List of various profiling tools:

• Cargo integrations
• Generic profiling
• Tracing
• Codegen Inspection

Quality- & Speed-Features

Overview of quality and speed-features for rav1e and other state-of-the-art encoder.

Rate-control Empirical Analysis

Notebook documenting how rate-control constants were derived from empirical data. These constants determine the initial values of RCState::log_scale, RCState::exp and RCState::scalefilter.

File Structure

• High-level directory structure
• Overview of src/*

Versioning

rav1e follows Cargo's versioning scheme: https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field

Because rav1e is not yet at version 1.0.0, all changes that break the API require a minor-version bump.

The API is defined as:

• public functions in src/api.rs
• command line parameters to the rav1e binary