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