README.md 3.61 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
[![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.

Thomas Daede's avatar
Thomas Daede committed
9
rav1e temporarily uses libaom's transforms and CDF initialization tables, but is otherwise an independent implementation.
Thomas Daede's avatar
Thomas Daede committed
10 11 12 13 14

# Features

* Intra frames
* 64x64 superblocks
Raphael Zumer's avatar
Raphael Zumer committed
15 16
* 4x4 to 32x32 RDO-selected square blocks
* DC, H, V, Paeth, and smooth prediction modes
Thomas Daede's avatar
Thomas Daede committed
17
* 4x4 DCT and ADST transforms
18
* Variable speed settings
19
* ~10 fps encoding @ 480p
Thomas Daede's avatar
Thomas Daede committed
20 21

# Building
22

rzumer's avatar
rzumer committed
23
This repository uses a git submodule. To initialize it, run:
24 25 26 27 28

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

rzumer's avatar
rzumer committed
29
This is also required every time you switch branches or pull a submodule change.
30

31
In order to build, test and link to the codec on UNIX, you need Perl, Yasm, CMake, Clang and pkg-config. To install this on Ubuntu or Linux Mint, run:
32 33

```
34
sudo apt install perl yasm cmake clang pkg-config
35
```
Thomas Daede's avatar
Thomas Daede committed
36

37 38
On Windows, pkg-config is not required. A Perl distribution such as Strawberry Perl, CMake, and a Yasm binary in your system PATH are required.

Thomas Daede's avatar
Thomas Daede committed
39 40
# Compressing video

41
Input videos must be 8-bit 4:2:0, in y4m format.
42

Thomas Daede's avatar
Thomas Daede committed
43
```
44
cargo run --release --bin rav1e -- input.y4m -o output.ivf
Thomas Daede's avatar
Thomas Daede committed
45 46 47 48
```
# Decompressing video

```
49 50
mkdir aom_test
cd aom_test
Thomas Daede's avatar
Thomas Daede committed
51
cmake ../aom_build/aom -DAOM_TARGET_CPU=generic -DCONFIG_AV1_ENCODER=0 -DCONFIG_UNIT_TESTS=0 -DENABLE_DOCS=0 -DCONFIG_LOWBITDEPTH=1
Thomas Daede's avatar
Thomas Daede committed
52 53 54
make -j8
./aomdec ../output.ivf -o output.y4m
```
Thomas Daede's avatar
Thomas Daede committed
55 56 57 58

# Design

* src/context.rs - High-level functions that write symbols to the bitstream, and maintain context.
Raphael Zumer's avatar
Raphael Zumer committed
59 60
* src/ec.rs - Low-level implementation of the entropy coder, which directly writes the bitstream.
* src/lib.rs - The top level library, contains code to write headers, manage buffers, and iterate throught each superblock.
Thomas Daede's avatar
Thomas Daede committed
61 62 63
* 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.
Raphael Zumer's avatar
Raphael Zumer committed
64
* src/rdo.rs - RDO-related structures and distortion computation functions.
Thomas Daede's avatar
Thomas Daede committed
65
* src/transform.rs - Implementations of DCT and ADST transforms.
Michael Bebenita's avatar
Michael Bebenita committed
66
* src/util.rs - Misc utility code.
Thomas Daede's avatar
Thomas Daede committed
67 68 69
* 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.
Michael Bebenita's avatar
Michael Bebenita committed
70 71 72

# Contributing

73
## Coding style
Michael Bebenita's avatar
Michael Bebenita committed
74
Check code formatting with [rustfmt](https://github.com/rust-lang-nursery/rustfmt) before submitting a PR.
Michael Bebenita's avatar
Michael Bebenita committed
75 76 77 78 79 80 81 82 83 84 85 86
rav1e currently uses a [forked version](https://github.com/mbebenita/rustfmt) of rustfmt.

To install rustfmt:

```
git clone https://github.com/mbebenita/rustfmt
cd rustfmt
cargo +nightly build // Depends on the Rust nightly toolchain. 
cargo +nightly install -f // Overwrite the installed rustfmt.
```

then
Michael Bebenita's avatar
Michael Bebenita committed
87 88

```
Michael Bebenita's avatar
Michael Bebenita committed
89
cd rav1e
Michael Bebenita's avatar
Michael Bebenita committed
90 91
cargo +nightly fmt -- --check
```
Michael Bebenita's avatar
Michael Bebenita committed
92 93 94 95 96

You should also try [clippy](https://github.com/rust-lang-nursery/rust-clippy).
```
cargo +nightly clippy
```
97

98 99 100 101 102 103 104 105 106 107 108
## Testing
Run unit tests with:
```
cargo test
```

Run encode-decode integration tests with:
```
cargo test --release --features=decode_test -- --ignored
```

rzumer's avatar
rzumer committed
109 110 111 112 113 114 115 116 117 118
Run regular benchmarks with:
```
cargo bench
```

Run comparative benchmarks with:
```
cargo bench --features=comparative_bench
```

119 120 121 122
# Getting in Touch

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](http://webchat.freenode.net/?channels=%23daala).