NEVERHOOD: First code with basic detection, nothing else so far

5 files changed, 527 insertions, 0 deletions

diff --git a/engines/engines.mk b/engines/engines.mk
index dc09fbd54e..fb754ef104 100644
--- a/engines/engines.mk
+++ b/engines/engines.mk
@@ -116,6 +116,11 @@ DEFINES += -DENABLE_RIVEN
 endif
 endif
 
+ifdef ENABLE_NEVERHOOD
+DEFINES += -DENABLE_NEVERHOOD=$(ENABLE_NEVERHOOD)
+MODULES += engines/neverhood
+endif
+
 ifdef ENABLE_PARALLACTION
 DEFINES += -DENABLE_PARALLACTION=$(ENABLE_PARALLACTION)
 MODULES += engines/parallaction
diff --git a/engines/neverhood/detection.cpp b/engines/neverhood/detection.cpp
new file mode 100644
index 0000000000..b80379bc2d
--- /dev/null
+++ b/engines/neverhood/detection.cpp
@@ -0,0 +1,285 @@
+/* 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 "base/plugins.h"
+
+#include "engines/advancedDetector.h"
+#include "common/file.h"
+
+#include "neverhood/neverhood.h"
+
+
+namespace Neverhood {
+
+struct NeverhoodGameDescription {
+	ADGameDescription desc;
+
+	int gameID;
+	int gameType;
+	uint32 features;
+	uint16 version;
+};
+
+const char *NeverhoodEngine::getGameId() const {
+	return _gameDescription->desc.gameid;
+}
+
+uint32 NeverhoodEngine::getFeatures() const {
+	return _gameDescription->features;
+}
+
+Common::Platform NeverhoodEngine::getPlatform() const {
+	return _gameDescription->desc.platform;
+}
+
+uint16 NeverhoodEngine::getVersion() const {
+	return _gameDescription->version;
+}
+
+}
+
+static const PlainGameDescriptor neverhoodGames[] = {
+	{"neverhood", "The Neverhood Chronicles"},
+	{0, 0}
+};
+
+namespace Neverhood {
+
+using Common::GUIO_NONE;
+using Common::GUIO_NOSPEECH;
+
+static const NeverhoodGameDescription gameDescriptions[] = {
+
+	{
+		// Neverhood English version
+		// TODO: Maybe additional files are needed to properly detect different versions
+		{
+			"neverhood",
+			0,
+			AD_ENTRY1s("hd.blb", "22958d968458c9ff221aee38577bb2b2", 4279716),
+			Common::EN_ANY,
+			Common::kPlatformWindows,
+			ADGF_NO_FLAGS,
+			GUIO_NONE
+		},
+		0,
+		0,
+		0,
+		0,
+	},
+
+	{ AD_TABLE_END_MARKER, 0, 0, 0, 0 }
+};
+
+/**
+ * The fallback game descriptor used by the Neverhood engine's fallbackDetector.
+ * Contents of this struct are to be overwritten by the fallbackDetector.
+ */
+static NeverhoodGameDescription g_fallbackDesc = {
+	{
+		"",
+		"",
+		AD_ENTRY1(0, 0), // This should always be AD_ENTRY1(0, 0) in the fallback descriptor
+		Common::UNK_LANG,
+		Common::kPlatformPC,
+		ADGF_NO_FLAGS,
+		GUIO_NONE
+	},
+	0,
+	0,
+	0,
+	0,
+};
+
+} // End of namespace Neverhood
+
+class NeverhoodMetaEngine : public AdvancedMetaEngine {
+public:
+	NeverhoodMetaEngine() : AdvancedMetaEngine(Neverhood::gameDescriptions, sizeof(Neverhood::NeverhoodGameDescription), neverhoodGames) {
+		_singleid = "neverhood";
+	}
+
+	virtual const char *getName() const {
+		return "Neverhood Engine";
+	}
+
+	virtual const char *getOriginalCopyright() const {
+		return "Neverhood Engine (C) Infogrames";
+	}
+
+	virtual bool hasFeature(MetaEngineFeature f) const;
+	virtual bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const;
+
+#if 0 // Not used yet but let's keep it for later when it is	
+	SaveStateList listSaves(const char *target) const;
+	virtual int getMaximumSaveSlot() const;
+	void removeSaveState(const char *target, int slot) const;
+	SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const;
+#endif
+
+	const ADGameDescription *fallbackDetect(const Common::FSList &fslist) const;
+
+};
+
+bool NeverhoodMetaEngine::hasFeature(MetaEngineFeature f) const {
+	return
+		false; // Nothing yet :(
+//		(f == kSupportsListSaves) ||
+//		(f == kSupportsLoadingDuringStartup) ||
+//		(f == kSupportsDeleteSave) ||
+//	   	(f == kSavesSupportMetaInfo) ||
+//		(f == kSavesSupportThumbnail);
+}
+
+bool Neverhood::NeverhoodEngine::hasFeature(EngineFeature f) const {
+	return
+		false; // Nothing yet :(
+//		(f == kSupportsRTL) || // TODO: Not yet...
+//		(f == kSupportsLoadingDuringRuntime) ||
+//		(f == kSupportsSavingDuringRuntime);
+}
+
+bool NeverhoodMetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
+	const Neverhood::NeverhoodGameDescription *gd = (const Neverhood::NeverhoodGameDescription *)desc;
+	if (gd) {
+		*engine = new Neverhood::NeverhoodEngine(syst, gd);
+	}
+	return gd != 0;
+}
+
+const ADGameDescription *NeverhoodMetaEngine::fallbackDetect(const Common::FSList &fslist) const {
+	// Set the default values for the fallback descriptor's ADGameDescription part.
+	Neverhood::g_fallbackDesc.desc.language = Common::UNK_LANG;
+	Neverhood::g_fallbackDesc.desc.platform = Common::kPlatformPC;
+	Neverhood::g_fallbackDesc.desc.flags = ADGF_NO_FLAGS;
+
+	// Set default values for the fallback descriptor's NeverhoodGameDescription part.
+	Neverhood::g_fallbackDesc.gameID = 0;
+	Neverhood::g_fallbackDesc.features = 0;
+	Neverhood::g_fallbackDesc.version = 3;
+
+	return NULL;
+}
+
+#if 0 // Not used yet but let's keep it for later when it is	
+
+SaveStateList NeverhoodMetaEngine::listSaves(const char *target) const {
+	Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
+	Neverhood::NeverhoodEngine::SaveHeader header;
+	Common::String pattern = target;
+	pattern += ".???";
+
+	Common::StringArray filenames;
+	filenames = saveFileMan->listSavefiles(pattern.c_str());
+	Common::sort(filenames.begin(), filenames.end());	// Sort (hopefully ensuring we are sorted numerically..)
+
+	SaveStateList saveList;
+	for (Common::StringArray::const_iterator file = filenames.begin(); file != filenames.end(); file++) {
+		// Obtain the last 3 digits of the filename, since they correspond to the save slot
+		int slotNum = atoi(file->c_str() + file->size() - 3);
+
+		if (slotNum >= 0 && slotNum <= 999) {
+			Common::InSaveFile *in = saveFileMan->openForLoading(file->c_str());
+			if (in) {
+				if (Neverhood::NeverhoodEngine::readSaveHeader(in, false, header) == Neverhood::NeverhoodEngine::kRSHENoError) {
+					saveList.push_back(SaveStateDescriptor(slotNum, header.description));
+				}
+				delete in;
+			}
+		}
+	}
+
+	return saveList;
+}
+
+int NeverhoodMetaEngine::getMaximumSaveSlot() const {
+	return 999;
+}
+
+void NeverhoodMetaEngine::removeSaveState(const char *target, int slot) const {
+	// Slot 0 can't be deleted, it's for restarting the game(s)
+	if (slot == 0)
+		return;
+
+	Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
+	Common::String filename = Neverhood::NeverhoodEngine::getSavegameFilename(target, slot);
+
+	saveFileMan->removeSavefile(filename.c_str());
+
+	Common::StringArray filenames;
+	Common::String pattern = target;
+	pattern += ".???";
+	filenames = saveFileMan->listSavefiles(pattern.c_str());
+	Common::sort(filenames.begin(), filenames.end());	// Sort (hopefully ensuring we are sorted numerically..)
+
+	for (Common::StringArray::const_iterator file = filenames.begin(); file != filenames.end(); ++file) {
+		// Obtain the last 3 digits of the filename, since they correspond to the save slot
+		int slotNum = atoi(file->c_str() + file->size() - 3);
+
+		// Rename every slot greater than the deleted slot,
+		// Also do not rename quicksaves.
+		if (slotNum > slot && slotNum < 990) {
+			// FIXME: Our savefile renaming done here is inconsitent with what we do in
+			// GUI_v2::deleteMenu. While here we rename every slot with a greater equal
+			// number of the deleted slot to deleted slot, deleted slot + 1 etc.,
+			// we only rename the following slots in GUI_v2::deleteMenu until a slot
+			// is missing.
+			saveFileMan->renameSavefile(file->c_str(), filename.c_str());
+
+			filename = Neverhood::NeverhoodEngine::getSavegameFilename(target, ++slot);
+		}
+	}
+
+}
+
+SaveStateDescriptor NeverhoodMetaEngine::querySaveMetaInfos(const char *target, int slot) const {
+	Common::String filename = Neverhood::NeverhoodEngine::getSavegameFilename(target, slot);
+	Common::InSaveFile *in = g_system->getSavefileManager()->openForLoading(filename.c_str());
+
+	if (in) {
+		Neverhood::NeverhoodEngine::SaveHeader header;
+		Neverhood::NeverhoodEngine::kReadSaveHeaderError error;
+
+		error = Neverhood::NeverhoodEngine::readSaveHeader(in, true, header);
+		delete in;
+
+		if (error == Neverhood::NeverhoodEngine::kRSHENoError) {
+			SaveStateDescriptor desc(slot, header.description);
+
+			desc.setDeletableFlag(false);
+			desc.setWriteProtectedFlag(false);
+			desc.setThumbnail(header.thumbnail);
+
+			return desc;
+		}
+	}
+
+	return SaveStateDescriptor();
+}
+
+#endif
+
+#if PLUGIN_ENABLED_DYNAMIC(NEVERHOOD)
+	REGISTER_PLUGIN_DYNAMIC(NEVERHOOD, PLUGIN_TYPE_ENGINE, NeverhoodMetaEngine);
+#else
+	REGISTER_PLUGIN_STATIC(NEVERHOOD, PLUGIN_TYPE_ENGINE, NeverhoodMetaEngine);
+#endif
diff --git a/engines/neverhood/module.mk b/engines/neverhood/module.mk
new file mode 100644
index 0000000000..d46d6a67ba
--- /dev/null
+++ b/engines/neverhood/module.mk
@@ -0,0 +1,13 @@
+MODULE := engines/neverhood
+
+MODULE_OBJS = \
+	detection.o \
+	neverhood.o
+
+# This module can be built as a plugin
+ifdef BUILD_PLUGINS
+PLUGIN := 1
+endif
+
+# Include common rules
+include $(srcdir)/rules.mk
diff --git a/engines/neverhood/neverhood.cpp b/engines/neverhood/neverhood.cpp
new file mode 100644
index 0000000000..9c464b9a83
--- /dev/null
+++ b/engines/neverhood/neverhood.cpp
@@ -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.
+ *
+ */
+
+#include "common/algorithm.h"
+#include "common/events.h"
+#include "common/keyboard.h"
+#include "common/file.h"
+#include "common/random.h"
+#include "common/savefile.h"
+#include "common/config-manager.h"
+
+#include "base/plugins.h"
+#include "base/version.h"
+
+#include "graphics/cursorman.h"
+
+#include "engines/util.h"
+
+#include "audio/mididrv.h"
+#include "audio/mixer.h"
+
+#include "neverhood/neverhood.h"
+
+namespace Neverhood {
+
+NeverhoodEngine::NeverhoodEngine(OSystem *syst, const NeverhoodGameDescription *gameDesc) : Engine(syst), _gameDescription(gameDesc) {
+	// Setup mixer
+	if (!_mixer->isReady()) {
+		warning("Sound initialization failed.");
+	}
+
+	_mixer->setVolumeForSoundType(Audio::Mixer::kSFXSoundType, ConfMan.getInt("sfx_volume"));
+	_mixer->setVolumeForSoundType(Audio::Mixer::kMusicSoundType, ConfMan.getInt("music_volume"));
+
+	_rnd = new Common::RandomSource("neverhood");
+
+}
+
+NeverhoodEngine::~NeverhoodEngine() {
+	delete _rnd;
+}
+
+Common::Error NeverhoodEngine::run() {
+	// Initialize backend
+	_system->beginGFXTransaction();
+		initCommonGFX(false);
+	_system->initSize(640, 480);
+	_system->endGFXTransaction();
+
+	_isSaveAllowed = false;
+
+	return Common::kNoError;
+}
+
+void NeverhoodEngine::updateEvents() {
+	Common::Event event;
+	Common::EventManager *eventMan = _system->getEventManager();
+
+	while (eventMan->pollEvent(event)) {
+		switch (event.type) {
+		case Common::EVENT_KEYDOWN:
+			_keyState = event.kbd.keycode;
+			break;
+		case Common::EVENT_KEYUP:
+			_keyState = Common::KEYCODE_INVALID;
+			break;
+		case Common::EVENT_MOUSEMOVE:
+			_mouseX = event.mouse.x;
+			_mouseY = event.mouse.y;
+			break;
+		/*			
+		case Common::EVENT_LBUTTONDOWN:
+			_buttonState |= kLeftButton;
+			break;
+		case Common::EVENT_LBUTTONUP:
+			_buttonState &= ~kLeftButton;
+			break;
+		case Common::EVENT_RBUTTONDOWN:
+			_buttonState |= kRightButton;
+			break;
+		case Common::EVENT_RBUTTONUP:
+			_buttonState &= ~kRightButton;
+			break;
+		case Common::EVENT_QUIT:
+			_system->quit();
+			break;
+		*/			
+		default:
+			break;
+		}
+	}
+}
+
+} // End of namespace Neverhood
diff --git a/engines/neverhood/neverhood.h b/engines/neverhood/neverhood.h
new file mode 100644
index 0000000000..c17116d2dd
--- /dev/null
+++ b/engines/neverhood/neverhood.h
@@ -0,0 +1,111 @@
+/* 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 NEVERHOOD_H
+#define NEVERHOOD_H
+
+#include "common/scummsys.h"
+#include "common/events.h"
+#include "common/keyboard.h"
+#include "common/random.h"
+#include "common/savefile.h"
+#include "common/system.h"
+
+#include "audio/mixer.h"
+
+#include "graphics/surface.h"
+
+#include "engines/engine.h"
+
+namespace Neverhood {
+
+enum NeverhoodGameFeatures {
+};
+
+struct NeverhoodGameDescription;
+
+class NeverhoodEngine : public ::Engine {
+protected:
+
+	Common::Error run();
+
+public:
+	NeverhoodEngine(OSystem *syst, const NeverhoodGameDescription *gameDesc);
+	virtual ~NeverhoodEngine();
+
+	// Detection related functions
+	const NeverhoodGameDescription *_gameDescription;
+	const char *getGameId() const;
+	uint32 getFeatures() const;
+	uint16 getVersion() const;
+	Common::Platform getPlatform() const;
+	bool hasFeature(EngineFeature f) const;
+
+	Common::RandomSource *_rnd;
+
+	int _mouseX, _mouseY;
+	Common::KeyCode _keyState;
+	uint16 _buttonState;
+
+    void updateEvents();
+
+public:
+	
+	/* Save/load */
+
+	enum kReadSaveHeaderError {
+		kRSHENoError = 0,
+		kRSHEInvalidType = 1,
+		kRSHEInvalidVersion = 2,
+		kRSHEIoError = 3
+	};
+
+	struct SaveHeader {
+		Common::String description;
+		uint32 version;
+		byte gameID;
+		uint32 flags;
+		Graphics::Surface *thumbnail;
+	};
+
+	bool _isSaveAllowed;
+
+	bool canLoadGameStateCurrently() { return _isSaveAllowed; }
+	bool canSaveGameStateCurrently() { return _isSaveAllowed; }
+	
+#if 0 // Not used yet but let's keep it for later when it is	
+	Common::Error loadGameState(int slot);
+	Common::Error saveGameState(int slot, const Common::String &description);
+	void savegame(const char *filename, const char *description);
+	void loadgame(const char *filename);
+	const char *getSavegameFilename(int num);
+	static Common::String getSavegameFilename(const Common::String &target, int num);
+	static kReadSaveHeaderError readSaveHeader(Common::SeekableReadStream *in, bool loadThumbnail, SaveHeader &header);
+#endif
+
+public:
+
+};
+
+} // End of namespace Neverhood
+
+#endif /* NEVERHOOD_H */