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
|
/* 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.
*
*/
#include "sci/sci.h"
#include "sci/engine/state.h"
#include "sci/engine/kernel.h"
#include "sci/engine/state.h"
#include "sci/sound/midiparser_sci.h"
#include "sci/sound/drivers/mididriver.h"
namespace Sci {
static const int nMidiParams[] = { 2, 2, 2, 2, 1, 1, 2, 0 };
enum SciMidiCommands {
kSetSignalLoop = 0x7F,
kEndOfTrack = 0xFC,
kSetReverb = 0x50,
kMidiHold = 0x52,
kUpdateCue = 0x60,
kResetOnPause = 0x4C
};
// MidiParser_SCI
//
MidiParser_SCI::MidiParser_SCI(SciVersion soundVersion, SciMusic *music) :
MidiParser() {
_soundVersion = soundVersion;
_music = music;
_mixedData = NULL;
// mididata contains delta in 1/60th second
// values of ppqn and tempo are found experimentally and may be wrong
_ppqn = 1;
setTempo(16667);
_masterVolume = 15;
_volume = 127;
_resetOnPause = false;
_pSnd = 0;
_mainThreadCalled = false;
resetStateTracking();
}
MidiParser_SCI::~MidiParser_SCI() {
unloadMusic();
// we do this, so that MidiParser won't be able to call his own ::allNotesOff()
// this one would affect all channels and we can't let that happen
_driver = 0;
}
void MidiParser_SCI::mainThreadBegin() {
assert(!_mainThreadCalled);
_mainThreadCalled = true;
}
void MidiParser_SCI::mainThreadEnd() {
assert(_mainThreadCalled);
_mainThreadCalled = false;
}
bool MidiParser_SCI::loadMusic(SoundResource::Track *track, MusicEntry *psnd, int channelFilterMask, SciVersion soundVersion) {
unloadMusic();
_track = track;
_pSnd = psnd;
_soundVersion = soundVersion;
for (int i = 0; i < 16; i++) {
_channelUsed[i] = false;
_channelMuted[i] = false;
_channelVolume[i] = 127;
if (_soundVersion <= SCI_VERSION_0_LATE)
_channelRemap[i] = i;
else
_channelRemap[i] = -1;
}
// FIXME: SSCI does not always start playing a track at the first byte.
// By default it skips 10 (or 13?) bytes containing prio/voices, patch,
// volume, pan commands in fixed locations, and possibly a signal
// in channel 15. We should initialize state tracking to those values
// so that they automatically get set up properly when the channels get
// mapped. See also the related FIXME in MidiParser_SCI::processEvent.
if (channelFilterMask) {
// SCI0 only has 1 data stream, but we need to filter out channels depending on music hardware selection
midiFilterChannels(channelFilterMask);
} else {
midiMixChannels();
}
_numTracks = 1;
_tracks[0] = _mixedData;
if (_pSnd)
setTrack(0);
_loopTick = 0;
return true;
}
byte MidiParser_SCI::midiGetNextChannel(long ticker) {
byte curr = 0xFF;
long closest = ticker + 1000000, next = 0;
for (int i = 0; i < _track->channelCount; i++) {
if (_track->channels[i].time == -1) // channel ended
continue;
SoundResource::Channel *curChannel = &_track->channels[i];
if (curChannel->curPos >= curChannel->data.size())
continue;
next = curChannel->data[curChannel->curPos]; // when the next event should occur
if (next == 0xF8) // 0xF8 means 240 ticks delay
next = 240;
next += _track->channels[i].time;
if (next < closest) {
curr = i;
closest = next;
}
}
return curr;
}
byte *MidiParser_SCI::midiMixChannels() {
int totalSize = 0;
for (int i = 0; i < _track->channelCount; i++) {
_track->channels[i].time = 0;
_track->channels[i].prev = 0;
_track->channels[i].curPos = 0;
totalSize += _track->channels[i].data.size();
}
byte *outData = new byte[totalSize * 2]; // FIXME: creates overhead and still may be not enough to hold all data
_mixedData = outData;
long ticker = 0;
byte channelNr, curDelta;
byte midiCommand = 0, midiParam, globalPrev = 0;
long newDelta;
SoundResource::Channel *channel;
while ((channelNr = midiGetNextChannel(ticker)) != 0xFF) { // there is still an active channel
channel = &_track->channels[channelNr];
curDelta = channel->data[channel->curPos++];
channel->time += (curDelta == 0xF8 ? 240 : curDelta); // when the command is supposed to occur
if (curDelta == 0xF8)
continue;
newDelta = channel->time - ticker;
ticker += newDelta;
midiCommand = channel->data[channel->curPos++];
if (midiCommand != kEndOfTrack) {
// Write delta
while (newDelta > 240) {
*outData++ = 0xF8;
newDelta -= 240;
}
*outData++ = (byte)newDelta;
}
// Write command
switch (midiCommand) {
case 0xF0: // sysEx
*outData++ = midiCommand;
do {
midiParam = channel->data[channel->curPos++];
*outData++ = midiParam;
} while (midiParam != 0xF7);
break;
case kEndOfTrack: // end of channel
channel->time = -1;
break;
default: // MIDI command
if (midiCommand & 0x80) {
midiParam = channel->data[channel->curPos++];
} else {// running status
midiParam = midiCommand;
midiCommand = channel->prev;
}
// remember which channel got used for channel remapping
byte midiChannel = midiCommand & 0xF;
_channelUsed[midiChannel] = true;
if (midiCommand != globalPrev)
*outData++ = midiCommand;
*outData++ = midiParam;
if (nMidiParams[(midiCommand >> 4) - 8] == 2)
*outData++ = channel->data[channel->curPos++];
channel->prev = midiCommand;
globalPrev = midiCommand;
}
}
// Insert stop event
*outData++ = 0; // Delta
*outData++ = 0xFF; // Meta event
*outData++ = 0x2F; // End of track (EOT)
*outData++ = 0x00;
*outData++ = 0x00;
return _mixedData;
}
// This is used for SCI0 sound-data. SCI0 only has one stream that may
// contain several channels and according to output device we remove
// certain channels from that data.
byte *MidiParser_SCI::midiFilterChannels(int channelMask) {
SoundResource::Channel *channel = &_track->channels[0];
SciSpan<const byte>::const_iterator channelData = channel->data.cbegin();
SciSpan<const byte>::const_iterator channelDataEnd = channel->data.cend();
byte *outData = new byte[channel->data.size() + 5];
byte curChannel = 15, curByte, curDelta;
byte command = 0, lastCommand = 0;
int delta = 0;
int midiParamCount = 0;
bool containsMidiData = false;
_mixedData = outData;
while (channelData != channelDataEnd) {
curDelta = *channelData++;
if (curDelta == 0xF8) {
delta += 240;
continue;
}
delta += curDelta;
curByte = *channelData++;
switch (curByte) {
case 0xF0: // sysEx
case kEndOfTrack: // end of channel
command = curByte;
curChannel = 15;
break;
default:
if (curByte & 0x80) {
command = curByte;
curChannel = command & 0x0F;
midiParamCount = nMidiParams[(command >> 4) - 8];
}
}
if ((1 << curChannel) & channelMask) {
if (curChannel != 0xF)
containsMidiData = true;
// Write delta
while (delta > 240) {
*outData++ = 0xF8;
delta -= 240;
}
*outData++ = (byte)delta;
delta = 0;
// Write command
switch (command) {
case 0xF0: // sysEx
*outData++ = command;
do {
curByte = *channelData++;
*outData++ = curByte; // out
} while (curByte != 0xF7);
lastCommand = command;
break;
case kEndOfTrack: // end of channel
break;
default: // MIDI command
// remember which channel got used for channel remapping
byte midiChannel = command & 0xF;
_channelUsed[midiChannel] = true;
if (lastCommand != command) {
*outData++ = command;
lastCommand = command;
}
if (midiParamCount > 0) {
if (curByte & 0x80)
*outData++ = *channelData++;
else
*outData++ = curByte;
}
if (midiParamCount > 1) {
*outData++ = *channelData++;
}
}
} else {
if (curByte & 0x80)
channelData += midiParamCount;
else
channelData += midiParamCount - 1;
}
}
// Insert stop event
// (Delta is already output above)
*outData++ = 0xFF; // Meta event
*outData++ = 0x2F; // End of track (EOT)
*outData++ = 0x00;
*outData++ = 0x00;
// This occurs in the music tracks of LB1 Amiga, when using the MT-32
// driver (bug #3297881)
if (!containsMidiData)
warning("MIDI parser: the requested SCI0 sound has no MIDI note data for the currently selected sound driver");
return _mixedData;
}
void MidiParser_SCI::resetStateTracking() {
for (int i = 0; i < 16; ++i) {
ChannelState &s = _channelState[i];
s._modWheel = 0;
s._pan = 64;
s._patch = 0; // TODO: Initialize properly (from data in LoadMusic?)
s._note = -1;
s._sustain = false;
s._pitchWheel = 0x2000;
s._voices = 0;
_channelVolume[i] = 127;
}
}
void MidiParser_SCI::sendInitCommands() {
resetStateTracking();
// reset our "global" volume
_volume = 127;
// Set initial voice count
if (_pSnd) {
if (_soundVersion <= SCI_VERSION_0_LATE) {
for (int i = 0; i < 15; ++i) {
byte voiceCount = 0;
if (_channelUsed[i]) {
voiceCount = _pSnd->soundRes->getInitialVoiceCount(i);
sendToDriver(0xB0 | i, 0x4B, voiceCount);
}
}
} else {
for (int i = 0; i < _track->channelCount; ++i) {
byte voiceCount = _track->channels[i].poly;
byte num = _track->channels[i].number;
// TODO: Should we skip the control channel?
sendToDriver(0xB0 | num, 0x4B, voiceCount);
}
}
}
// Reset all the parameters of the channels used by this song
for (int i = 0; i < 16; ++i) {
if (_channelUsed[i]) {
sendToDriver(0xB0 | i, 0x07, 127); // Reset volume to maximum
sendToDriver(0xB0 | i, 0x0A, 64); // Reset panning to center
sendToDriver(0xB0 | i, 0x40, 0); // Reset hold pedal to none
sendToDriver(0xB0 | i, 0x4E, 0); // Reset velocity to none
sendToDriver(0xE0 | i, 0, 64); // Reset pitch wheel to center
}
}
}
void MidiParser_SCI::unloadMusic() {
if (_pSnd) {
resetTracking();
allNotesOff();
}
_numTracks = 0;
_activeTrack = 255;
_resetOnPause = false;
if (_mixedData) {
delete[] _mixedData;
_mixedData = NULL;
}
}
// this is used for scripts sending midi commands to us. we verify in that case that the channel is actually
// used, so that channel remapping will work as well and then send them on
void MidiParser_SCI::sendFromScriptToDriver(uint32 midi) {
byte midiChannel = midi & 0xf;
if (!_channelUsed[midiChannel]) {
// trying to send to an unused channel
// this happens for cmdSendMidi at least in sq1vga right at the start, it's a script issue
return;
}
sendToDriver(midi);
}
void MidiParser_SCI::sendToDriver(uint32 midi) {
// State tracking
trackState(midi);
if ((midi & 0xFFF0) == 0x4EB0 && _soundVersion >= SCI_VERSION_1_EARLY) {
// Mute. Handled in trackState().
// CHECKME: Should we send this on to the driver?
return;
}
if ((midi & 0xFFF0) == 0x07B0) {
// someone trying to set channel volume?
int channelVolume = (midi >> 16) & 0xFF;
// Adjust volume accordingly to current local volume
channelVolume = channelVolume * _volume / 127;
midi = (midi & 0xFFFF) | ((channelVolume & 0xFF) << 16);
}
// Channel remapping
byte midiChannel = midi & 0xf;
int16 realChannel = _channelRemap[midiChannel];
if (realChannel == -1)
return;
midi = (midi & 0xFFFFFFF0) | realChannel;
sendToDriver_raw(midi);
}
void MidiParser_SCI::sendToDriver_raw(uint32 midi) {
if (_mainThreadCalled)
_music->putMidiCommandInQueue(midi);
else
_driver->send(midi);
}
void MidiParser_SCI::trackState(uint32 b) {
// We keep track of most of the state of a midi channel, so we can
// at any time reset the device to the current state, even if the
// channel has been temporarily disabled due to remapping.
byte command = b & 0xf0;
byte channel = b & 0xf;
byte op1 = (b >> 8) & 0x7f;
byte op2 = (b >> 16) & 0x7f;
ChannelState &s = _channelState[channel];
switch (command) {
case 0x90:
if (op2 != 0) {
// note on
s._note = op1;
break;
}
// else, fall-through
case 0x80:
// note off
if (s._note == op1)
s._note = -1;
break;
case 0xB0:
// control change
switch (op1) {
case 0x01: // mod wheel
s._modWheel = op2;
break;
case 0x07: // channel volume
_channelVolume[channel] = op2;
break;
case 0x0A: // pan
s._pan = op2;
break;
case 0x40: // sustain
s._sustain = (op2 != 0);
break;
case 0x4B: // voices
if (s._voices != op2) {
// CHECKME: Should we directly call remapChannels() if _mainThreadCalled?
debugC(2, kDebugLevelSound, "Dynamic voice change (%d to %d)", s._voices, op2);
_music->needsRemap();
}
s._voices = op2;
_pSnd->_chan[channel]._voices = op2; // Also sync our MusicEntry
break;
case 0x4E: // mute
// This is channel mute only for sci1.
// (It's velocity control for sci0, but we don't need state in sci0)
if (_soundVersion > SCI_VERSION_1_EARLY) {
// FIXME: mute is a level, not a bool, in some SCI versions
bool m = op2;
if (_pSnd->_chan[channel]._mute != m) {
_pSnd->_chan[channel]._mute = m;
// CHECKME: Should we directly call remapChannels() if _mainThreadCalled?
_music->needsRemap();
debugC(2, kDebugLevelSound, "Dynamic mute change (arg = %d, mainThread = %d)", m, _mainThreadCalled);
}
}
break;
default:
break;
}
break;
case 0xC0:
// program change
s._patch = op1;
break;
case 0xE0:
// pitchwheel
s._pitchWheel = (op2 << 7) | op1;
break;
default:
break;
}
}
void MidiParser_SCI::parseNextEvent(EventInfo &info) {
info.start = _position._playPos;
info.delta = 0;
while (*_position._playPos == 0xF8) {
info.delta += 240;
_position._playPos++;
}
info.delta += *(_position._playPos++);
// Process the next info.
if ((_position._playPos[0] & 0xF0) >= 0x80)
info.event = *(_position._playPos++);
else
info.event = _position._runningStatus;
if (info.event < 0x80)
return;
_position._runningStatus = info.event;
switch (info.command()) {
case 0xC:
info.basic.param1 = *(_position._playPos++);
info.basic.param2 = 0;
break;
case 0xD:
info.basic.param1 = *(_position._playPos++);
info.basic.param2 = 0;
break;
case 0xB:
info.basic.param1 = *(_position._playPos++);
info.basic.param2 = *(_position._playPos++);
info.length = 0;
break;
case 0x8:
case 0x9:
case 0xA:
case 0xE:
info.basic.param1 = *(_position._playPos++);
info.basic.param2 = *(_position._playPos++);
if (info.command() == 0x9 && info.basic.param2 == 0) {
// NoteOn with param2==0 is a NoteOff
info.event = info.channel() | 0x80;
}
info.length = 0;
break;
case 0xF: // System Common, Meta or SysEx event
switch (info.event & 0x0F) {
case 0x2: // Song Position Pointer
info.basic.param1 = *(_position._playPos++);
info.basic.param2 = *(_position._playPos++);
break;
case 0x3: // Song Select
info.basic.param1 = *(_position._playPos++);
info.basic.param2 = 0;
break;
case 0x6:
case 0x8:
case 0xA:
case 0xB:
case 0xC:
case 0xE:
info.basic.param1 = info.basic.param2 = 0;
break;
case 0x0: // SysEx
info.length = readVLQ(_position._playPos);
info.ext.data = _position._playPos;
_position._playPos += info.length;
break;
case 0xF: // META event
info.ext.type = *(_position._playPos++);
info.length = readVLQ(_position._playPos);
info.ext.data = _position._playPos;
_position._playPos += info.length;
break;
default:
warning(
"MidiParser_SCI::parseNextEvent: Unsupported event code %x",
info.event);
} // // System Common, Meta or SysEx event
}// switch (info.command())
}
bool MidiParser_SCI::processEvent(const EventInfo &info, bool fireEvents) {
if (!fireEvents) {
// We don't do any processing that should be done while skipping events
return MidiParser::processEvent(info, fireEvents);
}
switch (info.command()) {
case 0xC:
if (info.channel() == 0xF) {// SCI special case
if (info.basic.param1 != kSetSignalLoop) {
// At least in kq5/french&mac the first scene in the intro has
// a song that sets signal to 4 immediately on tick 0. Signal
// isn't set at that point by sierra sci and it would cause the
// castle daventry text to get immediately removed, so we
// currently filter it. Sierra SCI ignores them as well at that
// time. However, this filtering should only be performed for
// SCI1 and newer games. Signalling is done differently in SCI0
// though, so ignoring these signals in SCI0 games will result
// in glitches (e.g. the intro of LB1 Amiga gets stuck - bug
// #3297883). Refer to MusicEntry::setSignal() in sound/music.cpp.
// FIXME: SSCI doesn't start playing at the very beginning
// of the stream, but at a fixed location a few commands later.
// That is probably why this signal isn't triggered
// immediately there.
bool skipSignal = false;
if (_soundVersion >= SCI_VERSION_1_EARLY) {
if (!_position._playTick) {
skipSignal = true;
switch (g_sci->getGameId()) {
case GID_ECOQUEST2:
// In Eco Quest 2 room 530 - gonzales is supposed to dance
// WORKAROUND: we need to signal in this case on tick 0
// this whole issue is complicated and can only be properly fixed by
// changing the whole parser to a per-channel parser. SSCI seems to
// start each channel at offset 13 (may be 10 for us) and only
// starting at offset 0 when the music loops to the initial position.
if (g_sci->getEngineState()->currentRoomNumber() == 530)
skipSignal = false;
break;
default:
break;
}
}
}
if (!skipSignal) {
if (!_jumpingToTick) {
_pSnd->setSignal(info.basic.param1);
debugC(4, kDebugLevelSound, "signal %04x", info.basic.param1);
}
}
} else {
_loopTick = _position._playTick;
}
// Done with this event.
return true;
}
// Break to let parent handle the rest.
break;
case 0xB:
// Reference for some events:
// http://wiki.scummvm.org/index.php/SCI/Specifications/Sound/SCI0_Resource_Format#Status_Reference
// Handle common special events
switch (info.basic.param1) {
case kSetReverb:
if (info.basic.param2 == 127) // Set global reverb instead
_pSnd->reverb = _music->getGlobalReverb();
else
_pSnd->reverb = info.basic.param2;
((MidiPlayer *)_driver)->setReverb(_pSnd->reverb);
break;
default:
break;
}
// Handle events sent to the SCI special channel (15)
if (info.channel() == 0xF) {
switch (info.basic.param1) {
case kSetReverb:
// Already handled above
return true;
case kMidiHold:
// Check if the hold ID marker is the same as the hold ID
// marker set for that song by cmdSetSoundHold.
// If it is, loop back, but don't stop notes when jumping.
if (info.basic.param2 == _pSnd->hold) {
jumpToTick(_loopTick, false, false);
// Done with this event.
return true;
}
return true;
case kUpdateCue:
if (!_jumpingToTick) {
int inc;
switch (_soundVersion) {
case SCI_VERSION_0_EARLY:
case SCI_VERSION_0_LATE:
inc = info.basic.param2;
break;
case SCI_VERSION_1_EARLY:
case SCI_VERSION_1_LATE:
case SCI_VERSION_2_1_EARLY:
inc = 1;
break;
default:
error("unsupported _soundVersion");
}
_pSnd->dataInc += inc;
debugC(4, kDebugLevelSound, "datainc %04x", inc);
}
return true;
case kResetOnPause:
_resetOnPause = info.basic.param2;
return true;
// Unhandled SCI commands
case 0x46: // LSL3 - binoculars
case 0x61: // Iceman (AdLib?)
case 0x73: // Hoyle
case 0xD1: // KQ4, when riding the unicorn
// Obscure SCI commands - ignored
return true;
// Standard MIDI commands
case 0x01: // mod wheel
case 0x04: // foot controller
case 0x07: // channel volume
case 0x0A: // pan
case 0x0B: // expression
case 0x40: // sustain
case 0x79: // reset all
case 0x7B: // notes off
// These are all handled by the music driver, so ignore them
break;
case 0x4B: // voice mapping
// TODO: is any support for this needed at the MIDI parser level?
warning("Unhanded SCI MIDI command 0x%x - voice mapping (parameter %d)", info.basic.param1, info.basic.param2);
return true;
default:
warning("Unhandled SCI MIDI command 0x%x (parameter %d)", info.basic.param1, info.basic.param2);
return true;
}
}
// Break to let parent handle the rest.
break;
case 0xF: // META event
if (info.ext.type == 0x2F) {// end of track reached
if (_pSnd->loop)
_pSnd->loop--;
// QFG3 abuses the hold flag. Its scripts call kDoSoundSetHold,
// but sometimes there's no hold marker in the associated songs
// (e.g. song 110, during the intro). The original interpreter
// treats this case as an infinite loop (bug #3311911).
if (_pSnd->loop || _pSnd->hold > 0) {
jumpToTick(_loopTick);
// Done with this event.
return true;
} else {
_pSnd->status = kSoundStopped;
_pSnd->setSignal(SIGNAL_OFFSET);
debugC(4, kDebugLevelSound, "signal EOT");
}
}
// Break to let parent handle the rest.
break;
default:
// Break to let parent handle the rest.
break;
}
// Let parent handle the rest
return MidiParser::processEvent(info, fireEvents);
}
byte MidiParser_SCI::getSongReverb() {
assert(_track);
if (_soundVersion >= SCI_VERSION_1_EARLY) {
for (int i = 0; i < _track->channelCount; i++) {
SoundResource::Channel &channel = _track->channels[i];
// Peek ahead in the control channel to get the default reverb setting
if (channel.number == 15 && channel.data.size() >= 7)
return channel.data[6];
}
}
return 127;
}
void MidiParser_SCI::allNotesOff() {
if (!_driver)
return;
int i, j;
// Turn off all active notes
for (i = 0; i < 128; ++i) {
for (j = 0; j < 16; ++j) {
if ((_activeNotes[i] & (1 << j)) && (_channelRemap[j] != -1)){
sendToDriver(0x80 | j, i, 0);
}
}
}
// Turn off all hanging notes
for (i = 0; i < ARRAYSIZE(_hangingNotes); i++) {
byte midiChannel = _hangingNotes[i].channel;
if ((_hangingNotes[i].timeLeft) && (_channelRemap[midiChannel] != -1)) {
sendToDriver(0x80 | midiChannel, _hangingNotes[i].note, 0);
_hangingNotes[i].timeLeft = 0;
}
}
_hangingNotesCount = 0;
// To be sure, send an "All Note Off" event (but not all MIDI devices
// support this...).
for (i = 0; i < 16; ++i) {
if (_channelRemap[i] != -1) {
sendToDriver(0xB0 | i, 0x7b, 0); // All notes off
sendToDriver(0xB0 | i, 0x40, 0); // Also send a sustain off event (bug #3116608)
}
}
memset(_activeNotes, 0, sizeof(_activeNotes));
}
void MidiParser_SCI::setMasterVolume(byte masterVolume) {
assert(masterVolume <= MUSIC_MASTERVOLUME_MAX);
_masterVolume = masterVolume;
switch (_soundVersion) {
case SCI_VERSION_0_EARLY:
case SCI_VERSION_0_LATE:
// update driver master volume
setVolume(_volume);
break;
case SCI_VERSION_1_EARLY:
case SCI_VERSION_1_LATE:
case SCI_VERSION_2_1_EARLY:
// directly set master volume (global volume is merged with channel volumes)
((MidiPlayer *)_driver)->setVolume(masterVolume);
break;
default:
error("MidiParser_SCI::setVolume: Unsupported soundVersion");
}
}
void MidiParser_SCI::setVolume(byte volume) {
assert(volume <= MUSIC_VOLUME_MAX);
_volume = volume;
switch (_soundVersion) {
case SCI_VERSION_0_EARLY:
case SCI_VERSION_0_LATE: {
// SCI0 adlib driver doesn't support channel volumes, so we need to go this way
int16 globalVolume = _volume * _masterVolume / MUSIC_VOLUME_MAX;
((MidiPlayer *)_driver)->setVolume(globalVolume);
break;
}
case SCI_VERSION_1_EARLY:
case SCI_VERSION_1_LATE:
case SCI_VERSION_2_1_EARLY:
// Send previous channel volumes again to actually update the volume
for (int i = 0; i < 15; i++)
if (_channelRemap[i] != -1)
sendToDriver(0xB0 + i, 7, _channelVolume[i]);
break;
default:
error("MidiParser_SCI::setVolume: Unsupported soundVersion");
}
}
void MidiParser_SCI::remapChannel(int channel, int devChannel) {
if (_channelRemap[channel] == devChannel)
return;
_channelRemap[channel] = devChannel;
if (devChannel == -1)
return;
// debug(" restoring state: channel %d on devChannel %d", channel, devChannel);
// restore state
ChannelState &s = _channelState[channel];
int channelVolume = _channelVolume[channel];
channelVolume = (channelVolume * _volume / 127) & 0xFF;
byte pitch1 = s._pitchWheel & 0x7F;
byte pitch2 = (s._pitchWheel >> 7) & 0x7F;
sendToDriver_raw(0x0040B0 | devChannel); // sustain off
sendToDriver_raw(0x004BB0 | devChannel | (s._voices << 16));
sendToDriver_raw(0x0000C0 | devChannel | (s._patch << 8));
sendToDriver_raw(0x0007B0 | devChannel | (channelVolume << 16));
sendToDriver_raw(0x000AB0 | devChannel | (s._pan << 16));
sendToDriver_raw(0x0001B0 | devChannel | (s._modWheel << 16));
sendToDriver_raw(0x0040B0 | devChannel | (s._sustain ? 0x7F0000 : 0));
sendToDriver_raw(0x0000E0 | devChannel | (pitch1 << 8) | (pitch2 << 16));
// CHECKME: Some SSCI version send a control change 0x4E with s._note as
// parameter.
// We need to investigate how (and if) drivers should act on this.
// Related: controller 0x4E is used for 'mute' in the midiparser.
// This could be a bug in SSCI that went unnoticed because few (or no?)
// drivers implement controller 0x4E
// NB: The line below is _not_ valid since s._note can be 0xFF.
// SSCI handles this out of band in the driver interface.
// sendToDriver_raw(0x004EB0 | devChannel | (s._note << 16);
}
} // End of namespace Sci
|