xbmc/music/MusicThumbLoader.cpp

   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 #include "MusicThumbLoader.h"
  10
  11 #include "FileItem.h"
  12 #include "TextureDatabase.h"
  13 #include "music/infoscanner/MusicInfoScanner.h"
  14 #include "music/tags/MusicInfoTag.h"
  15 #include "music/tags/MusicInfoTagLoaderFactory.h"
  16 #include "utils/StringUtils.h"
  17 #include "video/VideoThumbLoader.h"
  18
  19 #include <utility>
  20
  21 using namespace MUSIC_INFO;
  22
  23 CMusicThumbLoader::CMusicThumbLoader() : CThumbLoader()
  24 {
  25   m_musicDatabase = new CMusicDatabase;
  26 }
  27
  28 CMusicThumbLoader::~CMusicThumbLoader()
  29 {
  30   delete m_musicDatabase;
  31 }
  32
  33 void CMusicThumbLoader::OnLoaderStart()
  34 {
  35   m_musicDatabase->Open();
  36   m_albumArt.clear();
  37   CThumbLoader::OnLoaderStart();
  38 }
  39
  40 void CMusicThumbLoader::OnLoaderFinish()
  41 {
  42   m_musicDatabase->Close();
  43   m_albumArt.clear();
  44   CThumbLoader::OnLoaderFinish();
  45 }
  46
  47 bool CMusicThumbLoader::LoadItem(CFileItem* pItem)
  48 {
  49   bool result  = LoadItemCached(pItem);
  50        result |= LoadItemLookup(pItem);
  51
  52   return result;
  53 }
  54
  55 bool CMusicThumbLoader::LoadItemCached(CFileItem* pItem)
  56 {
  57   if (pItem->m_bIsShareOrDrive)
  58     return false;
  59
  60   if (pItem->HasMusicInfoTag() && !pItem->GetProperty("libraryartfilled").asBoolean())
  61   {
  62     if (FillLibraryArt(*pItem))
  63       return true;
  64
  65     if (pItem->GetMusicInfoTag()->GetType() == MediaTypeArtist)
  66       return false; // No fallback
  67   }
  68
  69   if (pItem->HasVideoInfoTag() && !pItem->HasArt("thumb"))
  70   { // music video
  71     CVideoThumbLoader loader;
  72     if (loader.LoadItemCached(pItem))
  73       return true;
  74   }
  75
  76   // Fallback to folder thumb when path has one cached
  77   if (!pItem->HasArt("thumb"))
  78   {
  79     std::string art = GetCachedImage(*pItem, "thumb");
  80     if (!art.empty())
  81       pItem->SetArt("thumb", art);
  82   }
  83
  84   // Fallback to folder fanart when path has one cached
  85   //! @todo Remove as "fanart" is never been cached for music folders (only for
  86   // artists) or start caching fanart for folders?
  87   if (!pItem->HasArt("fanart"))
  88   {
  89     std::string art = GetCachedImage(*pItem, "fanart");
  90     if (!art.empty())
  91     {
  92       pItem->SetArt("fanart", art);
  93     }
  94   }
  95
  96   return false;
  97 }
  98
  99 bool CMusicThumbLoader::LoadItemLookup(CFileItem* pItem)
 100 {
 101   if (pItem->m_bIsShareOrDrive)
 102     return false;
 103
 104   if (pItem->HasMusicInfoTag() && pItem->GetMusicInfoTag()->GetType() == MediaTypeArtist) // No fallback for artist
 105     return false;
 106
 107   if (pItem->HasVideoInfoTag())
 108   { // music video
 109     CVideoThumbLoader loader;
 110     if (loader.LoadItemLookup(pItem))
 111       return true;
 112   }
 113
 114   if (!pItem->HasArt("thumb"))
 115   {
 116     // Look for embedded art
 117     if (pItem->HasMusicInfoTag() && !pItem->GetMusicInfoTag()->GetCoverArtInfo().Empty())
 118     {
 119       // The item has got embedded art but user thumbs overrule, so check for those first
 120       if (!FillThumb(*pItem, false)) // Check for user thumbs but ignore folder thumbs
 121       {
 122         // No user thumb, use embedded art
 123         std::string thumb = CTextureUtils::GetWrappedImageURL(pItem->GetPath(), "music");
 124         pItem->SetArt("thumb", thumb);
 125       }
 126     }
 127     else
 128     {
 129       // Check for user thumbs
 130       FillThumb(*pItem, true);
 131     }
 132   }
 133
 134   return true;
 135 }
 136
 137 bool CMusicThumbLoader::FillThumb(CFileItem &item, bool folderThumbs /* = true */)
 138 {
 139   if (item.HasArt("thumb"))
 140     return true;
 141   std::string thumb = GetCachedImage(item, "thumb");
 142   if (thumb.empty())
 143   {
 144     thumb = item.GetUserMusicThumb(false, folderThumbs);
 145     if (!thumb.empty())
 146       SetCachedImage(item, "thumb", thumb);
 147   }
 148   if (!thumb.empty())
 149     item.SetArt("thumb", thumb);
 150   return !thumb.empty();
 151 }
 152
 153 bool CMusicThumbLoader::FillLibraryArt(CFileItem &item)
 154 {
 155   /* Called for any item with MusicInfoTag and no art.
 156      Items on Genres, Sources and Roles nodes have ID (although items on Years
 157      node do not) so check for song/album/artist specifically.
 158      Non-library songs (file view) can also have MusicInfoTag but no ID or type
 159   */
 160   bool artfound(false);
 161   std::vector<ArtForThumbLoader> art;
 162   CMusicInfoTag &tag = *item.GetMusicInfoTag();
 163   if (tag.GetDatabaseId() > -1 &&
 164       (tag.GetType() == MediaTypeSong || tag.GetType() == MediaTypeAlbum ||
 165        tag.GetType() == MediaTypeArtist))
 166   {
 167     // Item in music library, fetch the art
 168     m_musicDatabase->Open();
 169     if (tag.GetType() == MediaTypeSong)
 170       artfound = m_musicDatabase->GetArtForItem(tag.GetDatabaseId(), tag.GetAlbumId(), -1, false, art);
 171     else if (tag.GetType() == MediaTypeAlbum)
 172       artfound = m_musicDatabase->GetArtForItem(-1, tag.GetDatabaseId(), -1, false, art);
 173     else //Artist
 174       artfound = m_musicDatabase->GetArtForItem(-1, -1, tag.GetDatabaseId(), true, art);
 175
 176     m_musicDatabase->Close();
 177   }
 178   else if (!tag.GetArtist().empty() &&
 179            (tag.GetType() == MediaTypeNone || tag.GetType() == MediaTypeSong))
 180   {
 181     /*
 182     Could be non-library song - has musictag but no ID or type (may have
 183     thumb already). Try to fetch both song artist(s) and album artist(s) art by
 184     artist name, e.g. "artist.thumb", "artist.fanart", "artist.clearlogo",
 185     "artist.banner", "artist1.thumb", "artist1.fanart", "artist1.clearlogo",
 186     "artist1.banner", "albumartist.thumb", "albumartist.fanart" etc.
 187     Set fanart as fallback.
 188     */
 189     CSong song;
 190     // Try to split song artist names (various tags) into artist credits
 191     song.SetArtistCredits(tag.GetArtist(), tag.GetMusicBrainzArtistHints(), tag.GetMusicBrainzArtistID());
 192     if (!song.artistCredits.empty())
 193     {
 194       tag.SetType(MediaTypeSong);  // Makes "Information" context menu visible
 195       m_musicDatabase->Open();
 196       int iOrder = 0;
 197       // Song artist art
 198       for (const auto& artistCredit : song.artistCredits)
 199       {
 200         int idArtist = m_musicDatabase->GetArtistByName(artistCredit.GetArtist());
 201         if (idArtist > 0)
 202         {
 203           std::vector<ArtForThumbLoader> artistart;
 204           if (m_musicDatabase->GetArtForItem(-1, -1, idArtist, true, artistart))
 205           {
 206             for (auto& artitem : artistart)
 207             {
 208               if (iOrder > 0)
 209                 artitem.prefix = StringUtils::Format("artist{}", iOrder);
 210               else
 211                 artitem.prefix = "artist";
 212             }
 213             art.insert(art.end(), artistart.begin(), artistart.end());
 214           }
 215         }
 216         ++iOrder;
 217       }
 218       // Album artist art
 219       if (!tag.GetAlbumArtist().empty() && tag.GetArtistString().compare(tag.GetAlbumArtistString()) != 0)
 220       {
 221         // Split song artist names correctly into artist credits from various tag
 222         // arrays, inc. fallback to song artist names
 223         CAlbum album;
 224         album.SetArtistCredits(tag.GetAlbumArtist(), tag.GetMusicBrainzAlbumArtistHints(), tag.GetMusicBrainzAlbumArtistID(),
 225           tag.GetArtist(), tag.GetMusicBrainzArtistHints(), tag.GetMusicBrainzArtistID());
 226
 227         iOrder = 0;
 228         for (const auto& artistCredit : album.artistCredits)
 229         {
 230           int idArtist = m_musicDatabase->GetArtistByName(artistCredit.GetArtist());
 231           if (idArtist > 0)
 232           {
 233             std::vector<ArtForThumbLoader> artistart;
 234             if (m_musicDatabase->GetArtForItem(-1, -1, idArtist, true, artistart))
 235             {
 236               for (auto& artitem : artistart)
 237               {
 238                 if (iOrder > 0)
 239                   artitem.prefix = StringUtils::Format("albumartist{}", iOrder);
 240                 else
 241                   artitem.prefix = "albumartist";
 242               }
 243               art.insert(art.end(), artistart.begin(), artistart.end());
 244             }
 245           }
 246           ++iOrder;
 247         }
 248       }
 249       else
 250       {
 251         // Replicate the artist art as album artist art
 252         std::vector<ArtForThumbLoader> artistart;
 253         for (const auto& artitem : art)
 254         {
 255           ArtForThumbLoader newart;
 256           newart.artType = artitem.artType;
 257           newart.mediaType = artitem.mediaType;
 258           newart.prefix = "album" + artitem.prefix;
 259           newart.url = artitem.url;
 260           artistart.emplace_back(newart);
 261         }
 262         art.insert(art.end(), artistart.begin(), artistart.end());
 263       }
 264       artfound = !art.empty();
 265       m_musicDatabase->Close();
 266     }
 267   }
 268
 269   if (artfound)
 270   {
 271     std::string fanartfallback;
 272     std::string artname;
 273     std::map<std::string, std::string> artmap;
 274     std::map<std::string, std::string> discartmap;
 275     for (auto artitem : art)
 276     {
 277       /* Add art to artmap, naming according to media type.
 278       For example: artists have "thumb", "fanart", "poster" etc.,
 279       albums have "thumb", "artist.thumb", "artist.fanart",... "artist1.thumb", "artist1.fanart" etc.,
 280       songs have "thumb", "album.thumb", "artist.thumb", "albumartist.thumb", "albumartist1.thumb" etc.
 281       */
 282       if (tag.GetType() == artitem.mediaType)
 283         artname = artitem.artType;
 284       else if (artitem.prefix.empty())
 285         artname = artitem.mediaType + "." + artitem.artType;
 286       else
 287       {
 288         if (tag.GetType() == MediaTypeAlbum)
 289           StringUtils::Replace(artitem.prefix, "albumartist", "artist");
 290         artname = artitem.prefix + "." + artitem.artType;
 291       }
 292
 293       // Pull out album art for this specific disc e.g. "thumb2", skip art for other discs
 294       if (artitem.mediaType == MediaTypeAlbum && tag.GetDiscNumber() > 0)
 295       {
 296         // Find any trailing digits
 297         size_t startnum = artitem.artType.find_last_not_of("0123456789");
 298         std::string digits = artitem.artType.substr(startnum + 1);
 299         int num = atoi(digits.c_str());
 300         if (num > 0 && startnum < artitem.artType.size())
 301         {
 302           if (num == tag.GetDiscNumber())
 303             discartmap.insert(std::make_pair(artitem.artType.substr(0, startnum + 1), artitem.url));
 304           continue;
 305         }
 306       }
 307
 308       artmap.insert(std::make_pair(artname, artitem.url));
 309
 310       // Add fallback art for "thumb" and "fanart" art types only
 311       // Set album thumb as the fallback used when song thumb is missing
 312       if (tag.GetType() == MediaTypeSong && artitem.mediaType == MediaTypeAlbum &&
 313           artitem.artType == "thumb")
 314       {
 315         item.SetArtFallback(artitem.artType, artname);
 316       }
 317
 318       // For albums and songs set fallback fanart from the artist.
 319       // For songs prefer primary song artist over primary albumartist fanart as fallback fanart
 320       if (artitem.prefix == "artist" && artitem.artType == "fanart")
 321         fanartfallback = artname;
 322       if (artitem.prefix == "albumartist" && artitem.artType == "fanart" && fanartfallback.empty())
 323         fanartfallback = artname;
 324     }
 325     if (!fanartfallback.empty())
 326       item.SetArtFallback("fanart", fanartfallback);
 327
 328     // Process specific disc art when we have some
 329     for (const auto& discart : discartmap)
 330     {
 331       std::map<std::string, std::string>::iterator it;
 332       if (tag.GetType() == MediaTypeAlbum)
 333       {
 334         // Insert or replace album art with specific disc art
 335         it = artmap.find(discart.first);
 336         if (it != artmap.end())
 337           it->second = discart.second;
 338         else
 339           artmap.insert(discart);
 340       }
 341       else if (tag.GetType() == MediaTypeSong)
 342       {
 343         // Use disc thumb rather than album as fallback for song thumb
 344         // (Fallback approach is used to fill missing thumbs).
 345         if (discart.first == "thumb")
 346         {
 347           it = artmap.find("album.thumb");
 348           if (it != artmap.end())
 349             // Replace "album.thumb" already set as fallback
 350             it->second = discart.second;
 351           else
 352           {
 353             // Insert thumb for album and set as fallback
 354             artmap.insert(std::make_pair("album.thumb", discart.second));
 355             item.SetArtFallback("thumb", "album.thumb");
 356           }
 357         }
 358         else
 359         {
 360           // Apply disc art as song art when not have that type (fallback does not apply).
 361           // Art of other types could been set via JSON, or in future read from metadata
 362           it = artmap.find(discart.first);
 363           if (it == artmap.end())
 364             artmap.insert(discart);
 365         }
 366       }
 367     }
 368
 369     item.AppendArt(artmap);
 370   }
 371
 372   item.SetProperty("libraryartfilled", true);
 373   return artfound;
 374 }
 375
 376 bool CMusicThumbLoader::GetEmbeddedThumb(const std::string &path, EmbeddedArt &art)
 377 {
 378   CFileItem item(path, false);
 379   std::unique_ptr<IMusicInfoTagLoader> pLoader (CMusicInfoTagLoaderFactory::CreateLoader(item));
 380   CMusicInfoTag tag;
 381   if (nullptr != pLoader)
 382     pLoader->Load(path, tag, &art);
 383
 384   return !art.Empty();
 385 }