PVRGUIActionsChannels.h

/*
 *  Copyright (C) 2016-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 "pvr/IPVRComponent.h"
#include "pvr/PVRChannelNumberInputHandler.h"
#include "pvr/guilib/PVRGUIChannelNavigator.h"
#include "pvr/settings/PVRSettings.h"
#include "threads/CriticalSection.h"

#include <memory>
#include <string>
#include <vector>

class CFileItem;

namespace PVR
{
class CPVRChannel;
class CPVRChannelGroupMember;

class CPVRChannelSwitchingInputHandler : public CPVRChannelNumberInputHandler
{
public:
  // CPVRChannelNumberInputHandler implementation
  void GetChannelNumbers(std::vector<std::string>& channelNumbers) override;
  void AppendChannelNumberCharacter(char cCharacter) override;
  void OnInputDone() override;

private:
  void SwitchToChannel(const CPVRChannelNumber& channelNumber);

  void SwitchToPreviousChannel();
};

class CPVRGUIActionsChannels : public IPVRComponent
{
public:
  CPVRGUIActionsChannels();
  ~CPVRGUIActionsChannels() override;

  CEventStream<PVRChannelNumberInputChangedEvent>& Events() { return m_events; }

  void RegisterChannelNumberInputHandler(CPVRChannelNumberInputHandler* handler);

  void DeregisterChannelNumberInputHandler(CPVRChannelNumberInputHandler* handler);

  void Notify(const PVRChannelNumberInputChangedEvent& event);

  bool HideChannel(const CFileItem& item) const;

  bool StartChannelScan();

  bool StartChannelScan(int clientId);

  bool IsRunningChannelScan() const { return m_bChannelScanRunning; }

  std::shared_ptr<CPVRChannelGroupMember> GetChannelGroupMember(
      const std::shared_ptr<const CPVRChannel>& channel) const;

  std::shared_ptr<CPVRChannelGroupMember> GetChannelGroupMember(const CFileItem& item) const;

  CPVRChannelNumberInputHandler& GetChannelNumberInputHandler();

  CPVRGUIChannelNavigator& GetChannelNavigator();

  void OnPlaybackStarted(const CFileItem& item);

  void OnPlaybackStopped(const CFileItem& item);

  std::string GetSelectedChannelPath(bool bRadio) const;

  void SetSelectedChannelPath(bool bRadio, const std::string& path);

private:
  CPVRGUIActionsChannels(const CPVRGUIActionsChannels&) = delete;
  CPVRGUIActionsChannels const& operator=(CPVRGUIActionsChannels const&) = delete;

  CPVRChannelSwitchingInputHandler m_channelNumberInputHandler;
  bool m_bChannelScanRunning{false};
  CPVRGUIChannelNavigator m_channelNavigator;
  CEventSource<PVRChannelNumberInputChangedEvent> m_events;

  mutable CCriticalSection m_critSection;
  CPVRSettings m_settings;
  std::string m_selectedChannelPathTV;
  std::string m_selectedChannelPathRadio;
};

namespace GUI
{
// pretty scope and name
using Channels = CPVRGUIActionsChannels;
} // namespace GUI

} // namespace PVR