diff --git a/lzss.baku.asm b/lzss.baku.asm index ec81ba1..60845ef 100644 --- a/lzss.baku.asm +++ b/lzss.baku.asm @@ -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 diff --git a/lzss.baku.unsafe.asm b/lzss.baku.unsafe.asm index 461fd9f..884dafb 100644 --- a/lzss.baku.unsafe.asm +++ b/lzss.baku.unsafe.asm @@ -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