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