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
185
186
187 | /*****************************************************************
|
| Platinum - AV Media Server Device
|
| 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 Server.
*/
#ifndef _PLT_MEDIA_SERVER_H_
#define _PLT_MEDIA_SERVER_H_
/*----------------------------------------------------------------------
| includes
+---------------------------------------------------------------------*/
#include "Neptune.h"
#include "PltDeviceHost.h"
#include "PltMediaItem.h"
/*----------------------------------------------------------------------
| constants
+---------------------------------------------------------------------*/
#define MAX_PATH_LENGTH 1024
/*----------------------------------------------------------------------
| PLT_MediaServerDelegate
+---------------------------------------------------------------------*/
/**
The PLT_MediaServerDelegate class is an interface for delegating the handling
of the required UPnP AV ContentDirectory service actions. It also handles
resource HTTP requests (downloading).
*/
class PLT_MediaServerDelegate
{
public:
PLT_MediaServerDelegate() {}
virtual ~PLT_MediaServerDelegate() {}
virtual NPT_Result OnBrowseMetadata(PLT_ActionReference& /*action*/,
const char* /*object_id*/,
const char* /*filter*/,
NPT_UInt32 /*starting_index*/,
NPT_UInt32 /*requested_count*/,
const char* /*sort_criteria*/,
const PLT_HttpRequestContext& /*context*/) = 0;
virtual NPT_Result OnBrowseDirectChildren(PLT_ActionReference& /*action*/,
const char* /*object_id*/,
const char* /*filter*/,
NPT_UInt32 /*starting_index*/,
NPT_UInt32 /*requested_count*/,
const char* /*sort_criteria*/,
const PLT_HttpRequestContext& /*context*/) = 0;
virtual NPT_Result OnSearchContainer(PLT_ActionReference& /*action*/,
const char* /*container_id*/,
const char* /*search_criteria*/,
const char* /*filter*/,
NPT_UInt32 /*starting_index*/,
NPT_UInt32 /*requested_count*/,
const char* /*sort_criteria*/,
const PLT_HttpRequestContext& /*context*/) = 0;
virtual NPT_Result ProcessFileRequest(NPT_HttpRequest& /*request*/,
const NPT_HttpRequestContext& /*context*/,
NPT_HttpResponse& /*response*/) = 0;
};
/*----------------------------------------------------------------------
| PLT_MediaServer
+---------------------------------------------------------------------*/
/**
The PLT_MediaServer class implements the base class for a UPnP AV
Media Server device.
*/
class PLT_MediaServer : public PLT_DeviceHost
{
public:
/* BrowseFlags */
enum BrowseFlags {
BROWSEMETADATA,
BROWSEDIRECTCHILDREN
};
// class methods
static NPT_Result ParseBrowseFlag(const char* str, BrowseFlags& flag);
static NPT_Result ParseSort(const NPT_String& sort, NPT_List<NPT_String>& list);
// constructor
PLT_MediaServer(const char* friendly_name,<--- Class 'PLT_MediaServer' has a constructor with 1 argument that is not explicit. [+]Class 'PLT_MediaServer' has a constructor with 1 argument that is not explicit. Such, so called "Converting constructors", should in general be explicit for type safety reasons as that prevents unintended implicit conversions.
bool show_ip = false,
const char* uuid = NULL,
NPT_UInt16 port = 0,
bool port_rebind = false);
// methods
virtual void SetDelegate(PLT_MediaServerDelegate* delegate) { m_Delegate = delegate; }
PLT_MediaServerDelegate* GetDelegate() { return m_Delegate; }
virtual void UpdateSystemUpdateID(NPT_UInt32 update);
virtual void UpdateContainerUpdateID(const char* id, NPT_UInt32 update);
protected:
virtual ~PLT_MediaServer();<--- Destructor in derived class
// PLT_DeviceHost methods
virtual NPT_Result SetupServices();<--- Function in derived class
virtual NPT_Result OnAction(PLT_ActionReference& action,<--- Function in derived class
const PLT_HttpRequestContext& context);
virtual NPT_Result ProcessHttpGetRequest(NPT_HttpRequest& request,<--- Function in derived class
const NPT_HttpRequestContext& context,
NPT_HttpResponse& response);
// ConnectionManager
virtual NPT_Result OnGetCurrentConnectionIDs(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnGetProtocolInfo(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnGetCurrentConnectionInfo(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
// ContentDirectory
virtual NPT_Result OnGetSortCapabilities(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnGetSearchCapabilities(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnGetSystemUpdateID(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnBrowse(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnSearch(PLT_ActionReference& action,
const PLT_HttpRequestContext& context);
// overridable methods
virtual NPT_Result OnBrowseMetadata(PLT_ActionReference& action,
const char* object_id,
const char* filter,
NPT_UInt32 starting_index,
NPT_UInt32 requested_count,
const char* sort_criteria,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnBrowseDirectChildren(PLT_ActionReference& action,
const char* object_id,
const char* filter,
NPT_UInt32 starting_index,
NPT_UInt32 requested_count,
const char* sort_criteria,
const PLT_HttpRequestContext& context);
virtual NPT_Result OnSearchContainer(PLT_ActionReference& action,
const char* container_id,
const char* search_criteria,
const char* filter,
NPT_UInt32 starting_index,
NPT_UInt32 requested_count,
const char* sort_criteria,
const PLT_HttpRequestContext& context);
private:
PLT_MediaServerDelegate* m_Delegate;
};
#endif /* _PLT_MEDIA_SERVER_H_ */
|