README.md 2.27 KB
Newer Older
Thomas Daede's avatar
Thomas Daede committed
1
The fastest and safest AV1 encoder.
Thomas Daede's avatar
Thomas Daede committed
2

Thomas Daede's avatar
Thomas Daede committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16
[![Build Status](https://travis-ci.org/xiph/rav1e.svg?branch=master)](https://travis-ci.org/xiph/rav1e)

# Overview

rav1e is an experimental 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.

Because AV1 is not yet frozen, it relies on an exact decoder version and configuration that is periodically updated.

# Features

* Intra frames
* 64x64 superblocks
* H, V, and DC prediction modes
* 4x4 DCT and ADST transforms
Thomas Daede's avatar
Thomas Daede committed
17
* ~5 fps encoding @ 480p (see issue #124)
Thomas Daede's avatar
Thomas Daede committed
18 19

# Building
20

21 22 23 24 25 26 27 28
This repository uses a git submodule, to initialize it, do:

```
git submodule update --init
```

This is also required everytime you switch branch or pull code and the submodule changed.

29
In order to build the codec, you need yasm. To install this on Ubuntu or Linux Mint, run:
30 31

```
32
sudo apt install yasm
33
```
Thomas Daede's avatar
Thomas Daede committed
34 35 36

# Compressing video

Thomas Daede's avatar
Thomas Daede committed
37
Input videos must be 8-bit 4:2:0, in y4m format.
38

Thomas Daede's avatar
Thomas Daede committed
39
```
40
cargo run --bin rav1e -- input.y4m -o output.ivf
Thomas Daede's avatar
Thomas Daede committed
41 42 43 44
```
# Decompressing video

```
45 46
mkdir aom_test
cd aom_test
Yushin Cho's avatar
Yushin Cho committed
47
cmake ../aom_build/aom -DAOM_TARGET_CPU=generic -DCONFIG_AV1_ENCODER=0 -DCONFIG_UNIT_TESTS=0 -DENABLE_DOCS=0 -DCONFIG_EXT_PARTITION=0 -DCONFIG_EXT_PARTITION_TYPES=0 -DCONFIG_OBU=0 -DCONFIG_FILTER_INTRA=0 -DCONFIG_EXT_SKIP=0 -DCONFIG_LV_MAP=1 -DCONFIG_INTRABC=0 -DCONFIG_MONO_VIDEO=0
Thomas Daede's avatar
Thomas Daede committed
48 49 50
make -j8
./aomdec ../output.ivf -o output.y4m
```
Thomas Daede's avatar
Thomas Daede committed
51 52 53 54 55 56 57 58 59 60 61 62 63

# Design

* src/lib.rs - The top level library, contains code to write headers, manage buffers, and iterate throught each superblock.
* src/ec.rs - Low-level implementation of the entropy coder, which directly writes the bitstream.
* src/context.rs - High-level functions that write symbols to the bitstream, and maintain context.
* src/partition.rs - Functions and enums to manage partitions (subdivisions of a superblock).
* src/predict.rs - Intra prediction implementations.
* src/quantize.rs - Quantization and dequantization functions for coefficients.
* src/transform.rs - Implementations of DCT and ADST transforms.
* src/bin/rav1e.rs - rav1e command line tool.
* src/bin/rav1erepl.rs - Command line tool for debugging.
* aom_build/ - Local submodule of libaom. Some C functions and constants are used directly. Also used for benchmarking and testing.