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
176
177
178
179
180
181
182
183
184
|
/*****************************************************************
|
| Platinum - AV Media Browser (Media Server Control Point)
|
| Copyright (c) 2004-2010, Plutinosoft, LLC.
| All rights reserved.
| http://www.plutinosoft.com
|
| This program is free software; you can redistribute it and/or
| modify it under the terms of the GNU General Public License
| as published by the Free Software Foundation; either version 2
| of the License, or (at your option) any later version.
|
| OEMs, ISVs, VARs and other distributors that combine and
| distribute commercially licensed software with Platinum software
| and do not wish to distribute the source code for the commercially
| licensed software under version 2, or (at your option) any later
| version, of the GNU General Public License (the "GPL") must enter
| into a commercial license agreement with Plutinosoft, LLC.
| licensing@plutinosoft.com
|
| This program is distributed in the hope that it will be useful,
| but WITHOUT ANY WARRANTY; without even the implied warranty of
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
| GNU General Public License for more details.
|
| You should have received a copy of the GNU General Public License
| along with this program; see the file LICENSE.txt. If not, write to
| the Free Software Foundation, Inc.,
| 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
| http://www.gnu.org/licenses/gpl-2.0.html
|
****************************************************************/
/** @file
UPnP AV Media Controller implementation.
*/
#ifndef _PLT_MEDIA_BROWSER_H_
#define _PLT_MEDIA_BROWSER_H_
/*----------------------------------------------------------------------
| includes
+---------------------------------------------------------------------*/
#include "PltCtrlPoint.h"
#include "PltMediaItem.h"
/*----------------------------------------------------------------------
| PLT_BrowseInfo
+---------------------------------------------------------------------*/
/**
The PLT_BrowseInfo struct is used to marshall Browse or Search action
response results across different threads of execution.
*/
typedef struct {
NPT_String object_id;
PLT_MediaObjectListReference items;
NPT_UInt32 si;
NPT_UInt32 nr;
NPT_UInt32 tm;
NPT_UInt32 uid;
} PLT_BrowseInfo;
/*----------------------------------------------------------------------
| PLT_MediaBrowserDelegate
+---------------------------------------------------------------------*/
/**
The PLT_MediaBrowserDelegate class is an interface for receiving PLT_MediaBrowser
events or action responses.
*/
class PLT_MediaBrowserDelegate
{
public:
virtual ~PLT_MediaBrowserDelegate() {}
virtual bool OnMSAdded(PLT_DeviceDataReference& /* device */) { return true; }
virtual void OnMSRemoved(PLT_DeviceDataReference& /* device */) {}
virtual void OnMSStateVariablesChanged(
PLT_Service* /*service*/,
NPT_List<PLT_StateVariable*>* /*vars*/) {}
// ContentDirectory
virtual void OnBrowseResult(
NPT_Result /*res*/,
PLT_DeviceDataReference& /*device*/,
PLT_BrowseInfo* /*info*/,
void* /*userdata*/) {}
virtual void OnSearchResult(
NPT_Result /*res*/,
PLT_DeviceDataReference& /*device*/,
PLT_BrowseInfo* /*info*/,
void* /*userdata*/) {}
virtual void OnGetSearchCapabilitiesResult(
NPT_Result /*res*/,
PLT_DeviceDataReference& /*device*/,
NPT_String /*searchCapabilities*/,
void* /*userdata*/) {}
virtual void OnGetSortCapabilitiesResult(
NPT_Result /*res*/,
PLT_DeviceDataReference& /*device*/,
NPT_String /*sortCapabilities*/,
void* /*userdata*/) {}
};
/*----------------------------------------------------------------------
| PLT_MediaBrowser
+---------------------------------------------------------------------*/
/**
The PLT_MediaBrowser class implements a UPnP AV Media Server control point.
*/
class PLT_MediaBrowser : public PLT_CtrlPointListener
{
public:
PLT_MediaBrowser(PLT_CtrlPointReference& ctrl_point,
PLT_MediaBrowserDelegate* delegate = NULL);
~PLT_MediaBrowser() override;
// ContentDirectory service
virtual NPT_Result Browse(PLT_DeviceDataReference& device,
const char* object_id,
NPT_UInt32 start_index,
NPT_UInt32 count = 30, // DLNA recommendations
bool browse_metadata = false,
const char* filter = "dc:date,upnp:genre,res,res@duration,res@size,upnp:albumArtURI,upnp:originalTrackNumber,upnp:album,upnp:artist,upnp:author", // explicitely specify res otherwise WMP won't return a URL!
const char* sort_criteria = "",
void* userdata = NULL);
virtual NPT_Result Search(PLT_DeviceDataReference& device,
const char* container_id,
const char* search_criteria,
NPT_UInt32 start_index,
NPT_UInt32 count = 30, // DLNA recommendations
const char* filter = "dc:date,upnp:genre,res,res@duration,res@size,upnp:albumArtURI,upnp:originalTrackNumber,upnp:album,upnp:artist,upnp:author", // explicitely specify res otherwise WMP won't return a URL!
void* userdata = NULL);
virtual NPT_Result GetSearchCapabilities(PLT_DeviceDataReference& device,
void* userdata = NULL);
virtual NPT_Result GetSortCapabilities(PLT_DeviceDataReference& device,
void* userdata = NULL);
// methods
virtual const NPT_Lock<PLT_DeviceDataReferenceList>& GetMediaServers() { return m_MediaServers; }
virtual NPT_Result FindServer(const char* uuid, PLT_DeviceDataReference& device);
virtual void SetDelegate(PLT_MediaBrowserDelegate* delegate) { m_Delegate = delegate; }
protected:
// PLT_CtrlPointListener methods
NPT_Result OnDeviceAdded(PLT_DeviceDataReference& device) override;
NPT_Result OnDeviceRemoved(PLT_DeviceDataReference& device) override;
NPT_Result OnActionResponse(NPT_Result res, PLT_ActionReference& action, void* userdata) override;
NPT_Result OnEventNotify(PLT_Service* service, NPT_List<PLT_StateVariable*>* vars) override;
// ContentDirectory service responses
virtual NPT_Result OnBrowseResponse(NPT_Result res,
PLT_DeviceDataReference& device,
PLT_ActionReference& action,
void* userdata);
virtual NPT_Result OnSearchResponse(NPT_Result res,
PLT_DeviceDataReference& device,
PLT_ActionReference& action,
void* userdata);
virtual NPT_Result OnGetSearchCapabilitiesResponse(NPT_Result res,
PLT_DeviceDataReference& device,
PLT_ActionReference& action,
void* userdata);
virtual NPT_Result OnGetSortCapabilitiesResponse(NPT_Result res,
PLT_DeviceDataReference& device,
PLT_ActionReference& action,
void* userdata);
protected:
PLT_CtrlPointReference m_CtrlPoint;
PLT_MediaBrowserDelegate* m_Delegate;
NPT_Lock<PLT_DeviceDataReferenceList> m_MediaServers;
};
#endif /* _PLT_MEDIA_BROWSER_H_ */
|
