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 "threads/CriticalSection.h"

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

namespace PVR
{
  class CPVRChannel;
  class CPVRClient;

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

    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)
    {
      return Update(group, true);
    }

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

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

    std::vector<std::shared_ptr<CPVRChannelGroup>> GetGroupsByChannel(const std::shared_ptr<CPVRChannel>& channel, bool bExcludeHidden = false) const;

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

    std::shared_ptr<CPVRChannelGroup> GetByName(const std::string& strName) 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;

    bool AddGroup(const std::string& strName);

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

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

    bool CreateChannelEpgs();

    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();

  private:
    void SortGroups();

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

    bool m_bRadio; 
    std::vector<std::shared_ptr<CPVRChannelGroup>> m_groups; 
    mutable CCriticalSection m_critSection;
    std::vector<int> m_failedClientsForChannelGroups;
  };
}