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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
|
/* 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 MADS_SOUND_NEBULAR_H
#define MADS_SOUND_NEBULAR_H
#include "common/scummsys.h"
#include "common/file.h"
#include "common/mutex.h"
#include "common/queue.h"
#include "audio/audiostream.h"
#include "audio/fmopl.h"
#include "audio/mixer.h"
namespace MADS {
class SoundManager;
namespace Nebular {
/**
* Represents the data for a channel on the Adlib
*/
class AdlibChannel {
public:
int _activeCount;
int _field1;
int _field2;
int _field3;
int _field4;
int _sampleIndex;
int _volume;
int _field7;
int _field8;
int _field9;
int _fieldA;
uint8 _fieldB;
int _fieldC;
int _fieldD;
int _fieldE;
byte *_ptr1;
byte *_pSrc;
byte *_ptr3;
byte *_ptr4;
int _field17;
int _field19;
byte *_soundData;
int _field1D;
int _field1E;
int _field1F;
// TODO: Only used by asound.003. Figure out usage
byte _field20;
public:
static bool _channelsEnabled;
public:
AdlibChannel();
void reset();
void enable(int flag);
void setPtr2(byte *pData);
void load(byte *pData);
void check(byte *nullPtr);
};
class AdlibChannelData {
public:
int _field0;
int _freqMask;
int _freqBase;
int _field6;
};
class AdlibSample {
public:
int _attackRate;
int _decayRate;
int _sustainLevel;
int _releaseRate;
bool _egTyp;
bool _ksr;
int _totalLevel;
int _scalingLevel;
int _waveformSelect;
int _freqMultiple;
int _feedback;
bool _ampMod;
int _vib;
int _alg;
int _fieldE;
int _freqMask;
int _freqBase;
int _field14;
AdlibSample() {}
AdlibSample(Common::SeekableReadStream &s);
};
struct RegisterValue {
uint8 _regNum;
uint8 _value;
RegisterValue(int regNum, int value) {
_regNum = regNum; _value = value;
}
};
#define ADLIB_CHANNEL_COUNT 9
#define ADLIB_CHANNEL_MIDWAY 5
#define CALLBACKS_PER_SECOND 60
/**
* Base class for the sound player resource files
*/
class ASound: public Audio::AudioStream {
private:
struct CachedDataEntry {
int _offset;
byte *_data;
};
Common::List<CachedDataEntry> _dataCache;
uint16 _randomSeed;
/**
* Does the initial Adlib initialisation
*/
void adlibInit();
/**
* Does on-going processing for the Adlib sounds being played
*/
void update();
/**
* Polls each of the channels for updates
*/
void pollChannels();
/**
* Checks the status of the channels
*/
void checkChannels();
/**
* Polls the currently active channel
*/
void pollActiveChannel();
/**
* Updates the octave of the currently active channel
*/
void updateOctave();
void updateChannelState();
void updateActiveChannel();
/**
* Loads up the specified sample
*/
void loadSample(int sampleIndex);
/**
* Writes out the data of the selected sample to the Adlib
*/
void processSample();
void updateFNumber();
protected:
int _commandParam;
/**
* Queue a byte for an Adlib register
*/
void write(int reg, int val);
/**
* Queue a byte for an Adlib register, and store it in the _ports array
*/
int write2(int state, int reg, int val);
/**
* Flush any pending Adlib register values to the OPL driver
*/
void flush();
/**
* Turn a channel on
*/
void channelOn(int reg, int volume);
/**
* Turn a channel off
*/
void channelOff(int reg);
/**
* Checks for whether a poll result needs to be set
*/
void resultCheck();
/**
* Loads a data block from the sound file, caching the result for any future
* calls for the same data
*/
byte *loadData(int offset, int size);
/**
* Play the specified sound
* @param offset Offset of sound data within sound player data segment
* @param size Size of sound data block
*/
void playSound(int offset, int size);
/**
* Play the specified raw sound data
* @param pData Pointer to data block containing sound data
* @param startingChannel Channel to start scan from
*/
void playSoundData(byte *pData, int startingChannel = ADLIB_CHANNEL_MIDWAY);
/**
* Checks to see whether the given block of data is already loaded into a channel.
*/
bool isSoundActive(byte *pData);
/**
* Sets the frequency for a given channel.
*/
void setFrequency(int channel, int freq);
/**
* Returns a 16-bit random number
*/
int getRandomNumber();
virtual int command0();
int command1();
int command2();
int command3();
int command4();
int command5();
int command6();
int command7();
int command8();
public:
Audio::Mixer *_mixer;
FM_OPL *_opl;
Audio::SoundHandle _soundHandle;
AdlibChannel _channels[ADLIB_CHANNEL_COUNT];
AdlibChannel *_activeChannelPtr;
AdlibChannelData _channelData[11];
Common::Array<AdlibSample> _samples;
AdlibSample *_samplePtr;
Common::File _soundFile;
Common::Queue<RegisterValue> _queue;
Common::Mutex _driverMutex;
int _dataOffset;
int _frameCounter;
bool _isDisabled;
int _v1;
int _v2;
int _activeChannelNumber;
int _freqMask1;
int _freqMask2;
int _freqBase1;
int _freqBase2;
int _channelNum1, _channelNum2;
int _v7;
int _v8;
int _v9;
int _v10;
int _pollResult;
int _resultFlag;
byte _nullData[2];
int _ports[256];
bool _stateFlag;
int _activeChannelReg;
int _v11;
bool _amDep, _vibDep, _splitPoint;
int _samplesPerCallback;
int _samplesPerCallbackRemainder;
int _samplesTillCallback;
int _samplesTillCallbackRemainder;
public:
/**
* Constructor
* @param filename Specifies the adlib sound player file to use
* @param dataOffset Offset in the file of the data segment
*/
ASound(Audio::Mixer *mixer, const Common::String &filename, int dataOffset);
/**
* Destructor
*/
virtual ~ASound();
/**
* Execute a player command. Most commands represent sounds to play, but some
* low number commands also provide control operations.
* @param commandId Player ommand to execute.
* @param param Optional parameter used by a few commands
*/
virtual int command(int commandId, int param) = 0;
/**
* Stop all currently playing sounds
*/
int stop();
/**
* Main poll method to allow sounds to progress
*/
int poll();
/**
* General noise/note output
*/
void noise();
/**
* Return the current frame counter
*/
int getFrameCounter() { return _frameCounter; }
// AudioStream interface
/**
* Main buffer read
*/
virtual int readBuffer(int16 *buffer, const int numSamples);
/**
* Mono sound only
*/
virtual bool isStereo() const { return false; }
/**
* Data is continuously pushed, so definitive end
*/
virtual bool endOfData() const { return false; }
/**
* Return sample rate
*/
virtual int getRate() const { return 11025; }
};
class ASound1: public ASound {
private:
typedef int (ASound1::*CommandPtr)();
static const CommandPtr _commandList[42];
bool _cmd23Toggle;
int command9();
int command10();
int command11();
int command12();
int command13();
int command14();
int command15();
int command16();
int command17();
int command18();
int command19();
int command20();
int command21();
int command22();
int command23();
int command24();
int command25();
int command26();
int command27();
int command28();
int command29();
int command30();
int command31();
int command32();
int command33();
int command34();
int command35();
int command36();
int command37();
int command38();
int command39();
int command40();
int command41();
void command111213();
int command2627293032();
public:
ASound1(Audio::Mixer *mixer);
virtual int command(int commandId, int param);
};
class ASound2 : public ASound {
private:
byte _command12Param;
private:
typedef int (ASound2::*CommandPtr)();
static const CommandPtr _commandList[44];
virtual int command0();
int command9();
int command10();
int command11();
int command12();
int command13();
int command14();
int command15();
int command16();
int command17();
int command18();
int command19();
int command20();
int command21();
int command22();
int command23();
int command24();
int command25();
int command26();
int command27();
int command28();
int command29();
int command30();
int command31();
int command32();
int command33();
int command34();
int command35();
int command36();
int command37();
int command38();
int command39();
int command40();
int command41();
int command42();
int command43();
void command9Randomize();
void command9Apply(byte *data, int val, int incr);
public:
ASound2(Audio::Mixer *mixer);
virtual int command(int commandId, int param);
};
class ASound3 : public ASound {
private:
bool _command39Flag;
typedef int (ASound3::*CommandPtr)();
static const CommandPtr _commandList[61];
int command9();
int command10();
int command11();
int command13();
int command14();
int command15();
int command16();
int command17();
int command18();
int command19();
int command20();
int command21();
int command22();
int command23();
int command24();
int command25();
int command26();
int command27();
int command28();
int command29();
int command30();
int command31();
int command32();
int command33();
int command34();
int command35();
int command36();
int command37();
int command38();
int command39();
int command40();
int command41();
int command42();
int command43();
int command44();
int command45();
int command46();
int command47();
int command49();
int command50();
int command51();
int command57();
int command59();
int command60();
int nullCommand() { return 0; }
void command9Randomize();
void command9Apply(byte *data, int val, int incr);
public:
ASound3(Audio::Mixer *mixer);
virtual int command(int commandId, int param);
};
class ASound4 : public ASound {
private:
typedef int (ASound4::*CommandPtr)();
static const CommandPtr _commandList[61];
int command10();
int command12();
int command19();
int command20();
int command21();
int command24();
int command27();
int command30();
int command32();
int command33();
int command34();
int command35();
int command36();
int command37();
int command38();
int command43();
int command52();
int command53();
int command54();
int command55();
int command56();
int command57();
int command58();
int command59();
int command60();
int nullCommand() { return 0; }
void method1();
public:
ASound4(Audio::Mixer *mixer);
virtual int command(int commandId, int param);
};
class ASound5 : public ASound {
private:
typedef int (ASound5::*CommandPtr)();
static const CommandPtr _commandList[42];
int command9();
int command10();
int command11();
int command12();
int command13();
int command14();
int command15();
int command16();
int command17();
int command18();
int command19();
int command20();
int command21();
int command22();
int command23();
int command24();
int command25();
int command26();
int command27();
int command28();
int command29();
int command30();
int command31();
int command32();
int command33();
int command34();
int command35();
int command36();
int command37();
int command38();
int command39();
int command40();
int command41();
int command42();
int command43();
public:
ASound5(Audio::Mixer *mixer);
virtual int command(int commandId, int param);
};
} // End of namespace Nebular
} // End of namespace MADS
#endif /* MADS_SOUND_NEBULAR_H */
|