decompressor.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef SCI_RESOURCE_DECOMPRESSOR_H
#define SCI_RESOURCE_DECOMPRESSOR_H

#include "common/scummsys.h"

namespace Common {
class ReadStream;
}

namespace Sci {

enum ResourceCompression {
    kCompUnknown = -1,
    kCompNone = 0,
    kCompLZW,
    kCompHuffman,
    kCompLZW1,          // LZW-like compression used in SCI01 and SCI1
    kCompLZW1View,      // Comp3 + view Post-processing
    kCompLZW1Pic,       // Comp3 + pic Post-processing
#ifdef ENABLE_SCI32
    kCompSTACpack,  // ? Used in SCI32
#endif
    kCompDCL
};

class Decompressor {
public:
    Decompressor() :
        _dwBits(0),
        _nBits(0),
        _szPacked(0),
        _szUnpacked(0),
        _dwRead(0),
        _dwWrote(0),
        _src(nullptr),
        _dest(nullptr)
    {}

    virtual ~Decompressor() {}


    virtual int unpack(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked);

protected:
    virtual void init(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked);

    uint32 getBitsMSB(int n);

    uint32 getBitsLSB(int n);

    byte getByteMSB();
    byte getByteLSB();

    void fetchBitsMSB();
    void fetchBitsLSB();

    virtual void putByte(byte b);

    bool isFinished() {
        return (_dwWrote == _szUnpacked) && (_dwRead >= _szPacked);
    }

    uint32 _dwBits;     
    byte _nBits;        
    uint32 _szPacked;   
    uint32 _szUnpacked; 
    uint32 _dwRead;     
    uint32 _dwWrote;    
    Common::ReadStream *_src;
    byte *_dest;
};

class DecompressorHuffman : public Decompressor {
public:
    int unpack(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked) override;

protected:
    int16 getc2();

    byte *_nodes;
};

class DecompressorLZW : public Decompressor {
public:
    DecompressorLZW(int nCompression) : _numbits(0), _curtoken(0), _endtoken(0) {
        _compression = nCompression;
    }
    void init(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked) override;
    int unpack(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked) override;

protected:
    enum {
        PIC_OPX_EMBEDDED_VIEW = 1,
        PIC_OPX_SET_PALETTE = 2,
        PIC_OP_OPX = 0xfe
    };
    // unpacking procedures
    // TODO: unpackLZW and unpackLZW1 are similar and should be merged
    int unpackLZW1(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked);
    int unpackLZW(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked);

    // functions to post-process view and pic resources
    void reorderPic(byte *src, byte *dest, int dsize);
    void reorderView(byte *src, byte *dest);
    void decodeRLE(byte **rledata, byte **pixeldata, byte *outbuffer, int size);
    int getRLEsize(byte *rledata, int dsize);
    void buildCelHeaders(byte **seeker, byte **writer, int celindex, int *cc_lengths, int max);

    // decompressor data
    struct Tokenlist {
        byte data;
        uint16 next;
    };
    uint16 _numbits;
    uint16 _curtoken, _endtoken;
    int _compression;
};

class DecompressorDCL : public Decompressor {
public:
    int unpack(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked) override;
};

#ifdef ENABLE_SCI32

class DecompressorLZS : public Decompressor {
public:
    int unpack(Common::ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked) override;
protected:
    int unpackLZS();
    uint32 getCompLen();
    void copyComp(int offs, uint32 clen);
};
#endif

} // End of namespace Sci

#endif // SCI_RESOURCE_DECOMPRESSOR_H