xbmc/application/ApplicationPlayerCallback.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 "ApplicationPlayerCallback.h"
  10
  11 #include "FileItem.h"
  12 #include "GUIUserMessages.h"
  13 #include "PlayListPlayer.h"
  14 #include "ServiceBroker.h"
  15 #include "URL.h"
  16 #include "application/ApplicationComponents.h"
  17 #include "application/ApplicationPlayer.h"
  18 #include "application/ApplicationStackHelper.h"
  19 #include "guilib/GUIComponent.h"
  20 #include "guilib/GUIMessage.h"
  21 #include "guilib/GUIWindowManager.h"
  22 #include "guilib/StereoscopicsManager.h"
  23 #include "interfaces/AnnouncementManager.h"
  24 #include "interfaces/json-rpc/JSONUtils.h"
  25 #include "interfaces/python/XBPython.h"
  26 #include "profiles/ProfileManager.h"
  27 #include "settings/AdvancedSettings.h"
  28 #include "settings/MediaSettings.h"
  29 #include "settings/SettingsComponent.h"
  30 #include "utils/JobManager.h"
  31 #include "utils/SaveFileStateJob.h"
  32 #include "utils/URIUtils.h"
  33 #include "utils/log.h"
  34 #include "video/VideoDatabase.h"
  35 #include "video/VideoInfoTag.h"
  36
  37 #include <memory>
  38
  39 CApplicationPlayerCallback::CApplicationPlayerCallback()
  40 {
  41 }
  42
  43 void CApplicationPlayerCallback::OnPlayBackEnded()
  44 {
  45   CLog::LogF(LOGDEBUG, "CApplicationPlayerCallback::OnPlayBackEnded");
  46
  47   CGUIMessage msg(GUI_MSG_PLAYBACK_ENDED, 0, 0);
  48   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
  49 }
  50
  51 void CApplicationPlayerCallback::OnPlayBackStarted(const CFileItem& file)
  52 {
  53   CLog::LogF(LOGDEBUG, "CApplication::OnPlayBackStarted");
  54   std::shared_ptr<CFileItem> itemCurrentFile;
  55
  56   // check if VideoPlayer should set file item stream details from its current streams
  57   const bool isBlu_dvd_image_or_stream = (URIUtils::IsBluray(file.GetPath()) || file.IsDVDFile() ||
  58                                           file.IsDiscImage() || file.IsInternetStream());
  59
  60   const bool hasNoStreamDetails =
  61       (!file.HasVideoInfoTag() || !file.GetVideoInfoTag()->HasStreamDetails());
  62
  63   if (file.GetProperty("get_stream_details_from_player").asBoolean() ||
  64       (hasNoStreamDetails && isBlu_dvd_image_or_stream))
  65   {
  66     auto& components = CServiceBroker::GetAppComponents();
  67     const auto appPlayer = components.GetComponent<CApplicationPlayer>();
  68     appPlayer->SetUpdateStreamDetails();
  69   }
  70
  71   auto& components = CServiceBroker::GetAppComponents();
  72   const auto stackHelper = components.GetComponent<CApplicationStackHelper>();
  73
  74   if (stackHelper->IsPlayingISOStack() || stackHelper->IsPlayingRegularStack())
  75     itemCurrentFile = std::make_shared<CFileItem>(*stackHelper->GetRegisteredStack(file));
  76   else
  77     itemCurrentFile = std::make_shared<CFileItem>(file);
  78
  79   /* When playing video pause any low priority jobs, they will be unpaused  when playback stops.
  80    * This should speed up player startup for files on internet filesystems (eg. webdav) and
  81    * increase performance on low powered systems (Atom/ARM).
  82    */
  83   if (file.IsVideo() || file.IsGame())
  84   {
  85     CServiceBroker::GetJobManager()->PauseJobs();
  86   }
  87
  88   stackHelper->OnPlayBackStarted(file);
  89
  90   CGUIMessage msg(GUI_MSG_PLAYBACK_STARTED, 0, 0, 0, 0, itemCurrentFile);
  91   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
  92 }
  93
  94 void CApplicationPlayerCallback::OnPlayerCloseFile(const CFileItem& file,
  95                                                    const CBookmark& bookmarkParam)
  96 {
  97   auto& components = CServiceBroker::GetAppComponents();
  98   const auto stackHelper = components.GetComponent<CApplicationStackHelper>();
  99
 100   std::unique_lock<CCriticalSection> lock(stackHelper->m_critSection);
 101
 102   CFileItem fileItem(file);
 103   CBookmark bookmark = bookmarkParam;
 104   CBookmark resumeBookmark;
 105   bool playCountUpdate = false;
 106   float percent = 0.0f;
 107
 108   // Make sure we don't reset existing bookmark etc. on eg. player start failure
 109   if (bookmark.timeInSeconds == 0.0)
 110     return;
 111
 112   if (stackHelper->GetRegisteredStack(fileItem) != nullptr &&
 113       stackHelper->GetRegisteredStackTotalTimeMs(fileItem) > 0)
 114   {
 115     // regular stack case: we have to save the bookmark on the stack
 116     fileItem = *stackHelper->GetRegisteredStack(file);
 117     // the bookmark coming from the player is only relative to the current part, thus needs to be corrected with these attributes (start time will be 0 for non-stackparts)
 118     bookmark.timeInSeconds += stackHelper->GetRegisteredStackPartStartTimeMs(file) / 1000.0;
 119     if (stackHelper->GetRegisteredStackTotalTimeMs(file) > 0)
 120       bookmark.totalTimeInSeconds = stackHelper->GetRegisteredStackTotalTimeMs(file) / 1000.0;
 121     bookmark.partNumber = stackHelper->GetRegisteredStackPartNumber(file);
 122   }
 123
 124   percent = bookmark.timeInSeconds / bookmark.totalTimeInSeconds * 100;
 125
 126   const std::shared_ptr<CAdvancedSettings> advancedSettings =
 127       CServiceBroker::GetSettingsComponent()->GetAdvancedSettings();
 128
 129   if ((fileItem.IsAudio() && advancedSettings->m_audioPlayCountMinimumPercent > 0 &&
 130        percent >= advancedSettings->m_audioPlayCountMinimumPercent) ||
 131       (fileItem.IsVideo() && advancedSettings->m_videoPlayCountMinimumPercent > 0 &&
 132        percent >= advancedSettings->m_videoPlayCountMinimumPercent))
 133   {
 134     playCountUpdate = true;
 135   }
 136
 137   if (advancedSettings->m_videoIgnorePercentAtEnd > 0 &&
 138       bookmark.totalTimeInSeconds - bookmark.timeInSeconds <
 139           0.01 * static_cast<double>(advancedSettings->m_videoIgnorePercentAtEnd) *
 140               bookmark.totalTimeInSeconds)
 141   {
 142     resumeBookmark.timeInSeconds = -1.0;
 143   }
 144   else if (bookmark.timeInSeconds > advancedSettings->m_videoIgnoreSecondsAtStart)
 145   {
 146     resumeBookmark = bookmark;
 147     if (stackHelper->GetRegisteredStack(file) != nullptr)
 148     {
 149       // also update video info tag with total time
 150       fileItem.GetVideoInfoTag()->m_streamDetails.SetVideoDuration(
 151           0, resumeBookmark.totalTimeInSeconds);
 152     }
 153   }
 154   else
 155   {
 156     resumeBookmark.timeInSeconds = 0.0;
 157   }
 158
 159   if (CServiceBroker::GetSettingsComponent()
 160           ->GetProfileManager()
 161           ->GetCurrentProfile()
 162           .canWriteDatabases())
 163   {
 164     CSaveFileState::DoWork(fileItem, resumeBookmark, playCountUpdate);
 165   }
 166 }
 167
 168 void CApplicationPlayerCallback::OnPlayBackPaused()
 169 {
 170 #ifdef HAS_PYTHON
 171   CServiceBroker::GetXBPython().OnPlayBackPaused();
 172 #endif
 173
 174   CGUIMessage msg(GUI_MSG_PLAYBACK_PAUSED, 0, 0);
 175   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 176 }
 177
 178 void CApplicationPlayerCallback::OnPlayBackResumed()
 179 {
 180 #ifdef HAS_PYTHON
 181   CServiceBroker::GetXBPython().OnPlayBackResumed();
 182 #endif
 183
 184   CGUIMessage msg(GUI_MSG_PLAYBACK_RESUMED, 0, 0);
 185   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 186 }
 187
 188 void CApplicationPlayerCallback::OnPlayBackStopped()
 189 {
 190   CLog::LogF(LOGDEBUG, "CApplication::OnPlayBackStopped");
 191
 192   CGUIMessage msg(GUI_MSG_PLAYBACK_STOPPED, 0, 0);
 193   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 194 }
 195
 196 void CApplicationPlayerCallback::OnPlayBackError()
 197 {
 198   //@todo Playlists can be continued by calling OnPlaybackEnded instead
 199   // open error dialog
 200   CGUIMessage msg(GUI_MSG_PLAYBACK_ERROR, 0, 0);
 201   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 202   OnPlayBackStopped();
 203 }
 204
 205 void CApplicationPlayerCallback::OnQueueNextItem()
 206 {
 207   CLog::LogF(LOGDEBUG, "CApplication::OnQueueNextItem");
 208
 209   // informs python script currently running that we are requesting the next track
 210   // (does nothing if python is not loaded)
 211 #ifdef HAS_PYTHON
 212   CServiceBroker::GetXBPython().OnQueueNextItem(); // currently unimplemented
 213 #endif
 214
 215   CGUIMessage msg(GUI_MSG_QUEUE_NEXT_ITEM, 0, 0);
 216   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 217 }
 218
 219 void CApplicationPlayerCallback::OnPlayBackSeek(int64_t iTime, int64_t seekOffset)
 220 {
 221 #ifdef HAS_PYTHON
 222   CServiceBroker::GetXBPython().OnPlayBackSeek(static_cast<int>(iTime),
 223                                                static_cast<int>(seekOffset));
 224 #endif
 225
 226   CGUIMessage msg(GUI_MSG_PLAYBACK_SEEKED, 0, 0, iTime, seekOffset);
 227   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 228 }
 229
 230 void CApplicationPlayerCallback::OnPlayBackSeekChapter(int iChapter)
 231 {
 232 #ifdef HAS_PYTHON
 233   CServiceBroker::GetXBPython().OnPlayBackSeekChapter(iChapter);
 234 #endif
 235 }
 236
 237 void CApplicationPlayerCallback::OnPlayBackSpeedChanged(int iSpeed)
 238 {
 239 #ifdef HAS_PYTHON
 240   CServiceBroker::GetXBPython().OnPlayBackSpeedChanged(iSpeed);
 241 #endif
 242
 243   CGUIMessage msg(GUI_MSG_PLAYBACK_SPEED_CHANGED, 0, 0, iSpeed);
 244   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 245 }
 246
 247 void CApplicationPlayerCallback::OnAVChange()
 248 {
 249   CLog::LogF(LOGDEBUG, "CApplication::OnAVChange");
 250
 251   CServiceBroker::GetGUI()->GetStereoscopicsManager().OnStreamChange();
 252
 253   CGUIMessage msg(GUI_MSG_PLAYBACK_AVCHANGE, 0, 0);
 254   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 255 }
 256
 257 void CApplicationPlayerCallback::OnAVStarted(const CFileItem& file)
 258 {
 259   CLog::LogF(LOGDEBUG, "CApplication::OnAVStarted");
 260
 261   CGUIMessage msg(GUI_MSG_PLAYBACK_AVSTARTED, 0, 0);
 262   CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
 263 }
 264
 265 void CApplicationPlayerCallback::RequestVideoSettings(const CFileItem& fileItem)
 266 {
 267   CVideoDatabase dbs;
 268   if (dbs.Open())
 269   {
 270     CLog::Log(LOGDEBUG, "Loading settings for {}", CURL::GetRedacted(fileItem.GetPath()));
 271
 272     // Load stored settings if they exist, otherwise use default
 273     CVideoSettings vs;
 274     if (!dbs.GetVideoSettings(fileItem, vs))
 275       vs = CMediaSettings::GetInstance().GetDefaultVideoSettings();
 276
 277     auto& components = CServiceBroker::GetAppComponents();
 278     const auto appPlayer = components.GetComponent<CApplicationPlayer>();
 279     appPlayer->SetVideoSettings(vs);
 280
 281     dbs.Close();
 282   }
 283 }
 284
 285 void CApplicationPlayerCallback::StoreVideoSettings(const CFileItem& fileItem,
 286                                                     const CVideoSettings& vs)
 287 {
 288   CVideoDatabase dbs;
 289   if (dbs.Open())
 290   {
 291     if (vs != CMediaSettings::GetInstance().GetDefaultVideoSettings())
 292     {
 293       dbs.SetVideoSettings(fileItem, vs);
 294     }
 295     else
 296     {
 297       dbs.EraseVideoSettings(fileItem);
 298     }
 299     dbs.Close();
 300   }
 301 }