PVRGUIChannelNavigator.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 "threads/CriticalSection.h"
#include "utils/EventStream.h"

#include <memory>

namespace KODI
{
namespace GUILIB
{
namespace GUIINFO
{
struct PlayerShowInfoChangedEvent;
}
} // namespace GUILIB
} // namespace KODI

namespace PVR
{
enum class ChannelSwitchMode
{
  NO_SWITCH, // no channel switch
  INSTANT_OR_DELAYED_SWITCH // switch according to SETTING_PVRPLAYBACK_CHANNELENTRYTIMEOUT
};

struct PVRPreviewAndPlayerShowInfoChangedEvent
{
  explicit PVRPreviewAndPlayerShowInfoChangedEvent(bool previewAndPlayerShowInfo)
    : m_previewAndPlayerShowInfo(previewAndPlayerShowInfo)
  {
  }
  virtual ~PVRPreviewAndPlayerShowInfoChangedEvent() = default;

  bool m_previewAndPlayerShowInfo{false};
};

class CPVRChannelGroupMember;

class CPVRGUIChannelNavigator
{
public:
  CPVRGUIChannelNavigator();
  virtual ~CPVRGUIChannelNavigator();

  template<typename A>
  void Subscribe(A* owner, void (A::*fn)(const PVRPreviewAndPlayerShowInfoChangedEvent&))
  {
    SubscribeToShowInfoEventStream();
    m_events.Subscribe(owner, fn);
  }

  template<typename A>
  void Unsubscribe(A* obj)
  {
    m_events.Unsubscribe(obj);
  }

  void Notify(const KODI::GUILIB::GUIINFO::PlayerShowInfoChangedEvent& event);

  void SelectNextChannel(ChannelSwitchMode eSwitchMode);

  void SelectPreviousChannel(ChannelSwitchMode eSwitchMode);

  void SwitchToCurrentChannel();

  bool IsPreview() const;

  bool IsPreviewAndShowInfo() const;

  void ShowInfo();

  void HideInfo();

  void ToggleInfo();

  void SetPlayingChannel(const std::shared_ptr<CPVRChannelGroupMember>& groupMember);

  void ClearPlayingChannel();

private:
  std::shared_ptr<CPVRChannelGroupMember> GetNextOrPrevChannel(bool bNext);

  void SelectChannel(const std::shared_ptr<CPVRChannelGroupMember>& groupMember,
                     ChannelSwitchMode eSwitchMode);

  void ShowInfo(bool bForce);

  void SubscribeToShowInfoEventStream();

  void CheckAndPublishPreviewAndPlayerShowInfoChangedEvent();

  mutable CCriticalSection m_critSection;
  std::shared_ptr<CPVRChannelGroupMember> m_playingChannel;
  std::shared_ptr<CPVRChannelGroupMember> m_currentChannel;
  int m_iChannelEntryJobId = -1;
  int m_iChannelInfoJobId = -1;
  CEventSource<PVRPreviewAndPlayerShowInfoChangedEvent> m_events;
  bool m_playerShowInfo{false};
  bool m_previewAndPlayerShowInfo{false};
};
} // namespace PVR