VBoxGuestR3LibVideo.cpp revision b83d9b1072dd8491c7ffe37830e8fd10f2dba561
/* $Id$ */
/** @file
* VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Video.
*/
/*
* Copyright (C) 2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <iprt/string.h>
#include <iprt/mem.h>
#include <iprt/assert.h>
#include <VBox/log.h>
#include <VBox/HostServices/VBoxInfoSvc.h> /* For Save and RetrieveVideoMode */
#include "VBGLR3Internal.h"
/**
* Enable or disable video acceleration.
*
* @returns VBox status code.
*
* @param fEnable Pass zero to disable, any other value to enable.
*/
VBGLR3DECL(int) VbglR3VideoAccelEnable(bool fEnable)
{
VMMDevVideoAccelEnable Req;
vmmdevInitRequest(&Req.header, VMMDevReq_VideoAccelEnable);
Req.u32Enable = fEnable;
Req.cbRingBuffer = VBVA_RING_BUFFER_SIZE;
Req.fu32Status = 0;
return vbglR3GRPerform(&Req.header);
}
/**
* Flush the video buffer.
*
* @returns VBox status code.
*/
VBGLR3DECL(int) VbglR3VideoAccelFlush(void)
{
VMMDevVideoAccelFlush Req;
vmmdevInitRequest(&Req.header, VMMDevReq_VideoAccelFlush);
return vbglR3GRPerform(&Req.header);
}
/**
* Send mouse pointer shape information to the host.
*
* @returns VBox status code.
*
* @param fFlags Mouse pointer flags.
* @param xHot X coordinate of hot spot.
* @param yHot Y coordinate of hot spot.
* @param cx Pointer width.
* @param cy Pointer height.
* @param pvImg Pointer to the image data (can be NULL).
* @param cbImg Size of the image data pointed to by pvImg.
*/
VBGLR3DECL(int) VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy, const void *pvImg, size_t cbImg)
{
VMMDevReqMousePointer *pReq;
int rc = vbglR3GRAlloc((VMMDevRequestHeader **)&pReq, RT_OFFSETOF(VMMDevReqMousePointer, pointerData) + cbImg, VMMDevReq_SetPointerShape);
if (RT_SUCCESS(rc))
{
pReq->fFlags = fFlags;
pReq->xHot = xHot;
pReq->yHot = yHot;
pReq->width = cx;
pReq->height = cy;
if (pvImg)
memcpy(pReq->pointerData, pvImg, cbImg);
rc = vbglR3GRPerform(&pReq->header);
vbglR3GRFree(&pReq->header);
if (RT_SUCCESS(rc))
rc = pReq->header.rc;
}
return rc;
}
/**
* Send mouse pointer shape information to the host.
* This version of the function accepts a request for clients that
* already allocate and manipulate the request structure directly.
*
* @returns VBox status code.
*
* @param pReq Pointer to the VMMDevReqMousePointer structure.
*/
VBGLR3DECL(int) VbglR3SetPointerShapeReq(VMMDevReqMousePointer *pReq)
{
int rc = vbglR3GRPerform(&pReq->header);
if (RT_SUCCESS(rc))
rc = pReq->header.rc;
return rc;
}
/**
* Query the last display change request.
*
* @returns iprt status value
* @param pcx Where to store the horizontal pixel resolution (0 = do not change).
* @param pcy Where to store the vertical pixel resolution (0 = do not change).
* @param pcBits Where to store the bits per pixel (0 = do not change).
* @param iDisplay Where to store the display number the request was for - 0 for the
* primary display, 1 for the first secondary, etc.
*/
VBGLR3DECL(int) VbglR3GetLastDisplayChangeRequest(uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits, uint32_t *piDisplay)
{
VMMDevDisplayChangeRequest2 Req = { { 0 } };
#ifndef VBOX_VBGLR3_XFREE86
AssertPtrReturn(pcx, VERR_INVALID_PARAMETER);
AssertPtrReturn(pcy, VERR_INVALID_PARAMETER);
AssertPtrReturn(pcBits, VERR_INVALID_PARAMETER);
AssertPtrReturn(piDisplay, VERR_INVALID_PARAMETER);
#endif
vmmdevInitRequest(&Req.header, VMMDevReq_GetDisplayChangeRequest2);
int rc = vbglR3GRPerform(&Req.header);
if (RT_SUCCESS(rc))
rc = Req.header.rc;
if (RT_SUCCESS(rc))
{
*pcx = Req.xres;
*pcy = Req.yres;
*pcBits = Req.bpp;
*piDisplay = Req.display;
}
return rc;
}
/**
* Wait for a display change request event from the host. These events must have been
* activated previously using VbglR3CtlFilterMask.
*
* @returns IPRT status value
* @param pcx On success, where to return the requested display width.
* 0 means no change.
* @param pcy On success, where to return the requested display height.
* 0 means no change.
* @param pcBits On success, where to return the requested bits per pixel.
* 0 means no change.
* @param piDisplay On success, where to return the index of the display to be changed.
*/
VBGLR3DECL(int) VbglR3DisplayChangeWaitEvent(uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits, uint32_t *piDisplay)
{
VBoxGuestWaitEventInfo waitEvent;
int rc;
#ifndef VBOX_VBGLR3_XFREE86
AssertPtrReturn(pcx, VERR_INVALID_PARAMETER);
AssertPtrReturn(pcy, VERR_INVALID_PARAMETER);
AssertPtrReturn(pcBits, VERR_INVALID_PARAMETER);
AssertPtrReturn(piDisplay, VERR_INVALID_PARAMETER);
#endif
waitEvent.u32TimeoutIn = RT_INDEFINITE_WAIT;
waitEvent.u32EventMaskIn = VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST;
waitEvent.u32Result = VBOXGUEST_WAITEVENT_ERROR;
waitEvent.u32EventFlagsOut = 0;
rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT, &waitEvent, sizeof(waitEvent));
if (RT_SUCCESS(rc))
{
/* did we get the right event? */
if (waitEvent.u32EventFlagsOut & VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST)
{
VMMDevDisplayChangeRequest2 Req = { { 0 } };
vmmdevInitRequest(&Req.header, VMMDevReq_GetDisplayChangeRequest2);
Req.eventAck = VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST;
int rc = vbglR3GRPerform(&Req.header);
if (RT_SUCCESS(rc))
rc = Req.header.rc;
if (RT_SUCCESS(rc))
{
*pcx = Req.xres;
*pcy = Req.yres;
*pcBits = Req.bpp;
*piDisplay = Req.display;
}
}
else
rc = VERR_TRY_AGAIN;
}
return rc;
}
/**
* Query the host as to whether it likes a specific video mode.
*
* @returns the result of the query
* @param cx the width of the mode being queried
* @param cy the height of the mode being queried
* @param cBits the bpp of the mode being queried
*/
VBGLR3DECL(bool) VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits)
{
bool fRc = false;
int rc;
VMMDevVideoModeSupportedRequest req;
vmmdevInitRequest(&req.header, VMMDevReq_VideoModeSupported);
req.width = cx;
req.height = cy;
req.bpp = cBits;
req.fSupported = false;
rc = vbglR3GRPerform(&req.header);
if (RT_SUCCESS(rc) && RT_SUCCESS(req.header.rc))
fRc = req.fSupported;
else
LogRelFunc(("error querying video mode supported status from VMMDev."
"rc = %Vrc, VMMDev rc = %Vrc\n", rc, req.header.rc));
return fRc;
}
/**
* Save video mode parameters to the registry.
*
* @returns iprt status value
* @param pszName the name to save the mode parameters under
* @param cx mode width
* @param cy mode height
* @param cBits bits per pixel for the mode
*/
VBGLR3DECL(int) VbglR3SaveVideoMode(const char *pszName, uint32_t cx, uint32_t cy, uint32_t cBits)
{
#ifdef VBOX_WITH_INFO_SVC
using namespace svcInfo;
char szModeName[KEY_MAX_LEN];
char szModeParms[KEY_MAX_VALUE_LEN];
uint32_t u32ClientId = 0;
RTStrPrintf(szModeName, sizeof(szModeName), "VideoMode/%s", pszName);
RTStrPrintf(szModeParms, sizeof(szModeParms), "%dx%dx%d", cx, cy, cBits);
int rc = VbglR3InfoSvcConnect(&u32ClientId);
if (RT_SUCCESS(rc))
rc = VbglR3InfoSvcWriteKey(u32ClientId, szModeName, szModeParms);
if (u32ClientId != 0)
VbglR3InfoSvcDisconnect(u32ClientId); /* Return value ignored, because what can we do anyway? */
return rc;
#else /* VBOX_WITH_INFO_SVC not defined */
return VERR_NOT_IMPLEMENTED;
#endif /* VBOX_WITH_INFO_SVC not defined */
}
/**
* Retrieve video mode parameters from the registry.
*
* @returns iprt status value
* @param pszName the name under which the mode parameters are saved
* @param pcx where to store the mode width
* @param pcy where to store the mode height
* @param pcBits where to store the bits per pixel for the mode
*/
VBGLR3DECL(int) VbglR3RetrieveVideoMode(const char *pszName, uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits)
{
#ifdef VBOX_WITH_INFO_SVC
using namespace svcInfo;
char szModeParms[KEY_MAX_VALUE_LEN];
char *pszNext;
uint32_t u32ClientId = 0;
uint32_t cx, cy, cBits;
int rc = VbglR3InfoSvcConnect(&u32ClientId);
if (RT_SUCCESS(rc))
{
char szModeName[KEY_MAX_LEN];
RTStrPrintf(szModeName, sizeof(szModeName), "VideoMode/%s", pszName);
rc = VbglR3InfoSvcReadKey(u32ClientId, szModeName, szModeParms,
sizeof(szModeParms), NULL); /** @todo add a VbglR3InfoSvcReadKeyF/FV that does the RTStrPrintf for you. */
}
if (RT_SUCCESS(rc))
/* Extract the width from the string */
rc = RTStrToUInt32Ex(szModeParms, &pszNext, 10, &cx);
if ((rc != VWRN_TRAILING_CHARS) || (*pszNext != 'x'))
rc = VERR_PARSE_ERROR;
if (RT_SUCCESS(rc))
{
++pszNext;
rc = RTStrToUInt32Ex(pszNext, &pszNext, 10, &cy);
}
if ((rc != VWRN_TRAILING_CHARS) || (*pszNext != 'x'))
rc = VERR_PARSE_ERROR;
if (RT_SUCCESS(rc))
{
++pszNext;
rc = RTStrToUInt32Full(pszNext, 10, &cBits);
}
if (rc != VINF_SUCCESS)
rc = VERR_PARSE_ERROR;
if (u32ClientId != 0)
VbglR3InfoSvcDisconnect(u32ClientId); /* Return value ignored, because what can we do anyway? */
if (RT_SUCCESS(rc))
{
*pcx = cx;
*pcy = cy;
*pcBits = cBits;
}
return rc;
#else /* VBOX_WITH_INFO_SVC not defined */
return VERR_NOT_IMPLEMENTED;
#endif /* VBOX_WITH_INFO_SVC not defined */
}