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