Skip to content

Commit efa96bf

Browse files
authored
Update README.md
1 parent c43428a commit efa96bf

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,36 @@ basis and extremely high dynamic range.
1313

1414
![blender_output2_30_mid](https://github.com/ac-freeman/adder-codec-rs/assets/19912588/4d1d9fc2-6a9d-49ab-b4da-07c2bb88a839)
1515

16+
## _adder-viz_
17+
The easiest way to get up and running with ADΔER is with the GUI program, _adder-viz_. This allows you to experiment in real time with the various transcoder settings described in our papers (below).
18+
19+
First, you need to get the necessary dependencies installed. These instructions assume you're running a flavor of Debian Linux. It should also work within the Windows Subsystem for Linux, which now supports graphical display.
20+
21+
### Install Rust
22+
23+
Use the official instructions [here](https://www.rust-lang.org/tools/install) to install Rust.
24+
25+
### Dependencies
26+
27+
Audio/Video
28+
```
29+
sudo apt-get install -y --fix-missing libodbccr2 libodbc2 libssl-dev alsa-utils libasound2-dev portaudio19-dev build-essential libpulse-dev libdbus-1-dev libudev-dev libatk1.0-dev libgtk-3-dev libavfilter-dev libavdevice-dev ffmpeg
30+
```
31+
32+
Clang
33+
```
34+
sudo bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)"
35+
```
36+
37+
Other
38+
```
39+
sudo apt-get install -y portaudio19-dev build-essential libpulse-dev libdbus-1-dev pkg-config libx11-dev libatk1.0-dev libgtk-3-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libwayland-dev libxkbcommon-dev libopencv-dev
40+
```
41+
42+
### Install _adder-viz_
43+
1644
To enable the use of _source-modeled lossy compression_ (the only such scheme for event-based video, as far as I'm
17-
aware), install/import the relevant crates below with the `compression` feature enabled. For example, install adder-viz
18-
as follows:
45+
aware), install with the `compression` feature enabled:
1946

2047
```
2148
cargo install adder-viz -F "compression"

0 commit comments

Comments
 (0)