xbmc/video/dialogs/GUIDialogVideoBookmarks.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 "GUIDialogVideoBookmarks.h"
  10
  11 #include "FileItem.h"
  12 #include "FileItemList.h"
  13 #include "ServiceBroker.h"
  14 #include "Util.h"
  15 #include "application/Application.h"
  16 #include "application/ApplicationComponents.h"
  17 #include "application/ApplicationPlayer.h"
  18 #include "dialogs/GUIDialogContextMenu.h"
  19 #include "dialogs/GUIDialogKaiToast.h"
  20 #include "guilib/GUIComponent.h"
  21 #include "guilib/GUIWindowManager.h"
  22 #include "guilib/LocalizeStrings.h"
  23 #include "imagefiles/ImageFileURL.h"
  24 #include "input/actions/Action.h"
  25 #include "input/actions/ActionIDs.h"
  26 #include "messaging/ApplicationMessenger.h"
  27 #include "pictures/Picture.h"
  28 #include "profiles/ProfileManager.h"
  29 #include "settings/AdvancedSettings.h"
  30 #include "settings/Settings.h"
  31 #include "settings/SettingsComponent.h"
  32 #include "utils/Crc32.h"
  33 #include "utils/FileUtils.h"
  34 #include "utils/StringUtils.h"
  35 #include "utils/URIUtils.h"
  36 #include "utils/Variant.h"
  37 #include "utils/log.h"
  38 #include "video/VideoDatabase.h"
  39 #include "video/VideoFileItemClassify.h"
  40 #include "view/ViewState.h"
  41
  42 #include <algorithm>
  43 #include <mutex>
  44 #include <string>
  45 #include <vector>
  46
  47 #define CONTROL_ADD_BOOKMARK           2
  48 #define CONTROL_CLEAR_BOOKMARKS        3
  49 #define CONTROL_ADD_EPISODE_BOOKMARK   4
  50
  51 #define CONTROL_THUMBS                11
  52
  53 using namespace KODI::VIDEO;
  54
  55 CGUIDialogVideoBookmarks::CGUIDialogVideoBookmarks()
  56   : CGUIDialog(WINDOW_DIALOG_VIDEO_BOOKMARKS, "VideoOSDBookmarks.xml")
  57 {
  58   m_vecItems = new CFileItemList;
  59   m_loadType = LOAD_EVERY_TIME;
  60 }
  61
  62 CGUIDialogVideoBookmarks::~CGUIDialogVideoBookmarks()
  63 {
  64   delete m_vecItems;
  65 }
  66
  67 bool CGUIDialogVideoBookmarks::OnMessage(CGUIMessage& message)
  68 {
  69   switch ( message.GetMessage() )
  70   {
  71   case GUI_MSG_WINDOW_DEINIT:
  72     {
  73       CUtil::DeleteVideoDatabaseDirectoryCache();
  74       Clear();
  75     }
  76     break;
  77
  78   case GUI_MSG_WINDOW_INIT:
  79     {
  80       // don't init this dialog if we don't playback a file
  81       const auto& components = CServiceBroker::GetAppComponents();
  82       const auto appPlayer = components.GetComponent<CApplicationPlayer>();
  83       if (!appPlayer->IsPlaying())
  84         return false;
  85
  86       CGUIWindow::OnMessage(message);
  87       Update();
  88       return true;
  89     }
  90     break;
  91
  92   case GUI_MSG_CLICKED:
  93     {
  94       int iControl = message.GetSenderId();
  95       if (iControl == CONTROL_ADD_BOOKMARK)
  96       {
  97         AddBookmark();
  98         Update();
  99       }
 100       else if (iControl == CONTROL_CLEAR_BOOKMARKS)
 101       {
 102         ClearBookmarks();
 103       }
 104       else if (iControl == CONTROL_ADD_EPISODE_BOOKMARK)
 105       {
 106         AddEpisodeBookmark();
 107         Update();
 108       }
 109       else if (m_viewControl.HasControl(iControl))  // list/thumb control
 110       {
 111         int iItem = m_viewControl.GetSelectedItem();
 112         int iAction = message.GetParam1();
 113         if (iAction == ACTION_DELETE_ITEM)
 114         {
 115           Delete(iItem);
 116         }
 117         else if (iAction == ACTION_SELECT_ITEM || iAction == ACTION_MOUSE_LEFT_CLICK)
 118         {
 119           GotoBookmark(iItem);
 120         }
 121       }
 122     }
 123     break;
 124   case GUI_MSG_SETFOCUS:
 125     {
 126       if (m_viewControl.HasControl(message.GetControlId()) && m_viewControl.GetCurrentControl() != message.GetControlId())
 127       {
 128         m_viewControl.SetFocused();
 129         return true;
 130       }
 131     }
 132     break;
 133   case GUI_MSG_REFRESH_LIST:
 134     {
 135       switch (message.GetParam1())
 136       {
 137       case 0:
 138         OnRefreshList();
 139         break;
 140       default:
 141         break;
 142       }
 143     }
 144     break;
 145   }
 146
 147   return CGUIDialog::OnMessage(message);
 148 }
 149
 150 bool CGUIDialogVideoBookmarks::OnAction(const CAction &action)
 151 {
 152   switch(action.GetID())
 153   {
 154   case ACTION_CONTEXT_MENU:
 155   case ACTION_MOUSE_RIGHT_CLICK:
 156     {
 157       OnPopupMenu(m_viewControl.GetSelectedItem());
 158       return true;
 159     }
 160   }
 161   return CGUIDialog::OnAction(action);
 162 }
 163
 164
 165 void CGUIDialogVideoBookmarks::OnPopupMenu(int item)
 166 {
 167   if (item < 0 || item >= (int) m_bookmarks.size())
 168     return;
 169
 170   // highlight the item
 171   (*m_vecItems)[item]->Select(true);
 172
 173   CContextButtons choices;
 174   choices.Add(1, (m_bookmarks[item].type == CBookmark::EPISODE ? 20405 : 20404)); // "Remove episode bookmark" or "Remove bookmark"
 175
 176   int button = CGUIDialogContextMenu::ShowAndGetChoice(choices);
 177
 178   // unhighlight the item
 179   (*m_vecItems)[item]->Select(false);
 180
 181   if (button == 1)
 182     Delete(item);
 183 }
 184
 185 void CGUIDialogVideoBookmarks::Delete(int item)
 186 {
 187   if ( item>=0 && (unsigned)item < m_bookmarks.size() )
 188   {
 189     CVideoDatabase videoDatabase;
 190     videoDatabase.Open();
 191     const std::string path{g_application.CurrentFileItem().GetDynPath()};
 192     videoDatabase.ClearBookMarkOfFile(path, m_bookmarks[item], m_bookmarks[item].type);
 193     videoDatabase.Close();
 194     CUtil::DeleteVideoDatabaseDirectoryCache();
 195   }
 196   Update();
 197 }
 198
 199 void CGUIDialogVideoBookmarks::OnRefreshList()
 200 {
 201   m_bookmarks.clear();
 202   std::vector<CFileItemPtr> items;
 203
 204   // open the d/b and retrieve the bookmarks for the current movie
 205   m_filePath = g_application.CurrentFileItem().GetDynPath();
 206
 207   CVideoDatabase videoDatabase;
 208   videoDatabase.Open();
 209   videoDatabase.GetBookMarksForFile(m_filePath, m_bookmarks);
 210   videoDatabase.GetBookMarksForFile(m_filePath, m_bookmarks, CBookmark::EPISODE, true);
 211   videoDatabase.Close();
 212
 213   std::unique_lock<CCriticalSection> lock(m_refreshSection);
 214   m_vecItems->Clear();
 215
 216   // cycle through each stored bookmark and add it to our list control
 217   for (unsigned int i = 0; i < m_bookmarks.size(); ++i)
 218   {
 219     std::string bookmarkTime;
 220     if (m_bookmarks[i].type == CBookmark::EPISODE)
 221       bookmarkTime = StringUtils::Format("{} {} {} {}", g_localizeStrings.Get(20373),
 222                                          m_bookmarks[i].seasonNumber, g_localizeStrings.Get(20359),
 223                                          m_bookmarks[i].episodeNumber);
 224     else
 225       bookmarkTime = StringUtils::SecondsToTimeString((long)m_bookmarks[i].timeInSeconds, TIME_FORMAT_HH_MM_SS);
 226
 227     CFileItemPtr item(new CFileItem(StringUtils::Format(g_localizeStrings.Get(299), i + 1)));
 228     item->SetLabel2(bookmarkTime);
 229     item->SetArt("thumb", m_bookmarks[i].thumbNailImage);
 230     item->SetProperty("resumepoint", m_bookmarks[i].timeInSeconds);
 231     item->SetProperty("playerstate", m_bookmarks[i].playerState);
 232     item->SetProperty("isbookmark", "true");
 233     items.push_back(item);
 234   }
 235
 236   // add chapters if around
 237   const auto& components = CServiceBroker::GetAppComponents();
 238   const auto appPlayer = components.GetComponent<CApplicationPlayer>();
 239   for (int i = 1; i <= appPlayer->GetChapterCount(); ++i)
 240   {
 241     std::string chapterName;
 242     appPlayer->GetChapterName(chapterName, i);
 243
 244     int64_t pos = appPlayer->GetChapterPos(i);
 245     std::string time = StringUtils::SecondsToTimeString((long) pos, TIME_FORMAT_HH_MM_SS);
 246
 247     if (chapterName.empty() ||
 248         StringUtils::StartsWithNoCase(chapterName, time) ||
 249         StringUtils::IsNaturalNumber(chapterName))
 250       chapterName = StringUtils::Format(g_localizeStrings.Get(25010), i);
 251
 252     CFileItemPtr item(new CFileItem(chapterName));
 253     item->SetLabel2(time);
 254
 255     if (CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(
 256             CSettings::SETTING_MYVIDEOS_EXTRACTCHAPTERTHUMBS))
 257     {
 258       auto chapterPath = IMAGE_FILES::CImageFileURL::FromFile(m_filePath, "video");
 259       chapterPath.AddOption("chapter", std::to_string(i));
 260       item->SetArt("thumb", chapterPath.ToCacheKey());
 261     }
 262
 263     item->SetProperty("chapter", i);
 264     item->SetProperty("resumepoint", static_cast<double>(pos));
 265     item->SetProperty("ischapter", "true");
 266     items.push_back(item);
 267   }
 268
 269   // sort items by resume point
 270   std::sort(items.begin(), items.end(), [](const CFileItemPtr &item1, const CFileItemPtr &item2) {
 271     return item1->GetProperty("resumepoint").asDouble() < item2->GetProperty("resumepoint").asDouble();
 272   });
 273
 274   // add items to file list and mark the proper item as selected if the current playtime is above
 275   int selectedItemIndex = 0;
 276   double playTime = g_application.GetTime();
 277   for (auto& item : items)
 278   {
 279     m_vecItems->Add(item);
 280     if (playTime >= item->GetProperty("resumepoint").asDouble())
 281       selectedItemIndex = m_vecItems->Size() - 1;
 282   }
 283
 284   m_viewControl.SetItems(*m_vecItems);
 285   m_viewControl.SetSelectedItem(selectedItemIndex);
 286 }
 287
 288 void CGUIDialogVideoBookmarks::Update()
 289 {
 290   CVideoDatabase videoDatabase;
 291   videoDatabase.Open();
 292
 293   if (g_application.CurrentFileItem().HasVideoInfoTag() && g_application.CurrentFileItem().GetVideoInfoTag()->m_iEpisode > -1)
 294   {
 295     std::vector<CVideoInfoTag> episodes;
 296     videoDatabase.GetEpisodesByFile(g_application.CurrentFile(),episodes);
 297     if (episodes.size() > 1)
 298     {
 299       CONTROL_ENABLE(CONTROL_ADD_EPISODE_BOOKMARK);
 300     }
 301     else
 302     {
 303       CONTROL_DISABLE(CONTROL_ADD_EPISODE_BOOKMARK);
 304     }
 305   }
 306   else
 307   {
 308     CONTROL_DISABLE(CONTROL_ADD_EPISODE_BOOKMARK);
 309   }
 310
 311
 312   m_viewControl.SetCurrentView(DEFAULT_VIEW_ICONS);
 313
 314   // empty the list ready for population
 315   Clear();
 316
 317   OnRefreshList();
 318
 319   videoDatabase.Close();
 320 }
 321
 322 void CGUIDialogVideoBookmarks::Clear()
 323 {
 324   m_viewControl.Clear();
 325   m_vecItems->Clear();
 326 }
 327
 328 void CGUIDialogVideoBookmarks::GotoBookmark(int item)
 329 {
 330   auto& components = CServiceBroker::GetAppComponents();
 331   const auto appPlayer = components.GetComponent<CApplicationPlayer>();
 332   if (item < 0 || item >= m_vecItems->Size() || !appPlayer->HasPlayer())
 333     return;
 334
 335   CFileItemPtr fileItem = m_vecItems->Get(item);
 336   int chapter = static_cast<int>(fileItem->GetProperty("chapter").asInteger());
 337   if (chapter <= 0)
 338   {
 339     appPlayer->SetPlayerState(fileItem->GetProperty("playerstate").asString());
 340     g_application.SeekTime(fileItem->GetProperty("resumepoint").asDouble());
 341   }
 342   else
 343     appPlayer->SeekChapter(chapter);
 344
 345   Close();
 346 }
 347
 348 void CGUIDialogVideoBookmarks::ClearBookmarks()
 349 {
 350   CVideoDatabase videoDatabase;
 351   videoDatabase.Open();
 352   const std::string path{g_application.CurrentFileItem().GetDynPath()};
 353   videoDatabase.ClearBookMarksOfFile(path, CBookmark::STANDARD);
 354   videoDatabase.ClearBookMarksOfFile(path, CBookmark::RESUME);
 355   videoDatabase.ClearBookMarksOfFile(path, CBookmark::EPISODE);
 356   videoDatabase.Close();
 357   Update();
 358 }
 359
 360 bool CGUIDialogVideoBookmarks::AddBookmark(CVideoInfoTag* tag)
 361 {
 362   CVideoDatabase videoDatabase;
 363   CBookmark bookmark;
 364   bookmark.timeInSeconds = (int)g_application.GetTime();
 365   bookmark.totalTimeInSeconds = (int)g_application.GetTotalTime();
 366
 367   auto& components = CServiceBroker::GetAppComponents();
 368   const auto appPlayer = components.GetComponent<CApplicationPlayer>();
 369
 370   if (appPlayer->HasPlayer())
 371     bookmark.playerState = appPlayer->GetPlayerState();
 372   else
 373     bookmark.playerState.clear();
 374
 375   bookmark.player = g_application.GetCurrentPlayer();
 376
 377   // create the thumbnail image
 378   const float aspectRatio{appPlayer->GetRenderAspectRatio()};
 379   CRect srcRect{}, renderRect{}, viewRect{};
 380   appPlayer->GetRects(srcRect, renderRect, viewRect);
 381   const unsigned int srcWidth{static_cast<unsigned int>(srcRect.Width())};
 382   const unsigned int srcHeight{static_cast<unsigned int>(srcRect.Height())};
 383   const unsigned int renderWidth{static_cast<unsigned int>(renderRect.Width())};
 384   const unsigned int renderHeight{static_cast<unsigned int>(renderRect.Height())};
 385   const unsigned int viewWidth{static_cast<unsigned int>(viewRect.Width())};
 386   const unsigned int viewHeight{static_cast<unsigned int>(viewRect.Height())};
 387
 388   if (!srcWidth || !srcHeight || !renderWidth || !renderHeight || !viewWidth || !viewHeight)
 389     return false;
 390
 391   const unsigned int orientation{appPlayer->GetOrientation()};
 392   const bool rotated{orientation == 90 || orientation == 270};
 393
 394   // FIXME: the renderer sets the scissors to the size of the screen (provided by graphiccontext),
 395   // limiting the max size of thumbs (for example 4k video played on 1024x768 screen)
 396
 397   // The advanced setting defines the max size of the largest dimension (depends on orientation)
 398   const unsigned int maxThumbDim{
 399       CServiceBroker::GetSettingsComponent()->GetAdvancedSettings()->m_imageRes};
 400   unsigned int width{}, height{};
 401
 402   if (!rotated)
 403   {
 404     if (aspectRatio >= 1.0f)
 405     {
 406       width = std::min({maxThumbDim, viewWidth, renderWidth, srcWidth});
 407       height = static_cast<unsigned int>(width / aspectRatio);
 408     }
 409     else
 410     {
 411       height = std::min({maxThumbDim, viewHeight, renderHeight, srcHeight});
 412       width = static_cast<unsigned int>(height * aspectRatio);
 413     }
 414   }
 415   else
 416   {
 417     // rotation is applied during rendering, switching source width and height
 418     if (aspectRatio >= 1.0f)
 419     {
 420       height = std::min({maxThumbDim, viewHeight, renderHeight, srcWidth});
 421       width = static_cast<unsigned int>(height / aspectRatio);
 422     }
 423     else
 424     {
 425       width = std::min({maxThumbDim, viewWidth, renderWidth, srcHeight});
 426       height = static_cast<unsigned int>(width * aspectRatio);
 427     }
 428   }
 429
 430   uint8_t *pixels = (uint8_t*)malloc(height * width * 4);
 431   unsigned int captureId = appPlayer->RenderCaptureAlloc();
 432
 433   appPlayer->RenderCapture(captureId, width, height, CAPTUREFLAG_IMMEDIATELY);
 434   bool hasImage = appPlayer->RenderCaptureGetPixels(captureId, 1000, pixels, height * width * 4);
 435
 436   if (hasImage)
 437   {
 438     const std::shared_ptr<CProfileManager> profileManager = CServiceBroker::GetSettingsComponent()->GetProfileManager();
 439
 440     auto crc = Crc32::ComputeFromLowerCase(g_application.CurrentFile());
 441     bookmark.thumbNailImage =
 442         StringUtils::Format("{:08x}_{}.jpg", crc, (int)bookmark.timeInSeconds);
 443     bookmark.thumbNailImage = URIUtils::AddFileToFolder(profileManager->GetBookmarksThumbFolder(), bookmark.thumbNailImage);
 444
 445     if (!CPicture::CreateThumbnailFromSurface(pixels, width, height, width * 4,
 446                                                          bookmark.thumbNailImage))
 447     {
 448       bookmark.thumbNailImage.clear();
 449     }
 450     else
 451       CLog::Log(LOGERROR,"CGUIDialogVideoBookmarks: failed to create thumbnail");
 452
 453     appPlayer->RenderCaptureRelease(captureId);
 454   }
 455   else
 456     CLog::Log(LOGERROR,"CGUIDialogVideoBookmarks: failed to create thumbnail 2");
 457
 458   free(pixels);
 459
 460   videoDatabase.Open();
 461   if (tag)
 462     videoDatabase.AddBookMarkForEpisode(*tag, bookmark);
 463   else
 464   {
 465     const std::string path{g_application.CurrentFileItem().GetDynPath()};
 466     videoDatabase.AddBookMarkToFile(path, bookmark, CBookmark::STANDARD);
 467   }
 468   videoDatabase.Close();
 469   return true;
 470 }
 471
 472 void CGUIDialogVideoBookmarks::OnWindowLoaded()
 473 {
 474   CGUIDialog::OnWindowLoaded();
 475   m_viewControl.Reset();
 476   m_viewControl.SetParentWindow(GetID());
 477   m_viewControl.AddView(GetControl(CONTROL_THUMBS));
 478   m_vecItems->Clear();
 479 }
 480
 481 void CGUIDialogVideoBookmarks::OnWindowUnload()
 482 {
 483   m_vecItems->Clear();
 484   CGUIDialog::OnWindowUnload();
 485   m_viewControl.Reset();
 486 }
 487
 488 CGUIControl *CGUIDialogVideoBookmarks::GetFirstFocusableControl(int id)
 489 {
 490   if (m_viewControl.HasControl(id))
 491     id = m_viewControl.GetCurrentControl();
 492   return CGUIWindow::GetFirstFocusableControl(id);
 493 }
 494
 495 bool CGUIDialogVideoBookmarks::AddEpisodeBookmark()
 496 {
 497   std::vector<CVideoInfoTag> episodes;
 498   CVideoDatabase videoDatabase;
 499   videoDatabase.Open();
 500   videoDatabase.GetEpisodesByFile(g_application.CurrentFile(), episodes);
 501   videoDatabase.Close();
 502   if (!episodes.empty())
 503   {
 504     CContextButtons choices;
 505     for (unsigned int i=0; i < episodes.size(); ++i)
 506     {
 507       std::string strButton =
 508           StringUtils::Format("{} {}, {} {}", g_localizeStrings.Get(20373), episodes[i].m_iSeason,
 509                               g_localizeStrings.Get(20359), episodes[i].m_iEpisode);
 510       choices.Add(i, strButton);
 511     }
 512
 513     int pressed = CGUIDialogContextMenu::ShowAndGetChoice(choices);
 514     if (pressed >= 0)
 515     {
 516       AddBookmark(&episodes[pressed]);
 517       return true;
 518     }
 519   }
 520   return false;
 521 }
 522
 523
 524
 525 bool CGUIDialogVideoBookmarks::OnAddBookmark()
 526 {
 527   if (!IsVideo(g_application.CurrentFileItem()))
 528     return false;
 529
 530   if (CGUIDialogVideoBookmarks::AddBookmark())
 531   {
 532     CServiceBroker::GetGUI()->GetWindowManager().SendMessage(GUI_MSG_REFRESH_LIST, 0, WINDOW_DIALOG_VIDEO_BOOKMARKS);
 533     CGUIDialogKaiToast::QueueNotification(CGUIDialogKaiToast::Info,
 534                                           g_localizeStrings.Get(298),   // "Bookmarks"
 535                                           g_localizeStrings.Get(21362));// "Bookmark created"
 536     return true;
 537   }
 538   return false;
 539 }
 540
 541 bool CGUIDialogVideoBookmarks::OnAddEpisodeBookmark()
 542 {
 543   bool bReturn = false;
 544   if (g_application.CurrentFileItem().HasVideoInfoTag() && g_application.CurrentFileItem().GetVideoInfoTag()->m_iEpisode > -1)
 545   {
 546     CVideoDatabase videoDatabase;
 547     videoDatabase.Open();
 548     std::vector<CVideoInfoTag> episodes;
 549     videoDatabase.GetEpisodesByFile(g_application.CurrentFile(),episodes);
 550     if (episodes.size() > 1)
 551     {
 552       bReturn = CGUIDialogVideoBookmarks::AddEpisodeBookmark();
 553       if(bReturn)
 554       {
 555         CServiceBroker::GetGUI()->GetWindowManager().SendMessage(GUI_MSG_REFRESH_LIST, 0, WINDOW_DIALOG_VIDEO_BOOKMARKS);
 556         CGUIDialogKaiToast::QueueNotification(CGUIDialogKaiToast::Info,
 557                                               g_localizeStrings.Get(298),   // "Bookmarks"
 558                                               g_localizeStrings.Get(21363));// "Episode Bookmark created"
 559
 560       }
 561     }
 562     videoDatabase.Close();
 563   }
 564   return bReturn;
 565 }