VirtualBox

source: vbox/trunk/src/VBox/Main/include/ConsoleVRDPServer.h@ 36843

Last change on this file since 36843 was 36843, checked in by vboxsync, 14 years ago

3D for VRDP: initial commit (xTracker 5565).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.4 KB
Line 
1/* $Id: ConsoleVRDPServer.h 36843 2011-04-26 08:33:19Z vboxsync $ */
2/** @file
3 * VBox Console VRDE Server Helper class and implementation of IVRDEServerInfo
4 */
5
6/*
7 * Copyright (C) 2006-2010 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef ____H_CONSOLEVRDPSERVER
19#define ____H_CONSOLEVRDPSERVER
20
21#include "RemoteUSBBackend.h"
22#include "HGCM.h"
23
24#include <VBox/VBoxAuth.h>
25
26#include <VBox/RemoteDesktop/VRDEImage.h>
27
28#include <VBox/HostServices/VBoxClipboardExt.h>
29
30#include "SchemaDefs.h"
31
32// ConsoleVRDPServer
33///////////////////////////////////////////////////////////////////////////////
34
35typedef struct _VRDPInputSynch
36{
37 int cGuestNumLockAdaptions;
38 int cGuestCapsLockAdaptions;
39
40 bool fGuestNumLock;
41 bool fGuestCapsLock;
42 bool fGuestScrollLock;
43
44 bool fClientNumLock;
45 bool fClientCapsLock;
46 bool fClientScrollLock;
47} VRDPInputSynch;
48
49/* Member of Console. Helper class for VRDP server management. Not a COM class. */
50class ConsoleVRDPServer
51{
52public:
53 ConsoleVRDPServer (Console *console);
54 ~ConsoleVRDPServer ();
55
56 int Launch (void);
57
58 void NotifyAbsoluteMouse (bool fGuestWantsAbsolute)
59 {
60 m_fGuestWantsAbsolute = fGuestWantsAbsolute;
61 }
62
63 void NotifyKeyboardLedsChange (BOOL fNumLock, BOOL fCapsLock, BOOL fScrollLock)
64 {
65 bool fGuestNumLock = (fNumLock != FALSE);
66 bool fGuestCapsLock = (fCapsLock != FALSE);
67 bool fGuestScrollLock = (fScrollLock != FALSE);
68
69 /* Might need to resync in case the guest itself changed the LED status. */
70 if (m_InputSynch.fClientNumLock != fGuestNumLock)
71 {
72 m_InputSynch.cGuestNumLockAdaptions = 2;
73 }
74
75 if (m_InputSynch.fClientCapsLock != fGuestCapsLock)
76 {
77 m_InputSynch.cGuestCapsLockAdaptions = 2;
78 }
79
80 m_InputSynch.fGuestNumLock = fGuestNumLock;
81 m_InputSynch.fGuestCapsLock = fGuestCapsLock;
82 m_InputSynch.fGuestScrollLock = fGuestScrollLock;
83 }
84
85 void EnableConnections (void);
86 void DisconnectClient (uint32_t u32ClientId, bool fReconnect);
87 void MousePointerUpdate (const VRDECOLORPOINTER *pPointer);
88 void MousePointerHide (void);
89
90 void Stop (void);
91
92 AuthResult Authenticate (const Guid &uuid, AuthGuestJudgement guestJudgement,
93 const char *pszUser, const char *pszPassword, const char *pszDomain,
94 uint32_t u32ClientId);
95
96 void AuthDisconnect (const Guid &uuid, uint32_t u32ClientId);
97
98 void USBBackendCreate (uint32_t u32ClientId, void **ppvIntercept);
99 void USBBackendDelete (uint32_t u32ClientId);
100
101 void *USBBackendRequestPointer (uint32_t u32ClientId, const Guid *pGuid);
102 void USBBackendReleasePointer (const Guid *pGuid);
103
104 /* Private interface for the RemoteUSBBackend destructor. */
105 void usbBackendRemoveFromList (RemoteUSBBackend *pRemoteUSBBackend);
106
107 /* Private methods for the Remote USB thread. */
108 RemoteUSBBackend *usbBackendGetNext (RemoteUSBBackend *pRemoteUSBBackend);
109
110 void notifyRemoteUSBThreadRunning (RTTHREAD thread);
111 bool isRemoteUSBThreadRunning (void);
112 void waitRemoteUSBThreadEvent (RTMSINTERVAL cMillies);
113
114 void ClipboardCreate (uint32_t u32ClientId);
115 void ClipboardDelete (uint32_t u32ClientId);
116
117 /*
118 * Forwarders to VRDP server library.
119 */
120 void SendUpdate (unsigned uScreenId, void *pvUpdate, uint32_t cbUpdate) const;
121 void SendResize (void) const;
122 void SendUpdateBitmap (unsigned uScreenId, uint32_t x, uint32_t y, uint32_t w, uint32_t h) const;
123
124 void SendAudioSamples (void *pvSamples, uint32_t cSamples, VRDEAUDIOFORMAT format) const;
125 void SendAudioVolume (uint16_t left, uint16_t right) const;
126 void SendUSBRequest (uint32_t u32ClientId, void *pvParms, uint32_t cbParms) const;
127
128 void QueryInfo (uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut) const;
129
130 int SendAudioInputBegin(void **ppvUserCtx,
131 void *pvContext,
132 uint32_t cSamples,
133 uint32_t iSampleHz,
134 uint32_t cChannels,
135 uint32_t cBits);
136
137 void SendAudioInputEnd(void *pvUserCtx);
138
139private:
140 /* Note: This is not a ComObjPtr here, because the ConsoleVRDPServer object
141 * is actually just a part of the Console.
142 */
143 Console *mConsole;
144
145 HVRDESERVER mhServer;
146 int mServerInterfaceVersion;
147
148 static int loadVRDPLibrary (const char *pszLibraryName);
149
150 /** Static because will never load this more than once! */
151 static RTLDRMOD mVRDPLibrary;
152
153 static PFNVRDECREATESERVER mpfnVRDECreateServer;
154
155 static VRDEENTRYPOINTS_4 mEntryPoints;
156 static VRDEENTRYPOINTS_4 *mpEntryPoints;
157 static VRDECALLBACKS_4 mCallbacks;
158
159 static DECLCALLBACK(int) VRDPCallbackQueryProperty (void *pvCallback, uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut);
160 static DECLCALLBACK(int) VRDPCallbackClientLogon (void *pvCallback, uint32_t u32ClientId, const char *pszUser, const char *pszPassword, const char *pszDomain);
161 static DECLCALLBACK(void) VRDPCallbackClientConnect (void *pvCallback, uint32_t u32ClientId);
162 static DECLCALLBACK(void) VRDPCallbackClientDisconnect (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercepted);
163 static DECLCALLBACK(int) VRDPCallbackIntercept (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercept, void **ppvIntercept);
164 static DECLCALLBACK(int) VRDPCallbackUSB (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint8_t u8Code, const void *pvRet, uint32_t cbRet);
165 static DECLCALLBACK(int) VRDPCallbackClipboard (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint32_t u32Function, uint32_t u32Format, const void *pvData, uint32_t cbData);
166 static DECLCALLBACK(bool) VRDPCallbackFramebufferQuery (void *pvCallback, unsigned uScreenId, VRDEFRAMEBUFFERINFO *pInfo);
167 static DECLCALLBACK(void) VRDPCallbackFramebufferLock (void *pvCallback, unsigned uScreenId);
168 static DECLCALLBACK(void) VRDPCallbackFramebufferUnlock (void *pvCallback, unsigned uScreenId);
169 static DECLCALLBACK(void) VRDPCallbackInput (void *pvCallback, int type, const void *pvInput, unsigned cbInput);
170 static DECLCALLBACK(void) VRDPCallbackVideoModeHint (void *pvCallback, unsigned cWidth, unsigned cHeight, unsigned cBitsPerPixel, unsigned uScreenId);
171 static DECLCALLBACK(void) VRDECallbackAudioIn (void *pvCallback, void *pvCtx, uint32_t u32ClientId, uint32_t u32Event, const void *pvData, uint32_t cbData);
172
173 bool m_fGuestWantsAbsolute;
174 int m_mousex;
175 int m_mousey;
176
177 IFramebuffer *maFramebuffers[SchemaDefs::MaxGuestMonitors];
178
179 ComPtr<IEventListener> mConsoleListener;
180
181 VRDPInputSynch m_InputSynch;
182
183 int32_t mVRDPBindPort;
184
185 RTCRITSECT mCritSect;
186
187 int lockConsoleVRDPServer (void);
188 void unlockConsoleVRDPServer (void);
189
190 int mcClipboardRefs;
191 HGCMSVCEXTHANDLE mhClipboard;
192 PFNVRDPCLIPBOARDEXTCALLBACK mpfnClipboardCallback;
193
194 static DECLCALLBACK(int) ClipboardCallback (void *pvCallback, uint32_t u32ClientId, uint32_t u32Function, uint32_t u32Format, const void *pvData, uint32_t cbData);
195 static DECLCALLBACK(int) ClipboardServiceExtension (void *pvExtension, uint32_t u32Function, void *pvParm, uint32_t cbParms);
196
197#ifdef VBOX_WITH_USB
198 RemoteUSBBackend *usbBackendFindByUUID (const Guid *pGuid);
199 RemoteUSBBackend *usbBackendFind (uint32_t u32ClientId);
200
201 typedef struct _USBBackends
202 {
203 RemoteUSBBackend *pHead;
204 RemoteUSBBackend *pTail;
205
206 RTTHREAD thread;
207
208 bool fThreadRunning;
209
210 RTSEMEVENT event;
211 } USBBackends;
212
213 USBBackends mUSBBackends;
214
215 void remoteUSBThreadStart (void);
216 void remoteUSBThreadStop (void);
217#endif /* VBOX_WITH_USB */
218
219 /* External authentication library handle. The library is loaded in the
220 * Authenticate method and unloaded at the object destructor.
221 */
222 RTLDRMOD mAuthLibrary;
223 PAUTHENTRY mpfnAuthEntry;
224 PAUTHENTRY2 mpfnAuthEntry2;
225 PAUTHENTRY3 mpfnAuthEntry3;
226
227 uint32_t volatile mu32AudioInputClientId;
228
229 static DECLCALLBACK(void) H3DORBegin(const void *pvContext, void **ppvInstance,
230 const char *pszFormat);
231 static DECLCALLBACK(void) H3DORGeometry(void *pvInstance,
232 int32_t x, int32_t y, uint32_t w, uint32_t h);
233 static DECLCALLBACK(void) H3DORVisibleRegion(void *pvInstance,
234 uint32_t cRects, RTRECT *paRects);
235 static DECLCALLBACK(void) H3DORFrame(void *pvInstance,
236 void *pvData, uint32_t cbData);
237 static DECLCALLBACK(void) H3DOREnd(void *pvInstance);
238 static DECLCALLBACK(int) H3DORContextProperty(const void *pvContext, uint32_t index,
239 void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut);
240
241 void remote3DRedirect(void);
242
243 /*
244 * VRDE server optional interfaces.
245 */
246
247 /* Image update interface. */
248 bool m_fInterfaceImage;
249 VRDEIMAGECALLBACKS m_interfaceCallbacksImage;
250 VRDEIMAGEINTERFACE m_interfaceImage;
251 static DECLCALLBACK(int) VRDEImageCbNotify (void *pvContext,
252 void *pvUser,
253 HVRDEIMAGE hVideo,
254 uint32_t u32Id,
255 void *pvData,
256 uint32_t cbData);
257};
258
259
260class Console;
261
262class ATL_NO_VTABLE VRDEServerInfo :
263 public VirtualBoxBase,
264 VBOX_SCRIPTABLE_IMPL(IVRDEServerInfo)
265{
266public:
267
268 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VRDEServerInfo, IVRDEServerInfo)
269
270 DECLARE_NOT_AGGREGATABLE(VRDEServerInfo)
271
272 DECLARE_PROTECT_FINAL_CONSTRUCT()
273
274 BEGIN_COM_MAP(VRDEServerInfo)
275 VBOX_DEFAULT_INTERFACE_ENTRIES(IVRDEServerInfo)
276 END_COM_MAP()
277
278 DECLARE_EMPTY_CTOR_DTOR (VRDEServerInfo)
279
280 HRESULT FinalConstruct();
281 void FinalRelease();
282
283 /* Public initializer/uninitializer for internal purposes only. */
284 HRESULT init (Console *aParent);
285 void uninit();
286
287 /* IVRDEServerInfo properties */
288 #define DECL_GETTER(_aType, _aName) STDMETHOD(COMGETTER(_aName)) (_aType *a##_aName)
289 DECL_GETTER (BOOL, Active);
290 DECL_GETTER (LONG, Port);
291 DECL_GETTER (ULONG, NumberOfClients);
292 DECL_GETTER (LONG64, BeginTime);
293 DECL_GETTER (LONG64, EndTime);
294 DECL_GETTER (LONG64, BytesSent);
295 DECL_GETTER (LONG64, BytesSentTotal);
296 DECL_GETTER (LONG64, BytesReceived);
297 DECL_GETTER (LONG64, BytesReceivedTotal);
298 DECL_GETTER (BSTR, User);
299 DECL_GETTER (BSTR, Domain);
300 DECL_GETTER (BSTR, ClientName);
301 DECL_GETTER (BSTR, ClientIP);
302 DECL_GETTER (ULONG, ClientVersion);
303 DECL_GETTER (ULONG, EncryptionStyle);
304 #undef DECL_GETTER
305
306private:
307
308 Console * const mParent;
309};
310
311#endif // ____H_CONSOLEVRDPSERVER
312/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette