xbmc/video/VideoThumbLoader.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 "FileItem.h"
  12 #include "ThumbLoader.h"
  13
  14 #include <map>
  15 #include <vector>
  16
  17 class CStreamDetails;
  18 class CVideoDatabase;
  19 class EmbeddedArt;
  20
  21 using ArtMap = std::map<std::string, std::string>;
  22 using ArtCache = std::map<std::pair<MediaType, int>, ArtMap>;
  23
  24 class CVideoThumbLoader : public CThumbLoader
  25 {
  26 public:
  27   CVideoThumbLoader();
  28   ~CVideoThumbLoader() override;
  29
  30   void OnLoaderStart() override;
  31   void OnLoaderFinish() override;
  32
  33   bool LoadItem(CFileItem* pItem) override;
  34   bool LoadItemCached(CFileItem* pItem) override;
  35   bool LoadItemLookup(CFileItem* pItem) override;
  36
  37   /*! \brief Fill the thumb of a video item
  38    First uses a cached thumb from a previous run, then checks for a local thumb
  39    and caches it for the next run
  40    \param item the CFileItem object to fill
  41    \return true if we fill the thumb, false otherwise
  42    */
  43   virtual bool FillThumb(CFileItem &item);
  44
  45   /*! \brief Find a particular art type for a given item, optionally checking at the folder level
  46    \param item the CFileItem to search.
  47    \param type the type of art to look for.
  48    \param checkFolder whether to also check the folder level for files. Defaults to false.
  49    \return the art file (if found), else empty.
  50    */
  51   static std::string GetLocalArt(const CFileItem &item, const std::string &type, bool checkFolder = false);
  52
  53   /*! \brief return the available art types for a given media type
  54    \param type the type of media.
  55    \return a vector of art types.
  56    \sa GetLocalArt
  57    */
  58   static std::vector<std::string> GetArtTypes(const std::string &type);
  59
  60   static bool IsValidArtType(const std::string& potentialArtType);
  61
  62   static bool IsArtTypeInWhitelist(const std::string& artType, const std::vector<std::string>& whitelist, bool exact);
  63
  64   /*! \brief helper function to retrieve a thumb URL for embedded video thumbs
  65    \param item a video CFileItem.
  66    \return a URL for the embedded thumb.
  67    */
  68   static std::string GetEmbeddedThumbURL(const CFileItem &item);
  69
  70   /*! \brief helper function to fill the art for a video library item
  71    \param item a video CFileItem
  72    \return true if we fill art, false otherwise
  73    */
  74  bool FillLibraryArt(CFileItem &item) override;
  75
  76 protected:
  77   CVideoDatabase *m_videoDatabase;
  78   ArtCache m_artCache;
  79
  80   /*! \brief Tries to detect missing data/info from a file and adds those
  81    \param item The CFileItem to process
  82    \return void
  83    */
  84   void DetectAndAddMissingItemData(CFileItem &item);
  85
  86   const ArtMap& GetArtFromCache(const std::string &mediaType, const int id);
  87 };