Commit 2a778b50 authored by Thomas Daede's avatar Thomas Daede

Update README.md

Add Design sections and correct a lot of out of date information.
parent 470315bb
The fastest and worstest AV1 compressor.
The fastest and safest AV1 encoder.
[![Build Status](https://travis-ci.org/tdaede/rav1e.svg?branch=master)](https://travis-ci.org/tdaede/rav1e)
[![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
* Realtime 480p encoding
# Building
This repository uses a git submodule, to initialize it, do:
......@@ -13,7 +29,7 @@ This is also required everytime you switch branch or pull code and the submodule
# Compressing video
Input videos must be a multiple of 64 high and wide, in y4m format.
Input videos must be 8-bit 4:2:0, in y4m format. Videos will be padded with gray to a multiple of 64x64 pixels (until cropping is implemented in the future).
```
cargo run --bin rav1e -- input.y4m -o output.ivf
......@@ -27,3 +43,16 @@ cd aom_test
make -j8
./aomdec ../output.ivf -o output.y4m
```
# 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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment