osystem_ds.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 _OSYSTEM_DS_H_
#define _OSYSTEM_DS_H_

#include "backends/modular-backend.h"
#include "backends/events/ds/ds-events.h"
#include "backends/mixer/mixer.h"
#include "backends/platform/ds/background.h"
#include "backends/platform/ds/keyboard.h"
#include "graphics/surface.h"
#include "graphics/paletteman.h"

enum {
    GFX_NOSCALE = 0,
    GFX_HWSCALE = 1,
    GFX_SWSCALE = 2
};

class OSystem_DS : public ModularMixerBackend, public PaletteManager {
protected:
    enum TransactionMode {
        kTransactionNone = 0,
        kTransactionActive = 1,
        kTransactionRollback = 2
    };

    TransactionMode _transactionMode;

    //
    // Transaction support
    //
    struct VideoState {
        constexpr VideoState() : width(0), height(0), format(),
            graphicsMode(GFX_HWSCALE), stretchMode(100) {
        }

        uint width, height;
        Graphics::PixelFormat format;
        int graphicsMode;
        int stretchMode;
    };

    VideoState _currentState;

    VideoState _oldState;

    int _screenChangeID;

    Graphics::Surface _framebuffer, _overlay;
    DS::Background *_screen, *_overlayScreen;
#ifdef DISABLE_TEXT_CONSOLE
    DS::Background *_subScreen;
    DS::TiledBackground *_banner;
#endif
    bool _subScreenActive;
    Graphics::Surface _cursor;
    bool _hiresHack;
    bool _paletteDirty, _cursorDirty;

    static OSystem_DS *_instance;

    u16 _palette[256];
    u16 _cursorPalette[256];

    u16 *_cursorSprite;
    Common::Point _cursorPos;
    int _cursorHotX;
    int _cursorHotY;
    uint32 _cursorKey;
    bool _cursorVisible;
    bool _overlayInGUI;

    DSEventSource *_eventSource;
    DS::Keyboard *_keyboard;

    void initGraphics();

    bool _disableCursorPalette;

    const Graphics::PixelFormat _pfCLUT8, _pfABGR1555;

    bool _engineRunning;

public:
    OSystem_DS();
    virtual ~OSystem_DS();

    static OSystem_DS *instance() { return _instance; }

    virtual bool hasFeature(Feature f);
    virtual void setFeatureState(Feature f, bool enable);
    virtual bool getFeatureState(Feature f);

    virtual const OSystem::GraphicsMode *getSupportedGraphicsModes() const;
    virtual int getDefaultGraphicsMode() const;
    virtual bool setGraphicsMode(int mode, uint flags);
    virtual int getGraphicsMode() const;

    virtual const GraphicsMode *getSupportedStretchModes() const;
    virtual int getDefaultStretchMode() const;
    virtual bool setStretchMode(int mode);
    virtual int getStretchMode() const;

    virtual Graphics::PixelFormat getScreenFormat() const;
    virtual Common::List<Graphics::PixelFormat> getSupportedFormats() const;

    virtual void beginGFXTransaction();
    virtual OSystem::TransactionError endGFXTransaction();

    virtual int getScreenChangeID() const;

    virtual void initSize(uint width, uint height, const Graphics::PixelFormat *format);
    virtual int16 getHeight();
    virtual int16 getWidth();

    virtual PaletteManager *getPaletteManager() { return this; }
protected:
    // PaletteManager API
    virtual void setPalette(const byte *colors, uint start, uint num);
    virtual void grabPalette(byte *colors, uint start, uint num) const;

public:
    virtual void copyRectToScreen(const void *buf, int pitch, int x, int y, int w, int h);
    virtual void updateScreen();
    virtual void setShakePos(int shakeXOffset, int shakeYOffset);

    virtual void showOverlay(bool inGUI);
    virtual void hideOverlay();
    virtual bool isOverlayVisible() const;
    virtual void clearOverlay();
    virtual void grabOverlay(Graphics::Surface &surface);
    virtual void copyRectToOverlay(const void *buf, int pitch, int x, int y, int w, int h);
    virtual int16 getOverlayHeight() const;
    virtual int16 getOverlayWidth() const;
    virtual Graphics::PixelFormat getOverlayFormat() const;

    Common::Point transformPoint(int16 x, int16 y);
    virtual bool showMouse(bool visible);

    virtual void warpMouse(int x, int y);
    virtual void setMouseCursor(const void *buf, uint w, uint h, int hotspotX, int hotspotY, u32 keycolor, bool dontScale, const Graphics::PixelFormat *format, const byte *mask);

    virtual void addSysArchivesToSearchSet(Common::SearchSet &s, int priority);

    virtual uint32 getMillis(bool skipRecord = false);
    virtual void delayMillis(uint msecs);
    virtual void getTimeAndDate(TimeDate &td, bool skipRecord = false) const;
    void doTimerCallback(int interval = 10);
    virtual Common::MutexInternal *createMutex();

    virtual Common::EventSource *getDefaultEventSource() { return _eventSource; }
    virtual Common::HardwareInputSet *getHardwareInputSet();

    virtual Common::String getSystemLanguage() const;

    virtual void engineInit();
    virtual void engineDone();
    virtual void quit();

    virtual void setFocusRectangle(const Common::Rect& rect);
    virtual void clearFocusRectangle();

    virtual void initBackend();

    virtual Graphics::Surface *lockScreen();
    virtual void unlockScreen();

    virtual void setCursorPalette(const byte *colors, uint start, uint num);

    void setSwapLCDs(bool swap);

    void refreshCursor(u16 *dst, const Graphics::Surface &src, const uint16 *palette);

    virtual void logMessage(LogMessageType::Type type, const char *message);
    virtual void messageBox(LogMessageType::Type type, const char *message);

    void setMainScreen(int32 x, int32 y, int32 sx, int32 sy);
    void setSubScreen(int32 x, int32 y, int32 sx, int32 sy);

    int _currentTimeMillis, _callbackTimer;
};

#endif