xbmc/pvr/addons/PVRClientCapabilities.h

   1 /*
   2  *  Copyright (C) 2012-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "addons/kodi-dev-kit/include/kodi/c-api/addon-instance/pvr.h"
  12
  13 #include <memory>
  14 #include <string>
  15 #include <utility>
  16 #include <vector>
  17
  18 namespace PVR
  19 {
  20
  21 class CPVRClientCapabilities
  22 {
  23 public:
  24   CPVRClientCapabilities() = default;
  25   virtual ~CPVRClientCapabilities() = default;
  26
  27   CPVRClientCapabilities(const CPVRClientCapabilities& other);
  28   const CPVRClientCapabilities& operator=(const CPVRClientCapabilities& other);
  29
  30   const CPVRClientCapabilities& operator=(const PVR_ADDON_CAPABILITIES& addonCapabilities);
  31
  32   void clear();
  33
  34   /////////////////////////////////////////////////////////////////////////////////
  35   //
  36   // Channels
  37   //
  38   /////////////////////////////////////////////////////////////////////////////////
  39
  40   /*!
  41    * @brief Check whether this add-on supports TV channels.
  42    * @return True if supported, false otherwise.
  43    */
  44   bool SupportsTV() const { return m_addonCapabilities && m_addonCapabilities->bSupportsTV; }
  45
  46   /*!
  47    * @brief Check whether this add-on supports radio channels.
  48    * @return True if supported, false otherwise.
  49    */
  50   bool SupportsRadio() const { return m_addonCapabilities && m_addonCapabilities->bSupportsRadio; }
  51
  52   /*!
  53    * @brief Check whether this add-on supports providers.
  54    * @return True if supported, false otherwise.
  55    */
  56   bool SupportsProviders() const
  57   {
  58     return m_addonCapabilities && m_addonCapabilities->bSupportsProviders;
  59   }
  60
  61   /*!
  62    * @brief Check whether this add-on supports channel groups.
  63    * @return True if supported, false otherwise.
  64    */
  65   bool SupportsChannelGroups() const
  66   {
  67     return m_addonCapabilities && m_addonCapabilities->bSupportsChannelGroups;
  68   }
  69
  70   /*!
  71    * @brief Check whether this add-on supports scanning for new channels on the backend.
  72    * @return True if supported, false otherwise.
  73    */
  74   bool SupportsChannelScan() const
  75   {
  76     return m_addonCapabilities && m_addonCapabilities->bSupportsChannelScan;
  77   }
  78
  79   /*!
  80    * @brief Check whether this add-on supports the following functions:
  81    * DeleteChannel, RenameChannel, DialogChannelSettings and DialogAddChannel.
  82    *
  83    * @return True if supported, false otherwise.
  84    */
  85   bool SupportsChannelSettings() const
  86   {
  87     return m_addonCapabilities && m_addonCapabilities->bSupportsChannelSettings;
  88   }
  89
  90   /*!
  91    * @brief Check whether this add-on supports descramble information for playing channels.
  92    * @return True if supported, false otherwise.
  93    */
  94   bool SupportsDescrambleInfo() const
  95   {
  96     return m_addonCapabilities && m_addonCapabilities->bSupportsDescrambleInfo;
  97   }
  98
  99   /////////////////////////////////////////////////////////////////////////////////
 100   //
 101   // EPG
 102   //
 103   /////////////////////////////////////////////////////////////////////////////////
 104
 105   /*!
 106    * @brief Check whether this add-on provides EPG information.
 107    * @return True if supported, false otherwise.
 108    */
 109   bool SupportsEPG() const { return m_addonCapabilities && m_addonCapabilities->bSupportsEPG; }
 110
 111   /*!
 112    * @brief Check whether this add-on supports asynchronous transfer of epg events.
 113    * @return True if supported, false otherwise.
 114    */
 115   bool SupportsAsyncEPGTransfer() const
 116   {
 117     return m_addonCapabilities && m_addonCapabilities->bSupportsAsyncEPGTransfer;
 118   }
 119
 120   /////////////////////////////////////////////////////////////////////////////////
 121   //
 122   // Timers
 123   //
 124   /////////////////////////////////////////////////////////////////////////////////
 125
 126   /*!
 127    * @brief Check whether this add-on supports the creation and editing of timers.
 128    * @return True if supported, false otherwise.
 129    */
 130   bool SupportsTimers() const
 131   {
 132     return m_addonCapabilities && m_addonCapabilities->bSupportsTimers;
 133   }
 134
 135   /////////////////////////////////////////////////////////////////////////////////
 136   //
 137   // Recordings
 138   //
 139   /////////////////////////////////////////////////////////////////////////////////
 140
 141   /*!
 142    * @brief Check whether this add-on supports recordings.
 143    * @return True if supported, false otherwise.
 144    */
 145   bool SupportsRecordings() const
 146   {
 147     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings;
 148   }
 149
 150   /*!
 151    * @brief Check whether this add-on supports undelete of deleted recordings.
 152    * @return True if supported, false otherwise.
 153    */
 154   bool SupportsRecordingsUndelete() const
 155   {
 156     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 157            m_addonCapabilities->bSupportsRecordingsUndelete;
 158   }
 159
 160   /*!
 161    * @brief Check whether this add-on supports play count for recordings.
 162    * @return True if supported, false otherwise.
 163    */
 164   bool SupportsRecordingsPlayCount() const
 165   {
 166     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 167            m_addonCapabilities->bSupportsRecordingPlayCount;
 168   }
 169
 170   /*!
 171    * @brief Check whether this add-on supports store/retrieve of last played position for recordings..
 172    * @return True if supported, false otherwise.
 173    */
 174   bool SupportsRecordingsLastPlayedPosition() const
 175   {
 176     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 177            m_addonCapabilities->bSupportsLastPlayedPosition;
 178   }
 179
 180   /*!
 181    * @brief Check whether this add-on supports retrieving an edit decision list for recordings.
 182    * @return True if supported, false otherwise.
 183    */
 184   bool SupportsRecordingsEdl() const
 185   {
 186     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 187            m_addonCapabilities->bSupportsRecordingEdl;
 188   }
 189
 190   /*!
 191    * @brief Check whether this add-on supports retrieving an edit decision list for epg tags.
 192    * @return True if supported, false otherwise.
 193    */
 194   bool SupportsEpgTagEdl() const
 195   {
 196     return m_addonCapabilities && m_addonCapabilities->bSupportsEPG &&
 197            m_addonCapabilities->bSupportsEPGEdl;
 198   }
 199
 200   /*!
 201    * @brief Check whether this add-on supports renaming recordings..
 202    * @return True if supported, false otherwise.
 203    */
 204   bool SupportsRecordingsRename() const
 205   {
 206     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 207            m_addonCapabilities->bSupportsRecordingsRename;
 208   }
 209
 210   /*!
 211    * @brief Check whether this add-on supports changing lifetime of recording.
 212    * @return True if supported, false otherwise.
 213    */
 214   bool SupportsRecordingsLifetimeChange() const
 215   {
 216     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 217            m_addonCapabilities->bSupportsRecordingsLifetimeChange;
 218   }
 219
 220   /*!
 221    * @brief Obtain a list with all possible values for recordings lifetime.
 222    * @param list out, the list with the values or an empty list, if lifetime is not supported.
 223    */
 224   void GetRecordingsLifetimeValues(std::vector<std::pair<std::string, int>>& list) const;
 225
 226   /*!
 227    * @brief Check whether this add-on supports retrieving the size recordings..
 228    * @return True if supported, false otherwise.
 229    */
 230   bool SupportsRecordingsSize() const
 231   {
 232     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 233            m_addonCapabilities->bSupportsRecordingSize;
 234   }
 235
 236   /*!
 237    * @brief Check whether this add-on supports deleting recordings.
 238    * @return True if supported, false otherwise.
 239    */
 240   bool SupportsRecordingsDelete() const
 241   {
 242     return m_addonCapabilities && m_addonCapabilities->bSupportsRecordings &&
 243            m_addonCapabilities->bSupportsRecordingsDelete;
 244   }
 245
 246   /////////////////////////////////////////////////////////////////////////////////
 247   //
 248   // Streams
 249   //
 250   /////////////////////////////////////////////////////////////////////////////////
 251
 252   /*!
 253    * @brief Check whether this add-on provides an input stream. false if Kodi handles the stream.
 254    * @return True if supported, false otherwise.
 255    */
 256   bool HandlesInputStream() const
 257   {
 258     return m_addonCapabilities && m_addonCapabilities->bHandlesInputStream;
 259   }
 260
 261   /*!
 262    * @brief Check whether this add-on demultiplexes packets.
 263    * @return True if supported, false otherwise.
 264    */
 265   bool HandlesDemuxing() const
 266   {
 267     return m_addonCapabilities && m_addonCapabilities->bHandlesDemuxing;
 268   }
 269
 270 private:
 271   void InitRecordingsLifetimeValues();
 272
 273   std::unique_ptr<PVR_ADDON_CAPABILITIES> m_addonCapabilities;
 274   std::vector<std::pair<std::string, int>> m_recordingsLifetimeValues;
 275 };
 276
 277 } // namespace PVR