detection.h

/* 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/>.
 *
 */

#ifndef SCUMM_DETECTION_H
#define SCUMM_DETECTION_H

#include "common/language.h"
#include "common/platform.h"

namespace Scumm {


// GUI-options, primarily used by detection_tables.h
#define GAMEOPTION_TRIM_FMTOWNS_TO_200_PIXELS                GUIO_GAMEOPTIONS1
#define GAMEOPTION_ENHANCEMENTS                              GUIO_GAMEOPTIONS2
#define GAMEOPTION_AUDIO_OVERRIDE                            GUIO_GAMEOPTIONS3
#define GAMEOPTION_ORIGINALGUI                               GUIO_GAMEOPTIONS4
#define GAMEOPTION_LOWLATENCYAUDIO                           GUIO_GAMEOPTIONS5
#define GAMEOPTION_NETWORK                                   GUIO_GAMEOPTIONS6
#define GAMEOPTION_COPY_PROTECTION                           GUIO_GAMEOPTIONS7
#define GAMEOPTION_USE_REMASTERED_AUDIO                      GUIO_GAMEOPTIONS8
#define GAMEOPTION_TTS                                       GUIO_GAMEOPTIONS9
#define GAMEOPTION_REBEL2_HIRES                              GUIO_GAMEOPTIONS10
#define GAMEOPTION_REBEL2_UNLOCK_ALL                         GUIO_GAMEOPTIONS11
#define GAMEOPTION_REBEL1_UNLOCK_ALL                         GUIO_GAMEOPTIONS12
#define GAMEOPTION_REBEL2_NO_DAMAGE                          GUIO_GAMEOPTIONS13

struct GameSettings {
    const char *gameid;

    const char *variant;

    const char *preferredTag;

    byte id;

    byte version;

    byte heversion;

    int midi;

    uint32 features;

    Common::Platform platform;

    const char *guioptions;
};

enum FilenameGenMethod {
    kGenDiskNum,
    kGenDiskNumSteam,
    kGenRoomNum,
    kGenRoomNumSteam,
    kGenHEMac,
    kGenHEMacNoParens,
    kGenHEPC,
    kGenHEIOS,
    kGenUnchanged
};

struct FilenamePattern {
    const char *pattern;
    FilenameGenMethod genMethod;
};

struct GameFilenamePattern {
    const char *gameid;
    const char *pattern;
    FilenameGenMethod genMethod;
    Common::Language language;
    Common::Platform platform;
    const char *variant;
};

struct DetectorResult {
    FilenamePattern fp;
    GameSettings game;
    Common::Language language;
    Common::String md5;
    const char *extra;
};

enum GameFeatures {
    GF_DEMO = 1 << 0,

    GF_NEW_COSTUMES = 1 << 2,

    GF_USE_KEY = 1 << 4,

    GF_SMALL_HEADER = 1 << 5,

    GF_OLD_BUNDLE = 1 << 6,

    GF_16COLOR = 1 << 7,

    GF_OLD256 = 1 << 8,

    GF_AUDIOTRACKS = 1 << 9,

    GF_FEW_LOCALS = 1 << 11,

    GF_HE_LOCALIZED = 1 << 13,

    GF_HE_985 = 1 << 14,

    GF_16BIT_COLOR = 1 << 15,

    GF_MAC_CONTAINER = 1 << 16,

    GF_HE_NO_BIDI = 1 << 17,

    GF_ULTIMATE_TALKIE = 1 << 18,

    GF_HE_995 = 1 << 19,

    GF_DOUBLEFINE_PAK = 1 << 20
};

enum ScummGameId {
    GID_CMI,
    GID_DIG,
    GID_FT,
    GID_REBEL1,
    GID_REBEL2,
    GID_INDY3,
    GID_INDY4,
    GID_LOOM,
    GID_MANIAC,
    GID_MONKEY_EGA,
    GID_MONKEY_VGA,
    GID_MONKEY,
    GID_MONKEY2,
    GID_PASS,
    GID_SAMNMAX,
    GID_TENTACLE,
    GID_ZAK,

    GID_HEGAME,      // Generic name for all HE games with default behavior
    GID_PUTTDEMO,
    GID_FBEAR,
    GID_PUTTMOON,
    GID_FUNPACK,
    GID_PUTTZOO,
    GID_FREDDI,
    GID_FREDDI3,
    GID_FREDDI4,
    GID_BIRTHDAYRED,
    GID_BIRTHDAYYELLOW,
    GID_TREASUREHUNT,
    GID_PUTTRACE,
    GID_FUNSHOP,    // Used for all three funshops
    GID_FOOTBALL,
    GID_FOOTBALL2002,
    GID_SOCCER,
    GID_SOCCERMLS,
    GID_SOCCER2004,
    GID_BASEBALL2001,
    GID_BASEBALL2003,
    GID_BASKETBALL,
    GID_MOONBASE,
    GID_PJGAMES,
    GID_HECUP       // CUP demos
};

struct RuScummPatcher {
    ScummGameId gameid;
    const char *variant;
    const char *patcherName;
};

enum {
    DEBUG_GENERAL = 1,  // General debug
    DEBUG_SCRIPTS,      // Track script execution (start/stop/pause)
    DEBUG_OPCODES,      // Track opcode invocations
    DEBUG_VARS,         // Track variable changes
    DEBUG_RESOURCE,     // Track resource loading / allocation
    DEBUG_IMUSE,        // Track iMUSE events
    DEBUG_SOUND,        // General Sound Debug
    DEBUG_ACTORS,       // General Actor Debug
    DEBUG_INSANE,       // Track INSANE
    DEBUG_SMUSH,        // Track SMUSH
    DEBUG_MOONBASE_AI,  // Moonbase AI
    DEBUG_NETWORK,      // Track Networking
    DEBUG_IMGUI,        // Show ImGui debug window (if available)
};

} // End of namespace Scumm


#endif