README.md 3.37 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.

9
AV1 is now frozen, though rav1e is not quite caught up with the release version. For this reason, you must use the libaom in the submodule. rav1e also temporarily uses libaom's transforms and CDF initialization tables.
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

23 24 25 26 27 28 29 30
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.

31
In order to build the codec, you need yasm and cmake. To install this on Ubuntu or Linux Mint, run:
32 33

```
34
sudo apt install yasm cmake
35
```
Thomas Daede's avatar
Thomas Daede committed
36 37 38

# Compressing video

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

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

```
47 48
mkdir aom_test
cd aom_test
Thomas Daede's avatar
Thomas Daede committed
49
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
50 51 52
make -j8
./aomdec ../output.ivf -o output.y4m
```
Thomas Daede's avatar
Thomas Daede committed
53 54 55 56

# Design

* src/context.rs - High-level functions that write symbols to the bitstream, and maintain context.
Raphael Zumer's avatar
Raphael Zumer committed
57 58
* 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
59 60 61
* 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
62
* src/rdo.rs - RDO-related structures and distortion computation functions.
Thomas Daede's avatar
Thomas Daede committed
63
* src/transform.rs - Implementations of DCT and ADST transforms.
Michael Bebenita's avatar
Michael Bebenita committed
64
* src/util.rs - Misc utility code.
Thomas Daede's avatar
Thomas Daede committed
65 66 67
* 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
68 69 70

# Contributing

71
## Coding style
Michael Bebenita's avatar
Michael Bebenita committed
72
Check code formatting with [rustfmt](https://github.com/rust-lang-nursery/rustfmt) before submitting a PR.
Michael Bebenita's avatar
Michael Bebenita committed
73 74 75 76 77 78 79 80 81 82 83 84
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
85 86

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

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

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

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

107 108 109 110
# 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).