DisplayImpl.cpp@ 78824

Last change on this file since 78824 was 78801, checked in by vboxsync, 6 years ago
API: add IGuestMonitorInfoChangedEvent. bugref:9472: API: let the GUI notice video mode hints from other sources. API users (mainly front-ends) can listen for this event to detect video mode hints/monitor changes, including those triggered by other API users.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 166.5 KB

Line
1	/* $Id: DisplayImpl.cpp 78801 2019-05-28 07:39:19Z vboxsync $ */
2	/** @file
3	* VirtualBox COM class implementation
4	*/
5
6	/*
7	* Copyright (C) 2006-2019 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#define LOG_GROUP LOG_GROUP_MAIN_DISPLAY
19	#include "LoggingNew.h"
20
21	#include "DisplayImpl.h"
22	#include "DisplayUtils.h"
23	#include "ConsoleImpl.h"
24	#include "ConsoleVRDPServer.h"
25	#include "GuestImpl.h"
26	#include "VMMDev.h"
27
28	#include "AutoCaller.h"
29
30	/* generated header */
31	#include "VBoxEvents.h"
32
33	#include <iprt/semaphore.h>
34	#include <iprt/thread.h>
35	#include <iprt/asm.h>
36	#include <iprt/time.h>
37	#include <iprt/cpp/utils.h>
38	#include <iprt/alloca.h>
39
40	#include <VBox/vmm/pdmdrv.h>
41	#if defined(DEBUG) \|\| defined(VBOX_STRICT) /* for VM_ASSERT_EMT(). */
42	# include <VBox/vmm/vm.h>
43	#endif
44
45	#ifdef VBOX_WITH_VIDEOHWACCEL
46	# include <VBoxVideo.h>
47	#endif
48
49	#if defined(VBOX_WITH_CROGL) \|\| defined(VBOX_WITH_CRHGSMI)
50	# include <VBox/HostServices/VBoxCrOpenGLSvc.h>
51	#endif
52
53	#include <VBox/com/array.h>
54
55	#ifdef VBOX_WITH_RECORDING
56	# include <iprt/path.h>
57	# include "Recording.h"
58
59	# ifdef VBOX_WITH_LIBVPX
60	# ifdef _MSC_VER
61	# pragma warning(push)
62	# pragma warning(disable: 4668) /* vpx_codec.h(64) : warning C4668: '__GNUC__' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif' */
63	# include <vpx/vpx_encoder.h>
64	# pragma warning(pop)
65	# else
66	# include <vpx/vpx_encoder.h>
67	# endif
68	# endif
69
70	# include <VBox/vmm/pdmapi.h>
71	# include <VBox/vmm/pdmaudioifs.h>
72	#endif
73
74	#ifdef VBOX_WITH_CROGL
75	typedef enum
76	{
77	CRVREC_STATE_IDLE,
78	CRVREC_STATE_SUBMITTED
79	} CRVREC_STATE;
80	#endif
81
82	/**
83	* Display driver instance data.
84	*
85	* @implements PDMIDISPLAYCONNECTOR
86	*/
87	typedef struct DRVMAINDISPLAY
88	{
89	/** Pointer to the display object. */
90	Display *pDisplay;
91	/** Pointer to the driver instance structure. */
92	PPDMDRVINS pDrvIns;
93	/** Pointer to the keyboard port interface of the driver/device above us. */
94	PPDMIDISPLAYPORT pUpPort;
95	/** Our display connector interface. */
96	PDMIDISPLAYCONNECTOR IConnector;
97	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
98	/** VBVA callbacks */
99	PPDMIDISPLAYVBVACALLBACKS pVBVACallbacks;
100	#endif
101	} DRVMAINDISPLAY, *PDRVMAINDISPLAY;
102
103	/** Converts PDMIDISPLAYCONNECTOR pointer to a DRVMAINDISPLAY pointer. */
104	#define PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface) RT_FROM_MEMBER(pInterface, DRVMAINDISPLAY, IConnector)
105
106	// constructor / destructor
107	/////////////////////////////////////////////////////////////////////////////
108
109	Display::Display()
110	: mParent(NULL), mfIsCr3DEnabled(false)
111	{
112	}
113
114	Display::~Display()
115	{
116	}
117
118
119	HRESULT Display::FinalConstruct()
120	{
121	int rc = videoAccelConstruct(&mVideoAccelLegacy);
122	AssertRC(rc);
123
124	mfVideoAccelVRDP = false;
125	mfu32SupportedOrders = 0;
126	mcVRDPRefs = 0;
127
128	mfSeamlessEnabled = false;
129	mpRectVisibleRegion = NULL;
130	mcRectVisibleRegion = 0;
131
132	#ifdef VBOX_WITH_CROGL
133	mfCrOglDataHidden = false;
134	#endif
135
136	mpDrv = NULL;
137
138	rc = RTCritSectInit(&mVideoAccelLock);
139	AssertRC(rc);
140
141	#ifdef VBOX_WITH_HGSMI
142	mu32UpdateVBVAFlags = 0;
143	mfVMMDevSupportsGraphics = false;
144	mfGuestVBVACapabilities = 0;
145	mfHostCursorCapabilities = 0;
146	#endif
147
148	#ifdef VBOX_WITH_RECORDING
149	rc = RTCritSectInit(&mVideoRecLock);
150	AssertRC(rc);
151
152	for (unsigned i = 0; i < RT_ELEMENTS(maRecordingEnabled); i++)
153	maRecordingEnabled[i] = true;
154	#endif
155
156	#ifdef VBOX_WITH_CRHGSMI
157	mhCrOglSvc = NULL;
158	rc = RTCritSectRwInit(&mCrOglLock);
159	AssertRC(rc);
160	#endif
161
162	#ifdef VBOX_WITH_CROGL
163	RT_ZERO(mCrOglCallbacks);
164	RT_ZERO(mCrOglScreenshotData);
165	mfCrOglVideoRecState = CRVREC_STATE_IDLE;
166	mCrOglScreenshotData.u32Screen = CRSCREEN_ALL;
167	mCrOglScreenshotData.pvContext = this;
168	mCrOglScreenshotData.pfnScreenshotBegin = i_displayCrVRecScreenshotBegin;
169	mCrOglScreenshotData.pfnScreenshotPerform = i_displayCrVRecScreenshotPerform;
170	mCrOglScreenshotData.pfnScreenshotEnd = i_displayCrVRecScreenshotEnd;
171	#endif
172
173	return BaseFinalConstruct();
174	}
175
176	void Display::FinalRelease()
177	{
178	uninit();
179
180	#ifdef VBOX_WITH_RECORDING
181	if (RTCritSectIsInitialized(&mVideoRecLock))
182	{
183	RTCritSectDelete(&mVideoRecLock);
184	RT_ZERO(mVideoRecLock);
185	}
186	#endif
187
188	videoAccelDestroy(&mVideoAccelLegacy);
189	i_saveVisibleRegion(0, NULL);
190
191	if (RTCritSectIsInitialized(&mVideoAccelLock))
192	{
193	RTCritSectDelete(&mVideoAccelLock);
194	RT_ZERO(mVideoAccelLock);
195	}
196
197	#ifdef VBOX_WITH_CRHGSMI
198	if (RTCritSectRwIsInitialized(&mCrOglLock))
199	{
200	RTCritSectRwDelete(&mCrOglLock);
201	RT_ZERO(mCrOglLock);
202	}
203	#endif
204	BaseFinalRelease();
205	}
206
207	// public initializer/uninitializer for internal purposes only
208	/////////////////////////////////////////////////////////////////////////////
209
210	#define kMaxSizeThumbnail 64
211
212	/**
213	* Save thumbnail and screenshot of the guest screen.
214	*/
215	static int displayMakeThumbnail(uint8_t *pbData, uint32_t cx, uint32_t cy,
216	uint8_t *ppu8Thumbnail, uint32_t pcbThumbnail, uint32_t pcxThumbnail, uint32_t pcyThumbnail)
217	{
218	int rc = VINF_SUCCESS;
219
220	uint8_t *pu8Thumbnail = NULL;
221	uint32_t cbThumbnail = 0;
222	uint32_t cxThumbnail = 0;
223	uint32_t cyThumbnail = 0;
224
225	if (cx > cy)
226	{
227	cxThumbnail = kMaxSizeThumbnail;
228	cyThumbnail = (kMaxSizeThumbnail * cy) / cx;
229	}
230	else
231	{
232	cyThumbnail = kMaxSizeThumbnail;
233	cxThumbnail = (kMaxSizeThumbnail * cx) / cy;
234	}
235
236	LogRelFlowFunc(("%dx%d -> %dx%d\n", cx, cy, cxThumbnail, cyThumbnail));
237
238	cbThumbnail = cxThumbnail * 4 * cyThumbnail;
239	pu8Thumbnail = (uint8_t *)RTMemAlloc(cbThumbnail);
240
241	if (pu8Thumbnail)
242	{
243	uint8_t *dst = pu8Thumbnail;
244	uint8_t *src = pbData;
245	int dstW = cxThumbnail;
246	int dstH = cyThumbnail;
247	int srcW = cx;
248	int srcH = cy;
249	int iDeltaLine = cx * 4;
250
251	BitmapScale32(dst,
252	dstW, dstH,
253	src,
254	iDeltaLine,
255	srcW, srcH);
256
257	*ppu8Thumbnail = pu8Thumbnail;
258	*pcbThumbnail = cbThumbnail;
259	*pcxThumbnail = cxThumbnail;
260	*pcyThumbnail = cyThumbnail;
261	}
262	else
263	{
264	rc = VERR_NO_MEMORY;
265	}
266
267	return rc;
268	}
269
270	#ifdef VBOX_WITH_CROGL
271	typedef struct
272	{
273	CRVBOXHGCMTAKESCREENSHOT Base;
274
275	/* 32bpp small RGB image. */
276	uint8_t *pu8Thumbnail;
277	uint32_t cbThumbnail;
278	uint32_t cxThumbnail;
279	uint32_t cyThumbnail;
280
281	/* PNG screenshot. */
282	uint8_t *pu8PNG;
283	uint32_t cbPNG;
284	uint32_t cxPNG;
285	uint32_t cyPNG;
286	} VBOX_DISPLAY_SAVESCREENSHOT_DATA;
287
288	static DECLCALLBACK(void) displaySaveScreenshotReport(void *pvCtx, uint32_t uScreen,
289	uint32_t x, uint32_t y, uint32_t uBitsPerPixel,
290	uint32_t uBytesPerLine, uint32_t uGuestWidth, uint32_t uGuestHeight,
291	uint8_t *pu8BufferAddress, uint64_t u64Timestamp)
292	{
293	RT_NOREF(uScreen, x, y, uBitsPerPixel,uBytesPerLine, u64Timestamp);
294	VBOX_DISPLAY_SAVESCREENSHOT_DATA pData = (VBOX_DISPLAY_SAVESCREENSHOT_DATA)pvCtx;
295	displayMakeThumbnail(pu8BufferAddress, uGuestWidth, uGuestHeight, &pData->pu8Thumbnail,
296	&pData->cbThumbnail, &pData->cxThumbnail, &pData->cyThumbnail);
297	int rc = DisplayMakePNG(pu8BufferAddress, uGuestWidth, uGuestHeight, &pData->pu8PNG,
298	&pData->cbPNG, &pData->cxPNG, &pData->cyPNG, 1);
299	if (RT_FAILURE(rc))
300	{
301	AssertMsgFailed(("DisplayMakePNG failed (rc=%Rrc)\n", rc));
302	if (pData->pu8PNG)
303	{
304	RTMemFree(pData->pu8PNG);
305	pData->pu8PNG = NULL;
306	}
307	pData->cbPNG = 0;
308	pData->cxPNG = 0;
309	pData->cyPNG = 0;
310	}
311	}
312	#endif
313
314	DECLCALLBACK(void) Display::i_displaySSMSaveScreenshot(PSSMHANDLE pSSM, void *pvUser)
315	{
316	Display that = static_cast<Display>(pvUser);
317
318	/* 32bpp small RGB image. */
319	uint8_t *pu8Thumbnail = NULL;
320	uint32_t cbThumbnail = 0;
321	uint32_t cxThumbnail = 0;
322	uint32_t cyThumbnail = 0;
323
324	/* PNG screenshot. */
325	uint8_t *pu8PNG = NULL;
326	uint32_t cbPNG = 0;
327	uint32_t cxPNG = 0;
328	uint32_t cyPNG = 0;
329
330	Console::SafeVMPtr ptrVM(that->mParent);
331	if (ptrVM.isOk())
332	{
333	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
334	BOOL f3DSnapshot = FALSE;
335	if ( that->mfIsCr3DEnabled
336	&& that->mCrOglCallbacks.pfnHasData
337	&& that->mCrOglCallbacks.pfnHasData())
338	{
339	VMMDev *pVMMDev = that->mParent->i_getVMMDev();
340	if (pVMMDev)
341	{
342	VBOX_DISPLAY_SAVESCREENSHOT_DATA *pScreenshot;
343	pScreenshot = (VBOX_DISPLAY_SAVESCREENSHOT_DATA)RTMemAllocZ(sizeof(pScreenshot));
344	if (pScreenshot)
345	{
346	/* screen id or CRSCREEN_ALL to specify all enabled */
347	pScreenshot->Base.u32Screen = 0;
348	pScreenshot->Base.u32Width = 0;
349	pScreenshot->Base.u32Height = 0;
350	pScreenshot->Base.u32Pitch = 0;
351	pScreenshot->Base.pvBuffer = NULL;
352	pScreenshot->Base.pvContext = pScreenshot;
353	pScreenshot->Base.pfnScreenshotBegin = NULL;
354	pScreenshot->Base.pfnScreenshotPerform = displaySaveScreenshotReport;
355	pScreenshot->Base.pfnScreenshotEnd = NULL;
356
357	VBOXCRCMDCTL_HGCM data;
358	data.Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
359	data.Hdr.u32Function = SHCRGL_HOST_FN_TAKE_SCREENSHOT;
360
361	data.aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
362	data.aParms[0].u.pointer.addr = &pScreenshot->Base;
363	data.aParms[0].u.pointer.size = sizeof(pScreenshot->Base);
364
365	int rc = that->i_crCtlSubmitSync(&data.Hdr, sizeof(data));
366	if (RT_SUCCESS(rc))
367	{
368	if (pScreenshot->pu8PNG)
369	{
370	pu8Thumbnail = pScreenshot->pu8Thumbnail;
371	cbThumbnail = pScreenshot->cbThumbnail;
372	cxThumbnail = pScreenshot->cxThumbnail;
373	cyThumbnail = pScreenshot->cyThumbnail;
374
375	/* PNG screenshot. */
376	pu8PNG = pScreenshot->pu8PNG;
377	cbPNG = pScreenshot->cbPNG;
378	cxPNG = pScreenshot->cxPNG;
379	cyPNG = pScreenshot->cyPNG;
380	f3DSnapshot = TRUE;
381	}
382	else
383	AssertMsgFailed(("no png\n"));
384	}
385	else
386	AssertMsgFailed(("SHCRGL_HOST_FN_TAKE_SCREENSHOT failed (rc=%Rrc)\n", rc));
387
388
389	RTMemFree(pScreenshot);
390	}
391	}
392	}
393
394	if (!f3DSnapshot)
395	#endif
396	{
397	/* Query RGB bitmap. */
398	/* SSM code is executed on EMT(0), therefore no need to use VMR3ReqCallWait. */
399	uint8_t *pbData = NULL;
400	size_t cbData = 0;
401	uint32_t cx = 0;
402	uint32_t cy = 0;
403	bool fFreeMem = false;
404	int rc = Display::i_displayTakeScreenshotEMT(that, VBOX_VIDEO_PRIMARY_SCREEN, &pbData, &cbData, &cx, &cy, &fFreeMem);
405
406	/*
407	* It is possible that success is returned but everything is 0 or NULL.
408	* (no display attached if a VM is running with VBoxHeadless on OSE for example)
409	*/
410	if (RT_SUCCESS(rc) && pbData)
411	{
412	Assert(cx && cy);
413
414	/* Prepare a small thumbnail and a PNG screenshot. */
415	displayMakeThumbnail(pbData, cx, cy, &pu8Thumbnail, &cbThumbnail, &cxThumbnail, &cyThumbnail);
416	rc = DisplayMakePNG(pbData, cx, cy, &pu8PNG, &cbPNG, &cxPNG, &cyPNG, 1);
417	if (RT_FAILURE(rc))
418	{
419	if (pu8PNG)
420	{
421	RTMemFree(pu8PNG);
422	pu8PNG = NULL;
423	}
424	cbPNG = 0;
425	cxPNG = 0;
426	cyPNG = 0;
427	}
428
429	if (fFreeMem)
430	RTMemFree(pbData);
431	else
432	that->mpDrv->pUpPort->pfnFreeScreenshot(that->mpDrv->pUpPort, pbData);
433	}
434	}
435	}
436	else
437	{
438	LogFunc(("Failed to get VM pointer 0x%x\n", ptrVM.rc()));
439	}
440
441	/* Regardless of rc, save what is available:
442	* Data format:
443	* uint32_t cBlocks;
444	* [blocks]
445	*
446	* Each block is:
447	* uint32_t cbBlock; if 0 - no 'block data'.
448	* uint32_t typeOfBlock; 0 - 32bpp RGB bitmap, 1 - PNG, ignored if 'cbBlock' is 0.
449	* [block data]
450	*
451	* Block data for bitmap and PNG:
452	* uint32_t cx;
453	* uint32_t cy;
454	* [image data]
455	*/
456	SSMR3PutU32(pSSM, 2); /* Write thumbnail and PNG screenshot. */
457
458	/* First block. */
459	SSMR3PutU32(pSSM, (uint32_t)(cbThumbnail + 2 * sizeof(uint32_t)));
460	SSMR3PutU32(pSSM, 0); /* Block type: thumbnail. */
461
462	if (cbThumbnail)
463	{
464	SSMR3PutU32(pSSM, cxThumbnail);
465	SSMR3PutU32(pSSM, cyThumbnail);
466	SSMR3PutMem(pSSM, pu8Thumbnail, cbThumbnail);
467	}
468
469	/* Second block. */
470	SSMR3PutU32(pSSM, (uint32_t)(cbPNG + 2 * sizeof(uint32_t)));
471	SSMR3PutU32(pSSM, 1); /* Block type: png. */
472
473	if (cbPNG)
474	{
475	SSMR3PutU32(pSSM, cxPNG);
476	SSMR3PutU32(pSSM, cyPNG);
477	SSMR3PutMem(pSSM, pu8PNG, cbPNG);
478	}
479
480	RTMemFree(pu8PNG);
481	RTMemFree(pu8Thumbnail);
482	}
483
484	DECLCALLBACK(int)
485	Display::i_displaySSMLoadScreenshot(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass)
486	{
487	RT_NOREF(pvUser);
488	if (uVersion != sSSMDisplayScreenshotVer)
489	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
490	Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
491
492	/* Skip data. */
493	uint32_t cBlocks;
494	int rc = SSMR3GetU32(pSSM, &cBlocks);
495	AssertRCReturn(rc, rc);
496
497	for (uint32_t i = 0; i < cBlocks; i++)
498	{
499	uint32_t cbBlock;
500	rc = SSMR3GetU32(pSSM, &cbBlock);
501	AssertRCBreak(rc);
502
503	uint32_t typeOfBlock;
504	rc = SSMR3GetU32(pSSM, &typeOfBlock);
505	AssertRCBreak(rc);
506
507	LogRelFlowFunc(("[%d] type %d, size %d bytes\n", i, typeOfBlock, cbBlock));
508
509	/* Note: displaySSMSaveScreenshot writes size of a block = 8 and
510	* do not write any data if the image size was 0.
511	* @todo Fix and increase saved state version.
512	*/
513	if (cbBlock > 2 * sizeof(uint32_t))
514	{
515	rc = SSMR3Skip(pSSM, cbBlock);
516	AssertRCBreak(rc);
517	}
518	}
519
520	return rc;
521	}
522
523	/**
524	* Save/Load some important guest state
525	*/
526	DECLCALLBACK(void)
527	Display::i_displaySSMSave(PSSMHANDLE pSSM, void *pvUser)
528	{
529	Display that = static_cast<Display>(pvUser);
530
531	SSMR3PutU32(pSSM, that->mcMonitors);
532	for (unsigned i = 0; i < that->mcMonitors; i++)
533	{
534	SSMR3PutU32(pSSM, that->maFramebuffers[i].u32Offset);
535	SSMR3PutU32(pSSM, that->maFramebuffers[i].u32MaxFramebufferSize);
536	SSMR3PutU32(pSSM, that->maFramebuffers[i].u32InformationSize);
537	SSMR3PutU32(pSSM, that->maFramebuffers[i].w);
538	SSMR3PutU32(pSSM, that->maFramebuffers[i].h);
539	SSMR3PutS32(pSSM, that->maFramebuffers[i].xOrigin);
540	SSMR3PutS32(pSSM, that->maFramebuffers[i].yOrigin);
541	SSMR3PutU32(pSSM, that->maFramebuffers[i].flags);
542	}
543	SSMR3PutS32(pSSM, that->xInputMappingOrigin);
544	SSMR3PutS32(pSSM, that->yInputMappingOrigin);
545	SSMR3PutU32(pSSM, that->cxInputMapping);
546	SSMR3PutU32(pSSM, that->cyInputMapping);
547	SSMR3PutU32(pSSM, that->mfGuestVBVACapabilities);
548	SSMR3PutU32(pSSM, that->mfHostCursorCapabilities);
549	}
550
551	DECLCALLBACK(int)
552	Display::i_displaySSMLoad(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass)
553	{
554	Display that = static_cast<Display>(pvUser);
555
556	if ( uVersion != sSSMDisplayVer
557	&& uVersion != sSSMDisplayVer2
558	&& uVersion != sSSMDisplayVer3
559	&& uVersion != sSSMDisplayVer4
560	&& uVersion != sSSMDisplayVer5)
561	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
562	Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
563
564	uint32_t cMonitors;
565	int rc = SSMR3GetU32(pSSM, &cMonitors);
566	AssertRCReturn(rc, rc);
567	if (cMonitors != that->mcMonitors)
568	return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Number of monitors changed (%d->%d)!"), cMonitors, that->mcMonitors);
569
570	for (uint32_t i = 0; i < cMonitors; i++)
571	{
572	SSMR3GetU32(pSSM, &that->maFramebuffers[i].u32Offset);
573	SSMR3GetU32(pSSM, &that->maFramebuffers[i].u32MaxFramebufferSize);
574	SSMR3GetU32(pSSM, &that->maFramebuffers[i].u32InformationSize);
575	if ( uVersion == sSSMDisplayVer2
576	\|\| uVersion == sSSMDisplayVer3
577	\|\| uVersion == sSSMDisplayVer4
578	\|\| uVersion == sSSMDisplayVer5)
579	{
580	uint32_t w;
581	uint32_t h;
582	SSMR3GetU32(pSSM, &w);
583	SSMR3GetU32(pSSM, &h);
584	that->maFramebuffers[i].w = w;
585	that->maFramebuffers[i].h = h;
586	}
587	if ( uVersion == sSSMDisplayVer3
588	\|\| uVersion == sSSMDisplayVer4
589	\|\| uVersion == sSSMDisplayVer5)
590	{
591	int32_t xOrigin;
592	int32_t yOrigin;
593	uint32_t flags;
594	SSMR3GetS32(pSSM, &xOrigin);
595	SSMR3GetS32(pSSM, &yOrigin);
596	SSMR3GetU32(pSSM, &flags);
597	that->maFramebuffers[i].xOrigin = xOrigin;
598	that->maFramebuffers[i].yOrigin = yOrigin;
599	that->maFramebuffers[i].flags = (uint16_t)flags;
600	that->maFramebuffers[i].fDisabled = (that->maFramebuffers[i].flags & VBVA_SCREEN_F_DISABLED) != 0;
601	}
602	}
603	if ( uVersion == sSSMDisplayVer4
604	\|\| uVersion == sSSMDisplayVer5)
605	{
606	SSMR3GetS32(pSSM, &that->xInputMappingOrigin);
607	SSMR3GetS32(pSSM, &that->yInputMappingOrigin);
608	SSMR3GetU32(pSSM, &that->cxInputMapping);
609	SSMR3GetU32(pSSM, &that->cyInputMapping);
610	}
611	if (uVersion == sSSMDisplayVer5)
612	{
613	SSMR3GetU32(pSSM, &that->mfGuestVBVACapabilities);
614	SSMR3GetU32(pSSM, &that->mfHostCursorCapabilities);
615	}
616
617	return VINF_SUCCESS;
618	}
619
620	/**
621	* Initializes the display object.
622	*
623	* @returns COM result indicator
624	* @param aParent handle of our parent object
625	*/
626	HRESULT Display::init(Console *aParent)
627	{
628	ComAssertRet(aParent, E_INVALIDARG);
629	/* Enclose the state transition NotReady->InInit->Ready */
630	AutoInitSpan autoInitSpan(this);
631	AssertReturn(autoInitSpan.isOk(), E_FAIL);
632
633	unconst(mParent) = aParent;
634
635	mfSourceBitmapEnabled = true;
636	fVGAResizing = false;
637
638	ULONG ul;
639	mParent->i_machine()->COMGETTER(MonitorCount)(&ul);
640	mcMonitors = ul;
641	xInputMappingOrigin = 0;
642	yInputMappingOrigin = 0;
643	cxInputMapping = 0;
644	cyInputMapping = 0;
645
646	for (ul = 0; ul < mcMonitors; ul++)
647	{
648	maFramebuffers[ul].u32Offset = 0;
649	maFramebuffers[ul].u32MaxFramebufferSize = 0;
650	maFramebuffers[ul].u32InformationSize = 0;
651
652	maFramebuffers[ul].pFramebuffer = NULL;
653	/* All secondary monitors are disabled at startup. */
654	maFramebuffers[ul].fDisabled = ul > 0;
655
656	maFramebuffers[ul].u32Caps = 0;
657
658	maFramebuffers[ul].updateImage.pu8Address = NULL;
659	maFramebuffers[ul].updateImage.cbLine = 0;
660
661	maFramebuffers[ul].xOrigin = 0;
662	maFramebuffers[ul].yOrigin = 0;
663
664	maFramebuffers[ul].w = 0;
665	maFramebuffers[ul].h = 0;
666
667	maFramebuffers[ul].flags = maFramebuffers[ul].fDisabled? VBVA_SCREEN_F_DISABLED: 0;
668
669	maFramebuffers[ul].u16BitsPerPixel = 0;
670	maFramebuffers[ul].pu8FramebufferVRAM = NULL;
671	maFramebuffers[ul].u32LineSize = 0;
672
673	maFramebuffers[ul].pHostEvents = NULL;
674
675	maFramebuffers[ul].fDefaultFormat = false;
676
677	#ifdef VBOX_WITH_HGSMI
678	maFramebuffers[ul].fVBVAEnabled = false;
679	maFramebuffers[ul].fVBVAForceResize = false;
680	maFramebuffers[ul].fRenderThreadMode = false;
681	maFramebuffers[ul].pVBVAHostFlags = NULL;
682	#endif /* VBOX_WITH_HGSMI */
683	#ifdef VBOX_WITH_CROGL
684	RT_ZERO(maFramebuffers[ul].pendingViewportInfo);
685	#endif
686	}
687
688	{
689	// register listener for state change events
690	ComPtr<IEventSource> es;
691	mParent->COMGETTER(EventSource)(es.asOutParam());
692	com::SafeArray<VBoxEventType_T> eventTypes;
693	eventTypes.push_back(VBoxEventType_OnStateChanged);
694	es->RegisterListener(this, ComSafeArrayAsInParam(eventTypes), true);
695	}
696
697	/* Cache the 3D settings. */
698	BOOL fIs3DEnabled = FALSE;
699	mParent->i_machine()->COMGETTER(Accelerate3DEnabled)(&fIs3DEnabled);
700	GraphicsControllerType_T enmGpuType = GraphicsControllerType_VBoxVGA;
701	mParent->i_machine()->COMGETTER(GraphicsControllerType)(&enmGpuType);
702	mfIsCr3DEnabled = fIs3DEnabled && enmGpuType == GraphicsControllerType_VBoxVGA;
703
704	/* Confirm a successful initialization */
705	autoInitSpan.setSucceeded();
706
707	return S_OK;
708	}
709
710	/**
711	* Uninitializes the instance and sets the ready flag to FALSE.
712	* Called either from FinalRelease() or by the parent when it gets destroyed.
713	*/
714	void Display::uninit()
715	{
716	LogRelFlowFunc(("this=%p\n", this));
717
718	/* Enclose the state transition Ready->InUninit->NotReady */
719	AutoUninitSpan autoUninitSpan(this);
720	if (autoUninitSpan.uninitDone())
721	return;
722
723	unsigned uScreenId;
724	for (uScreenId = 0; uScreenId < mcMonitors; uScreenId++)
725	{
726	maFramebuffers[uScreenId].pSourceBitmap.setNull();
727	maFramebuffers[uScreenId].updateImage.pSourceBitmap.setNull();
728	maFramebuffers[uScreenId].updateImage.pu8Address = NULL;
729	maFramebuffers[uScreenId].updateImage.cbLine = 0;
730	maFramebuffers[uScreenId].pFramebuffer.setNull();
731	#ifdef VBOX_WITH_RECORDING
732	maFramebuffers[uScreenId].Recording.pSourceBitmap.setNull();
733	#endif
734	}
735
736	if (mParent)
737	{
738	ComPtr<IEventSource> es;
739	mParent->COMGETTER(EventSource)(es.asOutParam());
740	es->UnregisterListener(this);
741	}
742
743	unconst(mParent) = NULL;
744
745	if (mpDrv)
746	mpDrv->pDisplay = NULL;
747
748	mpDrv = NULL;
749	}
750
751	/**
752	* Register the SSM methods. Called by the power up thread to be able to
753	* pass pVM
754	*/
755	int Display::i_registerSSM(PUVM pUVM)
756	{
757	/* Version 2 adds width and height of the framebuffer; version 3 adds
758	* the framebuffer offset in the virtual desktop and the framebuffer flags;
759	* version 4 adds guest to host input event mapping and version 5 adds
760	* guest VBVA and host cursor capabilities.
761	*/
762	int rc = SSMR3RegisterExternal(pUVM, "DisplayData", 0, sSSMDisplayVer5,
763	mcMonitors * sizeof(uint32_t) * 8 + sizeof(uint32_t),
764	NULL, NULL, NULL,
765	NULL, i_displaySSMSave, NULL,
766	NULL, i_displaySSMLoad, NULL, this);
767	AssertRCReturn(rc, rc);
768
769	/*
770	* Register loaders for old saved states where iInstance was
771	* 3 * sizeof(uint32_t *) due to a code mistake.
772	*/
773	rc = SSMR3RegisterExternal(pUVM, "DisplayData", 12 /uInstance/, sSSMDisplayVer, 0 /cbGuess/,
774	NULL, NULL, NULL,
775	NULL, NULL, NULL,
776	NULL, i_displaySSMLoad, NULL, this);
777	AssertRCReturn(rc, rc);
778
779	rc = SSMR3RegisterExternal(pUVM, "DisplayData", 24 /uInstance/, sSSMDisplayVer, 0 /cbGuess/,
780	NULL, NULL, NULL,
781	NULL, NULL, NULL,
782	NULL, i_displaySSMLoad, NULL, this);
783	AssertRCReturn(rc, rc);
784
785	/* uInstance is an arbitrary value greater than 1024. Such a value will ensure a quick seek in saved state file. */
786	rc = SSMR3RegisterExternal(pUVM, "DisplayScreenshot", 1100 /uInstance/, sSSMDisplayScreenshotVer, 0 /cbGuess/,
787	NULL, NULL, NULL,
788	NULL, i_displaySSMSaveScreenshot, NULL,
789	NULL, i_displaySSMLoadScreenshot, NULL, this);
790
791	AssertRCReturn(rc, rc);
792
793	return VINF_SUCCESS;
794	}
795
796	DECLCALLBACK(void) Display::i_displayCrCmdFree(struct VBOXCRCMDCTL pCmd, uint32_t cbCmd, int rc, void pvCompletion)
797	{
798	RT_NOREF(pCmd, cbCmd, rc);
799	Assert(pvCompletion);
800	RTMemFree((void *)pvCompletion);
801	}
802
803	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
804	int Display::i_crOglWindowsShow(bool fShow)
805	{
806	if (!mfCrOglDataHidden == !!fShow)
807	return VINF_SUCCESS;
808
809	if (!mhCrOglSvc)
810	{
811	/* No 3D or the VMSVGA3d kind. */
812	Assert(!mfIsCr3DEnabled);
813	return VERR_INVALID_STATE;
814	}
815
816	VMMDev *pVMMDev = mParent->i_getVMMDev();
817	if (!pVMMDev)
818	{
819	AssertMsgFailed(("no vmmdev\n"));
820	return VERR_INVALID_STATE;
821	}
822
823	VBOXCRCMDCTL_HGCM pData = (VBOXCRCMDCTL_HGCM)RTMemAlloc(sizeof(VBOXCRCMDCTL_HGCM));
824	if (!pData)
825	{
826	AssertMsgFailed(("RTMemAlloc failed\n"));
827	return VERR_NO_MEMORY;
828	}
829
830	pData->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
831	pData->Hdr.u32Function = SHCRGL_HOST_FN_WINDOWS_SHOW;
832
833	pData->aParms[0].type = VBOX_HGCM_SVC_PARM_32BIT;
834	pData->aParms[0].u.uint32 = (uint32_t)fShow;
835
836	int rc = i_crCtlSubmit(&pData->Hdr, sizeof(*pData), i_displayCrCmdFree, pData);
837	if (RT_SUCCESS(rc))
838	mfCrOglDataHidden = !fShow;
839	else
840	{
841	AssertMsgFailed(("crCtlSubmit failed (rc=%Rrc)\n", rc));
842	RTMemFree(pData);
843	}
844
845	return rc;
846	}
847	#endif
848
849
850	// public methods only for internal purposes
851	/////////////////////////////////////////////////////////////////////////////
852
853	int Display::i_notifyCroglResize(PCVBVAINFOVIEW pView, PCVBVAINFOSCREEN pScreen, void *pvVRAM)
854	{
855	RT_NOREF(pView);
856	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
857	if (maFramebuffers[pScreen->u32ViewIndex].fRenderThreadMode)
858	return VINF_SUCCESS; /* nop it */
859
860	if (mfIsCr3DEnabled)
861	{
862	int rc = VERR_INVALID_STATE;
863	if (mhCrOglSvc)
864	{
865	VMMDev *pVMMDev = mParent->i_getVMMDev();
866	if (pVMMDev)
867	{
868	VBOXCRCMDCTL_HGCM *pCtl;
869	pCtl = (VBOXCRCMDCTL_HGCM*)RTMemAlloc(sizeof(CRVBOXHGCMDEVRESIZE) + sizeof(VBOXCRCMDCTL_HGCM));
870	if (pCtl)
871	{
872	CRVBOXHGCMDEVRESIZE pData = (CRVBOXHGCMDEVRESIZE)(pCtl+1);
873	pData->Screen = *pScreen;
874	pData->pvVRAM = pvVRAM;
875
876	pCtl->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
877	pCtl->Hdr.u32Function = SHCRGL_HOST_FN_DEV_RESIZE;
878	pCtl->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
879	pCtl->aParms[0].u.pointer.addr = pData;
880	pCtl->aParms[0].u.pointer.size = sizeof(*pData);
881
882	rc = i_crCtlSubmit(&pCtl->Hdr, sizeof(*pCtl), i_displayCrCmdFree, pCtl);
883	if (RT_FAILURE(rc))
884	{
885	AssertMsgFailed(("crCtlSubmit failed (rc=%Rrc)\n", rc));
886	RTMemFree(pCtl);
887	}
888	}
889	else
890	rc = VERR_NO_MEMORY;
891	}
892	}
893
894	return rc;
895	}
896	#else /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
897	RT_NOREF(pScreen, pvVRAM);
898	#endif
899	return VINF_SUCCESS;
900	}
901
902	/**
903	* Handles display resize event.
904	*
905	* @param uScreenId Screen ID
906	* @param bpp New bits per pixel.
907	* @param pvVRAM VRAM pointer.
908	* @param cbLine New bytes per line.
909	* @param w New display width.
910	* @param h New display height.
911	* @param flags Flags of the new video mode.
912	* @param xOrigin New display origin X.
913	* @param yOrigin New display origin Y.
914	* @param fVGAResize Whether the resize is originated from the VGA device (DevVGA).
915	*/
916	int Display::i_handleDisplayResize(unsigned uScreenId, uint32_t bpp, void *pvVRAM,
917	uint32_t cbLine, uint32_t w, uint32_t h, uint16_t flags,
918	int32_t xOrigin, int32_t yOrigin, bool fVGAResize)
919	{
920	LogRel2(("Display::i_handleDisplayResize: uScreenId=%d pvVRAM=%p w=%d h=%d bpp=%d cbLine=0x%X flags=0x%X\n", uScreenId,
921	pvVRAM, w, h, bpp, cbLine, flags));
922
923	/* Caller must not hold the object lock. */
924	AssertReturn(!isWriteLockOnCurrentThread(), VERR_INVALID_STATE);
925
926	/* Note: the old code checked if the video mode was actially chnaged and
927	* did not invalidate the source bitmap if the mode did not change.
928	* The new code always invalidates the source bitmap, i.e. it will
929	* notify the frontend even if nothing actually changed.
930	*
931	* Implementing the filtering is possible but might lead to pfnSetRenderVRAM races
932	* between this method and QuerySourceBitmap. Such races can be avoided by implementing
933	* the @todo below.
934	*/
935
936	/* Make sure that the VGA device does not access the source bitmap. */
937	if (uScreenId == VBOX_VIDEO_PRIMARY_SCREEN && mpDrv)
938	{
939	/// @todo It is probably more convenient to implement
940	// mpDrv->pUpPort->pfnSetOutputBitmap(pvVRAM, cbScanline, cBits, cx, cy, bool fSet);
941	// and remove IConnector.pbData, cbScanline, cBits, cx, cy.
942	// fSet = false disables rendering and VGA can check
943	// if it is already rendering to a different bitmap, avoiding
944	// enable/disable rendering races.
945	mpDrv->pUpPort->pfnSetRenderVRAM(mpDrv->pUpPort, false);
946
947	mpDrv->IConnector.pbData = NULL;
948	mpDrv->IConnector.cbScanline = 0;
949	mpDrv->IConnector.cBits = 32; /* DevVGA does not work with cBits == 0. */
950	mpDrv->IConnector.cx = 0;
951	mpDrv->IConnector.cy = 0;
952	}
953
954	/* Update maFramebuffers[uScreenId] under lock. */
955	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
956
957	if (uScreenId >= mcMonitors)
958	{
959	LogRel(("Display::i_handleDisplayResize: mcMonitors=%u < uScreenId=%u (pvVRAM=%p w=%u h=%u bpp=%d cbLine=0x%X flags=0x%X)\n",
960	mcMonitors, uScreenId, pvVRAM, w, h, bpp, cbLine, flags));
961	return VINF_SUCCESS;
962	}
963
964	DISPLAYFBINFO *pFBInfo = &maFramebuffers[uScreenId];
965
966	/* Whether the monitor position has changed.
967	* A resize initiated by the VGA device does not change the monitor position.
968	*/
969	const bool fNewOrigin = !fVGAResize
970	&& ( pFBInfo->xOrigin != xOrigin
971	\|\| pFBInfo->yOrigin != yOrigin);
972
973	/* The event for disabled->enabled transition.
974	* VGA resizes also come when the guest uses VBVA mode. They do not affect pFBInfo->fDisabled.
975	* The primary screen is re-enabled when the guest leaves the VBVA mode in i_displayVBVADisable.
976	*/
977	const bool fGuestMonitorChangedEvent = !fVGAResize
978	&& (pFBInfo->fDisabled != RT_BOOL(flags & VBVA_SCREEN_F_DISABLED));
979
980	/* Reset the update mode. */
981	pFBInfo->updateImage.pSourceBitmap.setNull();
982	pFBInfo->updateImage.pu8Address = NULL;
983	pFBInfo->updateImage.cbLine = 0;
984
985	/* Release the current source bitmap. */
986	pFBInfo->pSourceBitmap.setNull();
987
988	/* VGA blanking is signaled as w=0, h=0, bpp=0 and cbLine=0, and it's
989	* best to keep the old resolution, as otherwise the window size would
990	* change before the new resolution is known. */
991	const bool fVGABlank = fVGAResize && uScreenId == VBOX_VIDEO_PRIMARY_SCREEN
992	&& w == 0 && h == 0 && bpp == 0 && cbLine == 0;
993	if (fVGABlank)
994	{
995	w = pFBInfo->w;
996	h = pFBInfo->h;
997	}
998
999	/* Log changes. */
1000	if ( pFBInfo->w != w
1001	\|\| pFBInfo->h != h
1002	\|\| pFBInfo->u32LineSize != cbLine
1003	/\|\| pFBInfo->pu8FramebufferVRAM != (uint8_t )pvVRAM - too noisy */
1004	\|\| ( !fVGAResize
1005	&& ( pFBInfo->xOrigin != xOrigin
1006	\|\| pFBInfo->yOrigin != yOrigin
1007	\|\| pFBInfo->flags != flags)))
1008	LogRel(("Display::i_handleDisplayResize: uScreenId=%d pvVRAM=%p w=%d h=%d bpp=%d cbLine=0x%X flags=0x%X origin=%d,%d\n",
1009	uScreenId, pvVRAM, w, h, bpp, cbLine, flags, xOrigin, yOrigin));
1010
1011	/* Update the video mode information. */
1012	pFBInfo->w = w;
1013	pFBInfo->h = h;
1014	pFBInfo->u16BitsPerPixel = (uint16_t)bpp;
1015	pFBInfo->pu8FramebufferVRAM = (uint8_t *)pvVRAM;
1016	pFBInfo->u32LineSize = cbLine;
1017	if (!fVGAResize)
1018	{
1019	/* Fields which are not used in not VBVA modes and not affected by a VGA resize. */
1020	pFBInfo->flags = flags;
1021	pFBInfo->xOrigin = xOrigin;
1022	pFBInfo->yOrigin = yOrigin;
1023	pFBInfo->fDisabled = RT_BOOL(flags & VBVA_SCREEN_F_DISABLED);
1024	pFBInfo->fVBVAForceResize = false;
1025	}
1026	else
1027	{
1028	pFBInfo->flags = VBVA_SCREEN_F_ACTIVE;
1029	if (fVGABlank)
1030	pFBInfo->flags \|= VBVA_SCREEN_F_BLANK;
1031	pFBInfo->fDisabled = false;
1032	}
1033
1034	/* Prepare local vars for the notification code below. */
1035	ComPtr<IFramebuffer> pFramebuffer = pFBInfo->pFramebuffer;
1036	const bool fDisabled = pFBInfo->fDisabled;
1037
1038	alock.release();
1039
1040	if (!pFramebuffer.isNull())
1041	{
1042	HRESULT hr = pFramebuffer->NotifyChange(uScreenId, 0, 0, w, h); /** @todo origin */
1043	LogFunc(("NotifyChange hr %08X\n", hr));
1044	NOREF(hr);
1045	}
1046
1047	if (fGuestMonitorChangedEvent)
1048	{
1049	if (fDisabled)
1050	fireGuestMonitorChangedEvent(mParent->i_getEventSource(),
1051	GuestMonitorChangedEventType_Disabled,
1052	uScreenId,
1053	0, 0, 0, 0);
1054	else
1055	fireGuestMonitorChangedEvent(mParent->i_getEventSource(),
1056	GuestMonitorChangedEventType_Enabled,
1057	uScreenId,
1058	xOrigin, yOrigin, w, h);
1059	}
1060
1061	if (fNewOrigin)
1062	fireGuestMonitorChangedEvent(mParent->i_getEventSource(),
1063	GuestMonitorChangedEventType_NewOrigin,
1064	uScreenId,
1065	xOrigin, yOrigin, 0, 0);
1066
1067	/* Inform the VRDP server about the change of display parameters. */
1068	LogRelFlowFunc(("Calling VRDP\n"));
1069	mParent->i_consoleVRDPServer()->SendResize();
1070
1071	/* And re-send the seamless rectangles if necessary. */
1072	if (mfSeamlessEnabled)
1073	i_handleSetVisibleRegion(mcRectVisibleRegion, mpRectVisibleRegion);
1074
1075	#ifdef VBOX_WITH_RECORDING
1076	i_recordingScreenChanged(uScreenId);
1077	#endif
1078
1079	LogRelFlowFunc(("[%d]: default format %d\n", uScreenId, pFBInfo->fDefaultFormat));
1080
1081	return VINF_SUCCESS;
1082	}
1083
1084	static void i_checkCoordBounds(int px, int py, int pw, int ph, int cx, int cy)
1085	{
1086	/* Correct negative x and y coordinates. */
1087	if (*px < 0)
1088	{
1089	px += pw; /* Compute xRight which is also the new width. */
1090
1091	pw = (px < 0)? 0: *px;
1092
1093	*px = 0;
1094	}
1095
1096	if (*py < 0)
1097	{
1098	py += ph; /* Compute xBottom, which is also the new height. */
1099
1100	ph = (py < 0)? 0: *py;
1101
1102	*py = 0;
1103	}
1104
1105	/* Also check if coords are greater than the display resolution. */
1106	if (px + pw > cx)
1107	{
1108	pw = cx > px? cx - *px: 0;
1109	}
1110
1111	if (py + ph > cy)
1112	{
1113	ph = cy > py? cy - *py: 0;
1114	}
1115	}
1116
1117	void Display::i_handleDisplayUpdate(unsigned uScreenId, int x, int y, int w, int h)
1118	{
1119	/*
1120	* Always runs under either VBVA lock or, for HGSMI, DevVGA lock.
1121	* Safe to use VBVA vars and take the framebuffer lock.
1122	*/
1123
1124	#ifdef DEBUG_sunlover
1125	LogFlowFunc(("[%d] %d,%d %dx%d\n",
1126	uScreenId, x, y, w, h));
1127	#endif /* DEBUG_sunlover */
1128
1129	/* No updates for a disabled guest screen. */
1130	if (maFramebuffers[uScreenId].fDisabled)
1131	return;
1132
1133	/* No updates for a blank guest screen. */
1134	/** @note Disabled for now, as the GUI does not update the picture when we
1135	* first blank. */
1136	/* if (maFramebuffers[uScreenId].flags & VBVA_SCREEN_F_BLANK)
1137	return; */
1138
1139	DISPLAYFBINFO *pFBInfo = &maFramebuffers[uScreenId];
1140	AutoReadLock alockr(this COMMA_LOCKVAL_SRC_POS);
1141
1142	ComPtr<IFramebuffer> pFramebuffer = pFBInfo->pFramebuffer;
1143	ComPtr<IDisplaySourceBitmap> pSourceBitmap = pFBInfo->updateImage.pSourceBitmap;
1144
1145	alockr.release();
1146
1147	if (RT_LIKELY(!pFramebuffer.isNull()))
1148	{
1149	if (RT_LIKELY(!RT_BOOL(pFBInfo->u32Caps & FramebufferCapabilities_UpdateImage)))
1150	{
1151	i_checkCoordBounds(&x, &y, &w, &h, pFBInfo->w, pFBInfo->h);
1152
1153	if (w != 0 && h != 0)
1154	{
1155	pFramebuffer->NotifyUpdate(x, y, w, h);
1156	}
1157	}
1158	else
1159	{
1160	if (RT_LIKELY(!pSourceBitmap.isNull()))
1161	{ /* likely */ }
1162	else
1163	{
1164	/* Create a source bitmap if UpdateImage mode is used. */
1165	HRESULT hr = QuerySourceBitmap(uScreenId, pSourceBitmap.asOutParam());
1166	if (SUCCEEDED(hr))
1167	{
1168	BYTE *pAddress = NULL;
1169	ULONG ulWidth = 0;
1170	ULONG ulHeight = 0;
1171	ULONG ulBitsPerPixel = 0;
1172	ULONG ulBytesPerLine = 0;
1173	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
1174
1175	hr = pSourceBitmap->QueryBitmapInfo(&pAddress,
1176	&ulWidth,
1177	&ulHeight,
1178	&ulBitsPerPixel,
1179	&ulBytesPerLine,
1180	&bitmapFormat);
1181	if (SUCCEEDED(hr))
1182	{
1183	AutoWriteLock alockw(this COMMA_LOCKVAL_SRC_POS);
1184
1185	if (pFBInfo->updateImage.pSourceBitmap.isNull())
1186	{
1187	pFBInfo->updateImage.pSourceBitmap = pSourceBitmap;
1188	pFBInfo->updateImage.pu8Address = pAddress;
1189	pFBInfo->updateImage.cbLine = ulBytesPerLine;
1190	}
1191
1192	pSourceBitmap = pFBInfo->updateImage.pSourceBitmap;
1193
1194	alockw.release();
1195	}
1196	}
1197	}
1198
1199	if (RT_LIKELY(!pSourceBitmap.isNull()))
1200	{
1201	BYTE *pbAddress = NULL;
1202	ULONG ulWidth = 0;
1203	ULONG ulHeight = 0;
1204	ULONG ulBitsPerPixel = 0;
1205	ULONG ulBytesPerLine = 0;
1206	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
1207
1208	HRESULT hr = pSourceBitmap->QueryBitmapInfo(&pbAddress,
1209	&ulWidth,
1210	&ulHeight,
1211	&ulBitsPerPixel,
1212	&ulBytesPerLine,
1213	&bitmapFormat);
1214	if (SUCCEEDED(hr))
1215	{
1216	/* Make sure that the requested update is within the source bitmap dimensions. */
1217	i_checkCoordBounds(&x, &y, &w, &h, ulWidth, ulHeight);
1218
1219	if (w != 0 && h != 0)
1220	{
1221	const size_t cbData = w * h * 4;
1222	com::SafeArray<BYTE> image(cbData);
1223
1224	uint8_t *pu8Dst = image.raw();
1225	const uint8_t pu8Src = pbAddress + ulBytesPerLine y + x * 4;
1226
1227	int i;
1228	for (i = y; i < y + h; ++i)
1229	{
1230	memcpy(pu8Dst, pu8Src, w * 4);
1231	pu8Dst += w * 4;
1232	pu8Src += ulBytesPerLine;
1233	}
1234
1235	pFramebuffer->NotifyUpdateImage(x, y, w, h, ComSafeArrayAsInParam(image));
1236	}
1237	}
1238	}
1239	}
1240	}
1241
1242	#ifndef VBOX_WITH_HGSMI
1243	if (!mVideoAccelLegacy.fVideoAccelEnabled)
1244	{
1245	#else
1246	if (!mVideoAccelLegacy.fVideoAccelEnabled && !maFramebuffers[uScreenId].fVBVAEnabled)
1247	{
1248	#endif /* VBOX_WITH_HGSMI */
1249	/* When VBVA is enabled, the VRDP server is informed
1250	* either in VideoAccelFlush or displayVBVAUpdateProcess.
1251	* Inform the server here only if VBVA is disabled.
1252	*/
1253	mParent->i_consoleVRDPServer()->SendUpdateBitmap(uScreenId, x, y, w, h);
1254	}
1255	}
1256
1257	void Display::i_updateGuestGraphicsFacility(void)
1258	{
1259	Guest* pGuest = mParent->i_getGuest();
1260	AssertPtrReturnVoid(pGuest);
1261	/* The following is from GuestImpl.cpp. */
1262	/** @todo A nit: The timestamp is wrong on saved state restore. Would be better
1263	* to move the graphics and seamless capability -> facility translation to
1264	* VMMDev so this could be saved. */
1265	RTTIMESPEC TimeSpecTS;
1266	RTTimeNow(&TimeSpecTS);
1267
1268	if ( mfVMMDevSupportsGraphics
1269	\|\| (mfGuestVBVACapabilities & VBVACAPS_VIDEO_MODE_HINTS) != 0)
1270	pGuest->i_setAdditionsStatus(VBoxGuestFacilityType_Graphics,
1271	VBoxGuestFacilityStatus_Active,
1272	0 /fFlags/, &TimeSpecTS);
1273	else
1274	pGuest->i_setAdditionsStatus(VBoxGuestFacilityType_Graphics,
1275	VBoxGuestFacilityStatus_Inactive,
1276	0 /fFlags/, &TimeSpecTS);
1277	}
1278
1279	void Display::i_handleUpdateVMMDevSupportsGraphics(bool fSupportsGraphics)
1280	{
1281	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1282	if (mfVMMDevSupportsGraphics == fSupportsGraphics)
1283	return;
1284	mfVMMDevSupportsGraphics = fSupportsGraphics;
1285	i_updateGuestGraphicsFacility();
1286	/* The VMMDev interface notifies the console. */
1287	}
1288
1289	void Display::i_handleUpdateGuestVBVACapabilities(uint32_t fNewCapabilities)
1290	{
1291	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1292	bool fNotify = (fNewCapabilities & VBVACAPS_VIDEO_MODE_HINTS) != (mfGuestVBVACapabilities & VBVACAPS_VIDEO_MODE_HINTS);
1293
1294	mfGuestVBVACapabilities = fNewCapabilities;
1295	if (!fNotify)
1296	return;
1297	i_updateGuestGraphicsFacility();
1298	/* Tell the console about it */
1299	mParent->i_onAdditionsStateChange();
1300	}
1301
1302	void Display::i_handleUpdateVBVAInputMapping(int32_t xOrigin, int32_t yOrigin, uint32_t cx, uint32_t cy)
1303	{
1304	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1305
1306	xInputMappingOrigin = xOrigin;
1307	yInputMappingOrigin = yOrigin;
1308	cxInputMapping = cx;
1309	cyInputMapping = cy;
1310
1311	/* Re-send the seamless rectangles if necessary. */
1312	if (mfSeamlessEnabled)
1313	i_handleSetVisibleRegion(mcRectVisibleRegion, mpRectVisibleRegion);
1314	}
1315
1316	/**
1317	* Returns the upper left and lower right corners of the virtual framebuffer.
1318	* The lower right is "exclusive" (i.e. first pixel beyond the framebuffer),
1319	* and the origin is (0, 0), not (1, 1) like the GUI returns.
1320	*/
1321	void Display::i_getFramebufferDimensions(int32_t px1, int32_t py1,
1322	int32_t px2, int32_t py2)
1323	{
1324	int32_t x1 = 0, y1 = 0, x2 = 0, y2 = 0;
1325	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1326
1327	AssertPtrReturnVoid(px1);
1328	AssertPtrReturnVoid(py1);
1329	AssertPtrReturnVoid(px2);
1330	AssertPtrReturnVoid(py2);
1331	LogRelFlowFunc(("\n"));
1332
1333	if (!mpDrv)
1334	return;
1335	/* If VBVA is not in use then this flag will not be set and this
1336	* will still work as it should. */
1337	if (!maFramebuffers[0].fDisabled)
1338	{
1339	x1 = (int32_t)maFramebuffers[0].xOrigin;
1340	y1 = (int32_t)maFramebuffers[0].yOrigin;
1341	x2 = (int32_t)maFramebuffers[0].w + (int32_t)maFramebuffers[0].xOrigin;
1342	y2 = (int32_t)maFramebuffers[0].h + (int32_t)maFramebuffers[0].yOrigin;
1343	}
1344	if (cxInputMapping && cyInputMapping)
1345	{
1346	x1 = xInputMappingOrigin;
1347	y1 = yInputMappingOrigin;
1348	x2 = xInputMappingOrigin + cxInputMapping;
1349	y2 = yInputMappingOrigin + cyInputMapping;
1350	}
1351	else
1352	for (unsigned i = 1; i < mcMonitors; ++i)
1353	{
1354	if (!maFramebuffers[i].fDisabled)
1355	{
1356	x1 = RT_MIN(x1, maFramebuffers[i].xOrigin);
1357	y1 = RT_MIN(y1, maFramebuffers[i].yOrigin);
1358	x2 = RT_MAX(x2, maFramebuffers[i].xOrigin + (int32_t)maFramebuffers[i].w);
1359	y2 = RT_MAX(y2, maFramebuffers[i].yOrigin + (int32_t)maFramebuffers[i].h);
1360	}
1361	}
1362	*px1 = x1;
1363	*py1 = y1;
1364	*px2 = x2;
1365	*py2 = y2;
1366	}
1367
1368	/** Updates the device's view of the host cursor handling capabilities.
1369	* Calls into mpDrv->pUpPort. */
1370	void Display::i_UpdateDeviceCursorCapabilities(void)
1371	{
1372	bool fRenderCursor = true;
1373	bool fMoveCursor = mcVRDPRefs == 0;
1374	#ifdef VBOX_WITH_RECORDING
1375	RecordingContext *pCtx = mParent->i_recordingGetContext();
1376
1377	if ( pCtx
1378	&& pCtx->IsStarted()
1379	&& pCtx->IsFeatureEnabled(RecordingFeature_Video))
1380	fRenderCursor = fMoveCursor = false;
1381	else
1382	#endif /* VBOX_WITH_RECORDING */
1383	{
1384	for (unsigned uScreenId = 0; uScreenId < mcMonitors; uScreenId++)
1385	{
1386	DISPLAYFBINFO *pFBInfo = &maFramebuffers[uScreenId];
1387	if (!(pFBInfo->u32Caps & FramebufferCapabilities_RenderCursor))
1388	fRenderCursor = false;
1389	if (!(pFBInfo->u32Caps & FramebufferCapabilities_MoveCursor))
1390	fMoveCursor = false;
1391	}
1392	}
1393
1394	if (mpDrv)
1395	mpDrv->pUpPort->pfnReportHostCursorCapabilities(mpDrv->pUpPort, fRenderCursor, fMoveCursor);
1396	}
1397
1398	HRESULT Display::i_reportHostCursorCapabilities(uint32_t fCapabilitiesAdded, uint32_t fCapabilitiesRemoved)
1399	{
1400	/* Do we need this to access mParent? I presume that the safe VM pointer
1401	* ensures that mpDrv will remain valid. */
1402	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1403	uint32_t fHostCursorCapabilities = (mfHostCursorCapabilities \| fCapabilitiesAdded)
1404	& ~fCapabilitiesRemoved;
1405
1406	Console::SafeVMPtr ptrVM(mParent);
1407	if (!ptrVM.isOk())
1408	return ptrVM.rc();
1409	if (mfHostCursorCapabilities == fHostCursorCapabilities)
1410	return S_OK;
1411	CHECK_CONSOLE_DRV(mpDrv);
1412	alock.release(); /* Release before calling up for lock order reasons. */
1413	mfHostCursorCapabilities = fHostCursorCapabilities;
1414	i_UpdateDeviceCursorCapabilities();
1415	return S_OK;
1416	}
1417
1418	HRESULT Display::i_reportHostCursorPosition(int32_t x, int32_t y, bool fOutOfRange)
1419	{
1420	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1421	uint32_t xAdj = (uint32_t)RT_MAX(x - xInputMappingOrigin, 0);
1422	uint32_t yAdj = (uint32_t)RT_MAX(y - yInputMappingOrigin, 0);
1423	xAdj = RT_MIN(xAdj, cxInputMapping);
1424	yAdj = RT_MIN(yAdj, cyInputMapping);
1425
1426	Console::SafeVMPtr ptrVM(mParent);
1427	if (!ptrVM.isOk())
1428	return ptrVM.rc();
1429	CHECK_CONSOLE_DRV(mpDrv);
1430	alock.release(); /* Release before calling up for lock order reasons. */
1431	if (fOutOfRange)
1432	mpDrv->pUpPort->pfnReportHostCursorPosition(mpDrv->pUpPort, 0, 0, true);
1433	else
1434	mpDrv->pUpPort->pfnReportHostCursorPosition(mpDrv->pUpPort, xAdj, yAdj, false);
1435	return S_OK;
1436	}
1437
1438	static bool displayIntersectRect(RTRECT *prectResult,
1439	const RTRECT *prect1,
1440	const RTRECT *prect2)
1441	{
1442	/* Initialize result to an empty record. */
1443	memset(prectResult, 0, sizeof(RTRECT));
1444
1445	int xLeftResult = RT_MAX(prect1->xLeft, prect2->xLeft);
1446	int xRightResult = RT_MIN(prect1->xRight, prect2->xRight);
1447
1448	if (xLeftResult < xRightResult)
1449	{
1450	/* There is intersection by X. */
1451
1452	int yTopResult = RT_MAX(prect1->yTop, prect2->yTop);
1453	int yBottomResult = RT_MIN(prect1->yBottom, prect2->yBottom);
1454
1455	if (yTopResult < yBottomResult)
1456	{
1457	/* There is intersection by Y. */
1458
1459	prectResult->xLeft = xLeftResult;
1460	prectResult->yTop = yTopResult;
1461	prectResult->xRight = xRightResult;
1462	prectResult->yBottom = yBottomResult;
1463
1464	return true;
1465	}
1466	}
1467
1468	return false;
1469	}
1470
1471	int Display::i_saveVisibleRegion(uint32_t cRect, PRTRECT pRect)
1472	{
1473	RTRECT *pRectVisibleRegion = NULL;
1474
1475	if (pRect == mpRectVisibleRegion)
1476	return VINF_SUCCESS;
1477	if (cRect != 0)
1478	{
1479	pRectVisibleRegion = (RTRECT )RTMemAlloc(cRect sizeof(RTRECT));
1480	if (!pRectVisibleRegion)
1481	{
1482	return VERR_NO_MEMORY;
1483	}
1484	memcpy(pRectVisibleRegion, pRect, cRect * sizeof(RTRECT));
1485	}
1486	if (mpRectVisibleRegion)
1487	RTMemFree(mpRectVisibleRegion);
1488	mcRectVisibleRegion = cRect;
1489	mpRectVisibleRegion = pRectVisibleRegion;
1490	return VINF_SUCCESS;
1491	}
1492
1493	int Display::i_handleSetVisibleRegion(uint32_t cRect, PRTRECT pRect)
1494	{
1495	RTRECT pVisibleRegion = (RTRECT )RTMemTmpAlloc( RT_MAX(cRect, 1)
1496	* sizeof(RTRECT));
1497	LogRel2(("%s: cRect=%u\n", __PRETTY_FUNCTION__, cRect));
1498	if (!pVisibleRegion)
1499	{
1500	return VERR_NO_TMP_MEMORY;
1501	}
1502	int rc = i_saveVisibleRegion(cRect, pRect);
1503	if (RT_FAILURE(rc))
1504	{
1505	RTMemTmpFree(pVisibleRegion);
1506	return rc;
1507	}
1508
1509	unsigned uScreenId;
1510	for (uScreenId = 0; uScreenId < mcMonitors; uScreenId++)
1511	{
1512	DISPLAYFBINFO *pFBInfo = &maFramebuffers[uScreenId];
1513
1514	if ( !pFBInfo->pFramebuffer.isNull()
1515	&& RT_BOOL(pFBInfo->u32Caps & FramebufferCapabilities_VisibleRegion))
1516	{
1517	/* Prepare a new array of rectangles which intersect with the framebuffer.
1518	*/
1519	RTRECT rectFramebuffer;
1520	rectFramebuffer.xLeft = pFBInfo->xOrigin - xInputMappingOrigin;
1521	rectFramebuffer.yTop = pFBInfo->yOrigin - yInputMappingOrigin;
1522	rectFramebuffer.xRight = rectFramebuffer.xLeft + pFBInfo->w;
1523	rectFramebuffer.yBottom = rectFramebuffer.yTop + pFBInfo->h;
1524
1525	uint32_t cRectVisibleRegion = 0;
1526
1527	uint32_t i;
1528	for (i = 0; i < cRect; i++)
1529	{
1530	if (displayIntersectRect(&pVisibleRegion[cRectVisibleRegion], &pRect[i], &rectFramebuffer))
1531	{
1532	pVisibleRegion[cRectVisibleRegion].xLeft -= rectFramebuffer.xLeft;
1533	pVisibleRegion[cRectVisibleRegion].yTop -= rectFramebuffer.yTop;
1534	pVisibleRegion[cRectVisibleRegion].xRight -= rectFramebuffer.xLeft;
1535	pVisibleRegion[cRectVisibleRegion].yBottom -= rectFramebuffer.yTop;
1536
1537	cRectVisibleRegion++;
1538	}
1539	}
1540	pFBInfo->pFramebuffer->SetVisibleRegion((BYTE *)pVisibleRegion, cRectVisibleRegion);
1541	}
1542	}
1543
1544	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
1545	VMMDev *vmmDev = mParent->i_getVMMDev();
1546	if (mfIsCr3DEnabled && vmmDev)
1547	{
1548	if (mhCrOglSvc)
1549	{
1550	VBOXCRCMDCTL_HGCM *pCtl;
1551	pCtl = (VBOXCRCMDCTL_HGCM)RTMemAlloc(RT_MAX(cRect, 1) sizeof(RTRECT) + sizeof(VBOXCRCMDCTL_HGCM));
1552	if (pCtl)
1553	{
1554	RTRECT pRectsCopy = (RTRECT)(pCtl+1);
1555	memcpy(pRectsCopy, pRect, cRect * sizeof(RTRECT));
1556
1557	pCtl->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
1558	pCtl->Hdr.u32Function = SHCRGL_HOST_FN_SET_VISIBLE_REGION;
1559
1560	pCtl->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
1561	pCtl->aParms[0].u.pointer.addr = pRectsCopy;
1562	pCtl->aParms[0].u.pointer.size = (uint32_t)(cRect * sizeof(RTRECT));
1563
1564	rc = i_crCtlSubmit(&pCtl->Hdr, sizeof(*pCtl), i_displayCrCmdFree, pCtl);
1565	if (!RT_SUCCESS(rc))
1566	{
1567	AssertMsgFailed(("crCtlSubmit failed (rc=%Rrc)\n", rc));
1568	RTMemFree(pCtl);
1569	}
1570	}
1571	else
1572	AssertMsgFailed(("failed to allocate rects memory\n"));
1573	}
1574	else
1575	AssertMsgFailed(("mhCrOglSvc is NULL\n"));
1576	}
1577	#endif
1578
1579	RTMemTmpFree(pVisibleRegion);
1580
1581	return VINF_SUCCESS;
1582	}
1583
1584	int Display::i_handleQueryVisibleRegion(uint32_t *pcRects, PRTRECT paRects)
1585	{
1586	/// @todo Currently not used by the guest and is not implemented in
1587	/// framebuffers. Remove?
1588	RT_NOREF(pcRects, paRects);
1589	return VERR_NOT_SUPPORTED;
1590	}
1591
1592	#ifdef VBOX_WITH_HGSMI
1593	static void vbvaSetMemoryFlagsHGSMI(unsigned uScreenId,
1594	uint32_t fu32SupportedOrders,
1595	bool fVideoAccelVRDP,
1596	DISPLAYFBINFO *pFBInfo)
1597	{
1598	LogRelFlowFunc(("HGSMI[%d]: %p\n", uScreenId, pFBInfo->pVBVAHostFlags));
1599
1600	if (pFBInfo->pVBVAHostFlags)
1601	{
1602	uint32_t fu32HostEvents = VBOX_VIDEO_INFO_HOST_EVENTS_F_VRDP_RESET;
1603
1604	if (pFBInfo->fVBVAEnabled)
1605	{
1606	fu32HostEvents \|= VBVA_F_MODE_ENABLED;
1607
1608	if (fVideoAccelVRDP)
1609	{
1610	fu32HostEvents \|= VBVA_F_MODE_VRDP;
1611	}
1612	}
1613
1614	ASMAtomicWriteU32(&pFBInfo->pVBVAHostFlags->u32HostEvents, fu32HostEvents);
1615	ASMAtomicWriteU32(&pFBInfo->pVBVAHostFlags->u32SupportedOrders, fu32SupportedOrders);
1616
1617	LogRelFlowFunc((" fu32HostEvents = 0x%08X, fu32SupportedOrders = 0x%08X\n", fu32HostEvents, fu32SupportedOrders));
1618	}
1619	}
1620
1621	static void vbvaSetMemoryFlagsAllHGSMI(uint32_t fu32SupportedOrders,
1622	bool fVideoAccelVRDP,
1623	DISPLAYFBINFO *paFBInfos,
1624	unsigned cFBInfos)
1625	{
1626	unsigned uScreenId;
1627
1628	for (uScreenId = 0; uScreenId < cFBInfos; uScreenId++)
1629	{
1630	vbvaSetMemoryFlagsHGSMI(uScreenId, fu32SupportedOrders, fVideoAccelVRDP, &paFBInfos[uScreenId]);
1631	}
1632	}
1633	#endif /* VBOX_WITH_HGSMI */
1634
1635	int Display::VideoAccelEnableVMMDev(bool fEnable, VBVAMEMORY *pVbvaMemory)
1636	{
1637	LogFlowFunc(("%d %p\n", fEnable, pVbvaMemory));
1638	int rc = videoAccelEnterVMMDev(&mVideoAccelLegacy);
1639	if (RT_SUCCESS(rc))
1640	{
1641	rc = i_VideoAccelEnable(fEnable, pVbvaMemory, mpDrv->pUpPort);
1642	videoAccelLeaveVMMDev(&mVideoAccelLegacy);
1643	}
1644	LogFlowFunc(("leave %Rrc\n", rc));
1645	return rc;
1646	}
1647
1648	int Display::VideoAccelEnableVGA(bool fEnable, VBVAMEMORY *pVbvaMemory)
1649	{
1650	LogFlowFunc(("%d %p\n", fEnable, pVbvaMemory));
1651	int rc = videoAccelEnterVGA(&mVideoAccelLegacy);
1652	if (RT_SUCCESS(rc))
1653	{
1654	rc = i_VideoAccelEnable(fEnable, pVbvaMemory, mpDrv->pUpPort);
1655	videoAccelLeaveVGA(&mVideoAccelLegacy);
1656	}
1657	LogFlowFunc(("leave %Rrc\n", rc));
1658	return rc;
1659	}
1660
1661	void Display::VideoAccelFlushVMMDev(void)
1662	{
1663	LogFlowFunc(("enter\n"));
1664	int rc = videoAccelEnterVMMDev(&mVideoAccelLegacy);
1665	if (RT_SUCCESS(rc))
1666	{
1667	i_VideoAccelFlush(mpDrv->pUpPort);
1668	videoAccelLeaveVMMDev(&mVideoAccelLegacy);
1669	}
1670	LogFlowFunc(("leave\n"));
1671	}
1672
1673	/* Called always by one VRDP server thread. Can be thread-unsafe.
1674	*/
1675	void Display::i_VRDPConnectionEvent(bool fConnect)
1676	{
1677	LogRelFlowFunc(("fConnect = %d\n", fConnect));
1678
1679	int c = fConnect?
1680	ASMAtomicIncS32(&mcVRDPRefs):
1681	ASMAtomicDecS32(&mcVRDPRefs);
1682
1683	i_VideoAccelVRDP(fConnect, c);
1684	i_UpdateDeviceCursorCapabilities();
1685	}
1686
1687
1688	void Display::i_VideoAccelVRDP(bool fEnable, int c)
1689	{
1690	VIDEOACCEL *pVideoAccel = &mVideoAccelLegacy;
1691
1692	Assert (c >= 0);
1693	RT_NOREF(fEnable);
1694
1695	/* This can run concurrently with Display videoaccel state change. */
1696	RTCritSectEnter(&mVideoAccelLock);
1697
1698	if (c == 0)
1699	{
1700	/* The last client has disconnected, and the accel can be
1701	* disabled.
1702	*/
1703	Assert(fEnable == false);
1704
1705	mfVideoAccelVRDP = false;
1706	mfu32SupportedOrders = 0;
1707
1708	i_vbvaSetMemoryFlags(pVideoAccel->pVbvaMemory, pVideoAccel->fVideoAccelEnabled, mfVideoAccelVRDP, mfu32SupportedOrders,
1709	maFramebuffers, mcMonitors);
1710	#ifdef VBOX_WITH_HGSMI
1711	/* Here is VRDP-IN thread. Process the request in vbvaUpdateBegin under DevVGA lock on an EMT. */
1712	ASMAtomicIncU32(&mu32UpdateVBVAFlags);
1713	#endif /* VBOX_WITH_HGSMI */
1714
1715	LogRel(("VBVA: VRDP acceleration has been disabled.\n"));
1716	}
1717	else if ( c == 1
1718	&& !mfVideoAccelVRDP)
1719	{
1720	/* The first client has connected. Enable the accel.
1721	*/
1722	Assert(fEnable == true);
1723
1724	mfVideoAccelVRDP = true;
1725	/* Supporting all orders. */
1726	mfu32SupportedOrders = UINT32_MAX;
1727
1728	i_vbvaSetMemoryFlags(pVideoAccel->pVbvaMemory, pVideoAccel->fVideoAccelEnabled, mfVideoAccelVRDP, mfu32SupportedOrders,
1729	maFramebuffers, mcMonitors);
1730	#ifdef VBOX_WITH_HGSMI
1731	/* Here is VRDP-IN thread. Process the request in vbvaUpdateBegin under DevVGA lock on an EMT. */
1732	ASMAtomicIncU32(&mu32UpdateVBVAFlags);
1733	#endif /* VBOX_WITH_HGSMI */
1734
1735	LogRel(("VBVA: VRDP acceleration has been requested.\n"));
1736	}
1737	else
1738	{
1739	/* A client is connected or disconnected but there is no change in the
1740	* accel state. It remains enabled.
1741	*/
1742	Assert(mfVideoAccelVRDP == true);
1743	}
1744
1745	RTCritSectLeave(&mVideoAccelLock);
1746	}
1747
1748	void Display::i_notifyPowerDown(void)
1749	{
1750	LogRelFlowFunc(("\n"));
1751
1752	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1753
1754	/* Source bitmaps are not available anymore. */
1755	mfSourceBitmapEnabled = false;
1756
1757	alock.release();
1758
1759	/* Resize all displays to tell framebuffers to forget current source bitmap. */
1760	unsigned uScreenId = mcMonitors;
1761	while (uScreenId > 0)
1762	{
1763	--uScreenId;
1764
1765	DISPLAYFBINFO *pFBInfo = &maFramebuffers[uScreenId];
1766	if (!pFBInfo->fDisabled)
1767	{
1768	i_handleDisplayResize(uScreenId, 32,
1769	pFBInfo->pu8FramebufferVRAM,
1770	pFBInfo->u32LineSize,
1771	pFBInfo->w,
1772	pFBInfo->h,
1773	pFBInfo->flags,
1774	pFBInfo->xOrigin,
1775	pFBInfo->yOrigin,
1776	false);
1777	}
1778	}
1779	}
1780
1781	// Wrapped IDisplay methods
1782	/////////////////////////////////////////////////////////////////////////////
1783	HRESULT Display::getScreenResolution(ULONG aScreenId, ULONG aWidth, ULONG aHeight, ULONG *aBitsPerPixel,
1784	LONG aXOrigin, LONG aYOrigin, GuestMonitorStatus_T *aGuestMonitorStatus)
1785	{
1786	LogRelFlowFunc(("aScreenId=%RU32\n", aScreenId));
1787
1788	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1789
1790	if (aScreenId >= mcMonitors)
1791	return E_INVALIDARG;
1792
1793	DISPLAYFBINFO *pFBInfo = &maFramebuffers[aScreenId];
1794
1795	GuestMonitorStatus_T guestMonitorStatus = GuestMonitorStatus_Enabled;
1796
1797	if (pFBInfo->flags & VBVA_SCREEN_F_DISABLED)
1798	guestMonitorStatus = GuestMonitorStatus_Disabled;
1799	else if (pFBInfo->flags & (VBVA_SCREEN_F_BLANK \| VBVA_SCREEN_F_BLANK2))
1800	guestMonitorStatus = GuestMonitorStatus_Blank;
1801
1802	if (aWidth)
1803	*aWidth = pFBInfo->w;
1804	if (aHeight)
1805	*aHeight = pFBInfo->h;
1806	if (aBitsPerPixel)
1807	*aBitsPerPixel = pFBInfo->u16BitsPerPixel;
1808	if (aXOrigin)
1809	*aXOrigin = pFBInfo->xOrigin;
1810	if (aYOrigin)
1811	*aYOrigin = pFBInfo->yOrigin;
1812	if (aGuestMonitorStatus)
1813	*aGuestMonitorStatus = guestMonitorStatus;
1814
1815	return S_OK;
1816	}
1817
1818
1819	HRESULT Display::attachFramebuffer(ULONG aScreenId, const ComPtr<IFramebuffer> &aFramebuffer, com::Guid &aId)
1820	{
1821	LogRelFlowFunc(("aScreenId = %d\n", aScreenId));
1822
1823	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1824
1825	if (aScreenId >= mcMonitors)
1826	return setError(E_INVALIDARG, tr("AttachFramebuffer: Invalid screen %d (total %d)"),
1827	aScreenId, mcMonitors);
1828
1829	DISPLAYFBINFO *pFBInfo = &maFramebuffers[aScreenId];
1830	if (!pFBInfo->pFramebuffer.isNull())
1831	return setError(E_FAIL, tr("AttachFramebuffer: Framebuffer already attached to %d"),
1832	aScreenId);
1833
1834	pFBInfo->pFramebuffer = aFramebuffer;
1835	pFBInfo->framebufferId.create();
1836	aId = pFBInfo->framebufferId;
1837
1838	SafeArray<FramebufferCapabilities_T> caps;
1839	pFBInfo->pFramebuffer->COMGETTER(Capabilities)(ComSafeArrayAsOutParam(caps));
1840	pFBInfo->u32Caps = 0;
1841	size_t i;
1842	for (i = 0; i < caps.size(); ++i)
1843	pFBInfo->u32Caps \|= caps[i];
1844
1845	alock.release();
1846
1847	/* The driver might not have been constructed yet */
1848	if (mpDrv)
1849	{
1850	/* Inform the framebuffer about the actual screen size. */
1851	HRESULT hr = aFramebuffer->NotifyChange(aScreenId, 0, 0, pFBInfo->w, pFBInfo->h); /** @todo origin */
1852	LogFunc(("NotifyChange hr %08X\n", hr)); NOREF(hr);
1853
1854	/* Re-send the seamless rectangles if necessary. */
1855	if (mfSeamlessEnabled)
1856	i_handleSetVisibleRegion(mcRectVisibleRegion, mpRectVisibleRegion);
1857	}
1858
1859	Console::SafeVMPtrQuiet ptrVM(mParent);
1860	if (ptrVM.isOk())
1861	{
1862	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
1863	if (mfIsCr3DEnabled)
1864	{
1865	VBOXCRCMDCTL_HGCM data;
1866	RT_ZERO(data);
1867	data.Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
1868	data.Hdr.u32Function = SHCRGL_HOST_FN_SCREEN_CHANGED;
1869
1870	data.aParms[0].type = VBOX_HGCM_SVC_PARM_32BIT;
1871	data.aParms[0].u.uint32 = aScreenId;
1872
1873	int vrc = i_crCtlSubmitSync(&data.Hdr, sizeof(data));
1874	AssertRC(vrc);
1875	}
1876	#endif /* defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL) */
1877
1878	VMR3ReqCallNoWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_InvalidateAndUpdateEMT,
1879	3, this, aScreenId, false);
1880	}
1881
1882	LogRelFlowFunc(("Attached to %d %RTuuid\n", aScreenId, aId.raw()));
1883	return S_OK;
1884	}
1885
1886	HRESULT Display::detachFramebuffer(ULONG aScreenId, const com::Guid &aId)
1887	{
1888	LogRelFlowFunc(("aScreenId = %d %RTuuid\n", aScreenId, aId.raw()));
1889
1890	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1891
1892	if (aScreenId >= mcMonitors)
1893	return setError(E_INVALIDARG, tr("DetachFramebuffer: Invalid screen %d (total %d)"),
1894	aScreenId, mcMonitors);
1895
1896	DISPLAYFBINFO *pFBInfo = &maFramebuffers[aScreenId];
1897
1898	if (pFBInfo->framebufferId != aId)
1899	{
1900	LogRelFlowFunc(("Invalid framebuffer aScreenId = %d, attached %p\n", aScreenId, pFBInfo->framebufferId.raw()));
1901	return setError(E_FAIL, tr("DetachFramebuffer: Invalid framebuffer object"));
1902	}
1903
1904	pFBInfo->pFramebuffer.setNull();
1905	pFBInfo->framebufferId.clear();
1906
1907	alock.release();
1908
1909	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
1910	Console::SafeVMPtrQuiet ptrVM(mParent);
1911	if (ptrVM.isOk())
1912	{
1913	if (mfIsCr3DEnabled)
1914	{
1915	VBOXCRCMDCTL_HGCM data;
1916	RT_ZERO(data);
1917	data.Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
1918	data.Hdr.u32Function = SHCRGL_HOST_FN_SCREEN_CHANGED;
1919
1920	data.aParms[0].type = VBOX_HGCM_SVC_PARM_32BIT;
1921	data.aParms[0].u.uint32 = aScreenId;
1922
1923	int vrc = i_crCtlSubmitSync(&data.Hdr, sizeof(data));
1924	AssertRC(vrc);
1925	}
1926	}
1927	#endif /* defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL) */
1928
1929	return S_OK;
1930	}
1931
1932	HRESULT Display::queryFramebuffer(ULONG aScreenId, ComPtr<IFramebuffer> &aFramebuffer)
1933	{
1934	LogRelFlowFunc(("aScreenId = %d\n", aScreenId));
1935
1936	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1937
1938	if (aScreenId >= mcMonitors)
1939	return setError(E_INVALIDARG, tr("QueryFramebuffer: Invalid screen %d (total %d)"),
1940	aScreenId, mcMonitors);
1941
1942	DISPLAYFBINFO *pFBInfo = &maFramebuffers[aScreenId];
1943
1944	pFBInfo->pFramebuffer.queryInterfaceTo(aFramebuffer.asOutParam());
1945
1946	return S_OK;
1947	}
1948
1949	HRESULT Display::setVideoModeHint(ULONG aDisplay, BOOL aEnabled,
1950	BOOL aChangeOrigin, LONG aOriginX, LONG aOriginY,
1951	ULONG aWidth, ULONG aHeight, ULONG aBitsPerPixel)
1952	{
1953	if (aWidth == 0 \|\| aHeight == 0 \|\| aBitsPerPixel == 0)
1954	{
1955	/* Some of parameters must not change. Query current mode. */
1956	ULONG ulWidth = 0;
1957	ULONG ulHeight = 0;
1958	ULONG ulBitsPerPixel = 0;
1959	HRESULT hr = getScreenResolution(aDisplay, &ulWidth, &ulHeight, &ulBitsPerPixel, NULL, NULL, NULL);
1960	if (FAILED(hr))
1961	return hr;
1962
1963	/* Assign current values to not changing parameters. */
1964	if (aWidth == 0)
1965	aWidth = ulWidth;
1966	if (aHeight == 0)
1967	aHeight = ulHeight;
1968	if (aBitsPerPixel == 0)
1969	aBitsPerPixel = ulBitsPerPixel;
1970	}
1971
1972	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1973
1974	if (aDisplay >= mcMonitors)
1975	return E_INVALIDARG;
1976
1977	CHECK_CONSOLE_DRV(mpDrv);
1978
1979	/*
1980	* It is up to the guest to decide whether the hint is
1981	* valid. Therefore don't do any VRAM sanity checks here.
1982	*/
1983
1984	/* Have to release the lock because the pfnRequestDisplayChange
1985	* will call EMT. */
1986	alock.release();
1987
1988	/* We always send the hint to the graphics card in case the guest enables
1989	* support later. For now we notify exactly when support is enabled. */
1990	mpDrv->pUpPort->pfnSendModeHint(mpDrv->pUpPort, aWidth, aHeight,
1991	aBitsPerPixel, aDisplay,
1992	aChangeOrigin ? aOriginX : ~0,
1993	aChangeOrigin ? aOriginY : ~0,
1994	RT_BOOL(aEnabled),
1995	mfGuestVBVACapabilities
1996	& VBVACAPS_VIDEO_MODE_HINTS);
1997	if ( mfGuestVBVACapabilities & VBVACAPS_VIDEO_MODE_HINTS
1998	&& !(mfGuestVBVACapabilities & VBVACAPS_IRQ))
1999	{
2000	mParent->i_sendACPIMonitorHotPlugEvent();
2001	}
2002
2003	VMMDevDisplayDef d;
2004	d.idDisplay = aDisplay;
2005	d.xOrigin = aOriginX;
2006	d.yOrigin = aOriginY;
2007	d.cx = aWidth;
2008	d.cy = aHeight;
2009	d.cBitsPerPixel = aBitsPerPixel;
2010	d.fDisplayFlags = VMMDEV_DISPLAY_CX \| VMMDEV_DISPLAY_CY \| VMMDEV_DISPLAY_BPP;
2011	if (!aEnabled)
2012	d.fDisplayFlags \|= VMMDEV_DISPLAY_DISABLED;
2013	if (aChangeOrigin)
2014	d.fDisplayFlags \|= VMMDEV_DISPLAY_ORIGIN;
2015	if (aDisplay == 0)
2016	d.fDisplayFlags \|= VMMDEV_DISPLAY_PRIMARY;
2017	/* We currently never suppress the VMMDev hint if the guest has requested
2018	* it. Specifically the video graphics driver may not be responsible for
2019	* screen positioning in the guest virtual desktop, and the component
2020	* responsible may want to get the hint from VMMDev. */
2021	VMMDev *pVMMDev = mParent->i_getVMMDev();
2022	if (pVMMDev)
2023	{
2024	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
2025	if (pVMMDevPort)
2026	pVMMDevPort->pfnRequestDisplayChange(pVMMDevPort, 1, &d, false);
2027	}
2028	/* Remember the monitor information and notify listeners. */
2029	maFramebuffers[aDisplay].monitorDesc = d;
2030	fireGuestMonitorInfoChangedEvent(mParent->i_getEventSource(), aDisplay);
2031	return S_OK;
2032	}
2033
2034	HRESULT Display::getVideoModeHint(ULONG cDisplay, BOOL *pfEnabled,
2035	BOOL pfChangeOrigin, LONG pxOrigin, LONG *pyOrigin,
2036	ULONG pcx, ULONG pcy, ULONG *pcBitsPerPixel)
2037	{
2038	if (cDisplay >= mcMonitors)
2039	return E_INVALIDARG;
2040
2041	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2042	if (pfEnabled)
2043	*pfEnabled = !( maFramebuffers[cDisplay].monitorDesc.fDisplayFlags
2044	& VMMDEV_DISPLAY_DISABLED);
2045	if (pfChangeOrigin)
2046	*pfChangeOrigin = RT_BOOL( maFramebuffers[cDisplay].monitorDesc.fDisplayFlags
2047	& VMMDEV_DISPLAY_ORIGIN);
2048	if (pxOrigin)
2049	*pxOrigin = maFramebuffers[cDisplay].monitorDesc.xOrigin;
2050	if (pyOrigin)
2051	*pyOrigin = maFramebuffers[cDisplay].monitorDesc.yOrigin;
2052	if (pcx)
2053	*pcx = maFramebuffers[cDisplay].monitorDesc.cx;
2054	if (pcy)
2055	*pcy = maFramebuffers[cDisplay].monitorDesc.cy;
2056	if (pcBitsPerPixel)
2057	*pcBitsPerPixel = maFramebuffers[cDisplay].monitorDesc.cBitsPerPixel;
2058	return S_OK;
2059	}
2060
2061	HRESULT Display::setSeamlessMode(BOOL enabled)
2062	{
2063	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2064
2065	/* Have to release the lock because the pfnRequestSeamlessChange will call EMT. */
2066	alock.release();
2067
2068	VMMDev *pVMMDev = mParent->i_getVMMDev();
2069	if (pVMMDev)
2070	{
2071	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
2072	if (pVMMDevPort)
2073	pVMMDevPort->pfnRequestSeamlessChange(pVMMDevPort, !!enabled);
2074	}
2075	mfSeamlessEnabled = RT_BOOL(enabled);
2076
2077	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2078	if (!enabled)
2079	{
2080	VMMDev *vmmDev = mParent->i_getVMMDev();
2081	if (mfIsCr3DEnabled && vmmDev)
2082	{
2083	VBOXCRCMDCTL_HGCM pData = (VBOXCRCMDCTL_HGCM)RTMemAlloc(sizeof(VBOXCRCMDCTL_HGCM));
2084	if (!pData)
2085	{
2086	AssertMsgFailed(("RTMemAlloc failed\n"));
2087	return VERR_NO_MEMORY;
2088	}
2089
2090	pData->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
2091	pData->Hdr.u32Function = SHCRGL_HOST_FN_SET_VISIBLE_REGION;
2092
2093	pData->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
2094	pData->aParms[0].u.pointer.addr = NULL;
2095	pData->aParms[0].u.pointer.size = 0; /* <- means null rects, NULL pRects address and 0 rects means "disable" */
2096
2097	int rc = i_crCtlSubmit(&pData->Hdr, sizeof(*pData), i_displayCrCmdFree, pData);
2098	if (!RT_SUCCESS(rc))
2099	{
2100	AssertMsgFailed(("crCtlSubmit failed (rc=%Rrc)\n", rc));
2101	RTMemFree(pData);
2102	}
2103	}
2104	}
2105	#endif
2106	return S_OK;
2107	}
2108
2109	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2110	BOOL Display::i_displayCheckTakeScreenshotCrOgl(Display pDisplay, ULONG aScreenId, uint8_t pbData,
2111	uint32_t u32Width, uint32_t u32Height)
2112	{
2113	if ( pDisplay->mfIsCr3DEnabled
2114	&& pDisplay->mCrOglCallbacks.pfnHasData
2115	&& pDisplay->mCrOglCallbacks.pfnHasData())
2116	{
2117	VMMDev *pVMMDev = pDisplay->mParent->i_getVMMDev();
2118	if (pVMMDev)
2119	{
2120	CRVBOXHGCMTAKESCREENSHOT pScreenshot = (CRVBOXHGCMTAKESCREENSHOT )RTMemAlloc(sizeof(*pScreenshot));
2121	if (pScreenshot)
2122	{
2123	/* screen id or CRSCREEN_ALL to specify all enabled */
2124	pScreenshot->u32Screen = aScreenId;
2125	pScreenshot->u32Width = u32Width;
2126	pScreenshot->u32Height = u32Height;
2127	pScreenshot->u32Pitch = u32Width * 4;
2128	pScreenshot->pvBuffer = pbData;
2129	pScreenshot->pvContext = NULL;
2130	pScreenshot->pfnScreenshotBegin = NULL;
2131	pScreenshot->pfnScreenshotPerform = NULL;
2132	pScreenshot->pfnScreenshotEnd = NULL;
2133
2134	VBOXCRCMDCTL_HGCM data;
2135	data.Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
2136	data.Hdr.u32Function = SHCRGL_HOST_FN_TAKE_SCREENSHOT;
2137
2138	data.aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
2139	data.aParms[0].u.pointer.addr = pScreenshot;
2140	data.aParms[0].u.pointer.size = sizeof(*pScreenshot);
2141
2142	int rc = pDisplay->i_crCtlSubmitSync(&data.Hdr, sizeof(data));
2143
2144	RTMemFree(pScreenshot);
2145
2146	if (RT_SUCCESS(rc))
2147	return TRUE;
2148	AssertMsgFailed(("failed to get screenshot data from crOgl (rc=%Rrc)\n", rc));
2149	/* fall back to the non-3d mechanism */
2150	}
2151	}
2152	}
2153	return FALSE;
2154	}
2155	#endif
2156
2157	/* static */
2158	int Display::i_displayTakeScreenshotEMT(Display pDisplay, ULONG aScreenId, uint8_t ppbData, size_t pcbData,
2159	uint32_t pcx, uint32_t pcy, bool *pfMemFree)
2160	{
2161	int rc;
2162	if ( aScreenId == VBOX_VIDEO_PRIMARY_SCREEN
2163	&& pDisplay->maFramebuffers[aScreenId].fVBVAEnabled == false) /* A non-VBVA mode. */
2164	{
2165	if (pDisplay->mpDrv)
2166	{
2167	rc = pDisplay->mpDrv->pUpPort->pfnTakeScreenshot(pDisplay->mpDrv->pUpPort, ppbData, pcbData, pcx, pcy);
2168	*pfMemFree = false;
2169	}
2170	else
2171	{
2172	/* No image. */
2173	*ppbData = NULL;
2174	*pcbData = 0;
2175	*pcx = 0;
2176	*pcy = 0;
2177	*pfMemFree = true;
2178	rc = VINF_SUCCESS;
2179	}
2180	}
2181	else if (aScreenId < pDisplay->mcMonitors)
2182	{
2183	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[aScreenId];
2184
2185	uint32_t width = pFBInfo->w;
2186	uint32_t height = pFBInfo->h;
2187
2188	/* Allocate 32 bit per pixel bitmap. */
2189	size_t cbRequired = width * 4 * height;
2190
2191	if (cbRequired)
2192	{
2193	uint8_t pbDst = (uint8_t )RTMemAlloc(cbRequired);
2194	if (pbDst != NULL)
2195	{
2196	if (pFBInfo->flags & VBVA_SCREEN_F_ACTIVE)
2197	{
2198	/* Copy guest VRAM to the allocated 32bpp buffer. */
2199	const uint8_t *pu8Src = pFBInfo->pu8FramebufferVRAM;
2200	int32_t xSrc = 0;
2201	int32_t ySrc = 0;
2202	uint32_t u32SrcWidth = width;
2203	uint32_t u32SrcHeight = height;
2204	uint32_t u32SrcLineSize = pFBInfo->u32LineSize;
2205	uint32_t u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
2206
2207	int32_t xDst = 0;
2208	int32_t yDst = 0;
2209	uint32_t u32DstWidth = u32SrcWidth;
2210	uint32_t u32DstHeight = u32SrcHeight;
2211	uint32_t u32DstLineSize = u32DstWidth * 4;
2212	uint32_t u32DstBitsPerPixel = 32;
2213
2214	rc = pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2215	width, height,
2216	pu8Src,
2217	xSrc, ySrc,
2218	u32SrcWidth, u32SrcHeight,
2219	u32SrcLineSize, u32SrcBitsPerPixel,
2220	pbDst,
2221	xDst, yDst,
2222	u32DstWidth, u32DstHeight,
2223	u32DstLineSize, u32DstBitsPerPixel);
2224	}
2225	else
2226	{
2227	memset(pbDst, 0, cbRequired);
2228	rc = VINF_SUCCESS;
2229	}
2230	if (RT_SUCCESS(rc))
2231	{
2232	*ppbData = pbDst;
2233	*pcbData = cbRequired;
2234	*pcx = width;
2235	*pcy = height;
2236	*pfMemFree = true;
2237	}
2238	else
2239	{
2240	RTMemFree(pbDst);
2241
2242	/* CopyRect can fail if VBVA was paused in VGA device, retry using the generic method. */
2243	if ( rc == VERR_INVALID_STATE
2244	&& aScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2245	{
2246	rc = pDisplay->mpDrv->pUpPort->pfnTakeScreenshot(pDisplay->mpDrv->pUpPort, ppbData, pcbData, pcx, pcy);
2247	*pfMemFree = false;
2248	}
2249	}
2250	}
2251	else
2252	rc = VERR_NO_MEMORY;
2253	}
2254	else
2255	{
2256	/* No image. */
2257	*ppbData = NULL;
2258	*pcbData = 0;
2259	*pcx = 0;
2260	*pcy = 0;
2261	*pfMemFree = true;
2262	rc = VINF_SUCCESS;
2263	}
2264	}
2265	else
2266	rc = VERR_INVALID_PARAMETER;
2267	return rc;
2268	}
2269
2270	static int i_displayTakeScreenshot(PUVM pUVM, Display pDisplay, struct DRVMAINDISPLAY pDrv, ULONG aScreenId,
2271	BYTE *address, ULONG width, ULONG height)
2272	{
2273	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2274	/*
2275	* CrOgl screenshot hook/hack.
2276	*/
2277	if (Display::i_displayCheckTakeScreenshotCrOgl(pDisplay, aScreenId, (uint8_t *)address, width, height))
2278	return VINF_SUCCESS;
2279	#endif
2280
2281	uint8_t *pbData = NULL;
2282	size_t cbData = 0;
2283	uint32_t cx = 0;
2284	uint32_t cy = 0;
2285	bool fFreeMem = false;
2286	int vrc = VINF_SUCCESS;
2287
2288	int cRetries = 5;
2289	while (cRetries-- > 0)
2290	{
2291	/* Note! Not sure if the priority call is such a good idea here, but
2292	it would be nice to have an accurate screenshot for the bug
2293	report if the VM deadlocks. */
2294	vrc = VMR3ReqPriorityCallWaitU(pUVM, VMCPUID_ANY, (PFNRT)Display::i_displayTakeScreenshotEMT, 7,
2295	pDisplay, aScreenId, &pbData, &cbData, &cx, &cy, &fFreeMem);
2296	if (vrc != VERR_TRY_AGAIN)
2297	{
2298	break;
2299	}
2300
2301	RTThreadSleep(10);
2302	}
2303
2304	if (RT_SUCCESS(vrc) && pbData)
2305	{
2306	if (cx == width && cy == height)
2307	{
2308	/* No scaling required. */
2309	memcpy(address, pbData, cbData);
2310	}
2311	else
2312	{
2313	/* Scale. */
2314	LogRelFlowFunc(("SCALE: %dx%d -> %dx%d\n", cx, cy, width, height));
2315
2316	uint8_t *dst = address;
2317	uint8_t *src = pbData;
2318	int dstW = width;
2319	int dstH = height;
2320	int srcW = cx;
2321	int srcH = cy;
2322	int iDeltaLine = cx * 4;
2323
2324	BitmapScale32(dst,
2325	dstW, dstH,
2326	src,
2327	iDeltaLine,
2328	srcW, srcH);
2329	}
2330
2331	if (fFreeMem)
2332	RTMemFree(pbData);
2333	else
2334	{
2335	/* This can be called from any thread. */
2336	pDrv->pUpPort->pfnFreeScreenshot(pDrv->pUpPort, pbData);
2337	}
2338	}
2339
2340	return vrc;
2341	}
2342
2343	HRESULT Display::takeScreenShotWorker(ULONG aScreenId,
2344	BYTE *aAddress,
2345	ULONG aWidth,
2346	ULONG aHeight,
2347	BitmapFormat_T aBitmapFormat,
2348	ULONG *pcbOut)
2349	{
2350	HRESULT rc = S_OK;
2351
2352	/* Do not allow too small and too large screenshots. This also filters out negative
2353	* values passed as either 'aWidth' or 'aHeight'.
2354	*/
2355	CheckComArgExpr(aWidth, aWidth != 0 && aWidth <= 32767);
2356	CheckComArgExpr(aHeight, aHeight != 0 && aHeight <= 32767);
2357
2358	if ( aBitmapFormat != BitmapFormat_BGR0
2359	&& aBitmapFormat != BitmapFormat_BGRA
2360	&& aBitmapFormat != BitmapFormat_RGBA
2361	&& aBitmapFormat != BitmapFormat_PNG)
2362	{
2363	return setError(E_NOTIMPL,
2364	tr("Unsupported screenshot format 0x%08X"), aBitmapFormat);
2365	}
2366
2367	Console::SafeVMPtr ptrVM(mParent);
2368	if (!ptrVM.isOk())
2369	return ptrVM.rc();
2370
2371	int vrc = i_displayTakeScreenshot(ptrVM.rawUVM(), this, mpDrv, aScreenId, aAddress, aWidth, aHeight);
2372
2373	if (RT_SUCCESS(vrc))
2374	{
2375	const size_t cbData = aWidth * 4 * aHeight;
2376
2377	/* Most of uncompressed formats. */
2378	*pcbOut = (ULONG)cbData;
2379
2380	if (aBitmapFormat == BitmapFormat_BGR0)
2381	{
2382	/* Do nothing. */
2383	}
2384	else if (aBitmapFormat == BitmapFormat_BGRA)
2385	{
2386	uint32_t pu32 = (uint32_t )aAddress;
2387	size_t cPixels = aWidth * aHeight;
2388	while (cPixels--)
2389	{
2390	*pu32++ \|= UINT32_C(0xFF000000);
2391	}
2392	}
2393	else if (aBitmapFormat == BitmapFormat_RGBA)
2394	{
2395	uint8_t *pu8 = aAddress;
2396	size_t cPixels = aWidth * aHeight;
2397	while (cPixels--)
2398	{
2399	uint8_t u8 = pu8[0];
2400	pu8[0] = pu8[2];
2401	pu8[2] = u8;
2402	pu8[3] = 0xFF;
2403
2404	pu8 += 4;
2405	}
2406	}
2407	else if (aBitmapFormat == BitmapFormat_PNG)
2408	{
2409	uint8_t *pu8PNG = NULL;
2410	uint32_t cbPNG = 0;
2411	uint32_t cxPNG = 0;
2412	uint32_t cyPNG = 0;
2413
2414	vrc = DisplayMakePNG(aAddress, aWidth, aHeight, &pu8PNG, &cbPNG, &cxPNG, &cyPNG, 0);
2415	if (RT_SUCCESS(vrc))
2416	{
2417	if (cbPNG <= cbData)
2418	{
2419	memcpy(aAddress, pu8PNG, cbPNG);
2420	*pcbOut = cbPNG;
2421	}
2422	else
2423	{
2424	rc = setError(E_FAIL,
2425	tr("PNG is larger than 32bpp bitmap"));
2426	}
2427	}
2428	else
2429	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not convert screenshot to PNG (%Rrc)"), vrc);
2430	RTMemFree(pu8PNG);
2431	}
2432	}
2433	else if (vrc == VERR_TRY_AGAIN)
2434	rc = setErrorBoth(E_UNEXPECTED, vrc, tr("Screenshot is not available at this time"));
2435	else if (RT_FAILURE(vrc))
2436	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not take a screenshot (%Rrc)"), vrc);
2437
2438	return rc;
2439	}
2440
2441	HRESULT Display::takeScreenShot(ULONG aScreenId,
2442	BYTE *aAddress,
2443	ULONG aWidth,
2444	ULONG aHeight,
2445	BitmapFormat_T aBitmapFormat)
2446	{
2447	HRESULT rc = S_OK;
2448
2449	LogRelFlowFunc(("[%d] address=%p, width=%d, height=%d, format 0x%08X\n",
2450	aScreenId, aAddress, aWidth, aHeight, aBitmapFormat));
2451
2452	ULONG cbOut = 0;
2453	rc = takeScreenShotWorker(aScreenId, aAddress, aWidth, aHeight, aBitmapFormat, &cbOut);
2454	NOREF(cbOut);
2455
2456	LogRelFlowFunc(("%Rhrc\n", rc));
2457	return rc;
2458	}
2459
2460	HRESULT Display::takeScreenShotToArray(ULONG aScreenId,
2461	ULONG aWidth,
2462	ULONG aHeight,
2463	BitmapFormat_T aBitmapFormat,
2464	std::vector<BYTE> &aScreenData)
2465	{
2466	HRESULT rc = S_OK;
2467
2468	LogRelFlowFunc(("[%d] width=%d, height=%d, format 0x%08X\n",
2469	aScreenId, aWidth, aHeight, aBitmapFormat));
2470
2471	/* Do not allow too small and too large screenshots. This also filters out negative
2472	* values passed as either 'aWidth' or 'aHeight'.
2473	*/
2474	CheckComArgExpr(aWidth, aWidth != 0 && aWidth <= 32767);
2475	CheckComArgExpr(aHeight, aHeight != 0 && aHeight <= 32767);
2476
2477	const size_t cbData = aWidth * 4 * aHeight;
2478	aScreenData.resize(cbData);
2479
2480	ULONG cbOut = 0;
2481	rc = takeScreenShotWorker(aScreenId, &aScreenData.front(), aWidth, aHeight, aBitmapFormat, &cbOut);
2482	if (FAILED(rc))
2483	cbOut = 0;
2484
2485	aScreenData.resize(cbOut);
2486
2487	LogRelFlowFunc(("%Rhrc\n", rc));
2488	return rc;
2489	}
2490
2491	#ifdef VBOX_WITH_RECORDING
2492	/**
2493	* Invalidates the recording configuration.
2494	*
2495	* @returns IPRT status code.
2496	*/
2497	int Display::i_recordingInvalidate(void)
2498	{
2499	RecordingContext *pCtx = mParent->i_recordingGetContext();
2500	if (!pCtx \|\| !pCtx->IsStarted())
2501	return VINF_SUCCESS;
2502
2503	/*
2504	* Invalidate screens.
2505	*/
2506	for (unsigned uScreen = 0; uScreen < mcMonitors; uScreen++)
2507	{
2508	RecordingStream *pRecordingStream = pCtx->GetStream(uScreen);
2509
2510	const bool fStreamEnabled = pRecordingStream->IsReady();
2511	bool fChanged = maRecordingEnabled[uScreen] != fStreamEnabled;
2512
2513	maRecordingEnabled[uScreen] = fStreamEnabled;
2514
2515	if (fChanged && uScreen < mcMonitors)
2516	i_recordingScreenChanged(uScreen);
2517	}
2518
2519	return VINF_SUCCESS;
2520	}
2521
2522	void Display::i_recordingScreenChanged(unsigned uScreenId)
2523	{
2524	RecordingContext *pCtx = mParent->i_recordingGetContext();
2525
2526	i_UpdateDeviceCursorCapabilities();
2527	if ( RT_LIKELY(!maRecordingEnabled[uScreenId])
2528	\|\| !pCtx \|\| !pCtx->IsStarted())
2529	{
2530	/* Skip recording this screen. */
2531	return;
2532	}
2533
2534	/* Get a new source bitmap which will be used by video recording code. */
2535	ComPtr<IDisplaySourceBitmap> pSourceBitmap;
2536	QuerySourceBitmap(uScreenId, pSourceBitmap.asOutParam());
2537
2538	int rc2 = RTCritSectEnter(&mVideoRecLock);
2539	if (RT_SUCCESS(rc2))
2540	{
2541	maFramebuffers[uScreenId].Recording.pSourceBitmap = pSourceBitmap;
2542
2543	rc2 = RTCritSectLeave(&mVideoRecLock);
2544	AssertRC(rc2);
2545	}
2546	}
2547	#endif /* VBOX_WITH_RECORDING */
2548
2549	int Display::i_drawToScreenEMT(Display pDisplay, ULONG aScreenId, BYTE address,
2550	ULONG x, ULONG y, ULONG width, ULONG height)
2551	{
2552	int rc = VINF_SUCCESS;
2553
2554	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[aScreenId];
2555
2556	if (aScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2557	{
2558	rc = pDisplay->mpDrv->pUpPort->pfnDisplayBlt(pDisplay->mpDrv->pUpPort, address, x, y, width, height);
2559	}
2560	else if (aScreenId < pDisplay->mcMonitors)
2561	{
2562	/* Copy the bitmap to the guest VRAM. */
2563	const uint8_t *pu8Src = address;
2564	int32_t xSrc = 0;
2565	int32_t ySrc = 0;
2566	uint32_t u32SrcWidth = width;
2567	uint32_t u32SrcHeight = height;
2568	uint32_t u32SrcLineSize = width * 4;
2569	uint32_t u32SrcBitsPerPixel = 32;
2570
2571	uint8_t *pu8Dst = pFBInfo->pu8FramebufferVRAM;
2572	int32_t xDst = x;
2573	int32_t yDst = y;
2574	uint32_t u32DstWidth = pFBInfo->w;
2575	uint32_t u32DstHeight = pFBInfo->h;
2576	uint32_t u32DstLineSize = pFBInfo->u32LineSize;
2577	uint32_t u32DstBitsPerPixel = pFBInfo->u16BitsPerPixel;
2578
2579	rc = pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2580	width, height,
2581	pu8Src,
2582	xSrc, ySrc,
2583	u32SrcWidth, u32SrcHeight,
2584	u32SrcLineSize, u32SrcBitsPerPixel,
2585	pu8Dst,
2586	xDst, yDst,
2587	u32DstWidth, u32DstHeight,
2588	u32DstLineSize, u32DstBitsPerPixel);
2589	if (RT_SUCCESS(rc))
2590	{
2591	if (!pFBInfo->pSourceBitmap.isNull())
2592	{
2593	/* Update the changed screen area. When source bitmap uses VRAM directly, just notify
2594	* frontend to update. And for default format, render the guest VRAM to the source bitmap.
2595	*/
2596	if ( pFBInfo->fDefaultFormat
2597	&& !pFBInfo->fDisabled)
2598	{
2599	BYTE *pAddress = NULL;
2600	ULONG ulWidth = 0;
2601	ULONG ulHeight = 0;
2602	ULONG ulBitsPerPixel = 0;
2603	ULONG ulBytesPerLine = 0;
2604	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
2605
2606	HRESULT hrc = pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
2607	&ulWidth,
2608	&ulHeight,
2609	&ulBitsPerPixel,
2610	&ulBytesPerLine,
2611	&bitmapFormat);
2612	if (SUCCEEDED(hrc))
2613	{
2614	pu8Src = pFBInfo->pu8FramebufferVRAM;
2615	xSrc = x;
2616	ySrc = y;
2617	u32SrcWidth = pFBInfo->w;
2618	u32SrcHeight = pFBInfo->h;
2619	u32SrcLineSize = pFBInfo->u32LineSize;
2620	u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
2621
2622	/* Default format is 32 bpp. */
2623	pu8Dst = pAddress;
2624	xDst = xSrc;
2625	yDst = ySrc;
2626	u32DstWidth = u32SrcWidth;
2627	u32DstHeight = u32SrcHeight;
2628	u32DstLineSize = u32DstWidth * 4;
2629	u32DstBitsPerPixel = 32;
2630
2631	pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2632	width, height,
2633	pu8Src,
2634	xSrc, ySrc,
2635	u32SrcWidth, u32SrcHeight,
2636	u32SrcLineSize, u32SrcBitsPerPixel,
2637	pu8Dst,
2638	xDst, yDst,
2639	u32DstWidth, u32DstHeight,
2640	u32DstLineSize, u32DstBitsPerPixel);
2641	}
2642	}
2643	}
2644
2645	pDisplay->i_handleDisplayUpdate(aScreenId, x, y, width, height);
2646	}
2647	}
2648	else
2649	{
2650	rc = VERR_INVALID_PARAMETER;
2651	}
2652
2653	if (RT_SUCCESS(rc))
2654	pDisplay->mParent->i_consoleVRDPServer()->SendUpdateBitmap(aScreenId, x, y, width, height);
2655
2656	return rc;
2657	}
2658
2659	HRESULT Display::drawToScreen(ULONG aScreenId, BYTE *aAddress, ULONG aX, ULONG aY, ULONG aWidth, ULONG aHeight)
2660	{
2661	/// @todo (r=dmik) this function may take too long to complete if the VM
2662	// is doing something like saving state right now. Which, in case if it
2663	// is called on the GUI thread, will make it unresponsive. We should
2664	// check the machine state here (by enclosing the check and VMRequCall
2665	// within the Console lock to make it atomic).
2666
2667	LogRelFlowFunc(("aAddress=%p, x=%d, y=%d, width=%d, height=%d\n",
2668	(void *)aAddress, aX, aY, aWidth, aHeight));
2669
2670	CheckComArgExpr(aWidth, aWidth != 0);
2671	CheckComArgExpr(aHeight, aHeight != 0);
2672
2673	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2674
2675	CHECK_CONSOLE_DRV(mpDrv);
2676
2677	Console::SafeVMPtr ptrVM(mParent);
2678	if (!ptrVM.isOk())
2679	return ptrVM.rc();
2680
2681	/* Release lock because the call scheduled on EMT may also try to take it. */
2682	alock.release();
2683
2684	/*
2685	* Again we're lazy and make the graphics device do all the
2686	* dirty conversion work.
2687	*/
2688	int vrc = VMR3ReqCallWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_drawToScreenEMT, 7,
2689	this, aScreenId, aAddress, aX, aY, aWidth, aHeight);
2690
2691	/*
2692	* If the function returns not supported, we'll have to do all the
2693	* work ourselves using the framebuffer.
2694	*/
2695	HRESULT rc = S_OK;
2696	if (vrc == VERR_NOT_SUPPORTED \|\| vrc == VERR_NOT_IMPLEMENTED)
2697	{
2698	/** @todo implement generic fallback for screen blitting. */
2699	rc = E_NOTIMPL;
2700	}
2701	else if (RT_FAILURE(vrc))
2702	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not draw to the screen (%Rrc)"), vrc);
2703	/// @todo
2704	// else
2705	// {
2706	// /* All ok. Redraw the screen. */
2707	// handleDisplayUpdate(x, y, width, height);
2708	// }
2709
2710	LogRelFlowFunc(("rc=%Rhrc\n", rc));
2711	return rc;
2712	}
2713
2714	int Display::i_InvalidateAndUpdateEMT(Display *pDisplay, unsigned uId, bool fUpdateAll)
2715	{
2716	LogRelFlowFunc(("uId=%d, fUpdateAll %d\n", uId, fUpdateAll));
2717
2718	unsigned uScreenId;
2719	for (uScreenId = (fUpdateAll ? 0 : uId); uScreenId < pDisplay->mcMonitors; uScreenId++)
2720	{
2721	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[uScreenId];
2722
2723	if ( !pFBInfo->fVBVAEnabled
2724	&& uScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2725	{
2726	pDisplay->mpDrv->pUpPort->pfnUpdateDisplayAll(pDisplay->mpDrv->pUpPort, /* fFailOnResize = */ true);
2727	}
2728	else
2729	{
2730	if (!pFBInfo->fDisabled)
2731	{
2732	/* Render complete VRAM screen to the framebuffer.
2733	* When framebuffer uses VRAM directly, just notify it to update.
2734	*/
2735	if (pFBInfo->fDefaultFormat && !pFBInfo->pSourceBitmap.isNull())
2736	{
2737	BYTE *pAddress = NULL;
2738	ULONG ulWidth = 0;
2739	ULONG ulHeight = 0;
2740	ULONG ulBitsPerPixel = 0;
2741	ULONG ulBytesPerLine = 0;
2742	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
2743
2744	HRESULT hrc = pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
2745	&ulWidth,
2746	&ulHeight,
2747	&ulBitsPerPixel,
2748	&ulBytesPerLine,
2749	&bitmapFormat);
2750	if (SUCCEEDED(hrc))
2751	{
2752	uint32_t width = pFBInfo->w;
2753	uint32_t height = pFBInfo->h;
2754
2755	const uint8_t *pu8Src = pFBInfo->pu8FramebufferVRAM;
2756	int32_t xSrc = 0;
2757	int32_t ySrc = 0;
2758	uint32_t u32SrcWidth = pFBInfo->w;
2759	uint32_t u32SrcHeight = pFBInfo->h;
2760	uint32_t u32SrcLineSize = pFBInfo->u32LineSize;
2761	uint32_t u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
2762
2763	/* Default format is 32 bpp. */
2764	uint8_t *pu8Dst = pAddress;
2765	int32_t xDst = xSrc;
2766	int32_t yDst = ySrc;
2767	uint32_t u32DstWidth = u32SrcWidth;
2768	uint32_t u32DstHeight = u32SrcHeight;
2769	uint32_t u32DstLineSize = u32DstWidth * 4;
2770	uint32_t u32DstBitsPerPixel = 32;
2771
2772	/* if uWidth != pFBInfo->w and uHeight != pFBInfo->h
2773	* implies resize of Framebuffer is in progress and
2774	* copyrect should not be called.
2775	*/
2776	if (ulWidth == pFBInfo->w && ulHeight == pFBInfo->h)
2777	{
2778	pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2779	width, height,
2780	pu8Src,
2781	xSrc, ySrc,
2782	u32SrcWidth, u32SrcHeight,
2783	u32SrcLineSize, u32SrcBitsPerPixel,
2784	pu8Dst,
2785	xDst, yDst,
2786	u32DstWidth, u32DstHeight,
2787	u32DstLineSize, u32DstBitsPerPixel);
2788	}
2789	}
2790	}
2791
2792	pDisplay->i_handleDisplayUpdate(uScreenId, 0, 0, pFBInfo->w, pFBInfo->h);
2793	}
2794	}
2795	if (!fUpdateAll)
2796	break;
2797	}
2798	LogRelFlowFunc(("done\n"));
2799	return VINF_SUCCESS;
2800	}
2801
2802	/**
2803	* Does a full invalidation of the VM display and instructs the VM
2804	* to update it immediately.
2805	*
2806	* @returns COM status code
2807	*/
2808
2809	HRESULT Display::invalidateAndUpdate()
2810	{
2811	LogRelFlowFunc(("\n"));
2812
2813	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2814
2815	CHECK_CONSOLE_DRV(mpDrv);
2816
2817	Console::SafeVMPtr ptrVM(mParent);
2818	if (!ptrVM.isOk())
2819	return ptrVM.rc();
2820
2821	HRESULT rc = S_OK;
2822
2823	LogRelFlowFunc(("Sending DPYUPDATE request\n"));
2824
2825	/* Have to release the lock when calling EMT. */
2826	alock.release();
2827
2828	int vrc = VMR3ReqCallNoWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_InvalidateAndUpdateEMT,
2829	3, this, 0, true);
2830	alock.acquire();
2831
2832	if (RT_FAILURE(vrc))
2833	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not invalidate and update the screen (%Rrc)"), vrc);
2834
2835	LogRelFlowFunc(("rc=%Rhrc\n", rc));
2836	return rc;
2837	}
2838
2839	HRESULT Display::invalidateAndUpdateScreen(ULONG aScreenId)
2840	{
2841	LogRelFlowFunc(("\n"));
2842
2843	HRESULT rc = S_OK;
2844
2845	Console::SafeVMPtr ptrVM(mParent);
2846	if (!ptrVM.isOk())
2847	return ptrVM.rc();
2848
2849	int vrc = VMR3ReqCallNoWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_InvalidateAndUpdateEMT,
2850	3, this, aScreenId, false);
2851	if (RT_FAILURE(vrc))
2852	rc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("Could not invalidate and update the screen %d (%Rrc)"), aScreenId, vrc);
2853
2854	LogRelFlowFunc(("rc=%Rhrc\n", rc));
2855	return rc;
2856	}
2857
2858	HRESULT Display::completeVHWACommand(BYTE *aCommand)
2859	{
2860	#ifdef VBOX_WITH_VIDEOHWACCEL
2861	mpDrv->pVBVACallbacks->pfnVHWACommandCompleteAsync(mpDrv->pVBVACallbacks, (VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *)aCommand);
2862	return S_OK;
2863	#else
2864	return E_NOTIMPL;
2865	#endif
2866	}
2867
2868	HRESULT Display::viewportChanged(ULONG aScreenId, ULONG aX, ULONG aY, ULONG aWidth, ULONG aHeight)
2869	{
2870	AssertMsgReturn(aScreenId < mcMonitors, ("aScreendId=%d mcMonitors=%d\n", aScreenId, mcMonitors), E_INVALIDARG);
2871
2872	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2873	if (mfIsCr3DEnabled)
2874	{
2875	int rc = i_crViewportNotify(aScreenId, aX, aY, aWidth, aHeight);
2876	if (RT_FAILURE(rc))
2877	{
2878	DISPLAYFBINFO *pFb = &maFramebuffers[aScreenId];
2879	pFb->pendingViewportInfo.fPending = true;
2880	pFb->pendingViewportInfo.x = aX;
2881	pFb->pendingViewportInfo.y = aY;
2882	pFb->pendingViewportInfo.width = aWidth;
2883	pFb->pendingViewportInfo.height = aHeight;
2884	}
2885	}
2886	#endif /* VBOX_WITH_CROGL && VBOX_WITH_HGCM */
2887
2888	/* The driver might not have been constructed yet */
2889	if (mpDrv && mpDrv->pUpPort->pfnSetViewport)
2890	mpDrv->pUpPort->pfnSetViewport(mpDrv->pUpPort, aScreenId, aX, aY, aWidth, aHeight);
2891
2892	return S_OK;
2893	}
2894
2895	HRESULT Display::querySourceBitmap(ULONG aScreenId,
2896	ComPtr<IDisplaySourceBitmap> &aDisplaySourceBitmap)
2897	{
2898	LogRelFlowFunc(("aScreenId = %d\n", aScreenId));
2899
2900	Console::SafeVMPtr ptrVM(mParent);
2901	if (!ptrVM.isOk())
2902	return ptrVM.rc();
2903
2904	CHECK_CONSOLE_DRV(mpDrv);
2905
2906	bool fSetRenderVRAM = false;
2907	bool fInvalidate = false;
2908
2909	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2910
2911	if (aScreenId >= mcMonitors)
2912	return setError(E_INVALIDARG, tr("QuerySourceBitmap: Invalid screen %d (total %d)"),
2913	aScreenId, mcMonitors);
2914
2915	if (!mfSourceBitmapEnabled)
2916	{
2917	aDisplaySourceBitmap = NULL;
2918	return E_FAIL;
2919	}
2920
2921	DISPLAYFBINFO *pFBInfo = &maFramebuffers[aScreenId];
2922
2923	/* No source bitmap for a blank guest screen. */
2924	if (pFBInfo->flags & VBVA_SCREEN_F_BLANK)
2925	{
2926	aDisplaySourceBitmap = NULL;
2927	return E_FAIL;
2928	}
2929
2930	HRESULT hr = S_OK;
2931
2932	if (pFBInfo->pSourceBitmap.isNull())
2933	{
2934	/* Create a new object. */
2935	ComObjPtr<DisplaySourceBitmap> obj;
2936	hr = obj.createObject();
2937	if (SUCCEEDED(hr))
2938	hr = obj->init(this, aScreenId, pFBInfo);
2939
2940	if (SUCCEEDED(hr))
2941	{
2942	pFBInfo->pSourceBitmap = obj;
2943	pFBInfo->fDefaultFormat = !obj->i_usesVRAM();
2944
2945	if (aScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2946	{
2947	/* Start buffer updates. */
2948	BYTE *pAddress = NULL;
2949	ULONG ulWidth = 0;
2950	ULONG ulHeight = 0;
2951	ULONG ulBitsPerPixel = 0;
2952	ULONG ulBytesPerLine = 0;
2953	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
2954
2955	pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
2956	&ulWidth,
2957	&ulHeight,
2958	&ulBitsPerPixel,
2959	&ulBytesPerLine,
2960	&bitmapFormat);
2961
2962	mpDrv->IConnector.pbData = pAddress;
2963	mpDrv->IConnector.cbScanline = ulBytesPerLine;
2964	mpDrv->IConnector.cBits = ulBitsPerPixel;
2965	mpDrv->IConnector.cx = ulWidth;
2966	mpDrv->IConnector.cy = ulHeight;
2967
2968	fSetRenderVRAM = pFBInfo->fDefaultFormat;
2969	}
2970
2971	/* Make sure that the bitmap contains the latest image. */
2972	fInvalidate = pFBInfo->fDefaultFormat;
2973	}
2974	}
2975
2976	if (SUCCEEDED(hr))
2977	{
2978	pFBInfo->pSourceBitmap.queryInterfaceTo(aDisplaySourceBitmap.asOutParam());
2979	}
2980
2981	/* Leave the IDisplay lock because the VGA device must not be called under it. */
2982	alock.release();
2983
2984	if (SUCCEEDED(hr))
2985	{
2986	if (fSetRenderVRAM)
2987	{
2988	mpDrv->pUpPort->pfnSetRenderVRAM(mpDrv->pUpPort, true);
2989	}
2990
2991	if (fInvalidate)
2992	VMR3ReqCallWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_InvalidateAndUpdateEMT,
2993	3, this, aScreenId, false);
2994	}
2995
2996	LogRelFlowFunc(("%Rhrc\n", hr));
2997	return hr;
2998	}
2999
3000	HRESULT Display::getGuestScreenLayout(std::vector<ComPtr<IGuestScreenInfo> > &aGuestScreenLayout)
3001	{
3002	NOREF(aGuestScreenLayout);
3003	return E_NOTIMPL;
3004	}
3005
3006	HRESULT Display::setScreenLayout(ScreenLayoutMode_T aScreenLayoutMode,
3007	const std::vector<ComPtr<IGuestScreenInfo> > &aGuestScreenInfo)
3008	{
3009	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3010
3011	if (aGuestScreenInfo.size() != mcMonitors)
3012	return E_INVALIDARG;
3013
3014	CHECK_CONSOLE_DRV(mpDrv);
3015
3016	/*
3017	* It is up to the guest to decide whether the hint is
3018	* valid. Therefore don't do any VRAM sanity checks here.
3019	*/
3020
3021	/* Have to release the lock because the pfnRequestDisplayChange
3022	* will call EMT. */
3023	alock.release();
3024
3025	VMMDev *pVMMDev = mParent->i_getVMMDev();
3026	if (pVMMDev)
3027	{
3028	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
3029	if (pVMMDevPort)
3030	{
3031	uint32_t const cDisplays = (uint32_t)aGuestScreenInfo.size();
3032
3033	size_t const cbAlloc = cDisplays * sizeof(VMMDevDisplayDef);
3034	VMMDevDisplayDef paDisplayDefs = (VMMDevDisplayDef )RTMemAlloc(cbAlloc);
3035	if (paDisplayDefs)
3036	{
3037	for (uint32_t i = 0; i < cDisplays; ++i)
3038	{
3039	VMMDevDisplayDef *p = &paDisplayDefs[i];
3040	ComPtr<IGuestScreenInfo> pScreenInfo = aGuestScreenInfo[i];
3041
3042	ULONG screenId = 0;
3043	GuestMonitorStatus_T guestMonitorStatus = GuestMonitorStatus_Enabled;
3044	BOOL origin = FALSE;
3045	BOOL primary = FALSE;
3046	LONG originX = 0;
3047	LONG originY = 0;
3048	ULONG width = 0;
3049	ULONG height = 0;
3050	ULONG bitsPerPixel = 0;
3051
3052	pScreenInfo->COMGETTER(ScreenId) (&screenId);
3053	pScreenInfo->COMGETTER(GuestMonitorStatus)(&guestMonitorStatus);
3054	pScreenInfo->COMGETTER(Primary) (&primary);
3055	pScreenInfo->COMGETTER(Origin) (&origin);
3056	pScreenInfo->COMGETTER(OriginX) (&originX);
3057	pScreenInfo->COMGETTER(OriginY) (&originY);
3058	pScreenInfo->COMGETTER(Width) (&width);
3059	pScreenInfo->COMGETTER(Height) (&height);
3060	pScreenInfo->COMGETTER(BitsPerPixel)(&bitsPerPixel);
3061
3062	LogFlowFunc(("%d %d,%d %dx%d\n", screenId, originX, originY, width, height));
3063
3064	p->idDisplay = screenId;
3065	p->xOrigin = originX;
3066	p->yOrigin = originY;
3067	p->cx = width;
3068	p->cy = height;
3069	p->cBitsPerPixel = bitsPerPixel;
3070	p->fDisplayFlags = VMMDEV_DISPLAY_CX \| VMMDEV_DISPLAY_CY \| VMMDEV_DISPLAY_BPP;
3071	if (guestMonitorStatus == GuestMonitorStatus_Disabled)
3072	p->fDisplayFlags \|= VMMDEV_DISPLAY_DISABLED;
3073	if (origin)
3074	p->fDisplayFlags \|= VMMDEV_DISPLAY_ORIGIN;
3075	if (primary)
3076	p->fDisplayFlags \|= VMMDEV_DISPLAY_PRIMARY;
3077	}
3078
3079	bool const fForce = aScreenLayoutMode == ScreenLayoutMode_Reset
3080	\|\| aScreenLayoutMode == ScreenLayoutMode_Apply;
3081	pVMMDevPort->pfnRequestDisplayChange(pVMMDevPort, cDisplays, paDisplayDefs, fForce);
3082
3083	RTMemFree(paDisplayDefs);
3084	}
3085	}
3086	}
3087	return S_OK;
3088	}
3089
3090	HRESULT Display::detachScreens(const std::vector<LONG> &aScreenIds)
3091	{
3092	NOREF(aScreenIds);
3093	return E_NOTIMPL;
3094	}
3095
3096	HRESULT Display::createGuestScreenInfo(ULONG aDisplay,
3097	GuestMonitorStatus_T aStatus,
3098	BOOL aPrimary,
3099	BOOL aChangeOrigin,
3100	LONG aOriginX,
3101	LONG aOriginY,
3102	ULONG aWidth,
3103	ULONG aHeight,
3104	ULONG aBitsPerPixel,
3105	ComPtr<IGuestScreenInfo> &aGuestScreenInfo)
3106	{
3107	/* Create a new object. */
3108	ComObjPtr<GuestScreenInfo> obj;
3109	HRESULT hr = obj.createObject();
3110	if (SUCCEEDED(hr))
3111	hr = obj->init(aDisplay, aStatus, aPrimary, aChangeOrigin, aOriginX, aOriginY,
3112	aWidth, aHeight, aBitsPerPixel);
3113	if (SUCCEEDED(hr))
3114	obj.queryInterfaceTo(aGuestScreenInfo.asOutParam());
3115
3116	return hr;
3117	}
3118
3119
3120	/*
3121	* GuestScreenInfo implementation.
3122	*/
3123	DEFINE_EMPTY_CTOR_DTOR(GuestScreenInfo)
3124
3125	HRESULT GuestScreenInfo::FinalConstruct()
3126	{
3127	return BaseFinalConstruct();
3128	}
3129
3130	void GuestScreenInfo::FinalRelease()
3131	{
3132	uninit();
3133
3134	BaseFinalRelease();
3135	}
3136
3137	HRESULT GuestScreenInfo::init(ULONG aDisplay,
3138	GuestMonitorStatus_T aGuestMonitorStatus,
3139	BOOL aPrimary,
3140	BOOL aChangeOrigin,
3141	LONG aOriginX,
3142	LONG aOriginY,
3143	ULONG aWidth,
3144	ULONG aHeight,
3145	ULONG aBitsPerPixel)
3146	{
3147	LogFlowThisFunc(("[%u]\n", aDisplay));
3148
3149	/* Enclose the state transition NotReady->InInit->Ready */
3150	AutoInitSpan autoInitSpan(this);
3151	AssertReturn(autoInitSpan.isOk(), E_FAIL);
3152
3153	mScreenId = aDisplay;
3154	mGuestMonitorStatus = aGuestMonitorStatus;
3155	mPrimary = aPrimary;
3156	mOrigin = aChangeOrigin;
3157	mOriginX = aOriginX;
3158	mOriginY = aOriginY;
3159	mWidth = aWidth;
3160	mHeight = aHeight;
3161	mBitsPerPixel = aBitsPerPixel;
3162
3163	/* Confirm a successful initialization */
3164	autoInitSpan.setSucceeded();
3165
3166	return S_OK;
3167	}
3168
3169	void GuestScreenInfo::uninit()
3170	{
3171	/* Enclose the state transition Ready->InUninit->NotReady */
3172	AutoUninitSpan autoUninitSpan(this);
3173	if (autoUninitSpan.uninitDone())
3174	return;
3175
3176	LogFlowThisFunc(("[%u]\n", mScreenId));
3177	}
3178
3179	HRESULT GuestScreenInfo::getScreenId(ULONG *aScreenId)
3180	{
3181	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3182	*aScreenId = mScreenId;
3183	return S_OK;
3184	}
3185
3186	HRESULT GuestScreenInfo::getGuestMonitorStatus(GuestMonitorStatus_T *aGuestMonitorStatus)
3187	{
3188	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3189	*aGuestMonitorStatus = mGuestMonitorStatus;
3190	return S_OK;
3191	}
3192
3193	HRESULT GuestScreenInfo::getPrimary(BOOL *aPrimary)
3194	{
3195	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3196	*aPrimary = mPrimary;
3197	return S_OK;
3198	}
3199
3200	HRESULT GuestScreenInfo::getOrigin(BOOL *aOrigin)
3201	{
3202	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3203	*aOrigin = mOrigin;
3204	return S_OK;
3205	}
3206
3207	HRESULT GuestScreenInfo::getOriginX(LONG *aOriginX)
3208	{
3209	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3210	*aOriginX = mOriginX;
3211	return S_OK;
3212	}
3213
3214	HRESULT GuestScreenInfo::getOriginY(LONG *aOriginY)
3215	{
3216	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3217	*aOriginY = mOriginY;
3218	return S_OK;
3219	}
3220
3221	HRESULT GuestScreenInfo::getWidth(ULONG *aWidth)
3222	{
3223	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3224	*aWidth = mWidth;
3225	return S_OK;
3226	}
3227
3228	HRESULT GuestScreenInfo::getHeight(ULONG *aHeight)
3229	{
3230	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3231	*aHeight = mHeight;
3232	return S_OK;
3233	}
3234
3235	HRESULT GuestScreenInfo::getBitsPerPixel(ULONG *aBitsPerPixel)
3236	{
3237	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3238	*aBitsPerPixel = mBitsPerPixel;
3239	return S_OK;
3240	}
3241
3242	HRESULT GuestScreenInfo::getExtendedInfo(com::Utf8Str &aExtendedInfo)
3243	{
3244	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3245	aExtendedInfo = com::Utf8Str();
3246	return S_OK;
3247	}
3248
3249	// wrapped IEventListener method
3250	HRESULT Display::handleEvent(const ComPtr<IEvent> &aEvent)
3251	{
3252	VBoxEventType_T aType = VBoxEventType_Invalid;
3253
3254	aEvent->COMGETTER(Type)(&aType);
3255	switch (aType)
3256	{
3257	case VBoxEventType_OnStateChanged:
3258	{
3259	ComPtr<IStateChangedEvent> scev = aEvent;
3260	Assert(scev);
3261	MachineState_T machineState;
3262	scev->COMGETTER(State)(&machineState);
3263	if ( machineState == MachineState_Running
3264	\|\| machineState == MachineState_Teleporting
3265	\|\| machineState == MachineState_LiveSnapshotting
3266	\|\| machineState == MachineState_DeletingSnapshotOnline
3267	)
3268	{
3269	LogRelFlowFunc(("Machine is running.\n"));
3270
3271	#ifdef VBOX_WITH_CROGL
3272	i_crOglWindowsShow(true);
3273	#endif
3274	}
3275	else
3276	{
3277	#ifdef VBOX_WITH_CROGL
3278	if (machineState == MachineState_Paused)
3279	i_crOglWindowsShow(false);
3280	#endif
3281	}
3282	break;
3283	}
3284	default:
3285	AssertFailed();
3286	}
3287
3288	return S_OK;
3289	}
3290
3291
3292	// private methods
3293	/////////////////////////////////////////////////////////////////////////////
3294
3295	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3296	int Display::i_crViewportNotify(ULONG aScreenId, ULONG x, ULONG y, ULONG width, ULONG height)
3297	{
3298	VMMDev *pVMMDev = mParent->i_getVMMDev();
3299	if (!pVMMDev)
3300	return VERR_INVALID_STATE;
3301
3302	size_t cbData = RT_UOFFSETOF_DYN(VBOXCRCMDCTL_HGCM, aParms[5]); /* (clang doesn't think this is a POD, thus _DYN.) */
3303	VBOXCRCMDCTL_HGCM pData = (VBOXCRCMDCTL_HGCM )alloca(cbData);
3304
3305	pData->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
3306	pData->Hdr.u32Function = SHCRGL_HOST_FN_VIEWPORT_CHANGED;
3307
3308	pData->aParms[0].type = VBOX_HGCM_SVC_PARM_32BIT;
3309	pData->aParms[0].u.uint32 = aScreenId;
3310
3311	pData->aParms[1].type = VBOX_HGCM_SVC_PARM_32BIT;
3312	pData->aParms[1].u.uint32 = x;
3313
3314	pData->aParms[2].type = VBOX_HGCM_SVC_PARM_32BIT;
3315	pData->aParms[2].u.uint32 = y;
3316
3317	pData->aParms[3].type = VBOX_HGCM_SVC_PARM_32BIT;
3318	pData->aParms[3].u.uint32 = width;
3319
3320	pData->aParms[4].type = VBOX_HGCM_SVC_PARM_32BIT;
3321	pData->aParms[4].u.uint32 = height;
3322
3323	return i_crCtlSubmitSyncIfHasDataForScreen(aScreenId, &pData->Hdr, (uint32_t)cbData);
3324	}
3325	#endif
3326	#ifdef VBOX_WITH_CRHGSMI
3327
3328	void Display::i_setupCrHgsmiData(void)
3329	{
3330	VMMDev *pVMMDev = mParent->i_getVMMDev();
3331	Assert(pVMMDev);
3332	int rc = RTCritSectRwEnterExcl(&mCrOglLock);
3333	AssertRC(rc);
3334
3335	if (pVMMDev)
3336	rc = pVMMDev->hgcmHostSvcHandleCreate("VBoxSharedCrOpenGL", &mhCrOglSvc);
3337	else
3338	rc = VERR_GENERAL_FAILURE;
3339
3340	if (RT_SUCCESS(rc))
3341	{
3342	Assert(mhCrOglSvc);
3343	/* setup command completion callback */
3344	VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_MAINCB Completion;
3345	Completion.Hdr.enmType = VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP_MAINCB;
3346	Completion.Hdr.cbCmd = sizeof(Completion);
3347	Completion.hCompletion = mpDrv->pVBVACallbacks;
3348	Completion.pfnCompletion = mpDrv->pVBVACallbacks->pfnCrHgsmiCommandCompleteAsync;
3349
3350	VBOXHGCMSVCPARM parm;
3351	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3352	parm.u.pointer.addr = &Completion;
3353	parm.u.pointer.size = 0;
3354
3355	rc = pVMMDev->hgcmHostCall("VBoxSharedCrOpenGL", SHCRGL_HOST_FN_CRHGSMI_CTL, 1, &parm);
3356	if (RT_SUCCESS(rc))
3357	mCrOglCallbacks = Completion.MainInterface;
3358	else
3359	AssertMsgFailed(("VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP_COMPLETION failed (rc=%Rrc)\n", rc));
3360	}
3361
3362	if (RT_FAILURE(rc))
3363	mhCrOglSvc = NULL;
3364
3365	RTCritSectRwLeaveExcl(&mCrOglLock);
3366	}
3367
3368	void Display::i_destructCrHgsmiData(void)
3369	{
3370	int rc = RTCritSectRwEnterExcl(&mCrOglLock);
3371	AssertRC(rc);
3372	mhCrOglSvc = NULL;
3373	RTCritSectRwLeaveExcl(&mCrOglLock);
3374	}
3375
3376	#endif /* VBOX_WITH_CRHGSMI */
3377
3378	/**
3379	* Handle display resize event issued by the VGA device for the primary screen.
3380	*
3381	* @see PDMIDISPLAYCONNECTOR::pfnResize
3382	*/
3383	DECLCALLBACK(int) Display::i_displayResizeCallback(PPDMIDISPLAYCONNECTOR pInterface,
3384	uint32_t bpp, void *pvVRAM, uint32_t cbLine, uint32_t cx, uint32_t cy)
3385	{
3386	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3387	Display *pThis = pDrv->pDisplay;
3388
3389	LogRelFlowFunc(("bpp %d, pvVRAM %p, cbLine %d, cx %d, cy %d\n",
3390	bpp, pvVRAM, cbLine, cx, cy));
3391
3392	bool f = ASMAtomicCmpXchgBool(&pThis->fVGAResizing, true, false);
3393	if (!f)
3394	{
3395	/* This is a result of recursive call when the source bitmap is being updated
3396	* during a VGA resize. Tell the VGA device to ignore the call.
3397	*
3398	* @todo It is a workaround, actually pfnUpdateDisplayAll must
3399	* fail on resize.
3400	*/
3401	LogRel(("displayResizeCallback: already processing\n"));
3402	return VINF_VGA_RESIZE_IN_PROGRESS;
3403	}
3404
3405	int rc = pThis->i_handleDisplayResize(VBOX_VIDEO_PRIMARY_SCREEN, bpp, pvVRAM, cbLine, cx, cy, 0, 0, 0, true);
3406
3407	/* Restore the flag. */
3408	f = ASMAtomicCmpXchgBool(&pThis->fVGAResizing, false, true);
3409	AssertRelease(f);
3410
3411	return rc;
3412	}
3413
3414	/**
3415	* Handle display update.
3416	*
3417	* @see PDMIDISPLAYCONNECTOR::pfnUpdateRect
3418	*/
3419	DECLCALLBACK(void) Display::i_displayUpdateCallback(PPDMIDISPLAYCONNECTOR pInterface,
3420	uint32_t x, uint32_t y, uint32_t cx, uint32_t cy)
3421	{
3422	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3423
3424	#ifdef DEBUG_sunlover
3425	LogFlowFunc(("fVideoAccelEnabled = %d, %d,%d %dx%d\n",
3426	pDrv->pDisplay->mVideoAccelLegacy.fVideoAccelEnabled, x, y, cx, cy));
3427	#endif /* DEBUG_sunlover */
3428
3429	/* This call does update regardless of VBVA status.
3430	* But in VBVA mode this is called only as result of
3431	* pfnUpdateDisplayAll in the VGA device.
3432	*/
3433
3434	pDrv->pDisplay->i_handleDisplayUpdate(VBOX_VIDEO_PRIMARY_SCREEN, x, y, cx, cy);
3435	}
3436
3437	/**
3438	* Periodic display refresh callback.
3439	*
3440	* @see PDMIDISPLAYCONNECTOR::pfnRefresh
3441	* @thread EMT
3442	*/
3443	/static/ DECLCALLBACK(void) Display::i_displayRefreshCallback(PPDMIDISPLAYCONNECTOR pInterface)
3444	{
3445	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3446
3447	#ifdef DEBUG_sunlover_2
3448	LogFlowFunc(("pDrv->pDisplay->mfVideoAccelEnabled = %d\n",
3449	pDrv->pDisplay->mfVideoAccelEnabled));
3450	#endif /* DEBUG_sunlover_2 */
3451
3452	Display *pDisplay = pDrv->pDisplay;
3453	unsigned uScreenId;
3454
3455	int rc = pDisplay->i_videoAccelRefreshProcess(pDrv->pUpPort);
3456	if (rc != VINF_TRY_AGAIN) /* Means 'do nothing' here. */
3457	{
3458	if (rc == VWRN_INVALID_STATE)
3459	{
3460	/* No VBVA do a display update. */
3461	pDrv->pUpPort->pfnUpdateDisplay(pDrv->pUpPort);
3462	}
3463
3464	/* Inform the VRDP server that the current display update sequence is
3465	* completed. At this moment the framebuffer memory contains a definite
3466	* image, that is synchronized with the orders already sent to VRDP client.
3467	* The server can now process redraw requests from clients or initial
3468	* fullscreen updates for new clients.
3469	*/
3470	for (uScreenId = 0; uScreenId < pDisplay->mcMonitors; uScreenId++)
3471	{
3472	Assert(pDisplay->mParent && pDisplay->mParent->i_consoleVRDPServer());
3473	pDisplay->mParent->i_consoleVRDPServer()->SendUpdate(uScreenId, NULL, 0);
3474	}
3475	}
3476
3477	#ifdef VBOX_WITH_RECORDING
3478	AssertPtr(pDisplay->mParent);
3479	RecordingContext *pCtx = pDisplay->mParent->i_recordingGetContext();
3480
3481	if ( pCtx
3482	&& pCtx->IsStarted()
3483	&& pCtx->IsFeatureEnabled(RecordingFeature_Video))
3484	{
3485	do {
3486	# if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3487	if (pDisplay->mfIsCr3DEnabled)
3488	{
3489	if (ASMAtomicCmpXchgU32(&pDisplay->mfCrOglVideoRecState, CRVREC_STATE_SUBMITTED, CRVREC_STATE_IDLE))
3490	{
3491	if ( pDisplay->mCrOglCallbacks.pfnHasData
3492	&& pDisplay->mCrOglCallbacks.pfnHasData())
3493	{
3494	/* submit */
3495	VBOXCRCMDCTL_HGCM *pData = &pDisplay->mCrOglScreenshotCtl;
3496
3497	pData->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
3498	pData->Hdr.u32Function = SHCRGL_HOST_FN_TAKE_SCREENSHOT;
3499
3500	pData->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
3501	pData->aParms[0].u.pointer.addr = &pDisplay->mCrOglScreenshotData;
3502	pData->aParms[0].u.pointer.size = sizeof(pDisplay->mCrOglScreenshotData);
3503	rc = pDisplay->i_crCtlSubmit(&pData->Hdr, sizeof(*pData), Display::i_displayVRecCompletion, pDisplay);
3504	if (RT_SUCCESS(rc))
3505	break;
3506	AssertMsgFailed(("crCtlSubmit failed (rc=%Rrc)\n", rc));
3507	}
3508
3509	/* no 3D data available, or error has occured,
3510	* go the straight way */
3511	ASMAtomicWriteU32(&pDisplay->mfCrOglVideoRecState, CRVREC_STATE_IDLE);
3512	}
3513	else
3514	{
3515	/* record request is still in progress, don't do anything */
3516	break;
3517	}
3518	}
3519	# endif /* VBOX_WITH_HGCM && VBOX_WITH_CROGL */
3520
3521	/* If the recording context has reached the configured recording
3522	* limit, disable recording. */
3523	if (pCtx->IsLimitReached())
3524	{
3525	pDisplay->mParent->i_onRecordingChange(FALSE /* Disable */);
3526	break;
3527	}
3528
3529	uint64_t tsNowMs = RTTimeProgramMilliTS();
3530	for (uScreenId = 0; uScreenId < pDisplay->mcMonitors; uScreenId++)
3531	{
3532	if (!pDisplay->maRecordingEnabled[uScreenId])
3533	continue;
3534
3535	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[uScreenId];
3536	if (!pFBInfo->fDisabled)
3537	{
3538	ComPtr<IDisplaySourceBitmap> pSourceBitmap;
3539	int rc2 = RTCritSectEnter(&pDisplay->mVideoRecLock);
3540	if (RT_SUCCESS(rc2))
3541	{
3542	pSourceBitmap = pFBInfo->Recording.pSourceBitmap;
3543	RTCritSectLeave(&pDisplay->mVideoRecLock);
3544	}
3545
3546	if (!pSourceBitmap.isNull())
3547	{
3548	BYTE *pbAddress = NULL;
3549	ULONG ulWidth = 0;
3550	ULONG ulHeight = 0;
3551	ULONG ulBitsPerPixel = 0;
3552	ULONG ulBytesPerLine = 0;
3553	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
3554	HRESULT hr = pSourceBitmap->QueryBitmapInfo(&pbAddress,
3555	&ulWidth,
3556	&ulHeight,
3557	&ulBitsPerPixel,
3558	&ulBytesPerLine,
3559	&bitmapFormat);
3560	if (SUCCEEDED(hr) && pbAddress)
3561	rc = pCtx->SendVideoFrame(uScreenId, 0, 0, BitmapFormat_BGR,
3562	ulBitsPerPixel, ulBytesPerLine, ulWidth, ulHeight,
3563	pbAddress, tsNowMs);
3564	else
3565	rc = VERR_NOT_SUPPORTED;
3566
3567	pSourceBitmap.setNull();
3568	}
3569	else
3570	rc = VERR_NOT_SUPPORTED;
3571
3572	if (rc == VINF_TRY_AGAIN)
3573	break;
3574	}
3575	}
3576	} while (0);
3577	}
3578	#endif /* VBOX_WITH_RECORDING */
3579
3580	#ifdef DEBUG_sunlover_2
3581	LogFlowFunc(("leave\n"));
3582	#endif /* DEBUG_sunlover_2 */
3583	}
3584
3585	/**
3586	* Reset notification
3587	*
3588	* @see PDMIDISPLAYCONNECTOR::pfnReset
3589	*/
3590	DECLCALLBACK(void) Display::i_displayResetCallback(PPDMIDISPLAYCONNECTOR pInterface)
3591	{
3592	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3593
3594	LogRelFlowFunc(("\n"));
3595
3596	/* Disable VBVA mode. */
3597	pDrv->pDisplay->VideoAccelEnableVGA(false, NULL);
3598	}
3599
3600	/**
3601	* LFBModeChange notification
3602	*
3603	* @see PDMIDISPLAYCONNECTOR::pfnLFBModeChange
3604	*/
3605	DECLCALLBACK(void) Display::i_displayLFBModeChangeCallback(PPDMIDISPLAYCONNECTOR pInterface, bool fEnabled)
3606	{
3607	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3608
3609	LogRelFlowFunc(("fEnabled=%d\n", fEnabled));
3610
3611	NOREF(fEnabled);
3612
3613	/* Disable VBVA mode in any case. The guest driver reenables VBVA mode if necessary. */
3614	pDrv->pDisplay->VideoAccelEnableVGA(false, NULL);
3615	}
3616
3617	/**
3618	* Adapter information change notification.
3619	*
3620	* @see PDMIDISPLAYCONNECTOR::pfnProcessAdapterData
3621	*/
3622	DECLCALLBACK(void) Display::i_displayProcessAdapterDataCallback(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM,
3623	uint32_t u32VRAMSize)
3624	{
3625	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3626	pDrv->pDisplay->processAdapterData(pvVRAM, u32VRAMSize);
3627	}
3628
3629	/**
3630	* Display information change notification.
3631	*
3632	* @see PDMIDISPLAYCONNECTOR::pfnProcessDisplayData
3633	*/
3634	DECLCALLBACK(void) Display::i_displayProcessDisplayDataCallback(PPDMIDISPLAYCONNECTOR pInterface,
3635	void *pvVRAM, unsigned uScreenId)
3636	{
3637	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3638	pDrv->pDisplay->processDisplayData(pvVRAM, uScreenId);
3639	}
3640
3641	#ifdef VBOX_WITH_VIDEOHWACCEL
3642
3643	#ifndef S_FALSE
3644	# define S_FALSE ((HRESULT)1L)
3645	#endif
3646
3647	int Display::i_handleVHWACommandProcess(int enmCmd, bool fGuestCmd, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand)
3648	{
3649	unsigned id = (unsigned)pCommand->iDisplay;
3650	if (id >= mcMonitors)
3651	return VERR_INVALID_PARAMETER;
3652
3653	ComPtr<IFramebuffer> pFramebuffer;
3654	AutoReadLock arlock(this COMMA_LOCKVAL_SRC_POS);
3655	pFramebuffer = maFramebuffers[id].pFramebuffer;
3656	bool fVHWASupported = RT_BOOL(maFramebuffers[id].u32Caps & FramebufferCapabilities_VHWA);
3657	arlock.release();
3658
3659	if (pFramebuffer == NULL \|\| !fVHWASupported)
3660	return VERR_NOT_IMPLEMENTED; /* Implementation is not available. */
3661
3662	HRESULT hr = pFramebuffer->ProcessVHWACommand((BYTE *)pCommand, enmCmd, fGuestCmd);
3663	if (hr == S_FALSE)
3664	return VINF_SUCCESS;
3665	if (SUCCEEDED(hr))
3666	return VINF_CALLBACK_RETURN;
3667	if (hr == E_ACCESSDENIED)
3668	return VERR_INVALID_STATE; /* notify we can not handle request atm */
3669	if (hr == E_NOTIMPL)
3670	return VERR_NOT_IMPLEMENTED;
3671	return VERR_GENERAL_FAILURE;
3672	}
3673
3674	DECLCALLBACK(int) Display::i_displayVHWACommandProcess(PPDMIDISPLAYCONNECTOR pInterface, int enmCmd, bool fGuestCmd,
3675	VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand)
3676	{
3677	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3678
3679	return pDrv->pDisplay->i_handleVHWACommandProcess(enmCmd, fGuestCmd, pCommand);
3680	}
3681	#endif
3682
3683	#ifdef VBOX_WITH_CRHGSMI
3684	void Display::i_handleCrHgsmiCommandCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam)
3685	{
3686	RT_NOREF(u32Function);
3687	mpDrv->pVBVACallbacks->pfnCrHgsmiCommandCompleteAsync(mpDrv->pVBVACallbacks,
3688	(PVBOXVDMACMD_CHROMIUM_CMD)pParam->u.pointer.addr, result);
3689	}
3690
3691	void Display::i_handleCrHgsmiControlCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam)
3692	{
3693	RT_NOREF(u32Function);
3694	PVBOXVDMACMD_CHROMIUM_CTL pCtl = (PVBOXVDMACMD_CHROMIUM_CTL)pParam->u.pointer.addr;
3695	mpDrv->pVBVACallbacks->pfnCrHgsmiControlCompleteAsync(mpDrv->pVBVACallbacks, pCtl, result);
3696	}
3697
3698	void Display::i_handleCrHgsmiCommandProcess(VBOXVDMACMD_CHROMIUM_CMD RT_UNTRUSTED_VOLATILE_GUEST *pCmd, uint32_t cbCmd)
3699	{
3700	int rc = VERR_NOT_SUPPORTED;
3701	VBOXHGCMSVCPARM parm;
3702	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3703	parm.u.pointer.addr = (void *)pCmd;
3704	parm.u.pointer.size = cbCmd;
3705
3706	if (mhCrOglSvc)
3707	{
3708	VMMDev *pVMMDev = mParent->i_getVMMDev();
3709	if (pVMMDev)
3710	{
3711	/* no completion callback is specified with this call,
3712	* the CrOgl code will complete the CrHgsmi command once it processes it */
3713	rc = pVMMDev->hgcmHostFastCallAsync(mhCrOglSvc, SHCRGL_HOST_FN_CRHGSMI_CMD, &parm, NULL, NULL);
3714	AssertRC(rc);
3715	if (RT_SUCCESS(rc))
3716	return;
3717	}
3718	else
3719	rc = VERR_INVALID_STATE;
3720	}
3721
3722	/* we are here because something went wrong with command processing, complete it */
3723	i_handleCrHgsmiCommandCompletion(rc, SHCRGL_HOST_FN_CRHGSMI_CMD, &parm);
3724	}
3725
3726	void Display::i_handleCrHgsmiControlProcess(VBOXVDMACMD_CHROMIUM_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCtl, uint32_t cbCtl)
3727	{
3728	int rc = VERR_NOT_SUPPORTED;
3729	VBOXHGCMSVCPARM parm;
3730	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3731	parm.u.pointer.addr = (void *)pCtl;
3732	parm.u.pointer.size = cbCtl;
3733
3734	if (mhCrOglSvc)
3735	{
3736	VMMDev *pVMMDev = mParent->i_getVMMDev();
3737	if (pVMMDev)
3738	{
3739	bool fCheckPendingViewport = (pCtl->enmType == VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP);
3740	rc = pVMMDev->hgcmHostFastCallAsync(mhCrOglSvc, SHCRGL_HOST_FN_CRHGSMI_CTL, &parm,
3741	Display::i_displayCrHgsmiControlCompletion, this);
3742	AssertRC(rc);
3743	if (RT_SUCCESS(rc))
3744	{
3745	if (fCheckPendingViewport)
3746	{
3747	ULONG ul;
3748	for (ul = 0; ul < mcMonitors; ul++)
3749	{
3750	DISPLAYFBINFO *pFb = &maFramebuffers[ul];
3751	if (!pFb->pendingViewportInfo.fPending)
3752	continue;
3753
3754	rc = i_crViewportNotify(ul, pFb->pendingViewportInfo.x, pFb->pendingViewportInfo.y,
3755	pFb->pendingViewportInfo.width, pFb->pendingViewportInfo.height);
3756	if (RT_SUCCESS(rc))
3757	pFb->pendingViewportInfo.fPending = false;
3758	else
3759	{
3760	AssertMsgFailed(("crViewportNotify failed (rc=%Rrc)\n", rc));
3761	rc = VINF_SUCCESS;
3762	}
3763	}
3764	}
3765	return;
3766	}
3767	}
3768	else
3769	rc = VERR_INVALID_STATE;
3770	}
3771
3772	/* we are here because something went wrong with command processing, complete it */
3773	i_handleCrHgsmiControlCompletion(rc, SHCRGL_HOST_FN_CRHGSMI_CTL, &parm);
3774	}
3775
3776	DECLCALLBACK(void) Display::i_displayCrHgsmiCommandProcess(PPDMIDISPLAYCONNECTOR pInterface,
3777	VBOXVDMACMD_CHROMIUM_CMD RT_UNTRUSTED_VOLATILE_GUEST *pCmd,
3778	uint32_t cbCmd)
3779	{
3780	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3781
3782	pDrv->pDisplay->i_handleCrHgsmiCommandProcess(pCmd, cbCmd);
3783	}
3784
3785	DECLCALLBACK(void) Display::i_displayCrHgsmiControlProcess(PPDMIDISPLAYCONNECTOR pInterface,
3786	VBOXVDMACMD_CHROMIUM_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCmd,
3787	uint32_t cbCmd)
3788	{
3789	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3790
3791	pDrv->pDisplay->i_handleCrHgsmiControlProcess(pCmd, cbCmd);
3792	}
3793
3794	DECLCALLBACK(void) Display::i_displayCrHgsmiCommandCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam,
3795	void *pvContext)
3796	{
3797	AssertMsgFailed(("not expected!\n"));
3798	Display pDisplay = (Display )pvContext;
3799	pDisplay->i_handleCrHgsmiCommandCompletion(result, u32Function, pParam);
3800	}
3801
3802	DECLCALLBACK(void) Display::i_displayCrHgsmiControlCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam,
3803	void *pvContext)
3804	{
3805	Display pDisplay = (Display )pvContext;
3806	pDisplay->i_handleCrHgsmiControlCompletion(result, u32Function, pParam);
3807
3808	}
3809	#endif
3810
3811	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3812	DECLCALLBACK(void) Display::i_displayCrHgcmCtlSubmitCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam,
3813	void *pvContext)
3814	{
3815	RT_NOREF(u32Function);
3816	VBOXCRCMDCTL pCmd = (VBOXCRCMDCTL )pParam->u.pointer.addr;
3817	if (pCmd->u.pfnInternal)
3818	((PFNCRCTLCOMPLETION)pCmd->u.pfnInternal)(pCmd, pParam->u.pointer.size, result, pvContext);
3819	}
3820
3821	int Display::i_handleCrHgcmCtlSubmit(struct VBOXCRCMDCTL RT_UNTRUSTED_VOLATILE_GUEST *pCmd, uint32_t cbCmd,
3822	PFNCRCTLCOMPLETION pfnCompletion, void *pvCompletion)
3823	{
3824	VMMDev *pVMMDev = mParent ? mParent->i_getVMMDev() : NULL;
3825	if (!pVMMDev)
3826	{
3827	AssertMsgFailed(("no vmmdev\n"));
3828	return VERR_INVALID_STATE;
3829	}
3830
3831	Assert(mhCrOglSvc);
3832	VBOXHGCMSVCPARM parm;
3833	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3834	parm.u.pointer.addr = (void *)pCmd;
3835	parm.u.pointer.size = cbCmd;
3836
3837	pCmd->u.pfnInternal = (PFNRT)pfnCompletion;
3838	int rc = pVMMDev->hgcmHostFastCallAsync(mhCrOglSvc, SHCRGL_HOST_FN_CTL, &parm, i_displayCrHgcmCtlSubmitCompletion,
3839	pvCompletion);
3840	if (!RT_SUCCESS(rc))
3841	AssertMsgFailed(("hgcmHostFastCallAsync failed (rc=%Rrc)\n", rc));
3842
3843	return rc;
3844	}
3845
3846	DECLCALLBACK(int) Display::i_displayCrHgcmCtlSubmit(PPDMIDISPLAYCONNECTOR pInterface, struct VBOXCRCMDCTL *pCmd, uint32_t cbCmd,
3847	PFNCRCTLCOMPLETION pfnCompletion, void *pvCompletion)
3848	{
3849	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3850	Display *pThis = pDrv->pDisplay;
3851	return pThis->i_handleCrHgcmCtlSubmit(pCmd, cbCmd, pfnCompletion, pvCompletion);
3852	}
3853
3854	int Display::i_crCtlSubmit(struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd, PFNCRCTLCOMPLETION pfnCompletion, void *pvCompletion)
3855	{
3856	int rc = RTCritSectRwEnterShared(&mCrOglLock);
3857	if (RT_SUCCESS(rc))
3858	{
3859	if (mhCrOglSvc)
3860	rc = mpDrv->pVBVACallbacks->pfnCrCtlSubmit(mpDrv->pVBVACallbacks, pCmd, cbCmd, pfnCompletion, pvCompletion);
3861	else
3862	rc = VERR_NOT_SUPPORTED;
3863
3864	RTCritSectRwLeaveShared(&mCrOglLock);
3865	}
3866	return rc;
3867	}
3868
3869	int Display::i_crCtlSubmitSync(struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd)
3870	{
3871	int rc = RTCritSectRwEnterShared(&mCrOglLock);
3872	if (RT_SUCCESS(rc))
3873	{
3874	if (mhCrOglSvc)
3875	rc = mpDrv->pVBVACallbacks->pfnCrCtlSubmitSync(mpDrv->pVBVACallbacks, pCmd, cbCmd);
3876	else
3877	rc = VERR_NOT_SUPPORTED;
3878
3879	RTCritSectRwLeaveShared(&mCrOglLock);
3880	}
3881	return rc;
3882	}
3883
3884	int Display::i_crCtlSubmitAsyncCmdCopy(struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd)
3885	{
3886	VBOXCRCMDCTL* pCmdCopy = (VBOXCRCMDCTL*)RTMemAlloc(cbCmd);
3887	if (!pCmdCopy)
3888	{
3889	LogRel(("RTMemAlloc failed\n"));
3890	return VERR_NO_MEMORY;
3891	}
3892
3893	memcpy(pCmdCopy, pCmd, cbCmd);
3894
3895	int rc = i_crCtlSubmit(pCmdCopy, cbCmd, i_displayCrCmdFree, pCmdCopy);
3896	if (RT_FAILURE(rc))
3897	{
3898	LogRel(("crCtlSubmit failed (rc=%Rrc)\n", rc));
3899	RTMemFree(pCmdCopy);
3900	return rc;
3901	}
3902
3903	return VINF_SUCCESS;
3904	}
3905
3906	int Display::i_crCtlSubmitSyncIfHasDataForScreen(uint32_t u32ScreenID, struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd)
3907	{
3908	int rc = RTCritSectRwEnterShared(&mCrOglLock);
3909	AssertRCReturn(rc, rc);
3910
3911	if ( mCrOglCallbacks.pfnHasDataForScreen
3912	&& mCrOglCallbacks.pfnHasDataForScreen(u32ScreenID))
3913	rc = i_crCtlSubmitSync(pCmd, cbCmd);
3914	else
3915	rc = i_crCtlSubmitAsyncCmdCopy(pCmd, cbCmd);
3916
3917	RTCritSectRwLeaveShared(&mCrOglLock);
3918
3919	return rc;
3920	}
3921
3922	bool Display::i_handleCrVRecScreenshotBegin(uint32_t uScreen, uint64_t uTimestampMs)
3923	{
3924	# ifdef VBOX_WITH_RECORDING
3925	RecordingContext *pCtx = mParent->i_recordingGetContext();
3926	return ( pCtx
3927	&& pCtx->IsReady(uScreen, uTimestampMs));
3928	# else
3929	RT_NOREF(uScreen, uTimestampMs);
3930	return false;
3931	# endif
3932	}
3933
3934	void Display::i_handleCrVRecScreenshotEnd(uint32_t uScreen, uint64_t uTimestampMs)
3935	{
3936	RT_NOREF(uScreen, uTimestampMs);
3937	}
3938
3939	void Display::i_handleCrVRecScreenshotPerform(uint32_t uScreen,
3940	uint32_t x, uint32_t y, uint32_t uPixelFormat,
3941	uint32_t uBitsPerPixel, uint32_t uBytesPerLine,
3942	uint32_t uGuestWidth, uint32_t uGuestHeight,
3943	uint8_t *pu8BufferAddress, uint64_t uTimestampMs)
3944	{
3945	Assert(mfCrOglVideoRecState == CRVREC_STATE_SUBMITTED);
3946	# ifdef VBOX_WITH_RECORDING
3947	RecordingContext *pCtx = mParent->i_recordingGetContext();
3948
3949	if ( pCtx
3950	&& pCtx->IsStarted()
3951	&& pCtx->IsFeatureEnabled(RecordingFeature_Video))
3952	{
3953	int rc2 = pCtx->SendVideoFrame(uScreen, x, y,
3954	uPixelFormat,
3955	uBitsPerPixel, uBytesPerLine,
3956	uGuestWidth, uGuestHeight,
3957	pu8BufferAddress, uTimestampMs);
3958	RT_NOREF(rc2);
3959	Assert(rc2 == VINF_SUCCESS /* \|\| rc == VERR_TRY_AGAIN \|\| rc == VINF_TRY_AGAIN*/);
3960	}
3961	# else
3962	RT_NOREF(uScreen, x, y, uPixelFormat, \
3963	uBitsPerPixel, uBytesPerLine, uGuestWidth, uGuestHeight, pu8BufferAddress, uTimestampMs);
3964	# endif /* VBOX_WITH_RECORDING */
3965	}
3966
3967	void Display::i_handleVRecCompletion()
3968	{
3969	Assert(mfCrOglVideoRecState == CRVREC_STATE_SUBMITTED);
3970	ASMAtomicWriteU32(&mfCrOglVideoRecState, CRVREC_STATE_IDLE);
3971	}
3972
3973	#endif /* VBOX_WITH_HGCM && VBOX_WITH_CROGL */
3974
3975	HRESULT Display::notifyScaleFactorChange(ULONG aScreenId, ULONG aScaleFactorWMultiplied, ULONG aScaleFactorHMultiplied)
3976	{
3977	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3978	HRESULT hr = E_UNEXPECTED;
3979
3980	if (aScreenId >= mcMonitors)
3981	return E_INVALIDARG;
3982
3983	/* 3D acceleration enabled in VM config. */
3984	if (mfIsCr3DEnabled)
3985	{
3986	/* VBoxSharedCrOpenGL HGCM host service is running. */
3987	if (mhCrOglSvc)
3988	{
3989	VMMDev *pVMMDev = mParent->i_getVMMDev();
3990	if (pVMMDev)
3991	{
3992	VBOXCRCMDCTL_HGCM *pCtl;
3993	pCtl = (VBOXCRCMDCTL_HGCM *)RTMemAlloc(sizeof(CRVBOXHGCMSETSCALEFACTOR) + sizeof(VBOXCRCMDCTL_HGCM));
3994	if (pCtl)
3995	{
3996	CRVBOXHGCMSETSCALEFACTOR pData = (CRVBOXHGCMSETSCALEFACTOR )(pCtl + 1);
3997	int rc;
3998
3999	pData->u32Screen = aScreenId;
4000	pData->u32ScaleFactorWMultiplied = aScaleFactorWMultiplied;
4001	pData->u32ScaleFactorHMultiplied = aScaleFactorHMultiplied;
4002
4003	pCtl->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
4004	pCtl->Hdr.u32Function = SHCRGL_HOST_FN_SET_SCALE_FACTOR;
4005	pCtl->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
4006	pCtl->aParms[0].u.pointer.addr = pData;
4007	pCtl->aParms[0].u.pointer.size = sizeof(*pData);
4008
4009	rc = i_crCtlSubmitSync(&pCtl->Hdr, sizeof(*pCtl));
4010	if (RT_FAILURE(rc))
4011	AssertMsgFailed(("crCtlSubmitSync failed (rc=%Rrc)\n", rc));
4012	else
4013	hr = S_OK;
4014
4015	RTMemFree(pCtl);
4016	}
4017	else
4018	{
4019	LogRel(("Running out of memory on attempt to set OpenGL content scale factor. Ignored.\n"));
4020	hr = E_OUTOFMEMORY;
4021	}
4022	}
4023	else
4024	LogRel(("Internal error occurred on attempt to set OpenGL content scale factor. Ignored.\n"));
4025	}
4026	else
4027	LogRel(("Attempt to specify OpenGL content scale factor while corresponding HGCM host service not yet runing. Ignored.\n"));
4028	}
4029	else
4030	# if 0 /** @todo Thank you so very much from anyone using VMSVGA3d! */
4031	AssertMsgFailed(("Attempt to specify OpenGL content scale factor while 3D acceleration is disabled in VM config. Ignored.\n"));
4032	# else
4033	{
4034	hr = S_OK;
4035	/* Need an interface like this here (and the #ifdefs needs adjusting):
4036	PPDMIDISPLAYPORT pUpPort = mpDrv ? mpDrv->pUpPort : NULL;
4037	if (pUpPort && pUpPort->pfnSetScaleFactor)
4038	pUpPort->pfnSetScaleFactor(pUpPort, aScreeId, aScaleFactorWMultiplied, aScaleFactorHMultiplied); */
4039	}
4040	# endif
4041
4042	return hr;
4043
4044	#else /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4045	RT_NOREF(aScreenId, aScaleFactorWMultiplied, aScaleFactorHMultiplied);
4046	AssertMsgFailed(("Attempt to specify OpenGL content scale factor while corresponding functionality is disabled."));
4047	return E_UNEXPECTED;
4048	#endif /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4049	}
4050
4051	HRESULT Display::notifyHiDPIOutputPolicyChange(BOOL fUnscaledHiDPI)
4052	{
4053	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
4054	HRESULT hr = E_UNEXPECTED;
4055
4056	/* 3D acceleration enabled in VM config. */
4057	if (mfIsCr3DEnabled)
4058	{
4059	/* VBoxSharedCrOpenGL HGCM host service is running. */
4060	if (mhCrOglSvc)
4061	{
4062	VMMDev *pVMMDev = mParent->i_getVMMDev();
4063	if (pVMMDev)
4064	{
4065	VBOXCRCMDCTL_HGCM *pCtl;
4066	pCtl = (VBOXCRCMDCTL_HGCM *)RTMemAlloc(sizeof(CRVBOXHGCMSETUNSCALEDHIDPIOUTPUT) + sizeof(VBOXCRCMDCTL_HGCM));
4067	if (pCtl)
4068	{
4069	CRVBOXHGCMSETUNSCALEDHIDPIOUTPUT pData = (CRVBOXHGCMSETUNSCALEDHIDPIOUTPUT )(pCtl + 1);
4070	int rc;
4071
4072	pData->fUnscaledHiDPI = RT_BOOL(fUnscaledHiDPI);
4073
4074	pCtl->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
4075	pCtl->Hdr.u32Function = SHCRGL_HOST_FN_SET_UNSCALED_HIDPI;
4076	pCtl->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
4077	pCtl->aParms[0].u.pointer.addr = pData;
4078	pCtl->aParms[0].u.pointer.size = sizeof(*pData);
4079
4080	rc = i_crCtlSubmitSync(&pCtl->Hdr, sizeof(*pCtl));
4081	if (RT_FAILURE(rc))
4082	AssertMsgFailed(("crCtlSubmitSync failed (rc=%Rrc)\n", rc));
4083	else
4084	hr = S_OK;
4085
4086	RTMemFree(pCtl);
4087	}
4088	else
4089	{
4090	LogRel(("Running out of memory on attempt to notify OpenGL about HiDPI output scaling policy change. Ignored.\n"));
4091	hr = E_OUTOFMEMORY;
4092	}
4093	}
4094	else
4095	LogRel(("Internal error occurred on attempt to notify OpenGL about HiDPI output scaling policy change. Ignored.\n"));
4096	}
4097	else
4098	LogRel(("Attempt to notify OpenGL about HiDPI output scaling policy change while corresponding HGCM host service not yet runing. Ignored.\n"));
4099	}
4100	else
4101	{
4102	hr = S_OK;
4103	/* Need an interface like this here (and the #ifdefs needs adjusting):
4104	PPDMIDISPLAYPORT pUpPort = mpDrv ? mpDrv->pUpPort : NULL;
4105	if (pUpPort && pUpPort->pfnSetScaleFactor)
4106	pUpPort->pfnSetScaleFactor(pUpPort, aScreeId, aScaleFactorWMultiplied, aScaleFactorHMultiplied); */
4107	}
4108
4109	return hr;
4110
4111	#else /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4112	RT_NOREF(fUnscaledHiDPI);
4113	AssertMsgFailed(("Attempt to notify OpenGL about HiDPI output scaling policy change while corresponding functionality is disabled."));
4114	return E_UNEXPECTED;
4115	#endif /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4116	}
4117
4118	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
4119	DECLCALLBACK(void) Display::i_displayCrVRecScreenshotPerform(void *pvCtx, uint32_t uScreen,
4120	uint32_t x, uint32_t y,
4121	uint32_t uBitsPerPixel, uint32_t uBytesPerLine,
4122	uint32_t uGuestWidth, uint32_t uGuestHeight,
4123	uint8_t *pu8BufferAddress, uint64_t u64Timestamp)
4124	{
4125	Display pDisplay = (Display )pvCtx;
4126	pDisplay->i_handleCrVRecScreenshotPerform(uScreen,
4127	x, y, BitmapFormat_BGR, uBitsPerPixel,
4128	uBytesPerLine, uGuestWidth, uGuestHeight,
4129	pu8BufferAddress, u64Timestamp);
4130	}
4131
4132	DECLCALLBACK(bool) Display::i_displayCrVRecScreenshotBegin(void *pvCtx, uint32_t uScreen, uint64_t u64Timestamp)
4133	{
4134	Display pDisplay = (Display )pvCtx;
4135	return pDisplay->i_handleCrVRecScreenshotBegin(uScreen, u64Timestamp);
4136	}
4137
4138	DECLCALLBACK(void) Display::i_displayCrVRecScreenshotEnd(void *pvCtx, uint32_t uScreen, uint64_t u64Timestamp)
4139	{
4140	Display pDisplay = (Display )pvCtx;
4141	pDisplay->i_handleCrVRecScreenshotEnd(uScreen, u64Timestamp);
4142	}
4143
4144	DECLCALLBACK(void) Display::i_displayVRecCompletion(struct VBOXCRCMDCTL pCmd, uint32_t cbCmd, int rc, void pvCompletion)
4145	{
4146	RT_NOREF(pCmd, cbCmd, rc);
4147	Display pDisplay = (Display )pvCompletion;
4148	pDisplay->i_handleVRecCompletion();
4149	}
4150
4151	#endif
4152
4153
4154	#ifdef VBOX_WITH_HGSMI
4155	/**
4156	* @interface_method_impl{PDMIDISPLAYCONNECTOR,pfnVBVAEnable}
4157	*/
4158	DECLCALLBACK(int) Display::i_displayVBVAEnable(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId,
4159	VBVAHOSTFLAGS RT_UNTRUSTED_VOLATILE_GUEST *pHostFlags,
4160	bool fRenderThreadMode)
4161	{
4162	LogRelFlowFunc(("uScreenId %d\n", uScreenId));
4163
4164	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4165	Display *pThis = pDrv->pDisplay;
4166
4167	if (pThis->maFramebuffers[uScreenId].fVBVAEnabled && pThis->maFramebuffers[uScreenId].fRenderThreadMode != fRenderThreadMode)
4168	{
4169	LogRel(("Enabling different vbva mode\n"));
4170	#ifdef DEBUG_misha
4171	AssertMsgFailed(("enabling different vbva mode\n"));
4172	#endif
4173	return VERR_INVALID_STATE;
4174	}
4175
4176	pThis->maFramebuffers[uScreenId].fVBVAEnabled = true;
4177	pThis->maFramebuffers[uScreenId].pVBVAHostFlags = pHostFlags;
4178	pThis->maFramebuffers[uScreenId].fRenderThreadMode = fRenderThreadMode;
4179	pThis->maFramebuffers[uScreenId].fVBVAForceResize = true;
4180
4181	vbvaSetMemoryFlagsHGSMI(uScreenId, pThis->mfu32SupportedOrders, pThis->mfVideoAccelVRDP, &pThis->maFramebuffers[uScreenId]);
4182
4183	return VINF_SUCCESS;
4184	}
4185
4186	/**
4187	* @interface_method_impl{PDMIDISPLAYCONNECTOR,pfnVBVADisable}
4188	*/
4189	DECLCALLBACK(void) Display::i_displayVBVADisable(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId)
4190	{
4191	LogRelFlowFunc(("uScreenId %d\n", uScreenId));
4192
4193	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4194	Display *pThis = pDrv->pDisplay;
4195
4196	DISPLAYFBINFO *pFBInfo = &pThis->maFramebuffers[uScreenId];
4197
4198	bool fRenderThreadMode = pFBInfo->fRenderThreadMode;
4199
4200	if (uScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
4201	{
4202	/* Make sure that the primary screen is visible now.
4203	* The guest can't use VBVA anymore, so only only the VGA device output works.
4204	*/
4205	pFBInfo->flags = 0;
4206	if (pFBInfo->fDisabled)
4207	{
4208	pFBInfo->fDisabled = false;
4209	fireGuestMonitorChangedEvent(pThis->mParent->i_getEventSource(),
4210	GuestMonitorChangedEventType_Enabled,
4211	uScreenId,
4212	pFBInfo->xOrigin, pFBInfo->yOrigin,
4213	pFBInfo->w, pFBInfo->h);
4214	}
4215	}
4216
4217	pFBInfo->fVBVAEnabled = false;
4218	pFBInfo->fVBVAForceResize = false;
4219	pFBInfo->fRenderThreadMode = false;
4220
4221	vbvaSetMemoryFlagsHGSMI(uScreenId, 0, false, pFBInfo);
4222
4223	pFBInfo->pVBVAHostFlags = NULL;
4224
4225	if (!fRenderThreadMode && uScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
4226	{
4227	/* Force full screen update, because VGA device must take control, do resize, etc. */
4228	pThis->mpDrv->pUpPort->pfnUpdateDisplayAll(pThis->mpDrv->pUpPort, /* fFailOnResize = */ false);
4229	}
4230	}
4231
4232	DECLCALLBACK(void) Display::i_displayVBVAUpdateBegin(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId)
4233	{
4234	RT_NOREF(uScreenId);
4235	LogFlowFunc(("uScreenId %d\n", uScreenId));
4236
4237	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4238	Display *pThis = pDrv->pDisplay;
4239
4240	if (ASMAtomicReadU32(&pThis->mu32UpdateVBVAFlags) > 0)
4241	{
4242	vbvaSetMemoryFlagsAllHGSMI(pThis->mfu32SupportedOrders, pThis->mfVideoAccelVRDP, pThis->maFramebuffers,
4243	pThis->mcMonitors);
4244	ASMAtomicDecU32(&pThis->mu32UpdateVBVAFlags);
4245	}
4246	}
4247
4248	/**
4249	* @interface_method_impl{PDMIDISPLAYCONNECTOR,pfnVBVAUpdateProcess}
4250	*/
4251	DECLCALLBACK(void) Display::i_displayVBVAUpdateProcess(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId,
4252	struct VBVACMDHDR const RT_UNTRUSTED_VOLATILE_GUEST *pCmd, size_t cbCmd)
4253	{
4254	LogFlowFunc(("uScreenId %d pCmd %p cbCmd %d, @%d,%d %dx%d\n", uScreenId, pCmd, cbCmd, pCmd->x, pCmd->y, pCmd->w, pCmd->h));
4255	VBVACMDHDR hdrSaved;
4256	RT_COPY_VOLATILE(hdrSaved, *pCmd);
4257	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE();
4258
4259	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4260	Display *pThis = pDrv->pDisplay;
4261	DISPLAYFBINFO *pFBInfo = &pThis->maFramebuffers[uScreenId];
4262
4263	if (pFBInfo->fDefaultFormat)
4264	{
4265	/* Make sure that framebuffer contains the same image as the guest VRAM. */
4266	if ( uScreenId == VBOX_VIDEO_PRIMARY_SCREEN
4267	&& !pFBInfo->fDisabled)
4268	{
4269	pDrv->pUpPort->pfnUpdateDisplayRect(pDrv->pUpPort, hdrSaved.x, hdrSaved.y, hdrSaved.w, hdrSaved.h);
4270	}
4271	else if ( !pFBInfo->pSourceBitmap.isNull()
4272	&& !pFBInfo->fDisabled)
4273	{
4274	/* Render VRAM content to the framebuffer. */
4275	BYTE *pAddress = NULL;
4276	ULONG ulWidth = 0;
4277	ULONG ulHeight = 0;
4278	ULONG ulBitsPerPixel = 0;
4279	ULONG ulBytesPerLine = 0;
4280	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
4281
4282	HRESULT hrc = pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
4283	&ulWidth,
4284	&ulHeight,
4285	&ulBitsPerPixel,
4286	&ulBytesPerLine,
4287	&bitmapFormat);
4288	if (SUCCEEDED(hrc))
4289	{
4290	uint32_t width = hdrSaved.w;
4291	uint32_t height = hdrSaved.h;
4292
4293	const uint8_t *pu8Src = pFBInfo->pu8FramebufferVRAM;
4294	int32_t xSrc = hdrSaved.x - pFBInfo->xOrigin;
4295	int32_t ySrc = hdrSaved.y - pFBInfo->yOrigin;
4296	uint32_t u32SrcWidth = pFBInfo->w;
4297	uint32_t u32SrcHeight = pFBInfo->h;
4298	uint32_t u32SrcLineSize = pFBInfo->u32LineSize;
4299	uint32_t u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
4300
4301	uint8_t *pu8Dst = pAddress;
4302	int32_t xDst = xSrc;
4303	int32_t yDst = ySrc;
4304	uint32_t u32DstWidth = u32SrcWidth;
4305	uint32_t u32DstHeight = u32SrcHeight;
4306	uint32_t u32DstLineSize = u32DstWidth * 4;
4307	uint32_t u32DstBitsPerPixel = 32;
4308
4309	pDrv->pUpPort->pfnCopyRect(pDrv->pUpPort,
4310	width, height,
4311	pu8Src,
4312	xSrc, ySrc,
4313	u32SrcWidth, u32SrcHeight,
4314	u32SrcLineSize, u32SrcBitsPerPixel,
4315	pu8Dst,
4316	xDst, yDst,
4317	u32DstWidth, u32DstHeight,
4318	u32DstLineSize, u32DstBitsPerPixel);
4319	}
4320	}
4321	}
4322
4323	/*
4324	* Here is your classic 'temporary' solution.
4325	*/
4326	/** @todo New SendUpdate entry which can get a separate cmd header or coords. */
4327	VBVACMDHDR pHdrUnconst = (VBVACMDHDR )pCmd;
4328
4329	pHdrUnconst->x -= (int16_t)pFBInfo->xOrigin;
4330	pHdrUnconst->y -= (int16_t)pFBInfo->yOrigin;
4331
4332	pThis->mParent->i_consoleVRDPServer()->SendUpdate(uScreenId, pHdrUnconst, (uint32_t)cbCmd);
4333
4334	*pHdrUnconst = hdrSaved;
4335	}
4336
4337	DECLCALLBACK(void) Display::i_displayVBVAUpdateEnd(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, int32_t x, int32_t y,
4338	uint32_t cx, uint32_t cy)
4339	{
4340	LogFlowFunc(("uScreenId %d %d,%d %dx%d\n", uScreenId, x, y, cx, cy));
4341
4342	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4343	Display *pThis = pDrv->pDisplay;
4344	DISPLAYFBINFO *pFBInfo = &pThis->maFramebuffers[uScreenId];
4345
4346	/** @todo handleFramebufferUpdate (uScreenId,
4347	* x - pThis->maFramebuffers[uScreenId].xOrigin,
4348	* y - pThis->maFramebuffers[uScreenId].yOrigin,
4349	* cx, cy);
4350	*/
4351	pThis->i_handleDisplayUpdate(uScreenId, x - pFBInfo->xOrigin, y - pFBInfo->yOrigin, cx, cy);
4352	}
4353
4354	#ifdef DEBUG_sunlover
4355	static void logVBVAResize(PCVBVAINFOVIEW pView, PCVBVAINFOSCREEN pScreen, const DISPLAYFBINFO *pFBInfo)
4356	{
4357	LogRel(("displayVBVAResize: [%d] %s\n"
4358	" pView->u32ViewIndex %d\n"
4359	" pView->u32ViewOffset 0x%08X\n"
4360	" pView->u32ViewSize 0x%08X\n"
4361	" pView->u32MaxScreenSize 0x%08X\n"
4362	" pScreen->i32OriginX %d\n"
4363	" pScreen->i32OriginY %d\n"
4364	" pScreen->u32StartOffset 0x%08X\n"
4365	" pScreen->u32LineSize 0x%08X\n"
4366	" pScreen->u32Width %d\n"
4367	" pScreen->u32Height %d\n"
4368	" pScreen->u16BitsPerPixel %d\n"
4369	" pScreen->u16Flags 0x%04X\n"
4370	" pFBInfo->u32Offset 0x%08X\n"
4371	" pFBInfo->u32MaxFramebufferSize 0x%08X\n"
4372	" pFBInfo->u32InformationSize 0x%08X\n"
4373	" pFBInfo->fDisabled %d\n"
4374	" xOrigin, yOrigin, w, h: %d,%d %dx%d\n"
4375	" pFBInfo->u16BitsPerPixel %d\n"
4376	" pFBInfo->pu8FramebufferVRAM %p\n"
4377	" pFBInfo->u32LineSize 0x%08X\n"
4378	" pFBInfo->flags 0x%04X\n"
4379	" pFBInfo->pHostEvents %p\n"
4380	" pFBInfo->fDefaultFormat %d\n"
4381	" pFBInfo->fVBVAEnabled %d\n"
4382	" pFBInfo->fVBVAForceResize %d\n"
4383	" pFBInfo->pVBVAHostFlags %p\n"
4384	"",
4385	pScreen->u32ViewIndex,
4386	(pScreen->u16Flags & VBVA_SCREEN_F_DISABLED)? "DISABLED": "ENABLED",
4387	pView->u32ViewIndex,
4388	pView->u32ViewOffset,
4389	pView->u32ViewSize,
4390	pView->u32MaxScreenSize,
4391	pScreen->i32OriginX,
4392	pScreen->i32OriginY,
4393	pScreen->u32StartOffset,
4394	pScreen->u32LineSize,
4395	pScreen->u32Width,
4396	pScreen->u32Height,
4397	pScreen->u16BitsPerPixel,
4398	pScreen->u16Flags,
4399	pFBInfo->u32Offset,
4400	pFBInfo->u32MaxFramebufferSize,
4401	pFBInfo->u32InformationSize,
4402	pFBInfo->fDisabled,
4403	pFBInfo->xOrigin,
4404	pFBInfo->yOrigin,
4405	pFBInfo->w,
4406	pFBInfo->h,
4407	pFBInfo->u16BitsPerPixel,
4408	pFBInfo->pu8FramebufferVRAM,
4409	pFBInfo->u32LineSize,
4410	pFBInfo->flags,
4411	pFBInfo->pHostEvents,
4412	pFBInfo->fDefaultFormat,
4413	pFBInfo->fVBVAEnabled,
4414	pFBInfo->fVBVAForceResize,
4415	pFBInfo->pVBVAHostFlags
4416	));
4417	}
4418	#endif /* DEBUG_sunlover */
4419
4420	DECLCALLBACK(int) Display::i_displayVBVAResize(PPDMIDISPLAYCONNECTOR pInterface, PCVBVAINFOVIEW pView,
4421	PCVBVAINFOSCREEN pScreen, void *pvVRAM, bool fResetInputMapping)
4422	{
4423	LogRelFlowFunc(("pScreen %p, pvVRAM %p\n", pScreen, pvVRAM));
4424
4425	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4426	Display *pThis = pDrv->pDisplay;
4427
4428	return pThis->processVBVAResize(pView, pScreen, pvVRAM, fResetInputMapping);
4429	}
4430
4431	int Display::processVBVAResize(PCVBVAINFOVIEW pView, PCVBVAINFOSCREEN pScreen, void *pvVRAM, bool fResetInputMapping)
4432	{
4433	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4434
4435	DISPLAYFBINFO *pFBInfo = &maFramebuffers[pScreen->u32ViewIndex];
4436
4437	if (pScreen->u16Flags & VBVA_SCREEN_F_DISABLED)
4438	{
4439	/* Ask the framebuffer to resize using a default format. The framebuffer will be black.
4440	* So if the frontend does not support GuestMonitorChangedEventType_Disabled event,
4441	* the VM window will be black. */
4442	uint32_t u32Width = pFBInfo->w ? pFBInfo->w : 640;
4443	uint32_t u32Height = pFBInfo->h ? pFBInfo->h : 480;
4444	int32_t xOrigin = pFBInfo->xOrigin;
4445	int32_t yOrigin = pFBInfo->yOrigin;
4446
4447	alock.release();
4448
4449	i_notifyCroglResize(pView, pScreen, pvVRAM);
4450
4451	i_handleDisplayResize(pScreen->u32ViewIndex, 0, (uint8_t *)NULL, 0,
4452	u32Width, u32Height, pScreen->u16Flags, xOrigin, yOrigin, false);
4453
4454	return VINF_SUCCESS;
4455	}
4456
4457	VBVAINFOSCREEN screenInfo;
4458	RT_ZERO(screenInfo);
4459
4460	if (pScreen->u16Flags & VBVA_SCREEN_F_BLANK2)
4461	{
4462	/* Init a local VBVAINFOSCREEN structure, which will be used instead of
4463	* the original pScreen. Set VBVA_SCREEN_F_BLANK, which will force
4464	* the code below to choose the "blanking" branches.
4465	*/
4466	screenInfo.u32ViewIndex = pScreen->u32ViewIndex;
4467	screenInfo.i32OriginX = pFBInfo->xOrigin;
4468	screenInfo.i32OriginY = pFBInfo->yOrigin;
4469	screenInfo.u32StartOffset = 0; /* Irrelevant */
4470	screenInfo.u32LineSize = pFBInfo->u32LineSize;
4471	screenInfo.u32Width = pFBInfo->w;
4472	screenInfo.u32Height = pFBInfo->h;
4473	screenInfo.u16BitsPerPixel = pFBInfo->u16BitsPerPixel;
4474	screenInfo.u16Flags = pScreen->u16Flags \| VBVA_SCREEN_F_BLANK;
4475
4476	pScreen = &screenInfo;
4477	}
4478
4479	if (fResetInputMapping)
4480	{
4481	/// @todo Rename to m* and verify whether some kind of lock is required.
4482	xInputMappingOrigin = 0;
4483	yInputMappingOrigin = 0;
4484	cxInputMapping = 0;
4485	cyInputMapping = 0;
4486	}
4487
4488	alock.release();
4489
4490	i_notifyCroglResize(pView, pScreen, pvVRAM);
4491
4492	return i_handleDisplayResize(pScreen->u32ViewIndex, pScreen->u16BitsPerPixel,
4493	(uint8_t *)pvVRAM + pScreen->u32StartOffset,
4494	pScreen->u32LineSize, pScreen->u32Width, pScreen->u32Height, pScreen->u16Flags,
4495	pScreen->i32OriginX, pScreen->i32OriginY, false);
4496	}
4497
4498	DECLCALLBACK(int) Display::i_displayVBVAMousePointerShape(PPDMIDISPLAYCONNECTOR pInterface, bool fVisible, bool fAlpha,
4499	uint32_t xHot, uint32_t yHot,
4500	uint32_t cx, uint32_t cy,
4501	const void *pvShape)
4502	{
4503	LogFlowFunc(("\n"));
4504	LogRel2(("%s: fVisible=%RTbool\n", __PRETTY_FUNCTION__, fVisible));
4505
4506	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4507
4508	uint32_t cbShape = 0;
4509	if (pvShape)
4510	{
4511	cbShape = (cx + 7) / 8 * cy; /* size of the AND mask */
4512	cbShape = ((cbShape + 3) & ~3) + cx * 4 * cy; /* + gap + size of the XOR mask */
4513	}
4514
4515	/* Tell the console about it */
4516	pDrv->pDisplay->mParent->i_onMousePointerShapeChange(fVisible, fAlpha,
4517	xHot, yHot, cx, cy, (uint8_t *)pvShape, cbShape);
4518
4519	return VINF_SUCCESS;
4520	}
4521
4522	DECLCALLBACK(void) Display::i_displayVBVAGuestCapabilityUpdate(PPDMIDISPLAYCONNECTOR pInterface, uint32_t fCapabilities)
4523	{
4524	LogFlowFunc(("\n"));
4525
4526	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4527	Display *pThis = pDrv->pDisplay;
4528
4529	pThis->i_handleUpdateGuestVBVACapabilities(fCapabilities);
4530	}
4531
4532	DECLCALLBACK(void) Display::i_displayVBVAInputMappingUpdate(PPDMIDISPLAYCONNECTOR pInterface, int32_t xOrigin, int32_t yOrigin,
4533	uint32_t cx, uint32_t cy)
4534	{
4535	LogFlowFunc(("\n"));
4536
4537	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4538	Display *pThis = pDrv->pDisplay;
4539
4540	pThis->i_handleUpdateVBVAInputMapping(xOrigin, yOrigin, cx, cy);
4541	}
4542
4543	DECLCALLBACK(void) Display::i_displayVBVAReportCursorPosition(PPDMIDISPLAYCONNECTOR pInterface, uint32_t fFlags, uint32_t aScreenId, uint32_t x, uint32_t y)
4544	{
4545	LogFlowFunc(("\n"));
4546	LogRel2(("%s: fFlags=%RU32, aScreenId=%RU32, x=%RU32, y=%RU32\n",
4547	__PRETTY_FUNCTION__, fFlags, aScreenId, x, y));
4548
4549	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4550	Display *pThis = pDrv->pDisplay;
4551
4552	if (fFlags & VBVA_CURSOR_SCREEN_RELATIVE)
4553	{
4554	x += pThis->maFramebuffers[aScreenId].xOrigin;
4555	y += pThis->maFramebuffers[aScreenId].yOrigin;
4556	}
4557	fireCursorPositionChangedEvent(pThis->mParent->i_getEventSource(), RT_BOOL(fFlags & VBVA_CURSOR_VALID_DATA), x, y);
4558	}
4559
4560	#endif /* VBOX_WITH_HGSMI */
4561
4562	/**
4563	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
4564	*/
4565	DECLCALLBACK(void ) Display::i_drvQueryInterface(PPDMIBASE pInterface, const char pszIID)
4566	{
4567	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
4568	PDRVMAINDISPLAY pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4569	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
4570	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIDISPLAYCONNECTOR, &pDrv->IConnector);
4571	return NULL;
4572	}
4573
4574
4575	/**
4576	* @interface_method_impl{PDMDRVREG,pfnPowerOff,
4577	* Tries to ensure no client calls gets to HGCM or the VGA device from here on.}
4578	*/
4579	DECLCALLBACK(void) Display::i_drvPowerOff(PPDMDRVINS pDrvIns)
4580	{
4581	PDRVMAINDISPLAY pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4582	LogRelFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
4583
4584	/*
4585	* Do much of the work that i_drvDestruct does.
4586	*/
4587	if (pThis->pUpPort)
4588	pThis->pUpPort->pfnSetRenderVRAM(pThis->pUpPort, false);
4589
4590	pThis->IConnector.pbData = NULL;
4591	pThis->IConnector.cbScanline = 0;
4592	pThis->IConnector.cBits = 32;
4593	pThis->IConnector.cx = 0;
4594	pThis->IConnector.cy = 0;
4595
4596	if (pThis->pDisplay)
4597	{
4598	AutoWriteLock displayLock(pThis->pDisplay COMMA_LOCKVAL_SRC_POS);
4599	#ifdef VBOX_WITH_RECORDING
4600	pThis->pDisplay->mParent->i_recordingStop();
4601	#endif
4602	#ifdef VBOX_WITH_CRHGSMI
4603	pThis->pDisplay->i_destructCrHgsmiData();
4604	#endif
4605	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4606	pThis->pVBVACallbacks = NULL;
4607	#endif
4608	}
4609	}
4610
4611
4612	/**
4613	* Destruct a display driver instance.
4614	*
4615	* @returns VBox status code.
4616	* @param pDrvIns The driver instance data.
4617	*/
4618	DECLCALLBACK(void) Display::i_drvDestruct(PPDMDRVINS pDrvIns)
4619	{
4620	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
4621	PDRVMAINDISPLAY pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4622	LogRelFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
4623
4624	/*
4625	* We repeat much of what i_drvPowerOff does in case it wasn't called.
4626	* In addition we sever the connection between us and the display.
4627	*/
4628	if (pThis->pUpPort)
4629	pThis->pUpPort->pfnSetRenderVRAM(pThis->pUpPort, false);
4630
4631	pThis->IConnector.pbData = NULL;
4632	pThis->IConnector.cbScanline = 0;
4633	pThis->IConnector.cBits = 32;
4634	pThis->IConnector.cx = 0;
4635	pThis->IConnector.cy = 0;
4636
4637	if (pThis->pDisplay)
4638	{
4639	AutoWriteLock displayLock(pThis->pDisplay COMMA_LOCKVAL_SRC_POS);
4640	#ifdef VBOX_WITH_RECORDING
4641	pThis->pDisplay->mParent->i_recordingStop();
4642	#endif
4643	#ifdef VBOX_WITH_CRHGSMI
4644	pThis->pDisplay->i_destructCrHgsmiData();
4645	#endif
4646	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4647	pThis->pVBVACallbacks = NULL;
4648	#endif
4649
4650	pThis->pDisplay->mpDrv = NULL;
4651	pThis->pDisplay = NULL;
4652	}
4653	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4654	pThis->pVBVACallbacks = NULL;
4655	#endif
4656	}
4657
4658
4659	/**
4660	* Construct a display driver instance.
4661	*
4662	* @copydoc FNPDMDRVCONSTRUCT
4663	*/
4664	DECLCALLBACK(int) Display::i_drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
4665	{
4666	RT_NOREF(fFlags);
4667	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
4668	PDRVMAINDISPLAY pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4669	LogRelFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
4670
4671	/*
4672	* Validate configuration.
4673	*/
4674	if (!CFGMR3AreValuesValid(pCfg, "Object\0"))
4675	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
4676	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
4677	("Configuration error: Not possible to attach anything to this driver!\n"),
4678	VERR_PDM_DRVINS_NO_ATTACH);
4679
4680	/*
4681	* Init Interfaces.
4682	*/
4683	pDrvIns->IBase.pfnQueryInterface = Display::i_drvQueryInterface;
4684
4685	pThis->IConnector.pfnResize = Display::i_displayResizeCallback;
4686	pThis->IConnector.pfnUpdateRect = Display::i_displayUpdateCallback;
4687	pThis->IConnector.pfnRefresh = Display::i_displayRefreshCallback;
4688	pThis->IConnector.pfnReset = Display::i_displayResetCallback;
4689	pThis->IConnector.pfnLFBModeChange = Display::i_displayLFBModeChangeCallback;
4690	pThis->IConnector.pfnProcessAdapterData = Display::i_displayProcessAdapterDataCallback;
4691	pThis->IConnector.pfnProcessDisplayData = Display::i_displayProcessDisplayDataCallback;
4692	#ifdef VBOX_WITH_VIDEOHWACCEL
4693	pThis->IConnector.pfnVHWACommandProcess = Display::i_displayVHWACommandProcess;
4694	#endif
4695	#ifdef VBOX_WITH_CRHGSMI
4696	pThis->IConnector.pfnCrHgsmiCommandProcess = Display::i_displayCrHgsmiCommandProcess;
4697	pThis->IConnector.pfnCrHgsmiControlProcess = Display::i_displayCrHgsmiControlProcess;
4698	#endif
4699	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
4700	pThis->IConnector.pfnCrHgcmCtlSubmit = Display::i_displayCrHgcmCtlSubmit;
4701	#endif
4702	#ifdef VBOX_WITH_HGSMI
4703	pThis->IConnector.pfnVBVAEnable = Display::i_displayVBVAEnable;
4704	pThis->IConnector.pfnVBVADisable = Display::i_displayVBVADisable;
4705	pThis->IConnector.pfnVBVAUpdateBegin = Display::i_displayVBVAUpdateBegin;
4706	pThis->IConnector.pfnVBVAUpdateProcess = Display::i_displayVBVAUpdateProcess;
4707	pThis->IConnector.pfnVBVAUpdateEnd = Display::i_displayVBVAUpdateEnd;
4708	pThis->IConnector.pfnVBVAResize = Display::i_displayVBVAResize;
4709	pThis->IConnector.pfnVBVAMousePointerShape = Display::i_displayVBVAMousePointerShape;
4710	pThis->IConnector.pfnVBVAGuestCapabilityUpdate = Display::i_displayVBVAGuestCapabilityUpdate;
4711	pThis->IConnector.pfnVBVAInputMappingUpdate = Display::i_displayVBVAInputMappingUpdate;
4712	pThis->IConnector.pfnVBVAReportCursorPosition = Display::i_displayVBVAReportCursorPosition;
4713	#endif
4714
4715	/*
4716	* Get the IDisplayPort interface of the above driver/device.
4717	*/
4718	pThis->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIDISPLAYPORT);
4719	if (!pThis->pUpPort)
4720	{
4721	AssertMsgFailed(("Configuration error: No display port interface above!\n"));
4722	return VERR_PDM_MISSING_INTERFACE_ABOVE;
4723	}
4724	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4725	pThis->pVBVACallbacks = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIDISPLAYVBVACALLBACKS);
4726	if (!pThis->pVBVACallbacks)
4727	{
4728	AssertMsgFailed(("Configuration error: No VBVA callback interface above!\n"));
4729	return VERR_PDM_MISSING_INTERFACE_ABOVE;
4730	}
4731	#endif
4732	/*
4733	* Get the Display object pointer and update the mpDrv member.
4734	*/
4735	void *pv;
4736	int rc = CFGMR3QueryPtr(pCfg, "Object", &pv);
4737	if (RT_FAILURE(rc))
4738	{
4739	AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
4740	return rc;
4741	}
4742	Display pDisplay = (Display )pv; /** @todo Check this cast! */
4743	pThis->pDisplay = pDisplay;
4744	pThis->pDisplay->mpDrv = pThis;
4745
4746	/* Disable VRAM to a buffer copy initially. */
4747	pThis->pUpPort->pfnSetRenderVRAM(pThis->pUpPort, false);
4748	pThis->IConnector.cBits = 32; /* DevVGA does nothing otherwise. */
4749
4750	/*
4751	* Start periodic screen refreshes
4752	*/
4753	pThis->pUpPort->pfnSetRefreshRate(pThis->pUpPort, 20);
4754
4755	#ifdef VBOX_WITH_CRHGSMI
4756	pDisplay->i_setupCrHgsmiData();
4757	#endif
4758
4759	return rc;
4760	}
4761
4762
4763	/**
4764	* Display driver registration record.
4765	*/
4766	const PDMDRVREG Display::DrvReg =
4767	{
4768	/* u32Version */
4769	PDM_DRVREG_VERSION,
4770	/* szName */
4771	"MainDisplay",
4772	/* szRCMod */
4773	"",
4774	/* szR0Mod */
4775	"",
4776	/* pszDescription */
4777	"Main display driver (Main as in the API).",
4778	/* fFlags */
4779	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
4780	/* fClass. */
4781	PDM_DRVREG_CLASS_DISPLAY,
4782	/* cMaxInstances */
4783	~0U,
4784	/* cbInstance */
4785	sizeof(DRVMAINDISPLAY),
4786	/* pfnConstruct */
4787	Display::i_drvConstruct,
4788	/* pfnDestruct */
4789	Display::i_drvDestruct,
4790	/* pfnRelocate */
4791	NULL,
4792	/* pfnIOCtl */
4793	NULL,
4794	/* pfnPowerOn */
4795	NULL,
4796	/* pfnReset */
4797	NULL,
4798	/* pfnSuspend */
4799	NULL,
4800	/* pfnResume */
4801	NULL,
4802	/* pfnAttach */
4803	NULL,
4804	/* pfnDetach */
4805	NULL,
4806	/* pfnPowerOff */
4807	Display::i_drvPowerOff,
4808	/* pfnSoftReset */
4809	NULL,
4810	/* u32EndVersion */
4811	PDM_DRVREG_VERSION
4812	};
4813
4814	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-client/DisplayImpl.cpp@ 78824

Download in other formats: