C# Class BitMiracle.LibTiff.Classic.TiffCodec

Base class for all codecs within the library.

A codec is a class that implements decoding, encoding, or decoding and encoding of a compression algorithm.

The library provides a collection of builtin codecs. More codecs may be registered through calls to the library and/or the builtin implementations may be overridden.

Show file Open project: Core-Techs/TiffLibrary Class Usage Examples

Protected Properties

Property	Type	Description
m_name	string
m_scheme	Compression
m_tif	Tiff

Public Methods

Method	Description
Cleanup ( ) : void	Cleanups the state of the codec. Cleanup is called when codec is no longer needed (won't be used) and can be used for example to restore tag methods that were substituted.
Close ( ) : void	Flushes any internal data buffers and terminates current operation.
DecodeRow ( byte buffer, int offset, int count, short plane ) : bool	Decodes one row of image data.
DecodeStrip ( byte buffer, int offset, int count, short plane ) : bool	Decodes one strip of image data.
DecodeTile ( byte buffer, int offset, int count, short plane ) : bool	Decodes one tile of image data.
DefStripSize ( int size ) : int	Calculates and/or constrains a strip size.
DefTileSize ( int &width, int &height ) : void	Calculate and/or constrains a tile size
EncodeRow ( byte buffer, int offset, int count, short plane ) : bool	Encodes one row of image data.
EncodeStrip ( byte buffer, int offset, int count, short plane ) : bool	Encodes one strip of image data.
EncodeTile ( byte buffer, int offset, int count, short plane ) : bool	Encodes one tile of image data.
Init ( ) : bool	Initializes this instance.
PostEncode ( ) : bool	Performs any actions after encoding required by the codec. PostEncode is called after encoding and can be used to release any external resources needed during encoding.
PreDecode ( short plane ) : bool	Prepares the decoder part of the codec for a decoding. PreDecode is called after SetupDecode and before decoding.
PreEncode ( short plane ) : bool	Prepares the encoder part of the codec for a encoding. PreEncode is called after SetupEncode and before encoding.
Seek ( int row ) : bool	Seeks the specified row in the strip being processed.
SetupDecode ( ) : bool	Setups the decoder part of the codec. SetupDecode is called once before PreDecode.
SetupEncode ( ) : bool	Setups the encoder part of the codec. SetupEncode is called once before PreEncode.
TiffCodec ( Tiff tif, Compression scheme, string name )	Initializes a new instance of the TiffCodec class.

Private Methods

Method	Description
noDecode ( string method ) : bool
noEncode ( string method ) : bool

Method Details

Cleanup() public method

Cleanups the state of the codec.

Cleanup is called when codec is no longer needed (won't be used) and can be used for example to restore tag methods that were substituted.

public Cleanup ( ) : void
return	void

Close() public method

Flushes any internal data buffers and terminates current operation.

public Close ( ) : void
return	void

DecodeRow() public method

Decodes one row of image data.

public DecodeRow ( byte buffer, int offset, int count, short plane ) : bool
buffer	byte	The buffer to place decoded image data to.
offset	int	The zero-based byte offset in at /// which to begin storing decoded bytes.
count	int	The number of decoded bytes that should be placed /// to .
plane	short	The zero-based sample plane index.
return	bool

DecodeStrip() public method

Decodes one strip of image data.

public DecodeStrip ( byte buffer, int offset, int count, short plane ) : bool
buffer	byte	The buffer to place decoded image data to.
offset	int	The zero-based byte offset in at /// which to begin storing decoded bytes.
count	int	The number of decoded bytes that should be placed /// to .
plane	short	The zero-based sample plane index.
return	bool

DecodeTile() public method

Decodes one tile of image data.

public DecodeTile ( byte buffer, int offset, int count, short plane ) : bool
buffer	byte	The buffer to place decoded image data to.
offset	int	The zero-based byte offset in at /// which to begin storing decoded bytes.
count	int	The number of decoded bytes that should be placed /// to .
plane	short	The zero-based sample plane index.
return	bool

DefStripSize() public method

Calculates and/or constrains a strip size.

public DefStripSize ( int size ) : int
size	int	The proposed strip size (may be zero or negative).
return	int

DefTileSize() public method

Calculate and/or constrains a tile size

public DefTileSize ( int &width, int &height ) : void
width	int	The proposed tile width upon the call / tile width to use after the call.
height	int	The proposed tile height upon the call / tile height to use after the call.
return	void

EncodeRow() public method

Encodes one row of image data.

public EncodeRow ( byte buffer, int offset, int count, short plane ) : bool
buffer	byte	The buffer with image data to be encoded.
offset	int	The zero-based byte offset in at /// which to begin read image data.
count	int	The maximum number of encoded bytes that can be placed /// to .
plane	short	The zero-based sample plane index.
return	bool

EncodeStrip() public method

Encodes one strip of image data.

public EncodeStrip ( byte buffer, int offset, int count, short plane ) : bool
buffer	byte	The buffer with image data to be encoded.
offset	int	The zero-based byte offset in at /// which to begin read image data.
count	int	The maximum number of encoded bytes that can be placed /// to .
plane	short	The zero-based sample plane index.
return	bool

EncodeTile() public method

Encodes one tile of image data.

public EncodeTile ( byte buffer, int offset, int count, short plane ) : bool
buffer	byte	The buffer with image data to be encoded.
offset	int	The zero-based byte offset in at /// which to begin read image data.
count	int	The maximum number of encoded bytes that can be placed /// to .
plane	short	The zero-based sample plane index.
return	bool

Init() public method

Initializes this instance.

public Init ( ) : bool
return	bool

PostEncode() public method

Performs any actions after encoding required by the codec.

PostEncode is called after encoding and can be used to release any external resources needed during encoding.

public PostEncode ( ) : bool
return	bool

PreDecode() public method

Prepares the decoder part of the codec for a decoding.

PreDecode is called after SetupDecode and before decoding.

public PreDecode ( short plane ) : bool
plane	short	The zero-based sample plane index.
return	bool

PreEncode() public method

Prepares the encoder part of the codec for a encoding.

PreEncode is called after SetupEncode and before encoding.

public PreEncode ( short plane ) : bool
plane	short	The zero-based sample plane index.
return	bool

Seek() public method

Seeks the specified row in the strip being processed.

public Seek ( int row ) : bool
row	int	The row to seek.
return	bool

SetupDecode() public method

Setups the decoder part of the codec.

SetupDecode is called once before PreDecode.

public SetupDecode ( ) : bool
return	bool

SetupEncode() public method

Setups the encoder part of the codec.

SetupEncode is called once before PreEncode.

public SetupEncode ( ) : bool
return	bool

TiffCodec() public method

Initializes a new instance of the TiffCodec class.

public TiffCodec ( Tiff tif, Compression scheme, string name )
tif	Tiff	An instance of class.
scheme	Compression	The compression scheme for the codec.
name	string	The name of the codec.

Property Details

m_name protected property

Codec name.

protected string m_name
return	string

m_scheme protected property

Compression scheme this codec impelements.

protected Compression m_scheme
return	Compression

m_tif protected property

An instance of Tiff.

protected Tiff,BitMiracle.LibTiff.Classic m_tif
return	Tiff