display.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 QUEEN_DISPLAY_H
#define QUEEN_DISPLAY_H

#include "common/str.h"
#include "common/util.h"
#include "common/random.h"
#include "queen/defs.h"

class OSystem;

namespace Common {
struct Rect;
}

namespace Queen {

class QueenEngine;

class Display {
public:

    Display(QueenEngine *vm, OSystem *system);
    ~Display();

    void dynalumInit(const char *roomName, uint16 roomNum);

    void dynalumUpdate(int16 x, int16 y);

    void palSet(const uint8 *pal, int start, int end, bool updateScreen = false);

    void palSetJoeDress();

    void palSetJoeNormal();

    void palSetPanel();

    void palFadeIn(uint16 roomNum, bool dynalum = false, int16 dynaX = 0, int16 dynaY = 0);

    void palFadeOut(uint16 roomNum);

    void palGreyPanel();

    void palScroll(int start, int end);

    void palSetAmigaColor(uint8 color, uint16 rgb);

    void palCustomColors(uint16 roomNum);

    void palCustomScroll(uint16 roomNum);

    void palCustomFlash();

    void palCustomLightsOff(uint16 roomNum);
    void palCustomLightsOn(uint16 roomNum);

    void palSetAllDirty() { _pal.dirtyMin = 0; _pal.dirtyMax = 255; }

    int getNumColorsForRoom(uint16 room) const;

    bool isPalFadingDisabled(uint16 room) const;

    void screenMode(int comPanel, bool inCutaway);

    void prepareUpdate();
    void update(bool dynalum = false, int16 dynaX = 0, int16 dynaY = 0);

    void setupPanel();
    void setupNewRoom(const char *name, uint16 room);

    void drawBobSprite(const uint8 *data, uint16 x, uint16 y, uint16 w, uint16 h, uint16 pitch, bool xflip);
    void drawBobPasteDown(const uint8 *data, uint16 x, uint16 y, uint16 w, uint16 h);
    void drawInventoryItem(const uint8 *data, uint16 x, uint16 y, uint16 w, uint16 h);

    void blit(uint8 *dstBuf, uint16 dstPitch, uint16 x, uint16 y, const uint8 *srcBuf, uint16 srcPitch, uint16 w, uint16 h, bool xflip, bool masked);
    void fill(uint8 *dstBuf, uint16 dstPitch, uint16 x, uint16 y, uint16 w, uint16 h, uint8 color);

    void decodePCX(const uint8 *src, uint32 srcSize, uint8 *dst, uint16 dstPitch, uint16 *w, uint16 *h, uint8 *pal, uint16 palStart, uint16 palEnd);

    void decodeIFF(const uint8 *src, uint32 srcSize, uint8 *dst, uint16 dstPitch, uint16 *w, uint16 *h, uint8 *pal, uint16 palStart, uint16 palEnd, uint8 colorBase = 0);

    void horizontalScrollUpdate(int16 xCamera);
    void horizontalScroll(int16 scroll);
    int16 horizontalScroll() const { return _horizontalScroll; }

    void fullscreen(bool fs) { _fullRefresh = 2; _fullscreen = fs; }
    bool fullscreen() const { return _fullscreen; }

    void setDirtyBlock(uint16 x, uint16 y, uint16 w, uint16 h);

    void forceFullRefresh() { _fullRefresh = 2; }

    void setMouseCursor(uint8 *buf, uint16 w, uint16 h);

    void showMouseCursor(bool show);

    void initFont();

    void setText(uint16 x, uint16 y, const char *text, bool outlined = true);

    void setTextCentered(uint16 y, const char *text, bool outlined = true);

    void drawTexts();

    void clearTexts(uint16 y1, uint16 y2);

    void setupInkColors();

    uint8 getInkColor(InkColor color) const { return _inkColors[color]; }

    void textCurrentColor(uint8 color) { _curTextColor = color; }

    void textColor(uint16 y, uint8 color) { _texts[y].color = color; }

    void setFocusRect(const Common::Rect& rect);

    int textCenterX(const char *text) const;
    uint16 textWidth(const char *text) const;
    uint16 textWidth(const char *text, uint16 len) const;
    void drawChar(uint16 x, uint16 y, uint8 color, const uint8 *chr);
    void drawText(uint16 x, uint16 y, uint8 color, const char *text, bool outlined = true);
    void drawBox(int16 x1, int16 y1, int16 x2, int16 y2, uint8 col);

    void shake(bool reset);

    void blankScreen();
    void blankScreenEffect1();
    void blankScreenEffect2();
    void blankScreenEffect3();

private:

    enum {
        FADE_SPEED = 16,
        D_BLOCK_W  =  8,
        D_BLOCK_H  =  8
    };

    enum BufferDimension {
        BACKDROP_W = 640,
        BACKDROP_H = 200,
        SCREEN_W   = 320,
        SCREEN_H   = 200,
        PANEL_W    = 320,
        PANEL_H    =  50
    };

    struct {
        uint8 *room;
        uint8 *screen;
        uint8 *panel;
        int dirtyMin, dirtyMax;
        bool scrollable;
    } _pal;

    struct Dynalum {
        bool valid;
        uint8 *mskBuf;
        uint32 mskSize;
        int8 *lumBuf;
        uint32 lumSize;
        uint8 prevColMask;

        void clear() {
            valid = false;
            mskBuf = nullptr;
            mskSize = 0;
            lumBuf = nullptr;
            lumSize = 0;
            prevColMask = 0;
        }
    };

    struct TextSlot {
        uint16 x;
        uint8 color;
        Common::String text;
        bool outlined;

        void clear() {
            x = 0;
            color = 0;
            text = "";
            outlined = false;
        }
    };

    uint8 *_screenBuf;
    uint8 *_panelBuf;
    uint8 *_backdropBuf;

    uint8 _fullRefresh;
    uint8 *_dirtyBlocks;
    uint16 _dirtyBlocksWidth, _dirtyBlocksHeight;

    bool _fullscreen;

    uint16 _horizontalScroll;
    uint16 _bdWidth, _bdHeight;

    const char *_imageExt;

    TextSlot _texts[GAME_SCREEN_HEIGHT];

    uint8 _curTextColor;

    uint8 _charWidth[256];

    uint8 _inkColors[INK_COUNT];

    Common::RandomSource _rnd;
    Dynalum _dynalum;
    OSystem *_system;
    QueenEngine *_vm;

    const uint8 *_font;

    static const uint8 _fontRegular[];
    static const uint8 _fontHebrew[];
    static const uint8 _fontHebrewAdvBrew[];
    static const uint8 _fontRussian[];
    static const uint8 _fontGreek[];
    static const uint8 _palJoeClothes[];
    static const uint8 _palJoeDress[];
};


} // End of namespace Queen

#endif