add notes to the decompressors

This commit is contained in:
Connor Olding 2018-08-19 00:33:54 +02:00
parent b2af69b7a0
commit 1ec9bb6596
2 changed files with 14 additions and 0 deletions

View file

@ -1,3 +1,7 @@
// a decompressor for the variant of LZSS used by Bomberman 64.
// a matching compressor is available here:
// https://github.com/notwa/baku/blob/master/compressor.c
LzDecomp:
// a0: pointer to compressed data (must be RDRAM, cart is unsupported)
// a1: compressed size

View file

@ -1,3 +1,13 @@
// a decompressor for the variant of LZSS used by Bomberman 64.
// a matching compressor is available here:
// https://github.com/notwa/baku/blob/master/compressor.c
// this unsafe variant assumes that:
// * the 0x400 bytes before the destination are readable and null
// * the input data ends exactly where it is expected to
// * the input data writes exactly as many bytes as expected
// the performance gain over the safe variant is around 38%.
LzDecomp:
// a0: pointer to compressed data (must be RDRAM, cart is unsupported)
// a1: compressed size