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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
|
/* 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 KYRA_SOUND_INTERN_H
#define KYRA_SOUND_INTERN_H
#include "kyra/sound/sound.h"
#include "kyra/sound/sound_adlib.h"
#include "common/mutex.h"
#include "audio/softsynth/fmtowns_pc98/towns_pc98_driver.h"
#include "audio/softsynth/fmtowns_pc98/towns_euphony.h"
#include "audio/softsynth/emumidi.h"
#include "audio/midiparser.h"
namespace Audio {
class PCSpeaker;
class MaxTrax;
} // End of namespace Audio
namespace Kyra {
class MidiOutput;
/**
* MIDI output device.
*
* This device supports both MT-32 MIDI, as used in
* Kyrandia 1 and 2, and GM MIDI, as used in Kyrandia 2.
*/
class SoundMidiPC : public Sound {
public:
SoundMidiPC(KyraEngine_v1 *vm, Audio::Mixer *mixer, MidiDriver *driver, kType type);
virtual ~SoundMidiPC();
virtual kType getMusicType() const { return _type; }
virtual bool init();
virtual void updateVolumeSettings();
virtual void initAudioResourceInfo(int set, void *info);
virtual void selectAudioResourceSet(int set);
virtual bool hasSoundFile(uint file) const;
virtual void loadSoundFile(uint file);
virtual void loadSoundFile(Common::String file);
virtual void loadSfxFile(Common::String file);
virtual void playTrack(uint8 track);
virtual void haltTrack();
virtual bool isPlaying() const;
virtual void playSoundEffect(uint8 track, uint8 volume = 0xFF);
virtual void stopAllSoundEffects();
virtual void beginFadeOut();
virtual void pause(bool paused);
private:
static void onTimer(void *data);
// Our channel handling
int _musicVolume, _sfxVolume;
uint32 _fadeStartTime;
bool _fadeMusicOut;
// Midi file related
Common::String _mFileName, _sFileName;
byte *_musicFile, *_sfxFile;
MidiParser *_music;
MidiParser *_sfx[3];
const SoundResourceInfo_PC *res() const {return _resInfo[_currentResourceSet]; }
SoundResourceInfo_PC *_resInfo[3];
int _currentResourceSet;
// misc
kType _type;
Common::String getFileName(const Common::String &str);
bool _nativeMT32;
MidiDriver *_driver;
MidiOutput *_output;
Common::Mutex _mutex;
};
class SoundTowns : public Sound {
public:
SoundTowns(KyraEngine_v1 *vm, Audio::Mixer *mixer);
virtual ~SoundTowns();
virtual kType getMusicType() const { return kTowns; }
virtual bool init();
virtual void process();
virtual void initAudioResourceInfo(int set, void *info);
virtual void selectAudioResourceSet(int set);
virtual bool hasSoundFile(uint file) const;
virtual void loadSoundFile(uint file);
virtual void loadSoundFile(Common::String) {}
virtual void playTrack(uint8 track);
virtual void haltTrack();
virtual void playSoundEffect(uint8 track, uint8 volume = 0xFF);
virtual void stopAllSoundEffects();
virtual void beginFadeOut();
virtual void updateVolumeSettings();
private:
bool loadInstruments();
void playEuphonyTrack(uint32 offset, int loop);
void fadeOutSoundEffects();
int _lastTrack;
Audio::SoundHandle _sfxHandle;
uint8 *_musicTrackData;
uint _sfxFileIndex;
uint8 *_sfxFileData;
uint8 _sfxChannel;
EuphonyPlayer *_player;
bool _cdaPlaying;
const SoundResourceInfo_Towns *res() const {return _resInfo[_currentResourceSet]; }
SoundResourceInfo_Towns *_resInfo[3];
int _currentResourceSet;
const uint8 *_musicFadeTable;
const uint8 *_sfxBTTable;
const uint8 *_sfxWDTable;
};
class SoundPC98 : public Sound {
public:
SoundPC98(KyraEngine_v1 *vm, Audio::Mixer *mixer);
virtual ~SoundPC98();
virtual kType getMusicType() const override { return kPC98; }
virtual bool init() override;
virtual void initAudioResourceInfo(int set, void *info) override;
virtual void selectAudioResourceSet(int set) override;
virtual bool hasSoundFile(uint file) const override;
virtual void loadSoundFile(uint file) override;
virtual void loadSoundFile(Common::String file) override;
virtual void playTrack(uint8 track) override;
virtual void haltTrack() override;
virtual void beginFadeOut() override;
virtual int32 voicePlay(const char *file, Audio::SoundHandle *handle, uint8 volume, uint8 priority, bool isSfx) override { return -1; }
virtual void playSoundEffect(uint8 track, uint8 volume = 0xFF) override;
virtual void updateVolumeSettings() override;
private:
int _lastTrack;
uint8 *_musicTrackData;
uint8 *_sfxTrackData;
TownsPC98_AudioDriver *_driver;
const char *resPattern() {return _resInfo[_currentResourceSet]->c_str(); }
Common::String *_resInfo[3];
int _currentResourceSet;
};
class SoundTownsPC98_v2 : public Sound {
public:
SoundTownsPC98_v2(KyraEngine_v1 *vm, Audio::Mixer *mixer);
virtual ~SoundTownsPC98_v2();
virtual kType getMusicType() const override { return _vm->gameFlags().platform == Common::kPlatformFMTowns ? kTowns : kPC98; }
virtual bool init() override;
virtual void process() override;
virtual void initAudioResourceInfo(int set, void *info) override;
virtual void selectAudioResourceSet(int set) override;
virtual bool hasSoundFile(uint file) const override;
virtual void loadSoundFile(uint file) override {}
virtual void loadSoundFile(Common::String file) override;
virtual void playTrack(uint8 track) override;
virtual void haltTrack() override;
virtual void beginFadeOut() override;
virtual int32 voicePlay(const char *file, Audio::SoundHandle *handle, uint8 volume = 255, uint8 priority = 255, bool isSfx = true) override;
virtual void playSoundEffect(uint8 track, uint8 volume = 0xFF) override;
virtual void updateVolumeSettings() override;
private:
Audio::AudioStream *_currentSFX;
int _lastTrack;
bool _useFmSfx;
uint8 *_musicTrackData;
uint8 *_sfxTrackData;
TownsPC98_AudioDriver *_driver;
const SoundResourceInfo_TownsPC98V2 *res() const {return _resInfo[_currentResourceSet]; }
SoundResourceInfo_TownsPC98V2 *_resInfo[3];
int _currentResourceSet;
};
// PC Speaker MIDI driver
class MidiDriver_PCSpeaker : public MidiDriver_Emulated {
public:
MidiDriver_PCSpeaker(Audio::Mixer *mixer);
~MidiDriver_PCSpeaker();
// MidiDriver interface
virtual void close() {}
virtual void send(uint32 data);
virtual MidiChannel *allocateChannel() { return 0; }
virtual MidiChannel *getPercussionChannel() { return 0; }
// MidiDriver_Emulated interface
void generateSamples(int16 *buffer, int numSamples);
// AudioStream interface
bool isStereo() const { return false; }
int getRate() const { return _rate; }
private:
Common::Mutex _mutex;
Audio::PCSpeaker *_speaker;
int _rate;
struct Channel {
uint8 pitchBendLow, pitchBendHigh;
uint8 hold;
uint8 modulation;
uint8 voiceProtect;
uint8 noteCount;
} _channel[2];
void resetController(int channel);
struct Note {
bool enabled;
uint8 hardwareChannel;
uint8 midiChannel;
uint8 note;
bool processHold;
uint8 flags;
uint8 hardwareFlags;
uint16 priority;
int16 modulation;
uint16 precedence;
} _note[2];
void noteOn(int channel, int note);
void noteOff(int channel, int note);
void turnNoteOn(int note);
void overwriteNote(int note);
void turnNoteOff(int note);
void setupTone(int note);
uint16 _countdown;
uint8 _hardwareChannel[1];
bool _modulationFlag;
uint8 _timerValue;
void onTimer();
static const uint8 _noteTable1[];
static const uint8 _noteTable2[];
};
// for StaticResource (maybe we can find a nicer way to handle it)
struct AmigaSfxTable {
uint8 note;
uint8 patch;
uint16 duration;
uint8 volume;
uint8 pan;
};
class SoundAmiga : public Sound {
public:
SoundAmiga(KyraEngine_v1 *vm, Audio::Mixer *mixer);
virtual ~SoundAmiga();
virtual kType getMusicType() const override { return kAmiga; } //FIXME
virtual bool init() override;
virtual void initAudioResourceInfo(int set, void *info) override;
virtual void selectAudioResourceSet(int set) override;
virtual bool hasSoundFile(uint file) const override;
virtual void loadSoundFile(uint file) override;
virtual void loadSoundFile(Common::String) override {}
virtual void playTrack(uint8 track) override;
virtual void haltTrack() override;
virtual void beginFadeOut() override;
virtual int32 voicePlay(const char *file, Audio::SoundHandle *handle, uint8 volume, uint8 priority, bool isSfx) override { return -1; }
virtual void playSoundEffect(uint8 track, uint8 volume = 0xFF) override;
protected:
Audio::MaxTrax *_driver;
Audio::SoundHandle _musicHandle;
enum FileType { kFileNone = -1, kFileIntro = 0, kFileGame = 1, kFileFinal = 2 } _fileLoaded;
const AmigaSfxTable *_tableSfxIntro;
int _tableSfxIntro_Size;
const AmigaSfxTable *_tableSfxGame;
int _tableSfxGame_Size;
};
class SoundTowns_Darkmoon : public Sound, public TownsAudioInterfacePluginDriver {
public:
SoundTowns_Darkmoon(KyraEngine_v1 *vm, Audio::Mixer *mixer);
virtual ~SoundTowns_Darkmoon();
virtual kType getMusicType() const { return kTowns; }
virtual bool init();
void timerCallback(int timerId);
virtual void initAudioResourceInfo(int set, void *info);
virtual void selectAudioResourceSet(int set);
virtual bool hasSoundFile(uint file) const;
virtual void loadSoundFile(uint file);
virtual void loadSoundFile(Common::String name);
virtual void playTrack(uint8 track);
virtual void haltTrack();
virtual bool isPlaying() const;
virtual void playSoundEffect(uint8 track, uint8 volume = 0xFF);
virtual void stopAllSoundEffects();
virtual void beginFadeOut();
virtual void updateVolumeSettings();
virtual int checkTrigger();
virtual void resetTrigger();
private:
struct SoundTableEntry {
int8 type;
int32 para1;
int16 para2;
} _soundTable[120];
const char *const *_fileList;
uint _fileListLen;
uint8 _lastSfxChan;
uint8 _lastEnvChan;
uint8 *_pcmData;
uint32 _pcmDataSize;
uint8 _pcmVol;
int _timer;
int _timerSwitch;
SoundResourceInfo_TownsEoB *_resource[3];
TownsAudioInterface *_intf;
};
class AudioMaster2;
class SoundAmiga_EoB: public Sound {
public:
SoundAmiga_EoB(KyraEngine_v1 *vm, Audio::Mixer *mixer);
virtual ~SoundAmiga_EoB();
kType getMusicType() const;
bool init();
void initAudioResourceInfo(int set, void *info);
void selectAudioResourceSet(int set);
bool hasSoundFile(uint file) const { return false; }
void loadSoundFile(uint) {}
void loadSoundFile(Common::String file);
void unloadSoundFile(Common::String file);
void playTrack(uint8 track);
void haltTrack();
void playSoundEffect(uint8 track, uint8 volume = 0xFF);
void beginFadeOut() { beginFadeOut(160); }
void beginFadeOut(int delay);
void updateVolumeSettings();
int checkTrigger();
private:
uint8 *_fileBuffer;
KyraEngine_v1 *_vm;
AudioMaster2 *_driver;
SoundResourceInfo_AmigaEoB *_resInfo[3];
Common::String _lastSound;
int _currentResourceSet;
bool _ready;
};
} // End of namespace Kyra
#endif
|