VRDEInput.h revision e6725710856db1d20c16eb103a0d3ea8f46a982a
236b2935f217749893b7034e59da3e3568928acevboxsync/** @file
236b2935f217749893b7034e59da3e3568928acevboxsync * VBox Remote Desktop Extension (VRDE) - Input interface.
236b2935f217749893b7034e59da3e3568928acevboxsync */
236b2935f217749893b7034e59da3e3568928acevboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/*
236b2935f217749893b7034e59da3e3568928acevboxsync * Copyright (C) 2013 Oracle Corporation
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
236b2935f217749893b7034e59da3e3568928acevboxsync * available from http://www.virtualbox.org. This file is free software;
236b2935f217749893b7034e59da3e3568928acevboxsync * you can redistribute it and/or modify it under the terms of the GNU
236b2935f217749893b7034e59da3e3568928acevboxsync * General Public License (GPL) as published by the Free Software
236b2935f217749893b7034e59da3e3568928acevboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
236b2935f217749893b7034e59da3e3568928acevboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
236b2935f217749893b7034e59da3e3568928acevboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * The contents of this file may alternatively be used under the terms
236b2935f217749893b7034e59da3e3568928acevboxsync * of the Common Development and Distribution License Version 1.0
236b2935f217749893b7034e59da3e3568928acevboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
236b2935f217749893b7034e59da3e3568928acevboxsync * VirtualBox OSE distribution, in which case the provisions of the
236b2935f217749893b7034e59da3e3568928acevboxsync * CDDL are applicable instead of those of the GPL.
236b2935f217749893b7034e59da3e3568928acevboxsync *
236b2935f217749893b7034e59da3e3568928acevboxsync * You may elect to license modified versions of this file under the
157093a77f2752732368338110cb50fa6cd7717fvboxsync * terms and conditions of either the GPL or the CDDL or both.
236b2935f217749893b7034e59da3e3568928acevboxsync */
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#ifndef ___VBox_RemoteDesktop_VRDEInput_h
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync#define ___VBox_RemoteDesktop_VRDEInput_h
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/*
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync * Interface for receiving input events from the client.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync */
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/* All structures in this file are packed.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * Everything is little-endian.
236b2935f217749893b7034e59da3e3568928acevboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsync#pragma pack(1)
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/*
157093a77f2752732368338110cb50fa6cd7717fvboxsync * The application interface between VirtualBox and the VRDE server.
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDE_INPUT_INTERFACE_NAME "VRDE::INPUT"
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync
236b2935f217749893b7034e59da3e3568928acevboxsync/*
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * Supported input methods.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync */
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync#define VRDE_INPUT_METHOD_TOUCH 1
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync/*
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * fu32Flags for VRDEInputSetup
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync */
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync#define VRDE_INPUT_F_ENABLE 1
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync/* The interface entry points. Interface version 1. */
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsynctypedef struct VRDEINPUTINTERFACE
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync{
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync /* The header. */
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync VRDEINTERFACEHDR header;
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync /* Tell the server that an input method will be used or disabled, etc.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * VRDECallbackInputSetup will be called with a result.
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync *
ce9f428fc2f581b4d8968d870967e259d9924d8dvboxsync * @param hServer The VRDE server instance.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param u32Method The method VRDE_INPUT_METHOD_*.
236b2935f217749893b7034e59da3e3568928acevboxsync * @param fu32Flags What to do with the method VRDE_INPUT_F_*.
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync * @param pvSetup Method specific parameters (optional).
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync * @param cbSetup Size of method specific parameters (optional).
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync */
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync DECLR3CALLBACKMEMBER(void, VRDEInputSetup, (HVRDESERVER hServer,
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync uint32_t u32Method,
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync uint32_t fu32Flags,
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync const void *pvSetup,
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync uint32_t cbSetup));
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync} VRDEINPUTINTERFACE;
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync/* Interface callbacks. */
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsynctypedef struct VRDEINPUTCALLBACKS
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync{
157093a77f2752732368338110cb50fa6cd7717fvboxsync /* The header. */
157093a77f2752732368338110cb50fa6cd7717fvboxsync VRDEINTERFACEHDR header;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync /* VRDPInputSetup async result.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync *
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @param pvCallback The callbacks context specified in VRDEGetInterface.
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync * @param rcSetup The result code of the request.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param u32Method The method VRDE_INPUT_METHOD_*.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param pvResult The result information.
157093a77f2752732368338110cb50fa6cd7717fvboxsync * @param cbResult The size of buffer pointed by pvResult.
157093a77f2752732368338110cb50fa6cd7717fvboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsync DECLR3CALLBACKMEMBER(void, VRDECallbackInputSetup,(void *pvCallback,
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync int rcRequest,
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync uint32_t u32Method,
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync const void *pvResult,
157093a77f2752732368338110cb50fa6cd7717fvboxsync uint32_t cbResult));
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync /* Input event.
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync *
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync * @param pvCallback The callbacks context specified in VRDEGetInterface.
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync * @param u32Method The method VRDE_INPUT_METHOD_*.
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync * @param pvEvent The event data.
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync * @param cbEvent The size of buffer pointed by pvEvent.
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync */
157093a77f2752732368338110cb50fa6cd7717fvboxsync DECLR3CALLBACKMEMBER(void, VRDECallbackInputEvent,(void *pvCallback,
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync uint32_t u32Method,
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync const void *pvEvent,
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync uint32_t cbEvent));
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync} VRDEINPUTCALLBACKS;
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync/*
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync * Touch input definitions VRDE_INPUT_METHOD_TOUCH.
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync */
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync/* pvResult is not used */
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync/* RDPINPUT_HEADER */
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsynctypedef struct VRDEINPUTHEADER
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync{
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync uint16_t u16EventId;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync uint32_t u32PDULength;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync} VRDEINPUTHEADER;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync/* VRDEINPUTHEADER::u16EventId */
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync#define VRDEINPUT_EVENTID_SC_READY 0x0001
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_EVENTID_CS_READY 0x0002
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_EVENTID_TOUCH 0x0003
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_EVENTID_SUSPEND_TOUCH 0x0004
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_EVENTID_RESUME_TOUCH 0x0005
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_EVENTID_DISMISS_HOVERING_CONTACT 0x0006
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/* RDPINPUT_SC_READY_PDU */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef struct VRDEINPUT_SC_READY_PDU
157093a77f2752732368338110cb50fa6cd7717fvboxsync{
157093a77f2752732368338110cb50fa6cd7717fvboxsync VRDEINPUTHEADER header;
157093a77f2752732368338110cb50fa6cd7717fvboxsync uint32_t u32ProtocolVersion;
157093a77f2752732368338110cb50fa6cd7717fvboxsync} VRDEINPUT_SC_READY_PDU;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
d26b6be365a8cdaa266abf40097afb031d4757d2vboxsync#define VRDEINPUT_PROTOCOL_V1 0x00010000
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/* RDPINPUT_CS_READY_PDU */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef struct VRDEINPUT_CS_READY_PDU
25c07bc6c4c5024d8693f2f808f34ee3fe820994vboxsync{
25c07bc6c4c5024d8693f2f808f34ee3fe820994vboxsync VRDEINPUTHEADER header;
25c07bc6c4c5024d8693f2f808f34ee3fe820994vboxsync uint32_t u32Flags;
25c07bc6c4c5024d8693f2f808f34ee3fe820994vboxsync uint32_t u32ProtocolVersion;
157093a77f2752732368338110cb50fa6cd7717fvboxsync uint16_t u16MaxTouchContacts;
25c07bc6c4c5024d8693f2f808f34ee3fe820994vboxsync} VRDEINPUT_CS_READY_PDU;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync#define VRDEINPUT_READY_FLAGS_SHOW_TOUCH_VISUALS 0x00000001
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync#define VRDEINPUT_READY_FLAGS_DISABLE_TIMESTAMP_INJECTION 0x00000002
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync/* RDPINPUT_CONTACT_DATA */
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsynctypedef struct VRDEINPUT_CONTACT_DATA
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync{
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync uint8_t u8ContactId;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync uint16_t u16FieldsPresent;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync int32_t i32X;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync int32_t i32Y;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync uint32_t u32ContactFlags;
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync int16_t i16ContactRectLeft;
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync int16_t i16ContactRectTop;
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync int16_t i16ContactRectRight;
bc5cd42756b3f98351040bbfccc08dd9bacd103avboxsync int16_t i16ContactRectBotton;
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync uint32_t u32Orientation;
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync uint32_t u32Pressure;
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsync} VRDEINPUT_CONTACT_DATA;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_CONTACT_DATA_CONTACTRECT_PRESENT 0x0001
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_CONTACT_DATA_ORIENTATION_PRESENT 0x0002
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync#define VRDEINPUT_CONTACT_DATA_PRESSURE_PRESENT 0x0004
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync#define VRDEINPUT_CONTACT_FLAG_DOWN 0x0001
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync#define VRDEINPUT_CONTACT_FLAG_UPDATE 0x0002
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_CONTACT_FLAG_UP 0x0004
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_CONTACT_FLAG_INRANGE 0x0008
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_CONTACT_FLAG_INCONTACT 0x0010
157093a77f2752732368338110cb50fa6cd7717fvboxsync#define VRDEINPUT_CONTACT_FLAG_CANCELED 0x0020
157093a77f2752732368338110cb50fa6cd7717fvboxsync
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync/* RDPINPUT_TOUCH_FRAME */
5067a9619d7131c54d4ebb371d9dac91abdd34f6vboxsynctypedef struct VRDEINPUT_TOUCH_FRAME
eca46116c06b850c8c6be84678ba1f9dbdb3f9ddvboxsync{
157093a77f2752732368338110cb50fa6cd7717fvboxsync uint16_t u16ContactCount;
157093a77f2752732368338110cb50fa6cd7717fvboxsync uint64_t u64FrameOffset;
157093a77f2752732368338110cb50fa6cd7717fvboxsync VRDEINPUT_CONTACT_DATA aContacts[1];
157093a77f2752732368338110cb50fa6cd7717fvboxsync} VRDEINPUT_TOUCH_FRAME;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync/* RDPINPUT_TOUCH_EVENT_PDU */
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsynctypedef struct VRDEINPUT_TOUCH_EVENT_PDU
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync{
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync VRDEINPUTHEADER header;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync uint32_t u32EncodeTime;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync uint16_t u16FrameCount;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync VRDEINPUT_TOUCH_FRAME aFrames[1];
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync} VRDEINPUT_TOUCH_EVENT_PDU;
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync/* RDPINPUT_SUSPEND_TOUCH_PDU */
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsynctypedef struct VRDEINPUT_SUSPEND_TOUCH_PDU
773940a4d3b16fc24fa111b73075a9fdcabbfc78vboxsync{
157093a77f2752732368338110cb50fa6cd7717fvboxsync VRDEINPUTHEADER header;
157093a77f2752732368338110cb50fa6cd7717fvboxsync} VRDEINPUT_SUSPEND_TOUCH_PDU;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync/* RDPINPUT_RESUME_TOUCH_PDU */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef struct VRDEINPUT_RESUME_TOUCH_PDU
157093a77f2752732368338110cb50fa6cd7717fvboxsync{
157093a77f2752732368338110cb50fa6cd7717fvboxsync VRDEINPUTHEADER header;
157093a77f2752732368338110cb50fa6cd7717fvboxsync} VRDEINPUT_RESUME_TOUCH_PDU;
2ac3892cdc8b16a0dee55e8b4510b8ecea83c95fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync/* RDPINPUT_DISMISS_HOVERING_CONTACT_PDU */
157093a77f2752732368338110cb50fa6cd7717fvboxsynctypedef struct VRDEINPUT_DISMISS_HOVERING_CONTACT_PDU
157093a77f2752732368338110cb50fa6cd7717fvboxsync{
157093a77f2752732368338110cb50fa6cd7717fvboxsync VRDEINPUTHEADER header;
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync uint8_t u8ContactId;
157093a77f2752732368338110cb50fa6cd7717fvboxsync} VRDEINPUT_DISMISS_HOVERING_CONTACT_PDU;
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#pragma pack()
157093a77f2752732368338110cb50fa6cd7717fvboxsync
157093a77f2752732368338110cb50fa6cd7717fvboxsync#endif
ad4f6ac2063d9b48efd9c3193442136a8c7c890avboxsync