/src/FreeRDP/libfreerdp/codec/nsc.c

Source (jump to first uncovered line)
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * NSCodec Codec
 *
 * Copyright 2011 Samsung, Author Jiten Pathy
 * Copyright 2012 Vic Lee
 * 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 <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <winpr/assert.h>
#include <winpr/cast.h>
#include <winpr/crt.h>

#include <freerdp/codec/nsc.h>
#include <freerdp/codec/color.h>

#include "nsc_types.h"
#include "nsc_encode.h"

#include "sse/nsc_sse2.h"
#include "neon/nsc_neon.h"

#include <freerdp/log.h>

static BOOL nsc_decode(NSC_CONTEXT* WINPR_RESTRICT context)
{
  size_t pos = 0;

  if (!context)
    return FALSE;

  const UINT16 rw = ROUND_UP_TO(context->width, 8);
  WINPR_ASSERT(context->ColorLossLevel >= 1);
  const BYTE shift = WINPR_ASSERTING_INT_CAST(BYTE, context->ColorLossLevel -
                                                        1); /* colorloss recovery + YCoCg shift */
  BYTE* bmpdata = context->BitmapData;

  if (!bmpdata)
    return FALSE;

  for (size_t 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 = WINPR_ASSERTING_INT_CAST(int16_t, y_val + co_val - cg_val);
      INT16 g_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val + cg_val);
      INT16 b_val = WINPR_ASSERTING_INT_CAST(int16_t, 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 > UINT32_MAX)
    return FALSE;

  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 = (UINT32)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* WINPR_RESTRICT 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* WINPR_RESTRICT context, UINT16 bpp, UINT32 width,
                         UINT32 height, const BYTE* data, UINT32 length,
                         BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat, UINT32 nDstStride,
                         UINT32 nXDst, UINT32 nYDst, UINT32 nWidth,
                         WINPR_ATTR_UNUSED 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 = WINPR_ASSERTING_INT_CAST(UINT16, width);
  context->height = WINPR_ASSERTING_INT_CAST(UINT16, 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;
}

Coverage Report

Created: 2025-07-01 06:46

Line	Count	Source (jump to first uncovered line)
1		/**
2		* FreeRDP: A Remote Desktop Protocol Implementation
3		* NSCodec Codec
4		*
5		* Copyright 2011 Samsung, Author Jiten Pathy
6		* Copyright 2012 Vic Lee
7		* Copyright 2016 Armin Novak <armin.novak@thincast.com>
8		* Copyright 2016 Thincast Technologies GmbH
9		*
10		* Licensed under the Apache License, Version 2.0 (the "License");
11		* you may not use this file except in compliance with the License.
12		* You may obtain a copy of the License at
13		*
14		* http://www.apache.org/licenses/LICENSE-2.0
15		*
16		* Unless required by applicable law or agreed to in writing, software
17		* distributed under the License is distributed on an "AS IS" BASIS,
18		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19		* See the License for the specific language governing permissions and
20		* limitations under the License.
21		*/
22
23		#include <freerdp/config.h>
24
25		#include <stdio.h>
26		#include <stdlib.h>
27		#include <string.h>
28
29		#include <winpr/assert.h>
30		#include <winpr/cast.h>
31		#include <winpr/crt.h>
32
33		#include <freerdp/codec/nsc.h>
34		#include <freerdp/codec/color.h>
35
36		#include "nsc_types.h"
37		#include "nsc_encode.h"
38
39		#include "sse/nsc_sse2.h"
40		#include "neon/nsc_neon.h"
41
42		#include <freerdp/log.h>
43
44		static BOOL nsc_decode(NSC_CONTEXT* WINPR_RESTRICT context)
45	0	{
46	0	size_t pos = 0;
47
48	0	if (!context)
49	0	return FALSE;
50
51	0	const UINT16 rw = ROUND_UP_TO(context->width, 8);
52	0	WINPR_ASSERT(context->ColorLossLevel >= 1);
53	0	const BYTE shift = WINPR_ASSERTING_INT_CAST(BYTE, context->ColorLossLevel -
54	0	1); /* colorloss recovery + YCoCg shift */
55	0	BYTE* bmpdata = context->BitmapData;
56
57	0	if (!bmpdata)
58	0	return FALSE;
59
60	0	for (size_t y = 0; y < context->height; y++)
61	0	{
62	0	const BYTE* yplane = NULL;
63	0	const BYTE* coplane = NULL;
64	0	const BYTE* cgplane = NULL;
65	0	const BYTE* aplane = context->priv->PlaneBuffers[3] + y * context->width; /* A */
66
67	0	if (context->ChromaSubsamplingLevel)
68	0	{
69	0	yplane = context->priv->PlaneBuffers[0] + y * rw; /* Y */
70	0	coplane = context->priv->PlaneBuffers[1] + (y >> 1) * (rw >> 1); /* Co, supersampled */
71	0	cgplane = context->priv->PlaneBuffers[2] + (y >> 1) * (rw >> 1); /* Cg, supersampled */
72	0	}
73	0	else
74	0	{
75	0	yplane = context->priv->PlaneBuffers[0] + y * context->width; /* Y */
76	0	coplane = context->priv->PlaneBuffers[1] + y * context->width; /* Co */
77	0	cgplane = context->priv->PlaneBuffers[2] + y * context->width; /* Cg */
78	0	}
79
80	0	for (UINT32 x = 0; x < context->width; x++)
81	0	{
82	0	INT16 y_val = (INT16)*yplane;
83	0	INT16 co_val = (INT16)(INT8)(((INT16)*coplane) << shift);
84	0	INT16 cg_val = (INT16)(INT8)(((INT16)*cgplane) << shift);
85	0	INT16 r_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val + co_val - cg_val);
86	0	INT16 g_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val + cg_val);
87	0	INT16 b_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val - co_val - cg_val);
88
89	0	if (pos + 4 > context->BitmapDataLength)
90	0	return FALSE;
91
92	0	pos += 4;
93	0	*bmpdata++ = MINMAX(b_val, 0, 0xFF);
94	0	*bmpdata++ = MINMAX(g_val, 0, 0xFF);
95	0	*bmpdata++ = MINMAX(r_val, 0, 0xFF);
96	0	bmpdata++ = aplane;
97	0	yplane++;
98	0	coplane += (context->ChromaSubsamplingLevel ? x % 2 : 1);
99	0	cgplane += (context->ChromaSubsamplingLevel ? x % 2 : 1);
100	0	aplane++;
101	0	}
102	0	}
103
104	0	return TRUE;
105	0	}
106
107		static BOOL nsc_rle_decode(const BYTE* WINPR_RESTRICT in, size_t inSize, BYTE* WINPR_RESTRICT out,
108		UINT32 outSize, UINT32 originalSize)
109	0	{
110	0	UINT32 left = originalSize;
111
112	0	while (left > 4)
113	0	{
114	0	if (inSize < 1)
115	0	return FALSE;
116	0	inSize--;
117
118	0	const BYTE value = *in++;
119	0	UINT32 len = 0;
120
121	0	if (left == 5)
122	0	{
123	0	if (outSize < 1)
124	0	return FALSE;
125
126	0	outSize--;
127	0	*out++ = value;
128	0	left--;
129	0	}
130	0	else if (inSize < 1)
131	0	return FALSE;
132	0	else if (value == *in)
133	0	{
134	0	inSize--;
135	0	in++;
136
137	0	if (inSize < 1)
138	0	return FALSE;
139	0	else if (*in < 0xFF)
140	0	{
141	0	inSize--;
142	0	len = (UINT32)*in++;
143	0	len += 2;
144	0	}
145	0	else
146	0	{
147	0	if (inSize < 5)
148	0	return FALSE;
149	0	inSize -= 5;
150	0	in++;
151	0	len = ((UINT32)(*in++));
152	0	len \|= ((UINT32)(*in++)) << 8U;
153	0	len \|= ((UINT32)(*in++)) << 16U;
154	0	len \|= ((UINT32)(*in++)) << 24U;
155	0	}
156
157	0	if ((outSize < len) \|\| (left < len))
158	0	return FALSE;
159
160	0	outSize -= len;
161	0	FillMemory(out, len, value);
162	0	out += len;
163	0	left -= len;
164	0	}
165	0	else
166	0	{
167	0	if (outSize < 1)
168	0	return FALSE;
169
170	0	outSize--;
171	0	*out++ = value;
172	0	left--;
173	0	}
174	0	}
175
176	0	if ((outSize < 4) \|\| (left < 4))
177	0	return FALSE;
178
179	0	if (inSize < 4)
180	0	return FALSE;
181	0	memcpy(out, in, 4);
182	0	return TRUE;
183	0	}
184
185		static BOOL nsc_rle_decompress_data(NSC_CONTEXT* WINPR_RESTRICT context)
186	0	{
187	0	if (!context)
188	0	return FALSE;
189
190	0	const BYTE* rle = context->Planes;
191	0	size_t rleSize = context->PlanesSize;
192	0	WINPR_ASSERT(rle);
193
194	0	for (size_t i = 0; i < 4; i++)
195	0	{
196	0	const UINT32 originalSize = context->OrgByteCount[i];
197	0	const UINT32 planeSize = context->PlaneByteCount[i];
198
199	0	if (rleSize < planeSize)
200	0	return FALSE;
201
202	0	if (planeSize == 0)
203	0	{
204	0	if (context->priv->PlaneBuffersLength < originalSize)
205	0	return FALSE;
206
207	0	FillMemory(context->priv->PlaneBuffers[i], originalSize, 0xFF);
208	0	}
209	0	else if (planeSize < originalSize)
210	0	{
211	0	if (!nsc_rle_decode(rle, rleSize, context->priv->PlaneBuffers[i],
212	0	context->priv->PlaneBuffersLength, originalSize))
213	0	return FALSE;
214	0	}
215	0	else
216	0	{
217	0	if (context->priv->PlaneBuffersLength < originalSize)
218	0	return FALSE;
219
220	0	if (rleSize < originalSize)
221	0	return FALSE;
222
223	0	CopyMemory(context->priv->PlaneBuffers[i], rle, originalSize);
224	0	}
225
226	0	rle += planeSize;
227	0	rleSize -= planeSize;
228	0	}
229
230	0	return TRUE;
231	0	}
232
233		static BOOL nsc_stream_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s)
234	0	{
235	0	WINPR_ASSERT(context);
236	0	WINPR_ASSERT(context->priv);
237	0	if (!Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, 20))
238	0	return FALSE;
239
240	0	size_t total = 0;
241	0	for (size_t i = 0; i < 4; i++)
242	0	{
243	0	Stream_Read_UINT32(s, context->PlaneByteCount[i]);
244	0	total += context->PlaneByteCount[i];
245	0	}
246
247	0	Stream_Read_UINT8(s, context->ColorLossLevel); /* ColorLossLevel (1 byte) */
248	0	if ((context->ColorLossLevel < 1) \|\| (context->ColorLossLevel > 7))
249	0	{
250	0	WLog_Print(context->priv->log, WLOG_ERROR,
251	0	"ColorLossLevel=%" PRIu8 " out of range, must be [1,7] inclusive",
252	0	context->ColorLossLevel);
253	0	return FALSE;
254	0	}
255	0	Stream_Read_UINT8(s, context->ChromaSubsamplingLevel); /* ChromaSubsamplingLevel (1 byte) */
256	0	Stream_Seek(s, 2); /* Reserved (2 bytes) */
257	0	context->Planes = Stream_Pointer(s);
258	0	context->PlanesSize = total;
259	0	return Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, total);
260	0	}
261
262		static BOOL nsc_context_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s)
263	0	{
264	0	if (!nsc_stream_initialize(context, s))
265	0	return FALSE;
266
267	0	const size_t blength = 4ull * context->width * context->height;
268
269	0	if (!context->BitmapData \|\| (blength > context->BitmapDataLength))
270	0	{
271	0	void* tmp = winpr_aligned_recalloc(context->BitmapData, blength + 16, sizeof(BYTE), 32);
272
273	0	if (!tmp)
274	0	return FALSE;
275
276	0	context->BitmapData = tmp;
277	0	context->BitmapDataLength = blength;
278	0	}
279
280	0	const UINT32 tempWidth = ROUND_UP_TO(context->width, 8);
281	0	const UINT32 tempHeight = ROUND_UP_TO(context->height, 2);
282		/* The maximum length a decoded plane can reach in all cases */
283	0	const size_t plength = 1ull * tempWidth * tempHeight;
284	0	if (plength > UINT32_MAX)
285	0	return FALSE;
286
287	0	if (plength > context->priv->PlaneBuffersLength)
288	0	{
289	0	for (size_t i = 0; i < 4; i++)
290	0	{
291	0	void* tmp = (BYTE*)winpr_aligned_recalloc(context->priv->PlaneBuffers[i], plength,
292	0	sizeof(BYTE), 32);
293
294	0	if (!tmp)
295	0	return FALSE;
296
297	0	context->priv->PlaneBuffers[i] = tmp;
298	0	}
299
300	0	context->priv->PlaneBuffersLength = (UINT32)plength;
301	0	}
302
303	0	for (size_t i = 0; i < 4; i++)
304	0	context->OrgByteCount[i] = context->width * context->height;
305
306	0	if (context->ChromaSubsamplingLevel)
307	0	{
308	0	context->OrgByteCount[0] = tempWidth * context->height;
309	0	context->OrgByteCount[1] = (tempWidth >> 1) * (tempHeight >> 1);
310	0	context->OrgByteCount[2] = context->OrgByteCount[1];
311	0	}
312
313	0	return TRUE;
314	0	}
315
316		static void nsc_profiler_print(NSC_CONTEXT_PRIV* WINPR_RESTRICT priv)
317	0	{
318	0	WINPR_UNUSED(priv);
319
320	0	PROFILER_PRINT_HEADER
321	0	PROFILER_PRINT(priv->prof_nsc_rle_decompress_data)
322	0	PROFILER_PRINT(priv->prof_nsc_decode)
323	0	PROFILER_PRINT(priv->prof_nsc_rle_compress_data)
324	0	PROFILER_PRINT(priv->prof_nsc_encode)
325	0	PROFILER_PRINT_FOOTER
326	0	}
327
328		BOOL nsc_context_reset(NSC_CONTEXT* WINPR_RESTRICT context, UINT32 width, UINT32 height)
329	0	{
330	0	if (!context)
331	0	return FALSE;
332
333	0	if ((width > UINT16_MAX) \|\| (height > UINT16_MAX))
334	0	return FALSE;
335
336	0	context->width = (UINT16)width;
337	0	context->height = (UINT16)height;
338	0	return TRUE;
339	0	}
340
341		NSC_CONTEXT* nsc_context_new(void)
342	0	{
343	0	NSC_CONTEXT* context = (NSC_CONTEXT*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT), 32);
344
345	0	if (!context)
346	0	return NULL;
347
348	0	context->priv = (NSC_CONTEXT_PRIV*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT_PRIV), 32);
349
350	0	if (!context->priv)
351	0	goto error;
352
353	0	context->priv->log = WLog_Get("com.freerdp.codec.nsc");
354	0	WLog_OpenAppender(context->priv->log);
355	0	context->BitmapData = NULL;
356	0	context->decode = nsc_decode;
357	0	context->encode = nsc_encode;
358
359	0	PROFILER_CREATE(context->priv->prof_nsc_rle_decompress_data, "nsc_rle_decompress_data")
360	0	PROFILER_CREATE(context->priv->prof_nsc_decode, "nsc_decode")
361	0	PROFILER_CREATE(context->priv->prof_nsc_rle_compress_data, "nsc_rle_compress_data")
362	0	PROFILER_CREATE(context->priv->prof_nsc_encode, "nsc_encode")
363		/* Default encoding parameters */
364	0	context->ColorLossLevel = 3;
365	0	context->ChromaSubsamplingLevel = 1;
366		/* init optimized methods */
367	0	nsc_init_sse2(context);
368	0	nsc_init_neon(context);
369	0	return context;
370	0	error:
371	0	WINPR_PRAGMA_DIAG_PUSH
372	0	WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
373	0	nsc_context_free(context);
374	0	WINPR_PRAGMA_DIAG_POP
375	0	return NULL;
376	0	}
377
378		void nsc_context_free(NSC_CONTEXT* context)
379	0	{
380	0	if (!context)
381	0	return;
382
383	0	if (context->priv)
384	0	{
385	0	for (size_t i = 0; i < 5; i++)
386	0	winpr_aligned_free(context->priv->PlaneBuffers[i]);
387
388	0	nsc_profiler_print(context->priv);
389	0	PROFILER_FREE(context->priv->prof_nsc_rle_decompress_data)
390	0	PROFILER_FREE(context->priv->prof_nsc_decode)
391	0	PROFILER_FREE(context->priv->prof_nsc_rle_compress_data)
392	0	PROFILER_FREE(context->priv->prof_nsc_encode)
393	0	winpr_aligned_free(context->priv);
394	0	}
395
396	0	winpr_aligned_free(context->BitmapData);
397	0	winpr_aligned_free(context);
398	0	}
399
400		#if defined(WITH_FREERDP_DEPRECATED)
401		BOOL nsc_context_set_pixel_format(NSC_CONTEXT* context, UINT32 pixel_format)
402		{
403		return nsc_context_set_parameters(context, NSC_COLOR_FORMAT, pixel_format);
404		}
405		#endif
406
407		BOOL nsc_context_set_parameters(NSC_CONTEXT* WINPR_RESTRICT context, NSC_PARAMETER what,
408		UINT32 value)
409	0	{
410	0	if (!context)
411	0	return FALSE;
412
413	0	switch (what)
414	0	{
415	0	case NSC_COLOR_LOSS_LEVEL:
416	0	context->ColorLossLevel = value;
417	0	break;
418	0	case NSC_ALLOW_SUBSAMPLING:
419	0	context->ChromaSubsamplingLevel = value;
420	0	break;
421	0	case NSC_DYNAMIC_COLOR_FIDELITY:
422	0	context->DynamicColorFidelity = value != 0;
423	0	break;
424	0	case NSC_COLOR_FORMAT:
425	0	context->format = value;
426	0	break;
427	0	default:
428	0	return FALSE;
429	0	}
430	0	return TRUE;
431	0	}
432
433		BOOL nsc_process_message(NSC_CONTEXT* WINPR_RESTRICT context, UINT16 bpp, UINT32 width,
434		UINT32 height, const BYTE* data, UINT32 length,
435		BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat, UINT32 nDstStride,
436		UINT32 nXDst, UINT32 nYDst, UINT32 nWidth,
437		WINPR_ATTR_UNUSED UINT32 nHeight, UINT32 flip)
438	0	{
439	0	wStream* s = NULL;
440	0	wStream sbuffer = { 0 };
441	0	BOOL ret = 0;
442	0	if (!context \|\| !data \|\| !pDstData)
443	0	return FALSE;
444
445	0	s = Stream_StaticConstInit(&sbuffer, data, length);
446
447	0	if (!s)
448	0	return FALSE;
449
450	0	if (nDstStride == 0)
451	0	nDstStride = nWidth * FreeRDPGetBytesPerPixel(DstFormat);
452
453	0	switch (bpp)
454	0	{
455	0	case 32:
456	0	context->format = PIXEL_FORMAT_BGRA32;
457	0	break;
458
459	0	case 24:
460	0	context->format = PIXEL_FORMAT_BGR24;
461	0	break;
462
463	0	case 16:
464	0	context->format = PIXEL_FORMAT_BGR16;
465	0	break;
466
467	0	case 8:
468	0	context->format = PIXEL_FORMAT_RGB8;
469	0	break;
470
471	0	case 4:
472	0	context->format = PIXEL_FORMAT_A4;
473	0	break;
474
475	0	default:
476	0	return FALSE;
477	0	}
478
479	0	context->width = WINPR_ASSERTING_INT_CAST(UINT16, width);
480	0	context->height = WINPR_ASSERTING_INT_CAST(UINT16, height);
481	0	ret = nsc_context_initialize(context, s);
482
483	0	if (!ret)
484	0	return FALSE;
485
486		/* RLE decode */
487	0	{
488	0	BOOL rc = 0;
489	0	PROFILER_ENTER(context->priv->prof_nsc_rle_decompress_data)
490	0	rc = nsc_rle_decompress_data(context);
491	0	PROFILER_EXIT(context->priv->prof_nsc_rle_decompress_data)
492
493	0	if (!rc)
494	0	return FALSE;
495	0	}
496		/* Colorloss recover, Chroma supersample and AYCoCg to ARGB Conversion in one step */
497	0	{
498	0	BOOL rc = 0;
499	0	PROFILER_ENTER(context->priv->prof_nsc_decode)
500	0	rc = context->decode(context);
501	0	PROFILER_EXIT(context->priv->prof_nsc_decode)
502
503	0	if (!rc)
504	0	return FALSE;
505	0	}
506
507	0	if (!freerdp_image_copy_no_overlap(pDstData, DstFormat, nDstStride, nXDst, nYDst, width, height,
508	0	context->BitmapData, PIXEL_FORMAT_BGRA32, 0, 0, 0, NULL,
509	0	flip))
510	0	return FALSE;
511
512	0	return TRUE;
513	0	}