OgreCodec.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2011 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef _Codec_H__
#define _Codec_H__

#include "OgrePrerequisites.h"
#include "OgreSharedPtr.h"
#include "OgreDataStream.h"
#include "OgreIteratorWrappers.h"
#include "OgreStringVector.h"
#include "OgreException.h"

namespace Ogre {
    class _OgreExport Codec : public CodecAlloc
    {
    protected:
        typedef map< String, Codec* >::type CodecList; 
        static CodecList ms_mapCodecs;

    public:
        class _OgrePrivate CodecData : public CodecAlloc
        {
        public:
            virtual ~CodecData() {}

            virtual String dataType() const { return "CodecData"; }
        };
        typedef SharedPtr<CodecData> CodecDataPtr;

        typedef ConstMapIterator<CodecList> CodecIterator;

    public:
        virtual ~Codec();
        
        static void registerCodec( Codec *pCodec )
        {
            CodecList::iterator i = ms_mapCodecs.find(pCodec->getType());
            if (i != ms_mapCodecs.end())
                OGRE_EXCEPT(Exception::ERR_DUPLICATE_ITEM, 
                    pCodec->getType() + " already has a registered codec. ", __FUNCTION__);

            ms_mapCodecs[pCodec->getType()] = pCodec;
        }

        static bool isCodecRegistered( const String& codecType )
        {
            return ms_mapCodecs.find(codecType) != ms_mapCodecs.end();
        }

        static void unRegisterCodec( Codec *pCodec )
        {
            ms_mapCodecs.erase(pCodec->getType());
        }

        static CodecIterator getCodecIterator(void)
        {
            return CodecIterator(ms_mapCodecs.begin(), ms_mapCodecs.end());
        }

        static StringVector getExtensions(void);

        static Codec* getCodec(const String& extension);

        static Codec* getCodec(char *magicNumberPtr, size_t maxbytes);

        virtual DataStreamPtr code(MemoryDataStreamPtr& input, CodecDataPtr& pData) const = 0;
        virtual void codeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const = 0;

        typedef std::pair<MemoryDataStreamPtr, CodecDataPtr> DecodeResult;
        virtual DecodeResult decode(DataStreamPtr& input) const = 0;

        virtual String getType() const = 0;

        virtual String getDataType() const = 0;

        virtual bool magicNumberMatch(const char *magicNumberPtr, size_t maxbytes) const 
        { return !magicNumberToFileExt(magicNumberPtr, maxbytes).empty(); }
        virtual String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const = 0;
    };
} // namespace

#endif