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