scummvm/engines/kyra/detection.cpp
Florian Kagerer 7b30081be2 - improved hof music support for fm-towns (driver for *.twn tracks) (still needs quite some work)
- some PC-98 music support since it uses a very similar driver, but this can't be considered working yet)
- Kyra 1 PC-98 music doen't work at all since I haven't figured out yet how to turn track numbers into the corresponding music file names (might require a hard coded track map)

svn-id: r32807
2008-06-26 19:42:59 +00:00

728 lines
16 KiB
C++

/* 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 "kyra/kyra_v1.h"
#include "kyra/kyra_lok.h"
#include "kyra/kyra_hof.h"
#include "kyra/kyra_mr.h"
#include "common/config-manager.h"
#include "common/advancedDetector.h"
#include "common/savefile.h"
#include "base/plugins.h"
struct KYRAGameDescription {
Common::ADGameDescription desc;
Kyra::GameFlags flags;
};
namespace {
#define FLAGS(x, y, z, a, b, c, id) { Common::UNK_LANG, Common::kPlatformUnknown, x, y, z, a, b, c, id }
#define KYRA1_FLOPPY_FLAGS FLAGS(false, false, false, false, false, false, Kyra::GI_KYRA1)
#define KYRA1_FLOPPY_CMP_FLAGS FLAGS(false, false, false, false, false, true, Kyra::GI_KYRA1)
#define KYRA1_AMIGA_FLAGS FLAGS(false, false, false, false, false, false, Kyra::GI_KYRA1)
#define KYRA1_TOWNS_FLAGS FLAGS(false, true, false, false, false, false, Kyra::GI_KYRA1)
#define KYRA1_TOWNS_SJIS_FLAGS FLAGS(false, true, false, true, false, false, Kyra::GI_KYRA1)
#define KYRA1_CD_FLAGS FLAGS(false, true, true, false, false, false, Kyra::GI_KYRA1)
#define KYRA1_DEMO_FLAGS FLAGS(true, false, false, false, false, false, Kyra::GI_KYRA1)
#define KYRA2_FLOPPY_FLAGS FLAGS(false, false, false, false, false, false, Kyra::GI_KYRA2)
#define KYRA2_FLOPPY_CMP_FLAGS FLAGS(false, false, false, false, false, true, Kyra::GI_KYRA2)
#define KYRA2_CD_FLAGS FLAGS(false, false, true, false, false, false, Kyra::GI_KYRA2)
#define KYRA2_CD_DEMO_FLAGS FLAGS(true, false, true, false, false, false, Kyra::GI_KYRA2)
#define KYRA2_DEMO_FLAGS FLAGS(true, false, false, false, false, false, Kyra::GI_KYRA2)
#define KYRA2_TOWNS_FLAGS FLAGS(false, false, false, false, false, false, Kyra::GI_KYRA2)
#define KYRA2_TOWNS_SJIS_FLAGS FLAGS(false, false, false, true, false, false, Kyra::GI_KYRA2)
#define KYRA3_CD_FLAGS FLAGS(false, false, true, false, true, true, Kyra::GI_KYRA3)
#define KYRA3_CD_INS_FLAGS FLAGS(false, false, true, false, true, true, Kyra::GI_KYRA3)
const KYRAGameDescription adGameDescs[] = {
{
{
"kyra1",
0,
AD_ENTRY1("DISK1.EXE", "c8641d0414d6c966d0a3dad79db07bf4"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_CMP_FLAGS
},
{
{
"kyra1",
0,
AD_ENTRY1("DISK1.EXE", "5d5cee4c3d0b68d586788b74243d254a"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_CMP_FLAGS
},
{
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "3c244298395520bb62b5edfe41688879"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "796e44863dd22fa635b042df1bf16673"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "abf8eb360e79a6c2a837751fbd4d3d24"),
Common::FR_FRA,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "6018e1dfeaca7fe83f8d0b00eb0dd049"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{ // from Arne.F
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "f0b276781f47c130f423ec9679fe9ed9"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{ // from VooD
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "8909b41596913b3f5deaf3c9f1017b01"),
Common::ES_ESP,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{ // floppy 1.8 from clemmy
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "747861d2a9c643c59fdab570df5b9093"),
Common::ES_ESP,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{ // from gourry
{
"kyra1",
"Extracted",
AD_ENTRY1("GEMCUT.EMC", "ef08c8c237ee1473fd52578303fc36df"),
Common::IT_ITA,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{
{
"kyra1",
0,
AD_ENTRY1("GEMCUT.PAK", "2bd1da653eaefd691e050e4a9eb68a64"),
Common::EN_ANY,
Common::kPlatformAmiga,
Common::ADGF_NO_FLAGS
},
KYRA1_AMIGA_FLAGS
},
{
{
"kyra1",
0,
{
{ "GEMCUT.EMC", 0, "796e44863dd22fa635b042df1bf16673", -1 },
{ "BEAD.CPS", 0, "3038466f65b7751451844707187aa401", -1 },
{ NULL, 0, NULL, 0 }
},
Common::EN_ANY,
Common::kPlatformMacintosh,
Common::ADGF_NO_FLAGS
},
KYRA1_FLOPPY_FLAGS
},
{ // FM-Towns version
{
"kyra1",
0,
{
{ "EMC.PAK", 0, "a046bb0b422061aab8e4c4689400343a", -1 },
{ "TWMUSIC.PAK", 0, "e53bca3a3e3fb49107d59463ec387a59", -1 },
{ NULL, 0, NULL, 0 }
},
Common::EN_ANY,
Common::kPlatformFMTowns,
Common::ADGF_NO_FLAGS
},
KYRA1_TOWNS_FLAGS
},
{
{
"kyra1",
0,
{
{ "JMC.PAK", 0, "9c5707a2a478e8167e44283246612d2c", -1 },
{ "TWMUSIC.PAK", 0, "e53bca3a3e3fb49107d59463ec387a59", -1 },
{ NULL, 0, NULL, 0 }
},
Common::JA_JPN,
Common::kPlatformFMTowns,
Common::ADGF_NO_FLAGS
},
KYRA1_TOWNS_SJIS_FLAGS
},
{ // PC-9821 version
{
"kyra1",
0,
{
{ "EMC.PAK", 0, "a046bb0b422061aab8e4c4689400343a", -1 },
{ "MUSIC98.PAK", 0, "02fc212f799331b769b274e33d87b37f", -1 },
{ NULL, 0, NULL, 0 }
},
Common::EN_ANY,
Common::kPlatformPC98,
Common::ADGF_NO_FLAGS
},
KYRA1_TOWNS_FLAGS
},
{
{
"kyra1",
0,
{
{ "JMC.PAK", 0, "9c5707a2a478e8167e44283246612d2c", -1 },
{ "MUSIC98.PAK", 0, "02fc212f799331b769b274e33d87b37f", -1 },
{ NULL, 0, NULL, 0 }
},
Common::JA_JPN,
Common::kPlatformPC98,
Common::ADGF_NO_FLAGS
},
KYRA1_TOWNS_SJIS_FLAGS
},
{
{
"kyra1",
"CD",
AD_ENTRY1("GEMCUT.PAK", "fac399fe62f98671e56a005c5e94e39f"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_CD
},
KYRA1_CD_FLAGS
},
{
{
"kyra1",
"CD",
AD_ENTRY1("GEMCUT.PAK", "230f54e6afc007ab4117159181a1c722"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_CD
},
KYRA1_CD_FLAGS
},
{
{
"kyra1",
"CD",
AD_ENTRY1("GEMCUT.PAK", "b037c41768b652a040360ffa3556fd2a"),
Common::FR_FRA,
Common::kPlatformPC,
Common::ADGF_CD
},
KYRA1_CD_FLAGS
},
{ // italian fan translation see fr#1727941 "KYRA: add Italian CD Version to kyra.dat"
{
"kyra1",
"CD",
AD_ENTRY1("GEMCUT.PAK", "d8327fc4b7a72b23c900fa13aef4093a"),
Common::IT_ITA,
Common::kPlatformPC,
Common::ADGF_CD
},
KYRA1_CD_FLAGS
},
{
{
"kyra1",
"Demo",
AD_ENTRY1("DEMO1.WSA", "fb722947d94897512b13b50cc84fd648"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_DEMO
},
KYRA1_DEMO_FLAGS
},
{ // Floppy version
{
"kyra2",
0,
AD_ENTRY1("WESTWOOD.001", "3f52dda68c4f7696c8309038be9f4151"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA2_FLOPPY_CMP_FLAGS
},
{ // Floppy version
{
"kyra2",
0,
AD_ENTRY1("WESTWOOD.001", "d787b9559afddfe058b84c0b3a787224"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA2_FLOPPY_CMP_FLAGS
},
{ // // Floppy version extracted
{
"kyra2",
"Extracted",
AD_ENTRY1("FATE.PAK", "1ba18be685ad8e5a0ab5d46a0ce4d345"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA2_FLOPPY_FLAGS
},
{ // Floppy version extracted
{
"kyra2",
"Extracted",
AD_ENTRY1("FATE.PAK", "262fb69dd8e52e596c7aefc6456f7c1b"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA2_FLOPPY_FLAGS
},
{ // Floppy version extracted
{
"kyra2",
"Extracted",
AD_ENTRY1("FATE.PAK", "f7de11506b4c8fdf64bc763206c3e4e7"),
Common::FR_FRA,
Common::kPlatformPC,
Common::ADGF_NO_FLAGS
},
KYRA2_FLOPPY_FLAGS
},
{ // CD version
{
"kyra2",
"CD",
AD_ENTRY1("FATE.PAK", "28cbad1c5bf06b2d3825ae57d760d032"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE | Common::ADGF_CD
},
KYRA2_CD_FLAGS
},
{
{
"kyra2",
"CD",
AD_ENTRY1("FATE.PAK", "28cbad1c5bf06b2d3825ae57d760d032"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE | Common::ADGF_CD
},
KYRA2_CD_FLAGS
},
{
{
"kyra2",
"CD",
AD_ENTRY1("FATE.PAK", "28cbad1c5bf06b2d3825ae57d760d032"),
Common::FR_FRA,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE | Common::ADGF_CD
},
KYRA2_CD_FLAGS
},
{ // Interactive Demo
{
"kyra2",
"CD/Demo",
AD_ENTRY1("THANKS.CPS", "b1a78d990b120bb2234b7094f74e30a5"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE | Common::ADGF_CD | Common::ADGF_DEMO
},
KYRA2_CD_DEMO_FLAGS
},
{ // Interactive Demo
{
"kyra2",
"CD/Demo",
AD_ENTRY1("THANKS.CPS", "b1a78d990b120bb2234b7094f74e30a5"),
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE | Common::ADGF_CD | Common::ADGF_DEMO
},
KYRA2_CD_DEMO_FLAGS
},
{ // Interactive Demo
{
"kyra2",
"CD/Demo",
AD_ENTRY1("THANKS.CPS", "b1a78d990b120bb2234b7094f74e30a5"),
Common::FR_FRA,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE | Common::ADGF_CD | Common::ADGF_DEMO
},
KYRA2_CD_DEMO_FLAGS
},
{ // Non-Interactive Demo
{
"kyra2",
"Demo",
AD_ENTRY1("GENERAL.PAK", "35825783e5b60755fd520360079f9c15"),
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_DEMO
},
KYRA2_DEMO_FLAGS
},
{ // FM-Towns
{
"kyra2",
0,
AD_ENTRY1("WSCORE.PAK", "c44de1302b67f27d4707409987b7a685"),
Common::EN_ANY,
Common::kPlatformFMTowns,
Common::ADGF_NO_FLAGS
},
KYRA2_TOWNS_FLAGS
},
{
{
"kyra2",
0,
AD_ENTRY1("WSCORE.PAK", "c44de1302b67f27d4707409987b7a685"),
Common::JA_JPN,
Common::kPlatformFMTowns,
Common::ADGF_NO_FLAGS
},
KYRA2_TOWNS_SJIS_FLAGS
},
{ // PC-9821
{
"kyra2",
0,
AD_ENTRY1("WSCORE.PAK", "c44de1302b67f27d4707409987b7a685"),
Common::EN_ANY,
Common::kPlatformPC98,
Common::ADGF_NO_FLAGS
},
KYRA2_TOWNS_FLAGS
},
{
{
"kyra2",
0,
AD_ENTRY1("WSCORE.PAK", "c44de1302b67f27d4707409987b7a685"),
Common::JA_JPN,
Common::kPlatformPC98,
Common::ADGF_NO_FLAGS
},
KYRA2_TOWNS_SJIS_FLAGS
},
// Kyra3
// non installed version
{
{
"kyra3",
0,
{
{ "ONETIME.PAK", 0, "3833ff312757b8e6147f464cca0a6587", -1 },
{ "WESTWOOD.001", 0, 0, -1 },
{ 0, 0, 0, 0 }
},
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE
},
KYRA3_CD_INS_FLAGS
},
{
{
"kyra3",
0,
{
{ "ONETIME.PAK", 0, "3833ff312757b8e6147f464cca0a6587", -1 },
{ "WESTWOOD.001", 0, 0, -1 },
{ 0, 0, 0, 0 }
},
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE
},
KYRA3_CD_INS_FLAGS
},
{
{
"kyra3",
0,
{
{ "ONETIME.PAK", 0, "3833ff312757b8e6147f464cca0a6587", -1 },
{ "WESTWOOD.001", 0, 0, -1 },
{ 0, 0, 0, 0 }
},
Common::FR_FRA,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE
},
KYRA3_CD_INS_FLAGS
},
// installed version
{
{
"kyra3",
0,
{
{ "ONETIME.PAK", 0, "3833ff312757b8e6147f464cca0a6587", -1 },
{ "AUD.PAK", 0, 0, -1 },
{ 0, 0, 0, 0 }
},
Common::EN_ANY,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE
},
KYRA3_CD_FLAGS
},
{
{
"kyra3",
0,
{
{ "ONETIME.PAK", 0, "3833ff312757b8e6147f464cca0a6587", -1 },
{ "AUD.PAK", 0, 0, -1 },
{ 0, 0, 0, 0 }
},
Common::DE_DEU,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE
},
KYRA3_CD_FLAGS
},
{
{
"kyra3",
0,
{
{ "ONETIME.PAK", 0, "3833ff312757b8e6147f464cca0a6587", -1 },
{ "AUD.PAK", 0, 0, -1 },
{ 0, 0, 0, 0 }
},
Common::FR_FRA,
Common::kPlatformPC,
Common::ADGF_DROPLANGUAGE
},
KYRA3_CD_FLAGS
},
{ AD_TABLE_END_MARKER, FLAGS(0, 0, 0, 0, 0, 0, 0) }
};
const PlainGameDescriptor gameList[] = {
{ "kyra1", "The Legend of Kyrandia" },
{ "kyra2", "The Legend of Kyrandia: The Hand of Fate" },
{ "kyra3", "The Legend of Kyrandia: Malcolm's Revenge" },
{ 0, 0 }
};
const Common::ADParams detectionParams = {
// Pointer to ADGameDescription or its superset structure
(const byte *)adGameDescs,
// Size of that superset structure
sizeof(KYRAGameDescription),
// Number of bytes to compute MD5 sum for
1024 * 1024,
// List of all engine targets
gameList,
// Structure for autoupgrading obsolete targets
0,
// Name of single gameid (optional)
0,
// List of files for file-based fallback detection (optional)
0,
// Flags
0
};
} // End of anonymous namespace
class KyraMetaEngine : public Common::AdvancedMetaEngine {
public:
KyraMetaEngine() : Common::AdvancedMetaEngine(detectionParams) {}
const char *getName() const {
return "Legend of Kyrandia Engine";
}
const char *getCopyright() const {
return "The Legend of Kyrandia (C) Westwood Studios";
}
bool createInstance(OSystem *syst, Engine **engine, const Common::ADGameDescription *desc) const;
SaveStateList listSaves(const char *target) const;
};
bool KyraMetaEngine::createInstance(OSystem *syst, Engine **engine, const Common::ADGameDescription *desc) const {
const KYRAGameDescription *gd = (const KYRAGameDescription *)desc;
bool res = true;
Kyra::GameFlags flags = gd->flags;
flags.lang = gd->desc.language;
flags.platform = gd->desc.platform;
Common::Platform platform = Common::parsePlatform(ConfMan.get("platform"));
if (platform != Common::kPlatformUnknown)
flags.platform = platform;
if (flags.lang == Common::UNK_LANG) {
Common::Language lang = Common::parseLanguage(ConfMan.get("language"));
if (lang != Common::UNK_LANG)
flags.lang = lang;
else
flags.lang = Common::EN_ANY;
}
switch (flags.gameID) {
case Kyra::GI_KYRA1:
*engine = new Kyra::KyraEngine_LoK(syst, flags);
break;
case Kyra::GI_KYRA2:
*engine = new Kyra::KyraEngine_HoF(syst, flags);
break;
case Kyra::GI_KYRA3:
*engine = new Kyra::KyraEngine_MR(syst, flags);
break;
default:
res = false;
warning("Kyra engine: unknown gameID");
}
return res;
}
SaveStateList KyraMetaEngine::listSaves(const char *target) const {
Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
Kyra::KyraEngine_v1::SaveHeader header;
Common::String pattern = target;
pattern += ".???";
Common::StringList filenames;
filenames = saveFileMan->listSavefiles(pattern.c_str());
sort(filenames.begin(), filenames.end()); // Sort (hopefully ensuring we are sorted numerically..)
SaveStateList saveList;
for (Common::StringList::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 (Kyra::KyraEngine_v1::readSaveHeader(in, header) == Kyra::KyraEngine_v1::kRSHENoError)
saveList.push_back(SaveStateDescriptor(slotNum, header.description, *file));
delete in;
}
}
}
return saveList;
}
#if PLUGIN_ENABLED_DYNAMIC(KYRA)
REGISTER_PLUGIN_DYNAMIC(KYRA, PLUGIN_TYPE_ENGINE, KyraMetaEngine);
#else
REGISTER_PLUGIN_STATIC(KYRA, PLUGIN_TYPE_ENGINE, KyraMetaEngine);
#endif