VirtualBox

source: vbox/trunk/src/VBox/Additions/WINNT/Graphics/Display/driver.h@ 20906

Last change on this file since 20906 was 20906, checked in by vboxsync, 16 years ago

video hw accel: color keying & color conversion basics impl for QGL Framebuffer
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.8 KB
Line 
1/******************************Module*Header*******************************\
2*
3 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
4 *
5 * This file is part of VirtualBox Open Source Edition (OSE), as
6 * available from http://www.virtualbox.org. This file is free software;
7 * you can redistribute it and/or modify it under the terms of the GNU
8 * General Public License (GPL) as published by the Free Software
9 * Foundation, in version 2 as it comes in the "COPYING" file of the
10 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
11 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
12 *
13 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
14 * Clara, CA 95054 USA or visit http://www.sun.com if you need
15 * additional information or have any questions.
16*/
17/*
18* Based in part on Microsoft DDK sample code
19*
20* *******************
21* * GDI SAMPLE CODE *
22* *******************
23*
24* Module Name: driver.h
25*
26* contains prototypes for the frame buffer driver.
27*
28* Copyright (c) 1992-1998 Microsoft Corporation
29\**************************************************************************/
30
31#include "stddef.h"
32#include <stdarg.h>
33#include "windef.h"
34#include "wingdi.h"
35#include "winddi.h"
36#include "devioctl.h"
37#include "ntddvdeo.h"
38#include "debug.h"
39
40#include "../Miniport/vboxioctl.h"
41
42#include <VBox/VBoxVideo.h>
43
44/* Forward declaration. */
45struct _PDEV;
46typedef struct _PDEV PDEV;
47typedef PDEV *PPDEV;
48
49typedef struct _VBOXDISPLAYINFO
50{
51 VBOXVIDEOINFOHDR hdrLink;
52 VBOXVIDEOINFOLINK link;
53 VBOXVIDEOINFOHDR hdrScreen;
54 VBOXVIDEOINFOSCREEN screen;
55 VBOXVIDEOINFOHDR hdrHostEvents;
56 VBOXVIDEOINFOHOSTEVENTS hostEvents;
57 VBOXVIDEOINFOHDR hdrEnd;
58} VBOXDISPLAYINFO;
59
60#include "vbvavrdp.h"
61#include "vrdpbmp.h"
62
63/* Saved screen bits information. */
64typedef struct _SSB
65{
66 ULONG ident; /* 1 based index in the stack = the handle returned by DrvSaveScreenBits (SS_SAVE) */
67 BYTE *pBuffer; /* Buffer where screen bits are saved. */
68} SSB;
69
70/* VRAM
71 * | | | | |
72 * 0+framebuffer+ddraw heap+VBVA buffer+displayinfo=cScreenSize
73 */
74typedef struct _VRAMLAYOUT
75{
76 ULONG cbVRAM;
77
78 ULONG offFrameBuffer;
79 ULONG cbFrameBuffer;
80
81 ULONG offDDRAWHeap; //@todo
82 ULONG cbDDRAWHeap;
83
84 ULONG offVBVABuffer;
85 ULONG cbVBVABuffer;
86
87 ULONG offDisplayInformation;
88 ULONG cbDisplayInformation;
89} VRAMLAYOUT;
90
91typedef struct
92{
93 PPDEV ppdev;
94} VBOXSURF, *PVBOXSURF;
95
96#ifdef VBOX_WITH_VIDEOHWACCEL
97typedef struct _VBOXVHWAREGION
98{
99 RECT DirtyMem;
100 bool bValid;
101}VBOXVHWAREGION, *PVBOXVHWAREGION;
102
103typedef struct _VBOXVHWASURFDESC
104{
105 VBOXVHWA_SURFHANDLE hHostHandle;
106 volatile uint32_t cPendingBltsSrc;
107 volatile uint32_t cPendingBltsDst;
108 volatile uint32_t cPendingFlips;
109 uint32_t cBitsPerPixel;
110}VBOXVHWASURFDESC, *PVBOXVHWASURFDESC;
111
112typedef struct _VBOXVHWAINFO
113{
114 uint32_t caps;
115 uint32_t colorKeyCaps;
116 uint32_t stretchCaps;
117 uint32_t surfaceCaps;
118 uint32_t numOverlays;
119 uint32_t numFourCC;
120 HGSMIOFFSET FourCC;
121 BOOLEAN bVHWAEnabled;
122} VBOXVHWAINFO;
123#endif
124
125struct _PDEV
126{
127 HANDLE hDriver; // Handle to \Device\Screen
128 HDEV hdevEng; // Engine's handle to PDEV
129 HSURF hsurfScreenBitmap; // Engine's handle to VRAM screen bitmap surface
130 SURFOBJ *psoScreenBitmap; // VRAM screen bitmap surface
131 HSURF hsurfScreen; // Engine's handle to VRAM screen device surface
132 ULONG ulBitmapType;
133 HPALETTE hpalDefault; // Handle to the default palette for device.
134 PBYTE pjScreen; // This is pointer to base screen address
135 ULONG cxScreen; // Visible screen width
136 ULONG cyScreen; // Visible screen height
137 POINTL ptlOrg; // Where this display is anchored in
138 // the virtual desktop.
139 POINTL ptlDevOrg; // Device origin for DualView (0,0 for primary view).
140 ULONG ulMode; // Mode the mini-port driver is in.
141 LONG lDeltaScreen; // Distance from one scan to the next.
142
143 PVOID pOffscreenList; // linked list of DCI offscreen surfaces.
144 FLONG flRed; // For bitfields device, Red Mask
145 FLONG flGreen; // For bitfields device, Green Mask
146 FLONG flBlue; // For bitfields device, Blue Mask
147 ULONG cPaletteShift; // number of bits the 8-8-8 palette must
148 // be shifted by to fit in the hardware
149 // palette.
150 ULONG ulBitCount; // # of bits per pel 8,16,24,32 are only supported.
151 POINTL ptlHotSpot; // adjustment for pointer hot spot
152 VIDEO_POINTER_CAPABILITIES PointerCapabilities; // HW pointer abilities
153 PVIDEO_POINTER_ATTRIBUTES pPointerAttributes; // hardware pointer attributes
154 DWORD cjPointerAttributes; // Size of buffer allocated
155 BOOL fHwCursorActive; // Are we currently using the hw cursor
156 PALETTEENTRY *pPal; // If this is pal managed, this is the pal
157 BOOL bSupportDCI; // Does the miniport support DCI?
158 FLONG flHooks;
159
160#ifndef VBOX_WITH_HGSMI
161 VBVAENABLERESULT vbva;
162 uint32_t u32VRDPResetFlag;
163#endif /* !VBOX_WITH_HGSMI */
164 BOOL fHwBufferOverflow;
165 VBVARECORD *pRecord;
166 VRDPBC cache;
167
168 ULONG cSSB; // Number of active saved screen bits records in the following array.
169 SSB aSSB[4]; // LIFO type stack for saved screen areas.
170
171#ifndef VBOX_WITH_HGSMI
172 VBOXDISPLAYINFO *pInfo;
173 BOOLEAN bVBoxVideoSupported;
174#endif /* !VBOX_WITH_HGSMI */
175 ULONG iDevice;
176 VRAMLAYOUT layout;
177
178 PVBOXSURF pdsurfScreen;
179
180#ifdef VBOX_WITH_DDRAW
181 BOOL bDdExclusiveMode;
182 DWORD dwNewDDSurfaceOffset;
183 DWORD cHeaps;
184 VIDEOMEMORY* pvmList;
185 struct {
186 DWORD bLocked;
187 RECTL rArea;
188 } ddLock;
189#endif /* VBOX_WITH_DDRAW */
190
191#ifdef VBOX_WITH_HGSMI
192 BOOLEAN bHGSMISupported;
193 HGSMIHEAP hgsmiDisplayHeap;
194 VBVABUFFER *pVBVA; /* Pointer to the pjScreen + layout->offVBVABuffer. NULL if VBVA is not enabled. */
195
196 HVBOXVIDEOHGSMI hMpHGSMI; /* context handler passed to miniport HGSMI callbacks */
197 PFNVBOXVIDEOHGSMICOMPLETION pfnHGSMICommandComplete; /* called to complete the command we receive from the miniport */
198 PFNVBOXVIDEOHGSMICOMMANDS pfnHGSMIRequestCommands; /* called to requests the commands posted to us from the host */
199#endif /* VBOX_WITH_HGSMI */
200
201#ifdef VBOX_WITH_VIDEOHWACCEL
202 VBOXVHWAINFO vhwaInfo;
203#endif
204};
205
206#ifdef VBOX_WITH_OPENGL
207typedef struct
208{
209 DWORD dwVersion;
210 DWORD dwDriverVersion;
211 WCHAR szDriverName[256];
212} OPENGL_INFO, *POPENGL_INFO;
213#endif
214
215#ifndef VBOX_WITH_HGSMI
216/* The global semaphore handle for all driver instances. */
217extern HSEMAPHORE ghsemHwBuffer;
218#endif /* !VBOX_WITH_HGSMI */
219
220
221#ifdef VBOX_WITH_HGSMI
222#define VBE_DISPI_IOPORT_INDEX 0x01CE
223#define VBE_DISPI_IOPORT_DATA 0x01CF
224#define VBE_DISPI_INDEX_VBVA_GUEST 0xc
225#endif /* VBOX_WITH_HGSMI */
226
227extern BOOL g_bOnNT40;
228
229DWORD getAvailableModes(HANDLE, PVIDEO_MODE_INFORMATION *, DWORD *);
230BOOL bInitPDEV(PPDEV, PDEVMODEW, GDIINFO *, DEVINFO *);
231BOOL bInitSURF(PPDEV, BOOL);
232BOOL bInitPaletteInfo(PPDEV, DEVINFO *);
233BOOL bInitPointer(PPDEV, DEVINFO *);
234BOOL bInit256ColorPalette(PPDEV);
235BOOL bInitNotificationThread(PPDEV);
236VOID vStopNotificationThread (PPDEV);
237VOID vDisablePalette(PPDEV);
238VOID vDisableSURF(PPDEV);
239
240#define MAX_CLUT_SIZE (sizeof(VIDEO_CLUT) + (sizeof(ULONG) * 256))
241
242//
243// Determines the size of the DriverExtra information in the DEVMODE
244// structure passed to and from the display driver.
245//
246
247#define DRIVER_EXTRA_SIZE 0
248
249#define DLL_NAME L"VBoxDisp" // Name of the DLL in UNICODE
250#define STANDARD_DEBUG_PREFIX "VBOXDISP: " // All debug output is prefixed
251#define ALLOC_TAG 'bvDD' // Four byte tag (characters in
252 // reverse order) used for memory
253 // allocations
254
255// VBOX
256typedef struct _CLIPRECTS {
257 ULONG c;
258 RECTL arcl[64];
259} CLIPRECTS;
260
261typedef struct _VRDPCLIPRECTS
262{
263 RECTL rclDstOrig; /* Original bounding rectancle. */
264 RECTL rclDst; /* Bounding rectangle of all rects. */
265 CLIPRECTS rects; /* Rectangles to update. */
266} VRDPCLIPRECTS;
267
268
269BOOL vboxVbvaEnable (PPDEV ppdev);
270void vboxVbvaDisable (PPDEV ppdev);
271
272BOOL vboxHwBufferBeginUpdate (PPDEV ppdev);
273void vboxHwBufferEndUpdate (PPDEV ppdev);
274
275BOOL vboxWrite (PPDEV ppdev, const void *pv, uint32_t cb);
276
277BOOL vboxOrderSupported (PPDEV ppdev, unsigned code);
278
279void VBoxProcessDisplayInfo(PPDEV ppdev);
280void VBoxUpdateDisplayInfo (PPDEV ppdev);
281
282void drvLoadEng (void);
283
284#ifdef VBOX_WITH_HGSMI
285void vboxVBVAHostCommandComplete(PPDEV ppdev, VBVAHOSTCMD * pCmd);
286
287 #ifdef VBOX_WITH_VIDEOHWACCEL
288
289#define VBOXDD_CHECKFLAG(_v, _f) ((_v) & (_f)) == (_f)
290
291typedef DECLCALLBACK(void) FNVBOXVHWACMDCOMPLETION(PPDEV ppdev, VBOXVHWACMD * pCmd, void * pContext);
292typedef FNVBOXVHWACMDCOMPLETION *PFNVBOXVHWACMDCOMPLETION;
293
294VBOXVHWACMD* vboxVHWACommandCreate (PPDEV ppdev, VBOXVHWACMD_TYPE enmCmd, VBOXVHWACMD_LENGTH cbCmd);
295void vboxVHWACommandFree (PPDEV ppdev, VBOXVHWACMD* pCmd);
296BOOL vboxVHWACommandSubmit (PPDEV ppdev, VBOXVHWACMD* pCmd);
297void vboxVHWACommandSubmitAsynch (PPDEV ppdev, VBOXVHWACMD* pCmd, PFNVBOXVHWACMDCOMPLETION pfnCompletion, void * pContext);
298void vboxVHWACommandSubmitAsynchByEvent (PPDEV ppdev, VBOXVHWACMD* pCmd, PEVENT pEvent);
299void vboxVHWACommandCheckHostCmds(PPDEV ppdev);
300
301int vboxVHWAInitHostInfo1(PPDEV ppdev);
302int vboxVHWAInitHostInfo2(PPDEV ppdev, DWORD *pFourCC);
303
304VBOXVHWACMD_QUERYINFO1* vboxVHWAQueryHostInfo1(PPDEV ppdev);
305void vboxVHWAFreeHostInfo1(PPDEV ppdev, VBOXVHWACMD_QUERYINFO1* pInfo);
306VBOXVHWACMD_QUERYINFO2* vboxVHWAQueryHostInfo2(PPDEV ppdev, uint32_t numFourCC);
307void vboxVHWAFreeHostInfo2(PPDEV ppdev, VBOXVHWACMD_QUERYINFO2* pInfo);
308
309void vboxVHWAInit();
310void vboxVHWATerm();
311uint32_t vboxVHWAUnsupportedDDCAPS(uint32_t caps);
312uint32_t vboxVHWAUnsupportedDDSCAPS(uint32_t caps);
313uint32_t vboxVHWAUnsupportedDDPFS(uint32_t caps);
314uint32_t vboxVHWASupportedDDCAPS(uint32_t caps);
315uint32_t vboxVHWASupportedDDSCAPS(uint32_t caps);
316uint32_t vboxVHWASupportedDDPFS(uint32_t caps);
317uint32_t vboxVHWAFromDDCAPS(uint32_t caps);
318uint32_t vboxVHWAToDDCAPS(uint32_t caps);
319uint32_t vboxVHWAFromDDSCAPS(uint32_t caps);
320uint32_t vboxVHWAToDDSCAPS(uint32_t caps);
321uint32_t vboxVHWAFromDDPFS(uint32_t caps);
322uint32_t vboxVHWAToDDPFS(uint32_t caps);
323int vboxVHWAFromDDPIXELFORMAT(VBOXVHWA_PIXELFORMAT *pVHWAFormat, DDPIXELFORMAT *pDdFormat);
324int vboxVHWAFromDDSURFACEDESC(VBOXVHWA_SURFACEDESC *pVHWADesc, DDSURFACEDESC *pDdDesc);
325void vboxVHWAFromRECTL(VBOXVHWA_RECTL *pDst, RECTL *pSrc);
326PVBOXVHWASURFDESC vboxVHWASurfDescAlloc();
327void vboxVHWASurfDescFree(PVBOXVHWASURFDESC pDesc);
328
329int vboxVHWAEnable(PPDEV ppdev);
330int vboxVHWADisable(PPDEV ppdev);
331
332 #endif
333#endif
334
335BOOL bIsScreenSurface (SURFOBJ *pso);
336
337__inline SURFOBJ *getSurfObj (SURFOBJ *pso)
338{
339 if (pso)
340 {
341 PPDEV ppdev = (PPDEV)pso->dhpdev;
342
343 if (ppdev)
344 {
345 if (ppdev->psoScreenBitmap && pso->hsurf == ppdev->hsurfScreen)
346 {
347 /* Convert the device PSO to the bitmap PSO which can be passed to Eng*. */
348 pso = ppdev->psoScreenBitmap;
349 }
350 }
351 }
352
353 return pso;
354}
355
356#define CONV_SURF(_pso) getSurfObj (_pso)
357
358__inline int format2BytesPerPixel(const SURFOBJ *pso)
359{
360 switch (pso->iBitmapFormat)
361 {
362 case BMF_16BPP: return 2;
363 case BMF_24BPP: return 3;
364 case BMF_32BPP: return 4;
365 }
366
367 return 0;
368}
369
370#ifdef VBOX_VBVA_ADJUST_RECT
371void vrdpAdjustRect (SURFOBJ *pso, RECTL *prcl);
372BOOL vbvaFindChangedRect (SURFOBJ *psoDest, SURFOBJ *psoSrc, RECTL *prclDest, POINTL *pptlSrc);
373#endif /* VBOX_VBVA_ADJUST_RECT */
374
375void vrdpReportDirtyRect (PPDEV ppdev, RECTL *prcl);
376void vbvaReportDirtyRect (PPDEV ppdev, RECTL *prcl);
377
378#define VRDP_TEXT_MAX_GLYPH_SIZE 0x100
379#define VRDP_TEXT_MAX_GLYPHS 0xfe
380
381BOOL vboxReportText (PPDEV ppdev,
382 VRDPCLIPRECTS *pClipRects,
383 STROBJ *pstro,
384 FONTOBJ *pfo,
385 RECTL *prclOpaque,
386 ULONG ulForeRGB,
387 ULONG ulBackRGB
388 );
389
390BOOL vrdpReportOrderGeneric (PPDEV ppdev,
391 const VRDPCLIPRECTS *pClipRects,
392 const void *pvOrder,
393 unsigned cbOrder,
394 unsigned code);
395
396
397#include <iprt/assert.h>
398
399#define VBVA_ASSERT(expr) \
400 do { \
401 if (!(expr)) \
402 { \
403 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
404 AssertMsg2("!!!\n"); \
405 } \
406 } while (0)
407
408#ifdef STAT_sunlover
409extern ULONG gStatCopyBitsOffscreenToScreen;
410extern ULONG gStatCopyBitsScreenToScreen;
411extern ULONG gStatBitBltOffscreenToScreen;
412extern ULONG gStatBitBltScreenToScreen;
413extern ULONG gStatUnchangedOffscreenToScreen;
414extern ULONG gStatUnchangedOffscreenToScreenCRC;
415extern ULONG gStatNonTransientEngineBitmaps;
416extern ULONG gStatTransientEngineBitmaps;
417extern ULONG gStatUnchangedBitmapsCRC;
418extern ULONG gStatUnchangedBitmapsDeviceCRC;
419extern ULONG gStatBitmapsCRC;
420extern ULONG gStatBitBltScreenPattern;
421extern ULONG gStatBitBltScreenSquare;
422extern ULONG gStatBitBltScreenPatternReported;
423extern ULONG gStatBitBltScreenSquareReported;
424extern ULONG gStatCopyBitsScreenSquare;
425
426extern ULONG gStatEnablePDEV;
427extern ULONG gStatCompletePDEV;
428extern ULONG gStatDisablePDEV;
429extern ULONG gStatEnableSurface;
430extern ULONG gStatDisableSurface;
431extern ULONG gStatAssertMode;
432extern ULONG gStatDisableDriver;
433extern ULONG gStatCreateDeviceBitmap;
434extern ULONG gStatDeleteDeviceBitmap;
435extern ULONG gStatDitherColor;
436extern ULONG gStatStrokePath;
437extern ULONG gStatFillPath;
438extern ULONG gStatStrokeAndFillPath;
439extern ULONG gStatPaint;
440extern ULONG gStatBitBlt;
441extern ULONG gStatCopyBits;
442extern ULONG gStatStretchBlt;
443extern ULONG gStatSetPalette;
444extern ULONG gStatTextOut;
445extern ULONG gStatSetPointerShape;
446extern ULONG gStatMovePointer;
447extern ULONG gStatLineTo;
448extern ULONG gStatSynchronize;
449extern ULONG gStatGetModes;
450extern ULONG gStatGradientFill;
451extern ULONG gStatStretchBltROP;
452extern ULONG gStatPlgBlt;
453extern ULONG gStatAlphaBlend;
454extern ULONG gStatTransparentBlt;
455
456void statPrint (void);
457
458#define STATDRVENTRY(a, b) do { if (bIsScreenSurface (b)) gStat##a++; } while (0)
459#define STATPRINT do { statPrint (); } while (0)
460#else
461#define STATDRVENTRY(a, b)
462#define STATPRINT
463#endif /* STAT_sunlover */
Note: See TracBrowser for help on using the repository browser.

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