Screensaver.h

/*
 *  Copyright (C) 2005-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 "../AddonBase.h"
#include "../c-api/addon-instance/screensaver.h"
#include "../gui/renderHelper.h"
 
#ifdef __cplusplus
namespace kodi
{
namespace addon
{
 
//==============================================================================
class ATTRIBUTE_HIDDEN CInstanceScreensaver : public IAddonInstance
{
public:
  //============================================================================
  CInstanceScreensaver()
    : IAddonInstance(ADDON_INSTANCE_SCREENSAVER, GetKodiTypeVersion(ADDON_INSTANCE_SCREENSAVER))
  {
    if (CAddonBase::m_interface->globalSingleInstance != nullptr)
      throw std::logic_error("kodi::addon::CInstanceScreensaver: Creation of more as one in single "
                             "instance way is not allowed!");
 
    SetAddonStruct(CAddonBase::m_interface->firstKodiInstance);
    CAddonBase::m_interface->globalSingleInstance = this;
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  explicit CInstanceScreensaver(KODI_HANDLE instance, const std::string& kodiVersion = "")
    : IAddonInstance(ADDON_INSTANCE_SCREENSAVER,
                     !kodiVersion.empty() ? kodiVersion
                                          : GetKodiTypeVersion(ADDON_INSTANCE_SCREENSAVER))
  {
    if (CAddonBase::m_interface->globalSingleInstance != nullptr)
      throw std::logic_error("kodi::addon::CInstanceScreensaver: Creation of multiple together "
                             "with single instance way is not allowed!");
 
    SetAddonStruct(instance);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  ~CInstanceScreensaver() override = default;
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual bool Start() { return true; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual void Stop() {}
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual void Render() {}
  //----------------------------------------------------------------------------
 
  //============================================================================
 
  //============================================================================
  inline kodi::HardwareContext Device() { return m_instanceData->props->device; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline int X() { return m_instanceData->props->x; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline int Y() { return m_instanceData->props->y; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline int Width() { return m_instanceData->props->width; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline int Height() { return m_instanceData->props->height; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline float PixelRatio() { return m_instanceData->props->pixelRatio; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline std::string Name() { return m_instanceData->props->name; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline std::string Presets() { return m_instanceData->props->presets; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  inline std::string Profile() { return m_instanceData->props->profile; }
  //----------------------------------------------------------------------------
 
 
private:
  void SetAddonStruct(KODI_HANDLE instance)
  {
    if (instance == nullptr)
      throw std::logic_error("kodi::addon::CInstanceScreensaver: Creation with empty addon "
                             "structure not allowed, table must be given from Kodi!");
 
    m_instanceData = static_cast<AddonInstance_Screensaver*>(instance);
    m_instanceData->toAddon->addonInstance = this;
    m_instanceData->toAddon->Start = ADDON_Start;
    m_instanceData->toAddon->Stop = ADDON_Stop;
    m_instanceData->toAddon->Render = ADDON_Render;
  }
 
  inline static bool ADDON_Start(AddonInstance_Screensaver* instance)
  {
    CInstanceScreensaver* thisClass =
        static_cast<CInstanceScreensaver*>(instance->toAddon->addonInstance);
    thisClass->m_renderHelper = kodi::gui::GetRenderHelper();
    return thisClass->Start();
  }
 
  inline static void ADDON_Stop(AddonInstance_Screensaver* instance)
  {
    CInstanceScreensaver* thisClass =
        static_cast<CInstanceScreensaver*>(instance->toAddon->addonInstance);
    thisClass->Stop();
    thisClass->m_renderHelper = nullptr;
  }
 
  inline static void ADDON_Render(AddonInstance_Screensaver* instance)
  {
    CInstanceScreensaver* thisClass =
        static_cast<CInstanceScreensaver*>(instance->toAddon->addonInstance);
 
    if (!thisClass->m_renderHelper)
      return;
    thisClass->m_renderHelper->Begin();
    thisClass->Render();
    thisClass->m_renderHelper->End();
  }
 
  /*
   * Background render helper holds here and in addon base.
   * In addon base also to have for the others, and stored here for the worst
   * case where this class is independent from base and base becomes closed
   * before.
   *
   * This is on Kodi with GL unused and the calls to there are empty (no work)
   * On Kodi with Direct X where angle is present becomes this used.
   */
  std::shared_ptr<kodi::gui::IRenderHelper> m_renderHelper;
  AddonInstance_Screensaver* m_instanceData;
};
 
} /* namespace addon */
} /* namespace kodi */
#endif /* __cplusplus */