PVRPlaybackState.h

/*
 *  Copyright (C) 2012-2019 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/ContentUtils.h"

#include <memory>
#include <string>

class CDateTime;
class CFileItem;

namespace PVR
{
class CPVRChannel;
class CPVRChannelGroup;
class CPVRChannelGroupMember;
class CPVREpgInfoTag;
class CPVRRecording;
class CPVRStreamProperties;

class CPVRPlaybackState
{
public:
  CPVRPlaybackState();

  virtual ~CPVRPlaybackState();

  void Clear();

  void ReInit();

  void OnPlaybackStarted(const CFileItem& item);

  bool OnPlaybackStopped(const CFileItem& item);

  bool OnPlaybackEnded(const CFileItem& item);

  void StartPlayback(
      CFileItem* item,
      ContentUtils::PlayMode mode = ContentUtils::PlayMode::CHECK_AUTO_PLAY_NEXT_ITEM) const;

  bool IsPlaying() const;

  bool IsPlayingTV() const;

  bool IsPlayingRadio() const;

  bool IsPlayingEncryptedChannel() const;

  bool IsPlayingRecording() const;

  bool IsPlayingEpgTag() const;

  bool IsPlayingChannel(int iClientID, int iUniqueChannelID) const;

  bool IsPlayingChannel(const std::shared_ptr<const CPVRChannel>& channel) const;

  bool IsPlayingRecording(const std::shared_ptr<const CPVRRecording>& recording) const;

  bool IsPlayingEpgTag(const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const;

  std::shared_ptr<CPVRChannel> GetPlayingChannel() const;

  std::shared_ptr<CPVRChannelGroupMember> GetPlayingChannelGroupMember() const;

  std::shared_ptr<CPVRRecording> GetPlayingRecording() const;

  std::shared_ptr<CPVREpgInfoTag> GetPlayingEpgTag() const;

  int GetPlayingChannelUniqueID() const;

  std::string GetPlayingClientName() const;

  int GetPlayingClientID() const;

  bool IsRecording() const;

  bool IsRecordingOnPlayingChannel() const;

  bool IsPlayingActiveRecording() const;

  bool CanRecordOnPlayingChannel() const;

  void SetActiveChannelGroup(const std::shared_ptr<CPVRChannelGroup>& group);

  std::shared_ptr<CPVRChannelGroup> GetActiveChannelGroup(bool bRadio) const;

  std::shared_ptr<CPVRChannelGroupMember> GetLastPlayedChannelGroupMember(bool bRadio) const;

  std::shared_ptr<CPVRChannelGroupMember> GetPreviousToLastPlayedChannelGroupMember(
      bool bRadio) const;

  CDateTime GetPlaybackTime(int iClientID, int iUniqueChannelID) const;

  CDateTime GetChannelPlaybackTime(int iClientID, int iUniqueChannelID) const;

private:
  void ClearData();

  std::unique_ptr<CFileItem> GetNextAutoplayItem(const CFileItem& item);

  void SetActiveChannelGroup(const std::shared_ptr<CPVRChannelGroupMember>& channel);

  void UpdateLastWatched(const std::shared_ptr<CPVRChannelGroupMember>& channel,
                         const CDateTime& time);

  mutable CCriticalSection m_critSection;

  std::shared_ptr<CPVRChannelGroupMember> m_playingChannel;
  std::shared_ptr<CPVRRecording> m_playingRecording;
  std::shared_ptr<CPVREpgInfoTag> m_playingEpgTag;
  std::shared_ptr<CPVRChannelGroupMember> m_lastPlayedChannelTV;
  std::shared_ptr<CPVRChannelGroupMember> m_lastPlayedChannelRadio;
  std::shared_ptr<CPVRChannelGroupMember> m_previousToLastPlayedChannelTV;
  std::shared_ptr<CPVRChannelGroupMember> m_previousToLastPlayedChannelRadio;
  std::string m_strPlayingClientName;
  int m_playingGroupId = -1;
  int m_playingClientId = -1;
  int m_playingChannelUniqueId = -1;
  std::string m_strPlayingRecordingUniqueId;
  int m_playingEpgTagChannelUniqueId = -1;
  unsigned int m_playingEpgTagUniqueId = 0;
  std::shared_ptr<CPVRChannelGroup> m_activeGroupTV;
  std::shared_ptr<CPVRChannelGroup> m_activeGroupRadio;

  class CLastWatchedUpdateTimer;
  std::unique_ptr<CLastWatchedUpdateTimer> m_lastWatchedUpdateTimer;
};
} // namespace PVR