PVRChannelGroups.h

/*
 *  Copyright (C) 2012-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "pvr/channels/PVRChannelGroup.h"
#include "pvr/settings/PVRSettings.h"
#include "settings/lib/ISettingCallback.h"
#include "threads/CriticalSection.h"

#include <memory>
#include <mutex>
#include <string>
#include <vector>

namespace PVR
{
enum class PVREvent;

class CPVRChannel;
class CPVRClient;

class CPVRChannelGroups : public ISettingCallback
{
public:
  explicit CPVRChannelGroups(bool bRadio);
  virtual ~CPVRChannelGroups();

  // ISettingCallback implementation
  void OnSettingChanged(const std::shared_ptr<const CSetting>& setting) override;

  void Unload();

  bool LoadFromDatabase(const std::vector<std::shared_ptr<CPVRClient>>& clients);

  std::shared_ptr<CPVRChannelGroup> CreateChannelGroup(int iType, const CPVRChannelsPath& path);

  size_t Size() const
  {
    std::unique_lock<CCriticalSection> lock(m_critSection);
    return m_groups.size();
  }

  bool Update(const std::shared_ptr<CPVRChannelGroup>& group, bool bUpdateFromClient = false);

  bool UpdateFromClient(const std::shared_ptr<CPVRChannelGroup>& group);

  std::shared_ptr<CPVRChannelGroupMember> GetChannelGroupMemberByPath(
      const CPVRChannelsPath& path) const;

  std::vector<std::shared_ptr<CPVRChannelGroupMember>> GetMembersAvailableForGroup(
      const std::shared_ptr<CPVRChannelGroup>& group);

  std::shared_ptr<CPVRChannelGroup> GetById(int iGroupId) const;

  std::shared_ptr<CPVRChannelGroup> GetGroupByPath(const std::string& strPath) const;

  std::shared_ptr<CPVRChannelGroup> GetByName(const std::string& strName, int clientID) const;

  std::shared_ptr<CPVRChannelGroup> GetGroupAll() const;

  std::shared_ptr<CPVRChannelGroup> GetFirstGroup() const { return GetGroupAll(); }

  std::shared_ptr<CPVRChannelGroup> GetLastGroup() const;

  GroupMemberPair GetLastAndPreviousToLastPlayedChannelGroupMember() const;

  std::shared_ptr<CPVRChannelGroup> GetLastOpenedGroup() const;

  std::vector<std::shared_ptr<CPVRChannelGroup>> GetMembers(bool bExcludeHidden = false) const;

  std::shared_ptr<CPVRChannelGroup> GetPreviousGroup(const CPVRChannelGroup& group) const;

  std::shared_ptr<CPVRChannelGroup> GetNextGroup(const CPVRChannelGroup& group) const;

  std::shared_ptr<CPVRChannelGroup> AddGroup(const std::string& strName);

  bool DeleteGroup(const std::shared_ptr<CPVRChannelGroup>& group);

  bool HideGroup(const std::shared_ptr<CPVRChannelGroup>& group, bool bHide);

  bool PersistAll();

  bool IsRadio() const { return m_bRadio; }

  bool UpdateFromClients(const std::vector<std::shared_ptr<CPVRClient>>& clients,
                         bool bChannelsOnly = false);

  bool UpdateChannelNumbersFromAllChannelsGroup();

  int CleanupCachedImages();

  void SortGroups();

private:
  void SortGroupsByBackendOrder();
  void SortGroupsByLocalOrder();

  bool HasValidDataForClients(const std::vector<std::shared_ptr<CPVRClient>>& clients) const;

  void OnPVRManagerEvent(const PVR::PVREvent& event);

  int GetGroupTypePriority(const std::shared_ptr<CPVRChannelGroup>& group) const;
  int GetGroupClientPriority(const std::shared_ptr<CPVRChannelGroup>& group) const;

  bool m_bRadio{false};
  std::vector<std::shared_ptr<CPVRChannelGroup>> m_groups;
  mutable CCriticalSection m_critSection;
  std::vector<int> m_failedClientsForChannelGroups;
  bool m_isSubscribed{false};
  CPVRSettings m_settings;
  std::shared_ptr<CPVRChannelGroup> m_allChannelsGroup;
};
} // namespace PVR