xbmc/pvr/dialogs/GUIDialogPVRChannelsOSD.cpp

   1 /*
   2  *  Copyright (C) 2012-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 "GUIDialogPVRChannelsOSD.h"
  10
  11 #include "FileItem.h"
  12 #include "FileItemList.h"
  13 #include "GUIInfoManager.h"
  14 #include "ServiceBroker.h"
  15 #include "guilib/GUIComponent.h"
  16 #include "guilib/GUIMessage.h"
  17 #include "input/actions/Action.h"
  18 #include "input/actions/ActionIDs.h"
  19 #include "messaging/ApplicationMessenger.h"
  20 #include "pvr/PVRManager.h"
  21 #include "pvr/PVRPlaybackState.h"
  22 #include "pvr/channels/PVRChannel.h"
  23 #include "pvr/channels/PVRChannelGroupMember.h"
  24 #include "pvr/channels/PVRChannelGroups.h"
  25 #include "pvr/channels/PVRChannelGroupsContainer.h"
  26 #include "pvr/epg/EpgContainer.h"
  27 #include "pvr/guilib/PVRGUIActionsChannels.h"
  28 #include "pvr/guilib/PVRGUIActionsPlayback.h"
  29 #include "settings/Settings.h"
  30 #include "settings/SettingsComponent.h"
  31
  32 #include <memory>
  33 #include <string>
  34 #include <vector>
  35
  36 using namespace PVR;
  37
  38 using namespace std::chrono_literals;
  39
  40 #define MAX_INVALIDATION_FREQUENCY 2000ms // limit to one invalidation per X milliseconds
  41
  42 CGUIDialogPVRChannelsOSD::CGUIDialogPVRChannelsOSD()
  43   : CGUIDialogPVRItemsViewBase(WINDOW_DIALOG_PVR_OSD_CHANNELS, "DialogPVRChannelsOSD.xml")
  44 {
  45   CServiceBroker::GetPVRManager().Get<PVR::GUI::Channels>().RegisterChannelNumberInputHandler(this);
  46 }
  47
  48 CGUIDialogPVRChannelsOSD::~CGUIDialogPVRChannelsOSD()
  49 {
  50   auto& mgr = CServiceBroker::GetPVRManager();
  51   mgr.Events().Unsubscribe(this);
  52   mgr.Get<PVR::GUI::Channels>().DeregisterChannelNumberInputHandler(this);
  53 }
  54
  55 bool CGUIDialogPVRChannelsOSD::OnMessage(CGUIMessage& message)
  56 {
  57   if (message.GetMessage() == GUI_MSG_REFRESH_LIST)
  58   {
  59     switch (static_cast<PVREvent>(message.GetParam1()))
  60     {
  61       case PVREvent::CurrentItem:
  62         m_viewControl.SetItems(*m_vecItems);
  63         return true;
  64
  65       case PVREvent::Epg:
  66       case PVREvent::EpgContainer:
  67       case PVREvent::EpgActiveItem:
  68         if (IsActive())
  69           SetInvalid();
  70         return true;
  71
  72       default:
  73         break;
  74     }
  75   }
  76   return CGUIDialogPVRItemsViewBase::OnMessage(message);
  77 }
  78
  79 void CGUIDialogPVRChannelsOSD::OnInitWindow()
  80 {
  81   if (!CServiceBroker::GetPVRManager().PlaybackState()->IsPlayingTV() &&
  82       !CServiceBroker::GetPVRManager().PlaybackState()->IsPlayingRadio())
  83   {
  84     Close();
  85     return;
  86   }
  87
  88   Init();
  89   Update();
  90   CGUIDialogPVRItemsViewBase::OnInitWindow();
  91 }
  92
  93 void CGUIDialogPVRChannelsOSD::OnDeinitWindow(int nextWindowID)
  94 {
  95   if (m_group)
  96   {
  97     CServiceBroker::GetPVRManager().Get<PVR::GUI::Channels>().SetSelectedChannelPath(
  98         m_group->IsRadio(), m_viewControl.GetSelectedItemPath());
  99
 100     // next OnInitWindow will set the group which is then selected
 101     m_group.reset();
 102   }
 103
 104   CGUIDialogPVRItemsViewBase::OnDeinitWindow(nextWindowID);
 105 }
 106
 107 bool CGUIDialogPVRChannelsOSD::OnAction(const CAction& action)
 108 {
 109   switch (action.GetID())
 110   {
 111     case ACTION_SELECT_ITEM:
 112     case ACTION_MOUSE_LEFT_CLICK:
 113     {
 114       // If direct channel number input is active, select the entered channel.
 115       if (CServiceBroker::GetPVRManager()
 116               .Get<PVR::GUI::Channels>()
 117               .GetChannelNumberInputHandler()
 118               .CheckInputAndExecuteAction())
 119         return true;
 120
 121       if (m_viewControl.HasControl(GetFocusedControlID()))
 122       {
 123         // Switch to channel
 124         GotoChannel(m_viewControl.GetSelectedItem());
 125         return true;
 126       }
 127       break;
 128     }
 129     case ACTION_PREVIOUS_CHANNELGROUP:
 130     case ACTION_NEXT_CHANNELGROUP:
 131     {
 132       // save control states and currently selected item of group
 133       SaveControlStates();
 134
 135       // switch to next or previous group
 136       const std::shared_ptr<const CPVRChannelGroups> groups{
 137           CServiceBroker::GetPVRManager().ChannelGroups()->Get(m_group->IsRadio())};
 138       const std::shared_ptr<CPVRChannelGroup> nextGroup = action.GetID() == ACTION_NEXT_CHANNELGROUP
 139                                                               ? groups->GetNextGroup(*m_group)
 140                                                               : groups->GetPreviousGroup(*m_group);
 141       CServiceBroker::GetPVRManager().PlaybackState()->SetActiveChannelGroup(nextGroup);
 142       m_group = nextGroup;
 143       Init();
 144       Update();
 145
 146       // restore control states and previously selected item of group
 147       RestoreControlStates();
 148       return true;
 149     }
 150     case REMOTE_0:
 151     case REMOTE_1:
 152     case REMOTE_2:
 153     case REMOTE_3:
 154     case REMOTE_4:
 155     case REMOTE_5:
 156     case REMOTE_6:
 157     case REMOTE_7:
 158     case REMOTE_8:
 159     case REMOTE_9:
 160     {
 161       AppendChannelNumberCharacter(static_cast<char>(action.GetID() - REMOTE_0) + '0');
 162       return true;
 163     }
 164     case ACTION_CHANNEL_NUMBER_SEP:
 165     {
 166       AppendChannelNumberCharacter(CPVRChannelNumber::SEPARATOR);
 167       return true;
 168     }
 169     default:
 170       break;
 171   }
 172
 173   return CGUIDialogPVRItemsViewBase::OnAction(action);
 174 }
 175
 176 void CGUIDialogPVRChannelsOSD::Update()
 177 {
 178   CPVRManager& pvrMgr = CServiceBroker::GetPVRManager();
 179   pvrMgr.Events().Subscribe(this, &CGUIDialogPVRChannelsOSD::Notify);
 180
 181   const std::shared_ptr<const CPVRChannel> channel = pvrMgr.PlaybackState()->GetPlayingChannel();
 182   if (channel)
 183   {
 184     const std::shared_ptr<CPVRChannelGroup> group =
 185         pvrMgr.PlaybackState()->GetActiveChannelGroup(channel->IsRadio());
 186     if (group)
 187     {
 188       const std::vector<std::shared_ptr<CPVRChannelGroupMember>> groupMembers =
 189           group->GetMembers(CPVRChannelGroup::Include::ONLY_VISIBLE);
 190       for (const auto& groupMember : groupMembers)
 191       {
 192         m_vecItems->Add(std::make_shared<CFileItem>(groupMember));
 193       }
 194
 195       m_viewControl.SetItems(*m_vecItems);
 196
 197       if (!m_group)
 198       {
 199         m_group = group;
 200         m_viewControl.SetSelectedItem(
 201             pvrMgr.Get<PVR::GUI::Channels>().GetSelectedChannelPath(channel->IsRadio()));
 202         SaveSelectedItemPath(group->GroupID());
 203       }
 204     }
 205   }
 206 }
 207
 208 void CGUIDialogPVRChannelsOSD::SetInvalid()
 209 {
 210   if (m_refreshTimeout.IsTimePast())
 211   {
 212     for (const auto& item : *m_vecItems)
 213       item->SetInvalid();
 214
 215     CGUIDialogPVRItemsViewBase::SetInvalid();
 216     m_refreshTimeout.Set(MAX_INVALIDATION_FREQUENCY);
 217   }
 218 }
 219
 220 void CGUIDialogPVRChannelsOSD::SaveControlStates()
 221 {
 222   CGUIDialogPVRItemsViewBase::SaveControlStates();
 223
 224   if (m_group)
 225     SaveSelectedItemPath(m_group->GroupID());
 226 }
 227
 228 void CGUIDialogPVRChannelsOSD::RestoreControlStates()
 229 {
 230   CGUIDialogPVRItemsViewBase::RestoreControlStates();
 231
 232   if (m_group)
 233   {
 234     const std::string path = GetLastSelectedItemPath(m_group->GroupID());
 235     if (path.empty())
 236       m_viewControl.SetSelectedItem(0);
 237     else
 238       m_viewControl.SetSelectedItem(path);
 239   }
 240 }
 241
 242 void CGUIDialogPVRChannelsOSD::GotoChannel(int iItem)
 243 {
 244   if (iItem < 0 || iItem >= m_vecItems->Size())
 245     return;
 246
 247   // Preserve the item before closing self, because this will clear m_vecItems
 248   const std::shared_ptr<CFileItem> item = m_vecItems->Get(iItem);
 249
 250   if (CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(
 251           CSettings::SETTING_PVRMENU_CLOSECHANNELOSDONSWITCH))
 252     Close();
 253
 254   CServiceBroker::GetPVRManager().Get<PVR::GUI::Playback>().SwitchToChannel(
 255       *item, true /* bCheckResume */);
 256 }
 257
 258 void CGUIDialogPVRChannelsOSD::Notify(const PVREvent& event)
 259 {
 260   const CGUIMessage m(GUI_MSG_REFRESH_LIST, GetID(), 0, static_cast<int>(event));
 261   CServiceBroker::GetAppMessenger()->SendGUIMessage(m);
 262 }
 263
 264 void CGUIDialogPVRChannelsOSD::SaveSelectedItemPath(int iGroupID)
 265 {
 266   m_groupSelectedItemPaths[iGroupID] = m_viewControl.GetSelectedItemPath();
 267 }
 268
 269 std::string CGUIDialogPVRChannelsOSD::GetLastSelectedItemPath(int iGroupID) const
 270 {
 271   const auto it = m_groupSelectedItemPaths.find(iGroupID);
 272   if (it != m_groupSelectedItemPaths.end())
 273     return it->second;
 274
 275   return std::string();
 276 }
 277
 278 void CGUIDialogPVRChannelsOSD::GetChannelNumbers(std::vector<std::string>& channelNumbers)
 279 {
 280   if (m_group)
 281     m_group->GetChannelNumbers(channelNumbers);
 282 }
 283
 284 void CGUIDialogPVRChannelsOSD::OnInputDone()
 285 {
 286   const CPVRChannelNumber channelNumber = GetChannelNumber();
 287   if (channelNumber.IsValid())
 288   {
 289     int itemIndex = 0;
 290     for (const CFileItemPtr& channel : *m_vecItems)
 291     {
 292       if (channel->GetPVRChannelGroupMemberInfoTag()->ChannelNumber() == channelNumber)
 293       {
 294         m_viewControl.SetSelectedItem(itemIndex);
 295         return;
 296       }
 297       ++itemIndex;
 298     }
 299   }
 300 }