VirtualBox

source: vbox/trunk/src/VBox/Frontends/VBoxSDL/Framebuffer.h@ 16827

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

VBoxSDL framebuffer resize optimization (xTracker #3487).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.8 KB
Line 
1/** @file
2 *
3 * VBox frontends: VBoxSDL (simple frontend based on SDL):
4 * Declaration of VBoxSDLFB (SDL framebuffer) class
5 */
6
7/*
8 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
19 * Clara, CA 95054 USA or visit http://www.sun.com if you need
20 * additional information or have any questions.
21 */
22
23#ifndef __H_FRAMEBUFFER
24#define __H_FRAMEBUFFER
25
26#include "VBoxSDL.h"
27#include <iprt/thread.h>
28
29#include <iprt/critsect.h>
30
31#ifdef VBOX_SECURELABEL
32#include <SDL_ttf.h>
33/* function pointers */
34extern "C"
35{
36extern DECLSPEC int (SDLCALL *pTTF_Init)(void);
37extern DECLSPEC TTF_Font* (SDLCALL *pTTF_OpenFont)(const char *file, int ptsize);
38extern DECLSPEC SDL_Surface* (SDLCALL *pTTF_RenderUTF8_Solid)(TTF_Font *font, const char *text, SDL_Color fg);
39extern DECLSPEC SDL_Surface* (SDLCALL *pTTF_RenderUTF8_Shaded)(TTF_Font *font, const char *text, SDL_Color fg, SDL_Color bg);
40extern DECLSPEC SDL_Surface* (SDLCALL *pTTF_RenderUTF8_Blended)(TTF_Font *font, const char *text, SDL_Color fg);
41extern DECLSPEC void (SDLCALL *pTTF_CloseFont)(TTF_Font *font);
42extern DECLSPEC void (SDLCALL *pTTF_Quit)(void);
43}
44#endif /* VBOX_SECURELABEL */
45
46class VBoxSDLFBOverlay;
47
48class VBoxSDLFB :
49 public IFramebuffer
50{
51public:
52 VBoxSDLFB(bool fFullscreen = false, bool fResizable = true, bool fShowSDLConfig = false,
53 bool fKeepHostRes = false, uint32_t u32FixedWidth = ~(uint32_t)0,
54 uint32_t u32FixedHeight = ~(uint32_t)0, uint32_t u32FixedBPP = ~(uint32_t)0);
55 virtual ~VBoxSDLFB();
56
57#ifdef RT_OS_WINDOWS
58 STDMETHOD_(ULONG, AddRef)()
59 {
60 return ::InterlockedIncrement (&refcnt);
61 }
62 STDMETHOD_(ULONG, Release)()
63 {
64 long cnt = ::InterlockedDecrement (&refcnt);
65 if (cnt == 0)
66 delete this;
67 return cnt;
68 }
69 STDMETHOD(QueryInterface) (REFIID riid , void **ppObj)
70 {
71 if (riid == IID_IUnknown)
72 {
73 *ppObj = this;
74 AddRef();
75 return S_OK;
76 }
77 if (riid == IID_IFramebuffer)
78 {
79 *ppObj = this;
80 AddRef();
81 return S_OK;
82 }
83 *ppObj = NULL;
84 return E_NOINTERFACE;
85 }
86#endif
87
88 NS_DECL_ISUPPORTS
89
90 STDMETHOD(COMGETTER(Width))(ULONG *width);
91 STDMETHOD(COMGETTER(Height))(ULONG *height);
92 STDMETHOD(Lock)();
93 STDMETHOD(Unlock)();
94 STDMETHOD(COMGETTER(Address))(BYTE **address);
95 STDMETHOD(COMGETTER(BitsPerPixel))(ULONG *bitsPerPixel);
96 STDMETHOD(COMGETTER(BytesPerLine))(ULONG *bytesPerLine);
97 STDMETHOD(COMGETTER(PixelFormat)) (ULONG *pixelFormat);
98 STDMETHOD(COMGETTER(UsesGuestVRAM)) (BOOL *usesGuestVRAM);
99 STDMETHOD(COMGETTER(HeightReduction)) (ULONG *heightReduction);
100 STDMETHOD(COMGETTER(Overlay)) (IFramebufferOverlay **aOverlay);
101 STDMETHOD(COMGETTER(WinId)) (uint64_t *winId);
102
103 STDMETHOD(NotifyUpdate)(ULONG x, ULONG y,
104 ULONG w, ULONG h, BOOL *finished);
105 STDMETHOD(RequestResize)(ULONG aScreenId, ULONG pixelFormat, BYTE *vram,
106 ULONG bitsPerPixel, ULONG bytesPerLine,
107 ULONG w, ULONG h, BOOL *finished);
108 STDMETHOD(OperationSupported)(FramebufferAccelerationOperation_T operation, BOOL *supported);
109 STDMETHOD(VideoModeSupported)(ULONG width, ULONG height, ULONG bpp, BOOL *supported);
110 STDMETHOD(SolidFill)(ULONG x, ULONG y, ULONG width, ULONG height,
111 ULONG color, BOOL *handled);
112 STDMETHOD(CopyScreenBits)(ULONG xDst, ULONG yDst, ULONG xSrc, ULONG ySrc,
113 ULONG width, ULONG height, BOOL *handled);
114
115 STDMETHOD(GetVisibleRegion)(BYTE *aRectangles, ULONG aCount, ULONG *aCountCopied);
116 STDMETHOD(SetVisibleRegion)(BYTE *aRectangles, ULONG aCount);
117
118 // internal public methods
119 bool initialized() { return mfInitialized; }
120 void resizeGuest();
121 void resizeSDL();
122 void update(int x, int y, int w, int h, bool fGuestRelative);
123 void repaint();
124 bool getFullscreen();
125 void setFullscreen(bool fFullscreen);
126 int getXOffset();
127 int getYOffset();
128 void getFullscreenGeometry(uint32_t *width, uint32_t *height);
129 uint32_t getGuestXRes() { return mGuestXRes; }
130 uint32_t getGuestYRes() { return mGuestYRes; }
131#ifdef VBOX_SECURELABEL
132 int initSecureLabel(uint32_t height, char *font, uint32_t pointsize, uint32_t labeloffs);
133 void setSecureLabelText(const char *text);
134 void setSecureLabelColor(uint32_t colorFG, uint32_t colorBG);
135 void paintSecureLabel(int x, int y, int w, int h, bool fForce);
136#endif
137 void uninit();
138 void setWinId(uint64_t winId) { mWinId = winId; }
139
140private:
141 /** the sdl thread */
142 RTNATIVETHREAD mSdlNativeThread;
143 /** current SDL framebuffer pointer (also includes screen width/height) */
144 SDL_Surface *mScreen;
145 /** false if constructor failed */
146 bool mfInitialized;
147 /** maximum possible screen width in pixels (~0 = no restriction) */
148 uint32_t mMaxScreenWidth;
149 /** maximum possible screen height in pixels (~0 = no restriction) */
150 uint32_t mMaxScreenHeight;
151 /** current guest screen width in pixels */
152 ULONG mGuestXRes;
153 /** current guest screen height in pixels */
154 ULONG mGuestYRes;
155 /** fixed SDL screen width (~0 = not set) */
156 uint32_t mFixedSDLWidth;
157 /** fixed SDL screen height (~0 = not set) */
158 uint32_t mFixedSDLHeight;
159 /** fixed SDL bits per pixel (~0 = not set) */
160 uint32_t mFixedSDLBPP;
161 /** default BPP */
162 uint32_t mDefaultSDLBPP;
163 /** Y offset in pixels, i.e. guest-nondrawable area at the top */
164 uint32_t mTopOffset;
165 /** X offset for guest screen centering */
166 uint32_t mCenterXOffset;
167 /** Y offset for guest screen centering */
168 uint32_t mCenterYOffset;
169 /** flag whether we're in fullscreen mode */
170 bool mfFullscreen;
171 /** flag wheter we keep the host screen resolution when switching to
172 * fullscreen or not */
173 bool mfKeepHostRes;
174 /** framebuffer update semaphore */
175 RTCRITSECT mUpdateLock;
176 /** flag whether the SDL window should be resizable */
177 bool mfResizable;
178 /** flag whether we print out SDL information */
179 bool mfShowSDLConfig;
180 /** handle to window where framebuffer context is being drawn*/
181 uint64_t mWinId;
182#ifdef VBOX_SECURELABEL
183 /** current secure label text */
184 Utf8Str mSecureLabelText;
185 /** current secure label foreground color (RGB) */
186 uint32_t mSecureLabelColorFG;
187 /** current secure label background color (RGB) */
188 uint32_t mSecureLabelColorBG;
189 /** secure label font handle */
190 TTF_Font *mLabelFont;
191 /** secure label height in pixels */
192 uint32_t mLabelHeight;
193 /** secure label offset from the top of the secure label */
194 uint32_t mLabelOffs;
195#endif
196#ifdef RT_OS_WINDOWS
197 long refcnt;
198#endif
199 SDL_Surface *mSurfVRAM;
200
201 BYTE *mPtrVRAM;
202 ULONG mBitsPerPixel;
203 ULONG mBytesPerLine;
204 ULONG mPixelFormat;
205 BOOL mUsesGuestVRAM;
206 BOOL mfSameSizeRequested;
207
208 /** the application Icon */
209 SDL_Surface *mWMIcon;
210};
211
212class VBoxSDLFBOverlay :
213 public IFramebufferOverlay
214{
215public:
216 VBoxSDLFBOverlay(ULONG x, ULONG y, ULONG width, ULONG height, BOOL visible,
217 VBoxSDLFB *aParent);
218 virtual ~VBoxSDLFBOverlay();
219
220#ifdef RT_OS_WINDOWS
221 STDMETHOD_(ULONG, AddRef)()
222 {
223 return ::InterlockedIncrement (&refcnt);
224 }
225 STDMETHOD_(ULONG, Release)()
226 {
227 long cnt = ::InterlockedDecrement (&refcnt);
228 if (cnt == 0)
229 delete this;
230 return cnt;
231 }
232 STDMETHOD(QueryInterface) (REFIID riid , void **ppObj)
233 {
234 if (riid == IID_IUnknown)
235 {
236 *ppObj = this;
237 AddRef();
238 return S_OK;
239 }
240 if (riid == IID_IFramebuffer)
241 {
242 *ppObj = this;
243 AddRef();
244 return S_OK;
245 }
246 *ppObj = NULL;
247 return E_NOINTERFACE;
248 }
249#endif
250
251 NS_DECL_ISUPPORTS
252
253 STDMETHOD(COMGETTER(X))(ULONG *x);
254 STDMETHOD(COMGETTER(Y))(ULONG *y);
255 STDMETHOD(COMGETTER(Width))(ULONG *width);
256 STDMETHOD(COMGETTER(Height))(ULONG *height);
257 STDMETHOD(COMGETTER(Visible))(BOOL *visible);
258 STDMETHOD(COMSETTER(Visible))(BOOL visible);
259 STDMETHOD(COMGETTER(Alpha))(ULONG *alpha);
260 STDMETHOD(COMSETTER(Alpha))(ULONG alpha);
261 STDMETHOD(COMGETTER(Address))(ULONG *address);
262 STDMETHOD(COMGETTER(BytesPerLine))(ULONG *bytesPerLine);
263
264 /* These are not used, or return standard values. */
265 STDMETHOD(COMGETTER(BitsPerPixel))(ULONG *bitsPerPixel);
266 STDMETHOD(COMGETTER(PixelFormat)) (ULONG *pixelFormat);
267 STDMETHOD(COMGETTER(UsesGuestVRAM)) (BOOL *usesGuestVRAM);
268 STDMETHOD(COMGETTER(HeightReduction)) (ULONG *heightReduction);
269 STDMETHOD(COMGETTER(Overlay)) (IFramebufferOverlay **aOverlay);
270 STDMETHOD(COMGETTER(WinId)) (ULONG64 *winId);
271
272 STDMETHOD(Lock)();
273 STDMETHOD(Unlock)();
274 STDMETHOD(Move)(ULONG x, ULONG y);
275 STDMETHOD(NotifyUpdate)(ULONG x, ULONG y,
276 ULONG w, ULONG h, BOOL *finished);
277 STDMETHOD(RequestResize)(ULONG aScreenId, ULONG pixelFormat, ULONG vram,
278 ULONG bitsPerPixel, ULONG bytesPerLine,
279 ULONG w, ULONG h, BOOL *finished);
280 STDMETHOD(OperationSupported)(FramebufferAccelerationOperation_T operation,
281 BOOL *supported);
282 STDMETHOD(VideoModeSupported)(ULONG width, ULONG height, ULONG bpp, BOOL *supported);
283 STDMETHOD(SolidFill)(ULONG x, ULONG y, ULONG width, ULONG height,
284 ULONG color, BOOL *handled);
285 STDMETHOD(CopyScreenBits)(ULONG xDst, ULONG yDst, ULONG xSrc, ULONG ySrc,
286 ULONG width, ULONG height, BOOL *handled);
287
288 // internal public methods
289 HRESULT init();
290
291private:
292 /** Overlay X offset */
293 ULONG mOverlayX;
294 /** Overlay Y offset */
295 ULONG mOverlayY;
296 /** Overlay width */
297 ULONG mOverlayWidth;
298 /** Overlay height */
299 ULONG mOverlayHeight;
300 /** Whether the overlay is currently active */
301 BOOL mOverlayVisible;
302 /** The parent IFramebuffer */
303 VBoxSDLFB *mParent;
304 /** SDL surface containing the actual framebuffer bits */
305 SDL_Surface *mOverlayBits;
306 /** Additional SDL surface used for combining the framebuffer and the overlay */
307 SDL_Surface *mBlendedBits;
308#ifdef RT_OS_WINDOWS
309 long refcnt;
310#endif
311};
312
313#endif // __H_FRAMEBUFFER
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