image_file.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 SHERLOCK_IMAGE_FILE_H
#define SHERLOCK_IMAGE_FILE_H

#include "common/array.h"
#include "common/file.h"
#include "common/path.h"
#include "common/rect.h"
#include "common/stream.h"
#include "graphics/surface.h"

namespace Sherlock {

class SherlockEngine;

struct ImageFrame {
    uint32 _pos;
    byte _decoded;
    uint32 _size;
    uint16 _width, _height;
    int _paletteBase;
    bool _rleEncoded;
    Common::Point _offset;
    byte _rleMarker;
    Graphics::Surface _frame;

    operator const Graphics::Surface &() { return _frame; }

    void decompressFrame(const byte *src, bool isRoseTattoo);

    int sDrawXSize(int scaleVal) const;

    int sDrawYSize(int scaleVal) const;

    int sDrawXOffset(int scaleVal) const;

    int sDrawYOffset(int scaleVal) const;
};

class ImageFile {
private:
    static SherlockEngine *_vm;
    Common::Array<ImageFrame> _frames;
    Common::Path _name;
    Common::SeekableReadStream *_stream;

    void load(Common::SeekableReadStream &stream, bool skipPalette, bool animImages);

    void loadPalette(Common::SeekableReadStream &stream);
protected:
    virtual void decodeFrame(ImageFrame &frame);
public:
    ImageFrame& operator[](uint index);
    uint size();
    void push_back(const ImageFrame &frame);

    byte _palette[256 * 3];
public:
    ImageFile();
    ImageFile(const Common::Path &name, bool skipPal = false, bool animImages = false);
    ImageFile(Common::SeekableReadStream &stream, bool skipPal = false);
    virtual ~ImageFile();
    static void setVm(SherlockEngine *vm);
};

enum ImageFile3DOType {
    kImageFile3DOType_Animation    = 0,
    kImageFile3DOType_Cel          = 1,
    kImageFile3DOType_CelAnimation = 2,
    kImageFile3DOType_RoomFormat   = 3,
    kImageFile3DOType_Font         = 4
};

struct ImageFile3DOPixelLookupTable {
    uint16 pixelColor[256];
};

class ImageFile3DO : public ImageFile { // Common::Array<ImageFrame> {
private:
    static SherlockEngine *_vm;

    void load(Common::SeekableReadStream &stream, bool isRoomData);

    inline uint16 convertPixel(uint16 pixel3DO);

    void load3DOCelFile(Common::SeekableReadStream &stream);

    void load3DOCelRoomData(Common::SeekableReadStream &stream);

    inline uint16 celGetBits(const byte *&dataPtr, byte bitCount, byte &dataBitsLeft);

    void decompress3DOCelFrame(ImageFrame &frame, const byte *dataPtr, uint32 dataSize, byte bitsPerPixel, ImageFile3DOPixelLookupTable *pixelLookupTable);

    void loadAnimationFile(Common::SeekableReadStream &stream);

    void loadFont(Common::SeekableReadStream &stream);

protected:
    void decodeFrame(ImageFrame &frame);

public:
    ImageFile3DO(const Common::Path &name, ImageFile3DOType imageFile3DOType);
    ImageFile3DO(Common::SeekableReadStream &stream, bool isRoomData = false);
    static void setVm(SherlockEngine *vm);
};

#define STREAMING_BUFFER_SIZE 65536

class StreamingImageFile {
private:
    int _frameNumber;
    Common::SeekableReadStream *_stream;
    byte _buffer[STREAMING_BUFFER_SIZE];
    bool _compressed;
    bool _active;
public:
    ImageFrame _imageFrame;

    Common::Point _position;        // Animation position
    Common::Rect _oldBounds;        // Bounds of previous frame
    Common::Rect _removeBounds;     // Remove area for just drawn frame

    int _flags;                     // Flags
    int _scaleVal;                  // Specifies the scale amount
    int _zPlacement;                // Used by doBgAnim for determining Z order
public:
    StreamingImageFile();
    ~StreamingImageFile();

    void load(Common::SeekableReadStream *stream, bool compressed);

    void close();

    bool getNextFrame();

    bool active() const { return _active; }

    int frameNumber() const { return _frameNumber; }
};

} // End of namespace Sherlock

#endif