/** * FreeRDP: A Remote Desktop Protocol Implementation * NSCodec Codec * * Copyright 2011 Samsung, Author Jiten Pathy * Copyright 2012 Vic Lee * Copyright 2016 Armin Novak * 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 #include #include #include #include #include #include #include "nsc_types.h" #include "nsc_encode.h" #include "sse/nsc_sse2.h" #include "neon/nsc_neon.h" #include #define TAG FREERDP_TAG("codec.nsc") #ifndef NSC_INIT_SIMD #define NSC_INIT_SIMD(_nsc_context) \ do \ { \ } while (0) #endif static BOOL nsc_decode(NSC_CONTEXT* WINPR_RESTRICT context) { UINT16 rw = 0; BYTE shift = 0; BYTE* bmpdata = NULL; size_t pos = 0; if (!context) return FALSE; rw = ROUND_UP_TO(context->width, 8); shift = context->ColorLossLevel - 1; /* colorloss recovery + YCoCg shift */ bmpdata = context->BitmapData; if (!bmpdata) return FALSE; for (UINT32 y = 0; y < context->height; y++) { const BYTE* yplane = NULL; const BYTE* coplane = NULL; const BYTE* cgplane = NULL; const BYTE* aplane = context->priv->PlaneBuffers[3] + y * context->width; /* A */ if (context->ChromaSubsamplingLevel) { yplane = context->priv->PlaneBuffers[0] + y * rw; /* Y */ coplane = context->priv->PlaneBuffers[1] + (y >> 1) * (rw >> 1); /* Co, supersampled */ cgplane = context->priv->PlaneBuffers[2] + (y >> 1) * (rw >> 1); /* Cg, supersampled */ } else { yplane = context->priv->PlaneBuffers[0] + y * context->width; /* Y */ coplane = context->priv->PlaneBuffers[1] + y * context->width; /* Co */ cgplane = context->priv->PlaneBuffers[2] + y * context->width; /* Cg */ } for (UINT32 x = 0; x < context->width; x++) { INT16 y_val = (INT16)*yplane; INT16 co_val = (INT16)(INT8)(((INT16)*coplane) << shift); INT16 cg_val = (INT16)(INT8)(((INT16)*cgplane) << shift); INT16 r_val = y_val + co_val - cg_val; INT16 g_val = y_val + cg_val; INT16 b_val = y_val - co_val - cg_val; if (pos + 4 > context->BitmapDataLength) return FALSE; pos += 4; *bmpdata++ = MINMAX(b_val, 0, 0xFF); *bmpdata++ = MINMAX(g_val, 0, 0xFF); *bmpdata++ = MINMAX(r_val, 0, 0xFF); *bmpdata++ = *aplane; yplane++; coplane += (context->ChromaSubsamplingLevel ? x % 2 : 1); cgplane += (context->ChromaSubsamplingLevel ? x % 2 : 1); aplane++; } } return TRUE; } static BOOL nsc_rle_decode(const BYTE* WINPR_RESTRICT in, size_t inSize, BYTE* WINPR_RESTRICT out, UINT32 outSize, UINT32 originalSize) { UINT32 left = originalSize; while (left > 4) { if (inSize < 1) return FALSE; inSize--; const BYTE value = *in++; UINT32 len = 0; if (left == 5) { if (outSize < 1) return FALSE; outSize--; *out++ = value; left--; } else if (inSize < 1) return FALSE; else if (value == *in) { inSize--; in++; if (inSize < 1) return FALSE; else if (*in < 0xFF) { inSize--; len = (UINT32)*in++; len += 2; } else { if (inSize < 5) return FALSE; inSize -= 5; in++; len = ((UINT32)(*in++)); len |= ((UINT32)(*in++)) << 8U; len |= ((UINT32)(*in++)) << 16U; len |= ((UINT32)(*in++)) << 24U; } if ((outSize < len) || (left < len)) return FALSE; outSize -= len; FillMemory(out, len, value); out += len; left -= len; } else { if (outSize < 1) return FALSE; outSize--; *out++ = value; left--; } } if ((outSize < 4) || (left < 4)) return FALSE; if (inSize < 4) return FALSE; memcpy(out, in, 4); return TRUE; } static BOOL nsc_rle_decompress_data(NSC_CONTEXT* WINPR_RESTRICT context) { if (!context) return FALSE; const BYTE* rle = context->Planes; size_t rleSize = context->PlanesSize; WINPR_ASSERT(rle); for (size_t i = 0; i < 4; i++) { const UINT32 originalSize = context->OrgByteCount[i]; const UINT32 planeSize = context->PlaneByteCount[i]; if (rleSize < planeSize) return FALSE; if (planeSize == 0) { if (context->priv->PlaneBuffersLength < originalSize) return FALSE; FillMemory(context->priv->PlaneBuffers[i], originalSize, 0xFF); } else if (planeSize < originalSize) { if (!nsc_rle_decode(rle, rleSize, context->priv->PlaneBuffers[i], context->priv->PlaneBuffersLength, originalSize)) return FALSE; } else { if (context->priv->PlaneBuffersLength < originalSize) return FALSE; if (rleSize < originalSize) return FALSE; CopyMemory(context->priv->PlaneBuffers[i], rle, originalSize); } rle += planeSize; rleSize -= planeSize; } return TRUE; } static BOOL nsc_stream_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s) { WINPR_ASSERT(context); WINPR_ASSERT(context->priv); if (!Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, 20)) return FALSE; size_t total = 0; for (size_t i = 0; i < 4; i++) { Stream_Read_UINT32(s, context->PlaneByteCount[i]); total += context->PlaneByteCount[i]; } Stream_Read_UINT8(s, context->ColorLossLevel); /* ColorLossLevel (1 byte) */ if ((context->ColorLossLevel < 1) || (context->ColorLossLevel > 7)) { WLog_Print(context->priv->log, WLOG_ERROR, "ColorLossLevel=%" PRIu8 " out of range, must be [1,7] inclusive", context->ColorLossLevel); return FALSE; } Stream_Read_UINT8(s, context->ChromaSubsamplingLevel); /* ChromaSubsamplingLevel (1 byte) */ Stream_Seek(s, 2); /* Reserved (2 bytes) */ context->Planes = Stream_Pointer(s); context->PlanesSize = total; return Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, total); } static BOOL nsc_context_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s) { if (!nsc_stream_initialize(context, s)) return FALSE; const size_t blength = 4ull * context->width * context->height; if (!context->BitmapData || (blength > context->BitmapDataLength)) { void* tmp = winpr_aligned_recalloc(context->BitmapData, blength + 16, sizeof(BYTE), 32); if (!tmp) return FALSE; context->BitmapData = tmp; context->BitmapDataLength = blength; } const UINT32 tempWidth = ROUND_UP_TO(context->width, 8); const UINT32 tempHeight = ROUND_UP_TO(context->height, 2); /* The maximum length a decoded plane can reach in all cases */ const size_t plength = 1ull * tempWidth * tempHeight; if (plength > context->priv->PlaneBuffersLength) { for (size_t i = 0; i < 4; i++) { void* tmp = (BYTE*)winpr_aligned_recalloc(context->priv->PlaneBuffers[i], plength, sizeof(BYTE), 32); if (!tmp) return FALSE; context->priv->PlaneBuffers[i] = tmp; } context->priv->PlaneBuffersLength = plength; } for (size_t i = 0; i < 4; i++) context->OrgByteCount[i] = context->width * context->height; if (context->ChromaSubsamplingLevel) { context->OrgByteCount[0] = tempWidth * context->height; context->OrgByteCount[1] = (tempWidth >> 1) * (tempHeight >> 1); context->OrgByteCount[2] = context->OrgByteCount[1]; } return TRUE; } static void nsc_profiler_print(NSC_CONTEXT_PRIV* WINPR_RESTRICT priv) { WINPR_UNUSED(priv); PROFILER_PRINT_HEADER PROFILER_PRINT(priv->prof_nsc_rle_decompress_data) PROFILER_PRINT(priv->prof_nsc_decode) PROFILER_PRINT(priv->prof_nsc_rle_compress_data) PROFILER_PRINT(priv->prof_nsc_encode) PROFILER_PRINT_FOOTER } BOOL nsc_context_reset(NSC_CONTEXT* WINPR_RESTRICT context, UINT32 width, UINT32 height) { if (!context) return FALSE; if ((width > UINT16_MAX) || (height > UINT16_MAX)) return FALSE; context->width = (UINT16)width; context->height = (UINT16)height; return TRUE; } NSC_CONTEXT* nsc_context_new(void) { NSC_CONTEXT* context = (NSC_CONTEXT*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT), 32); if (!context) return NULL; context->priv = (NSC_CONTEXT_PRIV*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT_PRIV), 32); if (!context->priv) goto error; context->priv->log = WLog_Get("com.freerdp.codec.nsc"); WLog_OpenAppender(context->priv->log); context->BitmapData = NULL; context->decode = nsc_decode; context->encode = nsc_encode; PROFILER_CREATE(context->priv->prof_nsc_rle_decompress_data, "nsc_rle_decompress_data") PROFILER_CREATE(context->priv->prof_nsc_decode, "nsc_decode") PROFILER_CREATE(context->priv->prof_nsc_rle_compress_data, "nsc_rle_compress_data") PROFILER_CREATE(context->priv->prof_nsc_encode, "nsc_encode") /* Default encoding parameters */ context->ColorLossLevel = 3; context->ChromaSubsamplingLevel = 1; /* init optimized methods */ nsc_init_sse2(context); nsc_init_neon(context); return context; error: WINPR_PRAGMA_DIAG_PUSH WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC nsc_context_free(context); WINPR_PRAGMA_DIAG_POP return NULL; } void nsc_context_free(NSC_CONTEXT* context) { if (!context) return; if (context->priv) { for (size_t i = 0; i < 5; i++) winpr_aligned_free(context->priv->PlaneBuffers[i]); nsc_profiler_print(context->priv); PROFILER_FREE(context->priv->prof_nsc_rle_decompress_data) PROFILER_FREE(context->priv->prof_nsc_decode) PROFILER_FREE(context->priv->prof_nsc_rle_compress_data) PROFILER_FREE(context->priv->prof_nsc_encode) winpr_aligned_free(context->priv); } winpr_aligned_free(context->BitmapData); winpr_aligned_free(context); } #if defined(WITH_FREERDP_DEPRECATED) BOOL nsc_context_set_pixel_format(NSC_CONTEXT* context, UINT32 pixel_format) { return nsc_context_set_parameters(context, NSC_COLOR_FORMAT, pixel_format); } #endif BOOL nsc_context_set_parameters(NSC_CONTEXT* context, NSC_PARAMETER what, UINT32 value) { if (!context) return FALSE; switch (what) { case NSC_COLOR_LOSS_LEVEL: context->ColorLossLevel = value; break; case NSC_ALLOW_SUBSAMPLING: context->ChromaSubsamplingLevel = value; break; case NSC_DYNAMIC_COLOR_FIDELITY: context->DynamicColorFidelity = value != 0; break; case NSC_COLOR_FORMAT: context->format = value; break; default: return FALSE; } return TRUE; } BOOL nsc_process_message(NSC_CONTEXT* context, UINT16 bpp, UINT32 width, UINT32 height, const BYTE* WINPR_RESTRICT data, UINT32 length, BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat, UINT32 nDstStride, UINT32 nXDst, UINT32 nYDst, UINT32 nWidth, UINT32 nHeight, UINT32 flip) { wStream* s = NULL; wStream sbuffer = { 0 }; BOOL ret = 0; if (!context || !data || !pDstData) return FALSE; s = Stream_StaticConstInit(&sbuffer, data, length); if (!s) return FALSE; if (nDstStride == 0) nDstStride = nWidth * FreeRDPGetBytesPerPixel(DstFormat); switch (bpp) { case 32: context->format = PIXEL_FORMAT_BGRA32; break; case 24: context->format = PIXEL_FORMAT_BGR24; break; case 16: context->format = PIXEL_FORMAT_BGR16; break; case 8: context->format = PIXEL_FORMAT_RGB8; break; case 4: context->format = PIXEL_FORMAT_A4; break; default: return FALSE; } context->width = width; context->height = height; ret = nsc_context_initialize(context, s); if (!ret) return FALSE; /* RLE decode */ { BOOL rc = 0; PROFILER_ENTER(context->priv->prof_nsc_rle_decompress_data) rc = nsc_rle_decompress_data(context); PROFILER_EXIT(context->priv->prof_nsc_rle_decompress_data) if (!rc) return FALSE; } /* Colorloss recover, Chroma supersample and AYCoCg to ARGB Conversion in one step */ { BOOL rc = 0; PROFILER_ENTER(context->priv->prof_nsc_decode) rc = context->decode(context); PROFILER_EXIT(context->priv->prof_nsc_decode) if (!rc) return FALSE; } if (!freerdp_image_copy_no_overlap(pDstData, DstFormat, nDstStride, nXDst, nYDst, width, height, context->BitmapData, PIXEL_FORMAT_BGRA32, 0, 0, 0, NULL, flip)) return FALSE; return TRUE; }