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 
00037 namespace Ogre {
00054     class _OgreExport Codec : public CodecAlloc
00055     {
00056     protected:
00057         typedef map< String, Codec* >::type CodecList; 
00060         static CodecList ms_mapCodecs;
00061 
00062     public:
00063         class _OgrePrivate CodecData : public CodecAlloc
00064         {
00065         public:
00066             virtual ~CodecData() {};
00067 
00070             virtual String dataType() const { return "CodecData"; };
00071         };
00072         typedef SharedPtr<CodecData> CodecDataPtr;
00073 
00074         typedef ConstMapIterator<CodecList> CodecIterator;
00075 
00076     public:
00077         virtual ~Codec();
00078         
00081         static void registerCodec( Codec *pCodec )
00082         {
00083             ms_mapCodecs[pCodec->getType()] = pCodec;
00084         }
00085 
00088         static void unRegisterCodec( Codec *pCodec )
00089         {
00090             ms_mapCodecs.erase(pCodec->getType());
00091         }
00092 
00094         static CodecIterator getCodecIterator(void)
00095         {
00096             return CodecIterator(ms_mapCodecs.begin(), ms_mapCodecs.end());
00097         }
00098 
00100         static StringVector getExtensions(void);
00101 
00103         static Codec* getCodec(const String& extension);
00104 
00111         static Codec* getCodec(char *magicNumberPtr, size_t maxbytes);
00112 
00116         virtual DataStreamPtr code(MemoryDataStreamPtr& input, CodecDataPtr& pData) const = 0;
00124         virtual void codeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const = 0;
00125 
00127         typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> DecodeResult;
00133         virtual DecodeResult decode(DataStreamPtr& input) const = 0;
00134 
00137         virtual String getType() const = 0;
00138 
00141         virtual String getDataType() const = 0;
00142 
00149         virtual bool magicNumberMatch(const char *magicNumberPtr, size_t maxbytes) const 
00150         { return !magicNumberToFileExt(magicNumberPtr, maxbytes).empty(); }
00158         virtual String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const = 0;
00159     };
00163 } // namespace
00164 
00165 #endif

Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Thu Dec 31 16:27:08 2009