Coverage Report

Created: 2026-10-28 06:50

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/FreeRDP/libfreerdp/codec/nsc.c
Line
Count
Source
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
469
{
46
469
  size_t pos = 0;
47
48
469
  if (!context)
49
0
    return FALSE;
50
51
469
  const UINT16 rw = ROUND_UP_TO(context->width, 8);
52
469
  WINPR_ASSERT(context->ColorLossLevel >= 1);
53
469
  const BYTE shift = WINPR_ASSERTING_INT_CAST(BYTE, context->ColorLossLevel -
54
469
                                                        1); /* colorloss recovery + YCoCg shift */
55
469
  BYTE* bmpdata = context->BitmapData;
56
57
469
  if (!bmpdata)
58
0
    return FALSE;
59
60
3.01k
  for (size_t y = 0; y < context->height; y++)
61
2.54k
  {
62
2.54k
    const BYTE* yplane = nullptr;
63
2.54k
    const BYTE* coplane = nullptr;
64
2.54k
    const BYTE* cgplane = nullptr;
65
2.54k
    const BYTE* aplane = context->priv->PlaneBuffers[3] + y * context->width; /* A */
66
67
2.54k
    if (context->ChromaSubsamplingLevel)
68
1.46k
    {
69
1.46k
      yplane = context->priv->PlaneBuffers[0] + y * rw;                /* Y */
70
1.46k
      coplane = context->priv->PlaneBuffers[1] + (y >> 1) * (rw >> 1); /* Co, supersampled */
71
1.46k
      cgplane = context->priv->PlaneBuffers[2] + (y >> 1) * (rw >> 1); /* Cg, supersampled */
72
1.46k
    }
73
1.07k
    else
74
1.07k
    {
75
1.07k
      yplane = context->priv->PlaneBuffers[0] + y * context->width;  /* Y */
76
1.07k
      coplane = context->priv->PlaneBuffers[1] + y * context->width; /* Co */
77
1.07k
      cgplane = context->priv->PlaneBuffers[2] + y * context->width; /* Cg */
78
1.07k
    }
79
80
43.2k
    for (UINT32 x = 0; x < context->width; x++)
81
40.7k
    {
82
40.7k
      INT16 y_val = (INT16)*yplane;
83
40.7k
      INT16 co_val = (INT16)(INT8)(((INT16)*coplane) << shift);
84
40.7k
      INT16 cg_val = (INT16)(INT8)(((INT16)*cgplane) << shift);
85
40.7k
      INT16 r_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val + co_val - cg_val);
86
40.7k
      INT16 g_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val + cg_val);
87
40.7k
      INT16 b_val = WINPR_ASSERTING_INT_CAST(int16_t, y_val - co_val - cg_val);
88
89
40.7k
      if (pos + 4 > context->BitmapDataLength)
90
0
        return FALSE;
91
92
40.7k
      pos += 4;
93
40.7k
      *bmpdata++ = MINMAX(b_val, 0, 0xFF);
94
40.7k
      *bmpdata++ = MINMAX(g_val, 0, 0xFF);
95
40.7k
      *bmpdata++ = MINMAX(r_val, 0, 0xFF);
96
40.7k
      *bmpdata++ = *aplane;
97
40.7k
      yplane++;
98
40.7k
      coplane += (context->ChromaSubsamplingLevel ? x % 2 : 1);
99
40.7k
      cgplane += (context->ChromaSubsamplingLevel ? x % 2 : 1);
100
40.7k
      aplane++;
101
40.7k
    }
102
2.54k
  }
103
104
469
  return TRUE;
105
469
}
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
430
{
110
430
  UINT32 left = originalSize;
111
112
7.36k
  while (left > 4)
113
7.10k
  {
114
7.10k
    if (inSize < 1)
115
18
      return FALSE;
116
7.09k
    inSize--;
117
118
7.09k
    const BYTE value = *in++;
119
7.09k
    UINT32 len = 0;
120
121
7.09k
    if (left == 5)
122
184
    {
123
184
      if (outSize < 1)
124
0
        return FALSE;
125
126
184
      outSize--;
127
184
      *out++ = value;
128
184
      left--;
129
184
    }
130
6.90k
    else if (inSize < 1)
131
37
      return FALSE;
132
6.86k
    else if (value == *in)
133
1.22k
    {
134
1.22k
      inSize--;
135
1.22k
      in++;
136
137
1.22k
      if (inSize < 1)
138
11
        return FALSE;
139
1.21k
      else if (*in < 0xFF)
140
1.04k
      {
141
1.04k
        inSize--;
142
1.04k
        len = (UINT32)*in++;
143
1.04k
        len += 2;
144
1.04k
      }
145
172
      else
146
172
      {
147
172
        if (inSize < 5)
148
9
          return FALSE;
149
163
        inSize -= 5;
150
163
        in++;
151
163
        len = ((UINT32)(*in++));
152
163
        len |= ((UINT32)(*in++)) << 8U;
153
163
        len |= ((UINT32)(*in++)) << 16U;
154
163
        len |= ((UINT32)(*in++)) << 24U;
155
163
      }
156
157
1.20k
      if ((outSize < len) || (left < len))
158
102
        return FALSE;
159
160
1.10k
      outSize -= len;
161
1.10k
      FillMemory(out, len, value);
162
1.10k
      out += len;
163
1.10k
      left -= len;
164
1.10k
    }
165
5.64k
    else
166
5.64k
    {
167
5.64k
      if (outSize < 1)
168
0
        return FALSE;
169
170
5.64k
      outSize--;
171
5.64k
      *out++ = value;
172
5.64k
      left--;
173
5.64k
    }
174
7.09k
  }
175
176
253
  if ((outSize < 4) || (left < 4))
177
25
    return FALSE;
178
179
228
  if (inSize < 4)
180
26
    return FALSE;
181
202
  memcpy(out, in, 4);
182
202
  return TRUE;
183
228
}
184
185
static BOOL nsc_rle_decompress_data(NSC_CONTEXT* WINPR_RESTRICT context)
186
697
{
187
697
  if (!context)
188
0
    return FALSE;
189
190
697
  const BYTE* rle = context->Planes;
191
697
  size_t rleSize = context->PlanesSize;
192
697
  WINPR_ASSERT(rle);
193
194
2.74k
  for (size_t i = 0; i < 4; i++)
195
2.27k
  {
196
2.27k
    const UINT32 originalSize = context->OrgByteCount[i];
197
2.27k
    const UINT32 planeSize = context->PlaneByteCount[i];
198
199
2.27k
    if (rleSize < planeSize)
200
0
      return FALSE;
201
202
2.27k
    if (planeSize == 0)
203
1.49k
    {
204
1.49k
      if (context->priv->PlaneBuffersLength < originalSize)
205
0
        return FALSE;
206
207
1.49k
      FillMemory(context->priv->PlaneBuffers[i], originalSize, 0xFF);
208
1.49k
    }
209
779
    else if (planeSize < originalSize)
210
430
    {
211
430
      if (!nsc_rle_decode(rle, rleSize, context->priv->PlaneBuffers[i],
212
430
                          context->priv->PlaneBuffersLength, originalSize))
213
228
        return FALSE;
214
430
    }
215
349
    else
216
349
    {
217
349
      if (context->priv->PlaneBuffersLength < originalSize)
218
0
        return FALSE;
219
220
349
      if (rleSize < originalSize)
221
0
        return FALSE;
222
223
349
      CopyMemory(context->priv->PlaneBuffers[i], rle, originalSize);
224
349
    }
225
226
2.04k
    rle += planeSize;
227
2.04k
    rleSize -= planeSize;
228
2.04k
  }
229
230
469
  return TRUE;
231
697
}
232
233
static BOOL nsc_stream_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s)
234
873
{
235
873
  WINPR_ASSERT(context);
236
873
  WINPR_ASSERT(context->priv);
237
873
  if (!Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, 20))
238
89
    return FALSE;
239
240
784
  size_t total = 0;
241
3.92k
  for (size_t i = 0; i < 4; i++)
242
3.13k
  {
243
3.13k
    Stream_Read_UINT32(s, context->PlaneByteCount[i]);
244
3.13k
    total += context->PlaneByteCount[i];
245
3.13k
  }
246
247
784
  Stream_Read_UINT8(s, context->ColorLossLevel);         /* ColorLossLevel (1 byte) */
248
784
  if ((context->ColorLossLevel < 1) || (context->ColorLossLevel > 7))
249
50
  {
250
50
    WLog_Print(context->priv->log, WLOG_ERROR,
251
50
               "ColorLossLevel=%" PRIu8 " out of range, must be [1,7] inclusive",
252
50
               context->ColorLossLevel);
253
50
    return FALSE;
254
50
  }
255
734
  Stream_Read_UINT8(s, context->ChromaSubsamplingLevel); /* ChromaSubsamplingLevel (1 byte) */
256
734
  Stream_Seek(s, 2);                                     /* Reserved (2 bytes) */
257
734
  context->Planes = Stream_Pointer(s);
258
734
  context->PlanesSize = total;
259
734
  return Stream_CheckAndLogRequiredLengthWLog(context->priv->log, s, total);
260
784
}
261
262
static BOOL nsc_context_initialize(NSC_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s)
263
873
{
264
873
  if (!nsc_stream_initialize(context, s))
265
176
    return FALSE;
266
267
697
  const size_t blength = 4ull * context->width * context->height;
268
269
697
  if (!context->BitmapData || (blength > context->BitmapDataLength))
270
650
  {
271
650
    void* tmp = winpr_aligned_recalloc(context->BitmapData, blength + 16, sizeof(BYTE), 32);
272
273
650
    if (!tmp)
274
0
      return FALSE;
275
276
650
    context->BitmapData = tmp;
277
650
    context->BitmapDataLength = blength;
278
650
  }
279
280
697
  const UINT32 tempWidth = ROUND_UP_TO(context->width, 8);
281
697
  const UINT32 tempHeight = ROUND_UP_TO(context->height, 2);
282
  /* The maximum length a decoded plane can reach in all cases */
283
697
  const size_t plength = 1ull * tempWidth * tempHeight;
284
697
  if (plength > UINT32_MAX)
285
0
    return FALSE;
286
287
697
  if (plength > context->priv->PlaneBuffersLength)
288
577
  {
289
2.88k
    for (size_t i = 0; i < 4; i++)
290
2.30k
    {
291
2.30k
      void* tmp = (BYTE*)winpr_aligned_recalloc(context->priv->PlaneBuffers[i], plength,
292
2.30k
                                                sizeof(BYTE), 32);
293
294
2.30k
      if (!tmp)
295
0
        return FALSE;
296
297
2.30k
      context->priv->PlaneBuffers[i] = tmp;
298
2.30k
    }
299
300
577
    context->priv->PlaneBuffersLength = (UINT32)plength;
301
577
  }
302
303
3.48k
  for (size_t i = 0; i < 4; i++)
304
2.78k
    context->OrgByteCount[i] = context->width * context->height;
305
306
697
  if (context->ChromaSubsamplingLevel)
307
354
  {
308
354
    context->OrgByteCount[0] = tempWidth * context->height;
309
354
    context->OrgByteCount[1] = (tempWidth >> 1) * (tempHeight >> 1);
310
354
    context->OrgByteCount[2] = context->OrgByteCount[1];
311
354
  }
312
313
697
  return TRUE;
314
697
}
315
316
static void nsc_profiler_print(NSC_CONTEXT_PRIV* WINPR_RESTRICT priv)
317
18.6k
{
318
18.6k
  WINPR_UNUSED(priv);
319
320
18.6k
  PROFILER_PRINT_HEADER
321
18.6k
  PROFILER_PRINT(priv->prof_nsc_rle_decompress_data)
322
18.6k
  PROFILER_PRINT(priv->prof_nsc_decode)
323
18.6k
  PROFILER_PRINT(priv->prof_nsc_rle_compress_data)
324
18.6k
  PROFILER_PRINT(priv->prof_nsc_encode)
325
18.6k
  PROFILER_PRINT_FOOTER
326
18.6k
}
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
18.6k
{
343
18.6k
  NSC_CONTEXT* context = (NSC_CONTEXT*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT), 32);
344
345
18.6k
  if (!context)
346
0
    return nullptr;
347
348
18.6k
  context->priv = (NSC_CONTEXT_PRIV*)winpr_aligned_calloc(1, sizeof(NSC_CONTEXT_PRIV), 32);
349
350
18.6k
  if (!context->priv)
351
0
    goto error;
352
353
18.6k
  context->priv->log = WLog_Get("com.freerdp.codec.nsc");
354
18.6k
  context->BitmapData = nullptr;
355
18.6k
  context->decode = nsc_decode;
356
18.6k
  context->encode = nsc_encode;
357
358
18.6k
  PROFILER_CREATE(context->priv->prof_nsc_rle_decompress_data, "nsc_rle_decompress_data")
359
18.6k
  PROFILER_CREATE(context->priv->prof_nsc_decode, "nsc_decode")
360
18.6k
  PROFILER_CREATE(context->priv->prof_nsc_rle_compress_data, "nsc_rle_compress_data")
361
18.6k
  PROFILER_CREATE(context->priv->prof_nsc_encode, "nsc_encode")
362
  /* Default encoding parameters */
363
18.6k
  context->ColorLossLevel = 3;
364
18.6k
  context->ChromaSubsamplingLevel = 1;
365
  /* init optimized methods */
366
18.6k
  nsc_init_sse2(context);
367
18.6k
  nsc_init_neon(context);
368
18.6k
  return context;
369
0
error:
370
0
  WINPR_PRAGMA_DIAG_PUSH
371
0
  WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
372
0
  nsc_context_free(context);
373
0
  WINPR_PRAGMA_DIAG_POP
374
0
  return nullptr;
375
18.6k
}
376
377
void nsc_context_planebuffers_free(NSC_CONTEXT_PRIV* priv)
378
18.6k
{
379
18.6k
  if (!priv)
380
0
    return;
381
382
111k
  for (size_t i = 0; i < ARRAYSIZE(priv->PlaneBuffers); i++)
383
93.1k
  {
384
93.1k
    BYTE* cur = priv->PlaneBuffers[i];
385
93.1k
    priv->PlaneBuffers[i] = nullptr;
386
93.1k
    winpr_aligned_free(cur);
387
93.1k
  }
388
389
18.6k
  priv->PlaneBuffersLength = 0;
390
18.6k
}
391
392
void nsc_context_free(NSC_CONTEXT* context)
393
18.6k
{
394
18.6k
  if (!context)
395
0
    return;
396
397
18.6k
  if (context->priv)
398
18.6k
  {
399
18.6k
    nsc_context_planebuffers_free(context->priv);
400
401
18.6k
    nsc_profiler_print(context->priv);
402
18.6k
    PROFILER_FREE(context->priv->prof_nsc_rle_decompress_data)
403
18.6k
    PROFILER_FREE(context->priv->prof_nsc_decode)
404
18.6k
    PROFILER_FREE(context->priv->prof_nsc_rle_compress_data)
405
18.6k
    PROFILER_FREE(context->priv->prof_nsc_encode)
406
18.6k
    winpr_aligned_free(context->priv);
407
18.6k
  }
408
409
18.6k
  winpr_aligned_free(context->BitmapData);
410
18.6k
  winpr_aligned_free(context);
411
18.6k
}
412
413
#if defined(WITH_FREERDP_DEPRECATED)
414
BOOL nsc_context_set_pixel_format(NSC_CONTEXT* context, UINT32 pixel_format)
415
{
416
  return nsc_context_set_parameters(context, NSC_COLOR_FORMAT, pixel_format);
417
}
418
#endif
419
420
BOOL nsc_context_set_parameters(NSC_CONTEXT* WINPR_RESTRICT context, NSC_PARAMETER what,
421
                                UINT32 value)
422
37.2k
{
423
37.2k
  if (!context)
424
0
    return FALSE;
425
426
37.2k
  switch (what)
427
37.2k
  {
428
0
    case NSC_COLOR_LOSS_LEVEL:
429
0
      context->ColorLossLevel = value;
430
0
      break;
431
0
    case NSC_ALLOW_SUBSAMPLING:
432
0
      context->ChromaSubsamplingLevel = value;
433
0
      break;
434
0
    case NSC_DYNAMIC_COLOR_FIDELITY:
435
0
      context->DynamicColorFidelity = value != 0;
436
0
      break;
437
37.2k
    case NSC_COLOR_FORMAT:
438
37.2k
      context->format = value;
439
37.2k
      break;
440
0
    default:
441
0
      return FALSE;
442
37.2k
  }
443
37.2k
  return TRUE;
444
37.2k
}
445
446
BOOL nsc_process_message(NSC_CONTEXT* WINPR_RESTRICT context, UINT16 bpp, UINT32 width,
447
                         UINT32 height, const BYTE* data, UINT32 length,
448
                         BYTE* WINPR_RESTRICT pDstData, UINT32 DstFormat, UINT32 nDstStride,
449
                         UINT32 nXDst, UINT32 nYDst, UINT32 nWidth, UINT32 nHeight, UINT32 flip)
450
873
{
451
873
  if (!context)
452
0
    return FALSE;
453
454
873
  WINPR_ASSERT(context->priv);
455
456
873
  wStream sbuffer = WINPR_C_ARRAY_INIT;
457
873
  BOOL ret = 0;
458
873
  if (!data || !pDstData)
459
0
  {
460
0
    WLog_Print(context->priv->log, WLOG_ERROR, "Invalid argument: data=%p, pDstData=%p",
461
0
               (const void*)data, (void*)pDstData);
462
0
    return FALSE;
463
0
  }
464
465
873
  if (nXDst > nWidth)
466
0
  {
467
0
    WLog_Print(context->priv->log, WLOG_ERROR, "nXDst %" PRIu32 " > nWidth %" PRIu32, nXDst,
468
0
               nWidth);
469
0
    return FALSE;
470
0
  }
471
873
  if (nYDst > nHeight)
472
0
  {
473
0
    WLog_Print(context->priv->log, WLOG_ERROR, "nYDst %" PRIu32 " > nHeight %" PRIu32, nYDst,
474
0
               nHeight);
475
0
    return FALSE;
476
0
  }
477
478
873
  wStream* s = Stream_StaticConstInit(&sbuffer, data, length);
479
873
  if (!s)
480
0
    return FALSE;
481
482
873
  const UINT32 minStride = nWidth * FreeRDPGetBytesPerPixel(DstFormat);
483
873
  if (nDstStride == 0)
484
873
    nDstStride = minStride;
485
873
  if (nDstStride < minStride)
486
0
  {
487
0
    WLog_Print(context->priv->log, WLOG_ERROR,
488
0
               "nDstStride %" PRIu32 " < minimum stride %" PRIu32, nDstStride, minStride);
489
0
    return FALSE;
490
0
  }
491
492
873
  switch (bpp)
493
873
  {
494
873
    case 32:
495
873
      context->format = PIXEL_FORMAT_BGRA32;
496
873
      break;
497
498
0
    case 24:
499
0
      context->format = PIXEL_FORMAT_BGR24;
500
0
      break;
501
502
0
    case 16:
503
0
      context->format = PIXEL_FORMAT_BGR16;
504
0
      break;
505
506
0
    case 8:
507
0
      context->format = PIXEL_FORMAT_RGB8;
508
0
      break;
509
510
0
    case 4:
511
0
      context->format = PIXEL_FORMAT_A4;
512
0
      break;
513
514
0
    default:
515
0
      return FALSE;
516
873
  }
517
518
873
  context->width = WINPR_ASSERTING_INT_CAST(UINT16, width);
519
873
  context->height = WINPR_ASSERTING_INT_CAST(UINT16, height);
520
873
  ret = nsc_context_initialize(context, s);
521
522
873
  if (!ret)
523
176
    return FALSE;
524
525
  /* RLE decode */
526
697
  {
527
697
    BOOL rc = 0;
528
697
    PROFILER_ENTER(context->priv->prof_nsc_rle_decompress_data)
529
697
    rc = nsc_rle_decompress_data(context);
530
697
    PROFILER_EXIT(context->priv->prof_nsc_rle_decompress_data)
531
532
697
    if (!rc)
533
228
      return FALSE;
534
697
  }
535
  /* Colorloss recover, Chroma supersample and AYCoCg to ARGB Conversion in one step */
536
469
  {
537
469
    BOOL rc = 0;
538
469
    PROFILER_ENTER(context->priv->prof_nsc_decode)
539
469
    rc = context->decode(context);
540
469
    PROFILER_EXIT(context->priv->prof_nsc_decode)
541
542
469
    if (!rc)
543
0
      return FALSE;
544
469
  }
545
546
469
  uint32_t cwidth = width;
547
469
  if (1ull * nXDst + width > nWidth)
548
0
    cwidth = nWidth - nXDst;
549
550
469
  uint32_t cheight = height;
551
469
  if (1ull * nYDst + height > nHeight)
552
0
    cheight = nHeight - nYDst;
553
554
469
  return (freerdp_image_copy_no_overlap(pDstData, DstFormat, nDstStride, nXDst, nYDst, cwidth,
555
469
                                        cheight, context->BitmapData, PIXEL_FORMAT_BGRA32, 0, 0,
556
469
                                        0, nullptr, flip));
557
469
}