guest_additions.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 SCI_ENGINE_GUEST_ADDITIONS_H
#define SCI_ENGINE_GUEST_ADDITIONS_H

#include "sci/engine/vm_types.h"

namespace Sci {

struct EngineState;
class GameFeatures;
class Kernel;
class Script;
class SegManager;

enum {
    // The in-game volumes for Phant2 use a volume range smaller than the
    // actual master volume because movie volume needs to be controllable from
    // the normal ScummVM launcher volume controls, but movie dialogue cannot be
    // heard if the game audio is at the same level as movies. The game normally
    // sets defaults so that the in-game volume is 85 and movies are 127, so we
    // will just use 85 as the maximum volume.
    kPhant2VolumeMax       = 85,

    kRamaVolumeMax         = 16,
    kLSL6UIVolumeMax       = 13,
    kHoyle5VolumeMax       = 8,
    kLSL6HiresSubtitleFlag = 105
};

class GuestAdditions {
public:
    GuestAdditions(EngineState *state, GameFeatures *features, Kernel *kernel);

#pragma mark -

    void syncSoundSettingsFromScummVM() const;

    void syncAudioOptionsFromScummVM() const;

    void reset();

private:
    EngineState *_state;
    GameFeatures *_features;
    Kernel *_kernel;
    SegManager *_segMan;

    void invokeSelector(const reg_t objId, const Selector selector, const int argc = 0, const StackPtr argv = nullptr) const;

    bool shouldSyncAudioToScummVM() const;

#pragma mark -
#pragma mark Hooks

public:
    void sciEngineRunGameHook();

    void writeVarHook(const int type, const int index, const reg_t value);

    bool kDoSoundMasterVolumeHook(const int volume) const;

    bool userHasControl();

#ifdef ENABLE_SCI32

    void sciEngineInitGameHook();

    void sendSelectorHook(const reg_t sendObj, Selector &selector, reg_t *argp);

    bool audio32SetVolumeHook(const int16 channelIndex, const int16 volume) const;

    void kDoSoundSetVolumeHook(const reg_t soundObj, const int16 volume) const;

    void instantiateScriptHook(Script &script, const bool ignoreDelayedRestore = false) const;

    void segManSaveLoadScriptHook(Script &script) const;
#endif

    bool kGetEventHook() const;

    bool kWaitHook() const;

#ifdef ENABLE_SCI32

    bool kPlayDuckPlayVMDHook() const;
#endif

#pragma mark -
#pragma mark Integrated save & restore

public:
    void patchGameSaveRestore() const;

private:
    void patchGameSaveRestoreSCI16() const;

#ifdef ENABLE_SCI32
public:
    reg_t kScummVMSaveLoad(EngineState *s, int argc, reg_t *argv) const;

private:
    void patchGameSaveRestoreSCI32(Script &script) const;

    void patchGameSaveRestoreTorin(Script &script) const;

    void patchGameSaveRestorePhant2(Script &script) const;

    void patchGameSaveRestoreRama(Script &script) const;

    void patchSRDialogDoit(Script &script, const char *const objectName, const byte *patchData, const int patchSize, const int *uint16Offsets = nullptr, const uint numOffsets = 0) const;

    reg_t promptSaveRestoreDefault(EngineState *s, int argc, reg_t *argv) const;

    reg_t promptSaveRestoreTorin(EngineState *s, int argc, reg_t *argv) const;

    reg_t promptSaveRestorePhant2(EngineState *s, int argc, reg_t *argv) const;

    reg_t promptSaveRestoreRama(EngineState *s, int argc, reg_t *argv) const;

    reg_t promptSaveRestoreHoyle5(EngineState *s, int argc, reg_t *argv) const;

public:
    int runSaveRestore(const bool isSave, const reg_t outDescription, const int forcedSaveId = -1) const;
    int runSaveRestore(const bool isSave, Common::String &outDescription, const int forcedSaveId = -1) const;
#endif

#pragma mark -
#pragma mark Restore from launcher

private:
    bool restoreFromLauncher() const;

#ifdef ENABLE_SCI32

    mutable bool _restoring;
#endif

#pragma mark -
#pragma mark Message type sync

private:
    bool _messageTypeSynced;

    void syncMessageTypeFromScummVM() const;

    void syncMessageTypeFromScummVMUsingDefaultStrategy() const;

#ifdef ENABLE_SCI32

    void syncMessageTypeFromScummVMUsingShiversStrategy() const;

    void syncMessageTypeFromScummVMUsingLSL6HiresStrategy() const;
#endif

    void syncMessageTypeToScummVM(const int index, const reg_t value);

    void syncMessageTypeToScummVMUsingDefaultStrategy(const int index, const reg_t value);

#ifdef ENABLE_SCI32

    void syncMessageTypeToScummVMUsingShiversStrategy(const int index, const reg_t value);

    void syncMessageTypeToScummVMUsingLSL6HiresStrategy(const reg_t sendObj, Selector &selector, reg_t *argp);
#endif

#pragma mark -
#pragma mark Master volume sync

private:
    void syncMasterVolumeFromScummVM() const;

    void syncMasterVolumeToScummVM(const int16 masterVolume) const;

#pragma mark -
#pragma mark Globals volume sync

private:
    void syncAudioVolumeGlobalsFromScummVM() const;

    void syncLSL6VolumeFromScummVM(const int16 musicVolume) const;

#ifdef ENABLE_SCI32

    void syncGK1StartupVolumeFromScummVM(const int index, const reg_t value) const;

    void syncGK1VolumeFromScummVM(const int16 musicVolume, const int16 dacVolume) const;

    void syncGK2VolumeFromScummVM(const int16 musicVolume) const;
    void syncHoyle5VolumeFromScummVM(const int16 musicVolume) const;
    void syncPhant2VolumeFromScummVM(const int16 masterVolume) const;
    void syncRamaVolumeFromScummVM(const int16 musicVolume) const;
    void syncTorinVolumeFromScummVM(const int16 musicVolume, const int16 sfxVolume, const int16 speechVolume) const;
#endif

    void syncAudioVolumeGlobalsToScummVM(const int index, const reg_t value) const;

#ifdef ENABLE_SCI32

    void syncGK1AudioVolumeToScummVM(const reg_t soundObj, const int16 volume) const;

#pragma mark -
#pragma mark Audio UI sync

private:
    void syncInGameUI(const int16 musicVolume, const int16 sfxVolume) const;

    void syncGK1UI() const;
    void syncGK2UI() const;
    void syncHoyle5UI(const int16 musicVolume) const;
#endif
    void syncLSL6UI(const int16 musicVolume) const;
#ifdef ENABLE_SCI32
    void syncMGDXUI(const int16 musicVolume) const;
    void syncPhant1UI(const int16 oldMusicVolume, const int16 musicVolume, reg_t &musicGlobal, const int16 oldDacVolume, const int16 dacVolume, reg_t &dacGlobal) const;
    void syncPhant2UI(const int16 masterVolume) const;
    void syncPQ4UI(const int16 musicVolume) const;
    void syncPQSWATUI() const;
    void syncQFG4UI(const int16 musicVolume) const;
    void syncRamaUI(const int16 musicVolume) const;
    void syncShivers1UI(const int16 dacVolume) const;
    void syncSQ6UI() const;
    void syncTorinUI(const int16 musicVolume, const int16 sfxVolume, const int16 speechVolume) const;

#pragma mark -
#pragma mark Talk speed sync

private:
    void syncTextSpeedFromScummVM() const;

    void syncTextSpeedToScummVM(const int index, const reg_t value) const;
#endif
};

} // End of namespace Sci

#endif // SCI_ENGINE_GUEST_ADDITIONS_H