VirtualBox

source: vbox/trunk/src/VBox/Additions/WINNT/Graphics/Miniport/wddm/VBoxVideoIf.h@ 32241

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

wddm/3d: multimonitor for fullscreen apps (Aero), shared rc support needed
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.2 KB
Line 
1/** @file
2 * Contains base definitions of constants & structures used
3 * to control & perform rendering,
4 * such as DMA commands types, allocation types, escape codes, etc.
5 * used by both miniport & display drivers.
6 *
7 * The latter uses these and only these defs to communicate with the former
8 * by posting appropriate requests via D3D RT Krnl Svc accessing callbacks.
9 */
10/*
11 * Copyright (C) 2010 Oracle Corporation
12 *
13 * This file is part of VirtualBox Open Source Edition (OSE), as
14 * available from http://www.virtualbox.org. This file is free software;
15 * you can redistribute it and/or modify it under the terms of the GNU
16 * General Public License (GPL) as published by the Free Software
17 * Foundation, in version 2 as it comes in the "COPYING" file of the
18 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
19 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
20 */
21#ifndef ___VBoxVideoIf_h___
22#define ___VBoxVideoIf_h___
23
24#include <VBox/VBoxVideo.h>
25#include "../../../include/VBoxDisplay.h"
26
27#include <iprt/assert.h>
28
29
30/* One would increase this whenever definitions in this file are changed */
31#define VBOXVIDEOIF_VERSION 5
32
33/* create allocation func */
34typedef enum
35{
36 VBOXWDDM_ALLOC_TYPE_UNEFINED = 0,
37 VBOXWDDM_ALLOC_TYPE_STD_SHAREDPRIMARYSURFACE,
38 VBOXWDDM_ALLOC_TYPE_STD_SHADOWSURFACE,
39 VBOXWDDM_ALLOC_TYPE_STD_STAGINGSURFACE,
40 /* this one is win 7-specific and hence unused for now */
41 VBOXWDDM_ALLOC_TYPE_STD_GDISURFACE
42 /* custom allocation types requested from user-mode d3d module will go here */
43 , VBOXWDDM_ALLOC_TYPE_UMD_RC_GENERIC
44} VBOXWDDM_ALLOC_TYPE;
45
46/* usage */
47typedef enum
48{
49 VBOXWDDM_ALLOCUSAGE_TYPE_UNEFINED = 0,
50 /* set for the allocation being primary */
51 VBOXWDDM_ALLOCUSAGE_TYPE_PRIMARY,
52} VBOXWDDM_ALLOCUSAGE_TYPE;
53
54typedef struct VBOXWDDM_SURFACE_DESC
55{
56 UINT width;
57 UINT height;
58 D3DDDIFORMAT format;
59 UINT bpp;
60 UINT pitch;
61 UINT depth;
62 UINT slicePitch;
63 UINT cbSize;
64 D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId;
65 D3DDDI_RATIONAL RefreshRate;
66} VBOXWDDM_SURFACE_DESC, *PVBOXWDDM_SURFACE_DESC;
67
68typedef struct VBOXWDDM_ALLOCINFO
69{
70 VBOXWDDM_ALLOC_TYPE enmType;
71 D3DDDI_RESOURCEFLAGS fFlags;
72 HANDLE hSharedHandle;
73 VBOXWDDM_SURFACE_DESC SurfDesc;
74} VBOXWDDM_ALLOCINFO, *PVBOXWDDM_ALLOCINFO;
75
76/* this resource is OpenResource'd rather than CreateResource'd */
77#define VBOXWDDM_RESOURCE_F_OPENNED 0x00000001
78/* identifies this is a resource created with CreateResource, the VBOXWDDMDISP_RESOURCE::fRcFlags is valid */
79#define VBOXWDDM_RESOURCE_F_TYPE_GENERIC 0x00000002
80
81typedef struct VBOXWDDM_RC_DESC
82{
83 D3DDDI_RESOURCEFLAGS fFlags;
84 D3DDDIFORMAT enmFormat;
85 D3DDDI_POOL enmPool;
86 D3DDDIMULTISAMPLE_TYPE enmMultisampleType;
87 UINT MultisampleQuality;
88 UINT MipLevels;
89 UINT Fvf;
90 D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId;
91 D3DDDI_RATIONAL RefreshRate;
92 D3DDDI_ROTATION enmRotation;
93} VBOXWDDM_RC_DESC, *PVBOXWDDM_RC_DESC;
94
95typedef struct VBOXWDDM_RCINFO
96{
97 uint32_t fFlags;
98 VBOXWDDM_RC_DESC RcDesc;
99 uint32_t cAllocInfos;
100// VBOXWDDM_ALLOCINFO aAllocInfos[1];
101} VBOXWDDM_RCINFO, *PVBOXWDDM_RCINFO;
102
103#define VBOXVHWA_F_ENABLED 0x00000001
104#define VBOXVHWA_F_CKEY_DST 0x00000002
105#define VBOXVHWA_F_CKEY_SRC 0x00000004
106
107#define VBOXVHWA_MAX_FORMATS 8
108
109typedef struct VBOXVHWA_INFO
110{
111 uint32_t fFlags;
112 uint32_t cOverlaysSupported;
113 uint32_t cFormats;
114 D3DDDIFORMAT aFormats[VBOXVHWA_MAX_FORMATS];
115} VBOXVHWA_INFO;
116
117#define VBOXWDDM_OVERLAY_F_CKEY_DST 0x00000001
118#define VBOXWDDM_OVERLAY_F_CKEY_DSTRANGE 0x00000002
119#define VBOXWDDM_OVERLAY_F_CKEY_SRC 0x00000004
120#define VBOXWDDM_OVERLAY_F_CKEY_SRCRANGE 0x00000008
121#define VBOXWDDM_OVERLAY_F_BOB 0x00000010
122#define VBOXWDDM_OVERLAY_F_INTERLEAVED 0x00000020
123#define VBOXWDDM_OVERLAY_F_MIRROR_LR 0x00000040
124#define VBOXWDDM_OVERLAY_F_MIRROR_UD 0x00000080
125#define VBOXWDDM_OVERLAY_F_DEINTERLACED 0x00000100
126
127typedef struct VBOXWDDM_OVERLAY_DESC
128{
129 uint32_t fFlags;
130 UINT DstColorKeyLow;
131 UINT DstColorKeyHigh;
132 UINT SrcColorKeyLow;
133 UINT SrcColorKeyHigh;
134} VBOXWDDM_OVERLAY_DESC, *PVBOXWDDM_OVERLAY_DESC;
135
136/* the dirty rect info is valid */
137#define VBOXWDDM_DIRTYREGION_F_VALID 0x00000001
138#define VBOXWDDM_DIRTYREGION_F_RECT_VALID 0x00000002
139
140typedef struct VBOXWDDM_DIRTYREGION
141{
142 uint32_t fFlags; /* <-- see VBOXWDDM_DIRTYREGION_F_xxx flags above */
143 RECT Rect;
144} VBOXWDDM_DIRTYREGION, *PVBOXWDDM_DIRTYREGION;
145
146typedef struct VBOXWDDM_OVERLAY_INFO
147{
148 VBOXWDDM_OVERLAY_DESC OverlayDesc;
149 VBOXWDDM_DIRTYREGION DirtyRegion; /* <- the dirty region of the overlay surface */
150} VBOXWDDM_OVERLAY_INFO, *PVBOXWDDM_OVERLAY_INFO;
151
152typedef struct VBOXWDDM_OVERLAYFLIP_INFO
153{
154 VBOXWDDM_DIRTYREGION DirtyRegion; /* <- the dirty region of the overlay surface */
155} VBOXWDDM_OVERLAYFLIP_INFO, *PVBOXWDDM_OVERLAYFLIP_INFO;
156
157typedef struct VBOXWDDM_CREATECONTEXT_INFO
158{
159 /* interface version, i.e. 9 for d3d9, 8 for d3d8, etc. */
160 uint32_t u32IfVersion;
161 /* true if d3d false if ddraw */
162 uint32_t u32IsD3D;
163 /* we use uint64_t instead of HANDLE to ensure structure def is the same for both 32-bit and 64-bit
164 * since x64 kernel driver can be called by 32-bit UMD */
165 uint64_t hUmEvent;
166 /* info to be passed to UMD notification to identify the context */
167 uint64_t u64UmInfo;
168} VBOXWDDM_CREATECONTEXT_INFO, *PVBOXWDDM_CREATECONTEXT_INFO;
169
170
171typedef struct VBOXWDDM_RECTS_FLAFS
172{
173 union
174 {
175 struct
176 {
177 /* used only in conjunction with bSetVisibleRects.
178 * if set - VBOXWDDM_RECTS_INFO::aRects[0] contains view rectangle */
179 UINT bSetViewRect : 1;
180 /* sets visible regions */
181 UINT bSetVisibleRects : 1;
182 /* adds hidden regions */
183 UINT bAddHiddenRects : 1;
184 UINT Reserved : 29;
185 };
186 uint32_t Value;
187 };
188} VBOXWDDM_RECTS_FLAFS, *PVBOXWDDM_RECTS_FLAFS;
189
190typedef struct VBOXWDDM_RECTS_INFO
191{
192 uint32_t cRects;
193 RECT aRects[1];
194} VBOXWDDM_RECTS_INFO, *PVBOXWDDM_RECTS_INFO;
195
196#define VBOXWDDM_RECTS_INFO_SIZE4CRECTS(_cRects) (RT_OFFSETOF(VBOXWDDM_RECTS_INFO, aRects[(_cRects)]))
197#define VBOXWDDM_RECTS_INFO_SIZE(_pRects) (VBOXVIDEOCM_CMD_RECTS_SIZE4CRECTS((_pRects)->cRects))
198
199typedef struct VBOXVIDEOCM_CMD_HDR
200{
201 uint64_t u64UmData;
202 uint32_t cbCmd;
203 uint32_t u32CmdSpecific;
204}VBOXVIDEOCM_CMD_HDR, *PVBOXVIDEOCM_CMD_HDR;
205
206AssertCompile((sizeof (VBOXVIDEOCM_CMD_HDR) & 7) == 0);
207
208typedef struct VBOXVIDEOCM_CMD_RECTS
209{
210 VBOXWDDM_RECTS_FLAFS fFlags;
211 VBOXWDDM_RECTS_INFO RectsInfo;
212} VBOXVIDEOCM_CMD_RECTS, *PVBOXVIDEOCM_CMD_RECTS;
213
214typedef struct VBOXVIDEOCM_CMD_RECTS_INTERNAL
215{
216 D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId;
217 UINT u32Reserved;
218 VBOXVIDEOCM_CMD_RECTS Cmd;
219} VBOXVIDEOCM_CMD_RECTS_INTERNAL, *PVBOXVIDEOCM_CMD_RECTS_INTERNAL;
220
221#define VBOXVIDEOCM_CMD_RECTS_INTERNAL_SIZE4CRECTS(_cRects) (RT_OFFSETOF(VBOXVIDEOCM_CMD_RECTS_INTERNAL, Cmd.RectsInfo.aRects[(_cRects)]))
222#define VBOXVIDEOCM_CMD_RECTS_INTERNAL_SIZE(_pCmd) (VBOXVIDEOCM_CMD_RECTS_INTERNAL_SIZE4CRECTS((_pCmd)->cRects))
223
224typedef struct VBOXWDDM_GETVBOXVIDEOCMCMD_HDR
225{
226 uint32_t cbCmdsReturned;
227 uint32_t cbRemainingCmds;
228 uint32_t cbRemainingFirstCmd;
229 uint32_t u32Reserved;
230} VBOXWDDM_GETVBOXVIDEOCMCMD_HDR, *PVBOXWDDM_GETVBOXVIDEOCMCMD_HDR;
231
232typedef struct VBOXDISPIFESCAPE_GETVBOXVIDEOCMCMD
233{
234 VBOXDISPIFESCAPE EscapeHdr;
235 VBOXWDDM_GETVBOXVIDEOCMCMD_HDR Hdr;
236} VBOXDISPIFESCAPE_GETVBOXVIDEOCMCMD, *PVBOXDISPIFESCAPE_GETVBOXVIDEOCMCMD;
237
238AssertCompile((sizeof (VBOXDISPIFESCAPE_GETVBOXVIDEOCMCMD) & 7) == 0);
239AssertCompile(RT_OFFSETOF(VBOXDISPIFESCAPE_GETVBOXVIDEOCMCMD, EscapeHdr) == 0);
240
241typedef struct VBOXDISPIFESCAPE_DBGPRINT
242{
243 VBOXDISPIFESCAPE EscapeHdr;
244 /* null-terminated string to DbgPrint including \0 */
245 char aStringBuf[1];
246} VBOXDISPIFESCAPE_DBGPRINT, *PVBOXDISPIFESCAPE_DBGPRINT;
247AssertCompile(RT_OFFSETOF(VBOXDISPIFESCAPE_DBGPRINT, EscapeHdr) == 0);
248
249typedef struct VBOXSCREENLAYOUT_ELEMENT
250{
251 D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId;
252 POINT pos;
253} VBOXSCREENLAYOUT_ELEMENT, *PVBOXSCREENLAYOUT_ELEMENT;
254
255typedef struct VBOXSCREENLAYOUT
256{
257 uint32_t cScreens;
258 VBOXSCREENLAYOUT_ELEMENT aScreens[1];
259} VBOXSCREENLAYOUT, *PVBOXSCREENLAYOUT;
260
261typedef struct VBOXDISPIFESCAPE_SCREENLAYOUT
262{
263 VBOXDISPIFESCAPE EscapeHdr;
264 VBOXSCREENLAYOUT ScreenLayout;
265} VBOXDISPIFESCAPE_SCREENLAYOUT, *PVBOXDISPIFESCAPE_SCREENLAYOUT;
266
267/* query info func */
268typedef struct VBOXWDDM_QI
269{
270 uint32_t u32Version;
271 uint32_t cInfos;
272 VBOXVHWA_INFO aInfos[VBOX_VIDEO_MAX_SCREENS];
273} VBOXWDDM_QI;
274
275/* submit cmd func */
276
277/* tooling */
278DECLINLINE(UINT) vboxWddmCalcBitsPerPixel(D3DDDIFORMAT format)
279{
280 switch (format)
281 {
282 case D3DDDIFMT_R8G8B8:
283 return 24;
284 case D3DDDIFMT_A8R8G8B8:
285 case D3DDDIFMT_X8R8G8B8:
286 return 32;
287 case D3DDDIFMT_R5G6B5:
288 case D3DDDIFMT_X1R5G5B5:
289 case D3DDDIFMT_A1R5G5B5:
290 case D3DDDIFMT_A4R4G4B4:
291 return 16;
292 case D3DDDIFMT_R3G3B2:
293 case D3DDDIFMT_A8:
294 return 8;
295 case D3DDDIFMT_A8R3G3B2:
296 case D3DDDIFMT_X4R4G4B4:
297 return 16;
298 case D3DDDIFMT_A2B10G10R10:
299 case D3DDDIFMT_A8B8G8R8:
300 case D3DDDIFMT_X8B8G8R8:
301 case D3DDDIFMT_G16R16:
302 case D3DDDIFMT_A2R10G10B10:
303 return 32;
304 case D3DDDIFMT_A16B16G16R16:
305 return 64;
306 case D3DDDIFMT_A8P8:
307 return 16;
308 case D3DDDIFMT_P8:
309 return 8;
310 case D3DDDIFMT_D16_LOCKABLE:
311 case D3DDDIFMT_D16:
312 case D3DDDIFMT_D15S1:
313 return 16;
314 case D3DDDIFMT_D32:
315 case D3DDDIFMT_D24S8:
316 case D3DDDIFMT_D24X8:
317 case D3DDDIFMT_D24X4S4:
318 case D3DDDIFMT_D24FS8:
319 case D3DDDIFMT_D32_LOCKABLE:
320 return 32;
321 case D3DDDIFMT_S8_LOCKABLE:
322 return 8;
323 default:
324 AssertBreakpoint();
325 return 0;
326 }
327}
328
329DECLINLINE(uint32_t) vboxWddmFormatToFourcc(D3DDDIFORMAT format)
330{
331 uint32_t uFormat = (uint32_t)format;
332 /* assume that in case both four bytes are non-zero, this is a fourcc */
333 if ((format & 0xff000000)
334 && (format & 0x00ff0000)
335 && (format & 0x0000ff00)
336 && (format & 0x000000ff)
337 )
338 return uFormat;
339 return 0;
340}
341
342#define VBOXWDDM_ROUNDBOUND(_v, _b) (((_v) + ((_b) - 1)) & ~((_b) - 1))
343
344DECLINLINE(UINT) vboxWddmCalcPitch(UINT w, UINT bitsPerPixel)
345{
346 UINT Pitch = bitsPerPixel * w;
347 /* pitch is now in bits, translate in bytes */
348 return VBOXWDDM_ROUNDBOUND(Pitch, 8) >> 3;
349}
350
351DECLINLINE(void) vboxWddmRectUnite(RECT *pR, const RECT *pR2Unite)
352{
353 pR->left = RT_MIN(pR->left, pR2Unite->left);
354 pR->top = RT_MIN(pR->top, pR2Unite->top);
355 pR->right = RT_MAX(pR->right, pR2Unite->right);
356 pR->bottom = RT_MAX(pR->bottom, pR2Unite->bottom);
357}
358
359DECLINLINE(bool) vboxWddmRectIntersection(const RECT *a, const RECT *b, RECT *rect)
360{
361 Assert(a);
362 Assert(b);
363 Assert(rect);
364 rect->left = RT_MAX(a->left, b->left);
365 rect->right = RT_MIN(a->right, b->right);
366 rect->top = RT_MAX(a->top, b->top);
367 rect->bottom = RT_MIN(a->bottom, b->bottom);
368 return (rect->right>rect->left) && (rect->bottom>rect->top);
369}
370
371DECLINLINE(bool) vboxWddmRectIsEqual(const RECT *pRect1, const RECT *pRect2)
372{
373 Assert(pRect1);
374 Assert(pRect2);
375 if (pRect1->left != pRect2->left)
376 return false;
377 if (pRect1->top != pRect2->top)
378 return false;
379 if (pRect1->right != pRect2->right)
380 return false;
381 if (pRect1->bottom != pRect2->bottom)
382 return false;
383 return true;
384}
385
386DECLINLINE(bool) vboxWddmRectIsCoveres(const RECT *pRect, const RECT *pCovered)
387{
388 Assert(pRect);
389 Assert(pCovered);
390 if (pRect->left > pCovered->left)
391 return false;
392 if (pRect->top > pCovered->top)
393 return false;
394 if (pRect->right < pCovered->right)
395 return false;
396 if (pRect->bottom < pCovered->bottom)
397 return false;
398 return true;
399}
400
401DECLINLINE(bool) vboxWddmRectIsEmpty(RECT * pRect)
402{
403 return pRect->left == pRect->right-1 && pRect->top == pRect->bottom-1;
404}
405
406DECLINLINE(bool) vboxWddmRectIsIntersect(RECT * pRect1, RECT * pRect2)
407{
408 return !((pRect1->left < pRect2->left && pRect1->right < pRect2->left)
409 || (pRect2->left < pRect1->left && pRect2->right < pRect1->left)
410 || (pRect1->top < pRect2->top && pRect1->bottom < pRect2->top)
411 || (pRect2->top < pRect1->top && pRect2->bottom < pRect1->top));
412}
413
414DECLINLINE(bool) vboxWddmRectIsInclude(RECT * pRect1, RECT * pRect2)
415{
416 return ((pRect1->left <= pRect2->left && pRect1->right >= pRect2->right)
417 && (pRect1->top <= pRect2->top && pRect1->bottom >= pRect2->bottom));
418}
419
420DECLINLINE(void) vboxWddmRectUnited(RECT * pDst, const RECT * pRect1, const RECT * pRect2)
421{
422 pDst->left = RT_MIN(pRect1->left, pRect2->left);
423 pDst->top = RT_MIN(pRect1->top, pRect2->top);
424 pDst->right = RT_MAX(pRect1->right, pRect2->right);
425 pDst->bottom = RT_MAX(pRect1->bottom, pRect2->bottom);
426}
427
428DECLINLINE(void) vboxWddmRectTranslate(RECT * pRect, int x, int y)
429{
430 pRect->left += x;
431 pRect->top += y;
432 pRect->right += x;
433 pRect->bottom += y;
434}
435
436DECLINLINE(void) vboxWddmDirtyRegionAddRect(PVBOXWDDM_DIRTYREGION pInfo, const RECT *pRect)
437{
438 if (!(pInfo->fFlags & VBOXWDDM_DIRTYREGION_F_VALID))
439 {
440 pInfo->fFlags = VBOXWDDM_DIRTYREGION_F_VALID;
441 if (pRect)
442 {
443 pInfo->fFlags |= VBOXWDDM_DIRTYREGION_F_RECT_VALID;
444 pInfo->Rect = *pRect;
445 }
446 }
447 else if (!!(pInfo->fFlags & VBOXWDDM_DIRTYREGION_F_RECT_VALID))
448 {
449 if (pRect)
450 vboxWddmRectUnite(&pInfo->Rect, pRect);
451 else
452 pInfo->fFlags &= ~VBOXWDDM_DIRTYREGION_F_RECT_VALID;
453 }
454}
455
456DECLINLINE(void) vboxWddmDirtyRegionUnite(PVBOXWDDM_DIRTYREGION pInfo, const PVBOXWDDM_DIRTYREGION pInfo2)
457{
458 if (pInfo2->fFlags & VBOXWDDM_DIRTYREGION_F_VALID)
459 {
460 if (pInfo2->fFlags & VBOXWDDM_DIRTYREGION_F_RECT_VALID)
461 vboxWddmDirtyRegionAddRect(pInfo, &pInfo2->Rect);
462 else
463 vboxWddmDirtyRegionAddRect(pInfo, NULL);
464 }
465}
466
467DECLINLINE(void) vboxWddmDirtyRegionClear(PVBOXWDDM_DIRTYREGION pInfo)
468{
469 pInfo->fFlags = 0;
470}
471
472#endif /* #ifndef ___VBoxVideoIf_h___ */
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