OGRE: OgreCodec.h Source File - OGRE Documentation

# OgreCodec.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004 (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef _Codec_H__
    00029 #define _Codec_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreSharedPtr.h"
    00033 #include "OgreDataStream.h"
    00034 #include "OgreIteratorWrappers.h"
    00035 #include "OgreStringVector.h"
    00036 #include "OgreException.h"
    00037
    00038 namespace Ogre {
    00055     class _OgreExport Codec : public CodecAlloc
    00056     {
    00057     protected:
    00058         typedef map< String, Codec* >::type CodecList;
    00061         static CodecList ms_mapCodecs;
    00062
    00063     public:
    00064         class _OgrePrivate CodecData : public CodecAlloc
    00065         {
    00066         public:
    00067             virtual ~CodecData() {}
    00068
    00071             virtual String dataType() const { return "CodecData"; }
    00072         };
    00073         typedef SharedPtr<CodecData> CodecDataPtr;
    00074
    00075         typedef ConstMapIterator<CodecList> CodecIterator;
    00076
    00077     public:
    00078         virtual ~Codec();
    00079
    00082         static void registerCodec( Codec *pCodec )
    00083         {
    00084             CodecList::iterator i = ms_mapCodecs.find(pCodec->getType());
    00085             if (i != ms_mapCodecs.end())
    00086                 OGRE_EXCEPT(Exception::ERR_DUPLICATE_ITEM,
    00087                     pCodec->getType() + " already has a registered codec. ", __FUNCTION__);
    00088
    00089             ms_mapCodecs[pCodec->getType()] = pCodec;
    00090         }
    00091
    00094         static bool isCodecRegistered( const String& codecType )
    00095         {
    00096             return ms_mapCodecs.find(codecType) != ms_mapCodecs.end();
    00097         }
    00098
    00101         static void unRegisterCodec( Codec *pCodec )
    00102         {
    00103             ms_mapCodecs.erase(pCodec->getType());
    00104         }
    00105
    00107         static CodecIterator getCodecIterator(void)
    00108         {
    00109             return CodecIterator(ms_mapCodecs.begin(), ms_mapCodecs.end());
    00110         }
    00111
    00113         static StringVector getExtensions(void);
    00114
    00116         static Codec* getCodec(const String& extension);
    00117
    00124         static Codec* getCodec(char *magicNumberPtr, size_t maxbytes);
    00125
    00129         virtual DataStreamPtr code(MemoryDataStreamPtr& input, CodecDataPtr& pData) const = 0;
    00137         virtual void codeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const = 0;
    00138
    00140         typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> DecodeResult;
    00146         virtual DecodeResult decode(DataStreamPtr& input) const = 0;
    00147
    00150         virtual String getType() const = 0;
    00151
    00154         virtual String getDataType() const = 0;
    00155
    00162         virtual bool magicNumberMatch(const char *magicNumberPtr, size_t maxbytes) const
    00163         { return !magicNumberToFileExt(magicNumberPtr, maxbytes).empty(); }
    00171         virtual String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const = 0;
    00172     };
    00176 } // namespace
    00177
    00178 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:51