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-2006 Torus Knot Software Ltd
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 
00024 You may alternatively use this source under the terms of a specific version of
00025 the OGRE Unrestricted License provided you have obtained such a license from
00026 Torus Knot Software Ltd.
00027 -----------------------------------------------------------------------------
00028 */
00029 #ifndef _Codec_H__
00030 #define _Codec_H__
00031 
00032 #include "OgrePrerequisites.h"
00033 #include "OgreSharedPtr.h"
00034 #include "OgreDataStream.h"
00035 #include "OgreIteratorWrappers.h"
00036 #include "OgreStringVector.h"
00037 
00038 namespace Ogre {
00039 
00049     class _OgreExport Codec : public CodecAlloc
00050     {
00051     protected:
00052         typedef std::map< String, Codec* > CodecList; 
00055         static CodecList ms_mapCodecs;
00056 
00057     public:
00058         class _OgrePrivate CodecData : public CodecAlloc
00059         {
00060         public:
00061             virtual ~CodecData() {};
00062 
00065             virtual String dataType() const { return "CodecData"; };
00066         };
00067         typedef SharedPtr<CodecData> CodecDataPtr;
00068 
00069         typedef ConstMapIterator<CodecList> CodecIterator;
00070 
00071     public:
00072         virtual ~Codec();
00073         
00076         static void registerCodec( Codec *pCodec )
00077         {
00078             ms_mapCodecs[pCodec->getType()] = pCodec;
00079         }
00080 
00083         static void unRegisterCodec( Codec *pCodec )
00084         {
00085             ms_mapCodecs.erase(pCodec->getType());
00086         }
00087 
00089         static CodecIterator getCodecIterator(void)
00090         {
00091             return CodecIterator(ms_mapCodecs.begin(), ms_mapCodecs.end());
00092         }
00093 
00095         static StringVector getExtensions(void);
00096 
00098         static Codec* getCodec(const String& extension);
00099 
00106         static Codec* getCodec(char *magicNumberPtr, size_t maxbytes);
00107 
00111         virtual DataStreamPtr code(MemoryDataStreamPtr& input, CodecDataPtr& pData) const = 0;
00119         virtual void codeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const = 0;
00120 
00122         typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> DecodeResult;
00128         virtual DecodeResult decode(DataStreamPtr& input) const = 0;
00129 
00132         virtual String getType() const = 0;
00133 
00136         virtual String getDataType() const = 0;
00137 
00144         virtual bool magicNumberMatch(const char *magicNumberPtr, size_t maxbytes) const 
00145         { return !magicNumberToFileExt(magicNumberPtr, maxbytes).empty(); }
00153         virtual String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const = 0;
00154     };
00155 
00156 } // namespace
00157 
00158 #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 Sun Sep 27 22:02:22 2009