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
|
/* 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 "sci/engine/kernel.h"
#include "sci/engine/state.h"
#include "sci/sound/midiparser_sci.h"
#include "sci/sound/softseq/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
};
// MidiParser_SCI
//
MidiParser_SCI::MidiParser_SCI(SciVersion soundVersion) :
MidiParser() {
_soundVersion = soundVersion;
_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);
_volume = 0;
_signalSet = false;
_signalToSet = 0;
}
MidiParser_SCI::~MidiParser_SCI() {
unloadMusic();
}
bool MidiParser_SCI::loadMusic(SoundResource::Track *track, MusicEntry *psnd, int channelFilterMask, SciVersion soundVersion) {
unloadMusic();
_track = track;
_pSnd = psnd;
_soundVersion = soundVersion;
setVolume(psnd->volume);
if (channelFilterMask) {
// SCI0 only has 1 data stream, but we need to filter out channels depending on music hardware selection
midiFilterChannels(channelFilterMask);
} else {
midiMixChannels();
}
_num_tracks = 1;
_tracks[0] = _mixedData;
setTrack(0);
_loopTick = 0;
return true;
}
void MidiParser_SCI::unloadMusic() {
allNotesOff();
resetTracking();
_num_tracks = 0;
if (_mixedData) {
delete[] _mixedData;
_mixedData = NULL;
}
}
void MidiParser_SCI::parseNextEvent(EventInfo &info) {
// Set signal AFTER waiting for delta, otherwise we would set signal too soon resulting in all sorts of bugs
if (_signalSet) {
_signalSet = false;
_pSnd->signal = _signalToSet;
debugC(2, kDebugLevelSound, "signal %04x", _signalToSet);
}
info.start = _position._play_pos;
info.delta = 0;
while (*_position._play_pos == 0xF8) {
info.delta += 240;
_position._play_pos++;
}
info.delta += *(_position._play_pos++);
// Process the next info.
if ((_position._play_pos[0] & 0xF0) >= 0x80)
info.event = *(_position._play_pos++);
else
info.event = _position._running_status;
if (info.event < 0x80)
return;
_position._running_status = info.event;
switch (info.command()) {
case 0xC:
info.basic.param1 = *(_position._play_pos++);
info.basic.param2 = 0;
if (info.channel() == 0xF) {// SCI special case
if (info.basic.param1 != kSetSignalLoop) {
_signalSet = true;
_signalToSet = info.basic.param1;
} else {
_loopTick = _position._play_tick;
}
}
break;
case 0xD:
info.basic.param1 = *(_position._play_pos++);
info.basic.param2 = 0;
break;
case 0xB:
info.basic.param1 = *(_position._play_pos++);
info.basic.param2 = *(_position._play_pos++);
if (info.channel() == 0xF) {// SCI special
// Reference for some events:
// http://wiki.scummvm.org/index.php/SCI/Specifications/Sound/SCI0_Resource_Format#Status_Reference
// Also, sci/sound/iterator/iterator.cpp, function BaseSongIterator::parseMidiCommand()
switch (info.basic.param1) {
case kSetReverb:
// TODO: Not implemented yet
break;
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);
break;
case kUpdateCue:
switch (_soundVersion) {
case SCI_VERSION_0_EARLY:
case SCI_VERSION_0_LATE:
_pSnd->dataInc += info.basic.param2;
_signalSet = true;
_signalToSet = 0x7f + _pSnd->dataInc;
break;
case SCI_VERSION_1_EARLY:
case SCI_VERSION_1_LATE:
_pSnd->dataInc++;
break;
default:
break;
}
break;
// 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
break;
// 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 0x4E: // velocity control
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);
break;
default:
warning("Unhandled SCI MIDI command 0x%x (parameter %d)", info.basic.param1, info.basic.param2);
break;
}
}
if (info.basic.param1 == 7) // channel volume change -scale it
info.basic.param2 = info.basic.param2 * _volume / 0x7F;
info.length = 0;
break;
case 0x8:
case 0x9:
case 0xA:
case 0xE:
info.basic.param1 = *(_position._play_pos++);
info.basic.param2 = *(_position._play_pos++);
if (info.command() == 0x9 && info.basic.param2 == 0)
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._play_pos++);
info.basic.param2 = *(_position._play_pos++);
break;
case 0x3: // Song Select
info.basic.param1 = *(_position._play_pos++);
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._play_pos);
info.ext.data = _position._play_pos;
_position._play_pos += info.length;
break;
case 0xF: // META event
info.ext.type = *(_position._play_pos++);
info.length = readVLQ(_position._play_pos);
info.ext.data = _position._play_pos;
_position._play_pos += info.length;
if (info.ext.type == 0x2F) {// end of track reached
if (_pSnd->loop)
_pSnd->loop--;
if (_pSnd->loop) {
// We need to play it again...
jumpToTick(_loopTick);
} else {
_pSnd->status = kSoundStopped;
_pSnd->signal = SIGNAL_OFFSET;
debugC(2, kDebugLevelSound, "signal EOT");
}
}
break;
default:
warning(
"MidiParser_SCI::parseNextEvent: Unsupported event code %x",
info.event);
} // // System Common, Meta or SysEx event
}// switch (info.command())
}
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;
next = *_track->channels[i].data; // when the next event shoudl 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;
byte **dataPtr = new byte *[_track->channelCount];
for (int i = 0; i < _track->channelCount; i++) {
dataPtr[i] = _track->channels[i].data;
_track->channels[i].time = 0;
_track->channels[i].prev = 0;
totalSize += _track->channels[i].size;
}
byte *mixedData = new byte[totalSize * 2]; // FIXME: creates overhead and still may be not enough to hold all data
_mixedData = mixedData;
long ticker = 0;
byte curr, delta;
byte cmd, par1, global_prev = 0;
long new_delta;
SoundResource::Channel *channel;
while ((curr = midiGetNextChannel(ticker)) != 0xFF) { // there is still active channel
channel = &_track->channels[curr];
delta = *channel->data++;
channel->time += (delta == 0xF8 ? 240 : delta); // when the comamnd is supposed to occur
if (delta == 0xF8)
continue;
new_delta = channel->time - ticker;
ticker += new_delta;
cmd = *channel->data++;
if (cmd != kEndOfTrack) {
// output new delta
while (new_delta > 240) {
*mixedData++ = 0xF8;
new_delta -= 240;
}
*mixedData++ = (byte)new_delta;
}
switch (cmd) {
case 0xF0: // sysEx
*mixedData++ = cmd;
do {
par1 = *channel->data++;
*mixedData++ = par1; // out
} while (par1 != 0xF7);
break;
case kEndOfTrack: // end channel
channel->time = -1; // FIXME
break;
default: // MIDI command
if (cmd & 0x80)
par1 = *channel->data++;
else {// running status
par1 = cmd;
cmd = channel->prev;
}
if (cmd != global_prev)
*mixedData++ = cmd; // out cmd
*mixedData++ = par1;// pout par1
if (nMidiParams[(cmd >> 4) - 8] == 2)
*mixedData++ = *channel->data++; // out par2
channel->prev = cmd;
global_prev = cmd;
}// switch(cmd)
}// while (curr)
// mixing finished. inserting stop event
*mixedData++ = 0;
*mixedData++ = 0xFF;
*mixedData++ = 0x2F;
*mixedData++ = 0x00;
*mixedData++ = 0x00;
for (int channelNr = 0; channelNr < _track->channelCount; channelNr++)
_track->channels[channelNr].data = dataPtr[channelNr];
delete[] dataPtr;
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];
byte *channelData = channel->data;
byte *channelDataEnd = channel->data + channel->size;
byte *filterData = new byte[channel->size + 5];
byte curChannel, curByte, curDelta;
byte command, lastCommand;
int delta = 0;
//int dataLeft = channel->size;
int midiParamCount;
_mixedData = filterData;
command = 0;
midiParamCount = 0;
lastCommand = 0;
curChannel = 15;
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 (command != kEndOfTrack) {
debugC(2, kDebugLevelSound, "\nDELTA ");
// Write delta
while (delta > 240) {
*filterData++ = 0xF8;
debugC(2, kDebugLevelSound, "F8 ");
delta -= 240;
}
*filterData++ = (byte)delta;
debugC(2, kDebugLevelSound, "%02X ", delta);
delta = 0;
}
// Write command
switch (command) {
case 0xF0: // sysEx
*filterData++ = command;
debugC(2, kDebugLevelSound, "%02X ", command);
do {
curByte = *channelData++;
*filterData++ = curByte; // out
} while (curByte != 0xF7);
lastCommand = command;
break;
case kEndOfTrack: // end of channel
break;
default: // MIDI command
if (lastCommand != command) {
*filterData++ = command;
debugC(2, kDebugLevelSound, "%02X ", command);
lastCommand = command;
}
if (midiParamCount > 0) {
if (curByte & 0x80) {
debugC(2, kDebugLevelSound, "%02X ", *channelData);
*filterData++ = *channelData++;
} else {
debugC(2, kDebugLevelSound, "%02X ", curByte);
*filterData++ = curByte;
}
}
if (midiParamCount > 1) {
debugC(2, kDebugLevelSound, "%02X ", *channelData);
*filterData++ = *channelData++;
}
}
} else {
if (curByte & 0x80) {
channelData += midiParamCount;
} else {
channelData += midiParamCount - 1;
}
}
}
// Stop event
*filterData++ = 0; // delta
*filterData++ = 0xFF; // Meta-Event
*filterData++ = 0x2F; // End-Of-Track
*filterData++ = 0x00;
*filterData++ = 0x00;
return _mixedData;
}
void MidiParser_SCI::setVolume(byte bVolume) {
if (bVolume > 0x7F)
bVolume = 0x7F;
if (_volume != bVolume) {
_volume = bVolume;
switch (_soundVersion) {
case SCI_VERSION_0_EARLY:
case SCI_VERSION_0_LATE: {
MidiPlayer *SCIDriver = (MidiPlayer *)_driver;
int16 globalVolume = _volume * 15 / 127;
SCIDriver->setVolume(globalVolume);
break;
}
case SCI_VERSION_1_EARLY:
case SCI_VERSION_1_LATE:
// sending volume change to all active channels
for (int i = 0; i < _track->channelCount; i++)
if (_track->channels[i].number <= 0xF)
_driver->send(0xB0 + _track->channels[i].number, 7, _volume);
break;
default:
error("MidiParser_SCI::setVolume: Unsupported soundVersion");
}
}
}
} // End of namespace Sci
|