ZVISION: Create a folder structure for ZVision source files

I personally used filters within my IDE, but since others are now joining the project,
it was brought to my attention that some better organization would be nice.

2 files changed, 337 insertions, 0 deletions

diff --git a/engines/zvision/sound/zork_raw.cpp b/engines/zvision/sound/zork_raw.cpp
new file mode 100644
index 0000000000..e64feca900
--- /dev/null
+++ b/engines/zvision/sound/zork_raw.cpp
@@ -0,0 +1,217 @@
+/* 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 "common/scummsys.h"
+
+#include "zvision/zork_raw.h"
+
+#include "zvision/zvision.h"
+#include "zvision/detection.h"
+#include "zvision/utility.h"
+
+#include "common/file.h"
+#include "common/str.h"
+#include "common/stream.h"
+#include "common/memstream.h"
+#include "common/bufferedstream.h"
+#include "common/util.h"
+
+#include "audio/audiostream.h"
+#include "audio/decoders/raw.h"
+
+
+namespace ZVision {
+
+const int16 RawZorkStream::_stepAdjustmentTable[8] = {-1, -1, -1, 1, 4, 7, 10, 12};
+
+const int32 RawZorkStream::_amplitudeLookupTable[89] = {0x0007, 0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E,
+                                                        0x0010, 0x0011, 0x0013, 0x0015, 0x0017, 0x0019, 0x001C, 0x001F,
+                                                        0x0022, 0x0025, 0x0029, 0x002D, 0x0032, 0x0037, 0x003C, 0x0042,
+                                                        0x0049, 0x0050, 0x0058, 0x0061, 0x006B, 0x0076, 0x0082, 0x008F,
+                                                        0x009D, 0x00AD, 0x00BE, 0x00D1, 0x00E6, 0x00FD, 0x0117, 0x0133, 
+                                                        0x0151, 0x0173, 0x0198, 0x01C1, 0x01EE, 0x0220, 0x0256, 0x0292,
+                                                        0x02D4, 0x031C, 0x036C, 0x03C3, 0x0424, 0x048E, 0x0502, 0x0583, 
+                                                        0x0610, 0x06AB, 0x0756, 0x0812, 0x08E0, 0x09C3, 0x0ABD, 0x0BD0,
+                                                        0x0CFF, 0x0E4C, 0x0FBA, 0x114C, 0x1307, 0x14EE, 0x1706, 0x1954, 
+                                                        0x1BDC, 0x1EA5, 0x21B6, 0x2515, 0x28CA, 0x2CDF, 0x315B, 0x364B,
+                                                        0x3BB9, 0x41B2, 0x4844, 0x4F7E, 0x5771, 0x602F, 0x69CE, 0x7462, 0x7FFF};
+
+const SoundParams RawZorkStream::_zNemSoundParamLookupTable[6] = {{'6', 0x2B11, false, false},
+                                                                  {'a', 0x5622, false,  true}, 
+                                                                  {'b', 0x5622, true,  true},
+                                                                  {'n', 0x2B11, false, true},
+                                                                  {'s', 0x5622, false, true},
+                                                                  {'t', 0x5622, true, true}
+};
+
+const SoundParams RawZorkStream::_zgiSoundParamLookupTable[5] = {{'a',0x5622, false, false},
+                                                                 {'k',0x2B11, true, true},
+                                                                 {'p',0x5622, false, true},
+                                                                 {'q',0x5622, true, true},
+                                                                 {'u',0xAC44, true, true}
+};
+
+RawZorkStream::RawZorkStream(uint32 rate, bool stereo, DisposeAfterUse::Flag disposeStream, Common::SeekableReadStream *stream)
+		: _rate(rate),
+		  _stereo(0),
+		  _stream(stream, disposeStream),
+		  _endOfData(false) {
+	if (stereo)
+		_stereo = 1;
+
+	_lastSample[0].index = 0;
+	_lastSample[0].sample = 0;
+	_lastSample[1].index = 0;
+	_lastSample[1].sample = 0;
+
+	// Calculate the total playtime of the stream
+	if (stereo)
+		_playtime = Audio::Timestamp(0, _stream->size() / 2, rate);
+	else
+		_playtime = Audio::Timestamp(0, _stream->size(), rate);
+}
+
+int RawZorkStream::readBuffer(int16 *buffer, const int numSamples) {
+	int bytesRead = 0;
+
+	// 0: Left, 1: Right
+	uint channel = 0;
+
+	while (bytesRead < numSamples) {
+		byte encodedSample = _stream->readByte();
+		if (_stream->eos()) {
+			_endOfData = true;
+			return bytesRead;
+		}
+		bytesRead++;
+
+		int16 index = _lastSample[channel].index;
+		uint32 lookUpSample = _amplitudeLookupTable[index];
+
+		int32 sample = 0;
+
+		if (encodedSample & 0x40)
+			sample += lookUpSample;
+		if (encodedSample & 0x20)
+			sample += lookUpSample >> 1;
+		if (encodedSample & 0x10)
+			sample += lookUpSample >> 2;
+		if (encodedSample & 8)
+			sample += lookUpSample >> 3;
+		if (encodedSample & 4)
+			sample += lookUpSample >> 4;
+		if (encodedSample & 2)
+			sample += lookUpSample >> 5;
+		if (encodedSample & 1)
+			sample += lookUpSample >> 6;
+		if (encodedSample & 0x80)
+			sample = -sample;
+
+		sample += _lastSample[channel].sample;
+		sample = CLIP<int32>(sample, -32768, 32767);
+
+		buffer[bytesRead - 1] = (int16)sample;
+
+		index += _stepAdjustmentTable[(encodedSample >> 4) & 7];
+		index = CLIP<int16>(index, 0, 88);
+
+		_lastSample[channel].sample = sample;
+		_lastSample[channel].index = index;
+
+		// Increment and wrap the channel
+		channel = (channel + 1) & _stereo;
+	}
+
+	return bytesRead;
+}
+
+bool RawZorkStream::rewind() {
+	_stream->seek(0, 0);
+	_stream->clearErr();
+	_endOfData = false;
+	_lastSample[0].index = 0;
+	_lastSample[0].sample = 0;
+	_lastSample[1].index = 0;
+	_lastSample[1].sample = 0;
+
+	return true;
+}
+
+Audio::RewindableAudioStream *makeRawZorkStream(Common::SeekableReadStream *stream,
+                                                int rate,
+								                bool stereo,
+                                                DisposeAfterUse::Flag disposeAfterUse) {
+	if (stereo)
+		assert(stream->size() % 2 == 0);
+
+	return new RawZorkStream(rate, stereo, disposeAfterUse, stream);
+}
+
+Audio::RewindableAudioStream *makeRawZorkStream(const byte *buffer, uint32 size,
+                                                int rate,
+								                bool stereo,
+                                                DisposeAfterUse::Flag disposeAfterUse) {
+	return makeRawZorkStream(new Common::MemoryReadStream(buffer, size, disposeAfterUse), rate, stereo, DisposeAfterUse::YES);
+}
+
+Audio::RewindableAudioStream *makeRawZorkStream(const Common::String &filePath, ZVision *engine) {
+	Common::File *file = new Common::File();
+	assert(file->open(filePath));
+
+	Common::String fileName = getFileName(filePath);
+	fileName.toLowercase();
+
+	SoundParams soundParams = { ' ', 0, false, false };
+	bool foundParams = false;
+	char fileIdentifier = (engine->getGameId() == GID_NEMESIS) ? fileName[6] : fileName[7];
+
+	if (engine->getGameId() == GID_NEMESIS) {
+		for (int i = 0; i < 6; ++i) {
+			if (RawZorkStream::_zNemSoundParamLookupTable[i].identifier == fileIdentifier) {
+				soundParams = RawZorkStream::_zNemSoundParamLookupTable[i];
+				foundParams = true;
+			}
+		}
+	} else if (engine->getGameId() == GID_GRANDINQUISITOR) {
+		for (int i = 0; i < 6; ++i) {
+			if (RawZorkStream::_zgiSoundParamLookupTable[i].identifier == fileIdentifier) {
+				soundParams = RawZorkStream::_zgiSoundParamLookupTable[i];
+				foundParams = true;
+			}
+		}
+	}
+	
+	if (!foundParams)
+		error("Unable to find sound params for file '%s'. File identifier is '%c'", filePath.c_str(), fileIdentifier);
+
+	if (soundParams.packed) {
+		return makeRawZorkStream(wrapBufferedSeekableReadStream(file, 2048, DisposeAfterUse::YES), soundParams.rate, soundParams.stereo, DisposeAfterUse::YES);
+	} else {
+		byte flags = 0;
+		if (soundParams.stereo)
+			flags |= Audio::FLAG_STEREO;
+
+		return Audio::makeRawStream(file, soundParams.rate, flags, DisposeAfterUse::YES);
+	}
+}
+
+} // End of namespace ZVision
diff --git a/engines/zvision/sound/zork_raw.h b/engines/zvision/sound/zork_raw.h
new file mode 100644
index 0000000000..481ea79f2d
--- /dev/null
+++ b/engines/zvision/sound/zork_raw.h
@@ -0,0 +1,120 @@
+/* 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 ZVISION_ZORK_RAW_H
+#define ZVISION_ZORK_RAW_H
+
+#include "audio/audiostream.h"
+
+
+namespace Common {
+class SeekableReadStream;
+}
+
+namespace ZVision {
+
+class ZVision;
+
+struct SoundParams {
+	char identifier;
+	uint32 rate;
+	bool stereo;
+	bool packed;
+};
+
+/**
+ * This is a stream, which allows for playing raw ADPCM data from a stream.
+ */
+class RawZorkStream : public Audio::RewindableAudioStream {
+public:
+	RawZorkStream(uint32 rate, bool stereo, DisposeAfterUse::Flag disposeStream, Common::SeekableReadStream *stream);
+
+	~RawZorkStream() {
+	}
+
+public:
+	static const SoundParams _zNemSoundParamLookupTable[6];
+	static const SoundParams _zgiSoundParamLookupTable[5];
+
+private:
+	const int _rate;                                           // Sample rate of stream
+	Audio::Timestamp _playtime;                                // Calculated total play time
+	Common::DisposablePtr<Common::SeekableReadStream> _stream; // Stream to read data from
+	bool _endOfData;                                           // Whether the stream end has been reached
+	uint _stereo;
+
+	/** 
+	 * Holds the frequency and index from the last sample
+	 * 0 holds the left channel, 1 holds the right channel
+	 */
+	struct {
+		int32 sample;
+		int16 index;
+	} _lastSample[2];
+
+	static const int16 _stepAdjustmentTable[8];
+	static const int32 _amplitudeLookupTable[89];
+
+public:
+	int readBuffer(int16 *buffer, const int numSamples);
+
+	bool isStereo() const { return true; }
+	bool endOfData() const { return _endOfData; }
+
+	int getRate() const { return _rate; }
+	Audio::Timestamp getLength() const { return _playtime; }
+
+	bool rewind();
+};
+
+/**
+ * Creates an audio stream, which plays from the given buffer.
+ *
+ * @param buffer     Buffer to play from.
+ * @param size       Size of the buffer in bytes.
+ * @param rate       Rate of the sound data.
+ * @param dispose    AfterUse Whether to free the buffer after use (with free!).
+ * @return           The new SeekableAudioStream (or 0 on failure).
+ */
+Audio::RewindableAudioStream *makeRawZorkStream(const byte *buffer, uint32 size,
+                                                int rate,
+                                                bool stereo,
+                                                DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);
+
+/**
+ * Creates an audio stream, which plays from the given stream.
+ *
+ * @param stream     Stream object to play from.
+ * @param rate       Rate of the sound data.
+ * @param dispose    AfterUse Whether to delete the stream after use.
+ * @return           The new SeekableAudioStream (or 0 on failure).
+ */
+Audio::RewindableAudioStream *makeRawZorkStream(Common::SeekableReadStream *stream,
+                                                int rate,
+                                                bool stereo,
+                                                DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);
+
+Audio::RewindableAudioStream *makeRawZorkStream(const Common::String &filePath, ZVision *engine);
+
+} // End of namespace ZVision
+
+#endif