osystem.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 PLATFORM_3DS_H
#define PLATFORM_3DS_H

#define FORBIDDEN_SYMBOL_EXCEPTION_time_h

#include "backends/base-backend.h"
#include "graphics/paletteman.h"
#include "base/main.h"
#include "audio/mixer_intern.h"
#include "backends/graphics/graphics.h"
#include "backends/log/log.h"
#include "backends/platform/3ds/sprite.h"
#include "common/rect.h"
#include "common/queue.h"
#include "common/ustr.h"
#include "engines/engine.h"

#define TICKS_PER_MSEC 268123

namespace N3DS {

enum MagnifyMode {
    MODE_MAGON,
    MODE_MAGOFF,
};

enum InputMode {
    MODE_HOVER,
    MODE_DRAG,
};

enum GraphicsModeID {
    RGBA8,
    RGB565,
    RGB555,
    RGB5A1,
    CLUT8
};

enum Screen {
    kScreenTop = 0x10000002,
    kScreenBottom,
    kScreenBoth,
};

enum TransactionState {
    kTransactionNone = 0,
    kTransactionActive = 1,
    kTransactionRollback = 2
};


struct TransactionDetails {
    bool formatChanged, modeChanged;

    TransactionDetails() {
        formatChanged = false;
        modeChanged = false;
    }
};

typedef struct GfxMode3DS {
    Graphics::PixelFormat surfaceFormat;
    GPU_TEXCOLOR textureFormat;
    uint32 textureTransferFlags;
} GfxMode3DS;

struct GfxState {
    bool setup;
    GraphicsModeID gfxModeID;
    const GfxMode3DS *gfxMode;

    GfxState() {
        setup = false;
        gfxModeID = CLUT8;
    }
};


class OSystem_3DS : public EventsBaseBackend, public PaletteManager, public Common::EventObserver {
public:
    OSystem_3DS();
    virtual ~OSystem_3DS();

    volatile bool exiting;
    volatile bool sleeping;

    virtual void initBackend();

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

    bool pollEvent(Common::Event &event) override;
    bool notifyEvent(const Common::Event &event) override;
    Common::HardwareInputSet *getHardwareInputSet() override;
    Common::KeymapArray getGlobalKeymaps() override;
    Common::KeymapperDefaultBindings *getKeymapperDefaultBindings() override;

    void registerDefaultSettings(const Common::String &target) const override;
    GUI::OptionsContainerWidget *buildBackendOptionsWidget(GUI::GuiObject *boss, const Common::String &name, const Common::String &target) const override;
    void applyBackendSettings() override;

    virtual uint32 getMillis(bool skipRecord = false);
    virtual void delayMillis(uint msecs);
    virtual void getTimeAndDate(TimeDate &td, bool skipRecord = false) const;

    virtual Common::MutexInternal *createMutex();

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

    virtual Audio::Mixer *getMixer();
    virtual PaletteManager *getPaletteManager() { return this; }
    virtual Common::String getSystemLanguage() const;
    virtual void fatalError();
    virtual void quit();

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

    // Graphics
    inline Graphics::PixelFormat getScreenFormat() const { return _pfGame; }
    virtual Common::List<Graphics::PixelFormat> getSupportedFormats() const;
    void initSize(uint width, uint height,
                  const Graphics::PixelFormat *format = NULL);
    virtual int getScreenChangeID() const { return _screenChangeId; };
    GraphicsModeID chooseMode(Graphics::PixelFormat *format);
    bool setGraphicsMode(GraphicsModeID modeID);

    void beginGFXTransaction();
    OSystem::TransactionError endGFXTransaction();
    int16 getHeight(){ return _gameHeight; }
    int16 getWidth(){ return _gameWidth; }
    float getScaleRatio() const;
    void setPalette(const byte *colors, uint start, uint num);
    void grabPalette(byte *colors, uint start, uint num) const;
    void copyRectToScreen(const void *buf, int pitch, int x, int y, int w,
                          int h);
    Graphics::Surface *lockScreen();
    void unlockScreen();
    void updateScreen();
    void setShakePos(int shakeXOffset, int shakeYOffset);
    void setFocusRectangle(const Common::Rect &rect);
    void clearFocusRectangle();
    void showOverlay(bool inGUI);
    void hideOverlay();
    bool isOverlayVisible() const { return _overlayVisible; }
    Graphics::PixelFormat getOverlayFormat() const;
    void clearOverlay();
    void grabOverlay(Graphics::Surface &surface);
    void copyRectToOverlay(const void *buf, int pitch, int x, int y, int w,
                           int h);
    virtual int16 getOverlayHeight();
    virtual int16 getOverlayWidth();
    void displayMessageOnOSD(const Common::U32String &msg) override;
    void displayActivityIconOnOSD(const Graphics::Surface *icon) override;

    bool showMouse(bool visible);
    void warpMouse(int x, int y);
    void setMouseCursor(const void *buf, uint w, uint h, int hotspotX,
                        int hotspotY, uint32 keycolor, bool dontScale = false,
                        const Graphics::PixelFormat *format = NULL, const byte *mask = NULL);
    void setCursorPalette(const byte *colors, uint start, uint num);

    // Transform point from touchscreen coords into gamescreen coords
    void transformPoint(touchPosition &point);
    // Clip point to gamescreen coords
    void clipPoint(touchPosition &point);

    void setCursorDelta(float deltaX, float deltaY);

    void updateFocus();
    void updateMagnify();
    void updateBacklight();
    void updateConfig();
    void updateSize();

private:
    void init3DSGraphics();
    void destroy3DSGraphics();
    void initAudio();
    void destroyAudio();
    void initEvents();
    void destroyEvents();

    void flushGameScreen();
    void flushCursor();

    virtual Common::Path getDefaultLogFileName();
    virtual Common::WriteStream *createLogFile();

protected:
    Audio::MixerImpl *_mixer;
    Backends::Log::Log *_logger;

private:
    u16 _gameWidth, _gameHeight;
    u16 _gameTopX, _gameTopY;
    u16 _gameBottomX, _gameBottomY;

    // Audio
    Thread audioThread;

    // Graphics
    GraphicsModeID _graphicsModeID;
    TransactionState _transactionState;
    TransactionDetails _transactionDetails;

    GfxState _gfxState, _oldGfxState;
    Graphics::PixelFormat _pfDefaultTexture;
    Graphics::PixelFormat _pfGame, _oldPfGame;
    Graphics::PixelFormat _pfCursor;
    byte _palette[3 * 256];
    byte _cursorPalette[3 * 256];
    uint32 _paletteMap[256];

    Graphics::Surface _gameScreen;
    bool _gameTextureDirty;
    Sprite _gameTopTexture;
    Sprite _gameBottomTexture;
    Sprite _overlay;
    Sprite _activityIcon;
    Sprite _osdMessage;
    bool _filteringEnabled;

    enum {
        kOSDMessageDuration = 800
    };
    uint32 _osdMessageEndTime;

    int _screenShakeXOffset;
    int _screenShakeYOffset;
    bool _overlayVisible;
    bool _overlayInGUI;
    int _screenChangeId;

    DVLB_s *_dvlb;
    shaderProgram_s _program;
    int _projectionLocation;
    int _modelviewLocation;
    C3D_Mtx _projectionTop;
    C3D_Mtx _projectionBottom;
    C3D_RenderTarget* _renderTargetTop;
    C3D_RenderTarget* _renderTargetBottom;

    // Focus
    Common::Rect _focusRect;
    bool _focusDirty;
    C3D_Mtx _focusMatrix;
    int _focusPosX, _focusPosY;
    int _focusTargetPosX, _focusTargetPosY;
    float _focusStepPosX, _focusStepPosY;
    float _focusScaleX, _focusScaleY;
    float _focusTargetScaleX, _focusTargetScaleY;
    float _focusStepScaleX, _focusStepScaleY;
    uint32 _focusClearTime;

    // Events
    Thread _eventThread;
    Thread _timerThread;
    Common::Queue<Common::Event> _eventQueue;

    // Cursor
    Graphics::Surface _cursor;
    Sprite _cursorTexture;
    bool _cursorPaletteEnabled;
    bool _cursorVisible;
    bool _cursorScalable;
    float _cursorScreenX, _cursorScreenY;
    float _cursorOverlayX, _cursorOverlayY;
    float _cursorDeltaX, _cursorDeltaY;
    int _cursorHotspotX, _cursorHotspotY;
    uint32 _cursorKeyColor;

    // Magnify
    MagnifyMode _magnifyMode;
    u16 _magX, _magY;
    u16 _magWidth, _magHeight;
    u16 _magCenterX, _magCenterY;

    Common::Path _logFilePath;

public:
    // Pause
    PauseToken _sleepPauseToken;

    bool _showCursor;
    bool _snapToBorder;
    bool _stretchToFit;
    Screen _screen;
};

} // namespace N3DS

#endif