VirtualBox

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

Last change on this file since 82781 was 81537, checked in by vboxsync, 5 years ago

FE/VBoxSDL: Added first support for SDL2 (by setting VBOX_WITH_SDL2). Very rough / hacky by now and needs more testing first before enabling by default. Also fixed non-starting with SDL 1.2.x on Windows hosts.

Known limitations / todos when running with SDL 2 for now:

  • No alpha channel support for cursors.
  • No mouse wheel support.
  • Desktop geometry handling needs a revamp for multi monitor setups.
  • Check / revamp dirty rectangle blitting.
  • OpenGL renderer needs testing wrt texture blitting.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.4 KB
Line 
1/* $Id: Framebuffer.h 81537 2019-10-25 11:46:30Z vboxsync $ */
2/** @file
3 *
4 * VBox frontends: VBoxSDL (simple frontend based on SDL):
5 * Declaration of VBoxSDLFB (SDL framebuffer) class
6 */
7
8/*
9 * Copyright (C) 2006-2019 Oracle Corporation
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
20#ifndef VBOX_INCLUDED_SRC_VBoxSDL_Framebuffer_h
21#define VBOX_INCLUDED_SRC_VBoxSDL_Framebuffer_h
22#ifndef RT_WITHOUT_PRAGMA_ONCE
23# pragma once
24#endif
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 && !VBOX_WITH_SDL2 */
45
46class VBoxSDLFBOverlay;
47
48class ATL_NO_VTABLE VBoxSDLFB :
49 public ATL::CComObjectRootEx<ATL::CComMultiThreadModel>,
50 VBOX_SCRIPTABLE_IMPL(IFramebuffer)
51{
52public:
53 VBoxSDLFB();
54 virtual ~VBoxSDLFB();
55
56 HRESULT init(uint32_t uScreenId,
57 bool fFullscreen, bool fResizable, bool fShowSDLConfig,
58 bool fKeepHostRes, uint32_t u32FixedWidth,
59 uint32_t u32FixedHeight, uint32_t u32FixedBPP,
60 bool fUpdateImage);
61
62 static bool init(bool fShowSDLConfig);
63 static void uninit();
64
65 DECLARE_NOT_AGGREGATABLE(VBoxSDLFB)
66
67 DECLARE_PROTECT_FINAL_CONSTRUCT()
68
69 BEGIN_COM_MAP(VBoxSDLFB)
70 COM_INTERFACE_ENTRY(IFramebuffer)
71 COM_INTERFACE_ENTRY2(IDispatch,IFramebuffer)
72 COM_INTERFACE_ENTRY_AGGREGATE(IID_IMarshal, m_pUnkMarshaler.m_p)
73 END_COM_MAP()
74
75 HRESULT FinalConstruct();
76 void FinalRelease();
77
78 STDMETHOD(COMGETTER(Width))(ULONG *width);
79 STDMETHOD(COMGETTER(Height))(ULONG *height);
80 STDMETHOD(COMGETTER(BitsPerPixel))(ULONG *bitsPerPixel);
81 STDMETHOD(COMGETTER(BytesPerLine))(ULONG *bytesPerLine);
82 STDMETHOD(COMGETTER(PixelFormat))(BitmapFormat_T *pixelFormat);
83 STDMETHOD(COMGETTER(HeightReduction))(ULONG *heightReduction);
84 STDMETHOD(COMGETTER(Overlay))(IFramebufferOverlay **aOverlay);
85 STDMETHOD(COMGETTER(WinId))(LONG64 *winId);
86 STDMETHOD(COMGETTER(Capabilities))(ComSafeArrayOut(FramebufferCapabilities_T, aCapabilities));
87
88 STDMETHOD(NotifyUpdate)(ULONG x, ULONG y, ULONG w, ULONG h);
89 STDMETHOD(NotifyUpdateImage)(ULONG x, ULONG y, ULONG w, ULONG h, ComSafeArrayIn(BYTE, aImage));
90 STDMETHOD(NotifyChange)(ULONG aScreenId,
91 ULONG aXOrigin,
92 ULONG aYOrigin,
93 ULONG aWidth,
94 ULONG aHeight);
95 STDMETHOD(VideoModeSupported)(ULONG width, ULONG height, ULONG bpp, BOOL *supported);
96
97 STDMETHOD(GetVisibleRegion)(BYTE *aRectangles, ULONG aCount, ULONG *aCountCopied);
98 STDMETHOD(SetVisibleRegion)(BYTE *aRectangles, ULONG aCount);
99
100 STDMETHOD(ProcessVHWACommand)(BYTE *pCommand, LONG enmCmd, BOOL fGuestCmd);
101
102 STDMETHOD(Notify3DEvent)(ULONG uType, ComSafeArrayIn(BYTE, aData));
103
104 // internal public methods
105 bool initialized() { return mfInitialized; }
106 void notifyChange(ULONG aScreenId);
107 void resizeGuest();
108 void resizeSDL();
109 void update(int x, int y, int w, int h, bool fGuestRelative);
110 void repaint();
111 void setFullscreen(bool fFullscreen);
112 void getFullscreenGeometry(uint32_t *width, uint32_t *height);
113 uint32_t getScreenId() { return mScreenId; }
114 uint32_t getGuestXRes() { return mGuestXRes; }
115 uint32_t getGuestYRes() { return mGuestYRes; }
116 int32_t getOriginX() { return mOriginX; }
117 int32_t getOriginY() { return mOriginY; }
118 int32_t getXOffset() { return mCenterXOffset; }
119 int32_t getYOffset() { return mCenterYOffset; }
120#ifdef VBOX_WITH_SDL2
121 SDL_Window *getWindow() { return mpWindow; }
122 bool hasWindow(uint32_t id) { return mScreen && SDL_GetWindowID(mpWindow) == id; }
123 int setWindowTitle(const char *pcszTitle);
124#endif
125#ifdef VBOX_SECURELABEL
126 int initSecureLabel(uint32_t height, char *font, uint32_t pointsize, uint32_t labeloffs);
127 void setSecureLabelText(const char *text);
128 void setSecureLabelColor(uint32_t colorFG, uint32_t colorBG);
129 void paintSecureLabel(int x, int y, int w, int h, bool fForce);
130#endif
131 void setWinId(int64_t winId) { mWinId = winId; }
132 void setOrigin(int32_t axOrigin, int32_t ayOrigin) { mOriginX = axOrigin; mOriginY = ayOrigin; }
133 bool getFullscreen() { return mfFullscreen; }
134
135private:
136 /** current SDL framebuffer pointer (also includes screen width/height) */
137 SDL_Surface *mScreen;
138#ifdef VBOX_WITH_SDL2
139 /** the SDL window */
140 SDL_Window *mpWindow;
141 /** the texture */
142 SDL_Texture *mpTexture;
143 /** renderer */
144 SDL_Renderer *mpRenderer;
145 /** render info */
146 SDL_RendererInfo mRenderInfo;
147#endif
148 /** false if constructor failed */
149 bool mfInitialized;
150 /** the screen number of this framebuffer */
151 uint32_t mScreenId;
152 /** use NotifyUpdateImage */
153 bool mfUpdateImage;
154 /** maximum possible screen width in pixels (~0 = no restriction) */
155 uint32_t mMaxScreenWidth;
156 /** maximum possible screen height in pixels (~0 = no restriction) */
157 uint32_t mMaxScreenHeight;
158 /** current guest screen width in pixels */
159 ULONG mGuestXRes;
160 /** current guest screen height in pixels */
161 ULONG mGuestYRes;
162 int32_t mOriginX;
163 int32_t mOriginY;
164 /** fixed SDL screen width (~0 = not set) */
165 uint32_t mFixedSDLWidth;
166 /** fixed SDL screen height (~0 = not set) */
167 uint32_t mFixedSDLHeight;
168 /** fixed SDL bits per pixel (~0 = not set) */
169 uint32_t mFixedSDLBPP;
170 /** Y offset in pixels, i.e. guest-nondrawable area at the top */
171 uint32_t mTopOffset;
172 /** X offset for guest screen centering */
173 uint32_t mCenterXOffset;
174 /** Y offset for guest screen centering */
175 uint32_t mCenterYOffset;
176 /** flag whether we're in fullscreen mode */
177 bool mfFullscreen;
178 /** flag whether we keep the host screen resolution when switching to
179 * fullscreen or not */
180 bool mfKeepHostRes;
181 /** framebuffer update semaphore */
182 RTCRITSECT mUpdateLock;
183 /** flag whether the SDL window should be resizable */
184 bool mfResizable;
185 /** flag whether we print out SDL information */
186 bool mfShowSDLConfig;
187 /** handle to window where framebuffer context is being drawn*/
188 int64_t mWinId;
189#ifdef VBOX_SECURELABEL
190 /** current secure label text */
191 Utf8Str mSecureLabelText;
192 /** current secure label foreground color (RGB) */
193 uint32_t mSecureLabelColorFG;
194 /** current secure label background color (RGB) */
195 uint32_t mSecureLabelColorBG;
196 /** secure label font handle */
197 TTF_Font *mLabelFont;
198 /** secure label height in pixels */
199 uint32_t mLabelHeight;
200 /** secure label offset from the top of the secure label */
201 uint32_t mLabelOffs;
202
203#endif
204
205 SDL_Surface *mSurfVRAM;
206
207 BYTE *mPtrVRAM;
208 ULONG mBitsPerPixel;
209 ULONG mBytesPerLine;
210 BOOL mfSameSizeRequested;
211
212 ComPtr<IDisplaySourceBitmap> mpSourceBitmap;
213 ComPtr<IDisplaySourceBitmap> mpPendingSourceBitmap;
214 bool mfUpdates;
215
216#ifdef RT_OS_WINDOWS
217 ComPtr<IUnknown> m_pUnkMarshaler;
218#endif
219};
220
221class VBoxSDLFBOverlay :
222 public IFramebufferOverlay
223{
224public:
225 VBoxSDLFBOverlay(ULONG x, ULONG y, ULONG width, ULONG height, BOOL visible,
226 VBoxSDLFB *aParent);
227 virtual ~VBoxSDLFBOverlay();
228
229#ifdef RT_OS_WINDOWS
230 STDMETHOD_(ULONG, AddRef)()
231 {
232 return ::InterlockedIncrement(&refcnt);
233 }
234 STDMETHOD_(ULONG, Release)()
235 {
236 long cnt = ::InterlockedDecrement(&refcnt);
237 if (cnt == 0)
238 delete this;
239 return cnt;
240 }
241#endif
242 VBOX_SCRIPTABLE_DISPATCH_IMPL(IFramebuffer)
243
244 NS_DECL_ISUPPORTS
245
246 STDMETHOD(COMGETTER(X))(ULONG *x);
247 STDMETHOD(COMGETTER(Y))(ULONG *y);
248 STDMETHOD(COMGETTER(Width))(ULONG *width);
249 STDMETHOD(COMGETTER(Height))(ULONG *height);
250 STDMETHOD(COMGETTER(Visible))(BOOL *visible);
251 STDMETHOD(COMSETTER(Visible))(BOOL visible);
252 STDMETHOD(COMGETTER(Alpha))(ULONG *alpha);
253 STDMETHOD(COMSETTER(Alpha))(ULONG alpha);
254 STDMETHOD(COMGETTER(BytesPerLine))(ULONG *bytesPerLine);
255
256 /* These are not used, or return standard values. */
257 STDMETHOD(COMGETTER(BitsPerPixel))(ULONG *bitsPerPixel);
258 STDMETHOD(COMGETTER(PixelFormat))(ULONG *pixelFormat);
259 STDMETHOD(COMGETTER(UsesGuestVRAM))(BOOL *usesGuestVRAM);
260 STDMETHOD(COMGETTER(HeightReduction))(ULONG *heightReduction);
261 STDMETHOD(COMGETTER(Overlay))(IFramebufferOverlay **aOverlay);
262 STDMETHOD(COMGETTER(WinId))(LONG64 *winId);
263
264 STDMETHOD(Lock)();
265 STDMETHOD(Unlock)();
266 STDMETHOD(Move)(ULONG x, ULONG y);
267 STDMETHOD(NotifyUpdate)(ULONG x, ULONG y, ULONG w, ULONG h);
268 STDMETHOD(RequestResize)(ULONG aScreenId, ULONG pixelFormat, ULONG vram,
269 ULONG bitsPerPixel, ULONG bytesPerLine,
270 ULONG w, ULONG h, BOOL *finished);
271 STDMETHOD(VideoModeSupported)(ULONG width, ULONG height, ULONG bpp, BOOL *supported);
272
273 // internal public methods
274 HRESULT init();
275
276private:
277 /** Overlay X offset */
278 ULONG mOverlayX;
279 /** Overlay Y offset */
280 ULONG mOverlayY;
281 /** Overlay width */
282 ULONG mOverlayWidth;
283 /** Overlay height */
284 ULONG mOverlayHeight;
285 /** Whether the overlay is currently active */
286 BOOL mOverlayVisible;
287 /** The parent IFramebuffer */
288 VBoxSDLFB *mParent;
289 /** SDL surface containing the actual framebuffer bits */
290 SDL_Surface *mOverlayBits;
291 /** Additional SDL surface used for combining the framebuffer and the overlay */
292 SDL_Surface *mBlendedBits;
293#ifdef RT_OS_WINDOWS
294 long refcnt;
295#endif
296};
297
298#endif /* !VBOX_INCLUDED_SRC_VBoxSDL_Framebuffer_h */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use