Encoder.h

Go to the documentation of this file.

/*
 * The Progressive Graphics File; http://www.libpgf.org
 * 
 * $Date: 2006-06-04 22:05:59 +0200 (So, 04 Jun 2006) $
 * $Revision: 229 $
 * 
 * This file Copyright (C) 2006 xeraina GmbH, Switzerland
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU LESSER GENERAL PUBLIC LICENSE
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */


#ifndef PGF_ENCODER_H
#define PGF_ENCODER_H

#include "PGFstream.h"
#include "BitStream.h"
#include "Subband.h"
#include "WaveletTransform.h"

// Constants
#define BufferLen           (BufferSize/WordWidth)  
#define CodeBufferLen       BufferSize              

class CEncoder {
    class CMacroBlock {
    public:
        CMacroBlock(CEncoder *encoder)
#if defined(WIN32) || defined(WINCE) || defined(WIN64)
#pragma warning( suppress : 4351 )
#endif
        : m_value()
        , m_codeBuffer()
        , m_header(0)
        , m_encoder(encoder)
        , m_sigFlagVector()
        {
            ASSERT(m_encoder);
            Init(-1);
        }

        void Init(int lastLevelIndex) {             // initialize for reusage
            m_valuePos = 0;
            m_maxAbsValue = 0;
            m_codePos = 0;
            m_lastLevelIndex = lastLevelIndex;
        }

        void BitplaneEncode();

        DataT   m_value[BufferSize];                
        UINT32  m_codeBuffer[CodeBufferLen];        
        ROIBlockHeader m_header;                    
        UINT32  m_valuePos;                         
        UINT32  m_maxAbsValue;                      
        UINT32  m_codePos;                          
        int     m_lastLevelIndex;                   

    private:
        UINT32 RLESigns(UINT32 codePos, UINT32* signBits, UINT32 signLen);
        UINT32 DecomposeBitplane(UINT32 bufferSize, UINT32 planeMask, UINT32 codePos, UINT32* sigBits, UINT32* refBits, UINT32* signBits, UINT32& signLen, UINT32& codeLen);
        UINT8  NumberOfBitplanes();
        bool   GetBitAtPos(UINT32 pos, UINT32 planeMask) const  { return (abs(m_value[pos]) & planeMask) > 0; } 

        CEncoder *m_encoder;                        // encoder instance
        bool    m_sigFlagVector[BufferSize+1];      // see paper from Malvar, Fast Progressive Wavelet Coder
    };

public:
    CEncoder(CPGFStream* stream, PGFPreHeader preHeader, PGFHeader header, const PGFPostHeader& postHeader, 
        UINT64& userDataPos, bool useOMP) THROW_; // throws IOException

    ~CEncoder();

    void FavorSpeedOverSize() { m_favorSpeed = true; }

    void Flush() THROW_;

    void UpdatePostHeaderSize(PGFPreHeader preHeader) THROW_;

    UINT32 WriteLevelLength(UINT32*& levelLength) THROW_;

    UINT32 UpdateLevelLength() THROW_;

    void Partition(CSubband* band, int width, int height, int startPos, int pitch) THROW_;

    void SetEncodedLevel(int currentLevel) { ASSERT(currentLevel >= 0); m_currentBlock->m_lastLevelIndex = m_nLevels - currentLevel - 1; m_forceWriting = true; }

    void WriteValue(CSubband* band, int bandPos) THROW_;

    INT64 ComputeHeaderLength() const { return m_levelLengthPos - m_startPosition; }

    INT64 ComputeBufferLength() const { return m_stream->GetPos() - m_bufferStartPos; }

    INT64 ComputeOffset() const { return m_stream->GetPos() - m_levelLengthPos; }

    void SetBufferStartPos() { m_bufferStartPos = m_stream->GetPos(); }

#ifdef __PGFROISUPPORT__
    void EncodeTileBuffer() THROW_  { ASSERT(m_currentBlock && m_currentBlock->m_valuePos >= 0 && m_currentBlock->m_valuePos <= BufferSize); EncodeBuffer(ROIBlockHeader(m_currentBlock->m_valuePos, true)); }

    void SetROI()                   { m_roi = true; }
#endif

#ifdef TRACE
    void DumpBuffer() const;
#endif

private:
    void EncodeBuffer(ROIBlockHeader h) THROW_; // throws IOException
    void WriteMacroBlock(CMacroBlock* block) THROW_; // throws IOException

    CPGFStream *m_stream;                       
    UINT64  m_startPosition;                    
    UINT64  m_levelLengthPos;                   
    UINT64  m_bufferStartPos;                   

    CMacroBlock **m_macroBlocks;                
    int     m_macroBlockLen;                    
    int     m_lastMacroBlock;                   
    CMacroBlock *m_currentBlock;                

    UINT32* m_levelLength;                      
    int     m_currLevelIndex;                   
    UINT8   m_nLevels;                          
    bool    m_favorSpeed;                       
    bool    m_forceWriting;                     
#ifdef __PGFROISUPPORT__
    bool    m_roi;                              
#endif
};

#endif //PGF_ENCODER