voyeur.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 VOYEUR_VOYEUR_H
#define VOYEUR_VOYEUR_H

#include "voyeur/debugger.h"
#include "voyeur/data.h"
#include "voyeur/events.h"
#include "voyeur/files.h"
#include "voyeur/screen.h"
#include "voyeur/sound.h"
#include "common/scummsys.h"
#include "common/system.h"
#include "common/error.h"
#include "common/random.h"
#include "common/savefile.h"
#include "common/serializer.h"
#include "common/util.h"
#include "engines/engine.h"
#include "graphics/surface.h"

namespace Voyeur {

#define DEBUG_BASIC 1
#define DEBUG_INTERMEDIATE 2
#define DEBUG_DETAILED 3

// Constants used for doInterface display of the mansion
#define MANSION_MAX_X 784
#define MANSION_MAX_Y 150
#define MANSION_VIEW_X 40
#define MANSION_VIEW_Y 27
#define MANSION_VIEW_WIDTH 240
#define MANSION_VIEW_HEIGHT 148
#define MANSION_SCROLL_AREA_X 20
#define MANSION_SCROLL_AREA_Y 20
#define MANSION_SCROLL_INC_X 4
#define MANSION_SCROLL_INC_Y 4

enum VoyeurDebugChannels {
    kDebugScripts   = 1 << 0
};

enum VoyeurArea { AREA_NONE, AREA_APARTMENT, AREA_INTERFACE, AREA_ROOM, AREA_EVIDENCE };

struct VoyeurGameDescription;

class VoyeurEngine : public Engine {
private:
    const VoyeurGameDescription *_gameDescription;
    Common::RandomSource _randomSource;
    FontInfoResource _defaultFontInfo;

    void ESP_Init();
    void globalInitBolt();
    void initBolt();
    void vInitInterrupts();
    void initInput();

    bool doHeadTitle();
    void showConversionScreen();
    bool doLock();
    void showTitleScreen();
    void doOpening();

    void playStamp();
    void initStamp();
    void closeStamp();

    void showLogo8Intro();

    void doTailTitle();

    void doClosingCredits();

    void doPiracy();

    void reviewTape();

    void doGossip();

    void doTapePlaying();

    bool checkForMurder();

    bool checkForIncriminate();

    void playAVideoEvent(int eventIndex);

    int getChooseButton();

    void synchronize(Common::Serializer &s);

    void centerMansionView();
protected:
    // Engine APIs
    Common::Error run() override;
    bool hasFeature(EngineFeature f) const override;
public:
    BoltFile *_bVoy;
    Debugger *_debugger;
    EventsManager *_eventsManager;
    FilesManager *_filesManager;
    Screen *_screen;
    SoundManager *_soundManager;
    SVoy *_voy;

    BoltFile *_stampLibPtr;
    BoltGroup *_controlGroupPtr;
    ControlResource *_controlPtr;
    byte *_stampData;
    BoltGroup *_stackGroupPtr;
    int _glGoState;
    int _glGoStack;
    int _stampFlags;
    int _playStampGroupId;
    int _currentVocId;

    int _audioVideoId;
    const int *_resolvePtr;
    int _iForceDeath;
    int _checkTransitionId;
    int _gameHour;
    int _gameMinute;
    int _flashTimeVal;
    bool _flashTimeFlag;
    int _timeBarVal;
    int _checkPhoneVal;
    Common::Point _mansionViewPos;
    ThreadResource *_mainThread;
    VoyeurArea _voyeurArea;
    int _loadGameSlot;
public:
    VoyeurEngine(OSystem *syst, const VoyeurGameDescription *gameDesc);
    ~VoyeurEngine() override;
    void GUIError(const Common::String &msg);

    uint32 getFeatures() const;
    Common::Language getLanguage() const;
    Common::Platform getPlatform() const;
    uint16 getVersion() const;
    bool getIsDemo() const;

    int getRandomNumber(int maxNumber);
    bool canLoadGameStateCurrently(Common::U32String *msg = nullptr) override;
    bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) override;
    Common::Error loadGameState(int slot) override;
    Common::Error saveGameState(int slot, const Common::String &desc, bool isAutosave = false) override;
    void loadGame(int slot);

    void playRL2Video(const Common::Path &filename);
    void doTransitionCard(const Common::String &time, const Common::String &location);

    void playAVideo(int videoId);

    void playAVideoDuration(int videoId, int duration);

    void playAudio(int audioId);

    void makeViewFinder();
    void makeViewFinderP();
    void initIFace();
    void checkTransition();
    int doComputerText(int maxLen);
    void getComputerBrush();

    void doTimeBar();

    void flashTimeBar();

    void doScroll(const Common::Point &pt);

    void checkPhoneCall();

    void doEvidDisplay(int evidId, int eventId);

    void flipPageAndWait();

    void flipPageAndWaitForFade();

    Common::String getDayName();

    Common::String getTimeOfDay();

    void showEndingNews();
};

#define VOYEUR_SAVEGAME_VERSION 3

struct VoyeurSavegameHeader {
    uint8 _version;
    Common::String _saveName;
    Graphics::Surface *_thumbnail;
    int _saveYear, _saveMonth, _saveDay;
    int _saveHour, _saveMinutes;
    int _totalFrames;

    bool read(Common::InSaveFile *f, bool skipThumbnail = true);

    void write(Common::OutSaveFile *f, VoyeurEngine *vm, const Common::String &saveName);
};

} // End of namespace Voyeur

#endif /* VOYEUR_VOYEUR_H */