VirtualBox

source: vbox/trunk/src/VBox/GuestHost/OpenGL/include/cr_blitter.h@ 71880

Last change on this file since 71880 was 69500, checked in by vboxsync, 7 years ago

*: scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.6 KB
Line 
1/* $Id: cr_blitter.h 69500 2017-10-28 15:14:05Z vboxsync $ */
2/** @file
3 * Blitter API.
4 */
5
6/*
7 * Copyright (C) 2013-2017 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#ifndef ___cr_blitter_h
19#define ___cr_blitter_h
20
21#include <iprt/cdefs.h>
22#include <iprt/asm.h>
23#include <iprt/string.h>
24#include "cr_vreg.h"
25#ifdef IN_VMSVGA3D
26# include <iprt/assert.h>
27typedef struct TODO_VMSVGA3D_DISPATCH_TABLE SPUDispatchTable;
28# include <OpenGL/OpenGL.h>
29#else
30# include "cr_spu.h"
31#endif
32
33/** @todo r=bird: VBOXBLITTERDECL makes no sense. */
34#ifndef IN_RING0
35# define VBOXBLITTERDECL(_type) DECLEXPORT(_type)
36#else
37# define VBOXBLITTERDECL(_type) RTDECL(_type)
38#endif
39
40RT_C_DECLS_BEGIN
41typedef struct CR_BLITTER_IMG
42{
43 void *pvData;
44 GLuint cbData;
45 GLenum enmFormat;
46 GLuint width, height;
47 GLuint bpp;
48 GLuint pitch;
49} CR_BLITTER_IMG;
50typedef CR_BLITTER_IMG *PCR_BLITTER_IMG;
51typedef CR_BLITTER_IMG const *PCCR_BLITTER_IMG;
52
53VBOXBLITTERDECL(void) CrMClrFillImgRect(PCR_BLITTER_IMG pDst, PCRTRECT pCopyRect, uint32_t u32Color);
54VBOXBLITTERDECL(void) CrMClrFillImg(PCR_BLITTER_IMG pImg, uint32_t cRects, PCRTRECT pRects, uint32_t u32Color);
55VBOXBLITTERDECL(void) CrMBltImgRect(PCCR_BLITTER_IMG pSrc, PCRTPOINT pSrcDataPoint, bool fSrcInvert, PCRTRECT pCopyRect,
56 PCR_BLITTER_IMG pDst);
57VBOXBLITTERDECL(void) CrMBltImg(PCCR_BLITTER_IMG pSrc, PCRTPOINT pPos, uint32_t cRects, PCRTRECT pRects, PCR_BLITTER_IMG pDst);
58VBOXBLITTERDECL(void) CrMBltImgRectScaled(PCCR_BLITTER_IMG pSrc, PCRTPOINT pPos, bool fSrcInvert, PCRTRECT pCopyRect,
59 float strX, float strY, PCR_BLITTER_IMG pDst);
60VBOXBLITTERDECL(void) CrMBltImgScaled(PCCR_BLITTER_IMG pSrc, PCRTRECTSIZE pSrcRectSize, PCRTRECT pDstRect, uint32_t cRects,
61 PCRTRECT pRects, PCR_BLITTER_IMG pDst);
62
63/*
64 * GLSL Cache
65 */
66typedef struct CR_GLSL_CACHE
67{
68 int iGlVersion;
69 GLuint uNoAlpha2DProg;
70 GLuint uNoAlpha2DRectProg;
71 SPUDispatchTable *pDispatch;
72} CR_GLSL_CACHE;
73typedef CR_GLSL_CACHE *PCR_GLSL_CACHE;
74typedef CR_GLSL_CACHE const *PCCR_GLSL_CACHE;
75
76DECLINLINE(void) CrGlslInit(PCR_GLSL_CACHE pCache, SPUDispatchTable *pDispatch)
77{
78 RT_ZERO(*pCache);
79 pCache->pDispatch = pDispatch;
80}
81
82DECLINLINE(bool) CrGlslIsInited(PCCR_GLSL_CACHE pCache)
83{
84 return !!pCache->pDispatch;
85}
86
87/* clients should set proper context before calling these funcs */
88VBOXBLITTERDECL(bool) CrGlslIsSupported(PCR_GLSL_CACHE pCache);
89VBOXBLITTERDECL(int) CrGlslProgGenAllNoAlpha(PCR_GLSL_CACHE pCache);
90VBOXBLITTERDECL(int) CrGlslProgGenNoAlpha(PCR_GLSL_CACHE pCache, GLenum enmTexTarget);
91VBOXBLITTERDECL(int) CrGlslProgUseGenNoAlpha(PCR_GLSL_CACHE pCache, GLenum enmTexTarget);
92VBOXBLITTERDECL(int) CrGlslProgUseNoAlpha(PCCR_GLSL_CACHE pCache, GLenum enmTexTarget);
93VBOXBLITTERDECL(void) CrGlslProgClear(PCCR_GLSL_CACHE pCache);
94VBOXBLITTERDECL(bool) CrGlslNeedsCleanup(PCCR_GLSL_CACHE pCache);
95VBOXBLITTERDECL(void) CrGlslCleanup(PCR_GLSL_CACHE pCache);
96VBOXBLITTERDECL(void) CrGlslTerm(PCR_GLSL_CACHE pCache);
97
98/*
99 * BLITTER
100 */
101typedef struct CR_BLITTER_BUFFER
102{
103 GLuint cbBuffer;
104 GLvoid *pvBuffer;
105} CR_BLITTER_BUFFER;
106typedef CR_BLITTER_BUFFER *PCR_BLITTER_BUFFER;
107typedef CR_BLITTER_BUFFER const *PCCR_BLITTER_BUFFER;
108
109typedef union CR_BLITTER_FLAGS
110{
111 struct
112 {
113 uint32_t Initialized : 1;
114 uint32_t CtxCreated : 1;
115 uint32_t SupportsFBO : 1;
116 uint32_t SupportsPBO : 1;
117 uint32_t CurrentMuralChanged : 1;
118 uint32_t LastWasFBODraw : 1;
119 uint32_t ForceDrawBlit : 1;
120 uint32_t ShadersGloal : 1;
121 uint32_t Reserved : 24;
122 };
123 uint32_t Value;
124} CR_BLITTER_FLAGS;
125
126struct CR_BLITTER;
127
128typedef DECLCALLBACK(int) FNCRBLT_BLITTER(struct CR_BLITTER *pBlitter, PCVBOXVR_TEXTURE pSrc, PCRTRECT paSrcRect,
129 PCRTRECTSIZE pDstSize, PCRTRECT paDstRect, uint32_t cRects, uint32_t fFlags);
130typedef FNCRBLT_BLITTER *PFNCRBLT_BLITTER;
131
132typedef struct CR_BLITTER_SPUITEM
133{
134 int id;
135 GLint visualBits;
136} CR_BLITTER_SPUITEM, *PCR_BLITTER_SPUITEM;
137
138typedef struct CR_BLITTER_CONTEXT
139{
140 CR_BLITTER_SPUITEM Base;
141} CR_BLITTER_CONTEXT;
142typedef CR_BLITTER_CONTEXT *PCR_BLITTER_CONTEXT;
143typedef CR_BLITTER_CONTEXT const *PCCR_BLITTER_CONTEXT;
144
145typedef struct CR_BLITTER_WINDOW
146{
147 CR_BLITTER_SPUITEM Base;
148 GLuint width, height;
149} CR_BLITTER_WINDOW;
150typedef CR_BLITTER_WINDOW *PCR_BLITTER_WINDOW;
151typedef CR_BLITTER_WINDOW const *PCCR_BLITTER_WINDOW;
152
153typedef struct CR_BLITTER
154{
155 GLuint idFBO;
156 CR_BLITTER_FLAGS Flags;
157 uint32_t cEnters;
158 PFNCRBLT_BLITTER pfnBlt;
159 CR_BLITTER_BUFFER Verticies;
160 CR_BLITTER_BUFFER Indicies;
161 RTRECTSIZE CurrentSetSize;
162 CR_BLITTER_WINDOW CurrentMural;
163 CR_BLITTER_CONTEXT CtxInfo;
164 int32_t i32MakeCurrentUserData;
165 SPUDispatchTable *pDispatch;
166 PCCR_GLSL_CACHE pGlslCache;
167 CR_GLSL_CACHE LocalGlslCache;
168} CR_BLITTER;
169typedef CR_BLITTER *PCR_BLITTER;
170typedef CR_BLITTER const *PCCR_BLITTER;
171
172DECLINLINE(GLboolean) CrBltIsInitialized(PCR_BLITTER pBlitter)
173{
174 return !!pBlitter->pDispatch;
175}
176
177VBOXBLITTERDECL(int) CrBltInit(PCR_BLITTER pBlitter, PCCR_BLITTER_CONTEXT pCtxBase, bool fCreateNewCtx,
178 bool fForceDrawBlt, PCCR_GLSL_CACHE pShaders, SPUDispatchTable *pDispatch);
179
180VBOXBLITTERDECL(void) CrBltTerm(PCR_BLITTER pBlitter);
181
182VBOXBLITTERDECL(int) CrBltCleanup(PCR_BLITTER pBlitter);
183
184DECLINLINE(GLboolean) CrBltSupportsTexTex(PCR_BLITTER pBlitter)
185{
186 return pBlitter->Flags.SupportsFBO;
187}
188
189DECLINLINE(GLboolean) CrBltIsEntered(PCR_BLITTER pBlitter)
190{
191 return !!pBlitter->cEnters;
192}
193
194DECLINLINE(GLint) CrBltGetVisBits(PCR_BLITTER pBlitter)
195{
196 return pBlitter->CtxInfo.Base.visualBits;
197}
198
199
200DECLINLINE(GLboolean) CrBltIsEverEntered(PCR_BLITTER pBlitter)
201{
202 return !!pBlitter->Flags.Initialized;
203}
204
205DECLINLINE(void) CrBltSetMakeCurrentUserData(PCR_BLITTER pBlitter, int32_t i32MakeCurrentUserData)
206{
207 pBlitter->i32MakeCurrentUserData = i32MakeCurrentUserData;
208}
209
210VBOXBLITTERDECL(int) CrBltMuralSetCurrentInfo(PCR_BLITTER pBlitter, PCCR_BLITTER_WINDOW pMural);
211
212DECLINLINE(PCCR_BLITTER_WINDOW) CrBltMuralGetCurrentInfo(PCR_BLITTER pBlitter)
213{
214 return &pBlitter->CurrentMural;
215}
216
217VBOXBLITTERDECL(void) CrBltCheckUpdateViewport(PCR_BLITTER pBlitter);
218
219VBOXBLITTERDECL(void) CrBltLeave(PCR_BLITTER pBlitter);
220VBOXBLITTERDECL(int) CrBltEnter(PCR_BLITTER pBlitter);
221VBOXBLITTERDECL(void) CrBltBlitTexMural(PCR_BLITTER pBlitter, bool fBb, PCVBOXVR_TEXTURE pSrc, PCRTRECT paSrcRects,
222 PCRTRECT paDstRects, uint32_t cRects, uint32_t fFlags);
223VBOXBLITTERDECL(void) CrBltBlitTexTex(PCR_BLITTER pBlitter, PCVBOXVR_TEXTURE pSrc, PCRTRECT pSrcRect, PCVBOXVR_TEXTURE pDst,
224 PCRTRECT pDstRect, uint32_t cRects, uint32_t fFlags);
225VBOXBLITTERDECL(int) CrBltImgGetTex(PCR_BLITTER pBlitter, PCVBOXVR_TEXTURE pSrc, GLenum enmFormat, PCR_BLITTER_IMG pDst);
226
227VBOXBLITTERDECL(int) CrBltImgGetMural(PCR_BLITTER pBlitter, bool fBb, PCR_BLITTER_IMG pDst);
228VBOXBLITTERDECL(void) CrBltImgFree(PCR_BLITTER pBlitter, PCR_BLITTER_IMG pDst);
229VBOXBLITTERDECL(void) CrBltPresent(PCR_BLITTER pBlitter);
230/* */
231struct CR_TEXDATA;
232
233typedef DECLCALLBACK(void) FNCRTEXDATA_RELEASED(struct CR_TEXDATA *pTexture);
234typedef FNCRTEXDATA_RELEASED *PFNCRTEXDATA_RELEASED;
235
236typedef union CR_TEXDATA_FLAGS
237{
238 struct
239 {
240 uint32_t DataValid : 1;
241 uint32_t DataAcquired : 1;
242 uint32_t DataInverted : 1;
243 uint32_t Entered : 1;
244 uint32_t Reserved : 28;
245 };
246 uint32_t Value;
247} CR_TEXDATA_FLAGS;
248
249
250typedef struct CR_TEXDATA
251{
252 VBOXVR_TEXTURE Tex;
253 volatile uint32_t cRefs;
254 /* fields specific to texture data download */
255 uint32_t idInvertTex;
256 uint32_t idPBO;
257 CR_TEXDATA_FLAGS Flags;
258 PCR_BLITTER pBlitter;
259 CR_BLITTER_IMG Img;
260 /*dtor*/
261 PFNCRTEXDATA_RELEASED pfnTextureReleased;
262 struct CR_TEXDATA *pScaledCache;
263} CR_TEXDATA;
264typedef CR_TEXDATA *PCR_TEXDATA;
265typedef CR_TEXDATA const *PCCR_TEXDATA;
266
267DECLINLINE(void) CrTdInit(PCR_TEXDATA pTex, PCVBOXVR_TEXTURE pVrTex, PCR_BLITTER pBlitter, PFNCRTEXDATA_RELEASED pfnTextureReleased)
268{
269 memset(pTex, 0, sizeof (*pTex));
270 pTex->Tex = *pVrTex;
271 pTex->cRefs = 1;
272 pTex->pBlitter = pBlitter;
273 pTex->pfnTextureReleased = pfnTextureReleased;
274}
275
276DECLINLINE(PCVBOXVR_TEXTURE) CrTdTexGet(PCCR_TEXDATA pTex)
277{
278 return &pTex->Tex;
279}
280
281DECLINLINE(PCR_BLITTER) CrTdBlitterGet(PCR_TEXDATA pTex)
282{
283 return pTex->pBlitter;
284}
285
286DECLINLINE(int) CrTdBltEnter(PCR_TEXDATA pTex)
287{
288 int rc;
289 if (pTex->Flags.Entered)
290 return VERR_INVALID_STATE;
291 rc = CrBltEnter(pTex->pBlitter);
292#ifdef IN_VMSVGA3D
293 AssertRCReturn(rc, rc);
294#else
295 if (!RT_SUCCESS(rc))
296 {
297 WARN(("CrBltEnter failed rc %d", rc));
298 return rc;
299 }
300#endif
301 pTex->Flags.Entered = 1;
302 return VINF_SUCCESS;
303}
304
305DECLINLINE(bool) CrTdBltIsEntered(PCR_TEXDATA pTex)
306{
307 return pTex->Flags.Entered;
308}
309
310DECLINLINE(void) CrTdBltLeave(PCR_TEXDATA pTex)
311{
312#ifdef IN_VMSVGA3D
313 AssertReturnVoid(pTex->Flags.Entered);
314#else
315 if (!pTex->Flags.Entered)
316 {
317 WARN(("invalid Blt Leave"));
318 return;
319 }
320#endif
321
322 CrBltLeave(pTex->pBlitter);
323
324 pTex->Flags.Entered = 0;
325}
326
327/* the CrTdBltXxx calls are done with the entered blitter */
328/** Acquire the texture data, returns the cached data in case it is cached.
329 * The data remains cached in the CR_TEXDATA object until it is discarded with
330 * CrTdBltDataFree or CrTdBltDataCleanup. */
331VBOXBLITTERDECL(int) CrTdBltDataAcquire(PCR_TEXDATA pTex, GLenum enmFormat, bool fInverted, PCCR_BLITTER_IMG *ppImg);
332
333VBOXBLITTERDECL(int) CrTdBltDataAcquireScaled(PCR_TEXDATA pTex, GLenum enmFormat, bool fInverted,
334 uint32_t width, uint32_t height, PCCR_BLITTER_IMG *ppImg);
335
336VBOXBLITTERDECL(int) CrTdBltDataReleaseScaled(PCR_TEXDATA pTex, PCCR_BLITTER_IMG pImg);
337
338VBOXBLITTERDECL(void) CrTdBltScaleCacheMoveTo(PCR_TEXDATA pTex, PCR_TEXDATA pDstTex);
339
340/** Release the texture data, the data remains cached in the CR_TEXDATA object
341 * until it is discarded with CrTdBltDataFree or CrTdBltDataCleanup. */
342VBOXBLITTERDECL(int) CrTdBltDataRelease(PCR_TEXDATA pTex);
343/** Discard the texture data cached with previous CrTdBltDataAcquire.
344 * Must be called wit data released (CrTdBltDataRelease). */
345VBOXBLITTERDECL(int) CrTdBltDataFree(PCR_TEXDATA pTex);
346VBOXBLITTERDECL(int) CrTdBltDataFreeNe(PCR_TEXDATA pTex);
347VBOXBLITTERDECL(void) CrTdBltDataInvalidateNe(PCR_TEXDATA pTex);
348/** Does same as CrTdBltDataFree, and in addition cleans up.
349 * This is kind of a texture destructor, which clients should call on texture object destruction,
350 * e.g. from the PFNCRTEXDATA_RELEASED callback. */
351VBOXBLITTERDECL(int) CrTdBltDataCleanup(PCR_TEXDATA pTex);
352
353VBOXBLITTERDECL(int) CrTdBltDataCleanupNe(PCR_TEXDATA pTex);
354
355DECLINLINE(uint32_t) CrTdAddRef(PCR_TEXDATA pTex)
356{
357 return ASMAtomicIncU32(&pTex->cRefs);
358}
359
360DECLINLINE(uint32_t) CrTdRelease(PCR_TEXDATA pTex)
361{
362 uint32_t cRefs = ASMAtomicDecU32(&pTex->cRefs);
363 if (!cRefs)
364 {
365 if (pTex->pfnTextureReleased)
366 pTex->pfnTextureReleased(pTex);
367 else
368 CrTdBltDataCleanupNe(pTex);
369 }
370
371 return cRefs;
372}
373
374RT_C_DECLS_END
375
376#endif
377
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