MouseImpl.cpp@ 47804

Last change on this file since 47804 was 47804, checked in by vboxsync, 12 years ago
Main: OnGuestMouse event cleanup.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 33.3 KB

Line
1	/* $Id: MouseImpl.cpp 47804 2013-08-16 12:26:40Z vboxsync $ */
2	/** @file
3	* VirtualBox COM class implementation
4	*/
5
6	/*
7	* Copyright (C) 2006-2012 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.215389.xyz. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#include <iprt/cpp/utils.h>
19
20	#include "MouseImpl.h"
21	#include "DisplayImpl.h"
22	#include "VMMDev.h"
23
24	#include "AutoCaller.h"
25	#include "Logging.h"
26
27	#include <VBox/vmm/pdmdrv.h>
28	#include <VBox/VMMDev.h>
29
30	#include <iprt/asm.h>
31
32	/** @name Mouse device capabilities bitfield
33	* @{ */
34	enum
35	{
36	/** The mouse device can do relative reporting */
37	MOUSE_DEVCAP_RELATIVE = 1,
38	/** The mouse device can do absolute reporting */
39	MOUSE_DEVCAP_ABSOLUTE = 2,
40	/** The mouse device can do absolute reporting */
41	MOUSE_DEVCAP_MULTI_TOUCH = 4
42	};
43	/** @} */
44
45
46	/**
47	* Mouse driver instance data.
48	*/
49	struct DRVMAINMOUSE
50	{
51	/** Pointer to the mouse object. */
52	Mouse *pMouse;
53	/** Pointer to the driver instance structure. */
54	PPDMDRVINS pDrvIns;
55	/** Pointer to the mouse port interface of the driver/device above us. */
56	PPDMIMOUSEPORT pUpPort;
57	/** Our mouse connector interface. */
58	PDMIMOUSECONNECTOR IConnector;
59	/** The capabilities of this device. */
60	uint32_t u32DevCaps;
61	/** The device priority. */
62	uint32_t u32Priority;
63	};
64
65
66	// constructor / destructor
67	/////////////////////////////////////////////////////////////////////////////
68
69	Mouse::Mouse()
70	: mParent(NULL)
71	{
72	}
73
74	Mouse::~Mouse()
75	{
76	}
77
78
79	HRESULT Mouse::FinalConstruct()
80	{
81	RT_ZERO(mpDrv);
82	mcLastX = 0x8000;
83	mcLastY = 0x8000;
84	mfLastButtons = 0;
85	mfVMMDevGuestCaps = 0;
86	return BaseFinalConstruct();
87	}
88
89	void Mouse::FinalRelease()
90	{
91	uninit();
92	BaseFinalRelease();
93	}
94
95	// public methods only for internal purposes
96	/////////////////////////////////////////////////////////////////////////////
97
98	/**
99	* Initializes the mouse object.
100	*
101	* @returns COM result indicator
102	* @param parent handle of our parent object
103	*/
104	HRESULT Mouse::init (ConsoleMouseInterface *parent)
105	{
106	LogFlowThisFunc(("\n"));
107
108	ComAssertRet(parent, E_INVALIDARG);
109
110	/* Enclose the state transition NotReady->InInit->Ready */
111	AutoInitSpan autoInitSpan(this);
112	AssertReturn(autoInitSpan.isOk(), E_FAIL);
113
114	unconst(mParent) = parent;
115
116	unconst(mEventSource).createObject();
117	HRESULT rc = mEventSource->init(static_cast<IMouse*>(this));
118	AssertComRCReturnRC(rc);
119	mMouseEvent.init(mEventSource, VBoxEventType_OnGuestMouse,
120	0, 0, 0, 0, 0, 0);
121
122	/* Confirm a successful initialization */
123	autoInitSpan.setSucceeded();
124
125	return S_OK;
126	}
127
128	/**
129	* Uninitializes the instance and sets the ready flag to FALSE.
130	* Called either from FinalRelease() or by the parent when it gets destroyed.
131	*/
132	void Mouse::uninit()
133	{
134	LogFlowThisFunc(("\n"));
135
136	/* Enclose the state transition Ready->InUninit->NotReady */
137	AutoUninitSpan autoUninitSpan(this);
138	if (autoUninitSpan.uninitDone())
139	return;
140
141	for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i)
142	{
143	if (mpDrv[i])
144	mpDrv[i]->pMouse = NULL;
145	mpDrv[i] = NULL;
146	}
147
148	mMouseEvent.uninit();
149	unconst(mEventSource).setNull();
150	unconst(mParent) = NULL;
151	}
152
153
154	// IMouse properties
155	/////////////////////////////////////////////////////////////////////////////
156
157	/** Report the front-end's mouse handling capabilities to the VMM device and
158	* thus to the guest.
159	* @note all calls out of this object are made with no locks held! */
160	HRESULT Mouse::updateVMMDevMouseCaps(uint32_t fCapsAdded,
161	uint32_t fCapsRemoved)
162	{
163	VMMDevMouseInterface *pVMMDev = mParent->getVMMDevMouseInterface();
164	if (!pVMMDev)
165	return E_FAIL; /* No assertion, as the front-ends can send events
166	* at all sorts of inconvenient times. */
167	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
168	if (!pVMMDevPort)
169	return E_FAIL; /* same here */
170
171	int rc = pVMMDevPort->pfnUpdateMouseCapabilities(pVMMDevPort, fCapsAdded,
172	fCapsRemoved);
173	return RT_SUCCESS(rc) ? S_OK : E_FAIL;
174	}
175
176	/**
177	* Returns whether the currently active device portfolio can accept absolute
178	* mouse events.
179	*
180	* @returns COM status code
181	* @param absoluteSupported address of result variable
182	*/
183	STDMETHODIMP Mouse::COMGETTER(AbsoluteSupported) (BOOL *absoluteSupported)
184	{
185	if (!absoluteSupported)
186	return E_POINTER;
187
188	AutoCaller autoCaller(this);
189	if (FAILED(autoCaller.rc())) return autoCaller.rc();
190
191	*absoluteSupported = supportsAbs();
192	return S_OK;
193	}
194
195	/**
196	* Returns whether the currently active device portfolio can accept relative
197	* mouse events.
198	*
199	* @returns COM status code
200	* @param relativeSupported address of result variable
201	*/
202	STDMETHODIMP Mouse::COMGETTER(RelativeSupported) (BOOL *relativeSupported)
203	{
204	if (!relativeSupported)
205	return E_POINTER;
206
207	AutoCaller autoCaller(this);
208	if (FAILED(autoCaller.rc())) return autoCaller.rc();
209
210	*relativeSupported = supportsRel();
211	return S_OK;
212	}
213
214	/**
215	* Returns whether the currently active device portfolio can accept multi-touch
216	* mouse events.
217	*
218	* @returns COM status code
219	* @param multiTouchSupported address of result variable
220	*/
221	STDMETHODIMP Mouse::COMGETTER(MultiTouchSupported) (BOOL *multiTouchSupported)
222	{
223	if (!multiTouchSupported)
224	return E_POINTER;
225
226	AutoCaller autoCaller(this);
227	if (FAILED(autoCaller.rc())) return autoCaller.rc();
228
229	*multiTouchSupported = supportsMT();
230	return S_OK;
231	}
232
233	/**
234	* Returns whether the guest can currently switch to drawing the mouse cursor
235	* itself if it is asked to by the front-end.
236	*
237	* @returns COM status code
238	* @param pfNeedsHostCursor address of result variable
239	*/
240	STDMETHODIMP Mouse::COMGETTER(NeedsHostCursor) (BOOL *pfNeedsHostCursor)
241	{
242	if (!pfNeedsHostCursor)
243	return E_POINTER;
244
245	AutoCaller autoCaller(this);
246	if (FAILED(autoCaller.rc())) return autoCaller.rc();
247
248	*pfNeedsHostCursor = guestNeedsHostCursor();
249	return S_OK;
250	}
251
252	// IMouse methods
253	/////////////////////////////////////////////////////////////////////////////
254
255	/** Converts a bitfield containing information about mouse buttons currently
256	* held down from the format used by the front-end to the format used by PDM
257	* and the emulated pointing devices. */
258	static uint32_t mouseButtonsToPDM(LONG buttonState)
259	{
260	uint32_t fButtons = 0;
261	if (buttonState & MouseButtonState_LeftButton)
262	fButtons \|= PDMIMOUSEPORT_BUTTON_LEFT;
263	if (buttonState & MouseButtonState_RightButton)
264	fButtons \|= PDMIMOUSEPORT_BUTTON_RIGHT;
265	if (buttonState & MouseButtonState_MiddleButton)
266	fButtons \|= PDMIMOUSEPORT_BUTTON_MIDDLE;
267	if (buttonState & MouseButtonState_XButton1)
268	fButtons \|= PDMIMOUSEPORT_BUTTON_X1;
269	if (buttonState & MouseButtonState_XButton2)
270	fButtons \|= PDMIMOUSEPORT_BUTTON_X2;
271	return fButtons;
272	}
273
274	STDMETHODIMP Mouse::COMGETTER(EventSource)(IEventSource ** aEventSource)
275	{
276	CheckComArgOutPointerValid(aEventSource);
277
278	AutoCaller autoCaller(this);
279	if (FAILED(autoCaller.rc())) return autoCaller.rc();
280
281	// no need to lock - lifetime constant
282	mEventSource.queryInterfaceTo(aEventSource);
283
284	return S_OK;
285	}
286
287	/**
288	* Send a relative pointer event to the relative device we deem most
289	* appropriate.
290	*
291	* @returns COM status code
292	*/
293	HRESULT Mouse::reportRelEventToMouseDev(int32_t dx, int32_t dy, int32_t dz,
294	int32_t dw, uint32_t fButtons)
295	{
296	if (dx \|\| dy \|\| dz \|\| dw \|\| fButtons != mfLastButtons)
297	{
298	PPDMIMOUSEPORT pUpPort = NULL;
299	{
300	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
301
302	for (unsigned i = 0; !pUpPort && i < MOUSE_MAX_DEVICES; ++i)
303	{
304	if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE))
305	pUpPort = mpDrv[i]->pUpPort;
306	}
307	}
308	if (!pUpPort)
309	return S_OK;
310
311	int vrc = pUpPort->pfnPutEvent(pUpPort, dx, dy, dz, dw, fButtons);
312
313	if (RT_FAILURE(vrc))
314	return setError(VBOX_E_IPRT_ERROR,
315	tr("Could not send the mouse event to the virtual mouse (%Rrc)"),
316	vrc);
317	mfLastButtons = fButtons;
318	}
319	return S_OK;
320	}
321
322
323	/**
324	* Send an absolute pointer event to the emulated absolute device we deem most
325	* appropriate.
326	*
327	* @returns COM status code
328	*/
329	HRESULT Mouse::reportAbsEventToMouseDev(int32_t x, int32_t y,
330	int32_t dz, int32_t dw, uint32_t fButtons)
331	{
332	if ( x < VMMDEV_MOUSE_RANGE_MIN
333	\|\| x > VMMDEV_MOUSE_RANGE_MAX)
334	return S_OK;
335	if ( y < VMMDEV_MOUSE_RANGE_MIN
336	\|\| y > VMMDEV_MOUSE_RANGE_MAX)
337	return S_OK;
338	if ( x != mcLastX \|\| y != mcLastY
339	\|\| dz \|\| dw \|\| fButtons != mfLastButtons)
340	{
341	PPDMIMOUSEPORT pUpPort = NULL;
342	{
343	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
344
345	for (unsigned i = 0; !pUpPort && i < MOUSE_MAX_DEVICES; ++i)
346	{
347	if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE))
348	pUpPort = mpDrv[i]->pUpPort;
349	}
350	}
351	if (!pUpPort)
352	return S_OK;
353
354	int vrc = pUpPort->pfnPutEventAbs(pUpPort, x, y, dz,
355	dw, fButtons);
356	if (RT_FAILURE(vrc))
357	return setError(VBOX_E_IPRT_ERROR,
358	tr("Could not send the mouse event to the virtual mouse (%Rrc)"),
359	vrc);
360	mfLastButtons = fButtons;
361
362	}
363	return S_OK;
364	}
365
366	HRESULT Mouse::reportMultiTouchEventToDevice(uint8_t cContacts,
367	const uint64_t *pau64Contacts,
368	uint32_t u32ScanTime)
369	{
370	HRESULT hrc = S_OK;
371
372	PPDMIMOUSEPORT pUpPort = NULL;
373	{
374	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
375
376	unsigned i;
377	for (i = 0; i < MOUSE_MAX_DEVICES; ++i)
378	{
379	if ( mpDrv[i]
380	&& (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_MULTI_TOUCH))
381	{
382	pUpPort = mpDrv[i]->pUpPort;
383	break;
384	}
385	}
386	}
387
388	if (pUpPort)
389	{
390	int vrc = pUpPort->pfnPutEventMultiTouch(pUpPort, cContacts, pau64Contacts, u32ScanTime);
391	if (RT_FAILURE(vrc))
392	hrc = setError(VBOX_E_IPRT_ERROR,
393	tr("Could not send the multi-touch event to the virtual device (%Rrc)"),
394	vrc);
395	}
396	else
397	{
398	hrc = E_UNEXPECTED;
399	}
400
401	return hrc;
402	}
403
404
405	/**
406	* Send an absolute position event to the VMM device.
407	* @note all calls out of this object are made with no locks held!
408	*
409	* @returns COM status code
410	*/
411	HRESULT Mouse::reportAbsEventToVMMDev(int32_t x, int32_t y)
412	{
413	VMMDevMouseInterface *pVMMDev = mParent->getVMMDevMouseInterface();
414	ComAssertRet(pVMMDev, E_FAIL);
415	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
416	ComAssertRet(pVMMDevPort, E_FAIL);
417
418	if (x != mcLastX \|\| y != mcLastY)
419	{
420	int vrc = pVMMDevPort->pfnSetAbsoluteMouse(pVMMDevPort,
421	x, y);
422	if (RT_FAILURE(vrc))
423	return setError(VBOX_E_IPRT_ERROR,
424	tr("Could not send the mouse event to the virtual mouse (%Rrc)"),
425	vrc);
426	}
427	return S_OK;
428	}
429
430
431	/**
432	* Send an absolute pointer event to a pointing device (the VMM device if
433	* possible or whatever emulated absolute device seems best to us if not).
434	*
435	* @returns COM status code
436	*/
437	HRESULT Mouse::reportAbsEvent(int32_t x, int32_t y,
438	int32_t dz, int32_t dw, uint32_t fButtons,
439	bool fUsesVMMDevEvent)
440	{
441	HRESULT rc = S_OK;
442	/** If we are using the VMMDev to report absolute position but without
443	* VMMDev IRQ support then we need to send a small "jiggle" to the emulated
444	* relative mouse device to alert the guest to changes. */
445	LONG cJiggle = 0;
446
447	/*
448	* Send the absolute mouse position to the device.
449	*/
450	if (x != mcLastX \|\| y != mcLastY)
451	{
452	if (vmmdevCanAbs())
453	{
454	rc = reportAbsEventToVMMDev(x, y);
455	cJiggle = !fUsesVMMDevEvent;
456	}
457	else
458	{
459	rc = reportAbsEventToMouseDev(x, y, 0, 0, fButtons);
460	fButtons = 0;
461	}
462	}
463	if (SUCCEEDED(rc))
464	rc = reportRelEventToMouseDev(cJiggle, 0, dz, dw, fButtons);
465
466	mcLastX = x;
467	mcLastY = y;
468	return rc;
469	}
470
471	void Mouse::fireMouseEvent(bool fAbsolute, LONG x, LONG y, LONG dz, LONG dw,
472	LONG fButtons)
473	{
474	/* If mouse button is pressed, we generate new event, to avoid reusable events coalescing and thus
475	dropping key press events */
476	GuestMouseEventMode_T mode = fAbsolute? GuestMouseEventMode_Absolute: GuestMouseEventMode_Relative;
477	if (fButtons != 0)
478	{
479	VBoxEventDesc evDesc;
480	evDesc.init(mEventSource, VBoxEventType_OnGuestMouse, mode, x, y,
481	dz, dw, fButtons);
482	evDesc.fire(0);
483	}
484	else
485	{
486	mMouseEvent.reinit(VBoxEventType_OnGuestMouse, mode, x, y, dz, dw,
487	fButtons);
488	mMouseEvent.fire(0);
489	}
490	}
491
492
493	/**
494	* Send a relative mouse event to the guest.
495	* @note the VMMDev capability change is so that the guest knows we are sending
496	* real events over the PS/2 device and not dummy events to signal the
497	* arrival of new absolute pointer data
498	*
499	* @returns COM status code
500	* @param dx X movement
501	* @param dy Y movement
502	* @param dz Z movement
503	* @param fButtons The mouse button state
504	*/
505	STDMETHODIMP Mouse::PutMouseEvent(LONG dx, LONG dy, LONG dz, LONG dw,
506	LONG fButtons)
507	{
508	HRESULT rc;
509	uint32_t fButtonsAdj;
510
511	AutoCaller autoCaller(this);
512	if (FAILED(autoCaller.rc())) return autoCaller.rc();
513	LogRel3(("%s: dx=%d, dy=%d, dz=%d, dw=%d\n", __PRETTY_FUNCTION__,
514	dx, dy, dz, dw));
515
516	fButtonsAdj = mouseButtonsToPDM(fButtons);
517	/* Make sure that the guest knows that we are sending real movement
518	* events to the PS/2 device and not just dummy wake-up ones. */
519	updateVMMDevMouseCaps(0, VMMDEV_MOUSE_HOST_WANTS_ABSOLUTE);
520	rc = reportRelEventToMouseDev(dx, dy, dz, dw, fButtonsAdj);
521
522	fireMouseEvent(false, dx, dy, dz, dw, fButtons);
523
524	return rc;
525	}
526
527	/**
528	* Convert an (X, Y) value pair in screen co-ordinates (starting from 1) to a
529	* value from VMMDEV_MOUSE_RANGE_MIN to VMMDEV_MOUSE_RANGE_MAX. Sets the
530	* optional validity value to false if the pair is not on an active screen and
531	* to true otherwise.
532	* @note since guests with recent versions of X.Org use a different method
533	* to everyone else to map the valuator value to a screen pixel (they
534	* multiply by the screen dimension, do a floating point divide by
535	* the valuator maximum and round the result, while everyone else
536	* does truncating integer operations) we adjust the value we send
537	* so that it maps to the right pixel both when the result is rounded
538	* and when it is truncated.
539	*
540	* @returns COM status value
541	*/
542	HRESULT Mouse::convertDisplayRes(LONG x, LONG y, int32_t pxAdj, int32_t pyAdj,
543	bool *pfValid)
544	{
545	AssertPtrReturn(pxAdj, E_POINTER);
546	AssertPtrReturn(pyAdj, E_POINTER);
547	AssertPtrNullReturn(pfValid, E_POINTER);
548	DisplayMouseInterface *pDisplay = mParent->getDisplayMouseInterface();
549	ComAssertRet(pDisplay, E_FAIL);
550	/** The amount to add to the result (multiplied by the screen width/height)
551	* to compensate for differences in guest methods for mapping back to
552	* pixels */
553	enum { ADJUST_RANGE = - 3 * VMMDEV_MOUSE_RANGE / 4 };
554
555	if (pfValid)
556	*pfValid = true;
557	if (!(mfVMMDevGuestCaps & VMMDEV_MOUSE_NEW_PROTOCOL))
558	{
559	ULONG displayWidth, displayHeight;
560	/* Takes the display lock */
561	HRESULT rc = pDisplay->getScreenResolution(0, &displayWidth,
562	&displayHeight, NULL, NULL, NULL);
563	if (FAILED(rc))
564	return rc;
565
566	pxAdj = displayWidth ? (x VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
567	/ (LONG) displayWidth: 0;
568	pyAdj = displayHeight ? (y VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
569	/ (LONG) displayHeight: 0;
570	}
571	else
572	{
573	int32_t x1, y1, x2, y2;
574	/* Takes the display lock */
575	pDisplay->getFramebufferDimensions(&x1, &y1, &x2, &y2);
576	pxAdj = x1 < x2 ? ((x - x1) VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
577	/ (x2 - x1) : 0;
578	pyAdj = y1 < y2 ? ((y - y1) VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
579	/ (y2 - y1) : 0;
580	if ( *pxAdj < VMMDEV_MOUSE_RANGE_MIN
581	\|\| *pxAdj > VMMDEV_MOUSE_RANGE_MAX
582	\|\| *pyAdj < VMMDEV_MOUSE_RANGE_MIN
583	\|\| *pyAdj > VMMDEV_MOUSE_RANGE_MAX)
584	if (pfValid)
585	*pfValid = false;
586	}
587	return S_OK;
588	}
589
590
591	/**
592	* Send an absolute mouse event to the VM. This requires either VirtualBox-
593	* specific drivers installed in the guest or absolute pointing device
594	* emulation.
595	* @note the VMMDev capability change is so that the guest knows we are sending
596	* dummy events over the PS/2 device to signal the arrival of new
597	* absolute pointer data, and not pointer real movement data
598	* @note all calls out of this object are made with no locks held!
599	*
600	* @returns COM status code
601	* @param x X position (pixel), starting from 1
602	* @param y Y position (pixel), starting from 1
603	* @param dz Z movement
604	* @param fButtons The mouse button state
605	*/
606	STDMETHODIMP Mouse::PutMouseEventAbsolute(LONG x, LONG y, LONG dz, LONG dw,
607	LONG fButtons)
608	{
609	AutoCaller autoCaller(this);
610	if (FAILED(autoCaller.rc())) return autoCaller.rc();
611
612	LogRel3(("%s: x=%d, y=%d, dz=%d, dw=%d, fButtons=0x%x\n",
613	__PRETTY_FUNCTION__, x, y, dz, dw, fButtons));
614
615	int32_t xAdj, yAdj;
616	uint32_t fButtonsAdj;
617	bool fValid;
618
619	/** @todo the front end should do this conversion to avoid races */
620	/** @note Or maybe not... races are pretty inherent in everything done in
621	* this object and not really bad as far as I can see. */
622	HRESULT rc = convertDisplayRes(x, y, &xAdj, &yAdj, &fValid);
623	if (FAILED(rc)) return rc;
624
625	fButtonsAdj = mouseButtonsToPDM(fButtons);
626	/* If we are doing old-style (IRQ-less) absolute reporting to the VMM
627	* device then make sure the guest is aware of it, so that it knows to
628	* ignore relative movement on the PS/2 device. */
629	updateVMMDevMouseCaps(VMMDEV_MOUSE_HOST_WANTS_ABSOLUTE, 0);
630	if (fValid)
631	{
632	rc = reportAbsEvent(xAdj, yAdj, dz, dw, fButtonsAdj,
633	RT_BOOL( mfVMMDevGuestCaps
634	& VMMDEV_MOUSE_NEW_PROTOCOL));
635
636	fireMouseEvent(true, x, y, dz, dw, fButtons);
637	}
638
639	return rc;
640	}
641
642	/**
643	* Send a multi-touch event. This requires multi-touch pointing device emulation.
644	* @note all calls out of this object are made with no locks held!
645	*
646	* @returns COM status code.
647	* @param aCount Number of contacts.
648	* @param aContacts Information about each contact.
649	* @param aScanTime Timestamp.
650	*/
651	STDMETHODIMP Mouse::PutEventMultiTouch(LONG aCount,
652	ComSafeArrayIn(LONG64, aContacts),
653	ULONG aScanTime)
654	{
655	AutoCaller autoCaller(this);
656	if (FAILED(autoCaller.rc())) return autoCaller.rc();
657
658	com::SafeArray <LONG64> arrayContacts(ComSafeArrayInArg(aContacts));
659
660	LogRel3(("%s: aCount %d(actual %d), aScanTime %u\n",
661	__FUNCTION__, aCount, arrayContacts.size(), aScanTime));
662
663	HRESULT rc = S_OK;
664
665	if ((LONG)arrayContacts.size() >= aCount)
666	{
667	LONG64* paContacts = arrayContacts.raw();
668
669	rc = putEventMultiTouch(aCount, paContacts, aScanTime);
670	}
671	else
672	{
673	rc = E_INVALIDARG;
674	}
675
676	return rc;
677	}
678
679	/**
680	* Send a multi-touch event. Version for scripting languages.
681	*
682	* @returns COM status code.
683	* @param aCount Number of contacts.
684	* @param aContacts Information about each contact.
685	* @param aScanTime Timestamp.
686	*/
687	STDMETHODIMP Mouse::PutEventMultiTouchString(LONG aCount,
688	IN_BSTR aContacts,
689	ULONG aScanTime)
690	{
691	/** @todo implement: convert the string to LONG64 array and call putEventMultiTouch. */
692	NOREF(aCount);
693	NOREF(aContacts);
694	NOREF(aScanTime);
695	return E_NOTIMPL;
696	}
697
698
699	// private methods
700	/////////////////////////////////////////////////////////////////////////////
701
702	/* Used by PutEventMultiTouch and PutEventMultiTouchString. */
703	HRESULT Mouse::putEventMultiTouch(LONG aCount,
704	LONG64 *paContacts,
705	ULONG aScanTime)
706	{
707	if (aCount >= 256)
708	{
709	return E_INVALIDARG;
710	}
711
712	DisplayMouseInterface *pDisplay = mParent->getDisplayMouseInterface();
713	ComAssertRet(pDisplay, E_FAIL);
714
715	/* Touch events are mapped to the primary monitor, because the emulated USB
716	* touchscreen device is associated with one (normally the primary) screen in the guest.
717	*/
718	ULONG uScreenId = 0;
719
720	ULONG cWidth = 0;
721	ULONG cHeight = 0;
722	LONG xOrigin = 0;
723	LONG yOrigin = 0;
724	HRESULT rc = pDisplay->getScreenResolution(uScreenId, &cWidth, &cHeight, NULL, &xOrigin, &yOrigin);
725	ComAssertComRCRetRC(rc);
726
727	uint64_t* pau64Contacts = NULL;
728	uint8_t cContacts = 0;
729
730	/* Deliver 0 contacts too, touch device may use this to reset the state. */
731	if (aCount > 0)
732	{
733	/* Create a copy with converted coords. */
734	pau64Contacts = (uint64_t )RTMemTmpAlloc(aCount sizeof(uint64_t));
735	if (pau64Contacts)
736	{
737	int32_t x1 = xOrigin;
738	int32_t y1 = yOrigin;
739	int32_t x2 = x1 + cWidth;
740	int32_t y2 = y1 + cHeight;
741
742	LogRel3(("%s: screen [%d] %d,%d %d,%d\n",
743	__FUNCTION__, uScreenId, x1, y1, x2, y2));
744
745	LONG i;
746	for (i = 0; i < aCount; i++)
747	{
748	uint32_t u32Lo = RT_LO_U32(paContacts[i]);
749	uint32_t u32Hi = RT_HI_U32(paContacts[i]);
750	int32_t x = (int16_t)u32Lo;
751	int32_t y = (int16_t)(u32Lo >> 16);
752	uint8_t contactId = RT_BYTE1(u32Hi);
753	bool fInContact = (RT_BYTE2(u32Hi) & 0x1) != 0;
754	bool fInRange = (RT_BYTE2(u32Hi) & 0x2) != 0;
755
756	LogRel3(("%s: [%d] %d,%d id %d, inContact %d, inRange %d\n",
757	__FUNCTION__, i, x, y, contactId, fInContact, fInRange));
758
759	/* x1,y1 are inclusive and x2,y2 are exclusive,
760	* while x,y start from 1 and are inclusive.
761	*/
762	if (x <= x1 \|\| x > x2 \|\| y <= y1 \|\| y > y2)
763	{
764	/* Out of range. Skip the contact. */
765	continue;
766	}
767
768	int32_t xAdj = x1 < x2? ((x - 1 - x1) * VMMDEV_MOUSE_RANGE) / (x2 - x1) : 0;
769	int32_t yAdj = y1 < y2? ((y - 1 - y1) * VMMDEV_MOUSE_RANGE) / (y2 - y1) : 0;
770
771	bool fValid = ( xAdj >= VMMDEV_MOUSE_RANGE_MIN
772	&& xAdj <= VMMDEV_MOUSE_RANGE_MAX
773	&& yAdj >= VMMDEV_MOUSE_RANGE_MIN
774	&& yAdj <= VMMDEV_MOUSE_RANGE_MAX);
775
776	if (fValid)
777	{
778	uint8_t fu8 = (fInContact? 0x01: 0x00)
779	\| (fInRange? 0x02: 0x00);
780	pau64Contacts[cContacts] = RT_MAKE_U64_FROM_U16((uint16_t)xAdj,
781	(uint16_t)yAdj,
782	RT_MAKE_U16(contactId, fu8),
783	0);
784	cContacts++;
785	}
786	}
787	}
788	else
789	{
790	rc = E_OUTOFMEMORY;
791	}
792	}
793
794	if (SUCCEEDED(rc))
795	{
796	rc = reportMultiTouchEventToDevice(cContacts, cContacts? pau64Contacts: NULL, (uint32_t)aScanTime);
797
798	// @todo Implement using a new TouchEvent rather than extending the mouse event.
799	// fireMouseEvent(true, x, y, 0, 0, cContact, contactState);
800	}
801
802	RTMemTmpFree(pau64Contacts);
803
804	return rc;
805	}
806
807
808	/** Does the guest currently rely on the host to draw the mouse cursor or
809	* can it switch to doing it itself in software? */
810	bool Mouse::guestNeedsHostCursor(void)
811	{
812	return RT_BOOL(mfVMMDevGuestCaps & VMMDEV_MOUSE_GUEST_NEEDS_HOST_CURSOR);
813	}
814
815
816	/** Check what sort of reporting can be done using the devices currently
817	* enabled. Does not consider the VMM device. */
818	void Mouse::getDeviceCaps(bool pfAbs, bool pfRel, bool *pfMT)
819	{
820	bool fAbsDev = false;
821	bool fRelDev = false;
822	bool fMTDev = false;
823
824	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
825
826	for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i)
827	if (mpDrv[i])
828	{
829	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE)
830	fAbsDev = true;
831	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE)
832	fRelDev = true;
833	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_MULTI_TOUCH)
834	fMTDev = true;
835	}
836	if (pfAbs)
837	*pfAbs = fAbsDev;
838	if (pfRel)
839	*pfRel = fRelDev;
840	if (pfMT)
841	*pfMT = fMTDev;
842	}
843
844
845	/** Does the VMM device currently support absolute reporting? */
846	bool Mouse::vmmdevCanAbs(void)
847	{
848	bool fRelDev;
849
850	getDeviceCaps(NULL, &fRelDev, NULL);
851	return (mfVMMDevGuestCaps & VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE)
852	&& fRelDev;
853	}
854
855
856	/** Does the VMM device currently support absolute reporting? */
857	bool Mouse::deviceCanAbs(void)
858	{
859	bool fAbsDev;
860
861	getDeviceCaps(&fAbsDev, NULL, NULL);
862	return fAbsDev;
863	}
864
865
866	/** Can we currently send relative events to the guest? */
867	bool Mouse::supportsRel(void)
868	{
869	bool fRelDev;
870
871	getDeviceCaps(NULL, &fRelDev, NULL);
872	return fRelDev;
873	}
874
875
876	/** Can we currently send absolute events to the guest? */
877	bool Mouse::supportsAbs(void)
878	{
879	bool fAbsDev;
880
881	getDeviceCaps(&fAbsDev, NULL, NULL);
882	return fAbsDev \|\| vmmdevCanAbs();
883	}
884
885
886	/** Can we currently send absolute events to the guest? */
887	bool Mouse::supportsMT(void)
888	{
889	bool fMTDev;
890
891	getDeviceCaps(NULL, NULL, &fMTDev);
892	return fMTDev;
893	}
894
895
896	/** Check what sort of reporting can be done using the devices currently
897	* enabled (including the VMM device) and notify the guest and the front-end.
898	*/
899	void Mouse::sendMouseCapsNotifications(void)
900	{
901	bool fAbsDev, fRelDev, fMTDev, fCanAbs, fNeedsHostCursor;
902
903	{
904	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
905
906	getDeviceCaps(&fAbsDev, &fRelDev, &fMTDev);
907	fCanAbs = supportsAbs();
908	fNeedsHostCursor = guestNeedsHostCursor();
909	}
910	if (fAbsDev)
911	updateVMMDevMouseCaps(VMMDEV_MOUSE_HOST_HAS_ABS_DEV, 0);
912	else
913	updateVMMDevMouseCaps(0, VMMDEV_MOUSE_HOST_HAS_ABS_DEV);
914	/** @todo this call takes the Console lock in order to update the cached
915	* callback data atomically. However I can't see any sign that the cached
916	* data is ever used again. */
917	mParent->onMouseCapabilityChange(fCanAbs, fRelDev, fMTDev, fNeedsHostCursor);
918	}
919
920
921	/**
922	* @interface_method_impl{PDMIMOUSECONNECTOR,pfnReportModes}
923	* A virtual device is notifying us about its current state and capabilities
924	*/
925	DECLCALLBACK(void) Mouse::mouseReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRel, bool fAbs, bool fMT)
926	{
927	PDRVMAINMOUSE pDrv = RT_FROM_MEMBER(pInterface, DRVMAINMOUSE, IConnector);
928	if (fRel)
929	pDrv->u32DevCaps \|= MOUSE_DEVCAP_RELATIVE;
930	else
931	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_RELATIVE;
932	if (fAbs)
933	pDrv->u32DevCaps \|= MOUSE_DEVCAP_ABSOLUTE;
934	else
935	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_ABSOLUTE;
936	if (fMT)
937	pDrv->u32DevCaps \|= MOUSE_DEVCAP_MULTI_TOUCH;
938	else
939	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_MULTI_TOUCH;
940
941	pDrv->pMouse->sendMouseCapsNotifications();
942	}
943
944
945	/**
946	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
947	*/
948	DECLCALLBACK(void ) Mouse::drvQueryInterface(PPDMIBASE pInterface, const char pszIID)
949	{
950	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
951	PDRVMAINMOUSE pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
952
953	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
954	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSECONNECTOR, &pDrv->IConnector);
955	return NULL;
956	}
957
958
959	/**
960	* Destruct a mouse driver instance.
961	*
962	* @returns VBox status.
963	* @param pDrvIns The driver instance data.
964	*/
965	DECLCALLBACK(void) Mouse::drvDestruct(PPDMDRVINS pDrvIns)
966	{
967	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
968	PDRVMAINMOUSE pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
969	LogFlow(("Mouse::drvDestruct: iInstance=%d\n", pDrvIns->iInstance));
970
971	if (pThis->pMouse)
972	{
973	AutoWriteLock mouseLock(pThis->pMouse COMMA_LOCKVAL_SRC_POS);
974	for (unsigned cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev)
975	if (pThis->pMouse->mpDrv[cDev] == pThis)
976	{
977	pThis->pMouse->mpDrv[cDev] = NULL;
978	break;
979	}
980	}
981	}
982
983
984	/**
985	* Construct a mouse driver instance.
986	*
987	* @copydoc FNPDMDRVCONSTRUCT
988	*/
989	DECLCALLBACK(int) Mouse::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
990	{
991	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
992	PDRVMAINMOUSE pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
993	LogFlow(("drvMainMouse_Construct: iInstance=%d\n", pDrvIns->iInstance));
994
995	/*
996	* Validate configuration.
997	*/
998	if (!CFGMR3AreValuesValid(pCfg, "Object\0Priority\0"))
999	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
1000	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
1001	("Configuration error: Not possible to attach anything to this driver!\n"),
1002	VERR_PDM_DRVINS_NO_ATTACH);
1003
1004	/*
1005	* IBase.
1006	*/
1007	pDrvIns->IBase.pfnQueryInterface = Mouse::drvQueryInterface;
1008
1009	pThis->IConnector.pfnReportModes = Mouse::mouseReportModes;
1010
1011	/*
1012	* Get the IMousePort interface of the above driver/device.
1013	*/
1014	pThis->pUpPort = (PPDMIMOUSEPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMIMOUSEPORT_IID);
1015	if (!pThis->pUpPort)
1016	{
1017	AssertMsgFailed(("Configuration error: No mouse port interface above!\n"));
1018	return VERR_PDM_MISSING_INTERFACE_ABOVE;
1019	}
1020
1021	/*
1022	* Get the Mouse object pointer and update the mpDrv member.
1023	*/
1024	void *pv;
1025	int rc = CFGMR3QueryPtr(pCfg, "Object", &pv);
1026	if (RT_FAILURE(rc))
1027	{
1028	AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
1029	return rc;
1030	}
1031	pThis->pMouse = (Mouse )pv; /* @todo Check this cast! */
1032	/*
1033	* Get the device priority.
1034	*/
1035	rc = CFGMR3QueryU32Def(pCfg, "Priority", &pThis->u32Priority, 1);
1036	if (RT_FAILURE(rc))
1037	{
1038	AssertMsgFailed(("Configuration error: Bad \"Priority\" value! rc=%Rrc\n", rc));
1039	return rc;
1040	}
1041	unsigned cDev;
1042	{
1043	PDRVMAINMOUSE pObject = pThis;
1044	AutoReadLock mouseLock(pThis->pMouse COMMA_LOCKVAL_SRC_POS);
1045
1046	for (cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev)
1047	if (pThis->pMouse->mpDrv[cDev])
1048	{
1049	/* Fix priorities. */
1050	if ( pThis->pMouse->mpDrv[cDev]->u32Priority
1051	<= pObject->u32Priority)
1052	{
1053	PDRVMAINMOUSE pNewObject = pThis->pMouse->mpDrv[cDev];
1054	pThis->pMouse->mpDrv[cDev] = pObject;
1055	pObject = pNewObject;
1056	}
1057	}
1058	else
1059	{
1060	pThis->pMouse->mpDrv[cDev] = pObject;
1061	break;
1062	}
1063	}
1064	if (cDev == MOUSE_MAX_DEVICES)
1065	return VERR_NO_MORE_HANDLES;
1066
1067	return VINF_SUCCESS;
1068	}
1069
1070
1071	/**
1072	* Main mouse driver registration record.
1073	*/
1074	const PDMDRVREG Mouse::DrvReg =
1075	{
1076	/* u32Version */
1077	PDM_DRVREG_VERSION,
1078	/* szName */
1079	"MainMouse",
1080	/* szRCMod */
1081	"",
1082	/* szR0Mod */
1083	"",
1084	/* pszDescription */
1085	"Main mouse driver (Main as in the API).",
1086	/* fFlags */
1087	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
1088	/* fClass. */
1089	PDM_DRVREG_CLASS_MOUSE,
1090	/* cMaxInstances */
1091	~0U,
1092	/* cbInstance */
1093	sizeof(DRVMAINMOUSE),
1094	/* pfnConstruct */
1095	Mouse::drvConstruct,
1096	/* pfnDestruct */
1097	Mouse::drvDestruct,
1098	/* pfnRelocate */
1099	NULL,
1100	/* pfnIOCtl */
1101	NULL,
1102	/* pfnPowerOn */
1103	NULL,
1104	/* pfnReset */
1105	NULL,
1106	/* pfnSuspend */
1107	NULL,
1108	/* pfnResume */
1109	NULL,
1110	/* pfnAttach */
1111	NULL,
1112	/* pfnDetach */
1113	NULL,
1114	/* pfnPowerOff */
1115	NULL,
1116	/* pfnSoftReset */
1117	NULL,
1118	/* u32EndVersion */
1119	PDM_DRVREG_VERSION
1120	};
1121	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-client/MouseImpl.cpp@ 47804

Download in other formats: