Codec specialized in images loaded using FreeImage. More...
#include <OgreFreeImageCodec.h>
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 |
Codec specialized in images loaded using FreeImage.
Definition at line 48 of file OgreFreeImageCodec.h.
|
inherited |
Definition at line 74 of file OgreCodec.h.
|
inherited |
Definition at line 76 of file OgreCodec.h.
|
protectedinherited |
Definition at line 59 of file OgreCodec.h.
|
inherited |
Result of a decoding; both a decoded data stream and CodecData metadata.
Definition at line 141 of file OgreCodec.h.
|
private |
Definition at line 54 of file OgreFreeImageCodec.h.
Ogre::FreeImageCodec::FreeImageCodec | ( | const String & | type, |
unsigned int | fiType | ||
) |
|
inlinevirtual |
Definition at line 62 of file OgreFreeImageCodec.h.
|
virtual |
Codes the data from the input chunk into the output chunk.
input | Stream containing the encoded data |
Implements Ogre::Codec.
|
virtual |
Codes the data in the input stream and saves the result in the output stream.
Implements Ogre::Codec.
|
private |
Common encoding routine.
|
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.
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.
Gets the codec registered for the passed in file extension.
|
staticinherited |
Gets the codec that can handle the given 'magic' identifier.
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 |
|
inlinestaticinherited |
Gets the iterator for the registered codecs.
Definition at line 108 of file OgreCodec.h.
|
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.
|
staticinherited |
Gets the file extension list for the registered codecs.
|
virtual |
Returns the type of the codec as a String.
Implements Ogre::Codec.
|
inlinestaticinherited |
Return whether a codec is registered already.
Definition at line 95 of file OgreCodec.h.
|
inlinevirtualinherited |
Returns whether a magic number header matches this codec.
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.
|
virtual |
Maps a magic number header to a file extension, if this codec recognises it.
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 |
Implements Ogre::Codec.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
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 |
Static method to shutdown FreeImage and unregister the FreeImage codecs.
|
static |
Static method to startup FreeImage and register the FreeImage codecs.
|
inlinestaticinherited |
Unregisters a codec from the database.
Definition at line 102 of file OgreCodec.h.
References Ogre::Codec::getType().
|
private |
Definition at line 52 of file OgreFreeImageCodec.h.
|
staticprivate |
Definition at line 55 of file OgreFreeImageCodec.h.
|
staticprotectedinherited |
A map that contains all the registered codecs.
Definition at line 62 of file OgreCodec.h.
|
private |
Definition at line 51 of file OgreFreeImageCodec.h.