picture.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 AGI_PICTURE_H
#define AGI_PICTURE_H

namespace Agi {

#define _DEFAULT_WIDTH      160
#define _DEFAULT_HEIGHT     168

struct AgiPicture {
    uint32 flen;            
    uint8 *rdata;           
    void reset() {
        flen = 0;
        rdata = nullptr;
    }

    AgiPicture() { reset(); }
};

// AGI picture version
enum AgiPictureVersion {
    AGIPIC_C64,
    AGIPIC_V1,
    AGIPIC_V15,
    AGIPIC_V2,
    AGIPIC_256
};

enum AgiPictureFlags {
    kPicFNone      = (1 << 0),
    kPicFCircle    = (1 << 1),
    kPicFStep      = (1 << 2),
    kPicFf3Stop    = (1 << 3),
    kPicFf3Cont    = (1 << 4),
    kPicFTrollMode = (1 << 5)
};

class AgiBase;
class GfxMgr;

class PictureMgr {
    AgiBase *_vm;
    GfxMgr *_gfx;

public:
    PictureMgr(AgiBase *agi, GfxMgr *gfx);

    int16 getResourceNr() const { return _resourceNr; };

private:
    void xCorner(bool skipOtherCoords = false);
    void yCorner(bool skipOtherCoords = false);
    void plotBrush();

    byte getNextByte();
    bool getNextParamByte(byte &b);
    byte getNextNibble();

public:
    void putVirtPixel(int x, int y);

    void decodePicture(int16 resourceNr, bool clearScreen, bool agi256 = false, int16 width = _DEFAULT_WIDTH, int16 height = _DEFAULT_HEIGHT);
    void decodePictureFromBuffer(byte *data, uint32 length, bool clearScreen, int16 width = _DEFAULT_WIDTH, int16 height = _DEFAULT_HEIGHT);
    void unloadPicture(int picNr);
    void drawPicture();
private:
    void drawPictureC64();
    void drawPictureV1();
    void drawPictureV15();
    void drawPictureV2();
    void drawPictureAGI256();

    void draw_SetColor();
    void draw_SetPriority();
    void draw_SetNibbleColor();
    void draw_SetNibblePriority();

    void draw_Line(int16 x1, int16 y1, int16 x2, int16 y2);
    void draw_LineShort();
    void draw_LineAbsolute();

    bool draw_FillCheck(int16 x, int16 y);
    void draw_Fill(int16 x, int16 y);
    void draw_Fill();

public:
    void showPic(); // <-- for regular AGI games
    void showPic(int16 x, int16 y, int16 pic_width, int16 pic_height); // <-- for preAGI games
    void showPicWithTransition();

    void plotPattern(int x, int y);     // public because it's used directly by preagi

    void setPattern(uint8 code, uint8 num);

    void setPictureVersion(AgiPictureVersion version);
    void setPictureData(uint8 *data, int len = 4096);

    void setPictureFlags(int flags) { _flags = flags; }

    void clear();

    void setOffset(int offX, int offY) {
        _xOffset = offX;
        _yOffset = offY;
    }

    void setDimensions(int w, int h) {
        _width = w;
        _height = h;
    }

private:
    int16  _resourceNr;
    uint8 *_data;
    uint32 _dataSize;
    uint32 _dataOffset;
    bool   _dataOffsetNibble;

    uint8 _patCode;
    uint8 _patNum;
    uint8 _priOn;
    uint8 _scrOn;
    uint8 _scrColor;
    uint8 _priColor;

    uint8 _minCommand;

    AgiPictureVersion _pictureVersion;
    int16 _width;
    int16 _height;
    int16 _xOffset;
    int16 _yOffset;

    int _flags;
    int _currentStep;
};

} // End of namespace Agi

#endif /* AGI_PICTURE_H */