OgreDeflate.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-2012 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 __OGRE_DEFLATE_H__
#define __OGRE_DEFLATE_H__

#include "OgrePrerequisites.h"
#include "OgreDataStream.h"


struct z_stream_s;
typedef struct z_stream_s z_stream;

namespace Ogre
{
    class _OgreExport DeflateStream : public DataStream
    {
    protected:
        DataStreamPtr mCompressedStream;
        DataStreamPtr mTmpWriteStream;
        String mTempFileName;
        z_stream* mZStream;
        size_t mCurrentPos;
        
        // Cache for read data in case skipping around
        StaticCache<16 * OGRE_STREAM_TEMP_SIZE> mReadCache;
        
        // Intermediate buffer for read / write
        unsigned char *mTmp;
        
        // Whether the underlying stream is valid compressed data
        bool mIsCompressedValid;
        
        
        void init();
        void destroy();
        void compressFinal();
    public:
        DeflateStream(const DataStreamPtr& compressedStream);
        DeflateStream(const String& name, const DataStreamPtr& compressedStream);   
        
        ~DeflateStream();
        
        bool isCompressedStreamValid() const { return mIsCompressedValid; }
        
        size_t read(void* buf, size_t count);
        
        size_t write(const void* buf, size_t count);
                
        void skip(long count);
        
        void seek( size_t pos );
        
        size_t tell(void) const;
        
        bool eof(void) const;
        
        void close(void);
        
    };
}

#endif