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
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
|
/* 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.
*
* $URL$
* $Id$
*
*/
#include "common/stdafx.h"
#include "common/md5.h"
#include "common/config-manager.h"
#include "common/fs.h"
#include "common/algorithm.h"
#include "sound/mixer.h"
#include "agi/agi.h"
#include "agi/sound.h"
namespace Agi {
#define USE_INTERPOLATION
static bool g_useChorus = true;
/* TODO: add support for variable sampling rate in the output device
*/
AgiSound *AgiSound::createFromRawResource(uint8 *data, uint32 len, int resnum, SoundMgr &manager) {
if (data == NULL || len < 2) return NULL; // Check for too small resource or no resource at all
uint16 type = READ_LE_UINT16(data);
switch (type) { // Create a sound object based on the type
case AGI_SOUND_SAMPLE : return new IIgsSample(data, len, resnum, manager);
case AGI_SOUND_MIDI : return new IIgsMidi (data, len, resnum, manager);
case AGI_SOUND_4CHN : return new PCjrSound (data, len, resnum, manager);
}
warning("Sound resource (%d) has unknown type (0x%04x). Not using the sound", resnum, type);
return NULL;
}
IIgsMidi::IIgsMidi(uint8 *data, uint32 len, int resnum, SoundMgr &manager) : AgiSound(manager) {
_data = data; // Save the resource pointer
_ptr = _data + 2; // Set current position to just after the header
_len = len; // Save the resource's length
_type = READ_LE_UINT16(data); // Read sound resource's type
_isValid = (_type == AGI_SOUND_MIDI) && (_data != NULL) && (_len >= 2);
if (!_isValid) // Check for errors
warning("Error creating Apple IIGS midi sound from resource %d (Type %d, length %d)", resnum, _type, len);
}
PCjrSound::PCjrSound(uint8 *data, uint32 len, int resnum, SoundMgr &manager) : AgiSound(manager) {
_data = data; // Save the resource pointer
_len = len; // Save the resource's length
_type = READ_LE_UINT16(data); // Read sound resource's type
_isValid = (_type == AGI_SOUND_4CHN) && (_data != NULL) && (_len >= 2);
if (!_isValid) // Check for errors
warning("Error creating PCjr 4-channel sound from resource %d (Type %d, length %d)", resnum, _type, len);
}
const uint8 *PCjrSound::getVoicePointer(uint voiceNum) {
assert(voiceNum < 4);
uint16 voiceStartOffset = READ_LE_UINT16(_data + voiceNum * 2);
return _data + voiceStartOffset;
}
IIgsSample::IIgsSample(uint8 *data, uint32 len, int resnum, SoundMgr &manager) : AgiSound(manager) {
Common::MemoryReadStream stream(data, len, true);
// Check that the header was read ok and that it's of the correct type
if (_header.read(stream) && _header.type == AGI_SOUND_SAMPLE) { // An Apple IIGS AGI sample resource
uint32 sampleStartPos = stream.pos();
uint32 tailLen = stream.size() - sampleStartPos;
if (tailLen < _header.sampleSize) { // Check if there's no room for the sample data in the stream
// Apple IIGS Manhunter I: Sound resource 16 has only 16074 bytes
// of sample data although header says it should have 16384 bytes.
warning("Apple IIGS sample (%d) too short (%d bytes. Should be %d bytes). Using the part that's left",
resnum, tailLen, _header.sampleSize);
_header.sampleSize = (uint16) tailLen; // Use the part that's left
}
if (_header.pitch > 0x7F) { // Check if the pitch is invalid
warning("Apple IIGS sample (%d) has too high pitch (0x%02x)", resnum, _header.pitch);
_header.pitch &= 0x7F; // Apple IIGS AGI probably did it this way too
}
// Finalize the header info using the 8-bit unsigned sample data
_header.finalize(stream);
// Convert sample data from 8-bit unsigned to 16-bit signed format
stream.seek(sampleStartPos);
_sample = new int16[_header.sampleSize];
if (_sample != NULL)
_isValid = _manager.convertWave(stream, _sample, _header.sampleSize);
}
if (!_isValid) // Check for errors
warning("Error creating Apple IIGS sample from resource %d (Type %d, length %d)", resnum, _header.type, len);
}
/** Reads an Apple IIGS envelope from then given stream. */
bool IIgsEnvelope::read(Common::SeekableReadStream &stream) {
for (int segNum = 0; segNum < ENVELOPE_SEGMENT_COUNT; segNum++) {
seg[segNum].bp = stream.readByte();
seg[segNum].inc = stream.readUint16LE();
}
return !stream.ioFailed();
}
/** Reads an Apple IIGS wave information structure from the given stream. */
bool IIgsWaveInfo::read(Common::SeekableReadStream &stream, bool ignoreAddr) {
top = stream.readByte();
addr = stream.readByte() * 256;
size = (1 << (stream.readByte() & 7)) * 256;
// Read packed mode byte and parse it into parts
byte packedModeByte = stream.readByte();
channel = (packedModeByte >> 4) & 1; // Bit 4
mode = (packedModeByte >> 1) & 3; // Bits 1-2
halt = (packedModeByte & 1) != 0; // Bit 0 (Converted to boolean)
relPitch = stream.readSint16LE();
// Zero the wave address if we want to ignore the wave address info
if (ignoreAddr)
addr = 0;
return !stream.ioFailed();
}
bool IIgsWaveInfo::finalize(Common::SeekableReadStream &uint8Wave) {
uint32 startPos = uint8Wave.pos(); // Save stream's starting position
uint8Wave.seek(addr, SEEK_CUR); // Seek to wave's address
// Calculate the true sample size (A zero ends the sample prematurely)
uint trueSize = size; // Set a default value for the result
for (uint i = 0; i < size; i++) {
if (uint8Wave.readByte() == 0) {
trueSize = i;
// A zero in the sample stream turns off looping
// (At least that's what MESS 0.117 and KEGS32 0.91 seem to do)
if (mode == OSC_MODE_LOOP)
mode = OSC_MODE_ONESHOT;
break;
}
}
size = trueSize; // Set the true sample size
uint8Wave.seek(startPos); // Seek back to the stream's starting position
return true;
}
bool IIgsOscillator::finalize(Common::SeekableReadStream &uint8Wave) {
for (uint i = 0; i < WAVES_PER_OSCILLATOR; i++)
if (!waves[i].finalize(uint8Wave))
return false;
return true;
}
bool IIgsOscillatorList::read(Common::SeekableReadStream &stream, uint oscillatorCount, bool ignoreAddr) {
// First read the A waves and then the B waves for the oscillators
for (uint waveNum = 0; waveNum < WAVES_PER_OSCILLATOR; waveNum++)
for (uint oscNum = 0; oscNum < oscillatorCount; oscNum++)
if (!osc[oscNum].waves[waveNum].read(stream, ignoreAddr))
return false;
count = oscillatorCount; // Set the oscillator count
return true;
}
bool IIgsOscillatorList::finalize(Common::SeekableReadStream &uint8Wave) {
for (uint i = 0; i < count; i++)
if (!osc[i].finalize(uint8Wave))
return false;
return true;
}
bool IIgsInstrumentHeader::read(Common::SeekableReadStream &stream, bool ignoreAddr) {
env.read(stream);
relseg = stream.readByte();
/*byte priority =*/ stream.readByte(); // Not needed? 32 in all tested data.
bendrange = stream.readByte();
vibdepth = stream.readByte();
vibspeed = stream.readByte();
/*byte spare =*/ stream.readByte(); // Not needed? 0 in all tested data.
byte wac = stream.readByte(); // Read A wave count
byte wbc = stream.readByte(); // Read B wave count
oscList.read(stream, wac, ignoreAddr); // Read the oscillators
return (wac == wbc) && !stream.ioFailed(); // A and B wave counts must match
}
bool IIgsInstrumentHeader::finalize(Common::SeekableReadStream &uint8Wave) {
return oscList.finalize(uint8Wave);
}
bool IIgsSampleHeader::read(Common::SeekableReadStream &stream) {
type = stream.readUint16LE();
pitch = stream.readByte();
unknownByte_Ofs3 = stream.readByte();
volume = stream.readByte();
unknownByte_Ofs5 = stream.readByte();
instrumentSize = stream.readUint16LE();
sampleSize = stream.readUint16LE();
// Read the instrument header *ignoring* its wave address info
return instrument.read(stream, true);
}
bool IIgsSampleHeader::finalize(Common::SeekableReadStream &uint8Wave) {
return instrument.finalize(uint8Wave);
}
/** Older Apple IIGS AGI instrument set. Used only by Space Quest I (AGI v1.002). */
static const instrumentSetInfo instSetV1 = {
1192, 26, "7ee16bbc135171ffd6b9120cc7ff1af2", "edd3bf8905d9c238e02832b732fb2e18"
};
/** Newer Apple IIGS AGI instrument set (AGI v1.003+). Used by all others than Space Quest I. */
static const instrumentSetInfo instSetV2 = {
1292, 28, "b7d428955bb90721996de1cbca25e768", "c05fb0b0e11deefab58bc68fbd2a3d07"
};
/** Information about different Apple IIGS AGI executables. */
static const IIgsExeInfo IIgsExeInfos[] = {
{GID_SQ1, "SQ", 0x1002, 138496, 0x80AD, instSetV1},
{GID_LSL1, "LL", 0x1003, 141003, 0x844E, instSetV2},
{GID_AGIDEMO, "DEMO", 0x1005, 141884, 0x8469, instSetV2},
{GID_KQ1, "KQ", 0x1006, 141894, 0x8469, instSetV2},
{GID_PQ1, "PQ", 0x1007, 141882, 0x8469, instSetV2},
{GID_MIXEDUP, "MG", 0x1013, 142552, 0x84B7, instSetV2},
{GID_KQ2, "KQ2", 0x1013, 143775, 0x84B7, instSetV2},
{GID_KQ3, "KQ3", 0x1014, 144312, 0x84B7, instSetV2},
{GID_SQ2, "SQ2", 0x1014, 107882, 0x6563, instSetV2},
{GID_MH1, "MH", 0x2004, 147678, 0x8979, instSetV2},
{GID_KQ4, "KQ4", 0x2006, 147652, 0x8979, instSetV2},
{GID_BC, "BC", 0x3001, 148192, 0x8979, instSetV2},
{GID_GOLDRUSH, "GR", 0x3003, 148268, 0x8979, instSetV2}
};
static IIgsInstrumentHeader g_instruments[MAX_INSTRUMENTS];
static uint g_numInstruments = 0;
static int16 g_wave[SIERRASTANDARD_SIZE]; // FIXME? Should this be allocated from the heap? (Size is 128KiB)
// Time (In milliseconds) in Apple IIGS mixing buffer time granularity
// (i.e. in IIGS_BUFFER_SIZE / getRate() seconds granularity)
static uint32 g_IIgsBufGranMillis = 0;
static uint32 g_midiMillis = 0; // Time position (In milliseconds) in currently playing MIDI sound
bool SoundMgr::finalizeInstruments(Common::SeekableReadStream &uint8Wave) {
for (uint i = 0; i < g_numInstruments; i++)
if (!g_instruments[i].finalize(uint8Wave))
return false;
return true;
}
static const int16 waveformRamp[WAVEFORM_SIZE] = {
0, 8, 16, 24, 32, 40, 48, 56,
64, 72, 80, 88, 96, 104, 112, 120,
128, 136, 144, 152, 160, 168, 176, 184,
192, 200, 208, 216, 224, 232, 240, 255,
0, -248, -240, -232, -224, -216, -208, -200,
-192, -184, -176, -168, -160, -152, -144, -136,
-128, -120, -112, -104, -96, -88, -80, -72,
-64, -56, -48, -40, -32, -24, -16, -8 /* Ramp up */
};
static const int16 waveformSquare[WAVEFORM_SIZE] = {
255, 230, 220, 220, 220, 220, 220, 220,
220, 220, 220, 220, 220, 220, 220, 220,
220, 220, 220, 220, 220, 220, 220, 220,
220, 220, 220, 220, 220, 220, 220, 110,
-255, -230, -220, -220, -220, -220, -220, -220,
-220, -220, -220, -220, -220, -220, -220, -220,
-220, -220, -220, -220, -220, -220, -220, -220,
-220, -220, -220, -110, 0, 0, 0, 0 /* Square */
};
static const int16 waveformMac[WAVEFORM_SIZE] = {
45, 110, 135, 161, 167, 173, 175, 176,
156, 137, 123, 110, 91, 72, 35, -2,
-60, -118, -142, -165, -170, -176, -177, -179,
-177, -176, -164, -152, -117, -82, -17, 47,
92, 137, 151, 166, 170, 173, 171, 169,
151, 133, 116, 100, 72, 43, -7, -57,
-99, -141, -156, -170, -174, -177, -178, -179,
-175, -172, -165, -159, -137, -114, -67, -19
};
static const uint16 period[] = {
1024, 1085, 1149, 1218, 1290, 1367,
1448, 1534, 1625, 1722, 1825, 1933
};
#if 0
static int noteToPeriod(int note) {
return 10 * (period[note % 12] >> (note / 12 - 3));
}
#endif
void SoundMgr::unloadSound(int resnum) {
if (_vm->_game.dirSound[resnum].flags & RES_LOADED) {
if (_vm->_game.sounds[resnum]->isPlaying()) {
_vm->_game.sounds[resnum]->stop();
}
// Release the sound resource's data
delete _vm->_game.sounds[resnum];
_vm->_game.sounds[resnum] = NULL;
_vm->_game.dirSound[resnum].flags &= ~RES_LOADED;
}
}
void SoundMgr::startSound(int resnum, int flag) {
int i;
AgiSoundType type;
if (_vm->_game.sounds[resnum] != NULL && _vm->_game.sounds[resnum]->isPlaying())
return;
stopSound();
if (_vm->_game.sounds[resnum] == NULL) // Is this needed at all?
return;
type = (AgiSoundType)_vm->_game.sounds[resnum]->type();
if (type != AGI_SOUND_SAMPLE && type != AGI_SOUND_MIDI && type != AGI_SOUND_4CHN)
return;
_vm->_game.sounds[resnum]->play();
_playingSound = resnum;
debugC(3, kDebugLevelSound, "startSound(resnum = %d, flag = %d)", resnum, flag);
switch (type) {
case AGI_SOUND_SAMPLE: {
IIgsSample *sampleRes = (IIgsSample *) _vm->_game.sounds[_playingSound];
const IIgsWaveInfo &waveInfo = _IIgsChannel.ins.oscList(0).waves[0];
const IIgsSampleHeader &header = sampleRes->getHeader();
_IIgsChannel.ins = header.instrument;
_IIgsChannel.sample = sampleRes->getSample() + waveInfo.addr;
_IIgsChannel.pos = intToFrac(0);
_IIgsChannel.posAdd = intToFrac(0);
_IIgsChannel.note = intToFrac(header.pitch) + doubleToFrac(waveInfo.relPitch/256.0);
_IIgsChannel.startEnvVol = intToFrac(0);
_IIgsChannel.chanVol = intToFrac(header.volume);
_IIgsChannel.envVol = _IIgsChannel.startEnvVol;
_IIgsChannel.vol = doubleToFrac(fracToDouble(_IIgsChannel.envVol) * fracToDouble(_IIgsChannel.chanVol) / 127.0);
_IIgsChannel.envSeg = intToFrac(0);
_IIgsChannel.loop = (waveInfo.mode == OSC_MODE_LOOP);
_IIgsChannel.size = waveInfo.size - waveInfo.addr;
_IIgsChannel.end = false;
break;
}
case AGI_SOUND_MIDI:
g_IIgsBufGranMillis = g_midiMillis = 0;
#if 0
debugC(3, kDebugLevelSound, "IIGS MIDI sequence");
for (i = 0; i < NUM_CHANNELS; i++) {
_chn[i].type = type;
_chn[i].flags = AGI_SOUND_LOOP | AGI_SOUND_ENVELOPE;
_chn[i].ins = _waveform;
_chn[i].size = WAVEFORM_SIZE;
_chn[i].vol = 0;
_chn[i].end = 0;
}
_chn[0].timer = *(song + 2);
_chn[0].ptr = (struct AgiNote *)(song + 3);
#endif
break;
case AGI_SOUND_4CHN:
PCjrSound *pcjrSound = (PCjrSound *) _vm->_game.sounds[resnum];
/* Initialize channel info */
for (i = 0; i < NUM_CHANNELS; i++) {
_chn[i].type = type;
_chn[i].flags = AGI_SOUND_LOOP;
if (_env) {
_chn[i].flags |= AGI_SOUND_ENVELOPE;
_chn[i].adsr = AGI_SOUND_ENV_ATTACK;
}
_chn[i].ins = _waveform;
_chn[i].size = WAVEFORM_SIZE;
_chn[i].ptr = pcjrSound->getVoicePointer(i % 4);
_chn[i].timer = 0;
_chn[i].vol = 0;
_chn[i].end = 0;
}
break;
}
memset(_sndBuffer, 0, BUFFER_SIZE << 1);
_endflag = flag;
/* Nat Budin reports that the flag should be reset when sound starts
*/
_vm->setflag(_endflag, false);
}
void SoundMgr::stopSound() {
int i;
_endflag = -1;
if (_vm->_soundemu != SOUND_EMU_APPLE2GS) {
for (i = 0; i < NUM_CHANNELS; i++)
stopNote(i);
}
if (_playingSound != -1) {
_vm->_game.sounds[_playingSound]->stop();
if (_vm->_soundemu == SOUND_EMU_APPLE2GS) {
_IIgsChannel.end = true;
_IIgsChannel.chanVol = intToFrac(0);
}
_playingSound = -1;
}
}
static int16 *buffer;
int SoundMgr::initSound() {
int r = -1;
buffer = _sndBuffer = (int16 *)calloc(2, BUFFER_SIZE);
_env = false;
switch (_vm->_soundemu) {
case SOUND_EMU_NONE:
_waveform = waveformRamp;
_env = true;
break;
case SOUND_EMU_AMIGA:
case SOUND_EMU_PC:
_waveform = waveformSquare;
break;
case SOUND_EMU_MAC:
_waveform = waveformMac;
break;
case SOUND_EMU_APPLE2GS:
loadInstruments();
break;
}
report("Initializing sound:\n");
report("sound: envelopes ");
if (_env) {
report("enabled (decay=%d, sustain=%d)\n", ENV_DECAY, ENV_SUSTAIN);
} else {
report("disabled\n");
}
_mixer->playInputStream(Audio::Mixer::kPlainSoundType, &_soundHandle, this, -1, Audio::Mixer::kMaxChannelVolume, 0, false, true);
return r;
}
void SoundMgr::deinitSound() {
debugC(3, kDebugLevelSound, "()");
_mixer->stopHandle(_soundHandle);
free(_sndBuffer);
}
void SoundMgr::stopNote(int i) {
_chn[i].adsr = AGI_SOUND_ENV_RELEASE;
if (g_useChorus) {
/* Stop chorus ;) */
if (_chn[i].type == AGI_SOUND_4CHN &&
_vm->_soundemu == SOUND_EMU_NONE && i < 3) {
stopNote(i + 4);
}
}
}
void SoundMgr::playNote(int i, int freq, int vol) {
if (!_vm->getflag(fSoundOn))
vol = 0;
else if (vol && _vm->_soundemu == SOUND_EMU_PC)
vol = 160;
_chn[i].phase = 0;
_chn[i].freq = freq;
_chn[i].vol = vol;
_chn[i].env = 0x10000;
_chn[i].adsr = AGI_SOUND_ENV_ATTACK;
if (g_useChorus) {
/* Add chorus ;) */
if (_chn[i].type == AGI_SOUND_4CHN &&
_vm->_soundemu == SOUND_EMU_NONE && i < 3) {
int newfreq = freq * 1007 / 1000;
if (freq == newfreq)
newfreq++;
playNote(i + 4, newfreq, vol * 2 / 3);
}
}
}
void SoundMgr::playMidiSound() {
const uint8 *p;
uint8 parm1, parm2;
static uint8 cmd, ch;
if (_playingSound == -1 || _vm->_game.sounds[_playingSound] == NULL) {
warning("Error playing Apple IIGS MIDI sound resource");
_playing = false;
return;
}
IIgsMidi *midiObj = (IIgsMidi *) _vm->_game.sounds[_playingSound];
_playing = true;
p = midiObj->getPtr();
g_IIgsBufGranMillis += (IIGS_BUFFER_SIZE * 1000) / getRate();
while (g_midiMillis < g_IIgsBufGranMillis) {
uint8 readByte = *p++;
// Check for end of MIDI sequence marker (Can also be here before delta-time)
if (readByte == MIDI_BYTE_STOP_SEQUENCE) {
debugC(3, kDebugLevelSound, "End of MIDI sequence (Before reading delta-time)");
g_IIgsBufGranMillis = g_midiMillis = 0;
_playing = false;
midiObj->rewind();
return;
} else if (readByte == MIDI_BYTE_TIMER_SYNC) {
debugC(3, kDebugLevelSound, "Timer sync");
continue;
}
uint8 deltaTime = readByte;
uint32 bpm = 120; // Don't know if this is correct
g_midiMillis += (deltaTime * 1000) / bpm;
// Check for end of MIDI sequence marker (This time it after reading delta-time)
if (*p == MIDI_BYTE_STOP_SEQUENCE) {
debugC(3, kDebugLevelSound, "End of MIDI sequence (After reading delta-time)");
g_IIgsBufGranMillis = g_midiMillis = 0;
_playing = false;
midiObj->rewind();
return;
}
// Separate byte into command and channel if it's a command byte.
// Otherwise use running status (i.e. previously set command and channel).
if (*p & 0x80) {
cmd = *p++;
ch = cmd & 0x0f;
cmd >>= 4;
}
switch (cmd) {
case MIDI_CMD_NOTE_OFF:
parm1 = *p++;
parm2 = *p++;
#if 0
if (ch < NUM_CHANNELS)
stopNote(ch);
#endif
debugC(3, kDebugLevelSound, "note off, channel %02x, note %02x, velocity %02x", ch, parm1, parm2);
break;
case MIDI_CMD_NOTE_ON:
parm1 = *p++;
parm2 = *p++;
#if 0
if (ch < NUM_CHANNELS)
playNote(ch, noteToPeriod(parm1), 127);
#endif
debugC(3, kDebugLevelSound, "note on, channel %02x, note %02x, velocity %02x", ch, parm1, parm2);
break;
case MIDI_CMD_CONTROLLER:
// The tested Apple IIGS AGI MIDI resources only used
// controllers 0 (Bank select?), 7 (Volume) and 64 (Sustain On/Off).
// Controller 0's parameter was in range 94-127,
// controller 7's parameter was in range 0-127 and
// controller 64's parameter was always 0 (i.e. sustain off).
// TODO: Find out what controller 0 does and implement volume changes.
parm1 = *p++;
parm2 = *p++;
debugC(3, kDebugLevelSound, "controller %02x, ch %02x, val %02x", parm1, ch, parm2);
break;
case MIDI_CMD_PROGRAM_CHANGE:
// In all the tested Apple IIGS AGI MIDI resources
// program change's parameter was in range 0-43.
// This doesn't map directly to instrument numbers as all of
// the tested Apple IIGS AGI games only use 26 or 28 instruments.
// TODO: Find out the mapping to instruments and implement it.
parm1 = *p++;
debugC(3, kDebugLevelSound, "program change %02x, channel %02x", parm1, ch);
#if 0
if (ch < NUM_CHANNELS) {
chn[ch].ins = (uint16 *)&wave[waveaddr[parm1]];
chn[ch].size = wavesize[parm1];
}
debugC(3, kDebugLevelSound, "set patch %02x (%d,%d), ch %02x",
parm1, waveaddr[parm1], wavesize[parm1], ch);
#endif
break;
case MIDI_CMD_PITCH_WHEEL:
parm1 = *p++;
parm2 = *p++;
// In all the tested Apple IIGS AGI MIDI resources
// pitch wheel commands always had 0x2000 (Center position)
// as the combined 14-bit value for the position.
uint16 wheelPos = ((parm2 & 0x7F) << 7) | (parm1 & 0x7F); // 14-bit value
debugC(3, kDebugLevelSound, "Pitch wheel position %04x (Not implemented yet)", wheelPos);
break;
}
}
midiObj->setPtr(p);
}
void SoundMgr::playSampleSound() {
if (_vm->_soundemu != SOUND_EMU_APPLE2GS) {
warning("Trying to play a sample but not using Apple IIGS sound emulation mode");
return;
}
if (_playingSound != -1)
_playing = !_IIgsChannel.end;
}
void SoundMgr::playAgiSound() {
int i;
AgiNote note;
_playing = false;
for (i = 0; i < (_vm->_soundemu == SOUND_EMU_PC ? 1 : 4); i++) {
_playing |= !_chn[i].end;
note.read(_chn[i].ptr); // Read a single note (Doesn't advance the pointer)
if (_chn[i].end)
continue;
if ((--_chn[i].timer) <= 0) {
stopNote(i);
if (note.freqDiv != 0) {
int volume = (note.attenuation == 0x0F) ? 0 : (0xFF - note.attenuation * 2);
playNote(i, note.freqDiv * 10, volume);
}
_chn[i].timer = note.duration;
if (_chn[i].timer == 0xffff) {
_chn[i].end = 1;
_chn[i].vol = 0;
_chn[i].env = 0;
if (g_useChorus) {
/* chorus */
if (_chn[i].type == AGI_SOUND_4CHN && _vm->_soundemu == SOUND_EMU_NONE && i < 3) {
_chn[i + 4].vol = 0;
_chn[i + 4].env = 0;
}
}
}
_chn[i].ptr += 5; // Advance the pointer to the next note data (5 bytes per note)
}
}
}
void SoundMgr::playSound() {
int i;
if (_endflag == -1)
return;
if (_vm->_soundemu == SOUND_EMU_APPLE2GS) {
if (_playingSound != -1) {
if (_vm->_game.sounds[_playingSound]->type() == AGI_SOUND_MIDI) {
playMidiSound();
//warning("playSound: Trying to play an Apple IIGS MIDI sound. Not yet implemented!");
} else if (_vm->_game.sounds[_playingSound]->type() == AGI_SOUND_SAMPLE) {
//debugC(3, kDebugLevelSound, "playSound: Trying to play an Apple IIGS sample");
playSampleSound();
}
}
} else {
//debugC(3, kDebugLevelSound, "playSound: Trying to play a PCjr 4-channel sound");
playAgiSound();
}
if (!_playing) {
if (_vm->_soundemu != SOUND_EMU_APPLE2GS) {
for (i = 0; i < NUM_CHANNELS; _chn[i++].vol = 0);
}
if (_endflag != -1)
_vm->setflag(_endflag, true);
if (_playingSound != -1)
_vm->_game.sounds[_playingSound]->stop();
_playingSound = -1;
_endflag = -1;
}
}
uint32 SoundMgr::mixSound(void) {
register int i, p;
const int16 *src;
int c, b, m;
memset(_sndBuffer, 0, BUFFER_SIZE << 1);
if (!_playing || _playingSound == -1)
return BUFFER_SIZE;
// Handle Apple IIGS sound mixing here
if (_vm->_soundemu == SOUND_EMU_APPLE2GS) {
AgiSoundType type = (AgiSoundType) _vm->_game.sounds[_playingSound]->type();
// Currently we only support mixing a single sample in Apple IIGS mixing code.
if (type != AGI_SOUND_SAMPLE)
return IIGS_BUFFER_SIZE;
//IIgsWaveInfo &waveInfo = _IIgsChannel.ins.oscList(0).waves[0];
//uint period = noteToPeriod(fracToInt(_IIgsChannel.note + FRAC_HALF));
//_IIgsChannel.posAdd = ((frac_t) (118600 * 4 / period)) << (FRAC_BITS - 8);
// Hertz (number of vibrations a second) = 6.875 x 2 ^ ( ( 3 + MIDI_Pitch ) / 12 )
// From http://www.musicmasterworks.com/WhereMathMeetsMusic.html
//double hertz = 6.875 * pow(SEMITONE, 3 + fracToDouble(_IIgsChannel.note));
//double hertz = 8.175798915644 * pow(SEMITONE, fracToDouble(_IIgsChannel.note));
// double step = getRate() / hertz;
// _IIgsChannel.posAdd = doubleToFrac(step);
// Frequency multiplier was 1076.0 based on tests made with MESS 0.117.
// Tests made with KEGS32 averaged the multiplier to around 1045.
// So this is a guess but maybe it's 1046.5... i.e. C6's frequency?
double hertz = C6_FREQ * pow(SEMITONE, fracToDouble(_IIgsChannel.note));
_IIgsChannel.posAdd = doubleToFrac(hertz / getRate());
_IIgsChannel.vol = doubleToFrac(fracToDouble(_IIgsChannel.envVol) * fracToDouble(_IIgsChannel.chanVol) / 127.0);
double tempVol = fracToDouble(_IIgsChannel.vol)/127.0;
for (i = 0; i < IIGS_BUFFER_SIZE; i++) {
b = _IIgsChannel.sample[fracToInt(_IIgsChannel.pos)];
// DOESN'T DO MIXING YET! ONLY ONE SAMPLE PER PLAYING!
_sndBuffer[i] = (int16) (b * tempVol);
_IIgsChannel.pos += _IIgsChannel.posAdd;
if (_IIgsChannel.pos >= intToFrac(_IIgsChannel.size)) {
if (_IIgsChannel.loop) {
_IIgsChannel.pos %= intToFrac(_IIgsChannel.size);
// Probably we should loop the envelope too
_IIgsChannel.envSeg = 0;
_IIgsChannel.envVol = _IIgsChannel.startEnvVol;
} else {
_IIgsChannel.pos = _IIgsChannel.chanVol = 0;
_IIgsChannel.end = true;
break;
}
}
}
if (_IIgsChannel.envSeg <= _IIgsChannel.ins.relseg) {
IIgsEnvelopeSegment &seg = _IIgsChannel.ins.env.seg[_IIgsChannel.envSeg];
double bufSecLen = IIGS_BUFFER_SIZE / (double) getRate();
double ticksPerSec = 100; // 1000 is way too much
double bufTickLen = bufSecLen / (1.0/ticksPerSec);
frac_t envVolDelta = doubleToFrac((seg.inc/256.0)*bufTickLen);
if (intToFrac(seg.bp) >= _IIgsChannel.envVol) {
_IIgsChannel.envVol += envVolDelta;
if (_IIgsChannel.envVol >= intToFrac(seg.bp)) {
_IIgsChannel.envVol = intToFrac(seg.bp);
_IIgsChannel.envSeg += 1;
}
} else {
_IIgsChannel.envVol -= envVolDelta;
if (_IIgsChannel.envVol <= intToFrac(seg.bp)) {
_IIgsChannel.envVol = intToFrac(seg.bp);
_IIgsChannel.envSeg += 1;
}
}
}
//_IIgsChannel.envSeg += doubleToFrac(1/100.0);
return IIGS_BUFFER_SIZE;
} /* else ... */
// Handle PCjr 4-channel sound mixing here
for (c = 0; c < NUM_CHANNELS; c++) {
if (!_chn[c].vol)
continue;
m = _chn[c].flags & AGI_SOUND_ENVELOPE ?
_chn[c].vol * _chn[c].env >> 16 : _chn[c].vol;
if (_chn[c].type != AGI_SOUND_4CHN || c != 3) {
src = _chn[c].ins;
p = _chn[c].phase;
for (i = 0; i < BUFFER_SIZE; i++) {
b = src[p >> 8];
#ifdef USE_INTERPOLATION
b += ((src[((p >> 8) + 1) % _chn[c].size] - src[p >> 8]) * (p & 0xff)) >> 8;
#endif
_sndBuffer[i] += (b * m) >> 4;
p += (uint32) 118600 *4 / _chn[c].freq;
// FIXME: Fingolfin asks: why is there a FIXME here? Please either clarify what
// needs fixing, or remove it!
/* FIXME */
if (_chn[c].flags & AGI_SOUND_LOOP) {
p %= _chn[c].size << 8;
} else {
if (p >= _chn[c].size << 8) {
p = _chn[c].vol = 0;
_chn[c].end = 1;
break;
}
}
}
_chn[c].phase = p;
} else {
/* Add white noise */
for (i = 0; i < BUFFER_SIZE; i++) {
b = _vm->_rnd->getRandomNumber(255) - 128;
_sndBuffer[i] += (b * m) >> 4;
}
}
switch (_chn[c].adsr) {
case AGI_SOUND_ENV_ATTACK:
/* not implemented */
_chn[c].adsr = AGI_SOUND_ENV_DECAY;
break;
case AGI_SOUND_ENV_DECAY:
if (_chn[c].env > _chn[c].vol * ENV_SUSTAIN + ENV_DECAY) {
_chn[c].env -= ENV_DECAY;
} else {
_chn[c].env = _chn[c].vol * ENV_SUSTAIN;
_chn[c].adsr = AGI_SOUND_ENV_SUSTAIN;
}
break;
case AGI_SOUND_ENV_SUSTAIN:
break;
case AGI_SOUND_ENV_RELEASE:
if (_chn[c].env >= ENV_RELEASE) {
_chn[c].env -= ENV_RELEASE;
} else {
_chn[c].env = 0;
}
}
}
return BUFFER_SIZE;
}
/**
* Finds information about an Apple IIGS AGI executable based on the game ID.
* @return A non-null IIgsExeInfo pointer if successful, otherwise NULL.
*/
const IIgsExeInfo *SoundMgr::getIIgsExeInfo(enum AgiGameID gameid) const {
for (int i = 0; i < ARRAYSIZE(IIgsExeInfos); i++)
if (IIgsExeInfos[i].gameid == gameid)
return &IIgsExeInfos[i];
return NULL;
}
bool SoundMgr::loadInstrumentHeaders(const Common::String &exePath, const IIgsExeInfo &exeInfo) {
bool loadedOk = false; // Was loading successful?
Common::File file;
// Open the executable file and check that it has correct size
file.open(exePath);
if (file.size() != exeInfo.exeSize) {
debugC(3, kDebugLevelSound, "Apple IIGS executable (%s) has wrong size (Is %d, should be %d)",
exePath.c_str(), file.size(), exeInfo.exeSize);
}
// Read the whole executable file into memory
Common::MemoryReadStream *data = file.readStream(file.size());
file.close();
// Check that we got enough data to be able to parse the instruments
if (data != NULL && data->size() >= (exeInfo.instSetStart + exeInfo.instSet.byteCount)) {
// Check instrument set's length (The info's saved in the executable)
data->seek(exeInfo.instSetStart - 4);
uint16 instSetByteCount = data->readUint16LE();
if (instSetByteCount != exeInfo.instSet.byteCount) {
debugC(3, kDebugLevelSound, "Wrong instrument set size (Is %d, should be %d) in Apple IIGS executable (%s)",
instSetByteCount, exeInfo.instSet.byteCount, exePath.c_str());
}
// Check instrument set's md5sum
data->seek(exeInfo.instSetStart);
char md5str[32+1];
Common::md5_file_string(*data, md5str, exeInfo.instSet.byteCount);
if (scumm_stricmp(md5str, exeInfo.instSet.md5)) {
warning("Unknown Apple IIGS instrument set (md5: %s) in %s, trying to use it nonetheless",
md5str, exePath.c_str());
}
// Read in the instrument set one instrument at a time
data->seek(exeInfo.instSetStart);
g_numInstruments = 0; // Zero number of successfully loaded instruments
for (uint i = 0; i < exeInfo.instSet.instCount; i++) {
if (!g_instruments[i].read(*data)) {
warning("Error loading Apple IIGS instrument (%d. of %d) from %s, not loading more instruments",
i + 1, exeInfo.instSet.instCount, exePath.c_str());
break;
}
g_numInstruments++; // Increase number of successfully loaded instruments
}
// Loading was successful only if all instruments were loaded successfully
loadedOk = (g_numInstruments == exeInfo.instSet.instCount);
} else // Couldn't read enough data from the executable file
warning("Error loading instruments from Apple IIGS executable (%s)", exePath.c_str());
delete data; // Free the memory buffer allocated for reading the executable file
return loadedOk;
}
/**
* Convert sample from 8-bit unsigned to 16-bit signed format.
* @param source Source stream containing the 8-bit unsigned sample data.
* @param dest Destination buffer for the 16-bit signed sample data.
* @param length Length of the sample data to be converted.
*/
bool SoundMgr::convertWave(Common::SeekableReadStream &source, int16 *dest, uint length) {
// Convert the wave from 8-bit unsigned to 16-bit signed format
for (uint i = 0; i < length; i++)
dest[i] = (int16) ((source.readByte() - 128) * 256);
return !source.ioFailed();
}
Common::MemoryReadStream *SoundMgr::loadWaveFile(const Common::String &wavePath, const IIgsExeInfo &exeInfo) {
Common::File file;
// Open the wave file and read it into memory
file.open(wavePath);
Common::MemoryReadStream *uint8Wave = file.readStream(file.size());
file.close();
// Check that we got the whole wave file
if (uint8Wave != NULL && uint8Wave->size() == SIERRASTANDARD_SIZE) {
// Check wave file's md5sum
char md5str[32+1];
Common::md5_file_string(*uint8Wave, md5str, SIERRASTANDARD_SIZE);
if (scumm_stricmp(md5str, exeInfo.instSet.waveFileMd5)) {
warning("Unknown Apple IIGS wave file (md5: %s, game: %s).\n" \
"Please report the information on the previous line to the ScummVM team.\n" \
"Using the wave file as it is - music may sound weird", md5str, exeInfo.exePrefix);
}
uint8Wave->seek(0); // Seek wave to its start
return uint8Wave;
} else { // Couldn't read the wave file or it had incorrect size
warning("Error loading Apple IIGS wave file (%s), not loading instruments", wavePath.c_str());
delete uint8Wave; // Free the memory buffer allocated for reading the wave file
return NULL;
}
}
/**
* A function object (i.e. a functor) for testing if a FilesystemNode
* object's name is equal (Ignoring case) to a string or to at least
* one of the strings in a list of strings. Can be used e.g. with find_if().
*/
struct fsnodeNameEqualsIgnoreCase : public Common::UnaryFunction<const FilesystemNode&, bool> {
fsnodeNameEqualsIgnoreCase(const Common::StringList &str) : _str(str) {}
fsnodeNameEqualsIgnoreCase(const Common::String str) { _str.push_back(str); }
bool operator()(const FilesystemNode ¶m) const {
for (Common::StringList::const_iterator iter = _str.begin(); iter != _str.end(); iter++)
if (param.getName().equalsIgnoreCase(*iter))
return true;
return false;
}
private:
Common::StringList _str;
};
bool SoundMgr::loadInstruments() {
// Check that the platform is Apple IIGS, as only it uses custom instruments
if (_vm->getPlatform() != Common::kPlatformApple2GS) {
debugC(3, kDebugLevelSound, "Platform isn't Apple IIGS so not loading any instruments");
return true;
}
// Get info on the particular Apple IIGS AGI game's executable
const IIgsExeInfo *exeInfo = getIIgsExeInfo((enum AgiGameID) _vm->getGameID());
if (exeInfo == NULL) {
warning("Unsupported Apple IIGS game, not loading instruments");
return false;
}
// List files in the game path
FSList fslist;
FilesystemNode dir(ConfMan.get("path"));
if (!dir.getChildren(fslist, FilesystemNode::kListFilesOnly)) {
warning("Invalid game path (\"%s\"), not loading Apple IIGS instruments", dir.getPath().c_str());
return false;
}
// Populate executable filenames list (Long filename and short filename) for searching
Common::StringList exeNames;
exeNames.push_back(Common::String(exeInfo->exePrefix) + ".SYS16");
exeNames.push_back(Common::String(exeInfo->exePrefix) + ".SYS");
// Populate wave filenames list (Long filename and short filename) for searching
Common::StringList waveNames;
waveNames.push_back("SIERRASTANDARD");
waveNames.push_back("SIERRAST");
// Search for the executable file and the wave file (i.e. check if any of the filenames match)
FSList::const_iterator exeFsnode, waveFsnode;
exeFsnode = Common::find_if(fslist.begin(), fslist.end(), fsnodeNameEqualsIgnoreCase(exeNames));
waveFsnode = Common::find_if(fslist.begin(), fslist.end(), fsnodeNameEqualsIgnoreCase(waveNames));
// Make sure that we found the executable file
if (exeFsnode == fslist.end()) {
warning("Couldn't find Apple IIGS game executable (%s), not loading instruments", exeNames.begin()->c_str());
return false;
}
// Make sure that we found the wave file
if (waveFsnode == fslist.end()) {
warning("Couldn't find Apple IIGS wave file (%s), not loading instruments", waveNames.begin()->c_str());
return false;
}
// First load the wave file and then load the instrument headers.
// Finally fix the instruments' lengths using the wave file data
// (A zero in the wave file data can end the sample prematurely)
// and convert the wave file from 8-bit unsigned to 16-bit signed format.
Common::MemoryReadStream *uint8Wave = loadWaveFile(waveFsnode->getPath(), *exeInfo);
// Seek the wave to its
if (uint8Wave != NULL)
uint8Wave->seek(0);
bool result = uint8Wave != NULL && loadInstrumentHeaders(exeFsnode->getPath(), *exeInfo) &&
finalizeInstruments(*uint8Wave) && convertWave(*uint8Wave, g_wave, uint8Wave->size());
delete uint8Wave; // Free the 8-bit unsigned wave file buffer
return result;
}
static void fillAudio(void *udata, int16 *stream, uint len) {
SoundMgr *soundMgr = (SoundMgr *)udata;
uint32 p = 0;
static uint32 n = 0, s = 0;
len <<= 2;
debugC(5, kDebugLevelSound, "(%p, %p, %d)", (void *)udata, (void *)stream, len);
memcpy(stream, (uint8 *)buffer + s, p = n);
for (n = 0, len -= p; n < len; p += n, len -= n) {
soundMgr->playSound();
n = soundMgr->mixSound() << 1;
if (len < n) {
memcpy((uint8 *)stream + p, buffer, len);
s = len;
n -= s;
return;
} else {
memcpy((uint8 *)stream + p, buffer, n);
}
}
soundMgr->playSound();
n = soundMgr->mixSound() << 1;
memcpy((uint8 *)stream + p, buffer, s = len);
n -= s;
}
SoundMgr::SoundMgr(AgiBase *agi, Audio::Mixer *pMixer) {
_vm = agi;
_mixer = pMixer;
_sampleRate = pMixer->getOutputRate();
_endflag = -1;
_playingSound = -1;
_sndBuffer = 0;
_waveform = 0;
}
void SoundMgr::premixerCall(int16 *data, uint len) {
fillAudio(this, data, len);
}
void SoundMgr::setVolume(uint8 volume) {
// TODO
}
SoundMgr::~SoundMgr() {
}
} // End of namespace Agi
|