FreeRDP
Loading...
Searching...
No Matches
sdl_context.hpp
1
19#pragma once
20
21#include <map>
22#include <memory>
23#include <sstream>
24#include <vector>
25#include <mutex>
26#include <queue>
27#include <thread>
28#include <atomic>
29
30#include <freerdp/freerdp.h>
31
32#include <SDL3/SDL.h>
33
34#include <sdl_common_utils.hpp>
35
36#include "sdl_window.hpp"
37#include "sdl_disp.hpp"
38#include "sdl_clip.hpp"
39#include "sdl_input.hpp"
40#include "sdl_rail.hpp"
41
42#include "dialogs/sdl_connection_dialog_wrapper.hpp"
43
44class SdlContext
45{
46 public:
47 enum CursorType
48 {
49 CURSOR_NULL,
50 CURSOR_DEFAULT,
51 CURSOR_IMAGE
52 };
53
54 explicit SdlContext(rdpContext* context);
55 SdlContext(const SdlContext& other) = delete;
56 SdlContext(SdlContext&& other) = delete;
57 ~SdlContext() = default;
58
59 SdlContext& operator=(const SdlContext& other) = delete;
60 SdlContext& operator=(SdlContext&& other) = delete;
61
62 [[nodiscard]] bool redraw(bool suppress = false) const;
63
64 void setConnected(bool val);
65 [[nodiscard]] bool isConnected() const;
66 void cleanup();
67
68 [[nodiscard]] bool resizeable() const;
69 [[nodiscard]] bool toggleResizeable();
70 [[nodiscard]] bool setResizeable(bool enable);
71
72 [[nodiscard]] bool fullscreen() const;
73 [[nodiscard]] bool toggleFullscreen();
74 [[nodiscard]] bool setFullscreen(bool enter, bool forceOriginalDisplay = false);
75
76 [[nodiscard]] bool setMinimized();
77
78 [[nodiscard]] bool grabMouse() const;
79 [[nodiscard]] bool toggleGrabMouse();
80 [[nodiscard]] bool setGrabMouse(bool enter);
81
82 [[nodiscard]] bool grabKeyboard() const;
83 [[nodiscard]] bool toggleGrabKeyboard();
84 [[nodiscard]] bool setGrabKeyboard(bool enter);
85
86 [[nodiscard]] rdpContext* context() const;
87 [[nodiscard]] rdpClientContext* common() const;
88
89 [[nodiscard]] bool setCursor(CursorType type);
90 [[nodiscard]] bool setCursor(const rdpPointer* cursor);
91 [[nodiscard]] rdpPointer* cursor() const;
92 [[nodiscard]] bool restoreCursor();
93
94 void setMonitorIds(const std::vector<SDL_DisplayID>& ids);
95 [[nodiscard]] const std::vector<SDL_DisplayID>& monitorIds() const;
96 [[nodiscard]] int64_t monitorId(uint32_t index) const;
97
98 void push(std::vector<SDL_Rect>&& rects);
99 [[nodiscard]] std::vector<SDL_Rect> pop();
100
101 void setHasCursor(bool val);
102 [[nodiscard]] bool hasCursor() const;
103
104 void setMetadata();
105
106 [[nodiscard]] int start();
107 [[nodiscard]] int join();
108 [[nodiscard]] bool shallAbort(bool ignoreDialogs = false);
109
110 [[nodiscard]] bool createWindows();
111 [[nodiscard]] bool updateWindowList();
112 [[nodiscard]] bool updateWindow(SDL_WindowID id);
113
114 [[nodiscard]] bool drawToWindows(const std::vector<SDL_Rect>& rects = {});
115 [[nodiscard]] bool drawToWindow(SdlWindow& window, const std::vector<SDL_Rect>& rects = {});
116 [[nodiscard]] bool minimizeAllWindows();
117 [[nodiscard]] int exitCode() const;
118 [[nodiscard]] SDL_PixelFormat pixelFormat() const;
119
120 [[nodiscard]] const SdlWindow* getWindowForId(SDL_WindowID id) const;
121 [[nodiscard]] SdlWindow* getWindowForId(SDL_WindowID id);
122 [[nodiscard]] SdlWindow* getFirstWindow();
123
124 [[nodiscard]] bool addDisplayWindow(SDL_DisplayID id);
125 [[nodiscard]] bool removeDisplayWindow(SDL_DisplayID id);
126 [[nodiscard]] bool detectDisplays();
127 [[nodiscard]] rdpMonitor getDisplay(SDL_DisplayID id) const;
128 [[nodiscard]] std::vector<SDL_DisplayID> getDisplayIds() const;
129
130 [[nodiscard]] sdlDispContext& getDisplayChannelContext();
131 [[nodiscard]] sdlInput& getInputChannelContext();
132 [[nodiscard]] sdlClip& getClipboardChannelContext();
133 [[nodiscard]] SdlRail& getRailChannelContext();
134
135 [[nodiscard]] SdlConnectionDialogWrapper& getDialog();
136
137 [[nodiscard]] wLog* getWLog();
138
139 [[nodiscard]] bool moveMouseTo(const SDL_FPoint& pos);
140
141 [[nodiscard]] SDL_FPoint screenToPixel(SDL_WindowID id, const SDL_FPoint& pos);
142
143 [[nodiscard]] SDL_FPoint pixelToScreen(SDL_WindowID id, const SDL_FPoint& pos);
144 [[nodiscard]] SDL_FRect pixelToScreen(SDL_WindowID id, const SDL_FRect& pos,
145 bool round = false);
146
147 [[nodiscard]] bool handleEvent(const SDL_Event& ev);
148
149 [[nodiscard]] COMMAND_LINE_ARGUMENT_A* args();
150 [[nodiscard]] size_t argsCount() const;
151
152 [[nodiscard]] static int argumentHandler(const COMMAND_LINE_ARGUMENT_A* arg, void* custom);
153
154 [[nodiscard]] CriticalSection& lock();
155
156 [[nodiscard]] std::vector<rdpPointer*>& pointers();
157 [[nodiscard]] bool contains(const rdpPointer* ptr) const;
158
159 [[nodiscard]] bool credentialsRead() const;
160 void setCredentialsRead();
161
162 private:
163 [[nodiscard]] bool resizeToScale(SdlWindow* window);
164 [[nodiscard]] bool useLocalScale() const;
165
166 [[nodiscard]] static BOOL preConnect(freerdp* instance);
167 [[nodiscard]] static BOOL postConnect(freerdp* instance);
168 static void postDisconnect(freerdp* instance);
169 static void postFinalDisconnect(freerdp* instance);
170 [[nodiscard]] static BOOL getAccessToken(freerdp* instance, AccessTokenType tokenType,
171 char** token, size_t count, ...);
172 [[nodiscard]] static BOOL desktopResize(rdpContext* context);
173 [[nodiscard]] static BOOL playSound(rdpContext* context, const PLAY_SOUND_UPDATE* play_sound);
174 [[nodiscard]] static BOOL beginPaint(rdpContext* context);
175 [[nodiscard]] static BOOL endPaint(rdpContext* context);
176 [[nodiscard]] static DWORD WINAPI rdpThreadRun(SdlContext* sdl);
177
178 [[nodiscard]] bool eventToPixelCoordinates(SDL_WindowID id, SDL_Event& ev);
179
180 [[nodiscard]] SDL_FPoint applyLocalScaling(const SDL_FPoint& val) const;
181 void removeLocalScaling(float& x, float& y) const;
182
183 [[nodiscard]] bool handleEvent(const SDL_WindowEvent& ev);
184 [[nodiscard]] bool handleEvent(const SDL_DisplayEvent& ev);
185 [[nodiscard]] bool handleEvent(const SDL_MouseButtonEvent& ev);
186 [[nodiscard]] bool handleEvent(const SDL_MouseMotionEvent& ev);
187 [[nodiscard]] bool handleEvent(const SDL_MouseWheelEvent& ev);
188 [[nodiscard]] bool handleEvent(const SDL_TouchFingerEvent& ev);
189
190 void addOrUpdateDisplay(SDL_DisplayID id);
191 void deleteDisplay(SDL_DisplayID id);
192
193 [[nodiscard]] bool createPrimary();
194 [[nodiscard]] std::string windowTitle() const;
195 [[nodiscard]] bool waitForWindowsCreated();
196
197 void sdl_client_cleanup(int exit_code, const std::string& error_msg);
198 [[nodiscard]] int sdl_client_thread_connect(std::string& error_msg);
199 [[nodiscard]] int sdl_client_thread_run(std::string& error_msg);
200
201 [[nodiscard]] int error_info_to_error(DWORD* pcode, char** msg, size_t* len) const;
202
203 void applyMonitorOffset(SDL_WindowID window, float& x, float& y) const;
204
205 [[nodiscard]] std::vector<SDL_DisplayID>
206 updateDisplayOffsetsForNeighbours(SDL_DisplayID id,
207 const std::vector<SDL_DisplayID>& ignore = {});
208 void updateMonitorDataFromOffsets();
209
210 rdpContext* _context = nullptr;
211 wLog* _log = nullptr;
212
213 std::atomic<bool> _connected = false;
214 bool _cursor_visible = true;
215 std::unique_ptr<rdpPointer, void (*)(rdpPointer*)> _cursor;
216 CursorType _cursorType = CURSOR_NULL;
217 std::vector<SDL_DisplayID> _monitorIds;
218 std::mutex _queue_mux;
219 std::queue<std::vector<SDL_Rect>> _queue;
220 /* SDL */
221 bool _fullscreen = false;
222 bool _resizeable = false;
223 bool _grabMouse = false;
224 bool _grabKeyboard = false;
225 int _exitCode = -1;
226 std::atomic<bool> _rdpThreadRunning = false;
227 SDL_PixelFormat _sdlPixelFormat = SDL_PIXELFORMAT_UNKNOWN;
228
229 CriticalSection _critical;
230
231 using SDLSurfacePtr = std::unique_ptr<SDL_Surface, decltype(&SDL_DestroySurface)>;
232
233 SDLSurfacePtr _primary;
234 SDL_FPoint _localScale{ 1.0f, 1.0f };
235
236 sdlDispContext _disp;
237 sdlInput _input;
238 sdlClip _clip;
239 SdlRail _rail;
240
242
243 std::map<SDL_DisplayID, rdpMonitor> _displays;
244 std::map<SDL_WindowID, SdlWindow> _windows;
245 std::map<SDL_DisplayID, std::pair<SDL_Rect, SDL_Rect>> _offsets;
246
247 uint32_t _windowWidth = 0;
248 uint32_t _windowHeight = 0;
249 WinPREvent _windowsCreatedEvent;
250 std::thread _thread;
251 std::vector<COMMAND_LINE_ARGUMENT_A> _args;
252 std::vector<rdpPointer*> _valid_pointers;
253 bool _credentialsRead = false;
254};
object that handles clipboard context for the SDL3 client
Definition sdl_clip.hpp:76