24#include <winpr/assert.h>
25#include <winpr/cast.h>
26#include <freerdp/config.h>
28#include <freerdp/codec/interleaved.h>
29#include <freerdp/log.h>
31#define TAG FREERDP_TAG("codec")
33#define UNROLL_BODY(_exp, _count) \
36 for (size_t x = 0; x < (_count); x++) \
45#define UNROLL_MULTIPLE(_condition, _exp, _count) \
48 while ((_condition) >= (_count)) \
50 UNROLL_BODY(_exp, _count); \
51 (_condition) -= (_count); \
55#define UNROLL(_condition, _exp) \
58 UNROLL_MULTIPLE(_condition, _exp, 16); \
59 UNROLL_MULTIPLE(_condition, _exp, 4); \
60 UNROLL_MULTIPLE(_condition, _exp, 1); \
70#define REGULAR_BG_RUN 0x00
71#define MEGA_MEGA_BG_RUN 0xF0
72#define REGULAR_FG_RUN 0x01
73#define MEGA_MEGA_FG_RUN 0xF1
74#define LITE_SET_FG_FG_RUN 0x0C
75#define MEGA_MEGA_SET_FG_RUN 0xF6
76#define LITE_DITHERED_RUN 0x0E
77#define MEGA_MEGA_DITHERED_RUN 0xF8
78#define REGULAR_COLOR_RUN 0x03
79#define MEGA_MEGA_COLOR_RUN 0xF3
80#define REGULAR_FGBG_IMAGE 0x02
81#define MEGA_MEGA_FGBG_IMAGE 0xF2
82#define LITE_SET_FG_FGBG_IMAGE 0x0D
83#define MEGA_MEGA_SET_FGBG_IMAGE 0xF7
84#define REGULAR_COLOR_IMAGE 0x04
85#define MEGA_MEGA_COLOR_IMAGE 0xF4
86#define SPECIAL_FGBG_1 0xF9
87#define SPECIAL_FGBG_2 0xFA
88#define SPECIAL_WHITE 0xFD
89#define SPECIAL_BLACK 0xFE
91#define BLACK_PIXEL 0x000000
95static const BYTE g_MaskSpecialFgBg1 = 0x03;
96static const BYTE g_MaskSpecialFgBg2 = 0x05;
98static const BYTE g_MaskRegularRunLength = 0x1F;
99static const BYTE g_MaskLiteRunLength = 0x0F;
101#if defined(WITH_DEBUG_CODECS)
102static const char* rle_code_str(UINT32 code)
107 return "REGULAR_BG_RUN";
108 case MEGA_MEGA_BG_RUN:
109 return "MEGA_MEGA_BG_RUN";
111 return "REGULAR_FG_RUN";
112 case MEGA_MEGA_FG_RUN:
113 return "MEGA_MEGA_FG_RUN";
114 case LITE_SET_FG_FG_RUN:
115 return "LITE_SET_FG_FG_RUN";
116 case MEGA_MEGA_SET_FG_RUN:
117 return "MEGA_MEGA_SET_FG_RUN";
118 case LITE_DITHERED_RUN:
119 return "LITE_DITHERED_RUN";
120 case MEGA_MEGA_DITHERED_RUN:
121 return "MEGA_MEGA_DITHERED_RUN";
122 case REGULAR_COLOR_RUN:
123 return "REGULAR_COLOR_RUN";
124 case MEGA_MEGA_COLOR_RUN:
125 return "MEGA_MEGA_COLOR_RUN";
126 case REGULAR_FGBG_IMAGE:
127 return "REGULAR_FGBG_IMAGE";
128 case MEGA_MEGA_FGBG_IMAGE:
129 return "MEGA_MEGA_FGBG_IMAGE";
130 case LITE_SET_FG_FGBG_IMAGE:
131 return "LITE_SET_FG_FGBG_IMAGE";
132 case MEGA_MEGA_SET_FGBG_IMAGE:
133 return "MEGA_MEGA_SET_FGBG_IMAGE";
134 case REGULAR_COLOR_IMAGE:
135 return "REGULAR_COLOR_IMAGE";
136 case MEGA_MEGA_COLOR_IMAGE:
137 return "MEGA_MEGA_COLOR_IMAGE";
139 return "SPECIAL_FGBG_1";
141 return "SPECIAL_FGBG_2";
143 return "SPECIAL_WHITE";
145 return "SPECIAL_BLACK";
152#define buffer_within_range(pbSrc, size, pbEnd) \
153 buffer_within_range_((pbSrc), (size), (pbEnd), __func__, __FILE__, __LINE__)
154static INLINE BOOL buffer_within_range_(
const void* pbSrc,
size_t size,
const void* pbEnd,
155 const char* fkt,
const char* file,
size_t line)
161 if ((
const char*)pbSrc + size > (
const char*)pbEnd)
163 WLog_ERR(TAG,
"[%s:%" PRIuz
"] pbSrc=%p + %" PRIuz
" > pbEnd=%p", fkt, line, pbSrc, size,
174static INLINE UINT32 ExtractCodeId(BYTE bOrderHdr)
176 if ((bOrderHdr & 0xC0U) != 0xC0U)
181 return bOrderHdr >> 5;
183 else if ((bOrderHdr & 0xF0U) == 0xF0U)
193 return bOrderHdr >> 4;
200static UINT ExtractRunLengthRegularFgBg(
const BYTE* pbOrderHdr,
const BYTE* pbEnd, UINT32* advance)
204 WINPR_ASSERT(pbOrderHdr);
206 WINPR_ASSERT(advance);
208 runLength = (*pbOrderHdr) & g_MaskRegularRunLength;
211 if (!buffer_within_range(pbOrderHdr, 2, pbEnd))
216 runLength = *(pbOrderHdr + 1) + 1;
220 runLength = runLength * 8;
225static UINT ExtractRunLengthLiteFgBg(
const BYTE* pbOrderHdr,
const BYTE* pbEnd, UINT32* advance)
229 WINPR_ASSERT(pbOrderHdr);
231 WINPR_ASSERT(advance);
233 runLength = *pbOrderHdr & g_MaskLiteRunLength;
236 if (!buffer_within_range(pbOrderHdr, 2, pbEnd))
241 runLength = *(pbOrderHdr + 1) + 1;
245 runLength = runLength * 8;
250static UINT ExtractRunLengthRegular(
const BYTE* pbOrderHdr,
const BYTE* pbEnd, UINT32* advance)
254 WINPR_ASSERT(pbOrderHdr);
256 WINPR_ASSERT(advance);
258 runLength = *pbOrderHdr & g_MaskRegularRunLength;
261 if (!buffer_within_range(pbOrderHdr, 2, pbEnd))
266 runLength = *(pbOrderHdr + 1) + 32;
273static UINT ExtractRunLengthMegaMega(
const BYTE* pbOrderHdr,
const BYTE* pbEnd, UINT32* advance)
277 WINPR_ASSERT(pbOrderHdr);
279 WINPR_ASSERT(advance);
281 if (!buffer_within_range(pbOrderHdr, 3, pbEnd))
287 runLength = ((UINT16)pbOrderHdr[1]) | ((((UINT16)pbOrderHdr[2]) << 8) & 0xFF00);
293static UINT ExtractRunLengthLite(
const BYTE* pbOrderHdr,
const BYTE* pbEnd, UINT32* advance)
297 WINPR_ASSERT(pbOrderHdr);
299 WINPR_ASSERT(advance);
301 runLength = *pbOrderHdr & g_MaskLiteRunLength;
304 if (!buffer_within_range(pbOrderHdr, 2, pbEnd))
309 runLength = *(pbOrderHdr + 1) + 16;
315static INLINE UINT32 ExtractRunLength(UINT32 code,
const BYTE* pbOrderHdr,
const BYTE* pbEnd,
318 UINT32 runLength = 0;
321 WINPR_ASSERT(pbOrderHdr);
323 WINPR_ASSERT(advance);
325#if defined(WITH_DEBUG_CODECS)
326 WLog_VRB(TAG,
"extracting %s", rle_code_str(code));
330 if (!buffer_within_range(pbOrderHdr, 0, pbEnd))
335 case REGULAR_FGBG_IMAGE:
336 runLength = ExtractRunLengthRegularFgBg(pbOrderHdr, pbEnd, &ladvance);
339 case LITE_SET_FG_FGBG_IMAGE:
340 runLength = ExtractRunLengthLiteFgBg(pbOrderHdr, pbEnd, &ladvance);
345 case REGULAR_COLOR_RUN:
346 case REGULAR_COLOR_IMAGE:
347 runLength = ExtractRunLengthRegular(pbOrderHdr, pbEnd, &ladvance);
350 case LITE_SET_FG_FG_RUN:
351 case LITE_DITHERED_RUN:
352 runLength = ExtractRunLengthLite(pbOrderHdr, pbEnd, &ladvance);
355 case MEGA_MEGA_BG_RUN:
356 case MEGA_MEGA_FG_RUN:
357 case MEGA_MEGA_SET_FG_RUN:
358 case MEGA_MEGA_DITHERED_RUN:
359 case MEGA_MEGA_COLOR_RUN:
360 case MEGA_MEGA_FGBG_IMAGE:
361 case MEGA_MEGA_SET_FGBG_IMAGE:
362 case MEGA_MEGA_COLOR_IMAGE:
363 runLength = ExtractRunLengthMegaMega(pbOrderHdr, pbEnd, &ladvance);
376#define ensure_capacity(start, end, size, base) \
377 ensure_capacity_((start), (end), (size), (base), __func__, __FILE__, __LINE__)
378static INLINE BOOL ensure_capacity_(
const BYTE* start,
const BYTE* end,
size_t size,
size_t base,
379 const char* fkt, WINPR_ATTR_UNUSED
const char* file,
382 const size_t available = (uintptr_t)end - (uintptr_t)start;
383 const BOOL rc = available >= size * base;
384 const BOOL res = rc && (start <= end);
388 "[%s:%" PRIuz
"] failed: start=%p <= end=%p, available=%" PRIuz
" >= size=%" PRIuz
390 fkt, line, start, end, available, size, base);
394static INLINE
void write_pixel_8(BYTE* _buf, BYTE _pix)
400static INLINE
void write_pixel_24(BYTE* _buf, UINT32 _pix)
403 (_buf)[0] = (BYTE)(_pix);
404 (_buf)[1] = (BYTE)((_pix) >> 8);
405 (_buf)[2] = (BYTE)((_pix) >> 16);
408static INLINE
void write_pixel_16(BYTE* _buf, UINT16 _pix)
411 _buf[0] = _pix & 0xFF;
412 _buf[1] = (_pix >> 8) & 0xFF;
419#undef WRITEFIRSTLINEFGBGIMAGE
427#define WHITE_PIXEL 0xFF
428#define DESTWRITEPIXEL(_buf, _pix) \
431 write_pixel_8(_buf, _pix); \
434#define DESTREADPIXEL(_pix, _buf) _pix = (_buf)[0]
435#define SRCREADPIXEL(_pix, _buf) \
438 (_pix) = (_buf)[0]; \
442#define WRITEFGBGIMAGE WriteFgBgImage8to8
443#define WRITEFIRSTLINEFGBGIMAGE WriteFirstLineFgBgImage8to8
444#define RLEDECOMPRESS RleDecompress8to8
446#undef ENSURE_CAPACITY
447#define ENSURE_CAPACITY(_start, _end, _size) ensure_capacity(_start, _end, _size, 1)
448#include "include/bitmap.h"
454#undef WRITEFIRSTLINEFGBGIMAGE
462#define WHITE_PIXEL 0xFFFF
463#define DESTWRITEPIXEL(_buf, _pix) \
466 write_pixel_16(_buf, _pix); \
469#define DESTREADPIXEL(_pix, _buf) _pix = ((UINT16*)(_buf))[0]
470#define SRCREADPIXEL(_pix, _buf) \
473 (_pix) = WINPR_ASSERTING_INT_CAST(UINT16, (_buf)[0] | (((_buf)[1] << 8) & 0xFF00)); \
476#define WRITEFGBGIMAGE WriteFgBgImage16to16
477#define WRITEFIRSTLINEFGBGIMAGE WriteFirstLineFgBgImage16to16
478#define RLEDECOMPRESS RleDecompress16to16
480#undef ENSURE_CAPACITY
481#define ENSURE_CAPACITY(_start, _end, _size) ensure_capacity(_start, _end, _size, 2)
482#include "include/bitmap.h"
488#undef WRITEFIRSTLINEFGBGIMAGE
496#define WHITE_PIXEL 0xffffff
497#define DESTWRITEPIXEL(_buf, _pix) \
500 write_pixel_24(_buf, _pix); \
503#define DESTREADPIXEL(_pix, _buf) \
504 _pix = (_buf)[0] | (((_buf)[1] << 8) & 0xFF00) | (((_buf)[2] << 16) & 0xFF0000)
505#define SRCREADPIXEL(_pix, _buf) \
508 (_pix) = (_buf)[0] | (((_buf)[1] << 8) & 0xFF00) | (((_buf)[2] << 16) & 0xFF0000); \
512#define WRITEFGBGIMAGE WriteFgBgImage24to24
513#define WRITEFIRSTLINEFGBGIMAGE WriteFirstLineFgBgImage24to24
514#define RLEDECOMPRESS RleDecompress24to24
516#undef ENSURE_CAPACITY
517#define ENSURE_CAPACITY(_start, _end, _size) ensure_capacity(_start, _end, _size, 3)
518#include "include/bitmap.h"
520struct S_BITMAP_INTERLEAVED_CONTEXT
530BOOL interleaved_decompress(BITMAP_INTERLEAVED_CONTEXT* WINPR_RESTRICT interleaved,
531 const BYTE* WINPR_RESTRICT pSrcData, UINT32 SrcSize, UINT32 nSrcWidth,
532 UINT32 nSrcHeight, UINT32 bpp, BYTE* WINPR_RESTRICT pDstData,
533 UINT32 DstFormat, UINT32 nDstStep, UINT32 nXDst, UINT32 nYDst,
534 UINT32 nDstWidth, UINT32 nDstHeight,
535 const gdiPalette* WINPR_RESTRICT palette)
538 UINT32 SrcFormat = 0;
539 UINT32 BufferSize = 0;
541 if (!interleaved || !pSrcData || !pDstData)
543 WLog_ERR(TAG,
"invalid arguments: interleaved=%p, pSrcData=%p, pDstData=%p", interleaved,
551 scanline = nSrcWidth * 3;
552 SrcFormat = PIXEL_FORMAT_BGR24;
556 scanline = nSrcWidth * 2;
557 SrcFormat = PIXEL_FORMAT_RGB16;
561 scanline = nSrcWidth * 2;
562 SrcFormat = PIXEL_FORMAT_RGB15;
566 scanline = nSrcWidth;
567 SrcFormat = PIXEL_FORMAT_RGB8;
571 WLog_ERR(TAG,
"Invalid color depth %" PRIu32
"", bpp);
575 BufferSize = scanline * nSrcHeight;
577 if (BufferSize > interleaved->TempSize)
579 interleaved->TempBuffer =
580 winpr_aligned_recalloc(interleaved->TempBuffer, BufferSize,
sizeof(BYTE), 16);
581 interleaved->TempSize = BufferSize;
584 if (!interleaved->TempBuffer)
586 WLog_ERR(TAG,
"interleaved->TempBuffer=%p", interleaved->TempBuffer);
593 if (!RleDecompress24to24(pSrcData, SrcSize, interleaved->TempBuffer, scanline,
594 nSrcWidth, nSrcHeight))
596 WLog_ERR(TAG,
"RleDecompress24to24 failed");
604 if (!RleDecompress16to16(pSrcData, SrcSize, interleaved->TempBuffer, scanline,
605 nSrcWidth, nSrcHeight))
607 WLog_ERR(TAG,
"RleDecompress16to16 failed");
614 if (!RleDecompress8to8(pSrcData, SrcSize, interleaved->TempBuffer, scanline, nSrcWidth,
617 WLog_ERR(TAG,
"RleDecompress8to8 failed");
624 WLog_ERR(TAG,
"Invalid color depth %" PRIu32
"", bpp);
628 if (!freerdp_image_copy_no_overlap(pDstData, DstFormat, nDstStep, nXDst, nYDst, nDstWidth,
629 nDstHeight, interleaved->TempBuffer, SrcFormat, scanline, 0,
630 0, palette, FREERDP_FLIP_VERTICAL | FREERDP_KEEP_DST_ALPHA))
632 WLog_ERR(TAG,
"freerdp_image_copy failed");
638BOOL interleaved_compress(BITMAP_INTERLEAVED_CONTEXT* WINPR_RESTRICT interleaved,
639 BYTE* WINPR_RESTRICT pDstData, UINT32* WINPR_RESTRICT pDstSize,
640 UINT32 nWidth, UINT32 nHeight,
const BYTE* WINPR_RESTRICT pSrcData,
641 UINT32 SrcFormat, UINT32 nSrcStep, UINT32 nXSrc, UINT32 nYSrc,
642 const gdiPalette* WINPR_RESTRICT palette, UINT32 bpp)
646 UINT32 DstFormat = 0;
647 const UINT32 maxSize = 64 * 64 * 4;
649 if (!interleaved || !pDstData || !pSrcData)
652 if ((nWidth == 0) || (nHeight == 0))
657 WLog_ERR(TAG,
"interleaved_compress: width is not a multiple of 4");
661 if ((nWidth > 64) || (nHeight > 64))
664 "interleaved_compress: width (%" PRIu32
") or height (%" PRIu32
665 ") is greater than 64",
673 DstFormat = PIXEL_FORMAT_BGRX32;
677 DstFormat = PIXEL_FORMAT_RGB16;
681 DstFormat = PIXEL_FORMAT_RGB15;
688 if (!freerdp_image_copy_no_overlap(interleaved->TempBuffer, DstFormat, 0, 0, 0, nWidth, nHeight,
689 pSrcData, SrcFormat, nSrcStep, nXSrc, nYSrc, palette,
690 FREERDP_KEEP_DST_ALPHA))
693 s = Stream_New(pDstData, *pDstSize);
698 Stream_SetPosition(interleaved->bts, 0);
700 if (freerdp_bitmap_compress(interleaved->TempBuffer, nWidth, nHeight, s, bpp, maxSize,
701 nHeight - 1, interleaved->bts, 0) < 0)
706 Stream_SealLength(s);
707 *pDstSize = (UINT32)Stream_Length(s);
708 Stream_Free(s, FALSE);
712BOOL bitmap_interleaved_context_reset(BITMAP_INTERLEAVED_CONTEXT* WINPR_RESTRICT interleaved)
720BITMAP_INTERLEAVED_CONTEXT* bitmap_interleaved_context_new(WINPR_ATTR_UNUSED BOOL Compressor)
722 BITMAP_INTERLEAVED_CONTEXT* interleaved = NULL;
723 interleaved = (BITMAP_INTERLEAVED_CONTEXT*)winpr_aligned_recalloc(
724 NULL, 1,
sizeof(BITMAP_INTERLEAVED_CONTEXT), 32);
728 interleaved->TempSize = 64 * 64 * 4;
729 interleaved->TempBuffer = winpr_aligned_calloc(interleaved->TempSize,
sizeof(BYTE), 16);
731 if (!interleaved->TempBuffer)
734 interleaved->bts = Stream_New(NULL, interleaved->TempSize);
736 if (!interleaved->bts)
743 WINPR_PRAGMA_DIAG_PUSH
744 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
745 bitmap_interleaved_context_free(interleaved);
746 WINPR_PRAGMA_DIAG_POP
750void bitmap_interleaved_context_free(BITMAP_INTERLEAVED_CONTEXT* WINPR_RESTRICT interleaved)
755 winpr_aligned_free(interleaved->TempBuffer);
756 Stream_Free(interleaved->bts, TRUE);
757 winpr_aligned_free(interleaved);