Blame libfreerdp/core/surface.c

Packit 1fb8d4
/**
Packit 1fb8d4
 * FreeRDP: A Remote Desktop Protocol Implementation
Packit 1fb8d4
 * Surface Commands
Packit 1fb8d4
 *
Packit 1fb8d4
 * Copyright 2011 Vic Lee
Packit 1fb8d4
 *
Packit 1fb8d4
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit 1fb8d4
 * you may not use this file except in compliance with the License.
Packit 1fb8d4
 * You may obtain a copy of the License at
Packit 1fb8d4
 *
Packit 1fb8d4
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit 1fb8d4
 *
Packit 1fb8d4
 * Unless required by applicable law or agreed to in writing, software
Packit 1fb8d4
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit 1fb8d4
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit 1fb8d4
 * See the License for the specific language governing permissions and
Packit 1fb8d4
 * limitations under the License.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
#ifdef HAVE_CONFIG_H
Packit 1fb8d4
#include "config.h"
Packit 1fb8d4
#endif
Packit 1fb8d4
Packit 1fb8d4
#include <freerdp/utils/pcap.h>
Packit 1fb8d4
#include <freerdp/log.h>
Packit 1fb8d4
Packit 1fb8d4
#include "../cache/cache.h"
Packit 1fb8d4
#include "surface.h"
Packit 1fb8d4
Packit 1fb8d4
#define TAG FREERDP_TAG("core.surface")
Packit 1fb8d4
Packit 1fb8d4
static BOOL update_recv_surfcmd_bitmap_header_ex(wStream* s, TS_COMPRESSED_BITMAP_HEADER_EX* header)
Packit 1fb8d4
{
Packit 1fb8d4
	if (!s || !header)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	if (Stream_GetRemainingLength(s) < 24)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	Stream_Read_UINT32(s, header->highUniqueId);
Packit 1fb8d4
	Stream_Read_UINT32(s, header->lowUniqueId);
Packit 1fb8d4
	Stream_Read_UINT64(s, header->tmMilliseconds);
Packit 1fb8d4
	Stream_Read_UINT64(s, header->tmSeconds);
Packit 1fb8d4
	return TRUE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
static BOOL update_recv_surfcmd_bitmap_ex(wStream* s, TS_BITMAP_DATA_EX* bmp)
Packit 1fb8d4
{
Packit 1fb8d4
	size_t pos;
Packit 1fb8d4
Packit 1fb8d4
	if (!s || !bmp)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	if (Stream_GetRemainingLength(s) < 12)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	Stream_Read_UINT8(s, bmp->bpp);
Packit 1fb8d4
	Stream_Read_UINT8(s, bmp->flags);
Packit 1fb8d4
	Stream_Seek(s, 1); /* reserved */
Packit 1fb8d4
	Stream_Read_UINT8(s, bmp->codecID);
Packit 1fb8d4
	Stream_Read_UINT16(s, bmp->width);
Packit 1fb8d4
	Stream_Read_UINT16(s, bmp->height);
Packit 1fb8d4
	Stream_Read_UINT32(s, bmp->bitmapDataLength);
Packit 1fb8d4
Packit 1fb8d4
	if ((bmp->bpp < 1) || (bmp->bpp > 32))
Packit 1fb8d4
	{
Packit Service 5a9772
		WLog_ERR(TAG, "invalid bpp value %" PRIu32 "", bmp->bpp);
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	memset(&bmp->exBitmapDataHeader, 0, sizeof(TS_COMPRESSED_BITMAP_HEADER_EX));
Packit 1fb8d4
Packit 1fb8d4
	if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (!update_recv_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
Packit 1fb8d4
			return FALSE;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (Stream_GetRemainingLength(s) < bmp->bitmapDataLength)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	pos = Stream_GetPosition(s) + bmp->bitmapDataLength;
Packit 1fb8d4
	bmp->bitmapData = Stream_Pointer(s);
Packit 1fb8d4
	Stream_SetPosition(s, pos);
Packit 1fb8d4
	return TRUE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit Service 5a9772
static BOOL update_recv_surfcmd_surface_bits(rdpUpdate* update, wStream* s, UINT16 cmdType)
Packit 1fb8d4
{
Packit Service 5a9772
	SURFACE_BITS_COMMAND cmd = { 0 };
Packit 1fb8d4
Packit 1fb8d4
	if (Stream_GetRemainingLength(s) < 8)
Packit 1fb8d4
		goto fail;
Packit 1fb8d4
Packit Service 5a9772
	cmd.cmdType = cmdType;
Packit 1fb8d4
	Stream_Read_UINT16(s, cmd.destLeft);
Packit 1fb8d4
	Stream_Read_UINT16(s, cmd.destTop);
Packit 1fb8d4
	Stream_Read_UINT16(s, cmd.destRight);
Packit 1fb8d4
	Stream_Read_UINT16(s, cmd.destBottom);
Packit 1fb8d4
Packit 1fb8d4
	if (!update_recv_surfcmd_bitmap_ex(s, &cmd.bmp))
Packit 1fb8d4
		goto fail;
Packit 1fb8d4
Packit 1fb8d4
	if (!update->SurfaceBits)
Packit 1fb8d4
	{
Packit 1fb8d4
		WLog_ERR(TAG, "Missing callback update->SurfaceBits");
Packit 1fb8d4
		goto fail;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	return update->SurfaceBits(update->context, &cmd);
Packit 1fb8d4
fail:
Packit 1fb8d4
	return FALSE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
static BOOL update_recv_surfcmd_frame_marker(rdpUpdate* update, wStream* s)
Packit 1fb8d4
{
Packit 1fb8d4
	SURFACE_FRAME_MARKER marker;
Packit 1fb8d4
Packit 1fb8d4
	if (Stream_GetRemainingLength(s) < 6)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	Stream_Read_UINT16(s, marker.frameAction);
Packit 1fb8d4
	Stream_Read_UINT32(s, marker.frameId);
Packit Service 5a9772
	WLog_Print(update->log, WLOG_DEBUG,
Packit Service 5a9772
	           "SurfaceFrameMarker: action: %s (%" PRIu32 ") id: %" PRIu32 "",
Packit Service 5a9772
	           (!marker.frameAction) ? "Begin" : "End", marker.frameAction, marker.frameId);
Packit 1fb8d4
Packit 1fb8d4
	if (!update->SurfaceFrameMarker)
Packit 1fb8d4
	{
Packit 1fb8d4
		WLog_ERR(TAG, "Missing callback update->SurfaceFrameMarker");
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	return update->SurfaceFrameMarker(update->context, &marker);
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
int update_recv_surfcmds(rdpUpdate* update, wStream* s)
Packit 1fb8d4
{
Packit 1fb8d4
	BYTE* mark;
Packit 1fb8d4
	UINT16 cmdType;
Packit 1fb8d4
Packit 1fb8d4
	while (Stream_GetRemainingLength(s) >= 2)
Packit 1fb8d4
	{
Packit 1fb8d4
		const size_t start = Stream_GetPosition(s);
Packit 1fb8d4
		Stream_GetPointer(s, mark);
Packit 1fb8d4
		Stream_Read_UINT16(s, cmdType);
Packit 1fb8d4
Packit 1fb8d4
		switch (cmdType)
Packit 1fb8d4
		{
Packit 1fb8d4
			case CMDTYPE_SET_SURFACE_BITS:
Packit 1fb8d4
			case CMDTYPE_STREAM_SURFACE_BITS:
Packit Service 5a9772
				if (!update_recv_surfcmd_surface_bits(update, s, cmdType))
Packit 1fb8d4
					return -1;
Packit 1fb8d4
Packit 1fb8d4
				break;
Packit 1fb8d4
Packit 1fb8d4
			case CMDTYPE_FRAME_MARKER:
Packit 1fb8d4
				if (!update_recv_surfcmd_frame_marker(update, s))
Packit 1fb8d4
					return -1;
Packit 1fb8d4
Packit 1fb8d4
				break;
Packit 1fb8d4
Packit 1fb8d4
			default:
Packit Service 5a9772
				WLog_ERR(TAG, "unknown cmdType 0x%04" PRIX16 "", cmdType);
Packit 1fb8d4
				return -1;
Packit 1fb8d4
		}
Packit 1fb8d4
Packit 1fb8d4
		if (update->dump_rfx)
Packit 1fb8d4
		{
Packit 1fb8d4
			const size_t size = Stream_GetPosition(s) - start;
Packit 1fb8d4
			/* TODO: treat return values */
Packit 1fb8d4
			pcap_add_record(update->pcap_rfx, mark, size);
Packit 1fb8d4
			pcap_flush(update->pcap_rfx);
Packit 1fb8d4
		}
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	return 0;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
static BOOL update_write_surfcmd_bitmap_header_ex(wStream* s,
Packit Service 5a9772
                                                  const TS_COMPRESSED_BITMAP_HEADER_EX* header)
Packit 1fb8d4
{
Packit 1fb8d4
	if (!s || !header)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	if (!Stream_EnsureRemainingCapacity(s, 24))
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	Stream_Write_UINT32(s, header->highUniqueId);
Packit 1fb8d4
	Stream_Write_UINT32(s, header->lowUniqueId);
Packit 1fb8d4
	Stream_Write_UINT64(s, header->tmMilliseconds);
Packit 1fb8d4
	Stream_Write_UINT64(s, header->tmSeconds);
Packit 1fb8d4
	return TRUE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
static BOOL update_write_surfcmd_bitmap_ex(wStream* s, const TS_BITMAP_DATA_EX* bmp)
Packit 1fb8d4
{
Packit 1fb8d4
	if (!s || !bmp)
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	if (!Stream_EnsureRemainingCapacity(s, 12))
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	Stream_Write_UINT8(s, bmp->bpp);
Packit 1fb8d4
	Stream_Write_UINT8(s, bmp->flags);
Packit 1fb8d4
	Stream_Write_UINT8(s, 0); /* reserved1, reserved2 */
Packit 1fb8d4
	Stream_Write_UINT8(s, bmp->codecID);
Packit 1fb8d4
	Stream_Write_UINT16(s, bmp->width);
Packit 1fb8d4
	Stream_Write_UINT16(s, bmp->height);
Packit 1fb8d4
	Stream_Write_UINT32(s, bmp->bitmapDataLength);
Packit 1fb8d4
Packit 1fb8d4
	if (bmp->flags & EX_COMPRESSED_BITMAP_HEADER_PRESENT)
Packit 1fb8d4
	{
Packit 1fb8d4
		if (!update_write_surfcmd_bitmap_header_ex(s, &bmp->exBitmapDataHeader))
Packit 1fb8d4
			return FALSE;
Packit 1fb8d4
	}
Packit 1fb8d4
Packit 1fb8d4
	if (!Stream_EnsureRemainingCapacity(s, bmp->bitmapDataLength))
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	Stream_Write(s, bmp->bitmapData, bmp->bitmapDataLength);
Packit 1fb8d4
	return TRUE;
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
BOOL update_write_surfcmd_surface_bits(wStream* s, const SURFACE_BITS_COMMAND* cmd)
Packit 1fb8d4
{
Packit Service 5a9772
	UINT16 cmdType;
Packit 1fb8d4
	if (!Stream_EnsureRemainingCapacity(s, SURFCMD_SURFACE_BITS_HEADER_LENGTH))
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit Service 5a9772
	cmdType = cmd->cmdType;
Packit Service 5a9772
	switch (cmdType)
Packit Service 5a9772
	{
Packit Service 5a9772
		case CMDTYPE_SET_SURFACE_BITS:
Packit Service 5a9772
		case CMDTYPE_STREAM_SURFACE_BITS:
Packit Service 5a9772
			break;
Packit Service 5a9772
		default:
Packit Service 5a9772
			WLog_WARN(TAG,
Packit Service 5a9772
			          "SURFACE_BITS_COMMAND->cmdType 0x%04" PRIx16
Packit Service 5a9772
			          " not allowed, correcting to 0x%04" PRIx16,
Packit Service 5a9772
			          cmdType, CMDTYPE_STREAM_SURFACE_BITS);
Packit Service 5a9772
			cmdType = CMDTYPE_STREAM_SURFACE_BITS;
Packit Service 5a9772
			break;
Packit Service 5a9772
	}
Packit Service 5a9772
Packit Service 5a9772
	Stream_Write_UINT16(s, cmdType);
Packit 1fb8d4
	Stream_Write_UINT16(s, cmd->destLeft);
Packit 1fb8d4
	Stream_Write_UINT16(s, cmd->destTop);
Packit 1fb8d4
	Stream_Write_UINT16(s, cmd->destRight);
Packit 1fb8d4
	Stream_Write_UINT16(s, cmd->destBottom);
Packit 1fb8d4
	return update_write_surfcmd_bitmap_ex(s, &cmd->bmp);
Packit 1fb8d4
}
Packit 1fb8d4
Packit 1fb8d4
BOOL update_write_surfcmd_frame_marker(wStream* s, UINT16 frameAction, UINT32 frameId)
Packit 1fb8d4
{
Packit 1fb8d4
	if (!Stream_EnsureRemainingCapacity(s, SURFCMD_FRAME_MARKER_LENGTH))
Packit 1fb8d4
		return FALSE;
Packit 1fb8d4
Packit 1fb8d4
	Stream_Write_UINT16(s, CMDTYPE_FRAME_MARKER);
Packit 1fb8d4
	Stream_Write_UINT16(s, frameAction);
Packit 1fb8d4
	Stream_Write_UINT32(s, frameId);
Packit 1fb8d4
	return TRUE;
Packit 1fb8d4
}