Coverage Report

Created: 2026-01-17 07:16

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