scummvm/engines/zvision/zork_raw.cpp

/* 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 "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"

#include "zvision/zork_raw.h"
#include "zvision/zvision.h"
#include "zvision/detection.h"
#include "zvision/utility.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};

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) {
	uint32 bytesRead = 0;

	// 0: Left, 1: Right
	byte 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(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::AudioStream *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;

	if (engine->getGameId() == ZorkNemesis) {
		for (int i = 0; i < 6; i++) {
			if (zNemSoundParamLookupTable[i].identifier == (fileName[6]))
				soundParams = zNemSoundParamLookupTable[i];
		}
	}
	else if (engine->getGameId() == ZorkGrandInquisitor) {
		for (int i = 0; i < 6; i++) {
			if (zgiSoundParamLookupTable[i].identifier == (fileName[7]))
				soundParams = zgiSoundParamLookupTable[i];
		}
	}
	
	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