Ogre::Codec Class Reference

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

#include <OgreCodec.h>

Inheritance diagram for Ogre::Codec:
[legend]

List of all members.

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.

Public Member Functions

virtual ~Codec ()
virtual DataStreamPtr code (MemoryDataStreamPtr &input, CodecDataPtr &pData) const =0
 Codes the data in the input stream and saves the result in the output stream.
virtual void codeToFile (MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const =0
 Codes the data in the input chunk and saves the result in the output filename provided.
virtual DecodeResult decode (DataStreamPtr &input) const =0
 Codes the data from the input chunk into the output chunk.
virtual String getType () const =0
 Returns the type of the codec as a String.
virtual String getDataType () const =0
 Returns the type of the data that supported by this codec as a String.

Static Public Member Functions

static void registerCodec (Codec *pCodec)
 Registers a new codec in the database.
static void unRegisterCodec (Codec *pCodec)
 Unregisters a codec from the database.
static CodecIterator getCodecIterator (void)
 Gets the iterator for the registered codecs.
static StringVector getExtensions (void)
 Gets the file extension list for the registered codecs.
static CodecgetCodec (const String &extension)
 Gets the codec registered for the passed in file extension.

Protected Types

typedef std::map
< String, Codec * > 
CodecList

Static Protected Attributes

static CodecList ms_mapCodecs
 A map that contains all the registered codecs.

Classes

class  CodecData


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.

Definition at line 49 of file OgreCodec.h.


Member Typedef Documentation

typedef std::map< String, Codec* > Ogre::Codec::CodecList [protected]

Definition at line 52 of file OgreCodec.h.

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

Definition at line 67 of file OgreCodec.h.

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

Definition at line 69 of file OgreCodec.h.

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

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

Definition at line 114 of file OgreCodec.h.


Constructor & Destructor Documentation

virtual Ogre::Codec::~Codec (  )  [virtual]


Member Function Documentation

static void Ogre::Codec::registerCodec ( Codec pCodec  )  [static]

Registers a new codec in the database.

Definition at line 76 of file OgreCodec.h.

References getType().

static void Ogre::Codec::unRegisterCodec ( Codec pCodec  )  [static]

Unregisters a codec from the database.

Definition at line 83 of file OgreCodec.h.

References getType().

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

Gets the iterator for the registered codecs.

Definition at line 89 of file OgreCodec.h.

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

Gets the file extension list for the registered codecs.

static Codec* Ogre::Codec::getCodec ( const String extension  )  [static]

Gets the codec registered for the passed in file extension.

virtual DataStreamPtr Ogre::Codec::code ( MemoryDataStreamPtr input,
CodecDataPtr pData 
) const [pure virtual]

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

Implemented in Ogre::ILImageCodec, Ogre::DDSCodec, Ogre::FreeImageCodec, and Ogre::ILImageCodec.

virtual void Ogre::Codec::codeToFile ( MemoryDataStreamPtr input,
const String outFileName,
CodecDataPtr pData 
) const [pure 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)

Implemented in Ogre::ILImageCodec, Ogre::DDSCodec, Ogre::FreeImageCodec, and Ogre::ILImageCodec.

virtual DecodeResult Ogre::Codec::decode ( DataStreamPtr input  )  const [pure virtual]

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

Parameters:
input Stream containing the encoded data
Note:
Has a variable number of arguments, which depend on the codec type.

Implemented in Ogre::ILImageCodec, Ogre::DDSCodec, Ogre::FreeImageCodec, and Ogre::ILImageCodec.

virtual String Ogre::Codec::getType (  )  const [pure virtual]

Returns the type of the codec as a String.

Implemented in Ogre::ILImageCodec, Ogre::DDSCodec, Ogre::FreeImageCodec, and Ogre::ILImageCodec.

Referenced by registerCodec(), and unRegisterCodec().

virtual String Ogre::Codec::getDataType (  )  const [pure virtual]

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

Implemented in Ogre::ImageCodec.


Member Data Documentation

CodecList Ogre::Codec::ms_mapCodecs [static, protected]

A map that contains all the registered codecs.

Definition at line 55 of file OgreCodec.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat May 10 16:25:27 2008