xbmc/addons/ExtsMimeSupportList.h

   1 /*
   2  *  Copyright (C) 2005-2021 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/IAddonSupportList.h"
  12 #include "threads/CriticalSection.h"
  13
  14 #include <map>
  15 #include <memory>
  16 #include <string>
  17 #include <utility>
  18 #include <vector>
  19
  20 namespace ADDON
  21 {
  22 enum class AddonType;
  23 class CAddonMgr;
  24 class CAddonInfo;
  25
  26 struct AddonEvent;
  27 }
  28
  29 namespace KODI
  30 {
  31 namespace ADDONS
  32 {
  33
  34 /*!
  35  * @brief Class to manage all available and activated add-ons and
  36  * to release their types to the outside for selection.
  37  *
  38  * @note It may also make sense in the future to expand this class and design it
  39  * globally in Kodi so that other addons can also be managed with it (all which
  40  * have mimetypes and file extensions, e.g. vfs, audioencoder).
  41  */
  42 class CExtsMimeSupportList : public KODI::ADDONS::IAddonSupportList
  43 {
  44 public:
  45   CExtsMimeSupportList(ADDON::CAddonMgr& addonMgr);
  46   ~CExtsMimeSupportList();
  47
  48   /*!
  49    * @brief Filter selection values.
  50    */
  51   enum class FilterSelect
  52   {
  53     /*! To select all available */
  54     all,
  55
  56     /*! To select only them where support tags */
  57     hasTags,
  58
  59     /*! Get only where support tracks within */
  60     hasTracks
  61   };
  62
  63   /*!
  64    * @brief Structure to store information about supported part.
  65    */
  66   struct SupportValue
  67   {
  68     SupportValue(int description, std::string icon)
  69       : m_description(description), m_icon(std::move(icon))
  70     {
  71     }
  72
  73     // Description text about supported part
  74     int m_description;
  75
  76     // Own by addon defined icon path
  77     std::string m_icon;
  78   };
  79
  80   /*!
  81    * @brief Structure to store available data for related addon.
  82    */
  83   struct SupportValues
  84   {
  85     // Type of stored addon to check on scan
  86     ADDON::AddonType m_addonType{};
  87
  88     // Related addon info class
  89     std::shared_ptr<ADDON::CAddonInfo> m_addonInfo;
  90
  91     // Addon his own codec identification name
  92     std::string m_codecName;
  93
  94     // If as true support addons own song information tags
  95     bool m_hasTags{false};
  96
  97     // To know addon includes several tracks inside one file, if set to true
  98     bool m_hasTracks{false};
  99
 100     // List of supported file extensions by addon
 101     // First: Extension name
 102     // Second: With @ref SupportValue defined content
 103     std::map<std::string, SupportValue> m_supportedExtensions;
 104
 105     // List of supported mimetypes by addon
 106     // First: Mimetype name
 107     // Second: With @ref SupportValue defined content
 108     std::map<std::string, SupportValue> m_supportedMimetypes;
 109   };
 110
 111   /*!
 112    * @brief Get list of all by audiodecoder supported parts.
 113    *
 114    * Thought to use on planned new window about management about supported
 115    * extensions and mimetypes in Kodi and to allow edit by user to enable or
 116    * disable corresponding parts.
 117    *
 118    * This function is also used to notify Kodi supported formats and to allow
 119    * playback.
 120    *
 121    * @param[in] select To filter the listed information by type
 122    * @return List of the available types listed for the respective add-on
 123    */
 124   std::vector<SupportValues> GetSupportedAddonInfos(FilterSelect select);
 125
 126   /*!
 127    * @brief To query the desired file extension is supported in it.
 128    *
 129    * @param[in] ext Extension name to check
 130    * @return True if within supported, false if not
 131    */
 132   bool IsExtensionSupported(const std::string& ext);
 133
 134   /*!
 135    * @brief To get a list of all compatible audio decoder add-ons for the file extension.
 136    *
 137    * @param[in] ext Extension name to check
 138    * @param[in] select To filter the listed information by type
 139    * @return List of @ref ADDON::CAddonInfo where support related extension
 140    */
 141   std::vector<std::pair<ADDON::AddonType, std::shared_ptr<ADDON::CAddonInfo>>>
 142   GetExtensionSupportedAddonInfos(const std::string& ext, FilterSelect select);
 143
 144   /*!
 145    * @brief To query the desired file mimetype is supported in it.
 146    *
 147    * @param[in] mimetype Mimetype name to check
 148    * @return True if within supported, false if not
 149    */
 150   bool IsMimetypeSupported(const std::string& mimetype);
 151
 152   /*!
 153    * @brief To get a list of all compatible audio decoder add-ons for the mimetype.
 154    *
 155    * @param[in] mimetype Mimetype name to check
 156    * @param[in] select To filter the listed information by type
 157    * @return List of @ref ADDON::CAddonInfo where support related mimetype
 158    */
 159   std::vector<std::pair<ADDON::AddonType, std::shared_ptr<ADDON::CAddonInfo>>>
 160   GetMimetypeSupportedAddonInfos(const std::string& mimetype, FilterSelect select);
 161
 162   /*!
 163    * @brief To give all file extensions and MIME types supported by the addon.
 164    *
 165    * @param[in] addonId Identifier about wanted addon
 166    * @return List of all supported parts on selected addon
 167    *
 168    * @sa KODI::ADDONS::IAddonSupportList
 169    */
 170   std::vector<KODI::ADDONS::AddonSupportEntry> GetSupportedExtsAndMimeTypes(
 171       const std::string& addonId) override;
 172
 173 protected:
 174   void Update(const std::string& id);
 175   void OnEvent(const ADDON::AddonEvent& event);
 176
 177   static SupportValues ScanAddonProperties(ADDON::AddonType type,
 178                                            const std::shared_ptr<ADDON::CAddonInfo>& addonInfo);
 179
 180   CCriticalSection m_critSection;
 181
 182   std::vector<SupportValues> m_supportedList;
 183   ADDON::CAddonMgr& m_addonMgr;
 184 };
 185
 186 } /* namespace ADDONS */
 187 } /* namespace KODI */