screen.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_SCREEN_H
#define SHERLOCK_SCREEN_H

#include "common/list.h"
#include "common/rect.h"
#include "sherlock/image_file.h"
#include "sherlock/surface.h"
#include "sherlock/resources.h"
#include "sherlock/saveload.h"

namespace Sherlock {

#define VGA_COLOR_TRANS(x) ((x) * 255 / 63)
#define BG_GREYSCALE_RANGE_END 229
#define BLACK 0

class SherlockEngine;

class Screen : public BaseSurface {
private:
    uint32 _transitionSeed;

    // Rose Tattoo fields
    int _fadeBytesRead, _fadeBytesToRead;
    int _oldFadePercent;
protected:
    SherlockEngine *_vm;
    Surface _backBuffer;

public:
    Surface _backBuffer1, _backBuffer2;
    bool _fadeStyle;
    byte _cMap[PALETTE_SIZE];
    byte _sMap[PALETTE_SIZE];
    byte _tMap[PALETTE_SIZE];
    bool _flushScreen;
    Common::Point _currentScroll;
public:
    static Screen *init(SherlockEngine *vm);
    Screen(SherlockEngine *vm);
    ~Screen() override;

    Surface *getBackBuffer() { return &_backBuffer; }

    void activateBackBuffer1();

    void activateBackBuffer2();

    int equalizePalette(const byte palette[PALETTE_SIZE]);

    void fadeToBlack(int speed = 2);

    void fadeIn(const byte palette[PALETTE_SIZE], int speed = 2);

    void randomTransition();

    void verticalTransition();

    void print(const Common::Point &pt, uint color, MSVC_PRINTF const char *formatStr, ...) GCC_PRINTF(4, 5);

    void gPrint(const Common::Point &pt, uint color, MSVC_PRINTF const char *formatStr, ...) GCC_PRINTF(4, 5);

    void restoreBackground(const Common::Rect &r);

    void slamArea(int16 xp, int16 yp, int16 width, int16 height);

    void slamRect(const Common::Rect &r);

    void flushImage(ImageFrame *frame, const Common::Point &pt, int16 *xp, int16 *yp,
        int16 *width, int16 *height);

    void flushScaleImage(ImageFrame *frame, const Common::Point &pt, int16 *xp, int16 *yp,
        int16 *width, int16 *height, int scaleVal);

    void flushImage(ImageFrame *frame, const Common::Point &pt, Common::Rect &newBounds, int scaleVal);

    void blockMove(const Common::Rect &r);

    void blockMove();

    void vgaBar(const Common::Rect &r, int color);

    void setDisplayBounds(const Common::Rect &r);

    void resetDisplayBounds();

    Common::Rect getDisplayBounds();

    void synchronize(Serializer &s);

    void writeString(const Common::String &str, const Common::Point &pt, uint overrideColor);


    // Rose Tattoo specific methods
    void initPaletteFade(int bytesToRead);

    int fadeRead(Common::SeekableReadStream &stream, byte *buf, int totalSize);

    static void translatePalette(byte palette[PALETTE_SIZE]);
};

} // End of namespace Sherlock

#endif