Merge pull request #2824 from stenzek/raintegration

Cheevos: Add RAIntergration support

src/core/cheevos.h

@@ -4,6 +4,8 @@
 #include <functional>
 #include <optional>
 #include <string>
+#include <utility>
+#include <vector>
 
 class CDImage;
 class StateWrapper;
@@ -51,6 +53,25 @@ extern bool g_active;
 extern bool g_challenge_mode;
 extern u32 g_game_id;
 
+// RAIntegration only exists for Windows, so no point checking it on other platforms.
+#ifdef WITH_RAINTEGRATION
+
+extern bool g_using_raintegration;
+
+static ALWAYS_INLINE bool IsUsingRAIntegration()
+{
+  return g_using_raintegration;
+}
+
+#else
+
+static ALWAYS_INLINE bool IsUsingRAIntegration()
+{
+  return false;
+}
+
+#endif
+
 ALWAYS_INLINE bool IsActive()
 {
   return g_active;
@@ -123,4 +144,15 @@ TinyString GetAchievementProgressText(const Achievement& achievement);
 void UnlockAchievement(u32 achievement_id, bool add_notification = true);
 void SubmitLeaderboard(u32 leaderboard_id, int value);
 
+#ifdef WITH_RAINTEGRATION
+void SwitchToRAIntegration();
+
+namespace RAIntegration {
+void MainWindowChanged(void* new_handle);
+void GameChanged();
+std::vector<std::pair<int, const char*>> GetMenuItems();
+void ActivateMenuItem(int item);
+} // namespace RAIntegration
+#endif
+
 } // namespace Cheevos

src/core/core.props

@@ -5,10 +5,12 @@
   <ItemDefinitionGroup>
     <ClCompile>
       <PreprocessorDefinitions>WITH_CHEEVOS=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
-      <PreprocessorDefinitions Condition="'$(Platform)'=='x64' Or '$(Platform)'=='ARM' Or '$(Platform)'=='ARM64'">WITH_RECOMPILER=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions Condition="('$(BuildingForUWP)'!='true' And '$(Platform)'!='ARM64')">WITH_RAINTEGRATION=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions Condition="('$(Platform)'=='x64' Or '$(Platform)'=='ARM' Or '$(Platform)'=='ARM64')">WITH_RECOMPILER=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <PreprocessorDefinitions Condition="('$(Platform)'=='x64' Or '$(Platform)'=='ARM64') And ('$(BuildingForUWP)'!='true')">WITH_MMAP_FASTMEM=1;%(PreprocessorDefinitions)</PreprocessorDefinitions>
 
       <AdditionalIncludeDirectories>$(SolutionDir)dep\glad\include;$(SolutionDir)dep\stb\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\xxhash\include;$(SolutionDir)dep\zlib\include;$(SolutionDir)dep\vulkan-loader\include;$(SolutionDir)dep\rcheevos\include;$(SolutionDir)dep\rapidjson\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories Condition="('$(BuildingForUWP)'!='true' And '$(Platform)'!='ARM64')">$(SolutionDir)dep\rainterface;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       
       <AdditionalIncludeDirectories Condition="'$(Platform)'=='x64'">$(SolutionDir)dep\xbyak\xbyak;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <AdditionalIncludeDirectories Condition="'$(Platform)'=='ARM' Or '$(Platform)'=='ARM64'">$(SolutionDir)dep\vixl\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
@@ -18,6 +20,7 @@
   <ItemDefinitionGroup>
     <Lib>
       <AdditionalDependencies>$(RootBuildDir)rcheevos\rcheevos.lib;$(RootBuildDir)imgui\imgui.lib;$(RootBuildDir)stb\stb.lib;$(RootBuildDir)vulkan-loader\vulkan-loader.lib;$(RootBuildDir)xxhash\xxhash.lib;$(RootBuildDir)zlib\zlib.lib;$(RootBuildDir)common\common.lib;%(AdditionalDependencies)</AdditionalDependencies>
+      <AdditionalDependencies Condition="('$(BuildingForUWP)'!='true' And '$(Platform)'!='ARM64')">$(RootBuildDir)rainterface\rainterface.lib;%(AdditionalDependencies)</AdditionalDependencies>
       <AdditionalDependencies Condition="'$(Platform)'=='ARM64'">$(RootBuildDir)vixl\vixl.lib;%(AdditionalDependencies)</AdditionalDependencies>
     </Lib>
   </ItemDefinitionGroup>

src/duckstation-qt/mainwindow.cpp

@@ -20,6 +20,11 @@
 #include "scmversion/scmversion.h"
 #include "settingsdialog.h"
 #include "settingwidgetbinder.h"
+
+#ifdef WITH_CHEEVOS
+#include "core/cheevos.h"
+#endif
+
 #include <QtCore/QDebug>
 #include <QtCore/QFile>
 #include <QtCore/QFileInfo>
@@ -101,6 +106,11 @@ void MainWindow::initializeAndShow()
   switchToGameListView();
 
   show();
+
+#ifdef WITH_RAINTEGRATION
+  if (Cheevos::IsUsingRAIntegration())
+    Cheevos::RAIntegration::MainWindowChanged((void*)winId());
+#endif
 }
 
 void MainWindow::reportError(const QString& message)
@@ -991,6 +1001,33 @@ void MainWindow::setupAdditionalUi()
     connect(action, &QAction::triggered,
             [scale]() { QtHostInterface::GetInstance()->requestRenderWindowScale(scale); });
   }
+
+#ifdef WITH_RAINTEGRATION
+  if (Cheevos::IsUsingRAIntegration())
+  {
+    QMenu* raMenu = new QMenu(QStringLiteral("RAIntegration"), m_ui.menuDebug);
+    connect(raMenu, &QMenu::aboutToShow, this, [this, raMenu]() {
+      raMenu->clear();
+
+      const auto items = Cheevos::RAIntegration::GetMenuItems();
+      for (const auto& [id, title] : items)
+      {
+        if (id == 0)
+        {
+          raMenu->addSeparator();
+          continue;
+        }
+
+        QAction* raAction = raMenu->addAction(QString::fromUtf8(title));
+        connect(raAction, &QAction::triggered, this, [id]() {
+          QtHostInterface::GetInstance()->executeOnEmulationThread(
+            [id]() { Cheevos::RAIntegration::ActivateMenuItem(id); });
+        });
+      }
+    });
+    m_ui.menuDebug->insertMenu(m_ui.menuCPUExecutionMode->menuAction(), raMenu);
+  }
+#endif
 }
 
 void MainWindow::updateEmulationActions(bool starting, bool running, bool cheevos_challenge_mode)

src/duckstation-qt/settingsdialog.cpp

@@ -18,6 +18,7 @@
 
 #ifdef WITH_CHEEVOS
 #include "achievementsettingswidget.h"
+#include "core/cheevos.h"
 #endif
 
 static constexpr char DEFAULT_SETTING_HELP_TEXT[] = "";
@@ -45,7 +46,8 @@ SettingsDialog::SettingsDialog(QtHostInterface* host_interface, QWidget* parent
   m_advanced_settings = new AdvancedSettingsWidget(host_interface, m_ui.settingsContainer, this);
 
 #ifdef WITH_CHEEVOS
-  m_achievement_settings = new AchievementSettingsWidget(host_interface, m_ui.settingsContainer, this);
+  if (!Cheevos::IsUsingRAIntegration())
+    m_achievement_settings = new AchievementSettingsWidget(host_interface, m_ui.settingsContainer, this);
 #endif
 
   m_ui.settingsContainer->insertWidget(static_cast<int>(Category::GeneralSettings), m_general_settings);
@@ -62,7 +64,18 @@ SettingsDialog::SettingsDialog(QtHostInterface* host_interface, QWidget* parent
   m_ui.settingsContainer->insertWidget(static_cast<int>(Category::AudioSettings), m_audio_settings);
 
 #ifdef WITH_CHEEVOS
-  m_ui.settingsContainer->insertWidget(static_cast<int>(Category::AchievementSettings), m_achievement_settings);
+  if (Cheevos::IsUsingRAIntegration())
+  {
+    QLabel* placeholder_label =
+      new QLabel(QStringLiteral("RAIntegration is being used, built-in RetroAchievements support is disabled."),
+                 m_ui.settingsContainer);
+    placeholder_label->setAlignment(Qt::AlignLeft | Qt::AlignTop);
+    m_ui.settingsContainer->insertWidget(static_cast<int>(Category::AchievementSettings), placeholder_label);
+  }
+  else
+  {
+    m_ui.settingsContainer->insertWidget(static_cast<int>(Category::AchievementSettings), m_achievement_settings);
+  }
 #else
   QLabel* placeholder_label =
     new QLabel(tr("This DuckStation build was not compiled with RetroAchievements support."), m_ui.settingsContainer);

src/frontend-common/common_host_interface.cpp

@@ -113,6 +113,11 @@ bool CommonHostInterface::Initialize()
   CreateImGuiContext();
 
 #ifdef WITH_CHEEVOS
+#ifdef WITH_RAINTEGRATION
+  if (GetBoolSettingValue("Cheevos", "UseRAIntegration", false))
+    Cheevos::SwitchToRAIntegration();
+#endif
+
   UpdateCheevosActive();
 #endif
 
@@ -3287,6 +3292,10 @@ void CommonHostInterface::SetDefaultSettings(SettingsInterface& si)
   si.SetBoolValue("Cheevos", "UseFirstDiscFromPlaylist", true);
   si.DeleteValue("Cheevos", "Username");
   si.DeleteValue("Cheevos", "Token");
+
+#ifdef WITH_RAINTEGRATION
+  si.SetBoolValue("Cheevos", "UseRAIntegration", false);
+#endif
 #endif
 }
 
@@ -4377,6 +4386,11 @@ void CommonHostInterface::UpdateCheevosActive()
   const bool cheevos_rich_presence = GetBoolSettingValue("Cheevos", "RichPresence", true);
   const bool cheevos_hardcore = GetBoolSettingValue("Cheevos", "ChallengeMode", false);
 
+#ifdef WITH_RAINTEGRATION
+  if (Cheevos::IsUsingRAIntegration())
+    return;
+#endif
+
   if (cheevos_enabled != Cheevos::IsActive() || cheevos_test_mode != Cheevos::IsTestModeActive() ||
       cheevos_unofficial_test_mode != Cheevos::IsUnofficialTestModeActive() ||
       cheevos_use_first_disc_from_playlist != Cheevos::IsUsingFirstDiscFromPlaylist() ||

src/frontend-common/fullscreen_ui.cpp

@@ -2328,6 +2328,17 @@ void DrawSettingsWindow()
 
       case SettingsPage::AchievementsSetings:
       {
+#ifdef WITH_RAINTEGRATION
+        if (Cheevos::IsUsingRAIntegration())
+        {
+          BeginMenuButtons();
+          ActiveButton(ICON_FA_BAN "  RAIntegration is being used instead of the built-in cheevos implementation.",
+                       false, false, ImGuiFullscreen::LAYOUT_MENU_BUTTON_HEIGHT_NO_SUMMARY);
+          EndMenuButtons();
+          break;
+        }
+#endif
+
 #ifdef WITH_CHEEVOS
         BeginMenuButtons();