metaforce/Runtime/Input/ControlMapper.cpp

#include "Runtime/Input/ControlMapper.hpp"

#include <array>

#include "Runtime/GameGlobalObjects.hpp"
#include "Runtime/RetroTypes.hpp"
#include "Runtime/Input/CFinalInput.hpp"

namespace metaforce {
namespace {
constexpr std::array skCommandDescs{
    "Forward",           "Backward",        "Turn Left",
    "Turn Right",        "Strafe Left",     "Strafe Right",
    "Look Left",         "Look Right",      "Look Up",
    "Look Down",         "Jump/Boost",      "Fire/Bomb",
    "Missile/PowerBomb", "Morph",           "Aim Up",
    "Aim Down",          "Cycle Beam Up",   "Cycle Beam Down",
    "Cycle Item",        "Power Beam",      "Ice Beam",
    "Wave Beam",         "Plasma Beam",     "Toggle Holster",
    "Orbit Close",       "Orbit Far",       "Orbit Object",
    "Orbit Select",      "Orbit Confirm",   "Orbit Left",
    "Orbit Right",       "Orbit Up",        "Orbit Down",
    "Look Hold1",        "Look Hold2",      "Look Zoom In",
    "Look Zoom Out",     "Aim Hold",        "Map Circle Up",
    "Map Circle Down",   "Map Circle Left", "Map Circle Right",
    "Map Move Forward",  "Map Move Back",   "Map Move Left",
    "Map Move Right",    "Map Zoom In",     "Map Zoom Out",
    "SpiderBall",        "Chase Camera",    "XRay Visor",
    "Thermo Visor",      "Enviro Visor",    "No Visor",
    "Visor Menu",        "Visor Up",        "Visor Down",
    "UNKNOWN",           "UNKNOWN",         "Use Shield",
    "Scan Item",         "UNKNOWN",         "UNKNOWN",
    "UNKNOWN",           "UNKNOWN",         "Previous Pause Screen",
    "Next Pause Screen", "UNKNOWN",         "None",
};

constexpr std::array skFunctionDescs{
    "None",
    "Left Stick Up",
    "Left Stick Down",
    "Left Stick Left",
    "Left Stick Right",
    "Right Stick Up",
    "Right Stick Down",
    "Right Stick Left",
    "Right Stick Right",
    "Left Trigger",
    "Right Trigger",
    "D-Pad Up   ",
    "D-Pad Down ",
    "D-Pad Left ",
    "D-Pad Right",
    "A Button",
    "B Button",
    "X Button",
    "Y Button",
    "Z Button",
    "Left Trigger Press",
    "Right Trigger Press",
    "Start",
};

using BoolReturnFn = bool (CFinalInput::*)() const;
using FloatReturnFn = float (CFinalInput::*)() const;

constexpr std::array<BoolReturnFn, 24> skPressFuncs{
    nullptr,
    &CFinalInput::PLAUp,
    &CFinalInput::PLADown,
    &CFinalInput::PLALeft,
    &CFinalInput::PLARight,
    &CFinalInput::PRAUp,
    &CFinalInput::PRADown,
    &CFinalInput::PRALeft,
    &CFinalInput::PRARight,
    &CFinalInput::PLTrigger,
    &CFinalInput::PRTrigger,
    &CFinalInput::PDPUp,
    &CFinalInput::PDPDown,
    &CFinalInput::PDPLeft,
    &CFinalInput::PDPRight,
    &CFinalInput::PA,
    &CFinalInput::PB,
    &CFinalInput::PX,
    &CFinalInput::PY,
    &CFinalInput::PZ,
    &CFinalInput::PL,
    &CFinalInput::PR,
    &CFinalInput::PStart,
    nullptr,
};

constexpr std::array<BoolReturnFn, 24> skDigitalFuncs{
    nullptr,
    &CFinalInput::DLAUp,
    &CFinalInput::DLADown,
    &CFinalInput::DLALeft,
    &CFinalInput::DLARight,
    &CFinalInput::DRAUp,
    &CFinalInput::DRADown,
    &CFinalInput::DRALeft,
    &CFinalInput::DRARight,
    &CFinalInput::DLTrigger,
    &CFinalInput::DRTrigger,
    &CFinalInput::DDPUp,
    &CFinalInput::DDPDown,
    &CFinalInput::DDPLeft,
    &CFinalInput::DDPRight,
    &CFinalInput::DA,
    &CFinalInput::DB,
    &CFinalInput::DX,
    &CFinalInput::DY,
    &CFinalInput::DZ,
    &CFinalInput::DL,
    &CFinalInput::DR,
    &CFinalInput::DStart,
    nullptr,
};

constexpr std::array<FloatReturnFn, 24> skAnalogFuncs{
    nullptr,
    &CFinalInput::ALAUp,
    &CFinalInput::ALADown,
    &CFinalInput::ALALeft,
    &CFinalInput::ALARight,
    &CFinalInput::ARAUp,
    &CFinalInput::ARADown,
    &CFinalInput::ARALeft,
    &CFinalInput::ARARight,
    &CFinalInput::ALTrigger,
    &CFinalInput::ARTrigger,
    &CFinalInput::ADPUp,
    &CFinalInput::ADPDown,
    &CFinalInput::ADPLeft,
    &CFinalInput::ADPRight,
    &CFinalInput::AA,
    &CFinalInput::AB,
    &CFinalInput::AX,
    &CFinalInput::AY,
    &CFinalInput::AZ,
    &CFinalInput::AL,
    &CFinalInput::AR,
    &CFinalInput::AStart,
    nullptr,
};

constexpr std::array<ControlMapper::EKBMFunctionList, 70> skKBMMapping{
    ControlMapper::EKBMFunctionList::KeyPress + 'w',                              // Forward,
    ControlMapper::EKBMFunctionList::KeyPress + 's',                              // Backward,
    ControlMapper::EKBMFunctionList::KeyPress + 'a',                              // TurnLeft,
    ControlMapper::EKBMFunctionList::KeyPress + 'd',                              // TurnRight,
    ControlMapper::EKBMFunctionList::KeyPress + 'a',                              // StrafeLeft,
    ControlMapper::EKBMFunctionList::KeyPress + 'd',                              // StrafeRight,
    ControlMapper::EKBMFunctionList::KeyPress + 'a',                              // LookLeft,
    ControlMapper::EKBMFunctionList::KeyPress + 'd',                              // LookRight,
    ControlMapper::EKBMFunctionList::KeyPress + 's',                              // LookUp,
    ControlMapper::EKBMFunctionList::KeyPress + 'w',                              // LookDown,
    ControlMapper::EKBMFunctionList::KeyPress + ' ',                              // JumpOrBoost = 10,
    ControlMapper::EKBMFunctionList::MousePress + EMouseButton::Primary,          // FireOrBomb = 11,
    ControlMapper::EKBMFunctionList::MousePress + EMouseButton::Secondary,        // MissileOrPowerBomb = 12,
    ControlMapper::EKBMFunctionList::KeyPress + 'c',                              // Morph,
    ControlMapper::EKBMFunctionList::None,                                        // AimUp,
    ControlMapper::EKBMFunctionList::None,                                        // AimDown,
    ControlMapper::EKBMFunctionList::None,                                        // CycleBeamUp,
    ControlMapper::EKBMFunctionList::None,                                        // CycleBeamDown,
    ControlMapper::EKBMFunctionList::None,                                        // CycleItem,
    ControlMapper::EKBMFunctionList::KeyPress + '1',                              // PowerBeam,
    ControlMapper::EKBMFunctionList::KeyPress + '3',                              // IceBeam,
    ControlMapper::EKBMFunctionList::KeyPress + '2',                              // WaveBeam,
    ControlMapper::EKBMFunctionList::KeyPress + '4',                              // PlasmaBeam,
    ControlMapper::EKBMFunctionList::None,                                        // ToggleHolster = 23,
    ControlMapper::EKBMFunctionList::None,                                        // OrbitClose,
    ControlMapper::EKBMFunctionList::KeyPress + 'q',                              // OrbitFar,
    ControlMapper::EKBMFunctionList::KeyPress + 'q',                              // OrbitObject,
    ControlMapper::EKBMFunctionList::None,                                        // OrbitSelect,
    ControlMapper::EKBMFunctionList::None,                                        // OrbitConfirm,
    ControlMapper::EKBMFunctionList::KeyPress + 'a',                              // OrbitLeft,
    ControlMapper::EKBMFunctionList::KeyPress + 'd',                              // OrbitRight,
    ControlMapper::EKBMFunctionList::KeyPress + 'w',                              // OrbitUp,
    ControlMapper::EKBMFunctionList::KeyPress + 's',                              // OrbitDown,
    ControlMapper::EKBMFunctionList::KeyPress + 'e',                              // LookHold1,
    ControlMapper::EKBMFunctionList::None,                                        // LookHold2,
    ControlMapper::EKBMFunctionList::None,                                        // LookZoomIn,
    ControlMapper::EKBMFunctionList::None,                                        // LookZoomOut,
    ControlMapper::EKBMFunctionList::None,                                        // AimHold,
    ControlMapper::EKBMFunctionList::KeyPress + 's',                              // MapCircleUp,
    ControlMapper::EKBMFunctionList::KeyPress + 'w',                              // MapCircleDown,
    ControlMapper::EKBMFunctionList::KeyPress + 'a',                              // MapCircleLeft,
    ControlMapper::EKBMFunctionList::KeyPress + 'd',                              // MapCircleRight,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Up,    // MapMoveForward,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Down,  // MapMoveBack,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Left,  // MapMoveLeft,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Right, // MapMoveRight,
    ControlMapper::EKBMFunctionList::KeyPress + 'e',                              // MapZoomIn,
    ControlMapper::EKBMFunctionList::KeyPress + 'q',                              // MapZoomOut,
    ControlMapper::EKBMFunctionList::KeyPress + 'e',                              // SpiderBall,
    ControlMapper::EKBMFunctionList::KeyPress + 'q',                              // ChaseCamera,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Right, // XrayVisor = 50,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Down,  // ThermoVisor = 51,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Left,  // InviroVisor = 52,
    ControlMapper::EKBMFunctionList::SpecialKeyPress + aurora::SpecialKey::Up,    // NoVisor = 53,
    ControlMapper::EKBMFunctionList::None,                                        // VisorMenu,
    ControlMapper::EKBMFunctionList::None,                                        // VisorUp,
    ControlMapper::EKBMFunctionList::None,                                        // VisorDown,
    ControlMapper::EKBMFunctionList::KeyPress + 'e',                              // ShowCrosshairs,
    ControlMapper::EKBMFunctionList::None,                                        // UNKNOWN
    ControlMapper::EKBMFunctionList::None,                                        // UseSheild = 0x3B,
    ControlMapper::EKBMFunctionList::KeyPress + 'q',                              // ScanItem = 0x3C,
    ControlMapper::EKBMFunctionList::None,                                        // UNKNOWN
    ControlMapper::EKBMFunctionList::None,                                        // UNKNOWN
    ControlMapper::EKBMFunctionList::None,                                        // UNKNOWN
    ControlMapper::EKBMFunctionList::None,                                        // UNKNOWN
    ControlMapper::EKBMFunctionList::KeyPress + 'q',                              // PreviousPauseScreen = 0x41,
    ControlMapper::EKBMFunctionList::KeyPress + 'e',                              // NextPauseScreen = 0x42,
    ControlMapper::EKBMFunctionList::None,                                        // UNKNOWN,
    ControlMapper::EKBMFunctionList::None,                                        // None,
    ControlMapper::EKBMFunctionList::None,
};

std::array<bool, 67> skCommandFilterFlag{true};
} // Anonymous namespace

void ControlMapper::SetCommandFiltered(ECommands cmd, bool filtered) { skCommandFilterFlag[size_t(cmd)] = filtered; }

void ControlMapper::ResetCommandFilters() { skCommandFilterFlag.fill(true); }

bool ControlMapper::GetPressInput(ECommands cmd, const CFinalInput& input) {
  if (!skCommandFilterFlag[size_t(cmd)]) {
    return false;
  }

  bool ret = false;
  const auto func = EFunctionList(g_currentPlayerControl->GetMapping(u32(cmd)));
  if (func < EFunctionList::MAX) {
    if (BoolReturnFn fn = skPressFuncs[size_t(func)]) {
      ret = (input.*fn)();
    }
  }
  if (const auto& kbm = input.GetKBM()) {
    const EKBMFunctionList kbmfunc = skKBMMapping[size_t(cmd)];
    if (kbmfunc < EKBMFunctionList::MAX) {
      if (kbmfunc >= EKBMFunctionList::MousePress) {
        ret |= input.m_PMouseButtons[size_t(kbmfunc) - size_t(EKBMFunctionList::MousePress)];
      } else if (kbmfunc >= EKBMFunctionList::SpecialKeyPress) {
        ret |= input.m_PSpecialKeys[size_t(kbmfunc) - size_t(EKBMFunctionList::SpecialKeyPress)];
      } else if (kbmfunc >= EKBMFunctionList::KeyPress) {
        ret |= input.m_PCharKeys[size_t(kbmfunc) - size_t(EKBMFunctionList::KeyPress)];
      }
    }
  }
  return ret;
}

bool ControlMapper::GetDigitalInput(ECommands cmd, const CFinalInput& input) {
  if (!skCommandFilterFlag[size_t(cmd)]) {
    return false;
  }

  bool ret = false;
  const auto func = EFunctionList(g_currentPlayerControl->GetMapping(u32(cmd)));
  if (func < EFunctionList::MAX) {
    if (BoolReturnFn fn = skDigitalFuncs[size_t(func)])
      ret = (input.*fn)();
  }
  if (const auto& kbm = input.GetKBM()) {
    EKBMFunctionList kbmfunc = skKBMMapping[size_t(cmd)];
    if (kbmfunc < EKBMFunctionList::MAX) {
      if (kbmfunc >= EKBMFunctionList::MousePress) {
        ret |= kbm->m_mouseButtons[size_t(kbmfunc) - size_t(EKBMFunctionList::MousePress)];
      } else if (kbmfunc >= EKBMFunctionList::SpecialKeyPress) {
        ret |= kbm->m_specialKeys[size_t(kbmfunc) - size_t(EKBMFunctionList::SpecialKeyPress)];
      } else if (kbmfunc >= EKBMFunctionList::KeyPress) {
        ret |= kbm->m_charKeys[size_t(kbmfunc) - size_t(EKBMFunctionList::KeyPress)];
      }
    }
  }
  return ret;
}

static float KBToWASDX(const CKeyboardMouseControllerData& data) {
  float retval = 0.0;
  if (data.m_charKeys[size_t('a')]) {
    retval -= 1.0;
  }
  if (data.m_charKeys[size_t('d')]) {
    retval += 1.0;
  }
  if (data.m_charKeys[size_t('w')] ^ data.m_charKeys[size_t('s')]) {
    retval *= 0.555f;
  }
  return retval;
}

static float KBToWASDY(const CKeyboardMouseControllerData& data) {
  float retval = 0.0;
  if (data.m_charKeys[size_t('s')]) {
    retval -= 1.0;
  }
  if (data.m_charKeys[size_t('w')]) {
    retval += 1.0;
  }
  if (data.m_charKeys[size_t('a')] ^ data.m_charKeys[size_t('d')]) {
    retval *= 0.555f;
  }
  return retval;
}

static float KBToArrowsX(const CKeyboardMouseControllerData& data) {
  float retval = 0.0;
  if (data.m_specialKeys[size_t(aurora::SpecialKey::Left)]) {
    retval -= 1.0;
  }
  if (data.m_specialKeys[size_t(aurora::SpecialKey::Right)]) {
    retval += 1.0;
  }
  return retval;
}

static float KBToArrowsY(const CKeyboardMouseControllerData& data) {
  float retval = 0.0;
  if (data.m_specialKeys[size_t(aurora::SpecialKey::Down)]) {
    retval -= 1.0;
  }
  if (data.m_specialKeys[size_t(aurora::SpecialKey::Up)]) {
    retval += 1.0;
  }
  return retval;
}

float ControlMapper::GetAnalogInput(ECommands cmd, const CFinalInput& input) {
  if (!skCommandFilterFlag[size_t(cmd)]) {
    return 0.f;
  }

  float ret = 0.f;
  const auto func = EFunctionList(g_currentPlayerControl->GetMapping(u32(cmd)));
  if (func < EFunctionList::MAX) {
    if (FloatReturnFn fn = skAnalogFuncs[size_t(func)]) {
      ret = (input.*fn)();
    }
  }
#if 0 // TODO: reimplement this
  if (const auto& kbm = input.GetKBM()) {
    switch (cmd) {
    case ECommands::Forward:
    case ECommands::LookDown:
    case ECommands::OrbitUp:
    case ECommands::MapCircleDown:
      ret = std::max(ret, zeus::clamp(-1.f, KBToWASDY(*kbm) * input.m_leftMul, 1.f));
      break;
    case ECommands::Backward:
    case ECommands::LookUp:
    case ECommands::OrbitDown:
    case ECommands::MapCircleUp:
      ret = std::max(ret, zeus::clamp(-1.f, -KBToWASDY(*kbm) * input.m_leftMul, 1.f));
      break;
    case ECommands::TurnLeft:
    case ECommands::StrafeLeft:
    case ECommands::LookLeft:
    case ECommands::OrbitLeft:
    case ECommands::MapCircleLeft:
      ret = std::max(ret, zeus::clamp(-1.f, -KBToWASDX(*kbm) * input.m_leftMul, 1.f));
      break;
    case ECommands::TurnRight:
    case ECommands::StrafeRight:
    case ECommands::LookRight:
    case ECommands::OrbitRight:
    case ECommands::MapCircleRight:
      ret = std::max(ret, zeus::clamp(-1.f, KBToWASDX(*kbm) * input.m_leftMul, 1.f));
      break;
    case ECommands::MapMoveForward:
      ret = std::max(ret, KBToArrowsY(*kbm));
      break;
    case ECommands::MapMoveBack:
      ret = std::max(ret, -KBToArrowsY(*kbm));
      break;
    case ECommands::MapMoveLeft:
      ret = std::max(ret, -KBToArrowsX(*kbm));
      break;
    case ECommands::MapMoveRight:
      ret = std::max(ret, KBToArrowsX(*kbm));
      break;
    default: {
      const EKBMFunctionList kbmfunc = skKBMMapping[size_t(cmd)];
      if (kbmfunc < EKBMFunctionList::MAX) {
        if (kbmfunc >= EKBMFunctionList::MousePress) {
          ret = std::max(ret, kbm->m_mouseButtons[size_t(kbmfunc) - size_t(EKBMFunctionList::MousePress)] ? 1.f : 0.f);
        } else if (kbmfunc >= EKBMFunctionList::SpecialKeyPress) {
          ret = std::max(ret,
                         kbm->m_specialKeys[size_t(kbmfunc) - size_t(EKBMFunctionList::SpecialKeyPress)] ? 1.f : 0.f);
        } else if (kbmfunc >= EKBMFunctionList::KeyPress) {
          ret = std::max(ret, kbm->m_charKeys[size_t(kbmfunc) - size_t(EKBMFunctionList::KeyPress)] ? 1.f : 0.f);
        }
      }
      break;
    }
    }
  }
#endif
  return ret;
}

const char* ControlMapper::GetDescriptionForCommand(ECommands cmd) {
  if (cmd >= ECommands::MAX) {
    return nullptr;
  }
  return skCommandDescs[size_t(cmd)];
}

const char* ControlMapper::GetDescriptionForFunction(EFunctionList func) {
  if (func >= EFunctionList::MAX) {
    return nullptr;
  }
  return skFunctionDescs[size_t(func)];
}

} // namespace metaforce