Coverage Report

Created: 2025-07-18 07:05

/src/FreeRDP/libfreerdp/codec/nsc.c
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
422
{
46
422
  size_t pos = 0;
47
48
422
  if (!context)
49
0
    return FALSE;
50
51
422
  const UINT16 rw = ROUND_UP_TO(context->width, 8);
52
422
  WINPR_ASSERT(context->ColorLossLevel >= 1);
53
844
  const BYTE shift = WINPR_ASSERTING_INT_CAST(BYTE, context->ColorLossLevel -
54
844
                                                        1); /* colorloss recovery + YCoCg shift */
55
0
  BYTE* bmpdata = context->BitmapData;
56
57
844
  if (!bmpdata)
58
0
    return FALSE;
59
60
2.56k
  for (size_t y = 0; y < context->height; y++)
61
2.13k
  {
62
2.13k
    const BYTE* yplane = NULL;
63
2.13k
    const BYTE* coplane = NULL;
64
2.13k
    const BYTE* cgplane = NULL;
65
2.13k
    const BYTE* aplane = context->priv->PlaneBuffers[3] + y * context->width; /* A */
66
67
2.13k
    if (context->ChromaSubsamplingLevel)
68
1.44k
    {
69
1.44k
      yplane = context->priv->PlaneBuffers[0] + y * rw;                /* Y */
70
1.44k
      coplane = context->priv->PlaneBuffers[1] + (y >> 1) * (rw >> 1); /* Co, supersampled */
71
1.44k
      cgplane = context->priv->PlaneBuffers[2] + (y >> 1) * (rw >> 1); /* Cg, supersampled */
72
1.44k
    }
73
692
    else
74
692
    {
75
692
      yplane = context->priv->PlaneBuffers[0] + y * context->width;  /* Y */
76
692
      coplane = context->priv->PlaneBuffers[1] + y * context->width; /* Co */
77
692
      cgplane = context->priv->PlaneBuffers[2] + y * context->width; /* Cg */
78
692
    }
79
80
34.6k
    for (UINT32 x = 0; x < context->width; x++)
81
32.5k
    {
82
32.5k
      INT16 y_val = (INT16)*yplane;
83
32.5k
      INT16 co_val = (INT16)(INT8)(((INT16)*coplane) << shift);
84
32.5k
      INT16 cg_val = (INT16)(INT8)(((INT16)*cgplane) << shift);
85
65.1k
      INT16 r_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val + co_val - cg_val);
86
65.1k
      INT16 g_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val + cg_val);
87
65.1k
      INT16 b_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val - co_val - cg_val);
88
89
32.5k
      if (pos + 4 > context->BitmapDataLength)
90
0
        return FALSE;
91
92
32.5k
      pos += 4;
93
32.5k
      *bmpdata++ = MINMAX(b_val, 0, 0xFF);
94
32.5k
      *bmpdata++ = MINMAX(g_val, 0, 0xFF);
95
32.5k
      *bmpdata++ = MINMAX(r_val, 0, 0xFF);
96
32.5k
      *bmpdata++ = *aplane;
97
32.5k
      yplane++;
98
32.5k
      coplane += (context->ChromaSubsamplingLevel ? x % 2 : 1);
99
32.5k
      cgplane += (context->ChromaSubsamplingLevel ? x % 2 : 1);
100
32.5k
      aplane++;
101
32.5k
    }
102
2.13k
  }
103
104
422
  return TRUE;
105
422
}
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
402
{
110
402
  UINT32 left = originalSize;
111
112
4.55k
  while (left > 4)
113
4.33k
  {
114
4.33k
    if (inSize < 1)
115
27
      return FALSE;
116
4.31k
    inSize--;
117
118
4.31k
    const BYTE value = *in++;
119
4.31k
    UINT32 len = 0;
120
121
4.31k
    if (left == 5)
122
157
    {
123
157
      if (outSize < 1)
124
0
        return FALSE;
125
126
157
      outSize--;
127
157
      *out++ = value;
128
157
      left--;
129
157
    }
130
4.15k
    else if (inSize < 1)
131
33
      return FALSE;
132
4.12k
    else if (value == *in)
133
1.38k
    {
134
1.38k
      inSize--;
135
1.38k
      in++;
136
137
1.38k
      if (inSize < 1)
138
11
        return FALSE;
139
1.37k
      else if (*in < 0xFF)
140
1.16k
      {
141
1.16k
        inSize--;
142
1.16k
        len = (UINT32)*in++;
143
1.16k
        len += 2;
144
1.16k
      }
145
207
      else
146
207
      {
147
207
        if (inSize < 5)
148
7
          return FALSE;
149
200
        inSize -= 5;
150
200
        in++;
151
200
        len = ((UINT32)(*in++));
152
200
        len |= ((UINT32)(*in++)) << 8U;
153
200
        len |= ((UINT32)(*in++)) << 16U;
154
200
        len |= ((UINT32)(*in++)) << 24U;
155
200
      }
156
157
1.36k
      if ((outSize < len) || (left < len))
158
109
        return FALSE;
159
160
1.25k
      outSize -= len;
161
1.25k
      FillMemory(out, len, value);
162
1.25k
      out += len;
163
1.25k
      left -= len;
164
1.25k
    }
165
2.73k
    else
166
2.73k
    {
167
2.73k
      if (outSize < 1)
168
0
        return FALSE;
169
170
2.73k
      outSize--;
171
2.73k
      *out++ = value;
172
2.73k
      left--;
173
2.73k
    }
174
4.31k
  }
175
176
215
  if ((outSize < 4) || (left < 4))
177
15
    return FALSE;
178
179
200
  if (inSize < 4)
180
20
    return FALSE;
181
180
  memcpy(out, in, 4);
182
180
  return TRUE;
183
200
}
184
185
static BOOL nsc_rle_decompress_data(NSC_CONTEXT* WINPR_RESTRICT context)
186
644
{
187
644
  if (!context)
188
0
    return FALSE;
189
190
644
  const BYTE* rle = context->Planes;
191
644
  size_t rleSize = context->PlanesSize;
192
644
  WINPR_ASSERT(rle);
193
194
2.47k
  for (size_t i = 0; i < 4; i++)
195
2.04k
  {
196
2.04k
    const UINT32 originalSize = context->OrgByteCount[i];
197
2.04k
    const UINT32 planeSize = context->PlaneByteCount[i];
198
199
2.04k
    if (rleSize < planeSize)
200
0
      return FALSE;
201
202
2.04k
    if (planeSize == 0)
203
1.30k
    {
204
1.30k
      if (context->priv->PlaneBuffersLength < originalSize)
205
0
        return FALSE;
206
207
1.30k
      FillMemory(context->priv->PlaneBuffers[i], originalSize, 0xFF);
208
1.30k
    }
209
749
    else if (planeSize < originalSize)
210
402
    {
211
402
      if (!nsc_rle_decode(rle, rleSize, context->priv->PlaneBuffers[i],
212
402
                          context->priv->PlaneBuffersLength, originalSize))
213
222
        return FALSE;
214
402
    }
215
347
    else
216
347
    {
217
347
      if (context->priv->PlaneBuffersLength < originalSize)
218
0
        return FALSE;
219
220
347
      if (rleSize < originalSize)
221
0
        return FALSE;
222
223
347
      CopyMemory(context->priv->PlaneBuffers[i], rle, originalSize);
224
347
    }
225
226
1.82k
    rle += planeSize;
227
1.82k
    rleSize -= planeSize;
228
1.82k
  }
229
230
422
  return TRUE;
231
644
}
232
233
static BOOL nsc_stream_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s)
234
815
{
235
815
  WINPR_ASSERT(context);
236
815
  WINPR_ASSERT(context->priv);
237
815
  if (!Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, 20))
238
78
    return FALSE;
239
240
737
  size_t total = 0;
241
3.68k
  for (size_t i = 0; i < 4; i++)
242
2.94k
  {
243
2.94k
    Stream_Read_UINT32(s, context->PlaneByteCount[i]);
244
2.94k
    total += context->PlaneByteCount[i];
245
2.94k
  }
246
247
737
  Stream_Read_UINT8(s, context->ColorLossLevel);         /* ColorLossLevel (1 byte) */
248
737
  if ((context->ColorLossLevel < 1) || (context->ColorLossLevel > 7))
249
44
  {
250
44
    WLog_Print(context->priv->log, WLOG_ERROR,
251
44
               "ColorLossLevel=%" PRIu8 " out of range, must be [1,7] inclusive",
252
44
               context->ColorLossLevel);
253
44
    return FALSE;
254
44
  }
255
693
  Stream_Read_UINT8(s, context->ChromaSubsamplingLevel); /* ChromaSubsamplingLevel (1 byte) */
256
693
  Stream_Seek(s, 2);                                     /* Reserved (2 bytes) */
257
693
  context->Planes = Stream_Pointer(s);
258
693
  context->PlanesSize = total;
259
693
  return Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, total);
260
737
}
261
262
static BOOL nsc_context_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s)
263
815
{
264
815
  if (!nsc_stream_initialize(context, s))
265
171
    return FALSE;
266
267
644
  const size_t blength = 4ull * context->width * context->height;
268
269
644
  if (!context->BitmapData || (blength > context->BitmapDataLength))
270
617
  {
271
617
    void* tmp = winpr_aligned_recalloc(context->BitmapData, blength + 16, sizeof(BYTE), 32);
272
273
617
    if (!tmp)
274
0
      return FALSE;
275
276
617
    context->BitmapData = tmp;
277
617
    context->BitmapDataLength = blength;
278
617
  }
279
280
644
  const UINT32 tempWidth = ROUND_UP_TO(context->width, 8);
281
644
  const UINT32 tempHeight = ROUND_UP_TO(context->height, 2);
282
  /* The maximum length a decoded plane can reach in all cases */
283
644
  const size_t plength = 1ull * tempWidth * tempHeight;
284
644
  if (plength > UINT32_MAX)
285
0
    return FALSE;
286
287
644
  if (plength > context->priv->PlaneBuffersLength)
288
534
  {
289
2.67k
    for (size_t i = 0; i < 4; i++)
290
2.13k
    {
291
2.13k
      void* tmp = (BYTE*)winpr_aligned_recalloc(context->priv->PlaneBuffers[i], plength,
292
2.13k
                                                sizeof(BYTE), 32);
293
294
2.13k
      if (!tmp)
295
0
        return FALSE;
296
297
2.13k
      context->priv->PlaneBuffers[i] = tmp;
298
2.13k
    }
299
300
534
    context->priv->PlaneBuffersLength = (UINT32)plength;
301
534
  }
302
303
3.22k
  for (size_t i = 0; i < 4; i++)
304
2.57k
    context->OrgByteCount[i] = context->width * context->height;
305
306
644
  if (context->ChromaSubsamplingLevel)
307
373
  {
308
373
    context->OrgByteCount[0] = tempWidth * context->height;
309
373
    context->OrgByteCount[1] = (tempWidth >> 1) * (tempHeight >> 1);
310
373
    context->OrgByteCount[2] = context->OrgByteCount[1];
311
373
  }
312
313
644
  return TRUE;
314
644
}
315
316
static void nsc_profiler_print(NSC_CONTEXT_PRIV* WINPR_RESTRICT priv)
317
17.9k
{
318
17.9k
  WINPR_UNUSED(priv);
319
320
17.9k
  PROFILER_PRINT_HEADER
321
17.9k
  PROFILER_PRINT(priv->prof_nsc_rle_decompress_data)
322
17.9k
  PROFILER_PRINT(priv->prof_nsc_decode)
323
17.9k
  PROFILER_PRINT(priv->prof_nsc_rle_compress_data)
324
17.9k
  PROFILER_PRINT(priv->prof_nsc_encode)
325
17.9k
  PROFILER_PRINT_FOOTER
326
17.9k
}
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
17.9k
{
343
17.9k
  NSC_CONTEXT* context = (NSC_CONTEXT*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT), 32);
344
345
17.9k
  if (!context)
346
0
    return NULL;
347
348
17.9k
  context->priv = (NSC_CONTEXT_PRIV*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT_PRIV), 32);
349
350
17.9k
  if (!context->priv)
351
0
    goto error;
352
353
17.9k
  context->priv->log = WLog_Get("com.freerdp.codec.nsc");
354
17.9k
  WLog_OpenAppender(context->priv->log);
355
17.9k
  context->BitmapData = NULL;
356
17.9k
  context->decode = nsc_decode;
357
17.9k
  context->encode = nsc_encode;
358
359
17.9k
  PROFILER_CREATE(context->priv->prof_nsc_rle_decompress_data, "nsc_rle_decompress_data")
360
17.9k
  PROFILER_CREATE(context->priv->prof_nsc_decode, "nsc_decode")
361
17.9k
  PROFILER_CREATE(context->priv->prof_nsc_rle_compress_data, "nsc_rle_compress_data")
362
17.9k
  PROFILER_CREATE(context->priv->prof_nsc_encode, "nsc_encode")
363
  /* Default encoding parameters */
364
17.9k
  context->ColorLossLevel = 3;
365
17.9k
  context->ChromaSubsamplingLevel = 1;
366
  /* init optimized methods */
367
17.9k
  nsc_init_sse2(context);
368
17.9k
  nsc_init_neon(context);
369
17.9k
  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
17.9k
}
377
378
void nsc_context_free(NSC_CONTEXT* context)
379
17.9k
{
380
17.9k
  if (!context)
381
0
    return;
382
383
17.9k
  if (context->priv)
384
17.9k
  {
385
107k
    for (size_t i = 0; i < 5; i++)
386
89.6k
      winpr_aligned_free(context->priv->PlaneBuffers[i]);
387
388
17.9k
    nsc_profiler_print(context->priv);
389
17.9k
    PROFILER_FREE(context->priv->prof_nsc_rle_decompress_data)
390
17.9k
    PROFILER_FREE(context->priv->prof_nsc_decode)
391
17.9k
    PROFILER_FREE(context->priv->prof_nsc_rle_compress_data)
392
17.9k
    PROFILER_FREE(context->priv->prof_nsc_encode)
393
17.9k
    winpr_aligned_free(context->priv);
394
17.9k
  }
395
396
17.9k
  winpr_aligned_free(context->BitmapData);
397
17.9k
  winpr_aligned_free(context);
398
17.9k
}
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
35.8k
{
410
35.8k
  if (!context)
411
0
    return FALSE;
412
413
35.8k
  switch (what)
414
35.8k
  {
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
35.8k
    case NSC_COLOR_FORMAT:
425
35.8k
      context->format = value;
426
35.8k
      break;
427
0
    default:
428
0
      return FALSE;
429
35.8k
  }
430
35.8k
  return TRUE;
431
35.8k
}
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
815
{
439
815
  wStream* s = NULL;
440
815
  wStream sbuffer = { 0 };
441
815
  BOOL ret = 0;
442
815
  if (!context || !data || !pDstData)
443
0
    return FALSE;
444
445
815
  s = Stream_StaticConstInit(&sbuffer, data, length);
446
447
815
  if (!s)
448
0
    return FALSE;
449
450
815
  if (nDstStride == 0)
451
815
    nDstStride = nWidth * FreeRDPGetBytesPerPixel(DstFormat);
452
453
815
  switch (bpp)
454
815
  {
455
815
    case 32:
456
815
      context->format = PIXEL_FORMAT_BGRA32;
457
815
      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
815
  }
478
479
1.63k
  context->width = WINPR_ASSERTING_INT_CAST(UINT16, width);
480
1.63k
  context->height = WINPR_ASSERTING_INT_CAST(UINT16, height);
481
0
  ret = nsc_context_initialize(context, s);
482
483
1.63k
  if (!ret)
484
171
    return FALSE;
485
486
  /* RLE decode */
487
644
  {
488
644
    BOOL rc = 0;
489
644
    PROFILER_ENTER(context->priv->prof_nsc_rle_decompress_data)
490
644
    rc = nsc_rle_decompress_data(context);
491
644
    PROFILER_EXIT(context->priv->prof_nsc_rle_decompress_data)
492
493
644
    if (!rc)
494
222
      return FALSE;
495
644
  }
496
  /* Colorloss recover, Chroma supersample and AYCoCg to ARGB Conversion in one step */
497
422
  {
498
422
    BOOL rc = 0;
499
422
    PROFILER_ENTER(context->priv->prof_nsc_decode)
500
422
    rc = context->decode(context);
501
422
    PROFILER_EXIT(context->priv->prof_nsc_decode)
502
503
422
    if (!rc)
504
0
      return FALSE;
505
422
  }
506
507
422
  if (!freerdp_image_copy_no_overlap(pDstData, DstFormat, nDstStride, nXDst, nYDst, width, height,
508
422
                                     context->BitmapData, PIXEL_FORMAT_BGRA32, 0, 0, 0, NULL,
509
422
                                     flip))
510
0
    return FALSE;
511
512
422
  return TRUE;
513
422
}