Initial import of the work in progress M4 engine

svn-id: r31600

1 files changed, 345 insertions, 0 deletions

diff --git a/engines/m4/detection.cpp b/engines/m4/detection.cpp
new file mode 100644
index 0000000000..7aee6167b3
--- /dev/null
+++ b/engines/m4/detection.cpp
@@ -0,0 +1,345 @@
+/* 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$
+ * $Id$
+ *
+ */
+
+#include "base/plugins.h"
+
+#include "common/advancedDetector.h"
+
+#include "m4/m4.h"
+#include "m4/resource.h"
+
+namespace M4 {
+
+struct M4GameDescription {
+	Common::ADGameDescription desc;
+
+	int gameType;
+	uint32 features;
+};
+
+int M4Engine::getGameType() const { return _gameDescription->gameType; }
+uint32 M4Engine::getFeatures() const { return _gameDescription->features; }
+Common::Language M4Engine::getLanguage() const { return _gameDescription->desc.language; }
+Common::Platform M4Engine::getPlatform() const { return _gameDescription->desc.platform; }
+
+}
+
+static const PlainGameDescriptor m4Games[] = {
+	{"m4", "MADS/M4 engine game"},
+	{"riddle", "Riddle of Master Lu: Believe it or Not!"},
+	{"burger", "Orion Burger"},
+	{"rex", "Rex Nebular and the Cosmic Gender Bender"},
+	{"dragon", "DragonSphere"},
+	{"dragoncd", "DragonSphere CD"},
+	{"phantom", "Return of the Phantom"},
+	{"phantomcd", "Return of the Phantom CD"},
+	{0, 0}
+};
+
+namespace M4 {
+
+const char *M4Engine::getGameFile(int fileType) {
+	for (int i = 0; _gameDescription->desc.filesDescriptions[i].fileName; i++) {
+		if (_gameDescription->desc.filesDescriptions[i].fileType == fileType)
+			return _gameDescription->desc.filesDescriptions[i].fileName;
+	}
+	return NULL;
+}
+
+static const M4GameDescription gameDescriptions[] = {
+	{
+		{
+			"burger",
+			"",
+			{
+				{ "burger.has",	kFileTypeHash, "10c8064e9c771072122f50737ac97245", 730771},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Burger,
+		kFeaturesCD
+	},
+	{
+		{
+			"burger",
+			"",
+			{
+				{ "burger.has",	kFileTypeHash, "55be8693a4c36e7efcdca0f0c77758ae", 724191},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::DE_DEU,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Burger,
+		kFeaturesCD
+	},
+	{
+		{
+			"riddle",
+			"",
+			{
+				{ "ripley.has",	kFileTypeHash, "056d517360c89eb4c297a319f21a7071", 700469},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Riddle,
+		kFeaturesCD
+	},
+	{
+		{
+			"riddle",
+			"",
+			{
+				{ "ripley.has",	kFileTypeHash, "d073582c9011d44dd0d7e2ede317a86d", 700469},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Riddle,
+		kFeaturesCD
+	},
+	{
+		{
+			"riddle",
+			"",
+			{
+				{ "ripley.has",	kFileTypeHash, "d9e9f8befec432a047b1047fb2bc7aea", 710997},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::DE_DEU,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Riddle,
+		kFeaturesCD
+	},
+	{
+		{
+			"riddle",
+			"",
+			{
+				{ "ripley.has",	kFileTypeHash, "3d48c5700785d11e6a5bc832b95be918", 701973},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::FR_FRA,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Riddle,
+		kFeaturesCD
+	},
+	{	// Demo
+		{
+			"riddle",
+			"Demo",
+			{
+				{ "ripley.has",	kFileTypeHash, "3a90dd7052860b6e246ec7e0aaf202f6", 104527},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_DEMO
+		},
+		GType_Riddle,
+		kFeaturesDemo
+	},
+	{
+		{
+			"rex",
+			"",
+			{
+				{ "global.hag",	kFileTypeHAG, "0530cbeee109fc79cc24421128dea1ce", 2083078},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_RexNebular,
+		kFeaturesNone
+	},
+	{	// Demo
+		{
+			"rex",
+			"Demo",
+			{
+				{ "global.hag",	kFileTypeHAG, "d5a481d14bc1bda66e46965a39badcc7", 220429},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_DEMO
+		},
+		GType_RexNebular,
+		kFeaturesDemo
+	},
+	{
+		{
+			"dragon",
+			"",
+			{
+				{ "global.hag",	kFileTypeHAG, "c3a6877665e7f21bf3d2b1e667155562", 2320567},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_DragonSphere,
+		kFeaturesNone
+	},
+	{	// CD version
+		{
+			"dragoncd",
+			"",
+			{
+				{ "global.hag",	kFileTypeHAG, "c3a6877665e7f21bf3d2b1e667155562", 2320567},
+				{ "speech.hag",	kFileTypeHAG, NULL, -1},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_DragonSphere,
+		kFeaturesCD
+	},
+	{	// Demo
+		{
+			"dragon",
+			"Demo",
+			{
+				{ "global.hag",	kFileTypeHAG, "541e12d8e9aad0c65d65f150de47582e", 212718},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_DEMO
+		},
+		GType_DragonSphere,
+		kFeaturesDemo
+	},
+	{
+		{
+			"phantom",
+			"",
+			{
+				{ "global.hag",	kFileTypeHAG, "bdce9ca93a015f0883d1bc0fabd0cdfa", 812150},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Phantom,
+		kFeaturesNone
+	},
+	{	// CD version
+		{
+			"phantomcd",
+			"",
+			{
+				{ "global.hag",	kFileTypeHAG, "8a51c984eb4c64e8b30a7e6670f6bddb", 101154000},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_NO_FLAGS
+		},
+		GType_Phantom,
+		kFeaturesCD
+	},
+	{	// CD version
+		{
+			"phantom",
+			"Demo",
+			{
+				{ "global.hag",	kFileTypeHAG, "e810adbc6fac77ac2fec841a9ec5e20e", 115266},
+				{ NULL, 0, NULL, 0}
+			},
+			Common::EN_ANY,
+			Common::kPlatformPC,
+			Common::ADGF_DEMO
+		},
+		GType_Phantom,
+		kFeaturesDemo
+	},
+	{ { NULL, NULL, { { NULL, 0, NULL, 0 } }, Common::UNK_LANG, Common::kPlatformUnknown, Common::ADGF_NO_FLAGS }, 0, 0 }
+};
+
+}
+
+static const Common::ADParams detectionParams = {
+	// Pointer to ADGameDescription or its superset structure
+	(const byte *)M4::gameDescriptions,
+	// Size of that superset structure
+	sizeof(M4::M4GameDescription),
+	// Number of bytes to compute MD5 sum for
+	5000,
+	// List of all engine targets
+	m4Games,
+	// Structure for autoupgrading obsolete targets
+	0,
+	// Name of single gameid (optional)
+	"m4",
+	// List of files for file-based fallback detection (optional)
+	0,
+	// Flags
+	0
+};
+
+class M4MetaEngine : public Common::AdvancedMetaEngine {
+public:
+	M4MetaEngine() : Common::AdvancedMetaEngine(detectionParams) {}
+
+	virtual const char *getName() const {
+		return "MADS/M4 engine";
+	}
+
+	virtual const char *getCopyright() const {
+		return "Riddle of Master Lu & Orion Burger (C) Sanctuary Woods";
+	}
+
+	virtual bool createInstance(OSystem *syst, Engine **engine, const Common::ADGameDescription *desc) const;
+};
+
+bool M4MetaEngine::createInstance(OSystem *syst, Engine **engine, const Common::ADGameDescription *desc) const {
+	const M4::M4GameDescription *gd = (const M4::M4GameDescription *)desc;
+	if (gd) {
+		*engine = new M4::M4Engine(syst, gd);
+	}
+	return gd != 0;
+}
+
+REGISTER_PLUGIN(M4, PLUGIN_TYPE_ENGINE, M4MetaEngine);