FreeRDP/libfreerdp/cache/brush.c

/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Brush Cache
 *
 * Copyright 2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 *
 * 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 <stdio.h>
#include <winpr/crt.h>
#include <winpr/assert.h>

#include <freerdp/log.h>
#include <freerdp/update.h>
#include <freerdp/freerdp.h>
#include <winpr/stream.h>

#include "brush.h"
#include "cache.h"

#define TAG FREERDP_TAG("cache.brush")

typedef struct
{
	UINT32 bpp;
	void* entry;
} BRUSH_ENTRY;

struct rdp_brush_cache
{
	pPatBlt PatBlt;          /* 0 */
	pCacheBrush CacheBrush;  /* 1 */
	pPolygonSC PolygonSC;    /* 2 */
	pPolygonCB PolygonCB;    /* 3 */
	UINT32 paddingA[16 - 4]; /* 4 */

	UINT32 maxEntries;        /* 16 */
	UINT32 maxMonoEntries;    /* 17 */
	BRUSH_ENTRY* entries;     /* 18 */
	BRUSH_ENTRY* monoEntries; /* 19 */
	UINT32 paddingB[32 - 20]; /* 20 */

	rdpContext* context;
};

static BOOL update_gdi_patblt(rdpContext* context, PATBLT_ORDER* patblt)
{
	BOOL ret = TRUE;

	WINPR_ASSERT(context);
	WINPR_ASSERT(patblt);

	const rdpCache* cache = context->cache;
	WINPR_ASSERT(cache);

	rdpBrush* brush = &patblt->brush;
	WINPR_ASSERT(brush->style <= UINT8_MAX);
	const BYTE style = (BYTE)brush->style;

	if (brush->style & CACHED_BRUSH)
	{
		brush->data = brush_cache_get(cache->brush, brush->index, &brush->bpp);
		brush->style = 0x03;
	}

	WINPR_ASSERT(cache->brush);
	IFCALLRET(cache->brush->PatBlt, ret, context, patblt);
	brush->style = style;
	return ret;
}

static BOOL update_gdi_polygon_sc(rdpContext* context, const POLYGON_SC_ORDER* polygon_sc)
{
	rdpCache* cache = NULL;
	WINPR_ASSERT(context);
	cache = context->cache;
	WINPR_ASSERT(cache);
	WINPR_ASSERT(cache->brush);
	return IFCALLRESULT(TRUE, cache->brush->PolygonSC, context, polygon_sc);
}

static BOOL update_gdi_polygon_cb(rdpContext* context, POLYGON_CB_ORDER* polygon_cb)
{
	BOOL ret = TRUE;

	WINPR_ASSERT(context);
	WINPR_ASSERT(polygon_cb);

	rdpCache* cache = context->cache;
	WINPR_ASSERT(cache);

	rdpBrush* brush = &polygon_cb->brush;
	WINPR_ASSERT(brush->style <= UINT8_MAX);
	const BYTE style = (UINT8)brush->style;

	if (brush->style & CACHED_BRUSH)
	{
		brush->data = brush_cache_get(cache->brush, brush->index, &brush->bpp);
		brush->style = 0x03;
	}

	WINPR_ASSERT(cache->brush);
	IFCALLRET(cache->brush->PolygonCB, ret, context, polygon_cb);
	brush->style = style;
	return ret;
}

static BOOL update_gdi_cache_brush(rdpContext* context, const CACHE_BRUSH_ORDER* cacheBrush)
{
	UINT32 length = 0;
	void* data = NULL;
	rdpCache* cache = NULL;

	WINPR_ASSERT(context);
	WINPR_ASSERT(cacheBrush);

	cache = context->cache;
	WINPR_ASSERT(cache);

	length = cacheBrush->bpp * 64 / 8;
	data = malloc(length);

	if (!data)
		return FALSE;

	CopyMemory(data, cacheBrush->data, length);
	brush_cache_put(cache->brush, cacheBrush->index, data, cacheBrush->bpp);
	return TRUE;
}

void* brush_cache_get(rdpBrushCache* brushCache, UINT32 index, UINT32* bpp)
{
	void* entry = NULL;

	if (!brushCache)
		return NULL;

	if (!bpp)
		return NULL;

	if (*bpp == 1)
	{
		if (index >= brushCache->maxMonoEntries)
		{
			WLog_ERR(TAG, "invalid brush (%" PRIu32 " bpp) index: 0x%08" PRIX32 "", *bpp, index);
			return NULL;
		}

		*bpp = brushCache->monoEntries[index].bpp;
		entry = brushCache->monoEntries[index].entry;
	}
	else
	{
		if (index >= brushCache->maxEntries)
		{
			WLog_ERR(TAG, "invalid brush (%" PRIu32 " bpp) index: 0x%08" PRIX32 "", *bpp, index);
			return NULL;
		}

		*bpp = brushCache->entries[index].bpp;
		entry = brushCache->entries[index].entry;
	}

	if (entry == NULL)
	{
		WLog_ERR(TAG, "invalid brush (%" PRIu32 " bpp) at index: 0x%08" PRIX32 "", *bpp, index);
		return NULL;
	}

	return entry;
}

void brush_cache_put(rdpBrushCache* brushCache, UINT32 index, void* entry, UINT32 bpp)
{
	WINPR_ASSERT(brushCache);

	if (bpp == 1)
	{
		if (index >= brushCache->maxMonoEntries)
		{
			WLog_ERR(TAG, "invalid brush (%" PRIu32 " bpp) index: 0x%08" PRIX32 "", bpp, index);
			free(entry);
			return;
		}

		WINPR_ASSERT(brushCache->monoEntries);
		free(brushCache->monoEntries[index].entry);
		brushCache->monoEntries[index].bpp = bpp;
		brushCache->monoEntries[index].entry = entry;
	}
	else
	{
		if (index >= brushCache->maxEntries)
		{
			WLog_ERR(TAG, "invalid brush (%" PRIu32 " bpp) index: 0x%08" PRIX32 "", bpp, index);
			free(entry);
			return;
		}

		WINPR_ASSERT(brushCache->entries);
		free(brushCache->entries[index].entry);
		brushCache->entries[index].bpp = bpp;
		brushCache->entries[index].entry = entry;
	}
}

void brush_cache_register_callbacks(rdpUpdate* update)
{
	WINPR_ASSERT(update);
	WINPR_ASSERT(update->context);
	WINPR_ASSERT(update->primary);
	WINPR_ASSERT(update->secondary);

	if (!freerdp_settings_get_bool(update->context->settings, FreeRDP_DeactivateClientDecoding))
	{
		rdpCache* cache = update->context->cache;
		WINPR_ASSERT(cache);
		WINPR_ASSERT(cache->brush);

		cache->brush->PatBlt = update->primary->PatBlt;
		cache->brush->PolygonSC = update->primary->PolygonSC;
		cache->brush->PolygonCB = update->primary->PolygonCB;
		update->primary->PatBlt = update_gdi_patblt;
		update->primary->PolygonSC = update_gdi_polygon_sc;
		update->primary->PolygonCB = update_gdi_polygon_cb;
		update->secondary->CacheBrush = update_gdi_cache_brush;
	}
}

rdpBrushCache* brush_cache_new(rdpContext* context)
{
	rdpBrushCache* brushCache = NULL;

	WINPR_ASSERT(context);

	brushCache = (rdpBrushCache*)calloc(1, sizeof(rdpBrushCache));

	if (!brushCache)
		return NULL;

	brushCache->context = context;
	brushCache->maxEntries = 64;
	brushCache->maxMonoEntries = 64;
	brushCache->entries = (BRUSH_ENTRY*)calloc(brushCache->maxEntries, sizeof(BRUSH_ENTRY));

	if (!brushCache->entries)
		goto fail;

	brushCache->monoEntries = (BRUSH_ENTRY*)calloc(brushCache->maxMonoEntries, sizeof(BRUSH_ENTRY));

	if (!brushCache->monoEntries)
		goto fail;

	return brushCache;
fail:
	WINPR_PRAGMA_DIAG_PUSH
	WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
	brush_cache_free(brushCache);
	WINPR_PRAGMA_DIAG_POP
	return NULL;
}

void brush_cache_free(rdpBrushCache* brushCache)
{
	if (brushCache)
	{
		if (brushCache->entries)
		{
			for (size_t i = 0; i < brushCache->maxEntries; i++)
				free(brushCache->entries[i].entry);

			free(brushCache->entries);
		}

		if (brushCache->monoEntries)
		{
			for (size_t i = 0; i < brushCache->maxMonoEntries; i++)
				free(brushCache->monoEntries[i].entry);

			free(brushCache->monoEntries);
		}

		free(brushCache);
	}
}

void free_cache_brush_order(rdpContext* context, CACHE_BRUSH_ORDER* order)
{
	WINPR_UNUSED(context);
	free(order);
}

CACHE_BRUSH_ORDER* copy_cache_brush_order(rdpContext* context, const CACHE_BRUSH_ORDER* order)
{
	CACHE_BRUSH_ORDER* dst = NULL;

	WINPR_ASSERT(context);

	dst = calloc(1, sizeof(CACHE_BRUSH_ORDER));

	if (!dst || !order)
		goto fail;

	*dst = *order;
	return dst;
fail:
	free_cache_brush_order(context, dst);
	return NULL;
}