EpgInfoTag.h

/*
 *  Copyright (C) 2012-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 "XBDateTime.h"
#include "pvr/PVRCachedImage.h"
#include "threads/CriticalSection.h"
#include "utils/ISerializable.h"

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

struct EPG_TAG;
struct PVR_EDL_ENTRY;

namespace PVR
{
class CPVREpgChannelData;
class CPVREpgDatabase;

class CPVREpgInfoTag final : public ISerializable,
                             public std::enable_shared_from_this<CPVREpgInfoTag>
{
  friend class CPVREpgDatabase;

public:
  static const std::string IMAGE_OWNER_PATTERN;

  CPVREpgInfoTag(const EPG_TAG& data,
                 int iClientId,
                 const std::shared_ptr<CPVREpgChannelData>& channelData,
                 int iEpgID);

  CPVREpgInfoTag(const std::shared_ptr<CPVREpgChannelData>& channelData,
                 int iEpgID,
                 const CDateTime& start,
                 const CDateTime& end,
                 bool bIsGapTag);

  void SetChannelData(const std::shared_ptr<CPVREpgChannelData>& data);

  bool operator==(const CPVREpgInfoTag& right) const;
  bool operator!=(const CPVREpgInfoTag& right) const;

  // ISerializable implementation
  void Serialize(CVariant& value) const override;

  int ClientID() const;

  bool IsActive() const;

  bool WasActive() const;

  bool IsUpcoming() const;

  float ProgressPercentage() const;

  int Progress() const;

  int EpgID() const;

  void SetEpgID(int iEpgID);

  void SetUniqueBroadcastID(unsigned int iUniqueBroadcastID);

  unsigned int UniqueBroadcastID() const;

  int DatabaseID() const;

  int UniqueChannelID() const;

  std::string ChannelIconPath() const;

  CDateTime StartAsUTC() const;

  CDateTime StartAsLocalTime() const;

  CDateTime EndAsUTC() const;

  CDateTime EndAsLocalTime() const;

  void SetEndFromUTC(const CDateTime& end);

  int GetDuration() const;

  std::string Title() const;

  std::string PlotOutline() const;

  std::string Plot() const;

  std::string OriginalTitle() const;

  const std::vector<std::string> Cast() const;

  const std::vector<std::string> Directors() const;

  const std::vector<std::string> Writers() const;

  const std::string GetCastLabel() const;

  const std::string GetDirectorsLabel() const;

  const std::string GetWritersLabel() const;

  const std::string GetGenresLabel() const;

  int Year() const;

  std::string IMDBNumber() const;

  int GenreType() const;

  int GenreSubType() const;

  std::string GenreDescription() const;

  const std::vector<std::string> Genre() const;

  CDateTime FirstAired() const;

  int ParentalRating() const;

  std::string ParentalRatingCode() const;

  int StarRating() const;

  int SeriesNumber() const;

  std::string SeriesLink() const;

  int EpisodeNumber() const;

  int EpisodePart() const;

  std::string EpisodeName() const;

  std::string IconPath() const;

  std::string ClientIconPath() const;

  std::string Path() const;

  bool IsRecordable() const;

  bool IsPlayable() const;

  bool QueuePersistQuery(const std::shared_ptr<CPVREpgDatabase>& database);

  bool Update(const CPVREpgInfoTag& tag, bool bUpdateBroadcastId = true);

  std::vector<PVR_EDL_ENTRY> GetEdl() const;

  bool IsSeries() const;

  bool IsRadio() const;

  bool IsParentalLocked() const;

  bool IsGapTag() const;

  bool IsNew() const;

  bool IsPremiere() const;

  bool IsFinale() const;

  bool IsLive() const;

  unsigned int Flags() const { return m_iFlags; }

  static const std::vector<std::string> Tokenize(const std::string& str);

  static const std::string DeTokenize(const std::vector<std::string>& tokens);

private:
  CPVREpgInfoTag(int iEpgID, const std::string& iconPath);

  CPVREpgInfoTag() = delete;
  CPVREpgInfoTag(const CPVREpgInfoTag& tag) = delete;
  CPVREpgInfoTag& operator=(const CPVREpgInfoTag& other) = delete;

  CDateTime GetCurrentPlayingTime() const;

  int m_iDatabaseID = -1; 
  int m_iGenreType = 0; 
  int m_iGenreSubType = 0; 
  std::string m_strGenreDescription; 
  int m_iParentalRating = 0; 
  std::string m_strParentalRatingCode; 
  int m_iStarRating = 0; 
  int m_iSeriesNumber = -1; 
  int m_iEpisodeNumber = -1; 
  int m_iEpisodePart = -1; 
  unsigned int m_iUniqueBroadcastID = 0; 
  std::string m_strTitle; 
  std::string m_strPlotOutline; 
  std::string m_strPlot; 
  std::string m_strOriginalTitle; 
  std::vector<std::string> m_cast; 
  std::vector<std::string> m_directors; 
  std::vector<std::string> m_writers; 
  int m_iYear = 0; 
  std::string m_strIMDBNumber; 
  mutable std::vector<std::string> m_genre; 
  std::string m_strEpisodeName; 
  CPVRCachedImage m_iconPath; 
  CDateTime m_startTime; 
  CDateTime m_endTime; 
  CDateTime m_firstAired; 
  unsigned int m_iFlags = 0; 
  std::string m_strSeriesLink; 
  bool m_bIsGapTag = false;

  mutable CCriticalSection m_critSection;
  std::shared_ptr<CPVREpgChannelData> m_channelData;
  int m_iEpgID = -1;
};
} // namespace PVR