Frontends/VBoxSDL/Framebuffer.h

	Framebuffer.h revision ab06f8d7650d6b6784b7489b4e6db9f693753fd8
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync/** @file
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync *
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * VBox frontends: VBoxSDL (simple frontend based on SDL):
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * Declaration of VBoxSDLFB (SDL framebuffer) class
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync */
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync/*
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * Copyright (C) 2006-2012 Oracle Corporation
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync *
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * available from http://www.virtualbox.org. This file is free software;
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * you can redistribute it and/or modify it under the terms of the GNU
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * General Public License (GPL) as published by the Free Software
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync */
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#ifndef __H_FRAMEBUFFER
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#define __H_FRAMEBUFFER
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#include "VBoxSDL.h"
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#include <iprt/thread.h>
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#include <iprt/critsect.h>
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#ifdef VBOX_SECURELABEL
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#include <SDL_ttf.h>
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync/* function pointers */
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern "C"
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync{
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern DECLSPEC int (SDLCALL *pTTF_Init)(void);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern DECLSPEC TTF_Font* (SDLCALL *pTTF_OpenFont)(const char *file, int ptsize);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern DECLSPEC SDL_Surface* (SDLCALL *pTTF_RenderUTF8_Solid)(TTF_Font *font, const char *text, SDL_Color fg);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern DECLSPEC SDL_Surface* (SDLCALL *pTTF_RenderUTF8_Shaded)(TTF_Font *font, const char *text, SDL_Color fg, SDL_Color bg);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern DECLSPEC SDL_Surface* (SDLCALL *pTTF_RenderUTF8_Blended)(TTF_Font *font, const char *text, SDL_Color fg);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern DECLSPEC void (SDLCALL *pTTF_CloseFont)(TTF_Font *font);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncextern DECLSPEC void (SDLCALL *pTTF_Quit)(void);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync}
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#endif /* VBOX_SECURELABEL && !VBOX_WITH_SDL13 */
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncclass VBoxSDLFBOverlay;
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncclass VBoxSDLFB :
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    VBOX_SCRIPTABLE_IMPL(IFramebuffer)
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync{
b9a21c3c91c47e090316e28d759194e46628ed49vboxsyncpublic:
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    VBoxSDLFB(uint32_t uScreenId,
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync              bool fFullscreen = false, bool fResizable = true, bool fShowSDLConfig = false,
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync              bool fKeepHostRes = false, uint32_t u32FixedWidth = ~(uint32_t)0,
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync              uint32_t u32FixedHeight = ~(uint32_t)0, uint32_t u32FixedBPP = ~(uint32_t)0);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    virtual ~VBoxSDLFB();
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    static bool init(bool fShowSDLConfig);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    static void uninit();
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#ifdef RT_OS_WINDOWS
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD_(ULONG, AddRef)()
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    {
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync        return ::InterlockedIncrement (&refcnt);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD_(ULONG, Release)()
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    {
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync        long cnt = ::InterlockedDecrement (&refcnt);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync        if (cnt == 0)
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync            delete this;
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync        return cnt;
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#endif
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    VBOX_SCRIPTABLE_DISPATCH_IMPL(IFramebuffer)
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    NS_DECL_ISUPPORTS
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(Width))(ULONG *width);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(Height))(ULONG *height);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(BitsPerPixel))(ULONG *bitsPerPixel);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(BytesPerLine))(ULONG *bytesPerLine);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(PixelFormat)) (ULONG *pixelFormat);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(HeightReduction)) (ULONG *heightReduction);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(Overlay)) (IFramebufferOverlay **aOverlay);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(COMGETTER(WinId)) (int64_t *winId);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(NotifyUpdate)(ULONG x, ULONG y, ULONG w, ULONG h);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(NotifyChange)(ULONG aScreenId,
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync                            ULONG aXOrigin,
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync                            ULONG aYOrigin,
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync                            ULONG aWidth,
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync                            ULONG aHeight);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(VideoModeSupported)(ULONG width, ULONG height, ULONG bpp, BOOL *supported);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(GetVisibleRegion)(BYTE *aRectangles, ULONG aCount, ULONG *aCountCopied);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(SetVisibleRegion)(BYTE *aRectangles, ULONG aCount);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(ProcessVHWACommand)(BYTE *pCommand);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    STDMETHOD(Notify3DEvent)(ULONG uType, BYTE *pReserved);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    // internal public methods
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    bool initialized() { return mfInitialized; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    void notifyChange(ULONG aScreenId);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    void resizeGuest();
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    void resizeSDL();
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    void update(int x, int y, int w, int h, bool fGuestRelative);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    void repaint();
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    void setFullscreen(bool fFullscreen);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    void getFullscreenGeometry(uint32_t *width, uint32_t *height);
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    uint32_t getScreenId() { return mScreenId; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    uint32_t getGuestXRes() { return mGuestXRes; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    uint32_t getGuestYRes() { return mGuestYRes; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    int32_t getOriginX() { return mOriginX; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    int32_t getOriginY() { return mOriginY; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    int32_t getXOffset() { return mCenterXOffset; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    int32_t getYOffset() { return mCenterYOffset; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#ifdef VBOX_WITH_SDL13
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    bool hasWindow(SDL_WindowID id) { return mScreen && mWindow == id; }
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#endif
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync#ifdef VBOX_SECURELABEL
b9a21c3c91c47e090316e28d759194e46628ed49vboxsync    int  initSecureLabel(uint32_t height, char *font, uint32_t pointsize, uint32_t labeloffs);
    void setSecureLabelText(const char *text);
    void setSecureLabelColor(uint32_t colorFG, uint32_t colorBG);
    void paintSecureLabel(int x, int y, int w, int h, bool fForce);
#endif
    void setWinId(int64_t winId) { mWinId = winId; }
    void setOrigin(int32_t axOrigin, int32_t ayOrigin) { mOriginX = axOrigin; mOriginY = ayOrigin; }
    bool getFullscreen() { return mfFullscreen; }

private:
    /** current SDL framebuffer pointer (also includes screen width/height) */
    SDL_Surface *mScreen;
#ifdef VBOX_WITH_SDL13
    /** the SDL window */
    SDL_WindowID mWindow;
    /** the texture */
    SDL_TextureID mTexture;
    /** render info */
    SDL_RendererInfo mRenderInfo;
#endif
    /** false if constructor failed */
    bool mfInitialized;
    /** the screen number of this framebuffer */
    uint32_t mScreenId;
    /** maximum possible screen width in pixels (~0 = no restriction) */
    uint32_t mMaxScreenWidth;
    /** maximum possible screen height in pixels (~0 = no restriction) */
    uint32_t mMaxScreenHeight;
    /** current guest screen width in pixels */
    ULONG mGuestXRes;
    /** current guest screen height in pixels */
    ULONG mGuestYRes;
    int32_t mOriginX;
    int32_t mOriginY;
    /** fixed SDL screen width (~0 = not set) */
    uint32_t mFixedSDLWidth;
    /** fixed SDL screen height (~0 = not set) */
    uint32_t mFixedSDLHeight;
    /** fixed SDL bits per pixel (~0 = not set) */
    uint32_t mFixedSDLBPP;
    /** Y offset in pixels, i.e. guest-nondrawable area at the top */
    uint32_t mTopOffset;
    /** X offset for guest screen centering */
    uint32_t mCenterXOffset;
    /** Y offset for guest screen centering */
    uint32_t mCenterYOffset;
    /** flag whether we're in fullscreen mode */
    bool  mfFullscreen;
    /** flag whether we keep the host screen resolution when switching to
     *  fullscreen or not */
    bool  mfKeepHostRes;
    /** framebuffer update semaphore */
    RTCRITSECT mUpdateLock;
    /** flag whether the SDL window should be resizable */
    bool mfResizable;
    /** flag whether we print out SDL information */
    bool mfShowSDLConfig;
    /** handle to window where framebuffer context is being drawn*/
    int64_t mWinId;
#ifdef VBOX_SECURELABEL
    /** current secure label text */
    Utf8Str mSecureLabelText;
    /** current secure label foreground color (RGB) */
    uint32_t mSecureLabelColorFG;
    /** current secure label background color (RGB) */
    uint32_t mSecureLabelColorBG;
    /** secure label font handle */
    TTF_Font *mLabelFont;
    /** secure label height in pixels */
    uint32_t mLabelHeight;
    /** secure label offset from the top of the secure label */
    uint32_t mLabelOffs;

#endif
#ifdef RT_OS_WINDOWS
    long refcnt;
#endif
    SDL_Surface *mSurfVRAM;

    BYTE *mPtrVRAM;
    ULONG mBitsPerPixel;
    ULONG mBytesPerLine;
    BOOL mfSameSizeRequested;

    ComPtr<IDisplaySourceBitmap> mpSourceBitmap;
    ComPtr<IDisplaySourceBitmap> mpPendingSourceBitmap;
    bool mfUpdates;
};

class VBoxSDLFBOverlay :
    public IFramebufferOverlay
{
public:
    VBoxSDLFBOverlay(ULONG x, ULONG y, ULONG width, ULONG height, BOOL visible,
                     VBoxSDLFB *aParent);
    virtual ~VBoxSDLFBOverlay();

#ifdef RT_OS_WINDOWS
    STDMETHOD_(ULONG, AddRef)()
    {
        return ::InterlockedIncrement (&refcnt);
    }
    STDMETHOD_(ULONG, Release)()
    {
        long cnt = ::InterlockedDecrement (&refcnt);
        if (cnt == 0)
            delete this;
        return cnt;
    }
#endif
    VBOX_SCRIPTABLE_DISPATCH_IMPL(IFramebuffer)

    NS_DECL_ISUPPORTS

    STDMETHOD(COMGETTER(X))(ULONG *x);
    STDMETHOD(COMGETTER(Y))(ULONG *y);
    STDMETHOD(COMGETTER(Width))(ULONG *width);
    STDMETHOD(COMGETTER(Height))(ULONG *height);
    STDMETHOD(COMGETTER(Visible))(BOOL *visible);
    STDMETHOD(COMSETTER(Visible))(BOOL visible);
    STDMETHOD(COMGETTER(Alpha))(ULONG *alpha);
    STDMETHOD(COMSETTER(Alpha))(ULONG alpha);
    STDMETHOD(COMGETTER(Address))(ULONG *address);
    STDMETHOD(COMGETTER(BytesPerLine))(ULONG *bytesPerLine);

    /* These are not used, or return standard values. */
    STDMETHOD(COMGETTER(BitsPerPixel))(ULONG *bitsPerPixel);
    STDMETHOD(COMGETTER(PixelFormat)) (ULONG *pixelFormat);
    STDMETHOD(COMGETTER(UsesGuestVRAM)) (BOOL *usesGuestVRAM);
    STDMETHOD(COMGETTER(HeightReduction)) (ULONG *heightReduction);
    STDMETHOD(COMGETTER(Overlay)) (IFramebufferOverlay **aOverlay);
    STDMETHOD(COMGETTER(WinId)) (LONG64 *winId);

    STDMETHOD(Lock)();
    STDMETHOD(Unlock)();
    STDMETHOD(Move)(ULONG x, ULONG y);
    STDMETHOD(NotifyUpdate)(ULONG x, ULONG y, ULONG w, ULONG h);
    STDMETHOD(RequestResize)(ULONG aScreenId, ULONG pixelFormat, ULONG vram,
                             ULONG bitsPerPixel, ULONG bytesPerLine,
                             ULONG w, ULONG h, BOOL *finished);
    STDMETHOD(VideoModeSupported)(ULONG width, ULONG height, ULONG bpp, BOOL *supported);

    // internal public methods
    HRESULT init();

private:
    /** Overlay X offset */
    ULONG mOverlayX;
    /** Overlay Y offset */
    ULONG mOverlayY;
    /** Overlay width */
    ULONG mOverlayWidth;
    /** Overlay height */
    ULONG mOverlayHeight;
    /** Whether the overlay is currently active */
    BOOL mOverlayVisible;
    /** The parent IFramebuffer */
    VBoxSDLFB *mParent;
    /** SDL surface containing the actual framebuffer bits */
    SDL_Surface *mOverlayBits;
    /** Additional SDL surface used for combining the framebuffer and the overlay */
    SDL_Surface *mBlendedBits;
#ifdef RT_OS_WINDOWS
    long refcnt;
#endif
};

#endif // __H_FRAMEBUFFER