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 BOOL connected;
121};
122
123WINPR_ATTR_NODISCARD
124static DWORD WINAPI play_thread(LPVOID arg);
125
126WINPR_ATTR_NODISCARD
127static const char* rdpsnd_is_dyn_str(BOOL dynamic)
128{
129 if (dynamic)
130 return "[dynamic]";
131 return "[static]";
132}
133
134static void rdpsnd_virtual_channel_event_terminated(rdpsndPlugin* rdpsnd);
135
141WINPR_ATTR_NODISCARD
142static UINT rdpsnd_virtual_channel_write(rdpsndPlugin* rdpsnd, wStream* s);
143
149WINPR_ATTR_NODISCARD
150static UINT rdpsnd_send_quality_mode_pdu(rdpsndPlugin* rdpsnd)
151{
152 wStream* pdu = nullptr;
153 WINPR_ASSERT(rdpsnd);
154 pdu = Stream_New(nullptr, 8);
155
156 if (!pdu)
157 {
158 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
159 return CHANNEL_RC_NO_MEMORY;
160 }
161
162 Stream_Write_UINT8(pdu, SNDC_QUALITYMODE); /* msgType */
163 Stream_Write_UINT8(pdu, 0); /* bPad */
164 Stream_Write_UINT16(pdu, 4); /* BodySize */
165 Stream_Write_UINT16(pdu, rdpsnd->wQualityMode); /* wQualityMode */
166 Stream_Write_UINT16(pdu, 0); /* Reserved */
167 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s QualityMode: %" PRIu16 "",
168 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->wQualityMode);
169 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
170}
171
172static void rdpsnd_select_supported_audio_formats(rdpsndPlugin* rdpsnd)
173{
174 WINPR_ASSERT(rdpsnd);
175 audio_formats_free(rdpsnd->ClientFormats, rdpsnd->NumberOfClientFormats);
176 rdpsnd->NumberOfClientFormats = 0;
177 rdpsnd->ClientFormats = nullptr;
178
179 if (!rdpsnd->NumberOfServerFormats)
180 return;
181
182 rdpsnd->ClientFormats = audio_formats_new(rdpsnd->NumberOfServerFormats);
183
184 if (!rdpsnd->ClientFormats || !rdpsnd->device)
185 return;
186
187 for (UINT16 index = 0; index < rdpsnd->NumberOfServerFormats; index++)
188 {
189 const AUDIO_FORMAT* serverFormat = &rdpsnd->ServerFormats[index];
190
191 if (!audio_format_compatible(rdpsnd->fixed_format, serverFormat))
192 continue;
193
194 WINPR_ASSERT(rdpsnd->device->FormatSupported);
195 if (freerdp_dsp_supports_format(serverFormat, FALSE) ||
196 rdpsnd->device->FormatSupported(rdpsnd->device, serverFormat))
197 {
198 AUDIO_FORMAT* clientFormat = &rdpsnd->ClientFormats[rdpsnd->NumberOfClientFormats++];
199 audio_format_copy(serverFormat, clientFormat);
200 }
201 }
202}
203
209WINPR_ATTR_NODISCARD
210static UINT rdpsnd_send_client_audio_formats(rdpsndPlugin* rdpsnd)
211{
212 wStream* pdu = nullptr;
213 size_t length = 0;
214 UINT32 dwVolume = 0;
215 UINT16 wNumberOfFormats = 0;
216 WINPR_ASSERT(rdpsnd);
217
218 if (!rdpsnd->device || (!rdpsnd->dynamic && (rdpsnd->OpenHandle == 0)))
219 return CHANNEL_RC_INITIALIZATION_ERROR;
220
221 dwVolume = IFCALLRESULT(0, rdpsnd->device->GetVolume, rdpsnd->device);
222 wNumberOfFormats = rdpsnd->NumberOfClientFormats;
223 length = 4 + 20;
224
225 for (UINT16 index = 0; index < wNumberOfFormats; index++)
226 length += (18 + rdpsnd->ClientFormats[index].cbSize);
227
228 /* BodySize is a UINT16 field, so the whole PDU must fit in UINT16_MAX. A server can inflate
229 * the client format list through large per-format cbSize values; without this bound the
230 * accumulator wrapped and Stream_New() below was undersized. Mirrors the server side check in
231 * rdpsnd_server_send_formats(). */
232 if (length > UINT16_MAX)
233 return ERROR_INVALID_DATA;
234
235 pdu = Stream_New(nullptr, length);
236
237 if (!pdu)
238 {
239 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
240 return CHANNEL_RC_NO_MEMORY;
241 }
242
243 Stream_Write_UINT8(pdu, SNDC_FORMATS); /* msgType */
244 Stream_Write_UINT8(pdu, 0); /* bPad */
245 Stream_Write_UINT16(pdu, (UINT16)(length - 4)); /* BodySize */
246 Stream_Write_UINT32(pdu, TSSNDCAPS_ALIVE | TSSNDCAPS_VOLUME); /* dwFlags */
247 Stream_Write_UINT32(pdu, dwVolume); /* dwVolume */
248 Stream_Write_UINT32(pdu, 0); /* dwPitch */
249 Stream_Write_UINT16(pdu, 0); /* wDGramPort */
250 Stream_Write_UINT16(pdu, wNumberOfFormats); /* wNumberOfFormats */
251 Stream_Write_UINT8(pdu, 0); /* cLastBlockConfirmed */
252 Stream_Write_UINT16(pdu, CHANNEL_VERSION_WIN_MAX); /* wVersion */
253 Stream_Write_UINT8(pdu, 0); /* bPad */
254
255 for (UINT16 index = 0; index < wNumberOfFormats; index++)
256 {
257 const AUDIO_FORMAT* clientFormat = &rdpsnd->ClientFormats[index];
258
259 if (!audio_format_write(pdu, clientFormat))
260 {
261 Stream_Free(pdu, TRUE);
262 return ERROR_INTERNAL_ERROR;
263 }
264 }
265
266 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Client Audio Formats",
267 rdpsnd_is_dyn_str(rdpsnd->dynamic));
268 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
269}
270
276WINPR_ATTR_NODISCARD
277static UINT rdpsnd_recv_server_audio_formats_pdu(rdpsndPlugin* rdpsnd, wStream* s)
278{
279 UINT16 wNumberOfFormats = 0;
280 UINT ret = ERROR_BAD_LENGTH;
281
282 WINPR_ASSERT(rdpsnd);
283 audio_formats_free(rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
284 rdpsnd->NumberOfServerFormats = 0;
285 rdpsnd->ServerFormats = nullptr;
286
287 if (!Stream_CheckAndLogRequiredLength(TAG, s, 30))
288 return ERROR_BAD_LENGTH;
289
290 /* http://msdn.microsoft.com/en-us/library/cc240956.aspx */
291 Stream_Seek_UINT32(s); /* dwFlags */
292 Stream_Seek_UINT32(s); /* dwVolume */
293 Stream_Seek_UINT32(s); /* dwPitch */
294 Stream_Seek_UINT16(s); /* wDGramPort */
295 Stream_Read_UINT16(s, wNumberOfFormats);
296 Stream_Read_UINT8(s, rdpsnd->cBlockNo); /* cLastBlockConfirmed */
297 Stream_Read_UINT16(s, rdpsnd->wVersion); /* wVersion */
298 Stream_Seek_UINT8(s); /* bPad */
299 rdpsnd->NumberOfServerFormats = wNumberOfFormats;
300
301 if (!Stream_CheckAndLogRequiredLengthOfSize(TAG, s, wNumberOfFormats, 14ull))
302 return ERROR_BAD_LENGTH;
303
304 if (rdpsnd->NumberOfServerFormats > 0)
305 {
306 rdpsnd->ServerFormats = audio_formats_new(wNumberOfFormats);
307
308 if (!rdpsnd->ServerFormats)
309 return CHANNEL_RC_NO_MEMORY;
310
311 for (UINT16 index = 0; index < wNumberOfFormats; index++)
312 {
313 AUDIO_FORMAT* format = &rdpsnd->ServerFormats[index];
314
315 if (!audio_format_read(s, format))
316 goto out_fail;
317 }
318 }
319
320 WINPR_ASSERT(rdpsnd->device);
321 ret = IFCALLRESULT(CHANNEL_RC_OK, rdpsnd->device->ServerFormatAnnounce, rdpsnd->device,
322 rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
323 if (ret != CHANNEL_RC_OK)
324 goto out_fail;
325
326 rdpsnd_select_supported_audio_formats(rdpsnd);
327 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Server Audio Formats",
328 rdpsnd_is_dyn_str(rdpsnd->dynamic));
329 ret = rdpsnd_send_client_audio_formats(rdpsnd);
330
331 if (ret == CHANNEL_RC_OK)
332 {
333 if (rdpsnd->wVersion >= CHANNEL_VERSION_WIN_7)
334 ret = rdpsnd_send_quality_mode_pdu(rdpsnd);
335 }
336
337 return ret;
338out_fail:
339 audio_formats_free(rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
340 rdpsnd->ServerFormats = nullptr;
341 rdpsnd->NumberOfServerFormats = 0;
342 return ret;
343}
344
350WINPR_ATTR_NODISCARD
351static UINT rdpsnd_send_training_confirm_pdu(rdpsndPlugin* rdpsnd, UINT16 wTimeStamp,
352 UINT16 wPackSize)
353{
354 wStream* pdu = nullptr;
355 WINPR_ASSERT(rdpsnd);
356 pdu = Stream_New(nullptr, 8);
357
358 if (!pdu)
359 {
360 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
361 return CHANNEL_RC_NO_MEMORY;
362 }
363
364 Stream_Write_UINT8(pdu, SNDC_TRAINING); /* msgType */
365 Stream_Write_UINT8(pdu, 0); /* bPad */
366 Stream_Write_UINT16(pdu, 4); /* BodySize */
367 Stream_Write_UINT16(pdu, wTimeStamp);
368 Stream_Write_UINT16(pdu, wPackSize);
369 WLog_Print(rdpsnd->log, WLOG_DEBUG,
370 "%s Training Response: wTimeStamp: %" PRIu16 " wPackSize: %" PRIu16 "",
371 rdpsnd_is_dyn_str(rdpsnd->dynamic), wTimeStamp, wPackSize);
372 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
373}
374
380WINPR_ATTR_NODISCARD
381static UINT rdpsnd_recv_training_pdu(rdpsndPlugin* rdpsnd, wStream* s)
382{
383 UINT16 wTimeStamp = 0;
384 UINT16 wPackSize = 0;
385 WINPR_ASSERT(rdpsnd);
386 WINPR_ASSERT(s);
387
388 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
389 return ERROR_BAD_LENGTH;
390
391 Stream_Read_UINT16(s, wTimeStamp);
392 Stream_Read_UINT16(s, wPackSize);
393 WLog_Print(rdpsnd->log, WLOG_DEBUG,
394 "%s Training Request: wTimeStamp: %" PRIu16 " wPackSize: %" PRIu16 "",
395 rdpsnd_is_dyn_str(rdpsnd->dynamic), wTimeStamp, wPackSize);
396 return rdpsnd_send_training_confirm_pdu(rdpsnd, wTimeStamp, wPackSize);
397}
398
399WINPR_ATTR_NODISCARD
400static BOOL rdpsnd_apply_volume(rdpsndPlugin* rdpsnd)
401{
402 WINPR_ASSERT(rdpsnd);
403
404 if (rdpsnd->isOpen && rdpsnd->applyVolume && rdpsnd->device)
405 {
406 BOOL rc = IFCALLRESULT(TRUE, rdpsnd->device->SetVolume, rdpsnd->device, rdpsnd->volume);
407 if (!rc)
408 return FALSE;
409 rdpsnd->applyVolume = FALSE;
410 }
411 return TRUE;
412}
413
414WINPR_ATTR_NODISCARD
415static BOOL rdpsnd_ensure_device_is_open(rdpsndPlugin* rdpsnd, UINT16 wFormatNo,
416 const AUDIO_FORMAT* format)
417{
418 if (!rdpsnd)
419 return FALSE;
420 WINPR_ASSERT(format);
421
422 if (!rdpsnd->isOpen || (wFormatNo != rdpsnd->wCurrentFormatNo))
423 {
424 BOOL rc = 0;
425 BOOL supported = 0;
426 AUDIO_FORMAT deviceFormat = *format;
427
428 IFCALL(rdpsnd->device->Close, rdpsnd->device);
429 supported = IFCALLRESULT(FALSE, rdpsnd->device->FormatSupported, rdpsnd->device, format);
430
431 if (!supported)
432 {
433 if (!IFCALLRESULT(FALSE, rdpsnd->device->DefaultFormat, rdpsnd->device, format,
434 &deviceFormat))
435 {
436 deviceFormat.wFormatTag = WAVE_FORMAT_PCM;
437 deviceFormat.wBitsPerSample = 16;
438 deviceFormat.cbSize = 0;
439 }
440 }
441
442 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Opening device with format %s [backend %s]",
443 rdpsnd_is_dyn_str(rdpsnd->dynamic),
444 audio_format_get_tag_string(format->wFormatTag),
445 audio_format_get_tag_string(deviceFormat.wFormatTag));
446 rc = IFCALLRESULT(FALSE, rdpsnd->device->Open, rdpsnd->device, &deviceFormat,
447 rdpsnd->latency);
448
449 if (!rc)
450 return FALSE;
451
452 if (!supported)
453 {
454 if (!freerdp_dsp_context_reset(rdpsnd->dsp_context, format, 0u))
455 return FALSE;
456 }
457
458 rdpsnd->isOpen = TRUE;
459 rdpsnd->wCurrentFormatNo = wFormatNo;
460 rdpsnd->startPlayTime = 0;
461 rdpsnd->totalPlaySize = 0;
462 }
463
464 return rdpsnd_apply_volume(rdpsnd);
465}
466
472WINPR_ATTR_NODISCARD
473static UINT rdpsnd_recv_wave_info_pdu(rdpsndPlugin* rdpsnd, wStream* s, UINT16 BodySize)
474{
475 UINT16 wFormatNo = 0;
476 const AUDIO_FORMAT* format = nullptr;
477 WINPR_ASSERT(rdpsnd);
478 WINPR_ASSERT(s);
479
480 if (!Stream_CheckAndLogRequiredLength(TAG, s, 12) || (BodySize < 8))
481 return ERROR_BAD_LENGTH;
482
483 rdpsnd->wArrivalTime = GetTickCount64();
484 Stream_Read_UINT16(s, rdpsnd->wTimeStamp);
485 Stream_Read_UINT16(s, wFormatNo);
486
487 if (wFormatNo >= rdpsnd->NumberOfClientFormats)
488 return ERROR_INVALID_DATA;
489
490 Stream_Read_UINT8(s, rdpsnd->cBlockNo);
491 Stream_Seek(s, 3); /* bPad */
492 Stream_Read(s, rdpsnd->waveData, 4);
493 rdpsnd->waveDataSize = BodySize - 8;
494 format = &rdpsnd->ClientFormats[wFormatNo];
495 WLog_Print(rdpsnd->log, WLOG_DEBUG,
496 "%s WaveInfo: cBlockNo: %" PRIu8 " wFormatNo: %" PRIu16 " [%s]",
497 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, wFormatNo,
498 audio_format_get_tag_string(format->wFormatTag));
499
500 if (!rdpsnd_ensure_device_is_open(rdpsnd, wFormatNo, format))
501 return ERROR_INTERNAL_ERROR;
502
503 rdpsnd->expectingWave = TRUE;
504 return CHANNEL_RC_OK;
505}
506
512WINPR_ATTR_NODISCARD
513static UINT rdpsnd_send_wave_confirm_pdu(rdpsndPlugin* rdpsnd, UINT16 wTimeStamp,
514 BYTE cConfirmedBlockNo)
515{
516 wStream* pdu = nullptr;
517 WINPR_ASSERT(rdpsnd);
518 pdu = Stream_New(nullptr, 8);
519
520 if (!pdu)
521 {
522 WLog_ERR(TAG, "%s Stream_New failed!", rdpsnd_is_dyn_str(rdpsnd->dynamic));
523 return CHANNEL_RC_NO_MEMORY;
524 }
525
526 Stream_Write_UINT8(pdu, SNDC_WAVECONFIRM);
527 Stream_Write_UINT8(pdu, 0);
528 Stream_Write_UINT16(pdu, 4);
529 Stream_Write_UINT16(pdu, wTimeStamp);
530 Stream_Write_UINT8(pdu, cConfirmedBlockNo); /* cConfirmedBlockNo */
531 Stream_Write_UINT8(pdu, 0); /* bPad */
532 return rdpsnd_virtual_channel_write(rdpsnd, pdu);
533}
534
535WINPR_ATTR_NODISCARD
536static BOOL rdpsnd_detect_overrun(rdpsndPlugin* rdpsnd, const AUDIO_FORMAT* format, size_t size)
537{
538 UINT32 bpf = 0;
539 UINT32 now = 0;
540 UINT32 duration = 0;
541 UINT32 totalDuration = 0;
542 UINT32 remainingDuration = 0;
543 UINT32 maxDuration = 0;
544
545 if (!rdpsnd || !format)
546 return FALSE;
547
548 /* Older windows RDP servers do not limit the send buffer, which can
549 * cause quite a large amount of sound data buffered client side.
550 * If e.g. sound is paused server side the client will keep playing
551 * for a long time instead of pausing playback.
552 *
553 * To avoid this we check:
554 *
555 * 1. Is the sound sample received from a known format these servers
556 * support
557 * 2. If it is calculate the size of the client side sound buffer
558 * 3. If the buffer is too large silently drop the sample which will
559 * trigger a retransmit later on.
560 *
561 * This check must only be applied to these known formats, because
562 * with newer and other formats the sample size can not be calculated
563 * without decompressing the sample first.
564 */
565 switch (format->wFormatTag)
566 {
567 case WAVE_FORMAT_PCM:
568 case WAVE_FORMAT_DVI_ADPCM:
569 case WAVE_FORMAT_ADPCM:
570 case WAVE_FORMAT_ALAW:
571 case WAVE_FORMAT_MULAW:
572 break;
573 case WAVE_FORMAT_MSG723:
574 case WAVE_FORMAT_GSM610:
575 case WAVE_FORMAT_AAC_MS:
576 default:
577 return FALSE;
578 }
579
580 audio_format_print(WLog_Get(TAG), WLOG_DEBUG, format);
581 bpf = format->nChannels * format->wBitsPerSample * format->nSamplesPerSec / 8;
582 if (bpf == 0)
583 return FALSE;
584
585 duration = (UINT32)(1000 * size / bpf);
586 totalDuration = (UINT32)(1000 * rdpsnd->totalPlaySize / bpf);
587 now = GetTickCountPrecise();
588 if (rdpsnd->startPlayTime == 0)
589 {
590 rdpsnd->startPlayTime = now;
591 rdpsnd->totalPlaySize = size;
592 return FALSE;
593 }
594 else if (now - rdpsnd->startPlayTime > totalDuration + 10)
595 {
596 /* Buffer underrun */
597 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Buffer underrun by %u ms",
598 rdpsnd_is_dyn_str(rdpsnd->dynamic),
599 (UINT)(now - rdpsnd->startPlayTime - totalDuration));
600 rdpsnd->startPlayTime = now;
601 rdpsnd->totalPlaySize = size;
602 return FALSE;
603 }
604 else
605 {
606 /* Calculate remaining duration to be played */
607 remainingDuration = totalDuration - (now - rdpsnd->startPlayTime);
608
609 /* Maximum allow duration calculation */
610 maxDuration = duration * 2 + rdpsnd->latency;
611
612 if (remainingDuration + duration > maxDuration)
613 {
614 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Buffer overrun pending %u ms dropping %u ms",
615 rdpsnd_is_dyn_str(rdpsnd->dynamic), remainingDuration, duration);
616 return TRUE;
617 }
618
619 rdpsnd->totalPlaySize += size;
620 return FALSE;
621 }
622}
623
624WINPR_ATTR_NODISCARD
625static UINT rdpsnd_treat_wave(rdpsndPlugin* rdpsnd, wStream* s, size_t size)
626{
627 AUDIO_FORMAT* format = nullptr;
628 UINT64 end = 0;
629 UINT64 diffMS = 0;
630 UINT64 ts = 0;
631 UINT latency = 0;
632 UINT error = 0;
633
634 if (!Stream_CheckAndLogRequiredLength(TAG, s, size))
635 return ERROR_BAD_LENGTH;
636
637 if (rdpsnd->wCurrentFormatNo >= rdpsnd->NumberOfClientFormats)
638 return ERROR_INTERNAL_ERROR;
639
640 /*
641 * Send the first WaveConfirm PDU. The server side uses this to determine the
642 * network latency.
643 * See also [MS-RDPEA] 2.2.3.8 Wave Confirm PDU
644 */
645 error = rdpsnd_send_wave_confirm_pdu(rdpsnd, rdpsnd->wTimeStamp, rdpsnd->cBlockNo);
646 if (error)
647 return error;
648
649 const BYTE* data = Stream_ConstPointer(s);
650 format = &rdpsnd->ClientFormats[rdpsnd->wCurrentFormatNo];
651 WLog_Print(rdpsnd->log, WLOG_DEBUG,
652 "%s Wave: cBlockNo: %" PRIu8 " wTimeStamp: %" PRIu16 ", size: %" PRIuz,
653 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, rdpsnd->wTimeStamp, size);
654
655 if (rdpsnd->device && rdpsnd->attached && !rdpsnd_detect_overrun(rdpsnd, format, size))
656 {
657 UINT status = CHANNEL_RC_OK;
658 wStream* pcmData = StreamPool_Take(rdpsnd->pool, 4096);
659
660 if (rdpsnd->device->FormatSupported(rdpsnd->device, format))
661 {
662 if (rdpsnd->device->PlayEx)
663 latency = rdpsnd->device->PlayEx(rdpsnd->device, format, data, size);
664 else
665 latency = IFCALLRESULT(0, rdpsnd->device->Play, rdpsnd->device, data, size);
666 }
667 else if (freerdp_dsp_decode(rdpsnd->dsp_context, format, data, size, pcmData))
668 {
669 Stream_SealLength(pcmData);
670
671 if (rdpsnd->device->PlayEx)
672 latency = rdpsnd->device->PlayEx(rdpsnd->device, format, Stream_Buffer(pcmData),
673 Stream_Length(pcmData));
674 else
675 latency = IFCALLRESULT(0, rdpsnd->device->Play, rdpsnd->device,
676 Stream_Buffer(pcmData), Stream_Length(pcmData));
677 }
678 else
679 status = ERROR_INTERNAL_ERROR;
680
681 Stream_Release(pcmData);
682
683 if (status != CHANNEL_RC_OK)
684 return status;
685 }
686
687 end = GetTickCount64();
688 diffMS = end - rdpsnd->wArrivalTime + latency;
689 ts = (rdpsnd->wTimeStamp + diffMS) % UINT16_MAX;
690
691 /*
692 * Send the second WaveConfirm PDU. With the first WaveConfirm PDU,
693 * the server side uses this second WaveConfirm PDU to determine the actual
694 * render latency.
695 */
696 return rdpsnd_send_wave_confirm_pdu(rdpsnd, (UINT16)ts, rdpsnd->cBlockNo);
697}
698
704WINPR_ATTR_NODISCARD
705static UINT rdpsnd_recv_wave_pdu(rdpsndPlugin* rdpsnd, wStream* s)
706{
707 rdpsnd->expectingWave = FALSE;
708
715 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
716 return ERROR_INVALID_DATA;
717
718 CopyMemory(Stream_Buffer(s), rdpsnd->waveData, 4);
719 return rdpsnd_treat_wave(rdpsnd, s, rdpsnd->waveDataSize);
720}
721
722WINPR_ATTR_NODISCARD
723static UINT rdpsnd_recv_wave2_pdu(rdpsndPlugin* rdpsnd, wStream* s, UINT16 BodySize)
724{
725 UINT16 wFormatNo = 0;
726 AUDIO_FORMAT* format = nullptr;
727 UINT32 dwAudioTimeStamp = 0;
728
729 if (!Stream_CheckAndLogRequiredLength(TAG, s, 12) || (BodySize < 12))
730 return ERROR_BAD_LENGTH;
731
732 Stream_Read_UINT16(s, rdpsnd->wTimeStamp);
733 Stream_Read_UINT16(s, wFormatNo);
734 Stream_Read_UINT8(s, rdpsnd->cBlockNo);
735 Stream_Seek(s, 3); /* bPad */
736 Stream_Read_UINT32(s, dwAudioTimeStamp);
737 if (wFormatNo >= rdpsnd->NumberOfClientFormats)
738 return ERROR_INVALID_DATA;
739 format = &rdpsnd->ClientFormats[wFormatNo];
740 rdpsnd->waveDataSize = BodySize - 12;
741 rdpsnd->wArrivalTime = GetTickCount64();
742 WLog_Print(rdpsnd->log, WLOG_DEBUG,
743 "%s Wave2PDU: cBlockNo: %" PRIu8 " wFormatNo: %" PRIu16
744 " [%s] , align=%hu wTimeStamp=0x%04" PRIx16 ", dwAudioTimeStamp=0x%08" PRIx32,
745 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, wFormatNo,
746 audio_format_get_tag_string(format->wFormatTag), format->nBlockAlign,
747 rdpsnd->wTimeStamp, dwAudioTimeStamp);
748
749 if (!rdpsnd_ensure_device_is_open(rdpsnd, wFormatNo, format))
750 return ERROR_INTERNAL_ERROR;
751
752 return rdpsnd_treat_wave(rdpsnd, s, rdpsnd->waveDataSize);
753}
754
755static void rdpsnd_recv_close_pdu(rdpsndPlugin* rdpsnd)
756{
757 if (rdpsnd->isOpen)
758 {
759 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Closing device",
760 rdpsnd_is_dyn_str(rdpsnd->dynamic));
761 }
762 else
763 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Device already closed",
764 rdpsnd_is_dyn_str(rdpsnd->dynamic));
765}
766
772WINPR_ATTR_NODISCARD
773static UINT rdpsnd_recv_volume_pdu(rdpsndPlugin* rdpsnd, wStream* s)
774{
775 BOOL rc = TRUE;
776 UINT32 dwVolume = 0;
777
778 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
779 return ERROR_BAD_LENGTH;
780
781 Stream_Read_UINT32(s, dwVolume);
782 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Volume: 0x%08" PRIX32 "",
783 rdpsnd_is_dyn_str(rdpsnd->dynamic), dwVolume);
784
785 rdpsnd->volume = dwVolume;
786 rdpsnd->applyVolume = TRUE;
787 rc = rdpsnd_apply_volume(rdpsnd);
788
789 if (!rc)
790 {
791 WLog_ERR(TAG, "%s error setting volume", rdpsnd_is_dyn_str(rdpsnd->dynamic));
792 return CHANNEL_RC_INITIALIZATION_ERROR;
793 }
794
795 return CHANNEL_RC_OK;
796}
797
803WINPR_ATTR_NODISCARD
804static UINT rdpsnd_recv_pdu(rdpsndPlugin* rdpsnd, wStream* s)
805{
806 BYTE msgType = 0;
807 UINT16 BodySize = 0;
808 UINT status = CHANNEL_RC_OK;
809
810 if (rdpsnd->expectingWave)
811 {
812 status = rdpsnd_recv_wave_pdu(rdpsnd, s);
813 goto out;
814 }
815
816 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
817 {
818 status = ERROR_BAD_LENGTH;
819 goto out;
820 }
821
822 Stream_Read_UINT8(s, msgType); /* msgType */
823 Stream_Seek_UINT8(s); /* bPad */
824 Stream_Read_UINT16(s, BodySize);
825
826 switch (msgType)
827 {
828 case SNDC_FORMATS:
829 status = rdpsnd_recv_server_audio_formats_pdu(rdpsnd, s);
830 break;
831
832 case SNDC_TRAINING:
833 status = rdpsnd_recv_training_pdu(rdpsnd, s);
834 break;
835
836 case SNDC_WAVE:
837 status = rdpsnd_recv_wave_info_pdu(rdpsnd, s, BodySize);
838 break;
839
840 case SNDC_CLOSE:
841 rdpsnd_recv_close_pdu(rdpsnd);
842 break;
843
844 case SNDC_SETVOLUME:
845 status = rdpsnd_recv_volume_pdu(rdpsnd, s);
846 break;
847
848 case SNDC_WAVE2:
849 status = rdpsnd_recv_wave2_pdu(rdpsnd, s, BodySize);
850 break;
851
852 default:
853 WLog_ERR(TAG, "%s unknown msgType %" PRIu8 "", rdpsnd_is_dyn_str(rdpsnd->dynamic),
854 msgType);
855 break;
856 }
857
858out:
859 Stream_Release(s);
860 return status;
861}
862
863static void rdpsnd_register_device_plugin(rdpsndPlugin* rdpsnd, rdpsndDevicePlugin* device)
864{
865 if (rdpsnd->device)
866 {
867 WLog_ERR(TAG, "%s existing device, abort.", rdpsnd_is_dyn_str(FALSE));
868 return;
869 }
870
871 rdpsnd->device = device;
872 device->rdpsnd = rdpsnd;
873}
874
880WINPR_ATTR_NODISCARD
881static UINT rdpsnd_load_device_plugin(rdpsndPlugin* rdpsnd, const char* name,
882 const ADDIN_ARGV* args)
883{
884 FREERDP_RDPSND_DEVICE_ENTRY_POINTS entryPoints = WINPR_C_ARRAY_INIT;
885 UINT error = 0;
886 DWORD flags = FREERDP_ADDIN_CHANNEL_STATIC | FREERDP_ADDIN_CHANNEL_ENTRYEX;
887 if (rdpsnd->dynamic)
888 flags = FREERDP_ADDIN_CHANNEL_DYNAMIC;
889 PVIRTUALCHANNELENTRY pvce =
890 freerdp_load_channel_addin_entry(RDPSND_CHANNEL_NAME, name, nullptr, flags);
891 PFREERDP_RDPSND_DEVICE_ENTRY entry = WINPR_FUNC_PTR_CAST(pvce, PFREERDP_RDPSND_DEVICE_ENTRY);
892
893 if (!entry)
894 return ERROR_INTERNAL_ERROR;
895
896 entryPoints.rdpsnd = rdpsnd;
897 entryPoints.pRegisterRdpsndDevice = rdpsnd_register_device_plugin;
898 entryPoints.args = args;
899
900 error = entry(&entryPoints);
901 if (error)
902 WLog_WARN(TAG, "%s %s entry returns error %" PRIu32 "", rdpsnd_is_dyn_str(rdpsnd->dynamic),
903 name, error);
904 else
905 WLog_INFO(TAG, "%s Loaded %s backend for rdpsnd", rdpsnd_is_dyn_str(rdpsnd->dynamic), name);
906
907 return error;
908}
909
910WINPR_ATTR_NODISCARD
911static BOOL rdpsnd_set_subsystem(rdpsndPlugin* rdpsnd, const char* subsystem)
912{
913 free(rdpsnd->subsystem);
914 rdpsnd->subsystem = _strdup(subsystem);
915 return (rdpsnd->subsystem != nullptr);
916}
917
918WINPR_ATTR_NODISCARD
919static BOOL rdpsnd_set_device_name(rdpsndPlugin* rdpsnd, const char* device_name)
920{
921 free(rdpsnd->device_name);
922 rdpsnd->device_name = _strdup(device_name);
923 return (rdpsnd->device_name != nullptr);
924}
925
931WINPR_ATTR_NODISCARD
932static UINT rdpsnd_process_addin_args(rdpsndPlugin* rdpsnd, const ADDIN_ARGV* args)
933{
934 int status = 0;
935 DWORD flags = 0;
936 const COMMAND_LINE_ARGUMENT_A* arg = nullptr;
937 COMMAND_LINE_ARGUMENT_A rdpsnd_args[] = {
938 { "sys", COMMAND_LINE_VALUE_REQUIRED, "<subsystem>", nullptr, nullptr, -1, nullptr,
939 "subsystem" },
940 { "dev", COMMAND_LINE_VALUE_REQUIRED, "<device>", nullptr, nullptr, -1, nullptr, "device" },
941 { "format", COMMAND_LINE_VALUE_REQUIRED, "<format>", nullptr, nullptr, -1, nullptr,
942 "format" },
943 { "rate", COMMAND_LINE_VALUE_REQUIRED, "<rate>", nullptr, nullptr, -1, nullptr, "rate" },
944 { "channel", COMMAND_LINE_VALUE_REQUIRED, "<channel>", nullptr, nullptr, -1, nullptr,
945 "channel" },
946 { "latency", COMMAND_LINE_VALUE_REQUIRED, "<latency>", nullptr, nullptr, -1, nullptr,
947 "latency" },
948 { "quality", COMMAND_LINE_VALUE_REQUIRED, "<quality mode>", nullptr, nullptr, -1, nullptr,
949 "quality mode" },
950 { nullptr, 0, nullptr, nullptr, nullptr, -1, nullptr, nullptr }
951 };
952 rdpsnd->wQualityMode = HIGH_QUALITY; /* default quality mode */
953
954 if (args->argc > 1)
955 {
956 flags = COMMAND_LINE_SIGIL_NONE | COMMAND_LINE_SEPARATOR_COLON;
957 status = CommandLineParseArgumentsA(args->argc, args->argv, rdpsnd_args, flags, rdpsnd,
958 nullptr, nullptr);
959
960 if (status < 0)
961 return CHANNEL_RC_INITIALIZATION_ERROR;
962
963 arg = rdpsnd_args;
964 errno = 0;
965
966 do
967 {
968 if (!(arg->Flags & COMMAND_LINE_VALUE_PRESENT))
969 continue;
970
971 CommandLineSwitchStart(arg) CommandLineSwitchCase(arg, "sys")
972 {
973 if (!rdpsnd_set_subsystem(rdpsnd, arg->Value))
974 return CHANNEL_RC_NO_MEMORY;
975 }
976 CommandLineSwitchCase(arg, "dev")
977 {
978 if (!rdpsnd_set_device_name(rdpsnd, arg->Value))
979 return CHANNEL_RC_NO_MEMORY;
980 }
981 CommandLineSwitchCase(arg, "format")
982 {
983 unsigned long val = strtoul(arg->Value, nullptr, 0);
984
985 if ((errno != 0) || (val > UINT16_MAX))
986 return CHANNEL_RC_INITIALIZATION_ERROR;
987
988 rdpsnd->fixed_format->wFormatTag = (UINT16)val;
989 }
990 CommandLineSwitchCase(arg, "rate")
991 {
992 unsigned long val = strtoul(arg->Value, nullptr, 0);
993
994 if ((errno != 0) || (val > UINT32_MAX))
995 return CHANNEL_RC_INITIALIZATION_ERROR;
996
997 rdpsnd->fixed_format->nSamplesPerSec = (UINT32)val;
998 }
999 CommandLineSwitchCase(arg, "channel")
1000 {
1001 unsigned long val = strtoul(arg->Value, nullptr, 0);
1002
1003 if ((errno != 0) || (val > UINT16_MAX))
1004 return CHANNEL_RC_INITIALIZATION_ERROR;
1005
1006 rdpsnd->fixed_format->nChannels = (UINT16)val;
1007 }
1008 CommandLineSwitchCase(arg, "latency")
1009 {
1010 unsigned long val = strtoul(arg->Value, nullptr, 0);
1011
1012 if ((errno != 0) || (val > UINT32_MAX))
1013 return CHANNEL_RC_INITIALIZATION_ERROR;
1014
1015 rdpsnd->latency = (UINT32)val;
1016 }
1017 CommandLineSwitchCase(arg, "quality")
1018 {
1019 long wQualityMode = DYNAMIC_QUALITY;
1020
1021 if (_stricmp(arg->Value, "dynamic") == 0)
1022 wQualityMode = DYNAMIC_QUALITY;
1023 else if (_stricmp(arg->Value, "medium") == 0)
1024 wQualityMode = MEDIUM_QUALITY;
1025 else if (_stricmp(arg->Value, "high") == 0)
1026 wQualityMode = HIGH_QUALITY;
1027 else
1028 {
1029 wQualityMode = strtol(arg->Value, nullptr, 0);
1030
1031 if (errno != 0)
1032 return CHANNEL_RC_INITIALIZATION_ERROR;
1033 }
1034
1035 if ((wQualityMode < 0) || (wQualityMode > 2))
1036 wQualityMode = DYNAMIC_QUALITY;
1037
1038 rdpsnd->wQualityMode = (UINT16)wQualityMode;
1039 }
1040 CommandLineSwitchDefault(arg)
1041 {
1042 }
1043 CommandLineSwitchEnd(arg)
1044 } while ((arg = CommandLineFindNextArgumentA(arg)) != nullptr);
1045 }
1046
1047 return CHANNEL_RC_OK;
1048}
1049
1055WINPR_ATTR_NODISCARD
1056static UINT rdpsnd_process_connect(rdpsndPlugin* rdpsnd)
1057{
1058 const struct
1059 {
1060 const char* subsystem;
1061 const char* device;
1062 } backends[] = {
1063#if defined(WITH_IOSAUDIO)
1064 { "ios", "" },
1065#endif
1066#if defined(WITH_AAUDIO)
1067 { "aaudio", "" },
1068#endif
1069#if defined(WITH_OPENSLES)
1070 { "opensles", "" },
1071#endif
1072#if defined(WITH_PULSE)
1073 { "pulse", "" },
1074#endif
1075#if defined(WITH_ALSA)
1076 { "alsa", "default" },
1077#endif
1078#if defined(WITH_OSS)
1079 { "oss", "" },
1080#endif
1081#if defined(WITH_MACAUDIO)
1082 { "mac", "default" },
1083#endif
1084#if defined(WITH_WINMM)
1085 { "winmm", "" },
1086#endif
1087#if defined(WITH_SNDIO)
1088 { "sndio", "" },
1089#endif
1090 { "fake", "" }
1091 };
1092 const ADDIN_ARGV* args = nullptr;
1093 UINT status = ERROR_INTERNAL_ERROR;
1094 WINPR_ASSERT(rdpsnd);
1095 rdpsnd->latency = 0;
1096 args = (const ADDIN_ARGV*)rdpsnd->channelEntryPoints.pExtendedData;
1097
1098 if (args)
1099 {
1100 status = rdpsnd_process_addin_args(rdpsnd, args);
1101
1102 if (status != CHANNEL_RC_OK)
1103 return status;
1104 }
1105
1106 if (rdpsnd->subsystem)
1107 {
1108 if ((status = rdpsnd_load_device_plugin(rdpsnd, rdpsnd->subsystem, args)))
1109 {
1110 WLog_ERR(TAG,
1111 "%s Unable to load sound playback subsystem %s because of error %" PRIu32 "",
1112 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->subsystem, status);
1113 return status;
1114 }
1115 }
1116 else
1117 {
1118 for (size_t x = 0; x < ARRAYSIZE(backends); x++)
1119 {
1120 const char* subsystem_name = backends[x].subsystem;
1121 const char* device_name = backends[x].device;
1122
1123 if ((status = rdpsnd_load_device_plugin(rdpsnd, subsystem_name, args)))
1124 WLog_WARN(TAG,
1125 "%s Unable to load sound playback subsystem %s because of error %" PRIu32
1126 "",
1127 rdpsnd_is_dyn_str(rdpsnd->dynamic), subsystem_name, status);
1128
1129 if (!rdpsnd->device)
1130 continue;
1131
1132 if (!rdpsnd_set_subsystem(rdpsnd, subsystem_name) ||
1133 !rdpsnd_set_device_name(rdpsnd, device_name))
1134 return CHANNEL_RC_NO_MEMORY;
1135
1136 break;
1137 }
1138
1139 if (!rdpsnd->device || status)
1140 return CHANNEL_RC_INITIALIZATION_ERROR;
1141 }
1142
1143 return CHANNEL_RC_OK;
1144}
1145
1151UINT rdpsnd_virtual_channel_write(rdpsndPlugin* rdpsnd, wStream* s)
1152{
1153 UINT status = CHANNEL_RC_BAD_INIT_HANDLE;
1154
1155 if (rdpsnd)
1156 {
1157 if (rdpsnd->dynamic)
1158 {
1159 if (rdpsnd->listener_callback && rdpsnd->connected)
1160 {
1161 IWTSVirtualChannel* 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
1783 WINPR_ASSERT(callback);
1784
1785 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)callback->plugin;
1786 WINPR_ASSERT(rdpsnd);
1787
1788 rdpsnd->OnOpenCalled = FALSE;
1789 if (rdpsnd->device)
1790 IFCALL(rdpsnd->device->Close, rdpsnd->device);
1791
1792 cleanup_internals(rdpsnd);
1793
1794 free_internals(rdpsnd);
1795 if (rdpsnd->device)
1796 {
1797 IFCALL(rdpsnd->device->Free, rdpsnd->device);
1798 rdpsnd->device = nullptr;
1799 }
1800
1801 free(pChannelCallback);
1802 rdpsnd->connected = FALSE;
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_LISTENER_CALLBACK* listener_callback = (GENERIC_LISTENER_CALLBACK*)pListenerCallback;
1815 WINPR_ASSERT(listener_callback);
1816 WINPR_ASSERT(pChannel);
1817 WINPR_ASSERT(ppCallback);
1818
1819 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)listener_callback->plugin;
1820 WINPR_ASSERT(rdpsnd);
1821
1822 if (rdpsnd->connected)
1823 {
1824 WLog_Print(rdpsnd->log, WLOG_ERROR, "Channel already connected, terminating.");
1825 return ERROR_DEVICE_ALREADY_ATTACHED;
1826 }
1827
1828 GENERIC_CHANNEL_CALLBACK* callback =
1829 (GENERIC_CHANNEL_CALLBACK*)calloc(1, sizeof(GENERIC_CHANNEL_CALLBACK));
1830
1831 WINPR_UNUSED(Data);
1832 WINPR_UNUSED(pbAccept);
1833
1834 if (!callback)
1835 {
1836 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1837 return CHANNEL_RC_NO_MEMORY;
1838 }
1839
1840 callback->iface.OnOpen = rdpsnd_on_open;
1841 callback->iface.OnDataReceived = rdpsnd_on_data_received;
1842 callback->iface.OnClose = rdpsnd_on_close;
1843 callback->plugin = listener_callback->plugin;
1844 callback->channel_mgr = listener_callback->channel_mgr;
1845 callback->channel = pChannel;
1846 listener_callback->channel_callback = callback;
1847 *ppCallback = &callback->iface;
1848 rdpsnd->connected = TRUE;
1849 return CHANNEL_RC_OK;
1850}
1851
1852WINPR_ATTR_NODISCARD
1853static UINT rdpsnd_plugin_initialize(IWTSPlugin* pPlugin, IWTSVirtualChannelManager* pChannelMgr)
1854{
1855 UINT status = 0;
1856 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)pPlugin;
1857 WINPR_ASSERT(rdpsnd);
1858 WINPR_ASSERT(pChannelMgr);
1859 if (rdpsnd->initialized)
1860 {
1861 WLog_ERR(TAG, "[%s] channel initialized twice, aborting", RDPSND_DVC_CHANNEL_NAME);
1862 return ERROR_INVALID_DATA;
1863 }
1864 rdpsnd->listener_callback =
1865 (GENERIC_LISTENER_CALLBACK*)calloc(1, sizeof(GENERIC_LISTENER_CALLBACK));
1866
1867 if (!rdpsnd->listener_callback)
1868 {
1869 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1870 return CHANNEL_RC_NO_MEMORY;
1871 }
1872
1873 rdpsnd->listener_callback->iface.OnNewChannelConnection = rdpsnd_on_new_channel_connection;
1874 rdpsnd->listener_callback->plugin = pPlugin;
1875 rdpsnd->listener_callback->channel_mgr = pChannelMgr;
1876 status = pChannelMgr->CreateListener(pChannelMgr, RDPSND_DVC_CHANNEL_NAME, 0,
1877 &rdpsnd->listener_callback->iface, &(rdpsnd->listener));
1878 if (status != CHANNEL_RC_OK)
1879 {
1880 WLog_ERR(TAG, "%s CreateListener failed!", rdpsnd_is_dyn_str(TRUE));
1881 return status;
1882 }
1883
1884 rdpsnd->listener->pInterface = rdpsnd->iface.pInterface;
1885 status = rdpsnd_virtual_channel_event_initialized(rdpsnd);
1886
1887 rdpsnd->initialized = status == CHANNEL_RC_OK;
1888 return status;
1889}
1890
1896WINPR_ATTR_NODISCARD
1897static UINT rdpsnd_plugin_terminated(IWTSPlugin* pPlugin)
1898{
1899 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)pPlugin;
1900 if (rdpsnd)
1901 {
1902 if (rdpsnd->listener_callback)
1903 {
1904 IWTSVirtualChannelManager* mgr = rdpsnd->listener_callback->channel_mgr;
1905 if (mgr)
1906 IFCALL(mgr->DestroyListener, mgr, rdpsnd->listener);
1907 }
1908 free(rdpsnd->listener_callback);
1909 free(rdpsnd->iface.pInterface);
1910 }
1911 rdpsnd_virtual_channel_event_terminated(rdpsnd);
1912 return CHANNEL_RC_OK;
1913}
1914
1920FREERDP_ENTRY_POINT(UINT VCAPITYPE rdpsnd_DVCPluginEntry(IDRDYNVC_ENTRY_POINTS* pEntryPoints))
1921{
1922 UINT error = CHANNEL_RC_OK;
1923
1924 WINPR_ASSERT(pEntryPoints);
1925 WINPR_ASSERT(pEntryPoints->GetPlugin);
1926
1927 rdpsndPlugin* rdpsnd =
1928 (rdpsndPlugin*)pEntryPoints->GetPlugin(pEntryPoints, RDPSND_CHANNEL_NAME);
1929
1930 if (!rdpsnd)
1931 {
1932 IWTSPlugin* iface = nullptr;
1933 union
1934 {
1935 const void* cev;
1936 void* ev;
1937 } cnv;
1938
1939 rdpsnd = allocatePlugin();
1940 if (!rdpsnd)
1941 {
1942 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1943 return CHANNEL_RC_NO_MEMORY;
1944 }
1945
1946 iface = &rdpsnd->iface;
1947 iface->Initialize = rdpsnd_plugin_initialize;
1948 iface->Connected = nullptr;
1949 iface->Disconnected = nullptr;
1950 iface->Terminated = rdpsnd_plugin_terminated;
1951
1952 rdpsnd->dynamic = TRUE;
1953
1954 WINPR_ASSERT(pEntryPoints->GetRdpContext);
1955 rdpsnd->rdpcontext = pEntryPoints->GetRdpContext(pEntryPoints);
1956
1957 if (!freerdp_settings_get_bool(rdpsnd->rdpcontext->settings,
1958 FreeRDP_SynchronousDynamicChannels))
1959 rdpsnd->async = TRUE;
1960
1961 /* user data pointer is not const, cast to avoid warning. */
1962 cnv.cev = pEntryPoints->GetPluginData(pEntryPoints);
1963 WINPR_ASSERT(pEntryPoints->GetPluginData);
1964 rdpsnd->channelEntryPoints.pExtendedData = cnv.ev;
1965
1966 error = pEntryPoints->RegisterPlugin(pEntryPoints, RDPSND_CHANNEL_NAME, iface);
1967 }
1968 else
1969 {
1970 WLog_ERR(TAG, "%s could not get rdpsnd Plugin.", rdpsnd_is_dyn_str(TRUE));
1971 return CHANNEL_RC_BAD_CHANNEL;
1972 }
1973
1974 return error;
1975}
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