FreeRDP/libfreerdp/codec/clear.c
2024-09-15 09:08:02 +02:00

1220 lines
33 KiB
C

/**
* FreeRDP: A Remote Desktop Protocol Implementation
* ClearCodec Bitmap Compression
*
* Copyright 2014 Marc-Andre Moreau <marcandre.moreau@gmail.com>
* Copyright 2016 Armin Novak <armin.novak@thincast.com>
* Copyright 2016 Thincast Technologies GmbH
*
* 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 <winpr/crt.h>
#include <winpr/print.h>
#include <winpr/bitstream.h>
#include <freerdp/codec/color.h>
#include <freerdp/codec/clear.h>
#include <freerdp/log.h>
#define TAG FREERDP_TAG("codec.clear")
#define CLEARCODEC_FLAG_GLYPH_INDEX 0x01
#define CLEARCODEC_FLAG_GLYPH_HIT 0x02
#define CLEARCODEC_FLAG_CACHE_RESET 0x04
#define CLEARCODEC_VBAR_SIZE 32768
#define CLEARCODEC_VBAR_SHORT_SIZE 16384
typedef struct
{
UINT32 size;
UINT32 count;
UINT32* pixels;
} CLEAR_GLYPH_ENTRY;
typedef struct
{
UINT32 size;
UINT32 count;
BYTE* pixels;
} CLEAR_VBAR_ENTRY;
struct S_CLEAR_CONTEXT
{
BOOL Compressor;
NSC_CONTEXT* nsc;
UINT32 seqNumber;
BYTE* TempBuffer;
UINT32 TempSize;
UINT32 nTempStep;
UINT32 TempFormat;
UINT32 format;
CLEAR_GLYPH_ENTRY GlyphCache[4000];
UINT32 VBarStorageCursor;
CLEAR_VBAR_ENTRY VBarStorage[CLEARCODEC_VBAR_SIZE];
UINT32 ShortVBarStorageCursor;
CLEAR_VBAR_ENTRY ShortVBarStorage[CLEARCODEC_VBAR_SHORT_SIZE];
};
static const UINT32 CLEAR_LOG2_FLOOR[256] = {
0, 0, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5,
6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7
};
static const BYTE CLEAR_8BIT_MASKS[9] = { 0x00, 0x01, 0x03, 0x07, 0x0F, 0x1F, 0x3F, 0x7F, 0xFF };
static void clear_reset_vbar_storage(CLEAR_CONTEXT* WINPR_RESTRICT clear, BOOL zero)
{
if (zero)
{
for (size_t i = 0; i < ARRAYSIZE(clear->VBarStorage); i++)
winpr_aligned_free(clear->VBarStorage[i].pixels);
ZeroMemory(clear->VBarStorage, sizeof(clear->VBarStorage));
}
clear->VBarStorageCursor = 0;
if (zero)
{
for (size_t i = 0; i < ARRAYSIZE(clear->ShortVBarStorage); i++)
winpr_aligned_free(clear->ShortVBarStorage[i].pixels);
ZeroMemory(clear->ShortVBarStorage, sizeof(clear->ShortVBarStorage));
}
clear->ShortVBarStorageCursor = 0;
}
static void clear_reset_glyph_cache(CLEAR_CONTEXT* WINPR_RESTRICT clear)
{
for (size_t i = 0; i < ARRAYSIZE(clear->GlyphCache); i++)
winpr_aligned_free(clear->GlyphCache[i].pixels);
ZeroMemory(clear->GlyphCache, sizeof(clear->GlyphCache));
}
static BOOL convert_color(BYTE* WINPR_RESTRICT dst, UINT32 nDstStep, UINT32 DstFormat, UINT32 nXDst,
UINT32 nYDst, UINT32 nWidth, UINT32 nHeight,
const BYTE* WINPR_RESTRICT src, UINT32 nSrcStep, UINT32 SrcFormat,
UINT32 nDstWidth, UINT32 nDstHeight,
const gdiPalette* WINPR_RESTRICT palette)
{
if (nWidth + nXDst > nDstWidth)
nWidth = nDstWidth - nXDst;
if (nHeight + nYDst > nDstHeight)
nHeight = nDstHeight - nYDst;
return freerdp_image_copy_no_overlap(dst, DstFormat, nDstStep, nXDst, nYDst, nWidth, nHeight,
src, SrcFormat, nSrcStep, 0, 0, palette,
FREERDP_KEEP_DST_ALPHA);
}
static BOOL clear_decompress_nscodec(NSC_CONTEXT* WINPR_RESTRICT nsc, UINT32 width, UINT32 height,
wStream* WINPR_RESTRICT s, UINT32 bitmapDataByteCount,
BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat,
UINT32 nDstStep, UINT32 nXDstRel, UINT32 nYDstRel)
{
BOOL rc = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, bitmapDataByteCount))
return FALSE;
rc = nsc_process_message(nsc, 32, width, height, Stream_Pointer(s), bitmapDataByteCount,
pDstData, DstFormat, nDstStep, nXDstRel, nYDstRel, width, height,
FREERDP_FLIP_NONE);
Stream_Seek(s, bitmapDataByteCount);
return rc;
}
static BOOL clear_decompress_subcode_rlex(wStream* WINPR_RESTRICT s, UINT32 bitmapDataByteCount,
UINT32 width, UINT32 height,
BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat,
UINT32 nDstStep, UINT32 nXDstRel, UINT32 nYDstRel,
UINT32 nDstWidth, UINT32 nDstHeight)
{
UINT32 x = 0;
UINT32 y = 0;
UINT32 pixelCount = 0;
UINT32 bitmapDataOffset = 0;
size_t pixelIndex = 0;
UINT32 numBits = 0;
BYTE startIndex = 0;
BYTE stopIndex = 0;
BYTE suiteIndex = 0;
BYTE suiteDepth = 0;
BYTE paletteCount = 0;
UINT32 palette[128] = { 0 };
if (!Stream_CheckAndLogRequiredLength(TAG, s, bitmapDataByteCount))
return FALSE;
if (!Stream_CheckAndLogRequiredLength(TAG, s, 1))
return FALSE;
Stream_Read_UINT8(s, paletteCount);
bitmapDataOffset = 1 + (paletteCount * 3);
if ((paletteCount > 127) || (paletteCount < 1))
{
WLog_ERR(TAG, "paletteCount %" PRIu8 "", paletteCount);
return FALSE;
}
if (!Stream_CheckAndLogRequiredLengthOfSize(TAG, s, paletteCount, 3ull))
return FALSE;
for (UINT32 i = 0; i < paletteCount; i++)
{
BYTE r = 0;
BYTE g = 0;
BYTE b = 0;
Stream_Read_UINT8(s, b);
Stream_Read_UINT8(s, g);
Stream_Read_UINT8(s, r);
palette[i] = FreeRDPGetColor(DstFormat, r, g, b, 0xFF);
}
pixelIndex = 0;
pixelCount = width * height;
numBits = CLEAR_LOG2_FLOOR[paletteCount - 1] + 1;
while (bitmapDataOffset < bitmapDataByteCount)
{
UINT32 tmp = 0;
UINT32 color = 0;
UINT32 runLengthFactor = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
return FALSE;
Stream_Read_UINT8(s, tmp);
Stream_Read_UINT8(s, runLengthFactor);
bitmapDataOffset += 2;
suiteDepth = (tmp >> numBits) & CLEAR_8BIT_MASKS[(8 - numBits)];
stopIndex = tmp & CLEAR_8BIT_MASKS[numBits];
startIndex = stopIndex - suiteDepth;
if (runLengthFactor >= 0xFF)
{
if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
return FALSE;
Stream_Read_UINT16(s, runLengthFactor);
bitmapDataOffset += 2;
if (runLengthFactor >= 0xFFFF)
{
if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
return FALSE;
Stream_Read_UINT32(s, runLengthFactor);
bitmapDataOffset += 4;
}
}
if (startIndex >= paletteCount)
{
WLog_ERR(TAG, "startIndex %" PRIu8 " > paletteCount %" PRIu8 "]", startIndex,
paletteCount);
return FALSE;
}
if (stopIndex >= paletteCount)
{
WLog_ERR(TAG, "stopIndex %" PRIu8 " > paletteCount %" PRIu8 "]", stopIndex,
paletteCount);
return FALSE;
}
suiteIndex = startIndex;
if (suiteIndex > 127)
{
WLog_ERR(TAG, "suiteIndex %" PRIu8 " > 127]", suiteIndex);
return FALSE;
}
color = palette[suiteIndex];
if ((pixelIndex + runLengthFactor) > pixelCount)
{
WLog_ERR(TAG,
"pixelIndex %" PRIu32 " + runLengthFactor %" PRIu32 " > pixelCount %" PRIu32
"",
pixelIndex, runLengthFactor, pixelCount);
return FALSE;
}
for (UINT32 i = 0; i < runLengthFactor; i++)
{
BYTE* pTmpData = &pDstData[(nXDstRel + x) * FreeRDPGetBytesPerPixel(DstFormat) +
(nYDstRel + y) * nDstStep];
if ((nXDstRel + x < nDstWidth) && (nYDstRel + y < nDstHeight))
FreeRDPWriteColor(pTmpData, DstFormat, color);
if (++x >= width)
{
y++;
x = 0;
}
}
pixelIndex += runLengthFactor;
if ((pixelIndex + (suiteDepth + 1)) > pixelCount)
{
WLog_ERR(TAG,
"pixelIndex %" PRIu32 " + suiteDepth %" PRIu8 " + 1 > pixelCount %" PRIu32 "",
pixelIndex, suiteDepth, pixelCount);
return FALSE;
}
for (UINT32 i = 0; i <= suiteDepth; i++)
{
BYTE* pTmpData = &pDstData[(nXDstRel + x) * FreeRDPGetBytesPerPixel(DstFormat) +
(nYDstRel + y) * nDstStep];
UINT32 ccolor = palette[suiteIndex];
if (suiteIndex > 127)
{
WLog_ERR(TAG, "suiteIndex %" PRIu8 " > 127", suiteIndex);
return FALSE;
}
suiteIndex++;
if ((nXDstRel + x < nDstWidth) && (nYDstRel + y < nDstHeight))
FreeRDPWriteColor(pTmpData, DstFormat, ccolor);
if (++x >= width)
{
y++;
x = 0;
}
}
pixelIndex += (suiteDepth + 1);
}
if (pixelIndex != pixelCount)
{
WLog_ERR(TAG, "pixelIndex %" PRIdz " != pixelCount %" PRIu32 "", pixelIndex, pixelCount);
return FALSE;
}
return TRUE;
}
static BOOL clear_resize_buffer(CLEAR_CONTEXT* WINPR_RESTRICT clear, UINT32 width, UINT32 height)
{
UINT32 size = 0;
if (!clear)
return FALSE;
size = ((width + 16) * (height + 16) * FreeRDPGetBytesPerPixel(clear->format));
if (size > clear->TempSize)
{
BYTE* tmp = (BYTE*)winpr_aligned_recalloc(clear->TempBuffer, size, sizeof(BYTE), 32);
if (!tmp)
{
WLog_ERR(TAG, "clear->TempBuffer winpr_aligned_recalloc failed for %" PRIu32 " bytes",
size);
return FALSE;
}
clear->TempSize = size;
clear->TempBuffer = tmp;
}
return TRUE;
}
static BOOL clear_decompress_residual_data(CLEAR_CONTEXT* WINPR_RESTRICT clear,
wStream* WINPR_RESTRICT s, UINT32 residualByteCount,
UINT32 nWidth, UINT32 nHeight,
BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat,
UINT32 nDstStep, UINT32 nXDst, UINT32 nYDst,
UINT32 nDstWidth, UINT32 nDstHeight,
const gdiPalette* WINPR_RESTRICT palette)
{
UINT32 nSrcStep = 0;
UINT32 suboffset = 0;
BYTE* dstBuffer = NULL;
UINT32 pixelIndex = 0;
UINT32 pixelCount = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, residualByteCount))
return FALSE;
suboffset = 0;
pixelIndex = 0;
pixelCount = nWidth * nHeight;
if (!clear_resize_buffer(clear, nWidth, nHeight))
return FALSE;
dstBuffer = clear->TempBuffer;
while (suboffset < residualByteCount)
{
BYTE r = 0;
BYTE g = 0;
BYTE b = 0;
UINT32 runLengthFactor = 0;
UINT32 color = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
return FALSE;
Stream_Read_UINT8(s, b);
Stream_Read_UINT8(s, g);
Stream_Read_UINT8(s, r);
Stream_Read_UINT8(s, runLengthFactor);
suboffset += 4;
color = FreeRDPGetColor(clear->format, r, g, b, 0xFF);
if (runLengthFactor >= 0xFF)
{
if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
return FALSE;
Stream_Read_UINT16(s, runLengthFactor);
suboffset += 2;
if (runLengthFactor >= 0xFFFF)
{
if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
return FALSE;
Stream_Read_UINT32(s, runLengthFactor);
suboffset += 4;
}
}
if ((pixelIndex >= pixelCount) || (runLengthFactor > (pixelCount - pixelIndex)))
{
WLog_ERR(TAG,
"pixelIndex %" PRIu32 " + runLengthFactor %" PRIu32 " > pixelCount %" PRIu32
"",
pixelIndex, runLengthFactor, pixelCount);
return FALSE;
}
for (UINT32 i = 0; i < runLengthFactor; i++)
{
FreeRDPWriteColor(dstBuffer, clear->format, color);
dstBuffer += FreeRDPGetBytesPerPixel(clear->format);
}
pixelIndex += runLengthFactor;
}
nSrcStep = nWidth * FreeRDPGetBytesPerPixel(clear->format);
if (pixelIndex != pixelCount)
{
WLog_ERR(TAG, "pixelIndex %" PRIu32 " != pixelCount %" PRIu32 "", pixelIndex, pixelCount);
return FALSE;
}
return convert_color(pDstData, nDstStep, DstFormat, nXDst, nYDst, nWidth, nHeight,
clear->TempBuffer, nSrcStep, clear->format, nDstWidth, nDstHeight,
palette);
}
static BOOL clear_decompress_subcodecs_data(CLEAR_CONTEXT* WINPR_RESTRICT clear,
wStream* WINPR_RESTRICT s, UINT32 subcodecByteCount,
UINT32 nWidth, UINT32 nHeight,
BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat,
UINT32 nDstStep, UINT32 nXDst, UINT32 nYDst,
UINT32 nDstWidth, UINT32 nDstHeight,
const gdiPalette* WINPR_RESTRICT palette)
{
UINT16 xStart = 0;
UINT16 yStart = 0;
UINT16 width = 0;
UINT16 height = 0;
UINT32 bitmapDataByteCount = 0;
BYTE subcodecId = 0;
UINT32 suboffset = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, subcodecByteCount))
return FALSE;
suboffset = 0;
while (suboffset < subcodecByteCount)
{
UINT32 nXDstRel = 0;
UINT32 nYDstRel = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, 13))
return FALSE;
Stream_Read_UINT16(s, xStart);
Stream_Read_UINT16(s, yStart);
Stream_Read_UINT16(s, width);
Stream_Read_UINT16(s, height);
Stream_Read_UINT32(s, bitmapDataByteCount);
Stream_Read_UINT8(s, subcodecId);
suboffset += 13;
if (!Stream_CheckAndLogRequiredLength(TAG, s, bitmapDataByteCount))
return FALSE;
nXDstRel = nXDst + xStart;
nYDstRel = nYDst + yStart;
if (1ull * xStart + width > nWidth)
{
WLog_ERR(TAG, "xStart %" PRIu16 " + width %" PRIu16 " > nWidth %" PRIu32 "", xStart,
width, nWidth);
return FALSE;
}
if (1ull * yStart + height > nHeight)
{
WLog_ERR(TAG, "yStart %" PRIu16 " + height %" PRIu16 " > nHeight %" PRIu32 "", yStart,
height, nHeight);
return FALSE;
}
if (!clear_resize_buffer(clear, width, height))
return FALSE;
switch (subcodecId)
{
case 0: /* Uncompressed */
{
const UINT32 nSrcStep = width * FreeRDPGetBytesPerPixel(PIXEL_FORMAT_BGR24);
const size_t nSrcSize = 1ull * nSrcStep * height;
if (bitmapDataByteCount != nSrcSize)
{
WLog_ERR(TAG, "bitmapDataByteCount %" PRIu32 " != nSrcSize %" PRIuz "",
bitmapDataByteCount, nSrcSize);
return FALSE;
}
if (!convert_color(pDstData, nDstStep, DstFormat, nXDstRel, nYDstRel, width, height,
Stream_Pointer(s), nSrcStep, PIXEL_FORMAT_BGR24, nDstWidth,
nDstHeight, palette))
return FALSE;
Stream_Seek(s, bitmapDataByteCount);
}
break;
case 1: /* NSCodec */
if (!clear_decompress_nscodec(clear->nsc, width, height, s, bitmapDataByteCount,
pDstData, DstFormat, nDstStep, nXDstRel, nYDstRel))
return FALSE;
break;
case 2: /* CLEARCODEC_SUBCODEC_RLEX */
if (!clear_decompress_subcode_rlex(s, bitmapDataByteCount, width, height, pDstData,
DstFormat, nDstStep, nXDstRel, nYDstRel,
nDstWidth, nDstHeight))
return FALSE;
break;
default:
WLog_ERR(TAG, "Unknown subcodec ID %" PRIu8 "", subcodecId);
return FALSE;
}
suboffset += bitmapDataByteCount;
}
return TRUE;
}
static BOOL resize_vbar_entry(CLEAR_CONTEXT* WINPR_RESTRICT clear,
CLEAR_VBAR_ENTRY* WINPR_RESTRICT vBarEntry)
{
if (vBarEntry->count > vBarEntry->size)
{
const UINT32 bpp = FreeRDPGetBytesPerPixel(clear->format);
const UINT32 oldPos = vBarEntry->size * bpp;
const UINT32 diffSize = (vBarEntry->count - vBarEntry->size) * bpp;
vBarEntry->size = vBarEntry->count;
BYTE* tmp =
(BYTE*)winpr_aligned_recalloc(vBarEntry->pixels, vBarEntry->count, 1ull * bpp, 32);
if (!tmp)
{
WLog_ERR(TAG, "vBarEntry->pixels winpr_aligned_recalloc %" PRIu32 " failed",
vBarEntry->count * bpp);
return FALSE;
}
memset(&tmp[oldPos], 0, diffSize);
vBarEntry->pixels = tmp;
}
if (!vBarEntry->pixels && vBarEntry->size)
{
WLog_ERR(TAG, "vBarEntry->pixels is NULL but vBarEntry->size is %" PRIu32 "",
vBarEntry->size);
return FALSE;
}
return TRUE;
}
static BOOL clear_decompress_bands_data(CLEAR_CONTEXT* WINPR_RESTRICT clear,
wStream* WINPR_RESTRICT s, UINT32 bandsByteCount,
UINT32 nWidth, UINT32 nHeight,
BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat,
UINT32 nDstStep, UINT32 nXDst, UINT32 nYDst,
UINT32 nDstWidth, UINT32 nDstHeight)
{
UINT32 suboffset = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, bandsByteCount))
return FALSE;
while (suboffset < bandsByteCount)
{
BYTE cr = 0;
BYTE cg = 0;
BYTE cb = 0;
UINT16 xStart = 0;
UINT16 xEnd = 0;
UINT16 yStart = 0;
UINT16 yEnd = 0;
UINT32 colorBkg = 0;
UINT16 vBarHeader = 0;
UINT16 vBarYOn = 0;
UINT16 vBarYOff = 0;
UINT32 vBarCount = 0;
UINT32 vBarPixelCount = 0;
UINT32 vBarShortPixelCount = 0;
if (!Stream_CheckAndLogRequiredLength(TAG, s, 11))
return FALSE;
Stream_Read_UINT16(s, xStart);
Stream_Read_UINT16(s, xEnd);
Stream_Read_UINT16(s, yStart);
Stream_Read_UINT16(s, yEnd);
Stream_Read_UINT8(s, cb);
Stream_Read_UINT8(s, cg);
Stream_Read_UINT8(s, cr);
suboffset += 11;
colorBkg = FreeRDPGetColor(clear->format, cr, cg, cb, 0xFF);
if (xEnd < xStart)
{
WLog_ERR(TAG, "xEnd %" PRIu16 " < xStart %" PRIu16 "", xEnd, xStart);
return FALSE;
}
if (yEnd < yStart)
{
WLog_ERR(TAG, "yEnd %" PRIu16 " < yStart %" PRIu16 "", yEnd, yStart);
return FALSE;
}
vBarCount = (xEnd - xStart) + 1;
for (UINT32 i = 0; i < vBarCount; i++)
{
UINT32 vBarHeight = 0;
CLEAR_VBAR_ENTRY* vBarEntry = NULL;
CLEAR_VBAR_ENTRY* vBarShortEntry = NULL;
BOOL vBarUpdate = FALSE;
const BYTE* cpSrcPixel = NULL;
if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
return FALSE;
Stream_Read_UINT16(s, vBarHeader);
suboffset += 2;
vBarHeight = (yEnd - yStart + 1);
if (vBarHeight > 52)
{
WLog_ERR(TAG, "vBarHeight (%" PRIu32 ") > 52", vBarHeight);
return FALSE;
}
if ((vBarHeader & 0xC000) == 0x4000) /* SHORT_VBAR_CACHE_HIT */
{
const UINT16 vBarIndex = (vBarHeader & 0x3FFF);
vBarShortEntry = &(clear->ShortVBarStorage[vBarIndex]);
if (!vBarShortEntry)
{
WLog_ERR(TAG, "missing vBarShortEntry %" PRIu16 "", vBarIndex);
return FALSE;
}
if (!Stream_CheckAndLogRequiredLength(TAG, s, 1))
return FALSE;
Stream_Read_UINT8(s, vBarYOn);
suboffset += 1;
vBarShortPixelCount = vBarShortEntry->count;
vBarUpdate = TRUE;
}
else if ((vBarHeader & 0xC000) == 0x0000) /* SHORT_VBAR_CACHE_MISS */
{
vBarYOn = (vBarHeader & 0xFF);
vBarYOff = ((vBarHeader >> 8) & 0x3F);
if (vBarYOff < vBarYOn)
{
WLog_ERR(TAG, "vBarYOff %" PRIu16 " < vBarYOn %" PRIu16 "", vBarYOff, vBarYOn);
return FALSE;
}
vBarShortPixelCount = (vBarYOff - vBarYOn);
if (vBarShortPixelCount > 52)
{
WLog_ERR(TAG, "vBarShortPixelCount %" PRIu32 " > 52", vBarShortPixelCount);
return FALSE;
}
if (!Stream_CheckAndLogRequiredLengthOfSize(TAG, s, vBarShortPixelCount, 3ull))
return FALSE;
if (clear->ShortVBarStorageCursor >= CLEARCODEC_VBAR_SHORT_SIZE)
{
WLog_ERR(TAG,
"clear->ShortVBarStorageCursor %" PRIu32
" >= CLEARCODEC_VBAR_SHORT_SIZE (%" PRIu32 ")",
clear->ShortVBarStorageCursor, CLEARCODEC_VBAR_SHORT_SIZE);
return FALSE;
}
vBarShortEntry = &(clear->ShortVBarStorage[clear->ShortVBarStorageCursor]);
vBarShortEntry->count = vBarShortPixelCount;
if (!resize_vbar_entry(clear, vBarShortEntry))
return FALSE;
for (size_t y = 0; y < vBarShortPixelCount; y++)
{
BYTE r = 0;
BYTE g = 0;
BYTE b = 0;
BYTE* dstBuffer =
&vBarShortEntry->pixels[y * FreeRDPGetBytesPerPixel(clear->format)];
UINT32 color = 0;
Stream_Read_UINT8(s, b);
Stream_Read_UINT8(s, g);
Stream_Read_UINT8(s, r);
color = FreeRDPGetColor(clear->format, r, g, b, 0xFF);
if (!FreeRDPWriteColor(dstBuffer, clear->format, color))
return FALSE;
}
suboffset += (vBarShortPixelCount * 3);
clear->ShortVBarStorageCursor =
(clear->ShortVBarStorageCursor + 1) % CLEARCODEC_VBAR_SHORT_SIZE;
vBarUpdate = TRUE;
}
else if ((vBarHeader & 0x8000) == 0x8000) /* VBAR_CACHE_HIT */
{
const UINT16 vBarIndex = (vBarHeader & 0x7FFF);
vBarEntry = &(clear->VBarStorage[vBarIndex]);
/* If the cache was reset we need to fill in some dummy data. */
if (vBarEntry->size == 0)
{
WLog_WARN(TAG, "Empty cache index %" PRIu16 ", filling dummy data", vBarIndex);
vBarEntry->count = vBarHeight;
if (!resize_vbar_entry(clear, vBarEntry))
return FALSE;
}
}
else
{
WLog_ERR(TAG, "invalid vBarHeader 0x%04" PRIX16 "", vBarHeader);
return FALSE; /* invalid vBarHeader */
}
if (vBarUpdate)
{
BYTE* pSrcPixel = NULL;
BYTE* dstBuffer = NULL;
if (clear->VBarStorageCursor >= CLEARCODEC_VBAR_SIZE)
{
WLog_ERR(TAG,
"clear->VBarStorageCursor %" PRIu32 " >= CLEARCODEC_VBAR_SIZE %" PRIu32
"",
clear->VBarStorageCursor, CLEARCODEC_VBAR_SIZE);
return FALSE;
}
vBarEntry = &(clear->VBarStorage[clear->VBarStorageCursor]);
vBarPixelCount = vBarHeight;
vBarEntry->count = vBarPixelCount;
if (!resize_vbar_entry(clear, vBarEntry))
return FALSE;
dstBuffer = vBarEntry->pixels;
/* if (y < vBarYOn), use colorBkg */
UINT32 y = 0;
UINT32 count = vBarYOn;
if ((y + count) > vBarPixelCount)
count = (vBarPixelCount > y) ? (vBarPixelCount - y) : 0;
if (count > 0)
{
while (count--)
{
FreeRDPWriteColor(dstBuffer, clear->format, colorBkg);
dstBuffer += FreeRDPGetBytesPerPixel(clear->format);
}
}
/*
* if ((y >= vBarYOn) && (y < (vBarYOn + vBarShortPixelCount))),
* use vBarShortPixels at index (y - shortVBarYOn)
*/
y = vBarYOn;
count = vBarShortPixelCount;
if ((y + count) > vBarPixelCount)
count = (vBarPixelCount > y) ? (vBarPixelCount - y) : 0;
if (count > 0)
{
const size_t offset =
(1ull * y - vBarYOn) * FreeRDPGetBytesPerPixel(clear->format);
pSrcPixel = &vBarShortEntry->pixels[offset];
if (offset + count > vBarShortEntry->count)
{
WLog_ERR(TAG, "offset + count > vBarShortEntry->count");
return FALSE;
}
}
for (size_t x = 0; x < count; x++)
{
UINT32 color = 0;
color = FreeRDPReadColor(&pSrcPixel[x * FreeRDPGetBytesPerPixel(clear->format)],
clear->format);
if (!FreeRDPWriteColor(dstBuffer, clear->format, color))
return FALSE;
dstBuffer += FreeRDPGetBytesPerPixel(clear->format);
}
/* if (y >= (vBarYOn + vBarShortPixelCount)), use colorBkg */
y = vBarYOn + vBarShortPixelCount;
count = (vBarPixelCount > y) ? (vBarPixelCount - y) : 0;
if (count > 0)
{
while (count--)
{
if (!FreeRDPWriteColor(dstBuffer, clear->format, colorBkg))
return FALSE;
dstBuffer += FreeRDPGetBytesPerPixel(clear->format);
}
}
vBarEntry->count = vBarPixelCount;
clear->VBarStorageCursor = (clear->VBarStorageCursor + 1) % CLEARCODEC_VBAR_SIZE;
}
if (vBarEntry->count != vBarHeight)
{
WLog_ERR(TAG, "vBarEntry->count %" PRIu32 " != vBarHeight %" PRIu32 "",
vBarEntry->count, vBarHeight);
vBarEntry->count = vBarHeight;
if (!resize_vbar_entry(clear, vBarEntry))
return FALSE;
}
const UINT32 nXDstRel = nXDst + xStart;
const UINT32 nYDstRel = nYDst + yStart;
cpSrcPixel = vBarEntry->pixels;
if (i < nWidth)
{
UINT32 count = vBarEntry->count;
if (count > nHeight)
count = nHeight;
if (nXDstRel + i > nDstWidth)
return FALSE;
for (UINT32 y = 0; y < count; y++)
{
if (nYDstRel + y > nDstHeight)
return FALSE;
BYTE* pDstPixel8 =
&pDstData[((nYDstRel + y) * nDstStep) +
((nXDstRel + i) * FreeRDPGetBytesPerPixel(DstFormat))];
UINT32 color = FreeRDPReadColor(cpSrcPixel, clear->format);
color = FreeRDPConvertColor(color, clear->format, DstFormat, NULL);
if (!FreeRDPWriteColor(pDstPixel8, DstFormat, color))
return FALSE;
cpSrcPixel += FreeRDPGetBytesPerPixel(clear->format);
}
}
}
}
return TRUE;
}
static BOOL clear_decompress_glyph_data(CLEAR_CONTEXT* WINPR_RESTRICT clear,
wStream* WINPR_RESTRICT s, UINT32 glyphFlags, UINT32 nWidth,
UINT32 nHeight, BYTE* WINPR_RESTRICT pDstData,
UINT32 DstFormat, UINT32 nDstStep, UINT32 nXDst,
UINT32 nYDst, UINT32 nDstWidth, UINT32 nDstHeight,
const gdiPalette* WINPR_RESTRICT palette,
BYTE** WINPR_RESTRICT ppGlyphData)
{
UINT16 glyphIndex = 0;
if (ppGlyphData)
*ppGlyphData = NULL;
if ((glyphFlags & CLEARCODEC_FLAG_GLYPH_HIT) && !(glyphFlags & CLEARCODEC_FLAG_GLYPH_INDEX))
{
WLog_ERR(TAG, "Invalid glyph flags %08" PRIX32 "", glyphFlags);
return FALSE;
}
if ((glyphFlags & CLEARCODEC_FLAG_GLYPH_INDEX) == 0)
return TRUE;
if ((nWidth * nHeight) > (1024 * 1024))
{
WLog_ERR(TAG, "glyph too large: %" PRIu32 "x%" PRIu32 "", nWidth, nHeight);
return FALSE;
}
if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
return FALSE;
Stream_Read_UINT16(s, glyphIndex);
if (glyphIndex >= 4000)
{
WLog_ERR(TAG, "Invalid glyphIndex %" PRIu16 "", glyphIndex);
return FALSE;
}
if (glyphFlags & CLEARCODEC_FLAG_GLYPH_HIT)
{
UINT32 nSrcStep = 0;
CLEAR_GLYPH_ENTRY* glyphEntry = &(clear->GlyphCache[glyphIndex]);
BYTE* glyphData = NULL;
if (!glyphEntry)
{
WLog_ERR(TAG, "clear->GlyphCache[%" PRIu16 "]=NULL", glyphIndex);
return FALSE;
}
glyphData = (BYTE*)glyphEntry->pixels;
if (!glyphData)
{
WLog_ERR(TAG, "clear->GlyphCache[%" PRIu16 "]->pixels=NULL", glyphIndex);
return FALSE;
}
if ((nWidth * nHeight) > glyphEntry->count)
{
WLog_ERR(TAG,
"(nWidth %" PRIu32 " * nHeight %" PRIu32 ") > glyphEntry->count %" PRIu32 "",
nWidth, nHeight, glyphEntry->count);
return FALSE;
}
nSrcStep = nWidth * FreeRDPGetBytesPerPixel(clear->format);
return convert_color(pDstData, nDstStep, DstFormat, nXDst, nYDst, nWidth, nHeight,
glyphData, nSrcStep, clear->format, nDstWidth, nDstHeight, palette);
}
if (glyphFlags & CLEARCODEC_FLAG_GLYPH_INDEX)
{
const UINT32 bpp = FreeRDPGetBytesPerPixel(clear->format);
CLEAR_GLYPH_ENTRY* glyphEntry = &(clear->GlyphCache[glyphIndex]);
glyphEntry->count = nWidth * nHeight;
if (glyphEntry->count > glyphEntry->size)
{
BYTE* tmp =
winpr_aligned_recalloc(glyphEntry->pixels, glyphEntry->count, 1ull * bpp, 32);
if (!tmp)
{
WLog_ERR(TAG, "glyphEntry->pixels winpr_aligned_recalloc %" PRIu32 " failed!",
glyphEntry->count * bpp);
return FALSE;
}
glyphEntry->size = glyphEntry->count;
glyphEntry->pixels = (UINT32*)tmp;
}
if (!glyphEntry->pixels)
{
WLog_ERR(TAG, "glyphEntry->pixels=NULL");
return FALSE;
}
if (ppGlyphData)
*ppGlyphData = (BYTE*)glyphEntry->pixels;
return TRUE;
}
return TRUE;
}
static INLINE BOOL updateContextFormat(CLEAR_CONTEXT* WINPR_RESTRICT clear, UINT32 DstFormat)
{
if (!clear || !clear->nsc)
return FALSE;
clear->format = DstFormat;
return nsc_context_set_parameters(clear->nsc, NSC_COLOR_FORMAT, DstFormat);
}
INT32 clear_decompress(CLEAR_CONTEXT* WINPR_RESTRICT clear, const BYTE* WINPR_RESTRICT pSrcData,
UINT32 SrcSize, UINT32 nWidth, UINT32 nHeight, BYTE* WINPR_RESTRICT pDstData,
UINT32 DstFormat, UINT32 nDstStep, UINT32 nXDst, UINT32 nYDst,
UINT32 nDstWidth, UINT32 nDstHeight,
const gdiPalette* WINPR_RESTRICT palette)
{
INT32 rc = -1;
BYTE seqNumber = 0;
BYTE glyphFlags = 0;
UINT32 residualByteCount = 0;
UINT32 bandsByteCount = 0;
UINT32 subcodecByteCount = 0;
wStream sbuffer = { 0 };
wStream* s = NULL;
BYTE* glyphData = NULL;
if (!pDstData)
return -1002;
if ((nDstWidth == 0) || (nDstHeight == 0))
return -1022;
if ((nWidth > 0xFFFF) || (nHeight > 0xFFFF))
return -1004;
s = Stream_StaticConstInit(&sbuffer, pSrcData, SrcSize);
if (!s)
return -2005;
if (!Stream_CheckAndLogRequiredLength(TAG, s, 2))
goto fail;
if (!updateContextFormat(clear, DstFormat))
goto fail;
Stream_Read_UINT8(s, glyphFlags);
Stream_Read_UINT8(s, seqNumber);
if (!clear->seqNumber && seqNumber)
clear->seqNumber = seqNumber;
if (seqNumber != clear->seqNumber)
{
WLog_ERR(TAG, "Sequence number unexpected %" PRIu8 " - %" PRIu32 "", seqNumber,
clear->seqNumber);
WLog_ERR(TAG, "seqNumber %" PRIu8 " != clear->seqNumber %" PRIu32 "", seqNumber,
clear->seqNumber);
goto fail;
}
clear->seqNumber = (seqNumber + 1) % 256;
if (glyphFlags & CLEARCODEC_FLAG_CACHE_RESET)
{
clear_reset_vbar_storage(clear, FALSE);
}
if (!clear_decompress_glyph_data(clear, s, glyphFlags, nWidth, nHeight, pDstData, DstFormat,
nDstStep, nXDst, nYDst, nDstWidth, nDstHeight, palette,
&glyphData))
{
WLog_ERR(TAG, "clear_decompress_glyph_data failed!");
goto fail;
}
/* Read composition payload header parameters */
if (Stream_GetRemainingLength(s) < 12)
{
const UINT32 mask = (CLEARCODEC_FLAG_GLYPH_HIT | CLEARCODEC_FLAG_GLYPH_INDEX);
if ((glyphFlags & mask) == mask)
goto finish;
WLog_ERR(TAG,
"invalid glyphFlags, missing flags: 0x%02" PRIx8 " & 0x%02" PRIx32
" == 0x%02" PRIx32,
glyphFlags, mask, glyphFlags & mask);
goto fail;
}
Stream_Read_UINT32(s, residualByteCount);
Stream_Read_UINT32(s, bandsByteCount);
Stream_Read_UINT32(s, subcodecByteCount);
if (residualByteCount > 0)
{
if (!clear_decompress_residual_data(clear, s, residualByteCount, nWidth, nHeight, pDstData,
DstFormat, nDstStep, nXDst, nYDst, nDstWidth,
nDstHeight, palette))
{
WLog_ERR(TAG, "clear_decompress_residual_data failed!");
goto fail;
}
}
if (bandsByteCount > 0)
{
if (!clear_decompress_bands_data(clear, s, bandsByteCount, nWidth, nHeight, pDstData,
DstFormat, nDstStep, nXDst, nYDst, nDstWidth, nDstHeight))
{
WLog_ERR(TAG, "clear_decompress_bands_data failed!");
goto fail;
}
}
if (subcodecByteCount > 0)
{
if (!clear_decompress_subcodecs_data(clear, s, subcodecByteCount, nWidth, nHeight, pDstData,
DstFormat, nDstStep, nXDst, nYDst, nDstWidth,
nDstHeight, palette))
{
WLog_ERR(TAG, "clear_decompress_subcodecs_data failed!");
goto fail;
}
}
if (glyphData)
{
if (!freerdp_image_copy_no_overlap(glyphData, clear->format, 0, 0, 0, nWidth, nHeight,
pDstData, DstFormat, nDstStep, nXDst, nYDst, palette,
FREERDP_KEEP_DST_ALPHA))
goto fail;
}
finish:
rc = 0;
fail:
return rc;
}
int clear_compress(CLEAR_CONTEXT* WINPR_RESTRICT clear, const BYTE* WINPR_RESTRICT pSrcData,
UINT32 SrcSize, BYTE** WINPR_RESTRICT ppDstData, UINT32* WINPR_RESTRICT pDstSize)
{
WLog_ERR(TAG, "TODO: not implemented!");
return 1;
}
BOOL clear_context_reset(CLEAR_CONTEXT* WINPR_RESTRICT clear)
{
if (!clear)
return FALSE;
/**
* The ClearCodec context is not bound to a particular surface,
* and its internal caches must NOT be reset on the ResetGraphics PDU.
*/
clear->seqNumber = 0;
return TRUE;
}
CLEAR_CONTEXT* clear_context_new(BOOL Compressor)
{
CLEAR_CONTEXT* clear = (CLEAR_CONTEXT*)winpr_aligned_calloc(1, sizeof(CLEAR_CONTEXT), 32);
if (!clear)
return NULL;
clear->Compressor = Compressor;
clear->nsc = nsc_context_new();
if (!clear->nsc)
goto error_nsc;
if (!updateContextFormat(clear, PIXEL_FORMAT_BGRX32))
goto error_nsc;
if (!clear_resize_buffer(clear, 512, 512))
goto error_nsc;
if (!clear->TempBuffer)
goto error_nsc;
if (!clear_context_reset(clear))
goto error_nsc;
return clear;
error_nsc:
WINPR_PRAGMA_DIAG_PUSH
WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
clear_context_free(clear);
WINPR_PRAGMA_DIAG_POP
return NULL;
}
void clear_context_free(CLEAR_CONTEXT* clear)
{
if (!clear)
return;
nsc_context_free(clear->nsc);
winpr_aligned_free(clear->TempBuffer);
clear_reset_vbar_storage(clear, TRUE);
clear_reset_glyph_cache(clear);
winpr_aligned_free(clear);
}