Static Public Member Functions | List of all members
Celartem::DjVu::DeflateStream Class Reference

#include <djv_compressStream.h>

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

Static Public Member Functions

static AutoPtr< DeflateStreamcreate (Stream *inStream, size_t inInternalBufferSize=1024, size_t inZPBlockSize=16)
 
- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()
 

Additional Inherited Members

- Public Member Functions inherited from Celartem::Stream
virtual size_t readBytes (void *buffer, size_t inSize, bool wouldBlock=false)=0
 
virtual void writeBytes (const void *buffer, size_t inSize)=0
 
virtual void flushBuffer ()=0
 
virtual bool isEof () const =0
 
virtual size_t duplicateStream (Stream *inStream, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
 
virtual size_t duplicateStreamBytes (Stream *inStream, size_t inMaximumByteSize, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
 
- Public Member Functions inherited from Celartem::Referable
 Referable ()
 
void addRef () const
 
void releaseRef () const
 
size_t getReferenceCount () const
 
- Public Member Functions inherited from Celartem::Lockable
virtual void lock () const =0
 
virtual void unlock () const =0
 

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
inStreamStream containing data to compress.
inInternalBufferSizeSpecifies 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.
inZPBlockSizeSpecifies 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:

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:07.
Cuminas Logo