BeLzma.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once
#include "BeSQLite.h"

BEGIN_BENTLEY_SQLITE_NAMESPACE

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct ILzmaOutputStream
{
    virtual ZipErrors _Write(void const* data, uint32_t size, uint32_t&bytesWritten) = 0;
    virtual void _SetAlwaysFlush(bool flushOnEveryWrite) = 0;
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct ILzmaInputStream
{
    virtual ZipErrors _Read(void* data, uint32_t size, uint32_t& actuallyRead) = 0;
    virtual uint64_t _GetSize() = 0;
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct BeFileLzmaInStream : ILzmaInputStream
{
private:
    BeFile   m_file;
    uint64_t m_fileSize;
    uint64_t m_bytesRead;

public:
    virtual ~BeFileLzmaInStream() {}
    BE_SQLITE_EXPORT StatusInt OpenInputFile(BeFileNameCR fileName);
    BE_SQLITE_EXPORT ZipErrors _Read(void* data, uint32_t size, uint32_t& actuallyRead) override;
    uint64_t _GetSize() override {return m_fileSize;}
    uint64_t GetBytesRead() {return m_bytesRead;}
    BeFile& GetBeFile() {return m_file;}
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct BeFileLzmaOutStream : ILzmaOutputStream
{
private:
    BeFile      m_file;
    uint64_t    m_bytesWritten;

public:
    virtual ~BeFileLzmaOutStream() {}
    BE_SQLITE_EXPORT BeFileStatus CreateOutputFile(BeFileNameCR fileName, bool createAlways = true);
    BE_SQLITE_EXPORT ZipErrors _Write(void const* data, uint32_t size, uint32_t& bytesWritten) override;
    BE_SQLITE_EXPORT void _SetAlwaysFlush(bool flushOnEveryWrite) override;
    uint64_t GetBytesWritten() {return m_bytesWritten;}
    BeFile& GetBeFile() {return m_file;}
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct MemoryLzmaInStream : ILzmaInputStream
{
private:
    uint32_t    m_offset;
    uint32_t    m_size;
    void const* m_data;

    uint32_t    m_headerOffset;
    uint32_t    m_headerSize;
    void const* m_headerData;

public:
    MemoryLzmaInStream(void const*data, uint32_t size)
        {
        SetData(data, size);
        SetHeaderData(nullptr, 0);
        }

    void SetData(void const* data, uint32_t size)
        {
        m_data = data;
        m_size = size;
        m_offset = 0;
        }

    void SetHeaderData(void const* headerData, uint32_t headerSize)
        {
        m_headerData = headerData;
        m_headerSize = headerSize;
        m_headerOffset = 0;
        }

    BE_SQLITE_EXPORT virtual ZipErrors _Read(void* data, uint32_t size, uint32_t& actuallyRead) override;
    virtual uint64_t _GetSize() override { return m_size + m_headerSize; }
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct MemoryLzmaOutStream : ILzmaOutputStream
{
private:
    bvector<Byte>& m_buffer;

public:
    MemoryLzmaOutStream(bvector<Byte>& v) : m_buffer(v) {}
    virtual ~MemoryLzmaOutStream() {}

    BE_SQLITE_EXPORT ZipErrors _Write(void const* data, uint32_t writeSize, uint32_t& bytesWritten) override;
    void _SetAlwaysFlush(bool flushOnEveryWrite) override {}
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct LzmaEncoder
{
public:
    struct Impl;

private:
    Impl* m_impl;

public:
    BE_SQLITE_EXPORT LzmaEncoder(uint32_t dictionarySize = 1 << 24, bool supportRandomAccess = false);

    BE_SQLITE_EXPORT ~LzmaEncoder();

    BE_SQLITE_EXPORT void SetProgressTracker(ICompressProgressTracker* progressTracker);

    void SetBlockSize(uint32_t blockSize); 

    BE_SQLITE_EXPORT ZipErrors StartCompress(ILzmaOutputStream& outStream);

    BE_SQLITE_EXPORT ZipErrors CompressNextPage(void const* pData, int nData);

    BE_SQLITE_EXPORT ZipErrors FinishCompress();

    BE_SQLITE_EXPORT ZipErrors CompressStream(ILzmaOutputStream& out, ILzmaInputStream& in);

    BE_SQLITE_EXPORT ZipErrors CompressBuffer(bvector<Byte>& out, void const *input, uint32_t sizeInput);
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct LzmaDecoder
{
public:
    struct Impl;

private:
    Impl* m_impl;

public:
    BE_SQLITE_EXPORT LzmaDecoder();

    BE_SQLITE_EXPORT ~LzmaDecoder();

    BE_SQLITE_EXPORT void SetProgressTracker(ICompressProgressTracker* progressTracker);

    BE_SQLITE_EXPORT ZipErrors StartDecompress(ILzmaInputStream& inStream);

    BE_SQLITE_EXPORT ZipErrors DecompressNextPage(void* pData, int* pnData);

    BE_SQLITE_EXPORT void FinishDecompress();

    BE_SQLITE_EXPORT ZipErrors DecompressStream(ILzmaOutputStream& outStream, ILzmaInputStream& inStream);

    BE_SQLITE_EXPORT ZipErrors DecompressBuffer(bvector<Byte>&out, void const*inputBuffer, uint32_t inputSize);
};

END_BENTLEY_SQLITE_NAMESPACE