FreeRDP
Loading...
Searching...
No Matches
include/freerdp/server/shadow.h
1
20#ifndef FREERDP_SERVER_SHADOW_H
21#define FREERDP_SERVER_SHADOW_H
22
23#include <freerdp/api.h>
24#include <freerdp/types.h>
25
26#include <freerdp/freerdp.h>
27#include <freerdp/settings.h>
28#include <freerdp/listener.h>
29
30#include <freerdp/channels/wtsvc.h>
31#include <freerdp/channels/channels.h>
32
33#include <freerdp/server/encomsp.h>
34#include <freerdp/server/remdesk.h>
35#include <freerdp/server/rdpsnd.h>
36#if defined(CHANNEL_AUDIN_SERVER)
37#include <freerdp/server/audin.h>
38#endif
39#include <freerdp/server/rdpgfx.h>
40
41#include <freerdp/codec/color.h>
42#include <freerdp/codec/region.h>
43
44#include <winpr/crt.h>
45#include <winpr/synch.h>
46#include <winpr/collections.h>
47#include <winpr/cmdline.h>
48
49#ifdef __cplusplus
50extern "C"
51{
52#endif
53
54 typedef struct rdp_shadow_client rdpShadowClient;
55 typedef struct rdp_shadow_server rdpShadowServer;
56 typedef struct rdp_shadow_screen rdpShadowScreen;
57 typedef struct rdp_shadow_surface rdpShadowSurface;
58 typedef struct rdp_shadow_encoder rdpShadowEncoder;
59 typedef struct rdp_shadow_capture rdpShadowCapture;
60 typedef struct rdp_shadow_subsystem rdpShadowSubsystem;
61 typedef struct rdp_shadow_multiclient_event rdpShadowMultiClientEvent;
62
63 typedef struct S_RDP_SHADOW_ENTRY_POINTS RDP_SHADOW_ENTRY_POINTS;
64 typedef int (*pfnShadowSubsystemEntry)(RDP_SHADOW_ENTRY_POINTS* pEntryPoints);
65
66 typedef rdpShadowSubsystem* (*pfnShadowSubsystemNew)(void);
67 typedef void (*pfnShadowSubsystemFree)(rdpShadowSubsystem* subsystem);
68
69 typedef int (*pfnShadowSubsystemInit)(rdpShadowSubsystem* subsystem);
70 typedef int (*pfnShadowSubsystemUninit)(rdpShadowSubsystem* subsystem);
71
72 typedef int (*pfnShadowSubsystemStart)(rdpShadowSubsystem* subsystem);
73 typedef int (*pfnShadowSubsystemStop)(rdpShadowSubsystem* subsystem);
74
75 typedef UINT32 (*pfnShadowEnumMonitors)(MONITOR_DEF* monitors, UINT32 maxMonitors);
76
77 typedef int (*pfnShadowAuthenticate)(rdpShadowSubsystem* subsystem, rdpShadowClient* client,
78 const char* user, const char* domain,
79 const char* password);
80 typedef BOOL (*pfnShadowClientConnect)(rdpShadowSubsystem* subsystem, rdpShadowClient* client);
81 typedef void (*pfnShadowClientDisconnect)(rdpShadowSubsystem* subsystem,
82 rdpShadowClient* client);
83 typedef BOOL (*pfnShadowClientCapabilities)(rdpShadowSubsystem* subsystem,
84 rdpShadowClient* client);
85
86 typedef BOOL (*pfnShadowSynchronizeEvent)(rdpShadowSubsystem* subsystem,
87 rdpShadowClient* client, UINT32 flags);
88 typedef BOOL (*pfnShadowKeyboardEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client,
89 UINT16 flags, UINT8 code);
90 typedef BOOL (*pfnShadowUnicodeKeyboardEvent)(rdpShadowSubsystem* subsystem,
91 rdpShadowClient* client, UINT16 flags,
92 UINT16 code);
93 typedef BOOL (*pfnShadowMouseEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client,
94 UINT16 flags, UINT16 x, UINT16 y);
95 typedef BOOL (*pfnShadowRelMouseEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client,
96 UINT16 flags, INT16 xDelta,
97 INT16 yDelta);
99 typedef BOOL (*pfnShadowExtendedMouseEvent)(rdpShadowSubsystem* subsystem,
100 rdpShadowClient* client, UINT16 flags, UINT16 x,
101 UINT16 y);
102
103 typedef BOOL (*pfnShadowChannelAudinServerReceiveSamples)(rdpShadowSubsystem* subsystem,
104 rdpShadowClient* client,
105 const AUDIO_FORMAT* format,
106 wStream* data);
107
108 struct rdp_shadow_client
109 {
110 rdpContext context;
111
112 HANDLE thread;
113 BOOL activated;
114 BOOL first_frame;
115 BOOL inLobby;
116 BOOL mayView;
117 BOOL mayInteract;
118 BOOL suppressOutput;
119 UINT16 surfaceId;
120 wMessageQueue* MsgQueue;
121 CRITICAL_SECTION lock;
122 REGION16 invalidRegion;
123 rdpShadowServer* server;
124 rdpShadowEncoder* encoder;
125 rdpShadowSubsystem* subsystem;
126
127 UINT32 pointerX;
128 UINT32 pointerY;
129
130 HANDLE vcm;
131 EncomspServerContext* encomsp;
132 RemdeskServerContext* remdesk;
133 RdpsndServerContext* rdpsnd;
134#if defined(CHANNEL_AUDIN_SERVER)
135 audin_server_context* audin;
136#endif
137 RdpgfxServerContext* rdpgfx;
138
139 BOOL resizeRequested;
140 UINT32 resizeWidth;
141 UINT32 resizeHeight;
142 BOOL areGfxCapsReady;
143 RDPGFX_CAPSET confirmedCaps;
144 };
145
146 struct rdp_shadow_server
147 {
148 void* ext;
149 HANDLE thread;
150 HANDLE StopEvent;
151 wArrayList* clients;
152 rdpSettings* settings;
153 rdpShadowScreen* screen;
154 rdpShadowSurface* surface;
155 rdpShadowSurface* lobby;
156 rdpShadowCapture* capture;
157 rdpShadowSubsystem* subsystem;
158
159 DWORD port;
160 BOOL mayView;
161 BOOL mayInteract;
162 BOOL shareSubRect;
163 BOOL authentication;
164 UINT32 selectedMonitor;
165 RECTANGLE_16 subRect;
166
167 /* Codec settings */
168 RLGR_MODE rfxMode; /* unused */
169 H264_RATECONTROL_MODE h264RateControlMode;
170 UINT32 h264BitRate;
171 UINT32 h264FrameRate;
172 UINT32 h264QP;
173
174 char* ipcSocket;
175 char* ConfigPath;
176 char* CertificateFile;
177 char* PrivateKeyFile;
178 CRITICAL_SECTION lock;
179 freerdp_listener* listener;
180
181 size_t maxClientsConnected;
182 BOOL SupportMultiRectBitmapUpdates;
183 BOOL ShowMouseCursor;
184#if defined(WITH_GFX_AV1)
185 FREERDP_AV1_RATECONTROL AV1RateControlMode;
186 UINT32 AV1BitRate;
187#else
188 UINT32 reservedAV1[2];
189#endif
190 };
191
192 struct rdp_shadow_surface
193 {
194 rdpShadowServer* server;
195
196 UINT16 x;
197 UINT16 y;
198 UINT32 width;
199 UINT32 height;
200 UINT32 scanline;
201 DWORD format;
202 BYTE* data;
203
204 CRITICAL_SECTION lock;
205 REGION16 invalidRegion;
206 };
207
208 struct S_RDP_SHADOW_ENTRY_POINTS
209 {
210 WINPR_ATTR_NODISCARD pfnShadowSubsystemNew New;
211 pfnShadowSubsystemFree Free;
212
213 WINPR_ATTR_NODISCARD pfnShadowSubsystemInit Init;
214 pfnShadowSubsystemUninit Uninit;
215
216 WINPR_ATTR_NODISCARD pfnShadowSubsystemStart Start;
217 pfnShadowSubsystemStop Stop;
218
219 WINPR_ATTR_NODISCARD pfnShadowEnumMonitors EnumMonitors;
220 };
221
222 struct rdp_shadow_subsystem
223 {
224 RDP_SHADOW_ENTRY_POINTS ep;
225 HANDLE event;
226 UINT32 numMonitors;
227 UINT32 captureFrameRate;
228 UINT32 selectedMonitor;
229 MONITOR_DEF monitors[16];
230 MONITOR_DEF virtualScreen;
231
232 /* This event indicates that we have graphic change */
233 /* such as screen update and resize. It should not be */
234 /* used by subsystem implementation directly */
235 rdpShadowMultiClientEvent* updateEvent;
236
237 wMessagePipe* MsgPipe;
238 UINT32 pointerX;
239 UINT32 pointerY;
240
241 AUDIO_FORMAT* rdpsndFormats;
242 size_t nRdpsndFormats;
243 AUDIO_FORMAT* audinFormats;
244 size_t nAudinFormats;
245
246 WINPR_ATTR_NODISCARD pfnShadowSynchronizeEvent SynchronizeEvent;
247 WINPR_ATTR_NODISCARD pfnShadowKeyboardEvent KeyboardEvent;
248 WINPR_ATTR_NODISCARD pfnShadowUnicodeKeyboardEvent UnicodeKeyboardEvent;
249 WINPR_ATTR_NODISCARD pfnShadowMouseEvent MouseEvent;
250 WINPR_ATTR_NODISCARD pfnShadowExtendedMouseEvent ExtendedMouseEvent;
251 WINPR_ATTR_NODISCARD pfnShadowChannelAudinServerReceiveSamples AudinServerReceiveSamples;
252
253 WINPR_ATTR_NODISCARD pfnShadowAuthenticate Authenticate;
254 WINPR_ATTR_NODISCARD pfnShadowClientConnect ClientConnect;
255 pfnShadowClientDisconnect ClientDisconnect;
256 WINPR_ATTR_NODISCARD pfnShadowClientCapabilities ClientCapabilities;
257
258 rdpShadowServer* server;
259
260 WINPR_ATTR_NODISCARD pfnShadowRelMouseEvent RelMouseEvent;
261 };
262
263/* Definition of message between subsystem and clients */
264#define SHADOW_MSG_IN_REFRESH_REQUEST_ID 1001
265
266 typedef struct S_SHADOW_MSG_OUT SHADOW_MSG_OUT;
267 typedef void (*MSG_OUT_FREE_FN)(UINT32 id,
268 SHADOW_MSG_OUT* msg); /* function to free SHADOW_MSG_OUT */
269
270 struct S_SHADOW_MSG_OUT
271 {
272 int refCount;
273 MSG_OUT_FREE_FN Free;
274 };
275
276#define SHADOW_MSG_OUT_POINTER_POSITION_UPDATE_ID 2001
277#define SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE_ID 2002
278#define SHADOW_MSG_OUT_AUDIO_OUT_SAMPLES_ID 2003
279#define SHADOW_MSG_OUT_AUDIO_OUT_VOLUME_ID 2004
280
281 typedef struct
282 {
283 SHADOW_MSG_OUT common;
284 UINT32 xPos;
285 UINT32 yPos;
286 } SHADOW_MSG_OUT_POINTER_POSITION_UPDATE;
287
288 typedef struct
289 {
290 SHADOW_MSG_OUT common;
291 UINT32 xHot;
292 UINT32 yHot;
293 UINT32 width;
294 UINT32 height;
295 UINT32 lengthAndMask;
296 UINT32 lengthXorMask;
297 BYTE* xorMaskData;
298 BYTE* andMaskData;
299 } SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE;
300
301 typedef struct
302 {
303 SHADOW_MSG_OUT common;
304 AUDIO_FORMAT* audio_format;
305 void* buf;
306 size_t nFrames;
307 UINT16 wTimestamp;
308 } SHADOW_MSG_OUT_AUDIO_OUT_SAMPLES;
309
310 typedef struct
311 {
312 SHADOW_MSG_OUT common;
313 UINT16 left;
314 UINT16 right;
315 } SHADOW_MSG_OUT_AUDIO_OUT_VOLUME;
316
317 FREERDP_API void shadow_subsystem_set_entry_builtin(const char* name);
318 FREERDP_API void shadow_subsystem_set_entry(pfnShadowSubsystemEntry pEntry);
319
320#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
321 WINPR_DEPRECATED_VAR(
322 "[since 3.4.0] Use shadow_subsystem_pointer_convert_alpha_pointer_data_to_format instead",
323 WINPR_ATTR_NODISCARD FREERDP_API int shadow_subsystem_pointer_convert_alpha_pointer_data(
324 const BYTE* WINPR_RESTRICT pixels, BOOL premultiplied, UINT32 width, UINT32 height,
325 SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE* WINPR_RESTRICT pointerColor));
326#endif
327
341 WINPR_ATTR_NODISCARD
342 FREERDP_API int shadow_subsystem_pointer_convert_alpha_pointer_data_to_format(
343 const BYTE* WINPR_RESTRICT pixels, UINT32 format, BOOL premultiplied, UINT32 width,
344 UINT32 height, SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE* WINPR_RESTRICT pointerColor);
345
346 WINPR_ATTR_NODISCARD
347 FREERDP_API int shadow_server_parse_command_line(rdpShadowServer* server, int argc, char** argv,
348 COMMAND_LINE_ARGUMENT_A* cargs);
349
350 WINPR_ATTR_NODISCARD
351 FREERDP_API int shadow_server_command_line_status_print(rdpShadowServer* server, int argc,
352 char** argv, int status,
353 const COMMAND_LINE_ARGUMENT_A* cargs);
354
355 WINPR_ATTR_NODISCARD
356 FREERDP_API int shadow_server_start(rdpShadowServer* server);
357
358 FREERDP_API int shadow_server_stop(rdpShadowServer* server);
359
360 WINPR_ATTR_NODISCARD
361 FREERDP_API int shadow_server_init(rdpShadowServer* server);
362
363 FREERDP_API int shadow_server_uninit(rdpShadowServer* server);
364
365 WINPR_ATTR_NODISCARD
366 FREERDP_API UINT32 shadow_enum_monitors(MONITOR_DEF* monitors, UINT32 maxMonitors);
367
368 FREERDP_API void shadow_server_free(rdpShadowServer* server);
369
370 WINPR_ATTR_MALLOC(shadow_server_free, 1)
371 WINPR_ATTR_NODISCARD
372 FREERDP_API rdpShadowServer* shadow_server_new(void);
373
374 WINPR_ATTR_NODISCARD
375 FREERDP_API int shadow_capture_align_clip_rect(RECTANGLE_16* rect, const RECTANGLE_16* clip);
376
377#if !defined(WITHOUT_FREERDP_3x_DEPRECATED)
378 WINPR_DEPRECATED_VAR("[since 3.4.0] Use shadow_capture_compare_with_format",
379 WINPR_ATTR_NODISCARD FREERDP_API int shadow_capture_compare(
380 const BYTE* WINPR_RESTRICT pData1, UINT32 nStep1, UINT32 nWidth,
381 UINT32 nHeight, const BYTE* WINPR_RESTRICT pData2, UINT32 nStep2,
382 RECTANGLE_16* WINPR_RESTRICT rect));
383#endif
384
401 WINPR_ATTR_NODISCARD
402 FREERDP_API int shadow_capture_compare_with_format(const BYTE* WINPR_RESTRICT pData1,
403 UINT32 format1, UINT32 nStep1, UINT32 nWidth,
404 UINT32 nHeight,
405 const BYTE* WINPR_RESTRICT pData2,
406 UINT32 format2, UINT32 nStep2,
407 RECTANGLE_16* WINPR_RESTRICT rect);
408
409 FREERDP_API void shadow_subsystem_frame_update(rdpShadowSubsystem* subsystem);
410
411 WINPR_ATTR_NODISCARD
412 FREERDP_API BOOL shadow_client_post_msg(rdpShadowClient* client, void* context, UINT32 type,
413 SHADOW_MSG_OUT* msg, void* lParam);
414
415 WINPR_ATTR_NODISCARD
416 FREERDP_API int shadow_client_boardcast_msg(rdpShadowServer* server, void* context, UINT32 type,
417 SHADOW_MSG_OUT* msg, void* lParam);
418
419 WINPR_ATTR_NODISCARD
420 FREERDP_API int shadow_client_boardcast_quit(rdpShadowServer* server, int nExitCode);
421
422 WINPR_ATTR_NODISCARD
423 FREERDP_API UINT32 shadow_encoder_preferred_fps(rdpShadowEncoder* encoder);
424
425 WINPR_ATTR_NODISCARD
426 FREERDP_API UINT32 shadow_encoder_inflight_frames(rdpShadowEncoder* encoder);
427
428 WINPR_ATTR_NODISCARD
429 FREERDP_API BOOL shadow_screen_resize(rdpShadowScreen* screen);
430
431#ifdef __cplusplus
432}
433#endif
434
435#endif /* FREERDP_SERVER_SHADOW_H */
MONITOR_DEF
Definition settings_types.h:413
AUDIO_FORMAT
Definition audio.h:35
COMMAND_LINE_ARGUMENT_A
Definition winpr/include/winpr/cmdline.h:100
RDPGFX_CAPSET
Definition channels/rdpgfx.h:120
RECTANGLE_16
Definition types.h:109
RTL_CRITICAL_SECTION
Definition include/winpr/synch.h:160
SHADOW_MSG_OUT_AUDIO_OUT_SAMPLES
Definition include/freerdp/server/shadow.h:302
SHADOW_MSG_OUT_AUDIO_OUT_VOLUME
Definition include/freerdp/server/shadow.h:311
SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE
Definition include/freerdp/server/shadow.h:289
SHADOW_MSG_OUT_POINTER_POSITION_UPDATE
Definition include/freerdp/server/shadow.h:282
S_RDP_SHADOW_ENTRY_POINTS
Definition include/freerdp/server/shadow.h:209
S_SHADOW_MSG_OUT
Definition include/freerdp/server/shadow.h:271
rdp_shadow_capture
Definition shadow_capture.h:29
rdp_shadow_client
Definition include/freerdp/server/shadow.h:109
rdp_shadow_client::confirmedCaps
RDPGFX_CAPSET confirmedCaps
Definition include/freerdp/server/shadow.h:143
rdp_shadow_encoder
Definition shadow_encoder.h:31
rdp_shadow_screen
Definition shadow_screen.h:28
rdp_shadow_server
Definition include/freerdp/server/shadow.h:147
rdp_shadow_server::ShowMouseCursor
BOOL ShowMouseCursor
Definition include/freerdp/server/shadow.h:183
rdp_shadow_server::reservedAV1
UINT32 reservedAV1[2]
Definition include/freerdp/server/shadow.h:188
rdp_shadow_subsystem
Definition include/freerdp/server/shadow.h:223
rdp_shadow_surface
Definition include/freerdp/server/shadow.h:193