Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxim-zhao/bmp2tilecompressors
Compression DLLs for BMP2Tile
https://github.com/maxim-zhao/bmp2tilecompressors
compression-implementations graphics sega-game-gear sega-master-system z80
Last synced: 3 months ago
JSON representation
Compression DLLs for BMP2Tile
- Host: GitHub
- URL: https://github.com/maxim-zhao/bmp2tilecompressors
- Owner: maxim-zhao
- License: mit
- Created: 2014-08-14T12:44:46.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T11:59:29.000Z (6 months ago)
- Last Synced: 2024-10-14T15:11:06.916Z (3 months ago)
- Topics: compression-implementations, graphics, sega-game-gear, sega-master-system, z80
- Language: C
- Homepage:
- Size: 2.88 MB
- Stars: 24
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
bmp2tile-compressors
====================
Compression DLLs for [BMP2Tile](https://github.com/maxim-zhao/bmp2tile)
[](https://ci.appveyor.com/project/maxim-zhao/bmp2tilecompressors)
Overview
----
BMP2Tile supports plug-in compressors, somewhat inspired by Winamp. This repo holds all the ones I've written, plus some that were contributed by others. As far as is possible, I try to also include decompressors for use in homebrew and ROM hacks.
Releases
----
Automated builds are available on the [Releases page](https://github.com/maxim-zhao/bmp2tilecompressors/releases).
Compressors
----
| DLL name | Short name | Longer name | Description | Tiles supported | Tilemap supported |
|:---------|:------------|:------------|:------------|:-----:|:-------:|
| 1bppraw | 1bpp | 1bpp raw (uncompressed) binary | One bit per pixel tiles - discards upper bits | ✅ | |
| 2bppraw | 2bpp | 2bpp raw (uncompressed) binary | Two bits per pixel tiles - discards upper bits | ✅ | |
| 3bppraw | 3bpp | 3bpp raw (uncompressed) binary | Three bits per pixel tiles - discards upper bit | ✅ | |
| aPLib | aPLib | aPLib | [aPLib](http://ibsensoftware.com/products_aPLib.html) compression library | ✅ | ✅ |
| apultra | apultra | aPLib (apultra) | [apultra](https://github.com/emmanuel-marty/apultra) aPLib compressor - better compression for the same format | ✅ | ✅ |
| berlinwall | berlinwallcompr | Berlin Wall LZ | Compression from the game [The Berlin Wall](http://www.smspower.org/Games/BerlinWall-GG) | ✅ | ✅ |
| exe | (configurable) | (configurable) | Wraps arbitrary external programs, passing data via files. This is useful if you do not want to implement your algorithm in the form of a DLL. | ✅ | ✅ |
| exomizerv2 | exomizer | Exomizer v2 | [Exomizer](https://bitbucket.org/magli143/exomizer/wiki/Home) v2 compression ⚠ Seems to crash on some inputs | ✅ | ✅ |
| highschoolkimengumi | hskcompr | High School Kimengumi RLE | Compression from the game [High School! Kimengumi](http://www.smspower.org/Games/HighSchoolKimengumi-SMS) | ✅ | ✅ |
| lemmings | lemmingscompr | Lemmings RLE | Compression from the game [Lemmings](http://www.smspower.org/Games/Lemmings-SMS) | ✅ | ✅ |
| lsb | lsbtilemap | LSB-only tilemap | Least significant byte of tilemap data | | ✅ |
| lz4 | lz4 | LZ4 (raw) | [LZ4](http://www.lz4.org/) compression library, using [smallz4](https://create.stephan-brumme.com/smallz4/). [lz4ultra](https://github.com/emmanuel-marty/lz4ultra) has negligibly different results. | ✅ | ✅ |
| lzsa1 | lzsa1 | LZSA1 | [LZSA](https://github.com/emmanuel-marty/lzsa) compression library | ✅ | ✅ |
| lzsa2 | lzsa2 | LZSA2 | [LZSA](https://github.com/emmanuel-marty/lzsa) compression library | ✅ | ✅ |
| magicknight | mkre2compr | Magic Knight Rayearth 2 RLE or LZ | Compressor from the game [魔法騎士レイアース２ ～making of magic knight～](https://www.smspower.org/Games/MagicKnightRayearth2-GG) | ✅ | |
| oapack | oapack | aPLib (oapack) | [oapack](https://gitlab.com/eugene77/oapack) aPLib compressor - better compression for the same format | ✅ | ✅ |
| phantasystar | pscompr | Phantasy Star RLE | Compression from the game [Phantasy Star](http://www.smspower.org/Games/PhantasyStar-SMS) | ✅ | ✅ |
| psgaiden | psgcompr | PS Gaiden | Compression from the game [Phantasy Star Gaiden](http://www.smspower.org/Games/PhantasyStarGaiden-GG) | ✅ | |
| pucrunch | pucrunch | Pucrunch | [Pucrunch](http://a1bert.kapsi.fi/Dev/pucrunch/) algorithm | ✅ | ✅ |
| raw | bin | Raw (uncompressed) binary | Does no compression at all | ✅ | ✅ |
| shrinkler | shrinkler | Shrinkler | [Shrinkler](https://github.com/askeksa/Shrinkler) Amiga executable compressor | ✅ | ✅ |
| sonic1 | soniccompr | Sonic 1 | Tile compression from the game [Sonic the Hedgehog](http://www.smspower.org/Games/SonicTheHedgehog-SMS) | ✅ | |
| sonic2 | sonic2compr | Sonic 2 | Tile compression from the game [Sonic the Hedgehog 2](http://www.smspower.org/Games/SonicTheHedgehog2-SMS) | ✅ | |
| stc0 | stc0compr | Simple Tile Compression 0 | @sverx's [stc0](https://github.com/sverx/stc0) | ✅ | |
| upkr | upkr | upkr | [Simple lz + arithmetic coding packer](https://github.com/exoticorn/upkr) | ✅ | ✅ |
| wonderboy | wbcompr | Wonder Boy RLE | Compression from the game [Wonder Boy](http://www.smspower.org/Games/WonderBoy-SMS) | ✅ | |
| zx0 | zx0 | ZX0 | [ZX0](https://github.com/einar-saukas/ZX0) compression library | ✅ | ✅ |
| zx7 | zx7 | ZX7 (8-bit limited) | Variant of [ZX7](http://www.worldofspectrum.org/infoseekid.cgi?id=0027996) compression library tweaked for performance | ✅ | ✅ |
Decompressors
----
All size stats are for emitting data direct to VRAM on Master System, using Z80 decompressors in non-interrupt-safe mode if available. Decompression to RAM will generally use less ROM.
| Description | ROM (bytes) | RAM (bytes, not including stack) | Performance relative to "zip" | Interrupt-safe | Non-VRAM support |
|:-------------------------|------------:|---------------------------------:|------------------------------:|:--------------:|:----------------:|
| aPLib | 303 | 5 | 96% | ❌ | ✅ |
| aPLib (fast) | 341 | 0 | 96% | ❌ | ✅ |
| Berlin Wall | 241 | 265 | 74% | ❌ | ❌ |
| Exomizer v2 (⚠ Broken) | 208 | 156 | | ❌ | ✅ |
| High School Kimengumi (unoptimised) | 119 | 4 | 67% | ❌ | ❌ |
| Lemmings (unoptimised) | 143 | 512 | 65% | ❌ | ❌ |
| LZ4 | 136 | 0 | 69% | ❌ | ❌ |
| LZSA1 | 207 | 0 | 79% | ❌ | ✅ |
| LZSA2 | 332 | 0 | 92% | ❌ | ✅ |
| Magic Knight Rayearth 2 | 139 | 0 | 79% | ❌ | ❌ |
| Phantasy Star RLE | 188 | 0 | 66% | ✅ | ❌ |
| PS Gaiden | 223 | 34 | 94% | ❌ | ❌ |
| PS Gaiden (fast) | 1028 | 32 | 94% | ❌ | ❌ |
| Pucrunch (⚠ Broken) | 412 | 44 | | ❌ | ❌ |
| Shrinkler | 259 | 2048 | 106% | ❌ | ✅ |
| Sonic | 162 | 8 | 60% | ❌ | ❌ |
| Sonic 2 | 289 | 39 | 53% | ❌ | ❌ |
| Simple tile Compression 0 | 57 | 0 | 59% | ❌ | ❌ |
| upkr | 226 | 321 | 108% | ❌ | ❌ |
| Wonder Boy | 73 | 0 | 50% | ❌ | ❌ |
| ZX0 | 157 | 0 | 98% | ❌ | ✅ |
| ZX0 (fast) | 274 | 0 | 98% | ❌ | ✅ |
| ZX7 | 117 | 0 | 91% | ✅ | ✅ |
Note that the technologies marked with ⚠ above fail the automated benchmark tests, with crashes in the compressor or incorrect decompressed output.
They could be fixed but as they are rather old, they are probably not competitive with newer compressors.
"zip" performance is compressing the data using `7z a -mx9 filename.zip`. Zip has some framing overhead but it would be unfeasible to implement a decompressor on Master System. We compute the mean compression ratio of this on the test coprpus, and then compare the compressors' mean ratio, so that >100% means they compress better, and 50% means they compress to double the size on average.
Interrupt-safe decompressors can run safely while interrupts are happening and interfering with the VDP state.
This will introduce some overhead - if nothing else, they need to disable interrupts - and they will therefore also change the interrupts enabled state.
Some compressors have assembly-time definitions to switch between decompressing directly to VRAM on SMS and decompressing to RAM.
Benchmark
----
Based on a benchmark corpus made of tilesets and title screens, here's a scatter of the results.
How to read:
- Further to the right is faster
- Further up is better compression
- 60% compression means that the compressed data is 40% of the size of the uncompressed data (for example)
- The scatter for a particular colour group is across a corpus of realistic Master System tile data
- Each colour group has a larger point showing the mean result across the corpus, with error bars showing one standard deviation.
- There are lines showing the mean performance of zip and 7z on the same corpus.
- There are two reference points to show the performance of loading uncompressed data, via the simplest and fastest methods.
There can be wide variation in performance between compressors depending on your data; you may want to try a few options for your specific use case.
Other compressors
----
Here's some other compressors people have made.
| Name | Link | Description | Tiles supported | Tilemap supported |
|:-----|:-----|:------------|:---------------:|:-----------------:|
| ShrunkTileMap | https://github.com/sverx/STMcomp | Compresses tilemaps with specific support for sequential tile indices | | ✅ |