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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
/* 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 XEEN_SOUND_DRIVER_H
#define XEEN_SOUND_DRIVER_H
#include "audio/fmopl.h"
#include "audio/mixer.h"
#include "common/array.h"
#include "common/mutex.h"
#include "common/queue.h"
#include "common/stack.h"
#include "xeen/files.h"
#define CHANNEL_COUNT 9
namespace OPL {
class OPL;
}
namespace Xeen {
enum MusicCommand {
STOP_SONG = 0, RESTART_SONG = 1, SET_VOLUME = 0x100,
GET_STATUS = 0xFFE0
};
class SoundDriver;
typedef bool (SoundDriver::*CommandFn)(const byte *&srcP, byte param);
/**
* Base class for sound drivers
*/
class SoundDriver {
protected:
struct Subroutine {
const byte *_returnP;
const byte *_jumpP;
Subroutine() : _returnP(nullptr), _jumpP(nullptr) {}
Subroutine(const byte *returnP, const byte *endP) :
_returnP(returnP), _jumpP(endP) {}
};
struct Channel {
bool _changeFrequency;
int _freqCtrChange;
int _freqChange;
int _freqCtr;
byte _volume;
byte _scalingValue;
uint _frequency;
Channel() : _changeFrequency(false), _freqCtr(0), _freqCtrChange(0),
_freqChange(0), _volume(0), _scalingValue(0), _frequency(0) {}
};
private:
static const CommandFn FX_COMMANDS[16];
static const CommandFn MUSIC_COMMANDS[16];
private:
Common::Stack<Subroutine> _musSubroutines, _fxSubroutines;
int _musCountdownTimer;
int _fxCountdownTimer;
const byte *_fxDataPtr, *_musDataPtr;
const byte *_fxStartPtr;
const byte *_musStartPtr;
uint _frameCtr;
private:
/**
* Executes the next command
* @param srcP Command data pointer
* @returns If true, execution of commands for the current timer call stops
*/
bool command(const byte *&srcP);
protected:
Common::Array<Channel> _channels;
bool _exclude7;
bool _musicPlaying;
bool _fxPlaying;
protected:
/**
* Executes a series of commands until instructed to stop
*/
void execute();
// Music commands (with some also used by FX)
virtual bool musCallSubroutine(const byte *&srcP, byte param);
virtual bool musSetCountdown(const byte *&srcP, byte param);
virtual bool musSetInstrument(const byte *&srcP, byte param) = 0;
virtual bool cmdNoOperation(const byte *&srcP, byte param);
virtual bool musSetPitchWheel(const byte *&srcP, byte param) = 0;
virtual bool musSkipWord(const byte *&srcP, byte param);
virtual bool musSetPanning(const byte *&srcP, byte param) = 0;
virtual bool musFade(const byte *&srcP, byte param) = 0;
virtual bool musStartNote(const byte *&srcP, byte param) = 0;
virtual bool musSetVolume(const byte *&srcP, byte param) = 0;
virtual bool musInjectMidi(const byte *&srcP, byte param) = 0;
virtual bool musPlayInstrument(const byte *&srcP, byte param) = 0;
virtual bool cmdFreezeFrequency(const byte *&srcP, byte param);
virtual bool cmdChangeFrequency(const byte *&srcP, byte param);
virtual bool musEndSubroutine(const byte *&srcP, byte param);
// FX commands
virtual bool fxCallSubroutine(const byte *&srcP, byte param);
virtual bool fxSetCountdown(const byte *&srcP, byte param);
virtual bool fxSetInstrument(const byte *&srcP, byte param) = 0;
virtual bool fxSetVolume(const byte *&srcP, byte param) = 0;
virtual bool fxMidiReset(const byte *&srcP, byte param) = 0;
virtual bool fxMidiDword(const byte *&srcP, byte param) = 0;
virtual bool fxSetPanning(const byte *&srcP, byte param) = 0;
virtual bool fxChannelOff(const byte *&srcP, byte param) = 0;
virtual bool fxFade(const byte *&srcP, byte param) = 0;
virtual bool fxStartNote(const byte *&srcP, byte param) = 0;
virtual bool fxInjectMidi(const byte *&srcP, byte param) = 0;
virtual bool fxPlayInstrument(const byte *&srcP, byte param) = 0;
virtual bool fxEndSubroutine(const byte *&srcP, byte param);
/**
* Post-processing done when a pause countdown starts or is in progress
*/
virtual void pausePostProcess() = 0;
/**
* Does a reset of any sound effect
*/
virtual void resetFX() = 0;
public:
/**
* Constructor
*/
SoundDriver();
/**
* Destructor
*/
virtual ~SoundDriver();
/**
* Starts an special effect playing
*/
virtual void playFX(uint effectId, const byte *data);
/**
* Stop any playing FX
*/
void stopFX();
/**
* Plays a song
*/
virtual void playSong(const byte *data);
/**
* Executes special music command
*/
virtual int songCommand(uint commandId, byte volume = 0);
/**
* Returns whether music is currently playing
*/
bool isPlaying() const { return _musicPlaying; }
};
class AdlibSoundDriver : public SoundDriver {
struct RegisterValue {
uint8 _regNum;
uint8 _value;
RegisterValue(int regNum, int value) {
_regNum = regNum; _value = value;
}
};
private:
static const byte OPERATOR1_INDEXES[CHANNEL_COUNT];
static const byte OPERATOR2_INDEXES[CHANNEL_COUNT];
static const uint WAVEFORMS[24];
private:
OPL::OPL *_opl;
Common::Queue<RegisterValue> _queue;
Common::Mutex _driverMutex;
const byte *_musInstrumentPtrs[16];
const byte *_fxInstrumentPtrs[16];
int _field180;
int _field181;
int _field182;
int _volume;
private:
/**
* Initializes the state of the Adlib OPL driver
*/
void initialize();
/**
* Adds a register write to the pending queue that will be flushed
* out to the OPL on the next timer call
*/
void write(int reg, int val);
/**
* Timer function for OPL
*/
void onTimer();
/**
* Flushes any pending writes to the OPL
*/
void flush();
/**
* Resets all the output frequencies
*/
void resetFrequencies();
/**
* Sets the frequency for an operator
*/
void setFrequency(byte operatorNum, uint frequency);
/**
* Calculates the frequency for a note
*/
uint calcFrequency(byte note);
/**
* Sets the output level for a channel
*/
void setOutputLevel(byte channelNum, uint level);
/**
* Starts playing an instrument
*/
void playInstrument(byte channelNum, const byte *data);
protected:
virtual bool musSetInstrument(const byte *&srcP, byte param);
virtual bool musSetPitchWheel(const byte *&srcP, byte param);
virtual bool musSetPanning(const byte *&srcP, byte param);
virtual bool musFade(const byte *&srcP, byte param);
virtual bool musStartNote(const byte *&srcP, byte param);
virtual bool musSetVolume(const byte *&srcP, byte param);
virtual bool musInjectMidi(const byte *&srcP, byte param);
virtual bool musPlayInstrument(const byte *&srcP, byte param);
virtual bool fxSetInstrument(const byte *&srcP, byte param);
virtual bool fxSetVolume(const byte *&srcP, byte param);
virtual bool fxMidiReset(const byte *&srcP, byte param);
virtual bool fxMidiDword(const byte *&srcP, byte param);
virtual bool fxSetPanning(const byte *&srcP, byte param);
virtual bool fxChannelOff(const byte *&srcP, byte param);
virtual bool fxFade(const byte *&srcP, byte param);
virtual bool fxStartNote(const byte *&srcP, byte param);
virtual bool fxInjectMidi(const byte *&srcP, byte param);
virtual bool fxPlayInstrument(const byte *&srcP, byte param);
/**
* Post-processing done when a pause countdown starts or is in progress
*/
virtual void pausePostProcess();
/**
* Does a reset of any sound effect
*/
virtual void resetFX();
public:
/**
* Constructor
*/
AdlibSoundDriver();
/**
* Destructor
*/
virtual ~AdlibSoundDriver();
/**
* Starts an special effect playing
*/
virtual void playFX(uint effectId, const byte *data);
/**
* Plays a song
*/
virtual void playSong(const byte *data);
/**
* Executes special music command
*/
virtual int songCommand(uint commandId, byte volume = 0);
};
} // End of namespace Xeen
#endif /* XEEN_SOUND_DRIVER_H */
|
