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