FreeRDP
Loading...
Searching...
No Matches
client/rdpsnd_main.c
1
25#include <freerdp/config.h>
26
27#ifndef _WIN32
28#include <sys/time.h>
29#include <signal.h>
30#endif
31
32#include <stdio.h>
33#include <stdlib.h>
34#include <string.h>
35#include <errno.h>
36
37#include <winpr/crt.h>
38#include <winpr/assert.h>
39#include <winpr/wlog.h>
40#include <winpr/stream.h>
41#include <winpr/cmdline.h>
42#include <winpr/sysinfo.h>
43#include <winpr/collections.h>
44
45#include <freerdp/types.h>
46#include <freerdp/addin.h>
47#include <freerdp/freerdp.h>
48#include <freerdp/codec/dsp.h>
49#include <freerdp/client/channels.h>
50
51#include "rdpsnd_common.h"
52#include "rdpsnd_main.h"
53
54struct rdpsnd_plugin
55{
56 IWTSPlugin iface;
57 IWTSListener* listener;
58 GENERIC_LISTENER_CALLBACK* listener_callback;
59
60 CHANNEL_DEF channelDef;
61 CHANNEL_ENTRY_POINTS_FREERDP_EX channelEntryPoints;
62
63 wStreamPool* pool;
64 wStream* data_in;
65
66 void* InitHandle;
67 DWORD OpenHandle;
68
69 wLog* log;
70
71 BYTE cBlockNo;
72 UINT16 wQualityMode;
73 UINT16 wCurrentFormatNo;
74
75 AUDIO_FORMAT* ServerFormats;
76 UINT16 NumberOfServerFormats;
77
78 AUDIO_FORMAT* ClientFormats;
79 UINT16 NumberOfClientFormats;
80
81 BOOL attached;
82 BOOL dynamic;
83
84 BOOL expectingWave;
85 BYTE waveData[4];
86 UINT16 waveDataSize;
87 UINT16 wTimeStamp;
88 UINT64 wArrivalTime;
89
90 UINT32 latency;
91 BOOL isOpen;
92 AUDIO_FORMAT* fixed_format;
93
94 UINT32 startPlayTime;
95 size_t totalPlaySize;
96
97 char* subsystem;
98 char* device_name;
99
100 /* Device plugin */
101 rdpsndDevicePlugin* device;
102 rdpContext* rdpcontext;
103
104 FREERDP_DSP_CONTEXT* dsp_context;
105
106 HANDLE thread;
107 wMessageQueue* queue;
108 CRITICAL_SECTION asyncLock;
109 BOOL initialized;
110
111 UINT16 wVersion;
112 UINT32 volume;
113 BOOL applyVolume;
114
115 size_t references;
116 BOOL OnOpenCalled;
117 BOOL async;
118 BOOL firstFlagReceived;
119 UINT32 totalLength;
120};
121
122WINPR_ATTR_NODISCARD
123static DWORD WINAPI play_thread(LPVOID arg);
124
125WINPR_ATTR_NODISCARD
126static const char* rdpsnd_is_dyn_str(BOOL dynamic)
127{
128 if (dynamic)
129 return "[dynamic]";
130 return "[static]";
131}
132
133static void rdpsnd_virtual_channel_event_terminated(rdpsndPlugin* rdpsnd);
134
140WINPR_ATTR_NODISCARD
141static UINT rdpsnd_virtual_channel_write(rdpsndPlugin* rdpsnd, wStream* s);
142
148WINPR_ATTR_NODISCARD
149static UINT rdpsnd_send_quality_mode_pdu(rdpsndPlugin* rdpsnd)
150{
151 wStream* pdu = nullptr;
152 WINPR_ASSERT(rdpsnd);
153 pdu = Stream_New(nullptr, 8);
154
155 if (!pdu)
156 {
157 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
158 return CHANNEL_RC_NO_MEMORY;
159 }
160
161 Stream_Write_UINT8(pdu, SNDC_QUALITYMODE); /* msgType */
162 Stream_Write_UINT8(pdu, 0); /* bPad */
163 Stream_Write_UINT16(pdu, 4); /* BodySize */
164 Stream_Write_UINT16(pdu, rdpsnd->wQualityMode); /* wQualityMode */
165 Stream_Write_UINT16(pdu, 0); /* Reserved */
166 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s QualityMode: %" PRIu16 "",
167 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->wQualityMode);
168 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
169}
170
171static void rdpsnd_select_supported_audio_formats(rdpsndPlugin* rdpsnd)
172{
173 WINPR_ASSERT(rdpsnd);
174 audio_formats_free(rdpsnd->ClientFormats, rdpsnd->NumberOfClientFormats);
175 rdpsnd->NumberOfClientFormats = 0;
176 rdpsnd->ClientFormats = nullptr;
177
178 if (!rdpsnd->NumberOfServerFormats)
179 return;
180
181 rdpsnd->ClientFormats = audio_formats_new(rdpsnd->NumberOfServerFormats);
182
183 if (!rdpsnd->ClientFormats || !rdpsnd->device)
184 return;
185
186 for (UINT16 index = 0; index < rdpsnd->NumberOfServerFormats; index++)
187 {
188 const AUDIO_FORMAT* serverFormat = &rdpsnd->ServerFormats[index];
189
190 if (!audio_format_compatible(rdpsnd->fixed_format, serverFormat))
191 continue;
192
193 WINPR_ASSERT(rdpsnd->device->FormatSupported);
194 if (freerdp_dsp_supports_format(serverFormat, FALSE) ||
195 rdpsnd->device->FormatSupported(rdpsnd->device, serverFormat))
196 {
197 AUDIO_FORMAT* clientFormat = &rdpsnd->ClientFormats[rdpsnd->NumberOfClientFormats++];
198 audio_format_copy(serverFormat, clientFormat);
199 }
200 }
201}
202
208WINPR_ATTR_NODISCARD
209static UINT rdpsnd_send_client_audio_formats(rdpsndPlugin* rdpsnd)
210{
211 wStream* pdu = nullptr;
212 size_t length = 0;
213 UINT32 dwVolume = 0;
214 UINT16 wNumberOfFormats = 0;
215 WINPR_ASSERT(rdpsnd);
216
217 if (!rdpsnd->device || (!rdpsnd->dynamic && (rdpsnd->OpenHandle == 0)))
218 return CHANNEL_RC_INITIALIZATION_ERROR;
219
220 dwVolume = IFCALLRESULT(0, rdpsnd->device->GetVolume, rdpsnd->device);
221 wNumberOfFormats = rdpsnd->NumberOfClientFormats;
222 length = 4 + 20;
223
224 for (UINT16 index = 0; index < wNumberOfFormats; index++)
225 length += (18 + rdpsnd->ClientFormats[index].cbSize);
226
227 /* BodySize is a UINT16 field, so the whole PDU must fit in UINT16_MAX. A server can inflate
228 * the client format list through large per-format cbSize values; without this bound the
229 * accumulator wrapped and Stream_New() below was undersized. Mirrors the server side check in
230 * rdpsnd_server_send_formats(). */
231 if (length > UINT16_MAX)
232 return ERROR_INVALID_DATA;
233
234 pdu = Stream_New(nullptr, length);
235
236 if (!pdu)
237 {
238 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
239 return CHANNEL_RC_NO_MEMORY;
240 }
241
242 Stream_Write_UINT8(pdu, SNDC_FORMATS); /* msgType */
243 Stream_Write_UINT8(pdu, 0); /* bPad */
244 Stream_Write_UINT16(pdu, (UINT16)(length - 4)); /* BodySize */
245 Stream_Write_UINT32(pdu, TSSNDCAPS_ALIVE | TSSNDCAPS_VOLUME); /* dwFlags */
246 Stream_Write_UINT32(pdu, dwVolume); /* dwVolume */
247 Stream_Write_UINT32(pdu, 0); /* dwPitch */
248 Stream_Write_UINT16(pdu, 0); /* wDGramPort */
249 Stream_Write_UINT16(pdu, wNumberOfFormats); /* wNumberOfFormats */
250 Stream_Write_UINT8(pdu, 0); /* cLastBlockConfirmed */
251 Stream_Write_UINT16(pdu, CHANNEL_VERSION_WIN_MAX); /* wVersion */
252 Stream_Write_UINT8(pdu, 0); /* bPad */
253
254 for (UINT16 index = 0; index < wNumberOfFormats; index++)
255 {
256 const AUDIO_FORMAT* clientFormat = &rdpsnd->ClientFormats[index];
257
258 if (!audio_format_write(pdu, clientFormat))
259 {
260 Stream_Free(pdu, TRUE);
261 return ERROR_INTERNAL_ERROR;
262 }
263 }
264
265 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Client Audio Formats",
266 rdpsnd_is_dyn_str(rdpsnd->dynamic));
267 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
268}
269
275WINPR_ATTR_NODISCARD
276static UINT rdpsnd_recv_server_audio_formats_pdu(rdpsndPlugin* rdpsnd, wStream* s)
277{
278 UINT16 wNumberOfFormats = 0;
279 UINT ret = ERROR_BAD_LENGTH;
280
281 WINPR_ASSERT(rdpsnd);
282 audio_formats_free(rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
283 rdpsnd->NumberOfServerFormats = 0;
284 rdpsnd->ServerFormats = nullptr;
285
286 if (!Stream_CheckAndLogRequiredLength(TAG, s, 30))
287 return ERROR_BAD_LENGTH;
288
289 /* http://msdn.microsoft.com/en-us/library/cc240956.aspx */
290 Stream_Seek_UINT32(s); /* dwFlags */
291 Stream_Seek_UINT32(s); /* dwVolume */
292 Stream_Seek_UINT32(s); /* dwPitch */
293 Stream_Seek_UINT16(s); /* wDGramPort */
294 Stream_Read_UINT16(s, wNumberOfFormats);
295 Stream_Read_UINT8(s, rdpsnd->cBlockNo); /* cLastBlockConfirmed */
296 Stream_Read_UINT16(s, rdpsnd->wVersion); /* wVersion */
297 Stream_Seek_UINT8(s); /* bPad */
298 rdpsnd->NumberOfServerFormats = wNumberOfFormats;
299
300 if (!Stream_CheckAndLogRequiredLengthOfSize(TAG, s, wNumberOfFormats, 14ull))
301 return ERROR_BAD_LENGTH;
302
303 if (rdpsnd->NumberOfServerFormats > 0)
304 {
305 rdpsnd->ServerFormats = audio_formats_new(wNumberOfFormats);
306
307 if (!rdpsnd->ServerFormats)
308 return CHANNEL_RC_NO_MEMORY;
309
310 for (UINT16 index = 0; index < wNumberOfFormats; index++)
311 {
312 AUDIO_FORMAT* format = &rdpsnd->ServerFormats[index];
313
314 if (!audio_format_read(s, format))
315 goto out_fail;
316 }
317 }
318
319 WINPR_ASSERT(rdpsnd->device);
320 ret = IFCALLRESULT(CHANNEL_RC_OK, rdpsnd->device->ServerFormatAnnounce, rdpsnd->device,
321 rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
322 if (ret != CHANNEL_RC_OK)
323 goto out_fail;
324
325 rdpsnd_select_supported_audio_formats(rdpsnd);
326 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Server Audio Formats",
327 rdpsnd_is_dyn_str(rdpsnd->dynamic));
328 ret = rdpsnd_send_client_audio_formats(rdpsnd);
329
330 if (ret == CHANNEL_RC_OK)
331 {
332 if (rdpsnd->wVersion >= CHANNEL_VERSION_WIN_7)
333 ret = rdpsnd_send_quality_mode_pdu(rdpsnd);
334 }
335
336 return ret;
337out_fail:
338 audio_formats_free(rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
339 rdpsnd->ServerFormats = nullptr;
340 rdpsnd->NumberOfServerFormats = 0;
341 return ret;
342}
343
349WINPR_ATTR_NODISCARD
350static UINT rdpsnd_send_training_confirm_pdu(rdpsndPlugin* rdpsnd, UINT16 wTimeStamp,
351 UINT16 wPackSize)
352{
353 wStream* pdu = nullptr;
354 WINPR_ASSERT(rdpsnd);
355 pdu = Stream_New(nullptr, 8);
356
357 if (!pdu)
358 {
359 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
360 return CHANNEL_RC_NO_MEMORY;
361 }
362
363 Stream_Write_UINT8(pdu, SNDC_TRAINING); /* msgType */
364 Stream_Write_UINT8(pdu, 0); /* bPad */
365 Stream_Write_UINT16(pdu, 4); /* BodySize */
366 Stream_Write_UINT16(pdu, wTimeStamp);
367 Stream_Write_UINT16(pdu, wPackSize);
368 WLog_Print(rdpsnd->log, WLOG_DEBUG,
369 "%s Training Response: wTimeStamp: %" PRIu16 " wPackSize: %" PRIu16 "",
370 rdpsnd_is_dyn_str(rdpsnd->dynamic), wTimeStamp, wPackSize);
371 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
372}
373
379WINPR_ATTR_NODISCARD
380static UINT rdpsnd_recv_training_pdu(rdpsndPlugin* rdpsnd, wStream* s)
381{
382 UINT16 wTimeStamp = 0;
383 UINT16 wPackSize = 0;
384 WINPR_ASSERT(rdpsnd);
385 WINPR_ASSERT(s);
386
387 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
388 return ERROR_BAD_LENGTH;
389
390 Stream_Read_UINT16(s, wTimeStamp);
391 Stream_Read_UINT16(s, wPackSize);
392 WLog_Print(rdpsnd->log, WLOG_DEBUG,
393 "%s Training Request: wTimeStamp: %" PRIu16 " wPackSize: %" PRIu16 "",
394 rdpsnd_is_dyn_str(rdpsnd->dynamic), wTimeStamp, wPackSize);
395 return rdpsnd_send_training_confirm_pdu(rdpsnd, wTimeStamp, wPackSize);
396}
397
398WINPR_ATTR_NODISCARD
399static BOOL rdpsnd_apply_volume(rdpsndPlugin* rdpsnd)
400{
401 WINPR_ASSERT(rdpsnd);
402
403 if (rdpsnd->isOpen && rdpsnd->applyVolume && rdpsnd->device)
404 {
405 BOOL rc = IFCALLRESULT(TRUE, rdpsnd->device->SetVolume, rdpsnd->device, rdpsnd->volume);
406 if (!rc)
407 return FALSE;
408 rdpsnd->applyVolume = FALSE;
409 }
410 return TRUE;
411}
412
413WINPR_ATTR_NODISCARD
414static BOOL rdpsnd_ensure_device_is_open(rdpsndPlugin* rdpsnd, UINT16 wFormatNo,
415 const AUDIO_FORMAT* format)
416{
417 if (!rdpsnd)
418 return FALSE;
419 WINPR_ASSERT(format);
420
421 if (!rdpsnd->isOpen || (wFormatNo != rdpsnd->wCurrentFormatNo))
422 {
423 BOOL rc = 0;
424 BOOL supported = 0;
425 AUDIO_FORMAT deviceFormat = *format;
426
427 IFCALL(rdpsnd->device->Close, rdpsnd->device);
428 supported = IFCALLRESULT(FALSE, rdpsnd->device->FormatSupported, rdpsnd->device, format);
429
430 if (!supported)
431 {
432 if (!IFCALLRESULT(FALSE, rdpsnd->device->DefaultFormat, rdpsnd->device, format,
433 &deviceFormat))
434 {
435 deviceFormat.wFormatTag = WAVE_FORMAT_PCM;
436 deviceFormat.wBitsPerSample = 16;
437 deviceFormat.cbSize = 0;
438 }
439 }
440
441 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Opening device with format %s [backend %s]",
442 rdpsnd_is_dyn_str(rdpsnd->dynamic),
443 audio_format_get_tag_string(format->wFormatTag),
444 audio_format_get_tag_string(deviceFormat.wFormatTag));
445 rc = IFCALLRESULT(FALSE, rdpsnd->device->Open, rdpsnd->device, &deviceFormat,
446 rdpsnd->latency);
447
448 if (!rc)
449 return FALSE;
450
451 if (!supported)
452 {
453 if (!freerdp_dsp_context_reset(rdpsnd->dsp_context, format, 0u))
454 return FALSE;
455 }
456
457 rdpsnd->isOpen = TRUE;
458 rdpsnd->wCurrentFormatNo = wFormatNo;
459 rdpsnd->startPlayTime = 0;
460 rdpsnd->totalPlaySize = 0;
461 }
462
463 return rdpsnd_apply_volume(rdpsnd);
464}
465
471WINPR_ATTR_NODISCARD
472static UINT rdpsnd_recv_wave_info_pdu(rdpsndPlugin* rdpsnd, wStream* s, UINT16 BodySize)
473{
474 UINT16 wFormatNo = 0;
475 const AUDIO_FORMAT* format = nullptr;
476 WINPR_ASSERT(rdpsnd);
477 WINPR_ASSERT(s);
478
479 if (!Stream_CheckAndLogRequiredLength(TAG, s, 12) || (BodySize < 8))
480 return ERROR_BAD_LENGTH;
481
482 rdpsnd->wArrivalTime = GetTickCount64();
483 Stream_Read_UINT16(s, rdpsnd->wTimeStamp);
484 Stream_Read_UINT16(s, wFormatNo);
485
486 if (wFormatNo >= rdpsnd->NumberOfClientFormats)
487 return ERROR_INVALID_DATA;
488
489 Stream_Read_UINT8(s, rdpsnd->cBlockNo);
490 Stream_Seek(s, 3); /* bPad */
491 Stream_Read(s, rdpsnd->waveData, 4);
492 rdpsnd->waveDataSize = BodySize - 8;
493 format = &rdpsnd->ClientFormats[wFormatNo];
494 WLog_Print(rdpsnd->log, WLOG_DEBUG,
495 "%s WaveInfo: cBlockNo: %" PRIu8 " wFormatNo: %" PRIu16 " [%s]",
496 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, wFormatNo,
497 audio_format_get_tag_string(format->wFormatTag));
498
499 if (!rdpsnd_ensure_device_is_open(rdpsnd, wFormatNo, format))
500 return ERROR_INTERNAL_ERROR;
501
502 rdpsnd->expectingWave = TRUE;
503 return CHANNEL_RC_OK;
504}
505
511WINPR_ATTR_NODISCARD
512static UINT rdpsnd_send_wave_confirm_pdu(rdpsndPlugin* rdpsnd, UINT16 wTimeStamp,
513 BYTE cConfirmedBlockNo)
514{
515 wStream* pdu = nullptr;
516 WINPR_ASSERT(rdpsnd);
517 pdu = Stream_New(nullptr, 8);
518
519 if (!pdu)
520 {
521 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
522 return CHANNEL_RC_NO_MEMORY;
523 }
524
525 Stream_Write_UINT8(pdu, SNDC_WAVECONFIRM);
526 Stream_Write_UINT8(pdu, 0);
527 Stream_Write_UINT16(pdu, 4);
528 Stream_Write_UINT16(pdu, wTimeStamp);
529 Stream_Write_UINT8(pdu, cConfirmedBlockNo); /* cConfirmedBlockNo */
530 Stream_Write_UINT8(pdu, 0); /* bPad */
531 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
532}
533
534WINPR_ATTR_NODISCARD
535static BOOL rdpsnd_detect_overrun(rdpsndPlugin* rdpsnd, const AUDIO_FORMAT* format, size_t size)
536{
537 UINT32 bpf = 0;
538 UINT32 now = 0;
539 UINT32 duration = 0;
540 UINT32 totalDuration = 0;
541 UINT32 remainingDuration = 0;
542 UINT32 maxDuration = 0;
543
544 if (!rdpsnd || !format)
545 return FALSE;
546
547 /* Older windows RDP servers do not limit the send buffer, which can
548 * cause quite a large amount of sound data buffered client side.
549 * If e.g. sound is paused server side the client will keep playing
550 * for a long time instead of pausing playback.
551 *
552 * To avoid this we check:
553 *
554 * 1. Is the sound sample received from a known format these servers
555 * support
556 * 2. If it is calculate the size of the client side sound buffer
557 * 3. If the buffer is too large silently drop the sample which will
558 * trigger a retransmit later on.
559 *
560 * This check must only be applied to these known formats, because
561 * with newer and other formats the sample size can not be calculated
562 * without decompressing the sample first.
563 */
564 switch (format->wFormatTag)
565 {
566 case WAVE_FORMAT_PCM:
567 case WAVE_FORMAT_DVI_ADPCM:
568 case WAVE_FORMAT_ADPCM:
569 case WAVE_FORMAT_ALAW:
570 case WAVE_FORMAT_MULAW:
571 break;
572 case WAVE_FORMAT_MSG723:
573 case WAVE_FORMAT_GSM610:
574 case WAVE_FORMAT_AAC_MS:
575 default:
576 return FALSE;
577 }
578
579 audio_format_print(WLog_Get(TAG), WLOG_DEBUG, format);
580 bpf = format->nChannels * format->wBitsPerSample * format->nSamplesPerSec / 8;
581 if (bpf == 0)
582 return FALSE;
583
584 duration = (UINT32)(1000 * size / bpf);
585 totalDuration = (UINT32)(1000 * rdpsnd->totalPlaySize / bpf);
586 now = GetTickCountPrecise();
587 if (rdpsnd->startPlayTime == 0)
588 {
589 rdpsnd->startPlayTime = now;
590 rdpsnd->totalPlaySize = size;
591 return FALSE;
592 }
593 else if (now - rdpsnd->startPlayTime > totalDuration + 10)
594 {
595 /* Buffer underrun */
596 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Buffer underrun by %u ms",
597 rdpsnd_is_dyn_str(rdpsnd->dynamic),
598 (UINT)(now - rdpsnd->startPlayTime - totalDuration));
599 rdpsnd->startPlayTime = now;
600 rdpsnd->totalPlaySize = size;
601 return FALSE;
602 }
603 else
604 {
605 /* Calculate remaining duration to be played */
606 remainingDuration = totalDuration - (now - rdpsnd->startPlayTime);
607
608 /* Maximum allow duration calculation */
609 maxDuration = duration * 2 + rdpsnd->latency;
610
611 if (remainingDuration + duration > maxDuration)
612 {
613 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Buffer overrun pending %u ms dropping %u ms",
614 rdpsnd_is_dyn_str(rdpsnd->dynamic), remainingDuration, duration);
615 return TRUE;
616 }
617
618 rdpsnd->totalPlaySize += size;
619 return FALSE;
620 }
621}
622
623WINPR_ATTR_NODISCARD
624static UINT rdpsnd_treat_wave(rdpsndPlugin* rdpsnd, wStream* s, size_t size)
625{
626 AUDIO_FORMAT* format = nullptr;
627 UINT64 end = 0;
628 UINT64 diffMS = 0;
629 UINT64 ts = 0;
630 UINT latency = 0;
631 UINT error = 0;
632
633 if (!Stream_CheckAndLogRequiredLength(TAG, s, size))
634 return ERROR_BAD_LENGTH;
635
636 if (rdpsnd->wCurrentFormatNo >= rdpsnd->NumberOfClientFormats)
637 return ERROR_INTERNAL_ERROR;
638
639 /*
640 * Send the first WaveConfirm PDU. The server side uses this to determine the
641 * network latency.
642 * See also [MS-RDPEA] 2.2.3.8 Wave Confirm PDU
643 */
644 error = rdpsnd_send_wave_confirm_pdu(rdpsnd, rdpsnd->wTimeStamp, rdpsnd->cBlockNo);
645 if (error)
646 return error;
647
648 const BYTE* data = Stream_ConstPointer(s);
649 format = &rdpsnd->ClientFormats[rdpsnd->wCurrentFormatNo];
650 WLog_Print(rdpsnd->log, WLOG_DEBUG,
651 "%s Wave: cBlockNo: %" PRIu8 " wTimeStamp: %" PRIu16 ", size: %" PRIuz,
652 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, rdpsnd->wTimeStamp, size);
653
654 if (rdpsnd->device && rdpsnd->attached && !rdpsnd_detect_overrun(rdpsnd, format, size))
655 {
656 UINT status = CHANNEL_RC_OK;
657 wStream* pcmData = StreamPool_Take(rdpsnd->pool, 4096);
658
659 if (rdpsnd->device->FormatSupported(rdpsnd->device, format))
660 {
661 if (rdpsnd->device->PlayEx)
662 latency = rdpsnd->device->PlayEx(rdpsnd->device, format, data, size);
663 else
664 latency = IFCALLRESULT(0, rdpsnd->device->Play, rdpsnd->device, data, size);
665 }
666 else if (freerdp_dsp_decode(rdpsnd->dsp_context, format, data, size, pcmData))
667 {
668 Stream_SealLength(pcmData);
669
670 if (rdpsnd->device->PlayEx)
671 latency = rdpsnd->device->PlayEx(rdpsnd->device, format, Stream_Buffer(pcmData),
672 Stream_Length(pcmData));
673 else
674 latency = IFCALLRESULT(0, rdpsnd->device->Play, rdpsnd->device,
675 Stream_Buffer(pcmData), Stream_Length(pcmData));
676 }
677 else
678 status = ERROR_INTERNAL_ERROR;
679
680 Stream_Release(pcmData);
681
682 if (status != CHANNEL_RC_OK)
683 return status;
684 }
685
686 end = GetTickCount64();
687 diffMS = end - rdpsnd->wArrivalTime + latency;
688 ts = (rdpsnd->wTimeStamp + diffMS) % UINT16_MAX;
689
690 /*
691 * Send the second WaveConfirm PDU. With the first WaveConfirm PDU,
692 * the server side uses this second WaveConfirm PDU to determine the actual
693 * render latency.
694 */
695 return rdpsnd_send_wave_confirm_pdu(rdpsnd, (UINT16)ts, rdpsnd->cBlockNo);
696}
697
703WINPR_ATTR_NODISCARD
704static UINT rdpsnd_recv_wave_pdu(rdpsndPlugin* rdpsnd, wStream* s)
705{
706 rdpsnd->expectingWave = FALSE;
707
714 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
715 return ERROR_INVALID_DATA;
716
717 CopyMemory(Stream_Buffer(s), rdpsnd->waveData, 4);
718 return rdpsnd_treat_wave(rdpsnd, s, rdpsnd->waveDataSize);
719}
720
721WINPR_ATTR_NODISCARD
722static UINT rdpsnd_recv_wave2_pdu(rdpsndPlugin* rdpsnd, wStream* s, UINT16 BodySize)
723{
724 UINT16 wFormatNo = 0;
725 AUDIO_FORMAT* format = nullptr;
726 UINT32 dwAudioTimeStamp = 0;
727
728 if (!Stream_CheckAndLogRequiredLength(TAG, s, 12) || (BodySize < 12))
729 return ERROR_BAD_LENGTH;
730
731 Stream_Read_UINT16(s, rdpsnd->wTimeStamp);
732 Stream_Read_UINT16(s, wFormatNo);
733 Stream_Read_UINT8(s, rdpsnd->cBlockNo);
734 Stream_Seek(s, 3); /* bPad */
735 Stream_Read_UINT32(s, dwAudioTimeStamp);
736 if (wFormatNo >= rdpsnd->NumberOfClientFormats)
737 return ERROR_INVALID_DATA;
738 format = &rdpsnd->ClientFormats[wFormatNo];
739 rdpsnd->waveDataSize = BodySize - 12;
740 rdpsnd->wArrivalTime = GetTickCount64();
741 WLog_Print(rdpsnd->log, WLOG_DEBUG,
742 "%s Wave2PDU: cBlockNo: %" PRIu8 " wFormatNo: %" PRIu16
743 " [%s] , align=%hu wTimeStamp=0x%04" PRIx16 ", dwAudioTimeStamp=0x%08" PRIx32,
744 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, wFormatNo,
745 audio_format_get_tag_string(format->wFormatTag), format->nBlockAlign,
746 rdpsnd->wTimeStamp, dwAudioTimeStamp);
747
748 if (!rdpsnd_ensure_device_is_open(rdpsnd, wFormatNo, format))
749 return ERROR_INTERNAL_ERROR;
750
751 return rdpsnd_treat_wave(rdpsnd, s, rdpsnd->waveDataSize);
752}
753
754static void rdpsnd_recv_close_pdu(rdpsndPlugin* rdpsnd)
755{
756 if (rdpsnd->isOpen)
757 {
758 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Closing device",
759 rdpsnd_is_dyn_str(rdpsnd->dynamic));
760 }
761 else
762 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Device already closed",
763 rdpsnd_is_dyn_str(rdpsnd->dynamic));
764}
765
771WINPR_ATTR_NODISCARD
772static UINT rdpsnd_recv_volume_pdu(rdpsndPlugin* rdpsnd, wStream* s)
773{
774 BOOL rc = TRUE;
775 UINT32 dwVolume = 0;
776
777 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
778 return ERROR_BAD_LENGTH;
779
780 Stream_Read_UINT32(s, dwVolume);
781 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Volume: 0x%08" PRIX32 "",
782 rdpsnd_is_dyn_str(rdpsnd->dynamic), dwVolume);
783
784 rdpsnd->volume = dwVolume;
785 rdpsnd->applyVolume = TRUE;
786 rc = rdpsnd_apply_volume(rdpsnd);
787
788 if (!rc)
789 {
790 WLog_ERR(TAG, "%s error setting volume", rdpsnd_is_dyn_str(rdpsnd->dynamic));
791 return CHANNEL_RC_INITIALIZATION_ERROR;
792 }
793
794 return CHANNEL_RC_OK;
795}
796
802WINPR_ATTR_NODISCARD
803static UINT rdpsnd_recv_pdu(rdpsndPlugin* rdpsnd, wStream* s)
804{
805 BYTE msgType = 0;
806 UINT16 BodySize = 0;
807 UINT status = CHANNEL_RC_OK;
808
809 if (rdpsnd->expectingWave)
810 {
811 status = rdpsnd_recv_wave_pdu(rdpsnd, s);
812 goto out;
813 }
814
815 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
816 {
817 status = ERROR_BAD_LENGTH;
818 goto out;
819 }
820
821 Stream_Read_UINT8(s, msgType); /* msgType */
822 Stream_Seek_UINT8(s); /* bPad */
823 Stream_Read_UINT16(s, BodySize);
824
825 switch (msgType)
826 {
827 case SNDC_FORMATS:
828 status = rdpsnd_recv_server_audio_formats_pdu(rdpsnd, s);
829 break;
830
831 case SNDC_TRAINING:
832 status = rdpsnd_recv_training_pdu(rdpsnd, s);
833 break;
834
835 case SNDC_WAVE:
836 status = rdpsnd_recv_wave_info_pdu(rdpsnd, s, BodySize);
837 break;
838
839 case SNDC_CLOSE:
840 rdpsnd_recv_close_pdu(rdpsnd);
841 break;
842
843 case SNDC_SETVOLUME:
844 status = rdpsnd_recv_volume_pdu(rdpsnd, s);
845 break;
846
847 case SNDC_WAVE2:
848 status = rdpsnd_recv_wave2_pdu(rdpsnd, s, BodySize);
849 break;
850
851 default:
852 WLog_ERR(TAG, "%s unknown msgType %" PRIu8 "", rdpsnd_is_dyn_str(rdpsnd->dynamic),
853 msgType);
854 break;
855 }
856
857out:
858 Stream_Release(s);
859 return status;
860}
861
862static void rdpsnd_register_device_plugin(rdpsndPlugin* rdpsnd, rdpsndDevicePlugin* device)
863{
864 if (rdpsnd->device)
865 {
866 WLog_ERR(TAG, "%s existing device, abort.", rdpsnd_is_dyn_str(FALSE));
867 return;
868 }
869
870 rdpsnd->device = device;
871 device->rdpsnd = rdpsnd;
872}
873
879WINPR_ATTR_NODISCARD
880static UINT rdpsnd_load_device_plugin(rdpsndPlugin* rdpsnd, const char* name,
881 const ADDIN_ARGV* args)
882{
883 FREERDP_RDPSND_DEVICE_ENTRY_POINTS entryPoints = WINPR_C_ARRAY_INIT;
884 UINT error = 0;
885 DWORD flags = FREERDP_ADDIN_CHANNEL_STATIC | FREERDP_ADDIN_CHANNEL_ENTRYEX;
886 if (rdpsnd->dynamic)
887 flags = FREERDP_ADDIN_CHANNEL_DYNAMIC;
888 PVIRTUALCHANNELENTRY pvce =
889 freerdp_load_channel_addin_entry(RDPSND_CHANNEL_NAME, name, nullptr, flags);
890 PFREERDP_RDPSND_DEVICE_ENTRY entry = WINPR_FUNC_PTR_CAST(pvce, PFREERDP_RDPSND_DEVICE_ENTRY);
891
892 if (!entry)
893 return ERROR_INTERNAL_ERROR;
894
895 entryPoints.rdpsnd = rdpsnd;
896 entryPoints.pRegisterRdpsndDevice = rdpsnd_register_device_plugin;
897 entryPoints.args = args;
898
899 error = entry(&entryPoints);
900 if (error)
901 WLog_WARN(TAG, "%s %s entry returns error %" PRIu32 "", rdpsnd_is_dyn_str(rdpsnd->dynamic),
902 name, error);
903 else
904 WLog_INFO(TAG, "%s Loaded %s backend for rdpsnd", rdpsnd_is_dyn_str(rdpsnd->dynamic), name);
905
906 return error;
907}
908
909WINPR_ATTR_NODISCARD
910static BOOL rdpsnd_set_subsystem(rdpsndPlugin* rdpsnd, const char* subsystem)
911{
912 free(rdpsnd->subsystem);
913 rdpsnd->subsystem = _strdup(subsystem);
914 return (rdpsnd->subsystem != nullptr);
915}
916
917WINPR_ATTR_NODISCARD
918static BOOL rdpsnd_set_device_name(rdpsndPlugin* rdpsnd, const char* device_name)
919{
920 free(rdpsnd->device_name);
921 rdpsnd->device_name = _strdup(device_name);
922 return (rdpsnd->device_name != nullptr);
923}
924
930WINPR_ATTR_NODISCARD
931static UINT rdpsnd_process_addin_args(rdpsndPlugin* rdpsnd, const ADDIN_ARGV* args)
932{
933 int status = 0;
934 DWORD flags = 0;
935 const COMMAND_LINE_ARGUMENT_A* arg = nullptr;
936 COMMAND_LINE_ARGUMENT_A rdpsnd_args[] = {
937 { "sys", COMMAND_LINE_VALUE_REQUIRED, "<subsystem>", nullptr, nullptr, -1, nullptr,
938 "subsystem" },
939 { "dev", COMMAND_LINE_VALUE_REQUIRED, "<device>", nullptr, nullptr, -1, nullptr, "device" },
940 { "format", COMMAND_LINE_VALUE_REQUIRED, "<format>", nullptr, nullptr, -1, nullptr,
941 "format" },
942 { "rate", COMMAND_LINE_VALUE_REQUIRED, "<rate>", nullptr, nullptr, -1, nullptr, "rate" },
943 { "channel", COMMAND_LINE_VALUE_REQUIRED, "<channel>", nullptr, nullptr, -1, nullptr,
944 "channel" },
945 { "latency", COMMAND_LINE_VALUE_REQUIRED, "<latency>", nullptr, nullptr, -1, nullptr,
946 "latency" },
947 { "quality", COMMAND_LINE_VALUE_REQUIRED, "<quality mode>", nullptr, nullptr, -1, nullptr,
948 "quality mode" },
949 { nullptr, 0, nullptr, nullptr, nullptr, -1, nullptr, nullptr }
950 };
951 rdpsnd->wQualityMode = HIGH_QUALITY; /* default quality mode */
952
953 if (args->argc > 1)
954 {
955 flags = COMMAND_LINE_SIGIL_NONE | COMMAND_LINE_SEPARATOR_COLON;
956 status = CommandLineParseArgumentsA(args->argc, args->argv, rdpsnd_args, flags, rdpsnd,
957 nullptr, nullptr);
958
959 if (status < 0)
960 return CHANNEL_RC_INITIALIZATION_ERROR;
961
962 arg = rdpsnd_args;
963 errno = 0;
964
965 do
966 {
967 if (!(arg->Flags & COMMAND_LINE_VALUE_PRESENT))
968 continue;
969
970 CommandLineSwitchStart(arg) CommandLineSwitchCase(arg, "sys")
971 {
972 if (!rdpsnd_set_subsystem(rdpsnd, arg->Value))
973 return CHANNEL_RC_NO_MEMORY;
974 }
975 CommandLineSwitchCase(arg, "dev")
976 {
977 if (!rdpsnd_set_device_name(rdpsnd, arg->Value))
978 return CHANNEL_RC_NO_MEMORY;
979 }
980 CommandLineSwitchCase(arg, "format")
981 {
982 unsigned long val = strtoul(arg->Value, nullptr, 0);
983
984 if ((errno != 0) || (val > UINT16_MAX))
985 return CHANNEL_RC_INITIALIZATION_ERROR;
986
987 rdpsnd->fixed_format->wFormatTag = (UINT16)val;
988 }
989 CommandLineSwitchCase(arg, "rate")
990 {
991 unsigned long val = strtoul(arg->Value, nullptr, 0);
992
993 if ((errno != 0) || (val > UINT32_MAX))
994 return CHANNEL_RC_INITIALIZATION_ERROR;
995
996 rdpsnd->fixed_format->nSamplesPerSec = (UINT32)val;
997 }
998 CommandLineSwitchCase(arg, "channel")
999 {
1000 unsigned long val = strtoul(arg->Value, nullptr, 0);
1001
1002 if ((errno != 0) || (val > UINT16_MAX))
1003 return CHANNEL_RC_INITIALIZATION_ERROR;
1004
1005 rdpsnd->fixed_format->nChannels = (UINT16)val;
1006 }
1007 CommandLineSwitchCase(arg, "latency")
1008 {
1009 unsigned long val = strtoul(arg->Value, nullptr, 0);
1010
1011 if ((errno != 0) || (val > UINT32_MAX))
1012 return CHANNEL_RC_INITIALIZATION_ERROR;
1013
1014 rdpsnd->latency = (UINT32)val;
1015 }
1016 CommandLineSwitchCase(arg, "quality")
1017 {
1018 long wQualityMode = DYNAMIC_QUALITY;
1019
1020 if (_stricmp(arg->Value, "dynamic") == 0)
1021 wQualityMode = DYNAMIC_QUALITY;
1022 else if (_stricmp(arg->Value, "medium") == 0)
1023 wQualityMode = MEDIUM_QUALITY;
1024 else if (_stricmp(arg->Value, "high") == 0)
1025 wQualityMode = HIGH_QUALITY;
1026 else
1027 {
1028 wQualityMode = strtol(arg->Value, nullptr, 0);
1029
1030 if (errno != 0)
1031 return CHANNEL_RC_INITIALIZATION_ERROR;
1032 }
1033
1034 if ((wQualityMode < 0) || (wQualityMode > 2))
1035 wQualityMode = DYNAMIC_QUALITY;
1036
1037 rdpsnd->wQualityMode = (UINT16)wQualityMode;
1038 }
1039 CommandLineSwitchDefault(arg)
1040 {
1041 }
1042 CommandLineSwitchEnd(arg)
1043 } while ((arg = CommandLineFindNextArgumentA(arg)) != nullptr);
1044 }
1045
1046 return CHANNEL_RC_OK;
1047}
1048
1054WINPR_ATTR_NODISCARD
1055static UINT rdpsnd_process_connect(rdpsndPlugin* rdpsnd)
1056{
1057 const struct
1058 {
1059 const char* subsystem;
1060 const char* device;
1061 } backends[] = {
1062#if defined(WITH_IOSAUDIO)
1063 { "ios", "" },
1064#endif
1065#if defined(WITH_AAUDIO)
1066 { "aaudio", "" },
1067#endif
1068#if defined(WITH_OPENSLES)
1069 { "opensles", "" },
1070#endif
1071#if defined(WITH_PULSE)
1072 { "pulse", "" },
1073#endif
1074#if defined(WITH_ALSA)
1075 { "alsa", "default" },
1076#endif
1077#if defined(WITH_OSS)
1078 { "oss", "" },
1079#endif
1080#if defined(WITH_MACAUDIO)
1081 { "mac", "default" },
1082#endif
1083#if defined(WITH_WINMM)
1084 { "winmm", "" },
1085#endif
1086#if defined(WITH_SNDIO)
1087 { "sndio", "" },
1088#endif
1089 { "fake", "" }
1090 };
1091 const ADDIN_ARGV* args = nullptr;
1092 UINT status = ERROR_INTERNAL_ERROR;
1093 WINPR_ASSERT(rdpsnd);
1094 rdpsnd->latency = 0;
1095 args = (const ADDIN_ARGV*)rdpsnd->channelEntryPoints.pExtendedData;
1096
1097 if (args)
1098 {
1099 status = rdpsnd_process_addin_args(rdpsnd, args);
1100
1101 if (status != CHANNEL_RC_OK)
1102 return status;
1103 }
1104
1105 if (rdpsnd->subsystem)
1106 {
1107 if ((status = rdpsnd_load_device_plugin(rdpsnd, rdpsnd->subsystem, args)))
1108 {
1109 WLog_ERR(TAG,
1110 "%s Unable to load sound playback subsystem %s because of error %" PRIu32 "",
1111 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->subsystem, status);
1112 return status;
1113 }
1114 }
1115 else
1116 {
1117 for (size_t x = 0; x < ARRAYSIZE(backends); x++)
1118 {
1119 const char* subsystem_name = backends[x].subsystem;
1120 const char* device_name = backends[x].device;
1121
1122 if ((status = rdpsnd_load_device_plugin(rdpsnd, subsystem_name, args)))
1123 WLog_WARN(TAG,
1124 "%s Unable to load sound playback subsystem %s because of error %" PRIu32
1125 "",
1126 rdpsnd_is_dyn_str(rdpsnd->dynamic), subsystem_name, status);
1127
1128 if (!rdpsnd->device)
1129 continue;
1130
1131 if (!rdpsnd_set_subsystem(rdpsnd, subsystem_name) ||
1132 !rdpsnd_set_device_name(rdpsnd, device_name))
1133 return CHANNEL_RC_NO_MEMORY;
1134
1135 break;
1136 }
1137
1138 if (!rdpsnd->device || status)
1139 return CHANNEL_RC_INITIALIZATION_ERROR;
1140 }
1141
1142 return CHANNEL_RC_OK;
1143}
1144
1150UINT rdpsnd_virtual_channel_write(rdpsndPlugin* rdpsnd, wStream* s)
1151{
1152 UINT status = CHANNEL_RC_BAD_INIT_HANDLE;
1153
1154 if (rdpsnd)
1155 {
1156 if (rdpsnd->dynamic)
1157 {
1158 IWTSVirtualChannel* channel = nullptr;
1159 if (rdpsnd->listener_callback)
1160 {
1161 channel = rdpsnd->listener_callback->channel_callback->channel;
1162 status =
1163 channel->Write(channel, (UINT32)Stream_Length(s), Stream_Buffer(s), nullptr);
1164 }
1165 Stream_Free(s, TRUE);
1166 }
1167 else
1168 {
1169 status = rdpsnd->channelEntryPoints.pVirtualChannelWriteEx(
1170 rdpsnd->InitHandle, rdpsnd->OpenHandle, Stream_Buffer(s),
1171 (UINT32)Stream_GetPosition(s), s);
1172
1173 if (status != CHANNEL_RC_OK)
1174 {
1175 Stream_Free(s, TRUE);
1176 WLog_ERR(TAG, "%s pVirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1177 rdpsnd_is_dyn_str(FALSE), WTSErrorToString(status), status);
1178 }
1179 }
1180 }
1181
1182 return status;
1183}
1184
1190WINPR_ATTR_NODISCARD
1191static UINT rdpsnd_virtual_channel_event_data_received(rdpsndPlugin* plugin, void* pData,
1192 UINT32 dataLength, UINT32 totalLength,
1193 UINT32 dataFlags)
1194{
1195 if ((dataFlags & CHANNEL_FLAG_SUSPEND) || (dataFlags & CHANNEL_FLAG_RESUME))
1196 return CHANNEL_RC_OK;
1197
1198 if (dataFlags & CHANNEL_FLAG_FIRST)
1199 {
1200 if (plugin->firstFlagReceived)
1201 return ERROR_INVALID_DATA;
1202 plugin->firstFlagReceived = TRUE;
1203
1204 if (!plugin->data_in)
1205 plugin->data_in = StreamPool_Take(plugin->pool, dataLength);
1206
1207 Stream_ResetPosition(plugin->data_in);
1208 plugin->totalLength = totalLength;
1209 }
1210
1211 if (!plugin->data_in)
1212 return ERROR_INVALID_DATA;
1213
1214 if (!Stream_EnsureRemainingCapacity(plugin->data_in, dataLength))
1215 return CHANNEL_RC_NO_MEMORY;
1216
1217 Stream_Write(plugin->data_in, pData, dataLength);
1218
1219 if ((Stream_GetPosition(plugin->data_in) > totalLength) || (totalLength != plugin->totalLength))
1220 return ERROR_INVALID_DATA;
1221
1222 if (dataFlags & CHANNEL_FLAG_LAST)
1223 {
1224 if (!plugin->firstFlagReceived)
1225 return ERROR_INVALID_DATA;
1226 if (Stream_GetPosition(plugin->data_in) != totalLength)
1227 return ERROR_INVALID_DATA;
1228 plugin->firstFlagReceived = FALSE;
1229
1230 Stream_SealLength(plugin->data_in);
1231 Stream_ResetPosition(plugin->data_in);
1232 plugin->totalLength = 0;
1233
1234 if (plugin->async)
1235 {
1236 if (!MessageQueue_Post(plugin->queue, nullptr, 0, plugin->data_in, nullptr))
1237 return ERROR_INTERNAL_ERROR;
1238 plugin->data_in = nullptr;
1239 }
1240 else
1241 {
1242 UINT error = rdpsnd_recv_pdu(plugin, plugin->data_in);
1243 plugin->data_in = nullptr;
1244 if (error)
1245 return error;
1246 }
1247 }
1248
1249 return CHANNEL_RC_OK;
1250}
1251
1252static VOID VCAPITYPE rdpsnd_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
1253 UINT event, LPVOID pData,
1254 UINT32 dataLength, UINT32 totalLength,
1255 UINT32 dataFlags)
1256{
1257 UINT error = CHANNEL_RC_OK;
1258 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)lpUserParam;
1259 WINPR_ASSERT(rdpsnd);
1260 WINPR_ASSERT(!rdpsnd->dynamic);
1261
1262 switch (event)
1263 {
1264 case CHANNEL_EVENT_DATA_RECEIVED:
1265 if (!rdpsnd)
1266 return;
1267
1268 if (rdpsnd->OpenHandle != openHandle)
1269 {
1270 WLog_ERR(TAG, "%s error no match", rdpsnd_is_dyn_str(rdpsnd->dynamic));
1271 return;
1272 }
1273 if ((error = rdpsnd_virtual_channel_event_data_received(rdpsnd, pData, dataLength,
1274 totalLength, dataFlags)))
1275 WLog_ERR(TAG,
1276 "%s rdpsnd_virtual_channel_event_data_received failed with error %" PRIu32
1277 "",
1278 rdpsnd_is_dyn_str(rdpsnd->dynamic), error);
1279
1280 break;
1281
1282 case CHANNEL_EVENT_WRITE_CANCELLED:
1283 case CHANNEL_EVENT_WRITE_COMPLETE:
1284 {
1285 wStream* s = (wStream*)pData;
1286 Stream_Free(s, TRUE);
1287 }
1288 break;
1289
1290 case CHANNEL_EVENT_USER:
1291 break;
1292 default:
1293 break;
1294 }
1295
1296 if (error && rdpsnd && rdpsnd->rdpcontext)
1297 {
1298 char buffer[8192];
1299 (void)_snprintf(buffer, sizeof(buffer),
1300 "%s rdpsnd_virtual_channel_open_event_ex reported an error",
1301 rdpsnd_is_dyn_str(rdpsnd->dynamic));
1302 setChannelError(rdpsnd->rdpcontext, error, buffer);
1303 }
1304}
1305
1311WINPR_ATTR_NODISCARD
1312static UINT rdpsnd_virtual_channel_event_connected(rdpsndPlugin* rdpsnd, LPVOID pData,
1313 UINT32 dataLength)
1314{
1315 UINT32 status = 0;
1316 DWORD opened = 0;
1317 WINPR_UNUSED(pData);
1318 WINPR_UNUSED(dataLength);
1319
1320 WINPR_ASSERT(rdpsnd);
1321 WINPR_ASSERT(!rdpsnd->dynamic);
1322
1323 status = rdpsnd->channelEntryPoints.pVirtualChannelOpenEx(
1324 rdpsnd->InitHandle, &opened, rdpsnd->channelDef.name, rdpsnd_virtual_channel_open_event_ex);
1325
1326 if (status != CHANNEL_RC_OK)
1327 {
1328 WLog_ERR(TAG, "%s pVirtualChannelOpenEx failed with %s [%08" PRIX32 "]",
1329 rdpsnd_is_dyn_str(rdpsnd->dynamic), WTSErrorToString(status), status);
1330 goto fail;
1331 }
1332
1333 if (rdpsnd_process_connect(rdpsnd) != CHANNEL_RC_OK)
1334 goto fail;
1335
1336 rdpsnd->OpenHandle = opened;
1337 return CHANNEL_RC_OK;
1338fail:
1339 if (opened != 0)
1340 rdpsnd->channelEntryPoints.pVirtualChannelCloseEx(rdpsnd->InitHandle, opened);
1341 return CHANNEL_RC_NO_MEMORY;
1342}
1343
1344static void rdpsnd_terminate_thread(rdpsndPlugin* rdpsnd)
1345{
1346 WINPR_ASSERT(rdpsnd);
1347 if (rdpsnd->async)
1348 {
1349 if (rdpsnd->queue)
1350 MessageQueue_PostQuit(rdpsnd->queue, 0);
1351
1352 if (rdpsnd->thread)
1353 {
1354 (void)WaitForSingleObject(rdpsnd->thread, INFINITE);
1355 (void)CloseHandle(rdpsnd->thread);
1356 }
1357 DeleteCriticalSection(&rdpsnd->asyncLock);
1358 MessageQueue_Free(rdpsnd->queue);
1359 }
1360 rdpsnd->thread = nullptr;
1361 rdpsnd->queue = nullptr;
1362}
1363
1364static void cleanup_internals(rdpsndPlugin* rdpsnd)
1365{
1366 if (!rdpsnd)
1367 return;
1368
1369 if (rdpsnd->async)
1370 EnterCriticalSection(&rdpsnd->asyncLock);
1371
1372 if (rdpsnd->pool)
1373 StreamPool_Return(rdpsnd->pool, rdpsnd->data_in);
1374
1375 audio_formats_free(rdpsnd->ClientFormats, rdpsnd->NumberOfClientFormats);
1376 audio_formats_free(rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
1377
1378 rdpsnd->NumberOfClientFormats = 0;
1379 rdpsnd->ClientFormats = nullptr;
1380 rdpsnd->NumberOfServerFormats = 0;
1381 rdpsnd->ServerFormats = nullptr;
1382
1383 rdpsnd->data_in = nullptr;
1384
1385 if (rdpsnd->async)
1386 LeaveCriticalSection(&rdpsnd->asyncLock);
1387}
1388
1394WINPR_ATTR_NODISCARD
1395static UINT rdpsnd_virtual_channel_event_disconnected(rdpsndPlugin* rdpsnd)
1396{
1397 UINT error = 0;
1398
1399 WINPR_ASSERT(rdpsnd);
1400 WINPR_ASSERT(!rdpsnd->dynamic);
1401 if (rdpsnd->OpenHandle != 0)
1402 {
1403 DWORD opened = rdpsnd->OpenHandle;
1404 rdpsnd->OpenHandle = 0;
1405 if (rdpsnd->device)
1406 IFCALL(rdpsnd->device->Close, rdpsnd->device);
1407
1408 error = rdpsnd->channelEntryPoints.pVirtualChannelCloseEx(rdpsnd->InitHandle, opened);
1409
1410 if (CHANNEL_RC_OK != error)
1411 {
1412 WLog_ERR(TAG, "%s pVirtualChannelCloseEx failed with %s [%08" PRIX32 "]",
1413 rdpsnd_is_dyn_str(rdpsnd->dynamic), WTSErrorToString(error), error);
1414 return error;
1415 }
1416 }
1417
1418 cleanup_internals(rdpsnd);
1419
1420 if (rdpsnd->device)
1421 {
1422 IFCALL(rdpsnd->device->Free, rdpsnd->device);
1423 rdpsnd->device = nullptr;
1424 }
1425
1426 return CHANNEL_RC_OK;
1427}
1428
1429static void queue_free(void* obj)
1430{
1431 wMessage* msg = obj;
1432 if (!msg)
1433 return;
1434 if (msg->id != 0)
1435 return;
1436 wStream* s = msg->wParam;
1437 Stream_Release(s);
1438}
1439
1440static void free_internals(rdpsndPlugin* rdpsnd)
1441{
1442 if (!rdpsnd)
1443 return;
1444
1445 if (rdpsnd->references > 0)
1446 rdpsnd->references--;
1447
1448 if (rdpsnd->references > 0)
1449 return;
1450
1451 rdpsnd_terminate_thread(rdpsnd);
1452 freerdp_dsp_context_free(rdpsnd->dsp_context);
1453 StreamPool_Free(rdpsnd->pool);
1454 rdpsnd->pool = nullptr;
1455 rdpsnd->dsp_context = nullptr;
1456}
1457
1458WINPR_ATTR_NODISCARD
1459static BOOL allocate_internals(rdpsndPlugin* rdpsnd)
1460{
1461 WINPR_ASSERT(rdpsnd);
1462
1463 if (!rdpsnd->pool)
1464 {
1465 rdpsnd->pool = StreamPool_New(TRUE, 4096);
1466 if (!rdpsnd->pool)
1467 return FALSE;
1468 }
1469
1470 if (!rdpsnd->dsp_context)
1471 {
1472 rdpsnd->dsp_context = freerdp_dsp_context_new(FALSE);
1473 if (!rdpsnd->dsp_context)
1474 return FALSE;
1475 }
1476
1477 if (rdpsnd->async)
1478 {
1479 if (!rdpsnd->queue)
1480 {
1481 wObject obj = WINPR_C_ARRAY_INIT;
1482
1483 obj.fnObjectFree = queue_free;
1484 rdpsnd->queue = MessageQueue_New(&obj);
1485 if (!rdpsnd->queue)
1486 return CHANNEL_RC_NO_MEMORY;
1487 InitializeCriticalSection(&rdpsnd->asyncLock);
1488 }
1489
1490 if (!rdpsnd->thread)
1491 {
1492 rdpsnd->thread = CreateThread(nullptr, 0, play_thread, rdpsnd, 0, nullptr);
1493 if (!rdpsnd->thread)
1494 return CHANNEL_RC_INITIALIZATION_ERROR;
1495 }
1496 }
1497
1498 rdpsnd->references++;
1499
1500 return TRUE;
1501}
1502
1503WINPR_ATTR_NODISCARD
1504static DWORD WINAPI play_thread(LPVOID arg)
1505{
1506 UINT error = CHANNEL_RC_OK;
1507 rdpsndPlugin* rdpsnd = arg;
1508
1509 if (!rdpsnd || !rdpsnd->queue)
1510 return ERROR_INVALID_PARAMETER;
1511
1512 while (TRUE)
1513 {
1514 int rc = -1;
1515 wMessage message = WINPR_C_ARRAY_INIT;
1516 wStream* s = nullptr;
1517 DWORD status = 0;
1518 DWORD nCount = 0;
1519 HANDLE handles[MAXIMUM_WAIT_OBJECTS] = WINPR_C_ARRAY_INIT;
1520
1521 handles[nCount++] = MessageQueue_Event(rdpsnd->queue);
1522 handles[nCount++] = freerdp_abort_event(rdpsnd->rdpcontext);
1523 status = WaitForMultipleObjects(nCount, handles, FALSE, INFINITE);
1524 switch (status)
1525 {
1526 case WAIT_OBJECT_0:
1527 break;
1528 default:
1529 return ERROR_TIMEOUT;
1530 }
1531
1532 rc = MessageQueue_Peek(rdpsnd->queue, &message, TRUE);
1533 if (rc < 1)
1534 continue;
1535
1536 if (message.id == WMQ_QUIT)
1537 break;
1538
1539 if (rdpsnd->async)
1540 EnterCriticalSection(&rdpsnd->asyncLock);
1541
1542 s = message.wParam;
1543 error = rdpsnd_recv_pdu(rdpsnd, s);
1544
1545 if (rdpsnd->async)
1546 LeaveCriticalSection(&rdpsnd->asyncLock);
1547
1548 if (error)
1549 return error;
1550 }
1551
1552 return CHANNEL_RC_OK;
1553}
1554
1555WINPR_ATTR_NODISCARD
1556static UINT rdpsnd_virtual_channel_event_initialized(rdpsndPlugin* rdpsnd)
1557{
1558 if (!rdpsnd)
1559 return ERROR_INVALID_PARAMETER;
1560
1561 if (!allocate_internals(rdpsnd))
1562 return CHANNEL_RC_NO_MEMORY;
1563
1564 return CHANNEL_RC_OK;
1565}
1566
1567void rdpsnd_virtual_channel_event_terminated(rdpsndPlugin* rdpsnd)
1568{
1569 if (rdpsnd)
1570 {
1571 free_internals(rdpsnd);
1572 audio_formats_free(rdpsnd->fixed_format, 1);
1573 free(rdpsnd->subsystem);
1574 free(rdpsnd->device_name);
1575 rdpsnd->InitHandle = nullptr;
1576 }
1577
1578 free(rdpsnd);
1579}
1580
1581static VOID VCAPITYPE rdpsnd_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
1582 UINT event, LPVOID pData,
1583 UINT dataLength)
1584{
1585 UINT error = CHANNEL_RC_OK;
1586 rdpsndPlugin* plugin = (rdpsndPlugin*)lpUserParam;
1587
1588 if (!plugin)
1589 return;
1590
1591 if (plugin->InitHandle != pInitHandle)
1592 {
1593 WLog_ERR(TAG, "%s error no match", rdpsnd_is_dyn_str(plugin->dynamic));
1594 return;
1595 }
1596
1597 switch (event)
1598 {
1599 case CHANNEL_EVENT_INITIALIZED:
1600 error = rdpsnd_virtual_channel_event_initialized(plugin);
1601 break;
1602
1603 case CHANNEL_EVENT_CONNECTED:
1604 error = rdpsnd_virtual_channel_event_connected(plugin, pData, dataLength);
1605 break;
1606
1607 case CHANNEL_EVENT_DISCONNECTED:
1608 error = rdpsnd_virtual_channel_event_disconnected(plugin);
1609 break;
1610
1611 case CHANNEL_EVENT_TERMINATED:
1612 rdpsnd_virtual_channel_event_terminated(plugin);
1613 plugin = nullptr;
1614 break;
1615
1616 case CHANNEL_EVENT_ATTACHED:
1617 plugin->attached = TRUE;
1618 break;
1619
1620 case CHANNEL_EVENT_DETACHED:
1621 plugin->attached = FALSE;
1622 break;
1623
1624 default:
1625 break;
1626 }
1627
1628 if (error && plugin && plugin->rdpcontext)
1629 {
1630 char buffer[8192];
1631 (void)_snprintf(buffer, sizeof(buffer), "%s reported an error",
1632 rdpsnd_is_dyn_str(plugin->dynamic));
1633 setChannelError(plugin->rdpcontext, error, buffer);
1634 }
1635}
1636
1637rdpContext* freerdp_rdpsnd_get_context(rdpsndPlugin* plugin)
1638{
1639 if (!plugin)
1640 return nullptr;
1641
1642 return plugin->rdpcontext;
1643}
1644
1645WINPR_ATTR_NODISCARD
1646static rdpsndPlugin* allocatePlugin(void)
1647{
1648 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)calloc(1, sizeof(rdpsndPlugin));
1649 if (!rdpsnd)
1650 goto fail;
1651
1652 rdpsnd->fixed_format = audio_format_new();
1653 if (!rdpsnd->fixed_format)
1654 goto fail;
1655 rdpsnd->log = WLog_Get("com.freerdp.channels.rdpsnd.client");
1656 if (!rdpsnd->log)
1657 goto fail;
1658
1659 rdpsnd->attached = TRUE;
1660 return rdpsnd;
1661
1662fail:
1663 if (rdpsnd)
1664 audio_formats_free(rdpsnd->fixed_format, 1);
1665 free(rdpsnd);
1666 return nullptr;
1667}
1668/* rdpsnd is always built-in */
1669FREERDP_ENTRY_POINT(BOOL VCAPITYPE rdpsnd_VirtualChannelEntryEx(
1670 PCHANNEL_ENTRY_POINTS_EX pEntryPoints, PVOID pInitHandle))
1671{
1672 UINT rc = 0;
1673 CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx = nullptr;
1674
1675 if (!pEntryPoints)
1676 return FALSE;
1677
1678 rdpsndPlugin* rdpsnd = allocatePlugin();
1679
1680 if (!rdpsnd)
1681 return FALSE;
1682
1683 rdpsnd->channelDef.options = CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP;
1684 (void)sprintf_s(rdpsnd->channelDef.name, ARRAYSIZE(rdpsnd->channelDef.name),
1685 RDPSND_CHANNEL_NAME);
1686 pEntryPointsEx = (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
1687
1688 if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
1689 (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
1690 {
1691 rdpsnd->rdpcontext = pEntryPointsEx->context;
1692 if (!freerdp_settings_get_bool(rdpsnd->rdpcontext->settings,
1693 FreeRDP_SynchronousStaticChannels))
1694 rdpsnd->async = TRUE;
1695 }
1696
1697 CopyMemory(&(rdpsnd->channelEntryPoints), pEntryPoints,
1698 sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX));
1699 rdpsnd->InitHandle = pInitHandle;
1700
1701 WINPR_ASSERT(rdpsnd->channelEntryPoints.pVirtualChannelInitEx);
1702 rc = rdpsnd->channelEntryPoints.pVirtualChannelInitEx(
1703 rdpsnd, nullptr, pInitHandle, &rdpsnd->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
1704 rdpsnd_virtual_channel_init_event_ex);
1705
1706 if (CHANNEL_RC_OK != rc)
1707 {
1708 WLog_ERR(TAG, "%s pVirtualChannelInitEx failed with %s [%08" PRIX32 "]",
1709 rdpsnd_is_dyn_str(FALSE), WTSErrorToString(rc), rc);
1710 rdpsnd_virtual_channel_event_terminated(rdpsnd);
1711 return FALSE;
1712 }
1713
1714 return TRUE;
1715}
1716
1717WINPR_ATTR_NODISCARD
1718static UINT rdpsnd_on_open(IWTSVirtualChannelCallback* pChannelCallback)
1719{
1720 GENERIC_CHANNEL_CALLBACK* callback = (GENERIC_CHANNEL_CALLBACK*)pChannelCallback;
1721 rdpsndPlugin* rdpsnd = nullptr;
1722
1723 WINPR_ASSERT(callback);
1724
1725 rdpsnd = (rdpsndPlugin*)callback->plugin;
1726 WINPR_ASSERT(rdpsnd);
1727
1728 if (rdpsnd->OnOpenCalled)
1729 return CHANNEL_RC_OK;
1730 rdpsnd->OnOpenCalled = TRUE;
1731
1732 if (!allocate_internals(rdpsnd))
1733 return ERROR_OUTOFMEMORY;
1734
1735 return rdpsnd_process_connect(rdpsnd);
1736}
1737
1738WINPR_ATTR_NODISCARD
1739static UINT rdpsnd_on_data_received(IWTSVirtualChannelCallback* pChannelCallback, wStream* data)
1740{
1741 GENERIC_CHANNEL_CALLBACK* callback = (GENERIC_CHANNEL_CALLBACK*)pChannelCallback;
1742 rdpsndPlugin* plugin = nullptr;
1743 wStream* copy = nullptr;
1744 size_t len = 0;
1745
1746 len = Stream_GetRemainingLength(data);
1747
1748 if (!callback || !callback->plugin)
1749 return ERROR_INVALID_PARAMETER;
1750 plugin = (rdpsndPlugin*)callback->plugin;
1751 WINPR_ASSERT(plugin);
1752
1753 copy = StreamPool_Take(plugin->pool, len);
1754 if (!copy)
1755 return ERROR_OUTOFMEMORY;
1756 Stream_Copy(data, copy, len);
1757 Stream_SealLength(copy);
1758 Stream_ResetPosition(copy);
1759
1760 if (plugin->async)
1761 {
1762 if (!MessageQueue_Post(plugin->queue, nullptr, 0, copy, nullptr))
1763 {
1764 Stream_Release(copy);
1765 return ERROR_INTERNAL_ERROR;
1766 }
1767 }
1768 else
1769 {
1770 UINT error = rdpsnd_recv_pdu(plugin, copy);
1771 if (error)
1772 return error;
1773 }
1774
1775 return CHANNEL_RC_OK;
1776}
1777
1778WINPR_ATTR_NODISCARD
1779static UINT rdpsnd_on_close(IWTSVirtualChannelCallback* pChannelCallback)
1780{
1781 GENERIC_CHANNEL_CALLBACK* callback = (GENERIC_CHANNEL_CALLBACK*)pChannelCallback;
1782 rdpsndPlugin* rdpsnd = nullptr;
1783
1784 WINPR_ASSERT(callback);
1785
1786 rdpsnd = (rdpsndPlugin*)callback->plugin;
1787 WINPR_ASSERT(rdpsnd);
1788
1789 rdpsnd->OnOpenCalled = FALSE;
1790 if (rdpsnd->device)
1791 IFCALL(rdpsnd->device->Close, rdpsnd->device);
1792
1793 cleanup_internals(rdpsnd);
1794
1795 free_internals(rdpsnd);
1796 if (rdpsnd->device)
1797 {
1798 IFCALL(rdpsnd->device->Free, rdpsnd->device);
1799 rdpsnd->device = nullptr;
1800 }
1801
1802 free(pChannelCallback);
1803 return CHANNEL_RC_OK;
1804}
1805
1806// NOLINTBEGIN(readability-non-const-parameter)
1807WINPR_ATTR_NODISCARD
1808static UINT rdpsnd_on_new_channel_connection(IWTSListenerCallback* pListenerCallback,
1809 IWTSVirtualChannel* pChannel, BYTE* Data,
1810 BOOL* pbAccept,
1811 IWTSVirtualChannelCallback** ppCallback)
1812// NOLINTEND(readability-non-const-parameter)
1813{
1814 GENERIC_CHANNEL_CALLBACK* callback = nullptr;
1815 GENERIC_LISTENER_CALLBACK* listener_callback = (GENERIC_LISTENER_CALLBACK*)pListenerCallback;
1816 WINPR_ASSERT(listener_callback);
1817 WINPR_ASSERT(pChannel);
1818 WINPR_ASSERT(ppCallback);
1819 callback = (GENERIC_CHANNEL_CALLBACK*)calloc(1, sizeof(GENERIC_CHANNEL_CALLBACK));
1820
1821 WINPR_UNUSED(Data);
1822 WINPR_UNUSED(pbAccept);
1823
1824 if (!callback)
1825 {
1826 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1827 return CHANNEL_RC_NO_MEMORY;
1828 }
1829
1830 callback->iface.OnOpen = rdpsnd_on_open;
1831 callback->iface.OnDataReceived = rdpsnd_on_data_received;
1832 callback->iface.OnClose = rdpsnd_on_close;
1833 callback->plugin = listener_callback->plugin;
1834 callback->channel_mgr = listener_callback->channel_mgr;
1835 callback->channel = pChannel;
1836 listener_callback->channel_callback = callback;
1837 *ppCallback = &callback->iface;
1838 return CHANNEL_RC_OK;
1839}
1840
1841WINPR_ATTR_NODISCARD
1842static UINT rdpsnd_plugin_initialize(IWTSPlugin* pPlugin, IWTSVirtualChannelManager* pChannelMgr)
1843{
1844 UINT status = 0;
1845 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)pPlugin;
1846 WINPR_ASSERT(rdpsnd);
1847 WINPR_ASSERT(pChannelMgr);
1848 if (rdpsnd->initialized)
1849 {
1850 WLog_ERR(TAG, "[%s] channel initialized twice, aborting", RDPSND_DVC_CHANNEL_NAME);
1851 return ERROR_INVALID_DATA;
1852 }
1853 rdpsnd->listener_callback =
1854 (GENERIC_LISTENER_CALLBACK*)calloc(1, sizeof(GENERIC_LISTENER_CALLBACK));
1855
1856 if (!rdpsnd->listener_callback)
1857 {
1858 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1859 return CHANNEL_RC_NO_MEMORY;
1860 }
1861
1862 rdpsnd->listener_callback->iface.OnNewChannelConnection = rdpsnd_on_new_channel_connection;
1863 rdpsnd->listener_callback->plugin = pPlugin;
1864 rdpsnd->listener_callback->channel_mgr = pChannelMgr;
1865 status = pChannelMgr->CreateListener(pChannelMgr, RDPSND_DVC_CHANNEL_NAME, 0,
1866 &rdpsnd->listener_callback->iface, &(rdpsnd->listener));
1867 if (status != CHANNEL_RC_OK)
1868 {
1869 WLog_ERR(TAG, "%s CreateListener failed!", rdpsnd_is_dyn_str(TRUE));
1870 return status;
1871 }
1872
1873 rdpsnd->listener->pInterface = rdpsnd->iface.pInterface;
1874 status = rdpsnd_virtual_channel_event_initialized(rdpsnd);
1875
1876 rdpsnd->initialized = status == CHANNEL_RC_OK;
1877 return status;
1878}
1879
1885WINPR_ATTR_NODISCARD
1886static UINT rdpsnd_plugin_terminated(IWTSPlugin* pPlugin)
1887{
1888 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)pPlugin;
1889 if (rdpsnd)
1890 {
1891 if (rdpsnd->listener_callback)
1892 {
1893 IWTSVirtualChannelManager* mgr = rdpsnd->listener_callback->channel_mgr;
1894 if (mgr)
1895 IFCALL(mgr->DestroyListener, mgr, rdpsnd->listener);
1896 }
1897 free(rdpsnd->listener_callback);
1898 free(rdpsnd->iface.pInterface);
1899 }
1900 rdpsnd_virtual_channel_event_terminated(rdpsnd);
1901 return CHANNEL_RC_OK;
1902}
1903
1909FREERDP_ENTRY_POINT(UINT VCAPITYPE rdpsnd_DVCPluginEntry(IDRDYNVC_ENTRY_POINTS* pEntryPoints))
1910{
1911 UINT error = CHANNEL_RC_OK;
1912
1913 WINPR_ASSERT(pEntryPoints);
1914 WINPR_ASSERT(pEntryPoints->GetPlugin);
1915
1916 rdpsndPlugin* rdpsnd =
1917 (rdpsndPlugin*)pEntryPoints->GetPlugin(pEntryPoints, RDPSND_CHANNEL_NAME);
1918
1919 if (!rdpsnd)
1920 {
1921 IWTSPlugin* iface = nullptr;
1922 union
1923 {
1924 const void* cev;
1925 void* ev;
1926 } cnv;
1927
1928 rdpsnd = allocatePlugin();
1929 if (!rdpsnd)
1930 {
1931 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1932 return CHANNEL_RC_NO_MEMORY;
1933 }
1934
1935 iface = &rdpsnd->iface;
1936 iface->Initialize = rdpsnd_plugin_initialize;
1937 iface->Connected = nullptr;
1938 iface->Disconnected = nullptr;
1939 iface->Terminated = rdpsnd_plugin_terminated;
1940
1941 rdpsnd->dynamic = TRUE;
1942
1943 WINPR_ASSERT(pEntryPoints->GetRdpContext);
1944 rdpsnd->rdpcontext = pEntryPoints->GetRdpContext(pEntryPoints);
1945
1946 if (!freerdp_settings_get_bool(rdpsnd->rdpcontext->settings,
1947 FreeRDP_SynchronousDynamicChannels))
1948 rdpsnd->async = TRUE;
1949
1950 /* user data pointer is not const, cast to avoid warning. */
1951 cnv.cev = pEntryPoints->GetPluginData(pEntryPoints);
1952 WINPR_ASSERT(pEntryPoints->GetPluginData);
1953 rdpsnd->channelEntryPoints.pExtendedData = cnv.ev;
1954
1955 error = pEntryPoints->RegisterPlugin(pEntryPoints, RDPSND_CHANNEL_NAME, iface);
1956 }
1957 else
1958 {
1959 WLog_ERR(TAG, "%s could not get rdpsnd Plugin.", rdpsnd_is_dyn_str(TRUE));
1960 return CHANNEL_RC_BAD_CHANNEL;
1961 }
1962
1963 return error;
1964}
freerdp_settings_get_bool
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
ADDIN_ARGV
Definition settings_types.h:390
AUDIO_FORMAT
Definition audio.h:35
CHANNEL_DEF
Definition wtsapi.h:78
CHANNEL_ENTRY_POINTS_FREERDP_EX
Definition svc.h:60
COMMAND_LINE_ARGUMENT_A
Definition winpr/include/winpr/cmdline.h:100
FREERDP_RDPSND_DEVICE_ENTRY_POINTS
Definition client/rdpsnd.h:76
GENERIC_CHANNEL_CALLBACK
Definition include/freerdp/client/channels.h:35
GENERIC_LISTENER_CALLBACK
Definition include/freerdp/client/channels.h:43
RTL_CRITICAL_SECTION
Definition include/winpr/synch.h:160
wObject
This struct contains function pointer to initialize/free objects.
Definition collections.h:52
wObject::fnObjectFree
OBJECT_FREE_FN fnObjectFree
Definition collections.h:59