diff options
Diffstat (limited to 'src/PartyModeManager.cpp')
| -rw-r--r-- | src/PartyModeManager.cpp | 712 |
1 files changed, 712 insertions, 0 deletions
diff --git a/src/PartyModeManager.cpp b/src/PartyModeManager.cpp new file mode 100644 index 0000000000..5348c74227 --- /dev/null +++ b/src/PartyModeManager.cpp @@ -0,0 +1,712 @@ +/* + * Copyright (C) 2005-2013 Team XBMC + * http://xbmc.org + * + * This Program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2, or (at your option) + * any later version. + * + * This Program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with XBMC; see the file COPYING. If not, see + * <http://www.gnu.org/licenses/>. + * + */ + +#include "threads/SystemClock.h" +#include "PartyModeManager.h" +#include "PlayListPlayer.h" +#include "music/MusicDatabase.h" +#include "music/windows/GUIWindowMusicPlaylist.h" +#include "video/VideoDatabase.h" +#include "playlists/SmartPlayList.h" +#include "profiles/ProfilesManager.h" +#include "dialogs/GUIDialogProgress.h" +#include "GUIUserMessages.h" +#include "guilib/GUIWindowManager.h" +#include "dialogs/GUIDialogOK.h" +#include "playlists/PlayList.h" +#include "utils/TimeUtils.h" +#include "utils/log.h" +#include "utils/StringUtils.h" +#include "Application.h" +#include "interfaces/AnnouncementManager.h" + +using namespace std; +using namespace PLAYLIST; + +#define QUEUE_DEPTH 10 + +CPartyModeManager::CPartyModeManager(void) +{ + m_bIsVideo = false; + m_bEnabled = false; + m_strCurrentFilterMusic.clear(); + m_strCurrentFilterVideo.clear(); + ClearState(); +} + +CPartyModeManager::~CPartyModeManager(void) +{ +} + +bool CPartyModeManager::Enable(PartyModeContext context /*= PARTYMODECONTEXT_MUSIC*/, const CStdString& strXspPath /*= ""*/) +{ + // Filter using our PartyMode xml file + CSmartPlaylist playlist; + CStdString partyModePath; + bool playlistLoaded; + + m_bIsVideo = context == PARTYMODECONTEXT_VIDEO; + if (!strXspPath.empty()) //if a path to a smartplaylist is supplied use it + partyModePath = strXspPath; + else if (m_bIsVideo) + partyModePath = CProfilesManager::Get().GetUserDataItem("PartyMode-Video.xsp"); + else + partyModePath = CProfilesManager::Get().GetUserDataItem("PartyMode.xsp"); + + playlistLoaded=playlist.Load(partyModePath); + + if ( playlistLoaded ) + { + m_type = playlist.GetType(); + if (context == PARTYMODECONTEXT_UNKNOWN) + { + //get it from the xsp file + m_bIsVideo = (m_type.Equals("video") || m_type.Equals("musicvideos") || m_type.Equals("mixed")); + } + + if (m_type.Equals("mixed")) + playlist.SetType("songs"); + + if (m_type.Equals("mixed")) + playlist.SetType("video"); + + playlist.SetType(m_type); + } + else + { + m_strCurrentFilterMusic.clear(); + m_strCurrentFilterVideo.clear(); + m_type = m_bIsVideo ? "musicvideos" : "songs"; + } + + CGUIDialogProgress* pDialog = (CGUIDialogProgress*)g_windowManager.GetWindow(WINDOW_DIALOG_PROGRESS); + int iHeading = (m_bIsVideo ? 20250 : 20121); + int iLine0 = (m_bIsVideo ? 20251 : 20123); + pDialog->SetHeading(iHeading); + pDialog->SetLine(0, iLine0); + pDialog->SetLine(1, ""); + pDialog->SetLine(2, ""); + pDialog->StartModal(); + + ClearState(); + unsigned int time = XbmcThreads::SystemClockMillis(); + vector< pair<int,int> > songIDs; + if (m_type.Equals("songs") || m_type.Equals("mixed")) + { + CMusicDatabase db; + if (db.Open()) + { + set<std::string> playlists; + if ( playlistLoaded ) + m_strCurrentFilterMusic = playlist.GetWhereClause(db, playlists); + + CLog::Log(LOGINFO, "PARTY MODE MANAGER: Registering filter:[%s]", m_strCurrentFilterMusic.c_str()); + m_iMatchingSongs = (int)db.GetSongIDs(m_strCurrentFilterMusic, songIDs); + if (m_iMatchingSongs < 1 && m_type.Equals("songs")) + { + pDialog->Close(); + db.Close(); + OnError(16031, (CStdString)"Party mode found no matching songs. Aborting."); + return false; + } + } + else + { + pDialog->Close(); + OnError(16033, (CStdString)"Party mode could not open database. Aborting."); + return false; + } + db.Close(); + } + + if (m_type.Equals("musicvideos") || m_type.Equals("mixed")) + { + vector< pair<int,int> > songIDs2; + CVideoDatabase db; + if (db.Open()) + { + set<std::string> playlists; + if ( playlistLoaded ) + m_strCurrentFilterVideo = playlist.GetWhereClause(db, playlists); + + CLog::Log(LOGINFO, "PARTY MODE MANAGER: Registering filter:[%s]", m_strCurrentFilterVideo.c_str()); + m_iMatchingSongs += (int)db.GetMusicVideoIDs(m_strCurrentFilterVideo, songIDs2); + if (m_iMatchingSongs < 1) + { + pDialog->Close(); + db.Close(); + OnError(16031, (CStdString)"Party mode found no matching songs. Aborting."); + return false; + } + } + else + { + pDialog->Close(); + OnError(16033, (CStdString)"Party mode could not open database. Aborting."); + return false; + } + db.Close(); + songIDs.insert(songIDs.end(),songIDs2.begin(),songIDs2.end()); + } + + // calculate history size + if (m_iMatchingSongs < 50) + m_songsInHistory = 0; + else + m_songsInHistory = (int)(m_iMatchingSongs/2); + if (m_songsInHistory > 200) + m_songsInHistory = 200; + + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Matching songs = %i, History size = %i", m_iMatchingSongs, m_songsInHistory); + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Party mode enabled!"); + + int iPlaylist = m_bIsVideo ? PLAYLIST_VIDEO : PLAYLIST_MUSIC; + + g_playlistPlayer.ClearPlaylist(iPlaylist); + g_playlistPlayer.SetShuffle(iPlaylist, false); + g_playlistPlayer.SetRepeat(iPlaylist, PLAYLIST::REPEAT_NONE); + + pDialog->SetLine(0, (m_bIsVideo ? 20252 : 20124)); + pDialog->Progress(); + // add initial songs + if (!AddInitialSongs(songIDs)) + { + pDialog->Close(); + return false; + } + CLog::Log(LOGDEBUG, "%s time for song fetch: %u", + __FUNCTION__, XbmcThreads::SystemClockMillis() - time); + + // start playing + g_playlistPlayer.SetCurrentPlaylist(iPlaylist); + Play(0); + + pDialog->Close(); + // open now playing window + if (m_type.Equals("songs")) + { + if (g_windowManager.GetActiveWindow() != WINDOW_MUSIC_PLAYLIST) + g_windowManager.ActivateWindow(WINDOW_MUSIC_PLAYLIST); + } + + // done + m_bEnabled = true; + Announce(); + return true; +} + +void CPartyModeManager::Disable() +{ + if (!IsEnabled()) + return; + m_bEnabled = false; + Announce(); + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Party mode disabled."); +} + +void CPartyModeManager::OnSongChange(bool bUpdatePlayed /* = false */) +{ + if (!IsEnabled()) + return; + Process(); + if (bUpdatePlayed) + m_iSongsPlayed++; +} + +void CPartyModeManager::AddUserSongs(CPlayList& tempList, bool bPlay /* = false */) +{ + if (!IsEnabled()) + return; + + // where do we add? + int iAddAt = -1; + if (m_iLastUserSong < 0 || bPlay) + iAddAt = 1; // under the currently playing song + else + iAddAt = m_iLastUserSong + 1; // under the last user added song + + int iNewUserSongs = tempList.size(); + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Adding %i user selected songs at %i", iNewUserSongs, iAddAt); + + int iPlaylist = PLAYLIST_MUSIC; + if (m_bIsVideo) + iPlaylist = PLAYLIST_VIDEO; + g_playlistPlayer.GetPlaylist(iPlaylist).Insert(tempList, iAddAt); + + // update last user added song location + if (m_iLastUserSong < 0) + m_iLastUserSong = 0; + m_iLastUserSong += iNewUserSongs; + + if (bPlay) + Play(1); +} + +void CPartyModeManager::AddUserSongs(CFileItemList& tempList, bool bPlay /* = false */) +{ + if (!IsEnabled()) + return; + + // where do we add? + int iAddAt = -1; + if (m_iLastUserSong < 0 || bPlay) + iAddAt = 1; // under the currently playing song + else + iAddAt = m_iLastUserSong + 1; // under the last user added song + + int iNewUserSongs = tempList.Size(); + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Adding %i user selected songs at %i", iNewUserSongs, iAddAt); + + int iPlaylist = PLAYLIST_MUSIC; + if (m_bIsVideo) + iPlaylist = PLAYLIST_VIDEO; + + g_playlistPlayer.GetPlaylist(iPlaylist).Insert(tempList, iAddAt); + + // update last user added song location + if (m_iLastUserSong < 0) + m_iLastUserSong = 0; + m_iLastUserSong += iNewUserSongs; + + if (bPlay) + Play(1); +} + +void CPartyModeManager::Process() +{ + ReapSongs(); + MovePlaying(); + AddRandomSongs(); + UpdateStats(); + SendUpdateMessage(); +} + +bool CPartyModeManager::AddRandomSongs(int iSongs /* = 0 */) +{ + int iPlaylist = PLAYLIST_MUSIC; + if (m_bIsVideo) + iPlaylist = PLAYLIST_VIDEO; + + CPlayList& playlist = g_playlistPlayer.GetPlaylist(iPlaylist); + int iMissingSongs = QUEUE_DEPTH - playlist.size(); + if (iSongs <= 0) + iSongs = iMissingSongs; + // distribute between types if mixed + int iSongsToAdd=iSongs; + int iVidsToAdd=iSongs; + if (m_type.Equals("mixed")) + { + if (iSongs == 1) + { + if (rand() % 10 < 7) // 70 % chance of grabbing a song + iVidsToAdd = 0; + else + iSongsToAdd = 0; + } + if (iSongs > 1) // grab 70 % songs, 30 % mvids + { + iSongsToAdd = (int).7f*iSongs; + iVidsToAdd = (int).3f*iSongs; + while (iSongsToAdd+iVidsToAdd < iSongs) // correct any rounding by adding songs + iSongsToAdd++; + } + } + + // add songs to fill queue + if (m_type.Equals("songs") || m_type.Equals("mixed")) + { + CMusicDatabase database; + if (database.Open()) + { + // Method: + // 1. Grab a random entry from the database using a where clause + // 2. Iterate on iSongs. + + // Note: At present, this method is faster than the alternative, which is to grab + // all valid songids, then select a random number of them (as done in AddInitialSongs()). + // The reason for this is simply the number of songs we are requesting - we generally + // only want one here. Any more than about 3 songs and it is more efficient + // to use the technique in AddInitialSongs. As it's unlikely that we'll require + // more than 1 song at a time here, this method is faster. + bool error(false); + for (int i = 0; i < iSongsToAdd; i++) + { + pair<CStdString,CStdString> whereClause = GetWhereClauseWithHistory(); + CFileItemPtr item(new CFileItem); + int songID; + if (database.GetRandomSong(item.get(), songID, whereClause.first)) + { // success + Add(item); + AddToHistory(1,songID); + } + else + { + error = true; + break; + } + } + + if (error) + { + database.Close(); + OnError(16034, (CStdString)"Cannot get songs from database. Aborting."); + return false; + } + } + else + { + OnError(16033, (CStdString)"Party mode could not open database. Aborting."); + return false; + } + database.Close(); + } + if (m_type.Equals("musicvideos") || m_type.Equals("mixed")) + { + CVideoDatabase database; + if (database.Open()) + { + // Method: + // 1. Grab a random entry from the database using a where clause + // 2. Iterate on iSongs. + + // Note: At present, this method is faster than the alternative, which is to grab + // all valid songids, then select a random number of them (as done in AddInitialSongs()). + // The reason for this is simply the number of songs we are requesting - we generally + // only want one here. Any more than about 3 songs and it is more efficient + // to use the technique in AddInitialSongs. As it's unlikely that we'll require + // more than 1 song at a time here, this method is faster. + bool error(false); + for (int i = 0; i < iVidsToAdd; i++) + { + pair<CStdString,CStdString> whereClause = GetWhereClauseWithHistory(); + CFileItemPtr item(new CFileItem); + int songID; + if (database.GetRandomMusicVideo(item.get(), songID, whereClause.second)) + { // success + Add(item); + AddToHistory(2,songID); + } + else + { + error = true; + break; + } + } + + if (error) + { + database.Close(); + OnError(16034, (CStdString)"Cannot get songs from database. Aborting."); + return false; + } + } + else + { + OnError(16033, (CStdString)"Party mode could not open database. Aborting."); + return false; + } + database.Close(); + } + return true; +} + +void CPartyModeManager::Add(CFileItemPtr &pItem) +{ + int iPlaylist = m_bIsVideo ? PLAYLIST_VIDEO : PLAYLIST_MUSIC; + if (pItem->HasMusicInfoTag()) + { + CMusicDatabase database; + database.Open(); + database.SetPropertiesForFileItem(*pItem); + } + + CPlayList& playlist = g_playlistPlayer.GetPlaylist(iPlaylist); + playlist.Add(pItem); + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Adding randomly selected song at %i:[%s]", playlist.size() - 1, pItem->GetPath().c_str()); + m_iMatchingSongsPicked++; +} + +bool CPartyModeManager::ReapSongs() +{ + int iPlaylist = m_bIsVideo ? PLAYLIST_VIDEO : PLAYLIST_MUSIC; + + // reap any played songs + int iCurrentSong = g_playlistPlayer.GetCurrentSong(); + int i=0; + while (i < g_playlistPlayer.GetPlaylist(iPlaylist).size()) + { + if (i < iCurrentSong) + { + g_playlistPlayer.GetPlaylist(iPlaylist).Remove(i); + iCurrentSong--; + if (i <= m_iLastUserSong) + m_iLastUserSong--; + } + else + i++; + } + + g_playlistPlayer.SetCurrentSong(iCurrentSong); + return true; +} + +bool CPartyModeManager::MovePlaying() +{ + // move current song to the top if its not there + int iCurrentSong = g_playlistPlayer.GetCurrentSong(); + int iPlaylist = m_bIsVideo ? PLAYLIST_MUSIC : PLAYLIST_VIDEO; + + if (iCurrentSong > 0) + { + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Moving currently playing song from %i to 0", iCurrentSong); + CPlayList &playlist = g_playlistPlayer.GetPlaylist(iPlaylist); + CPlayList playlistTemp; + playlistTemp.Add(playlist[iCurrentSong]); + playlist.Remove(iCurrentSong); + for (int i=0; i<playlist.size(); i++) + playlistTemp.Add(playlist[i]); + playlist.Clear(); + for (int i=0; i<playlistTemp.size(); i++) + playlist.Add(playlistTemp[i]); + } + g_playlistPlayer.SetCurrentSong(0); + return true; +} + +void CPartyModeManager::SendUpdateMessage() +{ + CGUIMessage msg(GUI_MSG_PLAYLIST_CHANGED, 0, 0); + g_windowManager.SendThreadMessage(msg); +} + +void CPartyModeManager::Play(int iPos) +{ + // move current song to the top if its not there + g_playlistPlayer.Play(iPos); + CLog::Log(LOGINFO,"PARTY MODE MANAGER: Playing song at %i", iPos); + Process(); +} + +void CPartyModeManager::OnError(int iError, const CStdString& strLogMessage) +{ + // open error dialog + CGUIDialogOK::ShowAndGetInput(257, 16030, iError, 0); + CLog::Log(LOGERROR, "PARTY MODE MANAGER: %s", strLogMessage.c_str()); + m_bEnabled = false; + SendUpdateMessage(); +} + +int CPartyModeManager::GetSongsPlayed() +{ + if (!IsEnabled()) + return -1; + return m_iSongsPlayed; +} + +int CPartyModeManager::GetMatchingSongs() +{ + if (!IsEnabled()) + return -1; + return m_iMatchingSongs; +} + +int CPartyModeManager::GetMatchingSongsPicked() +{ + if (!IsEnabled()) + return -1; + return m_iMatchingSongsPicked; +} + +int CPartyModeManager::GetMatchingSongsLeft() +{ + if (!IsEnabled()) + return -1; + return m_iMatchingSongsLeft; +} + +int CPartyModeManager::GetRelaxedSongs() +{ + if (!IsEnabled()) + return -1; + return m_iRelaxedSongs; +} + +int CPartyModeManager::GetRandomSongs() +{ + if (!IsEnabled()) + return -1; + return m_iRandomSongs; +} + +PartyModeContext CPartyModeManager::GetType() const +{ + if (!IsEnabled()) + return PARTYMODECONTEXT_UNKNOWN; + + if (m_bIsVideo) + return PARTYMODECONTEXT_VIDEO; + + return PARTYMODECONTEXT_MUSIC; +} + +void CPartyModeManager::ClearState() +{ + m_iLastUserSong = -1; + m_iSongsPlayed = 0; + m_iMatchingSongs = 0; + m_iMatchingSongsPicked = 0; + m_iMatchingSongsLeft = 0; + m_iRelaxedSongs = 0; + m_iRandomSongs = 0; + + m_songsInHistory = 0; + m_history.clear(); +} + +void CPartyModeManager::UpdateStats() +{ + m_iMatchingSongsLeft = m_iMatchingSongs - m_iMatchingSongsPicked; + m_iRandomSongs = m_iMatchingSongsPicked; + m_iRelaxedSongs = 0; // unsupported at this stage +} + +bool CPartyModeManager::AddInitialSongs(vector<pair<int,int> > &songIDs) +{ + int iPlaylist = m_bIsVideo ? PLAYLIST_VIDEO : PLAYLIST_MUSIC; + + CPlayList& playlist = g_playlistPlayer.GetPlaylist(iPlaylist); + int iMissingSongs = QUEUE_DEPTH - playlist.size(); + if (iMissingSongs > 0) + { + // generate iMissingSongs random ids from songIDs + if (iMissingSongs > (int)songIDs.size()) + return false; // can't do it if we have less songs than we need + + vector<pair<int,int> > chosenSongIDs; + GetRandomSelection(songIDs, iMissingSongs, chosenSongIDs); + CStdString sqlWhereMusic = "songview.idSong IN ("; + CStdString sqlWhereVideo = "idMVideo IN ("; + + for (vector< pair<int,int> >::iterator it = chosenSongIDs.begin(); it != chosenSongIDs.end(); it++) + { + CStdString song = StringUtils::Format("%i,", it->second); + if (it->first == 1) + sqlWhereMusic += song; + if (it->first == 2) + sqlWhereVideo += song; + } + // add songs to fill queue + CFileItemList items; + + if (sqlWhereMusic.size() > 26) + { + sqlWhereMusic[sqlWhereMusic.size() - 1] = ')'; // replace the last comma with closing bracket + CMusicDatabase database; + database.Open(); + database.GetSongsByWhere("musicdb://songs/", sqlWhereMusic, items); + } + if (sqlWhereVideo.size() > 19) + { + sqlWhereVideo[sqlWhereVideo.size() - 1] = ')'; // replace the last comma with closing bracket + CVideoDatabase database; + database.Open(); + database.GetMusicVideosByWhere("videodb://musicvideos/titles/", sqlWhereVideo, items); + } + + m_history = chosenSongIDs; + items.Randomize(); //randomizing the initial list or they will be in database order + for (int i = 0; i < items.Size(); i++) + { + CFileItemPtr item(items[i]); + Add(item); + // TODO: Allow "relaxed restrictions" later? + } + } + return true; +} + +pair<CStdString,CStdString> CPartyModeManager::GetWhereClauseWithHistory() const +{ + // now add this on to the normal where clause + std::vector<std::string> historyItemsMusic; + std::vector<std::string> historyItemsVideo; + for (unsigned int i = 0; i < m_history.size(); i++) + { + std::string number = StringUtils::Format("%i", m_history[i].second); + if (m_history[i].first == 1) + historyItemsMusic.push_back(number); + if (m_history[i].first == 2) + historyItemsVideo.push_back(number); + } + + std::string historyWhereMusic; + if (!historyItemsMusic.empty()) + { + if (!m_strCurrentFilterMusic.empty()) + historyWhereMusic = m_strCurrentFilterMusic + " and "; + historyWhereMusic += "songview.idSong not in (" + StringUtils::Join(historyItemsMusic, ", ") + ")"; + } + + std::string historyWhereVideo; + if (!historyItemsVideo.empty()) + { + if (!m_strCurrentFilterVideo.empty()) + historyWhereVideo = m_strCurrentFilterVideo + " and "; + historyWhereVideo += "idMVideo not in (" + StringUtils::Join(historyItemsVideo, ", ") + ")"; + } + + return make_pair(historyWhereMusic, historyWhereVideo); +} + +void CPartyModeManager::AddToHistory(int type, int songID) +{ + while (m_history.size() >= m_songsInHistory && m_songsInHistory) + m_history.erase(m_history.begin()); + m_history.push_back(make_pair(type,songID)); +} + +void CPartyModeManager::GetRandomSelection(vector< pair<int,int> >& in, unsigned int number, vector< pair<int,int> >& out) +{ + number = min(number, (unsigned int)in.size()); + random_shuffle(in.begin(), in.end()); + out.assign(in.begin(), in.begin() + number); +} + +bool CPartyModeManager::IsEnabled(PartyModeContext context /* = PARTYMODECONTEXT_UNKNOWN */) const +{ + if (!m_bEnabled) return false; + if (context == PARTYMODECONTEXT_VIDEO) + return m_bIsVideo; + if (context == PARTYMODECONTEXT_MUSIC) + return !m_bIsVideo; + return true; // unknown, but we're enabled +} + +void CPartyModeManager::Announce() +{ + if (g_application.m_pPlayer->IsPlaying()) + { + CVariant data; + + data["player"]["playerid"] = g_playlistPlayer.GetCurrentPlaylist(); + data["property"]["partymode"] = m_bEnabled; + ANNOUNCEMENT::CAnnouncementManager::Get().Announce(ANNOUNCEMENT::Player, "xbmc", "OnPropertyChanged", data); + } +} |