XSADiskImage.cc

Go to the documentation of this file.

#include "XSADiskImage.hh"
#include "DiskExceptions.hh"
#include "File.hh"
#include "narrow.hh"
#include "xrange.hh"
#include <array>
#include <utility>
 
namespace openmsx {
 
class XSAExtractor
{
public:
        explicit XSAExtractor(File& file);
        std::pair<MemBuffer<SectorBuffer>, unsigned> extractData();
 
private:
        static constexpr int MAX_STR_LEN = 254;
        static constexpr int TBL_SIZE = 16;
        static constexpr int MAX_HUF_CNT = 127;
 
        [[nodiscard]] inline uint8_t charIn();
        void chkHeader();
        void unLz77();
        [[nodiscard]] unsigned rdStrLen();
        [[nodiscard]] int rdStrPos();
        [[nodiscard]] bool bitIn();
        void initHufInfo();
        void mkHufTbl();
 
        struct HufNode {
                HufNode* child1;
                HufNode* child2;
                int weight;
        };
 
private:
        MemBuffer<SectorBuffer> outBuf; // the output buffer
        std::span<const uint8_t>::iterator inBufPos;    // pos in input buffer
        std::span<const uint8_t>::iterator inBufEnd;
        unsigned sectors;
 
        int updHufCnt;
        std::array<int, TBL_SIZE + 1> cpDist;
        std::array<int, TBL_SIZE> cpdBmask;
        std::array<int, TBL_SIZE> tblSizes;
        std::array<HufNode, 2 * TBL_SIZE - 1> hufTbl;
 
        uint8_t bitFlg;         // flag with the bits
        uint8_t bitCnt;         // nb bits left
 
        static constexpr std::array<uint8_t, TBL_SIZE> cpdExt = { // Extra bits for distance codes
                  0,  0,  0,  0,  1,  2,  3,  4, 5,  6,  7,  8,  9, 10, 11, 12
        };
};
 
 
// XSADiskImage
 
XSADiskImage::XSADiskImage(Filename& filename, File& file)
        : SectorBasedDisk(filename)
{
        XSAExtractor extractor(file);
        auto [d, sectors] = extractor.extractData();
        data = std::move(d);
        setNbSectors(sectors);
}
 
void XSADiskImage::readSectorsImpl(
        std::span<SectorBuffer> buffers, size_t startSector)
{
        ranges::copy(std::span{&data[startSector], buffers.size()}, buffers);
}
 
void XSADiskImage::writeSectorImpl(size_t /*sector*/, const SectorBuffer& /*buf*/)
{
        throw WriteProtectedException("Write protected");
}
 
bool XSADiskImage::isWriteProtectedImpl() const
{
        return true;
}
 
 
// XSAExtractor
 
XSAExtractor::XSAExtractor(File& file)
{
        auto mmap = file.mmap();
        inBufPos = mmap.begin();
        inBufEnd = mmap.end();
 
        if ((charIn() != 'P') || (charIn() != 'C') ||
            (charIn() != 'K') || (charIn() != '\010')) {
                throw MSXException("Not an XSA image");
        }
 
        chkHeader();
        initHufInfo();  // initialize the cpDist tables
        unLz77();
}
 
std::pair<MemBuffer<SectorBuffer>, unsigned> XSAExtractor::extractData()
{
        // destroys internal outBuf, but that's ok
        return {std::move(outBuf), sectors};
}
 
// Get the next character from the input buffer
uint8_t XSAExtractor::charIn()
{
        if (inBufPos >= inBufEnd) {
                throw MSXException("Corrupt XSA image: unexpected end of file");
        }
        return *inBufPos++;
}
 
// check fileheader
void XSAExtractor::chkHeader()
{
        // read original length (little endian)
        unsigned outBufLen = 0;
        for (auto i : xrange(4)) {
                outBufLen |= charIn() << (8 * i);
        }
        sectors = (outBufLen + 511) / 512;
        outBuf.resize(sectors);
 
        // skip compressed length
        inBufPos += 4;
 
        // skip original filename
        while (charIn()) /*empty*/;
}
 
// the actual decompression algorithm itself
void XSAExtractor::unLz77()
{
        bitCnt = 0; // no bits read yet
 
        size_t remaining = sectors * sizeof(SectorBuffer);
        std::span out = outBuf.data()->raw;
        size_t outIdx = 0;
        while (true) {
                if (bitIn()) {
                        // 1-bit
                        unsigned strLen = rdStrLen();
                        if (strLen == (MAX_STR_LEN + 1)) {
                                 return;
                        }
                        unsigned strPos = rdStrPos();
                        if ((strPos == 0) || (strPos > outIdx)) {
                                throw MSXException(
                                        "Corrupt XSA image: invalid offset");
                        }
                        if (remaining < strLen) {
                                throw MSXException(
                                        "Invalid XSA image: too small output buffer");
                        }
                        remaining -= strLen;
                        while (strLen--) {
                                out[outIdx] = out[outIdx - strPos];
                                ++outIdx;
                        }
                } else {
                        // 0-bit
                        if (remaining == 0) {
                                throw MSXException(
                                        "Invalid XSA image: too small output buffer");
                        }
                        --remaining;
                        out[outIdx++] = charIn();
                }
        }
}
 
// read string length
unsigned XSAExtractor::rdStrLen()
{
        if (!bitIn()) return 2;
        if (!bitIn()) return 3;
        if (!bitIn()) return 4;
 
        uint8_t nrBits = 2;
        while ((nrBits != 7) && bitIn()) {
                ++nrBits;
        }
 
        unsigned len = 1;
        while (nrBits--) {
                len = (len << 1) | (bitIn() ? 1 : 0);
        }
        return (len + 1);
}
 
// read string pos
int XSAExtractor::rdStrPos()
{
        HufNode* hufPos = &hufTbl[2 * TBL_SIZE - 2];
 
        while (hufPos->child1) {
                if (bitIn()) {
                        hufPos = hufPos->child2;
                } else {
                        hufPos = hufPos->child1;
                }
        }
        auto cpdIndex = narrow<uint8_t>(hufPos - &hufTbl[0]);
        ++tblSizes[cpdIndex];
 
        int strPos = [&] {
                if (cpdBmask[cpdIndex] >= 256) {
                        uint8_t strPosLsb = charIn();
                        uint8_t strPosMsb = 0;
                        for (auto nrBits = narrow_cast<uint8_t>(cpdExt[cpdIndex] - 8);
                             nrBits--;
                             strPosMsb |= uint8_t(bitIn() ? 1 : 0)) {
                                strPosMsb <<= 1;
                        }
                        return strPosLsb + 256 * strPosMsb;
                } else {
                        int pos = 0;
                        for (uint8_t nrBits = cpdExt[cpdIndex]; nrBits--;
                             pos |= (bitIn() ? 1 : 0)) {
                                pos <<= 1;
                        }
                        return pos;
                }
        }();
        if ((updHufCnt--) == 0) {
                mkHufTbl();     // make the huffman table
        }
        return strPos + cpDist[cpdIndex];
}
 
// read a bit from the input file
bool XSAExtractor::bitIn()
{
        if (bitCnt == 0) {
                bitFlg = charIn();      // read bitFlg
                bitCnt = 8;             // 8 bits left
        }
        bool temp = bitFlg & 1;
        --bitCnt;                       // 1 bit less
        bitFlg >>= 1;
 
        return temp;
}
 
// initialize the huffman info tables
void XSAExtractor::initHufInfo()
{
        int offs = 1;
        for (auto i : xrange(TBL_SIZE)) {
                cpDist[i] = offs;
                cpdBmask[i] = 1 << cpdExt[i];
                offs += cpdBmask[i];
        }
        cpDist[TBL_SIZE] = offs;
 
        for (auto i : xrange(TBL_SIZE)) {
                tblSizes[i] = 0;            // reset the table counters
                hufTbl[i].child1 = nullptr; // mark the leave nodes
        }
        mkHufTbl();     // make the huffman table
}
 
// Make huffman coding info
void XSAExtractor::mkHufTbl()
{
        // Initialize the huffman tree
        HufNode* hufPos = &hufTbl[0];
        for (auto i : xrange(TBL_SIZE)) {
                (hufPos++)->weight = 1 + (tblSizes[i] >>= 1);
        }
        for (int i = TBL_SIZE; i != 2 * TBL_SIZE - 1; ++i) {
                (hufPos++)->weight = -1;
        }
        // Place the nodes in the correct manner in the tree
        while (hufTbl[2 * TBL_SIZE - 2].weight == -1) {
                for (hufPos = &hufTbl[0]; !(hufPos->weight); ++hufPos) {
                        // nothing
                }
                HufNode* l1Pos = hufPos++;
                while (!(hufPos->weight)) {
                        ++hufPos;
                }
                HufNode* l2Pos = [&] {
                        if (hufPos->weight < l1Pos->weight) {
                                auto* tmp = l1Pos;
                                l1Pos = hufPos++;
                                return tmp;
                        } else {
                                return hufPos++;
                        }
                }();
                int tempW;
                while ((tempW = hufPos->weight) != -1) {
                        if (tempW) {
                                if (tempW < l1Pos->weight) {
                                        l2Pos = l1Pos;
                                        l1Pos = hufPos;
                                } else if (tempW < l2Pos->weight) {
                                        l2Pos = hufPos;
                                }
                        }
                        ++hufPos;
                }
                hufPos->weight = l1Pos->weight + l2Pos->weight;
                (hufPos->child1 = l1Pos)->weight = 0;
                (hufPos->child2 = l2Pos)->weight = 0;
        }
        updHufCnt = MAX_HUF_CNT;
}
 
} // namespace openmsx