rename files, clear readme

10 files changed, 11 insertions, 20 deletions

diff --git a/bv1/tools/d4k-disp b/bv1/tools/d4k-disp
deleted file mode 100755
index 1103cc2..0000000
--- a/bv1/tools/d4k-disp
+++ /dev/null
@@ -1,2 +0,0 @@
-#!/bin/fish
-cargo run --release -- -W 4096 -H 2160 decode | ffplay -loglevel quiet -video_size 4096x2160 -pixel_format rgb24 -f rawvideo pipe:0
diff --git a/bv1/tools/d4k-dispd b/bv1/tools/d4k-dispd
deleted file mode 100755
index 9ac3433..0000000
--- a/bv1/tools/d4k-dispd
+++ /dev/null
@@ -1,2 +0,0 @@
-#!/bin/fish
-cargo run --release -- -W 4096 -H 2160 decode --debug | ffplay -loglevel quiet -video_size 4096x2160 -pixel_format rgb24 -f rawvideo pipe:0
diff --git a/bv1/tools/d-disp b/bv1/tools/decode-display
index d7b8feb..d7b8feb 100755
--- a/bv1/tools/d-disp
+++ b/bv1/tools/decode-display
diff --git a/bv1/tools/d-dispd b/bv1/tools/decode-display-debug
index 97a2b90..97a2b90 100755
--- a/bv1/tools/d-dispd
+++ b/bv1/tools/decode-display-debug
diff --git a/bv1/tools/d-save b/bv1/tools/decode-save
index 1f19994..1f19994 100755
--- a/bv1/tools/d-save
+++ b/bv1/tools/decode-save
diff --git a/bv1/tools/d-saved b/bv1/tools/decode-save-debug
index 16de45a..16de45a 100755
--- a/bv1/tools/d-saved
+++ b/bv1/tools/decode-save-debug
diff --git a/bv1/tools/e b/bv1/tools/e
deleted file mode 100755
index a85a767..0000000
--- a/bv1/tools/e
+++ /dev/null
@@ -1,2 +0,0 @@
-#!/bin/fish
-ffmpeg -loglevel quiet -i $argv[1] -vf format=rgb24 -f rawvideo pipe:1 | cargo run --release -- -W 1920 -H 1080 encode $argv[2..]
diff --git a/bv1/tools/e4k b/bv1/tools/e4k
deleted file mode 100755
index 58e0b10..0000000
--- a/bv1/tools/e4k
+++ /dev/null
@@ -1,2 +0,0 @@
-#!/bin/fish
-ffmpeg -loglevel quiet -i $argv[1] -vf format=rgb24 -f rawvideo pipe:1 | cargo run --release -- -W 4096 -H 2160 encode $argv[2..]
diff --git a/bv1/tools/encode b/bv1/tools/encode
new file mode 100755
index 0000000..abab962
--- /dev/null
+++ b/bv1/tools/encode
@@ -0,0 +1,2 @@
+#!/bin/fish
+ffmpeg -loglevel quiet -i $argv[1] -vf scale=1920x1080,format=rgb24 -f rawvideo pipe:1 | cargo run --release -- -W 1920 -H 1080 encode $argv[2..]
diff --git a/readme.md b/readme.md
index a32a8a1..c1287b9 100644
--- a/readme.md
+++ b/readme.md
@@ -2,22 +2,19 @@
 
 My experiments on lossy video compression.
 
-## `bv1`
-
-A somewhat minimal video codec that is able to achieve quality comparable to
-H.264.
-
 ## Other codecs
 
+- `bv1` A somewhat minimal video codec that is also the best one i could come up
+  with.
 - `evc` is my first proper attempt at video compression. features motion
   compensation and broken dct.
-- `vgcodec` approximates images by drawing circles (on the GPU).
+- `vgcodec` approximates images by drawing circles (on the GPU) (which doesnt
+  work well).
 - (`dhwt-codec` tries to compress using a discrete haar wavelet across all three
-  dimensions. that doesnt work well)
+  dimensions. which doesnt work well either)
 
-## the test framework
+## Trying it out
 
-| Variable   | Description  |
-| ---------- | ------------ |
-| `V_WIDTH`  | Video width  |
-| `V_HEIGHT` | Video height |
+- `cd bv1`
+- Run `./tools/encode sample-video.mkv | ./tools/decode-display` (or
+  decode-display-debug to show debug overlay)