VirtualBox

source: vbox/trunk/src/VBox/Main/src-client/ConsoleVRDPServer.cpp@ 52934

最後變更 在這個檔案從52934是 52923,由 vboxsync 提交於 10 年 前

ConsoleVRDPServer: update the mouse pointer when the VRDP server is started.
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 138.5 KB
行 
1/* $Id: ConsoleVRDPServer.cpp 52923 2014-10-02 07:04:02Z vboxsync $ */
2/** @file
3 * VBox Console VRDP Helper class
4 */
5
6/*
7 * Copyright (C) 2006-2014 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.alldomusa.eu.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#include "ConsoleVRDPServer.h"
19#include "ConsoleImpl.h"
20#include "DisplayImpl.h"
21#include "KeyboardImpl.h"
22#include "MouseImpl.h"
23#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
24#include "DrvAudioVRDE.h"
25#else
26#include "AudioSnifferInterface.h"
27#endif
28#ifdef VBOX_WITH_EXTPACK
29# include "ExtPackManagerImpl.h"
30#endif
31#include "VMMDev.h"
32#ifdef VBOX_WITH_USB_CARDREADER
33# include "UsbCardReader.h"
34#endif
35#include "UsbWebcamInterface.h"
36
37#include "Global.h"
38#include "AutoCaller.h"
39#include "Logging.h"
40
41#include <iprt/asm.h>
42#include <iprt/alloca.h>
43#include <iprt/ldr.h>
44#include <iprt/param.h>
45#include <iprt/path.h>
46#include <iprt/cpp/utils.h>
47
48#include <VBox/err.h>
49#include <VBox/RemoteDesktop/VRDEOrders.h>
50#include <VBox/com/listeners.h>
51#include <VBox/HostServices/VBoxCrOpenGLSvc.h>
52
53class VRDPConsoleListener
54{
55public:
56 VRDPConsoleListener()
57 {
58 }
59
60 HRESULT init(ConsoleVRDPServer *server)
61 {
62 m_server = server;
63 return S_OK;
64 }
65
66 void uninit()
67 {
68 }
69
70 STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent * aEvent)
71 {
72 switch (aType)
73 {
74 case VBoxEventType_OnMousePointerShapeChanged:
75 {
76 ComPtr<IMousePointerShapeChangedEvent> mpscev = aEvent;
77 Assert(mpscev);
78 BOOL visible, alpha;
79 ULONG xHot, yHot, width, height;
80 com::SafeArray <BYTE> shape;
81
82 mpscev->COMGETTER(Visible)(&visible);
83 mpscev->COMGETTER(Alpha)(&alpha);
84 mpscev->COMGETTER(Xhot)(&xHot);
85 mpscev->COMGETTER(Yhot)(&yHot);
86 mpscev->COMGETTER(Width)(&width);
87 mpscev->COMGETTER(Height)(&height);
88 mpscev->COMGETTER(Shape)(ComSafeArrayAsOutParam(shape));
89
90 m_server->onMousePointerShapeChange(visible, alpha, xHot, yHot, width, height, ComSafeArrayAsInParam(shape));
91 break;
92 }
93 case VBoxEventType_OnMouseCapabilityChanged:
94 {
95 ComPtr<IMouseCapabilityChangedEvent> mccev = aEvent;
96 Assert(mccev);
97 if (m_server)
98 {
99 BOOL fAbsoluteMouse;
100 mccev->COMGETTER(SupportsAbsolute)(&fAbsoluteMouse);
101 m_server->NotifyAbsoluteMouse(!!fAbsoluteMouse);
102 }
103 break;
104 }
105 case VBoxEventType_OnKeyboardLedsChanged:
106 {
107 ComPtr<IKeyboardLedsChangedEvent> klcev = aEvent;
108 Assert(klcev);
109
110 if (m_server)
111 {
112 BOOL fNumLock, fCapsLock, fScrollLock;
113 klcev->COMGETTER(NumLock)(&fNumLock);
114 klcev->COMGETTER(CapsLock)(&fCapsLock);
115 klcev->COMGETTER(ScrollLock)(&fScrollLock);
116 m_server->NotifyKeyboardLedsChange(fNumLock, fCapsLock, fScrollLock);
117 }
118 break;
119 }
120
121 default:
122 AssertFailed();
123 }
124
125 return S_OK;
126 }
127
128private:
129 ConsoleVRDPServer *m_server;
130};
131
132typedef ListenerImpl<VRDPConsoleListener, ConsoleVRDPServer*> VRDPConsoleListenerImpl;
133
134VBOX_LISTENER_DECLARE(VRDPConsoleListenerImpl)
135
136#ifdef DEBUG_sunlover
137#define LOGDUMPPTR Log
138void dumpPointer(const uint8_t *pu8Shape, uint32_t width, uint32_t height, bool fXorMaskRGB32)
139{
140 unsigned i;
141
142 const uint8_t *pu8And = pu8Shape;
143
144 for (i = 0; i < height; i++)
145 {
146 unsigned j;
147 LOGDUMPPTR(("%p: ", pu8And));
148 for (j = 0; j < (width + 7) / 8; j++)
149 {
150 unsigned k;
151 for (k = 0; k < 8; k++)
152 {
153 LOGDUMPPTR(("%d", ((*pu8And) & (1 << (7 - k)))? 1: 0));
154 }
155
156 pu8And++;
157 }
158 LOGDUMPPTR(("\n"));
159 }
160
161 if (fXorMaskRGB32)
162 {
163 uint32_t *pu32Xor = (uint32_t*)(pu8Shape + ((((width + 7) / 8) * height + 3) & ~3));
164
165 for (i = 0; i < height; i++)
166 {
167 unsigned j;
168 LOGDUMPPTR(("%p: ", pu32Xor));
169 for (j = 0; j < width; j++)
170 {
171 LOGDUMPPTR(("%08X", *pu32Xor++));
172 }
173 LOGDUMPPTR(("\n"));
174 }
175 }
176 else
177 {
178 /* RDP 24 bit RGB mask. */
179 uint8_t *pu8Xor = (uint8_t*)(pu8Shape + ((((width + 7) / 8) * height + 3) & ~3));
180 for (i = 0; i < height; i++)
181 {
182 unsigned j;
183 LOGDUMPPTR(("%p: ", pu8Xor));
184 for (j = 0; j < width; j++)
185 {
186 LOGDUMPPTR(("%02X%02X%02X", pu8Xor[2], pu8Xor[1], pu8Xor[0]));
187 pu8Xor += 3;
188 }
189 LOGDUMPPTR(("\n"));
190 }
191 }
192}
193#else
194#define dumpPointer(a, b, c, d) do {} while (0)
195#endif /* DEBUG_sunlover */
196
197static void findTopLeftBorder(const uint8_t *pu8AndMask, const uint8_t *pu8XorMask, uint32_t width,
198 uint32_t height, uint32_t *pxSkip, uint32_t *pySkip)
199{
200 /*
201 * Find the top border of the AND mask. First assign to special value.
202 */
203 uint32_t ySkipAnd = ~0;
204
205 const uint8_t *pu8And = pu8AndMask;
206 const uint32_t cbAndRow = (width + 7) / 8;
207 const uint8_t maskLastByte = (uint8_t)( 0xFF << (cbAndRow * 8 - width) );
208
209 Assert(cbAndRow > 0);
210
211 unsigned y;
212 unsigned x;
213
214 for (y = 0; y < height && ySkipAnd == ~(uint32_t)0; y++, pu8And += cbAndRow)
215 {
216 /* For each complete byte in the row. */
217 for (x = 0; x < cbAndRow - 1; x++)
218 {
219 if (pu8And[x] != 0xFF)
220 {
221 ySkipAnd = y;
222 break;
223 }
224 }
225
226 if (ySkipAnd == ~(uint32_t)0)
227 {
228 /* Last byte. */
229 if ((pu8And[cbAndRow - 1] & maskLastByte) != maskLastByte)
230 {
231 ySkipAnd = y;
232 }
233 }
234 }
235
236 if (ySkipAnd == ~(uint32_t)0)
237 {
238 ySkipAnd = 0;
239 }
240
241 /*
242 * Find the left border of the AND mask.
243 */
244 uint32_t xSkipAnd = ~0;
245
246 /* For all bit columns. */
247 for (x = 0; x < width && xSkipAnd == ~(uint32_t)0; x++)
248 {
249 pu8And = pu8AndMask + x/8; /* Currently checking byte. */
250 uint8_t mask = 1 << (7 - x%8); /* Currently checking bit in the byte. */
251
252 for (y = ySkipAnd; y < height; y++, pu8And += cbAndRow)
253 {
254 if ((*pu8And & mask) == 0)
255 {
256 xSkipAnd = x;
257 break;
258 }
259 }
260 }
261
262 if (xSkipAnd == ~(uint32_t)0)
263 {
264 xSkipAnd = 0;
265 }
266
267 /*
268 * Find the XOR mask top border.
269 */
270 uint32_t ySkipXor = ~0;
271
272 uint32_t *pu32XorStart = (uint32_t *)pu8XorMask;
273
274 uint32_t *pu32Xor = pu32XorStart;
275
276 for (y = 0; y < height && ySkipXor == ~(uint32_t)0; y++, pu32Xor += width)
277 {
278 for (x = 0; x < width; x++)
279 {
280 if (pu32Xor[x] != 0)
281 {
282 ySkipXor = y;
283 break;
284 }
285 }
286 }
287
288 if (ySkipXor == ~(uint32_t)0)
289 {
290 ySkipXor = 0;
291 }
292
293 /*
294 * Find the left border of the XOR mask.
295 */
296 uint32_t xSkipXor = ~(uint32_t)0;
297
298 /* For all columns. */
299 for (x = 0; x < width && xSkipXor == ~(uint32_t)0; x++)
300 {
301 pu32Xor = pu32XorStart + x; /* Currently checking dword. */
302
303 for (y = ySkipXor; y < height; y++, pu32Xor += width)
304 {
305 if (*pu32Xor != 0)
306 {
307 xSkipXor = x;
308 break;
309 }
310 }
311 }
312
313 if (xSkipXor == ~(uint32_t)0)
314 {
315 xSkipXor = 0;
316 }
317
318 *pxSkip = RT_MIN(xSkipAnd, xSkipXor);
319 *pySkip = RT_MIN(ySkipAnd, ySkipXor);
320}
321
322/* Generate an AND mask for alpha pointers here, because
323 * guest driver does not do that correctly for Vista pointers.
324 * Similar fix, changing the alpha threshold, could be applied
325 * for the guest driver, but then additions reinstall would be
326 * necessary, which we try to avoid.
327 */
328static void mousePointerGenerateANDMask(uint8_t *pu8DstAndMask, int cbDstAndMask, const uint8_t *pu8SrcAlpha, int w, int h)
329{
330 memset(pu8DstAndMask, 0xFF, cbDstAndMask);
331
332 int y;
333 for (y = 0; y < h; y++)
334 {
335 uint8_t bitmask = 0x80;
336
337 int x;
338 for (x = 0; x < w; x++, bitmask >>= 1)
339 {
340 if (bitmask == 0)
341 {
342 bitmask = 0x80;
343 }
344
345 /* Whether alpha channel value is not transparent enough for the pixel to be seen. */
346 if (pu8SrcAlpha[x * 4 + 3] > 0x7f)
347 {
348 pu8DstAndMask[x / 8] &= ~bitmask;
349 }
350 }
351
352 /* Point to next source and dest scans. */
353 pu8SrcAlpha += w * 4;
354 pu8DstAndMask += (w + 7) / 8;
355 }
356}
357
358void ConsoleVRDPServer::onMousePointerShapeChange(BOOL visible,
359 BOOL alpha,
360 ULONG xHot,
361 ULONG yHot,
362 ULONG width,
363 ULONG height,
364 ComSafeArrayIn(BYTE,inShape))
365{
366 LogSunlover(("VRDPConsoleListener::OnMousePointerShapeChange: %d, %d, %lux%lu, @%lu,%lu\n",
367 visible, alpha, width, height, xHot, yHot));
368
369 com::SafeArray <BYTE> aShape(ComSafeArrayInArg(inShape));
370 if (aShape.size() == 0)
371 {
372 if (!visible)
373 {
374 MousePointerHide();
375 }
376 }
377 else if (width != 0 && height != 0)
378 {
379 uint8_t* shape = aShape.raw();
380
381 dumpPointer(shape, width, height, true);
382
383 /* Try the new interface. */
384 if (MousePointer(alpha, xHot, yHot, width, height, shape) == VINF_SUCCESS)
385 {
386 return;
387 }
388
389 /* Continue with the old interface. */
390
391 /* Pointer consists of 1 bpp AND and 24 BPP XOR masks.
392 * 'shape' AND mask followed by XOR mask.
393 * XOR mask contains 32 bit (lsb)BGR0(msb) values.
394 *
395 * We convert this to RDP color format which consist of
396 * one bpp AND mask and 24 BPP (BGR) color XOR image.
397 *
398 * RDP clients expect 8 aligned width and height of
399 * pointer (preferably 32x32).
400 *
401 * They even contain bugs which do not appear for
402 * 32x32 pointers but would appear for a 41x32 one.
403 *
404 * So set pointer size to 32x32. This can be done safely
405 * because most pointers are 32x32.
406 */
407
408 int cbDstAndMask = (((width + 7) / 8) * height + 3) & ~3;
409
410 uint8_t *pu8AndMask = shape;
411 uint8_t *pu8XorMask = shape + cbDstAndMask;
412
413 if (alpha)
414 {
415 pu8AndMask = (uint8_t*)alloca(cbDstAndMask);
416
417 mousePointerGenerateANDMask(pu8AndMask, cbDstAndMask, pu8XorMask, width, height);
418 }
419
420 /* Windows guest alpha pointers are wider than 32 pixels.
421 * Try to find out the top-left border of the pointer and
422 * then copy only meaningful bits. All complete top rows
423 * and all complete left columns where (AND == 1 && XOR == 0)
424 * are skipped. Hot spot is adjusted.
425 */
426 uint32_t ySkip = 0; /* How many rows to skip at the top. */
427 uint32_t xSkip = 0; /* How many columns to skip at the left. */
428
429 findTopLeftBorder(pu8AndMask, pu8XorMask, width, height, &xSkip, &ySkip);
430
431 /* Must not skip the hot spot. */
432 xSkip = RT_MIN(xSkip, xHot);
433 ySkip = RT_MIN(ySkip, yHot);
434
435 /*
436 * Compute size and allocate memory for the pointer.
437 */
438 const uint32_t dstwidth = 32;
439 const uint32_t dstheight = 32;
440
441 VRDECOLORPOINTER *pointer = NULL;
442
443 uint32_t dstmaskwidth = (dstwidth + 7) / 8;
444
445 uint32_t rdpmaskwidth = dstmaskwidth;
446 uint32_t rdpmasklen = dstheight * rdpmaskwidth;
447
448 uint32_t rdpdatawidth = dstwidth * 3;
449 uint32_t rdpdatalen = dstheight * rdpdatawidth;
450
451 pointer = (VRDECOLORPOINTER *)RTMemTmpAlloc(sizeof(VRDECOLORPOINTER) + rdpmasklen + rdpdatalen);
452
453 if (pointer)
454 {
455 uint8_t *maskarray = (uint8_t*)pointer + sizeof(VRDECOLORPOINTER);
456 uint8_t *dataarray = maskarray + rdpmasklen;
457
458 memset(maskarray, 0xFF, rdpmasklen);
459 memset(dataarray, 0x00, rdpdatalen);
460
461 uint32_t srcmaskwidth = (width + 7) / 8;
462 uint32_t srcdatawidth = width * 4;
463
464 /* Copy AND mask. */
465 uint8_t *src = pu8AndMask + ySkip * srcmaskwidth;
466 uint8_t *dst = maskarray + (dstheight - 1) * rdpmaskwidth;
467
468 uint32_t minheight = RT_MIN(height - ySkip, dstheight);
469 uint32_t minwidth = RT_MIN(width - xSkip, dstwidth);
470
471 unsigned x, y;
472
473 for (y = 0; y < minheight; y++)
474 {
475 for (x = 0; x < minwidth; x++)
476 {
477 uint32_t byteIndex = (x + xSkip) / 8;
478 uint32_t bitIndex = (x + xSkip) % 8;
479
480 bool bit = (src[byteIndex] & (1 << (7 - bitIndex))) != 0;
481
482 if (!bit)
483 {
484 byteIndex = x / 8;
485 bitIndex = x % 8;
486
487 dst[byteIndex] &= ~(1 << (7 - bitIndex));
488 }
489 }
490
491 src += srcmaskwidth;
492 dst -= rdpmaskwidth;
493 }
494
495 /* Point src to XOR mask */
496 src = pu8XorMask + ySkip * srcdatawidth;
497 dst = dataarray + (dstheight - 1) * rdpdatawidth;
498
499 for (y = 0; y < minheight ; y++)
500 {
501 for (x = 0; x < minwidth; x++)
502 {
503 memcpy(dst + x * 3, &src[4 * (x + xSkip)], 3);
504 }
505
506 src += srcdatawidth;
507 dst -= rdpdatawidth;
508 }
509
510 pointer->u16HotX = (uint16_t)(xHot - xSkip);
511 pointer->u16HotY = (uint16_t)(yHot - ySkip);
512
513 pointer->u16Width = (uint16_t)dstwidth;
514 pointer->u16Height = (uint16_t)dstheight;
515
516 pointer->u16MaskLen = (uint16_t)rdpmasklen;
517 pointer->u16DataLen = (uint16_t)rdpdatalen;
518
519 dumpPointer((uint8_t*)pointer + sizeof(*pointer), dstwidth, dstheight, false);
520
521 MousePointerUpdate(pointer);
522
523 RTMemTmpFree(pointer);
524 }
525 }
526}
527
528
529// ConsoleVRDPServer
530////////////////////////////////////////////////////////////////////////////////
531
532RTLDRMOD ConsoleVRDPServer::mVRDPLibrary = NIL_RTLDRMOD;
533
534PFNVRDECREATESERVER ConsoleVRDPServer::mpfnVRDECreateServer = NULL;
535
536VRDEENTRYPOINTS_4 ConsoleVRDPServer::mEntryPoints; /* A copy of the server entry points. */
537VRDEENTRYPOINTS_4 *ConsoleVRDPServer::mpEntryPoints = NULL;
538
539VRDECALLBACKS_4 ConsoleVRDPServer::mCallbacks =
540{
541 { VRDE_INTERFACE_VERSION_4, sizeof(VRDECALLBACKS_4) },
542 ConsoleVRDPServer::VRDPCallbackQueryProperty,
543 ConsoleVRDPServer::VRDPCallbackClientLogon,
544 ConsoleVRDPServer::VRDPCallbackClientConnect,
545 ConsoleVRDPServer::VRDPCallbackClientDisconnect,
546 ConsoleVRDPServer::VRDPCallbackIntercept,
547 ConsoleVRDPServer::VRDPCallbackUSB,
548 ConsoleVRDPServer::VRDPCallbackClipboard,
549 ConsoleVRDPServer::VRDPCallbackFramebufferQuery,
550 ConsoleVRDPServer::VRDPCallbackFramebufferLock,
551 ConsoleVRDPServer::VRDPCallbackFramebufferUnlock,
552 ConsoleVRDPServer::VRDPCallbackInput,
553 ConsoleVRDPServer::VRDPCallbackVideoModeHint,
554 ConsoleVRDPServer::VRDECallbackAudioIn
555};
556
557DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackQueryProperty(void *pvCallback, uint32_t index, void *pvBuffer,
558 uint32_t cbBuffer, uint32_t *pcbOut)
559{
560 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
561
562 int rc = VERR_NOT_SUPPORTED;
563
564 switch (index)
565 {
566 case VRDE_QP_NETWORK_PORT:
567 {
568 /* This is obsolete, the VRDE server uses VRDE_QP_NETWORK_PORT_RANGE instead. */
569 ULONG port = 0;
570
571 if (cbBuffer >= sizeof(uint32_t))
572 {
573 *(uint32_t *)pvBuffer = (uint32_t)port;
574 rc = VINF_SUCCESS;
575 }
576 else
577 {
578 rc = VINF_BUFFER_OVERFLOW;
579 }
580
581 *pcbOut = sizeof(uint32_t);
582 } break;
583
584 case VRDE_QP_NETWORK_ADDRESS:
585 {
586 com::Bstr bstr;
587 server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("TCP/Address").raw(), bstr.asOutParam());
588
589 /* The server expects UTF8. */
590 com::Utf8Str address = bstr;
591
592 size_t cbAddress = address.length() + 1;
593
594 if (cbAddress >= 0x10000)
595 {
596 /* More than 64K seems to be an invalid address. */
597 rc = VERR_TOO_MUCH_DATA;
598 break;
599 }
600
601 if ((size_t)cbBuffer >= cbAddress)
602 {
603 memcpy(pvBuffer, address.c_str(), cbAddress);
604 rc = VINF_SUCCESS;
605 }
606 else
607 {
608 rc = VINF_BUFFER_OVERFLOW;
609 }
610
611 *pcbOut = (uint32_t)cbAddress;
612 } break;
613
614 case VRDE_QP_NUMBER_MONITORS:
615 {
616 ULONG cMonitors = 1;
617
618 server->mConsole->i_machine()->COMGETTER(MonitorCount)(&cMonitors);
619
620 if (cbBuffer >= sizeof(uint32_t))
621 {
622 *(uint32_t *)pvBuffer = (uint32_t)cMonitors;
623 rc = VINF_SUCCESS;
624 }
625 else
626 {
627 rc = VINF_BUFFER_OVERFLOW;
628 }
629
630 *pcbOut = sizeof(uint32_t);
631 } break;
632
633 case VRDE_QP_NETWORK_PORT_RANGE:
634 {
635 com::Bstr bstr;
636 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("TCP/Ports").raw(), bstr.asOutParam());
637
638 if (hrc != S_OK)
639 {
640 bstr = "";
641 }
642
643 if (bstr == "0")
644 {
645 bstr = "3389";
646 }
647
648 /* The server expects UTF8. */
649 com::Utf8Str portRange = bstr;
650
651 size_t cbPortRange = portRange.length() + 1;
652
653 if (cbPortRange >= 0x10000)
654 {
655 /* More than 64K seems to be an invalid port range string. */
656 rc = VERR_TOO_MUCH_DATA;
657 break;
658 }
659
660 if ((size_t)cbBuffer >= cbPortRange)
661 {
662 memcpy(pvBuffer, portRange.c_str(), cbPortRange);
663 rc = VINF_SUCCESS;
664 }
665 else
666 {
667 rc = VINF_BUFFER_OVERFLOW;
668 }
669
670 *pcbOut = (uint32_t)cbPortRange;
671 } break;
672
673 case VRDE_QP_VIDEO_CHANNEL:
674 {
675 com::Bstr bstr;
676 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("VideoChannel/Enabled").raw(),
677 bstr.asOutParam());
678
679 if (hrc != S_OK)
680 {
681 bstr = "";
682 }
683
684 com::Utf8Str value = bstr;
685
686 BOOL fVideoEnabled = RTStrICmp(value.c_str(), "true") == 0
687 || RTStrICmp(value.c_str(), "1") == 0;
688
689 if (cbBuffer >= sizeof(uint32_t))
690 {
691 *(uint32_t *)pvBuffer = (uint32_t)fVideoEnabled;
692 rc = VINF_SUCCESS;
693 }
694 else
695 {
696 rc = VINF_BUFFER_OVERFLOW;
697 }
698
699 *pcbOut = sizeof(uint32_t);
700 } break;
701
702 case VRDE_QP_VIDEO_CHANNEL_QUALITY:
703 {
704 com::Bstr bstr;
705 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("VideoChannel/Quality").raw(),
706 bstr.asOutParam());
707
708 if (hrc != S_OK)
709 {
710 bstr = "";
711 }
712
713 com::Utf8Str value = bstr;
714
715 ULONG ulQuality = RTStrToUInt32(value.c_str()); /* This returns 0 on invalid string which is ok. */
716
717 if (cbBuffer >= sizeof(uint32_t))
718 {
719 *(uint32_t *)pvBuffer = (uint32_t)ulQuality;
720 rc = VINF_SUCCESS;
721 }
722 else
723 {
724 rc = VINF_BUFFER_OVERFLOW;
725 }
726
727 *pcbOut = sizeof(uint32_t);
728 } break;
729
730 case VRDE_QP_VIDEO_CHANNEL_SUNFLSH:
731 {
732 ULONG ulSunFlsh = 1;
733
734 com::Bstr bstr;
735 HRESULT hrc = server->mConsole->i_machine()->GetExtraData(Bstr("VRDP/SunFlsh").raw(),
736 bstr.asOutParam());
737 if (hrc == S_OK && !bstr.isEmpty())
738 {
739 com::Utf8Str sunFlsh = bstr;
740 if (!sunFlsh.isEmpty())
741 {
742 ulSunFlsh = sunFlsh.toUInt32();
743 }
744 }
745
746 if (cbBuffer >= sizeof(uint32_t))
747 {
748 *(uint32_t *)pvBuffer = (uint32_t)ulSunFlsh;
749 rc = VINF_SUCCESS;
750 }
751 else
752 {
753 rc = VINF_BUFFER_OVERFLOW;
754 }
755
756 *pcbOut = sizeof(uint32_t);
757 } break;
758
759 case VRDE_QP_FEATURE:
760 {
761 if (cbBuffer < sizeof(VRDEFEATURE))
762 {
763 rc = VERR_INVALID_PARAMETER;
764 break;
765 }
766
767 size_t cbInfo = cbBuffer - RT_OFFSETOF(VRDEFEATURE, achInfo);
768
769 VRDEFEATURE *pFeature = (VRDEFEATURE *)pvBuffer;
770
771 size_t cchInfo = 0;
772 rc = RTStrNLenEx(pFeature->achInfo, cbInfo, &cchInfo);
773
774 if (RT_FAILURE(rc))
775 {
776 rc = VERR_INVALID_PARAMETER;
777 break;
778 }
779
780 Log(("VRDE_QP_FEATURE [%s]\n", pFeature->achInfo));
781
782 com::Bstr bstrValue;
783
784 if ( RTStrICmp(pFeature->achInfo, "Client/DisableDisplay") == 0
785 || RTStrICmp(pFeature->achInfo, "Client/DisableInput") == 0
786 || RTStrICmp(pFeature->achInfo, "Client/DisableAudio") == 0
787 || RTStrICmp(pFeature->achInfo, "Client/DisableUSB") == 0
788 || RTStrICmp(pFeature->achInfo, "Client/DisableClipboard") == 0
789 )
790 {
791 /* @todo these features should be per client. */
792 NOREF(pFeature->u32ClientId);
793
794 /* These features are mapped to "VRDE/Feature/NAME" extra data. */
795 com::Utf8Str extraData("VRDE/Feature/");
796 extraData += pFeature->achInfo;
797
798 HRESULT hrc = server->mConsole->i_machine()->GetExtraData(com::Bstr(extraData).raw(),
799 bstrValue.asOutParam());
800 if (FAILED(hrc) || bstrValue.isEmpty())
801 {
802 /* Also try the old "VRDP/Feature/NAME" */
803 extraData = "VRDP/Feature/";
804 extraData += pFeature->achInfo;
805
806 hrc = server->mConsole->i_machine()->GetExtraData(com::Bstr(extraData).raw(),
807 bstrValue.asOutParam());
808 if (FAILED(hrc))
809 {
810 rc = VERR_NOT_SUPPORTED;
811 }
812 }
813 }
814 else if (RTStrNCmp(pFeature->achInfo, "Property/", 9) == 0)
815 {
816 /* Generic properties. */
817 const char *pszPropertyName = &pFeature->achInfo[9];
818 HRESULT hrc = server->mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr(pszPropertyName).raw(),
819 bstrValue.asOutParam());
820 if (FAILED(hrc))
821 {
822 rc = VERR_NOT_SUPPORTED;
823 }
824 }
825 else
826 {
827 rc = VERR_NOT_SUPPORTED;
828 }
829
830 /* Copy the value string to the callers buffer. */
831 if (rc == VINF_SUCCESS)
832 {
833 com::Utf8Str value = bstrValue;
834
835 size_t cb = value.length() + 1;
836
837 if ((size_t)cbInfo >= cb)
838 {
839 memcpy(pFeature->achInfo, value.c_str(), cb);
840 }
841 else
842 {
843 rc = VINF_BUFFER_OVERFLOW;
844 }
845
846 *pcbOut = (uint32_t)cb;
847 }
848 } break;
849
850 case VRDE_SP_NETWORK_BIND_PORT:
851 {
852 if (cbBuffer != sizeof(uint32_t))
853 {
854 rc = VERR_INVALID_PARAMETER;
855 break;
856 }
857
858 ULONG port = *(uint32_t *)pvBuffer;
859
860 server->mVRDPBindPort = port;
861
862 rc = VINF_SUCCESS;
863
864 if (pcbOut)
865 {
866 *pcbOut = sizeof(uint32_t);
867 }
868
869 server->mConsole->i_onVRDEServerInfoChange();
870 } break;
871
872 case VRDE_SP_CLIENT_STATUS:
873 {
874 if (cbBuffer < sizeof(VRDECLIENTSTATUS))
875 {
876 rc = VERR_INVALID_PARAMETER;
877 break;
878 }
879
880 size_t cbStatus = cbBuffer - RT_UOFFSETOF(VRDECLIENTSTATUS, achStatus);
881
882 VRDECLIENTSTATUS *pStatus = (VRDECLIENTSTATUS *)pvBuffer;
883
884 if (cbBuffer < RT_UOFFSETOF(VRDECLIENTSTATUS, achStatus) + pStatus->cbStatus)
885 {
886 rc = VERR_INVALID_PARAMETER;
887 break;
888 }
889
890 size_t cchStatus = 0;
891 rc = RTStrNLenEx(pStatus->achStatus, cbStatus, &cchStatus);
892
893 if (RT_FAILURE(rc))
894 {
895 rc = VERR_INVALID_PARAMETER;
896 break;
897 }
898
899 Log(("VRDE_SP_CLIENT_STATUS [%s]\n", pStatus->achStatus));
900
901 server->mConsole->i_VRDPClientStatusChange(pStatus->u32ClientId, pStatus->achStatus);
902
903 rc = VINF_SUCCESS;
904
905 if (pcbOut)
906 {
907 *pcbOut = cbBuffer;
908 }
909
910 server->mConsole->i_onVRDEServerInfoChange();
911 } break;
912
913 default:
914 break;
915 }
916
917 return rc;
918}
919
920DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackClientLogon(void *pvCallback, uint32_t u32ClientId, const char *pszUser,
921 const char *pszPassword, const char *pszDomain)
922{
923 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
924
925 return server->mConsole->i_VRDPClientLogon(u32ClientId, pszUser, pszPassword, pszDomain);
926}
927
928DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackClientConnect(void *pvCallback, uint32_t u32ClientId)
929{
930 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
931
932 server->mConsole->i_VRDPClientConnect(u32ClientId);
933
934 /* Should the server report usage of an interface for each client?
935 * Similar to Intercept.
936 */
937 int c = ASMAtomicIncS32(&server->mcClients);
938 if (c == 1)
939 {
940 /* Features which should be enabled only if there is a client. */
941 server->remote3DRedirect(true);
942 }
943}
944
945DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackClientDisconnect(void *pvCallback, uint32_t u32ClientId,
946 uint32_t fu32Intercepted)
947{
948 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
949
950 server->mConsole->i_VRDPClientDisconnect(u32ClientId, fu32Intercepted);
951
952 if (ASMAtomicReadU32(&server->mu32AudioInputClientId) == u32ClientId)
953 {
954 Log(("AUDIOIN: disconnected client %u\n", u32ClientId));
955 ASMAtomicWriteU32(&server->mu32AudioInputClientId, 0);
956
957#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
958 server->mConsole->getAudioVRDE()->handleVRDESvrCmdAudioInputIntercept(false);
959#else
960 PPDMIAUDIOSNIFFERPORT pPort = server->mConsole->i_getAudioSniffer()->getAudioSnifferPort();
961 if (pPort)
962 {
963 pPort->pfnAudioInputIntercept(pPort, false);
964 }
965 else
966 {
967 AssertFailed();
968 }
969#endif
970 }
971
972 int c = ASMAtomicDecS32(&server->mcClients);
973 if (c == 0)
974 {
975 /* Features which should be enabled only if there is a client. */
976 server->remote3DRedirect(false);
977 }
978}
979
980DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackIntercept(void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercept,
981 void **ppvIntercept)
982{
983 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
984
985 LogFlowFunc(("%x\n", fu32Intercept));
986
987 int rc = VERR_NOT_SUPPORTED;
988
989 switch (fu32Intercept)
990 {
991 case VRDE_CLIENT_INTERCEPT_AUDIO:
992 {
993 server->mConsole->i_VRDPInterceptAudio(u32ClientId);
994 if (ppvIntercept)
995 {
996 *ppvIntercept = server;
997 }
998 rc = VINF_SUCCESS;
999 } break;
1000
1001 case VRDE_CLIENT_INTERCEPT_USB:
1002 {
1003 server->mConsole->i_VRDPInterceptUSB(u32ClientId, ppvIntercept);
1004 rc = VINF_SUCCESS;
1005 } break;
1006
1007 case VRDE_CLIENT_INTERCEPT_CLIPBOARD:
1008 {
1009 server->mConsole->i_VRDPInterceptClipboard(u32ClientId);
1010 if (ppvIntercept)
1011 {
1012 *ppvIntercept = server;
1013 }
1014 rc = VINF_SUCCESS;
1015 } break;
1016
1017 case VRDE_CLIENT_INTERCEPT_AUDIO_INPUT:
1018 {
1019 /* This request is processed internally by the ConsoleVRDPServer.
1020 * Only one client is allowed to intercept audio input.
1021 */
1022 if (ASMAtomicCmpXchgU32(&server->mu32AudioInputClientId, u32ClientId, 0) == true)
1023 {
1024 Log(("AUDIOIN: connected client %u\n", u32ClientId));
1025#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
1026 server->mConsole->getAudioVRDE()->handleVRDESvrCmdAudioInputIntercept(true);
1027#else
1028 PPDMIAUDIOSNIFFERPORT pPort = server->mConsole->i_getAudioSniffer()->getAudioSnifferPort();
1029 if (pPort)
1030 {
1031 pPort->pfnAudioInputIntercept(pPort, true);
1032 if (ppvIntercept)
1033 {
1034 *ppvIntercept = server;
1035 }
1036 }
1037 else
1038 {
1039 AssertFailed();
1040 ASMAtomicWriteU32(&server->mu32AudioInputClientId, 0);
1041 rc = VERR_NOT_SUPPORTED;
1042 }
1043#endif
1044 }
1045 else
1046 {
1047 Log(("AUDIOIN: ignored client %u, active client %u\n", u32ClientId, server->mu32AudioInputClientId));
1048 rc = VERR_NOT_SUPPORTED;
1049 }
1050 } break;
1051
1052 default:
1053 break;
1054 }
1055
1056 return rc;
1057}
1058
1059DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackUSB(void *pvCallback, void *pvIntercept, uint32_t u32ClientId,
1060 uint8_t u8Code, const void *pvRet, uint32_t cbRet)
1061{
1062#ifdef VBOX_WITH_USB
1063 return USBClientResponseCallback(pvIntercept, u32ClientId, u8Code, pvRet, cbRet);
1064#else
1065 return VERR_NOT_SUPPORTED;
1066#endif
1067}
1068
1069DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackClipboard(void *pvCallback, void *pvIntercept, uint32_t u32ClientId,
1070 uint32_t u32Function, uint32_t u32Format,
1071 const void *pvData, uint32_t cbData)
1072{
1073 return ClipboardCallback(pvIntercept, u32ClientId, u32Function, u32Format, pvData, cbData);
1074}
1075
1076DECLCALLBACK(bool) ConsoleVRDPServer::VRDPCallbackFramebufferQuery(void *pvCallback, unsigned uScreenId,
1077 VRDEFRAMEBUFFERINFO *pInfo)
1078{
1079 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
1080
1081 bool fAvailable = false;
1082
1083 /* Obtain the new screen bitmap. */
1084 HRESULT hr = server->mConsole->i_getDisplay()->QuerySourceBitmap(uScreenId, server->maSourceBitmaps[uScreenId].asOutParam());
1085 if (SUCCEEDED(hr))
1086 {
1087 LONG xOrigin = 0;
1088 LONG yOrigin = 0;
1089 BYTE *pAddress = NULL;
1090 ULONG ulWidth = 0;
1091 ULONG ulHeight = 0;
1092 ULONG ulBitsPerPixel = 0;
1093 ULONG ulBytesPerLine = 0;
1094 ULONG ulPixelFormat = 0;
1095
1096 hr = server->maSourceBitmaps[uScreenId]->QueryBitmapInfo(&pAddress,
1097 &ulWidth,
1098 &ulHeight,
1099 &ulBitsPerPixel,
1100 &ulBytesPerLine,
1101 &ulPixelFormat);
1102
1103 if (SUCCEEDED(hr))
1104 {
1105 ULONG dummy;
1106 hr = server->mConsole->i_getDisplay()->GetScreenResolution(uScreenId, &dummy, &dummy, &dummy,
1107 &xOrigin, &yOrigin);
1108
1109 if (SUCCEEDED(hr))
1110 {
1111 /* Now fill the information as requested by the caller. */
1112 pInfo->pu8Bits = pAddress;
1113 pInfo->xOrigin = xOrigin;
1114 pInfo->yOrigin = yOrigin;
1115 pInfo->cWidth = ulWidth;
1116 pInfo->cHeight = ulHeight;
1117 pInfo->cBitsPerPixel = ulBitsPerPixel;
1118 pInfo->cbLine = ulBytesPerLine;
1119
1120 fAvailable = true;
1121 }
1122 }
1123 }
1124
1125 return fAvailable;
1126}
1127
1128DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackFramebufferLock(void *pvCallback, unsigned uScreenId)
1129{
1130 NOREF(pvCallback);
1131 NOREF(uScreenId);
1132 /* Do nothing */
1133}
1134
1135DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackFramebufferUnlock(void *pvCallback, unsigned uScreenId)
1136{
1137 NOREF(pvCallback);
1138 NOREF(uScreenId);
1139 /* Do nothing */
1140}
1141
1142static void fixKbdLockStatus(VRDPInputSynch *pInputSynch, IKeyboard *pKeyboard)
1143{
1144 if ( pInputSynch->cGuestNumLockAdaptions
1145 && (pInputSynch->fGuestNumLock != pInputSynch->fClientNumLock))
1146 {
1147 pInputSynch->cGuestNumLockAdaptions--;
1148 pKeyboard->PutScancode(0x45);
1149 pKeyboard->PutScancode(0x45 | 0x80);
1150 }
1151 if ( pInputSynch->cGuestCapsLockAdaptions
1152 && (pInputSynch->fGuestCapsLock != pInputSynch->fClientCapsLock))
1153 {
1154 pInputSynch->cGuestCapsLockAdaptions--;
1155 pKeyboard->PutScancode(0x3a);
1156 pKeyboard->PutScancode(0x3a | 0x80);
1157 }
1158}
1159
1160DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackInput(void *pvCallback, int type, const void *pvInput, unsigned cbInput)
1161{
1162 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
1163 Console *pConsole = server->mConsole;
1164
1165 switch (type)
1166 {
1167 case VRDE_INPUT_SCANCODE:
1168 {
1169 if (cbInput == sizeof(VRDEINPUTSCANCODE))
1170 {
1171 IKeyboard *pKeyboard = pConsole->i_getKeyboard();
1172
1173 const VRDEINPUTSCANCODE *pInputScancode = (VRDEINPUTSCANCODE *)pvInput;
1174
1175 /* Track lock keys. */
1176 if (pInputScancode->uScancode == 0x45)
1177 {
1178 server->m_InputSynch.fClientNumLock = !server->m_InputSynch.fClientNumLock;
1179 }
1180 else if (pInputScancode->uScancode == 0x3a)
1181 {
1182 server->m_InputSynch.fClientCapsLock = !server->m_InputSynch.fClientCapsLock;
1183 }
1184 else if (pInputScancode->uScancode == 0x46)
1185 {
1186 server->m_InputSynch.fClientScrollLock = !server->m_InputSynch.fClientScrollLock;
1187 }
1188 else if ((pInputScancode->uScancode & 0x80) == 0)
1189 {
1190 /* Key pressed. */
1191 fixKbdLockStatus(&server->m_InputSynch, pKeyboard);
1192 }
1193
1194 pKeyboard->PutScancode((LONG)pInputScancode->uScancode);
1195 }
1196 } break;
1197
1198 case VRDE_INPUT_POINT:
1199 {
1200 if (cbInput == sizeof(VRDEINPUTPOINT))
1201 {
1202 const VRDEINPUTPOINT *pInputPoint = (VRDEINPUTPOINT *)pvInput;
1203
1204 int mouseButtons = 0;
1205 int iWheel = 0;
1206
1207 if (pInputPoint->uButtons & VRDE_INPUT_POINT_BUTTON1)
1208 {
1209 mouseButtons |= MouseButtonState_LeftButton;
1210 }
1211 if (pInputPoint->uButtons & VRDE_INPUT_POINT_BUTTON2)
1212 {
1213 mouseButtons |= MouseButtonState_RightButton;
1214 }
1215 if (pInputPoint->uButtons & VRDE_INPUT_POINT_BUTTON3)
1216 {
1217 mouseButtons |= MouseButtonState_MiddleButton;
1218 }
1219 if (pInputPoint->uButtons & VRDE_INPUT_POINT_WHEEL_UP)
1220 {
1221 mouseButtons |= MouseButtonState_WheelUp;
1222 iWheel = -1;
1223 }
1224 if (pInputPoint->uButtons & VRDE_INPUT_POINT_WHEEL_DOWN)
1225 {
1226 mouseButtons |= MouseButtonState_WheelDown;
1227 iWheel = 1;
1228 }
1229
1230 if (server->m_fGuestWantsAbsolute)
1231 {
1232 pConsole->i_getMouse()->PutMouseEventAbsolute(pInputPoint->x + 1, pInputPoint->y + 1, iWheel,
1233 0 /* Horizontal wheel */, mouseButtons);
1234 } else
1235 {
1236 pConsole->i_getMouse()->PutMouseEvent(pInputPoint->x - server->m_mousex,
1237 pInputPoint->y - server->m_mousey,
1238 iWheel, 0 /* Horizontal wheel */, mouseButtons);
1239 server->m_mousex = pInputPoint->x;
1240 server->m_mousey = pInputPoint->y;
1241 }
1242 }
1243 } break;
1244
1245 case VRDE_INPUT_CAD:
1246 {
1247 pConsole->i_getKeyboard()->PutCAD();
1248 } break;
1249
1250 case VRDE_INPUT_RESET:
1251 {
1252 pConsole->Reset();
1253 } break;
1254
1255 case VRDE_INPUT_SYNCH:
1256 {
1257 if (cbInput == sizeof(VRDEINPUTSYNCH))
1258 {
1259 IKeyboard *pKeyboard = pConsole->i_getKeyboard();
1260
1261 const VRDEINPUTSYNCH *pInputSynch = (VRDEINPUTSYNCH *)pvInput;
1262
1263 server->m_InputSynch.fClientNumLock = (pInputSynch->uLockStatus & VRDE_INPUT_SYNCH_NUMLOCK) != 0;
1264 server->m_InputSynch.fClientCapsLock = (pInputSynch->uLockStatus & VRDE_INPUT_SYNCH_CAPITAL) != 0;
1265 server->m_InputSynch.fClientScrollLock = (pInputSynch->uLockStatus & VRDE_INPUT_SYNCH_SCROLL) != 0;
1266
1267 /* The client initiated synchronization. Always make the guest to reflect the client state.
1268 * Than means, when the guest changes the state itself, it is forced to return to the client
1269 * state.
1270 */
1271 if (server->m_InputSynch.fClientNumLock != server->m_InputSynch.fGuestNumLock)
1272 {
1273 server->m_InputSynch.cGuestNumLockAdaptions = 2;
1274 }
1275
1276 if (server->m_InputSynch.fClientCapsLock != server->m_InputSynch.fGuestCapsLock)
1277 {
1278 server->m_InputSynch.cGuestCapsLockAdaptions = 2;
1279 }
1280
1281 fixKbdLockStatus(&server->m_InputSynch, pKeyboard);
1282 }
1283 } break;
1284
1285 default:
1286 break;
1287 }
1288}
1289
1290DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackVideoModeHint(void *pvCallback, unsigned cWidth, unsigned cHeight,
1291 unsigned cBitsPerPixel, unsigned uScreenId)
1292{
1293 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
1294
1295 server->mConsole->i_getDisplay()->SetVideoModeHint(uScreenId, TRUE /*=enabled*/,
1296 FALSE /*=changeOrigin*/, 0/*=OriginX*/, 0/*=OriginY*/,
1297 cWidth, cHeight, cBitsPerPixel);
1298}
1299
1300DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackAudioIn(void *pvCallback,
1301 void *pvCtx,
1302 uint32_t u32ClientId,
1303 uint32_t u32Event,
1304 const void *pvData,
1305 uint32_t cbData)
1306{
1307 ConsoleVRDPServer *server = static_cast<ConsoleVRDPServer*>(pvCallback);
1308#ifndef VBOX_WITH_PDM_AUDIO_DRIVER
1309 PPDMIAUDIOSNIFFERPORT pPort = server->mConsole->i_getAudioSniffer()->getAudioSnifferPort();
1310#endif
1311
1312 switch (u32Event)
1313 {
1314 case VRDE_AUDIOIN_BEGIN:
1315 {
1316 const VRDEAUDIOINBEGIN *pParms = (const VRDEAUDIOINBEGIN *)pvData;
1317#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
1318 server->mConsole->getAudioVRDE()->handleVRDESvrCmdAudioInputEventBegin(pvCtx,
1319 VRDE_AUDIO_FMT_SAMPLE_FREQ(pParms->fmt),
1320 VRDE_AUDIO_FMT_CHANNELS(pParms->fmt),
1321 VRDE_AUDIO_FMT_BITS_PER_SAMPLE(pParms->fmt),
1322 VRDE_AUDIO_FMT_SIGNED(pParms->fmt)
1323 );
1324#else
1325 pPort->pfnAudioInputEventBegin (pPort, pvCtx,
1326 VRDE_AUDIO_FMT_SAMPLE_FREQ(pParms->fmt),
1327 VRDE_AUDIO_FMT_CHANNELS(pParms->fmt),
1328 VRDE_AUDIO_FMT_BITS_PER_SAMPLE(pParms->fmt),
1329 VRDE_AUDIO_FMT_SIGNED(pParms->fmt)
1330 );
1331#endif
1332 } break;
1333
1334 case VRDE_AUDIOIN_DATA:
1335 {
1336#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
1337 server->mConsole->getAudioVRDE()->handleVRDESvrCmdAudioInputEventData(pvCtx, pvData, cbData);
1338#else
1339 pPort->pfnAudioInputEventData (pPort, pvCtx, pvData, cbData);
1340#endif
1341 } break;
1342
1343 case VRDE_AUDIOIN_END:
1344 {
1345#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
1346 server->mConsole->getAudioVRDE()->handleVRDESvrCmdAudioInputEventEnd(pvCtx);
1347#else
1348 pPort->pfnAudioInputEventEnd (pPort, pvCtx);
1349#endif
1350 } break;
1351
1352 default:
1353 return;
1354 }
1355}
1356
1357
1358ConsoleVRDPServer::ConsoleVRDPServer(Console *console)
1359{
1360 mConsole = console;
1361
1362 int rc = RTCritSectInit(&mCritSect);
1363 AssertRC(rc);
1364
1365 mcClipboardRefs = 0;
1366 mpfnClipboardCallback = NULL;
1367#ifdef VBOX_WITH_USB
1368 mUSBBackends.pHead = NULL;
1369 mUSBBackends.pTail = NULL;
1370
1371 mUSBBackends.thread = NIL_RTTHREAD;
1372 mUSBBackends.fThreadRunning = false;
1373 mUSBBackends.event = 0;
1374#endif
1375
1376 mhServer = 0;
1377 mServerInterfaceVersion = 0;
1378
1379 mcInResize = 0;
1380
1381 m_fGuestWantsAbsolute = false;
1382 m_mousex = 0;
1383 m_mousey = 0;
1384
1385 m_InputSynch.cGuestNumLockAdaptions = 2;
1386 m_InputSynch.cGuestCapsLockAdaptions = 2;
1387
1388 m_InputSynch.fGuestNumLock = false;
1389 m_InputSynch.fGuestCapsLock = false;
1390 m_InputSynch.fGuestScrollLock = false;
1391
1392 m_InputSynch.fClientNumLock = false;
1393 m_InputSynch.fClientCapsLock = false;
1394 m_InputSynch.fClientScrollLock = false;
1395
1396 {
1397 ComPtr<IEventSource> es;
1398 console->COMGETTER(EventSource)(es.asOutParam());
1399 ComObjPtr<VRDPConsoleListenerImpl> aConsoleListener;
1400 aConsoleListener.createObject();
1401 aConsoleListener->init(new VRDPConsoleListener(), this);
1402 mConsoleListener = aConsoleListener;
1403 com::SafeArray <VBoxEventType_T> eventTypes;
1404 eventTypes.push_back(VBoxEventType_OnMousePointerShapeChanged);
1405 eventTypes.push_back(VBoxEventType_OnMouseCapabilityChanged);
1406 eventTypes.push_back(VBoxEventType_OnKeyboardLedsChanged);
1407 es->RegisterListener(mConsoleListener, ComSafeArrayAsInParam(eventTypes), true);
1408 }
1409
1410 mVRDPBindPort = -1;
1411
1412 mAuthLibrary = 0;
1413
1414 mu32AudioInputClientId = 0;
1415 mcClients = 0;
1416
1417 /*
1418 * Optional interfaces.
1419 */
1420 m_fInterfaceImage = false;
1421 RT_ZERO(m_interfaceImage);
1422 RT_ZERO(m_interfaceCallbacksImage);
1423 RT_ZERO(m_interfaceMousePtr);
1424 RT_ZERO(m_interfaceSCard);
1425 RT_ZERO(m_interfaceCallbacksSCard);
1426 RT_ZERO(m_interfaceTSMF);
1427 RT_ZERO(m_interfaceCallbacksTSMF);
1428 RT_ZERO(m_interfaceVideoIn);
1429 RT_ZERO(m_interfaceCallbacksVideoIn);
1430 RT_ZERO(m_interfaceInput);
1431 RT_ZERO(m_interfaceCallbacksInput);
1432
1433 rc = RTCritSectInit(&mTSMFLock);
1434 AssertRC(rc);
1435
1436 mEmWebcam = new EmWebcam(this);
1437 AssertPtr(mEmWebcam);
1438}
1439
1440ConsoleVRDPServer::~ConsoleVRDPServer()
1441{
1442 Stop();
1443
1444 if (mConsoleListener)
1445 {
1446 ComPtr<IEventSource> es;
1447 mConsole->COMGETTER(EventSource)(es.asOutParam());
1448 es->UnregisterListener(mConsoleListener);
1449 mConsoleListener.setNull();
1450 }
1451
1452 unsigned i;
1453 for (i = 0; i < RT_ELEMENTS(maSourceBitmaps); i++)
1454 {
1455 maSourceBitmaps[i].setNull();
1456 }
1457
1458 if (mEmWebcam)
1459 {
1460 delete mEmWebcam;
1461 mEmWebcam = NULL;
1462 }
1463
1464 if (RTCritSectIsInitialized(&mCritSect))
1465 {
1466 RTCritSectDelete(&mCritSect);
1467 RT_ZERO(mCritSect);
1468 }
1469
1470 if (RTCritSectIsInitialized(&mTSMFLock))
1471 {
1472 RTCritSectDelete(&mTSMFLock);
1473 RT_ZERO(mTSMFLock);
1474 }
1475}
1476
1477int ConsoleVRDPServer::Launch(void)
1478{
1479 LogFlowThisFunc(("\n"));
1480
1481 IVRDEServer *server = mConsole->i_getVRDEServer();
1482 AssertReturn(server, VERR_INTERNAL_ERROR_2);
1483
1484 /*
1485 * Check if VRDE is enabled.
1486 */
1487 BOOL fEnabled;
1488 HRESULT hrc = server->COMGETTER(Enabled)(&fEnabled);
1489 AssertComRCReturn(hrc, Global::vboxStatusCodeFromCOM(hrc));
1490 if (!fEnabled)
1491 return VINF_SUCCESS;
1492
1493 /*
1494 * Check that a VRDE extension pack name is set and resolve it into a
1495 * library path.
1496 */
1497 Bstr bstrExtPack;
1498 hrc = server->COMGETTER(VRDEExtPack)(bstrExtPack.asOutParam());
1499 if (FAILED(hrc))
1500 return Global::vboxStatusCodeFromCOM(hrc);
1501 if (bstrExtPack.isEmpty())
1502 return VINF_NOT_SUPPORTED;
1503
1504 Utf8Str strExtPack(bstrExtPack);
1505 Utf8Str strVrdeLibrary;
1506 int vrc = VINF_SUCCESS;
1507 if (strExtPack.equals(VBOXVRDP_KLUDGE_EXTPACK_NAME))
1508 strVrdeLibrary = "VBoxVRDP";
1509 else
1510 {
1511#ifdef VBOX_WITH_EXTPACK
1512 ExtPackManager *pExtPackMgr = mConsole->i_getExtPackManager();
1513 vrc = pExtPackMgr->i_getVrdeLibraryPathForExtPack(&strExtPack, &strVrdeLibrary);
1514#else
1515 vrc = VERR_FILE_NOT_FOUND;
1516#endif
1517 }
1518 if (RT_SUCCESS(vrc))
1519 {
1520 /*
1521 * Load the VRDE library and start the server, if it is enabled.
1522 */
1523 vrc = loadVRDPLibrary(strVrdeLibrary.c_str());
1524 if (RT_SUCCESS(vrc))
1525 {
1526 VRDEENTRYPOINTS_4 *pEntryPoints4;
1527 vrc = mpfnVRDECreateServer(&mCallbacks.header, this, (VRDEINTERFACEHDR **)&pEntryPoints4, &mhServer);
1528
1529 if (RT_SUCCESS(vrc))
1530 {
1531 mServerInterfaceVersion = 4;
1532 mEntryPoints = *pEntryPoints4;
1533 mpEntryPoints = &mEntryPoints;
1534 }
1535 else if (vrc == VERR_VERSION_MISMATCH)
1536 {
1537 /* An older version of VRDE is installed, try version 3. */
1538 VRDEENTRYPOINTS_3 *pEntryPoints3;
1539
1540 static VRDECALLBACKS_3 sCallbacks3 =
1541 {
1542 { VRDE_INTERFACE_VERSION_3, sizeof(VRDECALLBACKS_3) },
1543 ConsoleVRDPServer::VRDPCallbackQueryProperty,
1544 ConsoleVRDPServer::VRDPCallbackClientLogon,
1545 ConsoleVRDPServer::VRDPCallbackClientConnect,
1546 ConsoleVRDPServer::VRDPCallbackClientDisconnect,
1547 ConsoleVRDPServer::VRDPCallbackIntercept,
1548 ConsoleVRDPServer::VRDPCallbackUSB,
1549 ConsoleVRDPServer::VRDPCallbackClipboard,
1550 ConsoleVRDPServer::VRDPCallbackFramebufferQuery,
1551 ConsoleVRDPServer::VRDPCallbackFramebufferLock,
1552 ConsoleVRDPServer::VRDPCallbackFramebufferUnlock,
1553 ConsoleVRDPServer::VRDPCallbackInput,
1554 ConsoleVRDPServer::VRDPCallbackVideoModeHint,
1555 ConsoleVRDPServer::VRDECallbackAudioIn
1556 };
1557
1558 vrc = mpfnVRDECreateServer(&sCallbacks3.header, this, (VRDEINTERFACEHDR **)&pEntryPoints3, &mhServer);
1559 if (RT_SUCCESS(vrc))
1560 {
1561 mServerInterfaceVersion = 3;
1562 mEntryPoints.header = pEntryPoints3->header;
1563 mEntryPoints.VRDEDestroy = pEntryPoints3->VRDEDestroy;
1564 mEntryPoints.VRDEEnableConnections = pEntryPoints3->VRDEEnableConnections;
1565 mEntryPoints.VRDEDisconnect = pEntryPoints3->VRDEDisconnect;
1566 mEntryPoints.VRDEResize = pEntryPoints3->VRDEResize;
1567 mEntryPoints.VRDEUpdate = pEntryPoints3->VRDEUpdate;
1568 mEntryPoints.VRDEColorPointer = pEntryPoints3->VRDEColorPointer;
1569 mEntryPoints.VRDEHidePointer = pEntryPoints3->VRDEHidePointer;
1570 mEntryPoints.VRDEAudioSamples = pEntryPoints3->VRDEAudioSamples;
1571 mEntryPoints.VRDEAudioVolume = pEntryPoints3->VRDEAudioVolume;
1572 mEntryPoints.VRDEUSBRequest = pEntryPoints3->VRDEUSBRequest;
1573 mEntryPoints.VRDEClipboard = pEntryPoints3->VRDEClipboard;
1574 mEntryPoints.VRDEQueryInfo = pEntryPoints3->VRDEQueryInfo;
1575 mEntryPoints.VRDERedirect = pEntryPoints3->VRDERedirect;
1576 mEntryPoints.VRDEAudioInOpen = pEntryPoints3->VRDEAudioInOpen;
1577 mEntryPoints.VRDEAudioInClose = pEntryPoints3->VRDEAudioInClose;
1578 mEntryPoints.VRDEGetInterface = NULL;
1579 mpEntryPoints = &mEntryPoints;
1580 }
1581 else if (vrc == VERR_VERSION_MISMATCH)
1582 {
1583 /* An older version of VRDE is installed, try version 1. */
1584 VRDEENTRYPOINTS_1 *pEntryPoints1;
1585
1586 static VRDECALLBACKS_1 sCallbacks1 =
1587 {
1588 { VRDE_INTERFACE_VERSION_1, sizeof(VRDECALLBACKS_1) },
1589 ConsoleVRDPServer::VRDPCallbackQueryProperty,
1590 ConsoleVRDPServer::VRDPCallbackClientLogon,
1591 ConsoleVRDPServer::VRDPCallbackClientConnect,
1592 ConsoleVRDPServer::VRDPCallbackClientDisconnect,
1593 ConsoleVRDPServer::VRDPCallbackIntercept,
1594 ConsoleVRDPServer::VRDPCallbackUSB,
1595 ConsoleVRDPServer::VRDPCallbackClipboard,
1596 ConsoleVRDPServer::VRDPCallbackFramebufferQuery,
1597 ConsoleVRDPServer::VRDPCallbackFramebufferLock,
1598 ConsoleVRDPServer::VRDPCallbackFramebufferUnlock,
1599 ConsoleVRDPServer::VRDPCallbackInput,
1600 ConsoleVRDPServer::VRDPCallbackVideoModeHint
1601 };
1602
1603 vrc = mpfnVRDECreateServer(&sCallbacks1.header, this, (VRDEINTERFACEHDR **)&pEntryPoints1, &mhServer);
1604 if (RT_SUCCESS(vrc))
1605 {
1606 mServerInterfaceVersion = 1;
1607 mEntryPoints.header = pEntryPoints1->header;
1608 mEntryPoints.VRDEDestroy = pEntryPoints1->VRDEDestroy;
1609 mEntryPoints.VRDEEnableConnections = pEntryPoints1->VRDEEnableConnections;
1610 mEntryPoints.VRDEDisconnect = pEntryPoints1->VRDEDisconnect;
1611 mEntryPoints.VRDEResize = pEntryPoints1->VRDEResize;
1612 mEntryPoints.VRDEUpdate = pEntryPoints1->VRDEUpdate;
1613 mEntryPoints.VRDEColorPointer = pEntryPoints1->VRDEColorPointer;
1614 mEntryPoints.VRDEHidePointer = pEntryPoints1->VRDEHidePointer;
1615 mEntryPoints.VRDEAudioSamples = pEntryPoints1->VRDEAudioSamples;
1616 mEntryPoints.VRDEAudioVolume = pEntryPoints1->VRDEAudioVolume;
1617 mEntryPoints.VRDEUSBRequest = pEntryPoints1->VRDEUSBRequest;
1618 mEntryPoints.VRDEClipboard = pEntryPoints1->VRDEClipboard;
1619 mEntryPoints.VRDEQueryInfo = pEntryPoints1->VRDEQueryInfo;
1620 mEntryPoints.VRDERedirect = NULL;
1621 mEntryPoints.VRDEAudioInOpen = NULL;
1622 mEntryPoints.VRDEAudioInClose = NULL;
1623 mEntryPoints.VRDEGetInterface = NULL;
1624 mpEntryPoints = &mEntryPoints;
1625 }
1626 }
1627 }
1628
1629 if (RT_SUCCESS(vrc))
1630 {
1631 LogRel(("VRDE: loaded version %d of the server.\n", mServerInterfaceVersion));
1632
1633 if (mServerInterfaceVersion >= 4)
1634 {
1635 /* The server supports optional interfaces. */
1636 Assert(mpEntryPoints->VRDEGetInterface != NULL);
1637
1638 /* Image interface. */
1639 m_interfaceImage.header.u64Version = 1;
1640 m_interfaceImage.header.u64Size = sizeof(m_interfaceImage);
1641
1642 m_interfaceCallbacksImage.header.u64Version = 1;
1643 m_interfaceCallbacksImage.header.u64Size = sizeof(m_interfaceCallbacksImage);
1644 m_interfaceCallbacksImage.VRDEImageCbNotify = VRDEImageCbNotify;
1645
1646 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1647 VRDE_IMAGE_INTERFACE_NAME,
1648 &m_interfaceImage.header,
1649 &m_interfaceCallbacksImage.header,
1650 this);
1651 if (RT_SUCCESS(vrc))
1652 {
1653 LogRel(("VRDE: [%s]\n", VRDE_IMAGE_INTERFACE_NAME));
1654 m_fInterfaceImage = true;
1655 }
1656
1657 /* Mouse pointer interface. */
1658 m_interfaceMousePtr.header.u64Version = 1;
1659 m_interfaceMousePtr.header.u64Size = sizeof(m_interfaceMousePtr);
1660
1661 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1662 VRDE_MOUSEPTR_INTERFACE_NAME,
1663 &m_interfaceMousePtr.header,
1664 NULL,
1665 this);
1666 if (RT_SUCCESS(vrc))
1667 {
1668 LogRel(("VRDE: [%s]\n", VRDE_MOUSEPTR_INTERFACE_NAME));
1669 }
1670 else
1671 {
1672 RT_ZERO(m_interfaceMousePtr);
1673 }
1674
1675 /* Smartcard interface. */
1676 m_interfaceSCard.header.u64Version = 1;
1677 m_interfaceSCard.header.u64Size = sizeof(m_interfaceSCard);
1678
1679 m_interfaceCallbacksSCard.header.u64Version = 1;
1680 m_interfaceCallbacksSCard.header.u64Size = sizeof(m_interfaceCallbacksSCard);
1681 m_interfaceCallbacksSCard.VRDESCardCbNotify = VRDESCardCbNotify;
1682 m_interfaceCallbacksSCard.VRDESCardCbResponse = VRDESCardCbResponse;
1683
1684 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1685 VRDE_SCARD_INTERFACE_NAME,
1686 &m_interfaceSCard.header,
1687 &m_interfaceCallbacksSCard.header,
1688 this);
1689 if (RT_SUCCESS(vrc))
1690 {
1691 LogRel(("VRDE: [%s]\n", VRDE_SCARD_INTERFACE_NAME));
1692 }
1693 else
1694 {
1695 RT_ZERO(m_interfaceSCard);
1696 }
1697
1698 /* Raw TSMF interface. */
1699 m_interfaceTSMF.header.u64Version = 1;
1700 m_interfaceTSMF.header.u64Size = sizeof(m_interfaceTSMF);
1701
1702 m_interfaceCallbacksTSMF.header.u64Version = 1;
1703 m_interfaceCallbacksTSMF.header.u64Size = sizeof(m_interfaceCallbacksTSMF);
1704 m_interfaceCallbacksTSMF.VRDETSMFCbNotify = VRDETSMFCbNotify;
1705
1706 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1707 VRDE_TSMF_INTERFACE_NAME,
1708 &m_interfaceTSMF.header,
1709 &m_interfaceCallbacksTSMF.header,
1710 this);
1711 if (RT_SUCCESS(vrc))
1712 {
1713 LogRel(("VRDE: [%s]\n", VRDE_TSMF_INTERFACE_NAME));
1714 }
1715 else
1716 {
1717 RT_ZERO(m_interfaceTSMF);
1718 }
1719
1720 /* VideoIn interface. */
1721 m_interfaceVideoIn.header.u64Version = 1;
1722 m_interfaceVideoIn.header.u64Size = sizeof(m_interfaceVideoIn);
1723
1724 m_interfaceCallbacksVideoIn.header.u64Version = 1;
1725 m_interfaceCallbacksVideoIn.header.u64Size = sizeof(m_interfaceCallbacksVideoIn);
1726 m_interfaceCallbacksVideoIn.VRDECallbackVideoInNotify = VRDECallbackVideoInNotify;
1727 m_interfaceCallbacksVideoIn.VRDECallbackVideoInDeviceDesc = VRDECallbackVideoInDeviceDesc;
1728 m_interfaceCallbacksVideoIn.VRDECallbackVideoInControl = VRDECallbackVideoInControl;
1729 m_interfaceCallbacksVideoIn.VRDECallbackVideoInFrame = VRDECallbackVideoInFrame;
1730
1731 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1732 VRDE_VIDEOIN_INTERFACE_NAME,
1733 &m_interfaceVideoIn.header,
1734 &m_interfaceCallbacksVideoIn.header,
1735 this);
1736 if (RT_SUCCESS(vrc))
1737 {
1738 LogRel(("VRDE: [%s]\n", VRDE_VIDEOIN_INTERFACE_NAME));
1739 }
1740 else
1741 {
1742 RT_ZERO(m_interfaceVideoIn);
1743 }
1744
1745 /* Input interface. */
1746 m_interfaceInput.header.u64Version = 1;
1747 m_interfaceInput.header.u64Size = sizeof(m_interfaceInput);
1748
1749 m_interfaceCallbacksInput.header.u64Version = 1;
1750 m_interfaceCallbacksInput.header.u64Size = sizeof(m_interfaceCallbacksInput);
1751 m_interfaceCallbacksInput.VRDECallbackInputSetup = VRDECallbackInputSetup;
1752 m_interfaceCallbacksInput.VRDECallbackInputEvent = VRDECallbackInputEvent;
1753
1754 vrc = mpEntryPoints->VRDEGetInterface(mhServer,
1755 VRDE_INPUT_INTERFACE_NAME,
1756 &m_interfaceInput.header,
1757 &m_interfaceCallbacksInput.header,
1758 this);
1759 if (RT_SUCCESS(vrc))
1760 {
1761 LogRel(("VRDE: [%s]\n", VRDE_INPUT_INTERFACE_NAME));
1762 }
1763 else
1764 {
1765 RT_ZERO(m_interfaceInput);
1766 }
1767
1768 /* Since these interfaces are optional, it is always a success here. */
1769 vrc = VINF_SUCCESS;
1770 }
1771#ifdef VBOX_WITH_USB
1772 remoteUSBThreadStart();
1773#endif
1774
1775 /*
1776 * Re-init the server current state, which is usually obtained from events.
1777 */
1778 fetchCurrentState();
1779 }
1780 else
1781 {
1782 if (vrc != VERR_NET_ADDRESS_IN_USE)
1783 LogRel(("VRDE: Could not start the server rc = %Rrc\n", vrc));
1784 /* Don't unload the lib, because it prevents us trying again or
1785 because there may be other users? */
1786 }
1787 }
1788 }
1789
1790 return vrc;
1791}
1792
1793void ConsoleVRDPServer::fetchCurrentState(void)
1794{
1795 ComPtr<IMousePointerShape> mps;
1796 mConsole->i_getMouse()->COMGETTER(PointerShape)(mps.asOutParam());
1797 if (!mps.isNull())
1798 {
1799 BOOL visible, alpha;
1800 ULONG hotX, hotY, width, height;
1801 com::SafeArray <BYTE> shape;
1802
1803 mps->COMGETTER(Visible)(&visible);
1804 mps->COMGETTER(Alpha)(&alpha);
1805 mps->COMGETTER(HotX)(&hotX);
1806 mps->COMGETTER(HotY)(&hotY);
1807 mps->COMGETTER(Width)(&width);
1808 mps->COMGETTER(Height)(&height);
1809 mps->COMGETTER(Shape)(ComSafeArrayAsOutParam(shape));
1810
1811 onMousePointerShapeChange(visible, alpha, hotX, hotY, width, height, ComSafeArrayAsInParam(shape));
1812 }
1813}
1814
1815typedef struct H3DORInstance
1816{
1817 ConsoleVRDPServer *pThis;
1818 HVRDEIMAGE hImageBitmap;
1819 int32_t x;
1820 int32_t y;
1821 uint32_t w;
1822 uint32_t h;
1823 bool fCreated;
1824 bool fFallback;
1825 bool fTopDown;
1826} H3DORInstance;
1827
1828#define H3DORLOG Log
1829
1830/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORBegin(const void *pvContext, void **ppvInstance,
1831 const char *pszFormat)
1832{
1833 H3DORLOG(("H3DORBegin: ctx %p [%s]\n", pvContext, pszFormat));
1834
1835 H3DORInstance *p = (H3DORInstance *)RTMemAlloc(sizeof(H3DORInstance));
1836
1837 if (p)
1838 {
1839 p->pThis = (ConsoleVRDPServer *)pvContext;
1840 p->hImageBitmap = NULL;
1841 p->x = 0;
1842 p->y = 0;
1843 p->w = 0;
1844 p->h = 0;
1845 p->fCreated = false;
1846 p->fFallback = false;
1847
1848 /* Host 3D service passes the actual format of data in this redirect instance.
1849 * That is what will be in the H3DORFrame's parameters pvData and cbData.
1850 */
1851 if (RTStrICmp(pszFormat, H3DOR_FMT_RGBA_TOPDOWN) == 0)
1852 {
1853 /* Accept it. */
1854 p->fTopDown = true;
1855 }
1856 else if (RTStrICmp(pszFormat, H3DOR_FMT_RGBA) == 0)
1857 {
1858 /* Accept it. */
1859 p->fTopDown = false;
1860 }
1861 else
1862 {
1863 RTMemFree(p);
1864 p = NULL;
1865 }
1866 }
1867
1868 H3DORLOG(("H3DORBegin: ins %p\n", p));
1869
1870 /* Caller checks this for NULL. */
1871 *ppvInstance = p;
1872}
1873
1874/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORGeometry(void *pvInstance,
1875 int32_t x, int32_t y, uint32_t w, uint32_t h)
1876{
1877 H3DORLOG(("H3DORGeometry: ins %p %d,%d %dx%d\n", pvInstance, x, y, w, h));
1878
1879 H3DORInstance *p = (H3DORInstance *)pvInstance;
1880 Assert(p);
1881 Assert(p->pThis);
1882
1883 /* @todo find out what to do if size changes to 0x0 from non zero */
1884 if (w == 0 || h == 0)
1885 {
1886 /* Do nothing. */
1887 return;
1888 }
1889
1890 RTRECT rect;
1891 rect.xLeft = x;
1892 rect.yTop = y;
1893 rect.xRight = x + w;
1894 rect.yBottom = y + h;
1895
1896 if (p->hImageBitmap)
1897 {
1898 /* An image handle has been already created,
1899 * check if it has the same size as the reported geometry.
1900 */
1901 if ( p->x == x
1902 && p->y == y
1903 && p->w == w
1904 && p->h == h)
1905 {
1906 H3DORLOG(("H3DORGeometry: geometry not changed\n"));
1907 /* Do nothing. Continue using the existing handle. */
1908 }
1909 else
1910 {
1911 int rc = p->fFallback?
1912 VERR_NOT_SUPPORTED: /* Try to go out of fallback mode. */
1913 p->pThis->m_interfaceImage.VRDEImageGeometrySet(p->hImageBitmap, &rect);
1914 if (RT_SUCCESS(rc))
1915 {
1916 p->x = x;
1917 p->y = y;
1918 p->w = w;
1919 p->h = h;
1920 }
1921 else
1922 {
1923 /* The handle must be recreated. Delete existing handle here. */
1924 p->pThis->m_interfaceImage.VRDEImageHandleClose(p->hImageBitmap);
1925 p->hImageBitmap = NULL;
1926 }
1927 }
1928 }
1929
1930 if (!p->hImageBitmap)
1931 {
1932 /* Create a new bitmap handle. */
1933 uint32_t u32ScreenId = 0; /* @todo clip to corresponding screens.
1934 * Clipping can be done here or in VRDP server.
1935 * If VRDP does clipping, then uScreenId parameter
1936 * is not necessary and coords must be global.
1937 * (have to check which coords are used in opengl service).
1938 * Since all VRDE API uses a ScreenId,
1939 * the clipping must be done here in ConsoleVRDPServer
1940 */
1941 uint32_t fu32CompletionFlags = 0;
1942 p->fFallback = false;
1943 int rc = p->pThis->m_interfaceImage.VRDEImageHandleCreate(p->pThis->mhServer,
1944 &p->hImageBitmap,
1945 p,
1946 u32ScreenId,
1947 VRDE_IMAGE_F_CREATE_CONTENT_3D
1948 | VRDE_IMAGE_F_CREATE_WINDOW,
1949 &rect,
1950 VRDE_IMAGE_FMT_ID_BITMAP_BGRA8,
1951 NULL,
1952 0,
1953 &fu32CompletionFlags);
1954 if (RT_FAILURE(rc))
1955 {
1956 /* No support for a 3D + WINDOW. Try bitmap updates. */
1957 H3DORLOG(("H3DORGeometry: Fallback to bitmaps\n"));
1958 fu32CompletionFlags = 0;
1959 p->fFallback = true;
1960 rc = p->pThis->m_interfaceImage.VRDEImageHandleCreate(p->pThis->mhServer,
1961 &p->hImageBitmap,
1962 p,
1963 u32ScreenId,
1964 0,
1965 &rect,
1966 VRDE_IMAGE_FMT_ID_BITMAP_BGRA8,
1967 NULL,
1968 0,
1969 &fu32CompletionFlags);
1970 }
1971
1972 H3DORLOG(("H3DORGeometry: Image handle create %Rrc, flags 0x%RX32\n", rc, fu32CompletionFlags));
1973
1974 if (RT_SUCCESS(rc))
1975 {
1976 p->x = x;
1977 p->y = y;
1978 p->w = w;
1979 p->h = h;
1980
1981 if ((fu32CompletionFlags & VRDE_IMAGE_F_COMPLETE_ASYNC) == 0)
1982 {
1983 p->fCreated = true;
1984 }
1985 }
1986 else
1987 {
1988 p->hImageBitmap = NULL;
1989 p->w = 0;
1990 p->h = 0;
1991 }
1992 }
1993
1994 H3DORLOG(("H3DORGeometry: ins %p completed\n", pvInstance));
1995}
1996
1997/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORVisibleRegion(void *pvInstance,
1998 uint32_t cRects, const RTRECT *paRects)
1999{
2000 H3DORLOG(("H3DORVisibleRegion: ins %p %d\n", pvInstance, cRects));
2001
2002 H3DORInstance *p = (H3DORInstance *)pvInstance;
2003 Assert(p);
2004 Assert(p->pThis);
2005
2006 if (cRects == 0)
2007 {
2008 /* Complete image is visible. */
2009 RTRECT rect;
2010 rect.xLeft = p->x;
2011 rect.yTop = p->y;
2012 rect.xRight = p->x + p->w;
2013 rect.yBottom = p->y + p->h;
2014 p->pThis->m_interfaceImage.VRDEImageRegionSet (p->hImageBitmap,
2015 1,
2016 &rect);
2017 }
2018 else
2019 {
2020 p->pThis->m_interfaceImage.VRDEImageRegionSet (p->hImageBitmap,
2021 cRects,
2022 paRects);
2023 }
2024
2025 H3DORLOG(("H3DORVisibleRegion: ins %p completed\n", pvInstance));
2026}
2027
2028/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DORFrame(void *pvInstance,
2029 void *pvData, uint32_t cbData)
2030{
2031 H3DORLOG(("H3DORFrame: ins %p %p %d\n", pvInstance, pvData, cbData));
2032
2033 H3DORInstance *p = (H3DORInstance *)pvInstance;
2034 Assert(p);
2035 Assert(p->pThis);
2036
2037 /* Currently only a topdown BGR0 bitmap format is supported. */
2038 VRDEIMAGEBITMAP image;
2039
2040 image.cWidth = p->w;
2041 image.cHeight = p->h;
2042 image.pvData = pvData;
2043 image.cbData = cbData;
2044 image.pvScanLine0 = (uint8_t *)pvData + (p->h - 1) * p->w * 4;
2045 image.iScanDelta = 4 * p->w;
2046 if (p->fTopDown)
2047 {
2048 image.iScanDelta = -image.iScanDelta;
2049 }
2050
2051 p->pThis->m_interfaceImage.VRDEImageUpdate (p->hImageBitmap,
2052 p->x,
2053 p->y,
2054 p->w,
2055 p->h,
2056 &image,
2057 sizeof(VRDEIMAGEBITMAP));
2058
2059 H3DORLOG(("H3DORFrame: ins %p completed\n", pvInstance));
2060}
2061
2062/* static */ DECLCALLBACK(void) ConsoleVRDPServer::H3DOREnd(void *pvInstance)
2063{
2064 H3DORLOG(("H3DOREnd: ins %p\n", pvInstance));
2065
2066 H3DORInstance *p = (H3DORInstance *)pvInstance;
2067 Assert(p);
2068 Assert(p->pThis);
2069
2070 p->pThis->m_interfaceImage.VRDEImageHandleClose(p->hImageBitmap);
2071
2072 RTMemFree(p);
2073
2074 H3DORLOG(("H3DOREnd: ins %p completed\n", pvInstance));
2075}
2076
2077/* static */ DECLCALLBACK(int) ConsoleVRDPServer::H3DORContextProperty(const void *pvContext, uint32_t index,
2078 void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut)
2079{
2080 int rc = VINF_SUCCESS;
2081
2082 H3DORLOG(("H3DORContextProperty: index %d\n", index));
2083
2084 if (index == H3DOR_PROP_FORMATS)
2085 {
2086 /* Return a comma separated list of supported formats. */
2087 uint32_t cbOut = (uint32_t)strlen(H3DOR_FMT_RGBA_TOPDOWN) + 1
2088 + (uint32_t)strlen(H3DOR_FMT_RGBA) + 1;
2089 if (cbOut <= cbBuffer)
2090 {
2091 char *pch = (char *)pvBuffer;
2092 memcpy(pch, H3DOR_FMT_RGBA_TOPDOWN, strlen(H3DOR_FMT_RGBA_TOPDOWN));
2093 pch += strlen(H3DOR_FMT_RGBA_TOPDOWN);
2094 *pch++ = ',';
2095 memcpy(pch, H3DOR_FMT_RGBA, strlen(H3DOR_FMT_RGBA));
2096 pch += strlen(H3DOR_FMT_RGBA);
2097 *pch++ = '\0';
2098 }
2099 else
2100 {
2101 rc = VERR_BUFFER_OVERFLOW;
2102 }
2103 *pcbOut = cbOut;
2104 }
2105 else
2106 {
2107 rc = VERR_NOT_SUPPORTED;
2108 }
2109
2110 H3DORLOG(("H3DORContextProperty: %Rrc\n", rc));
2111 return rc;
2112}
2113
2114void ConsoleVRDPServer::remote3DRedirect(bool fEnable)
2115{
2116 if (!m_fInterfaceImage)
2117 {
2118 /* No redirect without corresponding interface. */
2119 return;
2120 }
2121
2122 /* Check if 3D redirection has been enabled. It is enabled by default. */
2123 com::Bstr bstr;
2124 HRESULT hrc = mConsole->i_getVRDEServer()->GetVRDEProperty(Bstr("H3DRedirect/Enabled").raw(), bstr.asOutParam());
2125
2126 com::Utf8Str value = hrc == S_OK? bstr: "";
2127
2128 bool fAllowed = RTStrICmp(value.c_str(), "true") == 0
2129 || RTStrICmp(value.c_str(), "1") == 0
2130 || value.c_str()[0] == 0;
2131
2132 if (!fAllowed && fEnable)
2133 {
2134 return;
2135 }
2136
2137 /* Tell the host 3D service to redirect output using the ConsoleVRDPServer callbacks. */
2138 H3DOUTPUTREDIRECT outputRedirect =
2139 {
2140 this,
2141 H3DORBegin,
2142 H3DORGeometry,
2143 H3DORVisibleRegion,
2144 H3DORFrame,
2145 H3DOREnd,
2146 H3DORContextProperty
2147 };
2148
2149 if (!fEnable)
2150 {
2151 /* This will tell the service to disable rediection. */
2152 RT_ZERO(outputRedirect);
2153 }
2154
2155#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2156 VBOXCRCMDCTL_HGCM data;
2157 data.Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
2158 data.Hdr.u32Function = SHCRGL_HOST_FN_SET_OUTPUT_REDIRECT;
2159
2160 data.aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
2161 data.aParms[0].u.pointer.addr = &outputRedirect;
2162 data.aParms[0].u.pointer.size = sizeof(outputRedirect);
2163
2164 int rc = mConsole->i_getDisplay()->i_crCtlSubmitSync(&data.Hdr, sizeof (data));
2165 if (!RT_SUCCESS(rc))
2166 {
2167 Log(("SHCRGL_HOST_FN_SET_CONSOLE failed with %Rrc\n", rc));
2168 return;
2169 }
2170
2171 LogRel(("VRDE: %s 3D redirect.\n", fEnable? "Enabled": "Disabled"));
2172# ifdef DEBUG_misha
2173 AssertFailed();
2174# endif
2175#endif
2176
2177 return;
2178}
2179
2180/* static */ DECLCALLBACK(int) ConsoleVRDPServer::VRDEImageCbNotify (void *pvContext,
2181 void *pvUser,
2182 HVRDEIMAGE hVideo,
2183 uint32_t u32Id,
2184 void *pvData,
2185 uint32_t cbData)
2186{
2187 H3DORLOG(("H3DOR: VRDEImageCbNotify: pvContext %p, pvUser %p, hVideo %p, u32Id %u, pvData %p, cbData %d\n",
2188 pvContext, pvUser, hVideo, u32Id, pvData, cbData));
2189
2190 ConsoleVRDPServer *pServer = static_cast<ConsoleVRDPServer*>(pvContext);
2191 H3DORInstance *p = (H3DORInstance *)pvUser;
2192 Assert(p);
2193 Assert(p->pThis);
2194 Assert(p->pThis == pServer);
2195
2196 if (u32Id == VRDE_IMAGE_NOTIFY_HANDLE_CREATE)
2197 {
2198 if (cbData != sizeof(uint32_t))
2199 {
2200 AssertFailed();
2201 return VERR_INVALID_PARAMETER;
2202 }
2203
2204 uint32_t u32StreamId = *(uint32_t *)pvData;
2205 H3DORLOG(("H3DOR: VRDE_IMAGE_NOTIFY_HANDLE_CREATE u32StreamId %d\n",
2206 u32StreamId));
2207
2208 if (u32StreamId != 0)
2209 {
2210 p->fCreated = true; // @todo not needed?
2211 }
2212 else
2213 {
2214 /* The stream has not been created. */
2215 }
2216 }
2217
2218 return VINF_SUCCESS;
2219}
2220
2221#undef H3DORLOG
2222
2223/* static */ DECLCALLBACK(int) ConsoleVRDPServer::VRDESCardCbNotify(void *pvContext,
2224 uint32_t u32Id,
2225 void *pvData,
2226 uint32_t cbData)
2227{
2228#ifdef VBOX_WITH_USB_CARDREADER
2229 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvContext);
2230 UsbCardReader *pReader = pThis->mConsole->i_getUsbCardReader();
2231 return pReader->VRDENotify(u32Id, pvData, cbData);
2232#else
2233 NOREF(pvContext);
2234 NOREF(u32Id);
2235 NOREF(pvData);
2236 NOREF(cbData);
2237 return VERR_NOT_SUPPORTED;
2238#endif
2239}
2240
2241/* static */ DECLCALLBACK(int) ConsoleVRDPServer::VRDESCardCbResponse(void *pvContext,
2242 int rcRequest,
2243 void *pvUser,
2244 uint32_t u32Function,
2245 void *pvData,
2246 uint32_t cbData)
2247{
2248#ifdef VBOX_WITH_USB_CARDREADER
2249 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvContext);
2250 UsbCardReader *pReader = pThis->mConsole->i_getUsbCardReader();
2251 return pReader->VRDEResponse(rcRequest, pvUser, u32Function, pvData, cbData);
2252#else
2253 NOREF(pvContext);
2254 NOREF(rcRequest);
2255 NOREF(pvUser);
2256 NOREF(u32Function);
2257 NOREF(pvData);
2258 NOREF(cbData);
2259 return VERR_NOT_SUPPORTED;
2260#endif
2261}
2262
2263int ConsoleVRDPServer::SCardRequest(void *pvUser, uint32_t u32Function, const void *pvData, uint32_t cbData)
2264{
2265 int rc = VINF_SUCCESS;
2266
2267 if (mhServer && mpEntryPoints && m_interfaceSCard.VRDESCardRequest)
2268 {
2269 rc = m_interfaceSCard.VRDESCardRequest(mhServer, pvUser, u32Function, pvData, cbData);
2270 }
2271 else
2272 {
2273 rc = VERR_NOT_SUPPORTED;
2274 }
2275
2276 return rc;
2277}
2278
2279
2280struct TSMFHOSTCHCTX;
2281struct TSMFVRDPCTX;
2282
2283typedef struct TSMFHOSTCHCTX
2284{
2285 ConsoleVRDPServer *pThis;
2286
2287 struct TSMFVRDPCTX *pVRDPCtx; /* NULL if no corresponding host channel context. */
2288
2289 void *pvDataReceived;
2290 uint32_t cbDataReceived;
2291 uint32_t cbDataAllocated;
2292} TSMFHOSTCHCTX;
2293
2294typedef struct TSMFVRDPCTX
2295{
2296 ConsoleVRDPServer *pThis;
2297
2298 VBOXHOSTCHANNELCALLBACKS *pCallbacks;
2299 void *pvCallbacks;
2300
2301 TSMFHOSTCHCTX *pHostChCtx; /* NULL if no corresponding host channel context. */
2302
2303 uint32_t u32ChannelHandle;
2304} TSMFVRDPCTX;
2305
2306static int tsmfContextsAlloc(TSMFHOSTCHCTX **ppHostChCtx, TSMFVRDPCTX **ppVRDPCtx)
2307{
2308 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)RTMemAllocZ(sizeof(TSMFHOSTCHCTX));
2309 if (!pHostChCtx)
2310 {
2311 return VERR_NO_MEMORY;
2312 }
2313
2314 TSMFVRDPCTX *pVRDPCtx = (TSMFVRDPCTX *)RTMemAllocZ(sizeof(TSMFVRDPCTX));
2315 if (!pVRDPCtx)
2316 {
2317 RTMemFree(pHostChCtx);
2318 return VERR_NO_MEMORY;
2319 }
2320
2321 *ppHostChCtx = pHostChCtx;
2322 *ppVRDPCtx = pVRDPCtx;
2323 return VINF_SUCCESS;
2324}
2325
2326int ConsoleVRDPServer::tsmfLock(void)
2327{
2328 int rc = RTCritSectEnter(&mTSMFLock);
2329 AssertRC(rc);
2330 return rc;
2331}
2332
2333void ConsoleVRDPServer::tsmfUnlock(void)
2334{
2335 RTCritSectLeave(&mTSMFLock);
2336}
2337
2338/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelAttach(void *pvProvider,
2339 void **ppvChannel,
2340 uint32_t u32Flags,
2341 VBOXHOSTCHANNELCALLBACKS *pCallbacks,
2342 void *pvCallbacks)
2343{
2344 LogFlowFunc(("\n"));
2345
2346 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvProvider);
2347
2348 /* Create 2 context structures: for the VRDP server and for the host service. */
2349 TSMFHOSTCHCTX *pHostChCtx = NULL;
2350 TSMFVRDPCTX *pVRDPCtx = NULL;
2351
2352 int rc = tsmfContextsAlloc(&pHostChCtx, &pVRDPCtx);
2353 if (RT_FAILURE(rc))
2354 {
2355 return rc;
2356 }
2357
2358 pHostChCtx->pThis = pThis;
2359 pHostChCtx->pVRDPCtx = pVRDPCtx;
2360
2361 pVRDPCtx->pThis = pThis;
2362 pVRDPCtx->pCallbacks = pCallbacks;
2363 pVRDPCtx->pvCallbacks = pvCallbacks;
2364 pVRDPCtx->pHostChCtx = pHostChCtx;
2365
2366 rc = pThis->m_interfaceTSMF.VRDETSMFChannelCreate(pThis->mhServer, pVRDPCtx, u32Flags);
2367
2368 if (RT_SUCCESS(rc))
2369 {
2370 /* @todo contexts should be in a list for accounting. */
2371 *ppvChannel = pHostChCtx;
2372 }
2373 else
2374 {
2375 RTMemFree(pHostChCtx);
2376 RTMemFree(pVRDPCtx);
2377 }
2378
2379 return rc;
2380}
2381
2382/* static */ DECLCALLBACK(void) ConsoleVRDPServer::tsmfHostChannelDetach(void *pvChannel)
2383{
2384 LogFlowFunc(("\n"));
2385
2386 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)pvChannel;
2387 ConsoleVRDPServer *pThis = pHostChCtx->pThis;
2388
2389 int rc = pThis->tsmfLock();
2390 if (RT_SUCCESS(rc))
2391 {
2392 bool fClose = false;
2393 uint32_t u32ChannelHandle = 0;
2394
2395 if (pHostChCtx->pVRDPCtx)
2396 {
2397 /* There is still a VRDP context for this channel. */
2398 pHostChCtx->pVRDPCtx->pHostChCtx = NULL;
2399 u32ChannelHandle = pHostChCtx->pVRDPCtx->u32ChannelHandle;
2400 fClose = true;
2401 }
2402
2403 pThis->tsmfUnlock();
2404
2405 RTMemFree(pHostChCtx);
2406
2407 if (fClose)
2408 {
2409 LogFlowFunc(("Closing VRDE channel %d.\n", u32ChannelHandle));
2410 pThis->m_interfaceTSMF.VRDETSMFChannelClose(pThis->mhServer, u32ChannelHandle);
2411 }
2412 else
2413 {
2414 LogFlowFunc(("No VRDE channel.\n"));
2415 }
2416 }
2417}
2418
2419/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelSend(void *pvChannel,
2420 const void *pvData,
2421 uint32_t cbData)
2422{
2423 LogFlowFunc(("cbData %d\n", cbData));
2424
2425 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)pvChannel;
2426 ConsoleVRDPServer *pThis = pHostChCtx->pThis;
2427
2428 int rc = pThis->tsmfLock();
2429 if (RT_SUCCESS(rc))
2430 {
2431 bool fSend = false;
2432 uint32_t u32ChannelHandle = 0;
2433
2434 if (pHostChCtx->pVRDPCtx)
2435 {
2436 u32ChannelHandle = pHostChCtx->pVRDPCtx->u32ChannelHandle;
2437 fSend = true;
2438 }
2439
2440 pThis->tsmfUnlock();
2441
2442 if (fSend)
2443 {
2444 LogFlowFunc(("Send to VRDE channel %d.\n", u32ChannelHandle));
2445 rc = pThis->m_interfaceTSMF.VRDETSMFChannelSend(pThis->mhServer, u32ChannelHandle,
2446 pvData, cbData);
2447 }
2448 }
2449
2450 return rc;
2451}
2452
2453/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelRecv(void *pvChannel,
2454 void *pvData,
2455 uint32_t cbData,
2456 uint32_t *pcbReceived,
2457 uint32_t *pcbRemaining)
2458{
2459 LogFlowFunc(("cbData %d\n", cbData));
2460
2461 TSMFHOSTCHCTX *pHostChCtx = (TSMFHOSTCHCTX *)pvChannel;
2462 ConsoleVRDPServer *pThis = pHostChCtx->pThis;
2463
2464 int rc = pThis->tsmfLock();
2465 if (RT_SUCCESS(rc))
2466 {
2467 uint32_t cbToCopy = RT_MIN(cbData, pHostChCtx->cbDataReceived);
2468 uint32_t cbRemaining = pHostChCtx->cbDataReceived - cbToCopy;
2469
2470 LogFlowFunc(("cbToCopy %d, cbRemaining %d\n", cbToCopy, cbRemaining));
2471
2472 if (cbToCopy != 0)
2473 {
2474 memcpy(pvData, pHostChCtx->pvDataReceived, cbToCopy);
2475
2476 if (cbRemaining != 0)
2477 {
2478 memmove(pHostChCtx->pvDataReceived, (uint8_t *)pHostChCtx->pvDataReceived + cbToCopy, cbRemaining);
2479 }
2480
2481 pHostChCtx->cbDataReceived = cbRemaining;
2482 }
2483
2484 pThis->tsmfUnlock();
2485
2486 *pcbRemaining = cbRemaining;
2487 *pcbReceived = cbToCopy;
2488 }
2489
2490 return rc;
2491}
2492
2493/* static */ DECLCALLBACK(int) ConsoleVRDPServer::tsmfHostChannelControl(void *pvChannel,
2494 uint32_t u32Code,
2495 const void *pvParm,
2496 uint32_t cbParm,
2497 const void *pvData,
2498 uint32_t cbData,
2499 uint32_t *pcbDataReturned)
2500{
2501 LogFlowFunc(("u32Code %u\n", u32Code));
2502
2503 if (!pvChannel)
2504 {
2505 /* Special case, the provider must answer rather than a channel instance. */
2506 if (u32Code == VBOX_HOST_CHANNEL_CTRL_EXISTS)
2507 {
2508 *pcbDataReturned = 0;
2509 return VINF_SUCCESS;
2510 }
2511
2512 return VERR_NOT_IMPLEMENTED;
2513 }
2514
2515 /* Channels do not support this. */
2516 return VERR_NOT_IMPLEMENTED;
2517}
2518
2519
2520void ConsoleVRDPServer::setupTSMF(void)
2521{
2522 if (m_interfaceTSMF.header.u64Size == 0)
2523 {
2524 return;
2525 }
2526
2527 /* Register with the host channel service. */
2528 VBOXHOSTCHANNELINTERFACE hostChannelInterface =
2529 {
2530 this,
2531 tsmfHostChannelAttach,
2532 tsmfHostChannelDetach,
2533 tsmfHostChannelSend,
2534 tsmfHostChannelRecv,
2535 tsmfHostChannelControl
2536 };
2537
2538 VBoxHostChannelHostRegister parms;
2539
2540 static char szProviderName[] = "/vrde/tsmf";
2541
2542 parms.name.type = VBOX_HGCM_SVC_PARM_PTR;
2543 parms.name.u.pointer.addr = &szProviderName[0];
2544 parms.name.u.pointer.size = sizeof(szProviderName);
2545
2546 parms.iface.type = VBOX_HGCM_SVC_PARM_PTR;
2547 parms.iface.u.pointer.addr = &hostChannelInterface;
2548 parms.iface.u.pointer.size = sizeof(hostChannelInterface);
2549
2550 VMMDev *pVMMDev = mConsole->i_getVMMDev();
2551
2552 if (!pVMMDev)
2553 {
2554 AssertMsgFailed(("setupTSMF no vmmdev\n"));
2555 return;
2556 }
2557
2558 int rc = pVMMDev->hgcmHostCall("VBoxHostChannel",
2559 VBOX_HOST_CHANNEL_HOST_FN_REGISTER,
2560 2,
2561 &parms.name);
2562
2563 if (!RT_SUCCESS(rc))
2564 {
2565 Log(("VBOX_HOST_CHANNEL_HOST_FN_REGISTER failed with %Rrc\n", rc));
2566 return;
2567 }
2568
2569 LogRel(("VRDE: Enabled TSMF channel.\n"));
2570
2571 return;
2572}
2573
2574/* @todo these defines must be in a header, which is used by guest component as well. */
2575#define VBOX_TSMF_HCH_CREATE_ACCEPTED (VBOX_HOST_CHANNEL_EVENT_USER + 0)
2576#define VBOX_TSMF_HCH_CREATE_DECLINED (VBOX_HOST_CHANNEL_EVENT_USER + 1)
2577#define VBOX_TSMF_HCH_DISCONNECTED (VBOX_HOST_CHANNEL_EVENT_USER + 2)
2578
2579/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDETSMFCbNotify(void *pvContext,
2580 uint32_t u32Notification,
2581 void *pvChannel,
2582 const void *pvParm,
2583 uint32_t cbParm)
2584{
2585 int rc = VINF_SUCCESS;
2586
2587 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvContext);
2588
2589 TSMFVRDPCTX *pVRDPCtx = (TSMFVRDPCTX *)pvChannel;
2590
2591 Assert(pVRDPCtx->pThis == pThis);
2592
2593 if (pVRDPCtx->pCallbacks == NULL)
2594 {
2595 LogFlowFunc(("tsmfHostChannel: Channel disconnected. Skipping.\n"));
2596 return;
2597 }
2598
2599 switch (u32Notification)
2600 {
2601 case VRDE_TSMF_N_CREATE_ACCEPTED:
2602 {
2603 VRDETSMFNOTIFYCREATEACCEPTED *p = (VRDETSMFNOTIFYCREATEACCEPTED *)pvParm;
2604 Assert(cbParm == sizeof(VRDETSMFNOTIFYCREATEACCEPTED));
2605
2606 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_CREATE_ACCEPTED(%p): p->u32ChannelHandle %d\n",
2607 pVRDPCtx, p->u32ChannelHandle));
2608
2609 pVRDPCtx->u32ChannelHandle = p->u32ChannelHandle;
2610
2611 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2612 VBOX_TSMF_HCH_CREATE_ACCEPTED,
2613 NULL, 0);
2614 } break;
2615
2616 case VRDE_TSMF_N_CREATE_DECLINED:
2617 {
2618 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_CREATE_DECLINED(%p)\n", pVRDPCtx));
2619
2620 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2621 VBOX_TSMF_HCH_CREATE_DECLINED,
2622 NULL, 0);
2623 } break;
2624
2625 case VRDE_TSMF_N_DATA:
2626 {
2627 /* Save the data in the intermediate buffer and send the event. */
2628 VRDETSMFNOTIFYDATA *p = (VRDETSMFNOTIFYDATA *)pvParm;
2629 Assert(cbParm == sizeof(VRDETSMFNOTIFYDATA));
2630
2631 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_DATA(%p): p->cbData %d\n", pVRDPCtx, p->cbData));
2632
2633 VBOXHOSTCHANNELEVENTRECV ev;
2634 ev.u32SizeAvailable = 0;
2635
2636 rc = pThis->tsmfLock();
2637
2638 if (RT_SUCCESS(rc))
2639 {
2640 TSMFHOSTCHCTX *pHostChCtx = pVRDPCtx->pHostChCtx;
2641
2642 if (pHostChCtx)
2643 {
2644 if (pHostChCtx->pvDataReceived)
2645 {
2646 uint32_t cbAlloc = p->cbData + pHostChCtx->cbDataReceived;
2647 pHostChCtx->pvDataReceived = RTMemRealloc(pHostChCtx->pvDataReceived, cbAlloc);
2648 memcpy((uint8_t *)pHostChCtx->pvDataReceived + pHostChCtx->cbDataReceived, p->pvData, p->cbData);
2649
2650 pHostChCtx->cbDataReceived += p->cbData;
2651 pHostChCtx->cbDataAllocated = cbAlloc;
2652 }
2653 else
2654 {
2655 pHostChCtx->pvDataReceived = RTMemAlloc(p->cbData);
2656 memcpy(pHostChCtx->pvDataReceived, p->pvData, p->cbData);
2657
2658 pHostChCtx->cbDataReceived = p->cbData;
2659 pHostChCtx->cbDataAllocated = p->cbData;
2660 }
2661
2662 ev.u32SizeAvailable = p->cbData;
2663 }
2664 else
2665 {
2666 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_DATA: no host channel. Skipping\n"));
2667 }
2668
2669 pThis->tsmfUnlock();
2670 }
2671
2672 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2673 VBOX_HOST_CHANNEL_EVENT_RECV,
2674 &ev, sizeof(ev));
2675 } break;
2676
2677 case VRDE_TSMF_N_DISCONNECTED:
2678 {
2679 LogFlowFunc(("tsmfHostChannel: VRDE_TSMF_N_DISCONNECTED(%p)\n", pVRDPCtx));
2680
2681 pVRDPCtx->pCallbacks->HostChannelCallbackEvent(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx,
2682 VBOX_TSMF_HCH_DISCONNECTED,
2683 NULL, 0);
2684
2685 /* The callback context will not be used anymore. */
2686 pVRDPCtx->pCallbacks->HostChannelCallbackDeleted(pVRDPCtx->pvCallbacks, pVRDPCtx->pHostChCtx);
2687 pVRDPCtx->pCallbacks = NULL;
2688 pVRDPCtx->pvCallbacks = NULL;
2689
2690 rc = pThis->tsmfLock();
2691 if (RT_SUCCESS(rc))
2692 {
2693 if (pVRDPCtx->pHostChCtx)
2694 {
2695 /* There is still a host channel context for this channel. */
2696 pVRDPCtx->pHostChCtx->pVRDPCtx = NULL;
2697 }
2698
2699 pThis->tsmfUnlock();
2700
2701 RT_ZERO(*pVRDPCtx);
2702 RTMemFree(pVRDPCtx);
2703 }
2704 } break;
2705
2706 default:
2707 {
2708 AssertFailed();
2709 } break;
2710 }
2711}
2712
2713/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInNotify(void *pvCallback,
2714 uint32_t u32Id,
2715 const void *pvData,
2716 uint32_t cbData)
2717{
2718 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2719 if (pThis->mEmWebcam)
2720 {
2721 pThis->mEmWebcam->EmWebcamCbNotify(u32Id, pvData, cbData);
2722 }
2723}
2724
2725/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInDeviceDesc(void *pvCallback,
2726 int rcRequest,
2727 void *pDeviceCtx,
2728 void *pvUser,
2729 const VRDEVIDEOINDEVICEDESC *pDeviceDesc,
2730 uint32_t cbDevice)
2731{
2732 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2733 if (pThis->mEmWebcam)
2734 {
2735 pThis->mEmWebcam->EmWebcamCbDeviceDesc(rcRequest, pDeviceCtx, pvUser, pDeviceDesc, cbDevice);
2736 }
2737}
2738
2739/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInControl(void *pvCallback,
2740 int rcRequest,
2741 void *pDeviceCtx,
2742 void *pvUser,
2743 const VRDEVIDEOINCTRLHDR *pControl,
2744 uint32_t cbControl)
2745{
2746 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2747 if (pThis->mEmWebcam)
2748 {
2749 pThis->mEmWebcam->EmWebcamCbControl(rcRequest, pDeviceCtx, pvUser, pControl, cbControl);
2750 }
2751}
2752
2753/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackVideoInFrame(void *pvCallback,
2754 int rcRequest,
2755 void *pDeviceCtx,
2756 const VRDEVIDEOINPAYLOADHDR *pFrame,
2757 uint32_t cbFrame)
2758{
2759 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2760 if (pThis->mEmWebcam)
2761 {
2762 pThis->mEmWebcam->EmWebcamCbFrame(rcRequest, pDeviceCtx, pFrame, cbFrame);
2763 }
2764}
2765
2766int ConsoleVRDPServer::VideoInDeviceAttach(const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle, void *pvDeviceCtx)
2767{
2768 int rc;
2769
2770 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInDeviceAttach)
2771 {
2772 rc = m_interfaceVideoIn.VRDEVideoInDeviceAttach(mhServer, pDeviceHandle, pvDeviceCtx);
2773 }
2774 else
2775 {
2776 rc = VERR_NOT_SUPPORTED;
2777 }
2778
2779 return rc;
2780}
2781
2782int ConsoleVRDPServer::VideoInDeviceDetach(const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle)
2783{
2784 int rc;
2785
2786 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInDeviceDetach)
2787 {
2788 rc = m_interfaceVideoIn.VRDEVideoInDeviceDetach(mhServer, pDeviceHandle);
2789 }
2790 else
2791 {
2792 rc = VERR_NOT_SUPPORTED;
2793 }
2794
2795 return rc;
2796}
2797
2798int ConsoleVRDPServer::VideoInGetDeviceDesc(void *pvUser, const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle)
2799{
2800 int rc;
2801
2802 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInGetDeviceDesc)
2803 {
2804 rc = m_interfaceVideoIn.VRDEVideoInGetDeviceDesc(mhServer, pvUser, pDeviceHandle);
2805 }
2806 else
2807 {
2808 rc = VERR_NOT_SUPPORTED;
2809 }
2810
2811 return rc;
2812}
2813
2814int ConsoleVRDPServer::VideoInControl(void *pvUser, const VRDEVIDEOINDEVICEHANDLE *pDeviceHandle,
2815 const VRDEVIDEOINCTRLHDR *pReq, uint32_t cbReq)
2816{
2817 int rc;
2818
2819 if (mhServer && mpEntryPoints && m_interfaceVideoIn.VRDEVideoInControl)
2820 {
2821 rc = m_interfaceVideoIn.VRDEVideoInControl(mhServer, pvUser, pDeviceHandle, pReq, cbReq);
2822 }
2823 else
2824 {
2825 rc = VERR_NOT_SUPPORTED;
2826 }
2827
2828 return rc;
2829}
2830
2831
2832/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackInputSetup(void *pvCallback,
2833 int rcRequest,
2834 uint32_t u32Method,
2835 const void *pvResult,
2836 uint32_t cbResult)
2837{
2838 NOREF(pvCallback);
2839 NOREF(rcRequest);
2840 NOREF(u32Method);
2841 NOREF(pvResult);
2842 NOREF(cbResult);
2843}
2844
2845/* static */ DECLCALLBACK(void) ConsoleVRDPServer::VRDECallbackInputEvent(void *pvCallback,
2846 uint32_t u32Method,
2847 const void *pvEvent,
2848 uint32_t cbEvent)
2849{
2850 ConsoleVRDPServer *pThis = static_cast<ConsoleVRDPServer*>(pvCallback);
2851
2852 if (u32Method == VRDE_INPUT_METHOD_TOUCH)
2853 {
2854 if (cbEvent >= sizeof(VRDEINPUTHEADER))
2855 {
2856 VRDEINPUTHEADER *pHeader = (VRDEINPUTHEADER *)pvEvent;
2857
2858 if (pHeader->u16EventId == VRDEINPUT_EVENTID_TOUCH)
2859 {
2860 IMouse *pMouse = pThis->mConsole->i_getMouse();
2861
2862 VRDEINPUT_TOUCH_EVENT_PDU *p = (VRDEINPUT_TOUCH_EVENT_PDU *)pHeader;
2863
2864 uint16_t iFrame;
2865 for (iFrame = 0; iFrame < p->u16FrameCount; iFrame++)
2866 {
2867 VRDEINPUT_TOUCH_FRAME *pFrame = &p->aFrames[iFrame];
2868
2869 com::SafeArray<LONG64> aContacts(pFrame->u16ContactCount);
2870
2871 uint16_t iContact;
2872 for (iContact = 0; iContact < pFrame->u16ContactCount; iContact++)
2873 {
2874 VRDEINPUT_CONTACT_DATA *pContact = &pFrame->aContacts[iContact];
2875
2876 int16_t x = (int16_t)(pContact->i32X + 1);
2877 int16_t y = (int16_t)(pContact->i32Y + 1);
2878 uint8_t contactId = pContact->u8ContactId;
2879 uint8_t contactState = TouchContactState_None;
2880
2881 if (pContact->u32ContactFlags & VRDEINPUT_CONTACT_FLAG_INRANGE)
2882 {
2883 contactState |= TouchContactState_InRange;
2884 }
2885 if (pContact->u32ContactFlags & VRDEINPUT_CONTACT_FLAG_INCONTACT)
2886 {
2887 contactState |= TouchContactState_InContact;
2888 }
2889
2890 aContacts[iContact] = RT_MAKE_U64_FROM_U16((uint16_t)x,
2891 (uint16_t)y,
2892 RT_MAKE_U16(contactId, contactState),
2893 0);
2894 }
2895
2896 if (pFrame->u64FrameOffset == 0)
2897 {
2898 pThis->mu64TouchInputTimestampMCS = 0;
2899 }
2900 else
2901 {
2902 pThis->mu64TouchInputTimestampMCS += pFrame->u64FrameOffset;
2903 }
2904
2905 pMouse->PutEventMultiTouch(pFrame->u16ContactCount,
2906 ComSafeArrayAsInParam(aContacts),
2907 (ULONG)(pThis->mu64TouchInputTimestampMCS / 1000)); /* Micro->milliseconds. */
2908 }
2909 }
2910 else if (pHeader->u16EventId == VRDEINPUT_EVENTID_DISMISS_HOVERING_CONTACT)
2911 {
2912 /* @todo */
2913 }
2914 else
2915 {
2916 AssertMsgFailed(("EventId %d\n", pHeader->u16EventId));
2917 }
2918 }
2919 }
2920}
2921
2922
2923void ConsoleVRDPServer::EnableConnections(void)
2924{
2925 if (mpEntryPoints && mhServer)
2926 {
2927 mpEntryPoints->VRDEEnableConnections(mhServer, true);
2928
2929 /* Setup the generic TSMF channel. */
2930 setupTSMF();
2931 }
2932}
2933
2934void ConsoleVRDPServer::DisconnectClient(uint32_t u32ClientId, bool fReconnect)
2935{
2936 if (mpEntryPoints && mhServer)
2937 {
2938 mpEntryPoints->VRDEDisconnect(mhServer, u32ClientId, fReconnect);
2939 }
2940}
2941
2942int ConsoleVRDPServer::MousePointer(BOOL alpha,
2943 ULONG xHot,
2944 ULONG yHot,
2945 ULONG width,
2946 ULONG height,
2947 const uint8_t *pu8Shape)
2948{
2949 int rc = VINF_SUCCESS;
2950
2951 if (mhServer && mpEntryPoints && m_interfaceMousePtr.VRDEMousePtr)
2952 {
2953 size_t cbMask = (((width + 7) / 8) * height + 3) & ~3;
2954 size_t cbData = width * height * 4;
2955
2956 size_t cbDstMask = alpha? 0: cbMask;
2957
2958 size_t cbPointer = sizeof(VRDEMOUSEPTRDATA) + cbDstMask + cbData;
2959 uint8_t *pu8Pointer = (uint8_t *)RTMemAlloc(cbPointer);
2960 if (pu8Pointer != NULL)
2961 {
2962 VRDEMOUSEPTRDATA *pPointer = (VRDEMOUSEPTRDATA *)pu8Pointer;
2963
2964 pPointer->u16HotX = (uint16_t)xHot;
2965 pPointer->u16HotY = (uint16_t)yHot;
2966 pPointer->u16Width = (uint16_t)width;
2967 pPointer->u16Height = (uint16_t)height;
2968 pPointer->u16MaskLen = (uint16_t)cbDstMask;
2969 pPointer->u32DataLen = (uint32_t)cbData;
2970
2971 /* AND mask. */
2972 uint8_t *pu8Mask = pu8Pointer + sizeof(VRDEMOUSEPTRDATA);
2973 if (cbDstMask)
2974 {
2975 memcpy(pu8Mask, pu8Shape, cbDstMask);
2976 }
2977
2978 /* XOR mask */
2979 uint8_t *pu8Data = pu8Mask + pPointer->u16MaskLen;
2980 memcpy(pu8Data, pu8Shape + cbMask, cbData);
2981
2982 m_interfaceMousePtr.VRDEMousePtr(mhServer, pPointer);
2983
2984 RTMemFree(pu8Pointer);
2985 }
2986 else
2987 {
2988 rc = VERR_NO_MEMORY;
2989 }
2990 }
2991 else
2992 {
2993 rc = VERR_NOT_SUPPORTED;
2994 }
2995
2996 return rc;
2997}
2998
2999void ConsoleVRDPServer::MousePointerUpdate(const VRDECOLORPOINTER *pPointer)
3000{
3001 if (mpEntryPoints && mhServer)
3002 {
3003 mpEntryPoints->VRDEColorPointer(mhServer, pPointer);
3004 }
3005}
3006
3007void ConsoleVRDPServer::MousePointerHide(void)
3008{
3009 if (mpEntryPoints && mhServer)
3010 {
3011 mpEntryPoints->VRDEHidePointer(mhServer);
3012 }
3013}
3014
3015void ConsoleVRDPServer::Stop(void)
3016{
3017 Assert(VALID_PTR(this)); /** @todo r=bird: there are(/was) some odd cases where this buster was invalid on
3018 * linux. Just remove this when it's 100% sure that problem has been fixed. */
3019
3020#ifdef VBOX_WITH_USB
3021 remoteUSBThreadStop();
3022#endif /* VBOX_WITH_USB */
3023
3024 if (mhServer)
3025 {
3026 HVRDESERVER hServer = mhServer;
3027
3028 /* Reset the handle to avoid further calls to the server. */
3029 mhServer = 0;
3030
3031 /* Workaround for VM process hangs on termination.
3032 *
3033 * Make sure that the server is not currently processing a resize.
3034 * mhServer 0 will not allow to enter the server again.
3035 * Wait until any current resize returns from the server.
3036 */
3037 if (mcInResize)
3038 {
3039 LogRel(("VRDP: waiting for resize %d\n", mcInResize));
3040
3041 int i = 0;
3042 while (mcInResize && ++i < 100)
3043 {
3044 RTThreadSleep(10);
3045 }
3046 }
3047
3048 if (mpEntryPoints && hServer)
3049 {
3050 mpEntryPoints->VRDEDestroy(hServer);
3051 }
3052 }
3053
3054 mpfnAuthEntry = NULL;
3055 mpfnAuthEntry2 = NULL;
3056 mpfnAuthEntry3 = NULL;
3057
3058 if (mAuthLibrary)
3059 {
3060 RTLdrClose(mAuthLibrary);
3061 mAuthLibrary = 0;
3062 }
3063}
3064
3065/* Worker thread for Remote USB. The thread polls the clients for
3066 * the list of attached USB devices.
3067 * The thread is also responsible for attaching/detaching devices
3068 * to/from the VM.
3069 *
3070 * It is expected that attaching/detaching is not a frequent operation.
3071 *
3072 * The thread is always running when the VRDP server is active.
3073 *
3074 * The thread scans backends and requests the device list every 2 seconds.
3075 *
3076 * When device list is available, the thread calls the Console to process it.
3077 *
3078 */
3079#define VRDP_DEVICE_LIST_PERIOD_MS (2000)
3080
3081#ifdef VBOX_WITH_USB
3082static DECLCALLBACK(int) threadRemoteUSB(RTTHREAD self, void *pvUser)
3083{
3084 ConsoleVRDPServer *pOwner = (ConsoleVRDPServer *)pvUser;
3085
3086 LogFlow(("Console::threadRemoteUSB: start. owner = %p.\n", pOwner));
3087
3088 pOwner->notifyRemoteUSBThreadRunning(self);
3089
3090 while (pOwner->isRemoteUSBThreadRunning())
3091 {
3092 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3093
3094 while ((pRemoteUSBBackend = pOwner->usbBackendGetNext(pRemoteUSBBackend)) != NULL)
3095 {
3096 pRemoteUSBBackend->PollRemoteDevices();
3097 }
3098
3099 pOwner->waitRemoteUSBThreadEvent(VRDP_DEVICE_LIST_PERIOD_MS);
3100
3101 LogFlow(("Console::threadRemoteUSB: iteration. owner = %p.\n", pOwner));
3102 }
3103
3104 return VINF_SUCCESS;
3105}
3106
3107void ConsoleVRDPServer::notifyRemoteUSBThreadRunning(RTTHREAD thread)
3108{
3109 mUSBBackends.thread = thread;
3110 mUSBBackends.fThreadRunning = true;
3111 int rc = RTThreadUserSignal(thread);
3112 AssertRC(rc);
3113}
3114
3115bool ConsoleVRDPServer::isRemoteUSBThreadRunning(void)
3116{
3117 return mUSBBackends.fThreadRunning;
3118}
3119
3120void ConsoleVRDPServer::waitRemoteUSBThreadEvent(RTMSINTERVAL cMillies)
3121{
3122 int rc = RTSemEventWait(mUSBBackends.event, cMillies);
3123 Assert(RT_SUCCESS(rc) || rc == VERR_TIMEOUT);
3124 NOREF(rc);
3125}
3126
3127void ConsoleVRDPServer::remoteUSBThreadStart(void)
3128{
3129 int rc = RTSemEventCreate(&mUSBBackends.event);
3130
3131 if (RT_FAILURE(rc))
3132 {
3133 AssertFailed();
3134 mUSBBackends.event = 0;
3135 }
3136
3137 if (RT_SUCCESS(rc))
3138 {
3139 rc = RTThreadCreate(&mUSBBackends.thread, threadRemoteUSB, this, 65536,
3140 RTTHREADTYPE_VRDP_IO, RTTHREADFLAGS_WAITABLE, "remote usb");
3141 }
3142
3143 if (RT_FAILURE(rc))
3144 {
3145 LogRel(("Warning: could not start the remote USB thread, rc = %Rrc!!!\n", rc));
3146 mUSBBackends.thread = NIL_RTTHREAD;
3147 }
3148 else
3149 {
3150 /* Wait until the thread is ready. */
3151 rc = RTThreadUserWait(mUSBBackends.thread, 60000);
3152 AssertRC(rc);
3153 Assert (mUSBBackends.fThreadRunning || RT_FAILURE(rc));
3154 }
3155}
3156
3157void ConsoleVRDPServer::remoteUSBThreadStop(void)
3158{
3159 mUSBBackends.fThreadRunning = false;
3160
3161 if (mUSBBackends.thread != NIL_RTTHREAD)
3162 {
3163 Assert (mUSBBackends.event != 0);
3164
3165 RTSemEventSignal(mUSBBackends.event);
3166
3167 int rc = RTThreadWait(mUSBBackends.thread, 60000, NULL);
3168 AssertRC(rc);
3169
3170 mUSBBackends.thread = NIL_RTTHREAD;
3171 }
3172
3173 if (mUSBBackends.event)
3174 {
3175 RTSemEventDestroy(mUSBBackends.event);
3176 mUSBBackends.event = 0;
3177 }
3178}
3179#endif /* VBOX_WITH_USB */
3180
3181typedef struct AuthCtx
3182{
3183 AuthResult result;
3184
3185 PAUTHENTRY3 pfnAuthEntry3;
3186 PAUTHENTRY2 pfnAuthEntry2;
3187 PAUTHENTRY pfnAuthEntry;
3188
3189 const char *pszCaller;
3190 PAUTHUUID pUuid;
3191 AuthGuestJudgement guestJudgement;
3192 const char *pszUser;
3193 const char *pszPassword;
3194 const char *pszDomain;
3195 int fLogon;
3196 unsigned clientId;
3197} AuthCtx;
3198
3199static DECLCALLBACK(int) authThread(RTTHREAD self, void *pvUser)
3200{
3201 AuthCtx *pCtx = (AuthCtx *)pvUser;
3202
3203 if (pCtx->pfnAuthEntry3)
3204 {
3205 pCtx->result = pCtx->pfnAuthEntry3(pCtx->pszCaller, pCtx->pUuid, pCtx->guestJudgement,
3206 pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain,
3207 pCtx->fLogon, pCtx->clientId);
3208 }
3209 else if (pCtx->pfnAuthEntry2)
3210 {
3211 pCtx->result = pCtx->pfnAuthEntry2(pCtx->pUuid, pCtx->guestJudgement,
3212 pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain,
3213 pCtx->fLogon, pCtx->clientId);
3214 }
3215 else if (pCtx->pfnAuthEntry)
3216 {
3217 pCtx->result = pCtx->pfnAuthEntry(pCtx->pUuid, pCtx->guestJudgement,
3218 pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain);
3219 }
3220 return VINF_SUCCESS;
3221}
3222
3223static AuthResult authCall(AuthCtx *pCtx)
3224{
3225 AuthResult result = AuthResultAccessDenied;
3226
3227 /* Use a separate thread because external modules might need a lot of stack space. */
3228 RTTHREAD thread = NIL_RTTHREAD;
3229 int rc = RTThreadCreate(&thread, authThread, pCtx, 512*_1K,
3230 RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE, "VRDEAuth");
3231 LogFlow(("authCall: RTThreadCreate %Rrc\n", rc));
3232
3233 if (RT_SUCCESS(rc))
3234 {
3235 rc = RTThreadWait(thread, RT_INDEFINITE_WAIT, NULL);
3236 LogFlow(("authCall: RTThreadWait %Rrc\n", rc));
3237 }
3238
3239 if (RT_SUCCESS(rc))
3240 {
3241 /* Only update the result if the thread finished without errors. */
3242 result = pCtx->result;
3243 }
3244 else
3245 {
3246 LogRel(("AUTH: unable to execute the auth thread %Rrc\n", rc));
3247 }
3248
3249 return result;
3250}
3251
3252AuthResult ConsoleVRDPServer::Authenticate(const Guid &uuid, AuthGuestJudgement guestJudgement,
3253 const char *pszUser, const char *pszPassword, const char *pszDomain,
3254 uint32_t u32ClientId)
3255{
3256 AUTHUUID rawuuid;
3257
3258 memcpy(rawuuid, uuid.raw(), sizeof(rawuuid));
3259
3260 LogFlow(("ConsoleVRDPServer::Authenticate: uuid = %RTuuid, guestJudgement = %d, pszUser = %s, pszPassword = %s, pszDomain = %s, u32ClientId = %d\n",
3261 rawuuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId));
3262
3263 /*
3264 * Called only from VRDP input thread. So thread safety is not required.
3265 */
3266
3267 if (!mAuthLibrary)
3268 {
3269 /* Load the external authentication library. */
3270 Bstr authLibrary;
3271 mConsole->i_getVRDEServer()->COMGETTER(AuthLibrary)(authLibrary.asOutParam());
3272
3273 Utf8Str filename = authLibrary;
3274
3275 LogRel(("AUTH: loading external authentication library '%ls'\n", authLibrary.raw()));
3276
3277 int rc;
3278 if (RTPathHavePath(filename.c_str()))
3279 rc = RTLdrLoad(filename.c_str(), &mAuthLibrary);
3280 else
3281 {
3282 rc = RTLdrLoadAppPriv(filename.c_str(), &mAuthLibrary);
3283 if (RT_FAILURE(rc))
3284 {
3285 /* Backward compatibility with old default 'VRDPAuth' name.
3286 * Try to load new default 'VBoxAuth' instead.
3287 */
3288 if (filename == "VRDPAuth")
3289 {
3290 LogRel(("AUTH: ConsoleVRDPServer::Authenticate: loading external authentication library VBoxAuth\n"));
3291 rc = RTLdrLoadAppPriv("VBoxAuth", &mAuthLibrary);
3292 }
3293 }
3294 }
3295
3296 if (RT_FAILURE(rc))
3297 LogRel(("AUTH: Failed to load external authentication library. Error code: %Rrc\n", rc));
3298
3299 if (RT_SUCCESS(rc))
3300 {
3301 typedef struct AuthEntryInfoStruct
3302 {
3303 const char *pszName;
3304 void **ppvAddress;
3305
3306 } AuthEntryInfo;
3307 AuthEntryInfo entries[] =
3308 {
3309 { AUTHENTRY3_NAME, (void **)&mpfnAuthEntry3 },
3310 { AUTHENTRY2_NAME, (void **)&mpfnAuthEntry2 },
3311 { AUTHENTRY_NAME, (void **)&mpfnAuthEntry },
3312 { NULL, NULL }
3313 };
3314
3315 /* Get the entry point. */
3316 AuthEntryInfo *pEntryInfo = &entries[0];
3317 while (pEntryInfo->pszName)
3318 {
3319 *pEntryInfo->ppvAddress = NULL;
3320
3321 int rc2 = RTLdrGetSymbol(mAuthLibrary, pEntryInfo->pszName, pEntryInfo->ppvAddress);
3322 if (RT_SUCCESS(rc2))
3323 {
3324 /* Found an entry point. */
3325 LogRel(("AUTH: Using entry point '%s'.\n", pEntryInfo->pszName));
3326 rc = VINF_SUCCESS;
3327 break;
3328 }
3329
3330 if (rc2 != VERR_SYMBOL_NOT_FOUND)
3331 {
3332 LogRel(("AUTH: Could not resolve import '%s'. Error code: %Rrc\n", pEntryInfo->pszName, rc2));
3333 }
3334 rc = rc2;
3335
3336 pEntryInfo++;
3337 }
3338 }
3339
3340 if (RT_FAILURE(rc))
3341 {
3342 mConsole->setError(E_FAIL,
3343 mConsole->tr("Could not load the external authentication library '%s' (%Rrc)"),
3344 filename.c_str(),
3345 rc);
3346
3347 mpfnAuthEntry = NULL;
3348 mpfnAuthEntry2 = NULL;
3349 mpfnAuthEntry3 = NULL;
3350
3351 if (mAuthLibrary)
3352 {
3353 RTLdrClose(mAuthLibrary);
3354 mAuthLibrary = 0;
3355 }
3356
3357 return AuthResultAccessDenied;
3358 }
3359 }
3360
3361 Assert(mAuthLibrary && (mpfnAuthEntry || mpfnAuthEntry2 || mpfnAuthEntry3));
3362
3363 AuthCtx ctx;
3364 ctx.result = AuthResultAccessDenied; /* Denied by default. */
3365 ctx.pfnAuthEntry3 = mpfnAuthEntry3;
3366 ctx.pfnAuthEntry2 = mpfnAuthEntry2;
3367 ctx.pfnAuthEntry = mpfnAuthEntry;
3368 ctx.pszCaller = "vrde";
3369 ctx.pUuid = &rawuuid;
3370 ctx.guestJudgement = guestJudgement;
3371 ctx.pszUser = pszUser;
3372 ctx.pszPassword = pszPassword;
3373 ctx.pszDomain = pszDomain;
3374 ctx.fLogon = true;
3375 ctx.clientId = u32ClientId;
3376
3377 AuthResult result = authCall(&ctx);
3378
3379 switch (result)
3380 {
3381 case AuthResultAccessDenied:
3382 LogRel(("AUTH: external authentication module returned 'access denied'\n"));
3383 break;
3384 case AuthResultAccessGranted:
3385 LogRel(("AUTH: external authentication module returned 'access granted'\n"));
3386 break;
3387 case AuthResultDelegateToGuest:
3388 LogRel(("AUTH: external authentication module returned 'delegate request to guest'\n"));
3389 break;
3390 default:
3391 LogRel(("AUTH: external authentication module returned incorrect return code %d\n", result));
3392 result = AuthResultAccessDenied;
3393 }
3394
3395 LogFlow(("ConsoleVRDPServer::Authenticate: result = %d\n", result));
3396
3397 return result;
3398}
3399
3400void ConsoleVRDPServer::AuthDisconnect(const Guid &uuid, uint32_t u32ClientId)
3401{
3402 AUTHUUID rawuuid;
3403
3404 memcpy(rawuuid, uuid.raw(), sizeof(rawuuid));
3405
3406 LogFlow(("ConsoleVRDPServer::AuthDisconnect: uuid = %RTuuid, u32ClientId = %d\n",
3407 rawuuid, u32ClientId));
3408
3409 Assert(mAuthLibrary && (mpfnAuthEntry || mpfnAuthEntry2 || mpfnAuthEntry3));
3410
3411 AuthCtx ctx;
3412 ctx.result = AuthResultAccessDenied; /* Not used. */
3413 ctx.pfnAuthEntry3 = mpfnAuthEntry3;
3414 ctx.pfnAuthEntry2 = mpfnAuthEntry2;
3415 ctx.pfnAuthEntry = NULL; /* Does not use disconnect notification. */
3416 ctx.pszCaller = "vrde";
3417 ctx.pUuid = &rawuuid;
3418 ctx.guestJudgement = AuthGuestNotAsked;
3419 ctx.pszUser = NULL;
3420 ctx.pszPassword = NULL;
3421 ctx.pszDomain = NULL;
3422 ctx.fLogon = false;
3423 ctx.clientId = u32ClientId;
3424
3425 authCall(&ctx);
3426}
3427
3428int ConsoleVRDPServer::lockConsoleVRDPServer(void)
3429{
3430 int rc = RTCritSectEnter(&mCritSect);
3431 AssertRC(rc);
3432 return rc;
3433}
3434
3435void ConsoleVRDPServer::unlockConsoleVRDPServer(void)
3436{
3437 RTCritSectLeave(&mCritSect);
3438}
3439
3440DECLCALLBACK(int) ConsoleVRDPServer::ClipboardCallback(void *pvCallback,
3441 uint32_t u32ClientId,
3442 uint32_t u32Function,
3443 uint32_t u32Format,
3444 const void *pvData,
3445 uint32_t cbData)
3446{
3447 LogFlowFunc(("pvCallback = %p, u32ClientId = %d, u32Function = %d, u32Format = 0x%08X, pvData = %p, cbData = %d\n",
3448 pvCallback, u32ClientId, u32Function, u32Format, pvData, cbData));
3449
3450 int rc = VINF_SUCCESS;
3451
3452 ConsoleVRDPServer *pServer = static_cast <ConsoleVRDPServer *>(pvCallback);
3453
3454 NOREF(u32ClientId);
3455
3456 switch (u32Function)
3457 {
3458 case VRDE_CLIPBOARD_FUNCTION_FORMAT_ANNOUNCE:
3459 {
3460 if (pServer->mpfnClipboardCallback)
3461 {
3462 pServer->mpfnClipboardCallback(VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE,
3463 u32Format,
3464 (void *)pvData,
3465 cbData);
3466 }
3467 } break;
3468
3469 case VRDE_CLIPBOARD_FUNCTION_DATA_READ:
3470 {
3471 if (pServer->mpfnClipboardCallback)
3472 {
3473 pServer->mpfnClipboardCallback(VBOX_CLIPBOARD_EXT_FN_DATA_READ,
3474 u32Format,
3475 (void *)pvData,
3476 cbData);
3477 }
3478 } break;
3479
3480 default:
3481 rc = VERR_NOT_SUPPORTED;
3482 }
3483
3484 return rc;
3485}
3486
3487DECLCALLBACK(int) ConsoleVRDPServer::ClipboardServiceExtension(void *pvExtension,
3488 uint32_t u32Function,
3489 void *pvParms,
3490 uint32_t cbParms)
3491{
3492 LogFlowFunc(("pvExtension = %p, u32Function = %d, pvParms = %p, cbParms = %d\n",
3493 pvExtension, u32Function, pvParms, cbParms));
3494
3495 int rc = VINF_SUCCESS;
3496
3497 ConsoleVRDPServer *pServer = static_cast <ConsoleVRDPServer *>(pvExtension);
3498
3499 VBOXCLIPBOARDEXTPARMS *pParms = (VBOXCLIPBOARDEXTPARMS *)pvParms;
3500
3501 switch (u32Function)
3502 {
3503 case VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK:
3504 {
3505 pServer->mpfnClipboardCallback = pParms->u.pfnCallback;
3506 } break;
3507
3508 case VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE:
3509 {
3510 /* The guest announces clipboard formats. This must be delivered to all clients. */
3511 if (mpEntryPoints && pServer->mhServer)
3512 {
3513 mpEntryPoints->VRDEClipboard(pServer->mhServer,
3514 VRDE_CLIPBOARD_FUNCTION_FORMAT_ANNOUNCE,
3515 pParms->u32Format,
3516 NULL,
3517 0,
3518 NULL);
3519 }
3520 } break;
3521
3522 case VBOX_CLIPBOARD_EXT_FN_DATA_READ:
3523 {
3524 /* The clipboard service expects that the pvData buffer will be filled
3525 * with clipboard data. The server returns the data from the client that
3526 * announced the requested format most recently.
3527 */
3528 if (mpEntryPoints && pServer->mhServer)
3529 {
3530 mpEntryPoints->VRDEClipboard(pServer->mhServer,
3531 VRDE_CLIPBOARD_FUNCTION_DATA_READ,
3532 pParms->u32Format,
3533 pParms->u.pvData,
3534 pParms->cbData,
3535 &pParms->cbData);
3536 }
3537 } break;
3538
3539 case VBOX_CLIPBOARD_EXT_FN_DATA_WRITE:
3540 {
3541 if (mpEntryPoints && pServer->mhServer)
3542 {
3543 mpEntryPoints->VRDEClipboard(pServer->mhServer,
3544 VRDE_CLIPBOARD_FUNCTION_DATA_WRITE,
3545 pParms->u32Format,
3546 pParms->u.pvData,
3547 pParms->cbData,
3548 NULL);
3549 }
3550 } break;
3551
3552 default:
3553 rc = VERR_NOT_SUPPORTED;
3554 }
3555
3556 return rc;
3557}
3558
3559void ConsoleVRDPServer::ClipboardCreate(uint32_t u32ClientId)
3560{
3561 int rc = lockConsoleVRDPServer();
3562
3563 if (RT_SUCCESS(rc))
3564 {
3565 if (mcClipboardRefs == 0)
3566 {
3567 rc = HGCMHostRegisterServiceExtension(&mhClipboard, "VBoxSharedClipboard", ClipboardServiceExtension, this);
3568
3569 if (RT_SUCCESS(rc))
3570 {
3571 mcClipboardRefs++;
3572 }
3573 }
3574
3575 unlockConsoleVRDPServer();
3576 }
3577}
3578
3579void ConsoleVRDPServer::ClipboardDelete(uint32_t u32ClientId)
3580{
3581 int rc = lockConsoleVRDPServer();
3582
3583 if (RT_SUCCESS(rc))
3584 {
3585 mcClipboardRefs--;
3586
3587 if (mcClipboardRefs == 0)
3588 {
3589 HGCMHostUnregisterServiceExtension(mhClipboard);
3590 }
3591
3592 unlockConsoleVRDPServer();
3593 }
3594}
3595
3596/* That is called on INPUT thread of the VRDP server.
3597 * The ConsoleVRDPServer keeps a list of created backend instances.
3598 */
3599void ConsoleVRDPServer::USBBackendCreate(uint32_t u32ClientId, void **ppvIntercept)
3600{
3601#ifdef VBOX_WITH_USB
3602 LogFlow(("ConsoleVRDPServer::USBBackendCreate: u32ClientId = %d\n", u32ClientId));
3603
3604 /* Create a new instance of the USB backend for the new client. */
3605 RemoteUSBBackend *pRemoteUSBBackend = new RemoteUSBBackend(mConsole, this, u32ClientId);
3606
3607 if (pRemoteUSBBackend)
3608 {
3609 pRemoteUSBBackend->AddRef(); /* 'Release' called in USBBackendDelete. */
3610
3611 /* Append the new instance in the list. */
3612 int rc = lockConsoleVRDPServer();
3613
3614 if (RT_SUCCESS(rc))
3615 {
3616 pRemoteUSBBackend->pNext = mUSBBackends.pHead;
3617 if (mUSBBackends.pHead)
3618 {
3619 mUSBBackends.pHead->pPrev = pRemoteUSBBackend;
3620 }
3621 else
3622 {
3623 mUSBBackends.pTail = pRemoteUSBBackend;
3624 }
3625
3626 mUSBBackends.pHead = pRemoteUSBBackend;
3627
3628 unlockConsoleVRDPServer();
3629
3630 if (ppvIntercept)
3631 {
3632 *ppvIntercept = pRemoteUSBBackend;
3633 }
3634 }
3635
3636 if (RT_FAILURE(rc))
3637 {
3638 pRemoteUSBBackend->Release();
3639 }
3640 }
3641#endif /* VBOX_WITH_USB */
3642}
3643
3644void ConsoleVRDPServer::USBBackendDelete(uint32_t u32ClientId)
3645{
3646#ifdef VBOX_WITH_USB
3647 LogFlow(("ConsoleVRDPServer::USBBackendDelete: u32ClientId = %d\n", u32ClientId));
3648
3649 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3650
3651 /* Find the instance. */
3652 int rc = lockConsoleVRDPServer();
3653
3654 if (RT_SUCCESS(rc))
3655 {
3656 pRemoteUSBBackend = usbBackendFind(u32ClientId);
3657
3658 if (pRemoteUSBBackend)
3659 {
3660 /* Notify that it will be deleted. */
3661 pRemoteUSBBackend->NotifyDelete();
3662 }
3663
3664 unlockConsoleVRDPServer();
3665 }
3666
3667 if (pRemoteUSBBackend)
3668 {
3669 /* Here the instance has been excluded from the list and can be dereferenced. */
3670 pRemoteUSBBackend->Release();
3671 }
3672#endif
3673}
3674
3675void *ConsoleVRDPServer::USBBackendRequestPointer(uint32_t u32ClientId, const Guid *pGuid)
3676{
3677#ifdef VBOX_WITH_USB
3678 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3679
3680 /* Find the instance. */
3681 int rc = lockConsoleVRDPServer();
3682
3683 if (RT_SUCCESS(rc))
3684 {
3685 pRemoteUSBBackend = usbBackendFind(u32ClientId);
3686
3687 if (pRemoteUSBBackend)
3688 {
3689 /* Inform the backend instance that it is referenced by the Guid. */
3690 bool fAdded = pRemoteUSBBackend->addUUID(pGuid);
3691
3692 if (fAdded)
3693 {
3694 /* Reference the instance because its pointer is being taken. */
3695 pRemoteUSBBackend->AddRef(); /* 'Release' is called in USBBackendReleasePointer. */
3696 }
3697 else
3698 {
3699 pRemoteUSBBackend = NULL;
3700 }
3701 }
3702
3703 unlockConsoleVRDPServer();
3704 }
3705
3706 if (pRemoteUSBBackend)
3707 {
3708 return pRemoteUSBBackend->GetBackendCallbackPointer();
3709 }
3710
3711#endif
3712 return NULL;
3713}
3714
3715void ConsoleVRDPServer::USBBackendReleasePointer(const Guid *pGuid)
3716{
3717#ifdef VBOX_WITH_USB
3718 RemoteUSBBackend *pRemoteUSBBackend = NULL;
3719
3720 /* Find the instance. */
3721 int rc = lockConsoleVRDPServer();
3722
3723 if (RT_SUCCESS(rc))
3724 {
3725 pRemoteUSBBackend = usbBackendFindByUUID(pGuid);
3726
3727 if (pRemoteUSBBackend)
3728 {
3729 pRemoteUSBBackend->removeUUID(pGuid);
3730 }
3731
3732 unlockConsoleVRDPServer();
3733
3734 if (pRemoteUSBBackend)
3735 {
3736 pRemoteUSBBackend->Release();
3737 }
3738 }
3739#endif
3740}
3741
3742RemoteUSBBackend *ConsoleVRDPServer::usbBackendGetNext(RemoteUSBBackend *pRemoteUSBBackend)
3743{
3744 LogFlow(("ConsoleVRDPServer::usbBackendGetNext: pBackend = %p\n", pRemoteUSBBackend));
3745
3746 RemoteUSBBackend *pNextRemoteUSBBackend = NULL;
3747#ifdef VBOX_WITH_USB
3748
3749 int rc = lockConsoleVRDPServer();
3750
3751 if (RT_SUCCESS(rc))
3752 {
3753 if (pRemoteUSBBackend == NULL)
3754 {
3755 /* The first backend in the list is requested. */
3756 pNextRemoteUSBBackend = mUSBBackends.pHead;
3757 }
3758 else
3759 {
3760 /* Get pointer to the next backend. */
3761 pNextRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3762 }
3763
3764 if (pNextRemoteUSBBackend)
3765 {
3766 pNextRemoteUSBBackend->AddRef();
3767 }
3768
3769 unlockConsoleVRDPServer();
3770
3771 if (pRemoteUSBBackend)
3772 {
3773 pRemoteUSBBackend->Release();
3774 }
3775 }
3776#endif
3777
3778 return pNextRemoteUSBBackend;
3779}
3780
3781#ifdef VBOX_WITH_USB
3782/* Internal method. Called under the ConsoleVRDPServerLock. */
3783RemoteUSBBackend *ConsoleVRDPServer::usbBackendFind(uint32_t u32ClientId)
3784{
3785 RemoteUSBBackend *pRemoteUSBBackend = mUSBBackends.pHead;
3786
3787 while (pRemoteUSBBackend)
3788 {
3789 if (pRemoteUSBBackend->ClientId() == u32ClientId)
3790 {
3791 break;
3792 }
3793
3794 pRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3795 }
3796
3797 return pRemoteUSBBackend;
3798}
3799
3800/* Internal method. Called under the ConsoleVRDPServerLock. */
3801RemoteUSBBackend *ConsoleVRDPServer::usbBackendFindByUUID(const Guid *pGuid)
3802{
3803 RemoteUSBBackend *pRemoteUSBBackend = mUSBBackends.pHead;
3804
3805 while (pRemoteUSBBackend)
3806 {
3807 if (pRemoteUSBBackend->findUUID(pGuid))
3808 {
3809 break;
3810 }
3811
3812 pRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3813 }
3814
3815 return pRemoteUSBBackend;
3816}
3817#endif
3818
3819/* Internal method. Called by the backend destructor. */
3820void ConsoleVRDPServer::usbBackendRemoveFromList(RemoteUSBBackend *pRemoteUSBBackend)
3821{
3822#ifdef VBOX_WITH_USB
3823 int rc = lockConsoleVRDPServer();
3824 AssertRC(rc);
3825
3826 /* Exclude the found instance from the list. */
3827 if (pRemoteUSBBackend->pNext)
3828 {
3829 pRemoteUSBBackend->pNext->pPrev = pRemoteUSBBackend->pPrev;
3830 }
3831 else
3832 {
3833 mUSBBackends.pTail = (RemoteUSBBackend *)pRemoteUSBBackend->pPrev;
3834 }
3835
3836 if (pRemoteUSBBackend->pPrev)
3837 {
3838 pRemoteUSBBackend->pPrev->pNext = pRemoteUSBBackend->pNext;
3839 }
3840 else
3841 {
3842 mUSBBackends.pHead = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
3843 }
3844
3845 pRemoteUSBBackend->pNext = pRemoteUSBBackend->pPrev = NULL;
3846
3847 unlockConsoleVRDPServer();
3848#endif
3849}
3850
3851
3852void ConsoleVRDPServer::SendUpdate(unsigned uScreenId, void *pvUpdate, uint32_t cbUpdate) const
3853{
3854 if (mpEntryPoints && mhServer)
3855 {
3856 mpEntryPoints->VRDEUpdate(mhServer, uScreenId, pvUpdate, cbUpdate);
3857 }
3858}
3859
3860void ConsoleVRDPServer::SendResize(void)
3861{
3862 if (mpEntryPoints && mhServer)
3863 {
3864 ++mcInResize;
3865 mpEntryPoints->VRDEResize(mhServer);
3866 --mcInResize;
3867 }
3868}
3869
3870void ConsoleVRDPServer::SendUpdateBitmap(unsigned uScreenId, uint32_t x, uint32_t y, uint32_t w, uint32_t h) const
3871{
3872 VRDEORDERHDR update;
3873 update.x = x;
3874 update.y = y;
3875 update.w = w;
3876 update.h = h;
3877 if (mpEntryPoints && mhServer)
3878 {
3879 mpEntryPoints->VRDEUpdate(mhServer, uScreenId, &update, sizeof(update));
3880 }
3881}
3882
3883void ConsoleVRDPServer::SendAudioSamples(void *pvSamples, uint32_t cSamples, VRDEAUDIOFORMAT format) const
3884{
3885 if (mpEntryPoints && mhServer)
3886 {
3887 mpEntryPoints->VRDEAudioSamples(mhServer, pvSamples, cSamples, format);
3888 }
3889}
3890
3891void ConsoleVRDPServer::SendAudioVolume(uint16_t left, uint16_t right) const
3892{
3893 if (mpEntryPoints && mhServer)
3894 {
3895 mpEntryPoints->VRDEAudioVolume(mhServer, left, right);
3896 }
3897}
3898
3899void ConsoleVRDPServer::SendUSBRequest(uint32_t u32ClientId, void *pvParms, uint32_t cbParms) const
3900{
3901 if (mpEntryPoints && mhServer)
3902 {
3903 mpEntryPoints->VRDEUSBRequest(mhServer, u32ClientId, pvParms, cbParms);
3904 }
3905}
3906
3907/* @todo rc not needed? */
3908int ConsoleVRDPServer::SendAudioInputBegin(void **ppvUserCtx,
3909 void *pvContext,
3910 uint32_t cSamples,
3911 uint32_t iSampleHz,
3912 uint32_t cChannels,
3913 uint32_t cBits)
3914{
3915 if (mpEntryPoints && mhServer && mpEntryPoints->VRDEAudioInOpen)
3916 {
3917 uint32_t u32ClientId = ASMAtomicReadU32(&mu32AudioInputClientId);
3918 if (u32ClientId != 0) /* 0 would mean broadcast to all clients. */
3919 {
3920 VRDEAUDIOFORMAT audioFormat = VRDE_AUDIO_FMT_MAKE(iSampleHz, cChannels, cBits, 0);
3921 mpEntryPoints->VRDEAudioInOpen (mhServer,
3922 pvContext,
3923 u32ClientId,
3924 audioFormat,
3925 cSamples);
3926#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
3927 //*ppvUserCtx = NULL;
3928#else
3929 *ppvUserCtx = NULL; /* This is the ConsoleVRDPServer context.
3930- * Currently not used because only one client is allowed to
3931- * do audio input and the client id is saved by the ConsoleVRDPServer.
3932- */
3933#endif
3934
3935 return VINF_SUCCESS;
3936 }
3937 }
3938 return VERR_NOT_SUPPORTED;
3939}
3940
3941void ConsoleVRDPServer::SendAudioInputEnd(void *pvUserCtx)
3942{
3943 if (mpEntryPoints && mhServer && mpEntryPoints->VRDEAudioInClose)
3944 {
3945 uint32_t u32ClientId = ASMAtomicReadU32(&mu32AudioInputClientId);
3946 if (u32ClientId != 0) /* 0 would mean broadcast to all clients. */
3947 {
3948 mpEntryPoints->VRDEAudioInClose(mhServer, u32ClientId);
3949 }
3950 }
3951}
3952
3953
3954void ConsoleVRDPServer::QueryInfo(uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut) const
3955{
3956 if (index == VRDE_QI_PORT)
3957 {
3958 uint32_t cbOut = sizeof(int32_t);
3959
3960 if (cbBuffer >= cbOut)
3961 {
3962 *pcbOut = cbOut;
3963 *(int32_t *)pvBuffer = (int32_t)mVRDPBindPort;
3964 }
3965 }
3966 else if (mpEntryPoints && mhServer)
3967 {
3968 mpEntryPoints->VRDEQueryInfo(mhServer, index, pvBuffer, cbBuffer, pcbOut);
3969 }
3970}
3971
3972/* static */ int ConsoleVRDPServer::loadVRDPLibrary(const char *pszLibraryName)
3973{
3974 int rc = VINF_SUCCESS;
3975
3976 if (mVRDPLibrary == NIL_RTLDRMOD)
3977 {
3978 RTERRINFOSTATIC ErrInfo;
3979 RTErrInfoInitStatic(&ErrInfo);
3980
3981 if (RTPathHavePath(pszLibraryName))
3982 rc = SUPR3HardenedLdrLoadPlugIn(pszLibraryName, &mVRDPLibrary, &ErrInfo.Core);
3983 else
3984 rc = SUPR3HardenedLdrLoadAppPriv(pszLibraryName, &mVRDPLibrary, RTLDRLOAD_FLAGS_LOCAL, &ErrInfo.Core);
3985 if (RT_SUCCESS(rc))
3986 {
3987 struct SymbolEntry
3988 {
3989 const char *name;
3990 void **ppfn;
3991 };
3992
3993 #define DEFSYMENTRY(a) { #a, (void**)&mpfn##a }
3994
3995 static const struct SymbolEntry s_aSymbols[] =
3996 {
3997 DEFSYMENTRY(VRDECreateServer)
3998 };
3999
4000 #undef DEFSYMENTRY
4001
4002 for (unsigned i = 0; i < RT_ELEMENTS(s_aSymbols); i++)
4003 {
4004 rc = RTLdrGetSymbol(mVRDPLibrary, s_aSymbols[i].name, s_aSymbols[i].ppfn);
4005
4006 if (RT_FAILURE(rc))
4007 {
4008 LogRel(("VRDE: Error resolving symbol '%s', rc %Rrc.\n", s_aSymbols[i].name, rc));
4009 break;
4010 }
4011 }
4012 }
4013 else
4014 {
4015 if (RTErrInfoIsSet(&ErrInfo.Core))
4016 LogRel(("VRDE: Error loading the library '%s': %s (%Rrc)\n", pszLibraryName, ErrInfo.Core.pszMsg, rc));
4017 else
4018 LogRel(("VRDE: Error loading the library '%s' rc = %Rrc.\n", pszLibraryName, rc));
4019
4020 mVRDPLibrary = NIL_RTLDRMOD;
4021 }
4022 }
4023
4024 if (RT_FAILURE(rc))
4025 {
4026 if (mVRDPLibrary != NIL_RTLDRMOD)
4027 {
4028 RTLdrClose(mVRDPLibrary);
4029 mVRDPLibrary = NIL_RTLDRMOD;
4030 }
4031 }
4032
4033 return rc;
4034}
4035
4036/*
4037 * IVRDEServerInfo implementation.
4038 */
4039// constructor / destructor
4040/////////////////////////////////////////////////////////////////////////////
4041
4042VRDEServerInfo::VRDEServerInfo()
4043 : mParent(NULL)
4044{
4045}
4046
4047VRDEServerInfo::~VRDEServerInfo()
4048{
4049}
4050
4051
4052HRESULT VRDEServerInfo::FinalConstruct()
4053{
4054 return BaseFinalConstruct();
4055}
4056
4057void VRDEServerInfo::FinalRelease()
4058{
4059 uninit();
4060 BaseFinalRelease();
4061}
4062
4063// public methods only for internal purposes
4064/////////////////////////////////////////////////////////////////////////////
4065
4066/**
4067 * Initializes the guest object.
4068 */
4069HRESULT VRDEServerInfo::init(Console *aParent)
4070{
4071 LogFlowThisFunc(("aParent=%p\n", aParent));
4072
4073 ComAssertRet(aParent, E_INVALIDARG);
4074
4075 /* Enclose the state transition NotReady->InInit->Ready */
4076 AutoInitSpan autoInitSpan(this);
4077 AssertReturn(autoInitSpan.isOk(), E_FAIL);
4078
4079 unconst(mParent) = aParent;
4080
4081 /* Confirm a successful initialization */
4082 autoInitSpan.setSucceeded();
4083
4084 return S_OK;
4085}
4086
4087/**
4088 * Uninitializes the instance and sets the ready flag to FALSE.
4089 * Called either from FinalRelease() or by the parent when it gets destroyed.
4090 */
4091void VRDEServerInfo::uninit()
4092{
4093 LogFlowThisFunc(("\n"));
4094
4095 /* Enclose the state transition Ready->InUninit->NotReady */
4096 AutoUninitSpan autoUninitSpan(this);
4097 if (autoUninitSpan.uninitDone())
4098 return;
4099
4100 unconst(mParent) = NULL;
4101}
4102
4103// IVRDEServerInfo properties
4104/////////////////////////////////////////////////////////////////////////////
4105
4106#define IMPL_GETTER_BOOL(_aType, _aName, _aIndex) \
4107 HRESULT VRDEServerInfo::get##_aName(_aType *a##_aName) \
4108 { \
4109 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
4110 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); \
4111 \
4112 uint32_t value; \
4113 uint32_t cbOut = 0; \
4114 \
4115 mParent->i_consoleVRDPServer()->QueryInfo \
4116 (_aIndex, &value, sizeof(value), &cbOut); \
4117 \
4118 *a##_aName = cbOut? !!value: FALSE; \
4119 \
4120 return S_OK; \
4121 } \
4122 extern void IMPL_GETTER_BOOL_DUMMY(void)
4123
4124#define IMPL_GETTER_SCALAR(_aType, _aName, _aIndex, _aValueMask) \
4125 HRESULT VRDEServerInfo::get##_aName(_aType *a##_aName) \
4126 { \
4127 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
4128 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); \
4129 \
4130 _aType value; \
4131 uint32_t cbOut = 0; \
4132 \
4133 mParent->i_consoleVRDPServer()->QueryInfo \
4134 (_aIndex, &value, sizeof(value), &cbOut); \
4135 \
4136 if (_aValueMask) value &= (_aValueMask); \
4137 *a##_aName = cbOut? value: 0; \
4138 \
4139 return S_OK; \
4140 } \
4141 extern void IMPL_GETTER_SCALAR_DUMMY(void)
4142
4143#define IMPL_GETTER_UTF8STR(_aType, _aName, _aIndex) \
4144 HRESULT VRDEServerInfo::get##_aName(_aType &a##_aName) \
4145 { \
4146 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
4147 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); \
4148 \
4149 uint32_t cbOut = 0; \
4150 \
4151 mParent->i_consoleVRDPServer()->QueryInfo \
4152 (_aIndex, NULL, 0, &cbOut); \
4153 \
4154 if (cbOut == 0) \
4155 { \
4156 a##_aName = Utf8Str::Empty; \
4157 return S_OK; \
4158 } \
4159 \
4160 char *pchBuffer = (char *)RTMemTmpAlloc(cbOut); \
4161 \
4162 if (!pchBuffer) \
4163 { \
4164 Log(("VRDEServerInfo::" \
4165 #_aName \
4166 ": Failed to allocate memory %d bytes\n", cbOut)); \
4167 return E_OUTOFMEMORY; \
4168 } \
4169 \
4170 mParent->i_consoleVRDPServer()->QueryInfo \
4171 (_aIndex, pchBuffer, cbOut, &cbOut); \
4172 \
4173 a##_aName = pchBuffer; \
4174 \
4175 RTMemTmpFree(pchBuffer); \
4176 \
4177 return S_OK; \
4178 } \
4179 extern void IMPL_GETTER_BSTR_DUMMY(void)
4180
4181IMPL_GETTER_BOOL (BOOL, Active, VRDE_QI_ACTIVE);
4182IMPL_GETTER_SCALAR (LONG, Port, VRDE_QI_PORT, 0);
4183IMPL_GETTER_SCALAR (ULONG, NumberOfClients, VRDE_QI_NUMBER_OF_CLIENTS, 0);
4184IMPL_GETTER_SCALAR (LONG64, BeginTime, VRDE_QI_BEGIN_TIME, 0);
4185IMPL_GETTER_SCALAR (LONG64, EndTime, VRDE_QI_END_TIME, 0);
4186IMPL_GETTER_SCALAR (LONG64, BytesSent, VRDE_QI_BYTES_SENT, INT64_MAX);
4187IMPL_GETTER_SCALAR (LONG64, BytesSentTotal, VRDE_QI_BYTES_SENT_TOTAL, INT64_MAX);
4188IMPL_GETTER_SCALAR (LONG64, BytesReceived, VRDE_QI_BYTES_RECEIVED, INT64_MAX);
4189IMPL_GETTER_SCALAR (LONG64, BytesReceivedTotal, VRDE_QI_BYTES_RECEIVED_TOTAL, INT64_MAX);
4190IMPL_GETTER_UTF8STR(Utf8Str, User, VRDE_QI_USER);
4191IMPL_GETTER_UTF8STR(Utf8Str, Domain, VRDE_QI_DOMAIN);
4192IMPL_GETTER_UTF8STR(Utf8Str, ClientName, VRDE_QI_CLIENT_NAME);
4193IMPL_GETTER_UTF8STR(Utf8Str, ClientIP, VRDE_QI_CLIENT_IP);
4194IMPL_GETTER_SCALAR (ULONG, ClientVersion, VRDE_QI_CLIENT_VERSION, 0);
4195IMPL_GETTER_SCALAR (ULONG, EncryptionStyle, VRDE_QI_ENCRYPTION_STYLE, 0);
4196
4197#undef IMPL_GETTER_UTF8STR
4198#undef IMPL_GETTER_SCALAR
4199#undef IMPL_GETTER_BOOL
4200/* vi: set tabstop=4 shiftwidth=4 expandtab: */
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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