xbmc/dialogs/GUIDialogKaiToast.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 "GUIDialogKaiToast.h"
  10
  11 #include "ServiceBroker.h"
  12 #include "guilib/GUIFadeLabelControl.h"
  13 #include "guilib/GUIMessage.h"
  14 #include "peripherals/Peripherals.h"
  15 #include "utils/TimeUtils.h"
  16
  17 #include <mutex>
  18
  19 #define POPUP_ICON                400
  20 #define POPUP_CAPTION_TEXT        401
  21 #define POPUP_NOTIFICATION_BUTTON 402
  22
  23 CGUIDialogKaiToast::TOASTQUEUE CGUIDialogKaiToast::m_notifications;
  24 CCriticalSection CGUIDialogKaiToast::m_critical;
  25
  26 CGUIDialogKaiToast::CGUIDialogKaiToast(void)
  27   : CGUIDialog(WINDOW_DIALOG_KAI_TOAST, "DialogNotification.xml", DialogModalityType::MODELESS)
  28 {
  29   m_loadType = LOAD_ON_GUI_INIT;
  30   m_timer = 0;
  31   m_toastDisplayTime = 0;
  32   m_toastMessageTime = 0;
  33 }
  34
  35 CGUIDialogKaiToast::~CGUIDialogKaiToast(void) = default;
  36
  37 bool CGUIDialogKaiToast::OnMessage(CGUIMessage& message)
  38 {
  39   switch ( message.GetMessage() )
  40   {
  41   case GUI_MSG_WINDOW_INIT:
  42     {
  43       CGUIDialog::OnMessage(message);
  44       ResetTimer();
  45       return true;
  46     }
  47     break;
  48
  49   case GUI_MSG_WINDOW_DEINIT:
  50     {
  51     }
  52     break;
  53   }
  54   return CGUIDialog::OnMessage(message);
  55 }
  56
  57 void CGUIDialogKaiToast::QueueNotification(eMessageType eType, const std::string& aCaption, const std::string& aDescription, unsigned int displayTime /*= TOAST_DISPLAY_TIME*/, bool withSound /*= true*/, unsigned int messageTime /*= TOAST_MESSAGE_TIME*/)
  58 {
  59   AddToQueue("", eType, aCaption, aDescription, displayTime, withSound, messageTime);
  60 }
  61
  62 void CGUIDialogKaiToast::QueueNotification(const std::string& aCaption, const std::string& aDescription)
  63 {
  64   QueueNotification("", aCaption, aDescription);
  65 }
  66
  67 void CGUIDialogKaiToast::QueueNotification(const std::string& aImageFile, const std::string& aCaption, const std::string& aDescription, unsigned int displayTime /*= TOAST_DISPLAY_TIME*/, bool withSound /*= true*/, unsigned int messageTime /*= TOAST_MESSAGE_TIME*/)
  68 {
  69   AddToQueue(aImageFile, Default, aCaption, aDescription, displayTime, withSound, messageTime);
  70 }
  71
  72 void CGUIDialogKaiToast::AddToQueue(const std::string& aImageFile, const eMessageType eType, const std::string& aCaption, const std::string& aDescription, unsigned int displayTime /*= TOAST_DISPLAY_TIME*/, bool withSound /*= true*/, unsigned int messageTime /*= TOAST_MESSAGE_TIME*/)
  73 {
  74   std::unique_lock<CCriticalSection> lock(m_critical);
  75
  76   if (!m_notifications.empty())
  77   {
  78     const auto& last = m_notifications.back();
  79     if (last.eType == eType && last.imagefile == aImageFile && last.caption == aCaption &&
  80         last.description == aDescription)
  81       return; // avoid duplicates in a row.
  82   }
  83
  84   Notification toast;
  85   toast.eType = eType;
  86   toast.imagefile = aImageFile;
  87   toast.caption = aCaption;
  88   toast.description = aDescription;
  89   toast.displayTime = displayTime > TOAST_MESSAGE_TIME + 500 ? displayTime : TOAST_MESSAGE_TIME + 500;
  90   toast.messageTime = messageTime;
  91   toast.withSound = withSound;
  92
  93   m_notifications.push(toast);
  94 }
  95
  96 bool CGUIDialogKaiToast::DoWork()
  97 {
  98   std::unique_lock<CCriticalSection> lock(m_critical);
  99
 100   if (!m_notifications.empty() &&
 101       CTimeUtils::GetFrameTime() - m_timer > m_toastMessageTime)
 102   {
 103     // if we have a fade label control for the text to display, ensure the whole text was shown
 104     // (scrolled to the end) before we move on to the next message
 105     const CGUIFadeLabelControl* notificationText =
 106         dynamic_cast<const CGUIFadeLabelControl*>(GetControl(POPUP_NOTIFICATION_BUTTON));
 107     if (notificationText && !notificationText->AllLabelsShown())
 108       return false;
 109
 110     Notification toast = m_notifications.front();
 111     m_notifications.pop();
 112     lock.unlock();
 113
 114     m_toastDisplayTime = toast.displayTime;
 115     m_toastMessageTime = toast.messageTime;
 116
 117     std::unique_lock<CCriticalSection> lock2(CServiceBroker::GetWinSystem()->GetGfxContext());
 118
 119     if(!Initialize())
 120       return false;
 121
 122     SET_CONTROL_LABEL(POPUP_CAPTION_TEXT, toast.caption);
 123
 124     SET_CONTROL_LABEL(POPUP_NOTIFICATION_BUTTON, toast.description);
 125
 126     // set the appropriate icon
 127     {
 128       std::string icon = toast.imagefile;
 129       if (icon.empty())
 130       {
 131         if (toast.eType == Warning)
 132           icon = "DefaultIconWarning.png";
 133         else if (toast.eType == Error)
 134           icon = "DefaultIconError.png";
 135         else
 136           icon = "DefaultIconInfo.png";
 137       }
 138       SET_CONTROL_FILENAME(POPUP_ICON, icon);
 139     }
 140
 141     //  Play the window specific init sound for each notification queued
 142     SetSound(toast.withSound);
 143
 144     // Activate haptics for this notification
 145     CServiceBroker::GetPeripherals().OnUserNotification();
 146
 147     ResetTimer();
 148     return true;
 149   }
 150
 151   return false;
 152 }
 153
 154
 155 void CGUIDialogKaiToast::ResetTimer()
 156 {
 157   m_timer = CTimeUtils::GetFrameTime();
 158 }
 159
 160 void CGUIDialogKaiToast::FrameMove()
 161 {
 162   //  Fading does not count as display time
 163   if (IsAnimating(ANIM_TYPE_WINDOW_OPEN))
 164     ResetTimer();
 165
 166   // now check if we should exit
 167   if (CTimeUtils::GetFrameTime() - m_timer > m_toastDisplayTime)
 168   {
 169     bool bClose = true;
 170
 171     // if we have a fade label control for the text to display, ensure the whole text was shown
 172     // (scrolled to the end) before we're closing the toast dialog
 173     const CGUIFadeLabelControl* notificationText =
 174         dynamic_cast<const CGUIFadeLabelControl*>(GetControl(POPUP_NOTIFICATION_BUTTON));
 175     if (notificationText)
 176     {
 177       std::unique_lock<CCriticalSection> lock(m_critical);
 178       bClose = notificationText->AllLabelsShown() && m_notifications.empty();
 179     }
 180
 181     if (bClose)
 182       Close();
 183   }
 184
 185   CGUIDialog::FrameMove();
 186 }