GUIGameRenderManager.h

/*
 *  Copyright (C) 2017-2018 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 "cores/GameSettings.h"
#include "threads/CriticalSection.h"

#include <map>
#include <memory>

namespace KODI
{
namespace GAME
{
class CDialogGameAdvancedSettings;
class CDialogGameVideoSelect;
} // namespace GAME

namespace RETRO
{
class CGameWindowFullScreen;
class CGUIGameControl;
class CGUIGameSettingsHandle;
class CGUIGameVideoHandle;
class CGUIRenderTargetFactory;
class CGUIRenderHandle;
class CGUIRenderTarget;
class IGameCallback;
class IRenderCallback;
class IPlayback;

class CGUIGameRenderManager
{
  // Classes that call into the protected interface
  friend class CGUIGameSettingsHandle;
  friend class CGUIGameVideoHandle;
  friend class CGUIRenderHandle;

public:
  CGUIGameRenderManager() = default;
  ~CGUIGameRenderManager();

  void RegisterPlayer(CGUIRenderTargetFactory* factory,
                      IRenderCallback* callback,
                      IGameCallback* gameCallback);

  void UnregisterPlayer();

  std::shared_ptr<CGUIRenderHandle> RegisterControl(CGUIGameControl& control);

  std::shared_ptr<CGUIRenderHandle> RegisterWindow(CGameWindowFullScreen& window);

  std::shared_ptr<CGUIGameVideoHandle> RegisterDialog(GAME::CDialogGameVideoSelect& dialog);

  std::shared_ptr<CGUIGameSettingsHandle> RegisterGameSettingsDialog();

protected:
  // Functions exposed to friend class CGUIRenderHandle
  void UnregisterHandle(CGUIRenderHandle* handle);
  void Render(CGUIRenderHandle* handle);
  void RenderEx(CGUIRenderHandle* handle);
  void ClearBackground(CGUIRenderHandle* handle);
  bool IsDirty(CGUIRenderHandle* handle);

  // Functions exposed to friend class CGUIGameVideoHandle
  void UnregisterHandle(CGUIGameVideoHandle* handle) {}
  bool IsPlayingGame();
  bool SupportsRenderFeature(RENDERFEATURE feature);
  bool SupportsScalingMethod(SCALINGMETHOD method);

  // Functions exposed to CGUIGameSettingsHandle
  void UnregisterHandle(CGUIGameSettingsHandle* handle) {}
  std::string GameClientID();
  std::string GetPlayingGame();
  std::string CreateSavestate(bool autosave);
  bool UpdateSavestate(const std::string& savestatePath);
  bool LoadSavestate(const std::string& savestatePath);
  void FreeSavestateResources(const std::string& savestatePath);
  void CloseOSD();

private:
  void UpdateRenderTargets();

  CGUIRenderTarget* CreateRenderTarget(CGUIRenderHandle* handle);

  // Render events
  CGUIRenderTargetFactory* m_factory = nullptr;
  std::map<CGUIRenderHandle*, std::shared_ptr<CGUIRenderTarget>> m_renderTargets;
  CCriticalSection m_targetMutex;

  // Video properties
  IRenderCallback* m_callback = nullptr;
  CCriticalSection m_callbackMutex;

  // Game properties
  IGameCallback* m_gameCallback = nullptr;
  CCriticalSection m_gameCallbackMutex;
};
} // namespace RETRO
} // namespace KODI