aboutsummaryrefslogtreecommitdiff
path: root/sound/mods/maxtrax.cpp
blob: b922fb0dc306378007a16094e3598b87818351a2 (plain)
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
/* 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/scummsys.h"
#include "common/endian.h"
#include "common/stream.h"
#include "common/util.h"
#include "common/debug.h"

#include "sound/mods/maxtrax.h"

namespace Audio {

MaxTrax::MaxTrax(int rate, bool stereo)
	: Paula(stereo, rate, rate/50), _playerCtx(), _voiceCtx(), _patch(), _channelCtx(), _scores(), _numScores(), _microtonal() {
	_playerCtx.maxScoreNum = 128;
	_playerCtx.vBlankFreq = 50;
	_playerCtx.frameUnit = (uint16)((1000 * (1<<8)) /  _playerCtx.vBlankFreq);
	_playerCtx.scoreIndex = -1;
	// glob_CurrentScore = _scoreptr;
	_playerCtx.volume = 0x64;

	_playerCtx.tempoTime = 0;

	uint32 uinqueId = 0;
	byte flags = 0;

	uint32 colorClock = kPalSystemClock / 2;

	for (int i = 0; i < kNumChannels; ++i)
		resetChannel(_channelCtx[i], (i & 1) != 0);

	// init extraChannel
	// extraChannel. chan_Number = 16, chan_Flags = chan_VoicesActive = 0
}

MaxTrax::~MaxTrax() {
	stopMusic();
	freePatches();
	freeScores();
}

void MaxTrax::interrupt() {
	// a5 - maxtraxm a4 . globaldata

	// TODO
	// test for changes in shared struct and make changes
	// specifically all used channels get marked altered

	_playerCtx.ticks += _playerCtx.tickUnit;
	const int32 millis = _playerCtx.ticks >> 8; // d4
	for (int i = 0; i < ARRAYSIZE(_voiceCtx); ++i) {
		VoiceContext &voice = _voiceCtx[i]; // a3
		if (!voice.channel || voice.stopEventCommand >= 0x80)
			continue;
		const int channelNo = voice.stopEventParameter;
		voice.stopEventTime -= (channelNo < kNumChannels) ? _playerCtx.tickUnit : _playerCtx.frameUnit;
		if (voice.stopEventTime <= 0) {
			noteOff(_channelCtx[channelNo], voice.stopEventCommand);
			voice.stopEventCommand = 0xFF;
		}
	}

	if (_playerCtx.musicPlaying) {
		Event *curEvent = _playerCtx.nextEvent;
		int32 eventTime = _playerCtx.nextEventTime;
		for (; eventTime <= millis; eventTime += (++curEvent)->startTime) {
			const byte cmd = curEvent->command;
			const byte data = curEvent->parameter;
			const uint16 stopTime = curEvent->stopTime;
			ChannelContext &channel = _channelCtx[data & 0x0F];

			outPutEvent(*curEvent);
			debug("CurTime, EventTime, NextEvent: %d, %d, %d", millis, eventTime, eventTime + curEvent[1].startTime );

			if (cmd < 0x80) {
				_playerCtx.addedNote = false;
				const uint16 vol = (data & 0xF0) >> 1;

				const int8 voiceIndex = noteOn(channel, cmd, vol, kPriorityScore);
				if (voiceIndex >= 0) {
					VoiceContext &voice = _voiceCtx[voiceIndex];
					voice.stopEventCommand = cmd;
					voice.stopEventParameter = data & 0x0F;
					voice.stopEventTime = (eventTime + stopTime - millis) << 8;
				}
			} else {
				switch (cmd) {
				case 0x80:	// TEMPO
					if ((_playerCtx.tickUnit >> 8) > stopTime) {
						setTempo(data << 4);
						_playerCtx.tempoTime = 0;
					} else {
						_playerCtx.tempoStart = _playerCtx.tempo;
						_playerCtx.tempoDelta = (data << 4) - _playerCtx.tempoStart;
						_playerCtx.tempoTime  = (stopTime << 8);
						_playerCtx.tempoTicks = 0;
					}
					break;
/*				case 0xA0:	// SPECIAL
					break;
				case 0xB0:	// CONTROL
					// TODO: controlChange((byte)stopTime, (byte)(stopTime >> 8))
					break;
*/				case 0xC0:	// PROGRAM
					channel.patch = &_patch[stopTime & (kNumPatches - 1)];
					break;
				case 0xE0:	// BEND
					channel.pitchBend = ((stopTime & 0x7F00) >> 1) | (stopTime & 0x7f);
					// channel.pitchReal = ((int32)(channel.pitchBendRange << 8) * (channel.pitchBend - (64 << 7))) / (64 << 7);
					channel.pitchReal = ((channel.pitchBendRange * channel.pitchBend) >> 5) - (channel.pitchBendRange << 8);
					channel.flags |= ChannelContext::kFlagAltered;
					break;
				case 0xFF:	// END
					if (_playerCtx.musicLoop) {
						// event -1 as it gets increased at the end of the loop
						curEvent = _scores[_playerCtx.scoreIndex].events - 1;
						_playerCtx.ticks = 0;
						eventTime = 0;
					} else
						_playerCtx.musicPlaying = false;
					break;
				default:
					debug("Unhandled Command");
					outPutEvent(*curEvent);
				}
			}
		}
		_playerCtx.nextEvent = curEvent;
		_playerCtx.nextEventTime = eventTime;

		// tempoEffect
		if (_playerCtx.tempoTime) {
			_playerCtx.tempoTicks += _playerCtx.tickUnit;
			uint16 newTempo;
			if (_playerCtx.tempoTicks < _playerCtx.tempoTime) {
				const uint16 delta = (_playerCtx.tempoTicks * _playerCtx.tempoDelta) / _playerCtx.tempoTime;
				newTempo = delta;
			} else {
				_playerCtx.tempoTime = 0;
				newTempo = _playerCtx.tempoDelta;
			}
			setTempo(_playerCtx.tempoStart + newTempo);
		}
	}

	// envelopes
	for (int i = 0; i < ARRAYSIZE(_voiceCtx); ++i) {
		VoiceContext &voice = _voiceCtx[i]; // a2
		if (!voice.channel)
			continue;
		ChannelContext &channel = *voice.channel; // a3
		Patch &patch = *voice.patch; // a5, used with start and later
		voice.lastTicks += _playerCtx.tickUnit;
		bool envHandling = true;
		byte newVolume = 0xFF; // if set to 0 this means skip recalc
		switch (voice.status) {
		case VoiceContext::kStatusSustain:
			// and no modulation 
			if ((channel.flags & ChannelContext::kFlagAltered) == 0 && (voice.flags & VoiceContext::kFlagPortamento) == 0)
				continue;
			// goto .l18
			envHandling = false;
			break;

		case VoiceContext::kStatusHalt:
			killVoice((byte)i);
			continue;

		case VoiceContext::kStatusStart:
			voice.envelope = patch.attackPtr;
			if (patch.attackLen) {
				const uint16 duration = voice.envelope->duration;
				voice.envelopeLeft = patch.attackLen;
				voice.ticksLeft = duration << 8;
				voice.status = VoiceContext::kStatusAttack;
				voice.lastTicks = _playerCtx.tickUnit;
				const int32 vol = voice.envelope->volume;
				voice.incrVolume = (duration) ? (1000 * vol) / (duration * _playerCtx.vBlankFreq) : vol;
				// skip to I9
			} else {
				voice.status = VoiceContext::kStatusSustain;
				voice.baseVolume = patch.volume;
				voice.lastTicks = _playerCtx.tickUnit;
				// goto .l18
				envHandling = false;
			}
			break;

		case VoiceContext::kStatusRelease:
			voice.envelope = patch.attackPtr + patch.attackLen;
			if (patch.releaseLen) {
				const uint16 duration = voice.envelope->duration;
				voice.envelopeLeft = patch.releaseLen;
				voice.ticksLeft = duration << 8;
				voice.status = VoiceContext::kStatusDecay;
				voice.lastTicks = _playerCtx.tickUnit;
				const int32 vol = voice.envelope->volume - voice.baseVolume;
				voice.incrVolume = (duration) ? (1000 * vol) / (duration * _playerCtx.vBlankFreq) : vol;
				// skip to I9
			} else {
				voice.status = VoiceContext::kStatusHalt;
				// set d4 = 0, goto I17
				envHandling = false;
				newVolume = 0;
			}
			break;
		}
		// .I9 - env managment
		if (envHandling) {
			assert(voice.status != VoiceContext::kStatusSustain);
			if (voice.ticksLeft > _playerCtx.tickUnit) {
				voice.baseVolume = (uint16)MIN(MAX(0, voice.baseVolume + voice.incrVolume), 0x8000);
				voice.ticksLeft -= _playerCtx.tickUnit;
				// goto .l18
			} else {
				// a0 = voice.envelope
				voice.baseVolume = voice.envelope->volume;
				if (--voice.envelopeLeft) {
					++voice.envelope;
					const uint16 duration = voice.envelope->duration;
					voice.ticksLeft = duration << 8;
					const int32 vol = voice.envelope->volume - voice.baseVolume;
					voice.incrVolume = (duration) ? (1000 * vol) / (duration * _playerCtx.vBlankFreq) : vol;
					// goto .l18
				} else if (voice.status == VoiceContext::kStatusDecay) {
					voice.status = VoiceContext::kStatusHalt;
					// set d4 = 0, goto I17
					newVolume = 0;
				} else {
					assert(voice.status == VoiceContext::kStatusAttack);
					voice.status = VoiceContext::kStatusSustain;
					voice.lastTicks = _playerCtx.tickUnit;
					// goto .l18
				}
			}
		}

		// .l18 - recalc 
		if (newVolume) {
			// calc volume
			uint16 vol = (voice.noteVolume < (1 << 7)) ? (voice.noteVolume * _playerCtx.volume) >> 7 : _playerCtx.volume;
			if (voice.baseVolume < (1 << 15))
				vol = (vol * (voice.baseVolume >> 8)) >> 7;
			if (voice.channel->volume < (1 << 7))
				vol = (vol * voice.channel->volume) >> 7;

			newVolume = (byte)MIN(vol, (uint16)0x64);
			voice.lastVolume = newVolume;

			if ((voice.flags & VoiceContext::kFlagPortamento) != 0) {
				voice.portaTicks += _playerCtx.tickUnit;
				if ((uint16)(voice.portaTicks >> 8) >= channel.portamento) {
					voice.flags &= ~VoiceContext::kFlagPortamento;
					voice.baseNote = voice.endNote;
				}
				voice.flags |= VoiceContext::kFlagRecalc;
				calcNote(voice);
			} else {
				// modulation
				if ((channel.flags & ChannelContext::kFlagAltered) != 0) {
					voice.flags |= VoiceContext::kFlagRecalc;
					calcNote(voice);
				}
			}
		}

		// .l17 - send audio package
		Paula::setChannelPeriod(i, (voice.lastPeriod) ? voice.lastPeriod : 1000);
		Paula::setChannelVolume(i, (voice.lastPeriod) ? newVolume : 0);
	}
	for (int i = 0; i < ARRAYSIZE(_channelCtx); ++i) {
		ChannelContext &channel = _channelCtx[i];
		channel.flags &= ~ChannelContext::kFlagAltered;
	}


	//modulation stuff,  sinevalue += tickunit
}

void MaxTrax::stopMusic() {
}

bool MaxTrax::doSong(int songIndex, int advance) {
	if (songIndex < 0 || songIndex >= _numScores)
		return false;
	Paula::pausePlay(true);
	_playerCtx.musicPlaying = false;
	_playerCtx.musicLoop = false;

	setTempo(_playerCtx.tempoInitial << 4);
	_playerCtx.nextEvent = _scores[songIndex].events;
	_playerCtx.nextEventTime = _playerCtx.nextEvent->startTime;
	_playerCtx.scoreIndex = songIndex;

	_playerCtx.musicPlaying = true;
	Paula::startPaula();
	return true;
}

void MaxTrax::killVoice(byte num) {
	VoiceContext &voice = _voiceCtx[num];
	--(voice.channel->voicesActive);
	voice.channel = 0;
	voice.status = VoiceContext::kStatusFree;
	voice.flags = 0;
	voice.priority = 0;
	voice.uinqueId = 0;

	// "stop" voice, set period to 1, vol to 0
	Paula::disableChannel(0);
	Paula::setChannelPeriod(num, 1);
	Paula::setChannelVolume(num, 0);
}

int MaxTrax::calcNote(VoiceContext &voice) {
	ChannelContext &channel = *voice.channel;
	voice.lastPeriod = 0;

	int16 bend = 0;
	if ((voice.flags & VoiceContext::kFlagPortamento) != 0) {
		// microtonal crap

		bend = (int16)((int8)(voice.endNote - voice.baseNote) * voice.portaTicks) / channel.portamento;
	}
	// modulation
	if (channel.modulation && (channel.flags & ChannelContext::kFlagModVolume) == 0) {
		// TODO get sine
		int32 sinevalue = 0;
		// TODO
	}

	int32 tone = bend + channel.pitchReal;
	// more it-never-worked microtonal code
	tone += voice.baseNote << 8;

	Patch &patch = *voice.patch;
	tone += ((int16)patch.tune << 8) / 24;

	tone -= 45 << 8; // MIDI note 45

	tone = (((tone * 4) / 3) << 4);
	// 0x9fd77 ~ log2(1017)
	// 0x8fd77 ~ log2(508.5)
	// 0x6f73d ~ log2(125)

	enum { K_VALUE = 0x9fd77, PREF_PERIOD = 0x8fd77, PERIOD_LIMIT = 0x6f73d };

	tone = K_VALUE - tone;
	int octave = 0;

	if ((voice.flags & VoiceContext::kFlagRecalc) == 0) {
		octave = (tone > PREF_PERIOD) ? MIN((int)((tone + 0xFFFF - PREF_PERIOD) >> 16), (int)patch.sampleOctaves - 1) : 0;
		voice.periodOffset = octave << 16;
	}
	tone -= voice.periodOffset;
	if (tone >= PERIOD_LIMIT)
		// we need to scale with log(2)
		voice.lastPeriod = (uint16)expf((float)tone * (float)(0.69314718055994530942 / (1 << 16)));
	return octave;
}

int8 MaxTrax::noteOn(ChannelContext &channel, const byte note, uint16 volume, uint16 pri) {
	if (channel.microtonal >= 0)
		_microtonal[note % 127] = channel.microtonal;
	if (!volume)
		return -1;

	Patch &patch = *channel.patch;
	if (!patch.samplePtr)
		return -1;
	int8 voiceNum = -1;
	if ((channel.flags & ChannelContext::kFlagMono) != 0  && channel.voicesActive) {
		for (voiceNum = ARRAYSIZE(_voiceCtx) - 1; voiceNum >= 0 && _voiceCtx[voiceNum].channel != &channel; --voiceNum)
			;
		if (voiceNum < 0)
			return -1;

		VoiceContext &voice = _voiceCtx[voiceNum];
		if (voice.status >= VoiceContext::kStatusSustain && (channel.flags & ChannelContext::kFlagPortamento) != 0) {
			// reset previous porta
			if ((voice.flags & VoiceContext::kFlagPortamento) != 0)
				voice.baseNote = voice.endNote;
			voice.portaTicks = 0;
			voice.flags |= VoiceContext::kFlagPortamento;
			voice.endNote = channel.lastNote = note;
			voice.noteVolume = (_playerCtx.handleVolume) ? volume + 1 : 128;
			_playerCtx.addedNote = true;
			_playerCtx.lastVoice = voiceNum;
			return voiceNum;
		}
	} else {
		// TODO:
		// pickvoice based on channel.isRightChannel
		// return if no channel found
		voiceNum = (channel.flags & ChannelContext::kFlagRightChannel) != 0 ? 0 : 1;
		static int c = 0;
		voiceNum = (++c) % 4;
	}
	assert(voiceNum >= 0 && voiceNum < ARRAYSIZE(_voiceCtx));

	VoiceContext &voice = _voiceCtx[voiceNum];
	voice.flags = 0;
	if (voice.channel) {
		killVoice(voiceNum);
		voice.flags |= VoiceContext::kFlagStolen;
	}
	voice.channel = &channel;
	voice.patch = &patch;
	voice.baseNote = note;

	int useOctave = calcNote(voice);
	voice.priority = (byte)pri;
	voice.status = VoiceContext::kStatusStart;

	voice.noteVolume = (_playerCtx.handleVolume) ? volume + 1 : 128;

	// ifeq HAS_FULLCHANVOL macro
	if (channel.volume < 128)
		voice.noteVolume = (voice.noteVolume * channel.volume) >> 7;

	voice.baseVolume = 0;
	voice.lastTicks = 0;

	uint16 period = voice.lastPeriod;
	if (!period)
		period = 1000;

	// get samplestart for the given octave
	const int8 *samplePtr = patch.samplePtr + (patch.sampleTotalLen << useOctave) - patch.sampleTotalLen;
	if (patch.sampleAttackLen) {
		Paula::setChannelSampleStart(voiceNum, samplePtr);
		Paula::setChannelSampleLen(voiceNum, (patch.sampleAttackLen << useOctave) / 2);
		Paula::setChannelPeriod(voiceNum, period);
		Paula::setChannelVolume(voiceNum, 0);

		Paula::enableChannel(voiceNum);
		// wait  for dma-clear
	}

	if (patch.sampleTotalLen > patch.sampleAttackLen) {
		Paula::setChannelSampleStart(voiceNum, samplePtr + (patch.sampleAttackLen << useOctave));
		Paula::setChannelSampleLen(voiceNum, ((patch.sampleTotalLen - patch.sampleAttackLen) << useOctave) / 2);
		if (!patch.sampleAttackLen) {
			// need to enable channel
			Paula::setChannelPeriod(voiceNum, period);
			Paula::setChannelVolume(voiceNum, 0);

			Paula::enableChannel(voiceNum);
		}
		// another pointless wait for DMA-Clear???
	}

	channel.voicesActive++;
	if (&channel < &_channelCtx[kNumChannels]) {
		const byte flagsSet = ChannelContext::kFlagMono | ChannelContext::kFlagPortamento;
		if ((channel.flags & flagsSet) == flagsSet && channel.lastNote < 0x80 && channel.lastNote != voice.baseNote) {
			voice.portaTicks = 0;
			voice.endNote = voice.baseNote;
			voice.baseNote = channel.lastNote;
			voice.flags |= VoiceContext::kFlagPortamento;
		}
		if ((channel.flags & ChannelContext::kFlagPortamento) != 0)
			channel.lastNote = note;
	}
	_playerCtx.addedNote = true;
	_playerCtx.lastVoice = voiceNum;
	return voiceNum;
}

void MaxTrax::noteOff(ChannelContext &channel, const byte note) {
	VoiceContext &voice = _voiceCtx[_playerCtx.lastVoice];
	if (channel.voicesActive && voice.channel == &channel && voice.status != VoiceContext::kStatusRelease) {
		const byte refNote = ((voice.flags & VoiceContext::kFlagPortamento) != 0) ? voice.endNote : voice.baseNote;
		if (refNote == note) {
			if ((channel.flags & ChannelContext::kFlagDamper) != 0)
				voice.flags |= VoiceContext::kFlagDamper;
			else
				voice.status = VoiceContext::kStatusRelease;
		}
	}
}

void MaxTrax::resetChannel(ChannelContext &chan, bool rightChannel) {
	chan.modulation = 0;
	chan.modulationTime = 1000;
	chan.microtonal = -1;
	chan.portamento = 500;
	chan.pitchBend = 64 << 7;
	chan.pitchReal = 0;
	chan.pitchBendRange = 24;
	chan.volume = 128;
	chan.flags &= ~ChannelContext::kFlagPortamento & ~ChannelContext::kFlagMicrotonal;
	chan.flags |= ChannelContext::kFlagAltered;
	if (rightChannel)
		chan.flags |= ChannelContext::kFlagRightChannel;
	else
		chan.flags &= ~ChannelContext::kFlagRightChannel;
}

void MaxTrax::freeScores() {
	if (_scores) {
		for (int i = 0; i < _numScores; ++i)
			delete[] _scores[i].events;
		delete[] _scores;
		_scores = 0;
	}
	_numScores = 0;
	memset(_microtonal, 0, sizeof(_microtonal));
}

void MaxTrax::freePatches() {
	for (int i = 0; i < ARRAYSIZE(_patch); ++i) {
		delete[] _patch[i].samplePtr;
		delete[] _patch[i].attackPtr;
	}
	memset(_patch, 0, sizeof(_patch));
}

bool MaxTrax::load(Common::SeekableReadStream &musicData, bool loadScores, bool loadSamples) {
	bool res = false;
	stopMusic();
	if (loadSamples)
		freePatches();
	if (loadScores)
		freeScores();
	// 0x0000: 4 Bytes Header "MXTX"
	// 0x0004: uint16 tempo
	// 0x0006: uint16 flags. bit0 = lowpassfilter, bit1 = attackvolume, bit15 = microtonal	
	if (musicData.readUint32BE() != 0x4D585458) {
		warning("Maxtrax: File is not a Maxtrax Module");
		return false;
	}
	const uint16 songTempo = musicData.readUint16BE();
	const uint16 flags = musicData.readUint16BE();
	if (loadScores) {
		_playerCtx.tempoInitial = songTempo;
		_playerCtx.filterOn = (flags & 1) != 0;
		_playerCtx.handleVolume = (flags & 2) != 0;
		debug("Header: MXTX %02X %02X", _playerCtx.tempo, flags);
	}

	if (flags & (1 << 15)) {
		debug("Song has microtonal");
		if (loadScores) {
			for (int i = 0; i < ARRAYSIZE(_microtonal); ++i)
				_microtonal[i] = musicData.readUint16BE();
		} else
			musicData.skip(128 * 2);
	}

	int scoresLoaded = 0;
	// uint16 number of Scores
	const uint16 scoresInFile = musicData.readUint16BE();

	if (loadScores) {
		const uint16 tempScores = MIN(scoresInFile, _playerCtx.maxScoreNum);
		debug("#Scores: %d, loading # of scores: %d", scoresInFile, tempScores);
		Score *curScore =_scores = new Score[tempScores];
		
		for (int i = tempScores; i > 0; --i, ++curScore) {
			const uint32 numEvents = musicData.readUint32BE();
			Event *curEvent = curScore->events = new Event[numEvents];
			for (int j = numEvents; j > 0; --j, ++curEvent) {
				curEvent->command = musicData.readByte();
				curEvent->parameter = musicData.readByte();
				curEvent->startTime = musicData.readUint16BE();
				curEvent->stopTime = musicData.readUint16BE();
			}
			curScore->numEvents = numEvents;
		}
		_numScores = scoresLoaded = tempScores;
	}

	if (false && !loadSamples)
		return true;

	// skip over remaining scores in file
	for (int i = scoresInFile - scoresLoaded; i > 0; --i)
		musicData.skip(musicData.readUint32BE() * 6);

	for (int i = 0; i < _numScores; ++i)
		outPutScore(_scores[i], i);

	debug("samples start at filepos %08X", musicData.pos());
	// uint16 number of Samples
	const uint16 wavesInFile = musicData.readUint16BE();
	if (loadSamples) {
		for (int i = wavesInFile; i > 0; --i) {
			// load disksample structure
			const uint16 number = musicData.readUint16BE();
			assert(number < ARRAYSIZE(_patch));
			// pointer to samples needed?
			Patch &curPatch = _patch[number];

			curPatch.tune = musicData.readUint16BE();
			curPatch.volume = musicData.readUint16BE();
			curPatch.sampleOctaves = musicData.readUint16BE();
			curPatch.sampleAttackLen = musicData.readUint32BE();
			const uint32 sustainLen = musicData.readUint32BE();
			curPatch.sampleTotalLen = curPatch.sampleAttackLen + sustainLen;
			// each octave the number of samples doubles.
			const uint32 totalSamples = curPatch.sampleTotalLen * ((1 << curPatch.sampleOctaves) - 1);
			curPatch.attackLen = musicData.readUint16BE();
			curPatch.releaseLen = musicData.readUint16BE();
			const uint32 totalEnvs = curPatch.attackLen + curPatch.releaseLen;

			debug("wave nr %d at %08X - %d octaves", number, musicData.pos(), curPatch.sampleOctaves);
			// Allocate space for both attack and release Segment.
			Envelope *envPtr = new Envelope[totalEnvs];
			// Attack Segment
			curPatch.attackPtr = envPtr;
			// Release Segment
			// curPatch.releasePtr = envPtr + curPatch.attackLen;

			// Read Attack and Release Segments
			for (int j = totalEnvs; j > 0; --j, ++envPtr) {
				envPtr->duration = musicData.readUint16BE();
				envPtr->volume = musicData.readUint16BE();
			}

			// read Samples
			curPatch.samplePtr = new int8[totalSamples];
			musicData.read(curPatch.samplePtr, totalSamples);
		}
	} else if (wavesInFile > 0){
		uint32 skipLen = 3 * 2;
		for (int i = wavesInFile; i > 0; --i) {
			musicData.skip(skipLen);
			const uint16 octaves = musicData.readUint16BE();
			const uint32 attackLen = musicData.readUint32BE();
			const uint32 sustainLen = musicData.readUint32BE();
			const uint16 attackCount = musicData.readUint16BE();
			const uint16 releaseCount = musicData.readUint16BE();
			debug("wave nr %d at %08X", 0, musicData.pos());
			
			skipLen = attackCount * 4 + releaseCount * 4 
				+ (attackLen + sustainLen) * ((1 << octaves) - 1)
				+ 3 * 2;
		}
		musicData.skip(skipLen - 3 * 2);
	}
	debug("endpos %08X", musicData.pos());
	return res;
}

}	// End of namespace Audio