Merged from linuxport rev21200:21590. Updated.
[xbmc:xbmc-antiquated.git] / XBMC / xbmc / lib / libUPnP / Platinum / Source / Devices / FrameStreamer / PltFrameServer.h
1 /*****************************************************************
2 |
3 |   Platinum - Frame Server
4 |
5 | Copyright (c) 2004-2008, Plutinosoft, LLC.
6 | All rights reserved.
7 | http://www.plutinosoft.com
8 |
9 | This program is free software; you can redistribute it and/or
10 | modify it under the terms of the GNU General Public License
11 | as published by the Free Software Foundation; either version 2
12 | of the License, or (at your option) any later version.
13 |
14 | OEMs, ISVs, VARs and other distributors that combine and 
15 | distribute commercially licensed software with Platinum software
16 | and do not wish to distribute the source code for the commercially
17 | licensed software under version 2, or (at your option) any later
18 | version, of the GNU General Public License (the "GPL") must enter
19 | into a commercial license agreement with Plutinosoft, LLC.
20
21 | This program is distributed in the hope that it will be useful,
22 | but WITHOUT ANY WARRANTY; without even the implied warranty of
23 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24 | GNU General Public License for more details.
25 |
26 | You should have received a copy of the GNU General Public License
27 | along with this program; see the file LICENSE.txt. If not, write to
28 | the Free Software Foundation, Inc., 
29 | 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
30 | http://www.gnu.org/licenses/gpl-2.0.html
31 |
32 ****************************************************************/
33
34 #ifndef _PLT_FRAME_SERVER_H_
35 #define _PLT_FRAME_SERVER_H_
36
37 /*----------------------------------------------------------------------
38 |   includes
39 +---------------------------------------------------------------------*/
40 #include "Neptune.h"
41 #include "PltFileMediaServer.h"
42 #include "PltFrameBuffer.h"
43
44 /*----------------------------------------------------------------------
45 |   forward declarations
46 +---------------------------------------------------------------------*/
47 class PLT_SocketPolicyServer;
48
49 /*----------------------------------------------------------------------
50 |   PLT_StreamValidator class
51 +---------------------------------------------------------------------*/
52 class PLT_StreamValidator
53 {
54 public:
55     virtual ~PLT_StreamValidator() {}
56     virtual bool OnNewRequestAccept(const NPT_HttpRequestContext& context) = 0;
57 };
58
59 /*----------------------------------------------------------------------
60 |   PLT_FrameServer class
61 +---------------------------------------------------------------------*/
62 class PLT_FrameServer : public PLT_FileMediaServer
63 {
64 public:
65     PLT_FrameServer(PLT_FrameBuffer& frame_buffer, 
66                     const char*      www_root,
67                     const char*      friendly_name,
68                     bool             show_ip = false,
69                     const char*      uuid = NULL,
70                     NPT_UInt16       port = 0,
71                     PLT_StreamValidator* stream_validator = NULL);
72
73 protected:
74     virtual ~PLT_FrameServer();
75
76     // overridable
77     virtual NPT_Result ProcessStreamRequest(NPT_HttpRequest&              request, 
78                                             const NPT_HttpRequestContext& context,
79                                             NPT_HttpResponse&             response);
80     // PLT_DeviceHost methods
81     virtual NPT_Result SetupDevice();
82     virtual NPT_Result ProcessHttpRequest(NPT_HttpRequest&              request, 
83                                           const NPT_HttpRequestContext& context,
84                                           NPT_HttpResponse&             response);
85     
86     // PLT_FileMediaServer methods
87     virtual NPT_String BuildResourceUri(const NPT_HttpUrl& base_uri, const char* host, const char* file_path);
88
89     // PLT_MediaServer methods
90     virtual NPT_Result OnBrowseMetadata(PLT_ActionReference&          action, 
91                                         const char*                   object_id, 
92                                         const char*                   filter,
93                                         NPT_UInt32                    starting_index,
94                                         NPT_UInt32                    requested_count,
95                                         const NPT_List<NPT_String>&   sort_criteria,
96                                         const PLT_HttpRequestContext& context);
97     virtual NPT_Result OnBrowseDirectChildren(PLT_ActionReference&          action, 
98                                               const char*                   object_id, 
99                                               const char*                   filter,
100                                               NPT_UInt32                    starting_index,
101                                               NPT_UInt32                    requested_count,
102                                               const NPT_List<NPT_String>&   sort_criteria,
103                                               const PLT_HttpRequestContext& context);
104     virtual PLT_MediaObject* BuildFromID(const char* id,
105                                          const NPT_SocketAddress* req_local_address /* = NULL */);
106
107 private:
108     NPT_Result Replace(const char* input, NPT_MemoryStream& output);
109     NPT_Result ProcessTemplate(NPT_HttpRequest&              request, 
110                                const NPT_HttpRequestContext& context,
111                                NPT_HttpResponse&             response);
112 protected:
113     friend class PLT_MediaItem;
114
115     PLT_FrameBuffer&        m_FrameBuffer;
116     NPT_HttpUrl             m_StreamBaseUri;
117     PLT_SocketPolicyServer* m_PolicyServer;
118     PLT_StreamValidator*    m_StreamValidator;
119 };
120
121 #endif /* _PLT_FRAME_SERVER_H_ */