DisplayImpl.cpp@ 78915

Last change on this file since 78915 was 78847, checked in by vboxsync, 6 years ago
API: do not loose monitor information which was set before devices start. bugref:9472: API: let the GUI notice video mode hints from other sources.
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 78847 2019-05-29 13:29:34Z 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	VMMDevDisplayDef d;
1978	d.idDisplay = aDisplay;
1979	d.xOrigin = aOriginX;
1980	d.yOrigin = aOriginY;
1981	d.cx = aWidth;
1982	d.cy = aHeight;
1983	d.cBitsPerPixel = aBitsPerPixel;
1984	d.fDisplayFlags = VMMDEV_DISPLAY_CX \| VMMDEV_DISPLAY_CY \| VMMDEV_DISPLAY_BPP;
1985	if (!aEnabled)
1986	d.fDisplayFlags \|= VMMDEV_DISPLAY_DISABLED;
1987	if (aChangeOrigin)
1988	d.fDisplayFlags \|= VMMDEV_DISPLAY_ORIGIN;
1989	if (aDisplay == 0)
1990	d.fDisplayFlags \|= VMMDEV_DISPLAY_PRIMARY;
1991
1992	/* Remember the monitor information. */
1993	maFramebuffers[aDisplay].monitorDesc = d;
1994
1995	CHECK_CONSOLE_DRV(mpDrv);
1996
1997	/*
1998	* It is up to the guest to decide whether the hint is
1999	* valid. Therefore don't do any VRAM sanity checks here.
2000	*/
2001
2002	/* Have to release the lock because the pfnRequestDisplayChange
2003	* will call EMT. */
2004	alock.release();
2005
2006	/* We always send the hint to the graphics card in case the guest enables
2007	* support later. For now we notify exactly when support is enabled. */
2008	mpDrv->pUpPort->pfnSendModeHint(mpDrv->pUpPort, aWidth, aHeight,
2009	aBitsPerPixel, aDisplay,
2010	aChangeOrigin ? aOriginX : ~0,
2011	aChangeOrigin ? aOriginY : ~0,
2012	RT_BOOL(aEnabled),
2013	mfGuestVBVACapabilities
2014	& VBVACAPS_VIDEO_MODE_HINTS);
2015	if ( mfGuestVBVACapabilities & VBVACAPS_VIDEO_MODE_HINTS
2016	&& !(mfGuestVBVACapabilities & VBVACAPS_IRQ))
2017	{
2018	mParent->i_sendACPIMonitorHotPlugEvent();
2019	}
2020
2021	/* We currently never suppress the VMMDev hint if the guest has requested
2022	* it. Specifically the video graphics driver may not be responsible for
2023	* screen positioning in the guest virtual desktop, and the component
2024	* responsible may want to get the hint from VMMDev. */
2025	VMMDev *pVMMDev = mParent->i_getVMMDev();
2026	if (pVMMDev)
2027	{
2028	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
2029	if (pVMMDevPort)
2030	pVMMDevPort->pfnRequestDisplayChange(pVMMDevPort, 1, &d, false);
2031	}
2032	/* Notify listeners. */
2033	fireGuestMonitorInfoChangedEvent(mParent->i_getEventSource(), aDisplay);
2034	return S_OK;
2035	}
2036
2037	HRESULT Display::getVideoModeHint(ULONG cDisplay, BOOL *pfEnabled,
2038	BOOL pfChangeOrigin, LONG pxOrigin, LONG *pyOrigin,
2039	ULONG pcx, ULONG pcy, ULONG *pcBitsPerPixel)
2040	{
2041	if (cDisplay >= mcMonitors)
2042	return E_INVALIDARG;
2043
2044	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2045	if (pfEnabled)
2046	*pfEnabled = !( maFramebuffers[cDisplay].monitorDesc.fDisplayFlags
2047	& VMMDEV_DISPLAY_DISABLED);
2048	if (pfChangeOrigin)
2049	*pfChangeOrigin = RT_BOOL( maFramebuffers[cDisplay].monitorDesc.fDisplayFlags
2050	& VMMDEV_DISPLAY_ORIGIN);
2051	if (pxOrigin)
2052	*pxOrigin = maFramebuffers[cDisplay].monitorDesc.xOrigin;
2053	if (pyOrigin)
2054	*pyOrigin = maFramebuffers[cDisplay].monitorDesc.yOrigin;
2055	if (pcx)
2056	*pcx = maFramebuffers[cDisplay].monitorDesc.cx;
2057	if (pcy)
2058	*pcy = maFramebuffers[cDisplay].monitorDesc.cy;
2059	if (pcBitsPerPixel)
2060	*pcBitsPerPixel = maFramebuffers[cDisplay].monitorDesc.cBitsPerPixel;
2061	return S_OK;
2062	}
2063
2064	HRESULT Display::setSeamlessMode(BOOL enabled)
2065	{
2066	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2067
2068	/* Have to release the lock because the pfnRequestSeamlessChange will call EMT. */
2069	alock.release();
2070
2071	VMMDev *pVMMDev = mParent->i_getVMMDev();
2072	if (pVMMDev)
2073	{
2074	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
2075	if (pVMMDevPort)
2076	pVMMDevPort->pfnRequestSeamlessChange(pVMMDevPort, !!enabled);
2077	}
2078	mfSeamlessEnabled = RT_BOOL(enabled);
2079
2080	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2081	if (!enabled)
2082	{
2083	VMMDev *vmmDev = mParent->i_getVMMDev();
2084	if (mfIsCr3DEnabled && vmmDev)
2085	{
2086	VBOXCRCMDCTL_HGCM pData = (VBOXCRCMDCTL_HGCM)RTMemAlloc(sizeof(VBOXCRCMDCTL_HGCM));
2087	if (!pData)
2088	{
2089	AssertMsgFailed(("RTMemAlloc failed\n"));
2090	return VERR_NO_MEMORY;
2091	}
2092
2093	pData->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
2094	pData->Hdr.u32Function = SHCRGL_HOST_FN_SET_VISIBLE_REGION;
2095
2096	pData->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
2097	pData->aParms[0].u.pointer.addr = NULL;
2098	pData->aParms[0].u.pointer.size = 0; /* <- means null rects, NULL pRects address and 0 rects means "disable" */
2099
2100	int rc = i_crCtlSubmit(&pData->Hdr, sizeof(*pData), i_displayCrCmdFree, pData);
2101	if (!RT_SUCCESS(rc))
2102	{
2103	AssertMsgFailed(("crCtlSubmit failed (rc=%Rrc)\n", rc));
2104	RTMemFree(pData);
2105	}
2106	}
2107	}
2108	#endif
2109	return S_OK;
2110	}
2111
2112	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2113	BOOL Display::i_displayCheckTakeScreenshotCrOgl(Display pDisplay, ULONG aScreenId, uint8_t pbData,
2114	uint32_t u32Width, uint32_t u32Height)
2115	{
2116	if ( pDisplay->mfIsCr3DEnabled
2117	&& pDisplay->mCrOglCallbacks.pfnHasData
2118	&& pDisplay->mCrOglCallbacks.pfnHasData())
2119	{
2120	VMMDev *pVMMDev = pDisplay->mParent->i_getVMMDev();
2121	if (pVMMDev)
2122	{
2123	CRVBOXHGCMTAKESCREENSHOT pScreenshot = (CRVBOXHGCMTAKESCREENSHOT )RTMemAlloc(sizeof(*pScreenshot));
2124	if (pScreenshot)
2125	{
2126	/* screen id or CRSCREEN_ALL to specify all enabled */
2127	pScreenshot->u32Screen = aScreenId;
2128	pScreenshot->u32Width = u32Width;
2129	pScreenshot->u32Height = u32Height;
2130	pScreenshot->u32Pitch = u32Width * 4;
2131	pScreenshot->pvBuffer = pbData;
2132	pScreenshot->pvContext = NULL;
2133	pScreenshot->pfnScreenshotBegin = NULL;
2134	pScreenshot->pfnScreenshotPerform = NULL;
2135	pScreenshot->pfnScreenshotEnd = NULL;
2136
2137	VBOXCRCMDCTL_HGCM data;
2138	data.Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
2139	data.Hdr.u32Function = SHCRGL_HOST_FN_TAKE_SCREENSHOT;
2140
2141	data.aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
2142	data.aParms[0].u.pointer.addr = pScreenshot;
2143	data.aParms[0].u.pointer.size = sizeof(*pScreenshot);
2144
2145	int rc = pDisplay->i_crCtlSubmitSync(&data.Hdr, sizeof(data));
2146
2147	RTMemFree(pScreenshot);
2148
2149	if (RT_SUCCESS(rc))
2150	return TRUE;
2151	AssertMsgFailed(("failed to get screenshot data from crOgl (rc=%Rrc)\n", rc));
2152	/* fall back to the non-3d mechanism */
2153	}
2154	}
2155	}
2156	return FALSE;
2157	}
2158	#endif
2159
2160	/* static */
2161	int Display::i_displayTakeScreenshotEMT(Display pDisplay, ULONG aScreenId, uint8_t ppbData, size_t pcbData,
2162	uint32_t pcx, uint32_t pcy, bool *pfMemFree)
2163	{
2164	int rc;
2165	if ( aScreenId == VBOX_VIDEO_PRIMARY_SCREEN
2166	&& pDisplay->maFramebuffers[aScreenId].fVBVAEnabled == false) /* A non-VBVA mode. */
2167	{
2168	if (pDisplay->mpDrv)
2169	{
2170	rc = pDisplay->mpDrv->pUpPort->pfnTakeScreenshot(pDisplay->mpDrv->pUpPort, ppbData, pcbData, pcx, pcy);
2171	*pfMemFree = false;
2172	}
2173	else
2174	{
2175	/* No image. */
2176	*ppbData = NULL;
2177	*pcbData = 0;
2178	*pcx = 0;
2179	*pcy = 0;
2180	*pfMemFree = true;
2181	rc = VINF_SUCCESS;
2182	}
2183	}
2184	else if (aScreenId < pDisplay->mcMonitors)
2185	{
2186	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[aScreenId];
2187
2188	uint32_t width = pFBInfo->w;
2189	uint32_t height = pFBInfo->h;
2190
2191	/* Allocate 32 bit per pixel bitmap. */
2192	size_t cbRequired = width * 4 * height;
2193
2194	if (cbRequired)
2195	{
2196	uint8_t pbDst = (uint8_t )RTMemAlloc(cbRequired);
2197	if (pbDst != NULL)
2198	{
2199	if (pFBInfo->flags & VBVA_SCREEN_F_ACTIVE)
2200	{
2201	/* Copy guest VRAM to the allocated 32bpp buffer. */
2202	const uint8_t *pu8Src = pFBInfo->pu8FramebufferVRAM;
2203	int32_t xSrc = 0;
2204	int32_t ySrc = 0;
2205	uint32_t u32SrcWidth = width;
2206	uint32_t u32SrcHeight = height;
2207	uint32_t u32SrcLineSize = pFBInfo->u32LineSize;
2208	uint32_t u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
2209
2210	int32_t xDst = 0;
2211	int32_t yDst = 0;
2212	uint32_t u32DstWidth = u32SrcWidth;
2213	uint32_t u32DstHeight = u32SrcHeight;
2214	uint32_t u32DstLineSize = u32DstWidth * 4;
2215	uint32_t u32DstBitsPerPixel = 32;
2216
2217	rc = pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2218	width, height,
2219	pu8Src,
2220	xSrc, ySrc,
2221	u32SrcWidth, u32SrcHeight,
2222	u32SrcLineSize, u32SrcBitsPerPixel,
2223	pbDst,
2224	xDst, yDst,
2225	u32DstWidth, u32DstHeight,
2226	u32DstLineSize, u32DstBitsPerPixel);
2227	}
2228	else
2229	{
2230	memset(pbDst, 0, cbRequired);
2231	rc = VINF_SUCCESS;
2232	}
2233	if (RT_SUCCESS(rc))
2234	{
2235	*ppbData = pbDst;
2236	*pcbData = cbRequired;
2237	*pcx = width;
2238	*pcy = height;
2239	*pfMemFree = true;
2240	}
2241	else
2242	{
2243	RTMemFree(pbDst);
2244
2245	/* CopyRect can fail if VBVA was paused in VGA device, retry using the generic method. */
2246	if ( rc == VERR_INVALID_STATE
2247	&& aScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2248	{
2249	rc = pDisplay->mpDrv->pUpPort->pfnTakeScreenshot(pDisplay->mpDrv->pUpPort, ppbData, pcbData, pcx, pcy);
2250	*pfMemFree = false;
2251	}
2252	}
2253	}
2254	else
2255	rc = VERR_NO_MEMORY;
2256	}
2257	else
2258	{
2259	/* No image. */
2260	*ppbData = NULL;
2261	*pcbData = 0;
2262	*pcx = 0;
2263	*pcy = 0;
2264	*pfMemFree = true;
2265	rc = VINF_SUCCESS;
2266	}
2267	}
2268	else
2269	rc = VERR_INVALID_PARAMETER;
2270	return rc;
2271	}
2272
2273	static int i_displayTakeScreenshot(PUVM pUVM, Display pDisplay, struct DRVMAINDISPLAY pDrv, ULONG aScreenId,
2274	BYTE *address, ULONG width, ULONG height)
2275	{
2276	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2277	/*
2278	* CrOgl screenshot hook/hack.
2279	*/
2280	if (Display::i_displayCheckTakeScreenshotCrOgl(pDisplay, aScreenId, (uint8_t *)address, width, height))
2281	return VINF_SUCCESS;
2282	#endif
2283
2284	uint8_t *pbData = NULL;
2285	size_t cbData = 0;
2286	uint32_t cx = 0;
2287	uint32_t cy = 0;
2288	bool fFreeMem = false;
2289	int vrc = VINF_SUCCESS;
2290
2291	int cRetries = 5;
2292	while (cRetries-- > 0)
2293	{
2294	/* Note! Not sure if the priority call is such a good idea here, but
2295	it would be nice to have an accurate screenshot for the bug
2296	report if the VM deadlocks. */
2297	vrc = VMR3ReqPriorityCallWaitU(pUVM, VMCPUID_ANY, (PFNRT)Display::i_displayTakeScreenshotEMT, 7,
2298	pDisplay, aScreenId, &pbData, &cbData, &cx, &cy, &fFreeMem);
2299	if (vrc != VERR_TRY_AGAIN)
2300	{
2301	break;
2302	}
2303
2304	RTThreadSleep(10);
2305	}
2306
2307	if (RT_SUCCESS(vrc) && pbData)
2308	{
2309	if (cx == width && cy == height)
2310	{
2311	/* No scaling required. */
2312	memcpy(address, pbData, cbData);
2313	}
2314	else
2315	{
2316	/* Scale. */
2317	LogRelFlowFunc(("SCALE: %dx%d -> %dx%d\n", cx, cy, width, height));
2318
2319	uint8_t *dst = address;
2320	uint8_t *src = pbData;
2321	int dstW = width;
2322	int dstH = height;
2323	int srcW = cx;
2324	int srcH = cy;
2325	int iDeltaLine = cx * 4;
2326
2327	BitmapScale32(dst,
2328	dstW, dstH,
2329	src,
2330	iDeltaLine,
2331	srcW, srcH);
2332	}
2333
2334	if (fFreeMem)
2335	RTMemFree(pbData);
2336	else
2337	{
2338	/* This can be called from any thread. */
2339	pDrv->pUpPort->pfnFreeScreenshot(pDrv->pUpPort, pbData);
2340	}
2341	}
2342
2343	return vrc;
2344	}
2345
2346	HRESULT Display::takeScreenShotWorker(ULONG aScreenId,
2347	BYTE *aAddress,
2348	ULONG aWidth,
2349	ULONG aHeight,
2350	BitmapFormat_T aBitmapFormat,
2351	ULONG *pcbOut)
2352	{
2353	HRESULT rc = S_OK;
2354
2355	/* Do not allow too small and too large screenshots. This also filters out negative
2356	* values passed as either 'aWidth' or 'aHeight'.
2357	*/
2358	CheckComArgExpr(aWidth, aWidth != 0 && aWidth <= 32767);
2359	CheckComArgExpr(aHeight, aHeight != 0 && aHeight <= 32767);
2360
2361	if ( aBitmapFormat != BitmapFormat_BGR0
2362	&& aBitmapFormat != BitmapFormat_BGRA
2363	&& aBitmapFormat != BitmapFormat_RGBA
2364	&& aBitmapFormat != BitmapFormat_PNG)
2365	{
2366	return setError(E_NOTIMPL,
2367	tr("Unsupported screenshot format 0x%08X"), aBitmapFormat);
2368	}
2369
2370	Console::SafeVMPtr ptrVM(mParent);
2371	if (!ptrVM.isOk())
2372	return ptrVM.rc();
2373
2374	int vrc = i_displayTakeScreenshot(ptrVM.rawUVM(), this, mpDrv, aScreenId, aAddress, aWidth, aHeight);
2375
2376	if (RT_SUCCESS(vrc))
2377	{
2378	const size_t cbData = aWidth * 4 * aHeight;
2379
2380	/* Most of uncompressed formats. */
2381	*pcbOut = (ULONG)cbData;
2382
2383	if (aBitmapFormat == BitmapFormat_BGR0)
2384	{
2385	/* Do nothing. */
2386	}
2387	else if (aBitmapFormat == BitmapFormat_BGRA)
2388	{
2389	uint32_t pu32 = (uint32_t )aAddress;
2390	size_t cPixels = aWidth * aHeight;
2391	while (cPixels--)
2392	{
2393	*pu32++ \|= UINT32_C(0xFF000000);
2394	}
2395	}
2396	else if (aBitmapFormat == BitmapFormat_RGBA)
2397	{
2398	uint8_t *pu8 = aAddress;
2399	size_t cPixels = aWidth * aHeight;
2400	while (cPixels--)
2401	{
2402	uint8_t u8 = pu8[0];
2403	pu8[0] = pu8[2];
2404	pu8[2] = u8;
2405	pu8[3] = 0xFF;
2406
2407	pu8 += 4;
2408	}
2409	}
2410	else if (aBitmapFormat == BitmapFormat_PNG)
2411	{
2412	uint8_t *pu8PNG = NULL;
2413	uint32_t cbPNG = 0;
2414	uint32_t cxPNG = 0;
2415	uint32_t cyPNG = 0;
2416
2417	vrc = DisplayMakePNG(aAddress, aWidth, aHeight, &pu8PNG, &cbPNG, &cxPNG, &cyPNG, 0);
2418	if (RT_SUCCESS(vrc))
2419	{
2420	if (cbPNG <= cbData)
2421	{
2422	memcpy(aAddress, pu8PNG, cbPNG);
2423	*pcbOut = cbPNG;
2424	}
2425	else
2426	{
2427	rc = setError(E_FAIL,
2428	tr("PNG is larger than 32bpp bitmap"));
2429	}
2430	}
2431	else
2432	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not convert screenshot to PNG (%Rrc)"), vrc);
2433	RTMemFree(pu8PNG);
2434	}
2435	}
2436	else if (vrc == VERR_TRY_AGAIN)
2437	rc = setErrorBoth(E_UNEXPECTED, vrc, tr("Screenshot is not available at this time"));
2438	else if (RT_FAILURE(vrc))
2439	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not take a screenshot (%Rrc)"), vrc);
2440
2441	return rc;
2442	}
2443
2444	HRESULT Display::takeScreenShot(ULONG aScreenId,
2445	BYTE *aAddress,
2446	ULONG aWidth,
2447	ULONG aHeight,
2448	BitmapFormat_T aBitmapFormat)
2449	{
2450	HRESULT rc = S_OK;
2451
2452	LogRelFlowFunc(("[%d] address=%p, width=%d, height=%d, format 0x%08X\n",
2453	aScreenId, aAddress, aWidth, aHeight, aBitmapFormat));
2454
2455	ULONG cbOut = 0;
2456	rc = takeScreenShotWorker(aScreenId, aAddress, aWidth, aHeight, aBitmapFormat, &cbOut);
2457	NOREF(cbOut);
2458
2459	LogRelFlowFunc(("%Rhrc\n", rc));
2460	return rc;
2461	}
2462
2463	HRESULT Display::takeScreenShotToArray(ULONG aScreenId,
2464	ULONG aWidth,
2465	ULONG aHeight,
2466	BitmapFormat_T aBitmapFormat,
2467	std::vector<BYTE> &aScreenData)
2468	{
2469	HRESULT rc = S_OK;
2470
2471	LogRelFlowFunc(("[%d] width=%d, height=%d, format 0x%08X\n",
2472	aScreenId, aWidth, aHeight, aBitmapFormat));
2473
2474	/* Do not allow too small and too large screenshots. This also filters out negative
2475	* values passed as either 'aWidth' or 'aHeight'.
2476	*/
2477	CheckComArgExpr(aWidth, aWidth != 0 && aWidth <= 32767);
2478	CheckComArgExpr(aHeight, aHeight != 0 && aHeight <= 32767);
2479
2480	const size_t cbData = aWidth * 4 * aHeight;
2481	aScreenData.resize(cbData);
2482
2483	ULONG cbOut = 0;
2484	rc = takeScreenShotWorker(aScreenId, &aScreenData.front(), aWidth, aHeight, aBitmapFormat, &cbOut);
2485	if (FAILED(rc))
2486	cbOut = 0;
2487
2488	aScreenData.resize(cbOut);
2489
2490	LogRelFlowFunc(("%Rhrc\n", rc));
2491	return rc;
2492	}
2493
2494	#ifdef VBOX_WITH_RECORDING
2495	/**
2496	* Invalidates the recording configuration.
2497	*
2498	* @returns IPRT status code.
2499	*/
2500	int Display::i_recordingInvalidate(void)
2501	{
2502	RecordingContext *pCtx = mParent->i_recordingGetContext();
2503	if (!pCtx \|\| !pCtx->IsStarted())
2504	return VINF_SUCCESS;
2505
2506	/*
2507	* Invalidate screens.
2508	*/
2509	for (unsigned uScreen = 0; uScreen < mcMonitors; uScreen++)
2510	{
2511	RecordingStream *pRecordingStream = pCtx->GetStream(uScreen);
2512
2513	const bool fStreamEnabled = pRecordingStream->IsReady();
2514	bool fChanged = maRecordingEnabled[uScreen] != fStreamEnabled;
2515
2516	maRecordingEnabled[uScreen] = fStreamEnabled;
2517
2518	if (fChanged && uScreen < mcMonitors)
2519	i_recordingScreenChanged(uScreen);
2520	}
2521
2522	return VINF_SUCCESS;
2523	}
2524
2525	void Display::i_recordingScreenChanged(unsigned uScreenId)
2526	{
2527	RecordingContext *pCtx = mParent->i_recordingGetContext();
2528
2529	i_UpdateDeviceCursorCapabilities();
2530	if ( RT_LIKELY(!maRecordingEnabled[uScreenId])
2531	\|\| !pCtx \|\| !pCtx->IsStarted())
2532	{
2533	/* Skip recording this screen. */
2534	return;
2535	}
2536
2537	/* Get a new source bitmap which will be used by video recording code. */
2538	ComPtr<IDisplaySourceBitmap> pSourceBitmap;
2539	QuerySourceBitmap(uScreenId, pSourceBitmap.asOutParam());
2540
2541	int rc2 = RTCritSectEnter(&mVideoRecLock);
2542	if (RT_SUCCESS(rc2))
2543	{
2544	maFramebuffers[uScreenId].Recording.pSourceBitmap = pSourceBitmap;
2545
2546	rc2 = RTCritSectLeave(&mVideoRecLock);
2547	AssertRC(rc2);
2548	}
2549	}
2550	#endif /* VBOX_WITH_RECORDING */
2551
2552	int Display::i_drawToScreenEMT(Display pDisplay, ULONG aScreenId, BYTE address,
2553	ULONG x, ULONG y, ULONG width, ULONG height)
2554	{
2555	int rc = VINF_SUCCESS;
2556
2557	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[aScreenId];
2558
2559	if (aScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2560	{
2561	rc = pDisplay->mpDrv->pUpPort->pfnDisplayBlt(pDisplay->mpDrv->pUpPort, address, x, y, width, height);
2562	}
2563	else if (aScreenId < pDisplay->mcMonitors)
2564	{
2565	/* Copy the bitmap to the guest VRAM. */
2566	const uint8_t *pu8Src = address;
2567	int32_t xSrc = 0;
2568	int32_t ySrc = 0;
2569	uint32_t u32SrcWidth = width;
2570	uint32_t u32SrcHeight = height;
2571	uint32_t u32SrcLineSize = width * 4;
2572	uint32_t u32SrcBitsPerPixel = 32;
2573
2574	uint8_t *pu8Dst = pFBInfo->pu8FramebufferVRAM;
2575	int32_t xDst = x;
2576	int32_t yDst = y;
2577	uint32_t u32DstWidth = pFBInfo->w;
2578	uint32_t u32DstHeight = pFBInfo->h;
2579	uint32_t u32DstLineSize = pFBInfo->u32LineSize;
2580	uint32_t u32DstBitsPerPixel = pFBInfo->u16BitsPerPixel;
2581
2582	rc = pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2583	width, height,
2584	pu8Src,
2585	xSrc, ySrc,
2586	u32SrcWidth, u32SrcHeight,
2587	u32SrcLineSize, u32SrcBitsPerPixel,
2588	pu8Dst,
2589	xDst, yDst,
2590	u32DstWidth, u32DstHeight,
2591	u32DstLineSize, u32DstBitsPerPixel);
2592	if (RT_SUCCESS(rc))
2593	{
2594	if (!pFBInfo->pSourceBitmap.isNull())
2595	{
2596	/* Update the changed screen area. When source bitmap uses VRAM directly, just notify
2597	* frontend to update. And for default format, render the guest VRAM to the source bitmap.
2598	*/
2599	if ( pFBInfo->fDefaultFormat
2600	&& !pFBInfo->fDisabled)
2601	{
2602	BYTE *pAddress = NULL;
2603	ULONG ulWidth = 0;
2604	ULONG ulHeight = 0;
2605	ULONG ulBitsPerPixel = 0;
2606	ULONG ulBytesPerLine = 0;
2607	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
2608
2609	HRESULT hrc = pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
2610	&ulWidth,
2611	&ulHeight,
2612	&ulBitsPerPixel,
2613	&ulBytesPerLine,
2614	&bitmapFormat);
2615	if (SUCCEEDED(hrc))
2616	{
2617	pu8Src = pFBInfo->pu8FramebufferVRAM;
2618	xSrc = x;
2619	ySrc = y;
2620	u32SrcWidth = pFBInfo->w;
2621	u32SrcHeight = pFBInfo->h;
2622	u32SrcLineSize = pFBInfo->u32LineSize;
2623	u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
2624
2625	/* Default format is 32 bpp. */
2626	pu8Dst = pAddress;
2627	xDst = xSrc;
2628	yDst = ySrc;
2629	u32DstWidth = u32SrcWidth;
2630	u32DstHeight = u32SrcHeight;
2631	u32DstLineSize = u32DstWidth * 4;
2632	u32DstBitsPerPixel = 32;
2633
2634	pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2635	width, height,
2636	pu8Src,
2637	xSrc, ySrc,
2638	u32SrcWidth, u32SrcHeight,
2639	u32SrcLineSize, u32SrcBitsPerPixel,
2640	pu8Dst,
2641	xDst, yDst,
2642	u32DstWidth, u32DstHeight,
2643	u32DstLineSize, u32DstBitsPerPixel);
2644	}
2645	}
2646	}
2647
2648	pDisplay->i_handleDisplayUpdate(aScreenId, x, y, width, height);
2649	}
2650	}
2651	else
2652	{
2653	rc = VERR_INVALID_PARAMETER;
2654	}
2655
2656	if (RT_SUCCESS(rc))
2657	pDisplay->mParent->i_consoleVRDPServer()->SendUpdateBitmap(aScreenId, x, y, width, height);
2658
2659	return rc;
2660	}
2661
2662	HRESULT Display::drawToScreen(ULONG aScreenId, BYTE *aAddress, ULONG aX, ULONG aY, ULONG aWidth, ULONG aHeight)
2663	{
2664	/// @todo (r=dmik) this function may take too long to complete if the VM
2665	// is doing something like saving state right now. Which, in case if it
2666	// is called on the GUI thread, will make it unresponsive. We should
2667	// check the machine state here (by enclosing the check and VMRequCall
2668	// within the Console lock to make it atomic).
2669
2670	LogRelFlowFunc(("aAddress=%p, x=%d, y=%d, width=%d, height=%d\n",
2671	(void *)aAddress, aX, aY, aWidth, aHeight));
2672
2673	CheckComArgExpr(aWidth, aWidth != 0);
2674	CheckComArgExpr(aHeight, aHeight != 0);
2675
2676	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2677
2678	CHECK_CONSOLE_DRV(mpDrv);
2679
2680	Console::SafeVMPtr ptrVM(mParent);
2681	if (!ptrVM.isOk())
2682	return ptrVM.rc();
2683
2684	/* Release lock because the call scheduled on EMT may also try to take it. */
2685	alock.release();
2686
2687	/*
2688	* Again we're lazy and make the graphics device do all the
2689	* dirty conversion work.
2690	*/
2691	int vrc = VMR3ReqCallWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_drawToScreenEMT, 7,
2692	this, aScreenId, aAddress, aX, aY, aWidth, aHeight);
2693
2694	/*
2695	* If the function returns not supported, we'll have to do all the
2696	* work ourselves using the framebuffer.
2697	*/
2698	HRESULT rc = S_OK;
2699	if (vrc == VERR_NOT_SUPPORTED \|\| vrc == VERR_NOT_IMPLEMENTED)
2700	{
2701	/** @todo implement generic fallback for screen blitting. */
2702	rc = E_NOTIMPL;
2703	}
2704	else if (RT_FAILURE(vrc))
2705	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not draw to the screen (%Rrc)"), vrc);
2706	/// @todo
2707	// else
2708	// {
2709	// /* All ok. Redraw the screen. */
2710	// handleDisplayUpdate(x, y, width, height);
2711	// }
2712
2713	LogRelFlowFunc(("rc=%Rhrc\n", rc));
2714	return rc;
2715	}
2716
2717	int Display::i_InvalidateAndUpdateEMT(Display *pDisplay, unsigned uId, bool fUpdateAll)
2718	{
2719	LogRelFlowFunc(("uId=%d, fUpdateAll %d\n", uId, fUpdateAll));
2720
2721	unsigned uScreenId;
2722	for (uScreenId = (fUpdateAll ? 0 : uId); uScreenId < pDisplay->mcMonitors; uScreenId++)
2723	{
2724	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[uScreenId];
2725
2726	if ( !pFBInfo->fVBVAEnabled
2727	&& uScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2728	{
2729	pDisplay->mpDrv->pUpPort->pfnUpdateDisplayAll(pDisplay->mpDrv->pUpPort, /* fFailOnResize = */ true);
2730	}
2731	else
2732	{
2733	if (!pFBInfo->fDisabled)
2734	{
2735	/* Render complete VRAM screen to the framebuffer.
2736	* When framebuffer uses VRAM directly, just notify it to update.
2737	*/
2738	if (pFBInfo->fDefaultFormat && !pFBInfo->pSourceBitmap.isNull())
2739	{
2740	BYTE *pAddress = NULL;
2741	ULONG ulWidth = 0;
2742	ULONG ulHeight = 0;
2743	ULONG ulBitsPerPixel = 0;
2744	ULONG ulBytesPerLine = 0;
2745	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
2746
2747	HRESULT hrc = pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
2748	&ulWidth,
2749	&ulHeight,
2750	&ulBitsPerPixel,
2751	&ulBytesPerLine,
2752	&bitmapFormat);
2753	if (SUCCEEDED(hrc))
2754	{
2755	uint32_t width = pFBInfo->w;
2756	uint32_t height = pFBInfo->h;
2757
2758	const uint8_t *pu8Src = pFBInfo->pu8FramebufferVRAM;
2759	int32_t xSrc = 0;
2760	int32_t ySrc = 0;
2761	uint32_t u32SrcWidth = pFBInfo->w;
2762	uint32_t u32SrcHeight = pFBInfo->h;
2763	uint32_t u32SrcLineSize = pFBInfo->u32LineSize;
2764	uint32_t u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
2765
2766	/* Default format is 32 bpp. */
2767	uint8_t *pu8Dst = pAddress;
2768	int32_t xDst = xSrc;
2769	int32_t yDst = ySrc;
2770	uint32_t u32DstWidth = u32SrcWidth;
2771	uint32_t u32DstHeight = u32SrcHeight;
2772	uint32_t u32DstLineSize = u32DstWidth * 4;
2773	uint32_t u32DstBitsPerPixel = 32;
2774
2775	/* if uWidth != pFBInfo->w and uHeight != pFBInfo->h
2776	* implies resize of Framebuffer is in progress and
2777	* copyrect should not be called.
2778	*/
2779	if (ulWidth == pFBInfo->w && ulHeight == pFBInfo->h)
2780	{
2781	pDisplay->mpDrv->pUpPort->pfnCopyRect(pDisplay->mpDrv->pUpPort,
2782	width, height,
2783	pu8Src,
2784	xSrc, ySrc,
2785	u32SrcWidth, u32SrcHeight,
2786	u32SrcLineSize, u32SrcBitsPerPixel,
2787	pu8Dst,
2788	xDst, yDst,
2789	u32DstWidth, u32DstHeight,
2790	u32DstLineSize, u32DstBitsPerPixel);
2791	}
2792	}
2793	}
2794
2795	pDisplay->i_handleDisplayUpdate(uScreenId, 0, 0, pFBInfo->w, pFBInfo->h);
2796	}
2797	}
2798	if (!fUpdateAll)
2799	break;
2800	}
2801	LogRelFlowFunc(("done\n"));
2802	return VINF_SUCCESS;
2803	}
2804
2805	/**
2806	* Does a full invalidation of the VM display and instructs the VM
2807	* to update it immediately.
2808	*
2809	* @returns COM status code
2810	*/
2811
2812	HRESULT Display::invalidateAndUpdate()
2813	{
2814	LogRelFlowFunc(("\n"));
2815
2816	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2817
2818	CHECK_CONSOLE_DRV(mpDrv);
2819
2820	Console::SafeVMPtr ptrVM(mParent);
2821	if (!ptrVM.isOk())
2822	return ptrVM.rc();
2823
2824	HRESULT rc = S_OK;
2825
2826	LogRelFlowFunc(("Sending DPYUPDATE request\n"));
2827
2828	/* Have to release the lock when calling EMT. */
2829	alock.release();
2830
2831	int vrc = VMR3ReqCallNoWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_InvalidateAndUpdateEMT,
2832	3, this, 0, true);
2833	alock.acquire();
2834
2835	if (RT_FAILURE(vrc))
2836	rc = setErrorBoth(VBOX_E_VM_ERROR, vrc, tr("Could not invalidate and update the screen (%Rrc)"), vrc);
2837
2838	LogRelFlowFunc(("rc=%Rhrc\n", rc));
2839	return rc;
2840	}
2841
2842	HRESULT Display::invalidateAndUpdateScreen(ULONG aScreenId)
2843	{
2844	LogRelFlowFunc(("\n"));
2845
2846	HRESULT rc = S_OK;
2847
2848	Console::SafeVMPtr ptrVM(mParent);
2849	if (!ptrVM.isOk())
2850	return ptrVM.rc();
2851
2852	int vrc = VMR3ReqCallNoWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_InvalidateAndUpdateEMT,
2853	3, this, aScreenId, false);
2854	if (RT_FAILURE(vrc))
2855	rc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("Could not invalidate and update the screen %d (%Rrc)"), aScreenId, vrc);
2856
2857	LogRelFlowFunc(("rc=%Rhrc\n", rc));
2858	return rc;
2859	}
2860
2861	HRESULT Display::completeVHWACommand(BYTE *aCommand)
2862	{
2863	#ifdef VBOX_WITH_VIDEOHWACCEL
2864	mpDrv->pVBVACallbacks->pfnVHWACommandCompleteAsync(mpDrv->pVBVACallbacks, (VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *)aCommand);
2865	return S_OK;
2866	#else
2867	return E_NOTIMPL;
2868	#endif
2869	}
2870
2871	HRESULT Display::viewportChanged(ULONG aScreenId, ULONG aX, ULONG aY, ULONG aWidth, ULONG aHeight)
2872	{
2873	AssertMsgReturn(aScreenId < mcMonitors, ("aScreendId=%d mcMonitors=%d\n", aScreenId, mcMonitors), E_INVALIDARG);
2874
2875	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
2876	if (mfIsCr3DEnabled)
2877	{
2878	int rc = i_crViewportNotify(aScreenId, aX, aY, aWidth, aHeight);
2879	if (RT_FAILURE(rc))
2880	{
2881	DISPLAYFBINFO *pFb = &maFramebuffers[aScreenId];
2882	pFb->pendingViewportInfo.fPending = true;
2883	pFb->pendingViewportInfo.x = aX;
2884	pFb->pendingViewportInfo.y = aY;
2885	pFb->pendingViewportInfo.width = aWidth;
2886	pFb->pendingViewportInfo.height = aHeight;
2887	}
2888	}
2889	#endif /* VBOX_WITH_CROGL && VBOX_WITH_HGCM */
2890
2891	/* The driver might not have been constructed yet */
2892	if (mpDrv && mpDrv->pUpPort->pfnSetViewport)
2893	mpDrv->pUpPort->pfnSetViewport(mpDrv->pUpPort, aScreenId, aX, aY, aWidth, aHeight);
2894
2895	return S_OK;
2896	}
2897
2898	HRESULT Display::querySourceBitmap(ULONG aScreenId,
2899	ComPtr<IDisplaySourceBitmap> &aDisplaySourceBitmap)
2900	{
2901	LogRelFlowFunc(("aScreenId = %d\n", aScreenId));
2902
2903	Console::SafeVMPtr ptrVM(mParent);
2904	if (!ptrVM.isOk())
2905	return ptrVM.rc();
2906
2907	CHECK_CONSOLE_DRV(mpDrv);
2908
2909	bool fSetRenderVRAM = false;
2910	bool fInvalidate = false;
2911
2912	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2913
2914	if (aScreenId >= mcMonitors)
2915	return setError(E_INVALIDARG, tr("QuerySourceBitmap: Invalid screen %d (total %d)"),
2916	aScreenId, mcMonitors);
2917
2918	if (!mfSourceBitmapEnabled)
2919	{
2920	aDisplaySourceBitmap = NULL;
2921	return E_FAIL;
2922	}
2923
2924	DISPLAYFBINFO *pFBInfo = &maFramebuffers[aScreenId];
2925
2926	/* No source bitmap for a blank guest screen. */
2927	if (pFBInfo->flags & VBVA_SCREEN_F_BLANK)
2928	{
2929	aDisplaySourceBitmap = NULL;
2930	return E_FAIL;
2931	}
2932
2933	HRESULT hr = S_OK;
2934
2935	if (pFBInfo->pSourceBitmap.isNull())
2936	{
2937	/* Create a new object. */
2938	ComObjPtr<DisplaySourceBitmap> obj;
2939	hr = obj.createObject();
2940	if (SUCCEEDED(hr))
2941	hr = obj->init(this, aScreenId, pFBInfo);
2942
2943	if (SUCCEEDED(hr))
2944	{
2945	pFBInfo->pSourceBitmap = obj;
2946	pFBInfo->fDefaultFormat = !obj->i_usesVRAM();
2947
2948	if (aScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
2949	{
2950	/* Start buffer updates. */
2951	BYTE *pAddress = NULL;
2952	ULONG ulWidth = 0;
2953	ULONG ulHeight = 0;
2954	ULONG ulBitsPerPixel = 0;
2955	ULONG ulBytesPerLine = 0;
2956	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
2957
2958	pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
2959	&ulWidth,
2960	&ulHeight,
2961	&ulBitsPerPixel,
2962	&ulBytesPerLine,
2963	&bitmapFormat);
2964
2965	mpDrv->IConnector.pbData = pAddress;
2966	mpDrv->IConnector.cbScanline = ulBytesPerLine;
2967	mpDrv->IConnector.cBits = ulBitsPerPixel;
2968	mpDrv->IConnector.cx = ulWidth;
2969	mpDrv->IConnector.cy = ulHeight;
2970
2971	fSetRenderVRAM = pFBInfo->fDefaultFormat;
2972	}
2973
2974	/* Make sure that the bitmap contains the latest image. */
2975	fInvalidate = pFBInfo->fDefaultFormat;
2976	}
2977	}
2978
2979	if (SUCCEEDED(hr))
2980	{
2981	pFBInfo->pSourceBitmap.queryInterfaceTo(aDisplaySourceBitmap.asOutParam());
2982	}
2983
2984	/* Leave the IDisplay lock because the VGA device must not be called under it. */
2985	alock.release();
2986
2987	if (SUCCEEDED(hr))
2988	{
2989	if (fSetRenderVRAM)
2990	{
2991	mpDrv->pUpPort->pfnSetRenderVRAM(mpDrv->pUpPort, true);
2992	}
2993
2994	if (fInvalidate)
2995	VMR3ReqCallWaitU(ptrVM.rawUVM(), VMCPUID_ANY, (PFNRT)Display::i_InvalidateAndUpdateEMT,
2996	3, this, aScreenId, false);
2997	}
2998
2999	LogRelFlowFunc(("%Rhrc\n", hr));
3000	return hr;
3001	}
3002
3003	HRESULT Display::getGuestScreenLayout(std::vector<ComPtr<IGuestScreenInfo> > &aGuestScreenLayout)
3004	{
3005	NOREF(aGuestScreenLayout);
3006	return E_NOTIMPL;
3007	}
3008
3009	HRESULT Display::setScreenLayout(ScreenLayoutMode_T aScreenLayoutMode,
3010	const std::vector<ComPtr<IGuestScreenInfo> > &aGuestScreenInfo)
3011	{
3012	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3013
3014	if (aGuestScreenInfo.size() != mcMonitors)
3015	return E_INVALIDARG;
3016
3017	CHECK_CONSOLE_DRV(mpDrv);
3018
3019	/*
3020	* It is up to the guest to decide whether the hint is
3021	* valid. Therefore don't do any VRAM sanity checks here.
3022	*/
3023
3024	/* Have to release the lock because the pfnRequestDisplayChange
3025	* will call EMT. */
3026	alock.release();
3027
3028	VMMDev *pVMMDev = mParent->i_getVMMDev();
3029	if (pVMMDev)
3030	{
3031	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
3032	if (pVMMDevPort)
3033	{
3034	uint32_t const cDisplays = (uint32_t)aGuestScreenInfo.size();
3035
3036	size_t const cbAlloc = cDisplays * sizeof(VMMDevDisplayDef);
3037	VMMDevDisplayDef paDisplayDefs = (VMMDevDisplayDef )RTMemAlloc(cbAlloc);
3038	if (paDisplayDefs)
3039	{
3040	for (uint32_t i = 0; i < cDisplays; ++i)
3041	{
3042	VMMDevDisplayDef *p = &paDisplayDefs[i];
3043	ComPtr<IGuestScreenInfo> pScreenInfo = aGuestScreenInfo[i];
3044
3045	ULONG screenId = 0;
3046	GuestMonitorStatus_T guestMonitorStatus = GuestMonitorStatus_Enabled;
3047	BOOL origin = FALSE;
3048	BOOL primary = FALSE;
3049	LONG originX = 0;
3050	LONG originY = 0;
3051	ULONG width = 0;
3052	ULONG height = 0;
3053	ULONG bitsPerPixel = 0;
3054
3055	pScreenInfo->COMGETTER(ScreenId) (&screenId);
3056	pScreenInfo->COMGETTER(GuestMonitorStatus)(&guestMonitorStatus);
3057	pScreenInfo->COMGETTER(Primary) (&primary);
3058	pScreenInfo->COMGETTER(Origin) (&origin);
3059	pScreenInfo->COMGETTER(OriginX) (&originX);
3060	pScreenInfo->COMGETTER(OriginY) (&originY);
3061	pScreenInfo->COMGETTER(Width) (&width);
3062	pScreenInfo->COMGETTER(Height) (&height);
3063	pScreenInfo->COMGETTER(BitsPerPixel)(&bitsPerPixel);
3064
3065	LogFlowFunc(("%d %d,%d %dx%d\n", screenId, originX, originY, width, height));
3066
3067	p->idDisplay = screenId;
3068	p->xOrigin = originX;
3069	p->yOrigin = originY;
3070	p->cx = width;
3071	p->cy = height;
3072	p->cBitsPerPixel = bitsPerPixel;
3073	p->fDisplayFlags = VMMDEV_DISPLAY_CX \| VMMDEV_DISPLAY_CY \| VMMDEV_DISPLAY_BPP;
3074	if (guestMonitorStatus == GuestMonitorStatus_Disabled)
3075	p->fDisplayFlags \|= VMMDEV_DISPLAY_DISABLED;
3076	if (origin)
3077	p->fDisplayFlags \|= VMMDEV_DISPLAY_ORIGIN;
3078	if (primary)
3079	p->fDisplayFlags \|= VMMDEV_DISPLAY_PRIMARY;
3080	}
3081
3082	bool const fForce = aScreenLayoutMode == ScreenLayoutMode_Reset
3083	\|\| aScreenLayoutMode == ScreenLayoutMode_Apply;
3084	pVMMDevPort->pfnRequestDisplayChange(pVMMDevPort, cDisplays, paDisplayDefs, fForce);
3085
3086	RTMemFree(paDisplayDefs);
3087	}
3088	}
3089	}
3090	return S_OK;
3091	}
3092
3093	HRESULT Display::detachScreens(const std::vector<LONG> &aScreenIds)
3094	{
3095	NOREF(aScreenIds);
3096	return E_NOTIMPL;
3097	}
3098
3099	HRESULT Display::createGuestScreenInfo(ULONG aDisplay,
3100	GuestMonitorStatus_T aStatus,
3101	BOOL aPrimary,
3102	BOOL aChangeOrigin,
3103	LONG aOriginX,
3104	LONG aOriginY,
3105	ULONG aWidth,
3106	ULONG aHeight,
3107	ULONG aBitsPerPixel,
3108	ComPtr<IGuestScreenInfo> &aGuestScreenInfo)
3109	{
3110	/* Create a new object. */
3111	ComObjPtr<GuestScreenInfo> obj;
3112	HRESULT hr = obj.createObject();
3113	if (SUCCEEDED(hr))
3114	hr = obj->init(aDisplay, aStatus, aPrimary, aChangeOrigin, aOriginX, aOriginY,
3115	aWidth, aHeight, aBitsPerPixel);
3116	if (SUCCEEDED(hr))
3117	obj.queryInterfaceTo(aGuestScreenInfo.asOutParam());
3118
3119	return hr;
3120	}
3121
3122
3123	/*
3124	* GuestScreenInfo implementation.
3125	*/
3126	DEFINE_EMPTY_CTOR_DTOR(GuestScreenInfo)
3127
3128	HRESULT GuestScreenInfo::FinalConstruct()
3129	{
3130	return BaseFinalConstruct();
3131	}
3132
3133	void GuestScreenInfo::FinalRelease()
3134	{
3135	uninit();
3136
3137	BaseFinalRelease();
3138	}
3139
3140	HRESULT GuestScreenInfo::init(ULONG aDisplay,
3141	GuestMonitorStatus_T aGuestMonitorStatus,
3142	BOOL aPrimary,
3143	BOOL aChangeOrigin,
3144	LONG aOriginX,
3145	LONG aOriginY,
3146	ULONG aWidth,
3147	ULONG aHeight,
3148	ULONG aBitsPerPixel)
3149	{
3150	LogFlowThisFunc(("[%u]\n", aDisplay));
3151
3152	/* Enclose the state transition NotReady->InInit->Ready */
3153	AutoInitSpan autoInitSpan(this);
3154	AssertReturn(autoInitSpan.isOk(), E_FAIL);
3155
3156	mScreenId = aDisplay;
3157	mGuestMonitorStatus = aGuestMonitorStatus;
3158	mPrimary = aPrimary;
3159	mOrigin = aChangeOrigin;
3160	mOriginX = aOriginX;
3161	mOriginY = aOriginY;
3162	mWidth = aWidth;
3163	mHeight = aHeight;
3164	mBitsPerPixel = aBitsPerPixel;
3165
3166	/* Confirm a successful initialization */
3167	autoInitSpan.setSucceeded();
3168
3169	return S_OK;
3170	}
3171
3172	void GuestScreenInfo::uninit()
3173	{
3174	/* Enclose the state transition Ready->InUninit->NotReady */
3175	AutoUninitSpan autoUninitSpan(this);
3176	if (autoUninitSpan.uninitDone())
3177	return;
3178
3179	LogFlowThisFunc(("[%u]\n", mScreenId));
3180	}
3181
3182	HRESULT GuestScreenInfo::getScreenId(ULONG *aScreenId)
3183	{
3184	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3185	*aScreenId = mScreenId;
3186	return S_OK;
3187	}
3188
3189	HRESULT GuestScreenInfo::getGuestMonitorStatus(GuestMonitorStatus_T *aGuestMonitorStatus)
3190	{
3191	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3192	*aGuestMonitorStatus = mGuestMonitorStatus;
3193	return S_OK;
3194	}
3195
3196	HRESULT GuestScreenInfo::getPrimary(BOOL *aPrimary)
3197	{
3198	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3199	*aPrimary = mPrimary;
3200	return S_OK;
3201	}
3202
3203	HRESULT GuestScreenInfo::getOrigin(BOOL *aOrigin)
3204	{
3205	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3206	*aOrigin = mOrigin;
3207	return S_OK;
3208	}
3209
3210	HRESULT GuestScreenInfo::getOriginX(LONG *aOriginX)
3211	{
3212	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3213	*aOriginX = mOriginX;
3214	return S_OK;
3215	}
3216
3217	HRESULT GuestScreenInfo::getOriginY(LONG *aOriginY)
3218	{
3219	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3220	*aOriginY = mOriginY;
3221	return S_OK;
3222	}
3223
3224	HRESULT GuestScreenInfo::getWidth(ULONG *aWidth)
3225	{
3226	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3227	*aWidth = mWidth;
3228	return S_OK;
3229	}
3230
3231	HRESULT GuestScreenInfo::getHeight(ULONG *aHeight)
3232	{
3233	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3234	*aHeight = mHeight;
3235	return S_OK;
3236	}
3237
3238	HRESULT GuestScreenInfo::getBitsPerPixel(ULONG *aBitsPerPixel)
3239	{
3240	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3241	*aBitsPerPixel = mBitsPerPixel;
3242	return S_OK;
3243	}
3244
3245	HRESULT GuestScreenInfo::getExtendedInfo(com::Utf8Str &aExtendedInfo)
3246	{
3247	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3248	aExtendedInfo = com::Utf8Str();
3249	return S_OK;
3250	}
3251
3252	// wrapped IEventListener method
3253	HRESULT Display::handleEvent(const ComPtr<IEvent> &aEvent)
3254	{
3255	VBoxEventType_T aType = VBoxEventType_Invalid;
3256
3257	aEvent->COMGETTER(Type)(&aType);
3258	switch (aType)
3259	{
3260	case VBoxEventType_OnStateChanged:
3261	{
3262	ComPtr<IStateChangedEvent> scev = aEvent;
3263	Assert(scev);
3264	MachineState_T machineState;
3265	scev->COMGETTER(State)(&machineState);
3266	if ( machineState == MachineState_Running
3267	\|\| machineState == MachineState_Teleporting
3268	\|\| machineState == MachineState_LiveSnapshotting
3269	\|\| machineState == MachineState_DeletingSnapshotOnline
3270	)
3271	{
3272	LogRelFlowFunc(("Machine is running.\n"));
3273
3274	#ifdef VBOX_WITH_CROGL
3275	i_crOglWindowsShow(true);
3276	#endif
3277	}
3278	else
3279	{
3280	#ifdef VBOX_WITH_CROGL
3281	if (machineState == MachineState_Paused)
3282	i_crOglWindowsShow(false);
3283	#endif
3284	}
3285	break;
3286	}
3287	default:
3288	AssertFailed();
3289	}
3290
3291	return S_OK;
3292	}
3293
3294
3295	// private methods
3296	/////////////////////////////////////////////////////////////////////////////
3297
3298	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3299	int Display::i_crViewportNotify(ULONG aScreenId, ULONG x, ULONG y, ULONG width, ULONG height)
3300	{
3301	VMMDev *pVMMDev = mParent->i_getVMMDev();
3302	if (!pVMMDev)
3303	return VERR_INVALID_STATE;
3304
3305	size_t cbData = RT_UOFFSETOF_DYN(VBOXCRCMDCTL_HGCM, aParms[5]); /* (clang doesn't think this is a POD, thus _DYN.) */
3306	VBOXCRCMDCTL_HGCM pData = (VBOXCRCMDCTL_HGCM )alloca(cbData);
3307
3308	pData->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
3309	pData->Hdr.u32Function = SHCRGL_HOST_FN_VIEWPORT_CHANGED;
3310
3311	pData->aParms[0].type = VBOX_HGCM_SVC_PARM_32BIT;
3312	pData->aParms[0].u.uint32 = aScreenId;
3313
3314	pData->aParms[1].type = VBOX_HGCM_SVC_PARM_32BIT;
3315	pData->aParms[1].u.uint32 = x;
3316
3317	pData->aParms[2].type = VBOX_HGCM_SVC_PARM_32BIT;
3318	pData->aParms[2].u.uint32 = y;
3319
3320	pData->aParms[3].type = VBOX_HGCM_SVC_PARM_32BIT;
3321	pData->aParms[3].u.uint32 = width;
3322
3323	pData->aParms[4].type = VBOX_HGCM_SVC_PARM_32BIT;
3324	pData->aParms[4].u.uint32 = height;
3325
3326	return i_crCtlSubmitSyncIfHasDataForScreen(aScreenId, &pData->Hdr, (uint32_t)cbData);
3327	}
3328	#endif
3329	#ifdef VBOX_WITH_CRHGSMI
3330
3331	void Display::i_setupCrHgsmiData(void)
3332	{
3333	VMMDev *pVMMDev = mParent->i_getVMMDev();
3334	Assert(pVMMDev);
3335	int rc = RTCritSectRwEnterExcl(&mCrOglLock);
3336	AssertRC(rc);
3337
3338	if (pVMMDev)
3339	rc = pVMMDev->hgcmHostSvcHandleCreate("VBoxSharedCrOpenGL", &mhCrOglSvc);
3340	else
3341	rc = VERR_GENERAL_FAILURE;
3342
3343	if (RT_SUCCESS(rc))
3344	{
3345	Assert(mhCrOglSvc);
3346	/* setup command completion callback */
3347	VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_MAINCB Completion;
3348	Completion.Hdr.enmType = VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP_MAINCB;
3349	Completion.Hdr.cbCmd = sizeof(Completion);
3350	Completion.hCompletion = mpDrv->pVBVACallbacks;
3351	Completion.pfnCompletion = mpDrv->pVBVACallbacks->pfnCrHgsmiCommandCompleteAsync;
3352
3353	VBOXHGCMSVCPARM parm;
3354	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3355	parm.u.pointer.addr = &Completion;
3356	parm.u.pointer.size = 0;
3357
3358	rc = pVMMDev->hgcmHostCall("VBoxSharedCrOpenGL", SHCRGL_HOST_FN_CRHGSMI_CTL, 1, &parm);
3359	if (RT_SUCCESS(rc))
3360	mCrOglCallbacks = Completion.MainInterface;
3361	else
3362	AssertMsgFailed(("VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP_COMPLETION failed (rc=%Rrc)\n", rc));
3363	}
3364
3365	if (RT_FAILURE(rc))
3366	mhCrOglSvc = NULL;
3367
3368	RTCritSectRwLeaveExcl(&mCrOglLock);
3369	}
3370
3371	void Display::i_destructCrHgsmiData(void)
3372	{
3373	int rc = RTCritSectRwEnterExcl(&mCrOglLock);
3374	AssertRC(rc);
3375	mhCrOglSvc = NULL;
3376	RTCritSectRwLeaveExcl(&mCrOglLock);
3377	}
3378
3379	#endif /* VBOX_WITH_CRHGSMI */
3380
3381	/**
3382	* Handle display resize event issued by the VGA device for the primary screen.
3383	*
3384	* @see PDMIDISPLAYCONNECTOR::pfnResize
3385	*/
3386	DECLCALLBACK(int) Display::i_displayResizeCallback(PPDMIDISPLAYCONNECTOR pInterface,
3387	uint32_t bpp, void *pvVRAM, uint32_t cbLine, uint32_t cx, uint32_t cy)
3388	{
3389	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3390	Display *pThis = pDrv->pDisplay;
3391
3392	LogRelFlowFunc(("bpp %d, pvVRAM %p, cbLine %d, cx %d, cy %d\n",
3393	bpp, pvVRAM, cbLine, cx, cy));
3394
3395	bool f = ASMAtomicCmpXchgBool(&pThis->fVGAResizing, true, false);
3396	if (!f)
3397	{
3398	/* This is a result of recursive call when the source bitmap is being updated
3399	* during a VGA resize. Tell the VGA device to ignore the call.
3400	*
3401	* @todo It is a workaround, actually pfnUpdateDisplayAll must
3402	* fail on resize.
3403	*/
3404	LogRel(("displayResizeCallback: already processing\n"));
3405	return VINF_VGA_RESIZE_IN_PROGRESS;
3406	}
3407
3408	int rc = pThis->i_handleDisplayResize(VBOX_VIDEO_PRIMARY_SCREEN, bpp, pvVRAM, cbLine, cx, cy, 0, 0, 0, true);
3409
3410	/* Restore the flag. */
3411	f = ASMAtomicCmpXchgBool(&pThis->fVGAResizing, false, true);
3412	AssertRelease(f);
3413
3414	return rc;
3415	}
3416
3417	/**
3418	* Handle display update.
3419	*
3420	* @see PDMIDISPLAYCONNECTOR::pfnUpdateRect
3421	*/
3422	DECLCALLBACK(void) Display::i_displayUpdateCallback(PPDMIDISPLAYCONNECTOR pInterface,
3423	uint32_t x, uint32_t y, uint32_t cx, uint32_t cy)
3424	{
3425	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3426
3427	#ifdef DEBUG_sunlover
3428	LogFlowFunc(("fVideoAccelEnabled = %d, %d,%d %dx%d\n",
3429	pDrv->pDisplay->mVideoAccelLegacy.fVideoAccelEnabled, x, y, cx, cy));
3430	#endif /* DEBUG_sunlover */
3431
3432	/* This call does update regardless of VBVA status.
3433	* But in VBVA mode this is called only as result of
3434	* pfnUpdateDisplayAll in the VGA device.
3435	*/
3436
3437	pDrv->pDisplay->i_handleDisplayUpdate(VBOX_VIDEO_PRIMARY_SCREEN, x, y, cx, cy);
3438	}
3439
3440	/**
3441	* Periodic display refresh callback.
3442	*
3443	* @see PDMIDISPLAYCONNECTOR::pfnRefresh
3444	* @thread EMT
3445	*/
3446	/static/ DECLCALLBACK(void) Display::i_displayRefreshCallback(PPDMIDISPLAYCONNECTOR pInterface)
3447	{
3448	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3449
3450	#ifdef DEBUG_sunlover_2
3451	LogFlowFunc(("pDrv->pDisplay->mfVideoAccelEnabled = %d\n",
3452	pDrv->pDisplay->mfVideoAccelEnabled));
3453	#endif /* DEBUG_sunlover_2 */
3454
3455	Display *pDisplay = pDrv->pDisplay;
3456	unsigned uScreenId;
3457
3458	int rc = pDisplay->i_videoAccelRefreshProcess(pDrv->pUpPort);
3459	if (rc != VINF_TRY_AGAIN) /* Means 'do nothing' here. */
3460	{
3461	if (rc == VWRN_INVALID_STATE)
3462	{
3463	/* No VBVA do a display update. */
3464	pDrv->pUpPort->pfnUpdateDisplay(pDrv->pUpPort);
3465	}
3466
3467	/* Inform the VRDP server that the current display update sequence is
3468	* completed. At this moment the framebuffer memory contains a definite
3469	* image, that is synchronized with the orders already sent to VRDP client.
3470	* The server can now process redraw requests from clients or initial
3471	* fullscreen updates for new clients.
3472	*/
3473	for (uScreenId = 0; uScreenId < pDisplay->mcMonitors; uScreenId++)
3474	{
3475	Assert(pDisplay->mParent && pDisplay->mParent->i_consoleVRDPServer());
3476	pDisplay->mParent->i_consoleVRDPServer()->SendUpdate(uScreenId, NULL, 0);
3477	}
3478	}
3479
3480	#ifdef VBOX_WITH_RECORDING
3481	AssertPtr(pDisplay->mParent);
3482	RecordingContext *pCtx = pDisplay->mParent->i_recordingGetContext();
3483
3484	if ( pCtx
3485	&& pCtx->IsStarted()
3486	&& pCtx->IsFeatureEnabled(RecordingFeature_Video))
3487	{
3488	do {
3489	# if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3490	if (pDisplay->mfIsCr3DEnabled)
3491	{
3492	if (ASMAtomicCmpXchgU32(&pDisplay->mfCrOglVideoRecState, CRVREC_STATE_SUBMITTED, CRVREC_STATE_IDLE))
3493	{
3494	if ( pDisplay->mCrOglCallbacks.pfnHasData
3495	&& pDisplay->mCrOglCallbacks.pfnHasData())
3496	{
3497	/* submit */
3498	VBOXCRCMDCTL_HGCM *pData = &pDisplay->mCrOglScreenshotCtl;
3499
3500	pData->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
3501	pData->Hdr.u32Function = SHCRGL_HOST_FN_TAKE_SCREENSHOT;
3502
3503	pData->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
3504	pData->aParms[0].u.pointer.addr = &pDisplay->mCrOglScreenshotData;
3505	pData->aParms[0].u.pointer.size = sizeof(pDisplay->mCrOglScreenshotData);
3506	rc = pDisplay->i_crCtlSubmit(&pData->Hdr, sizeof(*pData), Display::i_displayVRecCompletion, pDisplay);
3507	if (RT_SUCCESS(rc))
3508	break;
3509	AssertMsgFailed(("crCtlSubmit failed (rc=%Rrc)\n", rc));
3510	}
3511
3512	/* no 3D data available, or error has occured,
3513	* go the straight way */
3514	ASMAtomicWriteU32(&pDisplay->mfCrOglVideoRecState, CRVREC_STATE_IDLE);
3515	}
3516	else
3517	{
3518	/* record request is still in progress, don't do anything */
3519	break;
3520	}
3521	}
3522	# endif /* VBOX_WITH_HGCM && VBOX_WITH_CROGL */
3523
3524	/* If the recording context has reached the configured recording
3525	* limit, disable recording. */
3526	if (pCtx->IsLimitReached())
3527	{
3528	pDisplay->mParent->i_onRecordingChange(FALSE /* Disable */);
3529	break;
3530	}
3531
3532	uint64_t tsNowMs = RTTimeProgramMilliTS();
3533	for (uScreenId = 0; uScreenId < pDisplay->mcMonitors; uScreenId++)
3534	{
3535	if (!pDisplay->maRecordingEnabled[uScreenId])
3536	continue;
3537
3538	DISPLAYFBINFO *pFBInfo = &pDisplay->maFramebuffers[uScreenId];
3539	if (!pFBInfo->fDisabled)
3540	{
3541	ComPtr<IDisplaySourceBitmap> pSourceBitmap;
3542	int rc2 = RTCritSectEnter(&pDisplay->mVideoRecLock);
3543	if (RT_SUCCESS(rc2))
3544	{
3545	pSourceBitmap = pFBInfo->Recording.pSourceBitmap;
3546	RTCritSectLeave(&pDisplay->mVideoRecLock);
3547	}
3548
3549	if (!pSourceBitmap.isNull())
3550	{
3551	BYTE *pbAddress = NULL;
3552	ULONG ulWidth = 0;
3553	ULONG ulHeight = 0;
3554	ULONG ulBitsPerPixel = 0;
3555	ULONG ulBytesPerLine = 0;
3556	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
3557	HRESULT hr = pSourceBitmap->QueryBitmapInfo(&pbAddress,
3558	&ulWidth,
3559	&ulHeight,
3560	&ulBitsPerPixel,
3561	&ulBytesPerLine,
3562	&bitmapFormat);
3563	if (SUCCEEDED(hr) && pbAddress)
3564	rc = pCtx->SendVideoFrame(uScreenId, 0, 0, BitmapFormat_BGR,
3565	ulBitsPerPixel, ulBytesPerLine, ulWidth, ulHeight,
3566	pbAddress, tsNowMs);
3567	else
3568	rc = VERR_NOT_SUPPORTED;
3569
3570	pSourceBitmap.setNull();
3571	}
3572	else
3573	rc = VERR_NOT_SUPPORTED;
3574
3575	if (rc == VINF_TRY_AGAIN)
3576	break;
3577	}
3578	}
3579	} while (0);
3580	}
3581	#endif /* VBOX_WITH_RECORDING */
3582
3583	#ifdef DEBUG_sunlover_2
3584	LogFlowFunc(("leave\n"));
3585	#endif /* DEBUG_sunlover_2 */
3586	}
3587
3588	/**
3589	* Reset notification
3590	*
3591	* @see PDMIDISPLAYCONNECTOR::pfnReset
3592	*/
3593	DECLCALLBACK(void) Display::i_displayResetCallback(PPDMIDISPLAYCONNECTOR pInterface)
3594	{
3595	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3596
3597	LogRelFlowFunc(("\n"));
3598
3599	/* Disable VBVA mode. */
3600	pDrv->pDisplay->VideoAccelEnableVGA(false, NULL);
3601	}
3602
3603	/**
3604	* LFBModeChange notification
3605	*
3606	* @see PDMIDISPLAYCONNECTOR::pfnLFBModeChange
3607	*/
3608	DECLCALLBACK(void) Display::i_displayLFBModeChangeCallback(PPDMIDISPLAYCONNECTOR pInterface, bool fEnabled)
3609	{
3610	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3611
3612	LogRelFlowFunc(("fEnabled=%d\n", fEnabled));
3613
3614	NOREF(fEnabled);
3615
3616	/* Disable VBVA mode in any case. The guest driver reenables VBVA mode if necessary. */
3617	pDrv->pDisplay->VideoAccelEnableVGA(false, NULL);
3618	}
3619
3620	/**
3621	* Adapter information change notification.
3622	*
3623	* @see PDMIDISPLAYCONNECTOR::pfnProcessAdapterData
3624	*/
3625	DECLCALLBACK(void) Display::i_displayProcessAdapterDataCallback(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM,
3626	uint32_t u32VRAMSize)
3627	{
3628	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3629	pDrv->pDisplay->processAdapterData(pvVRAM, u32VRAMSize);
3630	}
3631
3632	/**
3633	* Display information change notification.
3634	*
3635	* @see PDMIDISPLAYCONNECTOR::pfnProcessDisplayData
3636	*/
3637	DECLCALLBACK(void) Display::i_displayProcessDisplayDataCallback(PPDMIDISPLAYCONNECTOR pInterface,
3638	void *pvVRAM, unsigned uScreenId)
3639	{
3640	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3641	pDrv->pDisplay->processDisplayData(pvVRAM, uScreenId);
3642	}
3643
3644	#ifdef VBOX_WITH_VIDEOHWACCEL
3645
3646	#ifndef S_FALSE
3647	# define S_FALSE ((HRESULT)1L)
3648	#endif
3649
3650	int Display::i_handleVHWACommandProcess(int enmCmd, bool fGuestCmd, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand)
3651	{
3652	unsigned id = (unsigned)pCommand->iDisplay;
3653	if (id >= mcMonitors)
3654	return VERR_INVALID_PARAMETER;
3655
3656	ComPtr<IFramebuffer> pFramebuffer;
3657	AutoReadLock arlock(this COMMA_LOCKVAL_SRC_POS);
3658	pFramebuffer = maFramebuffers[id].pFramebuffer;
3659	bool fVHWASupported = RT_BOOL(maFramebuffers[id].u32Caps & FramebufferCapabilities_VHWA);
3660	arlock.release();
3661
3662	if (pFramebuffer == NULL \|\| !fVHWASupported)
3663	return VERR_NOT_IMPLEMENTED; /* Implementation is not available. */
3664
3665	HRESULT hr = pFramebuffer->ProcessVHWACommand((BYTE *)pCommand, enmCmd, fGuestCmd);
3666	if (hr == S_FALSE)
3667	return VINF_SUCCESS;
3668	if (SUCCEEDED(hr))
3669	return VINF_CALLBACK_RETURN;
3670	if (hr == E_ACCESSDENIED)
3671	return VERR_INVALID_STATE; /* notify we can not handle request atm */
3672	if (hr == E_NOTIMPL)
3673	return VERR_NOT_IMPLEMENTED;
3674	return VERR_GENERAL_FAILURE;
3675	}
3676
3677	DECLCALLBACK(int) Display::i_displayVHWACommandProcess(PPDMIDISPLAYCONNECTOR pInterface, int enmCmd, bool fGuestCmd,
3678	VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand)
3679	{
3680	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3681
3682	return pDrv->pDisplay->i_handleVHWACommandProcess(enmCmd, fGuestCmd, pCommand);
3683	}
3684	#endif
3685
3686	#ifdef VBOX_WITH_CRHGSMI
3687	void Display::i_handleCrHgsmiCommandCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam)
3688	{
3689	RT_NOREF(u32Function);
3690	mpDrv->pVBVACallbacks->pfnCrHgsmiCommandCompleteAsync(mpDrv->pVBVACallbacks,
3691	(PVBOXVDMACMD_CHROMIUM_CMD)pParam->u.pointer.addr, result);
3692	}
3693
3694	void Display::i_handleCrHgsmiControlCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam)
3695	{
3696	RT_NOREF(u32Function);
3697	PVBOXVDMACMD_CHROMIUM_CTL pCtl = (PVBOXVDMACMD_CHROMIUM_CTL)pParam->u.pointer.addr;
3698	mpDrv->pVBVACallbacks->pfnCrHgsmiControlCompleteAsync(mpDrv->pVBVACallbacks, pCtl, result);
3699	}
3700
3701	void Display::i_handleCrHgsmiCommandProcess(VBOXVDMACMD_CHROMIUM_CMD RT_UNTRUSTED_VOLATILE_GUEST *pCmd, uint32_t cbCmd)
3702	{
3703	int rc = VERR_NOT_SUPPORTED;
3704	VBOXHGCMSVCPARM parm;
3705	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3706	parm.u.pointer.addr = (void *)pCmd;
3707	parm.u.pointer.size = cbCmd;
3708
3709	if (mhCrOglSvc)
3710	{
3711	VMMDev *pVMMDev = mParent->i_getVMMDev();
3712	if (pVMMDev)
3713	{
3714	/* no completion callback is specified with this call,
3715	* the CrOgl code will complete the CrHgsmi command once it processes it */
3716	rc = pVMMDev->hgcmHostFastCallAsync(mhCrOglSvc, SHCRGL_HOST_FN_CRHGSMI_CMD, &parm, NULL, NULL);
3717	AssertRC(rc);
3718	if (RT_SUCCESS(rc))
3719	return;
3720	}
3721	else
3722	rc = VERR_INVALID_STATE;
3723	}
3724
3725	/* we are here because something went wrong with command processing, complete it */
3726	i_handleCrHgsmiCommandCompletion(rc, SHCRGL_HOST_FN_CRHGSMI_CMD, &parm);
3727	}
3728
3729	void Display::i_handleCrHgsmiControlProcess(VBOXVDMACMD_CHROMIUM_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCtl, uint32_t cbCtl)
3730	{
3731	int rc = VERR_NOT_SUPPORTED;
3732	VBOXHGCMSVCPARM parm;
3733	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3734	parm.u.pointer.addr = (void *)pCtl;
3735	parm.u.pointer.size = cbCtl;
3736
3737	if (mhCrOglSvc)
3738	{
3739	VMMDev *pVMMDev = mParent->i_getVMMDev();
3740	if (pVMMDev)
3741	{
3742	bool fCheckPendingViewport = (pCtl->enmType == VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP);
3743	rc = pVMMDev->hgcmHostFastCallAsync(mhCrOglSvc, SHCRGL_HOST_FN_CRHGSMI_CTL, &parm,
3744	Display::i_displayCrHgsmiControlCompletion, this);
3745	AssertRC(rc);
3746	if (RT_SUCCESS(rc))
3747	{
3748	if (fCheckPendingViewport)
3749	{
3750	ULONG ul;
3751	for (ul = 0; ul < mcMonitors; ul++)
3752	{
3753	DISPLAYFBINFO *pFb = &maFramebuffers[ul];
3754	if (!pFb->pendingViewportInfo.fPending)
3755	continue;
3756
3757	rc = i_crViewportNotify(ul, pFb->pendingViewportInfo.x, pFb->pendingViewportInfo.y,
3758	pFb->pendingViewportInfo.width, pFb->pendingViewportInfo.height);
3759	if (RT_SUCCESS(rc))
3760	pFb->pendingViewportInfo.fPending = false;
3761	else
3762	{
3763	AssertMsgFailed(("crViewportNotify failed (rc=%Rrc)\n", rc));
3764	rc = VINF_SUCCESS;
3765	}
3766	}
3767	}
3768	return;
3769	}
3770	}
3771	else
3772	rc = VERR_INVALID_STATE;
3773	}
3774
3775	/* we are here because something went wrong with command processing, complete it */
3776	i_handleCrHgsmiControlCompletion(rc, SHCRGL_HOST_FN_CRHGSMI_CTL, &parm);
3777	}
3778
3779	DECLCALLBACK(void) Display::i_displayCrHgsmiCommandProcess(PPDMIDISPLAYCONNECTOR pInterface,
3780	VBOXVDMACMD_CHROMIUM_CMD RT_UNTRUSTED_VOLATILE_GUEST *pCmd,
3781	uint32_t cbCmd)
3782	{
3783	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3784
3785	pDrv->pDisplay->i_handleCrHgsmiCommandProcess(pCmd, cbCmd);
3786	}
3787
3788	DECLCALLBACK(void) Display::i_displayCrHgsmiControlProcess(PPDMIDISPLAYCONNECTOR pInterface,
3789	VBOXVDMACMD_CHROMIUM_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCmd,
3790	uint32_t cbCmd)
3791	{
3792	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3793
3794	pDrv->pDisplay->i_handleCrHgsmiControlProcess(pCmd, cbCmd);
3795	}
3796
3797	DECLCALLBACK(void) Display::i_displayCrHgsmiCommandCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam,
3798	void *pvContext)
3799	{
3800	AssertMsgFailed(("not expected!\n"));
3801	Display pDisplay = (Display )pvContext;
3802	pDisplay->i_handleCrHgsmiCommandCompletion(result, u32Function, pParam);
3803	}
3804
3805	DECLCALLBACK(void) Display::i_displayCrHgsmiControlCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam,
3806	void *pvContext)
3807	{
3808	Display pDisplay = (Display )pvContext;
3809	pDisplay->i_handleCrHgsmiControlCompletion(result, u32Function, pParam);
3810
3811	}
3812	#endif
3813
3814	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3815	DECLCALLBACK(void) Display::i_displayCrHgcmCtlSubmitCompletion(int32_t result, uint32_t u32Function, PVBOXHGCMSVCPARM pParam,
3816	void *pvContext)
3817	{
3818	RT_NOREF(u32Function);
3819	VBOXCRCMDCTL pCmd = (VBOXCRCMDCTL )pParam->u.pointer.addr;
3820	if (pCmd->u.pfnInternal)
3821	((PFNCRCTLCOMPLETION)pCmd->u.pfnInternal)(pCmd, pParam->u.pointer.size, result, pvContext);
3822	}
3823
3824	int Display::i_handleCrHgcmCtlSubmit(struct VBOXCRCMDCTL RT_UNTRUSTED_VOLATILE_GUEST *pCmd, uint32_t cbCmd,
3825	PFNCRCTLCOMPLETION pfnCompletion, void *pvCompletion)
3826	{
3827	VMMDev *pVMMDev = mParent ? mParent->i_getVMMDev() : NULL;
3828	if (!pVMMDev)
3829	{
3830	AssertMsgFailed(("no vmmdev\n"));
3831	return VERR_INVALID_STATE;
3832	}
3833
3834	Assert(mhCrOglSvc);
3835	VBOXHGCMSVCPARM parm;
3836	parm.type = VBOX_HGCM_SVC_PARM_PTR;
3837	parm.u.pointer.addr = (void *)pCmd;
3838	parm.u.pointer.size = cbCmd;
3839
3840	pCmd->u.pfnInternal = (PFNRT)pfnCompletion;
3841	int rc = pVMMDev->hgcmHostFastCallAsync(mhCrOglSvc, SHCRGL_HOST_FN_CTL, &parm, i_displayCrHgcmCtlSubmitCompletion,
3842	pvCompletion);
3843	if (!RT_SUCCESS(rc))
3844	AssertMsgFailed(("hgcmHostFastCallAsync failed (rc=%Rrc)\n", rc));
3845
3846	return rc;
3847	}
3848
3849	DECLCALLBACK(int) Display::i_displayCrHgcmCtlSubmit(PPDMIDISPLAYCONNECTOR pInterface, struct VBOXCRCMDCTL *pCmd, uint32_t cbCmd,
3850	PFNCRCTLCOMPLETION pfnCompletion, void *pvCompletion)
3851	{
3852	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
3853	Display *pThis = pDrv->pDisplay;
3854	return pThis->i_handleCrHgcmCtlSubmit(pCmd, cbCmd, pfnCompletion, pvCompletion);
3855	}
3856
3857	int Display::i_crCtlSubmit(struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd, PFNCRCTLCOMPLETION pfnCompletion, void *pvCompletion)
3858	{
3859	int rc = RTCritSectRwEnterShared(&mCrOglLock);
3860	if (RT_SUCCESS(rc))
3861	{
3862	if (mhCrOglSvc)
3863	rc = mpDrv->pVBVACallbacks->pfnCrCtlSubmit(mpDrv->pVBVACallbacks, pCmd, cbCmd, pfnCompletion, pvCompletion);
3864	else
3865	rc = VERR_NOT_SUPPORTED;
3866
3867	RTCritSectRwLeaveShared(&mCrOglLock);
3868	}
3869	return rc;
3870	}
3871
3872	int Display::i_crCtlSubmitSync(struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd)
3873	{
3874	int rc = RTCritSectRwEnterShared(&mCrOglLock);
3875	if (RT_SUCCESS(rc))
3876	{
3877	if (mhCrOglSvc)
3878	rc = mpDrv->pVBVACallbacks->pfnCrCtlSubmitSync(mpDrv->pVBVACallbacks, pCmd, cbCmd);
3879	else
3880	rc = VERR_NOT_SUPPORTED;
3881
3882	RTCritSectRwLeaveShared(&mCrOglLock);
3883	}
3884	return rc;
3885	}
3886
3887	int Display::i_crCtlSubmitAsyncCmdCopy(struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd)
3888	{
3889	VBOXCRCMDCTL* pCmdCopy = (VBOXCRCMDCTL*)RTMemAlloc(cbCmd);
3890	if (!pCmdCopy)
3891	{
3892	LogRel(("RTMemAlloc failed\n"));
3893	return VERR_NO_MEMORY;
3894	}
3895
3896	memcpy(pCmdCopy, pCmd, cbCmd);
3897
3898	int rc = i_crCtlSubmit(pCmdCopy, cbCmd, i_displayCrCmdFree, pCmdCopy);
3899	if (RT_FAILURE(rc))
3900	{
3901	LogRel(("crCtlSubmit failed (rc=%Rrc)\n", rc));
3902	RTMemFree(pCmdCopy);
3903	return rc;
3904	}
3905
3906	return VINF_SUCCESS;
3907	}
3908
3909	int Display::i_crCtlSubmitSyncIfHasDataForScreen(uint32_t u32ScreenID, struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd)
3910	{
3911	int rc = RTCritSectRwEnterShared(&mCrOglLock);
3912	AssertRCReturn(rc, rc);
3913
3914	if ( mCrOglCallbacks.pfnHasDataForScreen
3915	&& mCrOglCallbacks.pfnHasDataForScreen(u32ScreenID))
3916	rc = i_crCtlSubmitSync(pCmd, cbCmd);
3917	else
3918	rc = i_crCtlSubmitAsyncCmdCopy(pCmd, cbCmd);
3919
3920	RTCritSectRwLeaveShared(&mCrOglLock);
3921
3922	return rc;
3923	}
3924
3925	bool Display::i_handleCrVRecScreenshotBegin(uint32_t uScreen, uint64_t uTimestampMs)
3926	{
3927	# ifdef VBOX_WITH_RECORDING
3928	RecordingContext *pCtx = mParent->i_recordingGetContext();
3929	return ( pCtx
3930	&& pCtx->IsReady(uScreen, uTimestampMs));
3931	# else
3932	RT_NOREF(uScreen, uTimestampMs);
3933	return false;
3934	# endif
3935	}
3936
3937	void Display::i_handleCrVRecScreenshotEnd(uint32_t uScreen, uint64_t uTimestampMs)
3938	{
3939	RT_NOREF(uScreen, uTimestampMs);
3940	}
3941
3942	void Display::i_handleCrVRecScreenshotPerform(uint32_t uScreen,
3943	uint32_t x, uint32_t y, uint32_t uPixelFormat,
3944	uint32_t uBitsPerPixel, uint32_t uBytesPerLine,
3945	uint32_t uGuestWidth, uint32_t uGuestHeight,
3946	uint8_t *pu8BufferAddress, uint64_t uTimestampMs)
3947	{
3948	Assert(mfCrOglVideoRecState == CRVREC_STATE_SUBMITTED);
3949	# ifdef VBOX_WITH_RECORDING
3950	RecordingContext *pCtx = mParent->i_recordingGetContext();
3951
3952	if ( pCtx
3953	&& pCtx->IsStarted()
3954	&& pCtx->IsFeatureEnabled(RecordingFeature_Video))
3955	{
3956	int rc2 = pCtx->SendVideoFrame(uScreen, x, y,
3957	uPixelFormat,
3958	uBitsPerPixel, uBytesPerLine,
3959	uGuestWidth, uGuestHeight,
3960	pu8BufferAddress, uTimestampMs);
3961	RT_NOREF(rc2);
3962	Assert(rc2 == VINF_SUCCESS /* \|\| rc == VERR_TRY_AGAIN \|\| rc == VINF_TRY_AGAIN*/);
3963	}
3964	# else
3965	RT_NOREF(uScreen, x, y, uPixelFormat, \
3966	uBitsPerPixel, uBytesPerLine, uGuestWidth, uGuestHeight, pu8BufferAddress, uTimestampMs);
3967	# endif /* VBOX_WITH_RECORDING */
3968	}
3969
3970	void Display::i_handleVRecCompletion()
3971	{
3972	Assert(mfCrOglVideoRecState == CRVREC_STATE_SUBMITTED);
3973	ASMAtomicWriteU32(&mfCrOglVideoRecState, CRVREC_STATE_IDLE);
3974	}
3975
3976	#endif /* VBOX_WITH_HGCM && VBOX_WITH_CROGL */
3977
3978	HRESULT Display::notifyScaleFactorChange(ULONG aScreenId, ULONG aScaleFactorWMultiplied, ULONG aScaleFactorHMultiplied)
3979	{
3980	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
3981	HRESULT hr = E_UNEXPECTED;
3982
3983	if (aScreenId >= mcMonitors)
3984	return E_INVALIDARG;
3985
3986	/* 3D acceleration enabled in VM config. */
3987	if (mfIsCr3DEnabled)
3988	{
3989	/* VBoxSharedCrOpenGL HGCM host service is running. */
3990	if (mhCrOglSvc)
3991	{
3992	VMMDev *pVMMDev = mParent->i_getVMMDev();
3993	if (pVMMDev)
3994	{
3995	VBOXCRCMDCTL_HGCM *pCtl;
3996	pCtl = (VBOXCRCMDCTL_HGCM *)RTMemAlloc(sizeof(CRVBOXHGCMSETSCALEFACTOR) + sizeof(VBOXCRCMDCTL_HGCM));
3997	if (pCtl)
3998	{
3999	CRVBOXHGCMSETSCALEFACTOR pData = (CRVBOXHGCMSETSCALEFACTOR )(pCtl + 1);
4000	int rc;
4001
4002	pData->u32Screen = aScreenId;
4003	pData->u32ScaleFactorWMultiplied = aScaleFactorWMultiplied;
4004	pData->u32ScaleFactorHMultiplied = aScaleFactorHMultiplied;
4005
4006	pCtl->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
4007	pCtl->Hdr.u32Function = SHCRGL_HOST_FN_SET_SCALE_FACTOR;
4008	pCtl->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
4009	pCtl->aParms[0].u.pointer.addr = pData;
4010	pCtl->aParms[0].u.pointer.size = sizeof(*pData);
4011
4012	rc = i_crCtlSubmitSync(&pCtl->Hdr, sizeof(*pCtl));
4013	if (RT_FAILURE(rc))
4014	AssertMsgFailed(("crCtlSubmitSync failed (rc=%Rrc)\n", rc));
4015	else
4016	hr = S_OK;
4017
4018	RTMemFree(pCtl);
4019	}
4020	else
4021	{
4022	LogRel(("Running out of memory on attempt to set OpenGL content scale factor. Ignored.\n"));
4023	hr = E_OUTOFMEMORY;
4024	}
4025	}
4026	else
4027	LogRel(("Internal error occurred on attempt to set OpenGL content scale factor. Ignored.\n"));
4028	}
4029	else
4030	LogRel(("Attempt to specify OpenGL content scale factor while corresponding HGCM host service not yet runing. Ignored.\n"));
4031	}
4032	else
4033	# if 0 /** @todo Thank you so very much from anyone using VMSVGA3d! */
4034	AssertMsgFailed(("Attempt to specify OpenGL content scale factor while 3D acceleration is disabled in VM config. Ignored.\n"));
4035	# else
4036	{
4037	hr = S_OK;
4038	/* Need an interface like this here (and the #ifdefs needs adjusting):
4039	PPDMIDISPLAYPORT pUpPort = mpDrv ? mpDrv->pUpPort : NULL;
4040	if (pUpPort && pUpPort->pfnSetScaleFactor)
4041	pUpPort->pfnSetScaleFactor(pUpPort, aScreeId, aScaleFactorWMultiplied, aScaleFactorHMultiplied); */
4042	}
4043	# endif
4044
4045	return hr;
4046
4047	#else /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4048	RT_NOREF(aScreenId, aScaleFactorWMultiplied, aScaleFactorHMultiplied);
4049	AssertMsgFailed(("Attempt to specify OpenGL content scale factor while corresponding functionality is disabled."));
4050	return E_UNEXPECTED;
4051	#endif /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4052	}
4053
4054	HRESULT Display::notifyHiDPIOutputPolicyChange(BOOL fUnscaledHiDPI)
4055	{
4056	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
4057	HRESULT hr = E_UNEXPECTED;
4058
4059	/* 3D acceleration enabled in VM config. */
4060	if (mfIsCr3DEnabled)
4061	{
4062	/* VBoxSharedCrOpenGL HGCM host service is running. */
4063	if (mhCrOglSvc)
4064	{
4065	VMMDev *pVMMDev = mParent->i_getVMMDev();
4066	if (pVMMDev)
4067	{
4068	VBOXCRCMDCTL_HGCM *pCtl;
4069	pCtl = (VBOXCRCMDCTL_HGCM *)RTMemAlloc(sizeof(CRVBOXHGCMSETUNSCALEDHIDPIOUTPUT) + sizeof(VBOXCRCMDCTL_HGCM));
4070	if (pCtl)
4071	{
4072	CRVBOXHGCMSETUNSCALEDHIDPIOUTPUT pData = (CRVBOXHGCMSETUNSCALEDHIDPIOUTPUT )(pCtl + 1);
4073	int rc;
4074
4075	pData->fUnscaledHiDPI = RT_BOOL(fUnscaledHiDPI);
4076
4077	pCtl->Hdr.enmType = VBOXCRCMDCTL_TYPE_HGCM;
4078	pCtl->Hdr.u32Function = SHCRGL_HOST_FN_SET_UNSCALED_HIDPI;
4079	pCtl->aParms[0].type = VBOX_HGCM_SVC_PARM_PTR;
4080	pCtl->aParms[0].u.pointer.addr = pData;
4081	pCtl->aParms[0].u.pointer.size = sizeof(*pData);
4082
4083	rc = i_crCtlSubmitSync(&pCtl->Hdr, sizeof(*pCtl));
4084	if (RT_FAILURE(rc))
4085	AssertMsgFailed(("crCtlSubmitSync failed (rc=%Rrc)\n", rc));
4086	else
4087	hr = S_OK;
4088
4089	RTMemFree(pCtl);
4090	}
4091	else
4092	{
4093	LogRel(("Running out of memory on attempt to notify OpenGL about HiDPI output scaling policy change. Ignored.\n"));
4094	hr = E_OUTOFMEMORY;
4095	}
4096	}
4097	else
4098	LogRel(("Internal error occurred on attempt to notify OpenGL about HiDPI output scaling policy change. Ignored.\n"));
4099	}
4100	else
4101	LogRel(("Attempt to notify OpenGL about HiDPI output scaling policy change while corresponding HGCM host service not yet runing. Ignored.\n"));
4102	}
4103	else
4104	{
4105	hr = S_OK;
4106	/* Need an interface like this here (and the #ifdefs needs adjusting):
4107	PPDMIDISPLAYPORT pUpPort = mpDrv ? mpDrv->pUpPort : NULL;
4108	if (pUpPort && pUpPort->pfnSetScaleFactor)
4109	pUpPort->pfnSetScaleFactor(pUpPort, aScreeId, aScaleFactorWMultiplied, aScaleFactorHMultiplied); */
4110	}
4111
4112	return hr;
4113
4114	#else /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4115	RT_NOREF(fUnscaledHiDPI);
4116	AssertMsgFailed(("Attempt to notify OpenGL about HiDPI output scaling policy change while corresponding functionality is disabled."));
4117	return E_UNEXPECTED;
4118	#endif /* !VBOX_WITH_HGCM \|\| !VBOX_WITH_CROGL */
4119	}
4120
4121	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
4122	DECLCALLBACK(void) Display::i_displayCrVRecScreenshotPerform(void *pvCtx, uint32_t uScreen,
4123	uint32_t x, uint32_t y,
4124	uint32_t uBitsPerPixel, uint32_t uBytesPerLine,
4125	uint32_t uGuestWidth, uint32_t uGuestHeight,
4126	uint8_t *pu8BufferAddress, uint64_t u64Timestamp)
4127	{
4128	Display pDisplay = (Display )pvCtx;
4129	pDisplay->i_handleCrVRecScreenshotPerform(uScreen,
4130	x, y, BitmapFormat_BGR, uBitsPerPixel,
4131	uBytesPerLine, uGuestWidth, uGuestHeight,
4132	pu8BufferAddress, u64Timestamp);
4133	}
4134
4135	DECLCALLBACK(bool) Display::i_displayCrVRecScreenshotBegin(void *pvCtx, uint32_t uScreen, uint64_t u64Timestamp)
4136	{
4137	Display pDisplay = (Display )pvCtx;
4138	return pDisplay->i_handleCrVRecScreenshotBegin(uScreen, u64Timestamp);
4139	}
4140
4141	DECLCALLBACK(void) Display::i_displayCrVRecScreenshotEnd(void *pvCtx, uint32_t uScreen, uint64_t u64Timestamp)
4142	{
4143	Display pDisplay = (Display )pvCtx;
4144	pDisplay->i_handleCrVRecScreenshotEnd(uScreen, u64Timestamp);
4145	}
4146
4147	DECLCALLBACK(void) Display::i_displayVRecCompletion(struct VBOXCRCMDCTL pCmd, uint32_t cbCmd, int rc, void pvCompletion)
4148	{
4149	RT_NOREF(pCmd, cbCmd, rc);
4150	Display pDisplay = (Display )pvCompletion;
4151	pDisplay->i_handleVRecCompletion();
4152	}
4153
4154	#endif
4155
4156
4157	#ifdef VBOX_WITH_HGSMI
4158	/**
4159	* @interface_method_impl{PDMIDISPLAYCONNECTOR,pfnVBVAEnable}
4160	*/
4161	DECLCALLBACK(int) Display::i_displayVBVAEnable(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId,
4162	VBVAHOSTFLAGS RT_UNTRUSTED_VOLATILE_GUEST *pHostFlags,
4163	bool fRenderThreadMode)
4164	{
4165	LogRelFlowFunc(("uScreenId %d\n", uScreenId));
4166
4167	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4168	Display *pThis = pDrv->pDisplay;
4169
4170	if (pThis->maFramebuffers[uScreenId].fVBVAEnabled && pThis->maFramebuffers[uScreenId].fRenderThreadMode != fRenderThreadMode)
4171	{
4172	LogRel(("Enabling different vbva mode\n"));
4173	#ifdef DEBUG_misha
4174	AssertMsgFailed(("enabling different vbva mode\n"));
4175	#endif
4176	return VERR_INVALID_STATE;
4177	}
4178
4179	pThis->maFramebuffers[uScreenId].fVBVAEnabled = true;
4180	pThis->maFramebuffers[uScreenId].pVBVAHostFlags = pHostFlags;
4181	pThis->maFramebuffers[uScreenId].fRenderThreadMode = fRenderThreadMode;
4182	pThis->maFramebuffers[uScreenId].fVBVAForceResize = true;
4183
4184	vbvaSetMemoryFlagsHGSMI(uScreenId, pThis->mfu32SupportedOrders, pThis->mfVideoAccelVRDP, &pThis->maFramebuffers[uScreenId]);
4185
4186	return VINF_SUCCESS;
4187	}
4188
4189	/**
4190	* @interface_method_impl{PDMIDISPLAYCONNECTOR,pfnVBVADisable}
4191	*/
4192	DECLCALLBACK(void) Display::i_displayVBVADisable(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId)
4193	{
4194	LogRelFlowFunc(("uScreenId %d\n", uScreenId));
4195
4196	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4197	Display *pThis = pDrv->pDisplay;
4198
4199	DISPLAYFBINFO *pFBInfo = &pThis->maFramebuffers[uScreenId];
4200
4201	bool fRenderThreadMode = pFBInfo->fRenderThreadMode;
4202
4203	if (uScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
4204	{
4205	/* Make sure that the primary screen is visible now.
4206	* The guest can't use VBVA anymore, so only only the VGA device output works.
4207	*/
4208	pFBInfo->flags = 0;
4209	if (pFBInfo->fDisabled)
4210	{
4211	pFBInfo->fDisabled = false;
4212	fireGuestMonitorChangedEvent(pThis->mParent->i_getEventSource(),
4213	GuestMonitorChangedEventType_Enabled,
4214	uScreenId,
4215	pFBInfo->xOrigin, pFBInfo->yOrigin,
4216	pFBInfo->w, pFBInfo->h);
4217	}
4218	}
4219
4220	pFBInfo->fVBVAEnabled = false;
4221	pFBInfo->fVBVAForceResize = false;
4222	pFBInfo->fRenderThreadMode = false;
4223
4224	vbvaSetMemoryFlagsHGSMI(uScreenId, 0, false, pFBInfo);
4225
4226	pFBInfo->pVBVAHostFlags = NULL;
4227
4228	if (!fRenderThreadMode && uScreenId == VBOX_VIDEO_PRIMARY_SCREEN)
4229	{
4230	/* Force full screen update, because VGA device must take control, do resize, etc. */
4231	pThis->mpDrv->pUpPort->pfnUpdateDisplayAll(pThis->mpDrv->pUpPort, /* fFailOnResize = */ false);
4232	}
4233	}
4234
4235	DECLCALLBACK(void) Display::i_displayVBVAUpdateBegin(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId)
4236	{
4237	RT_NOREF(uScreenId);
4238	LogFlowFunc(("uScreenId %d\n", uScreenId));
4239
4240	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4241	Display *pThis = pDrv->pDisplay;
4242
4243	if (ASMAtomicReadU32(&pThis->mu32UpdateVBVAFlags) > 0)
4244	{
4245	vbvaSetMemoryFlagsAllHGSMI(pThis->mfu32SupportedOrders, pThis->mfVideoAccelVRDP, pThis->maFramebuffers,
4246	pThis->mcMonitors);
4247	ASMAtomicDecU32(&pThis->mu32UpdateVBVAFlags);
4248	}
4249	}
4250
4251	/**
4252	* @interface_method_impl{PDMIDISPLAYCONNECTOR,pfnVBVAUpdateProcess}
4253	*/
4254	DECLCALLBACK(void) Display::i_displayVBVAUpdateProcess(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId,
4255	struct VBVACMDHDR const RT_UNTRUSTED_VOLATILE_GUEST *pCmd, size_t cbCmd)
4256	{
4257	LogFlowFunc(("uScreenId %d pCmd %p cbCmd %d, @%d,%d %dx%d\n", uScreenId, pCmd, cbCmd, pCmd->x, pCmd->y, pCmd->w, pCmd->h));
4258	VBVACMDHDR hdrSaved;
4259	RT_COPY_VOLATILE(hdrSaved, *pCmd);
4260	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE();
4261
4262	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4263	Display *pThis = pDrv->pDisplay;
4264	DISPLAYFBINFO *pFBInfo = &pThis->maFramebuffers[uScreenId];
4265
4266	if (pFBInfo->fDefaultFormat)
4267	{
4268	/* Make sure that framebuffer contains the same image as the guest VRAM. */
4269	if ( uScreenId == VBOX_VIDEO_PRIMARY_SCREEN
4270	&& !pFBInfo->fDisabled)
4271	{
4272	pDrv->pUpPort->pfnUpdateDisplayRect(pDrv->pUpPort, hdrSaved.x, hdrSaved.y, hdrSaved.w, hdrSaved.h);
4273	}
4274	else if ( !pFBInfo->pSourceBitmap.isNull()
4275	&& !pFBInfo->fDisabled)
4276	{
4277	/* Render VRAM content to the framebuffer. */
4278	BYTE *pAddress = NULL;
4279	ULONG ulWidth = 0;
4280	ULONG ulHeight = 0;
4281	ULONG ulBitsPerPixel = 0;
4282	ULONG ulBytesPerLine = 0;
4283	BitmapFormat_T bitmapFormat = BitmapFormat_Opaque;
4284
4285	HRESULT hrc = pFBInfo->pSourceBitmap->QueryBitmapInfo(&pAddress,
4286	&ulWidth,
4287	&ulHeight,
4288	&ulBitsPerPixel,
4289	&ulBytesPerLine,
4290	&bitmapFormat);
4291	if (SUCCEEDED(hrc))
4292	{
4293	uint32_t width = hdrSaved.w;
4294	uint32_t height = hdrSaved.h;
4295
4296	const uint8_t *pu8Src = pFBInfo->pu8FramebufferVRAM;
4297	int32_t xSrc = hdrSaved.x - pFBInfo->xOrigin;
4298	int32_t ySrc = hdrSaved.y - pFBInfo->yOrigin;
4299	uint32_t u32SrcWidth = pFBInfo->w;
4300	uint32_t u32SrcHeight = pFBInfo->h;
4301	uint32_t u32SrcLineSize = pFBInfo->u32LineSize;
4302	uint32_t u32SrcBitsPerPixel = pFBInfo->u16BitsPerPixel;
4303
4304	uint8_t *pu8Dst = pAddress;
4305	int32_t xDst = xSrc;
4306	int32_t yDst = ySrc;
4307	uint32_t u32DstWidth = u32SrcWidth;
4308	uint32_t u32DstHeight = u32SrcHeight;
4309	uint32_t u32DstLineSize = u32DstWidth * 4;
4310	uint32_t u32DstBitsPerPixel = 32;
4311
4312	pDrv->pUpPort->pfnCopyRect(pDrv->pUpPort,
4313	width, height,
4314	pu8Src,
4315	xSrc, ySrc,
4316	u32SrcWidth, u32SrcHeight,
4317	u32SrcLineSize, u32SrcBitsPerPixel,
4318	pu8Dst,
4319	xDst, yDst,
4320	u32DstWidth, u32DstHeight,
4321	u32DstLineSize, u32DstBitsPerPixel);
4322	}
4323	}
4324	}
4325
4326	/*
4327	* Here is your classic 'temporary' solution.
4328	*/
4329	/** @todo New SendUpdate entry which can get a separate cmd header or coords. */
4330	VBVACMDHDR pHdrUnconst = (VBVACMDHDR )pCmd;
4331
4332	pHdrUnconst->x -= (int16_t)pFBInfo->xOrigin;
4333	pHdrUnconst->y -= (int16_t)pFBInfo->yOrigin;
4334
4335	pThis->mParent->i_consoleVRDPServer()->SendUpdate(uScreenId, pHdrUnconst, (uint32_t)cbCmd);
4336
4337	*pHdrUnconst = hdrSaved;
4338	}
4339
4340	DECLCALLBACK(void) Display::i_displayVBVAUpdateEnd(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, int32_t x, int32_t y,
4341	uint32_t cx, uint32_t cy)
4342	{
4343	LogFlowFunc(("uScreenId %d %d,%d %dx%d\n", uScreenId, x, y, cx, cy));
4344
4345	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4346	Display *pThis = pDrv->pDisplay;
4347	DISPLAYFBINFO *pFBInfo = &pThis->maFramebuffers[uScreenId];
4348
4349	/** @todo handleFramebufferUpdate (uScreenId,
4350	* x - pThis->maFramebuffers[uScreenId].xOrigin,
4351	* y - pThis->maFramebuffers[uScreenId].yOrigin,
4352	* cx, cy);
4353	*/
4354	pThis->i_handleDisplayUpdate(uScreenId, x - pFBInfo->xOrigin, y - pFBInfo->yOrigin, cx, cy);
4355	}
4356
4357	#ifdef DEBUG_sunlover
4358	static void logVBVAResize(PCVBVAINFOVIEW pView, PCVBVAINFOSCREEN pScreen, const DISPLAYFBINFO *pFBInfo)
4359	{
4360	LogRel(("displayVBVAResize: [%d] %s\n"
4361	" pView->u32ViewIndex %d\n"
4362	" pView->u32ViewOffset 0x%08X\n"
4363	" pView->u32ViewSize 0x%08X\n"
4364	" pView->u32MaxScreenSize 0x%08X\n"
4365	" pScreen->i32OriginX %d\n"
4366	" pScreen->i32OriginY %d\n"
4367	" pScreen->u32StartOffset 0x%08X\n"
4368	" pScreen->u32LineSize 0x%08X\n"
4369	" pScreen->u32Width %d\n"
4370	" pScreen->u32Height %d\n"
4371	" pScreen->u16BitsPerPixel %d\n"
4372	" pScreen->u16Flags 0x%04X\n"
4373	" pFBInfo->u32Offset 0x%08X\n"
4374	" pFBInfo->u32MaxFramebufferSize 0x%08X\n"
4375	" pFBInfo->u32InformationSize 0x%08X\n"
4376	" pFBInfo->fDisabled %d\n"
4377	" xOrigin, yOrigin, w, h: %d,%d %dx%d\n"
4378	" pFBInfo->u16BitsPerPixel %d\n"
4379	" pFBInfo->pu8FramebufferVRAM %p\n"
4380	" pFBInfo->u32LineSize 0x%08X\n"
4381	" pFBInfo->flags 0x%04X\n"
4382	" pFBInfo->pHostEvents %p\n"
4383	" pFBInfo->fDefaultFormat %d\n"
4384	" pFBInfo->fVBVAEnabled %d\n"
4385	" pFBInfo->fVBVAForceResize %d\n"
4386	" pFBInfo->pVBVAHostFlags %p\n"
4387	"",
4388	pScreen->u32ViewIndex,
4389	(pScreen->u16Flags & VBVA_SCREEN_F_DISABLED)? "DISABLED": "ENABLED",
4390	pView->u32ViewIndex,
4391	pView->u32ViewOffset,
4392	pView->u32ViewSize,
4393	pView->u32MaxScreenSize,
4394	pScreen->i32OriginX,
4395	pScreen->i32OriginY,
4396	pScreen->u32StartOffset,
4397	pScreen->u32LineSize,
4398	pScreen->u32Width,
4399	pScreen->u32Height,
4400	pScreen->u16BitsPerPixel,
4401	pScreen->u16Flags,
4402	pFBInfo->u32Offset,
4403	pFBInfo->u32MaxFramebufferSize,
4404	pFBInfo->u32InformationSize,
4405	pFBInfo->fDisabled,
4406	pFBInfo->xOrigin,
4407	pFBInfo->yOrigin,
4408	pFBInfo->w,
4409	pFBInfo->h,
4410	pFBInfo->u16BitsPerPixel,
4411	pFBInfo->pu8FramebufferVRAM,
4412	pFBInfo->u32LineSize,
4413	pFBInfo->flags,
4414	pFBInfo->pHostEvents,
4415	pFBInfo->fDefaultFormat,
4416	pFBInfo->fVBVAEnabled,
4417	pFBInfo->fVBVAForceResize,
4418	pFBInfo->pVBVAHostFlags
4419	));
4420	}
4421	#endif /* DEBUG_sunlover */
4422
4423	DECLCALLBACK(int) Display::i_displayVBVAResize(PPDMIDISPLAYCONNECTOR pInterface, PCVBVAINFOVIEW pView,
4424	PCVBVAINFOSCREEN pScreen, void *pvVRAM, bool fResetInputMapping)
4425	{
4426	LogRelFlowFunc(("pScreen %p, pvVRAM %p\n", pScreen, pvVRAM));
4427
4428	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4429	Display *pThis = pDrv->pDisplay;
4430
4431	return pThis->processVBVAResize(pView, pScreen, pvVRAM, fResetInputMapping);
4432	}
4433
4434	int Display::processVBVAResize(PCVBVAINFOVIEW pView, PCVBVAINFOSCREEN pScreen, void *pvVRAM, bool fResetInputMapping)
4435	{
4436	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4437
4438	DISPLAYFBINFO *pFBInfo = &maFramebuffers[pScreen->u32ViewIndex];
4439
4440	if (pScreen->u16Flags & VBVA_SCREEN_F_DISABLED)
4441	{
4442	/* Ask the framebuffer to resize using a default format. The framebuffer will be black.
4443	* So if the frontend does not support GuestMonitorChangedEventType_Disabled event,
4444	* the VM window will be black. */
4445	uint32_t u32Width = pFBInfo->w ? pFBInfo->w : 640;
4446	uint32_t u32Height = pFBInfo->h ? pFBInfo->h : 480;
4447	int32_t xOrigin = pFBInfo->xOrigin;
4448	int32_t yOrigin = pFBInfo->yOrigin;
4449
4450	alock.release();
4451
4452	i_notifyCroglResize(pView, pScreen, pvVRAM);
4453
4454	i_handleDisplayResize(pScreen->u32ViewIndex, 0, (uint8_t *)NULL, 0,
4455	u32Width, u32Height, pScreen->u16Flags, xOrigin, yOrigin, false);
4456
4457	return VINF_SUCCESS;
4458	}
4459
4460	VBVAINFOSCREEN screenInfo;
4461	RT_ZERO(screenInfo);
4462
4463	if (pScreen->u16Flags & VBVA_SCREEN_F_BLANK2)
4464	{
4465	/* Init a local VBVAINFOSCREEN structure, which will be used instead of
4466	* the original pScreen. Set VBVA_SCREEN_F_BLANK, which will force
4467	* the code below to choose the "blanking" branches.
4468	*/
4469	screenInfo.u32ViewIndex = pScreen->u32ViewIndex;
4470	screenInfo.i32OriginX = pFBInfo->xOrigin;
4471	screenInfo.i32OriginY = pFBInfo->yOrigin;
4472	screenInfo.u32StartOffset = 0; /* Irrelevant */
4473	screenInfo.u32LineSize = pFBInfo->u32LineSize;
4474	screenInfo.u32Width = pFBInfo->w;
4475	screenInfo.u32Height = pFBInfo->h;
4476	screenInfo.u16BitsPerPixel = pFBInfo->u16BitsPerPixel;
4477	screenInfo.u16Flags = pScreen->u16Flags \| VBVA_SCREEN_F_BLANK;
4478
4479	pScreen = &screenInfo;
4480	}
4481
4482	if (fResetInputMapping)
4483	{
4484	/// @todo Rename to m* and verify whether some kind of lock is required.
4485	xInputMappingOrigin = 0;
4486	yInputMappingOrigin = 0;
4487	cxInputMapping = 0;
4488	cyInputMapping = 0;
4489	}
4490
4491	alock.release();
4492
4493	i_notifyCroglResize(pView, pScreen, pvVRAM);
4494
4495	return i_handleDisplayResize(pScreen->u32ViewIndex, pScreen->u16BitsPerPixel,
4496	(uint8_t *)pvVRAM + pScreen->u32StartOffset,
4497	pScreen->u32LineSize, pScreen->u32Width, pScreen->u32Height, pScreen->u16Flags,
4498	pScreen->i32OriginX, pScreen->i32OriginY, false);
4499	}
4500
4501	DECLCALLBACK(int) Display::i_displayVBVAMousePointerShape(PPDMIDISPLAYCONNECTOR pInterface, bool fVisible, bool fAlpha,
4502	uint32_t xHot, uint32_t yHot,
4503	uint32_t cx, uint32_t cy,
4504	const void *pvShape)
4505	{
4506	LogFlowFunc(("\n"));
4507	LogRel2(("%s: fVisible=%RTbool\n", __PRETTY_FUNCTION__, fVisible));
4508
4509	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4510
4511	uint32_t cbShape = 0;
4512	if (pvShape)
4513	{
4514	cbShape = (cx + 7) / 8 * cy; /* size of the AND mask */
4515	cbShape = ((cbShape + 3) & ~3) + cx * 4 * cy; /* + gap + size of the XOR mask */
4516	}
4517
4518	/* Tell the console about it */
4519	pDrv->pDisplay->mParent->i_onMousePointerShapeChange(fVisible, fAlpha,
4520	xHot, yHot, cx, cy, (uint8_t *)pvShape, cbShape);
4521
4522	return VINF_SUCCESS;
4523	}
4524
4525	DECLCALLBACK(void) Display::i_displayVBVAGuestCapabilityUpdate(PPDMIDISPLAYCONNECTOR pInterface, uint32_t fCapabilities)
4526	{
4527	LogFlowFunc(("\n"));
4528
4529	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4530	Display *pThis = pDrv->pDisplay;
4531
4532	pThis->i_handleUpdateGuestVBVACapabilities(fCapabilities);
4533	}
4534
4535	DECLCALLBACK(void) Display::i_displayVBVAInputMappingUpdate(PPDMIDISPLAYCONNECTOR pInterface, int32_t xOrigin, int32_t yOrigin,
4536	uint32_t cx, uint32_t cy)
4537	{
4538	LogFlowFunc(("\n"));
4539
4540	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4541	Display *pThis = pDrv->pDisplay;
4542
4543	pThis->i_handleUpdateVBVAInputMapping(xOrigin, yOrigin, cx, cy);
4544	}
4545
4546	DECLCALLBACK(void) Display::i_displayVBVAReportCursorPosition(PPDMIDISPLAYCONNECTOR pInterface, uint32_t fFlags, uint32_t aScreenId, uint32_t x, uint32_t y)
4547	{
4548	LogFlowFunc(("\n"));
4549	LogRel2(("%s: fFlags=%RU32, aScreenId=%RU32, x=%RU32, y=%RU32\n",
4550	__PRETTY_FUNCTION__, fFlags, aScreenId, x, y));
4551
4552	PDRVMAINDISPLAY pDrv = PDMIDISPLAYCONNECTOR_2_MAINDISPLAY(pInterface);
4553	Display *pThis = pDrv->pDisplay;
4554
4555	if (fFlags & VBVA_CURSOR_SCREEN_RELATIVE)
4556	{
4557	x += pThis->maFramebuffers[aScreenId].xOrigin;
4558	y += pThis->maFramebuffers[aScreenId].yOrigin;
4559	}
4560	fireCursorPositionChangedEvent(pThis->mParent->i_getEventSource(), RT_BOOL(fFlags & VBVA_CURSOR_VALID_DATA), x, y);
4561	}
4562
4563	#endif /* VBOX_WITH_HGSMI */
4564
4565	/**
4566	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
4567	*/
4568	DECLCALLBACK(void ) Display::i_drvQueryInterface(PPDMIBASE pInterface, const char pszIID)
4569	{
4570	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
4571	PDRVMAINDISPLAY pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4572	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
4573	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIDISPLAYCONNECTOR, &pDrv->IConnector);
4574	return NULL;
4575	}
4576
4577
4578	/**
4579	* @interface_method_impl{PDMDRVREG,pfnPowerOff,
4580	* Tries to ensure no client calls gets to HGCM or the VGA device from here on.}
4581	*/
4582	DECLCALLBACK(void) Display::i_drvPowerOff(PPDMDRVINS pDrvIns)
4583	{
4584	PDRVMAINDISPLAY pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4585	LogRelFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
4586
4587	/*
4588	* Do much of the work that i_drvDestruct does.
4589	*/
4590	if (pThis->pUpPort)
4591	pThis->pUpPort->pfnSetRenderVRAM(pThis->pUpPort, false);
4592
4593	pThis->IConnector.pbData = NULL;
4594	pThis->IConnector.cbScanline = 0;
4595	pThis->IConnector.cBits = 32;
4596	pThis->IConnector.cx = 0;
4597	pThis->IConnector.cy = 0;
4598
4599	if (pThis->pDisplay)
4600	{
4601	AutoWriteLock displayLock(pThis->pDisplay COMMA_LOCKVAL_SRC_POS);
4602	#ifdef VBOX_WITH_RECORDING
4603	pThis->pDisplay->mParent->i_recordingStop();
4604	#endif
4605	#ifdef VBOX_WITH_CRHGSMI
4606	pThis->pDisplay->i_destructCrHgsmiData();
4607	#endif
4608	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4609	pThis->pVBVACallbacks = NULL;
4610	#endif
4611	}
4612	}
4613
4614
4615	/**
4616	* Destruct a display driver instance.
4617	*
4618	* @returns VBox status code.
4619	* @param pDrvIns The driver instance data.
4620	*/
4621	DECLCALLBACK(void) Display::i_drvDestruct(PPDMDRVINS pDrvIns)
4622	{
4623	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
4624	PDRVMAINDISPLAY pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4625	LogRelFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
4626
4627	/*
4628	* We repeat much of what i_drvPowerOff does in case it wasn't called.
4629	* In addition we sever the connection between us and the display.
4630	*/
4631	if (pThis->pUpPort)
4632	pThis->pUpPort->pfnSetRenderVRAM(pThis->pUpPort, false);
4633
4634	pThis->IConnector.pbData = NULL;
4635	pThis->IConnector.cbScanline = 0;
4636	pThis->IConnector.cBits = 32;
4637	pThis->IConnector.cx = 0;
4638	pThis->IConnector.cy = 0;
4639
4640	if (pThis->pDisplay)
4641	{
4642	AutoWriteLock displayLock(pThis->pDisplay COMMA_LOCKVAL_SRC_POS);
4643	#ifdef VBOX_WITH_RECORDING
4644	pThis->pDisplay->mParent->i_recordingStop();
4645	#endif
4646	#ifdef VBOX_WITH_CRHGSMI
4647	pThis->pDisplay->i_destructCrHgsmiData();
4648	#endif
4649	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4650	pThis->pVBVACallbacks = NULL;
4651	#endif
4652
4653	pThis->pDisplay->mpDrv = NULL;
4654	pThis->pDisplay = NULL;
4655	}
4656	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4657	pThis->pVBVACallbacks = NULL;
4658	#endif
4659	}
4660
4661
4662	/**
4663	* Construct a display driver instance.
4664	*
4665	* @copydoc FNPDMDRVCONSTRUCT
4666	*/
4667	DECLCALLBACK(int) Display::i_drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
4668	{
4669	RT_NOREF(fFlags);
4670	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
4671	PDRVMAINDISPLAY pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINDISPLAY);
4672	LogRelFlowFunc(("iInstance=%d\n", pDrvIns->iInstance));
4673
4674	/*
4675	* Validate configuration.
4676	*/
4677	if (!CFGMR3AreValuesValid(pCfg, "Object\0"))
4678	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
4679	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
4680	("Configuration error: Not possible to attach anything to this driver!\n"),
4681	VERR_PDM_DRVINS_NO_ATTACH);
4682
4683	/*
4684	* Init Interfaces.
4685	*/
4686	pDrvIns->IBase.pfnQueryInterface = Display::i_drvQueryInterface;
4687
4688	pThis->IConnector.pfnResize = Display::i_displayResizeCallback;
4689	pThis->IConnector.pfnUpdateRect = Display::i_displayUpdateCallback;
4690	pThis->IConnector.pfnRefresh = Display::i_displayRefreshCallback;
4691	pThis->IConnector.pfnReset = Display::i_displayResetCallback;
4692	pThis->IConnector.pfnLFBModeChange = Display::i_displayLFBModeChangeCallback;
4693	pThis->IConnector.pfnProcessAdapterData = Display::i_displayProcessAdapterDataCallback;
4694	pThis->IConnector.pfnProcessDisplayData = Display::i_displayProcessDisplayDataCallback;
4695	#ifdef VBOX_WITH_VIDEOHWACCEL
4696	pThis->IConnector.pfnVHWACommandProcess = Display::i_displayVHWACommandProcess;
4697	#endif
4698	#ifdef VBOX_WITH_CRHGSMI
4699	pThis->IConnector.pfnCrHgsmiCommandProcess = Display::i_displayCrHgsmiCommandProcess;
4700	pThis->IConnector.pfnCrHgsmiControlProcess = Display::i_displayCrHgsmiControlProcess;
4701	#endif
4702	#if defined(VBOX_WITH_HGCM) && defined(VBOX_WITH_CROGL)
4703	pThis->IConnector.pfnCrHgcmCtlSubmit = Display::i_displayCrHgcmCtlSubmit;
4704	#endif
4705	#ifdef VBOX_WITH_HGSMI
4706	pThis->IConnector.pfnVBVAEnable = Display::i_displayVBVAEnable;
4707	pThis->IConnector.pfnVBVADisable = Display::i_displayVBVADisable;
4708	pThis->IConnector.pfnVBVAUpdateBegin = Display::i_displayVBVAUpdateBegin;
4709	pThis->IConnector.pfnVBVAUpdateProcess = Display::i_displayVBVAUpdateProcess;
4710	pThis->IConnector.pfnVBVAUpdateEnd = Display::i_displayVBVAUpdateEnd;
4711	pThis->IConnector.pfnVBVAResize = Display::i_displayVBVAResize;
4712	pThis->IConnector.pfnVBVAMousePointerShape = Display::i_displayVBVAMousePointerShape;
4713	pThis->IConnector.pfnVBVAGuestCapabilityUpdate = Display::i_displayVBVAGuestCapabilityUpdate;
4714	pThis->IConnector.pfnVBVAInputMappingUpdate = Display::i_displayVBVAInputMappingUpdate;
4715	pThis->IConnector.pfnVBVAReportCursorPosition = Display::i_displayVBVAReportCursorPosition;
4716	#endif
4717
4718	/*
4719	* Get the IDisplayPort interface of the above driver/device.
4720	*/
4721	pThis->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIDISPLAYPORT);
4722	if (!pThis->pUpPort)
4723	{
4724	AssertMsgFailed(("Configuration error: No display port interface above!\n"));
4725	return VERR_PDM_MISSING_INTERFACE_ABOVE;
4726	}
4727	#if defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_CRHGSMI)
4728	pThis->pVBVACallbacks = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIDISPLAYVBVACALLBACKS);
4729	if (!pThis->pVBVACallbacks)
4730	{
4731	AssertMsgFailed(("Configuration error: No VBVA callback interface above!\n"));
4732	return VERR_PDM_MISSING_INTERFACE_ABOVE;
4733	}
4734	#endif
4735	/*
4736	* Get the Display object pointer and update the mpDrv member.
4737	*/
4738	void *pv;
4739	int rc = CFGMR3QueryPtr(pCfg, "Object", &pv);
4740	if (RT_FAILURE(rc))
4741	{
4742	AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
4743	return rc;
4744	}
4745	Display pDisplay = (Display )pv; /** @todo Check this cast! */
4746	pThis->pDisplay = pDisplay;
4747	pThis->pDisplay->mpDrv = pThis;
4748
4749	/* Disable VRAM to a buffer copy initially. */
4750	pThis->pUpPort->pfnSetRenderVRAM(pThis->pUpPort, false);
4751	pThis->IConnector.cBits = 32; /* DevVGA does nothing otherwise. */
4752
4753	/*
4754	* Start periodic screen refreshes
4755	*/
4756	pThis->pUpPort->pfnSetRefreshRate(pThis->pUpPort, 20);
4757
4758	#ifdef VBOX_WITH_CRHGSMI
4759	pDisplay->i_setupCrHgsmiData();
4760	#endif
4761
4762	return rc;
4763	}
4764
4765
4766	/**
4767	* Display driver registration record.
4768	*/
4769	const PDMDRVREG Display::DrvReg =
4770	{
4771	/* u32Version */
4772	PDM_DRVREG_VERSION,
4773	/* szName */
4774	"MainDisplay",
4775	/* szRCMod */
4776	"",
4777	/* szR0Mod */
4778	"",
4779	/* pszDescription */
4780	"Main display driver (Main as in the API).",
4781	/* fFlags */
4782	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
4783	/* fClass. */
4784	PDM_DRVREG_CLASS_DISPLAY,
4785	/* cMaxInstances */
4786	~0U,
4787	/* cbInstance */
4788	sizeof(DRVMAINDISPLAY),
4789	/* pfnConstruct */
4790	Display::i_drvConstruct,
4791	/* pfnDestruct */
4792	Display::i_drvDestruct,
4793	/* pfnRelocate */
4794	NULL,
4795	/* pfnIOCtl */
4796	NULL,
4797	/* pfnPowerOn */
4798	NULL,
4799	/* pfnReset */
4800	NULL,
4801	/* pfnSuspend */
4802	NULL,
4803	/* pfnResume */
4804	NULL,
4805	/* pfnAttach */
4806	NULL,
4807	/* pfnDetach */
4808	NULL,
4809	/* pfnPowerOff */
4810	Display::i_drvPowerOff,
4811	/* pfnSoftReset */
4812	NULL,
4813	/* u32EndVersion */
4814	PDM_DRVREG_VERSION
4815	};
4816
4817	/* 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@ 78915

Download in other formats: