Set Game metadata to Player class

xbmc/Application.cpp

@@ -2380,6 +2380,19 @@ void CApplication::OnApplicationMessage(ThreadMessage* pMsg)
   }
   break;
 
+  case TMSG_SET_PLAYER_ITEM:
+  {
+    CFileItem* item = static_cast<CFileItem*>(pMsg->lpVoid);
+    if (item == nullptr)
+      return;
+
+    *m_itemCurrentFile = *item;
+    CServiceBroker::GetGUI()->GetInfoManager().SetCurrentItem(*m_itemCurrentFile);
+
+    delete item;
+  }
+  break;
+
   default:
     CLog::Log(LOGERROR, "%s: Unhandled threadmessage sent, %u", __FUNCTION__, msg);
     break;

xbmc/GUIInfoManager.cpp

@@ -15,6 +15,7 @@
 #include "Util.h"
 #include "cores/DataCacheCore.h"
 #include "filesystem/File.h"
+#include "games/tags/GameInfoTag.h"
 #include "guilib/guiinfo/GUIInfo.h"
 #include "guilib/guiinfo/GUIInfoHelper.h"
 #include "guilib/guiinfo/GUIInfoLabels.h"
@@ -10964,6 +10965,14 @@ const CVideoInfoTag* CGUIInfoManager::GetCurrentMovieTag() const
   return nullptr;
 }
 
+const KODI::GAME::CGameInfoTag* CGUIInfoManager::GetCurrentGameTag() const
+{
+  if (m_currentFile->HasGameInfoTag())
+    return m_currentFile->GetGameInfoTag();
+
+  return nullptr;
+}
+
 int CGUIInfoManager::RegisterSkinVariableString(const CSkinVariableString* info)
 {
   if (!info)

xbmc/GUIInfoManager.h

@@ -28,6 +28,10 @@ typedef std::shared_ptr<CGUIListItem> CGUIListItemPtr;
 
 namespace KODI
 {
+namespace GAME
+{
+  class CGameInfoTag;
+}
 namespace GUILIB
 {
 namespace GUIINFO
@@ -109,6 +113,10 @@ class CGUIInfoManager : public KODI::MESSAGING::IMessageTarget
   bool GetItemInt(int &value, const CGUIListItem *item, int contextWindow, int info) const;
   bool GetItemBool(const CGUIListItem *item, int contextWindow, int condition) const;
 
+  /*! \brief Get currently playing file item
+   */
+  const CFileItem& GetCurrentItem() const { return *m_currentFile; }
+
   /*! \brief Set currently playing file item
    */
   void SetCurrentItem(const CFileItem &item);
@@ -122,6 +130,9 @@ class CGUIInfoManager : public KODI::MESSAGING::IMessageTarget
   // Current video stuff
   const CVideoInfoTag* GetCurrentMovieTag() const;
 
+  // Current game stuff
+  const KODI::GAME::CGameInfoTag* GetCurrentGameTag() const;
+
   void UpdateAVInfo();
 
   int RegisterSkinVariableString(const INFO::CSkinVariableString* info);

xbmc/cores/RetroPlayer/RetroPlayer.cpp

@@ -9,6 +9,7 @@
 #include "RetroPlayer.h"
 
 #include "FileItem.h"
+#include "GUIInfoManager.h"
 #include "RetroPlayerAutoSave.h"
 #include "RetroPlayerInput.h"
 #include "ServiceBroker.h"
@@ -40,6 +41,7 @@
 #include "guilib/WindowIDs.h"
 #include "input/actions/Action.h"
 #include "input/actions/ActionIDs.h"
+#include "interfaces/AnnouncementManager.h"
 #include "messaging/ApplicationMessenger.h"
 #include "settings/MediaSettings.h"
 #include "threads/SingleLock.h"
@@ -54,37 +56,41 @@ using namespace GAME;
 using namespace RETRO;
 
 CRetroPlayer::CRetroPlayer(IPlayerCallback& callback)
-  : IPlayer(callback), m_gameServices(CServiceBroker::GetGameServices())
+  : IPlayer(callback),
+    m_gameServices(CServiceBroker::GetGameServices()),
+    m_fileItem(new CFileItem())
 {
   ResetPlayback();
   CServiceBroker::GetWinSystem()->RegisterRenderLoop(this);
+  CServiceBroker::GetAnnouncementManager()->AddAnnouncer(this);
 }
 
 CRetroPlayer::~CRetroPlayer()
 {
   CServiceBroker::GetWinSystem()->UnregisterRenderLoop(this);
+  CServiceBroker::GetAnnouncementManager()->RemoveAnnouncer(this);
   CloseFile();
 }
 
 bool CRetroPlayer::OpenFile(const CFileItem& file, const CPlayerOptions& options)
 {
-  CFileItem fileCopy(file);
+  *m_fileItem = file;
 
   std::string savestatePath;
 
   // When playing a game, set the game client that we'll use to open the game.
   // This will prompt the user to select a savestate if there are any.
   // If there are no savestates, or the user wants to create a new savestate
   // it will prompt the user to select a game client
-  if (!GAME::CGameUtils::FillInGameClient(fileCopy, savestatePath))
+  if (!GAME::CGameUtils::FillInGameClient(*m_fileItem, savestatePath))
   {
     CLog::Log(LOGINFO,
               "RetroPlayer[PLAYER]: No compatible game client selected, aborting playback");
     return false;
   }
 
   // Check if we should open in standalone mode
-  const bool bStandalone = fileCopy.GetPath().empty();
+  const bool bStandalone = m_fileItem->GetPath().empty();
 
   m_processInfo.reset(CRPProcessInfo::CreateInstance());
   if (!m_processInfo)
@@ -103,11 +109,11 @@ bool CRetroPlayer::OpenFile(const CFileItem& file, const CPlayerOptions& options
   if (IsPlaying())
     CloseFile();
 
-  PrintGameInfo(fileCopy);
+  PrintGameInfo(*m_fileItem);
 
   bool bSuccess = false;
 
-  std::string gameClientId = fileCopy.GetGameInfoTag()->GetGameClient();
+  std::string gameClientId = m_fileItem->GetGameInfoTag()->GetGameClient();
 
   ADDON::AddonPtr addon;
   if (gameClientId.empty())
@@ -131,9 +137,9 @@ bool CRetroPlayer::OpenFile(const CFileItem& file, const CPlayerOptions& options
 
       if (!bStandalone)
       {
-        std::string redactedPath = CURL::GetRedacted(fileCopy.GetPath());
+        std::string redactedPath = CURL::GetRedacted(m_fileItem->GetPath());
         CLog::Log(LOGINFO, "RetroPlayer[PLAYER]: Opening: %s", redactedPath.c_str());
-        bSuccess = m_gameClient->OpenFile(fileCopy, *m_streamManager, m_input.get());
+        bSuccess = m_gameClient->OpenFile(*m_fileItem, *m_streamManager, m_input.get());
       }
       else
       {
@@ -182,11 +188,15 @@ bool CRetroPlayer::OpenFile(const CFileItem& file, const CPlayerOptions& options
     // Switch to fullscreen
     MESSAGING::CApplicationMessenger::GetInstance().PostMsg(TMSG_SWITCHTOFULLSCREEN);
 
-    m_cheevos.reset(new CCheevos(m_gameClient.get(), m_gameServices.GameSettings().RAUsername(),
+    m_cheevos.reset(new CCheevos(m_gameClient.get(), *m_fileItem,
+                                 m_gameServices.GameSettings().RAUsername(),
                                  m_gameServices.GameSettings().RAToken()));
 
     m_cheevos->EnableRichPresence();
 
+    // Calls to external code could mutate file item, so make a copy
+    CFileItem fileCopy(*m_fileItem);
+
     // Initialize gameplay
     CreatePlayback(m_gameServices.GameSettings().AutosaveEnabled(), savestatePath);
     RegisterWindowCallbacks();
@@ -570,6 +580,33 @@ std::string CRetroPlayer::CreateAutosave()
   return m_playback->CreateSavestate(true);
 }
 
+void CRetroPlayer::Announce(ANNOUNCEMENT::AnnouncementFlag flag,
+                            const std::string& sender,
+                            const std::string& message,
+                            const CVariant& data)
+{
+  // Announce() is called at the end of a chain to update the currently-playing
+  // file.
+  //
+  // Updates to current file metadata should find their way to CApplication.
+  // This can be accomplished off-thread by sending a TMSG_SET_PLAYER_ITEM
+  // message via app messenger.
+  //
+  // When CApplication receives a file metadata update, it in turn updates
+  // the state of CGUIInfoManager.
+  //
+  // CGUIInfoManager fires an "OnChanged" event for the info update. Publishers
+  // of file item metadata should be subscribed to this event to receive info
+  // updates from other publishers, as well as info added by CApplication
+  // during the playback lifecycle.
+
+  if (flag == ANNOUNCEMENT::Info && message == "OnChanged")
+  {
+    const CGUIInfoManager& infoMgr = CServiceBroker::GetGUI()->GetInfoManager();
+    *m_fileItem = infoMgr.GetCurrentItem();
+  }
+}
+
 void CRetroPlayer::SetSpeedInternal(double speed)
 {
   OnSpeedChange(speed);

xbmc/cores/RetroPlayer/RetroPlayer.h

@@ -14,6 +14,7 @@
 #include "cores/RetroPlayer/playback/IPlaybackControl.h"
 #include "games/GameTypes.h"
 #include "guilib/DispResource.h"
+#include "interfaces/IAnnouncer.h"
 #include "threads/CriticalSection.h"
 
 #include <memory>
@@ -38,7 +39,8 @@ class CRetroPlayer : public IPlayer,
                      public IRenderLoop,
                      public IGameCallback,
                      public IPlaybackCallback,
-                     public IAutoSaveCallback
+                     public IAutoSaveCallback,
+                     public ANNOUNCEMENT::IAnnouncer
 {
 public:
   explicit CRetroPlayer(IPlayerCallback& callback);
@@ -84,6 +86,12 @@ class CRetroPlayer : public IPlayer,
   bool IsAutoSaveEnabled() const override;
   std::string CreateAutosave() override;
 
+  // Implementation of IAnnouncer
+  void Announce(ANNOUNCEMENT::AnnouncementFlag flag,
+                const std::string& sender,
+                const std::string& message,
+                const CVariant& data) override;
+
 private:
   void SetSpeedInternal(double speed);
 
@@ -136,6 +144,9 @@ class CRetroPlayer : public IPlayer,
 
   // Synchronization parameters
   CCriticalSection m_mutex;
+
+  // File metadata
+  std::shared_ptr<CFileItem> m_fileItem;
 };
 } // namespace RETRO
 } // namespace KODI

xbmc/cores/RetroPlayer/cheevos/Cheevos.cpp

@@ -8,11 +8,14 @@
 
 #include "Cheevos.h"
 
+#include "FileItem.h"
 #include "URL.h"
 #include "filesystem/CurlFile.h"
 #include "filesystem/File.h"
 #include "games/addons/GameClient.h"
 #include "games/addons/cheevos/GameClientCheevos.h"
+#include "games/tags/GameInfoTag.h"
+#include "messaging/ApplicationMessenger.h"
 #include "utils/JSONVariantParser.h"
 #include "utils/URIUtils.h"
 #include "utils/Variant.h"
@@ -24,16 +27,25 @@ using namespace RETRO;
 
 // API JSON Field names
 constexpr auto SUCCESS = "Success";
-constexpr auto GAME_ID = "GameID";
 constexpr auto PATCH_DATA = "PatchData";
+constexpr auto GAME_ID = "GameID";
 constexpr auto RICH_PRESENCE = "RichPresencePatch";
+constexpr auto GAME_TITLE = "Title";
+constexpr auto PUBLISHER = "Publisher";
+constexpr auto DEVELOPER = "Developer";
+constexpr auto GENRE = "Genre";
+constexpr auto CONSOLE_NAME = "ConsoleName";
 
 constexpr int RESPORNSE_SIZE = 64;
 
 CCheevos::CCheevos(GAME::CGameClient* gameClient,
-                   const std::string userName,
-                   const std::string loginToken)
-  : m_gameClient(gameClient), m_userName(userName), m_loginToken(loginToken)
+                   CFileItem& fileItem,
+                   std::string userName,
+                   std::string loginToken)
+  : m_gameClient(gameClient),
+    m_fileItem(fileItem),
+    m_userName(std::move(userName)),
+    m_loginToken(std::move(loginToken))
 {
 }
 
@@ -107,6 +119,14 @@ bool CCheevos::LoadData()
   m_richPresenceScript = data[PATCH_DATA][RICH_PRESENCE].asString();
   m_richPresenceLoaded = true;
 
+  GAME::CGameInfoTag& tag = *m_fileItem.GetGameInfoTag();
+
+  tag.SetTitle(data[PATCH_DATA][GAME_TITLE].asString());
+  tag.SetPublisher(data[PATCH_DATA][PUBLISHER].asString());
+  tag.SetDeveloper(data[PATCH_DATA][DEVELOPER].asString());
+  tag.SetGenres({data[PATCH_DATA][GENRE].asString()});
+  tag.SetPlatform(data[PATCH_DATA][CONSOLE_NAME].asString());
+
   return true;
 }
 
@@ -136,6 +156,14 @@ std::string CCheevos::GetRichPresenceEvaluation()
   std::string evaluation;
   m_gameClient->Cheevos().GetRichPresenceEvaluation(evaluation);
 
+  GAME::CGameInfoTag& tag = *m_fileItem.GetGameInfoTag();
+
+  tag.SetCaption(evaluation);
+
+  CFileItem* file = new CFileItem(m_fileItem);
+  MESSAGING::CApplicationMessenger::GetInstance().PostMsg(TMSG_SET_PLAYER_ITEM, -1, -1,
+                                                          static_cast<void*>(file));
+
   std::string url;
   std::string postData;
   if (m_gameClient->Cheevos().RCPostRichPresenceUrl(url, postData, m_userName, m_loginToken,

xbmc/cores/RetroPlayer/cheevos/Cheevos.h

@@ -13,6 +13,8 @@
 #include <map>
 #include <string>
 
+class CFileItem;
+
 namespace KODI
 {
 namespace GAME
@@ -25,21 +27,28 @@ namespace RETRO
 class CCheevos
 {
 public:
-  CCheevos(GAME::CGameClient* gameClient, const std::string userName, const std::string loginToken);
+  CCheevos(GAME::CGameClient* gameClient,
+           CFileItem& fileItem,
+           std::string userName,
+           std::string loginToken);
   void ResetRuntime();
   void EnableRichPresence();
   std::string GetRichPresenceEvaluation();
 
 private:
   bool LoadData();
 
+  // Construction parameters
   GAME::CGameClient* const m_gameClient;
-  std::string m_userName;
-  std::string m_loginToken;
-  std::string m_romHash{};
-  std::string m_richPresenceScript{};
-  unsigned m_gameID{};
-  bool m_richPresenceLoaded{};
+  CFileItem& m_fileItem;
+  const std::string m_userName;
+  const std::string m_loginToken;
+
+  // Game parameters
+  std::string m_romHash;
+  std::string m_richPresenceScript;
+  unsigned m_gameID = 0;
+  bool m_richPresenceLoaded = false;
 
   const std::map<std::string, int> m_extensionToConsole = {{".a26", RC_CONSOLE_ATARI_2600},
                                                            {".a78", RC_CONSOLE_ATARI_7800},