xref: /livemedia/livemedia/packages/clofi

This directory contains the sources of on the fly decompression
support in the lofi(7D) kernel module in OpenSolaris.

To build this you must have the current OpenSolaris source tree
and the SUN Studio compiler installed on your system. These can
be downloaded from www.opensolaris.org . In addition you must
edit the Makefile and set the "OSOL_WS" variable to point to the
root of your OpenSolaris source tree. Subsequently typing a make
will generate 3 binaries:

lofi: This is the modified lofi module and can be copied into
      /kernel/drv

lcompress: This is an utility that compresses a file in a way
      such that it can be decompressed on the fly via the modified
      lofi module. It takes 3 arguments:

	filename - File to compress
	segment size - The file is split into segments of this size
	               and each segment is compressed. This size
	               must be a power of two.
	threshold - The minimum amount by which compression must
	            reduce a segment's size. If after compression
	            the difference between uncompressed size and
	            compressed size is less than this threshold
		    then the segment is stored uncompressed.

      This utility generates a new file named <filename>.zlib

ldecompress: A utility to decompress a file compressed using
      lcompress. This is mainly required for testing/verification.