update readme; fix tests

Author: adusachev

README.md

@@ -1,35 +1,67 @@
 
 [![Build Status](https://github.com/adusachev/QOI-image-compression/actions/workflows/testing.yml/badge.svg)](https://github.com/adusachev/QOI-image-compression/actions/workflows/testing.yml)
 
+
 # QOI image compression
 
 Python implementation of QOI encoder and decoder
 
 QOI format: https://qoiformat.org/
 
+## Installation
 
-## Usage
-
-**1) Encode single .png image and save .qoi image**
+```
+git clone https://github.com/adusachev/QOI-image-compression.git
+```
 
-At the end of `qoi_encoder.py` enter path to .png image and run: 
 ```
-python3 qoi_encoder.py
+python setup.py install
 ```
 
 
-**2) Decode single .qoi image**
+## Usage
 
-At the end of `qoi_decoder.py` enter path to .qoi image and run: 
-```
-python3 qoi_decoder.py
+
+1) Encode: convert png image to qoi image
+```python
+from qoi_compress import qoi_encoder
+
+png_file = "./png_images/doge.png"
+qoi_file = "./qoi_images/doge.qoi"  # where to save qoi image
+
+qoi_encoder.run_encoder(png_file, qoi_file)
 ```
 
+2) Decode: import .qoi file into numpy array
+```python
+from qoi_compress import qoi_decoder
 
-**3) Encode and decode all .png images in some directory, compare decoded .qoi image with original .png image**
+qoi_file = "./qoi_images/doge.qoi"
 
-At the end of `main.py` choose `dir_with_png` and uncomment line with `run_multiple_experiments(dir_with_png)`, then run:
+img_decoded, time_elapsed = qoi_encoder.run_decoder(qoi_file)
+img_decoded
 ```
-python3 main.py
+
+3) Test: encode image `png_file` and save it as `qoi_file`, then decode `qoi_file` and compare decoded qoi image with original png image
+```python
+from qoi_compress.main import run_single_experiment
+
+png_file = "./png_images/doge.png"
+qoi_file = "./qoi_images/doge.qoi"
+
+run_single_experiment(png_file, qoi_file)
 ```
 
+
+## Benchmarks
+
+| Image size | Encoding time | Decoding time | Compression ratio |
+| ---------- | ------------- | ------------- | ----------------- |
+| 460x460    | 0.7 sec       | 0.3 sec       | 2.2               |
+| 1920x1080  | 5.5 sec       | 2.5 sec       | 2.56              |
+| 3840x2400  | 42 sec        | 19 sec        | 1.83              | 
+
+
+## TODO
+
+Add support for RGBA images

tests/test_qoi_full.py

@@ -2,23 +2,26 @@
 from pathlib import Path
 import unittest
 import numpy as np
-
 from qoi_compress.qoi_decoder import run_decoder
 from qoi_compress.qoi_encoder import run_encoder
 from qoi_compress.read_png import read_png
 
 
 BASE_DIR = Path(__file__).resolve().parent.parent
 
+if not os.path.exists(BASE_DIR / "qoi_images"):
+    os.mkdir(BASE_DIR / "qoi_images")
+
 
 class TestQOI(unittest.TestCase):
 
     def test_single_image(self):
 
         png_filename = str(BASE_DIR / "png_images/R_video.png")
+        qoi_filename = str(BASE_DIR / "qoi_images/R_video.qoi")
 
         # encoding
-        qoi_filename, _ = run_encoder(png_filename)
+        qoi_filename, _ = run_encoder(png_filename, qoi_filename)
 
         # decoding
         img_decoded, _ = run_decoder(qoi_filename)
@@ -32,20 +35,23 @@ def test_single_image(self):
 
     def test_multiple_images(self):
 
-        dir_with_png = str(BASE_DIR / "png_images/")
+        dir_with_png = str(BASE_DIR / "png_images")
+        dir_with_qoi = str(BASE_DIR / "qoi_images")
 
-        for name in os.listdir(dir_with_png):
-            if Path(name).suffix == ".png":
-                png_filename = os.path.join(dir_with_png, name)
+        for filename in os.listdir(dir_with_png):
+            if Path(filename).suffix == ".png":
+                name = Path(filename).stem
+                png_file = os.path.join(dir_with_png, filename)
+                qoi_file = os.path.join(dir_with_qoi, f"{name}.qoi")
 
                 # encoding
-                qoi_filename, _ = run_encoder(png_filename)
+                qoi_filename, _ = run_encoder(png_file, qoi_file)
 
                 # decoding
-                img_decoded, _ = run_decoder(qoi_filename)
+                img_decoded, _ = run_decoder(qoi_file)
 
                 # compare with original image
-                orig_img, _, _, _ = read_png(png_filename)
+                orig_img, _, _, _ = read_png(png_file)
 
                 self.assertTrue(np.all(img_decoded == orig_img), 
                         f"Decoding of image {qoi_filename} failed at indexes {np.where(img_decoded != orig_img)[0]}")