2012-04-25 02:49:49 +00:00
|
|
|
/* 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 2
|
|
|
|
* of the License, or (at your option) any later version.
|
2014-02-18 01:34:26 +00:00
|
|
|
*
|
2012-04-25 02:49:49 +00:00
|
|
|
* 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.
|
2014-02-18 01:34:26 +00:00
|
|
|
*
|
2012-04-25 02:49:49 +00:00
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2016-05-17 16:20:01 +00:00
|
|
|
#ifndef TONY_TONY_H
|
|
|
|
#define TONY_TONY_H
|
2012-04-25 02:49:49 +00:00
|
|
|
|
|
|
|
#include "common/scummsys.h"
|
|
|
|
#include "common/system.h"
|
2012-04-29 01:23:02 +00:00
|
|
|
#include "common/array.h"
|
2012-05-11 13:15:59 +00:00
|
|
|
#include "common/coroutines.h"
|
2012-04-25 02:49:49 +00:00
|
|
|
#include "common/error.h"
|
2012-04-25 23:43:55 +00:00
|
|
|
#include "common/random.h"
|
2012-04-25 02:49:49 +00:00
|
|
|
#include "common/util.h"
|
|
|
|
#include "engines/engine.h"
|
2013-12-07 02:32:29 +00:00
|
|
|
#include "gui/debugger.h"
|
2012-04-25 02:49:49 +00:00
|
|
|
|
2012-04-26 15:32:46 +00:00
|
|
|
#include "tony/mpal/mpal.h"
|
2012-04-29 13:19:30 +00:00
|
|
|
#include "tony/mpal/memory.h"
|
2012-05-21 14:29:27 +00:00
|
|
|
#include "tony/debugger.h"
|
2012-05-04 11:30:45 +00:00
|
|
|
#include "tony/gfxengine.h"
|
2012-04-29 13:19:30 +00:00
|
|
|
#include "tony/loc.h"
|
2012-04-29 01:01:40 +00:00
|
|
|
#include "tony/utils.h"
|
2012-04-30 13:16:19 +00:00
|
|
|
#include "tony/window.h"
|
2012-05-13 12:34:40 +00:00
|
|
|
#include "tony/globals.h"
|
2012-04-25 23:43:55 +00:00
|
|
|
|
2012-04-25 02:49:49 +00:00
|
|
|
/**
|
|
|
|
* This is the namespace of the Tony engine.
|
|
|
|
*
|
|
|
|
* Status of this engine: In Development
|
|
|
|
*
|
|
|
|
* Games using this engine:
|
|
|
|
* - Tony Tough
|
|
|
|
*/
|
|
|
|
namespace Tony {
|
|
|
|
|
2012-04-25 23:43:55 +00:00
|
|
|
using namespace MPAL;
|
|
|
|
|
2012-05-13 12:34:40 +00:00
|
|
|
class Globals;
|
|
|
|
|
2012-04-25 02:49:49 +00:00
|
|
|
enum {
|
|
|
|
kTonyDebugAnimations = 1 << 0,
|
|
|
|
kTonyDebugActions = 1 << 1,
|
|
|
|
kTonyDebugSound = 1 << 2,
|
2012-05-19 10:29:53 +00:00
|
|
|
kTonyDebugMusic = 1 << 3,
|
|
|
|
kTonyDebugMPAL = 1 << 4
|
2012-04-25 02:49:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#define DEBUG_BASIC 1
|
|
|
|
#define DEBUG_INTERMEDIATE 2
|
|
|
|
#define DEBUG_DETAILED 3
|
|
|
|
|
|
|
|
struct TonyGameDescription;
|
|
|
|
|
2012-11-12 00:39:20 +00:00
|
|
|
#define MAX_SFX_CHANNELS 32
|
2012-08-26 21:33:46 +00:00
|
|
|
#define TONY_DAT_VER_MAJ 0
|
2012-09-28 08:50:20 +00:00
|
|
|
#define TONY_DAT_VER_MIN 3
|
2012-05-03 14:11:38 +00:00
|
|
|
|
2012-04-29 01:23:02 +00:00
|
|
|
struct VoiceHeader {
|
2012-06-04 21:45:36 +00:00
|
|
|
int _offset;
|
|
|
|
int _code;
|
|
|
|
int _parts;
|
2012-04-29 01:23:02 +00:00
|
|
|
};
|
|
|
|
#define VOICE_HEADER_SIZE 12
|
|
|
|
|
2012-04-25 02:49:49 +00:00
|
|
|
class TonyEngine : public Engine {
|
2012-04-25 23:43:55 +00:00
|
|
|
private:
|
2012-06-04 21:45:36 +00:00
|
|
|
Common::ErrorCode init();
|
2012-08-26 21:33:46 +00:00
|
|
|
bool loadTonyDat();
|
2012-06-04 21:45:36 +00:00
|
|
|
void initMusic();
|
|
|
|
void closeMusic();
|
|
|
|
bool openVoiceDatabase();
|
|
|
|
void closeVoiceDatabase();
|
|
|
|
void initCustomFunctionMap();
|
|
|
|
static void playProcess(CORO_PARAM, const void *param);
|
2012-06-19 10:50:48 +00:00
|
|
|
static void doNextMusic(CORO_PARAM, const void *param);
|
|
|
|
|
2012-04-25 02:49:49 +00:00
|
|
|
protected:
|
|
|
|
// Engine APIs
|
2020-02-09 11:05:33 +00:00
|
|
|
Common::Error run() override;
|
|
|
|
bool hasFeature(EngineFeature f) const override;
|
2012-04-25 23:43:55 +00:00
|
|
|
public:
|
2012-06-04 21:45:36 +00:00
|
|
|
LPCUSTOMFUNCTION _funcList[300];
|
|
|
|
Common::String _funcListStrings[300];
|
2012-04-25 23:43:55 +00:00
|
|
|
Common::RandomSource _randomSource;
|
2012-04-29 01:01:40 +00:00
|
|
|
RMResUpdate _resUpdate;
|
2012-06-04 21:45:36 +00:00
|
|
|
uint32 _hEndOfFrame;
|
2012-04-29 01:23:02 +00:00
|
|
|
Common::File _vdbFP;
|
2016-01-04 12:43:36 +00:00
|
|
|
SoundCodecs _vdbCodec;
|
2012-04-29 01:23:02 +00:00
|
|
|
Common::Array<VoiceHeader> _voices;
|
2012-06-16 09:32:50 +00:00
|
|
|
FPSound _theSound;
|
|
|
|
Common::List<FPSfx *> _activeSfx;
|
2012-05-13 12:34:40 +00:00
|
|
|
Globals _globals;
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-08-26 21:33:46 +00:00
|
|
|
int16 _cTableDialog[256];
|
|
|
|
int16 _lTableDialog[256];
|
|
|
|
int16 _cTableMacc[256];
|
|
|
|
int16 _lTableMacc[256];
|
|
|
|
int16 _cTableCred[256];
|
|
|
|
int16 _lTableCred[256];
|
|
|
|
int16 _cTableObj[256];
|
|
|
|
int16 _lTableObj[256];
|
|
|
|
|
2012-06-16 09:09:08 +00:00
|
|
|
enum DataDir {
|
2012-04-30 13:16:19 +00:00
|
|
|
DD_BASE = 1,
|
|
|
|
DD_SAVE,
|
|
|
|
DD_SHOTS,
|
|
|
|
DD_MUSIC,
|
|
|
|
DD_LAYER,
|
|
|
|
DD_UTILSFX,
|
|
|
|
DD_VOICES,
|
|
|
|
DD_BASE2
|
|
|
|
};
|
2012-05-03 14:11:38 +00:00
|
|
|
|
2012-06-16 09:32:50 +00:00
|
|
|
FPStream *_stream[6];
|
|
|
|
FPSfx *_sfx[MAX_SFX_CHANNELS];
|
|
|
|
FPSfx *_utilSfx[MAX_SFX_CHANNELS];
|
2012-06-04 21:45:36 +00:00
|
|
|
bool _bPaused;
|
|
|
|
bool _bDrawLocation;
|
|
|
|
int _startTime;
|
|
|
|
uint16 *_curThumbnail;
|
2012-05-18 12:57:25 +00:00
|
|
|
int _initialLoadSlotNumber;
|
|
|
|
int _loadSlotNumber;
|
2012-05-03 14:11:38 +00:00
|
|
|
|
|
|
|
// Bounding box list manager
|
|
|
|
RMGameBoxes _theBoxes;
|
2012-05-05 10:54:21 +00:00
|
|
|
RMWindow _window;
|
2012-05-05 10:29:37 +00:00
|
|
|
RMGfxEngine _theEngine;
|
2012-05-03 14:11:38 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
bool _bQuitNow;
|
|
|
|
bool _bTimeFreezed;
|
|
|
|
int _nTimeFreezed;
|
2012-04-25 02:49:49 +00:00
|
|
|
public:
|
|
|
|
TonyEngine(OSystem *syst, const TonyGameDescription *gameDesc);
|
2020-02-09 11:05:33 +00:00
|
|
|
~TonyEngine() override;
|
2012-04-25 02:49:49 +00:00
|
|
|
|
|
|
|
const TonyGameDescription *_gameDescription;
|
|
|
|
uint32 getFeatures() const;
|
|
|
|
Common::Language getLanguage() const;
|
|
|
|
uint16 getVersion() const;
|
2012-04-30 13:16:19 +00:00
|
|
|
bool getIsDemo() const;
|
2012-05-28 20:56:31 +00:00
|
|
|
bool isCompressed() const;
|
2012-06-04 21:45:36 +00:00
|
|
|
RMGfxEngine *getEngine() {
|
2012-05-21 21:53:13 +00:00
|
|
|
return &_theEngine;
|
|
|
|
}
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2020-02-09 11:05:33 +00:00
|
|
|
bool canLoadGameStateCurrently() override;
|
|
|
|
bool canSaveGameStateCurrently() override;
|
2020-02-05 15:28:57 +00:00
|
|
|
Common::Error loadGameState(int slot) override;
|
2020-02-05 06:13:33 +00:00
|
|
|
Common::Error saveGameState(int slot, const Common::String &desc, bool isAutosave = false) override;
|
2012-05-15 14:05:48 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
void play();
|
|
|
|
void close();
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-16 09:09:08 +00:00
|
|
|
void getDataDirectory(DataDir dir, char *path);
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-08-31 23:05:22 +00:00
|
|
|
void showLocation();
|
|
|
|
void hideLocation();
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-17 17:39:58 +00:00
|
|
|
/**
|
|
|
|
* Reads the time
|
|
|
|
*/
|
2012-06-18 06:24:33 +00:00
|
|
|
uint32 getTime();
|
|
|
|
void freezeTime();
|
|
|
|
void unfreezeTime();
|
2012-04-30 13:16:19 +00:00
|
|
|
|
|
|
|
// Music
|
|
|
|
// ******
|
2012-06-19 10:50:48 +00:00
|
|
|
void playMusic(int nChannel, const Common::String &fn, int nFX, bool bLoop, int nSync);
|
2012-06-04 21:45:36 +00:00
|
|
|
void stopMusic(int nChannel);
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
void playSFX(int nSfx, int nFX = 0);
|
|
|
|
void stopSFX(int nSfx);
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
void playUtilSFX(int nSfx, int nFX = 0);
|
|
|
|
void stopUtilSFX(int nSfx);
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-16 09:32:50 +00:00
|
|
|
FPSfx *createSFX(Common::SeekableReadStream *stream);
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
void preloadSFX(int nSfx, const char *fn);
|
2012-06-18 06:24:33 +00:00
|
|
|
void unloadAllSFX();
|
2012-05-21 21:53:13 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
void preloadUtilSFX(int nSfx, const char *fn);
|
2012-06-18 06:24:33 +00:00
|
|
|
void unloadAllUtilSFX();
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-17 17:39:58 +00:00
|
|
|
/**
|
|
|
|
* Stop all the audio
|
|
|
|
*/
|
2012-06-04 21:45:36 +00:00
|
|
|
void pauseSound(bool bPause);
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
void setMusicVolume(int nChannel, int volume);
|
|
|
|
int getMusicVolume(int nChannel);
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-17 17:39:58 +00:00
|
|
|
/**
|
|
|
|
* Handle saving
|
|
|
|
*/
|
2012-06-04 21:45:36 +00:00
|
|
|
void autoSave(CORO_PARAM);
|
|
|
|
void saveState(int n, const char *name);
|
|
|
|
void loadState(CORO_PARAM, int n);
|
|
|
|
static Common::String getSaveStateFileName(int n);
|
2020-02-07 05:54:41 +00:00
|
|
|
virtual Common::String getSaveStateName(int slot) const override;
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-17 17:39:58 +00:00
|
|
|
/**
|
|
|
|
* Get a thumbnail
|
|
|
|
*/
|
2012-06-18 06:24:33 +00:00
|
|
|
void grabThumbnail();
|
2012-08-31 23:05:22 +00:00
|
|
|
uint16 *getThumbnail();
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-08-31 23:05:22 +00:00
|
|
|
void quitGame();
|
2012-04-30 13:16:19 +00:00
|
|
|
|
2012-06-04 21:45:36 +00:00
|
|
|
void openInitLoadMenu(CORO_PARAM);
|
|
|
|
void openInitOptions(CORO_PARAM);
|
2012-06-17 07:04:10 +00:00
|
|
|
|
2020-02-09 11:05:33 +00:00
|
|
|
void syncSoundSettings() override;
|
2012-06-17 07:04:10 +00:00
|
|
|
void saveSoundSettings();
|
2012-04-25 02:49:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
// Global reference to the TonyEngine object
|
2012-08-22 12:00:46 +00:00
|
|
|
extern TonyEngine *g_vm;
|
2012-04-25 02:49:49 +00:00
|
|
|
|
2012-08-22 12:00:46 +00:00
|
|
|
#define GLOBALS g_vm->_globals
|
2012-05-13 12:34:40 +00:00
|
|
|
|
2012-04-25 02:49:49 +00:00
|
|
|
} // End of namespace Tony
|
|
|
|
|
2016-05-17 16:20:01 +00:00
|
|
|
#endif /* TONY_TONY_H */
|