summaryrefslogtreecommitdiffstats
path: root/include/freerdp/channels/rdpemsc.h
blob: 46203584873d4f9d19a5fde4158f59c2087f4b6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Mouse Cursor Virtual Channel Extension
 *
 * Copyright 2023 Pascal Nowack <Pascal.Nowack@gmx.de>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef FREERDP_CHANNEL_RDPEMSC_H
#define FREERDP_CHANNEL_RDPEMSC_H

#include <freerdp/api.h>
#include <freerdp/dvc.h>
#include <freerdp/types.h>

#define RDPEMSC_CHANNEL_NAME "mousecursor"
#define RDPEMSC_DVC_CHANNEL_NAME "Microsoft::Windows::RDS::MouseCursor"

#ifdef __cplusplus
extern "C"
{
#endif

	typedef enum
	{
		PDUTYPE_EMSC_RESERVED = 0x00,
		PDUTYPE_CS_CAPS_ADVERTISE = 0x01,
		PDUTYPE_SC_CAPS_CONFIRM = 0x02,
		PDUTYPE_SC_MOUSEPTR_UPDATE = 0x03,
	} RDP_MOUSE_CURSOR_PDUTYPE;

	typedef enum
	{
		TS_UPDATETYPE_MOUSEPTR_SYSTEM_NULL = 0x05,
		TS_UPDATETYPE_MOUSEPTR_SYSTEM_DEFAULT = 0x06,
		TS_UPDATETYPE_MOUSEPTR_POSITION = 0x08,
		TS_UPDATETYPE_MOUSEPTR_CACHED = 0x0A,
		TS_UPDATETYPE_MOUSEPTR_POINTER = 0x0B,
		TS_UPDATETYPE_MOUSEPTR_LARGE_POINTER = 0x0C,
	} TS_UPDATETYPE_MOUSEPTR;

#define RDPEMSC_HEADER_SIZE 4

	typedef struct
	{
		RDP_MOUSE_CURSOR_PDUTYPE pduType;
		TS_UPDATETYPE_MOUSEPTR updateType;
		UINT16 reserved;
	} RDP_MOUSE_CURSOR_HEADER;

	typedef enum
	{
		RDP_MOUSE_CURSOR_CAPVERSION_INVALID = 0x00000000,
		RDP_MOUSE_CURSOR_CAPVERSION_1 = 0x00000001,
	} RDP_MOUSE_CURSOR_CAPVERSION;

	typedef struct
	{
		UINT32 signature;
		RDP_MOUSE_CURSOR_CAPVERSION version;
		UINT32 size;
	} RDP_MOUSE_CURSOR_CAPSET;

	typedef struct
	{
		RDP_MOUSE_CURSOR_CAPSET capsetHeader;
	} RDP_MOUSE_CURSOR_CAPSET_VERSION1;

	typedef struct
	{
		RDP_MOUSE_CURSOR_HEADER header;
		wArrayList* capsSets;
	} RDP_MOUSE_CURSOR_CAPS_ADVERTISE_PDU;

	typedef struct
	{
		RDP_MOUSE_CURSOR_HEADER header;
		RDP_MOUSE_CURSOR_CAPSET* capsSet;
	} RDP_MOUSE_CURSOR_CAPS_CONFIRM_PDU;

	typedef struct
	{
		UINT16 xPos;
		UINT16 yPos;
	} TS_POINT16;

	typedef struct
	{
		UINT16 xorBpp;
		UINT16 cacheIndex;
		TS_POINT16 hotSpot;
		UINT16 width;
		UINT16 height;
		UINT16 lengthAndMask;
		UINT16 lengthXorMask;
		BYTE* xorMaskData;
		BYTE* andMaskData;
		BYTE pad;
	} TS_POINTERATTRIBUTE;

	typedef struct
	{
		UINT16 xorBpp;
		UINT16 cacheIndex;
		TS_POINT16 hotSpot;
		UINT16 width;
		UINT16 height;
		UINT32 lengthAndMask;
		UINT32 lengthXorMask;
		BYTE* xorMaskData;
		BYTE* andMaskData;
		BYTE pad;
	} TS_LARGEPOINTERATTRIBUTE;

	typedef struct
	{
		RDP_MOUSE_CURSOR_HEADER header;
		TS_POINT16* position;
		UINT16* cachedPointerIndex;
		TS_POINTERATTRIBUTE* pointerAttribute;
		TS_LARGEPOINTERATTRIBUTE* largePointerAttribute;
	} RDP_MOUSE_CURSOR_MOUSEPTR_UPDATE_PDU;

#ifdef __cplusplus
}
#endif
#endif /* FREERDP_CHANNEL_RDPEMSC_H */