From 9a34e20e71ef82b0ae669848b7222b354e72d154 Mon Sep 17 00:00:00 2001 From: Thomas Spurden Date: Sun, 10 Jan 2021 18:22:22 +0000 Subject: [PATCH] Update readme Add description of decompressing raw captured stream Add info about gbcap verilog testbench --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4884e6a..02cead4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,16 @@ If using a [Papilio Pro] board ./run gbcap build ./papilio-prog/papilio-prog -f build/top.bit - ./recv.py -b 2000000 /dev/ttyUSB1 -o frames + ./recv.py -b 2000000 /dev/ttyUSB1 -o frames.cap + +Captured raw data can be decompressed into images using `decomp_stream.py`: + + ./decomp_stream.py --output-gif frames.gif frames.cap + +The GIFs output from this will be pretty big and unoptimised - try `gifsicle` to +optimise the size, or use `gif2webp` to convert to `webp`. + +There is also an option to output a set of pgm images, one per frame. [papilio pro]: http://papilio.cc/index.php?n=Papilio.PapilioPro @@ -39,3 +48,13 @@ connected to which pins on the Gameboy: Should output the second argument 'abcde' in the example back. If it doesn't then something is wrong! +# Verilog testbench + +Build the verilator testbench: + + ./run gbcap verilator + +Binary will be at `obj_dir/gbcap_tb`. Pipe raw binary into the testbench, it +will output the bytes from the compressor, e.g. + + ./dump_pgm.py *.pgm | ./obj_dir/gbcap_tb > tb.cap -- 2.45.2