VirtualBox

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

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

Main,ExtPacks/Puel/UsbWebcam: UsbWebcam intergration.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.6 KB
Line 
1/* $Id: ConsoleVRDPServer.h 37282 2011-06-01 02:56:05Z 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#ifdef VBOX_WITH_USB_VIDEO
139 int GetVideoFrameDimensions(uint16_t *pu16Heigh, uint16_t *pu16Width);
140 int SendVideoSreamOn(bool fFetch);
141#endif
142
143private:
144 /* Note: This is not a ComObjPtr here, because the ConsoleVRDPServer object
145 * is actually just a part of the Console.
146 */
147 Console *mConsole;
148
149 HVRDESERVER mhServer;
150 int mServerInterfaceVersion;
151
152 static int loadVRDPLibrary (const char *pszLibraryName);
153
154 /** Static because will never load this more than once! */
155 static RTLDRMOD mVRDPLibrary;
156
157 static PFNVRDECREATESERVER mpfnVRDECreateServer;
158
159 static VRDEENTRYPOINTS_4 mEntryPoints;
160 static VRDEENTRYPOINTS_4 *mpEntryPoints;
161 static VRDECALLBACKS_4 mCallbacks;
162
163 static DECLCALLBACK(int) VRDPCallbackQueryProperty (void *pvCallback, uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut);
164 static DECLCALLBACK(int) VRDPCallbackClientLogon (void *pvCallback, uint32_t u32ClientId, const char *pszUser, const char *pszPassword, const char *pszDomain);
165 static DECLCALLBACK(void) VRDPCallbackClientConnect (void *pvCallback, uint32_t u32ClientId);
166 static DECLCALLBACK(void) VRDPCallbackClientDisconnect (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercepted);
167 static DECLCALLBACK(int) VRDPCallbackIntercept (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercept, void **ppvIntercept);
168 static DECLCALLBACK(int) VRDPCallbackUSB (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint8_t u8Code, const void *pvRet, uint32_t cbRet);
169 static DECLCALLBACK(int) VRDPCallbackClipboard (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint32_t u32Function, uint32_t u32Format, const void *pvData, uint32_t cbData);
170 static DECLCALLBACK(bool) VRDPCallbackFramebufferQuery (void *pvCallback, unsigned uScreenId, VRDEFRAMEBUFFERINFO *pInfo);
171 static DECLCALLBACK(void) VRDPCallbackFramebufferLock (void *pvCallback, unsigned uScreenId);
172 static DECLCALLBACK(void) VRDPCallbackFramebufferUnlock (void *pvCallback, unsigned uScreenId);
173 static DECLCALLBACK(void) VRDPCallbackInput (void *pvCallback, int type, const void *pvInput, unsigned cbInput);
174 static DECLCALLBACK(void) VRDPCallbackVideoModeHint (void *pvCallback, unsigned cWidth, unsigned cHeight, unsigned cBitsPerPixel, unsigned uScreenId);
175 static DECLCALLBACK(void) VRDECallbackAudioIn (void *pvCallback, void *pvCtx, uint32_t u32ClientId, uint32_t u32Event, const void *pvData, uint32_t cbData);
176
177 bool m_fGuestWantsAbsolute;
178 int m_mousex;
179 int m_mousey;
180
181 IFramebuffer *maFramebuffers[SchemaDefs::MaxGuestMonitors];
182
183 ComPtr<IEventListener> mConsoleListener;
184
185 VRDPInputSynch m_InputSynch;
186
187 int32_t mVRDPBindPort;
188
189 RTCRITSECT mCritSect;
190
191 int lockConsoleVRDPServer (void);
192 void unlockConsoleVRDPServer (void);
193
194 int mcClipboardRefs;
195 HGCMSVCEXTHANDLE mhClipboard;
196 PFNVRDPCLIPBOARDEXTCALLBACK mpfnClipboardCallback;
197
198 static DECLCALLBACK(int) ClipboardCallback (void *pvCallback, uint32_t u32ClientId, uint32_t u32Function, uint32_t u32Format, const void *pvData, uint32_t cbData);
199 static DECLCALLBACK(int) ClipboardServiceExtension (void *pvExtension, uint32_t u32Function, void *pvParm, uint32_t cbParms);
200
201#ifdef VBOX_WITH_USB
202 RemoteUSBBackend *usbBackendFindByUUID (const Guid *pGuid);
203 RemoteUSBBackend *usbBackendFind (uint32_t u32ClientId);
204
205 typedef struct _USBBackends
206 {
207 RemoteUSBBackend *pHead;
208 RemoteUSBBackend *pTail;
209
210 RTTHREAD thread;
211
212 bool fThreadRunning;
213
214 RTSEMEVENT event;
215 } USBBackends;
216
217 USBBackends mUSBBackends;
218
219 void remoteUSBThreadStart (void);
220 void remoteUSBThreadStop (void);
221#endif /* VBOX_WITH_USB */
222
223 /* External authentication library handle. The library is loaded in the
224 * Authenticate method and unloaded at the object destructor.
225 */
226 RTLDRMOD mAuthLibrary;
227 PAUTHENTRY mpfnAuthEntry;
228 PAUTHENTRY2 mpfnAuthEntry2;
229 PAUTHENTRY3 mpfnAuthEntry3;
230
231 uint32_t volatile mu32AudioInputClientId;
232
233 static DECLCALLBACK(void) H3DORBegin(const void *pvContext, void **ppvInstance,
234 const char *pszFormat);
235 static DECLCALLBACK(void) H3DORGeometry(void *pvInstance,
236 int32_t x, int32_t y, uint32_t w, uint32_t h);
237 static DECLCALLBACK(void) H3DORVisibleRegion(void *pvInstance,
238 uint32_t cRects, RTRECT *paRects);
239 static DECLCALLBACK(void) H3DORFrame(void *pvInstance,
240 void *pvData, uint32_t cbData);
241 static DECLCALLBACK(void) H3DOREnd(void *pvInstance);
242 static DECLCALLBACK(int) H3DORContextProperty(const void *pvContext, uint32_t index,
243 void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut);
244
245 void remote3DRedirect(void);
246
247 /*
248 * VRDE server optional interfaces.
249 */
250
251 /* Image update interface. */
252 bool m_fInterfaceImage;
253 VRDEIMAGECALLBACKS m_interfaceCallbacksImage;
254 VRDEIMAGEINTERFACE m_interfaceImage;
255 static DECLCALLBACK(int) VRDEImageCbNotify (void *pvContext,
256 void *pvUser,
257 HVRDEIMAGE hVideo,
258 uint32_t u32Id,
259 void *pvData,
260 uint32_t cbData);
261};
262
263
264class Console;
265
266class ATL_NO_VTABLE VRDEServerInfo :
267 public VirtualBoxBase,
268 VBOX_SCRIPTABLE_IMPL(IVRDEServerInfo)
269{
270public:
271
272 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VRDEServerInfo, IVRDEServerInfo)
273
274 DECLARE_NOT_AGGREGATABLE(VRDEServerInfo)
275
276 DECLARE_PROTECT_FINAL_CONSTRUCT()
277
278 BEGIN_COM_MAP(VRDEServerInfo)
279 VBOX_DEFAULT_INTERFACE_ENTRIES(IVRDEServerInfo)
280 END_COM_MAP()
281
282 DECLARE_EMPTY_CTOR_DTOR (VRDEServerInfo)
283
284 HRESULT FinalConstruct();
285 void FinalRelease();
286
287 /* Public initializer/uninitializer for internal purposes only. */
288 HRESULT init (Console *aParent);
289 void uninit();
290
291 /* IVRDEServerInfo properties */
292 #define DECL_GETTER(_aType, _aName) STDMETHOD(COMGETTER(_aName)) (_aType *a##_aName)
293 DECL_GETTER (BOOL, Active);
294 DECL_GETTER (LONG, Port);
295 DECL_GETTER (ULONG, NumberOfClients);
296 DECL_GETTER (LONG64, BeginTime);
297 DECL_GETTER (LONG64, EndTime);
298 DECL_GETTER (LONG64, BytesSent);
299 DECL_GETTER (LONG64, BytesSentTotal);
300 DECL_GETTER (LONG64, BytesReceived);
301 DECL_GETTER (LONG64, BytesReceivedTotal);
302 DECL_GETTER (BSTR, User);
303 DECL_GETTER (BSTR, Domain);
304 DECL_GETTER (BSTR, ClientName);
305 DECL_GETTER (BSTR, ClientIP);
306 DECL_GETTER (ULONG, ClientVersion);
307 DECL_GETTER (ULONG, EncryptionStyle);
308 #undef DECL_GETTER
309
310private:
311
312 Console * const mParent;
313};
314
315#endif // ____H_CONSOLEVRDPSERVER
316/* 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