Modify some context checks
[openal-soft.git] / Alc / pulseaudio.c
blob3eac26cbb02c23cd619bffd81b9a2deb4cc8cfe9
1 /**
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
21 #include "config.h"
23 #include "alMain.h"
24 #ifdef HAVE_DLFCN_H
25 #include <dlfcn.h>
26 #endif
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
45 #endif
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_context_new);
60 MAKE_FUNC(pa_threaded_mainloop_stop);
61 MAKE_FUNC(pa_context_disconnect);
62 MAKE_FUNC(pa_threaded_mainloop_start);
63 MAKE_FUNC(pa_threaded_mainloop_get_api);
64 MAKE_FUNC(pa_context_set_state_callback);
65 MAKE_FUNC(pa_stream_write);
66 MAKE_FUNC(pa_xfree);
67 MAKE_FUNC(pa_stream_connect_record);
68 MAKE_FUNC(pa_stream_connect_playback);
69 MAKE_FUNC(pa_path_get_filename);
70 MAKE_FUNC(pa_get_binary_name);
71 MAKE_FUNC(pa_threaded_mainloop_free);
72 MAKE_FUNC(pa_context_errno);
73 MAKE_FUNC(pa_xmalloc0);
74 MAKE_FUNC(pa_stream_unref);
75 MAKE_FUNC(pa_threaded_mainloop_accept);
76 MAKE_FUNC(pa_stream_set_write_callback);
77 MAKE_FUNC(pa_threaded_mainloop_new);
78 MAKE_FUNC(pa_context_connect);
79 MAKE_FUNC(pa_stream_set_read_callback);
80 MAKE_FUNC(pa_stream_set_state_callback);
81 MAKE_FUNC(pa_stream_new);
82 MAKE_FUNC(pa_stream_disconnect);
83 MAKE_FUNC(pa_threaded_mainloop_lock);
84 #undef MAKE_FUNC
86 typedef struct {
87 ALCdevice *device;
89 ALCuint samples;
90 ALCuint frame_size;
92 RingBuffer *ring;
94 pa_buffer_attr attr;
95 pa_sample_spec spec;
97 char path_name[PATH_MAX];
98 const char *context_name;
99 const char *stream_name;
101 pa_threaded_mainloop *loop;
103 pa_stream *stream;
104 pa_context *context;
105 } pulse_data;
107 static char *pulse_device;
108 static char *pulse_capture_device;
110 // PulseAudio Event Callbacks {{{
111 static void stream_state_callback(pa_stream *stream, void *pdata) //{{{
113 pulse_data *data = pdata;
115 switch(ppa_stream_get_state(stream))
117 case PA_STREAM_READY:
118 AL_PRINT("%s: %s ready!\n", data->context_name, data->stream_name);
119 break;
121 case PA_STREAM_FAILED:
122 AL_PRINT("%s: %s: Connection failed: %s\n", data->context_name,
123 data->stream_name, ppa_strerror(ppa_context_errno(data->context)));
124 break;
126 case PA_STREAM_TERMINATED:
127 AL_PRINT("%s: %s terminated!\n", data->context_name, data->stream_name);
128 break;
130 default:
131 break;
134 ppa_threaded_mainloop_signal(data->loop, 1);
135 } //}}}
137 static void context_state_callback(pa_context *context, void *pdata) //{{{
139 pulse_data *data = pdata;
141 switch(ppa_context_get_state(context))
143 case PA_CONTEXT_READY:
144 AL_PRINT("%s ready!\n", data->context_name);
145 break;
147 case PA_CONTEXT_FAILED:
148 AL_PRINT("%s: Connection failed: %s\n", data->context_name,
149 ppa_strerror(ppa_context_errno(context)));
150 break;
152 case PA_CONTEXT_TERMINATED:
153 AL_PRINT("%s terminated!\n", data->context_name);
154 break;
156 default:
157 break;
160 ppa_threaded_mainloop_signal(data->loop, 1);
161 } //}}}
162 //}}}
164 // PulseAudio I/O Callbacks //{{{
165 static void stream_write_callback(pa_stream *stream, size_t len, void *pdata) //{{{
167 ALCdevice *Device = pdata;
168 void *buf = ppa_xmalloc0(len);
170 SuspendContext(NULL);
171 aluMixData(Device->Context, buf, len, Device->Format);
172 ProcessContext(NULL);
174 ppa_stream_write(stream, buf, len, ppa_xfree, 0, PA_SEEK_RELATIVE);
175 } //}}}
177 static void stream_read_callback(pa_stream *stream, size_t length, void *pdata) //{{{
179 ALCdevice *Device = pdata;
180 pulse_data *data = Device->ExtraData;
181 const void *buf;
183 if(ppa_stream_peek(stream, &buf, &length) < 0)
185 AL_PRINT("pa_stream_peek() failed: %s\n",
186 ppa_strerror(ppa_context_errno(data->context)));
187 return;
190 assert(buf);
191 assert(length);
193 length /= data->frame_size;
195 if(data->samples < length)
196 AL_PRINT("stream_read_callback: buffer overflow!\n");
198 WriteRingBuffer(data->ring, buf, (length<data->samples) ? length : data->samples);
200 ppa_stream_drop(stream);
201 } //}}}
202 //}}}
204 static ALCboolean pulse_open(ALCdevice *device, ALCchar *device_name) //{{{
206 pulse_data *data = ppa_xmalloc0(sizeof(pulse_data));
208 data->device = device;
210 if(ppa_get_binary_name(data->path_name, sizeof(data->path_name)))
211 data->context_name = ppa_path_get_filename(data->path_name);
212 else
213 data->context_name = "OpenAL Soft";
215 device->ExtraData = data;
216 device->szDeviceName = device_name;
218 if(!(data->loop = ppa_threaded_mainloop_new()))
220 AL_PRINT("pa_threaded_mainloop_new() failed!\n");
221 goto out;
224 if(ppa_threaded_mainloop_start(data->loop) < 0)
226 AL_PRINT("pa_threaded_mainloop_start() failed\n");
227 goto out;
230 ppa_threaded_mainloop_lock(data->loop);
232 data->context = ppa_context_new(ppa_threaded_mainloop_get_api(data->loop), data->context_name);
233 if(!data->context)
235 AL_PRINT("pa_context_new() failed: %s\n",
236 ppa_strerror(ppa_context_errno(data->context)));
238 ppa_threaded_mainloop_unlock(data->loop);
239 goto out;
242 ppa_context_set_state_callback(data->context, context_state_callback, data);
244 if(ppa_context_connect(data->context, NULL, PA_CONTEXT_NOAUTOSPAWN, NULL) < 0)
246 AL_PRINT("Context did not connect: %s\n",
247 ppa_strerror(ppa_context_errno(data->context)));
249 ppa_context_unref(data->context);
250 data->context = NULL;
252 ppa_threaded_mainloop_unlock(data->loop);
253 goto out;
256 while(ppa_context_get_state(data->context) != PA_CONTEXT_READY)
258 if(!PA_CONTEXT_IS_GOOD(ppa_context_get_state(data->context)))
260 AL_PRINT("Context did not get ready: %s\n",
261 ppa_strerror(ppa_context_errno(data->context)));
263 ppa_context_unref(data->context);
264 data->context = NULL;
266 ppa_threaded_mainloop_unlock(data->loop);
267 goto out;
270 ppa_threaded_mainloop_wait(data->loop);
271 ppa_threaded_mainloop_accept(data->loop);
274 ppa_threaded_mainloop_unlock(data->loop);
275 return ALC_TRUE;
277 out:
278 if(data->loop)
280 ppa_threaded_mainloop_stop(data->loop);
281 ppa_threaded_mainloop_free(data->loop);
283 device->ExtraData = NULL;
284 device->szDeviceName = NULL;
286 ppa_xfree(data);
287 return ALC_FALSE;
288 } //}}}
290 static void pulse_close(ALCdevice *device) //{{{
292 pulse_data *data = device->ExtraData;
294 ppa_threaded_mainloop_lock(data->loop);
296 if(data->stream)
298 ppa_stream_disconnect(data->stream);
299 ppa_stream_unref(data->stream);
302 ppa_context_disconnect(data->context);
303 ppa_context_unref(data->context);
305 ppa_threaded_mainloop_unlock(data->loop);
307 ppa_threaded_mainloop_stop(data->loop);
308 ppa_threaded_mainloop_free(data->loop);
310 device->ExtraData = NULL;
311 device->szDeviceName = NULL;
312 DestroyRingBuffer(data->ring);
314 ppa_xfree(data);
315 } //}}}
316 //}}}
318 // OpenAL {{{
319 static ALCboolean pulse_open_playback(ALCdevice *device, const ALCchar *device_name) //{{{
321 if(!pa_handle)
322 return ALC_FALSE;
324 if(device_name)
326 if(strcmp(device_name, pulse_device) != 0)
327 return ALC_FALSE;
330 return pulse_open(device, pulse_device);
331 } //}}}
333 static void pulse_close_playback(ALCdevice *device) //{{{
335 pulse_close(device);
336 } //}}}
338 static ALCboolean pulse_start_context(ALCdevice *device, ALCcontext *context) //{{{
340 pulse_data *data = device->ExtraData;
341 (void)context;
343 ppa_threaded_mainloop_lock(data->loop);
345 data->samples = device->BufferSize;
346 data->frame_size = aluBytesFromFormat(device->Format) *
347 aluChannelsFromFormat(device->Format);
349 device->UpdateSize = device->BufferSize / 4;
351 data->attr.minreq = -1;
352 data->attr.prebuf = -1;
353 data->attr.maxlength = -1;
354 data->attr.fragsize = data->frame_size * device->UpdateSize;
355 data->attr.tlength = data->attr.fragsize * 4;
356 data->stream_name = "Playback Stream";
358 data->spec.rate = device->Frequency;
359 data->spec.channels = aluChannelsFromFormat(device->Format);
361 switch(aluBytesFromFormat(device->Format))
363 case 1:
364 data->spec.format = PA_SAMPLE_U8;
365 break;
366 case 2:
367 data->spec.format = PA_SAMPLE_S16NE;
368 break;
369 case 4:
370 data->spec.format = PA_SAMPLE_FLOAT32NE;
371 break;
372 default:
373 AL_PRINT("Unknown format: %x\n", device->Format);
374 ppa_threaded_mainloop_unlock(data->loop);
375 return ALC_FALSE;
378 if(ppa_sample_spec_valid(&data->spec) == 0)
380 AL_PRINT("Invalid sample format\n");
381 ppa_threaded_mainloop_unlock(data->loop);
382 return ALC_FALSE;
385 data->stream = ppa_stream_new(data->context, data->stream_name, &data->spec, NULL);
386 if(!data->stream)
388 AL_PRINT("pa_stream_new() failed: %s\n",
389 ppa_strerror(ppa_context_errno(data->context)));
391 ppa_threaded_mainloop_unlock(data->loop);
392 return ALC_FALSE;
395 ppa_stream_set_state_callback(data->stream, stream_state_callback, data);
396 ppa_stream_set_write_callback(data->stream, stream_write_callback, device);
398 if(ppa_stream_connect_playback(data->stream, NULL, &data->attr, PA_STREAM_ADJUST_LATENCY, NULL, NULL) < 0)
400 AL_PRINT("Stream did not connect: %s\n",
401 ppa_strerror(ppa_context_errno(data->context)));
403 ppa_stream_unref(data->stream);
404 data->stream = NULL;
406 ppa_threaded_mainloop_unlock(data->loop);
407 return ALC_FALSE;
410 while(ppa_stream_get_state(data->stream) != PA_STREAM_READY)
412 if(!PA_STREAM_IS_GOOD(ppa_stream_get_state(data->stream)))
414 AL_PRINT("Stream did not get ready: %s\n",
415 ppa_strerror(ppa_context_errno(data->context)));
417 ppa_stream_unref(data->stream);
418 data->stream = NULL;
420 ppa_threaded_mainloop_unlock(data->loop);
421 return ALC_FALSE;
424 ppa_threaded_mainloop_wait(data->loop);
425 ppa_threaded_mainloop_accept(data->loop);
428 ppa_threaded_mainloop_unlock(data->loop);
429 return ALC_TRUE;
430 } //}}}
432 static void pulse_stop_context(ALCdevice *device, ALCcontext *context) //{{{
434 pulse_data *data = device->ExtraData;
435 (void)context;
437 if(!data->stream)
438 return;
440 ppa_threaded_mainloop_lock(data->loop);
442 ppa_stream_disconnect(data->stream);
443 ppa_stream_unref(data->stream);
444 data->stream = NULL;
446 ppa_threaded_mainloop_unlock(data->loop);
447 } //}}}
450 static ALCboolean pulse_open_capture(ALCdevice *device, const ALCchar *device_name) //{{{
452 pulse_data *data;
454 if(!pa_handle)
455 return ALC_FALSE;
457 if(device_name)
459 if(strcmp(device_name, pulse_capture_device) != 0)
460 return ALC_FALSE;
463 if(pulse_open(device, pulse_capture_device) == ALC_FALSE)
464 return ALC_FALSE;
466 data = device->ExtraData;
467 ppa_threaded_mainloop_lock(data->loop);
469 data->samples = device->BufferSize;
470 data->frame_size = aluBytesFromFormat(device->Format) *
471 aluChannelsFromFormat(device->Format);
473 if(!(data->ring = CreateRingBuffer(data->frame_size, data->samples)))
475 ppa_threaded_mainloop_unlock(data->loop);
476 pulse_close(device);
477 return ALC_FALSE;
480 data->attr.minreq = -1;
481 data->attr.prebuf = -1;
482 data->attr.maxlength = -1;
483 data->attr.tlength = -1;
484 data->attr.fragsize = data->frame_size * data->samples / 2;
485 data->stream_name = "Capture Stream";
487 data->spec.rate = device->Frequency;
488 data->spec.channels = aluChannelsFromFormat(device->Format);
490 switch(aluBytesFromFormat(device->Format))
492 case 1:
493 data->spec.format = PA_SAMPLE_U8;
494 break;
495 case 2:
496 data->spec.format = PA_SAMPLE_S16NE;
497 break;
498 default:
499 AL_PRINT("Unknown format: %x\n", device->Format);
500 ppa_threaded_mainloop_unlock(data->loop);
501 pulse_close(device);
502 return ALC_FALSE;
505 if(ppa_sample_spec_valid(&data->spec) == 0)
507 AL_PRINT("Invalid sample format\n");
508 ppa_threaded_mainloop_unlock(data->loop);
509 pulse_close(device);
510 return ALC_FALSE;
513 data->stream = ppa_stream_new(data->context, data->stream_name, &data->spec, NULL);
514 if(!data->stream)
516 AL_PRINT("pa_stream_new() failed: %s\n",
517 ppa_strerror(ppa_context_errno(data->context)));
519 ppa_threaded_mainloop_unlock(data->loop);
520 pulse_close(device);
521 return ALC_FALSE;
524 ppa_stream_set_state_callback(data->stream, stream_state_callback, data);
526 if(ppa_stream_connect_record(data->stream, NULL, &data->attr, PA_STREAM_ADJUST_LATENCY) < 0)
528 AL_PRINT("Stream did not connect: %s\n",
529 ppa_strerror(ppa_context_errno(data->context)));
531 ppa_stream_unref(data->stream);
532 ppa_threaded_mainloop_unlock(data->loop);
534 data->stream = NULL;
535 pulse_close(device);
536 return ALC_FALSE;
539 while(ppa_stream_get_state(data->stream) != PA_STREAM_READY)
541 if(!PA_STREAM_IS_GOOD(ppa_stream_get_state(data->stream)))
543 AL_PRINT("Stream did not get ready: %s\n",
544 ppa_strerror(ppa_context_errno(data->context)));
546 ppa_stream_unref(data->stream);
547 ppa_threaded_mainloop_unlock(data->loop);
549 data->stream = NULL;
550 pulse_close(device);
551 return ALC_FALSE;
554 ppa_threaded_mainloop_wait(data->loop);
555 ppa_threaded_mainloop_accept(data->loop);
558 ppa_threaded_mainloop_unlock(data->loop);
559 return ALC_TRUE;
560 } //}}}
562 static void pulse_close_capture(ALCdevice *device) //{{{
564 pulse_close(device);
565 } //}}}
567 static void pulse_start_capture(ALCdevice *device) //{{{
569 pulse_data *data = device->ExtraData;
571 ppa_threaded_mainloop_lock(data->loop);
572 ppa_stream_set_read_callback(data->stream, stream_read_callback, device);
573 ppa_threaded_mainloop_unlock(data->loop);
574 } //}}}
576 static void pulse_stop_capture(ALCdevice *device) //{{{
578 pulse_data *data = device->ExtraData;
580 ppa_threaded_mainloop_lock(data->loop);
581 ppa_stream_set_read_callback(data->stream, NULL, NULL);
582 ppa_threaded_mainloop_unlock(data->loop);
583 } //}}}
585 static void pulse_capture_samples(ALCdevice *device, ALCvoid *buffer, ALCuint samples) //{{{
587 pulse_data *data = device->ExtraData;
588 ALCuint available = RingBufferSize(data->ring);
590 if(available < samples)
591 SetALCError(ALC_INVALID_VALUE);
592 else
593 ReadRingBuffer(data->ring, buffer, samples);
594 } //}}}
596 static ALCuint pulse_available_samples(ALCdevice *device) //{{{
598 pulse_data *data = device->ExtraData;
599 return RingBufferSize(data->ring);
600 } //}}}
602 BackendFuncs pulse_funcs = { //{{{
603 pulse_open_playback,
604 pulse_close_playback,
605 pulse_start_context,
606 pulse_stop_context,
607 pulse_open_capture,
608 pulse_close_capture,
609 pulse_start_capture,
610 pulse_stop_capture,
611 pulse_capture_samples,
612 pulse_available_samples
613 }; //}}}
615 void alc_pulse_init(BackendFuncs *func_list) //{{{
617 *func_list = pulse_funcs;
619 #ifdef _WIN32
620 pa_handle = LoadLibrary("libpulse-0.dll");
621 #define LOAD_FUNC(x) do { \
622 p##x = GetProcAddress(pa_handle, #x); \
623 if(!(p##x)) { \
624 AL_PRINT("Could not load %s from libpulse-0.dll\n", #x); \
625 FreeLibrary(pa_handle); \
626 pa_handle = NULL; \
627 return; \
629 } while(0)
631 #elif defined (HAVE_DLFCN_H)
633 #if defined(__APPLE__) && defined(__MACH__)
634 pa_handle = dlopen("libpulse.0.dylib", RTLD_NOW);
635 #else
636 pa_handle = dlopen("libpulse.so.0", RTLD_NOW);
637 #endif
638 #define LOAD_FUNC(x) do { \
639 p##x = dlsym(pa_handle, #x); \
640 if(!(p##x)) { \
641 AL_PRINT("Could not load %s from libpulse\n", #x); \
642 dlclose(pa_handle); \
643 pa_handle = NULL; \
644 return; \
646 } while(0)
648 #else
650 pa_handle = (void*)0xDEADBEEF;
651 #define LOAD_FUNC(x) p##x = (x)
653 #endif
654 if(!pa_handle)
655 return;
657 LOAD_FUNC(pa_context_unref);
658 LOAD_FUNC(pa_sample_spec_valid);
659 LOAD_FUNC(pa_stream_drop);
660 LOAD_FUNC(pa_strerror);
661 LOAD_FUNC(pa_context_get_state);
662 LOAD_FUNC(pa_stream_get_state);
663 LOAD_FUNC(pa_threaded_mainloop_signal);
664 LOAD_FUNC(pa_stream_peek);
665 LOAD_FUNC(pa_threaded_mainloop_wait);
666 LOAD_FUNC(pa_threaded_mainloop_unlock);
667 LOAD_FUNC(pa_context_new);
668 LOAD_FUNC(pa_threaded_mainloop_stop);
669 LOAD_FUNC(pa_context_disconnect);
670 LOAD_FUNC(pa_threaded_mainloop_start);
671 LOAD_FUNC(pa_threaded_mainloop_get_api);
672 LOAD_FUNC(pa_context_set_state_callback);
673 LOAD_FUNC(pa_stream_write);
674 LOAD_FUNC(pa_xfree);
675 LOAD_FUNC(pa_stream_connect_record);
676 LOAD_FUNC(pa_stream_connect_playback);
677 LOAD_FUNC(pa_path_get_filename);
678 LOAD_FUNC(pa_get_binary_name);
679 LOAD_FUNC(pa_threaded_mainloop_free);
680 LOAD_FUNC(pa_context_errno);
681 LOAD_FUNC(pa_xmalloc0);
682 LOAD_FUNC(pa_stream_unref);
683 LOAD_FUNC(pa_threaded_mainloop_accept);
684 LOAD_FUNC(pa_stream_set_write_callback);
685 LOAD_FUNC(pa_threaded_mainloop_new);
686 LOAD_FUNC(pa_context_connect);
687 LOAD_FUNC(pa_stream_set_read_callback);
688 LOAD_FUNC(pa_stream_set_state_callback);
689 LOAD_FUNC(pa_stream_new);
690 LOAD_FUNC(pa_stream_disconnect);
691 LOAD_FUNC(pa_threaded_mainloop_lock);
693 #undef LOAD_FUNC
695 pulse_device = AppendDeviceList("PulseAudio Software");
696 AppendAllDeviceList(pulse_device);
698 pulse_capture_device = AppendCaptureDeviceList("PulseAudio Capture");
699 } //}}}
700 //}}}