2 * OpenAL cross platform audio library
3 * Copyright (C) 2009 by Konstantinos Natsakis <konstantinos.natsakis@gmail.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 * Or go to http://www.gnu.org/copyleft/lgpl.html
28 #include <pulse/pulseaudio.h>
30 #if PA_API_VERSION == 11
31 #define PA_STREAM_ADJUST_LATENCY 0x2000U
32 static inline int PA_STREAM_IS_GOOD(pa_stream_state_t x
)
34 return (x
== PA_STREAM_CREATING
|| x
== PA_STREAM_READY
);
36 static inline int PA_CONTEXT_IS_GOOD(pa_context_state_t x
)
38 return (x
== PA_CONTEXT_CONNECTING
|| x
== PA_CONTEXT_AUTHORIZING
||
39 x
== PA_CONTEXT_SETTING_NAME
|| x
== PA_CONTEXT_READY
);
41 #define PA_STREAM_IS_GOOD PA_STREAM_IS_GOOD
42 #define PA_CONTEXT_IS_GOOD PA_CONTEXT_IS_GOOD
43 #elif PA_API_VERSION != 12
44 #error Invalid PulseAudio API version
47 static void *pa_handle
;
48 #define MAKE_FUNC(x) static typeof(x) * p##x
49 MAKE_FUNC(pa_context_unref
);
50 MAKE_FUNC(pa_sample_spec_valid
);
51 MAKE_FUNC(pa_stream_drop
);
52 MAKE_FUNC(pa_strerror
);
53 MAKE_FUNC(pa_context_get_state
);
54 MAKE_FUNC(pa_stream_get_state
);
55 MAKE_FUNC(pa_threaded_mainloop_signal
);
56 MAKE_FUNC(pa_stream_peek
);
57 MAKE_FUNC(pa_threaded_mainloop_wait
);
58 MAKE_FUNC(pa_threaded_mainloop_unlock
);
59 MAKE_FUNC(pa_threaded_mainloop_in_thread
);
60 MAKE_FUNC(pa_context_new
);
61 MAKE_FUNC(pa_threaded_mainloop_stop
);
62 MAKE_FUNC(pa_context_disconnect
);
63 MAKE_FUNC(pa_threaded_mainloop_start
);
64 MAKE_FUNC(pa_threaded_mainloop_get_api
);
65 MAKE_FUNC(pa_context_set_state_callback
);
66 MAKE_FUNC(pa_stream_write
);
68 MAKE_FUNC(pa_stream_connect_record
);
69 MAKE_FUNC(pa_stream_connect_playback
);
70 MAKE_FUNC(pa_path_get_filename
);
71 MAKE_FUNC(pa_get_binary_name
);
72 MAKE_FUNC(pa_threaded_mainloop_free
);
73 MAKE_FUNC(pa_context_errno
);
74 MAKE_FUNC(pa_xmalloc0
);
75 MAKE_FUNC(pa_stream_unref
);
76 MAKE_FUNC(pa_threaded_mainloop_accept
);
77 MAKE_FUNC(pa_stream_set_write_callback
);
78 MAKE_FUNC(pa_threaded_mainloop_new
);
79 MAKE_FUNC(pa_context_connect
);
80 MAKE_FUNC(pa_stream_get_buffer_attr
);
81 MAKE_FUNC(pa_stream_set_buffer_attr_callback
);
82 MAKE_FUNC(pa_stream_set_read_callback
);
83 MAKE_FUNC(pa_stream_set_state_callback
);
84 MAKE_FUNC(pa_stream_new
);
85 MAKE_FUNC(pa_stream_disconnect
);
86 MAKE_FUNC(pa_threaded_mainloop_lock
);
102 char path_name
[PATH_MAX
];
103 const char *context_name
;
104 const char *stream_name
;
106 pa_threaded_mainloop
*loop
;
112 static const ALCchar pulse_device
[] = "PulseAudio Software";
113 static const ALCchar pulse_capture_device
[] = "PulseAudio Capture";
114 static volatile ALuint load_count
;
117 void pulse_load(void) //{{{
122 pa_handle
= LoadLibrary("libpulse-0.dll");
123 #define LOAD_FUNC(x) do { \
124 p##x = GetProcAddress(pa_handle, #x); \
126 AL_PRINT("Could not load %s from libpulse-0.dll\n", #x); \
127 FreeLibrary(pa_handle); \
133 #elif defined (HAVE_DLFCN_H)
136 #if defined(__APPLE__) && defined(__MACH__)
137 pa_handle
= dlopen("libpulse.0.dylib", RTLD_NOW
);
139 pa_handle
= dlopen("libpulse.so.0", RTLD_NOW
);
143 #define LOAD_FUNC(x) do { \
144 p##x = dlsym(pa_handle, #x); \
145 if((err=dlerror()) != NULL) { \
146 AL_PRINT("Could not load %s from libpulse: %s\n", #x, err); \
147 dlclose(pa_handle); \
155 pa_handle
= (void*)0xDEADBEEF;
156 #define LOAD_FUNC(x) p##x = (x)
162 LOAD_FUNC(pa_context_unref
);
163 LOAD_FUNC(pa_sample_spec_valid
);
164 LOAD_FUNC(pa_stream_drop
);
165 LOAD_FUNC(pa_strerror
);
166 LOAD_FUNC(pa_context_get_state
);
167 LOAD_FUNC(pa_stream_get_state
);
168 LOAD_FUNC(pa_threaded_mainloop_signal
);
169 LOAD_FUNC(pa_stream_peek
);
170 LOAD_FUNC(pa_threaded_mainloop_wait
);
171 LOAD_FUNC(pa_threaded_mainloop_unlock
);
172 LOAD_FUNC(pa_threaded_mainloop_in_thread
);
173 LOAD_FUNC(pa_context_new
);
174 LOAD_FUNC(pa_threaded_mainloop_stop
);
175 LOAD_FUNC(pa_context_disconnect
);
176 LOAD_FUNC(pa_threaded_mainloop_start
);
177 LOAD_FUNC(pa_threaded_mainloop_get_api
);
178 LOAD_FUNC(pa_context_set_state_callback
);
179 LOAD_FUNC(pa_stream_write
);
181 LOAD_FUNC(pa_stream_connect_record
);
182 LOAD_FUNC(pa_stream_connect_playback
);
183 LOAD_FUNC(pa_path_get_filename
);
184 LOAD_FUNC(pa_get_binary_name
);
185 LOAD_FUNC(pa_threaded_mainloop_free
);
186 LOAD_FUNC(pa_context_errno
);
187 LOAD_FUNC(pa_xmalloc0
);
188 LOAD_FUNC(pa_stream_unref
);
189 LOAD_FUNC(pa_threaded_mainloop_accept
);
190 LOAD_FUNC(pa_stream_set_write_callback
);
191 LOAD_FUNC(pa_threaded_mainloop_new
);
192 LOAD_FUNC(pa_context_connect
);
193 LOAD_FUNC(pa_stream_get_buffer_attr
);
194 LOAD_FUNC(pa_stream_set_buffer_attr_callback
);
195 LOAD_FUNC(pa_stream_set_read_callback
);
196 LOAD_FUNC(pa_stream_set_state_callback
);
197 LOAD_FUNC(pa_stream_new
);
198 LOAD_FUNC(pa_stream_disconnect
);
199 LOAD_FUNC(pa_threaded_mainloop_lock
);
206 void pulse_unload(void) //{{{
208 if(load_count
== 0 || --load_count
> 0)
212 FreeLibrary(pa_handle
);
213 #elif defined (HAVE_DLFCN_H)
220 // PulseAudio Event Callbacks //{{{
221 static void context_state_callback(pa_context
*context
, void *pdata
) //{{{
223 ALCdevice
*Device
= pdata
;
224 pulse_data
*data
= Device
->ExtraData
;
227 if(ppa_threaded_mainloop_in_thread(data
->loop
))
228 ppa_threaded_mainloop_signal(data
->loop
, 1);
231 static void stream_state_callback(pa_stream
*stream
, void *pdata
) //{{{
233 ALCdevice
*Device
= pdata
;
234 pulse_data
*data
= Device
->ExtraData
;
237 if(ppa_threaded_mainloop_in_thread(data
->loop
))
238 ppa_threaded_mainloop_signal(data
->loop
, 1);
241 static void stream_buffer_attr_callback(pa_stream
*stream
, void *pdata
) //{{{
243 ALCdevice
*Device
= pdata
;
244 pulse_data
*data
= Device
->ExtraData
;
246 SuspendContext(NULL
);
248 data
->attr
= *(ppa_stream_get_buffer_attr(stream
));
249 if((data
->attr
.tlength
%data
->attr
.minreq
) != 0)
250 AL_PRINT("new tlength (%d) is not a multiple of minreq (%d)!\n",
251 data
->attr
.tlength
, data
->attr
.minreq
);
252 Device
->UpdateSize
= data
->attr
.minreq
;
253 Device
->NumUpdates
= data
->attr
.tlength
/data
->attr
.minreq
;
255 ProcessContext(NULL
);
259 // PulseAudio I/O Callbacks //{{{
260 static void stream_write_callback(pa_stream
*stream
, size_t len
, void *pdata
) //{{{
262 ALCdevice
*Device
= pdata
;
263 pulse_data
*data
= Device
->ExtraData
;
265 len
-= len
&data
->attr
.minreq
;
268 void *buf
= ppa_xmalloc0(len
);
269 aluMixData(Device
, buf
, len
/data
->frame_size
);
270 ppa_stream_write(stream
, buf
, len
, ppa_xfree
, 0, PA_SEEK_RELATIVE
);
274 static void stream_read_callback(pa_stream
*stream
, size_t length
, void *pdata
) //{{{
276 ALCdevice
*Device
= pdata
;
277 pulse_data
*data
= Device
->ExtraData
;
280 if(ppa_stream_peek(stream
, &buf
, &length
) < 0)
282 AL_PRINT("pa_stream_peek() failed: %s\n",
283 ppa_strerror(ppa_context_errno(data
->context
)));
290 length
/= data
->frame_size
;
292 if(data
->samples
< length
)
293 AL_PRINT("stream_read_callback: buffer overflow!\n");
295 WriteRingBuffer(data
->ring
, buf
, (length
<data
->samples
) ? length
: data
->samples
);
297 ppa_stream_drop(stream
);
301 static ALCboolean
pulse_open(ALCdevice
*device
, const ALCchar
*device_name
) //{{{
303 pulse_data
*data
= ppa_xmalloc0(sizeof(pulse_data
));
304 pa_context_state_t state
;
306 if(ppa_get_binary_name(data
->path_name
, sizeof(data
->path_name
)))
307 data
->context_name
= ppa_path_get_filename(data
->path_name
);
309 data
->context_name
= "OpenAL Soft";
311 if(!(data
->loop
= ppa_threaded_mainloop_new()))
313 AL_PRINT("pa_threaded_mainloop_new() failed!\n");
317 if(ppa_threaded_mainloop_start(data
->loop
) < 0)
319 AL_PRINT("pa_threaded_mainloop_start() failed\n");
323 ppa_threaded_mainloop_lock(data
->loop
);
324 device
->ExtraData
= data
;
326 data
->context
= ppa_context_new(ppa_threaded_mainloop_get_api(data
->loop
), data
->context_name
);
329 AL_PRINT("pa_context_new() failed: %s\n",
330 ppa_strerror(ppa_context_errno(data
->context
)));
332 ppa_threaded_mainloop_unlock(data
->loop
);
336 ppa_context_set_state_callback(data
->context
, context_state_callback
, device
);
338 if(ppa_context_connect(data
->context
, NULL
, PA_CONTEXT_NOAUTOSPAWN
, NULL
) < 0)
340 AL_PRINT("Context did not connect: %s\n",
341 ppa_strerror(ppa_context_errno(data
->context
)));
343 ppa_context_unref(data
->context
);
344 data
->context
= NULL
;
346 ppa_threaded_mainloop_unlock(data
->loop
);
350 while((state
=ppa_context_get_state(data
->context
)) != PA_CONTEXT_READY
)
352 if(!PA_CONTEXT_IS_GOOD(state
))
354 AL_PRINT("Context did not get ready: %s\n",
355 ppa_strerror(ppa_context_errno(data
->context
)));
357 ppa_context_unref(data
->context
);
358 data
->context
= NULL
;
360 ppa_threaded_mainloop_unlock(data
->loop
);
364 ppa_threaded_mainloop_wait(data
->loop
);
365 ppa_threaded_mainloop_accept(data
->loop
);
367 ppa_context_set_state_callback(data
->context
, NULL
, NULL
);
369 device
->szDeviceName
= strdup(device_name
);
371 ppa_threaded_mainloop_unlock(data
->loop
);
377 ppa_threaded_mainloop_stop(data
->loop
);
378 ppa_threaded_mainloop_free(data
->loop
);
381 device
->ExtraData
= NULL
;
386 static void pulse_close(ALCdevice
*device
) //{{{
388 pulse_data
*data
= device
->ExtraData
;
390 ppa_threaded_mainloop_lock(data
->loop
);
394 ppa_stream_disconnect(data
->stream
);
395 ppa_stream_unref(data
->stream
);
398 ppa_context_disconnect(data
->context
);
399 ppa_context_unref(data
->context
);
401 ppa_threaded_mainloop_unlock(data
->loop
);
403 ppa_threaded_mainloop_stop(data
->loop
);
404 ppa_threaded_mainloop_free(data
->loop
);
406 DestroyRingBuffer(data
->ring
);
408 device
->ExtraData
= NULL
;
414 static ALCboolean
pulse_open_playback(ALCdevice
*device
, const ALCchar
*device_name
) //{{{
417 device_name
= pulse_device
;
418 else if(strcmp(device_name
, pulse_device
) != 0)
425 if(pulse_open(device
, device_name
) != ALC_FALSE
)
432 static void pulse_close_playback(ALCdevice
*device
) //{{{
438 static ALCboolean
pulse_reset_playback(ALCdevice
*device
) //{{{
440 pulse_data
*data
= device
->ExtraData
;
441 pa_stream_state_t state
;
443 ppa_threaded_mainloop_lock(data
->loop
);
445 data
->frame_size
= aluBytesFromFormat(device
->Format
) *
446 aluChannelsFromFormat(device
->Format
);
447 data
->attr
.minreq
= data
->frame_size
* device
->UpdateSize
;
448 data
->attr
.prebuf
= -1;
449 data
->attr
.maxlength
= -1;
450 data
->attr
.fragsize
= -1;
451 data
->attr
.tlength
= data
->attr
.minreq
* device
->NumUpdates
;
452 data
->stream_name
= "Playback Stream";
454 switch(aluBytesFromFormat(device
->Format
))
457 data
->spec
.format
= PA_SAMPLE_U8
;
460 data
->spec
.format
= PA_SAMPLE_S16NE
;
463 data
->spec
.format
= PA_SAMPLE_FLOAT32NE
;
466 AL_PRINT("Unknown format: 0x%x\n", device
->Format
);
467 ppa_threaded_mainloop_unlock(data
->loop
);
470 data
->spec
.rate
= device
->Frequency
;
471 data
->spec
.channels
= aluChannelsFromFormat(device
->Format
);
473 if(ppa_sample_spec_valid(&data
->spec
) == 0)
475 AL_PRINT("Invalid sample format\n");
476 ppa_threaded_mainloop_unlock(data
->loop
);
480 data
->stream
= ppa_stream_new(data
->context
, data
->stream_name
, &data
->spec
, NULL
);
483 AL_PRINT("pa_stream_new() failed: %s\n",
484 ppa_strerror(ppa_context_errno(data
->context
)));
486 ppa_threaded_mainloop_unlock(data
->loop
);
490 ppa_stream_set_state_callback(data
->stream
, stream_state_callback
, device
);
491 ppa_stream_set_write_callback(data
->stream
, stream_write_callback
, device
);
493 if(ppa_stream_connect_playback(data
->stream
, NULL
, &data
->attr
, PA_STREAM_ADJUST_LATENCY
, NULL
, NULL
) < 0)
495 AL_PRINT("Stream did not connect: %s\n",
496 ppa_strerror(ppa_context_errno(data
->context
)));
498 ppa_stream_unref(data
->stream
);
501 ppa_threaded_mainloop_unlock(data
->loop
);
505 while((state
=ppa_stream_get_state(data
->stream
)) != PA_STREAM_READY
)
507 if(!PA_STREAM_IS_GOOD(state
))
509 AL_PRINT("Stream did not get ready: %s\n",
510 ppa_strerror(ppa_context_errno(data
->context
)));
512 ppa_stream_unref(data
->stream
);
515 ppa_threaded_mainloop_unlock(data
->loop
);
519 ppa_threaded_mainloop_wait(data
->loop
);
520 ppa_threaded_mainloop_accept(data
->loop
);
522 ppa_stream_set_state_callback(data
->stream
, NULL
, NULL
);
524 stream_buffer_attr_callback(data
->stream
, device
);
525 ppa_stream_set_buffer_attr_callback(data
->stream
, stream_buffer_attr_callback
, device
);
527 ppa_threaded_mainloop_unlock(data
->loop
);
531 static void pulse_stop_playback(ALCdevice
*device
) //{{{
533 pulse_data
*data
= device
->ExtraData
;
538 ppa_threaded_mainloop_lock(data
->loop
);
540 ppa_stream_disconnect(data
->stream
);
541 ppa_stream_unref(data
->stream
);
544 ppa_threaded_mainloop_unlock(data
->loop
);
548 static ALCboolean
pulse_open_capture(ALCdevice
*device
, const ALCchar
*device_name
) //{{{
551 pa_stream_state_t state
;
554 device_name
= pulse_capture_device
;
555 else if(strcmp(device_name
, pulse_capture_device
) != 0)
562 if(pulse_open(device
, device_name
) == ALC_FALSE
)
568 data
= device
->ExtraData
;
569 ppa_threaded_mainloop_lock(data
->loop
);
571 data
->samples
= device
->UpdateSize
* device
->NumUpdates
;
572 data
->frame_size
= aluBytesFromFormat(device
->Format
) *
573 aluChannelsFromFormat(device
->Format
);
575 if(!(data
->ring
= CreateRingBuffer(data
->frame_size
, data
->samples
)))
577 ppa_threaded_mainloop_unlock(data
->loop
);
583 data
->attr
.minreq
= -1;
584 data
->attr
.prebuf
= -1;
585 data
->attr
.maxlength
= -1;
586 data
->attr
.tlength
= -1;
587 data
->attr
.fragsize
= data
->frame_size
* data
->samples
/ 2;
588 data
->stream_name
= "Capture Stream";
590 data
->spec
.rate
= device
->Frequency
;
591 data
->spec
.channels
= aluChannelsFromFormat(device
->Format
);
593 switch(aluBytesFromFormat(device
->Format
))
596 data
->spec
.format
= PA_SAMPLE_U8
;
599 data
->spec
.format
= PA_SAMPLE_S16NE
;
602 data
->spec
.format
= PA_SAMPLE_FLOAT32NE
;
605 AL_PRINT("Unknown format: 0x%x\n", device
->Format
);
606 ppa_threaded_mainloop_unlock(data
->loop
);
612 if(ppa_sample_spec_valid(&data
->spec
) == 0)
614 AL_PRINT("Invalid sample format\n");
615 ppa_threaded_mainloop_unlock(data
->loop
);
621 data
->stream
= ppa_stream_new(data
->context
, data
->stream_name
, &data
->spec
, NULL
);
624 AL_PRINT("pa_stream_new() failed: %s\n",
625 ppa_strerror(ppa_context_errno(data
->context
)));
627 ppa_threaded_mainloop_unlock(data
->loop
);
633 ppa_stream_set_state_callback(data
->stream
, stream_state_callback
, device
);
635 if(ppa_stream_connect_record(data
->stream
, NULL
, &data
->attr
, PA_STREAM_ADJUST_LATENCY
) < 0)
637 AL_PRINT("Stream did not connect: %s\n",
638 ppa_strerror(ppa_context_errno(data
->context
)));
640 ppa_stream_unref(data
->stream
);
641 ppa_threaded_mainloop_unlock(data
->loop
);
649 while((state
=ppa_stream_get_state(data
->stream
)) != PA_STREAM_READY
)
651 if(!PA_STREAM_IS_GOOD(state
))
653 AL_PRINT("Stream did not get ready: %s\n",
654 ppa_strerror(ppa_context_errno(data
->context
)));
656 ppa_stream_unref(data
->stream
);
657 ppa_threaded_mainloop_unlock(data
->loop
);
665 ppa_threaded_mainloop_wait(data
->loop
);
666 ppa_threaded_mainloop_accept(data
->loop
);
668 ppa_stream_set_state_callback(data
->stream
, NULL
, NULL
);
670 ppa_threaded_mainloop_unlock(data
->loop
);
674 static void pulse_close_capture(ALCdevice
*device
) //{{{
680 static void pulse_start_capture(ALCdevice
*device
) //{{{
682 pulse_data
*data
= device
->ExtraData
;
684 ppa_threaded_mainloop_lock(data
->loop
);
685 ppa_stream_set_read_callback(data
->stream
, stream_read_callback
, device
);
686 ppa_threaded_mainloop_unlock(data
->loop
);
689 static void pulse_stop_capture(ALCdevice
*device
) //{{{
691 pulse_data
*data
= device
->ExtraData
;
693 ppa_threaded_mainloop_lock(data
->loop
);
694 ppa_stream_set_read_callback(data
->stream
, NULL
, NULL
);
695 ppa_threaded_mainloop_unlock(data
->loop
);
698 static void pulse_capture_samples(ALCdevice
*device
, ALCvoid
*buffer
, ALCuint samples
) //{{{
700 pulse_data
*data
= device
->ExtraData
;
701 ALCuint available
= RingBufferSize(data
->ring
);
703 if(available
< samples
)
704 alcSetError(ALC_INVALID_VALUE
);
706 ReadRingBuffer(data
->ring
, buffer
, samples
);
709 static ALCuint
pulse_available_samples(ALCdevice
*device
) //{{{
711 pulse_data
*data
= device
->ExtraData
;
712 return RingBufferSize(data
->ring
);
715 BackendFuncs pulse_funcs
= { //{{{
717 pulse_close_playback
,
718 pulse_reset_playback
,
724 pulse_capture_samples
,
725 pulse_available_samples
728 void alc_pulse_init(BackendFuncs
*func_list
) //{{{
730 *func_list
= pulse_funcs
;
733 void alc_pulse_deinit(void) //{{{
737 void alc_pulse_probe(int type
) //{{{
740 if(!pa_handle
) return;
742 if(type
== DEVICE_PROBE
)
743 AppendDeviceList(pulse_device
);
744 else if(type
== ALL_DEVICE_PROBE
)
745 AppendAllDeviceList(pulse_device
);
746 else if(type
== CAPTURE_DEVICE_PROBE
)
747 AppendCaptureDeviceList(pulse_capture_device
);