xbmc/PartyModeManager.cpp

   1 /*
   2  *  Copyright (C) 2005-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 "PartyModeManager.h"
  10
  11 #include "FileItem.h"
  12 #include "GUIUserMessages.h"
  13 #include "PlayListPlayer.h"
  14 #include "ServiceBroker.h"
  15 #include "application/ApplicationComponents.h"
  16 #include "application/ApplicationPlayer.h"
  17 #include "dialogs/GUIDialogProgress.h"
  18 #include "guilib/GUIComponent.h"
  19 #include "guilib/GUIWindowManager.h"
  20 #include "interfaces/AnnouncementManager.h"
  21 #include "messaging/helpers/DialogOKHelper.h"
  22 #include "music/MusicDatabase.h"
  23 #include "music/tags/MusicInfoTag.h"
  24 #include "playlists/PlayList.h"
  25 #include "playlists/SmartPlayList.h"
  26 #include "profiles/ProfileManager.h"
  27 #include "settings/SettingsComponent.h"
  28 #include "utils/Random.h"
  29 #include "utils/StringUtils.h"
  30 #include "utils/Variant.h"
  31 #include "utils/log.h"
  32 #include "video/VideoDatabase.h"
  33 #include "video/VideoInfoTag.h"
  34
  35 #include <algorithm>
  36
  37 using namespace KODI::MESSAGING;
  38
  39 #define QUEUE_DEPTH       10
  40
  41 CPartyModeManager::CPartyModeManager(void)
  42 {
  43   m_bIsVideo = false;
  44   m_bEnabled = false;
  45   ClearState();
  46 }
  47
  48 bool CPartyModeManager::Enable(PartyModeContext context /*= PARTYMODECONTEXT_MUSIC*/, const std::string& strXspPath /*= ""*/)
  49 {
  50   // Filter using our PartyMode xml file
  51   CSmartPlaylist playlist;
  52   std::string partyModePath;
  53   bool playlistLoaded;
  54
  55   m_bIsVideo = context == PARTYMODECONTEXT_VIDEO;
  56
  57   const std::shared_ptr<CProfileManager> profileManager = CServiceBroker::GetSettingsComponent()->GetProfileManager();
  58
  59   if (!strXspPath.empty()) //if a path to a smartplaylist is supplied use it
  60     partyModePath = strXspPath;
  61   else if (m_bIsVideo)
  62     partyModePath = profileManager->GetUserDataItem("PartyMode-Video.xsp");
  63   else
  64     partyModePath = profileManager->GetUserDataItem("PartyMode.xsp");
  65
  66   playlistLoaded=playlist.Load(partyModePath);
  67
  68   if (playlistLoaded)
  69   {
  70     m_type = playlist.GetType();
  71     if (context == PARTYMODECONTEXT_UNKNOWN)
  72     {
  73       //get it from the xsp file
  74       m_bIsVideo = (StringUtils::EqualsNoCase(m_type, "video") ||
  75         StringUtils::EqualsNoCase(m_type, "musicvideos") ||
  76         StringUtils::EqualsNoCase(m_type, "mixed"));
  77     }
  78   }
  79   else if (m_bIsVideo)
  80     m_type = "musicvideos";
  81   else
  82     m_type = "songs";
  83
  84   CGUIDialogProgress* pDialog = CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogProgress>(WINDOW_DIALOG_PROGRESS);
  85   int iHeading = (m_bIsVideo ? 20250 : 20121);
  86   int iLine0 = (m_bIsVideo ? 20251 : 20123);
  87   pDialog->SetHeading(CVariant{iHeading});
  88   pDialog->SetLine(0, CVariant{iLine0});
  89   pDialog->SetLine(1, CVariant{""});
  90   pDialog->SetLine(2, CVariant{""});
  91   pDialog->Open();
  92
  93   ClearState();
  94   std::string strCurrentFilterMusic;
  95   std::string strCurrentFilterVideo;
  96   unsigned int songcount = 0;
  97   unsigned int videocount = 0;
  98   auto start = std::chrono::steady_clock::now();
  99
 100   if (StringUtils::EqualsNoCase(m_type, "songs") ||
 101       StringUtils::EqualsNoCase(m_type, "mixed"))
 102   {
 103     CMusicDatabase db;
 104     if (db.Open())
 105     {
 106       std::set<std::string> playlists;
 107       if (playlistLoaded)
 108       {
 109         playlist.SetType("songs");
 110         strCurrentFilterMusic = playlist.GetWhereClause(db, playlists);
 111       }
 112
 113       CLog::Log(LOGINFO, "PARTY MODE MANAGER: Registering filter:[{}]", strCurrentFilterMusic);
 114       songcount = db.GetRandomSongIDs(CDatabase::Filter(strCurrentFilterMusic), m_songIDCache);
 115       m_iMatchingSongs = static_cast<int>(songcount);
 116       if (m_iMatchingSongs < 1 && StringUtils::EqualsNoCase(m_type, "songs"))
 117       {
 118         pDialog->Close();
 119         db.Close();
 120         OnError(16031, "Party mode found no matching songs. Aborting.");
 121         return false;
 122       }
 123     }
 124     else
 125     {
 126       pDialog->Close();
 127       OnError(16033, "Party mode could not open database. Aborting.");
 128       return false;
 129     }
 130     db.Close();
 131   }
 132
 133   if (StringUtils::EqualsNoCase(m_type, "musicvideos") ||
 134       StringUtils::EqualsNoCase(m_type, "mixed"))
 135   {
 136     std::vector< std::pair<int,int> > songIDs2;
 137     CVideoDatabase db;
 138     if (db.Open())
 139     {
 140       std::set<std::string> playlists;
 141       if (playlistLoaded)
 142       {
 143         playlist.SetType("musicvideos");
 144         strCurrentFilterVideo = playlist.GetWhereClause(db, playlists);
 145       }
 146
 147       CLog::Log(LOGINFO, "PARTY MODE MANAGER: Registering filter:[{}]", strCurrentFilterVideo);
 148       videocount = db.GetRandomMusicVideoIDs(strCurrentFilterVideo, songIDs2);
 149       m_iMatchingSongs += static_cast<int>(videocount);
 150       if (m_iMatchingSongs < 1)
 151       {
 152         pDialog->Close();
 153         db.Close();
 154         OnError(16031, "Party mode found no matching songs. Aborting.");
 155         return false;
 156       }
 157     }
 158     else
 159     {
 160       pDialog->Close();
 161       OnError(16033, "Party mode could not open database. Aborting.");
 162       return false;
 163     }
 164     db.Close();
 165     m_songIDCache.insert(m_songIDCache.end(), songIDs2.begin(), songIDs2.end());
 166   }
 167
 168   // Songs and music videos are random from query, but need mixing together when have both
 169   if (songcount > 0 && videocount > 0 )
 170     KODI::UTILS::RandomShuffle(m_songIDCache.begin(), m_songIDCache.end());
 171
 172   CLog::Log(LOGINFO,"PARTY MODE MANAGER: Matching songs = {0}", m_iMatchingSongs);
 173   CLog::Log(LOGINFO,"PARTY MODE MANAGER: Party mode enabled!");
 174
 175   PLAYLIST::Id playlistId = GetPlaylistId();
 176
 177   CServiceBroker::GetPlaylistPlayer().ClearPlaylist(playlistId);
 178   CServiceBroker::GetPlaylistPlayer().SetShuffle(playlistId, false);
 179   CServiceBroker::GetPlaylistPlayer().SetRepeat(playlistId, PLAYLIST::RepeatState::NONE);
 180
 181   pDialog->SetLine(0, CVariant{m_bIsVideo ? 20252 : 20124});
 182   pDialog->Progress();
 183   // add initial songs
 184   if (!AddRandomSongs())
 185   {
 186     pDialog->Close();
 187     return false;
 188   }
 189
 190   auto end = std::chrono::steady_clock::now();
 191   auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(end - start);
 192   CLog::Log(LOGDEBUG, "{} time for song fetch: {} ms", __FUNCTION__, duration.count());
 193
 194   // start playing
 195   CServiceBroker::GetPlaylistPlayer().SetCurrentPlaylist(playlistId);
 196   Play(0);
 197
 198   pDialog->Close();
 199   // open now playing window
 200   if (StringUtils::EqualsNoCase(m_type, "songs"))
 201   {
 202     if (CServiceBroker::GetGUI()->GetWindowManager().GetActiveWindow() != WINDOW_MUSIC_PLAYLIST)
 203       CServiceBroker::GetGUI()->GetWindowManager().ActivateWindow(WINDOW_MUSIC_PLAYLIST);
 204   }
 205
 206   // done
 207   m_bEnabled = true;
 208   Announce();
 209   return true;
 210 }
 211
 212 void CPartyModeManager::Disable()
 213 {
 214   if (!IsEnabled())
 215     return;
 216   m_bEnabled = false;
 217   Announce();
 218   CLog::Log(LOGINFO,"PARTY MODE MANAGER: Party mode disabled.");
 219 }
 220
 221 void CPartyModeManager::OnSongChange(bool bUpdatePlayed /* = false */)
 222 {
 223   if (!IsEnabled())
 224     return;
 225   Process();
 226   if (bUpdatePlayed)
 227     m_iSongsPlayed++;
 228 }
 229
 230 void CPartyModeManager::AddUserSongs(PLAYLIST::CPlayList& tempList, bool bPlay /* = false */)
 231 {
 232   if (!IsEnabled())
 233     return;
 234
 235   // where do we add?
 236   int iAddAt = -1;
 237   if (m_iLastUserSong < 0 || bPlay)
 238     iAddAt = 1; // under the currently playing song
 239   else
 240     iAddAt = m_iLastUserSong + 1; // under the last user added song
 241
 242   int iNewUserSongs = tempList.size();
 243   CLog::Log(LOGINFO, "PARTY MODE MANAGER: Adding {} user selected songs at {}", iNewUserSongs,
 244             iAddAt);
 245
 246   CServiceBroker::GetPlaylistPlayer().GetPlaylist(GetPlaylistId()).Insert(tempList, iAddAt);
 247
 248   // update last user added song location
 249   if (m_iLastUserSong < 0)
 250     m_iLastUserSong = 0;
 251   m_iLastUserSong += iNewUserSongs;
 252
 253   if (bPlay)
 254     Play(1);
 255 }
 256
 257 void CPartyModeManager::AddUserSongs(CFileItemList& tempList, bool bPlay /* = false */)
 258 {
 259   if (!IsEnabled())
 260     return;
 261
 262   // where do we add?
 263   int iAddAt = -1;
 264   if (m_iLastUserSong < 0 || bPlay)
 265     iAddAt = 1; // under the currently playing song
 266   else
 267     iAddAt = m_iLastUserSong + 1; // under the last user added song
 268
 269   int iNewUserSongs = tempList.Size();
 270   CLog::Log(LOGINFO, "PARTY MODE MANAGER: Adding {} user selected songs at {}", iNewUserSongs,
 271             iAddAt);
 272
 273   CServiceBroker::GetPlaylistPlayer().GetPlaylist(GetPlaylistId()).Insert(tempList, iAddAt);
 274
 275   // update last user added song location
 276   if (m_iLastUserSong < 0)
 277     m_iLastUserSong = 0;
 278   m_iLastUserSong += iNewUserSongs;
 279
 280   if (bPlay)
 281     Play(1);
 282 }
 283
 284 void CPartyModeManager::Process()
 285 {
 286   ReapSongs();
 287   MovePlaying();
 288   AddRandomSongs();
 289   UpdateStats();
 290   SendUpdateMessage();
 291 }
 292
 293 bool CPartyModeManager::AddRandomSongs()
 294 {
 295   // All songs have been picked, no more to add
 296   if (static_cast<int>(m_songIDCache.size()) == m_iMatchingSongsPicked)
 297     return false;
 298
 299   PLAYLIST::CPlayList& playlist = CServiceBroker::GetPlaylistPlayer().GetPlaylist(GetPlaylistId());
 300   int iMissingSongs = QUEUE_DEPTH - playlist.size();
 301
 302   if (iMissingSongs > 0)
 303   {
 304     // Limit songs fetched to remainder of songID cache
 305     iMissingSongs = std::min(iMissingSongs, static_cast<int>(m_songIDCache.size()) - m_iMatchingSongsPicked);
 306
 307     // Pick iMissingSongs from remaining songID cache
 308     std::string sqlWhereMusic = "songview.idSong IN (";
 309     std::string sqlWhereVideo = "idMVideo IN (";
 310
 311     bool bSongs = false;
 312     bool bMusicVideos = false;
 313     for (int i = m_iMatchingSongsPicked; i < m_iMatchingSongsPicked + iMissingSongs; i++)
 314     {
 315       std::string song = StringUtils::Format("{},", m_songIDCache[i].second);
 316       if (m_songIDCache[i].first == 1)
 317       {
 318         sqlWhereMusic += song;
 319         bSongs = true;
 320       }
 321       else if (m_songIDCache[i].first == 2)
 322       {
 323         sqlWhereVideo += song;
 324         bMusicVideos = true;
 325       }
 326     }
 327     CFileItemList items;
 328
 329     if (bSongs)
 330     {
 331       sqlWhereMusic.back() = ')'; // replace the last comma with closing bracket
 332       // Apply random sort (and limit) at db query for efficiency
 333       SortDescription SortDescription;
 334       SortDescription.sortBy = SortByRandom;
 335       SortDescription.limitEnd = QUEUE_DEPTH;
 336       CMusicDatabase database;
 337       if (database.Open())
 338       {
 339         database.GetSongsFullByWhere("musicdb://songs/", CDatabase::Filter(sqlWhereMusic),
 340           items, SortDescription, true);
 341
 342         // Get artist and album properties for songs
 343         for (auto& item : items)
 344           database.SetPropertiesForFileItem(*item);
 345         database.Close();
 346       }
 347       else
 348       {
 349         OnError(16033, "Party mode could not open database. Aborting.");
 350         return false;
 351       }
 352     }
 353     if (bMusicVideos)
 354     {
 355       sqlWhereVideo.back() = ')'; // replace the last comma with closing bracket
 356       CVideoDatabase database;
 357       if (database.Open())
 358       {
 359         database.GetMusicVideosByWhere("videodb://musicvideos/titles/",
 360           CDatabase::Filter(sqlWhereVideo), items);
 361         database.Close();
 362       }
 363       else
 364       {
 365         OnError(16033, "Party mode could not open database. Aborting.");
 366         return false;
 367       }
 368     }
 369
 370     // Randomize if the list has music videos or they will be in db order
 371     // Songs only are already random.
 372     if (bMusicVideos)
 373       items.Randomize();
 374     for (const auto& item : items)
 375     {
 376       // Update songID cache with order items in playlist
 377       if (item->HasMusicInfoTag())
 378       {
 379         m_songIDCache[m_iMatchingSongsPicked].first = 1;
 380         m_songIDCache[m_iMatchingSongsPicked].second = item->GetMusicInfoTag()->GetDatabaseId();
 381       }
 382       else if (item->HasVideoInfoTag())
 383       {
 384         m_songIDCache[m_iMatchingSongsPicked].first = 2;
 385         m_songIDCache[m_iMatchingSongsPicked].second = item->GetVideoInfoTag()->m_iDbId;
 386       }
 387       CFileItemPtr pItem(item);
 388       Add(pItem); // inc m_iMatchingSongsPicked
 389     }
 390   }
 391   return true;
 392 }
 393
 394 void CPartyModeManager::Add(CFileItemPtr &pItem)
 395 {
 396   PLAYLIST::CPlayList& playlist = CServiceBroker::GetPlaylistPlayer().GetPlaylist(GetPlaylistId());
 397   playlist.Add(pItem);
 398   CLog::Log(LOGINFO, "PARTY MODE MANAGER: Adding randomly selected song at {}:[{}]",
 399             playlist.size() - 1, pItem->GetPath());
 400   m_iMatchingSongsPicked++;
 401 }
 402
 403 bool CPartyModeManager::ReapSongs()
 404 {
 405   const PLAYLIST::Id playlistId = GetPlaylistId();
 406
 407   // reap any played songs
 408   int iCurrentSong = CServiceBroker::GetPlaylistPlayer().GetCurrentSong();
 409   int i=0;
 410   while (i < CServiceBroker::GetPlaylistPlayer().GetPlaylist(playlistId).size())
 411   {
 412     if (i < iCurrentSong)
 413     {
 414       CServiceBroker::GetPlaylistPlayer().GetPlaylist(playlistId).Remove(i);
 415       iCurrentSong--;
 416       if (i <= m_iLastUserSong)
 417         m_iLastUserSong--;
 418     }
 419     else
 420       i++;
 421   }
 422
 423   CServiceBroker::GetPlaylistPlayer().SetCurrentSong(iCurrentSong);
 424   return true;
 425 }
 426
 427 bool CPartyModeManager::MovePlaying()
 428 {
 429   // move current song to the top if its not there
 430   int iCurrentSong = CServiceBroker::GetPlaylistPlayer().GetCurrentSong();
 431
 432   if (iCurrentSong > 0)
 433   {
 434     CLog::Log(LOGINFO, "PARTY MODE MANAGER: Moving currently playing song from {} to 0",
 435               iCurrentSong);
 436     PLAYLIST::CPlayList& playlist =
 437         CServiceBroker::GetPlaylistPlayer().GetPlaylist(GetPlaylistId());
 438     PLAYLIST::CPlayList playlistTemp;
 439     playlistTemp.Add(playlist[iCurrentSong]);
 440     playlist.Remove(iCurrentSong);
 441     for (int i=0; i<playlist.size(); i++)
 442       playlistTemp.Add(playlist[i]);
 443     playlist.Clear();
 444     for (int i=0; i<playlistTemp.size(); i++)
 445       playlist.Add(playlistTemp[i]);
 446   }
 447   CServiceBroker::GetPlaylistPlayer().SetCurrentSong(0);
 448   return true;
 449 }
 450
 451 void CPartyModeManager::SendUpdateMessage()
 452 {
 453   CGUIMessage msg(GUI_MSG_PLAYLIST_CHANGED, 0, 0);
 454   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 455 }
 456
 457 void CPartyModeManager::Play(int iPos)
 458 {
 459   // Move current song to the top if its not there. Playlist filled up below by
 460   // OnSongChange call from application GUI_MSG_PLAYBACK_STARTED processing
 461   CServiceBroker::GetPlaylistPlayer().Play(iPos, "");
 462   CLog::Log(LOGINFO, "PARTY MODE MANAGER: Playing song at {}", iPos);
 463 }
 464
 465 void CPartyModeManager::OnError(int iError, const std::string&  strLogMessage)
 466 {
 467   // open error dialog
 468   HELPERS::ShowOKDialogLines(CVariant{257}, CVariant{16030}, CVariant{iError}, CVariant{0});
 469   CLog::Log(LOGERROR, "PARTY MODE MANAGER: {}", strLogMessage);
 470   m_bEnabled = false;
 471   SendUpdateMessage();
 472 }
 473
 474 int CPartyModeManager::GetSongsPlayed()
 475 {
 476   if (!IsEnabled())
 477     return -1;
 478   return m_iSongsPlayed;
 479 }
 480
 481 int CPartyModeManager::GetMatchingSongs()
 482 {
 483   if (!IsEnabled())
 484     return -1;
 485   return m_iMatchingSongs;
 486 }
 487
 488 int CPartyModeManager::GetMatchingSongsPicked()
 489 {
 490   if (!IsEnabled())
 491     return -1;
 492   return m_iMatchingSongsPicked;
 493 }
 494
 495 int CPartyModeManager::GetMatchingSongsLeft()
 496 {
 497   if (!IsEnabled())
 498     return -1;
 499   return m_iMatchingSongsLeft;
 500 }
 501
 502 int CPartyModeManager::GetRelaxedSongs()
 503 {
 504   if (!IsEnabled())
 505     return -1;
 506   return m_iRelaxedSongs;
 507 }
 508
 509 int CPartyModeManager::GetRandomSongs()
 510 {
 511   if (!IsEnabled())
 512     return -1;
 513   return m_iRandomSongs;
 514 }
 515
 516 PartyModeContext CPartyModeManager::GetType() const
 517 {
 518   if (!IsEnabled())
 519     return PARTYMODECONTEXT_UNKNOWN;
 520
 521   if (m_bIsVideo)
 522     return PARTYMODECONTEXT_VIDEO;
 523
 524   return PARTYMODECONTEXT_MUSIC;
 525 }
 526
 527 void CPartyModeManager::ClearState()
 528 {
 529   m_iLastUserSong = -1;
 530   m_iSongsPlayed = 0;
 531   m_iMatchingSongs = 0;
 532   m_iMatchingSongsPicked = 0;
 533   m_iMatchingSongsLeft = 0;
 534   m_iRelaxedSongs = 0;
 535   m_iRandomSongs = 0;
 536
 537   m_songIDCache.clear();
 538 }
 539
 540 void CPartyModeManager::UpdateStats()
 541 {
 542   m_iMatchingSongsLeft = m_iMatchingSongs - m_iMatchingSongsPicked;
 543   m_iRandomSongs = m_iMatchingSongsPicked;
 544   m_iRelaxedSongs = 0;  // unsupported at this stage
 545 }
 546
 547 bool CPartyModeManager::IsEnabled(PartyModeContext context /* = PARTYMODECONTEXT_UNKNOWN */) const
 548 {
 549   if (!m_bEnabled) return false;
 550   if (context == PARTYMODECONTEXT_VIDEO)
 551     return m_bIsVideo;
 552   if (context == PARTYMODECONTEXT_MUSIC)
 553     return !m_bIsVideo;
 554   return true; // unknown, but we're enabled
 555 }
 556
 557 void CPartyModeManager::Announce()
 558 {
 559   const auto& components = CServiceBroker::GetAppComponents();
 560   const auto appPlayer = components.GetComponent<CApplicationPlayer>();
 561   if (appPlayer->IsPlaying())
 562   {
 563     CVariant data;
 564
 565     data["player"]["playerid"] = CServiceBroker::GetPlaylistPlayer().GetCurrentPlaylist();
 566     data["property"]["partymode"] = m_bEnabled;
 567     CServiceBroker::GetAnnouncementManager()->Announce(ANNOUNCEMENT::Player, "OnPropertyChanged",
 568                                                        data);
 569   }
 570 }
 571
 572 PLAYLIST::Id CPartyModeManager::GetPlaylistId() const
 573 {
 574   return m_bIsVideo ? PLAYLIST::TYPE_VIDEO : PLAYLIST::TYPE_MUSIC;
 575 }