Tinytim File Compression Utility v1.0                   31/01/01

Zipped files:

\tinytim
    tiny.exe            Tinytim compression utility, Windows console application
    libtiny.a           Tinytim compression library for Net Yaroze
    libtiny.a.lib       CodeWarrior equivalent of the above
    libtiny.h           header for library
    libtiny.txt         library function information
    readme.txt          this file
\tinytim\source
    zlib.zip            zlib public domain compression library source code
    codecs.tgz          compression source code examples
\tinytim\source\pc
    source code for tiny.exe
\tiny\source\yaroze
    source code for libtiny.a


What it is
Tinytim is a file compression utility designed to allow compression and decompression of file data on the PC and yaroze. Tiny.exe provides compression and decompression on the PC, while the yaroze library libtiny.a provides the same functionality on the playstation.

Tinytim supports two compression types, delate/inflate from the zlib compression library, written by Jean-Loup Gailly and Mark Adler, and huffman compression using code written by David Bourgin. Huffman encoding gives reasonable compression, while zlib is better, more on a par with WinZip, but its memory requirements are greater. Libtiny.txt contains a table of the memory requirements of each library function. Depending on the size of your project you'll need to decide which compression type is right to use. In general huffman compression is better for small projects and zlib better for larger ones.


Installation and use
Place tiny.exe either in the current directory or somewhere along the Path. Beside siocons is ideal.
To use tiny.exe the syntax is:

        tiny <option> <input file> <output file>

the options are:

        -z      zlib compression of input file into output file
        -h      huffman compression of input file into output file
        -d      decompress input file into output file


To install the library, if you use the GCC compiler, put libtiny.a and libtiny.h in your Lib and Include directories, beside libps.a and libps.h. To include the library in compilation, add -ltiny to the GCC command line.

eg      gcc -o main main.c -ltiny

In a make file you can do the same or use a macro instead

eg      LIBS    = -ltiny
        .
        .
        .
        $(CC) $(LINKER) -o $@ $? $(LIBS)


For CodeWarriors, place libtiny.a.lib and libtiny.h in the respective Lib and Include directories, alongside libps.a.lib and libps.h. To include the library in compilation, open up your project in CodeWarrior and either drag and drop the library into it or select from the menus under Project -> Add Files...

For both GCC and CodeWarrior, include the libtiny.h header in your source files to call the library functions. See libtiny.txt for function descriptions.


Source code
The source code to both tiny.exe and the libtiny library are included. The zlib library source used in tiny.exe and libtiny.a I've left in its original zip file as I've only altered one file, zconf.h. In this file I've reduced the compression resolution (MAX_WBITS) from 15 to 13, and memory use (MAX_MEM_LEVEL) from 9 to 5.
The huffman source code I've modified comes from the codecs.tgz file.


That's it from me. Needless to say, if you have any problems with tinytim or have any comments or suggestions, send me an email.

Thanks,

Peter
hanno@btinternet.com


Copyright info
zlib library code:      Deflate code: deflate 1.1.3 Copyright 1995-1998 Jean-loup Gailly
                        Inflate code: inflate 1.1.3 Copyright 1995-1998 Mark Adler
huffman code:           (C) David Bourgin