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 rdp_update_internal* up = update_cast(update);
133 BOOL rc = FALSE;
134 SURFACE_BITS_COMMAND cmd = WINPR_C_ARRAY_INIT;
135
136 WINPR_ASSERT(up);
137
138 if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
139 goto fail;
140
141 cmd.cmdType = cmdType;
142 Stream_Read_UINT16(s, cmd.destLeft);
143 Stream_Read_UINT16(s, cmd.destTop);
144 Stream_Read_UINT16(s, cmd.destRight);
145 Stream_Read_UINT16(s, cmd.destBottom);
146
147 if (!update_recv_surfcmd_is_rect_valid(update->context, &cmd))
148 goto fail;
149
150 if (!update_recv_surfcmd_bitmap_ex(s, &cmd.bmp))
151 goto fail;
152
153 up->stats.base[RDP_STATS_SURFACE_BITS]++;
154 switch (cmd.bmp.codecID)
155 {
156 case RDP_CODEC_ID_REMOTEFX:
157 up->stats.base[RDP_STATS_SURFACE_BITS_RFX]++;
158 break;
159 case RDP_CODEC_ID_IMAGE_REMOTEFX:
160 up->stats.base[RDP_STATS_SURFACE_BITS_RFX_IMAGE]++;
161 break;
162 case RDP_CODEC_ID_NSCODEC:
163 up->stats.base[RDP_STATS_SURFACE_BITS_NSC]++;
164 break;
165 case RDP_CODEC_ID_NONE:
166 up->stats.base[RDP_STATS_SURFACE_BITS_NONE]++;
167 break;
168 default:
169 up->stats.base[RDP_STATS_SURFACE_BITS_UNKNOWN]++;
170 break;
171 }
172
173 if (!IFCALLRESULT(TRUE, update->SurfaceBits, update->context, &cmd))
174 {
175 WLog_DBG(TAG, "update->SurfaceBits implementation failed");
176 goto fail;
177 }
178
179 rc = TRUE;
180fail:
181 return rc;
182}
183
184static BOOL update_recv_surfcmd_frame_marker(rdpUpdate* update, wStream* s)
185{
186 SURFACE_FRAME_MARKER marker = WINPR_C_ARRAY_INIT;
187 rdp_update_internal* up = update_cast(update);
188
189 WINPR_ASSERT(s);
190
191 if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
192 return FALSE;
193
194 Stream_Read_UINT16(s, marker.frameAction);
195 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
196 WLog_WARN(TAG,
197 "[SERVER-BUG]: got %" PRIuz ", expected %u"
198 " bytes. [MS-RDPBCGR] 2.2.9.2.3 Frame Marker Command (TS_FRAME_MARKER) is "
199 "missing frameId, ignoring",
200 Stream_GetRemainingLength(s), 4u);
201 else
202 Stream_Read_UINT32(s, marker.frameId);
203 WLog_Print(up->log, WLOG_DEBUG, "SurfaceFrameMarker: action: %s (%" PRIu32 ") id: %" PRIu32 "",
204 (!marker.frameAction) ? "Begin" : "End", marker.frameAction, marker.frameId);
205
206 if (!update->SurfaceFrameMarker)
207 {
208 WINPR_ASSERT(update->context);
209 if (freerdp_settings_get_bool(update->context->settings, FreeRDP_DeactivateClientDecoding))
210 return TRUE;
211 WLog_ERR(TAG, "Missing callback update->SurfaceFrameMarker");
212 return FALSE;
213 }
214
215 if (!update->SurfaceFrameMarker(update->context, &marker))
216 {
217 WLog_DBG(TAG, "update->SurfaceFrameMarker implementation failed");
218 return FALSE;
219 }
220
221 return TRUE;
222}
223
224BOOL update_recv_surfcmds(rdpUpdate* update, wStream* s)
225{
226 UINT16 cmdType = 0;
227 rdp_update_internal* up = update_cast(update);
228
229 WINPR_ASSERT(s);
230
231 while (Stream_GetRemainingLength(s) >= 2)
232 {
233 const size_t start = Stream_GetPosition(s);
234 const BYTE* mark = Stream_ConstPointer(s);
235
236 Stream_Read_UINT16(s, cmdType);
237
238 switch (cmdType)
239 {
240 case CMDTYPE_SET_SURFACE_BITS:
241 case CMDTYPE_STREAM_SURFACE_BITS:
242 if (!update_recv_surfcmd_surface_bits(update, s, cmdType))
243 return FALSE;
244 break;
245
246 case CMDTYPE_FRAME_MARKER:
247 up->stats.base[RDP_STATS_SURFACE_FRAME_MARKER]++;
248 if (!update_recv_surfcmd_frame_marker(update, s))
249 return FALSE;
250
251 break;
252
253 default:
254 WLog_ERR(TAG, "unknown cmdType 0x%04" PRIX16 "", cmdType);
255 return FALSE;
256 }
257
258 if (up->dump_rfx)
259 {
260 const size_t size = Stream_GetPosition(s) - start;
261 /* TODO: treat return values */
262 if (!pcap_add_record(up->pcap_rfx, mark, size))
263 return FALSE;
264 pcap_flush(up->pcap_rfx);
265 }
266 }
267
268 return TRUE;
269}
270
271static BOOL update_write_surfcmd_bitmap_header_ex(wStream* s,
272 const TS_COMPRESSED_BITMAP_HEADER_EX* header)
273{
274 if (!s || !header)
275 return FALSE;
276
277 if (!Stream_EnsureRemainingCapacity(s, 24))
278 return FALSE;
279
280 Stream_Write_UINT32(s, header->highUniqueId);
281 Stream_Write_UINT32(s, header->lowUniqueId);
282 Stream_Write_UINT64(s, header->tmMilliseconds);
283 Stream_Write_UINT64(s, header->tmSeconds);
284 return TRUE;
285}
286
287static BOOL update_write_surfcmd_bitmap_ex(wStream* s, const TS_BITMAP_DATA_EX* bmp)
288{
289 if (!s || !bmp)
290 return FALSE;
291
292 if (!Stream_EnsureRemainingCapacity(s, 12))
293 return FALSE;
294
295 if (bmp->codecID > UINT8_MAX)
296 {
297 WLog_ERR(TAG, "Invalid TS_BITMAP_DATA_EX::codecID=0x%04" PRIx16 "", bmp->codecID);
298 return FALSE;
299 }
300 Stream_Write_UINT8(s, bmp->bpp);
301 Stream_Write_UINT8(s, bmp->flags);
302 Stream_Write_UINT8(s, 0); /* reserved1, reserved2 */
303 Stream_Write_UINT8(s, (UINT8)bmp->codecID);
304 Stream_Write_UINT16(s, bmp->width);
305 Stream_Write_UINT16(s, bmp->height);
306 Stream_Write_UINT32(s, bmp->bitmapDataLength);
307
308 if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
309 {
310 if (!update_write_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
311 return FALSE;
312 }
313
314 if (!Stream_EnsureRemainingCapacity(s, bmp->bitmapDataLength))
315 return FALSE;
316
317 Stream_Write(s, bmp->bitmapData, bmp->bitmapDataLength);
318 return TRUE;
319}
320
321BOOL update_write_surfcmd_surface_bits(wStream* s, const SURFACE_BITS_COMMAND* cmd)
322{
323 if (!Stream_EnsureRemainingCapacity(s, SURFCMD_SURFACE_BITS_HEADER_LENGTH))
324 return FALSE;
325
326 WINPR_ASSERT(cmd->cmdType <= UINT16_MAX);
327 UINT16 cmdType = (UINT16)cmd->cmdType;
328 switch (cmdType)
329 {
330 case CMDTYPE_SET_SURFACE_BITS:
331 case CMDTYPE_STREAM_SURFACE_BITS:
332 break;
333 default:
334 {
335 const UINT16 defaultCmdType = CMDTYPE_STREAM_SURFACE_BITS;
336 WLog_WARN(TAG,
337 "SURFACE_BITS_COMMAND->cmdType 0x%04" PRIx16
338 " not allowed, correcting to 0x%04" PRIx16,
339 cmdType, defaultCmdType);
340 cmdType = defaultCmdType;
341 }
342 break;
343 }
344
345 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmdType));
346 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destLeft));
347 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destTop));
348 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destRight));
349 Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destBottom));
350 return update_write_surfcmd_bitmap_ex(s, &cmd->bmp);
351}
352
353BOOL update_write_surfcmd_frame_marker(wStream* s, UINT16 frameAction, UINT32 frameId)
354{
355 if (!Stream_EnsureRemainingCapacity(s, SURFCMD_FRAME_MARKER_LENGTH))
356 return FALSE;
357
358 Stream_Write_UINT16(s, CMDTYPE_FRAME_MARKER);
359 Stream_Write_UINT16(s, frameAction);
360 Stream_Write_UINT32(s, frameId);
361 return TRUE;
362}
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:83