blob: d7b7f57835f371147e6846a831619e0ae979421f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* 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 "threads/CriticalSection.h"
#include <memory>
#include <vector>
namespace PVR
{
class CPVRChannel;
class CPVRChannelGroup;
class CPVRChannelGroupMember;
class CPVRChannelGroups;
class CPVRClient;
class CPVREpgInfoTag;
class CPVRChannelGroupsContainer
{
public:
/*!
* @brief Create a new container for all channel groups
*/
CPVRChannelGroupsContainer();
/*!
* @brief Destroy this container.
*/
virtual ~CPVRChannelGroupsContainer();
/*!
* @brief Update all channel groups and all channels from PVR database and from given clients.
* @param clients The PVR clients data should be loaded for. Leave empty for all clients.
* @return True on success, false otherwise.
*/
bool Update(const std::vector<std::shared_ptr<CPVRClient>>& clients);
/*!
* @brief Update data with groups and channels from the given clients, sync with local data.
* @param clients The clients to fetch data from. Leave empty to fetch data from all created clients.
* @param bChannelsOnly Set to true to only update channels, not the groups themselves.
* @return True on success, false otherwise.
*/
bool UpdateFromClients(const std::vector<std::shared_ptr<CPVRClient>>& clients,
bool bChannelsOnly = false);
/*!
* @brief Unload and destruct all channel groups and all channels in them.
*/
void Unload();
/*!
* @brief Get the TV channel groups.
* @return The TV channel groups.
*/
CPVRChannelGroups* GetTV() const { return Get(false); }
/*!
* @brief Get the radio channel groups.
* @return The radio channel groups.
*/
CPVRChannelGroups* GetRadio() const { return Get(true); }
/*!
* @brief Get the radio or TV channel groups.
* @param bRadio If true, get the radio channel groups. Get the TV channel groups otherwise.
* @return The requested groups.
*/
CPVRChannelGroups* Get(bool bRadio) const;
/*!
* @brief Get the group containing all TV channels.
* @return The group containing all TV channels.
*/
std::shared_ptr<CPVRChannelGroup> GetGroupAllTV() const { return GetGroupAll(false); }
/*!
* @brief Get the group containing all radio channels.
* @return The group containing all radio channels.
*/
std::shared_ptr<CPVRChannelGroup> GetGroupAllRadio() const { return GetGroupAll(true); }
/*!
* @brief Get the group containing all TV or radio channels.
* @param bRadio If true, get the group containing all radio channels. Get the group containing all TV channels otherwise.
* @return The requested group.
*/
std::shared_ptr<CPVRChannelGroup> GetGroupAll(bool bRadio) const;
/*!
* @brief Get a group given it's ID.
* @param iGroupId The ID of the group.
* @return The requested group or NULL if it wasn't found.
*/
std::shared_ptr<CPVRChannelGroup> GetByIdFromAll(int iGroupId) const;
/*!
* @brief Get a channel given it's database ID.
* @param iChannelId The ID of the channel.
* @return The channel or NULL if it wasn't found.
*/
std::shared_ptr<CPVRChannel> GetChannelById(int iChannelId) const;
/*!
* @brief Get the channel for the given epg tag.
* @param epgTag The epg tag.
* @return The channel.
*/
std::shared_ptr<CPVRChannel> GetChannelForEpgTag(const std::shared_ptr<CPVREpgInfoTag>& epgTag) const;
/*!
* @brief Get a channel given it's path.
* @param strPath The path.
* @return The channel or nullptr if it wasn't found.
*/
std::shared_ptr<CPVRChannel> GetByPath(const std::string& strPath) const;
/*!
* @brief Get a channel group member given it's path.
* @param strPath The path.
* @return The channel group member or nullptr if it wasn't found.
*/
std::shared_ptr<CPVRChannelGroupMember> GetChannelGroupMemberByPath(
const std::string& strPath) const;
/*!
* @brief Get a channel given it's channel ID from all containers.
* @param iUniqueChannelId The unique channel id on the client.
* @param iClientID The ID of the client.
* @return The channel or NULL if it wasn't found.
*/
std::shared_ptr<CPVRChannel> GetByUniqueID(int iUniqueChannelId, int iClientID) const;
/*!
* @brief Get the channel group member that was played last.
* @return The requested channel group member or nullptr.
*/
std::shared_ptr<CPVRChannelGroupMember> GetLastPlayedChannelGroupMember() const;
/*!
* @brief Create EPG tags for channels in all internal channel groups.
* @return True if EPG tags were created successfully.
*/
bool CreateChannelEpgs();
/*!
* @brief Erase stale texture db entries and image files.
* @return number of cleaned up images.
*/
int CleanupCachedImages();
private:
CPVRChannelGroupsContainer& operator=(const CPVRChannelGroupsContainer&) = delete;
CPVRChannelGroupsContainer(const CPVRChannelGroupsContainer&) = delete;
/*!
* @brief Load all channel groups and all channels from PVR database.
* @param clients The PVR clients data should be loaded for. Leave empty for all clients.
* @return True on success, false otherwise.
*/
bool LoadFromDatabase(const std::vector<std::shared_ptr<CPVRClient>>& clients);
CPVRChannelGroups* m_groupsRadio; /*!< all radio channel groups */
CPVRChannelGroups* m_groupsTV; /*!< all TV channel groups */
CCriticalSection m_critSection;
bool m_bIsUpdating = false;
};
}
|
