FreeRDP
Loading...
Searching...
No Matches
surface.c
1
20#include <freerdp/config.h>
21
22#include "settings.h"
23
24#include <winpr/assert.h>
25#include <winpr/cast.h>
26
27#include <freerdp/utils/pcap.h>
28#include <freerdp/log.h>
29
30#include "../cache/cache.h"
31#include "surface.h"
32
33#define TAG FREERDP_TAG("core.surface")
34
35static BOOL update_recv_surfcmd_bitmap_header_ex(wStream* s, TS_COMPRESSED_BITMAP_HEADER_EX* header)
36{
37 if (!s || !header)
38 return FALSE;
39
40 if (!Stream_CheckAndLogRequiredLength(TAG, s, 24))
41 return FALSE;
42
43 Stream_Read_UINT32(s, header->highUniqueId);
44 Stream_Read_UINT32(s, header->lowUniqueId);
45 Stream_Read_UINT64(s, header->tmMilliseconds);
46 Stream_Read_UINT64(s, header->tmSeconds);
47 return TRUE;
48}
49
50static BOOL update_recv_surfcmd_bitmap_ex(wStream* s, TS_BITMAP_DATA_EX* bmp)
51{
52 if (!s || !bmp)
53 return FALSE;
54
55 if (!Stream_CheckAndLogRequiredLength(TAG, s, 12))
56 return FALSE;
57
58 Stream_Read_UINT8(s, bmp->bpp);
59 Stream_Read_UINT8(s, bmp->flags);
60 Stream_Seek(s, 1); /* reserved */
61 Stream_Read_UINT8(s, bmp->codecID);
62 Stream_Read_UINT16(s, bmp->width);
63 Stream_Read_UINT16(s, bmp->height);
64 Stream_Read_UINT32(s, bmp->bitmapDataLength);
65
66 if ((bmp->width == 0) || (bmp->height == 0))
67 {
68 WLog_ERR(TAG, "invalid size value width=%" PRIu16 ", height=%" PRIu16, bmp->width,
69 bmp->height);
70 return FALSE;
71 }
72
73 if ((bmp->bpp < 1) || (bmp->bpp > 32))
74 {
75 WLog_ERR(TAG, "invalid bpp value %" PRIu32 "", bmp->bpp);
76 return FALSE;
77 }
78
79 if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
80 {
81 if (!update_recv_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
82 return FALSE;
83 }
84
85 bmp->bitmapData = Stream_Pointer(s);
86 if (!Stream_SafeSeek(s, bmp->bitmapDataLength))
87 {
88 WLog_ERR(TAG, "expected bitmapDataLength %" PRIu32 ", not enough data",
89 bmp->bitmapDataLength);
90 return FALSE;
91 }
92 return TRUE;
93}
94
95static BOOL update_recv_surfcmd_is_rect_valid(const rdpContext* context,
96 const SURFACE_BITS_COMMAND* cmd)
97{
98 WINPR_ASSERT(context);
99 WINPR_ASSERT(context->settings);
100 WINPR_ASSERT(cmd);
101
102 /* We need a rectangle with left/top being smaller than right/bottom.
103 * Also do not allow empty rectangles. */
104 if ((cmd->destTop >= cmd->destBottom) || (cmd->destLeft >= cmd->destRight))
105 {
106 WLog_WARN(TAG,
107 "Empty surface bits command rectangle: %" PRIu16 "x%" PRIu16 "-%" PRIu16
108 "x%" PRIu16,
109 cmd->destLeft, cmd->destTop, cmd->destRight, cmd->destBottom);
110 return FALSE;
111 }
112
113 /* The rectangle needs to fit into our session size */
114 const DWORD DesktopWidth = freerdp_settings_get_uint32(context->settings, FreeRDP_DesktopWidth);
115 const DWORD DesktopHeight =
116 freerdp_settings_get_uint32(context->settings, FreeRDP_DesktopHeight);
117 if ((cmd->destRight > DesktopWidth) || (cmd->destBottom > DesktopHeight))
118 {
119 WLog_WARN(TAG,
120 "Invalid surface bits command rectangle: %" PRIu16 "x%" PRIu16 "-%" PRIu16
121 "x%" PRIu16 " does not fit %" PRIu32 "x%" PRIu32,
122 cmd->destLeft, cmd->destTop, cmd->destRight, cmd->destBottom, DesktopWidth,
123 DesktopHeight);
124 return FALSE;
125 }
126
127 return TRUE;
128}
129
130static BOOL update_recv_surfcmd_surface_bits(rdpUpdate* update, wStream* s, UINT16 cmdType)
131{
132 BOOL rc = FALSE;
133 SURFACE_BITS_COMMAND cmd = WINPR_C_ARRAY_INIT;
134
135 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
136 goto fail;
137
138 cmd.cmdType = cmdType;
139 Stream_Read_UINT16(s, cmd.destLeft);
140 Stream_Read_UINT16(s, cmd.destTop);
141 Stream_Read_UINT16(s, cmd.destRight);
142 Stream_Read_UINT16(s, cmd.destBottom);
143
144 if (!update_recv_surfcmd_is_rect_valid(update->context, &cmd))
145 goto fail;
146
147 if (!update_recv_surfcmd_bitmap_ex(s, &cmd.bmp))
148 goto fail;
149
150 if (!IFCALLRESULT(TRUE, update->SurfaceBits, update->context, &cmd))
151 {
152 WLog_DBG(TAG, "update->SurfaceBits implementation failed");
153 goto fail;
154 }
155
156 rc = TRUE;
157fail:
158 return rc;
159}
160
161static BOOL update_recv_surfcmd_frame_marker(rdpUpdate* update, wStream* s)
162{
163 SURFACE_FRAME_MARKER marker = WINPR_C_ARRAY_INIT;
164 rdp_update_internal* up = update_cast(update);
165
166 WINPR_ASSERT(s);
167
168 if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
169 return FALSE;
170
171 Stream_Read_UINT16(s, marker.frameAction);
172 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
173 WLog_WARN(TAG,
174 "[SERVER-BUG]: got %" PRIuz ", expected %u"
175 " bytes. [MS-RDPBCGR] 2.2.9.2.3 Frame Marker Command (TS_FRAME_MARKER) is "
176 "missing frameId, ignoring",
177 Stream_GetRemainingLength(s), 4u);
178 else
179 Stream_Read_UINT32(s, marker.frameId);
180 WLog_Print(up->log, WLOG_DEBUG, "SurfaceFrameMarker: action: %s (%" PRIu32 ") id: %" PRIu32 "",
181 (!marker.frameAction) ? "Begin" : "End", marker.frameAction, marker.frameId);
182
183 if (!update->SurfaceFrameMarker)
184 {
185 WINPR_ASSERT(update->context);
186 if (freerdp_settings_get_bool(update->context->settings, FreeRDP_DeactivateClientDecoding))
187 return TRUE;
188 WLog_ERR(TAG, "Missing callback update->SurfaceFrameMarker");
189 return FALSE;
190 }
191
192 if (!update->SurfaceFrameMarker(update->context, &marker))
193 {
194 WLog_DBG(TAG, "update->SurfaceFrameMarker implementation failed");
195 return FALSE;
196 }
197
198 return TRUE;
199}
200
201BOOL update_recv_surfcmds(rdpUpdate* update, wStream* s)
202{
203 UINT16 cmdType = 0;
204 rdp_update_internal* up = update_cast(update);
205
206 WINPR_ASSERT(s);
207
208 while (Stream_GetRemainingLength(s) >= 2)
209 {
210 const size_t start = Stream_GetPosition(s);
211 const BYTE* mark = Stream_ConstPointer(s);
212
213 Stream_Read_UINT16(s, cmdType);
214
215 switch (cmdType)
216 {
217 case CMDTYPE_SET_SURFACE_BITS:
218 case CMDTYPE_STREAM_SURFACE_BITS:
219 if (!update_recv_surfcmd_surface_bits(update, s, cmdType))
220 return FALSE;
221
222 break;
223
224 case CMDTYPE_FRAME_MARKER:
225 if (!update_recv_surfcmd_frame_marker(update, s))
226 return FALSE;
227
228 break;
229
230 default:
231 WLog_ERR(TAG, "unknown cmdType 0x%04" PRIX16 "", cmdType);
232 return FALSE;
233 }
234
235 if (up->dump_rfx)
236 {
237 const size_t size = Stream_GetPosition(s) - start;
238 /* TODO: treat return values */
239 if (!pcap_add_record(up->pcap_rfx, mark, size))
240 return FALSE;
241 pcap_flush(up->pcap_rfx);
242 }
243 }
244
245 return TRUE;
246}
247
248static BOOL update_write_surfcmd_bitmap_header_ex(wStream* s,
249 const TS_COMPRESSED_BITMAP_HEADER_EX* header)
250{
251 if (!s || !header)
252 return FALSE;
253
254 if (!Stream_EnsureRemainingCapacity(s, 24))
255 return FALSE;
256
257 Stream_Write_UINT32(s, header->highUniqueId);
258 Stream_Write_UINT32(s, header->lowUniqueId);
259 Stream_Write_UINT64(s, header->tmMilliseconds);
260 Stream_Write_UINT64(s, header->tmSeconds);
261 return TRUE;
262}
263
264static BOOL update_write_surfcmd_bitmap_ex(wStream* s, const TS_BITMAP_DATA_EX* bmp)
265{
266 if (!s || !bmp)
267 return FALSE;
268
269 if (!Stream_EnsureRemainingCapacity(s, 12))
270 return FALSE;
271
272 if (bmp->codecID > UINT8_MAX)
273 {
274 WLog_ERR(TAG, "Invalid TS_BITMAP_DATA_EX::codecID=0x%04" PRIx16 "", bmp->codecID);
275 return FALSE;
276 }
277 Stream_Write_UINT8(s, bmp->bpp);
278 Stream_Write_UINT8(s, bmp->flags);
279 Stream_Write_UINT8(s, 0); /* reserved1, reserved2 */
280 Stream_Write_UINT8(s, (UINT8)bmp->codecID);
281 Stream_Write_UINT16(s, bmp->width);
282 Stream_Write_UINT16(s, bmp->height);
283 Stream_Write_UINT32(s, bmp->bitmapDataLength);
284
285 if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
286 {
287 if (!update_write_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
288 return FALSE;
289 }
290
291 if (!Stream_EnsureRemainingCapacity(s, bmp->bitmapDataLength))
292 return FALSE;
293
294 Stream_Write(s, bmp->bitmapData, bmp->bitmapDataLength);
295 return TRUE;
296}
297
298BOOL update_write_surfcmd_surface_bits(wStream* s, const SURFACE_BITS_COMMAND* cmd)
299{
300 if (!Stream_EnsureRemainingCapacity(s, SURFCMD_SURFACE_BITS_HEADER_LENGTH))
301 return FALSE;
302
303 WINPR_ASSERT(cmd->cmdType <= UINT16_MAX);
304 UINT16 cmdType = (UINT16)cmd->cmdType;
305 switch (cmdType)
306 {
307 case CMDTYPE_SET_SURFACE_BITS:
308 case CMDTYPE_STREAM_SURFACE_BITS:
309 break;
310 default:
311 {
312 const UINT16 defaultCmdType = CMDTYPE_STREAM_SURFACE_BITS;
313 WLog_WARN(TAG,
314 "SURFACE_BITS_COMMAND->cmdType 0x%04" PRIx16
315 " not allowed, correcting to 0x%04" PRIx16,
316 cmdType, defaultCmdType);
317 cmdType = defaultCmdType;
318 }
319 break;
320 }
321
322 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmdType));
323 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destLeft));
324 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destTop));
325 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destRight));
326 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destBottom));
327 return update_write_surfcmd_bitmap_ex(s, &cmd->bmp);
328}
329
330BOOL update_write_surfcmd_frame_marker(wStream* s, UINT16 frameAction, UINT32 frameId)
331{
332 if (!Stream_EnsureRemainingCapacity(s, SURFCMD_FRAME_MARKER_LENGTH))
333 return FALSE;
334
335 Stream_Write_UINT16(s, CMDTYPE_FRAME_MARKER);
336 Stream_Write_UINT16(s, frameAction);
337 Stream_Write_UINT32(s, frameId);
338 return TRUE;
339}
freerdp_settings_get_uint32
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
freerdp_settings_get_bool
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
SURFACE_BITS_COMMAND
Definition include/freerdp/update.h:123
SURFACE_FRAME_MARKER
Definition include/freerdp/update.h:134
TS_BITMAP_DATA_EX
Definition include/freerdp/update.h:104
TS_COMPRESSED_BITMAP_HEADER_EX
Definition include/freerdp/update.h:96
rdp_update_internal
Definition libfreerdp/core/update.h:46