/src/FreeRDP/libfreerdp/core/surface.c

Source
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Surface Commands
 *
 * Copyright 2011 Vic Lee
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <freerdp/config.h>

#include "settings.h"

#include <winpr/assert.h>
#include <winpr/cast.h>

#include <freerdp/utils/pcap.h>
#include <freerdp/log.h>

#include "../cache/cache.h"
#include "surface.h"

#define TAG FREERDP_TAG("core.surface")

static BOOL update_recv_surfcmd_bitmap_header_ex(wStream* s, TS_COMPRESSED_BITMAP_HEADER_EX* header)
{
  if (!s || !header)
    return FALSE;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 24))
    return FALSE;

  Stream_Read_UINT32(s, header->highUniqueId);
  Stream_Read_UINT32(s, header->lowUniqueId);
  Stream_Read_UINT64(s, header->tmMilliseconds);
  Stream_Read_UINT64(s, header->tmSeconds);
  return TRUE;
}

static BOOL update_recv_surfcmd_bitmap_ex(wStream* s, TS_BITMAP_DATA_EX* bmp)
{
  if (!s || !bmp)
    return FALSE;

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 12))
    return FALSE;

  Stream_Read_UINT8(s, bmp->bpp);
  Stream_Read_UINT8(s, bmp->flags);
  Stream_Seek(s, 1); /* reserved */
  Stream_Read_UINT8(s, bmp->codecID);
  Stream_Read_UINT16(s, bmp->width);
  Stream_Read_UINT16(s, bmp->height);
  Stream_Read_UINT32(s, bmp->bitmapDataLength);

  if ((bmp->width == 0) || (bmp->height == 0))
  {
    WLog_ERR(TAG, "invalid size value width=%" PRIu16 ", height=%" PRIu16, bmp->width,
             bmp->height);
    return FALSE;
  }

  if ((bmp->bpp < 1) || (bmp->bpp > 32))
  {
    WLog_ERR(TAG, "invalid bpp value %" PRIu32 "", bmp->bpp);
    return FALSE;
  }

  if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
  {
    if (!update_recv_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
      return FALSE;
  }

  bmp->bitmapData = Stream_Pointer(s);
  if (!Stream_SafeSeek(s, bmp->bitmapDataLength))
  {
    WLog_ERR(TAG, "expected bitmapDataLength %" PRIu32 ", not enough data",
             bmp->bitmapDataLength);
    return FALSE;
  }
  return TRUE;
}

static BOOL update_recv_surfcmd_is_rect_valid(const rdpContext* context,
                                              const SURFACE_BITS_COMMAND* cmd)
{
  WINPR_ASSERT(context);
  WINPR_ASSERT(context->settings);
  WINPR_ASSERT(cmd);

  /* We need a rectangle with left/top being smaller than right/bottom.
   * Also do not allow empty rectangles. */
  if ((cmd->destTop >= cmd->destBottom) || (cmd->destLeft >= cmd->destRight))
  {
    WLog_WARN(TAG,
              "Empty surface bits command rectangle: %" PRIu16 "x%" PRIu16 "-%" PRIu16
              "x%" PRIu16,
              cmd->destLeft, cmd->destTop, cmd->destRight, cmd->destBottom);
    return FALSE;
  }

  /* The rectangle needs to fit into our session size */
  const DWORD DesktopWidth = freerdp_settings_get_uint32(context->settings, FreeRDP_DesktopWidth);
  const DWORD DesktopHeight =
      freerdp_settings_get_uint32(context->settings, FreeRDP_DesktopHeight);
  if ((cmd->destRight > DesktopWidth) || (cmd->destBottom > DesktopHeight))
  {
    WLog_WARN(TAG,
              "Invalid surface bits command rectangle: %" PRIu16 "x%" PRIu16 "-%" PRIu16
              "x%" PRIu16 " does not fit %" PRIu32 "x%" PRIu32,
              cmd->destLeft, cmd->destTop, cmd->destRight, cmd->destBottom, DesktopWidth,
              DesktopHeight);
    return FALSE;
  }

  return TRUE;
}

static BOOL update_recv_surfcmd_surface_bits(rdpUpdate* update, wStream* s, UINT16 cmdType)
{
  rdp_update_internal* up = update_cast(update);
  BOOL rc = FALSE;
  SURFACE_BITS_COMMAND cmd = WINPR_C_ARRAY_INIT;

  WINPR_ASSERT(up);

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
    goto fail;

  cmd.cmdType = cmdType;
  Stream_Read_UINT16(s, cmd.destLeft);
  Stream_Read_UINT16(s, cmd.destTop);
  Stream_Read_UINT16(s, cmd.destRight);
  Stream_Read_UINT16(s, cmd.destBottom);

  if (!update_recv_surfcmd_is_rect_valid(update->context, &cmd))
    goto fail;

  if (!update_recv_surfcmd_bitmap_ex(s, &cmd.bmp))
    goto fail;

  up->stats.base[RDP_STATS_SURFACE_BITS]++;
  switch (cmd.bmp.codecID)
  {
    case RDP_CODEC_ID_REMOTEFX:
      up->stats.base[RDP_STATS_SURFACE_BITS_RFX]++;
      break;
    case RDP_CODEC_ID_IMAGE_REMOTEFX:
      up->stats.base[RDP_STATS_SURFACE_BITS_RFX_IMAGE]++;
      break;
    case RDP_CODEC_ID_NSCODEC:
      up->stats.base[RDP_STATS_SURFACE_BITS_NSC]++;
      break;
    case RDP_CODEC_ID_NONE:
      up->stats.base[RDP_STATS_SURFACE_BITS_NONE]++;
      break;
    default:
      up->stats.base[RDP_STATS_SURFACE_BITS_UNKNOWN]++;
      break;
  }

  if (!IFCALLRESULT(TRUE, update->SurfaceBits, update->context, &cmd))
  {
    WLog_DBG(TAG, "update->SurfaceBits implementation failed");
    goto fail;
  }

  rc = TRUE;
fail:
  return rc;
}

static BOOL update_recv_surfcmd_frame_marker(rdpUpdate* update, wStream* s)
{
  SURFACE_FRAME_MARKER marker = WINPR_C_ARRAY_INIT;
  rdp_update_internal* up = update_cast(update);

  WINPR_ASSERT(s);

  if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
    return FALSE;

  Stream_Read_UINT16(s, marker.frameAction);
  if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
    WLog_WARN(TAG,
              "[SERVER-BUG]: got %" PRIuz ", expected %u"
              " bytes. [MS-RDPBCGR] 2.2.9.2.3 Frame Marker Command (TS_FRAME_MARKER) is "
              "missing frameId, ignoring",
              Stream_GetRemainingLength(s), 4u);
  else
    Stream_Read_UINT32(s, marker.frameId);
  WLog_Print(up->log, WLOG_DEBUG, "SurfaceFrameMarker: action: %s (%" PRIu32 ") id: %" PRIu32 "",
             (!marker.frameAction) ? "Begin" : "End", marker.frameAction, marker.frameId);

  if (!update->SurfaceFrameMarker)
  {
    WINPR_ASSERT(update->context);
    if (freerdp_settings_get_bool(update->context->settings, FreeRDP_DeactivateClientDecoding))
      return TRUE;
    WLog_ERR(TAG, "Missing callback update->SurfaceFrameMarker");
    return FALSE;
  }

  if (!update->SurfaceFrameMarker(update->context, &marker))
  {
    WLog_DBG(TAG, "update->SurfaceFrameMarker implementation failed");
    return FALSE;
  }

  return TRUE;
}

BOOL update_recv_surfcmds(rdpUpdate* update, wStream* s)
{
  UINT16 cmdType = 0;
  rdp_update_internal* up = update_cast(update);

  WINPR_ASSERT(s);

  while (Stream_GetRemainingLength(s) >= 2)
  {
    const size_t start = Stream_GetPosition(s);
    const BYTE* mark = Stream_ConstPointer(s);

    Stream_Read_UINT16(s, cmdType);

    switch (cmdType)
    {
      case CMDTYPE_SET_SURFACE_BITS:
      case CMDTYPE_STREAM_SURFACE_BITS:
        if (!update_recv_surfcmd_surface_bits(update, s, cmdType))
          return FALSE;
        break;

      case CMDTYPE_FRAME_MARKER:
        up->stats.base[RDP_STATS_SURFACE_FRAME_MARKER]++;
        if (!update_recv_surfcmd_frame_marker(update, s))
          return FALSE;

        break;

      default:
        WLog_ERR(TAG, "unknown cmdType 0x%04" PRIX16 "", cmdType);
        return FALSE;
    }

    if (up->dump_rfx)
    {
      const size_t size = Stream_GetPosition(s) - start;
      /* TODO: treat return values */
      if (!pcap_add_record(up->pcap_rfx, mark, size))
        return FALSE;
      pcap_flush(up->pcap_rfx);
    }
  }

  return TRUE;
}

static BOOL update_write_surfcmd_bitmap_header_ex(wStream* s,
                                                  const TS_COMPRESSED_BITMAP_HEADER_EX* header)
{
  if (!s || !header)
    return FALSE;

  if (!Stream_EnsureRemainingCapacity(s, 24))
    return FALSE;

  Stream_Write_UINT32(s, header->highUniqueId);
  Stream_Write_UINT32(s, header->lowUniqueId);
  Stream_Write_UINT64(s, header->tmMilliseconds);
  Stream_Write_UINT64(s, header->tmSeconds);
  return TRUE;
}

static BOOL update_write_surfcmd_bitmap_ex(wStream* s, const TS_BITMAP_DATA_EX* bmp)
{
  if (!s || !bmp)
    return FALSE;

  if (!Stream_EnsureRemainingCapacity(s, 12))
    return FALSE;

  if (bmp->codecID > UINT8_MAX)
  {
    WLog_ERR(TAG, "Invalid TS_BITMAP_DATA_EX::codecID=0x%04" PRIx16 "", bmp->codecID);
    return FALSE;
  }
  Stream_Write_UINT8(s, bmp->bpp);
  Stream_Write_UINT8(s, bmp->flags);
  Stream_Write_UINT8(s, 0); /* reserved1, reserved2 */
  Stream_Write_UINT8(s, (UINT8)bmp->codecID);
  Stream_Write_UINT16(s, bmp->width);
  Stream_Write_UINT16(s, bmp->height);
  Stream_Write_UINT32(s, bmp->bitmapDataLength);

  if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
  {
    if (!update_write_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
      return FALSE;
  }

  if (!Stream_EnsureRemainingCapacity(s, bmp->bitmapDataLength))
    return FALSE;

  Stream_Write(s, bmp->bitmapData, bmp->bitmapDataLength);
  return TRUE;
}

BOOL update_write_surfcmd_surface_bits(wStream* s, const SURFACE_BITS_COMMAND* cmd)
{
  if (!Stream_EnsureRemainingCapacity(s, SURFCMD_SURFACE_BITS_HEADER_LENGTH))
    return FALSE;

  WINPR_ASSERT(cmd->cmdType <= UINT16_MAX);
  UINT16 cmdType = (UINT16)cmd->cmdType;
  switch (cmdType)
  {
    case CMDTYPE_SET_SURFACE_BITS:
    case CMDTYPE_STREAM_SURFACE_BITS:
      break;
    default:
    {
      const UINT16 defaultCmdType = CMDTYPE_STREAM_SURFACE_BITS;
      WLog_WARN(TAG,
                "SURFACE_BITS_COMMAND->cmdType 0x%04" PRIx16
                " not allowed, correcting to 0x%04" PRIx16,
                cmdType, defaultCmdType);
      cmdType = defaultCmdType;
    }
    break;
  }

  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmdType));
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destLeft));
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destTop));
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destRight));
  Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destBottom));
  return update_write_surfcmd_bitmap_ex(s, &cmd->bmp);
}

BOOL update_write_surfcmd_frame_marker(wStream* s, UINT16 frameAction, UINT32 frameId)
{
  if (!Stream_EnsureRemainingCapacity(s, SURFCMD_FRAME_MARKER_LENGTH))
    return FALSE;

  Stream_Write_UINT16(s, CMDTYPE_FRAME_MARKER);
  Stream_Write_UINT16(s, frameAction);
  Stream_Write_UINT32(s, frameId);
  return TRUE;
}

Coverage Report

Created: 2026-09-14 06:32

Line	Count	Source
1		/**
2		* FreeRDP: A Remote Desktop Protocol Implementation
3		* Surface Commands
4		*
5		* Copyright 2011 Vic Lee
6		*
7		* Licensed under the Apache License, Version 2.0 (the "License");
8		* you may not use this file except in compliance with the License.
9		* You may obtain a copy of the License at
10		*
11		* http://www.apache.org/licenses/LICENSE-2.0
12		*
13		* Unless required by applicable law or agreed to in writing, software
14		* distributed under the License is distributed on an "AS IS" BASIS,
15		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16		* See the License for the specific language governing permissions and
17		* limitations under the License.
18		*/
19
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
35		static BOOL update_recv_surfcmd_bitmap_header_ex(wStream* s, TS_COMPRESSED_BITMAP_HEADER_EX* header)
36	0	{
37	0	if (!s \|\| !header)
38	0	return FALSE;
39
40	0	if (!Stream_CheckAndLogRequiredLength(TAG, s, 24))
41	0	return FALSE;
42
43	0	Stream_Read_UINT32(s, header->highUniqueId);
44	0	Stream_Read_UINT32(s, header->lowUniqueId);
45	0	Stream_Read_UINT64(s, header->tmMilliseconds);
46	0	Stream_Read_UINT64(s, header->tmSeconds);
47	0	return TRUE;
48	0	}
49
50		static BOOL update_recv_surfcmd_bitmap_ex(wStream* s, TS_BITMAP_DATA_EX* bmp)
51	0	{
52	0	if (!s \|\| !bmp)
53	0	return FALSE;
54
55	0	if (!Stream_CheckAndLogRequiredLength(TAG, s, 12))
56	0	return FALSE;
57
58	0	Stream_Read_UINT8(s, bmp->bpp);
59	0	Stream_Read_UINT8(s, bmp->flags);
60	0	Stream_Seek(s, 1); /* reserved */
61	0	Stream_Read_UINT8(s, bmp->codecID);
62	0	Stream_Read_UINT16(s, bmp->width);
63	0	Stream_Read_UINT16(s, bmp->height);
64	0	Stream_Read_UINT32(s, bmp->bitmapDataLength);
65
66	0	if ((bmp->width == 0) \|\| (bmp->height == 0))
67	0	{
68	0	WLog_ERR(TAG, "invalid size value width=%" PRIu16 ", height=%" PRIu16, bmp->width,
69	0	bmp->height);
70	0	return FALSE;
71	0	}
72
73	0	if ((bmp->bpp < 1) \|\| (bmp->bpp > 32))
74	0	{
75	0	WLog_ERR(TAG, "invalid bpp value %" PRIu32 "", bmp->bpp);
76	0	return FALSE;
77	0	}
78
79	0	if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
80	0	{
81	0	if (!update_recv_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
82	0	return FALSE;
83	0	}
84
85	0	bmp->bitmapData = Stream_Pointer(s);
86	0	if (!Stream_SafeSeek(s, bmp->bitmapDataLength))
87	0	{
88	0	WLog_ERR(TAG, "expected bitmapDataLength %" PRIu32 ", not enough data",
89	0	bmp->bitmapDataLength);
90	0	return FALSE;
91	0	}
92	0	return TRUE;
93	0	}
94
95		static BOOL update_recv_surfcmd_is_rect_valid(const rdpContext* context,
96		const SURFACE_BITS_COMMAND* cmd)
97	0	{
98	0	WINPR_ASSERT(context);
99	0	WINPR_ASSERT(context->settings);
100	0	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	0	if ((cmd->destTop >= cmd->destBottom) \|\| (cmd->destLeft >= cmd->destRight))
105	0	{
106	0	WLog_WARN(TAG,
107	0	"Empty surface bits command rectangle: %" PRIu16 "x%" PRIu16 "-%" PRIu16
108	0	"x%" PRIu16,
109	0	cmd->destLeft, cmd->destTop, cmd->destRight, cmd->destBottom);
110	0	return FALSE;
111	0	}
112
113		/* The rectangle needs to fit into our session size */
114	0	const DWORD DesktopWidth = freerdp_settings_get_uint32(context->settings, FreeRDP_DesktopWidth);
115	0	const DWORD DesktopHeight =
116	0	freerdp_settings_get_uint32(context->settings, FreeRDP_DesktopHeight);
117	0	if ((cmd->destRight > DesktopWidth) \|\| (cmd->destBottom > DesktopHeight))
118	0	{
119	0	WLog_WARN(TAG,
120	0	"Invalid surface bits command rectangle: %" PRIu16 "x%" PRIu16 "-%" PRIu16
121	0	"x%" PRIu16 " does not fit %" PRIu32 "x%" PRIu32,
122	0	cmd->destLeft, cmd->destTop, cmd->destRight, cmd->destBottom, DesktopWidth,
123	0	DesktopHeight);
124	0	return FALSE;
125	0	}
126
127	0	return TRUE;
128	0	}
129
130		static BOOL update_recv_surfcmd_surface_bits(rdpUpdate* update, wStream* s, UINT16 cmdType)
131	0	{
132	0	rdp_update_internal* up = update_cast(update);
133	0	BOOL rc = FALSE;
134	0	SURFACE_BITS_COMMAND cmd = WINPR_C_ARRAY_INIT;
135
136	0	WINPR_ASSERT(up);
137
138	0	if (!Stream_CheckAndLogRequiredLength(TAG, s, 8))
139	0	goto fail;
140
141	0	cmd.cmdType = cmdType;
142	0	Stream_Read_UINT16(s, cmd.destLeft);
143	0	Stream_Read_UINT16(s, cmd.destTop);
144	0	Stream_Read_UINT16(s, cmd.destRight);
145	0	Stream_Read_UINT16(s, cmd.destBottom);
146
147	0	if (!update_recv_surfcmd_is_rect_valid(update->context, &cmd))
148	0	goto fail;
149
150	0	if (!update_recv_surfcmd_bitmap_ex(s, &cmd.bmp))
151	0	goto fail;
152
153	0	up->stats.base[RDP_STATS_SURFACE_BITS]++;
154	0	switch (cmd.bmp.codecID)
155	0	{
156	0	case RDP_CODEC_ID_REMOTEFX:
157	0	up->stats.base[RDP_STATS_SURFACE_BITS_RFX]++;
158	0	break;
159	0	case RDP_CODEC_ID_IMAGE_REMOTEFX:
160	0	up->stats.base[RDP_STATS_SURFACE_BITS_RFX_IMAGE]++;
161	0	break;
162	0	case RDP_CODEC_ID_NSCODEC:
163	0	up->stats.base[RDP_STATS_SURFACE_BITS_NSC]++;
164	0	break;
165	0	case RDP_CODEC_ID_NONE:
166	0	up->stats.base[RDP_STATS_SURFACE_BITS_NONE]++;
167	0	break;
168	0	default:
169	0	up->stats.base[RDP_STATS_SURFACE_BITS_UNKNOWN]++;
170	0	break;
171	0	}
172
173	0	if (!IFCALLRESULT(TRUE, update->SurfaceBits, update->context, &cmd))
174	0	{
175	0	WLog_DBG(TAG, "update->SurfaceBits implementation failed");
176	0	goto fail;
177	0	}
178
179	0	rc = TRUE;
180	0	fail:
181	0	return rc;
182	0	}
183
184		static BOOL update_recv_surfcmd_frame_marker(rdpUpdate* update, wStream* s)
185	0	{
186	0	SURFACE_FRAME_MARKER marker = WINPR_C_ARRAY_INIT;
187	0	rdp_update_internal* up = update_cast(update);
188
189	0	WINPR_ASSERT(s);
190
191	0	if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
192	0	return FALSE;
193
194	0	Stream_Read_UINT16(s, marker.frameAction);
195	0	if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
196	0	WLog_WARN(TAG,
197	0	"[SERVER-BUG]: got %" PRIuz ", expected %u"
198	0	" bytes. [MS-RDPBCGR] 2.2.9.2.3 Frame Marker Command (TS_FRAME_MARKER) is "
199	0	"missing frameId, ignoring",
200	0	Stream_GetRemainingLength(s), 4u);
201	0	else
202	0	Stream_Read_UINT32(s, marker.frameId);
203	0	WLog_Print(up->log, WLOG_DEBUG, "SurfaceFrameMarker: action: %s (%" PRIu32 ") id: %" PRIu32 "",
204	0	(!marker.frameAction) ? "Begin" : "End", marker.frameAction, marker.frameId);
205
206	0	if (!update->SurfaceFrameMarker)
207	0	{
208	0	WINPR_ASSERT(update->context);
209	0	if (freerdp_settings_get_bool(update->context->settings, FreeRDP_DeactivateClientDecoding))
210	0	return TRUE;
211	0	WLog_ERR(TAG, "Missing callback update->SurfaceFrameMarker");
212	0	return FALSE;
213	0	}
214
215	0	if (!update->SurfaceFrameMarker(update->context, &marker))
216	0	{
217	0	WLog_DBG(TAG, "update->SurfaceFrameMarker implementation failed");
218	0	return FALSE;
219	0	}
220
221	0	return TRUE;
222	0	}
223
224		BOOL update_recv_surfcmds(rdpUpdate* update, wStream* s)
225	0	{
226	0	UINT16 cmdType = 0;
227	0	rdp_update_internal* up = update_cast(update);
228
229	0	WINPR_ASSERT(s);
230
231	0	while (Stream_GetRemainingLength(s) >= 2)
232	0	{
233	0	const size_t start = Stream_GetPosition(s);
234	0	const BYTE* mark = Stream_ConstPointer(s);
235
236	0	Stream_Read_UINT16(s, cmdType);
237
238	0	switch (cmdType)
239	0	{
240	0	case CMDTYPE_SET_SURFACE_BITS:
241	0	case CMDTYPE_STREAM_SURFACE_BITS:
242	0	if (!update_recv_surfcmd_surface_bits(update, s, cmdType))
243	0	return FALSE;
244	0	break;
245
246	0	case CMDTYPE_FRAME_MARKER:
247	0	up->stats.base[RDP_STATS_SURFACE_FRAME_MARKER]++;
248	0	if (!update_recv_surfcmd_frame_marker(update, s))
249	0	return FALSE;
250
251	0	break;
252
253	0	default:
254	0	WLog_ERR(TAG, "unknown cmdType 0x%04" PRIX16 "", cmdType);
255	0	return FALSE;
256	0	}
257
258	0	if (up->dump_rfx)
259	0	{
260	0	const size_t size = Stream_GetPosition(s) - start;
261		/* TODO: treat return values */
262	0	if (!pcap_add_record(up->pcap_rfx, mark, size))
263	0	return FALSE;
264	0	pcap_flush(up->pcap_rfx);
265	0	}
266	0	}
267
268	0	return TRUE;
269	0	}
270
271		static BOOL update_write_surfcmd_bitmap_header_ex(wStream* s,
272		const TS_COMPRESSED_BITMAP_HEADER_EX* header)
273	0	{
274	0	if (!s \|\| !header)
275	0	return FALSE;
276
277	0	if (!Stream_EnsureRemainingCapacity(s, 24))
278	0	return FALSE;
279
280	0	Stream_Write_UINT32(s, header->highUniqueId);
281	0	Stream_Write_UINT32(s, header->lowUniqueId);
282	0	Stream_Write_UINT64(s, header->tmMilliseconds);
283	0	Stream_Write_UINT64(s, header->tmSeconds);
284	0	return TRUE;
285	0	}
286
287		static BOOL update_write_surfcmd_bitmap_ex(wStream* s, const TS_BITMAP_DATA_EX* bmp)
288	0	{
289	0	if (!s \|\| !bmp)
290	0	return FALSE;
291
292	0	if (!Stream_EnsureRemainingCapacity(s, 12))
293	0	return FALSE;
294
295	0	if (bmp->codecID > UINT8_MAX)
296	0	{
297	0	WLog_ERR(TAG, "Invalid TS_BITMAP_DATA_EX::codecID=0x%04" PRIx16 "", bmp->codecID);
298	0	return FALSE;
299	0	}
300	0	Stream_Write_UINT8(s, bmp->bpp);
301	0	Stream_Write_UINT8(s, bmp->flags);
302	0	Stream_Write_UINT8(s, 0); /* reserved1, reserved2 */
303	0	Stream_Write_UINT8(s, (UINT8)bmp->codecID);
304	0	Stream_Write_UINT16(s, bmp->width);
305	0	Stream_Write_UINT16(s, bmp->height);
306	0	Stream_Write_UINT32(s, bmp->bitmapDataLength);
307
308	0	if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
309	0	{
310	0	if (!update_write_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
311	0	return FALSE;
312	0	}
313
314	0	if (!Stream_EnsureRemainingCapacity(s, bmp->bitmapDataLength))
315	0	return FALSE;
316
317	0	Stream_Write(s, bmp->bitmapData, bmp->bitmapDataLength);
318	0	return TRUE;
319	0	}
320
321		BOOL update_write_surfcmd_surface_bits(wStream* s, const SURFACE_BITS_COMMAND* cmd)
322	0	{
323	0	if (!Stream_EnsureRemainingCapacity(s, SURFCMD_SURFACE_BITS_HEADER_LENGTH))
324	0	return FALSE;
325
326	0	WINPR_ASSERT(cmd->cmdType <= UINT16_MAX);
327	0	UINT16 cmdType = (UINT16)cmd->cmdType;
328	0	switch (cmdType)
329	0	{
330	0	case CMDTYPE_SET_SURFACE_BITS:
331	0	case CMDTYPE_STREAM_SURFACE_BITS:
332	0	break;
333	0	default:
334	0	{
335	0	const UINT16 defaultCmdType = CMDTYPE_STREAM_SURFACE_BITS;
336	0	WLog_WARN(TAG,
337	0	"SURFACE_BITS_COMMAND->cmdType 0x%04" PRIx16
338	0	" not allowed, correcting to 0x%04" PRIx16,
339	0	cmdType, defaultCmdType);
340	0	cmdType = defaultCmdType;
341	0	}
342	0	break;
343	0	}
344
345	0	Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmdType));
346	0	Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destLeft));
347	0	Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destTop));
348	0	Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destRight));
349	0	Stream_Write_UINT16(s, WINPR_ASSERTING_INT_CAST(uint16_t, cmd->destBottom));
350	0	return update_write_surfcmd_bitmap_ex(s, &cmd->bmp);
351	0	}
352
353		BOOL update_write_surfcmd_frame_marker(wStream* s, UINT16 frameAction, UINT32 frameId)
354	0	{
355	0	if (!Stream_EnsureRemainingCapacity(s, SURFCMD_FRAME_MARKER_LENGTH))
356	0	return FALSE;
357
358	0	Stream_Write_UINT16(s, CMDTYPE_FRAME_MARKER);
359	0	Stream_Write_UINT16(s, frameAction);
360	0	Stream_Write_UINT32(s, frameId);
361	0	return TRUE;
362	0	}