Public Member Functions | Static Public Member Functions | List of all members
Celartem::DjVu::JBIG2EncodeHelper Class Referenceabstract

#include <djv_jbig2encoder.h>

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

Public Member Functions

virtual void encodeDict (Stream *inStream, const JB2Dictionary *inDict=NULL)=0
 
virtual AutoPtr< ChunkencodeJB2dChunk (const JB2Dictionary *inDict=NULL)=0
 
virtual void encodePage (Stream *inStream, const JB2Page *inPage)=0
 
virtual AutoPtr< ChunkencodeJB2pChunk (const JB2Page *inPage)=0
 
virtual void saveToJBIG2File (Stream *inStream, const JB2Page *inPage)=0
 
- Public Member Functions inherited from Celartem::Referable
 Referable ()
 
void addRef () const
 
void releaseRef () const
 
size_t getReferenceCount () const
 

Static Public Member Functions

static AutoPtr< JBIG2EncodeHelpercreate (bool inUseRefine)
 
- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()
 

Detailed Description

This class provides supplemental functions to encode JBIG2 images.
Please note that the encoder equips only some parts of JBIG2 specification enough to support JBIG2 on DjVu and PDF.

See Also
JB2Page, JBIG2DecodeHelper

Member Function Documentation

static AutoPtr<JBIG2EncodeHelper> Celartem::DjVu::JBIG2EncodeHelper::create ( bool  inUseRefine)
static

Create a JBIG2EncodeHelper instance. This class is used with JB2Page to encode JBIG2 data.

Parameters
inUseRefineAlthough refinement improves JBIG2 compression ratio, it causes crash in Adobe products.
virtual void Celartem::DjVu::JBIG2EncodeHelper::encodeDict ( Stream inStream,
const JB2Dictionary inDict = NULL 
)
pure virtual

Encode JBIG2 dictionary.
This method throws an exception if no dictionary is specified either explicitly or implicitly.

Parameters
inStreamStream write to.
inDictDictionary to write.
If any encodePage calls with a page associated with a dictionary before this call, inDict can be NULL.
virtual AutoPtr<Chunk> Celartem::DjVu::JBIG2EncodeHelper::encodeJB2dChunk ( const JB2Dictionary inDict = NULL)
pure virtual

Encode JBIG2 dictionary (JB2d).
This method throws an exception if no dictionary is specified either explicitly or implicitly.

Parameters
inDictDictionary to write.
If any encodePage calls with a page associated with a dictionary before this call, inDict can be NULL.
Returns
Pointer to a newly created JB2d chunk.
virtual AutoPtr<Chunk> Celartem::DjVu::JBIG2EncodeHelper::encodeJB2pChunk ( const JB2Page inPage)
pure virtual

Encode JBIG2 page (JB2p).

Parameters
inPagePage to encode.
If the page has associated with a dictionary, the dictionary should be also encoded separately.
Returns
Pointer to a newly created JB2p chunk.
virtual void Celartem::DjVu::JBIG2EncodeHelper::encodePage ( Stream inStream,
const JB2Page inPage 
)
pure virtual

Encode JBIG2 page.

Parameters
inStreamStream write to.
inPagePage to encode.
If the page has associated with a dictionary, the dictionary should be also encoded separately.
virtual void Celartem::DjVu::JBIG2EncodeHelper::saveToJBIG2File ( Stream inStream,
const JB2Page inPage 
)
pure virtual

Encode JBIG2 file.

Parameters
inStreamStream write to.
inPagePage to encode.

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