scummvm/engines/adl/detection.cpp

588 lines
18 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#include "common/file.h"
#include "common/md5.h"
#include "common/debug.h"
#include "engines/advancedDetector.h"
#include "adl/detection.h"
#include "adl/disk.h"
#include "adl/disk_image_helpers.h"
#include "adl/adl.h"
namespace Adl {
static const DebugChannelDef debugFlagList[] = {
{Adl::kDebugChannelScript, "Script", "Trace script execution"},
DEBUG_CHANNEL_END
};
#define DEFAULT_OPTIONS GUIO5(GAMEOPTION_NTSC, GAMEOPTION_COLOR_DEFAULT_ON, GAMEOPTION_MONO_TEXT, GAMEOPTION_SCANLINES, GUIO_NOMIDI)
#define MH_OPTIONS GUIO5(GAMEOPTION_NTSC, GAMEOPTION_COLOR_DEFAULT_OFF, GAMEOPTION_MONO_TEXT, GAMEOPTION_SCANLINES, GUIO_NOMIDI)
static const PlainGameDescriptor adlGames[] = {
{ "hires0", "Hi-Res Adventure #0: Mission Asteroid" },
{ "hires1", "Hi-Res Adventure #1: Mystery House" },
{ "hires2", "Hi-Res Adventure #2: Wizard and the Princess" },
{ "hires3", "Hi-Res Adventure #3: Cranston Manor" },
{ "hires4", "Hi-Res Adventure #4: Ulysses and the Golden Fleece" },
{ "hires5", "Hi-Res Adventure #5: Time Zone" },
{ "hires6", "Hi-Res Adventure #6: The Dark Crystal" },
{ nullptr, nullptr }
};
static const AdlGameDescription gameFileDescriptions[] = {
{ // Hi-Res Adventure #1: Mystery House - Apple II - Simi Valley
{
"hires1", "On-Line Systems [A]",
{
{ "ADVENTURE", 0, "22d9e63a11d69fa033ba1738715ad09a", 29952 },
{ "AUTO LOAD OBJ", 0, "a2ab7be25842e1fa9f1343b0894a8b6f", 4095 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_SIMI
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - Coarsegold - Without MIXEDON
{
"hires1", "On-Line Systems [B]",
{
{ "ADVENTURE", 0, "22d9e63a11d69fa033ba1738715ad09a", 29952 },
{ "AUTO LOAD OBJ", 0, "669b5f313ffdfb373ab8dce5961688d3", 12288 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_COARSE
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - French - Without MIXEDON
{
"hires1", "Malibu Microcomputing [A]",
{
{ "ADVENTURE", 0, "6e2245979871b44a9fec46b4b2ba590a", 29952 },
{ "AUTO LOAD OBJ", 0, "3d417e923e70abe9a82e51155974027d", 12288 },
AD_LISTEND
},
Common::FR_FRA,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_VF1
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - French - Modified parser
{
"hires1", "Malibu Microcomputing [B]",
{
{ "ADVENTURE", 0, "f9a1add3609b4bc24b5dc4a9db1fec67", 29952 },
{ "AUTO LOAD OBJ", 0, "2a348058363da4c78a069ee5a2d81a31", 12287 },
AD_LISTEND
},
Common::FR_FRA,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_VF2
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - Coarsegold - With MIXEDON
{
"hires1", "On-Line Systems [C]",
{
{ "ADVENTURE", 0, "22d9e63a11d69fa033ba1738715ad09a", 29952 },
{ "AUTO LOAD OBJ", 0, "f6a6ac60c04c6ba6dff68b92cc279ba2", 12291 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_COARSE
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - Public Domain
{
"hires1", "Public Domain",
{
{ "ADVENTURE", 0, "22d9e63a11d69fa033ba1738715ad09a", 29952 },
{ "AUTO LOAD OBJ", 0, "23bfccfe9fcff9b22cf6c41bde9078ac", 12291 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_PD
},
{ AD_TABLE_END_MARKER, GAME_TYPE_NONE, GAME_VER_NONE }
};
static const AdlGameDescription gameDiskDescriptions[] = {
{ // Hi-Res Adventure #1: Mystery House - Apple II - Simi Valley - DOS 3.2 only
{
"hires1", "On-Line Systems [A]",
AD_ENTRY1s("mysthous", "629b9d034cbf8d8e3a612398f53a8dfc", 116480),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_SIMI
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - Coarsegold - Without MIXEDON
{
"hires1", "On-Line Systems [B]",
AD_ENTRY1s("mysthous", "b22561b5327c7dcdb659e2d649749310", 116480),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_COARSE
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - French - Modified parser
{
"hires1", "Malibu Microcomputing [B]",
AD_ENTRY1s("mysthous", "7bd1918ffc28e551e5b3baf610982bd3", 116480),
Common::FR_FRA,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_VF2
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - Coarsegold - With MIXEDON
{
"hires1", "On-Line Systems [C]",
AD_ENTRY1s("mysthous", "8df0b3b3e609a2e40237e2419c1cb767", 116480),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_COARSE
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - Roberta Williams Anthology
{
"hires1", "Public Domain",
AD_ENTRY1s("mysthous", "54d20eb1ef0084ac3c2d16c31c5b7eb7", 143360),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_PD
},
{ // Hi-Res Adventure #1: Mystery House - Apple II - Public Domain
{
"hires1", "Public Domain",
AD_ENTRY1s("mysthous", "bc0f34d153a530b9bb4e554b0a42f8d7", 143360),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
MH_OPTIONS
},
GAME_TYPE_HIRES1,
GAME_VER_HR1_PD
},
{ // Hi-Res Adventure #2: Wizard and the Princess - Apple II - DOS 3.2 only
{
"hires2", "On-Line Systems [A]",
AD_ENTRY1s("wizard", "5201c87db24ba7e3fa447471f4f2ec99", 116480),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES2,
GAME_VER_NONE
},
{ // Hi-Res Adventure #2: Wizard and the Princess - Apple II
{
"hires2", "On-Line Systems [B]",
AD_ENTRY1s("wizard", "1de984859212ff11cf61b29cb9b55f8c", 116480),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES2,
GAME_VER_NONE
},
{ // Hi-Res Adventure #2: Wizard and the Princess - Apple II - Green Valley Publishing
{
"hires2", "Green Valley [A]",
AD_ENTRY1s("wizard", "73cd373e9a2946c3181b72fdf7a32c77", 143360),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES2,
GAME_VER_NONE
},
{ // Hi-Res Adventure #2: Wizard and the Princess - Apple II - Roberta Williams Anthology
{
"hires2", "Green Valley [B]",
AD_ENTRY1s("wizard", "72b114bf8f94fafe5672daac2a70c765", 143360),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES2,
GAME_VER_NONE
},
{ // Hi-Res Adventure #0: Mission Asteroid - Apple II - Roberta Williams Anthology
{
"hires0", "",
AD_ENTRY1s("mission", "6bc53f51a3c8ee65c020af55fb8bd875", 116480),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES0,
GAME_VER_NONE
},
{ // Hi-Res Adventure #3: Cranston Manor - Apple II
{
"hires3", "",
AD_ENTRY1s("cranston", "e4d35440791a36e55299c7be1ccd2b04", 116480),
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES3,
GAME_VER_NONE
},
{ // Hi-Res Adventure #4: Ulysses and the Golden Fleece - Apple II - Original release
{
"hires4", "On-Line Systems [A]",
{
{ "ulyssesa", 0, "fac225127a35cf2596d41e91647a532c", 143360 },
{ "ulyssesb", 1, "793a01392a094d5e2988deab5510e9fc", 143360 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES4,
GAME_VER_HR4_V1_0
},
{ // Hi-Res Adventure #4: Ulysses and the Golden Fleece - Apple II - Version 1.1
{
"hires4", "On-Line Systems [B]",
{
{ "ulyssesa", 0, "420f515e64612d21446ede8078055f0e", 143360 },
{ "ulyssesb", 1, "9fa8552255ae651b252844168b8b6617", 143360 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES4,
GAME_VER_HR4_V1_1
},
{ // Hi-Res Adventure #4: Ulysses and the Golden Fleece - Apple II - Green Valley Publishing - Version 0.0
{
"hires4", "Green Valley [A]",
{
{ "ulyssesa", 0, "1eaeb2f1a773ce2d1cb9f16b2ef09049", 143360 },
{ "ulyssesb", 1, "9fa8552255ae651b252844168b8b6617", 143360 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES4,
GAME_VER_HR4_LNG
},
{ // Hi-Res Adventure #4: Ulysses and the Golden Fleece - Apple II - Green Valley Publishing - Version 1.1
{
"hires4", "Green Valley [B]",
{
{ "ulyssesa", 0, "35b6dce492c893327796645f481737ca", 143360 },
{ "ulyssesb", 1, "9fa8552255ae651b252844168b8b6617", 143360 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES4,
GAME_VER_HR4_LNG
},
{ // Hi-Res Adventure #4: Ulysses and the Golden Fleece - Atari 8-bit - Re-release
{
"hires4", "",
{
{ "ulys1b", 0, "bb6aab9a35b41d160b6eefa088165f56", 92160 },
{ "ulys1a", 0, "c227eeee34d0bacd62b2d6231c409204", 92160 },
// Load 'N' Go Software release XAG-0646 appears to be missing the second disk
{ "ulys2c", 0, "8c6a76d1767e4ffa2f0118c9c56c0e90", 92160 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformAtari8Bit,
ADGF_UNSTABLE,
GUIO2(GAMEOPTION_COLOR_DEFAULT_ON, GAMEOPTION_SCANLINES)
},
GAME_TYPE_HIRES4,
GAME_VER_NONE
},
{ // Hi-Res Adventure #5: Time Zone - Apple II - Version 1.1 - Roberta Williams Anthology
{
"hires5", "",
{
{ "tzone1a", 2, "731844b1d19c2801e3a5bc61d109af54", 143360 },
{ "tzone1b", 3, "4eaf8d790e3f93097cca9ddbe863df50", 143360 },
{ "tzone2c", 4, "e3aa4f56e727339b1ec00978ce9d435b", 143360 },
{ "tzone2d", 5, "77b8219a380410015c986fa192d4c3bf", 143360 },
{ "tzone3e", 6, "f7acc03edd8d8aecb90711cd5f9e5593", 143360 },
{ "tzone3f", 7, "ed74c056976ecea2eab07448c8a72eb8", 143360 },
{ "tzone4g", 8, "de7bda8a641169fc2dedd8a7b0b7e7de", 143360 },
{ "tzone4h", 9, "21cf76d97505ff09fff5d5e4711bc47c", 143360 },
{ "tzone5i", 10, "d665df374e594cd0978b73c3490e5de2", 143360 },
{ "tzone5j", 11, "5095be23d13201d0897b9169c4e473df", 143360 },
{ "tzone6k", 12, "bef044503f21af5f0a4088e99aa778b1", 143360 },
{ "tzone6l", 13, "84801b7c2ab6c09e62a2a0809b94d16a", 143360 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES5,
GAME_VER_NONE
},
{ // Hi-Res Adventure #6: The Dark Crystal - Apple II - Roberta Williams Anthology / SierraVenture
{
"hires6", "SierraVenture [A]",
{
{ "dark1a", 0, "9a5968a8f378c84454d88f4cd4e143a9", 143360 },
{ "dark1b", 3, "1271ff9c3e1bdb4942301dd37dd0ef87", 143360 },
{ "dark2a", 4, "090e77563add7b4c9ab25f444d727316", 143360 },
{ "dark2b", 5, "f2db96af0955324900b800505af4d91f", 143360 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES6,
GAME_VER_NONE
},
{ // Hi-Res Adventure #6: The Dark Crystal - Apple II - SierraVenture
{
"hires6", "SierraVenture [B]",
{
{ "dark1a", 0, "d0b8e808b02564b6ce58b5ea5cc61ead", 143360 },
{ "dark1b", 3, "1271ff9c3e1bdb4942301dd37dd0ef87", 143360 },
{ "dark2a", 4, "090e77563add7b4c9ab25f444d727316", 143360 },
{ "dark2b", 5, "f2db96af0955324900b800505af4d91f", 143360 },
AD_LISTEND
},
Common::EN_ANY,
Common::kPlatformApple2,
ADGF_NO_FLAGS,
DEFAULT_OPTIONS
},
GAME_TYPE_HIRES6,
GAME_VER_NONE
},
{ AD_TABLE_END_MARKER, GAME_TYPE_NONE, GAME_VER_NONE }
};
class AdlMetaEngineDetection : public AdvancedMetaEngineDetection<AdlGameDescription> {
public:
AdlMetaEngineDetection() : AdvancedMetaEngineDetection(gameFileDescriptions, adlGames) { }
const char *getEngineName() const override {
return "ADL";
}
const char *getName() const override {
return "adl";
}
const char *getOriginalCopyright() const override {
return "Copyright (C) Sierra On-Line";
}
const DebugChannelDef *getDebugChannels() const override {
return debugFlagList;
}
ADDetectedGames detectGame(const Common::FSNode &parent, const FileMap &allFiles, Common::Language language, Common::Platform platform, const Common::String &extra, uint32 skipADFlags, bool skipIncomplete) override;
bool addFileProps(const FileMap &allFiles, const Common::Path &fname, FilePropertiesMap &filePropsMap) const;
};
bool AdlMetaEngineDetection::addFileProps(const FileMap &allFiles, const Common::Path &fname, FilePropertiesMap &filePropsMap) const {
if (filePropsMap.contains(fname))
return true;
if (!allFiles.contains(fname))
return false;
FileProperties fileProps;
fileProps.size = computeMD5(allFiles[fname], fileProps.md5, 16384);
if (fileProps.size != -1) {
debugC(3, kDebugGlobalDetection, "> '%s': '%s'", fname.toString().c_str(), fileProps.md5.c_str());
filePropsMap[fname] = fileProps;
}
return true;
}
// Based on AdvancedMetaEngine::detectGame
ADDetectedGames AdlMetaEngineDetection::detectGame(const Common::FSNode &parent, const FileMap &allFiles, Common::Language language, Common::Platform platform, const Common::String &extra, uint32 skipADFlags, bool skipIncomplete) {
// We run the file-based detector first, if it finds a match we do not search for disk images
ADDetectedGames matched = AdvancedMetaEngineDetection::detectGame(parent, allFiles, language, platform, extra, skipADFlags, skipIncomplete);
if (!matched.empty())
return matched;
debugC(3, kDebugGlobalDetection, "Starting disk image detection in dir '%s'", parent.getPath().toString(Common::Path::kNativeSeparator).c_str());
FilePropertiesMap filesProps;
for (uint g = 0; gameDiskDescriptions[g].desc.gameId != nullptr; ++g) {
ADDetectedGame game(&gameDiskDescriptions[g].desc);
// Skip games that don't meet the language/platform/extra criteria
if (language != Common::UNK_LANG && game.desc->language != Common::UNK_LANG) {
if (game.desc->language != language && !(language == Common::EN_ANY && (game.desc->flags & ADGF_ADDENGLISH)))
continue;
}
if (platform != Common::kPlatformUnknown && game.desc->platform != Common::kPlatformUnknown && game.desc->platform != platform)
continue;
if ((_flags & kADFlagUseExtraAsHint) && !extra.empty() && game.desc->extra != extra)
continue;
bool allFilesPresent = true;
for (uint f = 0; game.desc->filesDescriptions[f].fileName; ++f) {
const ADGameFileDescription &fDesc = game.desc->filesDescriptions[f];
Common::Path fileName;
bool foundDiskImage = false;
for (uint e = 0; e < ARRAYSIZE(diskImageExts); ++e) {
if (diskImageExts[e].platform == game.desc->platform) {
Common::Path testFileName(fDesc.fileName, Common::Path::kNoSeparator);
testFileName.appendInPlace(diskImageExts[e].extension);
if (addFileProps(allFiles, testFileName, filesProps)) {
if (foundDiskImage) {
warning("Ignoring '%s' (already found '%s')", testFileName.toString().c_str(), fileName.toString().c_str());
filesProps.erase(testFileName);
} else {
foundDiskImage = true;
fileName = testFileName;
}
}
}
}
if (!foundDiskImage) {
allFilesPresent = false;
break;
}
game.matchedFiles[fileName] = filesProps[fileName];
if (game.hasUnknownFiles)
continue;
if (fDesc.md5 && fDesc.md5 != filesProps[fileName].md5) {
debugC(3, kDebugGlobalDetection, "MD5 Mismatch. Skipping (%s) (%s)", fDesc.md5, filesProps[fileName].md5.c_str());
game.hasUnknownFiles = true;
continue;
}
if (fDesc.fileSize != AD_NO_SIZE && fDesc.fileSize != filesProps[fileName].size) {
debugC(3, kDebugGlobalDetection, "Size Mismatch. Skipping");
game.hasUnknownFiles = true;
continue;
}
debugC(3, kDebugGlobalDetection, "Matched file: %s", fileName.toString().c_str());
}
// This assumes that the detection table groups together games that have the same gameId and platform
if (allFilesPresent) {
if (!game.hasUnknownFiles) {
debugC(2, kDebugGlobalDetection, "Found game: %s (%s/%s) (%d)", game.desc->gameId, getPlatformDescription(game.desc->platform), getLanguageDescription(game.desc->language), g);
// If we just added an unknown variant for this game and platform, remove it
if (!matched.empty() && strcmp(matched.back().desc->gameId, game.desc->gameId) == 0 && matched.back().desc->platform == game.desc->platform)
matched.pop_back();
matched.push_back(game);
} else {
debugC(5, kDebugGlobalDetection, "Skipping game: %s (%s/%s) (%d)", game.desc->gameId, getPlatformDescription(game.desc->platform), getLanguageDescription(game.desc->language), g);
// If we already added a known or unknown variant for this game and platform, don't add another
if (matched.empty() || strcmp(matched.back().desc->gameId, game.desc->gameId) != 0 || matched.back().desc->platform != game.desc->platform)
matched.push_back(game);
}
}
}
return matched;
}
} // End of namespace Adl
REGISTER_PLUGIN_STATIC(ADL_DETECTION, PLUGIN_TYPE_ENGINE_DETECTION, Adl::AdlMetaEngineDetection);