FreeRDP
Loading...
Searching...
No Matches
SDL3/sdl_freerdp.cpp
1
20#include <iostream>
21#include <memory>
22#include <mutex>
23
24#include <freerdp/config.h>
25
26#include <cerrno>
27#include <cstdio>
28#include <cstring>
29
30#include <freerdp/constants.h>
31#include <freerdp/freerdp.h>
32#include <freerdp/gdi/gdi.h>
33#include <freerdp/streamdump.h>
34#include <freerdp/utils/signal.h>
35
36#include <freerdp/channels/channels.h>
37#include <freerdp/client/channels.h>
38#include <freerdp/client/cliprdr.h>
39#include <freerdp/client/cmdline.h>
40#include <freerdp/client/file.h>
41
42#include <freerdp/log.h>
43#include <winpr/assert.h>
44#include <winpr/config.h>
45#include <winpr/crt.h>
46#include <winpr/synch.h>
47
48#include <SDL3/SDL.h>
49#if !defined(__MINGW32__)
50#include <SDL3/SDL_main.h>
51#endif
52#include <SDL3/SDL_hints.h>
53#include <SDL3/SDL_oldnames.h>
54#include <SDL3/SDL_video.h>
55
56#include <sdl_config.hpp>
57
58#include "dialogs/sdl_connection_dialog_hider.hpp"
59#include "dialogs/sdl_dialogs.hpp"
60#include "scoped_guard.hpp"
61#include "sdl_channels.hpp"
62#include "sdl_disp.hpp"
63#include "sdl_freerdp.hpp"
64#include "sdl_kbd.hpp"
65#include "sdl_monitor.hpp"
66#include "sdl_pointer.hpp"
67#include "sdl_prefs.hpp"
68#include "sdl_touch.hpp"
69#include "sdl_utils.hpp"
70
71#if defined(WITH_WEBVIEW)
72#include <aad/sdl_webview.hpp>
73#endif
74
75#define SDL_TAG CLIENT_TAG("SDL")
76
77enum SDL_EXIT_CODE
78{
79 /* section 0-15: protocol-independent codes */
80 SDL_EXIT_SUCCESS = 0,
81 SDL_EXIT_DISCONNECT = 1,
82 SDL_EXIT_LOGOFF = 2,
83 SDL_EXIT_IDLE_TIMEOUT = 3,
84 SDL_EXIT_LOGON_TIMEOUT = 4,
85 SDL_EXIT_CONN_REPLACED = 5,
86 SDL_EXIT_OUT_OF_MEMORY = 6,
87 SDL_EXIT_CONN_DENIED = 7,
88 SDL_EXIT_CONN_DENIED_FIPS = 8,
89 SDL_EXIT_USER_PRIVILEGES = 9,
90 SDL_EXIT_FRESH_CREDENTIALS_REQUIRED = 10,
91 SDL_EXIT_DISCONNECT_BY_USER = 11,
92
93 /* section 16-31: license error set */
94 SDL_EXIT_LICENSE_INTERNAL = 16,
95 SDL_EXIT_LICENSE_NO_LICENSE_SERVER = 17,
96 SDL_EXIT_LICENSE_NO_LICENSE = 18,
97 SDL_EXIT_LICENSE_BAD_CLIENT_MSG = 19,
98 SDL_EXIT_LICENSE_HWID_DOESNT_MATCH = 20,
99 SDL_EXIT_LICENSE_BAD_CLIENT = 21,
100 SDL_EXIT_LICENSE_CANT_FINISH_PROTOCOL = 22,
101 SDL_EXIT_LICENSE_CLIENT_ENDED_PROTOCOL = 23,
102 SDL_EXIT_LICENSE_BAD_CLIENT_ENCRYPTION = 24,
103 SDL_EXIT_LICENSE_CANT_UPGRADE = 25,
104 SDL_EXIT_LICENSE_NO_REMOTE_CONNECTIONS = 26,
105
106 /* section 32-127: RDP protocol error set */
107 SDL_EXIT_RDP = 32,
108
109 /* section 128-254: xfreerdp specific exit codes */
110 SDL_EXIT_PARSE_ARGUMENTS = 128,
111 SDL_EXIT_MEMORY = 129,
112 SDL_EXIT_PROTOCOL = 130,
113 SDL_EXIT_CONN_FAILED = 131,
114 SDL_EXIT_AUTH_FAILURE = 132,
115 SDL_EXIT_NEGO_FAILURE = 133,
116 SDL_EXIT_LOGON_FAILURE = 134,
117 SDL_EXIT_ACCOUNT_LOCKED_OUT = 135,
118 SDL_EXIT_PRE_CONNECT_FAILED = 136,
119 SDL_EXIT_CONNECT_UNDEFINED = 137,
120 SDL_EXIT_POST_CONNECT_FAILED = 138,
121 SDL_EXIT_DNS_ERROR = 139,
122 SDL_EXIT_DNS_NAME_NOT_FOUND = 140,
123 SDL_EXIT_CONNECT_FAILED = 141,
124 SDL_EXIT_MCS_CONNECT_INITIAL_ERROR = 142,
125 SDL_EXIT_TLS_CONNECT_FAILED = 143,
126 SDL_EXIT_INSUFFICIENT_PRIVILEGES = 144,
127 SDL_EXIT_CONNECT_CANCELLED = 145,
128
129 SDL_EXIT_CONNECT_TRANSPORT_FAILED = 147,
130 SDL_EXIT_CONNECT_PASSWORD_EXPIRED = 148,
131 SDL_EXIT_CONNECT_PASSWORD_MUST_CHANGE = 149,
132 SDL_EXIT_CONNECT_KDC_UNREACHABLE = 150,
133 SDL_EXIT_CONNECT_ACCOUNT_DISABLED = 151,
134 SDL_EXIT_CONNECT_PASSWORD_CERTAINLY_EXPIRED = 152,
135 SDL_EXIT_CONNECT_CLIENT_REVOKED = 153,
136 SDL_EXIT_CONNECT_WRONG_PASSWORD = 154,
137 SDL_EXIT_CONNECT_ACCESS_DENIED = 155,
138 SDL_EXIT_CONNECT_ACCOUNT_RESTRICTION = 156,
139 SDL_EXIT_CONNECT_ACCOUNT_EXPIRED = 157,
140 SDL_EXIT_CONNECT_LOGON_TYPE_NOT_GRANTED = 158,
141 SDL_EXIT_CONNECT_NO_OR_MISSING_CREDENTIALS = 159,
142 SDL_EXIT_CONNECT_TARGET_BOOTING = 160,
143
144 SDL_EXIT_UNKNOWN = 255,
145};
146
147struct sdl_exit_code_map_t
148{
149 DWORD error;
150 int code;
151 const char* code_tag;
152};
153
154#define ENTRY(x, y) { x, y, #y }
155static const struct sdl_exit_code_map_t sdl_exit_code_map[] = {
156 ENTRY(FREERDP_ERROR_SUCCESS, SDL_EXIT_SUCCESS), ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_DISCONNECT),
157 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LOGOFF), ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_IDLE_TIMEOUT),
158 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LOGON_TIMEOUT),
159 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_CONN_REPLACED),
160 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_OUT_OF_MEMORY),
161 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_CONN_DENIED),
162 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_CONN_DENIED_FIPS),
163 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_USER_PRIVILEGES),
164 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_FRESH_CREDENTIALS_REQUIRED),
165 ENTRY(ERRINFO_LOGOFF_BY_USER, SDL_EXIT_DISCONNECT_BY_USER),
166 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_UNKNOWN),
167
168 /* section 16-31: license error set */
169 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_INTERNAL),
170 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_NO_LICENSE_SERVER),
171 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_NO_LICENSE),
172 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_BAD_CLIENT_MSG),
173 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_HWID_DOESNT_MATCH),
174 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_BAD_CLIENT),
175 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_CANT_FINISH_PROTOCOL),
176 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_CLIENT_ENDED_PROTOCOL),
177 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_BAD_CLIENT_ENCRYPTION),
178 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_CANT_UPGRADE),
179 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_NO_REMOTE_CONNECTIONS),
180 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_LICENSE_CANT_UPGRADE),
181
182 /* section 32-127: RDP protocol error set */
183 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_RDP),
184
185 /* section 128-254: xfreerdp specific exit codes */
186 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_PARSE_ARGUMENTS), ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_MEMORY),
187 ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_PROTOCOL), ENTRY(FREERDP_ERROR_NONE, SDL_EXIT_CONN_FAILED),
188
189 ENTRY(FREERDP_ERROR_AUTHENTICATION_FAILED, SDL_EXIT_AUTH_FAILURE),
190 ENTRY(FREERDP_ERROR_SECURITY_NEGO_CONNECT_FAILED, SDL_EXIT_NEGO_FAILURE),
191 ENTRY(FREERDP_ERROR_CONNECT_LOGON_FAILURE, SDL_EXIT_LOGON_FAILURE),
192 ENTRY(FREERDP_ERROR_CONNECT_TARGET_BOOTING, SDL_EXIT_CONNECT_TARGET_BOOTING),
193 ENTRY(FREERDP_ERROR_CONNECT_ACCOUNT_LOCKED_OUT, SDL_EXIT_ACCOUNT_LOCKED_OUT),
194 ENTRY(FREERDP_ERROR_PRE_CONNECT_FAILED, SDL_EXIT_PRE_CONNECT_FAILED),
195 ENTRY(FREERDP_ERROR_CONNECT_UNDEFINED, SDL_EXIT_CONNECT_UNDEFINED),
196 ENTRY(FREERDP_ERROR_POST_CONNECT_FAILED, SDL_EXIT_POST_CONNECT_FAILED),
197 ENTRY(FREERDP_ERROR_DNS_ERROR, SDL_EXIT_DNS_ERROR),
198 ENTRY(FREERDP_ERROR_DNS_NAME_NOT_FOUND, SDL_EXIT_DNS_NAME_NOT_FOUND),
199 ENTRY(FREERDP_ERROR_CONNECT_FAILED, SDL_EXIT_CONNECT_FAILED),
200 ENTRY(FREERDP_ERROR_MCS_CONNECT_INITIAL_ERROR, SDL_EXIT_MCS_CONNECT_INITIAL_ERROR),
201 ENTRY(FREERDP_ERROR_TLS_CONNECT_FAILED, SDL_EXIT_TLS_CONNECT_FAILED),
202 ENTRY(FREERDP_ERROR_INSUFFICIENT_PRIVILEGES, SDL_EXIT_INSUFFICIENT_PRIVILEGES),
203 ENTRY(FREERDP_ERROR_CONNECT_CANCELLED, SDL_EXIT_CONNECT_CANCELLED),
204 ENTRY(FREERDP_ERROR_CONNECT_TRANSPORT_FAILED, SDL_EXIT_CONNECT_TRANSPORT_FAILED),
205 ENTRY(FREERDP_ERROR_CONNECT_PASSWORD_EXPIRED, SDL_EXIT_CONNECT_PASSWORD_EXPIRED),
206 ENTRY(FREERDP_ERROR_CONNECT_PASSWORD_MUST_CHANGE, SDL_EXIT_CONNECT_PASSWORD_MUST_CHANGE),
207 ENTRY(FREERDP_ERROR_CONNECT_KDC_UNREACHABLE, SDL_EXIT_CONNECT_KDC_UNREACHABLE),
208 ENTRY(FREERDP_ERROR_CONNECT_ACCOUNT_DISABLED, SDL_EXIT_CONNECT_ACCOUNT_DISABLED),
209 ENTRY(FREERDP_ERROR_CONNECT_PASSWORD_CERTAINLY_EXPIRED,
210 SDL_EXIT_CONNECT_PASSWORD_CERTAINLY_EXPIRED),
211 ENTRY(FREERDP_ERROR_CONNECT_CLIENT_REVOKED, SDL_EXIT_CONNECT_CLIENT_REVOKED),
212 ENTRY(FREERDP_ERROR_CONNECT_WRONG_PASSWORD, SDL_EXIT_CONNECT_WRONG_PASSWORD),
213 ENTRY(FREERDP_ERROR_CONNECT_ACCESS_DENIED, SDL_EXIT_CONNECT_ACCESS_DENIED),
214 ENTRY(FREERDP_ERROR_CONNECT_ACCOUNT_RESTRICTION, SDL_EXIT_CONNECT_ACCOUNT_RESTRICTION),
215 ENTRY(FREERDP_ERROR_CONNECT_ACCOUNT_EXPIRED, SDL_EXIT_CONNECT_ACCOUNT_EXPIRED),
216 ENTRY(FREERDP_ERROR_CONNECT_LOGON_TYPE_NOT_GRANTED, SDL_EXIT_CONNECT_LOGON_TYPE_NOT_GRANTED),
217 ENTRY(FREERDP_ERROR_CONNECT_NO_OR_MISSING_CREDENTIALS,
218 SDL_EXIT_CONNECT_NO_OR_MISSING_CREDENTIALS)
219};
220
221static const struct sdl_exit_code_map_t* sdl_map_entry_by_code(int exit_code)
222{
223 for (const auto& x : sdl_exit_code_map)
224 {
225 const struct sdl_exit_code_map_t* cur = &x;
226 if (cur->code == exit_code)
227 return cur;
228 }
229 return nullptr;
230}
231
232static const struct sdl_exit_code_map_t* sdl_map_entry_by_error(UINT32 error)
233{
234 for (const auto& x : sdl_exit_code_map)
235 {
236 const struct sdl_exit_code_map_t* cur = &x;
237 if (cur->error == error)
238 return cur;
239 }
240 return nullptr;
241}
242
243static int sdl_map_error_to_exit_code(DWORD error)
244{
245 const struct sdl_exit_code_map_t* entry = sdl_map_entry_by_error(error);
246 if (entry)
247 return entry->code;
248
249 return SDL_EXIT_CONN_FAILED;
250}
251
252static const char* sdl_map_error_to_code_tag(UINT32 error)
253{
254 const struct sdl_exit_code_map_t* entry = sdl_map_entry_by_error(error);
255 if (entry)
256 return entry->code_tag;
257 return nullptr;
258}
259
260static const char* sdl_map_to_code_tag(int code)
261{
262 const struct sdl_exit_code_map_t* entry = sdl_map_entry_by_code(code);
263 if (entry)
264 return entry->code_tag;
265 return nullptr;
266}
267
268static int error_info_to_error(freerdp* instance, DWORD* pcode, char** msg, size_t* len)
269{
270 const DWORD code = freerdp_error_info(instance);
271 const char* name = freerdp_get_error_info_name(code);
272 const char* str = freerdp_get_error_info_string(code);
273 const int exit_code = sdl_map_error_to_exit_code(code);
274
275 winpr_asprintf(msg, len, "Terminate with %s due to ERROR_INFO %s [0x%08" PRIx32 "]: %s",
276 sdl_map_error_to_code_tag(code), name, code, str);
277 SDL_LogDebug(SDL_LOG_CATEGORY_APPLICATION, "%s", *msg);
278 if (pcode)
279 *pcode = code;
280 return exit_code;
281}
282
283/* This function is called whenever a new frame starts.
284 * It can be used to reset invalidated areas. */
285static BOOL sdl_begin_paint(rdpContext* context)
286{
287 auto gdi = context->gdi;
288 WINPR_ASSERT(gdi);
289 WINPR_ASSERT(gdi->primary);
290
291 HGDI_DC hdc = gdi->primary->hdc;
292 WINPR_ASSERT(hdc);
293 if (!hdc->hwnd)
294 return TRUE;
295
296 HGDI_WND hwnd = hdc->hwnd;
297 WINPR_ASSERT(hwnd->invalid);
298 hwnd->invalid->null = TRUE;
299 hwnd->ninvalid = 0;
300
301 return TRUE;
302}
303
304static bool sdl_draw_to_window_rect([[maybe_unused]] SdlContext* sdl, SdlWindow& window,
305 SDL_Surface* surface, SDL_Point offset, const SDL_Rect& srcRect)
306{
307 WINPR_ASSERT(surface);
308 SDL_Rect dstRect = { offset.x + srcRect.x, offset.y + srcRect.y, srcRect.w, srcRect.h };
309 return window.blit(surface, srcRect, dstRect);
310}
311
312static bool sdl_draw_to_window_rect(SdlContext* sdl, SdlWindow& window, SDL_Surface* surface,
313 SDL_Point offset, const std::vector<SDL_Rect>& rects = {})
314{
315 if (rects.empty())
316 {
317 return sdl_draw_to_window_rect(sdl, window, surface, offset,
318 { 0, 0, surface->w, surface->h });
319 }
320 for (auto& srcRect : rects)
321 {
322 if (!sdl_draw_to_window_rect(sdl, window, surface, offset, srcRect))
323 return false;
324 }
325 return true;
326}
327
328static bool sdl_draw_to_window_scaled_rect(SdlContext* sdl, SdlWindow& window, SDL_Surface* surface,
329 const SDL_Rect& srcRect)
330{
331 SDL_Rect dstRect = srcRect;
332 sdl_scale_coordinates(sdl, window.id(), &dstRect.x, &dstRect.y, FALSE, TRUE);
333 sdl_scale_coordinates(sdl, window.id(), &dstRect.w, &dstRect.h, FALSE, TRUE);
334 return window.blit(surface, srcRect, dstRect);
335}
336
337static BOOL sdl_draw_to_window_scaled_rect(SdlContext* sdl, SdlWindow& window, SDL_Surface* surface,
338 const std::vector<SDL_Rect>& rects = {})
339{
340 if (rects.empty())
341 {
342 return sdl_draw_to_window_scaled_rect(sdl, window, surface,
343 { 0, 0, surface->w, surface->h });
344 }
345 for (const auto& srcRect : rects)
346 {
347 if (!sdl_draw_to_window_scaled_rect(sdl, window, surface, srcRect))
348 return FALSE;
349 }
350 return TRUE;
351}
352
353static BOOL sdl_draw_to_window(SdlContext* sdl, SdlWindow& window,
354 const std::vector<SDL_Rect>& rects = {})
355{
356 WINPR_ASSERT(sdl);
357
358 if (!sdl->isConnected())
359 return TRUE;
360
361 auto context = sdl->context();
362 auto gdi = context->gdi;
363 WINPR_ASSERT(gdi);
364
365 auto size = window.rect();
366
367 auto surface = sdl->primary.get();
368 if (freerdp_settings_get_bool(context->settings, FreeRDP_SmartSizing))
369 {
370 window.setOffsetX(0);
371 window.setOffsetY(0);
372 if (gdi->width < size.w)
373 {
374 window.setOffsetX((size.w - gdi->width) / 2);
375 }
376 if (gdi->height < size.h)
377 {
378 window.setOffsetY((size.h - gdi->height) / 2);
379 }
380 if (!sdl_draw_to_window_scaled_rect(sdl, window, surface, rects))
381 return FALSE;
382 }
383 else
384 {
385
386 if (!sdl_draw_to_window_rect(sdl, window, surface, { window.offsetX(), window.offsetY() },
387 rects))
388 return FALSE;
389 }
390
391 window.updateSurface();
392 return TRUE;
393}
394
395static BOOL sdl_draw_to_window(SdlContext* sdl, std::map<Uint32, SdlWindow>& windows,
396 const std::vector<SDL_Rect>& rects = {})
397{
398 for (auto& window : windows)
399 {
400 if (!sdl_draw_to_window(sdl, window.second, rects))
401 return FALSE;
402 }
403
404 return TRUE;
405}
406
407/* This function is called when the library completed composing a new
408 * frame. Read out the changed areas and blit them to your output device.
409 * The image buffer will have the format specified by gdi_init
410 */
411static BOOL sdl_end_paint(rdpContext* context)
412{
413 auto sdl = get_context(context);
414 WINPR_ASSERT(sdl);
415
416 auto gdi = context->gdi;
417 WINPR_ASSERT(gdi);
418 WINPR_ASSERT(gdi->primary);
419
420 HGDI_DC hdc = gdi->primary->hdc;
421 WINPR_ASSERT(hdc);
422 if (!hdc->hwnd)
423 return TRUE;
424
425 HGDI_WND hwnd = hdc->hwnd;
426 WINPR_ASSERT(hwnd->invalid || (hwnd->ninvalid == 0));
427
428 if (hwnd->invalid->null)
429 return TRUE;
430
431 WINPR_ASSERT(hwnd->invalid);
432 if (gdi->suppressOutput || hwnd->invalid->null)
433 return TRUE;
434
435 const INT32 ninvalid = hwnd->ninvalid;
436 const GDI_RGN* cinvalid = hwnd->cinvalid;
437
438 if (ninvalid < 1)
439 return TRUE;
440
441 std::vector<SDL_Rect> rects;
442 for (INT32 x = 0; x < ninvalid; x++)
443 {
444 auto& rgn = cinvalid[x];
445 rects.push_back({ rgn.x, rgn.y, rgn.w, rgn.h });
446 }
447
448 sdl->push(std::move(rects));
449 return sdl_push_user_event(SDL_EVENT_USER_UPDATE);
450}
451
452static void sdl_destroy_primary(SdlContext* sdl)
453{
454 if (!sdl)
455 return;
456 sdl->primary.reset();
457}
458
459/* Create a SDL surface from the GDI buffer */
460static BOOL sdl_create_primary(SdlContext* sdl)
461{
462 rdpGdi* gdi = nullptr;
463
464 WINPR_ASSERT(sdl);
465
466 gdi = sdl->context()->gdi;
467 WINPR_ASSERT(gdi);
468
469 sdl_destroy_primary(sdl);
470 sdl->primary =
471 SDLSurfacePtr(SDL_CreateSurfaceFrom(static_cast<int>(gdi->width),
472 static_cast<int>(gdi->height), sdl->sdl_pixel_format,
473 gdi->primary_buffer, static_cast<int>(gdi->stride)),
474 SDL_DestroySurface);
475 if (!sdl->primary)
476 return FALSE;
477
478 SDL_SetSurfaceBlendMode(sdl->primary.get(), SDL_BLENDMODE_NONE);
479 SDL_Rect surfaceRect = { 0, 0, gdi->width, gdi->height };
480 SDL_FillSurfaceRect(sdl->primary.get(), &surfaceRect,
481 SDL_MapSurfaceRGBA(sdl->primary.get(), 0, 0, 0, 0xff));
482
483 return TRUE;
484}
485
486static BOOL sdl_desktop_resize(rdpContext* context)
487{
488 rdpGdi* gdi = nullptr;
489 rdpSettings* settings = nullptr;
490 auto sdl = get_context(context);
491
492 WINPR_ASSERT(sdl);
493 WINPR_ASSERT(context);
494
495 settings = context->settings;
496 WINPR_ASSERT(settings);
497
498 std::lock_guard<CriticalSection> lock(sdl->critical);
499 gdi = context->gdi;
500 if (!gdi_resize(gdi, freerdp_settings_get_uint32(settings, FreeRDP_DesktopWidth),
501 freerdp_settings_get_uint32(settings, FreeRDP_DesktopHeight)))
502 return FALSE;
503 return sdl_create_primary(sdl);
504}
505
506/* This function is called to output a System BEEP */
507static BOOL sdl_play_sound(rdpContext* context, const PLAY_SOUND_UPDATE* play_sound)
508{
509 /* TODO: Implement */
510 WINPR_UNUSED(context);
511 WINPR_UNUSED(play_sound);
512 return TRUE;
513}
514
515static BOOL sdl_wait_for_init(SdlContext* sdl)
516{
517 WINPR_ASSERT(sdl);
518 sdl->initialize.set();
519
520 HANDLE handles[] = { sdl->initialized.handle(), freerdp_abort_event(sdl->context()) };
521
522 const DWORD rc = WaitForMultipleObjects(ARRAYSIZE(handles), handles, FALSE, INFINITE);
523 switch (rc)
524 {
525 case WAIT_OBJECT_0:
526 return TRUE;
527 default:
528 return FALSE;
529 }
530}
531
532/* Called before a connection is established.
533 * Set all configuration options to support and load channels here. */
534static BOOL sdl_pre_connect(freerdp* instance)
535{
536 WINPR_ASSERT(instance);
537 WINPR_ASSERT(instance->context);
538
539 auto sdl = get_context(instance->context);
540
541 auto settings = instance->context->settings;
542 WINPR_ASSERT(settings);
543
544 if (!freerdp_settings_set_bool(settings, FreeRDP_CertificateCallbackPreferPEM, TRUE))
545 return FALSE;
546
547 /* Optional OS identifier sent to server */
548 if (!freerdp_settings_set_uint32(settings, FreeRDP_OsMajorType, OSMAJORTYPE_UNIX))
549 return FALSE;
550 if (!freerdp_settings_set_uint32(settings, FreeRDP_OsMinorType, OSMINORTYPE_NATIVE_SDL))
551 return FALSE;
552 /* OrderSupport is initialized at this point.
553 * Only override it if you plan to implement custom order
554 * callbacks or deactivate certain features. */
555 /* Register the channel listeners.
556 * They are required to set up / tear down channels if they are loaded. */
557 PubSub_SubscribeChannelConnected(instance->context->pubSub, sdl_OnChannelConnectedEventHandler);
558 PubSub_SubscribeChannelDisconnected(instance->context->pubSub,
559 sdl_OnChannelDisconnectedEventHandler);
560
561 if (!freerdp_settings_get_bool(settings, FreeRDP_AuthenticationOnly))
562 {
563 UINT32 maxWidth = 0;
564 UINT32 maxHeight = 0;
565
566 if (!sdl_wait_for_init(sdl))
567 return FALSE;
568
569 if (!sdl_detect_monitors(sdl, &maxWidth, &maxHeight))
570 return FALSE;
571
572 if ((maxWidth != 0) && (maxHeight != 0) &&
573 !freerdp_settings_get_bool(settings, FreeRDP_SmartSizing))
574 {
575 WLog_Print(sdl->log, WLOG_INFO, "Update size to %ux%u", maxWidth, maxHeight);
576 if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopWidth, maxWidth))
577 return FALSE;
578 if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopHeight, maxHeight))
579 return FALSE;
580 }
581 }
582 else
583 {
584 /* Check +auth-only has a username and password. */
585 if (!freerdp_settings_get_string(settings, FreeRDP_Password))
586 {
587 WLog_Print(sdl->log, WLOG_INFO, "auth-only, but no password set. Please provide one.");
588 return FALSE;
589 }
590
591 if (!freerdp_settings_set_bool(settings, FreeRDP_DeactivateClientDecoding, TRUE))
592 return FALSE;
593
594 WLog_Print(sdl->log, WLOG_INFO, "Authentication only. Don't connect SDL.");
595 }
596
597 if (!sdl->input.initialize())
598 return FALSE;
599
600 /* TODO: Any code your client requires */
601 return TRUE;
602}
603
604static const char* sdl_window_get_title(rdpSettings* settings)
605{
606 const char* windowTitle = nullptr;
607 UINT32 port = 0;
608 BOOL addPort = 0;
609 const char* name = nullptr;
610 const char* prefix = "FreeRDP:";
611
612 if (!settings)
613 return nullptr;
614
615 windowTitle = freerdp_settings_get_string(settings, FreeRDP_WindowTitle);
616 if (windowTitle)
617 return windowTitle;
618
619 name = freerdp_settings_get_server_name(settings);
620 port = freerdp_settings_get_uint32(settings, FreeRDP_ServerPort);
621
622 addPort = (port != 3389);
623
624 char buffer[MAX_PATH + 64] = {};
625
626 if (!addPort)
627 (void)sprintf_s(buffer, sizeof(buffer), "%s %s", prefix, name);
628 else
629 (void)sprintf_s(buffer, sizeof(buffer), "%s %s:%" PRIu32, prefix, name, port);
630
631 if (!freerdp_settings_set_string(settings, FreeRDP_WindowTitle, buffer))
632 return nullptr;
633 return freerdp_settings_get_string(settings, FreeRDP_WindowTitle);
634}
635
636static void sdl_term_handler([[maybe_unused]] int signum, [[maybe_unused]] const char* signame,
637 [[maybe_unused]] void* context)
638{
639 sdl_push_quit();
640}
641
642static void sdl_cleanup_sdl(SdlContext* sdl)
643{
644 if (!sdl)
645 return;
646
647 std::lock_guard<CriticalSection> lock(sdl->critical);
648 sdl->windows.clear();
649 sdl->dialog.destroy();
650
651 sdl_destroy_primary(sdl);
652
653 freerdp_del_signal_cleanup_handler(sdl->context(), sdl_term_handler);
654 sdl_dialogs_uninit();
655 SDL_Quit();
656}
657
658static BOOL sdl_create_windows(SdlContext* sdl)
659{
660 WINPR_ASSERT(sdl);
661
662 auto settings = sdl->context()->settings;
663 auto title = sdl_window_get_title(settings);
664
665 ScopeGuard guard1([&]() { sdl->windows_created.set(); });
666
667 UINT32 windowCount = freerdp_settings_get_uint32(settings, FreeRDP_MonitorCount);
668
669 Sint32 originX = 0;
670 Sint32 originY = 0;
671 for (UINT32 x = 0; x < windowCount; x++)
672 {
673 auto id = sdl->monitorId(x);
674 if (id < 0)
675 return FALSE;
676
677 auto monitor = static_cast<rdpMonitor*>(
678 freerdp_settings_get_pointer_array_writable(settings, FreeRDP_MonitorDefArray, x));
679
680 originX = std::min<Sint32>(monitor->x, originX);
681 originY = std::min<Sint32>(monitor->y, originY);
682 }
683
684 for (UINT32 x = 0; x < windowCount; x++)
685 {
686 auto id = sdl->monitorId(x);
687 if (id < 0)
688 return FALSE;
689
690 auto monitor = static_cast<rdpMonitor*>(
691 freerdp_settings_get_pointer_array_writable(settings, FreeRDP_MonitorDefArray, x));
692
693 auto w = WINPR_ASSERTING_INT_CAST(Uint32, monitor->width);
694 auto h = WINPR_ASSERTING_INT_CAST(Uint32, monitor->height);
695 if (!(freerdp_settings_get_bool(settings, FreeRDP_UseMultimon) ||
696 freerdp_settings_get_bool(settings, FreeRDP_Fullscreen)))
697 {
698 w = freerdp_settings_get_uint32(settings, FreeRDP_DesktopWidth);
699 h = freerdp_settings_get_uint32(settings, FreeRDP_DesktopHeight);
700 }
701
702 Uint32 flags = SDL_WINDOW_HIGH_PIXEL_DENSITY;
703 auto startupX = SDL_WINDOWPOS_CENTERED_DISPLAY(id);
704 auto startupY = SDL_WINDOWPOS_CENTERED_DISPLAY(id);
705
706 if (freerdp_settings_get_bool(settings, FreeRDP_Fullscreen) &&
707 !freerdp_settings_get_bool(settings, FreeRDP_UseMultimon))
708 {
709 flags |= SDL_WINDOW_FULLSCREEN;
710 }
711
712 if (freerdp_settings_get_bool(settings, FreeRDP_UseMultimon))
713 {
714 flags |= SDL_WINDOW_BORDERLESS;
715 }
716
717 if (!freerdp_settings_get_bool(settings, FreeRDP_Decorations))
718 flags |= SDL_WINDOW_BORDERLESS;
719
720 char buffer[MAX_PATH + 64] = {};
721 (void)sprintf_s(buffer, sizeof(buffer), "%s:%" PRIu32, title, x);
722 SdlWindow window{ buffer,
723 static_cast<int>(startupX),
724 static_cast<int>(startupY),
725 static_cast<int>(w),
726 static_cast<int>(h),
727 flags };
728 if (!window.window())
729 return FALSE;
730
731 if (freerdp_settings_get_bool(settings, FreeRDP_UseMultimon))
732 {
733 window.setOffsetX(originX - monitor->x);
734 window.setOffsetY(originY - monitor->y);
735 }
736
737 sdl->windows.insert({ window.id(), std::move(window) });
738 }
739
740 return TRUE;
741}
742
743static BOOL sdl_wait_create_windows(SdlContext* sdl)
744{
745 {
746 std::unique_lock<CriticalSection> lock(sdl->critical);
747 sdl->windows_created.clear();
748 if (!sdl_push_user_event(SDL_EVENT_USER_CREATE_WINDOWS, sdl))
749 return FALSE;
750 }
751
752 HANDLE handles[] = { sdl->windows_created.handle(), freerdp_abort_event(sdl->context()) };
753
754 const DWORD rc = WaitForMultipleObjects(ARRAYSIZE(handles), handles, FALSE, INFINITE);
755 switch (rc)
756 {
757 case WAIT_OBJECT_0:
758 return TRUE;
759 default:
760 return FALSE;
761 }
762}
763
764static bool shall_abort(SdlContext* sdl)
765{
766 std::lock_guard<CriticalSection> lock(sdl->critical);
767 if (freerdp_shall_disconnect_context(sdl->context()))
768 {
769 if (sdl->rdp_thread_running)
770 return false;
771 return !sdl->dialog.isRunning();
772 }
773 return false;
774}
775
776static int sdl_run(SdlContext* sdl)
777{
778 int rc = -1;
779 WINPR_ASSERT(sdl);
780
781 HANDLE handles[] = { sdl->initialize.handle(), freerdp_abort_event(sdl->context()) };
782 const DWORD status = WaitForMultipleObjects(ARRAYSIZE(handles), handles, FALSE, INFINITE);
783 switch (status)
784 {
785 case WAIT_OBJECT_0:
786 break;
787 default:
788 return 0;
789 }
790
791 SDL_Init(SDL_INIT_VIDEO | SDL_INIT_EVENTS);
792 auto backend = SDL_GetCurrentVideoDriver();
793 WLog_Print(sdl->log, WLOG_DEBUG, "client is using backend '%s'", backend);
794 sdl_dialogs_init();
795
796 SDL_SetHint(SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED, "0");
797 SDL_SetHint(SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR, "0");
798
799 freerdp_add_signal_cleanup_handler(sdl->context(), sdl_term_handler);
800 sdl->dialog.create(sdl->context());
801 sdl->dialog.setTitle("Connecting to '%s'",
802 freerdp_settings_get_server_name(sdl->context()->settings));
803 sdl->dialog.showInfo("The connection is being established\n\nPlease wait...");
804 if (!freerdp_settings_get_bool(sdl->context()->settings, FreeRDP_UseCommonStdioCallbacks))
805 {
806 sdl->dialog.show(true);
807 }
808
809 sdl->initialized.set();
810
811 while (!shall_abort(sdl))
812 {
813 SDL_Event windowEvent = {};
814 while (!shall_abort(sdl) && SDL_WaitEventTimeout(nullptr, 1000))
815 {
816 /* Only poll standard SDL events and SDL_EVENT_USERS meant to create
817 * dialogs. do not process the dialog return value events here.
818 */
819 const int prc = SDL_PeepEvents(&windowEvent, 1, SDL_GETEVENT, SDL_EVENT_FIRST,
820 SDL_EVENT_USER_RETRY_DIALOG);
821 if (prc < 0)
822 {
823 if (sdl_log_error(prc, sdl->log, "SDL_PeepEvents"))
824 continue;
825 }
826
827#if defined(WITH_DEBUG_SDL_EVENTS)
828 SDL_LogDebug(SDL_LOG_CATEGORY_APPLICATION, "got event %s [0x%08" PRIx32 "]",
829 sdl_event_type_str(windowEvent.type), windowEvent.type);
830#endif
831 {
832 std::lock_guard<CriticalSection> lock(sdl->critical);
833 /* The session might have been disconnected while we were waiting for a
834 * new SDL event. In that case ignore the SDL event and terminate. */
835 if (freerdp_shall_disconnect_context(sdl->context()))
836 continue;
837 }
838
839 if (sdl->dialog.handleEvent(windowEvent))
840 {
841 continue;
842 }
843
844 auto point2pix = [](Uint32 win_id, float& x, float& y)
845 {
846 auto win = SDL_GetWindowFromID(win_id);
847 if (win)
848 {
849 auto scale = SDL_GetWindowDisplayScale(win);
850 assert(scale);
851 x *= scale;
852 y *= scale;
853 }
854 };
855
856 switch (windowEvent.type)
857 {
858 case SDL_EVENT_QUIT:
859 freerdp_abort_connect_context(sdl->context());
860 break;
861 case SDL_EVENT_KEY_DOWN:
862 case SDL_EVENT_KEY_UP:
863 {
864 const SDL_KeyboardEvent* ev = &windowEvent.key;
865 sdl->input.keyboard_handle_event(ev);
866 }
867 break;
868 case SDL_EVENT_KEYMAP_CHANGED:
869 {
870 }
871 break; // TODO: Switch keyboard layout
872 case SDL_EVENT_MOUSE_MOTION:
873 {
874 SDL_MouseMotionEvent& ev = windowEvent.motion;
875 point2pix(ev.windowID, ev.x, ev.y);
876 point2pix(ev.windowID, ev.xrel, ev.yrel);
877 sdl_handle_mouse_motion(sdl, &ev);
878 }
879 break;
880 case SDL_EVENT_MOUSE_BUTTON_DOWN:
881 case SDL_EVENT_MOUSE_BUTTON_UP:
882 {
883 SDL_MouseButtonEvent& ev = windowEvent.button;
884 point2pix(ev.windowID, ev.x, ev.y);
885 sdl_handle_mouse_button(sdl, &ev);
886 }
887 break;
888 case SDL_EVENT_MOUSE_WHEEL:
889 {
890 const SDL_MouseWheelEvent* ev = &windowEvent.wheel;
891 sdl_handle_mouse_wheel(sdl, ev);
892 }
893 break;
894 case SDL_EVENT_FINGER_DOWN:
895 {
896 const SDL_TouchFingerEvent* ev = &windowEvent.tfinger;
897 sdl_handle_touch_down(sdl, ev);
898 }
899 break;
900 case SDL_EVENT_FINGER_UP:
901 {
902 const SDL_TouchFingerEvent* ev = &windowEvent.tfinger;
903 sdl_handle_touch_up(sdl, ev);
904 }
905 break;
906 case SDL_EVENT_FINGER_MOTION:
907 {
908 const SDL_TouchFingerEvent* ev = &windowEvent.tfinger;
909 sdl_handle_touch_motion(sdl, ev);
910 }
911 break;
912
913 case SDL_EVENT_RENDER_TARGETS_RESET:
914 (void)sdl->redraw();
915 break;
916 case SDL_EVENT_RENDER_DEVICE_RESET:
917 (void)sdl->redraw();
918 break;
919 case SDL_EVENT_WILL_ENTER_FOREGROUND:
920 (void)sdl->redraw();
921 break;
922 case SDL_EVENT_USER_CERT_DIALOG:
923 {
924 SDLConnectionDialogHider hider(sdl);
925 auto title = static_cast<const char*>(windowEvent.user.data1);
926 auto msg = static_cast<const char*>(windowEvent.user.data2);
927 sdl_cert_dialog_show(title, msg);
928 }
929 break;
930 case SDL_EVENT_USER_SHOW_DIALOG:
931 {
932 SDLConnectionDialogHider hider(sdl);
933 auto title = static_cast<const char*>(windowEvent.user.data1);
934 auto msg = static_cast<const char*>(windowEvent.user.data2);
935 sdl_message_dialog_show(title, msg, windowEvent.user.code);
936 }
937 break;
938 case SDL_EVENT_USER_SCARD_DIALOG:
939 {
940 SDLConnectionDialogHider hider(sdl);
941 auto title = static_cast<const char*>(windowEvent.user.data1);
942 auto msg = static_cast<const char**>(windowEvent.user.data2);
943 sdl_scard_dialog_show(title, windowEvent.user.code, msg);
944 }
945 break;
946 case SDL_EVENT_USER_AUTH_DIALOG:
947 {
948 SDLConnectionDialogHider hider(sdl);
949 sdl_auth_dialog_show(
950 reinterpret_cast<const SDL_UserAuthArg*>(windowEvent.padding));
951 }
952 break;
953 case SDL_EVENT_USER_UPDATE:
954 {
955 std::vector<SDL_Rect> rectangles;
956 do
957 {
958 rectangles = sdl->pop();
959 sdl_draw_to_window(sdl, sdl->windows, rectangles);
960 } while (!rectangles.empty());
961 }
962 break;
963 case SDL_EVENT_USER_CREATE_WINDOWS:
964 {
965 auto ctx = static_cast<SdlContext*>(windowEvent.user.data1);
966 sdl_create_windows(ctx);
967 }
968 break;
969 case SDL_EVENT_USER_WINDOW_RESIZEABLE:
970 {
971 auto window = static_cast<SdlWindow*>(windowEvent.user.data1);
972 const bool use = windowEvent.user.code != 0;
973 if (window)
974 window->resizeable(use);
975 }
976 break;
977 case SDL_EVENT_USER_WINDOW_FULLSCREEN:
978 {
979 auto window = static_cast<SdlWindow*>(windowEvent.user.data1);
980 const bool enter = windowEvent.user.code != 0;
981 if (window)
982 window->fullscreen(enter);
983 }
984 break;
985 case SDL_EVENT_USER_WINDOW_MINIMIZE:
986 for (auto& window : sdl->windows)
987 {
988 window.second.minimize();
989 }
990 break;
991 case SDL_EVENT_USER_POINTER_NULL:
992 SDL_HideCursor();
993 sdl->setCursor(nullptr);
994 sdl->setHasCursor(false);
995 break;
996 case SDL_EVENT_USER_POINTER_DEFAULT:
997 {
998 SDL_Cursor* def = SDL_GetDefaultCursor();
999 SDL_SetCursor(def);
1000 SDL_ShowCursor();
1001 sdl->setCursor(nullptr);
1002 sdl->setHasCursor(true);
1003 }
1004 break;
1005 case SDL_EVENT_USER_POINTER_POSITION:
1006 {
1007 const auto x =
1008 static_cast<INT32>(reinterpret_cast<uintptr_t>(windowEvent.user.data1));
1009 const auto y =
1010 static_cast<INT32>(reinterpret_cast<uintptr_t>(windowEvent.user.data2));
1011
1012 SDL_Window* window = SDL_GetMouseFocus();
1013 if (window)
1014 {
1015 const Uint32 id = SDL_GetWindowID(window);
1016
1017 INT32 sx = x;
1018 INT32 sy = y;
1019 if (sdl_scale_coordinates(sdl, id, &sx, &sy, FALSE, FALSE))
1020 SDL_WarpMouseInWindow(window, static_cast<float>(sx),
1021 static_cast<float>(sy));
1022 }
1023 }
1024 break;
1025 case SDL_EVENT_USER_POINTER_SET:
1026 sdl->setCursor(static_cast<rdpPointer*>(windowEvent.user.data1));
1027 sdl_Pointer_Set_Process(sdl);
1028 break;
1029 case SDL_EVENT_CLIPBOARD_UPDATE:
1030 sdl->clip.handle_update(windowEvent.clipboard);
1031 break;
1032 case SDL_EVENT_USER_QUIT:
1033 default:
1034 if ((windowEvent.type >= SDL_EVENT_DISPLAY_FIRST) &&
1035 (windowEvent.type <= SDL_EVENT_DISPLAY_LAST))
1036 {
1037 const SDL_DisplayEvent* ev = &windowEvent.display;
1038 (void)sdl->disp.handle_display_event(ev);
1039 }
1040 else if ((windowEvent.type >= SDL_EVENT_WINDOW_FIRST) &&
1041 (windowEvent.type <= SDL_EVENT_WINDOW_LAST))
1042 {
1043 const SDL_WindowEvent* ev = &windowEvent.window;
1044 auto window = sdl->windows.find(ev->windowID);
1045 if (window != sdl->windows.end())
1046 {
1047 (void)sdl->disp.handle_window_event(ev);
1048
1049 switch (ev->type)
1050 {
1051 case SDL_EVENT_WINDOW_DISPLAY_SCALE_CHANGED:
1052 if (sdl->isConnected())
1053 {
1054 sdl_Pointer_Set_Process(sdl);
1056 sdl->context()->settings,
1057 FreeRDP_DynamicResolutionUpdate))
1058 {
1059 break;
1060 }
1061 auto win = window->second.window();
1062 int w_pix{};
1063 int h_pix{};
1064 [[maybe_unused]] auto rcpix =
1065 SDL_GetWindowSizeInPixels(win, &w_pix, &h_pix);
1066 assert(rcpix);
1067 auto scale = SDL_GetWindowDisplayScale(win);
1068 if (scale <= SDL_FLT_EPSILON)
1069 {
1070 auto err = SDL_GetError();
1071 SDL_LogWarn(
1072 SDL_LOG_CATEGORY_APPLICATION,
1073 "SDL_GetWindowDisplayScale() failed with %s", err);
1074 }
1075 else
1076 {
1077 assert(SDL_isnanf(scale) == 0);
1078 assert(SDL_isinff(scale) == 0);
1079 assert(scale > SDL_FLT_EPSILON);
1080 auto w_gdi = sdl->context()->gdi->width;
1081 auto h_gdi = sdl->context()->gdi->height;
1082 auto pix2point = [=](int pix)
1083 {
1084 return static_cast<int>(static_cast<float>(pix) /
1085 scale);
1086 };
1087 if (w_pix != w_gdi || h_pix != h_gdi)
1088 {
1089 const auto ssws = SDL_SetWindowSize(
1090 win, pix2point(w_gdi), pix2point(h_gdi));
1091 if (!ssws)
1092 {
1093 auto err = SDL_GetError();
1094 SDL_LogWarn(
1095 SDL_LOG_CATEGORY_APPLICATION,
1096 "SDL_SetWindowSize() failed with %s", err);
1097 }
1098 }
1099 }
1100 }
1101 break;
1102 case SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED:
1103 window->second.fill();
1104 sdl_draw_to_window(sdl, window->second);
1105 sdl_Pointer_Set_Process(sdl);
1106 break;
1107 case SDL_EVENT_WINDOW_MOVED:
1108 {
1109 auto r = window->second.rect();
1110 auto id = window->second.id();
1111 SDL_LogDebug(SDL_LOG_CATEGORY_APPLICATION, "%u: %dx%d-%dx%d",
1112 id, r.x, r.y, r.w, r.h);
1113 }
1114 break;
1115 case SDL_EVENT_WINDOW_CLOSE_REQUESTED:
1116 {
1117 SDL_LogDebug(SDL_LOG_CATEGORY_APPLICATION,
1118 "Window closed, terminating RDP session...");
1119 freerdp_abort_connect_context(sdl->context());
1120 }
1121 break;
1122 default:
1123 break;
1124 }
1125 }
1126 }
1127 break;
1128 }
1129 }
1130 }
1131
1132 rc = 1;
1133
1134 sdl_cleanup_sdl(sdl);
1135 return rc;
1136}
1137
1138/* Called after a RDP connection was successfully established.
1139 * Settings might have changed during negotiation of client / server feature
1140 * support.
1141 *
1142 * Set up local framebuffers and paing callbacks.
1143 * If required, register pointer callbacks to change the local mouse cursor
1144 * when hovering over the RDP window
1145 */
1146static BOOL sdl_post_connect(freerdp* instance)
1147{
1148 WINPR_ASSERT(instance);
1149
1150 auto context = instance->context;
1151 WINPR_ASSERT(context);
1152
1153 auto sdl = get_context(context);
1154
1155 // Retry was successful, discard dialog
1156 sdl->dialog.show(false);
1157
1158 if (freerdp_settings_get_bool(context->settings, FreeRDP_AuthenticationOnly))
1159 {
1160 /* Check +auth-only has a username and password. */
1161 if (!freerdp_settings_get_string(context->settings, FreeRDP_Password))
1162 {
1163 WLog_Print(sdl->log, WLOG_INFO, "auth-only, but no password set. Please provide one.");
1164 return FALSE;
1165 }
1166
1167 WLog_Print(sdl->log, WLOG_INFO, "Authentication only. Don't connect to X.");
1168 return TRUE;
1169 }
1170
1171 if (!sdl_wait_create_windows(sdl))
1172 return FALSE;
1173
1174 sdl->sdl_pixel_format = SDL_PIXELFORMAT_BGRA32;
1175 if (!gdi_init(instance, PIXEL_FORMAT_BGRA32))
1176 return FALSE;
1177
1178 if (!sdl_create_primary(sdl))
1179 return FALSE;
1180
1181 if (!sdl_register_pointer(instance->context->graphics))
1182 return FALSE;
1183
1184 WINPR_ASSERT(context->update);
1185
1186 context->update->BeginPaint = sdl_begin_paint;
1187 context->update->EndPaint = sdl_end_paint;
1188 context->update->PlaySound = sdl_play_sound;
1189 context->update->DesktopResize = sdl_desktop_resize;
1190 context->update->SetKeyboardIndicators = sdlInput::keyboard_set_indicators;
1191 context->update->SetKeyboardImeStatus = sdlInput::keyboard_set_ime_status;
1192
1193 if (!sdl->update_resizeable(false))
1194 return FALSE;
1195 if (!sdl->update_fullscreen(freerdp_settings_get_bool(context->settings, FreeRDP_Fullscreen) ||
1196 freerdp_settings_get_bool(context->settings, FreeRDP_UseMultimon)))
1197 return FALSE;
1198 sdl->setConnected(true);
1199 return TRUE;
1200}
1201
1202/* This function is called whether a session ends by failure or success.
1203 * Clean up everything allocated by pre_connect and post_connect.
1204 */
1205static void sdl_post_disconnect(freerdp* instance)
1206{
1207 if (!instance)
1208 return;
1209
1210 if (!instance->context)
1211 return;
1212
1213 auto sdl = get_context(instance->context);
1214 sdl->setConnected(false);
1215
1216 gdi_free(instance);
1217}
1218
1219static void sdl_post_final_disconnect(freerdp* instance)
1220{
1221 if (!instance)
1222 return;
1223
1224 if (!instance->context)
1225 return;
1226
1227 PubSub_UnsubscribeChannelConnected(instance->context->pubSub,
1228 sdl_OnChannelConnectedEventHandler);
1229 PubSub_UnsubscribeChannelDisconnected(instance->context->pubSub,
1230 sdl_OnChannelDisconnectedEventHandler);
1231}
1232
1233static void sdl_client_cleanup(SdlContext* sdl, int exit_code, const std::string& error_msg)
1234{
1235 WINPR_ASSERT(sdl);
1236
1237 rdpContext* context = sdl->context();
1238 WINPR_ASSERT(context);
1239 rdpSettings* settings = context->settings;
1240 WINPR_ASSERT(settings);
1241
1242 sdl->rdp_thread_running = false;
1243 bool showError = false;
1244 if (freerdp_settings_get_bool(settings, FreeRDP_AuthenticationOnly))
1245 WLog_Print(sdl->log, WLOG_INFO, "Authentication only, exit status %s [%" PRId32 "]",
1246 sdl_map_to_code_tag(exit_code), exit_code);
1247 else
1248 {
1249 switch (exit_code)
1250 {
1251 case SDL_EXIT_SUCCESS:
1252 case SDL_EXIT_DISCONNECT:
1253 case SDL_EXIT_LOGOFF:
1254 case SDL_EXIT_DISCONNECT_BY_USER:
1255 case SDL_EXIT_CONNECT_CANCELLED:
1256 break;
1257 default:
1258 {
1259 sdl->dialog.showError(error_msg);
1260 }
1261 break;
1262 }
1263 }
1264
1265 if (!showError)
1266 sdl->dialog.show(false);
1267
1268 sdl->exit_code = exit_code;
1269 sdl_push_user_event(SDL_EVENT_USER_QUIT);
1270 SDL_CleanupTLS();
1271}
1272
1273static int sdl_client_thread_connect(SdlContext* sdl, std::string& error_msg)
1274{
1275 WINPR_ASSERT(sdl);
1276
1277 auto instance = sdl->context()->instance;
1278 WINPR_ASSERT(instance);
1279
1280 sdl->rdp_thread_running = true;
1281 BOOL rc = freerdp_connect(instance);
1282
1283 rdpContext* context = sdl->context();
1284 rdpSettings* settings = context->settings;
1285 WINPR_ASSERT(settings);
1286
1287 int exit_code = SDL_EXIT_SUCCESS;
1288 if (!rc)
1289 {
1290 UINT32 error = freerdp_get_last_error(context);
1291 exit_code = sdl_map_error_to_exit_code(error);
1292 }
1293
1294 if (freerdp_settings_get_bool(settings, FreeRDP_AuthenticationOnly))
1295 {
1296 DWORD code = freerdp_get_last_error(context);
1297 freerdp_abort_connect_context(context);
1298 WLog_Print(sdl->log, WLOG_ERROR, "Authentication only, %s [0x%08" PRIx32 "] %s",
1299 freerdp_get_last_error_name(code), code, freerdp_get_last_error_string(code));
1300 return exit_code;
1301 }
1302
1303 if (!rc)
1304 {
1305 DWORD code = freerdp_error_info(instance);
1306 if (exit_code == SDL_EXIT_SUCCESS)
1307 {
1308 char* msg = nullptr;
1309 size_t len = 0;
1310 exit_code = error_info_to_error(instance, &code, &msg, &len);
1311 if (msg)
1312 error_msg = msg;
1313 free(msg);
1314 }
1315
1316 auto last = freerdp_get_last_error(context);
1317 if (error_msg.empty())
1318 {
1319 char* msg = nullptr;
1320 size_t len = 0;
1321 winpr_asprintf(&msg, &len, "%s [0x%08" PRIx32 "]\n%s",
1322 freerdp_get_last_error_name(last), last,
1323 freerdp_get_last_error_string(last));
1324 if (msg)
1325 error_msg = msg;
1326 free(msg);
1327 }
1328
1329 if (exit_code == SDL_EXIT_SUCCESS)
1330 {
1331 if (last == FREERDP_ERROR_AUTHENTICATION_FAILED)
1332 exit_code = SDL_EXIT_AUTH_FAILURE;
1333 else if (code == ERRINFO_SUCCESS)
1334 exit_code = SDL_EXIT_CONN_FAILED;
1335 }
1336
1337 sdl->dialog.show(false);
1338 }
1339
1340 return exit_code;
1341}
1342
1343static int sdl_client_thread_run(SdlContext* sdl, std::string& error_msg)
1344{
1345 WINPR_ASSERT(sdl);
1346
1347 auto context = sdl->context();
1348 WINPR_ASSERT(context);
1349
1350 auto instance = context->instance;
1351 WINPR_ASSERT(instance);
1352
1353 int exit_code = SDL_EXIT_SUCCESS;
1354 while (!freerdp_shall_disconnect_context(context))
1355 {
1356 HANDLE handles[MAXIMUM_WAIT_OBJECTS] = {};
1357 /*
1358 * win8 and server 2k12 seem to have some timing issue/race condition
1359 * when a initial sync request is send to sync the keyboard indicators
1360 * sending the sync event twice fixed this problem
1361 */
1362 if (freerdp_focus_required(instance))
1363 {
1364 auto ctx = get_context(context);
1365 WINPR_ASSERT(ctx);
1366 if (!ctx->input.keyboard_focus_in())
1367 break;
1368 if (!ctx->input.keyboard_focus_in())
1369 break;
1370 }
1371
1372 const DWORD nCount = freerdp_get_event_handles(context, handles, ARRAYSIZE(handles));
1373
1374 if (nCount == 0)
1375 {
1376 WLog_Print(sdl->log, WLOG_ERROR, "freerdp_get_event_handles failed");
1377 break;
1378 }
1379
1380 const DWORD status = WaitForMultipleObjects(nCount, handles, FALSE, INFINITE);
1381
1382 if (status == WAIT_FAILED)
1383 break;
1384
1385 if (!freerdp_check_event_handles(context))
1386 {
1387 if (client_auto_reconnect(instance))
1388 {
1389 // Retry was successful, discard dialog
1390 sdl->dialog.show(false);
1391 continue;
1392 }
1393 else
1394 {
1395 /*
1396 * Indicate an unsuccessful connection attempt if reconnect
1397 * did not succeed and no other error was specified.
1398 */
1399 if (freerdp_error_info(instance) == 0)
1400 exit_code = SDL_EXIT_CONN_FAILED;
1401 }
1402
1403 if (freerdp_get_last_error(context) == FREERDP_ERROR_SUCCESS)
1404 WLog_Print(sdl->log, WLOG_ERROR, "WaitForMultipleObjects failed with %" PRIu32 "",
1405 status);
1406 if (freerdp_get_last_error(context) == FREERDP_ERROR_SUCCESS)
1407 WLog_Print(sdl->log, WLOG_ERROR, "Failed to check FreeRDP event handles");
1408 break;
1409 }
1410 }
1411
1412 if (exit_code == SDL_EXIT_SUCCESS)
1413 {
1414 DWORD code = 0;
1415 {
1416 char* emsg = nullptr;
1417 size_t elen = 0;
1418 exit_code = error_info_to_error(instance, &code, &emsg, &elen);
1419 if (emsg)
1420 error_msg = emsg;
1421 free(emsg);
1422 }
1423
1424 if ((code == ERRINFO_LOGOFF_BY_USER) &&
1425 (freerdp_get_disconnect_ultimatum(context) == Disconnect_Ultimatum_user_requested))
1426 {
1427 const char* msg = "Error info says user did not initiate but disconnect ultimatum says "
1428 "they did; treat this as a user logoff";
1429
1430 char* emsg = nullptr;
1431 size_t elen = 0;
1432 winpr_asprintf(&emsg, &elen, "%s", msg);
1433 if (emsg)
1434 error_msg = emsg;
1435 free(emsg);
1436
1437 /* This situation might be limited to Windows XP. */
1438 WLog_Print(sdl->log, WLOG_INFO, "%s", msg);
1439 exit_code = SDL_EXIT_LOGOFF;
1440 }
1441 }
1442
1443 freerdp_disconnect(instance);
1444
1445 return exit_code;
1446}
1447
1448/* RDP main loop.
1449 * Connects RDP, loops while running and handles event and dispatch, cleans up
1450 * after the connection ends. */
1451static DWORD WINAPI sdl_client_thread_proc(SdlContext* sdl)
1452{
1453 WINPR_ASSERT(sdl);
1454
1455 std::string error_msg;
1456 int exit_code = sdl_client_thread_connect(sdl, error_msg);
1457 if (exit_code == SDL_EXIT_SUCCESS)
1458 exit_code = sdl_client_thread_run(sdl, error_msg);
1459 sdl_client_cleanup(sdl, exit_code, error_msg);
1460
1461 return static_cast<DWORD>(exit_code);
1462}
1463
1464/* Optional global initializer.
1465 * Here we just register a signal handler to print out stack traces
1466 * if available. */
1467static BOOL sdl_client_global_init()
1468{
1469#if defined(_WIN32)
1470 WSADATA wsaData = {};
1471 const DWORD wVersionRequested = MAKEWORD(1, 1);
1472 const int rc = WSAStartup(wVersionRequested, &wsaData);
1473 if (rc != 0)
1474 {
1475 WLog_ERR(SDL_TAG, "WSAStartup failed with %s [%d]", gai_strerrorA(rc), rc);
1476 return FALSE;
1477 }
1478#endif
1479
1480 return (freerdp_handle_signals() == 0);
1481}
1482
1483/* Optional global tear down */
1484static void sdl_client_global_uninit()
1485{
1486#if defined(_WIN32)
1487 WSACleanup();
1488#endif
1489}
1490
1491static BOOL sdl_client_new(freerdp* instance, rdpContext* context)
1492{
1493 auto sdl = reinterpret_cast<sdl_rdp_context*>(context);
1494
1495 if (!instance || !context)
1496 return FALSE;
1497
1498 sdl->sdl = new SdlContext(context);
1499 if (!sdl->sdl)
1500 return FALSE;
1501
1502 instance->PreConnect = sdl_pre_connect;
1503 instance->PostConnect = sdl_post_connect;
1504 instance->PostDisconnect = sdl_post_disconnect;
1505 instance->PostFinalDisconnect = sdl_post_final_disconnect;
1506 instance->AuthenticateEx = sdl_authenticate_ex;
1507 instance->VerifyCertificateEx = sdl_verify_certificate_ex;
1508 instance->VerifyChangedCertificateEx = sdl_verify_changed_certificate_ex;
1509 instance->LogonErrorInfo = sdl_logon_error_info;
1510 instance->PresentGatewayMessage = sdl_present_gateway_message;
1511 instance->ChooseSmartcard = sdl_choose_smartcard;
1512 instance->RetryDialog = sdl_retry_dialog;
1513
1514#ifdef WITH_WEBVIEW
1515 instance->GetAccessToken = sdl_webview_get_access_token;
1516#else
1517 instance->GetAccessToken = client_cli_get_access_token;
1518#endif
1519 /* TODO: Client display set up */
1520
1521 return TRUE;
1522}
1523
1524static void sdl_client_free([[maybe_unused]] freerdp* instance, rdpContext* context)
1525{
1526 auto sdl = reinterpret_cast<sdl_rdp_context*>(context);
1527
1528 if (!context)
1529 return;
1530
1531 delete sdl->sdl;
1532}
1533
1534static int sdl_client_start(rdpContext* context)
1535{
1536 auto sdl = get_context(context);
1537 WINPR_ASSERT(sdl);
1538
1539 sdl->thread = std::thread(sdl_client_thread_proc, sdl);
1540 return 0;
1541}
1542
1543static int sdl_client_stop(rdpContext* context)
1544{
1545 auto sdl = get_context(context);
1546 WINPR_ASSERT(sdl);
1547
1548 /* We do not want to use freerdp_abort_connect_context here.
1549 * It would change the exit code and we do not want that. */
1550 HANDLE event = freerdp_abort_event(context);
1551 if (!SetEvent(event))
1552 return -1;
1553
1554 sdl->thread.join();
1555 return 0;
1556}
1557
1558static int RdpClientEntry(RDP_CLIENT_ENTRY_POINTS* pEntryPoints)
1559{
1560 WINPR_ASSERT(pEntryPoints);
1561
1562 ZeroMemory(pEntryPoints, sizeof(RDP_CLIENT_ENTRY_POINTS));
1563 pEntryPoints->Version = RDP_CLIENT_INTERFACE_VERSION;
1564 pEntryPoints->Size = sizeof(RDP_CLIENT_ENTRY_POINTS_V1);
1565 pEntryPoints->GlobalInit = sdl_client_global_init;
1566 pEntryPoints->GlobalUninit = sdl_client_global_uninit;
1567 pEntryPoints->ContextSize = sizeof(sdl_rdp_context);
1568 pEntryPoints->ClientNew = sdl_client_new;
1569 pEntryPoints->ClientFree = sdl_client_free;
1570 pEntryPoints->ClientStart = sdl_client_start;
1571 pEntryPoints->ClientStop = sdl_client_stop;
1572 return 0;
1573}
1574
1575static void context_free(sdl_rdp_context* sdl)
1576{
1577 if (sdl)
1578 freerdp_client_context_free(&sdl->common.context);
1579}
1580
1581static const char* category2str(int category)
1582{
1583 switch (category)
1584 {
1585 case SDL_LOG_CATEGORY_APPLICATION:
1586 return "SDL_LOG_CATEGORY_APPLICATION";
1587 case SDL_LOG_CATEGORY_ERROR:
1588 return "SDL_LOG_CATEGORY_ERROR";
1589 case SDL_LOG_CATEGORY_ASSERT:
1590 return "SDL_LOG_CATEGORY_ASSERT";
1591 case SDL_LOG_CATEGORY_SYSTEM:
1592 return "SDL_LOG_CATEGORY_SYSTEM";
1593 case SDL_LOG_CATEGORY_AUDIO:
1594 return "SDL_LOG_CATEGORY_AUDIO";
1595 case SDL_LOG_CATEGORY_VIDEO:
1596 return "SDL_LOG_CATEGORY_VIDEO";
1597 case SDL_LOG_CATEGORY_RENDER:
1598 return "SDL_LOG_CATEGORY_RENDER";
1599 case SDL_LOG_CATEGORY_INPUT:
1600 return "SDL_LOG_CATEGORY_INPUT";
1601 case SDL_LOG_CATEGORY_TEST:
1602 return "SDL_LOG_CATEGORY_TEST";
1603 case SDL_LOG_CATEGORY_GPU:
1604 return "SDL_LOG_CATEGORY_GPU";
1605 case SDL_LOG_CATEGORY_RESERVED2:
1606 return "SDL_LOG_CATEGORY_RESERVED2";
1607 case SDL_LOG_CATEGORY_RESERVED3:
1608 return "SDL_LOG_CATEGORY_RESERVED3";
1609 case SDL_LOG_CATEGORY_RESERVED4:
1610 return "SDL_LOG_CATEGORY_RESERVED4";
1611 case SDL_LOG_CATEGORY_RESERVED5:
1612 return "SDL_LOG_CATEGORY_RESERVED5";
1613 case SDL_LOG_CATEGORY_RESERVED6:
1614 return "SDL_LOG_CATEGORY_RESERVED6";
1615 case SDL_LOG_CATEGORY_RESERVED7:
1616 return "SDL_LOG_CATEGORY_RESERVED7";
1617 case SDL_LOG_CATEGORY_RESERVED8:
1618 return "SDL_LOG_CATEGORY_RESERVED8";
1619 case SDL_LOG_CATEGORY_RESERVED9:
1620 return "SDL_LOG_CATEGORY_RESERVED9";
1621 case SDL_LOG_CATEGORY_RESERVED10:
1622 return "SDL_LOG_CATEGORY_RESERVED10";
1623 case SDL_LOG_CATEGORY_CUSTOM:
1624 default:
1625 return "SDL_LOG_CATEGORY_CUSTOM";
1626 }
1627}
1628
1629static SDL_LogPriority wloglevel2dl(DWORD level)
1630{
1631 switch (level)
1632 {
1633 case WLOG_TRACE:
1634 return SDL_LOG_PRIORITY_VERBOSE;
1635 case WLOG_DEBUG:
1636 return SDL_LOG_PRIORITY_DEBUG;
1637 case WLOG_INFO:
1638 return SDL_LOG_PRIORITY_INFO;
1639 case WLOG_WARN:
1640 return SDL_LOG_PRIORITY_WARN;
1641 case WLOG_ERROR:
1642 return SDL_LOG_PRIORITY_ERROR;
1643 case WLOG_FATAL:
1644 return SDL_LOG_PRIORITY_CRITICAL;
1645 case WLOG_OFF:
1646 default:
1647 return SDL_LOG_PRIORITY_VERBOSE;
1648 }
1649}
1650
1651static DWORD sdlpriority2wlog(SDL_LogPriority priority)
1652{
1653 DWORD level = WLOG_OFF;
1654 switch (priority)
1655 {
1656 case SDL_LOG_PRIORITY_VERBOSE:
1657 level = WLOG_TRACE;
1658 break;
1659 case SDL_LOG_PRIORITY_DEBUG:
1660 level = WLOG_DEBUG;
1661 break;
1662 case SDL_LOG_PRIORITY_INFO:
1663 level = WLOG_INFO;
1664 break;
1665 case SDL_LOG_PRIORITY_WARN:
1666 level = WLOG_WARN;
1667 break;
1668 case SDL_LOG_PRIORITY_ERROR:
1669 level = WLOG_ERROR;
1670 break;
1671 case SDL_LOG_PRIORITY_CRITICAL:
1672 level = WLOG_FATAL;
1673 break;
1674 default:
1675 break;
1676 }
1677
1678 return level;
1679}
1680
1681static void SDLCALL winpr_LogOutputFunction(void* userdata, int category, SDL_LogPriority priority,
1682 const char* message)
1683{
1684 auto sdl = static_cast<SdlContext*>(userdata);
1685 WINPR_ASSERT(sdl);
1686
1687 const DWORD level = sdlpriority2wlog(priority);
1688 auto log = sdl->log;
1689 if (!WLog_IsLevelActive(log, level))
1690 return;
1691
1692 WLog_PrintTextMessage(log, level, __LINE__, __FILE__, __func__, "[%s] %s",
1693 category2str(category), message);
1694}
1695
1696int main(int argc, char* argv[])
1697{
1698 int rc = -1;
1699 int status = 0;
1700 RDP_CLIENT_ENTRY_POINTS clientEntryPoints = {};
1701
1702 RdpClientEntry(&clientEntryPoints);
1703 std::unique_ptr<sdl_rdp_context, void (*)(sdl_rdp_context*)> sdl_rdp(
1704 reinterpret_cast<sdl_rdp_context*>(freerdp_client_context_new(&clientEntryPoints)),
1705 context_free);
1706
1707 if (!sdl_rdp)
1708 return -1;
1709 auto sdl = sdl_rdp->sdl;
1710
1711 auto settings = sdl->context()->settings;
1712 WINPR_ASSERT(settings);
1713
1714 status = freerdp_client_settings_parse_command_line(settings, argc, argv, FALSE);
1715 sdl_rdp->sdl->setMetadata();
1716 if (status)
1717 {
1718 rc = freerdp_client_settings_command_line_status_print(settings, status, argc, argv);
1719 if (freerdp_settings_get_bool(settings, FreeRDP_ListMonitors))
1720 sdl_list_monitors(sdl);
1721 else
1722 {
1723 switch (status)
1724 {
1725 case COMMAND_LINE_STATUS_PRINT:
1726 case COMMAND_LINE_STATUS_PRINT_VERSION:
1727 case COMMAND_LINE_STATUS_PRINT_BUILDCONFIG:
1728 break;
1729 case COMMAND_LINE_STATUS_PRINT_HELP:
1730 default:
1731 SdlPref::print_config_file_help(3);
1732 break;
1733 }
1734 }
1735 return rc;
1736 }
1737
1738 SDL_SetLogOutputFunction(winpr_LogOutputFunction, sdl);
1739 auto level = WLog_GetLogLevel(sdl->log);
1740 SDL_SetLogPriorities(wloglevel2dl(level));
1741
1742 auto context = sdl->context();
1743 WINPR_ASSERT(context);
1744
1745 if (!stream_dump_register_handlers(context, CONNECTION_STATE_MCS_CREATE_REQUEST, FALSE))
1746 return -1;
1747
1748 if (freerdp_client_start(context) != 0)
1749 return -1;
1750
1751 rc = sdl_run(sdl);
1752
1753 if (freerdp_client_stop(context) != 0)
1754 return -1;
1755
1756 if (sdl->exit_code != 0)
1757 rc = sdl->exit_code;
1758
1759 return rc;
1760}
1761
1762bool SdlContext::update_fullscreen(bool enter)
1763{
1764 for (const auto& window : windows)
1765 {
1766 if (!sdl_push_user_event(SDL_EVENT_USER_WINDOW_FULLSCREEN, &window.second, enter))
1767 return false;
1768 }
1769 fullscreen = enter;
1770 return true;
1771}
1772
1773bool SdlContext::update_minimize()
1774{
1775 return sdl_push_user_event(SDL_EVENT_USER_WINDOW_MINIMIZE);
1776}
1777
1778bool SdlContext::update_resizeable(bool enable)
1779{
1780 const auto settings = context()->settings;
1781 const bool dyn = freerdp_settings_get_bool(settings, FreeRDP_DynamicResolutionUpdate);
1782 const bool smart = freerdp_settings_get_bool(settings, FreeRDP_SmartSizing);
1783 bool use = (dyn && enable) || smart;
1784
1785 for (const auto& window : windows)
1786 {
1787 if (!sdl_push_user_event(SDL_EVENT_USER_WINDOW_RESIZEABLE, &window.second, use))
1788 return false;
1789 }
1790 resizeable = use;
1791
1792 return true;
1793}
1794
1795SdlContext::SdlContext(rdpContext* context)
1796 : _context(context), log(WLog_Get(SDL_TAG)), disp(this), input(this), clip(this),
1797 primary(nullptr, SDL_DestroySurface), rdp_thread_running(false), dialog(log)
1798{
1799 WINPR_ASSERT(context);
1800 setMetadata();
1801}
1802
1803void SdlContext::setHasCursor(bool val)
1804{
1805 this->_cursor_visible = val;
1806}
1807
1808bool SdlContext::hasCursor() const
1809{
1810 return _cursor_visible;
1811}
1812
1813void SdlContext::setMetadata()
1814{
1815 auto wmclass = freerdp_settings_get_string(_context->settings, FreeRDP_WmClass);
1816 if (!wmclass || (strlen(wmclass) == 0))
1817 wmclass = SDL_CLIENT_UUID;
1818
1819 SDL_SetAppMetadataProperty(SDL_PROP_APP_METADATA_IDENTIFIER_STRING, wmclass);
1820 SDL_SetAppMetadataProperty(SDL_PROP_APP_METADATA_NAME_STRING, SDL_CLIENT_NAME);
1821 SDL_SetAppMetadataProperty(SDL_PROP_APP_METADATA_VERSION_STRING, SDL_CLIENT_VERSION);
1822 SDL_SetAppMetadataProperty(SDL_PROP_APP_METADATA_CREATOR_STRING, SDL_CLIENT_VENDOR);
1823 SDL_SetAppMetadataProperty(SDL_PROP_APP_METADATA_COPYRIGHT_STRING, SDL_CLIENT_COPYRIGHT);
1824 SDL_SetAppMetadataProperty(SDL_PROP_APP_METADATA_URL_STRING, SDL_CLIENT_URL);
1825 SDL_SetAppMetadataProperty(SDL_PROP_APP_METADATA_TYPE_STRING, SDL_CLIENT_TYPE);
1826}
1827
1828bool SdlContext::redraw(bool suppress) const
1829{
1830 if (!_connected)
1831 return true;
1832
1833 auto gdi = context()->gdi;
1834 WINPR_ASSERT(gdi);
1835 return gdi_send_suppress_output(gdi, suppress);
1836}
1837
1838void SdlContext::setConnected(bool val)
1839{
1840 _connected = val;
1841}
1842
1843bool SdlContext::isConnected() const
1844{
1845 return _connected;
1846}
1847
1848rdpContext* SdlContext::context() const
1849{
1850 WINPR_ASSERT(_context);
1851 return _context;
1852}
1853
1854rdpClientContext* SdlContext::common() const
1855{
1856 return reinterpret_cast<rdpClientContext*>(context());
1857}
1858
1859void SdlContext::setCursor(rdpPointer* cursor)
1860{
1861 _cursor = cursor;
1862}
1863
1864rdpPointer* SdlContext::cursor() const
1865{
1866 return _cursor;
1867}
1868
1869void SdlContext::setMonitorIds(const std::vector<SDL_DisplayID>& ids)
1870{
1871 _monitorIds.clear();
1872 for (auto id : ids)
1873 {
1874 _monitorIds.push_back(id);
1875 }
1876}
1877
1878const std::vector<SDL_DisplayID>& SdlContext::monitorIds() const
1879{
1880 return _monitorIds;
1881}
1882
1883int64_t SdlContext::monitorId(uint32_t index) const
1884{
1885 if (index >= _monitorIds.size())
1886 {
1887 return -1;
1888 }
1889 return _monitorIds[index];
1890}
1891
1892void SdlContext::push(std::vector<SDL_Rect>&& rects)
1893{
1894 std::unique_lock lock(_queue_mux);
1895 _queue.emplace(std::move(rects));
1896}
1897
1898std::vector<SDL_Rect> SdlContext::pop()
1899{
1900 std::unique_lock lock(_queue_mux);
1901 if (_queue.empty())
1902 {
1903 return {};
1904 }
1905 auto val = std::move(_queue.front());
1906 _queue.pop();
1907 return val;
1908}
FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *param)
Sets a string settings value. The param is copied.
FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
FREERDP_API const char * freerdp_settings_get_server_name(const rdpSettings *settings)
A helper function to return the correct server name.
FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 param)
Sets a UINT32 settings value.
FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL param)
Sets a BOOL settings value.