SCUMM: Add support for Mac Loom music and sound

It turns out that playing the Mac Loom music isn't particularly
different from playing the Monkey Island 1 music, except the data
layout is a bit different and there's no per-note volume.

5 files changed, 553 insertions, 20 deletions

diff --git a/engines/scumm/module.mk b/engines/scumm/module.mk
index 474d517cbd..57a495a772 100644
--- a/engines/scumm/module.mk
+++ b/engines/scumm/module.mk
@@ -47,6 +47,7 @@ MODULE_OBJS := \
 	player_v2base.o \
 	player_v2cms.o \
 	player_v3a.o \
+	player_v3m.o \
 	player_v4a.o \
 	player_v5m.o \
 	resource_v2.o \
diff --git a/engines/scumm/player_v3m.cpp b/engines/scumm/player_v3m.cpp
new file mode 100644
index 0000000000..081f48f259
--- /dev/null
+++ b/engines/scumm/player_v3m.cpp
@@ -0,0 +1,433 @@
+/* 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.
+ *
+ */
+
+/*
+	We have the following information from Lars Christensen (lechimp) and
+	Jamieson Christian (jamieson630):
+
+	RESOURCE DATA
+	LE 2 bytes Resource size
+	2 bytes Unknown
+	2 bytes 'so'
+	14 bytes Unknown
+	BE 2 bytes Instrument for Stream 1
+	BE 2 bytes Instrument for Stream 2
+	BE 2 bytes Instrument for Stream 3
+	BE 2 bytes Instrument for Stream 4
+	BE 2 bytes Instrument for Stream 5
+	BE 2 bytes Offset to Stream 1
+	BE 2 bytes Offset to Stream 2
+	BE 2 bytes Offset to Stream 3
+	BE 2 bytes Offset to Stream 4
+	BE 2 bytes Offset to Stream 5
+	? bytes The streams
+
+	STREAM DATA
+	BE 2 bytes Unknown (always 1?)
+	2 bytes Unknown (always 0?)
+	BE 2 bytes Number of events in stream
+	? bytes Stream data
+
+	Each stream event is exactly 3 bytes, therefore one can
+	assert that numEvents == (streamSize - 6) / 3. The
+	polyphony of a stream appears to be 1; in other words, only
+	one note at a time can be playing in each stream. The next
+	event is not executed until the current note (or rest) is
+	finished playing; therefore, note duration also serves as the
+	time delta between events.
+
+	FOR EACH EVENTS
+	BE 2 bytes Note duration
+	1 byte Note number to play (0 = rest/silent)
+
+	Oh, and quick speculation -- Stream 1 may be used for a
+	single-voice interleaved version of the music, where Stream 2-
+	5 represent a version of the music in up to 4-voice
+	polyphony, one voice per stream. I postulate thus because
+	the first stream of the Mac Loom theme music contains
+	interleaved voices, whereas the second stream seemed to
+	contain only the pizzicato bottom-end harp. Stream 5, in this
+	example, is empty, so if my speculation is correct, this
+	particular musical number supports 3-voice polyphony at
+	most. I must check out Streams 3 and 4 to see what they
+	contain.
+
+	==========
+
+	The instruments appear to be identified by their resource IDs:
+
+	1000	Dual Harp
+	10895	harp1
+	11445	strings1
+	11548	silent
+	13811	staff1
+	15703	brass1
+	16324	flute1
+	25614	accordian 1
+	28110	f horn1
+	29042	bassoon1
+*/
+
+#include "common/macresman.h"
+#include "common/translation.h"
+#include "engines/engine.h"
+#include "gui/message.h"
+#include "scumm/player_v3m.h"
+#include "scumm/scumm.h"
+
+#define RES_SND MKTAG('s', 'n', 'd', ' ')
+
+namespace Scumm {
+
+Player_V3M::Player_V3M(ScummEngine *scumm, Audio::Mixer *mixer)
+	: _vm(scumm),
+	  _mixer(mixer),
+	  _sampleRate(_mixer->getOutputRate()),
+	  _soundPlaying(-1) {
+
+	assert(scumm);
+	assert(mixer);
+	assert(_vm->_game.id == GID_LOOM);
+
+	int i;
+
+	for (i = 0; i < 5; i++) {
+		_channel[i]._looped = false;
+		_channel[i]._length = 0;
+		_channel[i]._data = NULL;
+		_channel[i]._pos = 0;
+		_channel[i]._pitchModifier = 0;
+		_channel[i]._velocity = 0;
+		_channel[i]._remaining = 0;
+		_channel[i]._notesLeft = false;
+		_channel[i]._instrument._data = NULL;
+		_channel[i]._instrument._size = 0;
+		_channel[i]._instrument._rate = 0;
+		_channel[i]._instrument._loopStart = 0;
+		_channel[i]._instrument._loopEnd = 0;
+		_channel[i]._instrument._baseFreq = 0;
+		_channel[i]._instrument._pos = 0;
+		_channel[i]._instrument._subPos = 0;
+	}
+
+	_pitchTable[116] = 1664510;
+	_pitchTable[117] = 1763487;
+	_pitchTable[118] = 1868350;
+	_pitchTable[119] = 1979447;
+	_pitchTable[120] = 2097152;
+	_pitchTable[121] = 2221855;
+	_pitchTable[122] = 2353973;
+	_pitchTable[123] = 2493948;
+	_pitchTable[124] = 2642246;
+	_pitchTable[125] = 2799362;
+	_pitchTable[126] = 2965820;
+	_pitchTable[127] = 3142177;
+	for (i = 115; i >= 0; --i) {
+		_pitchTable[i] = _pitchTable[i + 12] / 2;
+	}
+
+	setMusicVolume(255);
+
+	Common::MacResManager resource;
+	// \252 is a trademark glyph. I don't think we should assume that it
+	// will be preserved when copying from the Mac disk.
+	if (!resource.exists("Loom\252") && !resource.exists("Loom")) {
+		GUI::MessageDialog dialog(_(
+			"Could not find the 'Loom' Macintosh executable to read the\n"
+			"instruments from. Music will be disabled."), _("OK"));
+		dialog.runModal();
+		return;
+	}
+
+	_mixer->playStream(Audio::Mixer::kPlainSoundType, &_soundHandle, this, -1, Audio::Mixer::kMaxChannelVolume, 0, DisposeAfterUse::NO, true);
+}
+
+Player_V3M::~Player_V3M() {
+	Common::StackLock lock(_mutex);
+	_mixer->stopHandle(_soundHandle);
+	stopAllSounds_Internal();
+}
+
+void Player_V3M::setMusicVolume(int vol) {
+	debug(5, "Player_V3M::setMusicVolume(%d)", vol);
+}
+
+void Player_V3M::stopAllSounds_Internal() {
+	_soundPlaying = -1;
+	for (int i = 0; i < 3; i++) {
+		// The channel data is managed by the resource manager, so
+		// don't delete that.
+		delete[] _channel[i]._instrument._data;
+		_channel[i]._instrument._data = NULL;
+
+		_channel[i]._remaining = 0;
+		_channel[i]._notesLeft = false;
+	}
+}
+
+void Player_V3M::stopAllSounds() {
+	Common::StackLock lock(_mutex);
+	debug(5, "Player_V3M::stopAllSounds()");
+	stopAllSounds_Internal();
+}
+
+void Player_V3M::stopSound(int nr) {
+	Common::StackLock lock(_mutex);
+	debug(5, "Player_V3M::stopSound(%d)", nr);
+
+	if (nr == _soundPlaying) {
+		stopAllSounds();
+	}
+}
+
+void Player_V3M::startSound(int nr) {
+	Common::StackLock lock(_mutex);
+	debug(5, "Player_V3M::startSound(%d)", nr);
+
+	Common::MacResManager resource;
+	if (!resource.open("Loom\252") && !resource.open("Loom")) {
+		return;
+	}
+
+	const byte *ptr = _vm->getResourceAddress(rtSound, nr);
+	assert(ptr);
+
+	const byte *src = ptr;
+	uint i;
+
+	assert(src[4] == 's' && src[5] == 'o');
+	for (i = 0; i < 5; i++) {
+		int instrument = READ_BE_UINT16(src + 20 + 2 * i);
+		int offset = READ_BE_UINT16(src + 30 + 2 * i);
+		_channel[i]._looped = false;
+		_channel[i]._length = READ_BE_UINT16(src + offset + 4) * 3;
+		_channel[i]._data = src + offset + 6;
+		_channel[i]._pos = 0;
+		_channel[i]._pitchModifier = 0;
+		_channel[i]._velocity = 0;
+		_channel[i]._remaining = 0;
+		_channel[i]._notesLeft = true;
+
+		Common::SeekableReadStream *stream = resource.getResource(RES_SND, instrument);
+		if (_channel[i].loadInstrument(stream)) {
+			debug(6, "Player_V3M::startSound: Channel %d - Loaded Instrument %d (%s)", i, instrument, resource.getResName(RES_SND, instrument).c_str());
+		} else {
+			resource.close();
+			return;
+		}
+	}
+
+	resource.close();
+	_soundPlaying = nr;
+}
+
+bool Player_V3M::Channel::loadInstrument(Common::SeekableReadStream *stream) {
+	// Load the sound
+	uint16 soundType = stream->readUint16BE();
+	if (soundType != 1) {
+		warning("Player_V3M::loadInstrument: Unsupported sound type %d", soundType);
+		return false;
+	}
+	uint16 typeCount = stream->readUint16BE();
+	if (typeCount != 1) {
+		warning("Player_V3M::loadInstrument: Unsupported data type count %d", typeCount);
+		return false;
+	}
+	uint16 dataType = stream->readUint16BE();
+	if (dataType != 5) {
+		warning("Player_V3M::loadInstrument: Unsupported data type %d", dataType);
+		return false;
+	}
+
+	stream->readUint32BE();	// initialization option
+
+	uint16 cmdCount = stream->readUint16BE();
+	if (cmdCount != 1) {
+		warning("Player_V3M::loadInstrument: Unsupported command count %d", cmdCount);
+		return false;
+	}
+	uint16 command = stream->readUint16BE();
+	if (command != 0x8050 && command != 0x8051) {
+		warning("Player_V3M::loadInstrument: Unsupported command 0x%04X", command);
+		return false;
+	}
+
+	stream->readUint16BE(); // 0
+	uint32 soundHeaderOffset = stream->readUint32BE();
+
+	stream->seek(soundHeaderOffset);
+
+	uint32 soundDataOffset = stream->readUint32BE();
+	uint32 size = stream->readUint32BE();
+	uint32 rate = stream->readUint32BE() >> 16;
+	uint32 loopStart = stream->readUint32BE();
+	uint32 loopEnd = stream->readUint32BE();
+	byte encoding = stream->readByte();
+	byte baseFreq = stream->readByte();
+
+	if (encoding != 0) {
+		warning("Player_V3M::loadInstrument: Unsupported encoding %d", encoding);
+		return false;
+	}
+
+	stream->skip(soundDataOffset);
+
+	byte *data = new byte[size];
+	stream->read(data, size);
+
+	_instrument._data = data;
+	_instrument._size = size;
+	_instrument._rate = rate;
+	_instrument._loopStart = loopStart;
+	_instrument._loopEnd = loopEnd;
+	_instrument._baseFreq = baseFreq;
+
+	return true;
+}
+
+int Player_V3M::getMusicTimer() {
+	return 0;
+}
+
+int Player_V3M::getSoundStatus(int nr) const {
+	return _soundPlaying == nr;
+}
+
+int Player_V3M::readBuffer(int16 *data, const int numSamples) {
+	Common::StackLock lock(_mutex);
+
+	memset(data, 0, numSamples * 2);
+	if (_soundPlaying == -1) {
+		return numSamples;
+	}
+
+	bool notesLeft = false;
+
+	// Channel 0 seems to be what was played on low-end macs, that couldn't
+	// handle multi-channel music and play the game at the same time. I'm
+	// not sure if stream 4 is ever used, but let's use it just in case.
+
+	for (int i = 1; i < 5; i++) {
+		uint samplesLeft = numSamples;
+		int16 *ptr = data;
+
+		while (samplesLeft > 0) {
+			int generated;
+			if (_channel[i]._remaining == 0) {
+				uint16 duration;
+				byte note, velocity;
+				if (_channel[i].getNextNote(duration, note, velocity)) {
+					if (note > 0) {
+						const int pitchIdx = note + 60 - _channel[i]._instrument._baseFreq;
+						assert(pitchIdx >= 0);
+						// I don't want to use floating-point arithmetics here,
+						// but I ran into overflow problems with the church
+						// music. It's only once per note, so it should be ok.
+						double mult = (double)(_channel[i]._instrument._rate) / (double)_sampleRate;
+						_channel[i]._pitchModifier = mult * _pitchTable[pitchIdx];
+						_channel[i]._velocity = velocity;
+					} else {
+						_channel[i]._pitchModifier = 0;
+						_channel[i]._velocity = 0;
+					}
+
+					// The correct formula should be:
+					//
+					// (duration * 473 * _sampleRate) / (4 * 480 * 480)
+					//
+					// But that's likely to cause integer overflow, so
+					// we do it in two steps and hope that the rounding
+					// error won't be noticeable.
+					//
+					// The original code is a bit unclear on if it should
+					// be 473 or 437, but since the comments indicated
+					// 473 I'm assuming 437 was a typo.
+					_channel[i]._remaining = (duration * _sampleRate) / (4 * 480);
+					_channel[i]._remaining = (_channel[i]._remaining * 473) / 480;
+				} else {
+					_channel[i]._pitchModifier = 0;
+					_channel[i]._velocity = 0;
+					_channel[i]._remaining = samplesLeft;
+				}
+			}
+			generated = MIN(_channel[i]._remaining, samplesLeft);
+			if (_channel[i]._velocity != 0) {
+				_channel[i]._instrument.generateSamples(ptr, _channel[i]._pitchModifier, _channel[i]._velocity, generated);
+			}
+			ptr += generated;
+			samplesLeft -= generated;
+			_channel[i]._remaining -= generated;
+		}
+
+		if (_channel[i]._notesLeft) {
+			notesLeft = true;
+		}
+	}
+
+	if (!notesLeft) {
+		stopAllSounds_Internal();
+	}
+
+	return numSamples;
+}
+
+bool Player_V3M::Channel::getNextNote(uint16 &duration, byte &note, byte &velocity) {
+	_instrument.newNote();
+	if (_pos >= _length) {
+		if (!_looped) {
+			_notesLeft = false;
+			return false;
+		}
+		_pos = 0;
+	}
+	duration = READ_BE_UINT16(&_data[_pos]);
+	note = _data[_pos + 2];
+	velocity = 127;
+	_pos += 3;
+	return true;
+}
+
+void Player_V3M::Instrument::generateSamples(int16 *data, int pitchModifier, int volume, int numSamples) {
+	int samplesLeft = numSamples;
+	while (samplesLeft) {
+		_subPos += pitchModifier;
+		while (_subPos >= 0x10000) {
+			_subPos -= 0x10000;
+			_pos++;
+			if (_pos >= _loopEnd) {
+				_pos = _loopStart;
+			}
+		}
+
+		int sample = *data + ((_data[_pos] - 129) * 128 * volume) / 255;
+		if (sample > 32767) {
+			sample = 32767;
+		} else if (sample < -32768) {
+			sample = -32768;
+		}
+
+		*data++ = sample; // (_data[_pos] * 127) / 100;
+		samplesLeft--;
+	}
+}
+
+} // End of namespace Scumm
diff --git a/engines/scumm/player_v3m.h b/engines/scumm/player_v3m.h
new file mode 100644
index 0000000000..3465621ca3
--- /dev/null
+++ b/engines/scumm/player_v3m.h
@@ -0,0 +1,113 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifndef SCUMM_PLAYER_V3M_H
+#define SCUMM_PLAYER_V3M_H
+
+#include "common/scummsys.h"
+#include "common/util.h"
+#include "common/mutex.h"
+#include "scumm/music.h"
+#include "audio/audiostream.h"
+#include "audio/mixer.h"
+
+class Mixer;
+
+namespace Scumm {
+
+class ScummEngine;
+
+/**
+ * Scumm V3 Macintosh music driver.
+ */
+ class Player_V3M : public Audio::AudioStream, public MusicEngine {
+public:
+	Player_V3M(ScummEngine *scumm, Audio::Mixer *mixer);
+	virtual ~Player_V3M();
+
+	// MusicEngine API
+	virtual void setMusicVolume(int vol);
+	virtual void startSound(int sound);
+	virtual void stopSound(int sound);
+	virtual void stopAllSounds();
+	virtual int  getMusicTimer();
+	virtual int  getSoundStatus(int sound) const;
+
+	// AudioStream API
+	virtual int readBuffer(int16 *buffer, const int numSamples);
+	virtual bool isStereo() const { return false; }
+	virtual bool endOfData() const { return false; }
+	virtual int getRate() const { return _sampleRate; }
+
+private:
+	ScummEngine *const _vm;
+	Common::Mutex _mutex;
+	Audio::Mixer *const _mixer;
+	Audio::SoundHandle _soundHandle;
+	const uint32 _sampleRate;
+	int _soundPlaying;
+
+	void stopAllSounds_Internal();
+
+	struct Instrument {
+		byte *_data;
+		uint32 _size;
+		uint32 _rate;
+		uint32 _loopStart;
+		uint32 _loopEnd;
+		byte _baseFreq;
+
+		uint _pos;
+		uint _subPos;
+
+		void newNote() {
+			_pos = 0;
+			_subPos = 0;
+		}
+
+		void generateSamples(int16 *data, int pitchModifier, int volume, int numSamples);
+	};
+
+	struct Channel {
+		Instrument _instrument;
+		bool _looped;
+		uint32 _length;
+		const byte *_data;
+
+		uint _pos;
+		int _pitchModifier;
+		byte _velocity;
+		uint32 _remaining;
+
+		bool _notesLeft;
+
+		bool loadInstrument(Common::SeekableReadStream *stream);
+		bool getNextNote(uint16 &duration, byte &value, byte &velocity);
+ 	};
+
+	Channel _channel[5];
+	int _pitchTable[128];
+};
+
+} // End of namespace Scumm
+
+#endif
diff --git a/engines/scumm/scumm.cpp b/engines/scumm/scumm.cpp
index 67ca071a76..4ca4df44ab 100644
--- a/engines/scumm/scumm.cpp
+++ b/engines/scumm/scumm.cpp
@@ -61,6 +61,7 @@
 #include "scumm/player_v2cms.h"
 #include "scumm/player_v2a.h"
 #include "scumm/player_v3a.h"
+#include "scumm/player_v3m.h"
 #include "scumm/player_v4a.h"
 #include "scumm/player_v5m.h"
 #include "scumm/resource.h"
@@ -1820,6 +1821,8 @@ void ScummEngine::setupMusic(int midi) {
 #endif
 	} else if (_game.platform == Common::kPlatformAmiga && _game.version <= 4) {
 		_musicEngine = new Player_V4A(this, _mixer);
+	} else if (_game.platform == Common::kPlatformMacintosh && _game.id == GID_LOOM) {
+		_musicEngine = new Player_V3M(this, _mixer);
 	} else if (_game.platform == Common::kPlatformMacintosh && _game.id == GID_MONKEY) {
 		_musicEngine = new Player_V5M(this, _mixer);
 	} else if (_game.id == GID_MANIAC && _game.version == 1) {
diff --git a/engines/scumm/sound.cpp b/engines/scumm/sound.cpp
index 57345126d3..d6de1cddd5 100644
--- a/engines/scumm/sound.cpp
+++ b/engines/scumm/sound.cpp
@@ -348,26 +348,9 @@ void Sound::playSound(int soundID) {
 	}
 	else if ((_vm->_game.id == GID_LOOM) && (_vm->_game.platform == Common::kPlatformMacintosh))  {
 		// Mac version of Loom uses yet another sound format
-		/*
-		playSound #9 (room 70)
-		000000: 55 00 00 45  73 6f 00 64  01 00 00 00  00 00 00 00   |U..Eso.d........|
-		000010: 00 05 00 8e  2a 8f 2d 1c  2a 8f 2a 8f  2d 1c 00 28   |....*.-.*.*.-..(|
-		000020: 00 31 00 3a  00 43 00 4c  00 01 00 00  00 01 00 64   |.1.:.C.L.......d|
-		000030: 5a 00 01 00  00 00 01 00  64 00 00 01  00 00 00 01   |Z.......d.......|
-		000040: 00 64 5a 00  01 00 00 00  01 00 64 5a  00 01 00 00   |.dZ.......dZ....|
-		000050: 00 01 00 64  00 00 00 00  00 00 00 07  00 00 00 64   |...d...........d|
-		000060: 64 00 00 4e  73 6f 00 64  01 00 00 00  00 00 00 00   |d..Nso.d........|
-		000070: 00 05 00 89  3d 57 2d 1c  3d 57 3d 57  2d 1c 00 28   |....=W-.=W=W-..(|
-		playSound #16 (room 69)
-		000000: dc 00 00 a5  73 6f 00 64  01 00 00 00  00 00 00 00   |....so.d........|
-		000010: 00 05 00 00  2a 8f 03 e8  03 e8 03 e8  03 e8 00 28   |....*..........(|
-		000020: 00 79 00 7f  00 85 00 d6  00 01 00 00  00 19 01 18   |.y..............|
-		000030: 2f 00 18 00  01 18 32 00  18 00 01 18  36 00 18 00   |/.....2.....6...|
-		000040: 01 18 3b 00  18 00 01 18  3e 00 18 00  01 18 42 00   |..;.....>.....B.|
-		000050: 18 00 01 18  47 00 18 00  01 18 4a 00  18 00 01 18   |....G.....J.....|
-		000060: 4e 00 10 00  01 18 53 00  10 00 01 18  56 00 10 00   |N.....S.....V...|
-		000070: 01 18 5a 00  10 00 02 28  5f 00 01 00  00 00 00 00   |..Z....(_.......|
-		*/
+		if (_vm->_musicEngine) {
+			_vm->_musicEngine->startSound(soundID);
+		}
 	}
 	else if ((_vm->_game.platform == Common::kPlatformMacintosh) && (_vm->_game.id == GID_INDY3) && READ_BE_UINT16(ptr + 8) == 0x1C) {
 		// Sound format as used in Indy3 EGA Mac.