Ogre::Codec Class Reference

Abstract class that defines a 'codec'. More...

#include <OgreCodec.h>

Inheritance diagram for Ogre::Codec:

Classes
class	CodecData

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
virtual	~Codec ()
virtual DecodeResult	decode (const DataStreamPtr &input) const
virtual void	decode (const DataStreamPtr &input, const Any &output) const
	Codes the data from the input chunk into the output chunk. More...
virtual DataStreamPtr	encode (const Any &input) const
	Codes the input and saves the result in the output stream. More...
virtual DataStreamPtr	encode (const MemoryDataStreamPtr &input, const CodecDataPtr &pData) const
virtual void	encodeToFile (const Any &input, const String &outFileName) const
	Codes the data in the input chunk and saves the result in the output filename provided. More...
virtual void	encodeToFile (const MemoryDataStreamPtr &input, const String &outFileName, const CodecDataPtr &pData) const
virtual String	getDataType () const
virtual String	getType () const =0
	Returns the type of the codec as a String. More...
bool	magicNumberMatch (const char *magicNumberPtr, size_t maxbytes) const
	Returns whether a magic number header matches this codec. More...
virtual String	magicNumberToFileExt (const char *magicNumberPtr, size_t maxbytes) const =0
	Maps a magic number header to a file extension, if this codec recognises it. More...

Static Public Member Functions
static Codec *	getCodec (char *magicNumberPtr, size_t maxbytes)
	Gets the codec that can handle the given 'magic' identifier. More...
static Codec *	getCodec (const String &extension)
	Gets the codec registered for the passed in file extension. More...
static CodecIterator	getCodecIterator (void)
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	unregisterCodec (Codec *pCodec)
	Unregisters a codec from the database. More...

Detailed Description

Abstract class that defines a 'codec'.

Remarks

A codec class works like a two-way filter for data - data entered on one end (the decode end) gets processed and transformed into easily usable data while data passed the other way around codes it back.

The codec concept is a pretty generic one - you can easily understand how it can be used for images, sounds, archives, even compressed data.

Member Typedef Documentation

CodecDataPtr

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

CodecIterator

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

DecodeResult

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

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

Constructor & Destructor Documentation

~Codec()

virtual Ogre::Codec::~Codec ( )

virtual

Member Function Documentation

registerCodec()

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

static

Registers a new codec in the database.

isCodecRegistered()

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

inlinestatic

Return whether a codec is registered already.

unregisterCodec()

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

inlinestatic

Unregisters a codec from the database.

References getType().

getCodecIterator()

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

inlinestatic

Deprecated:

use getExtensions()

getExtensions()

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

static

Gets the file extension list for the registered codecs.

getCodec() [1/2]

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

static

Gets the codec registered for the passed in file extension.

getCodec() [2/2]

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

static

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

encode() [1/2]

virtual DataStreamPtr Ogre::Codec::encode ( const Any &  input ) const

virtual

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

Reimplemented in Ogre::ImageCodec.

encode() [2/2]

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

inlinevirtual

Deprecated:

Reimplemented in Ogre::FreeImageCodec, and Ogre::STBIImageCodec.

References encode().

Referenced by encode().

encodeToFile() [1/2]

virtual void Ogre::Codec::encodeToFile ( const Any &  input, const String &  outFileName  ) 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 (codec type specific)
outFileName	The filename to write to

Reimplemented in Ogre::ImageCodec.

encodeToFile() [2/2]

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

inlinevirtual

Deprecated:

Reimplemented in Ogre::DDSCodec, Ogre::FreeImageCodec, and Ogre::STBIImageCodec.

decode() [1/2]

virtual DecodeResult Ogre::Codec::decode ( const DataStreamPtr &  input ) const

inlinevirtual

Deprecated:

Reimplemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::STBIImageCodec, Ogre::ETCCodec, Ogre::ASTCCodec, Ogre::PVRTCCodec, and Ogre::EXRCodec.

decode() [2/2]

virtual void Ogre::Codec::decode ( const DataStreamPtr &  input, const Any &  output  ) const

inlinevirtual

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

Parameters

input	Stream containing the encoded data
output	codec type specific result

Reimplemented in Ogre::ImageCodec.

getType()

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

pure virtual

Returns the type of the codec as a String.

Implemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::STBIImageCodec, Ogre::ETCCodec, Ogre::ASTCCodec, Ogre::PVRTCCodec, and Ogre::EXRCodec.

Referenced by unregisterCodec().

getDataType()

virtual String Ogre::Codec::getDataType ( ) const

inlinevirtual

Deprecated:

do not use

Reimplemented in Ogre::ImageCodec.

magicNumberMatch()

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

inline

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

magicNumberToFileExt()

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

pure 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.

Implemented in Ogre::DDSCodec, Ogre::FreeImageCodec, Ogre::STBIImageCodec, Ogre::ETCCodec, Ogre::ASTCCodec, Ogre::PVRTCCodec, and Ogre::EXRCodec.

---

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

• OgreCodec.h