Codec specialized in images loaded using FreeImage. More...

#include <OgreFreeImageCodec.h>

Inheritance diagram for Ogre::FreeImageCodec:

Collaboration diagram for Ogre::FreeImageCodec:

Public Types
typedef SharedPtr< CodecData >	CodecDataPtr

typedef ConstMapIterator < CodecList >	CodecIterator

typedef std::pair < MemoryDataStreamPtr, CodecDataPtr >	DecodeResult
	Result of a decoding; both a decoded data stream and CodecData metadata. More...

Public Member Functions
	FreeImageCodec (const String &type, unsigned int fiType)

virtual	~FreeImageCodec ()

DecodeResult	decode (DataStreamPtr &input) const
	Codes the data from the input chunk into the output chunk. More...

DataStreamPtr	encode (MemoryDataStreamPtr &input, CodecDataPtr &pData) const
	Codes the data in the input stream and saves the result in the output stream. More...

void	encodeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const
	Codes the data in the input chunk and saves the result in the output filename provided. More...

String	getDataType () const
	Returns the type of the data that supported by this codec as a String. More...

virtual String	getType () const
	Returns the type of the codec as a String. More...

virtual bool	magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
	Returns whether a magic number header matches this codec. More...

String	magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const
	Maps a magic number header to a file extension, if this codec recognises it. More...

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

Static Public Member Functions
static Codec *	getCodec (const String &extension)
	Gets the codec registered for the passed in file extension. More...

static Codec *	getCodec (char *magicNumberPtr, size_t maxbytes)
	Gets the codec that can handle the given 'magic' identifier. More...

static CodecIterator	getCodecIterator (void)
	Gets the iterator for the registered codecs. More...

static StringVector	getExtensions (void)
	Gets the file extension list for the registered codecs. More...

static bool	isCodecRegistered (const String &codecType)
	Return whether a codec is registered already. More...

static void	registerCodec (Codec *pCodec)
	Registers a new codec in the database. More...

static void	shutdown (void)
	Static method to shutdown FreeImage and unregister the FreeImage codecs. More...

static void	startup (void)
	Static method to startup FreeImage and register the FreeImage codecs. More...

static void	unregisterCodec (Codec *pCodec)
	Unregisters a codec from the database. More...

Protected Types
typedef map< String, Codec * > ::type	CodecList

Static Protected Attributes
static CodecList	msMapCodecs
	A map that contains all the registered codecs. More...

Private Types
typedef list< ImageCodec * >::type	RegisteredCodecList

Private Member Functions
FIBITMAP *	encodeBitmap (MemoryDataStreamPtr &input, CodecDataPtr &pData) const
	Common encoding routine. More...

Private Attributes
unsigned int	mFreeImageType

String	mType

Static Private Attributes
static RegisteredCodecList	msCodecList

Detailed Description

Codec specialized in images loaded using FreeImage.

Remarks: The users implementing subclasses of ImageCodec are required to return a valid pointer to a ImageData class from the decode(...) function.

Definition at line 48 of file OgreFreeImageCodec.h.

Member Typedef Documentation

typedef SharedPtr<CodecData> Ogre::Codec::CodecDataPtr

inherited

Definition at line 74 of file OgreCodec.h.

typedef ConstMapIterator<CodecList> Ogre::Codec::CodecIterator

inherited

Definition at line 76 of file OgreCodec.h.

typedef map< String, Codec* >::type Ogre::Codec::CodecList

protectedinherited

Definition at line 59 of file OgreCodec.h.

typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> Ogre::Codec::DecodeResult

inherited

Result of a decoding; both a decoded data stream and CodecData metadata.

Definition at line 141 of file OgreCodec.h.

typedef list<ImageCodec*>::type Ogre::FreeImageCodec::RegisteredCodecList

private

Definition at line 54 of file OgreFreeImageCodec.h.

Constructor & Destructor Documentation

Ogre::FreeImageCodec::FreeImageCodec	(	const String &	type,
		unsigned int	fiType
	)

virtual Ogre::FreeImageCodec::~FreeImageCodec ( )

inlinevirtual

Definition at line 62 of file OgreFreeImageCodec.h.

Member Function Documentation

DecodeResult Ogre::FreeImageCodec::decode ( DataStreamPtr & input ) const

virtual

Codes the data from the input chunk into the output chunk.

Parameters

input Stream containing the encoded data

Implements Ogre::Codec.

DataStreamPtr Ogre::FreeImageCodec::encode	(	MemoryDataStreamPtr &	input,
		CodecDataPtr &	pData
	)		const

virtual

Codes the data in the input stream and saves the result in the output stream.

Implements Ogre::Codec.

FIBITMAP* Ogre::FreeImageCodec::encodeBitmap	(	MemoryDataStreamPtr &	input,
		CodecDataPtr &	pData
	)		const

private

Common encoding routine.

void Ogre::FreeImageCodec::encodeToFile	(	MemoryDataStreamPtr &	input,
		const String &	outFileName,
		CodecDataPtr &	pData
	)		const

virtual

Codes the data in the input chunk and saves the result in the output filename provided.

Provided for efficiency since coding to memory is progressive therefore memory required is unknown leading to reallocations.

Parameters

input	The input data
outFileName	The filename to write to
pData	Extra information to be passed to the codec (codec type specific)

Implements Ogre::Codec.

static Codec* Ogre::Codec::getCodec ( const String & extension )

staticinherited

Gets the codec registered for the passed in file extension.

static Codec* Ogre::Codec::getCodec	(	char *	magicNumberPtr,
		size_t	maxbytes
	)

staticinherited

Gets the codec that can handle the given 'magic' identifier.

Parameters

magicNumberPtr	Pointer to a stream of bytes which should identify the file. Note that this may be more than needed - each codec may be looking for a different size magic number.
maxbytes	The number of bytes passed

static CodecIterator Ogre::Codec::getCodecIterator ( void )

inlinestaticinherited

Gets the iterator for the registered codecs.

Definition at line 108 of file OgreCodec.h.

String Ogre::ImageCodec::getDataType ( ) const

inlinevirtualinherited

Returns the type of the data that supported by this codec as a String.

Implements Ogre::Codec.

Definition at line 79 of file OgreImageCodec.h.

static StringVector Ogre::Codec::getExtensions ( void )

staticinherited

Gets the file extension list for the registered codecs.

virtual String Ogre::FreeImageCodec::getType ( ) const

virtual

Returns the type of the codec as a String.

Implements Ogre::Codec.

static bool Ogre::Codec::isCodecRegistered ( const String & codecType )

inlinestaticinherited

Return whether a codec is registered already.

Definition at line 95 of file OgreCodec.h.

virtual bool Ogre::Codec::magicNumberMatch	(	const char *	magicNumberPtr,
		size_t	maxbytes
	)		const

inlinevirtualinherited

Returns whether a magic number header matches this codec.

Parameters

magicNumberPtr	Pointer to a stream of bytes which should identify the file. Note that this may be more than needed - each codec may be looking for a different size magic number.
maxbytes	The number of bytes passed

Definition at line 161 of file OgreCodec.h.

String Ogre::FreeImageCodec::magicNumberToFileExt	(	const char *	magicNumberPtr,
		size_t	maxbytes
	)		const

virtual

Maps a magic number header to a file extension, if this codec recognises it.

Parameters

magicNumberPtr	Pointer to a stream of bytes which should identify the file. Note that this may be more than needed - each codec may be looking for a different size magic number.
maxbytes	The number of bytes passed

Returns: A blank string if the magic number was unknown, or a file extension.

Implements Ogre::Codec.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

static void Ogre::Codec::registerCodec ( Codec * pCodec )

inlinestaticinherited

Registers a new codec in the database.

Definition at line 83 of file OgreCodec.h.

References Ogre::Exception::ERR_DUPLICATE_ITEM, Ogre::Codec::getType(), and OGRE_EXCEPT.

static void Ogre::FreeImageCodec::shutdown ( void )

static

Static method to shutdown FreeImage and unregister the FreeImage codecs.

static void Ogre::FreeImageCodec::startup ( void )

static

Static method to startup FreeImage and register the FreeImage codecs.

static void Ogre::Codec::unregisterCodec ( Codec * pCodec )

inlinestaticinherited

Unregisters a codec from the database.

Definition at line 102 of file OgreCodec.h.

References Ogre::Codec::getType().

Member Data Documentation

unsigned int Ogre::FreeImageCodec::mFreeImageType

private

Definition at line 52 of file OgreFreeImageCodec.h.

RegisteredCodecList Ogre::FreeImageCodec::msCodecList

staticprivate

Definition at line 55 of file OgreFreeImageCodec.h.

CodecList Ogre::Codec::msMapCodecs

staticprotectedinherited

A map that contains all the registered codecs.

Definition at line 62 of file OgreCodec.h.

String Ogre::FreeImageCodec::mType

private

Definition at line 51 of file OgreFreeImageCodec.h.

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

OgreFreeImageCodec.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation