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
535/* Audio the client may queue beyond the current sample before it drops
536 * samples as an overrun. The check is meant to stop old servers from
537 * queueing seconds of audio; jitter and bursts are tens of milliseconds. */
538#define RDPSND_OVERRUN_SLACK_MS 200
539
540WINPR_ATTR_NODISCARD
541static BOOL rdpsnd_detect_overrun(rdpsndPlugin* rdpsnd, const AUDIO_FORMAT* format, size_t size)
542{
543 UINT32 bpf = 0;
544 UINT32 now = 0;
545 UINT32 duration = 0;
546 UINT32 totalDuration = 0;
547 UINT32 remainingDuration = 0;
548 UINT32 maxDuration = 0;
549
550 if (!rdpsnd || !format)
551 return FALSE;
552
553 /* Older windows RDP servers do not limit the send buffer, which can
554 * cause quite a large amount of sound data buffered client side.
555 * If e.g. sound is paused server side the client will keep playing
556 * for a long time instead of pausing playback.
557 *
558 * To avoid this we check:
559 *
560 * 1. Is the sound sample received from a known format these servers
561 * support
562 * 2. If it is calculate the size of the client side sound buffer
563 * 3. If the buffer is too large silently drop the sample which will
564 * trigger a retransmit later on.
565 *
566 * This check must only be applied to these known formats, because
567 * with newer and other formats the sample size can not be calculated
568 * without decompressing the sample first.
569 */
570 switch (format->wFormatTag)
571 {
572 case WAVE_FORMAT_PCM:
573 case WAVE_FORMAT_DVI_ADPCM:
574 case WAVE_FORMAT_ADPCM:
575 case WAVE_FORMAT_ALAW:
576 case WAVE_FORMAT_MULAW:
577 break;
578 case WAVE_FORMAT_MSG723:
579 case WAVE_FORMAT_GSM610:
580 case WAVE_FORMAT_AAC_MS:
581 default:
582 return FALSE;
583 }
584
585 audio_format_print(WLog_Get(TAG), WLOG_DEBUG, format);
586 bpf = format->nChannels * format->wBitsPerSample * format->nSamplesPerSec / 8;
587 if (bpf == 0)
588 return FALSE;
589
590 duration = (UINT32)(1000 * size / bpf);
591 totalDuration = (UINT32)(1000 * rdpsnd->totalPlaySize / bpf);
592 now = GetTickCountPrecise();
593 if (rdpsnd->startPlayTime == 0)
594 {
595 rdpsnd->startPlayTime = now;
596 rdpsnd->totalPlaySize = size;
597 return FALSE;
598 }
599 else if (now - rdpsnd->startPlayTime > totalDuration + 10)
600 {
601 /* Buffer underrun */
602 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Buffer underrun by %u ms",
603 rdpsnd_is_dyn_str(rdpsnd->dynamic),
604 (UINT)(now - rdpsnd->startPlayTime - totalDuration));
605 rdpsnd->startPlayTime = now;
606 rdpsnd->totalPlaySize = size;
607 return FALSE;
608 }
609 else
610 {
611 /* Calculate remaining duration to be played */
612 remainingDuration = totalDuration - (now - rdpsnd->startPlayTime);
613
614 /* Maximum allow duration calculation: at least RDPSND_OVERRUN_SLACK_MS
615 * on top, so samples that arrive in a burst (a late one followed by
616 * an on-time one, or a server sending several at once) are kept */
617 maxDuration = duration * 2 + MAX(rdpsnd->latency, RDPSND_OVERRUN_SLACK_MS);
618
619 if (remainingDuration + duration > maxDuration)
620 {
621 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Buffer overrun pending %u ms dropping %u ms",
622 rdpsnd_is_dyn_str(rdpsnd->dynamic), remainingDuration, duration);
623 return TRUE;
624 }
625
626 rdpsnd->totalPlaySize += size;
627 return FALSE;
628 }
629}
630
631WINPR_ATTR_NODISCARD
632static UINT rdpsnd_treat_wave(rdpsndPlugin* rdpsnd, wStream* s, size_t size)
633{
634 AUDIO_FORMAT* format = nullptr;
635 UINT64 end = 0;
636 UINT64 diffMS = 0;
637 UINT64 ts = 0;
638 UINT latency = 0;
639 UINT error = 0;
640
641 if (!Stream_CheckAndLogRequiredLength(TAG, s, size))
642 return ERROR_BAD_LENGTH;
643
644 if (rdpsnd->wCurrentFormatNo >= rdpsnd->NumberOfClientFormats)
645 return ERROR_INTERNAL_ERROR;
646
647 /*
648 * Send the first WaveConfirm PDU. The server side uses this to determine the
649 * network latency.
650 * See also [MS-RDPEA] 2.2.3.8 Wave Confirm PDU
651 */
652 error = rdpsnd_send_wave_confirm_pdu(rdpsnd, rdpsnd->wTimeStamp, rdpsnd->cBlockNo);
653 if (error)
654 return error;
655
656 const BYTE* data = Stream_ConstPointer(s);
657 format = &rdpsnd->ClientFormats[rdpsnd->wCurrentFormatNo];
658 WLog_Print(rdpsnd->log, WLOG_DEBUG,
659 "%s Wave: cBlockNo: %" PRIu8 " wTimeStamp: %" PRIu16 ", size: %" PRIuz,
660 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, rdpsnd->wTimeStamp, size);
661
662 if (rdpsnd->device && rdpsnd->attached && !rdpsnd_detect_overrun(rdpsnd, format, size))
663 {
664 UINT status = CHANNEL_RC_OK;
665 wStream* pcmData = StreamPool_Take(rdpsnd->pool, 4096);
666
667 if (rdpsnd->device->FormatSupported(rdpsnd->device, format))
668 {
669 if (rdpsnd->device->PlayEx)
670 latency = rdpsnd->device->PlayEx(rdpsnd->device, format, data, size);
671 else
672 latency = IFCALLRESULT(0, rdpsnd->device->Play, rdpsnd->device, data, size);
673 }
674 else if (freerdp_dsp_decode(rdpsnd->dsp_context, format, data, size, pcmData))
675 {
676 Stream_SealLength(pcmData);
677
678 if (rdpsnd->device->PlayEx)
679 latency = rdpsnd->device->PlayEx(rdpsnd->device, format, Stream_Buffer(pcmData),
680 Stream_Length(pcmData));
681 else
682 latency = IFCALLRESULT(0, rdpsnd->device->Play, rdpsnd->device,
683 Stream_Buffer(pcmData), Stream_Length(pcmData));
684 }
685 else
686 status = ERROR_INTERNAL_ERROR;
687
688 Stream_Release(pcmData);
689
690 if (status != CHANNEL_RC_OK)
691 return status;
692 }
693
694 end = GetTickCount64();
695 diffMS = end - rdpsnd->wArrivalTime + latency;
696 ts = (rdpsnd->wTimeStamp + diffMS) % UINT16_MAX;
697
698 /*
699 * Send the second WaveConfirm PDU. With the first WaveConfirm PDU,
700 * the server side uses this second WaveConfirm PDU to determine the actual
701 * render latency.
702 */
703 return rdpsnd_send_wave_confirm_pdu(rdpsnd, (UINT16)ts, rdpsnd->cBlockNo);
704}
705
711WINPR_ATTR_NODISCARD
712static UINT rdpsnd_recv_wave_pdu(rdpsndPlugin* rdpsnd, wStream* s)
713{
714 rdpsnd->expectingWave = FALSE;
715
722 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
723 return ERROR_INVALID_DATA;
724
725 CopyMemory(Stream_Buffer(s), rdpsnd->waveData, 4);
726 return rdpsnd_treat_wave(rdpsnd, s, rdpsnd->waveDataSize);
727}
728
729WINPR_ATTR_NODISCARD
730static UINT rdpsnd_recv_wave2_pdu(rdpsndPlugin* rdpsnd, wStream* s, UINT16 BodySize)
731{
732 UINT16 wFormatNo = 0;
733 AUDIO_FORMAT* format = nullptr;
734 UINT32 dwAudioTimeStamp = 0;
735
736 if (!Stream_CheckAndLogRequiredLength(TAG, s, 12) || (BodySize < 12))
737 return ERROR_BAD_LENGTH;
738
739 Stream_Read_UINT16(s, rdpsnd->wTimeStamp);
740 Stream_Read_UINT16(s, wFormatNo);
741 Stream_Read_UINT8(s, rdpsnd->cBlockNo);
742 Stream_Seek(s, 3); /* bPad */
743 Stream_Read_UINT32(s, dwAudioTimeStamp);
744 if (wFormatNo >= rdpsnd->NumberOfClientFormats)
745 return ERROR_INVALID_DATA;
746 format = &rdpsnd->ClientFormats[wFormatNo];
747 rdpsnd->waveDataSize = BodySize - 12;
748 rdpsnd->wArrivalTime = GetTickCount64();
749 WLog_Print(rdpsnd->log, WLOG_DEBUG,
750 "%s Wave2PDU: cBlockNo: %" PRIu8 " wFormatNo: %" PRIu16
751 " [%s] , align=%hu wTimeStamp=0x%04" PRIx16 ", dwAudioTimeStamp=0x%08" PRIx32,
752 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->cBlockNo, wFormatNo,
753 audio_format_get_tag_string(format->wFormatTag), format->nBlockAlign,
754 rdpsnd->wTimeStamp, dwAudioTimeStamp);
755
756 if (!rdpsnd_ensure_device_is_open(rdpsnd, wFormatNo, format))
757 return ERROR_INTERNAL_ERROR;
758
759 return rdpsnd_treat_wave(rdpsnd, s, rdpsnd->waveDataSize);
760}
761
762static void rdpsnd_recv_close_pdu(rdpsndPlugin* rdpsnd)
763{
764 if (rdpsnd->isOpen)
765 {
766 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Closing device",
767 rdpsnd_is_dyn_str(rdpsnd->dynamic));
768 }
769 else
770 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Device already closed",
771 rdpsnd_is_dyn_str(rdpsnd->dynamic));
772}
773
779WINPR_ATTR_NODISCARD
780static UINT rdpsnd_recv_volume_pdu(rdpsndPlugin* rdpsnd, wStream* s)
781{
782 BOOL rc = TRUE;
783 UINT32 dwVolume = 0;
784
785 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
786 return ERROR_BAD_LENGTH;
787
788 Stream_Read_UINT32(s, dwVolume);
789 WLog_Print(rdpsnd->log, WLOG_DEBUG, "%s Volume: 0x%08" PRIX32 "",
790 rdpsnd_is_dyn_str(rdpsnd->dynamic), dwVolume);
791
792 rdpsnd->volume = dwVolume;
793 rdpsnd->applyVolume = TRUE;
794 rc = rdpsnd_apply_volume(rdpsnd);
795
796 if (!rc)
797 {
798 WLog_ERR(TAG, "%s error setting volume", rdpsnd_is_dyn_str(rdpsnd->dynamic));
799 return CHANNEL_RC_INITIALIZATION_ERROR;
800 }
801
802 return CHANNEL_RC_OK;
803}
804
810WINPR_ATTR_NODISCARD
811static UINT rdpsnd_recv_pdu(rdpsndPlugin* rdpsnd, wStream* s)
812{
813 BYTE msgType = 0;
814 UINT16 BodySize = 0;
815 UINT status = CHANNEL_RC_OK;
816
817 if (rdpsnd->expectingWave)
818 {
819 status = rdpsnd_recv_wave_pdu(rdpsnd, s);
820 goto out;
821 }
822
823 if (!Stream_CheckAndLogRequiredLength(TAG, s, 4))
824 {
825 status = ERROR_BAD_LENGTH;
826 goto out;
827 }
828
829 Stream_Read_UINT8(s, msgType); /* msgType */
830 Stream_Seek_UINT8(s); /* bPad */
831 Stream_Read_UINT16(s, BodySize);
832
833 switch (msgType)
834 {
835 case SNDC_FORMATS:
836 status = rdpsnd_recv_server_audio_formats_pdu(rdpsnd, s);
837 break;
838
839 case SNDC_TRAINING:
840 status = rdpsnd_recv_training_pdu(rdpsnd, s);
841 break;
842
843 case SNDC_WAVE:
844 status = rdpsnd_recv_wave_info_pdu(rdpsnd, s, BodySize);
845 break;
846
847 case SNDC_CLOSE:
848 rdpsnd_recv_close_pdu(rdpsnd);
849 break;
850
851 case SNDC_SETVOLUME:
852 status = rdpsnd_recv_volume_pdu(rdpsnd, s);
853 break;
854
855 case SNDC_WAVE2:
856 status = rdpsnd_recv_wave2_pdu(rdpsnd, s, BodySize);
857 break;
858
859 default:
860 WLog_ERR(TAG, "%s unknown msgType %" PRIu8 "", rdpsnd_is_dyn_str(rdpsnd->dynamic),
861 msgType);
862 break;
863 }
864
865out:
866 Stream_Release(s);
867 return status;
868}
869
870static void rdpsnd_register_device_plugin(rdpsndPlugin* rdpsnd, rdpsndDevicePlugin* device)
871{
872 if (rdpsnd->device)
873 {
874 WLog_ERR(TAG, "%s existing device, abort.", rdpsnd_is_dyn_str(FALSE));
875 return;
876 }
877
878 rdpsnd->device = device;
879 device->rdpsnd = rdpsnd;
880}
881
887WINPR_ATTR_NODISCARD
888static UINT rdpsnd_load_device_plugin(rdpsndPlugin* rdpsnd, const char* name,
889 const ADDIN_ARGV* args)
890{
891 FREERDP_RDPSND_DEVICE_ENTRY_POINTS entryPoints = WINPR_C_ARRAY_INIT;
892 UINT error = 0;
893 DWORD flags = FREERDP_ADDIN_CHANNEL_STATIC | FREERDP_ADDIN_CHANNEL_ENTRYEX;
894 if (rdpsnd->dynamic)
895 flags = FREERDP_ADDIN_CHANNEL_DYNAMIC;
896 PVIRTUALCHANNELENTRY pvce =
897 freerdp_load_channel_addin_entry(RDPSND_CHANNEL_NAME, name, nullptr, flags);
898 PFREERDP_RDPSND_DEVICE_ENTRY entry = WINPR_FUNC_PTR_CAST(pvce, PFREERDP_RDPSND_DEVICE_ENTRY);
899
900 if (!entry)
901 return ERROR_INTERNAL_ERROR;
902
903 entryPoints.rdpsnd = rdpsnd;
904 entryPoints.pRegisterRdpsndDevice = rdpsnd_register_device_plugin;
905 entryPoints.args = args;
906
907 error = entry(&entryPoints);
908 if (error)
909 WLog_WARN(TAG, "%s %s entry returns error %" PRIu32 "", rdpsnd_is_dyn_str(rdpsnd->dynamic),
910 name, error);
911 else
912 WLog_INFO(TAG, "%s Loaded %s backend for rdpsnd", rdpsnd_is_dyn_str(rdpsnd->dynamic), name);
913
914 return error;
915}
916
917WINPR_ATTR_NODISCARD
918static BOOL rdpsnd_set_subsystem(rdpsndPlugin* rdpsnd, const char* subsystem)
919{
920 free(rdpsnd->subsystem);
921 rdpsnd->subsystem = _strdup(subsystem);
922 return (rdpsnd->subsystem != nullptr);
923}
924
925WINPR_ATTR_NODISCARD
926static BOOL rdpsnd_set_device_name(rdpsndPlugin* rdpsnd, const char* device_name)
927{
928 free(rdpsnd->device_name);
929 rdpsnd->device_name = _strdup(device_name);
930 return (rdpsnd->device_name != nullptr);
931}
932
933/* format:<format> accepts a numeric wFormatTag (e.g. 0x704F) or the name
934 * audio_format_get_tag_string() returns for it, with or without the
935 * WAVE_FORMAT_ prefix (e.g. opus, alaw, aac_ms).
936 * Anything else is rejected instead of silently becoming WAVE_FORMAT_UNKNOWN,
937 * which would allow any format. */
938WINPR_ATTR_NODISCARD
939static BOOL rdpsnd_parse_format_tag(const char* value, UINT16* tag)
940{
941 static const char prefix[] = "WAVE_FORMAT_";
942 const size_t prefixlen = strnlen(prefix, sizeof(prefix));
943
944 WINPR_ASSERT(value);
945 WINPR_ASSERT(tag);
946
947 char* end = nullptr;
948 errno = 0;
949 const unsigned long val = strtoul(value, &end, 0);
950 if ((errno == 0) && (end != value) && (*end == '\0'))
951 {
952 if (val > UINT16_MAX)
953 return FALSE;
954 *tag = (UINT16)val;
955 return TRUE;
956 }
957
958 const char* name = value;
959 if (_strnicmp(name, prefix, prefixlen) == 0)
960 name += prefixlen;
961
962 for (UINT32 x = 0; x <= UINT16_MAX; x++)
963 {
964 const char* str = audio_format_get_tag_string((UINT16)x);
965 if (strncmp(str, prefix, prefixlen) == 0)
966 str += prefixlen;
967 if (_stricmp(name, str) == 0)
968 {
969 *tag = (UINT16)x;
970 return TRUE;
971 }
972 }
973
974 return FALSE;
975}
976
982WINPR_ATTR_NODISCARD
983static UINT rdpsnd_process_addin_args(rdpsndPlugin* rdpsnd, const ADDIN_ARGV* args)
984{
985 int status = 0;
986 DWORD flags = 0;
987 const COMMAND_LINE_ARGUMENT_A* arg = nullptr;
988 COMMAND_LINE_ARGUMENT_A rdpsnd_args[] = {
989 { "sys", COMMAND_LINE_VALUE_REQUIRED, "<subsystem>", nullptr, nullptr, -1, nullptr,
990 "subsystem" },
991 { "dev", COMMAND_LINE_VALUE_REQUIRED, "<device>", nullptr, nullptr, -1, nullptr, "device" },
992 { "format", COMMAND_LINE_VALUE_REQUIRED, "<format>", nullptr, nullptr, -1, nullptr,
993 "format" },
994 { "rate", COMMAND_LINE_VALUE_REQUIRED, "<rate>", nullptr, nullptr, -1, nullptr, "rate" },
995 { "channel", COMMAND_LINE_VALUE_REQUIRED, "<channel>", nullptr, nullptr, -1, nullptr,
996 "channel" },
997 { "latency", COMMAND_LINE_VALUE_REQUIRED, "<latency>", nullptr, nullptr, -1, nullptr,
998 "latency" },
999 { "quality", COMMAND_LINE_VALUE_REQUIRED, "<quality mode>", nullptr, nullptr, -1, nullptr,
1000 "quality mode" },
1001 { nullptr, 0, nullptr, nullptr, nullptr, -1, nullptr, nullptr }
1002 };
1003 rdpsnd->wQualityMode = HIGH_QUALITY; /* default quality mode */
1004
1005 if (args->argc > 1)
1006 {
1007 flags = COMMAND_LINE_SIGIL_NONE | COMMAND_LINE_SEPARATOR_COLON;
1008 status = CommandLineParseArgumentsA(args->argc, args->argv, rdpsnd_args, flags, rdpsnd,
1009 nullptr, nullptr);
1010
1011 if (status < 0)
1012 return CHANNEL_RC_INITIALIZATION_ERROR;
1013
1014 arg = rdpsnd_args;
1015 errno = 0;
1016
1017 do
1018 {
1019 if (!(arg->Flags & COMMAND_LINE_VALUE_PRESENT))
1020 continue;
1021
1022 CommandLineSwitchStart(arg) CommandLineSwitchCase(arg, "sys")
1023 {
1024 if (!rdpsnd_set_subsystem(rdpsnd, arg->Value))
1025 return CHANNEL_RC_NO_MEMORY;
1026 }
1027 CommandLineSwitchCase(arg, "dev")
1028 {
1029 if (!rdpsnd_set_device_name(rdpsnd, arg->Value))
1030 return CHANNEL_RC_NO_MEMORY;
1031 }
1032 CommandLineSwitchCase(arg, "format")
1033 {
1034 UINT16 tag = WAVE_FORMAT_UNKNOWN;
1035
1036 if (!rdpsnd_parse_format_tag(arg->Value, &tag))
1037 {
1038 WLog_Print(rdpsnd->log, WLOG_ERROR,
1039 "invalid format '%s', expected a format tag (e.g. 0x704F) or "
1040 "a WAVE_FORMAT_ name (e.g. opus, pcm, alaw, aac_ms)",
1041 arg->Value);
1042 return CHANNEL_RC_INITIALIZATION_ERROR;
1043 }
1044
1045 rdpsnd->fixed_format->wFormatTag = tag;
1046 }
1047 CommandLineSwitchCase(arg, "rate")
1048 {
1049 unsigned long val = strtoul(arg->Value, nullptr, 0);
1050
1051 if ((errno != 0) || (val > UINT32_MAX))
1052 return CHANNEL_RC_INITIALIZATION_ERROR;
1053
1054 rdpsnd->fixed_format->nSamplesPerSec = (UINT32)val;
1055 }
1056 CommandLineSwitchCase(arg, "channel")
1057 {
1058 unsigned long val = strtoul(arg->Value, nullptr, 0);
1059
1060 if ((errno != 0) || (val > UINT16_MAX))
1061 return CHANNEL_RC_INITIALIZATION_ERROR;
1062
1063 rdpsnd->fixed_format->nChannels = (UINT16)val;
1064 }
1065 CommandLineSwitchCase(arg, "latency")
1066 {
1067 unsigned long val = strtoul(arg->Value, nullptr, 0);
1068
1069 if ((errno != 0) || (val > UINT32_MAX))
1070 return CHANNEL_RC_INITIALIZATION_ERROR;
1071
1072 rdpsnd->latency = (UINT32)val;
1073 }
1074 CommandLineSwitchCase(arg, "quality")
1075 {
1076 long wQualityMode = DYNAMIC_QUALITY;
1077
1078 if (_stricmp(arg->Value, "dynamic") == 0)
1079 wQualityMode = DYNAMIC_QUALITY;
1080 else if (_stricmp(arg->Value, "medium") == 0)
1081 wQualityMode = MEDIUM_QUALITY;
1082 else if (_stricmp(arg->Value, "high") == 0)
1083 wQualityMode = HIGH_QUALITY;
1084 else
1085 {
1086 wQualityMode = strtol(arg->Value, nullptr, 0);
1087
1088 if (errno != 0)
1089 return CHANNEL_RC_INITIALIZATION_ERROR;
1090 }
1091
1092 if ((wQualityMode < 0) || (wQualityMode > 2))
1093 wQualityMode = DYNAMIC_QUALITY;
1094
1095 rdpsnd->wQualityMode = (UINT16)wQualityMode;
1096 }
1097 CommandLineSwitchDefault(arg)
1098 {
1099 }
1100 CommandLineSwitchEnd(arg)
1101 } while ((arg = CommandLineFindNextArgumentA(arg)) != nullptr);
1102 }
1103
1104 return CHANNEL_RC_OK;
1105}
1106
1112WINPR_ATTR_NODISCARD
1113static UINT rdpsnd_process_connect(rdpsndPlugin* rdpsnd)
1114{
1115 const struct
1116 {
1117 const char* subsystem;
1118 const char* device;
1119 } backends[] = {
1120#if defined(WITH_IOSAUDIO)
1121 { "ios", "" },
1122#endif
1123#if defined(WITH_AAUDIO)
1124 { "aaudio", "" },
1125#endif
1126#if defined(WITH_OPENSLES)
1127 { "opensles", "" },
1128#endif
1129#if defined(WITH_PULSE)
1130 { "pulse", "" },
1131#endif
1132#if defined(WITH_ALSA)
1133 { "alsa", "default" },
1134#endif
1135#if defined(WITH_OSS)
1136 { "oss", "" },
1137#endif
1138#if defined(WITH_MACAUDIO)
1139 { "mac", "default" },
1140#endif
1141#if defined(WITH_WINMM)
1142 { "winmm", "" },
1143#endif
1144#if defined(WITH_SNDIO)
1145 { "sndio", "" },
1146#endif
1147 { "fake", "" }
1148 };
1149 const ADDIN_ARGV* args = nullptr;
1150 UINT status = ERROR_INTERNAL_ERROR;
1151 WINPR_ASSERT(rdpsnd);
1152 rdpsnd->latency = 0;
1153 args = (const ADDIN_ARGV*)rdpsnd->channelEntryPoints.pExtendedData;
1154
1155 if (args)
1156 {
1157 status = rdpsnd_process_addin_args(rdpsnd, args);
1158
1159 if (status != CHANNEL_RC_OK)
1160 return status;
1161 }
1162
1163 if (rdpsnd->subsystem)
1164 {
1165 if ((status = rdpsnd_load_device_plugin(rdpsnd, rdpsnd->subsystem, args)))
1166 {
1167 WLog_ERR(TAG,
1168 "%s Unable to load sound playback subsystem %s because of error %" PRIu32 "",
1169 rdpsnd_is_dyn_str(rdpsnd->dynamic), rdpsnd->subsystem, status);
1170 return status;
1171 }
1172 }
1173 else
1174 {
1175 for (size_t x = 0; x < ARRAYSIZE(backends); x++)
1176 {
1177 const char* subsystem_name = backends[x].subsystem;
1178 const char* device_name = backends[x].device;
1179
1180 if ((status = rdpsnd_load_device_plugin(rdpsnd, subsystem_name, args)))
1181 WLog_WARN(TAG,
1182 "%s Unable to load sound playback subsystem %s because of error %" PRIu32
1183 "",
1184 rdpsnd_is_dyn_str(rdpsnd->dynamic), subsystem_name, status);
1185
1186 if (!rdpsnd->device)
1187 continue;
1188
1189 if (!rdpsnd_set_subsystem(rdpsnd, subsystem_name) ||
1190 !rdpsnd_set_device_name(rdpsnd, device_name))
1191 return CHANNEL_RC_NO_MEMORY;
1192
1193 break;
1194 }
1195
1196 if (!rdpsnd->device || status)
1197 return CHANNEL_RC_INITIALIZATION_ERROR;
1198 }
1199
1200 return CHANNEL_RC_OK;
1201}
1202
1208UINT rdpsnd_virtual_channel_write(rdpsndPlugin* rdpsnd, wStream* s)
1209{
1210 UINT status = CHANNEL_RC_BAD_INIT_HANDLE;
1211
1212 if (rdpsnd)
1213 {
1214 if (rdpsnd->dynamic)
1215 {
1216 if (rdpsnd->listener_callback && rdpsnd->connected)
1217 {
1218 IWTSVirtualChannel* channel = rdpsnd->listener_callback->channel_callback->channel;
1219 status =
1220 channel->Write(channel, (UINT32)Stream_Length(s), Stream_Buffer(s), nullptr);
1221 }
1222 Stream_Free(s, TRUE);
1223 }
1224 else
1225 {
1226 status = rdpsnd->channelEntryPoints.pVirtualChannelWriteEx(
1227 rdpsnd->InitHandle, rdpsnd->OpenHandle, Stream_Buffer(s),
1228 (UINT32)Stream_GetPosition(s), s);
1229
1230 if (status != CHANNEL_RC_OK)
1231 {
1232 Stream_Free(s, TRUE);
1233 WLog_ERR(TAG, "%s pVirtualChannelWriteEx failed with %s [%08" PRIX32 "]",
1234 rdpsnd_is_dyn_str(FALSE), WTSErrorToString(status), status);
1235 }
1236 }
1237 }
1238
1239 return status;
1240}
1241
1247WINPR_ATTR_NODISCARD
1248static UINT rdpsnd_virtual_channel_event_data_received(rdpsndPlugin* plugin, void* pData,
1249 UINT32 dataLength, UINT32 totalLength,
1250 UINT32 dataFlags)
1251{
1252 if ((dataFlags & CHANNEL_FLAG_SUSPEND) || (dataFlags & CHANNEL_FLAG_RESUME))
1253 return CHANNEL_RC_OK;
1254
1255 if (dataFlags & CHANNEL_FLAG_FIRST)
1256 {
1257 if (plugin->firstFlagReceived)
1258 return ERROR_INVALID_DATA;
1259 plugin->firstFlagReceived = TRUE;
1260
1261 if (!plugin->data_in)
1262 plugin->data_in = StreamPool_Take(plugin->pool, dataLength);
1263
1264 Stream_ResetPosition(plugin->data_in);
1265 plugin->totalLength = totalLength;
1266 }
1267
1268 if (!plugin->data_in)
1269 return ERROR_INVALID_DATA;
1270
1271 if (!Stream_EnsureRemainingCapacity(plugin->data_in, dataLength))
1272 return CHANNEL_RC_NO_MEMORY;
1273
1274 Stream_Write(plugin->data_in, pData, dataLength);
1275
1276 if ((Stream_GetPosition(plugin->data_in) > totalLength) || (totalLength != plugin->totalLength))
1277 return ERROR_INVALID_DATA;
1278
1279 if (dataFlags & CHANNEL_FLAG_LAST)
1280 {
1281 if (!plugin->firstFlagReceived)
1282 return ERROR_INVALID_DATA;
1283 if (Stream_GetPosition(plugin->data_in) != totalLength)
1284 return ERROR_INVALID_DATA;
1285 plugin->firstFlagReceived = FALSE;
1286
1287 Stream_SealLength(plugin->data_in);
1288 Stream_ResetPosition(plugin->data_in);
1289 plugin->totalLength = 0;
1290
1291 if (plugin->async)
1292 {
1293 if (!MessageQueue_Post(plugin->queue, nullptr, 0, plugin->data_in, nullptr))
1294 return ERROR_INTERNAL_ERROR;
1295 plugin->data_in = nullptr;
1296 }
1297 else
1298 {
1299 UINT error = rdpsnd_recv_pdu(plugin, plugin->data_in);
1300 plugin->data_in = nullptr;
1301 if (error)
1302 return error;
1303 }
1304 }
1305
1306 return CHANNEL_RC_OK;
1307}
1308
1309static VOID VCAPITYPE rdpsnd_virtual_channel_open_event_ex(LPVOID lpUserParam, DWORD openHandle,
1310 UINT event, LPVOID pData,
1311 UINT32 dataLength, UINT32 totalLength,
1312 UINT32 dataFlags)
1313{
1314 UINT error = CHANNEL_RC_OK;
1315 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)lpUserParam;
1316 WINPR_ASSERT(rdpsnd);
1317 WINPR_ASSERT(!rdpsnd->dynamic);
1318
1319 switch (event)
1320 {
1321 case CHANNEL_EVENT_DATA_RECEIVED:
1322 if (!rdpsnd)
1323 return;
1324
1325 if (rdpsnd->OpenHandle != openHandle)
1326 {
1327 WLog_ERR(TAG, "%s error no match", rdpsnd_is_dyn_str(rdpsnd->dynamic));
1328 return;
1329 }
1330 if ((error = rdpsnd_virtual_channel_event_data_received(rdpsnd, pData, dataLength,
1331 totalLength, dataFlags)))
1332 WLog_ERR(TAG,
1333 "%s rdpsnd_virtual_channel_event_data_received failed with error %" PRIu32
1334 "",
1335 rdpsnd_is_dyn_str(rdpsnd->dynamic), error);
1336
1337 break;
1338
1339 case CHANNEL_EVENT_WRITE_CANCELLED:
1340 case CHANNEL_EVENT_WRITE_COMPLETE:
1341 {
1342 wStream* s = (wStream*)pData;
1343 Stream_Free(s, TRUE);
1344 }
1345 break;
1346
1347 case CHANNEL_EVENT_USER:
1348 break;
1349 default:
1350 break;
1351 }
1352
1353 if (error && rdpsnd && rdpsnd->rdpcontext)
1354 {
1355 char buffer[8192];
1356 (void)_snprintf(buffer, sizeof(buffer),
1357 "%s rdpsnd_virtual_channel_open_event_ex reported an error",
1358 rdpsnd_is_dyn_str(rdpsnd->dynamic));
1359 setChannelError(rdpsnd->rdpcontext, error, buffer);
1360 }
1361}
1362
1368WINPR_ATTR_NODISCARD
1369static UINT rdpsnd_virtual_channel_event_connected(rdpsndPlugin* rdpsnd, LPVOID pData,
1370 UINT32 dataLength)
1371{
1372 UINT32 status = 0;
1373 DWORD opened = 0;
1374 WINPR_UNUSED(pData);
1375 WINPR_UNUSED(dataLength);
1376
1377 WINPR_ASSERT(rdpsnd);
1378 WINPR_ASSERT(!rdpsnd->dynamic);
1379
1380 status = rdpsnd->channelEntryPoints.pVirtualChannelOpenEx(
1381 rdpsnd->InitHandle, &opened, rdpsnd->channelDef.name, rdpsnd_virtual_channel_open_event_ex);
1382
1383 if (status != CHANNEL_RC_OK)
1384 {
1385 WLog_ERR(TAG, "%s pVirtualChannelOpenEx failed with %s [%08" PRIX32 "]",
1386 rdpsnd_is_dyn_str(rdpsnd->dynamic), WTSErrorToString(status), status);
1387 goto fail;
1388 }
1389
1390 if (rdpsnd_process_connect(rdpsnd) != CHANNEL_RC_OK)
1391 goto fail;
1392
1393 rdpsnd->OpenHandle = opened;
1394 return CHANNEL_RC_OK;
1395fail:
1396 if (opened != 0)
1397 rdpsnd->channelEntryPoints.pVirtualChannelCloseEx(rdpsnd->InitHandle, opened);
1398 return CHANNEL_RC_NO_MEMORY;
1399}
1400
1401static void rdpsnd_terminate_thread(rdpsndPlugin* rdpsnd)
1402{
1403 WINPR_ASSERT(rdpsnd);
1404 if (rdpsnd->async)
1405 {
1406 if (rdpsnd->queue)
1407 MessageQueue_PostQuit(rdpsnd->queue, 0);
1408
1409 if (rdpsnd->thread)
1410 {
1411 (void)WaitForSingleObject(rdpsnd->thread, INFINITE);
1412 (void)CloseHandle(rdpsnd->thread);
1413 }
1414 DeleteCriticalSection(&rdpsnd->asyncLock);
1415 MessageQueue_Free(rdpsnd->queue);
1416 }
1417 rdpsnd->thread = nullptr;
1418 rdpsnd->queue = nullptr;
1419}
1420
1421static void cleanup_internals(rdpsndPlugin* rdpsnd)
1422{
1423 if (!rdpsnd)
1424 return;
1425
1426 if (rdpsnd->async)
1427 EnterCriticalSection(&rdpsnd->asyncLock);
1428
1429 if (rdpsnd->pool)
1430 StreamPool_Return(rdpsnd->pool, rdpsnd->data_in);
1431
1432 audio_formats_free(rdpsnd->ClientFormats, rdpsnd->NumberOfClientFormats);
1433 audio_formats_free(rdpsnd->ServerFormats, rdpsnd->NumberOfServerFormats);
1434
1435 rdpsnd->NumberOfClientFormats = 0;
1436 rdpsnd->ClientFormats = nullptr;
1437 rdpsnd->NumberOfServerFormats = 0;
1438 rdpsnd->ServerFormats = nullptr;
1439
1440 rdpsnd->data_in = nullptr;
1441
1442 if (rdpsnd->async)
1443 LeaveCriticalSection(&rdpsnd->asyncLock);
1444}
1445
1451WINPR_ATTR_NODISCARD
1452static UINT rdpsnd_virtual_channel_event_disconnected(rdpsndPlugin* rdpsnd)
1453{
1454 UINT error = 0;
1455
1456 WINPR_ASSERT(rdpsnd);
1457 WINPR_ASSERT(!rdpsnd->dynamic);
1458 if (rdpsnd->OpenHandle != 0)
1459 {
1460 DWORD opened = rdpsnd->OpenHandle;
1461 rdpsnd->OpenHandle = 0;
1462 if (rdpsnd->device)
1463 IFCALL(rdpsnd->device->Close, rdpsnd->device);
1464
1465 error = rdpsnd->channelEntryPoints.pVirtualChannelCloseEx(rdpsnd->InitHandle, opened);
1466
1467 if (CHANNEL_RC_OK != error)
1468 {
1469 WLog_ERR(TAG, "%s pVirtualChannelCloseEx failed with %s [%08" PRIX32 "]",
1470 rdpsnd_is_dyn_str(rdpsnd->dynamic), WTSErrorToString(error), error);
1471 return error;
1472 }
1473 }
1474
1475 cleanup_internals(rdpsnd);
1476
1477 if (rdpsnd->device)
1478 {
1479 IFCALL(rdpsnd->device->Free, rdpsnd->device);
1480 rdpsnd->device = nullptr;
1481 }
1482
1483 return CHANNEL_RC_OK;
1484}
1485
1486static void queue_free(void* obj)
1487{
1488 wMessage* msg = obj;
1489 if (!msg)
1490 return;
1491 if (msg->id != 0)
1492 return;
1493 wStream* s = msg->wParam;
1494 Stream_Release(s);
1495}
1496
1497static void free_internals(rdpsndPlugin* rdpsnd)
1498{
1499 if (!rdpsnd)
1500 return;
1501
1502 if (rdpsnd->references > 0)
1503 rdpsnd->references--;
1504
1505 if (rdpsnd->references > 0)
1506 return;
1507
1508 rdpsnd_terminate_thread(rdpsnd);
1509 freerdp_dsp_context_free(rdpsnd->dsp_context);
1510 StreamPool_Free(rdpsnd->pool);
1511 rdpsnd->pool = nullptr;
1512 rdpsnd->dsp_context = nullptr;
1513}
1514
1515WINPR_ATTR_NODISCARD
1516static BOOL allocate_internals(rdpsndPlugin* rdpsnd)
1517{
1518 WINPR_ASSERT(rdpsnd);
1519
1520 if (!rdpsnd->pool)
1521 {
1522 rdpsnd->pool = StreamPool_New(TRUE, 4096);
1523 if (!rdpsnd->pool)
1524 return FALSE;
1525 }
1526
1527 if (!rdpsnd->dsp_context)
1528 {
1529 rdpsnd->dsp_context = freerdp_dsp_context_new(FALSE);
1530 if (!rdpsnd->dsp_context)
1531 return FALSE;
1532 }
1533
1534 if (rdpsnd->async)
1535 {
1536 if (!rdpsnd->queue)
1537 {
1538 wObject obj = WINPR_C_ARRAY_INIT;
1539
1540 obj.fnObjectFree = queue_free;
1541 rdpsnd->queue = MessageQueue_New(&obj);
1542 if (!rdpsnd->queue)
1543 return CHANNEL_RC_NO_MEMORY;
1544 InitializeCriticalSection(&rdpsnd->asyncLock);
1545 }
1546
1547 if (!rdpsnd->thread)
1548 {
1549 rdpsnd->thread = CreateThread(nullptr, 0, play_thread, rdpsnd, 0, nullptr);
1550 if (!rdpsnd->thread)
1551 return CHANNEL_RC_INITIALIZATION_ERROR;
1552 }
1553 }
1554
1555 rdpsnd->references++;
1556
1557 return TRUE;
1558}
1559
1560WINPR_ATTR_NODISCARD
1561static DWORD WINAPI play_thread(LPVOID arg)
1562{
1563 UINT error = CHANNEL_RC_OK;
1564 rdpsndPlugin* rdpsnd = arg;
1565
1566 if (!rdpsnd || !rdpsnd->queue)
1567 return ERROR_INVALID_PARAMETER;
1568
1569 while (TRUE)
1570 {
1571 int rc = -1;
1572 wMessage message = WINPR_C_ARRAY_INIT;
1573 wStream* s = nullptr;
1574 DWORD status = 0;
1575 DWORD nCount = 0;
1576 HANDLE handles[MAXIMUM_WAIT_OBJECTS] = WINPR_C_ARRAY_INIT;
1577
1578 handles[nCount++] = MessageQueue_Event(rdpsnd->queue);
1579 handles[nCount++] = freerdp_abort_event(rdpsnd->rdpcontext);
1580 status = WaitForMultipleObjects(nCount, handles, FALSE, INFINITE);
1581 switch (status)
1582 {
1583 case WAIT_OBJECT_0:
1584 break;
1585 default:
1586 return ERROR_TIMEOUT;
1587 }
1588
1589 rc = MessageQueue_Peek(rdpsnd->queue, &message, TRUE);
1590 if (rc < 1)
1591 continue;
1592
1593 if (message.id == WMQ_QUIT)
1594 break;
1595
1596 if (rdpsnd->async)
1597 EnterCriticalSection(&rdpsnd->asyncLock);
1598
1599 s = message.wParam;
1600 error = rdpsnd_recv_pdu(rdpsnd, s);
1601
1602 if (rdpsnd->async)
1603 LeaveCriticalSection(&rdpsnd->asyncLock);
1604
1605 if (error)
1606 return error;
1607 }
1608
1609 return CHANNEL_RC_OK;
1610}
1611
1612WINPR_ATTR_NODISCARD
1613static UINT rdpsnd_virtual_channel_event_initialized(rdpsndPlugin* rdpsnd)
1614{
1615 if (!rdpsnd)
1616 return ERROR_INVALID_PARAMETER;
1617
1618 if (!allocate_internals(rdpsnd))
1619 return CHANNEL_RC_NO_MEMORY;
1620
1621 return CHANNEL_RC_OK;
1622}
1623
1624void rdpsnd_virtual_channel_event_terminated(rdpsndPlugin* rdpsnd)
1625{
1626 if (rdpsnd)
1627 {
1628 free_internals(rdpsnd);
1629 audio_formats_free(rdpsnd->fixed_format, 1);
1630 free(rdpsnd->subsystem);
1631 free(rdpsnd->device_name);
1632 rdpsnd->InitHandle = nullptr;
1633 }
1634
1635 free(rdpsnd);
1636}
1637
1638static VOID VCAPITYPE rdpsnd_virtual_channel_init_event_ex(LPVOID lpUserParam, LPVOID pInitHandle,
1639 UINT event, LPVOID pData,
1640 UINT dataLength)
1641{
1642 UINT error = CHANNEL_RC_OK;
1643 rdpsndPlugin* plugin = (rdpsndPlugin*)lpUserParam;
1644
1645 if (!plugin)
1646 return;
1647
1648 if (plugin->InitHandle != pInitHandle)
1649 {
1650 WLog_ERR(TAG, "%s error no match", rdpsnd_is_dyn_str(plugin->dynamic));
1651 return;
1652 }
1653
1654 switch (event)
1655 {
1656 case CHANNEL_EVENT_INITIALIZED:
1657 error = rdpsnd_virtual_channel_event_initialized(plugin);
1658 break;
1659
1660 case CHANNEL_EVENT_CONNECTED:
1661 error = rdpsnd_virtual_channel_event_connected(plugin, pData, dataLength);
1662 break;
1663
1664 case CHANNEL_EVENT_DISCONNECTED:
1665 error = rdpsnd_virtual_channel_event_disconnected(plugin);
1666 break;
1667
1668 case CHANNEL_EVENT_TERMINATED:
1669 rdpsnd_virtual_channel_event_terminated(plugin);
1670 plugin = nullptr;
1671 break;
1672
1673 case CHANNEL_EVENT_ATTACHED:
1674 plugin->attached = TRUE;
1675 break;
1676
1677 case CHANNEL_EVENT_DETACHED:
1678 plugin->attached = FALSE;
1679 break;
1680
1681 default:
1682 break;
1683 }
1684
1685 if (error && plugin && plugin->rdpcontext)
1686 {
1687 char buffer[8192];
1688 (void)_snprintf(buffer, sizeof(buffer), "%s reported an error",
1689 rdpsnd_is_dyn_str(plugin->dynamic));
1690 setChannelError(plugin->rdpcontext, error, buffer);
1691 }
1692}
1693
1694rdpContext* freerdp_rdpsnd_get_context(rdpsndPlugin* plugin)
1695{
1696 if (!plugin)
1697 return nullptr;
1698
1699 return plugin->rdpcontext;
1700}
1701
1702WINPR_ATTR_NODISCARD
1703static rdpsndPlugin* allocatePlugin(void)
1704{
1705 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)calloc(1, sizeof(rdpsndPlugin));
1706 if (!rdpsnd)
1707 goto fail;
1708
1709 rdpsnd->fixed_format = audio_format_new();
1710 if (!rdpsnd->fixed_format)
1711 goto fail;
1712 rdpsnd->log = WLog_Get("com.freerdp.channels.rdpsnd.client");
1713 if (!rdpsnd->log)
1714 goto fail;
1715
1716 rdpsnd->attached = TRUE;
1717 return rdpsnd;
1718
1719fail:
1720 if (rdpsnd)
1721 audio_formats_free(rdpsnd->fixed_format, 1);
1722 free(rdpsnd);
1723 return nullptr;
1724}
1725/* rdpsnd is always built-in */
1726FREERDP_ENTRY_POINT(BOOL VCAPITYPE rdpsnd_VirtualChannelEntryEx(
1727 PCHANNEL_ENTRY_POINTS_EX pEntryPoints, PVOID pInitHandle))
1728{
1729 UINT rc = 0;
1730 CHANNEL_ENTRY_POINTS_FREERDP_EX* pEntryPointsEx = nullptr;
1731
1732 if (!pEntryPoints)
1733 return FALSE;
1734
1735 rdpsndPlugin* rdpsnd = allocatePlugin();
1736
1737 if (!rdpsnd)
1738 return FALSE;
1739
1740 rdpsnd->channelDef.options = CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP;
1741 (void)sprintf_s(rdpsnd->channelDef.name, ARRAYSIZE(rdpsnd->channelDef.name),
1742 RDPSND_CHANNEL_NAME);
1743 pEntryPointsEx = (CHANNEL_ENTRY_POINTS_FREERDP_EX*)pEntryPoints;
1744
1745 if ((pEntryPointsEx->cbSize >= sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX)) &&
1746 (pEntryPointsEx->MagicNumber == FREERDP_CHANNEL_MAGIC_NUMBER))
1747 {
1748 rdpsnd->rdpcontext = pEntryPointsEx->context;
1749 if (!freerdp_settings_get_bool(rdpsnd->rdpcontext->settings,
1750 FreeRDP_SynchronousStaticChannels))
1751 rdpsnd->async = TRUE;
1752 }
1753
1754 CopyMemory(&(rdpsnd->channelEntryPoints), pEntryPoints,
1755 sizeof(CHANNEL_ENTRY_POINTS_FREERDP_EX));
1756 rdpsnd->InitHandle = pInitHandle;
1757
1758 WINPR_ASSERT(rdpsnd->channelEntryPoints.pVirtualChannelInitEx);
1759 rc = rdpsnd->channelEntryPoints.pVirtualChannelInitEx(
1760 rdpsnd, nullptr, pInitHandle, &rdpsnd->channelDef, 1, VIRTUAL_CHANNEL_VERSION_WIN2000,
1761 rdpsnd_virtual_channel_init_event_ex);
1762
1763 if (CHANNEL_RC_OK != rc)
1764 {
1765 WLog_ERR(TAG, "%s pVirtualChannelInitEx failed with %s [%08" PRIX32 "]",
1766 rdpsnd_is_dyn_str(FALSE), WTSErrorToString(rc), rc);
1767 rdpsnd_virtual_channel_event_terminated(rdpsnd);
1768 return FALSE;
1769 }
1770
1771 return TRUE;
1772}
1773
1774WINPR_ATTR_NODISCARD
1775static UINT rdpsnd_on_open(IWTSVirtualChannelCallback* pChannelCallback)
1776{
1777 GENERIC_CHANNEL_CALLBACK* callback = (GENERIC_CHANNEL_CALLBACK*)pChannelCallback;
1778 rdpsndPlugin* rdpsnd = nullptr;
1779
1780 WINPR_ASSERT(callback);
1781
1782 rdpsnd = (rdpsndPlugin*)callback->plugin;
1783 WINPR_ASSERT(rdpsnd);
1784
1785 if (rdpsnd->OnOpenCalled)
1786 return CHANNEL_RC_OK;
1787 rdpsnd->OnOpenCalled = TRUE;
1788
1789 if (!allocate_internals(rdpsnd))
1790 return ERROR_OUTOFMEMORY;
1791
1792 return rdpsnd_process_connect(rdpsnd);
1793}
1794
1795WINPR_ATTR_NODISCARD
1796static UINT rdpsnd_on_data_received(IWTSVirtualChannelCallback* pChannelCallback, wStream* data)
1797{
1798 GENERIC_CHANNEL_CALLBACK* callback = (GENERIC_CHANNEL_CALLBACK*)pChannelCallback;
1799 rdpsndPlugin* plugin = nullptr;
1800 wStream* copy = nullptr;
1801 size_t len = 0;
1802
1803 len = Stream_GetRemainingLength(data);
1804
1805 if (!callback || !callback->plugin)
1806 return ERROR_INVALID_PARAMETER;
1807 plugin = (rdpsndPlugin*)callback->plugin;
1808 WINPR_ASSERT(plugin);
1809
1810 copy = StreamPool_Take(plugin->pool, len);
1811 if (!copy)
1812 return ERROR_OUTOFMEMORY;
1813 Stream_Copy(data, copy, len);
1814 Stream_SealLength(copy);
1815 Stream_ResetPosition(copy);
1816
1817 if (plugin->async)
1818 {
1819 if (!MessageQueue_Post(plugin->queue, nullptr, 0, copy, nullptr))
1820 {
1821 Stream_Release(copy);
1822 return ERROR_INTERNAL_ERROR;
1823 }
1824 }
1825 else
1826 {
1827 UINT error = rdpsnd_recv_pdu(plugin, copy);
1828 if (error)
1829 return error;
1830 }
1831
1832 return CHANNEL_RC_OK;
1833}
1834
1835WINPR_ATTR_NODISCARD
1836static UINT rdpsnd_on_close(IWTSVirtualChannelCallback* pChannelCallback)
1837{
1838 GENERIC_CHANNEL_CALLBACK* callback = (GENERIC_CHANNEL_CALLBACK*)pChannelCallback;
1839
1840 WINPR_ASSERT(callback);
1841
1842 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)callback->plugin;
1843 WINPR_ASSERT(rdpsnd);
1844
1845 rdpsnd->OnOpenCalled = FALSE;
1846 if (rdpsnd->device)
1847 IFCALL(rdpsnd->device->Close, rdpsnd->device);
1848
1849 cleanup_internals(rdpsnd);
1850
1851 free_internals(rdpsnd);
1852 if (rdpsnd->device)
1853 {
1854 IFCALL(rdpsnd->device->Free, rdpsnd->device);
1855 rdpsnd->device = nullptr;
1856 }
1857
1858 free(pChannelCallback);
1859 rdpsnd->connected = FALSE;
1860 return CHANNEL_RC_OK;
1861}
1862
1863// NOLINTBEGIN(readability-non-const-parameter)
1864WINPR_ATTR_NODISCARD
1865static UINT rdpsnd_on_new_channel_connection(IWTSListenerCallback* pListenerCallback,
1866 IWTSVirtualChannel* pChannel, BYTE* Data,
1867 BOOL* pbAccept,
1868 IWTSVirtualChannelCallback** ppCallback)
1869// NOLINTEND(readability-non-const-parameter)
1870{
1871 GENERIC_LISTENER_CALLBACK* listener_callback = (GENERIC_LISTENER_CALLBACK*)pListenerCallback;
1872 WINPR_ASSERT(listener_callback);
1873 WINPR_ASSERT(pChannel);
1874 WINPR_ASSERT(ppCallback);
1875
1876 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)listener_callback->plugin;
1877 WINPR_ASSERT(rdpsnd);
1878
1879 if (rdpsnd->connected)
1880 {
1881 WLog_Print(rdpsnd->log, WLOG_ERROR, "Channel already connected, terminating.");
1882 return ERROR_DEVICE_ALREADY_ATTACHED;
1883 }
1884
1885 GENERIC_CHANNEL_CALLBACK* callback =
1886 (GENERIC_CHANNEL_CALLBACK*)calloc(1, sizeof(GENERIC_CHANNEL_CALLBACK));
1887
1888 WINPR_UNUSED(Data);
1889 WINPR_UNUSED(pbAccept);
1890
1891 if (!callback)
1892 {
1893 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1894 return CHANNEL_RC_NO_MEMORY;
1895 }
1896
1897 callback->iface.OnOpen = rdpsnd_on_open;
1898 callback->iface.OnDataReceived = rdpsnd_on_data_received;
1899 callback->iface.OnClose = rdpsnd_on_close;
1900 callback->plugin = listener_callback->plugin;
1901 callback->channel_mgr = listener_callback->channel_mgr;
1902 callback->channel = pChannel;
1903 listener_callback->channel_callback = callback;
1904 *ppCallback = &callback->iface;
1905 rdpsnd->connected = TRUE;
1906 return CHANNEL_RC_OK;
1907}
1908
1909WINPR_ATTR_NODISCARD
1910static UINT rdpsnd_plugin_initialize(IWTSPlugin* pPlugin, IWTSVirtualChannelManager* pChannelMgr)
1911{
1912 UINT status = 0;
1913 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)pPlugin;
1914 WINPR_ASSERT(rdpsnd);
1915 WINPR_ASSERT(pChannelMgr);
1916 if (rdpsnd->initialized)
1917 {
1918 WLog_ERR(TAG, "[%s] channel initialized twice, aborting", RDPSND_DVC_CHANNEL_NAME);
1919 return ERROR_INVALID_DATA;
1920 }
1921 rdpsnd->listener_callback =
1922 (GENERIC_LISTENER_CALLBACK*)calloc(1, sizeof(GENERIC_LISTENER_CALLBACK));
1923
1924 if (!rdpsnd->listener_callback)
1925 {
1926 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
1927 return CHANNEL_RC_NO_MEMORY;
1928 }
1929
1930 rdpsnd->listener_callback->iface.OnNewChannelConnection = rdpsnd_on_new_channel_connection;
1931 rdpsnd->listener_callback->plugin = pPlugin;
1932 rdpsnd->listener_callback->channel_mgr = pChannelMgr;
1933 status = pChannelMgr->CreateListener(pChannelMgr, RDPSND_DVC_CHANNEL_NAME, 0,
1934 &rdpsnd->listener_callback->iface, &(rdpsnd->listener));
1935 if (status != CHANNEL_RC_OK)
1936 {
1937 WLog_ERR(TAG, "%s CreateListener failed!", rdpsnd_is_dyn_str(TRUE));
1938 return status;
1939 }
1940
1941 rdpsnd->listener->pInterface = rdpsnd->iface.pInterface;
1942 status = rdpsnd_virtual_channel_event_initialized(rdpsnd);
1943
1944 rdpsnd->initialized = status == CHANNEL_RC_OK;
1945 return status;
1946}
1947
1953WINPR_ATTR_NODISCARD
1954static UINT rdpsnd_plugin_terminated(IWTSPlugin* pPlugin)
1955{
1956 rdpsndPlugin* rdpsnd = (rdpsndPlugin*)pPlugin;
1957 if (rdpsnd)
1958 {
1959 if (rdpsnd->listener_callback)
1960 {
1961 IWTSVirtualChannelManager* mgr = rdpsnd->listener_callback->channel_mgr;
1962 if (mgr)
1963 IFCALL(mgr->DestroyListener, mgr, rdpsnd->listener);
1964 }
1965 free(rdpsnd->listener_callback);
1966 free(rdpsnd->iface.pInterface);
1967 }
1968 rdpsnd_virtual_channel_event_terminated(rdpsnd);
1969 return CHANNEL_RC_OK;
1970}
1971
1977FREERDP_ENTRY_POINT(UINT VCAPITYPE rdpsnd_DVCPluginEntry(IDRDYNVC_ENTRY_POINTS* pEntryPoints))
1978{
1979 UINT error = CHANNEL_RC_OK;
1980
1981 WINPR_ASSERT(pEntryPoints);
1982 WINPR_ASSERT(pEntryPoints->GetPlugin);
1983
1984 rdpsndPlugin* rdpsnd =
1985 (rdpsndPlugin*)pEntryPoints->GetPlugin(pEntryPoints, RDPSND_CHANNEL_NAME);
1986
1987 if (!rdpsnd)
1988 {
1989 IWTSPlugin* iface = nullptr;
1990 union
1991 {
1992 const void* cev;
1993 void* ev;
1994 } cnv;
1995
1996 rdpsnd = allocatePlugin();
1997 if (!rdpsnd)
1998 {
1999 WLog_ERR(TAG, "%s calloc failed!", rdpsnd_is_dyn_str(TRUE));
2000 return CHANNEL_RC_NO_MEMORY;
2001 }
2002
2003 iface = &rdpsnd->iface;
2004 iface->Initialize = rdpsnd_plugin_initialize;
2005 iface->Connected = nullptr;
2006 iface->Disconnected = nullptr;
2007 iface->Terminated = rdpsnd_plugin_terminated;
2008
2009 rdpsnd->dynamic = TRUE;
2010
2011 WINPR_ASSERT(pEntryPoints->GetRdpContext);
2012 rdpsnd->rdpcontext = pEntryPoints->GetRdpContext(pEntryPoints);
2013
2014 if (!freerdp_settings_get_bool(rdpsnd->rdpcontext->settings,
2015 FreeRDP_SynchronousDynamicChannels))
2016 rdpsnd->async = TRUE;
2017
2018 /* user data pointer is not const, cast to avoid warning. */
2019 cnv.cev = pEntryPoints->GetPluginData(pEntryPoints);
2020 WINPR_ASSERT(pEntryPoints->GetPluginData);
2021 rdpsnd->channelEntryPoints.pExtendedData = cnv.ev;
2022
2023 error = pEntryPoints->RegisterPlugin(pEntryPoints, RDPSND_CHANNEL_NAME, iface);
2024 }
2025 else
2026 {
2027 WLog_ERR(TAG, "%s could not get rdpsnd Plugin.", rdpsnd_is_dyn_str(TRUE));
2028 return CHANNEL_RC_BAD_CHANNEL;
2029 }
2030
2031 return error;
2032}
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:396
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:46
GENERIC_LISTENER_CALLBACK
Definition include/freerdp/client/channels.h:54
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