sprites.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 MM_SHARED_XEEN_SPRITES_H
#define MM_SHARED_XEEN_SPRITES_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/file.h"
#include "graphics/surface.h"
#include "mm/shared/xeen/file.h"
#include "mm/shared/xeen/xsurface.h"

namespace MM {
namespace Xeen {
class XeenEngine;
class Window;
} // namespace Xeen

namespace Shared {
namespace Xeen {

enum {
    SCALE_MASK = 0x7FFF, SCALE_ENLARGE = 0x8000
};

enum SpriteFlags {
    SPRFLAG_MODE_MASK = 0xF00, SPRFLAG_DRAWER1 = 0x100, SPRFLAG_DRAWER2 = 0x200,
    SPRFLAG_DRAWER3 = 0x300, SPRFLAG_DRAWER4 = 0x400, SPRFLAG_DRAWER5 = 0x500, SPRFLAG_DRAWER6 = 0x600,
    SPRFLAG_DRAWER7 = 0x700, SPRFLAG_800 = 0x800, SPRFLAG_SCENE_CLIPPED = 0x2000,
    SPRFLAG_BOTTOM_CLIPPED = 0x4000, SPRFLAG_HORIZ_FLIPPED = 0x8000, SPRFLAG_RESIZE = 0x10000
};

class SpriteResource {
protected:
    struct IndexEntry {
        uint16 _offset1, _offset2;
    };
    Common::Array<IndexEntry> _index;
    size_t _filesize;
    byte *_data;
    Common::Path _filename;
    static int _clippedBottom;

    void load(Common::SeekableReadStream &f);

    void draw(XSurface &dest, int frame, const Common::Point &destPos,
        const Common::Rect &bounds, uint flags = 0, int scale = 0) const;

    void copy(const SpriteResource &src);
public:
    SpriteResource();
    SpriteResource(const Common::Path &filename);
    SpriteResource(const SpriteResource &src);

    virtual ~SpriteResource();

    SpriteResource &operator=(const SpriteResource &src);

    void load(const Common::Path &filename);

    void clear();

    void draw(XSurface &dest, int frame, const Common::Point &destPos,
        uint flags = 0, int scale = 0) const;

    void draw(XSurface &dest, int frame) const;

    void draw(Graphics::ManagedSurface *dest, int frame, const Common::Point &destPos) const;

    Common::Point getFrameSize(int frame) const;

    size_t size() const {
        return _index.size();
    }

    bool empty() const {
        return _index.size() == 0;
    }

    static void setClippedBottom(int y) {
        _clippedBottom = y;
    }
};

class SpriteDrawer {
private:
    byte *_data = nullptr;
    size_t _filesize = 0;
protected:
    byte *_destTop = nullptr, *_destBottom = nullptr;
    byte *_destLeft = nullptr, *_destRight = nullptr;
    int _pitch = 0;
private:
    static uint getScaledVal(int xy, uint16 &scaleMask);
protected:
    void rcr(uint16 &val, bool &cf);

    virtual void drawPixel(byte *dest, byte pixel);
public:
    SpriteDrawer(byte *data, size_t filesize) : _data(data), _filesize(filesize) {
    }

    virtual ~SpriteDrawer() {
    }

    void draw(XSurface &dest, uint16 offset, const Common::Point &pt,
        const Common::Rect &clipRect, uint flags, int scale);
};

class SpriteDrawer1 : public SpriteDrawer {
private:
    byte _offset = 0, _mask = 0;
protected:
    void drawPixel(byte *dest, byte pixel) override;
public:
    SpriteDrawer1(byte *data, size_t filesize, int index);
};

class SpriteDrawer2 : public SpriteDrawer {
private:
    uint16 _mask1 = 0, _mask2 = 0;
    uint16 _random1 = 0, _random2 = 0;
private:
    void drawPixel(byte *dest, byte pixel) override;
public:
    SpriteDrawer2(byte *data, size_t filesize, int index);
};

class SpriteDrawer3 : public SpriteDrawer {
private:
    uint16 _offset = 0, _mask = 0;
    byte _palette[256 * 3];
    bool _hasPalette = false;
private:
    void drawPixel(byte *dest, byte pixel) override;
public:
    SpriteDrawer3(byte *data, size_t filesize, int index);
};

class SpriteDrawer4 : public SpriteDrawer {
private:
    byte _threshold = 0;
protected:
    void drawPixel(byte *dest, byte pixel) override;
public:
    SpriteDrawer4(byte *data, size_t filesize, int index);
};

class SpriteDrawer5 : public SpriteDrawer {
private:
    uint16 _threshold = 0, _random1 = 0, _random2 = 0;
protected:
    void drawPixel(byte *dest, byte pixel) override;
public:
    SpriteDrawer5(byte *data, size_t filesize, int index);
};

class SpriteDrawer6 : public SpriteDrawer {
private:
    byte _mask = 0;
protected:
    void drawPixel(byte *dest, byte pixel) override;
public:
    SpriteDrawer6(byte *data, size_t filesize, int index);
};

} // End of namespace Xeen
} // End of namespace Shared
} // End of namespace MM

#endif