Unify the way of setting game ID, title ID, revision

The existing code from ConfigManager, ES and MIOS is merged
into a new set of functions called SetRunningGameMetadata.

Source/Core/Core/BootManager.cpp

@@ -415,8 +415,7 @@ void Stop()
 void RestoreConfig()
 {
   SConfig::GetInstance().LoadSettingsFromSysconf();
-  SConfig::GetInstance().m_strGameID = "00000000";
-  SConfig::GetInstance().m_title_id = 0;
+  SConfig::GetInstance().ResetRunningGameMetadata();
   config_cache.RestoreConfig(&SConfig::GetInstance());
 }
 

Source/Core/Core/ConfigManager.cpp

@@ -21,11 +21,16 @@
 #include "Core/Boot/Boot.h"
 #include "Core/Boot/Boot_DOL.h"
 #include "Core/ConfigManager.h"
-#include "Core/Core.h"  // for bWii
+#include "Core/Core.h"
 #include "Core/FifoPlayer/FifoDataFile.h"
+#include "Core/HLE/HLE.h"
 #include "Core/HW/SI/SI.h"
+#include "Core/IOS/ES/Formats.h"
 #include "Core/IOS/USB/Bluetooth/BTBase.h"
+#include "Core/PatchEngine.h"
+#include "Core/PowerPC/PPCSymbolDB.h"
 #include "Core/PowerPC/PowerPC.h"
+#include "VideoCommon/HiresTextures.h"
 
 #include "DiscIO/Enums.h"
 #include "DiscIO/NANDContentLoader.h"
@@ -726,6 +731,67 @@ void SConfig::LoadSettingsFromSysconf()
   bPAL60 = sysconf.GetData<u8>("IPL.E60") != 0;
 }
 
+void SConfig::ResetRunningGameMetadata()
+{
+  SetRunningGameMetadata("00000000", 0, 0);
+}
+
+void SConfig::SetRunningGameMetadata(const DiscIO::IVolume& volume)
+{
+  u64 title_id = 0;
+  volume.GetTitleID(&title_id);
+  SetRunningGameMetadata(volume.GetGameID(), title_id, volume.GetRevision());
+}
+
+void SConfig::SetRunningGameMetadata(const IOS::ES::TMDReader& tmd)
+{
+  const u64 title_id = tmd.GetTitleId();
+  std::string game_id;
+
+  if (IOS::ES::IsDiscTitle(title_id))
+  {
+    const u32 title_identifier = Common::swap32(static_cast<u32>(title_id));
+    const u16 group_id = Common::swap16(tmd.GetGroupId());
+
+    char ascii_game_id[6];
+    std::memcpy(ascii_game_id, &title_identifier, sizeof(title_identifier));
+    std::memcpy(ascii_game_id + sizeof(title_identifier), &group_id, sizeof(group_id));
+
+    game_id = ascii_game_id;
+  }
+  else
+  {
+    game_id = StringFromFormat("%016" PRIX64, title_id);
+  }
+
+  SetRunningGameMetadata(game_id, title_id, tmd.GetTitleVersion());
+}
+
+void SConfig::SetRunningGameMetadata(const std::string& game_id, u64 title_id, u16 revision)
+{
+  const bool was_changed = m_game_id != game_id || m_title_id != title_id || m_revision != revision;
+  m_game_id = game_id;
+  m_title_id = title_id;
+  m_revision = revision;
+
+  if (was_changed)
+  {
+    NOTICE_LOG(BOOT, "Game ID set to %s", game_id.c_str());
+
+    if (Core::IsRunning())
+    {
+      // TODO: have a callback mechanism for title changes?
+      g_symbolDB.Clear();
+      CBoot::LoadMapFromFilename();
+      HLE::Clear();
+      HLE::PatchFunctions();
+      PatchEngine::Shutdown();
+      PatchEngine::LoadPatches();
+      HiresTexture::Update();
+    }
+  }
+}
+
 void SConfig::LoadDefaults()
 {
   bEnableDebugging = false;
@@ -783,9 +849,7 @@ void SConfig::LoadDefaults()
   bJITSystemRegistersOff = false;
   bJITBranchOff = false;
 
-  m_strGameID = "00000000";
-  m_title_id = 0;
-  m_revision = 0;
+  ResetRunningGameMetadata();
 }
 
 bool SConfig::IsUSBDeviceWhitelisted(const std::pair<u16, u16> vid_pid) const
@@ -870,9 +934,7 @@ bool SConfig::AutoSetup(EBootBS2 _BootBS2)
                       m_strFilename.c_str());
         return false;
       }
-      m_strGameID = pVolume->GetGameID();
-      pVolume->GetTitleID(&m_title_id);
-      m_revision = pVolume->GetRevision();
+      SetRunningGameMetadata(*pVolume);
 
       // Check if we have a Wii disc
       bWii = pVolume->GetVolumeType() == DiscIO::Platform::WII_DISC;
@@ -916,11 +978,11 @@ bool SConfig::AutoSetup(EBootBS2 _BootBS2)
     }
     else if (DiscIO::CNANDContentManager::Access().GetNANDLoader(m_strFilename).IsValid())
     {
-      std::unique_ptr<DiscIO::IVolume> pVolume(DiscIO::CreateVolumeFromFilename(m_strFilename));
-      const DiscIO::CNANDContentLoader& ContentLoader =
+      const DiscIO::CNANDContentLoader& content_loader =
           DiscIO::CNANDContentManager::Access().GetNANDLoader(m_strFilename);
+      const IOS::ES::TMDReader& tmd = content_loader.GetTMD();
 
-      if (ContentLoader.GetContentByIndex(ContentLoader.GetTMD().GetBootIndex()) == nullptr)
+      if (content_loader.GetContentByIndex(tmd.GetBootIndex()) == nullptr)
       {
         // WAD is valid yet cannot be booted. Install instead.
         u64 installed = DiscIO::CNANDContentManager::Access().Install_WiiWAD(m_strFilename);
@@ -929,33 +991,11 @@ bool SConfig::AutoSetup(EBootBS2 _BootBS2)
         return false;  // do not boot
       }
 
-      SetRegion(ContentLoader.GetTMD().GetRegion(), &set_region_dir);
+      SetRegion(tmd.GetRegion(), &set_region_dir);
+      SetRunningGameMetadata(tmd);
 
       bWii = true;
       m_BootType = BOOT_WII_NAND;
-
-      if (pVolume)
-      {
-        m_strGameID = pVolume->GetGameID();
-        pVolume->GetTitleID(&m_title_id);
-      }
-      else
-      {
-        // null pVolume means that we are loading from nand folder (Most Likely Wii Menu)
-        // if this is the second boot we would be using the Name and id of the last title
-        m_strGameID.clear();
-        m_title_id = 0;
-      }
-
-      // Use the TitleIDhex for name and/or game ID if launching
-      // from nand folder or if it is not ascii characters
-      // (specifically sysmenu could potentially apply to other things)
-      std::string titleidstr = StringFromFormat("%016" PRIx64, m_title_id);
-
-      if (m_strGameID.empty())
-      {
-        m_strGameID = titleidstr;
-      }
     }
     else
     {

Source/Core/Core/ConfigManager.h

@@ -19,6 +19,14 @@ namespace DiscIO
 {
 enum class Language;
 enum class Region;
+class IVolume;
+}
+namespace IOS
+{
+namespace ES
+{
+class TMDReader;
+}
 }
 
 // DSP Backend Types
@@ -209,17 +217,20 @@ struct SConfig : NonCopyable
   std::string m_strDefaultISO;
   std::string m_strDVDRoot;
   std::string m_strApploader;
-  std::string m_strGameID;
-  u64 m_title_id;
   std::string m_strWiiSDCardPath;
-  u16 m_revision;
 
   std::string m_perfDir;
 
+  const std::string& GetGameID() const { return m_game_id; }
+  u64 GetTitleID() const { return m_title_id; }
+  u16 GetRevision() const { return m_revision; }
+  void ResetRunningGameMetadata();
+  void SetRunningGameMetadata(const DiscIO::IVolume& volume);
+  void SetRunningGameMetadata(const IOS::ES::TMDReader& tmd);
+
   void LoadDefaults();
   static const char* GetDirectoryForRegion(DiscIO::Region region);
   bool AutoSetup(EBootBS2 _BootBS2);
-  const std::string& GetGameID() const { return m_strGameID; }
   void CheckMemcardPath(std::string& memcardPath, const std::string& gameRegion, bool isSlotA);
   DiscIO::Language GetCurrentLanguage(bool wii) const;
 
@@ -373,7 +384,12 @@ private:
   void LoadUSBPassthroughSettings(IniFile& ini);
   void LoadSysconfSettings(IniFile& ini);
 
+  void SetRunningGameMetadata(const std::string& game_id, u64 title_id, u16 revision);
   bool SetRegion(DiscIO::Region region, std::string* directory_name);
 
   static SConfig* m_Instance;
+
+  std::string m_game_id;
+  u64 m_title_id;
+  u16 m_revision;
 };

Source/Core/Core/HW/EXI/EXI_DeviceMemoryCard.cpp

@@ -156,7 +156,7 @@ void CEXIMemoryCard::SetupGciFolder(u16 sizeMb)
 {
   DiscIO::Region region = SConfig::GetInstance().m_region;
 
-  std::string game_id = SConfig::GetInstance().m_strGameID;
+  const std::string& game_id = SConfig::GetInstance().GetGameID();
   u32 CurrentGameId = 0;
   if (game_id.length() >= 4 && game_id != "00000000" && game_id != TITLEID_SYSMENU_STRING)
     CurrentGameId = BE32((u8*)game_id.c_str());

Source/Core/Core/IOS/ES/ES.cpp

@@ -24,17 +24,12 @@
 #include "Common/MsgHandler.h"
 #include "Common/NandPaths.h"
 #include "Common/Swap.h"
-#include "Core/Boot/Boot.h"
 #include "Core/ConfigManager.h"
-#include "Core/HLE/HLE.h"
 #include "Core/HW/Memmap.h"
 #include "Core/IOS/ES/Formats.h"
-#include "Core/PatchEngine.h"
-#include "Core/PowerPC/PPCSymbolDB.h"
 #include "Core/ec_wii.h"
 #include "DiscIO/NANDContentLoader.h"
 #include "DiscIO/Volume.h"
-#include "VideoCommon/HiresTextures.h"
 
 namespace IOS
 {
@@ -48,7 +43,6 @@ struct TitleContext
   void DoState(PointerWrap& p);
   void Update(const DiscIO::CNANDContentLoader& content_loader);
   void Update(const IOS::ES::TMDReader& tmd_, const IOS::ES::TicketReader& ticket_);
-  void UpdateRunningGame() const;
 
   IOS::ES::TicketReader ticket;
   IOS::ES::TMDReader tmd;
@@ -86,12 +80,6 @@ constexpr const u8* s_key_table[11] = {
     s_key_empty,  // Unknown
 };
 
-static bool IsDiscTitle(u64 title_id)
-{
-  return IsTitleType(title_id, IOS::ES::TitleType::Game) ||
-         IsTitleType(title_id, IOS::ES::TitleType::GameWithChannel);
-}
-
 ES::ES(u32 device_id, const std::string& device_name) : Device(device_id, device_name)
 {
 }
@@ -145,43 +133,11 @@ void TitleContext::Update(const IOS::ES::TMDReader& tmd_, const IOS::ES::TicketR
   // Interesting title changes (channel or disc game launch) always happen after an IOS reload.
   if (first_change)
   {
-    UpdateRunningGame();
+    SConfig::GetInstance().SetRunningGameMetadata(tmd);
     first_change = false;
   }
 }
 
-void TitleContext::UpdateRunningGame() const
-{
-  if (IsDiscTitle(tmd.GetTitleId()))
-  {
-    const u32 title_identifier = Common::swap32(static_cast<u32>(tmd.GetTitleId()));
-    const u16 group_id = Common::swap16(tmd.GetGroupId());
-
-    char ascii_game_id[6];
-    std::memcpy(ascii_game_id, &title_identifier, sizeof(title_identifier));
-    std::memcpy(ascii_game_id + sizeof(title_identifier), &group_id, sizeof(group_id));
-
-    SConfig::GetInstance().m_strGameID = ascii_game_id;
-  }
-  else
-  {
-    SConfig::GetInstance().m_strGameID = StringFromFormat("%016" PRIX64, tmd.GetTitleId());
-  }
-
-  SConfig::GetInstance().m_title_id = tmd.GetTitleId();
-
-  // TODO: have a callback mechanism for title changes?
-  g_symbolDB.Clear();
-  CBoot::LoadMapFromFilename();
-  ::HLE::Clear();
-  ::HLE::PatchFunctions();
-  PatchEngine::Shutdown();
-  PatchEngine::LoadPatches();
-  HiresTexture::Update();
-
-  NOTICE_LOG(IOS_ES, "Active title: %016" PRIx64, tmd.GetTitleId());
-}
-
 void ES::LoadWAD(const std::string& _rContentFile)
 {
   s_content_file = _rContentFile;
@@ -1040,7 +996,8 @@ IPCCommandResult ES::GetTitles(const IOCtlVRequest& request)
 static bool ShouldReturnFakeViewsForIOSes(u64 title_id)
 {
   const bool ios = IsTitleType(title_id, IOS::ES::TitleType::System) && title_id != TITLEID_SYSMENU;
-  const bool disc_title = s_title_context.active && IsDiscTitle(s_title_context.tmd.GetTitleId());
+  const bool disc_title =
+      s_title_context.active && IOS::ES::IsDiscTitle(s_title_context.tmd.GetTitleId());
   return ios && SConfig::GetInstance().m_BootType == SConfig::BOOT_ISO && disc_title;
 }
 

Source/Core/Core/IOS/ES/Formats.cpp

@@ -26,6 +26,12 @@ bool IsTitleType(u64 title_id, TitleType title_type)
   return static_cast<u32>(title_id >> 32) == static_cast<u32>(title_type);
 }
 
+bool IsDiscTitle(u64 title_id)
+{
+  return IsTitleType(title_id, TitleType::Game) ||
+         IsTitleType(title_id, TitleType::GameWithChannel);
+}
+
 bool Content::IsShared() const
 {
   return (type & 0x8000) != 0;

Source/Core/Core/IOS/ES/Formats.h

@@ -30,6 +30,7 @@ enum class TitleType : u32
 };
 
 bool IsTitleType(u64 title_id, TitleType title_type);
+bool IsDiscTitle(u64 title_id);
 
 #pragma pack(push, 4)
 struct TMDHeader

Source/Core/Core/IOS/MIOS.cpp

@@ -12,7 +12,6 @@
 #include "Common/MsgHandler.h"
 #include "Common/NandPaths.h"
 #include "Common/Swap.h"
-#include "Core/Boot/Boot.h"
 #include "Core/Boot/ElfReader.h"
 #include "Core/ConfigManager.h"
 #include "Core/Core.h"
@@ -124,17 +123,8 @@ static void ReinitHardware()
 static void UpdateRunningGame()
 {
   DVDThread::WaitUntilIdle();
-  const DiscIO::IVolume& volume = DVDInterface::GetVolume();
   SConfig::GetInstance().m_BootType = SConfig::BOOT_MIOS;
-  SConfig::GetInstance().m_strGameID = volume.GetGameID();
-  SConfig::GetInstance().m_revision = volume.GetRevision();
-
-  g_symbolDB.Clear();
-  CBoot::LoadMapFromFilename();
-  ::HLE::Clear();
-  ::HLE::PatchFunctions();
-
-  NOTICE_LOG(IOS, "Running game: %s", SConfig::GetInstance().m_strGameID.c_str());
+  SConfig::GetInstance().SetRunningGameMetadata(DVDInterface::GetVolume());
 }
 
 constexpr u32 ADDRESS_INIT_SEMAPHORE = 0x30f8;

Source/Core/Core/Movie.cpp

@@ -1477,7 +1477,7 @@ void GetSettings()
   s_bNetPlay = NetPlay::IsNetPlayRunning();
   if (SConfig::GetInstance().bWii)
   {
-    u64 title_id = SConfig::GetInstance().m_title_id;
+    u64 title_id = SConfig::GetInstance().GetTitleID();
     s_bClearSave =
         !File::Exists(Common::GetTitleDataPath(title_id, Common::FROM_SESSION_ROOT) + "banner.bin");
     s_language = SConfig::GetInstance().m_wii_language;

Source/Core/Core/WiiRoot.cpp

@@ -27,9 +27,9 @@ static std::string s_temp_wii_root;
 static void InitializeDeterministicWiiSaves()
 {
   std::string save_path =
-      Common::GetTitleDataPath(SConfig::GetInstance().m_title_id, Common::FROM_SESSION_ROOT);
+      Common::GetTitleDataPath(SConfig::GetInstance().GetTitleID(), Common::FROM_SESSION_ROOT);
   std::string user_save_path =
-      Common::GetTitleDataPath(SConfig::GetInstance().m_title_id, Common::FROM_CONFIGURED_ROOT);
+      Common::GetTitleDataPath(SConfig::GetInstance().GetTitleID(), Common::FROM_CONFIGURED_ROOT);
   if (Movie::IsRecordingInput())
   {
     if (NetPlay::IsNetPlayRunning() && !SConfig::GetInstance().bCopyWiiSaveNetplay)
@@ -93,13 +93,13 @@ void ShutdownWiiRoot()
   if (!s_temp_wii_root.empty())
   {
     std::string save_path =
-        Common::GetTitleDataPath(SConfig::GetInstance().m_title_id, Common::FROM_SESSION_ROOT);
+        Common::GetTitleDataPath(SConfig::GetInstance().GetTitleID(), Common::FROM_SESSION_ROOT);
     std::string user_save_path =
-        Common::GetTitleDataPath(SConfig::GetInstance().m_title_id, Common::FROM_CONFIGURED_ROOT);
+        Common::GetTitleDataPath(SConfig::GetInstance().GetTitleID(), Common::FROM_CONFIGURED_ROOT);
     std::string user_backup_path =
         File::GetUserPath(D_BACKUP_IDX) +
-        StringFromFormat("%08x/%08x/", static_cast<u32>(SConfig::GetInstance().m_title_id >> 32),
-                         static_cast<u32>(SConfig::GetInstance().m_title_id));
+        StringFromFormat("%08x/%08x/", static_cast<u32>(SConfig::GetInstance().GetTitleID() >> 32),
+                         static_cast<u32>(SConfig::GetInstance().GetTitleID()));
     if (File::Exists(save_path + "banner.bin") && SConfig::GetInstance().bEnableMemcardSdWriting)
     {
       // Backup the existing save just in case it's still needed.