This change adds support for the VMware Mouse Position pseudo-encoding[1], which is used to notify VNC clients when X11 clients call `XWarpPointer()`[2]. This function is called by SDL (and other similar libraries) when they detect that the server does not support native relative motion, like some RFB clients. With this, RFB clients can choose to adjust the local cursor position under certain circumstances to match what the server has set. For instance, if pointer lock has been enabled on the client's machine and the cursor is not being drawn locally, the local position of the cursor is irrelevant, so the RFB client can use what the server sends as the canonical absolute position of the cursor. This ultimately enables the possibility of games (especially FPS games) to behave how users expect (if the clients implement the corresponding change). Part of: #619 1: https://github.com/rfbproto/rfbproto/blob/master/rfbproto.rst#vmware-cursor-position-pseudo-encoding 2: https://tronche.com/gui/x/xlib/input/XWarpPointer.html 3: https://hg.libsdl.org/SDL/file/28e3b60e2131/src/events/SDL_mouse.c#l804tags/v1.11.90
compressLevel(2), qualityLevel(-1), fineQualityLevel(-1), | compressLevel(2), qualityLevel(-1), fineQualityLevel(-1), | ||||
subsampling(subsampleUndefined), | subsampling(subsampleUndefined), | ||||
width_(0), height_(0), name_(0), | width_(0), height_(0), name_(0), | ||||
ledState_(ledUnknown) | |||||
cursorPos_(0, 0), ledState_(ledUnknown) | |||||
{ | { | ||||
setName(""); | setName(""); | ||||
cursor_ = new Cursor(other); | cursor_ = new Cursor(other); | ||||
} | } | ||||
void ClientParams::setCursorPos(const Point& pos) | |||||
{ | |||||
cursorPos_ = pos; | |||||
} | |||||
bool ClientParams::supportsEncoding(rdr::S32 encoding) const | bool ClientParams::supportsEncoding(rdr::S32 encoding) const | ||||
{ | { | ||||
return encodings_.count(encoding) != 0; | return encodings_.count(encoding) != 0; | ||||
return false; | return false; | ||||
} | } | ||||
bool ClientParams::supportsCursorPosition() const | |||||
{ | |||||
if (supportsEncoding(pseudoEncodingVMwareCursorPosition)) | |||||
return true; | |||||
return false; | |||||
} | |||||
bool ClientParams::supportsDesktopSize() const | bool ClientParams::supportsDesktopSize() const | ||||
{ | { | ||||
if (supportsEncoding(pseudoEncodingExtendedDesktopSize)) | if (supportsEncoding(pseudoEncodingExtendedDesktopSize)) |
const Cursor& cursor() const { return *cursor_; } | const Cursor& cursor() const { return *cursor_; } | ||||
void setCursor(const Cursor& cursor); | void setCursor(const Cursor& cursor); | ||||
const Point& cursorPos() const { return cursorPos_; } | |||||
void setCursorPos(const Point& pos); | |||||
bool supportsEncoding(rdr::S32 encoding) const; | bool supportsEncoding(rdr::S32 encoding) const; | ||||
void setEncodings(int nEncodings, const rdr::S32* encodings); | void setEncodings(int nEncodings, const rdr::S32* encodings); | ||||
// Wrappers to check for functionality rather than specific | // Wrappers to check for functionality rather than specific | ||||
// encodings | // encodings | ||||
bool supportsLocalCursor() const; | bool supportsLocalCursor() const; | ||||
bool supportsCursorPosition() const; | |||||
bool supportsDesktopSize() const; | bool supportsDesktopSize() const; | ||||
bool supportsLEDState() const; | bool supportsLEDState() const; | ||||
bool supportsFence() const; | bool supportsFence() const; | ||||
PixelFormat pf_; | PixelFormat pf_; | ||||
char* name_; | char* name_; | ||||
Cursor* cursor_; | Cursor* cursor_; | ||||
Point cursorPos_; | |||||
std::set<rdr::S32> encodings_; | std::set<rdr::S32> encodings_; | ||||
unsigned int ledState_; | unsigned int ledState_; | ||||
rdr::U32 clipFlags; | rdr::U32 clipFlags; |
: client(client_), os(os_), | : client(client_), os(os_), | ||||
nRectsInUpdate(0), nRectsInHeader(0), | nRectsInUpdate(0), nRectsInHeader(0), | ||||
needSetDesktopName(false), needCursor(false), | needSetDesktopName(false), needCursor(false), | ||||
needLEDState(false), needQEMUKeyEvent(false) | |||||
needCursorPos(false), needLEDState(false), | |||||
needQEMUKeyEvent(false) | |||||
{ | { | ||||
} | } | ||||
needCursor = true; | needCursor = true; | ||||
} | } | ||||
void SMsgWriter::writeCursorPos() | |||||
{ | |||||
if (!client->supportsEncoding(pseudoEncodingVMwareCursorPosition)) | |||||
throw Exception("Client does not support cursor position"); | |||||
needCursorPos = true; | |||||
} | |||||
void SMsgWriter::writeLEDState() | void SMsgWriter::writeLEDState() | ||||
{ | { | ||||
if (!client->supportsEncoding(pseudoEncodingLEDState) && | if (!client->supportsEncoding(pseudoEncodingLEDState) && | ||||
return true; | return true; | ||||
if (needCursor) | if (needCursor) | ||||
return true; | return true; | ||||
if (needCursorPos) | |||||
return true; | |||||
if (needLEDState) | if (needLEDState) | ||||
return true; | return true; | ||||
if (needQEMUKeyEvent) | if (needQEMUKeyEvent) | ||||
nRects++; | nRects++; | ||||
if (needCursor) | if (needCursor) | ||||
nRects++; | nRects++; | ||||
if (needCursorPos) | |||||
nRects++; | |||||
if (needLEDState) | if (needLEDState) | ||||
nRects++; | nRects++; | ||||
if (needQEMUKeyEvent) | if (needQEMUKeyEvent) | ||||
needCursor = false; | needCursor = false; | ||||
} | } | ||||
if (needCursorPos) { | |||||
const Point& cursorPos = client->cursorPos(); | |||||
if (client->supportsEncoding(pseudoEncodingVMwareCursorPosition)) { | |||||
writeSetVMwareCursorPositionRect(cursorPos.x, cursorPos.y); | |||||
} else { | |||||
throw Exception("Client does not support cursor position"); | |||||
} | |||||
needCursorPos = false; | |||||
} | |||||
if (needSetDesktopName) { | if (needSetDesktopName) { | ||||
writeSetDesktopNameRect(client->name()); | writeSetDesktopNameRect(client->name()); | ||||
needSetDesktopName = false; | needSetDesktopName = false; | ||||
os->writeBytes(data, width*height*4); | os->writeBytes(data, width*height*4); | ||||
} | } | ||||
void SMsgWriter::writeSetVMwareCursorPositionRect(int hotspotX, int hotspotY) | |||||
{ | |||||
if (!client->supportsEncoding(pseudoEncodingVMwareCursorPosition)) | |||||
throw Exception("Client does not support cursor position"); | |||||
if (++nRectsInUpdate > nRectsInHeader && nRectsInHeader) | |||||
throw Exception("SMsgWriter::writeSetVMwareCursorRect: nRects out of sync"); | |||||
os->writeS16(hotspotX); | |||||
os->writeS16(hotspotY); | |||||
os->writeU16(0); | |||||
os->writeU16(0); | |||||
os->writeU32(pseudoEncodingVMwareCursorPosition); | |||||
} | |||||
void SMsgWriter::writeLEDStateRect(rdr::U8 state) | void SMsgWriter::writeLEDStateRect(rdr::U8 state) | ||||
{ | { | ||||
if (!client->supportsEncoding(pseudoEncodingLEDState) && | if (!client->supportsEncoding(pseudoEncodingLEDState) && |
// immediately. | // immediately. | ||||
void writeCursor(); | void writeCursor(); | ||||
// Notifies the client that the cursor pointer was moved by the server. | |||||
void writeCursorPos(); | |||||
// Same for LED state message | // Same for LED state message | ||||
void writeLEDState(); | void writeLEDState(); | ||||
void writeSetVMwareCursorRect(int width, int height, | void writeSetVMwareCursorRect(int width, int height, | ||||
int hotspotX, int hotspotY, | int hotspotX, int hotspotY, | ||||
const rdr::U8* data); | const rdr::U8* data); | ||||
void writeSetVMwareCursorPositionRect(int hotspotX, int hotspotY); | |||||
void writeLEDStateRect(rdr::U8 state); | void writeLEDStateRect(rdr::U8 state); | ||||
void writeQEMUKeyEventRect(); | void writeQEMUKeyEventRect(); | ||||
bool needSetDesktopName; | bool needSetDesktopName; | ||||
bool needCursor; | bool needCursor; | ||||
bool needCursorPos; | |||||
bool needLEDState; | bool needLEDState; | ||||
bool needQEMUKeyEvent; | bool needQEMUKeyEvent; | ||||
} | } | ||||
} | } | ||||
// cursorPositionChange() is called whenever the cursor has changed position by | |||||
// the server. If the client supports being informed about these changes then | |||||
// it will arrange for the new cursor position to be sent to the client. | |||||
void VNCSConnectionST::cursorPositionChange() | |||||
{ | |||||
setCursorPos(); | |||||
} | |||||
// needRenderedCursor() returns true if this client needs the server-side | // needRenderedCursor() returns true if this client needs the server-side | ||||
// rendered cursor. This may be because it does not support local cursor or | // rendered cursor. This may be because it does not support local cursor or | ||||
// because the current cursor position has not been set by this client. | // because the current cursor position has not been set by this client. | ||||
writer()->writeCursor(); | writer()->writeCursor(); | ||||
} | } | ||||
// setCursorPos() is called whenever the cursor has changed position by the | |||||
// server. If the client supports being informed about these changes then it | |||||
// will arrange for the new cursor position to be sent to the client. | |||||
void VNCSConnectionST::setCursorPos() | |||||
{ | |||||
if (state() != RFBSTATE_NORMAL) | |||||
return; | |||||
if (client.supportsCursorPosition()) { | |||||
client.setCursorPos(server->getCursorPos()); | |||||
writer()->writeCursorPos(); | |||||
} | |||||
} | |||||
void VNCSConnectionST::setDesktopName(const char *name) | void VNCSConnectionST::setDesktopName(const char *name) | ||||
{ | { | ||||
client.setName(name); | client.setName(name); |
// cursor. | // cursor. | ||||
void renderedCursorChange(); | void renderedCursorChange(); | ||||
// cursorPositionChange() is called whenever the cursor has changed position by | |||||
// the server. If the client supports being informed about these changes then | |||||
// it will arrange for the new cursor position to be sent to the client. | |||||
void cursorPositionChange(); | |||||
// needRenderedCursor() returns true if this client needs the server-side | // needRenderedCursor() returns true if this client needs the server-side | ||||
// rendered cursor. This may be because it does not support local cursor | // rendered cursor. This may be because it does not support local cursor | ||||
// or because the current cursor position has not been set by this client. | // or because the current cursor position has not been set by this client. | ||||
void screenLayoutChange(rdr::U16 reason); | void screenLayoutChange(rdr::U16 reason); | ||||
void setCursor(); | void setCursor(); | ||||
void setCursorPos(); | |||||
void setDesktopName(const char *name); | void setDesktopName(const char *name); | ||||
void setLEDState(unsigned int state); | void setLEDState(unsigned int state); | ||||
virtual void setCursor(int width, int height, const Point& hotspot, | virtual void setCursor(int width, int height, const Point& hotspot, | ||||
const rdr::U8* cursorData) = 0; | const rdr::U8* cursorData) = 0; | ||||
// setCursorPos() tells the server the current position of the cursor. | |||||
virtual void setCursorPos(const Point& p) = 0; | |||||
// setCursorPos() tells the server the current position of the cursor, and | |||||
// whether the server initiated that change (e.g. through another X11 | |||||
// client calling XWarpPointer()). | |||||
virtual void setCursorPos(const Point& p, bool warped) = 0; | |||||
// setName() tells the server what desktop title to supply to clients | // setName() tells the server what desktop title to supply to clients | ||||
virtual void setName(const char* name) = 0; | virtual void setName(const char* name) = 0; |
} | } | ||||
} | } | ||||
void VNCServerST::setCursorPos(const Point& pos) | |||||
void VNCServerST::setCursorPos(const Point& pos, bool warped) | |||||
{ | { | ||||
if (!cursorPos.equals(pos)) { | if (!cursorPos.equals(pos)) { | ||||
cursorPos = pos; | cursorPos = pos; | ||||
renderedCursorInvalid = true; | renderedCursorInvalid = true; | ||||
std::list<VNCSConnectionST*>::iterator ci; | std::list<VNCSConnectionST*>::iterator ci; | ||||
for (ci = clients.begin(); ci != clients.end(); ci++) | |||||
for (ci = clients.begin(); ci != clients.end(); ci++) { | |||||
(*ci)->renderedCursorChange(); | (*ci)->renderedCursorChange(); | ||||
if (warped) | |||||
(*ci)->cursorPositionChange(); | |||||
} | |||||
} | } | ||||
} | } | ||||
virtual void add_copied(const Region &dest, const Point &delta); | virtual void add_copied(const Region &dest, const Point &delta); | ||||
virtual void setCursor(int width, int height, const Point& hotspot, | virtual void setCursor(int width, int height, const Point& hotspot, | ||||
const rdr::U8* data); | const rdr::U8* data); | ||||
virtual void setCursorPos(const Point& p); | |||||
virtual void setCursorPos(const Point& p, bool warped); | |||||
virtual void setName(const char* name_); | virtual void setName(const char* name_); | ||||
virtual void setLEDState(unsigned state); | virtual void setLEDState(unsigned state); | ||||
// VMware-specific | // VMware-specific | ||||
const int pseudoEncodingVMwareCursor = 0x574d5664; | const int pseudoEncodingVMwareCursor = 0x574d5664; | ||||
const int pseudoEncodingVMwareCursorPosition = 0x574d5666; | |||||
const int pseudoEncodingVMwareLEDState = 0x574d5668; | const int pseudoEncodingVMwareLEDState = 0x574d5668; | ||||
// UltraVNC-specific | // UltraVNC-specific |
&x, &y, &wx, &wy, &mask); | &x, &y, &wx, &wy, &mask); | ||||
x -= geometry->offsetLeft(); | x -= geometry->offsetLeft(); | ||||
y -= geometry->offsetTop(); | y -= geometry->offsetTop(); | ||||
server->setCursorPos(rfb::Point(x, y)); | |||||
server->setCursorPos(rfb::Point(x, y), false); | |||||
} | } | ||||
} | } | ||||
delete [] cursorData; | delete [] cursorData; | ||||
} | } | ||||
void XserverDesktop::setCursorPos(int x, int y, bool warped) | |||||
{ | |||||
try { | |||||
server->setCursorPos(Point(x, y), warped); | |||||
} catch (rdr::Exception& e) { | |||||
vlog.error("XserverDesktop::setCursorPos: %s",e.str()); | |||||
} | |||||
} | |||||
void XserverDesktop::add_changed(const rfb::Region ®ion) | void XserverDesktop::add_changed(const rfb::Region ®ion) | ||||
{ | { | ||||
try { | try { | ||||
if (oldCursorPos.x != cursorX || oldCursorPos.y != cursorY) { | if (oldCursorPos.x != cursorX || oldCursorPos.y != cursorY) { | ||||
oldCursorPos.x = cursorX; | oldCursorPos.x = cursorX; | ||||
oldCursorPos.y = cursorY; | oldCursorPos.y = cursorY; | ||||
server->setCursorPos(oldCursorPos); | |||||
server->setCursorPos(oldCursorPos, false); | |||||
} | } | ||||
// Trigger timers and check when the next will expire | // Trigger timers and check when the next will expire |
void setDesktopName(const char* name); | void setDesktopName(const char* name); | ||||
void setCursor(int width, int height, int hotX, int hotY, | void setCursor(int width, int height, int hotX, int hotY, | ||||
const unsigned char *rgbaData); | const unsigned char *rgbaData); | ||||
void setCursorPos(int x, int y, bool warped); | |||||
void add_changed(const rfb::Region ®ion); | void add_changed(const rfb::Region ®ion); | ||||
void add_copied(const rfb::Region &dest, const rfb::Point &delta); | void add_copied(const rfb::Region &dest, const rfb::Point &delta); | ||||
void handleSocketEvent(int fd, bool read, bool write); | void handleSocketEvent(int fd, bool read, bool write); |
desktop[scr]->setCursor(width, height, hotX, hotY, rgbaData); | desktop[scr]->setCursor(width, height, hotX, hotY, rgbaData); | ||||
} | } | ||||
void vncSetCursorPos(int scrIdx, int x, int y) | |||||
{ | |||||
desktop[scrIdx]->setCursorPos(x, y, true); | |||||
} | |||||
void vncPreScreenResize(int scrIdx) | void vncPreScreenResize(int scrIdx) | ||||
{ | { | ||||
// We need to prevent the RFB core from accessing the framebuffer | // We need to prevent the RFB core from accessing the framebuffer |
void vncSetCursor(int width, int height, int hotX, int hotY, | void vncSetCursor(int width, int height, int hotX, int hotY, | ||||
const unsigned char *rgbaData); | const unsigned char *rgbaData); | ||||
void vncSetCursorPos(int scrIdx, int x, int y); | |||||
void vncPreScreenResize(int scrIdx); | void vncPreScreenResize(int scrIdx); | ||||
void vncPostScreenResize(int scrIdx, int success, int width, int height); | void vncPostScreenResize(int scrIdx, int success, int width, int height); |
CopyWindowProcPtr CopyWindow; | CopyWindowProcPtr CopyWindow; | ||||
ClearToBackgroundProcPtr ClearToBackground; | ClearToBackgroundProcPtr ClearToBackground; | ||||
DisplayCursorProcPtr DisplayCursor; | DisplayCursorProcPtr DisplayCursor; | ||||
#if XORG >= 119 | |||||
CursorWarpedToProcPtr CursorWarpedTo; | |||||
#endif | |||||
ScreenBlockHandlerProcPtr BlockHandler; | ScreenBlockHandlerProcPtr BlockHandler; | ||||
#ifdef RENDER | #ifdef RENDER | ||||
CompositeProcPtr Composite; | CompositeProcPtr Composite; | ||||
int h, Bool generateExposures); | int h, Bool generateExposures); | ||||
static Bool vncHooksDisplayCursor(DeviceIntPtr pDev, | static Bool vncHooksDisplayCursor(DeviceIntPtr pDev, | ||||
ScreenPtr pScreen, CursorPtr cursor); | ScreenPtr pScreen, CursorPtr cursor); | ||||
#if XORG >= 119 | |||||
static void vncHooksCursorWarpedTo(DeviceIntPtr pDev, | |||||
ScreenPtr pScreen_, ClientPtr pClient, | |||||
WindowPtr pWindow, SpritePtr pSprite, | |||||
int x, int y); | |||||
#endif | |||||
#if XORG <= 118 | #if XORG <= 118 | ||||
static void vncHooksBlockHandler(ScreenPtr pScreen, void * pTimeout, | static void vncHooksBlockHandler(ScreenPtr pScreen, void * pTimeout, | ||||
void * pReadmask); | void * pReadmask); | ||||
wrap(vncHooksScreen, pScreen, CopyWindow, vncHooksCopyWindow); | wrap(vncHooksScreen, pScreen, CopyWindow, vncHooksCopyWindow); | ||||
wrap(vncHooksScreen, pScreen, ClearToBackground, vncHooksClearToBackground); | wrap(vncHooksScreen, pScreen, ClearToBackground, vncHooksClearToBackground); | ||||
wrap(vncHooksScreen, pScreen, DisplayCursor, vncHooksDisplayCursor); | wrap(vncHooksScreen, pScreen, DisplayCursor, vncHooksDisplayCursor); | ||||
#if XORG >= 119 | |||||
wrap(vncHooksScreen, pScreen, CursorWarpedTo, vncHooksCursorWarpedTo); | |||||
#endif | |||||
wrap(vncHooksScreen, pScreen, BlockHandler, vncHooksBlockHandler); | wrap(vncHooksScreen, pScreen, BlockHandler, vncHooksBlockHandler); | ||||
#ifdef RENDER | #ifdef RENDER | ||||
ps = GetPictureScreenIfSet(pScreen); | ps = GetPictureScreenIfSet(pScreen); | ||||
return ret; | return ret; | ||||
} | } | ||||
// CursorWarpedTo - notify that the cursor was warped | |||||
#if XORG >= 119 | |||||
static void vncHooksCursorWarpedTo(DeviceIntPtr pDev, | |||||
ScreenPtr pScreen_, ClientPtr pClient, | |||||
WindowPtr pWindow, SpritePtr pSprite, | |||||
int x, int y) | |||||
{ | |||||
SCREEN_PROLOGUE(pScreen_, CursorWarpedTo); | |||||
vncSetCursorPos(pScreen->myNum, x, y); | |||||
SCREEN_EPILOGUE(CursorWarpedTo); | |||||
} | |||||
#endif | |||||
// BlockHandler - ignore any changes during the block handler - it's likely | // BlockHandler - ignore any changes during the block handler - it's likely | ||||
// these are just drawing the cursor. | // these are just drawing the cursor. | ||||
// Update the cursor position | // Update the cursor position | ||||
// NB: First translate from Screen coordinates to Desktop | // NB: First translate from Screen coordinates to Desktop | ||||
Point desktopPos = info.position.translate(screenRect.tl.negate()); | Point desktopPos = info.position.translate(screenRect.tl.negate()); | ||||
server->setCursorPos(desktopPos); | |||||
server->setCursorPos(desktopPos, false); | |||||
old_cursor = info; | old_cursor = info; | ||||
} | } |