2
* FreeRDP: A Remote Desktop Protocol client.
3
* Audio Output Virtual Channel
5
* Copyright 2011 Vic Lee
7
* Licensed under the Apache License, Version 2.0 (the "License");
8
* you may not use this file except in compliance with the License.
9
* You may obtain a copy of the License at
11
* http://www.apache.org/licenses/LICENSE-2.0
13
* Unless required by applicable law or agreed to in writing, software
14
* distributed under the License is distributed on an "AS IS" BASIS,
15
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
* See the License for the specific language governing permissions and
17
* limitations under the License.
23
#include <pulse/pulseaudio.h>
24
#include <freerdp/types.h>
25
#include <freerdp/utils/memory.h>
26
#include <freerdp/utils/dsp.h>
27
#include <freerdp/utils/svc_plugin.h>
29
#include "rdpsnd_main.h"
31
typedef struct rdpsnd_pulse_plugin rdpsndPulsePlugin;
32
struct rdpsnd_pulse_plugin
34
rdpsndDevicePlugin device;
37
pa_threaded_mainloop *mainloop;
39
pa_sample_spec sample_spec;
47
static void rdpsnd_pulse_context_state_callback(pa_context* context, void* userdata)
49
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)userdata;
50
pa_context_state_t state;
52
state = pa_context_get_state(context);
55
case PA_CONTEXT_READY:
56
DEBUG_SVC("PA_CONTEXT_READY");
57
pa_threaded_mainloop_signal(pulse->mainloop, 0);
60
case PA_CONTEXT_FAILED:
61
case PA_CONTEXT_TERMINATED:
62
DEBUG_SVC("PA_CONTEXT_FAILED/PA_CONTEXT_TERMINATED %d", (int)state);
63
pa_threaded_mainloop_signal(pulse->mainloop, 0);
67
DEBUG_SVC("state %d", (int)state);
72
static boolean rdpsnd_pulse_connect(rdpsndDevicePlugin* device)
74
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
75
pa_context_state_t state;
80
if (pa_context_connect(pulse->context, NULL, 0, NULL))
82
DEBUG_WARN("pa_context_connect failed (%d)", pa_context_errno(pulse->context));
85
pa_threaded_mainloop_lock(pulse->mainloop);
86
if (pa_threaded_mainloop_start(pulse->mainloop) < 0)
88
pa_threaded_mainloop_unlock(pulse->mainloop);
89
DEBUG_WARN("pa_threaded_mainloop_start failed (%d)", pa_context_errno(pulse->context));
94
state = pa_context_get_state(pulse->context);
95
if (state == PA_CONTEXT_READY)
97
if (!PA_CONTEXT_IS_GOOD(state))
99
DEBUG_WARN("bad context state (%d)", pa_context_errno(pulse->context));
102
pa_threaded_mainloop_wait(pulse->mainloop);
104
pa_threaded_mainloop_unlock(pulse->mainloop);
105
if (state == PA_CONTEXT_READY)
107
DEBUG_SVC("connected");
112
pa_context_disconnect(pulse->context);
117
static void rdpsnd_pulse_stream_success_callback(pa_stream* stream, int success, void* userdata)
119
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)userdata;
121
pa_threaded_mainloop_signal(pulse->mainloop, 0);
124
static void rdpsnd_pulse_wait_for_operation(rdpsndPulsePlugin* pulse, pa_operation* operation)
126
if (operation == NULL)
128
while (pa_operation_get_state(operation) == PA_OPERATION_RUNNING)
130
pa_threaded_mainloop_wait(pulse->mainloop);
132
pa_operation_unref(operation);
135
static void rdpsnd_pulse_stream_state_callback(pa_stream* stream, void* userdata)
137
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)userdata;
138
pa_stream_state_t state;
140
state = pa_stream_get_state(stream);
143
case PA_STREAM_READY:
144
DEBUG_SVC("PA_STREAM_READY");
145
pa_threaded_mainloop_signal(pulse->mainloop, 0);
148
case PA_STREAM_FAILED:
149
case PA_STREAM_TERMINATED:
150
DEBUG_SVC("state %d", (int)state);
151
pa_threaded_mainloop_signal(pulse->mainloop, 0);
155
DEBUG_SVC("state %d", (int)state);
160
static void rdpsnd_pulse_stream_request_callback(pa_stream* stream, size_t length, void* userdata)
162
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)userdata;
164
pa_threaded_mainloop_signal(pulse->mainloop, 0);
167
static void rdpsnd_pulse_close(rdpsndDevicePlugin* device)
169
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
171
if (!pulse->context || !pulse->stream)
174
pa_threaded_mainloop_lock(pulse->mainloop);
175
rdpsnd_pulse_wait_for_operation(pulse,
176
pa_stream_drain(pulse->stream, rdpsnd_pulse_stream_success_callback, pulse));
177
pa_stream_disconnect(pulse->stream);
178
pa_stream_unref(pulse->stream);
179
pulse->stream = NULL;
180
pa_threaded_mainloop_unlock(pulse->mainloop);
183
static void rdpsnd_pulse_set_format_spec(rdpsndPulsePlugin* pulse, rdpsndFormat* format)
185
pa_sample_spec sample_spec = { 0 };
190
sample_spec.rate = format->nSamplesPerSec;
191
sample_spec.channels = format->nChannels;
192
switch (format->wFormatTag)
195
switch (format->wBitsPerSample)
198
sample_spec.format = PA_SAMPLE_U8;
201
sample_spec.format = PA_SAMPLE_S16LE;
207
sample_spec.format = PA_SAMPLE_ALAW;
211
sample_spec.format = PA_SAMPLE_ULAW;
214
case 0x11: /* IMA ADPCM */
215
sample_spec.format = PA_SAMPLE_S16LE;
219
pulse->sample_spec = sample_spec;
220
pulse->format = format->wFormatTag;
221
pulse->block_size = format->nBlockAlign;
224
static void rdpsnd_pulse_open(rdpsndDevicePlugin* device, rdpsndFormat* format, int latency)
226
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
227
pa_stream_state_t state;
228
pa_stream_flags_t flags;
229
pa_buffer_attr buffer_attr = { 0 };
230
char ss[PA_SAMPLE_SPEC_SNPRINT_MAX];
232
if (!pulse->context || pulse->stream)
234
DEBUG_WARN("pulse stream has been created.");
238
rdpsnd_pulse_set_format_spec(pulse, format);
239
pulse->latency = latency;
241
if (pa_sample_spec_valid(&pulse->sample_spec) == 0)
243
pa_sample_spec_snprint(ss, sizeof(ss), &pulse->sample_spec);
244
DEBUG_WARN("Invalid sample spec %s", ss);
248
pa_threaded_mainloop_lock(pulse->mainloop);
249
pulse->stream = pa_stream_new(pulse->context, "freerdp",
250
&pulse->sample_spec, NULL);
253
pa_threaded_mainloop_unlock(pulse->mainloop);
254
DEBUG_WARN("pa_stream_new failed (%d)",
255
pa_context_errno(pulse->context));
259
/* install essential callbacks */
260
pa_stream_set_state_callback(pulse->stream,
261
rdpsnd_pulse_stream_state_callback, pulse);
262
pa_stream_set_write_callback(pulse->stream,
263
rdpsnd_pulse_stream_request_callback, pulse);
265
flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE;
266
if (pulse->latency > 0)
268
buffer_attr.maxlength = pa_usec_to_bytes(pulse->latency * 2 * 1000, &pulse->sample_spec);
269
buffer_attr.tlength = pa_usec_to_bytes(pulse->latency * 1000, &pulse->sample_spec);
270
buffer_attr.prebuf = (uint32_t) -1;
271
buffer_attr.minreq = (uint32_t) -1;
272
buffer_attr.fragsize = (uint32_t) -1;
273
flags |= PA_STREAM_ADJUST_LATENCY;
275
if (pa_stream_connect_playback(pulse->stream,
276
pulse->device_name, pulse->latency > 0 ? &buffer_attr : NULL, flags, NULL, NULL) < 0)
278
pa_threaded_mainloop_unlock(pulse->mainloop);
279
DEBUG_WARN("pa_stream_connect_playback failed (%d)",
280
pa_context_errno(pulse->context));
286
state = pa_stream_get_state(pulse->stream);
287
if (state == PA_STREAM_READY)
289
if (!PA_STREAM_IS_GOOD(state))
291
DEBUG_WARN("bad stream state (%d)",
292
pa_context_errno(pulse->context));
295
pa_threaded_mainloop_wait(pulse->mainloop);
297
pa_threaded_mainloop_unlock(pulse->mainloop);
298
if (state == PA_STREAM_READY)
300
memset(&pulse->adpcm, 0, sizeof(ADPCM));
301
DEBUG_SVC("connected");
305
rdpsnd_pulse_close(device);
309
static void rdpsnd_pulse_free(rdpsndDevicePlugin* device)
311
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
315
rdpsnd_pulse_close(device);
318
pa_threaded_mainloop_stop(pulse->mainloop);
322
pa_context_disconnect(pulse->context);
323
pa_context_unref(pulse->context);
324
pulse->context = NULL;
328
pa_threaded_mainloop_free(pulse->mainloop);
329
pulse->mainloop = NULL;
331
xfree(pulse->device_name);
335
static boolean rdpsnd_pulse_format_supported(rdpsndDevicePlugin* device, rdpsndFormat* format)
337
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
342
switch (format->wFormatTag)
345
if (format->cbSize == 0 &&
346
(format->nSamplesPerSec <= PA_RATE_MAX) &&
347
(format->wBitsPerSample == 8 || format->wBitsPerSample == 16) &&
348
(format->nChannels >= 1 && format->nChannels <= PA_CHANNELS_MAX))
356
if (format->cbSize == 0 &&
357
(format->nSamplesPerSec <= PA_RATE_MAX) &&
358
(format->wBitsPerSample == 8) &&
359
(format->nChannels >= 1 && format->nChannels <= PA_CHANNELS_MAX))
365
case 0x11: /* IMA ADPCM */
366
if ((format->nSamplesPerSec <= PA_RATE_MAX) &&
367
(format->wBitsPerSample == 4) &&
368
(format->nChannels == 1 || format->nChannels == 2))
377
static void rdpsnd_pulse_set_format(rdpsndDevicePlugin* device, rdpsndFormat* format, int latency)
379
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
383
pa_threaded_mainloop_lock(pulse->mainloop);
384
pa_stream_disconnect(pulse->stream);
385
pa_stream_unref(pulse->stream);
386
pulse->stream = NULL;
387
pa_threaded_mainloop_unlock(pulse->mainloop);
389
rdpsnd_pulse_open(device, format, latency);
392
static void rdpsnd_pulse_set_volume(rdpsndDevicePlugin* device, uint32 value)
396
static void rdpsnd_pulse_play(rdpsndDevicePlugin* device, uint8* data, int size)
398
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
408
if (pulse->format == 0x11)
410
decoded_data = dsp_decode_ima_adpcm(&pulse->adpcm,
411
data, size, pulse->sample_spec.channels, pulse->block_size, &decoded_size);
421
pa_threaded_mainloop_lock(pulse->mainloop);
424
while ((len = pa_stream_writable_size(pulse->stream)) == 0)
426
pa_threaded_mainloop_wait(pulse->mainloop);
432
ret = pa_stream_write(pulse->stream, src, len, NULL, 0LL, PA_SEEK_RELATIVE);
435
DEBUG_WARN("pa_stream_write failed (%d)",
436
pa_context_errno(pulse->context));
442
pa_threaded_mainloop_unlock(pulse->mainloop);
448
static void rdpsnd_pulse_start(rdpsndDevicePlugin* device)
450
rdpsndPulsePlugin* pulse = (rdpsndPulsePlugin*)device;
455
pa_stream_trigger(pulse->stream, NULL, NULL);
458
int FreeRDPRdpsndDeviceEntry(PFREERDP_RDPSND_DEVICE_ENTRY_POINTS pEntryPoints)
460
rdpsndPulsePlugin* pulse;
461
RDP_PLUGIN_DATA* data;
463
pulse = xnew(rdpsndPulsePlugin);
465
pulse->device.Open = rdpsnd_pulse_open;
466
pulse->device.FormatSupported = rdpsnd_pulse_format_supported;
467
pulse->device.SetFormat = rdpsnd_pulse_set_format;
468
pulse->device.SetVolume = rdpsnd_pulse_set_volume;
469
pulse->device.Play = rdpsnd_pulse_play;
470
pulse->device.Start = rdpsnd_pulse_start;
471
pulse->device.Close = rdpsnd_pulse_close;
472
pulse->device.Free = rdpsnd_pulse_free;
474
data = pEntryPoints->plugin_data;
475
if (data && strcmp((char*)data->data[0], "pulse") == 0)
477
if(strlen((char*)data->data[1]) > 0)
478
pulse->device_name = xstrdup((char*)data->data[1]);
480
pulse->device_name = NULL;
483
pulse->mainloop = pa_threaded_mainloop_new();
484
if (!pulse->mainloop)
486
DEBUG_WARN("pa_threaded_mainloop_new failed");
487
rdpsnd_pulse_free((rdpsndDevicePlugin*)pulse);
490
pulse->context = pa_context_new(pa_threaded_mainloop_get_api(pulse->mainloop), "freerdp");
493
DEBUG_WARN("pa_context_new failed");
494
rdpsnd_pulse_free((rdpsndDevicePlugin*)pulse);
497
pa_context_set_state_callback(pulse->context, rdpsnd_pulse_context_state_callback, pulse);
498
if (!rdpsnd_pulse_connect((rdpsndDevicePlugin*)pulse))
500
DEBUG_WARN("rdpsnd_pulse_connect failed");
501
rdpsnd_pulse_free((rdpsndDevicePlugin*)pulse);
505
pEntryPoints->pRegisterRdpsndDevice(pEntryPoints->rdpsnd, (rdpsndDevicePlugin*)pulse);