JCALG1 r5.21
(c)1999,2000 Jeremy Collake
All Rights Reserved.
http://www.collakesoftware.com
jeremy@collakesoftware.com

This software is provided as-is, without warranty of ANY KIND, either expressed or implied, including but not limited to the implied warranties of merchantability and/or fitness for a particular purpose. The author shall NOT be held liable for ANY damage to you, your computer, or to anyone or anything else, that may result from its use, or misuse. Basically, you use it at YOUR OWN RISK.

License
This library may be used freely in any applications as long as the following to criteria are met:
(a). Notify the author of JCALG1's use and in what application.
(b). Show notification of JCALG1's usage in your program or program documentation along with a link to the authors webpage.

Credits
First of all, I would like to credit Joergen Ibsen, author of apLib, for many suggestions and help with my development of JCALG1. You may notice similarities between the JCALG1 decompressor and that of apLib. The reason for this is because I could not come up with a better encoding scheme than Joergen Ibsen's. So, I must, rightfully, give him credit to developing much of the encoding scheme that JCALG1 uses.

Synopsis
JCALG1 is a fast and tight compression library that can easily be integrated into any application. Written in 100% assembly, compression is fairly fast, and decompression is rapid.

Features

Coded in 100% 32bit x86 assembly language for maximum performance and minimum size.
Excellent compression ratio, typically much better than ZIP's deflate.
Extremely small and fast decompressor. Decompression throughput greater than 13MB/Sec on my PII/450 with 100mhz SDRAM.
Adjustable window size to allow for faster compression at the cost of compression ratio.
Decompression requires no memory, other than the destination buffer of course.
x86 assembly decompressor source code included.
Easy integration with any application.

Specifications

Author: Jeremy Collake
Revision: 5.21
Type: LZSS with Lazy Evaluation, Gamma Encoding, and LOTS of other additions.
Window Size: Variable. Maximum is size of the source data.
Orientation: Binary data.
Compression memory requirement: ((WindowSize+1)*10h)+40000h+WindowSize.
Phrase Search Algorithm: 64k linked lists holding positions of WORDs in window
Decompression memory requirement: None.
Small Decompressor Size: 353 bytes. (could be decreased, I did do some speed optimization).
Fast Decompressor Size: 535 bytes.
Decompression Throughput: Approximatly 13MB/Sec+

Documentation

This is where I tell you what you need to know, ever-so-briefly ;). I decided to document all functions in C, since most people are familar with it. All functions use the STDCALL calling convention (parameters pushed onto stack, called function adjusts stack before return).

DWORD JCALG1_Compress(: void *Source,; DWORD Length,; void *Destination,; DWORD WindowSize,; AllocFunc *pAlloc,; DeAllocFunc *pDealloc,; CallbackFunc *pCallback);

Parameters

Source is a pointer to the uncompressed data.
Length is the size of the uncompressed data.
Destination is a pointer to the destination of the compressed data. This buffer should be at least 4 bytes larger than the uncompressed data size. One can retrieve the minimum needed buffer size by issuing a call to JCALG1_GetNeededBufferSize.
WindowSize is a nonzero value up to the size of the file. The larger, the better the compression ratio but the slower the compression.
pAlloc is a pointer to a memory allocation function. See prototype below.
pDealloc is a pointer to a memory deallocation function. See prototype below.
pCallback is a pointer to a callback function which is called in every iteration of the main compression loop. See protoype below.

Returns: Size of the compressed data, or NULL if the data could not be compressed.

DWORD JCALG1_Decompress_Fast(: void *Source,; void *Destination);
DWORD JCALG1_Decompress_Small(: void *Source,; void *Destination);

Parameters

Source is a pointer to the source data.
Destination is a pointer to the destination buffer for the uncompressed data.

Returns: Size of the uncompressed data or 0 if the block of data was not compressed by JCALG1.

DWORD JCALG1_GetUncompressedSizeOfCompressedBlock(: void *pBlock)

Parameters

pBlock is a pointer to a JCALG1 compressed block of memory.

Returns: Size of the uncompressed block, in bytes.

DWORD JCALG1_GetNeededBufferSize(: DWORD n Size);

Parameters

n Size is size, in bytes, of a block of uncompressed data.

Returns: The minimum destination buffer size (currently nSize+4).

void JCALG1_GetInfo(: _JCALG1_Info *JCALG1_Info);

Parameters

JCALG1_Info is a pointer to a _JCALG1_Info structure.

typedef struct __JCALG1_Info {: DWORD MajorRev;; DWORD MinorRev;; DWORD FastDecompressorSize;; DWORD SmallDecompressorSize;
} _JCALG1_Info;

BOOL CallbackFunc(: DWORD pCurrentSrc,; DWORD pCurrentDest);

Parameters

pCurrentSrc is the relative offset of the current position in the uncompressed data.
pCurrentDest is the relative offset of the current position in the compressed data.

Return: FALSE to stop compression, TRUE to continue compression.

void *AllocFunc(: DWORD Size);

Parameters

Size is the number of bytes requested.

Returns: Pointer to allocated memory block.

BOOL DeallocFunc(: void *pMemory)

Parameters

pMemory is a pointer to the memory block to be deallocated.

Returns: FALSE if failure.