# 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-2005 The OGRE Team
    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 */
    00025 #ifndef _Codec_H__
    00026 #define _Codec_H__
    00027
    00028 #include "OgrePrerequisites.h"
    00029 #include "OgreSharedPtr.h"
    00030 #include "OgreDataStream.h"
    00031
    00032 namespace Ogre {
    00033
    00043     class _OgreExport Codec
    00044     {
    00045     protected:
    00046         typedef std::map< String, Codec* > CodecList;
    00049         static CodecList ms_mapCodecs;
    00050
    00051     public:
    00052         class _OgrePrivate CodecData
    00053         {
    00054         public:
    00055             virtual ~CodecData() {};
    00056
    00059             virtual String dataType() const { return "CodecData"; };
    00060         };
    00061         typedef SharedPtr<CodecData> CodecDataPtr;
    00062
    00063     public:
    00064         virtual ~Codec();
    00065
    00068         static void registerCodec( Codec *pCodec )
    00069         {
    00070             ms_mapCodecs[pCodec->getType()] = pCodec;
    00071         }
    00072
    00075         static void unRegisterCodec( Codec *pCodec )
    00076         {
    00077             ms_mapCodecs.erase(pCodec->getType());
    00078         }
    00079
    00081         static Codec* getCodec(const String& extension);
    00082
    00086         virtual DataStreamPtr code(MemoryDataStreamPtr& input, CodecDataPtr& pData) const = 0;
    00094         virtual void codeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const = 0;
    00095
    00097         typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> DecodeResult;
    00103         virtual DecodeResult decode(DataStreamPtr& input) const = 0;
    00104
    00107         virtual String getType() const = 0;
    00108     };
    00109
    00110 } // namespace
    00111
    00112 #endif

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:42 2006