Static Public Member Functions

Celartem::DjVu::DeflateStream Class Reference

#include <djv_compressStream.h>

Inheritance diagram for Celartem::DjVu::DeflateStream:
Inheritance graph
[legend]

List of all members.

Static Public Member Functions

static AutoPtr< DeflateStreamcreate (Stream *inStream, size_t inInternalBufferSize=1024, size_t inZPBlockSize=16)

Detailed Description

Class used to compress data. This class is usually used to encode DjVu files. This implementation uses ZPCodec.


Member Function Documentation

static AutoPtr<DeflateStream> Celartem::DjVu::DeflateStream::create ( Stream inStream,
size_t  inInternalBufferSize = 1024,
size_t  inZPBlockSize = 16 
) [static]

Creates a DeflateStream instance.

Parameters:
inStream Stream containing data to compress.
inInternalBufferSize Specifies the size of the internal buffer contained in the DeflateStream. It must be a positive number between 10 and 4096.
The larger value results in better compression ratio but comsumes more computation time.
There is no need to specify a block size larger than the total number of bytes to compress.
inZPBlockSize Specifies the size of the internal buffer that the ZPCodec uses.
The larger value results in better speed but comsumes more memory.
Returns:
Pointer to the newly created instance of DeflateStream.

The documentation for this class was generated from the following file:

This document is made with doxygen 1.7.1 at Thu Feb 17 2011 15:40:20.
Caminova Logo