aboutsummaryrefslogtreecommitdiff
path: root/engines/tony/tony.h
blob: bdaffee7c906b562d80e760a5f7d9eef388d1f02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/* 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.

 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef TONY_H
#define TONY_H

#include "common/scummsys.h"
#include "common/system.h"
#include "common/array.h"
#include "common/coroutines.h"
#include "common/error.h"
#include "common/random.h"
#include "common/util.h"
#include "engines/engine.h"

#include "tony/mpal/mpal.h"
#include "tony/mpal/memory.h"
#include "tony/debugger.h"
#include "tony/gfxengine.h"
#include "tony/loc.h"
#include "tony/utils.h"
#include "tony/window.h"
#include "tony/globals.h"

/**
 * This is the namespace of the Tony engine.
 *
 * Status of this engine: In Development
 *
 * Games using this engine:
 * - Tony Tough
 */
namespace Tony {

using namespace MPAL;

class Globals;

enum {
	kTonyDebugAnimations = 1 << 0,
	kTonyDebugActions = 1 << 1,
	kTonyDebugSound = 1 << 2,
	kTonyDebugMusic = 1 << 3,
	kTonyDebugMPAL = 1 << 4
};

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

struct TonyGameDescription;

#define MAX_SFX_CHANNELS	32

struct VoiceHeader {
	int offset;
	int code;
	int parts;
};
#define VOICE_HEADER_SIZE 12

class TonyEngine : public Engine {
private:
	Common::ErrorCode Init();
	void InitMusic();
	void CloseMusic();
	bool OpenVoiceDatabase();
	void CloseVoiceDatabase();
	void InitCustomFunctionMap();
	static void PlayProcess(CORO_PARAM, const void *param);
protected:
	// Engine APIs
	virtual Common::Error run();
	virtual bool hasFeature(EngineFeature f) const;
public:
	LPCUSTOMFUNCTION FuncList[300];
	Common::String FuncListStrings[300];
	Common::RandomSource _randomSource;
	MPAL::MemoryManager _memoryManager;
	RMResUpdate _resUpdate;
	uint32 m_hEndOfFrame;
	Common::File _vdbFP;
	Common::Array<VoiceHeader> _voices;
	FPSOUND	_theSound;
	Globals _globals;
	Debugger *_debugger;

	enum DATADIR {
		DD_BASE = 1,
		DD_SAVE,
		DD_SHOTS,
		DD_MUSIC,
		DD_LAYER,
		DD_UTILSFX,
		DD_VOICES,
		DD_BASE2
	};

	FPSTREAM *m_stream[6];
	FPSFX *m_sfx[MAX_SFX_CHANNELS];
	FPSFX *m_utilSfx[MAX_SFX_CHANNELS];
	RMFont *fonts[2];
	bool m_bPaused;
	bool m_bDrawLocation;
	int m_startTime;
	uint16 *m_curThumbnail;
	int _initialLoadSlotNumber;
	int _loadSlotNumber;

	// Bounding box list manager
	RMGameBoxes _theBoxes;
	RMWindow _window;
	RMGfxEngine _theEngine;

	bool m_bQuitNow;
	bool m_bTimeFreezed;
	int m_nTimeFreezed;
public:
	TonyEngine(OSystem *syst, const TonyGameDescription *gameDesc);
	virtual ~TonyEngine();

	const TonyGameDescription *_gameDescription;
	uint32 getFeatures() const;
	Common::Language getLanguage() const;
	uint16 getVersion() const;
	bool getIsDemo() const;
	RMGfxEngine *GetEngine() { return &_theEngine; }
	void GUIError(const Common::String &msg);

	virtual bool canLoadGameStateCurrently();
	virtual bool canSaveGameStateCurrently();
	Common::Error loadGameState(int slot);
	Common::Error saveGameState(int slot, const Common::String &desc);

	// Warn when are being controlled by the GDI
	void GDIControl(bool bCon);

	void Play();
	void Close();
	void Abort();

	void GetDataDirectory(DATADIR dir, char *path);

	void SwitchFullscreen(bool bFull);
	void OptionScreen(void);

	void ShowLocation(void) { m_bDrawLocation = true; }
	void HideLocation(void) { m_bDrawLocation = false; }

	// Reads the time
	uint32 GetTime(void);
	void FreezeTime(void);
	void UnfreezeTime(void);

	// Music
	// ******
	void PlayMusic(int nChannel, const char *fn, int nFX, bool bLoop, int nSync);
	void StopMusic(int nChannel);

	void PlaySFX(int nSfx, int nFX = 0);
	void StopSFX(int nSfx);

	void PlayUtilSFX(int nSfx, int nFX = 0);
	void StopUtilSFX(int nSfx);

	FPSFX *CreateSFX(byte *buf);

	void PreloadSFX(int nSfx, const char *fn);
	void UnloadAllSFX(void);
	
	void PreloadUtilSFX(int nSfx, const char *fn);
	void UnloadAllUtilSFX(void);

	// Stop all the audio
	void PauseSound(bool bPause);

	void SetMusicVolume(int nChannel, int volume);
	int GetMusicVolume(int nChannel);

	// Handle saving
	void AutoSave(CORO_PARAM);
	void SaveState(int n, const char *name);
	void LoadState(CORO_PARAM, int n);
	static Common::String GetSaveStateFileName(int n);

	// Get a thumbnail
	void GrabThumbnail(void);
	uint16 *GetThumbnail(void) { return m_curThumbnail; }

	void Quit(void) { m_bQuitNow = true; }

	void OpenInitLoadMenu(CORO_PARAM);
	void OpenInitOptions(CORO_PARAM);
};

// Global reference to the TonyEngine object
extern TonyEngine *_vm;

#define GLOBALS _vm->_globals

} // End of namespace Tony

#endif /* TONY_H */