[WIP] RetroEngine: A new player core for kodi

This includes two subsystems:

  * Rendering
  * Input

Author: garbear

addons/skin.estuary/xml/Includes_DialogSelect.xml

@@ -805,6 +805,13 @@
 								<texture>$INFO[ListItem.Art(screenshot)]</texture>
 								<aspectratio>keep</aspectratio>
 							</control>
+							<control type="gameengine">
+								<left>10</left>
+								<right>10</right>
+								<top>10</top>
+								<height>256</height>
+								<savestate>$INFO[ListItem.FilenameAndPath]</savestate>
+							</control>
 							<control type="label">
 								<left>10</left>
 								<right>10</right>
@@ -843,6 +850,13 @@
 								<texture>$INFO[ListItem.Art(screenshot)]</texture>
 								<aspectratio>keep</aspectratio>
 							</control>
+							<control type="gameengine">
+								<left>10</left>
+								<right>10</right>
+								<top>10</top>
+								<height>256</height>
+								<savestate>$INFO[ListItem.FilenameAndPath]</savestate>
+							</control>
 							<control type="label">
 								<left>10</left>
 								<right>10</right>

cmake/treedata/common/retroengine.txt

@@ -0,0 +1,6 @@
+xbmc/cores/RetroEngine cores/RetroEngine
+xbmc/cores/RetroEngine/guibridge cores/RetroEngine/guibridge
+xbmc/cores/RetroEngine/guicontrols cores/RetroEngine/guicontrols
+xbmc/cores/RetroEngine/input cores/RetroEngine/input
+xbmc/cores/RetroEngine/rendering cores/RetroEngine/rendering
+xbmc/cores/RetroEngine/streams cores/RetroEngine/streams

xbmc/ServiceBroker.cpp

@@ -473,3 +473,8 @@ std::shared_ptr<XFILE::CBlurayDiscCache> CServiceBroker::GetBlurayDiscCache()
 {
   return g_serviceBroker.m_blurayDiscCache;
 }
+
+RETRO_ENGINE::CRetroEngineServices& CServiceBroker::GetRetroEngineServices()
+{
+  return g_application.m_ServiceManager->GetRetroEngineServices();
+}

xbmc/ServiceBroker.h

@@ -48,6 +48,11 @@ namespace MESSAGING
 {
 class CApplicationMessenger;
 }
+
+namespace RETRO_ENGINE
+{
+class CRetroEngineServices;
+}
 } // namespace KODI
 
 class CAppParams;
@@ -239,6 +244,8 @@ class CServiceBroker
   static void UnregisterBlurayDiscCache();
   static std::shared_ptr<XFILE::CBlurayDiscCache> GetBlurayDiscCache();
 
+  static KODI::RETRO_ENGINE::CRetroEngineServices& GetRetroEngineServices();
+
 private:
   std::shared_ptr<CAppParams> m_appParams;
   std::unique_ptr<CLog> m_logging;

xbmc/ServiceManager.cpp

@@ -19,6 +19,7 @@
 #include "addons/VFSEntry.h"
 #include "addons/binary-addons/BinaryAddonManager.h"
 #include "cores/DataCacheCore.h"
+#include "cores/RetroEngine/RetroEngineServices.h"
 #include "cores/RetroPlayer/guibridge/GUIGameRenderManager.h"
 #include "cores/playercorefactory/PlayerCoreFactory.h"
 #include "favourites/FavouritesService.h"
@@ -162,6 +163,8 @@ bool CServiceManager::InitStageTwo(const std::string& profilesUserDataFolder)
 
   m_gameRenderManager = std::make_unique<RETRO::CGUIGameRenderManager>();
 
+  m_retroEngineServices = std::make_unique<RETRO_ENGINE::CRetroEngineServices>(*m_peripherals);
+
   m_fileExtensionProvider = std::make_unique<CFileExtensionProvider>(*m_addonMgr);
 
   m_powerManager = std::make_unique<CPowerManager>();
@@ -216,6 +219,8 @@ bool CServiceManager::InitStageThree(const std::shared_ptr<CProfileManager>& pro
   if (!m_Platform->InitStageThree())
     return false;
 
+  m_retroEngineServices->Initialize(*m_gameServices);
+
   init_level = 3;
   return true;
 }
@@ -248,6 +253,8 @@ void CServiceManager::DeinitStageTwo()
   m_weatherManager.reset();
   m_powerManager.reset();
   m_fileExtensionProvider.reset();
+  m_retroEngineServices->Deinitialize();
+  m_retroEngineServices.reset();
   m_gameRenderManager.reset();
   m_peripherals.reset();
   m_inputManager.reset();
@@ -383,6 +390,11 @@ KODI::RETRO::CGUIGameRenderManager& CServiceManager::GetGameRenderManager()
   return *m_gameRenderManager;
 }
 
+RETRO_ENGINE::CRetroEngineServices& CServiceManager::GetRetroEngineServices()
+{
+  return *m_retroEngineServices;
+}
+
 PERIPHERALS::CPeripherals& CServiceManager::GetPeripherals()
 {
   return *m_peripherals;

xbmc/ServiceManager.h

@@ -67,6 +67,11 @@ namespace RETRO
 {
 class CGUIGameRenderManager;
 }
+
+namespace RETRO_ENGINE
+{
+class CRetroEngineServices;
+}
 } // namespace KODI
 
 namespace MEDIA_DETECT
@@ -149,6 +154,8 @@ class CServiceManager
   MEDIA_DETECT::CDetectDVDMedia& GetDetectDVDMedia();
 #endif
 
+  KODI::RETRO_ENGINE::CRetroEngineServices& GetRetroEngineServices();
+
 protected:
   std::unique_ptr<ADDON::CAddonMgr> m_addonMgr;
   std::unique_ptr<ADDON::CBinaryAddonManager> m_binaryAddonManager;
@@ -171,6 +178,7 @@ class CServiceManager
   std::unique_ptr<KODI::GAME::CControllerManager> m_gameControllerManager;
   std::unique_ptr<KODI::GAME::CGameServices> m_gameServices;
   std::unique_ptr<KODI::RETRO::CGUIGameRenderManager> m_gameRenderManager;
+  std::unique_ptr<KODI::RETRO_ENGINE::CRetroEngineServices> m_retroEngineServices;
   std::unique_ptr<PERIPHERALS::CPeripherals> m_peripherals;
   std::unique_ptr<CFavouritesService> m_favouritesService;
   std::unique_ptr<CInputManager> m_inputManager;

xbmc/cores/RetroEngine/CMakeLists.txt

@@ -0,0 +1,9 @@
+set(SOURCES RetroEngine.cpp
+            RetroEngineServices.cpp
+)
+
+set(HEADERS RetroEngine.h
+            RetroEngineServices.h
+)
+
+core_add_library(retroengine)

xbmc/cores/RetroEngine/RetroEngine.cpp

@@ -0,0 +1,44 @@
+/*
+ *  Copyright (C) 2023-2024 Team Kodi
+ *  This file is part of Kodi - https://kodi.tv
+ *
+ *  SPDX-License-Identifier: GPL-2.0-or-later
+ *  See LICENSES/README.md for more information.
+ */
+
+#include "RetroEngine.h"
+
+#include "cores/RetroEngine/guibridge/RetroEngineGuiBridge.h"
+#include "cores/RetroEngine/rendering/RetroEngineRenderer.h"
+#include "cores/RetroEngine/streams/IRetroEngineStream.h"
+#include "cores/RetroEngine/streams/RetroEngineStreamManager.h"
+#include "cores/RetroEngine/streams/RetroEngineStreamSwFramebuffer.h"
+
+using namespace KODI;
+using namespace RETRO_ENGINE;
+
+CRetroEngine::CRetroEngine(CRetroEngineGuiBridge& guiBridge, const std::string& savestatePath)
+  : m_guiBridge(guiBridge),
+    m_savestatePath(savestatePath),
+    m_streamManager(std::make_unique<CRetroEngineStreamManager>()),
+    m_renderer(std::make_unique<CRetroEngineRenderer>(m_guiBridge, *m_streamManager))
+{
+}
+
+CRetroEngine::~CRetroEngine() = default;
+
+void CRetroEngine::Initialize()
+{
+  // Initialize rendering
+  m_renderer->Initialize();
+}
+
+void CRetroEngine::Deinitialize()
+{
+  // Deinitialize stream
+  if (m_stream)
+    m_streamManager->CloseStream(std::move(m_stream));
+
+  // Deinitialize rendering
+  m_renderer->Deinitialize();
+}

xbmc/cores/RetroEngine/RetroEngine.h

@@ -0,0 +1,45 @@
+/*
+ *  Copyright (C) 2023-2024 Team Kodi
+ *  This file is part of Kodi - https://kodi.tv
+ *
+ *  SPDX-License-Identifier: GPL-2.0-or-later
+ *  See LICENSES/README.md for more information.
+ */
+
+#pragma once
+
+#include <memory>
+#include <string>
+
+namespace KODI
+{
+namespace RETRO_ENGINE
+{
+
+class CRetroEngineGuiBridge;
+class CRetroEngineRenderer;
+class CRetroEngineStreamManager;
+class IRetroEngineStream;
+
+class CRetroEngine
+{
+public:
+  explicit CRetroEngine(CRetroEngineGuiBridge& guiBridge, const std::string& savestatePath);
+  ~CRetroEngine();
+
+  // Lifecycle functions
+  void Initialize();
+  void Deinitialize();
+
+private:
+  // Construction parameters
+  CRetroEngineGuiBridge& m_guiBridge;
+  const std::string m_savestatePath;
+
+  // RetroEngine parameters
+  std::unique_ptr<CRetroEngineStreamManager> m_streamManager;
+  std::unique_ptr<IRetroEngineStream> m_stream;
+  std::unique_ptr<CRetroEngineRenderer> m_renderer;
+};
+} // namespace RETRO_ENGINE
+} // namespace KODI

xbmc/cores/RetroEngine/RetroEngineServices.cpp

@@ -0,0 +1,46 @@
+/*
+ *  Copyright (C) 2021-2024 Team Kodi
+ *  This file is part of Kodi - https://kodi.tv
+ *
+ *  SPDX-License-Identifier: GPL-2.0-or-later
+ *  See LICENSES/README.md for more information.
+ */
+
+#include "cores/RetroEngine/RetroEngineServices.h"
+
+#include "ServiceBroker.h"
+#include "application/AppParams.h"
+#include "cores/RetroEngine/guibridge/RetroEngineGuiBridge.h"
+#include "cores/RetroEngine/guibridge/RetroEngineGuiManager.h"
+#include "cores/RetroEngine/input/RetroEngineInputManager.h"
+#include "utils/log.h"
+
+using namespace KODI;
+using namespace RETRO_ENGINE;
+
+CRetroEngineServices::CRetroEngineServices(PERIPHERALS::CPeripherals& peripheralManager)
+  : m_guiManager(std::make_unique<CRetroEngineGuiManager>()),
+    m_inputManager(std::make_unique<CRetroEngineInputManager>(peripheralManager))
+{
+}
+
+CRetroEngineServices::~CRetroEngineServices() = default;
+
+void CRetroEngineServices::Initialize(GAME::CGameServices& gameServices)
+{
+  CLog::Log(LOGDEBUG, "RETROENGINE: Initializing services");
+
+  m_inputManager->Initialize(gameServices);
+}
+
+void CRetroEngineServices::Deinitialize()
+{
+  CLog::Log(LOGDEBUG, "RETROENGINE: Deinitializing services");
+
+  m_inputManager->Deinitialize();
+}
+
+CRetroEngineGuiBridge& CRetroEngineServices::GuiBridge(const std::string& savestatePath)
+{
+  return m_guiManager->GetGuiBridge(savestatePath);
+}