Added support for sound archives.

We initialize them in the DraciEngine constructor, but don't play any sounds
yet.  Checked that it works for all existing sound files (required several
work-arounds against unspoken specification).

When copying the interface from barchive.h, I decided to remove some const's
from there, because getFile() wasn't really behaving like const.

Removed some static Common::String instances.

svn-id: r44953

1 files changed, 160 insertions, 0 deletions

diff --git a/engines/draci/sound.cpp b/engines/draci/sound.cpp
new file mode 100644
index 0000000000..bd2f68658b
--- /dev/null
+++ b/engines/draci/sound.cpp
@@ -0,0 +1,160 @@
+/* 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: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/trunk/engines/draci/barchive.cpp $
+ * $Id: barchive.cpp 44493 2009-09-30 16:04:21Z fingolfin $
+ *
+ */
+
+#include "common/debug.h"
+#include "common/file.h"
+#include "common/str.h"
+#include "common/stream.h"
+
+#include "draci/sound.h"
+#include "draci/draci.h"
+
+namespace Draci {
+
+void SoundArchive::openArchive(const Common::String &path) {
+	// Close previously opened archive (if any)
+	closeArchive();
+
+	debugCN(2, kDraciArchiverDebugLevel, "Loading samples %s: ", path.c_str());
+
+	_f = new Common::File();
+	_f->open(path);
+	if (_f->isOpen()) {
+		debugC(2, kDraciArchiverDebugLevel, "Success");
+	} else {
+		debugC(2, kDraciArchiverDebugLevel, "Error");
+		return;
+	}
+
+	// Save path for reading in files later on
+	_path = path;
+
+	// Read archive header
+	debugC(2, kDraciArchiverDebugLevel, "Loading header");
+
+	uint totalLength = _f->readUint32LE();
+	const uint kMaxSamples = 4095;	// The no-sound file is exactly 16K bytes long, so don't fail on short reads
+	uint sampleStarts[kMaxSamples];
+	for (uint i = 0; i < kMaxSamples; ++i) {
+		sampleStarts[i] = _f->readUint32LE();
+	}
+
+	// Fill the sample table
+	for (_sampleCount = 0; _sampleCount < kMaxSamples - 1; ++_sampleCount) {
+		int length = sampleStarts[_sampleCount + 1] - sampleStarts[_sampleCount];
+		if (length <= 0 && sampleStarts[_sampleCount] >= totalLength)	// heuristics to detect the last sample
+			break;
+	}
+	if (_sampleCount > 0) {
+		debugC(2, kDraciArchiverDebugLevel, "Archive info: %d samples, %d total length",
+			_sampleCount, totalLength);
+		_samples = new SoundSample[_sampleCount];
+		for (uint i = 0; i < _sampleCount; ++i) {
+			_samples[i]._offset = sampleStarts[i];
+			_samples[i]._length = sampleStarts[i+1] - sampleStarts[i];
+			_samples[i]._data = NULL;
+		}
+		if (_samples[_sampleCount-1]._offset + _samples[_sampleCount-1]._length != totalLength &&
+		    _samples[_sampleCount-1]._offset + _samples[_sampleCount-1]._length - _samples[0]._offset != totalLength) {
+			// WORKAROUND: the stored length is stored with the header for sounds and without the hader for dubbing.  Crazy.
+			debugC(2, kDraciArchiverDebugLevel, "Broken sound archive: %d != %d",
+				_samples[_sampleCount-1]._offset + _samples[_sampleCount-1]._length,
+				totalLength);
+			closeArchive();
+			return;
+		}
+	} else {
+		debugC(2, kDraciArchiverDebugLevel, "Archive info: empty");
+	}
+
+	// Indicate that the archive has been successfully opened
+	_opened = true;
+}
+
+/**
+ * @brief SoundArchive close method
+ *
+ * Closes the currently opened archive. It can be called explicitly to
+ * free up memory.
+ */
+void SoundArchive::closeArchive() {
+	clearCache();
+	delete _f;
+	_f = NULL;
+	delete[] _samples;
+	_samples = NULL;
+	_sampleCount = 0;
+	_path = "";
+	_opened = false;
+}
+
+/**
+ * Clears the cache of the open files inside the archive without closing it.
+ * If the files are subsequently accessed, they are read from the disk.
+ */
+void SoundArchive::clearCache() {
+	// Delete all cached data
+	for (uint i = 0; i < _sampleCount; ++i) {
+		_samples[i].close();
+	}
+}
+
+/**
+ * @brief On-demand sound sample loader
+ * @param i Index of file inside an archive
+ * @return Pointer to a SoundSample coresponding to the opened file or NULL (on failure)
+ *
+ * Loads individual samples from an archive to memory on demand.
+ */
+const SoundSample *SoundArchive::getSample(uint i) {
+	// Check whether requested file exists
+	if (i >= _sampleCount) {
+		return NULL;
+	}
+
+	debugCN(2, kDraciArchiverDebugLevel, "Accessing sample %d from archive %s... ",
+		i, _path.c_str());
+
+	// Check if file has already been opened and return that
+	if (_samples[i]._data) {
+		debugC(2, kDraciArchiverDebugLevel, "Success");
+		return _samples + i;
+	}
+
+	// Read in the file (without the file header)
+	_f->seek(_samples[i]._offset);
+	_samples[i]._data = new byte[_samples[i]._length];
+	_f->read(_samples[i]._data, _samples[i]._length);
+
+	debugC(3, kDraciArchiverDebugLevel, "Cached sample %d from archive %s",
+		i, _path.c_str());
+
+	return _samples + i;
+}
+
+} // End of namespace Draci
+
+
+