iff.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 IMAGE_IFF_H
#define IMAGE_IFF_H

#include "common/array.h"
#include "common/endian.h"
#include "graphics/palette.h"
#include "graphics/surface.h"

#include "image/image_decoder.h"

namespace Common {
class SeekableReadStream;
}

namespace Graphics {
struct Surface;
}

namespace Image {

class IFFDecoder : public ImageDecoder {
public:
    struct Header {
        uint16 width, height;
        uint16 x, y;
        byte numPlanes;
        byte masking;
        byte compression;
        byte flags;
        uint16 transparentColor;
        byte xAspect, yAspect;
        uint16 pageWidth, pageHeight;
    };

    struct PaletteRange {
        int16  timer, step, flags;
        byte first, last;
    };

    enum Type {
        TYPE_UNKNOWN = 0,
        TYPE_ILBM,
        TYPE_PBM
    };

    IFFDecoder();
    virtual ~IFFDecoder();

    // ImageDecoder API
    void destroy() override;
    bool loadStream(Common::SeekableReadStream &stream) override;
    const Header *getHeader() const { return &_header; }
    const Graphics::Surface *getSurface() const override { return _surface; }
    const Graphics::Palette &getPalette() const override { return _palette; }
    const Common::Array<PaletteRange> &getPaletteRanges() const { return _paletteRanges; }

    void setNumRelevantPlanes(const uint8 numRelevantPlanes) { _numRelevantPlanes = numRelevantPlanes; }

    void setPixelPacking(const bool pixelPacking) { _pixelPacking = pixelPacking; }
private:

    Header _header;
    Graphics::Surface *_surface;
    Graphics::Palette _palette;
    Common::Array<PaletteRange> _paletteRanges;
    Type _type;
    uint8 _numRelevantPlanes;
    bool _pixelPacking;

    void loadHeader(Common::SeekableReadStream &stream);
    void loadPalette(Common::SeekableReadStream &stream, const uint32 size);
    void loadPaletteRange(Common::SeekableReadStream &stream, const uint32 size);
    void loadBitmap(Common::SeekableReadStream &stream);
    void packPixels(byte *scanlines, byte *data, const uint16 scanlinePitch, const uint16 outPitch);
};
} // End of namespace Image

#endif