VirtualBox

source: vbox/trunk/src/VBox/Main/include/DisplayImpl.h@ 22480

Last change on this file since 22480 was 22480, checked in by vboxsync, 15 years ago

SSM,VMM,Devices,Main,VBoxBFE: Live snapshot/migration SSM API adjustments.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.3 KB
Line 
1/* $Id: DisplayImpl.h 22480 2009-08-26 17:14:13Z vboxsync $ */
2
3/** @file
4 *
5 * VirtualBox COM class implementation
6 */
7
8/*
9 * Copyright (C) 2006-2008 Sun Microsystems, Inc.
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 *
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
20 * Clara, CA 95054 USA or visit http://www.sun.com if you need
21 * additional information or have any questions.
22 */
23
24#ifndef ____H_DISPLAYIMPL
25#define ____H_DISPLAYIMPL
26
27#include "VirtualBoxBase.h"
28#include "SchemaDefs.h"
29
30#include <iprt/semaphore.h>
31#include <VBox/pdmdrv.h>
32#include <VBox/VMMDev.h>
33#include <VBox/VBoxVideo.h>
34
35class Console;
36
37enum {
38 ResizeStatus_Void,
39 ResizeStatus_InProgress,
40 ResizeStatus_UpdateDisplayData
41};
42
43typedef struct _DISPLAYFBINFO
44{
45 uint32_t u32Offset;
46 uint32_t u32MaxFramebufferSize;
47 uint32_t u32InformationSize;
48
49 ComPtr<IFramebuffer> pFramebuffer;
50
51 LONG xOrigin;
52 LONG yOrigin;
53
54 ULONG w;
55 ULONG h;
56
57 VBOXVIDEOINFOHOSTEVENTS *pHostEvents;
58
59 volatile uint32_t u32ResizeStatus;
60
61 /* The Framebuffer has default format and must be updates immediately. */
62 bool fDefaultFormat;
63
64 struct {
65 /* The rectangle that includes all dirty rectangles. */
66 int32_t xLeft;
67 int32_t xRight;
68 int32_t yTop;
69 int32_t yBottom;
70 } dirtyRect;
71
72 struct {
73 bool fPending;
74 ULONG pixelFormat;
75 void *pvVRAM;
76 uint32_t bpp;
77 uint32_t cbLine;
78 int w;
79 int h;
80 } pendingResize;
81
82#ifdef VBOX_WITH_HGSMI
83 bool fVBVAEnabled;
84#endif /* VBOX_WITH_HGSMI */
85} DISPLAYFBINFO;
86
87class ATL_NO_VTABLE Display :
88 public VirtualBoxBase,
89 VBOX_SCRIPTABLE_IMPL(IConsoleCallback),
90 public VirtualBoxSupportErrorInfoImpl<Display, IDisplay>,
91 public VirtualBoxSupportTranslation<Display>,
92 VBOX_SCRIPTABLE_IMPL(IDisplay)
93{
94
95public:
96
97 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (Display)
98
99 DECLARE_NOT_AGGREGATABLE(Display)
100
101 DECLARE_PROTECT_FINAL_CONSTRUCT()
102
103 BEGIN_COM_MAP(Display)
104 COM_INTERFACE_ENTRY(ISupportErrorInfo)
105 COM_INTERFACE_ENTRY(IDisplay)
106 COM_INTERFACE_ENTRY2(IDispatch,IDisplay)
107 END_COM_MAP()
108
109 NS_DECL_ISUPPORTS
110
111 DECLARE_EMPTY_CTOR_DTOR (Display)
112
113 HRESULT FinalConstruct();
114 void FinalRelease();
115
116 // public initializer/uninitializer for internal purposes only
117 HRESULT init (Console *aParent);
118 void uninit();
119 int registerSSM(PVM pVM);
120
121 // public methods only for internal purposes
122 int handleDisplayResize (unsigned uScreenId, uint32_t bpp, void *pvVRAM, uint32_t cbLine, int w, int h);
123 void handleDisplayUpdate (int x, int y, int cx, int cy);
124#ifdef VBOX_WITH_VIDEOHWACCEL
125 void handleVHWACommandProcess(PPDMIDISPLAYCONNECTOR pInterface, PVBOXVHWACMD pCommand);
126#endif
127 IFramebuffer *getFramebuffer()
128 {
129 return maFramebuffers[VBOX_VIDEO_PRIMARY_SCREEN].pFramebuffer;
130 }
131
132 int VideoAccelEnable (bool fEnable, VBVAMEMORY *pVbvaMemory);
133 void VideoAccelFlush (void);
134
135 bool VideoAccelAllowed (void);
136
137#ifdef VBOX_WITH_VRDP
138 void VideoAccelVRDP (bool fEnable);
139#endif /* VBOX_WITH_VRDP */
140
141 // IConsoleCallback methods
142 STDMETHOD(OnMousePointerShapeChange)(BOOL visible, BOOL alpha, ULONG xHot, ULONG yHot,
143 ULONG width, ULONG height, BYTE *shape)
144 {
145 return S_OK;
146 }
147
148 STDMETHOD(OnMouseCapabilityChange)(BOOL supportsAbsolute, BOOL needsHostCursor)
149 {
150 return S_OK;
151 }
152
153 STDMETHOD(OnKeyboardLedsChange)(BOOL fNumLock, BOOL fCapsLock, BOOL fScrollLock)
154 {
155 return S_OK;
156 }
157
158 STDMETHOD(OnStateChange)(MachineState_T machineState);
159
160 STDMETHOD(OnAdditionsStateChange)()
161 {
162 return S_OK;
163 }
164
165 STDMETHOD(OnDVDDriveChange)()
166 {
167 return S_OK;
168 }
169
170 STDMETHOD(OnFloppyDriveChange)()
171 {
172 return S_OK;
173 }
174
175 STDMETHOD(OnNetworkAdapterChange) (INetworkAdapter *aNetworkAdapter)
176 {
177 return S_OK;
178 }
179
180 STDMETHOD(OnSerialPortChange) (ISerialPort *aSerialPort)
181 {
182 return S_OK;
183 }
184
185 STDMETHOD(OnParallelPortChange) (IParallelPort *aParallelPort)
186 {
187 return S_OK;
188 }
189
190 STDMETHOD(OnStorageControllerChange) ()
191 {
192 return S_OK;
193 }
194
195 STDMETHOD(OnVRDPServerChange)()
196 {
197 return S_OK;
198 }
199
200 STDMETHOD(OnUSBControllerChange)()
201 {
202 return S_OK;
203 }
204
205 STDMETHOD(OnUSBDeviceStateChange)(IUSBDevice *device, BOOL attached,
206 IVirtualBoxErrorInfo *message)
207 {
208 return S_OK;
209 }
210
211 STDMETHOD(OnSharedFolderChange) (Scope_T aScope)
212 {
213 return S_OK;
214 }
215
216 STDMETHOD(OnRuntimeError)(BOOL fatal, IN_BSTR id, IN_BSTR message)
217 {
218 return S_OK;
219 }
220
221 STDMETHOD(OnCanShowWindow)(BOOL *canShow)
222 {
223 if (canShow)
224 *canShow = TRUE;
225 return S_OK;
226 }
227
228 STDMETHOD(OnShowWindow)(ULONG64 *winId)
229 {
230 if (winId)
231 *winId = 0;
232 return S_OK;
233 }
234
235 // IDisplay properties
236 STDMETHOD(COMGETTER(Width)) (ULONG *width);
237 STDMETHOD(COMGETTER(Height)) (ULONG *height);
238 STDMETHOD(COMGETTER(BitsPerPixel)) (ULONG *bitsPerPixel);
239
240 // IDisplay methods
241 STDMETHOD(SetFramebuffer)(ULONG aScreenId, IFramebuffer *aFramebuffer);
242 STDMETHOD(GetFramebuffer)(ULONG aScreenId, IFramebuffer **aFramebuffer, LONG *aXOrigin, LONG *aYOrigin);
243 STDMETHOD(SetVideoModeHint)(ULONG width, ULONG height, ULONG bitsPerPixel, ULONG display);
244 STDMETHOD(TakeScreenShot)(BYTE *address, ULONG width, ULONG height);
245 STDMETHOD(TakeScreenShotSlow)(ULONG width, ULONG height, ComSafeArrayOut(BYTE, aScreenData));
246 STDMETHOD(DrawToScreen)(BYTE *address, ULONG x, ULONG y, ULONG width, ULONG height);
247 STDMETHOD(InvalidateAndUpdate)();
248 STDMETHOD(ResizeCompleted)(ULONG aScreenId);
249 STDMETHOD(UpdateCompleted)();
250 STDMETHOD(SetSeamlessMode)(BOOL enabled);
251
252 STDMETHOD(CompleteVHWACommand)(BYTE *pCommand);
253
254 // for VirtualBoxSupportErrorInfoImpl
255 static const wchar_t *getComponentName() { return L"Display"; }
256
257 static const PDMDRVREG DrvReg;
258
259private:
260
261 void updateDisplayData (bool aCheckParams = false);
262
263 static DECLCALLBACK(int) changeFramebuffer (Display *that, IFramebuffer *aFB,
264 unsigned uScreenId);
265
266 static DECLCALLBACK(void*) drvQueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface);
267 static DECLCALLBACK(int) drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle, uint32_t fFlags);
268 static DECLCALLBACK(void) drvDestruct(PPDMDRVINS pDrvIns);
269 static DECLCALLBACK(int) displayResizeCallback(PPDMIDISPLAYCONNECTOR pInterface, uint32_t bpp, void *pvVRAM, uint32_t cbLine, uint32_t cx, uint32_t cy);
270 static DECLCALLBACK(void) displayUpdateCallback(PPDMIDISPLAYCONNECTOR pInterface,
271 uint32_t x, uint32_t y, uint32_t cx, uint32_t cy);
272 static DECLCALLBACK(void) displayRefreshCallback(PPDMIDISPLAYCONNECTOR pInterface);
273 static DECLCALLBACK(void) displayResetCallback(PPDMIDISPLAYCONNECTOR pInterface);
274 static DECLCALLBACK(void) displayLFBModeChangeCallback(PPDMIDISPLAYCONNECTOR pInterface, bool fEnabled);
275 static DECLCALLBACK(void) displayProcessAdapterDataCallback(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, uint32_t u32VRAMSize);
276 static DECLCALLBACK(void) displayProcessDisplayDataCallback(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, unsigned uScreenId);
277
278#ifdef VBOX_WITH_VIDEOHWACCEL
279 static DECLCALLBACK(void) displayVHWACommandProcess(PPDMIDISPLAYCONNECTOR pInterface, PVBOXVHWACMD pCommand);
280#endif
281
282#ifdef VBOX_WITH_HGSMI
283 static DECLCALLBACK(int) displayVBVAEnable(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId);
284 static DECLCALLBACK(void) displayVBVADisable(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId);
285 static DECLCALLBACK(void) displayVBVAUpdateBegin(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId);
286 static DECLCALLBACK(void) displayVBVAUpdateProcess(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, const PVBVACMDHDR pCmd, size_t cbCmd);
287 static DECLCALLBACK(void) displayVBVAUpdateEnd(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy);
288 static DECLCALLBACK(int) displayVBVAResize(PPDMIDISPLAYCONNECTOR pInterface, const PVBVAINFOVIEW pView, const PVBVAINFOSCREEN pScreen, void *pvVRAM);
289 static DECLCALLBACK(int) displayVBVAMousePointerShape(PPDMIDISPLAYCONNECTOR pInterface, bool fVisible, bool fAlpha, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy, const void *pvShape);
290#endif
291
292
293 static DECLCALLBACK(void) displaySSMSave(PSSMHANDLE pSSM, void *pvUser);
294 static DECLCALLBACK(int) displaySSMLoad(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPhase);
295
296 const ComObjPtr<Console, ComWeakRef> mParent;
297 /** Pointer to the associated display driver. */
298 struct DRVMAINDISPLAY *mpDrv;
299 /** Pointer to the device instance for the VMM Device. */
300 PPDMDEVINS mpVMMDev;
301 /** Set after the first attempt to find the VMM Device. */
302 bool mfVMMDevInited;
303
304 unsigned mcMonitors;
305 DISPLAYFBINFO maFramebuffers[SchemaDefs::MaxGuestMonitors];
306
307 bool mFramebufferOpened;
308
309 /* arguments of the last handleDisplayResize() call */
310 void *mLastAddress;
311 uint32_t mLastBytesPerLine;
312 uint32_t mLastBitsPerPixel;
313 int mLastWidth;
314 int mLastHeight;
315
316 VBVAMEMORY *mpVbvaMemory;
317 bool mfVideoAccelEnabled;
318 bool mfVideoAccelVRDP;
319 uint32_t mfu32SupportedOrders;
320
321 int32_t volatile mcVideoAccelVRDPRefs;
322
323 VBVAMEMORY *mpPendingVbvaMemory;
324 bool mfPendingVideoAccelEnable;
325 bool mfMachineRunning;
326
327 uint8_t *mpu8VbvaPartial;
328 uint32_t mcbVbvaPartial;
329
330 bool vbvaFetchCmd (VBVACMDHDR **ppHdr, uint32_t *pcbCmd);
331 void vbvaReleaseCmd (VBVACMDHDR *pHdr, int32_t cbCmd);
332
333 void handleResizeCompletedEMT (void);
334};
335
336#endif // ____H_DISPLAYIMPL
337/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

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