Remove unnecessary function parameters
[openal-soft.git] / Alc / pulseaudio.c
bloba9fcb3dfee72701d37a503087aa8518fd49d09f2
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;
209 data->samples = device->BufferSize;
210 data->frame_size = aluBytesFromFormat(device->Format) *
211 aluChannelsFromFormat(device->Format);
213 if(ppa_get_binary_name(data->path_name, sizeof(data->path_name)))
214 data->context_name = ppa_path_get_filename(data->path_name);
215 else
216 data->context_name = "OpenAL Soft";
218 if(!(data->ring = CreateRingBuffer(data->frame_size, data->samples)))
220 ppa_xfree(data);
221 return ALC_FALSE;
224 device->ExtraData = data;
225 device->szDeviceName = device_name;
227 if(!(data->loop = ppa_threaded_mainloop_new()))
229 AL_PRINT("pa_threaded_mainloop_new() failed!\n");
230 goto out;
233 if(ppa_threaded_mainloop_start(data->loop) < 0)
235 AL_PRINT("pa_threaded_mainloop_start() failed\n");
236 goto out;
239 ppa_threaded_mainloop_lock(data->loop);
241 data->context = ppa_context_new(ppa_threaded_mainloop_get_api(data->loop), data->context_name);
242 if(!data->context)
244 AL_PRINT("pa_context_new() failed: %s\n",
245 ppa_strerror(ppa_context_errno(data->context)));
247 ppa_threaded_mainloop_unlock(data->loop);
248 goto out;
251 ppa_context_set_state_callback(data->context, context_state_callback, data);
253 if(ppa_context_connect(data->context, NULL, PA_CONTEXT_NOAUTOSPAWN, NULL) < 0)
255 AL_PRINT("Context did not connect: %s\n",
256 ppa_strerror(ppa_context_errno(data->context)));
258 ppa_context_unref(data->context);
259 data->context = NULL;
261 ppa_threaded_mainloop_unlock(data->loop);
262 goto out;
265 while(ppa_context_get_state(data->context) != PA_CONTEXT_READY)
267 if(!PA_CONTEXT_IS_GOOD(ppa_context_get_state(data->context)))
269 AL_PRINT("Context did not get ready: %s\n",
270 ppa_strerror(ppa_context_errno(data->context)));
272 ppa_context_unref(data->context);
273 data->context = NULL;
275 ppa_threaded_mainloop_unlock(data->loop);
276 goto out;
279 ppa_threaded_mainloop_wait(data->loop);
280 ppa_threaded_mainloop_accept(data->loop);
283 ppa_threaded_mainloop_unlock(data->loop);
284 return ALC_TRUE;
286 out:
287 if(data->loop)
289 ppa_threaded_mainloop_stop(data->loop);
290 ppa_threaded_mainloop_free(data->loop);
292 device->ExtraData = NULL;
293 device->szDeviceName = NULL;
294 DestroyRingBuffer(data->ring);
296 ppa_xfree(data);
297 return ALC_FALSE;
298 } //}}}
300 static void pulse_close(ALCdevice *device) //{{{
302 pulse_data *data = device->ExtraData;
304 ppa_threaded_mainloop_lock(data->loop);
306 if(data->stream)
308 ppa_stream_disconnect(data->stream);
309 ppa_stream_unref(data->stream);
312 ppa_context_disconnect(data->context);
313 ppa_context_unref(data->context);
315 ppa_threaded_mainloop_unlock(data->loop);
317 ppa_threaded_mainloop_stop(data->loop);
318 ppa_threaded_mainloop_free(data->loop);
320 device->ExtraData = NULL;
321 device->szDeviceName = NULL;
322 DestroyRingBuffer(data->ring);
324 ppa_xfree(data);
325 } //}}}
326 //}}}
328 // OpenAL {{{
329 static ALCboolean pulse_open_playback(ALCdevice *device, const ALCchar *device_name) //{{{
331 if(!pa_handle)
332 return ALC_FALSE;
334 if(device_name)
336 if(strcmp(device_name, pulse_device) != 0)
337 return ALC_FALSE;
340 return pulse_open(device, pulse_device);
341 } //}}}
343 static void pulse_close_playback(ALCdevice *device) //{{{
345 pulse_close(device);
346 } //}}}
348 static ALCboolean pulse_start_context(ALCdevice *device, ALCcontext *context) //{{{
350 pulse_data *data = device->ExtraData;
351 (void)context;
353 ppa_threaded_mainloop_lock(data->loop);
355 device->UpdateSize = device->BufferSize / 4;
357 data->attr.minreq = -1;
358 data->attr.prebuf = -1;
359 data->attr.maxlength = -1;
360 data->attr.fragsize = data->frame_size * device->UpdateSize;
361 data->attr.tlength = data->attr.fragsize * 4;
362 data->stream_name = "Playback Stream";
364 data->spec.rate = device->Frequency;
365 data->spec.channels = aluChannelsFromFormat(device->Format);
367 switch(aluBytesFromFormat(device->Format))
369 case 1:
370 data->spec.format = PA_SAMPLE_U8;
371 break;
372 case 2:
373 data->spec.format = PA_SAMPLE_S16NE;
374 break;
375 default:
376 AL_PRINT("Unknown format: %x\n", device->Format);
377 ppa_threaded_mainloop_unlock(data->loop);
378 return ALC_FALSE;
381 if(ppa_sample_spec_valid(&data->spec) == 0)
383 AL_PRINT("Invalid sample format\n");
384 ppa_threaded_mainloop_unlock(data->loop);
385 return ALC_FALSE;
388 data->stream = ppa_stream_new(data->context, data->stream_name, &data->spec, NULL);
389 if(!data->stream)
391 AL_PRINT("pa_stream_new() failed: %s\n",
392 ppa_strerror(ppa_context_errno(data->context)));
394 ppa_threaded_mainloop_unlock(data->loop);
395 return ALC_FALSE;
398 ppa_stream_set_state_callback(data->stream, stream_state_callback, data);
399 ppa_stream_set_write_callback(data->stream, stream_write_callback, device);
401 if(ppa_stream_connect_playback(data->stream, NULL, &data->attr, PA_STREAM_ADJUST_LATENCY, NULL, NULL) < 0)
403 AL_PRINT("Stream did not connect: %s\n",
404 ppa_strerror(ppa_context_errno(data->context)));
406 ppa_stream_unref(data->stream);
407 data->stream = NULL;
409 ppa_threaded_mainloop_unlock(data->loop);
410 return ALC_FALSE;
413 while(ppa_stream_get_state(data->stream) != PA_STREAM_READY)
415 if(!PA_STREAM_IS_GOOD(ppa_stream_get_state(data->stream)))
417 AL_PRINT("Stream did not get ready: %s\n",
418 ppa_strerror(ppa_context_errno(data->context)));
420 ppa_stream_unref(data->stream);
421 data->stream = NULL;
423 ppa_threaded_mainloop_unlock(data->loop);
424 return ALC_FALSE;
427 ppa_threaded_mainloop_wait(data->loop);
428 ppa_threaded_mainloop_accept(data->loop);
431 ppa_threaded_mainloop_unlock(data->loop);
432 return ALC_TRUE;
433 } //}}}
435 static void pulse_stop_context(ALCdevice *device, ALCcontext *context) //{{{
437 pulse_data *data = device->ExtraData;
438 (void)context;
440 if(!data->stream)
441 return;
443 ppa_threaded_mainloop_lock(data->loop);
445 ppa_stream_disconnect(data->stream);
446 ppa_stream_unref(data->stream);
447 data->stream = NULL;
449 ppa_threaded_mainloop_unlock(data->loop);
450 } //}}}
453 static ALCboolean pulse_open_capture(ALCdevice *device, const ALCchar *device_name) //{{{
455 pulse_data *data;
457 if(!pa_handle)
458 return ALC_FALSE;
460 if(device_name)
462 if(strcmp(device_name, pulse_capture_device) != 0)
463 return ALC_FALSE;
466 if(pulse_open(device, pulse_capture_device) == ALC_FALSE)
467 return ALC_FALSE;
469 data = device->ExtraData;
470 ppa_threaded_mainloop_lock(data->loop);
472 data->attr.minreq = -1;
473 data->attr.prebuf = -1;
474 data->attr.maxlength = -1;
475 data->attr.tlength = -1;
476 data->attr.fragsize = data->frame_size * data->samples / 2;
477 data->stream_name = "Capture Stream";
479 data->spec.rate = device->Frequency;
480 data->spec.channels = aluChannelsFromFormat(device->Format);
482 switch(aluBytesFromFormat(device->Format))
484 case 1:
485 data->spec.format = PA_SAMPLE_U8;
486 break;
487 case 2:
488 data->spec.format = PA_SAMPLE_S16NE;
489 break;
490 default:
491 AL_PRINT("Unknown format: %x\n", device->Format);
492 ppa_threaded_mainloop_unlock(data->loop);
493 pulse_close(device);
494 return ALC_FALSE;
497 if(ppa_sample_spec_valid(&data->spec) == 0)
499 AL_PRINT("Invalid sample format\n");
500 ppa_threaded_mainloop_unlock(data->loop);
501 pulse_close(device);
502 return ALC_FALSE;
505 data->stream = ppa_stream_new(data->context, data->stream_name, &data->spec, NULL);
506 if(!data->stream)
508 AL_PRINT("pa_stream_new() failed: %s\n",
509 ppa_strerror(ppa_context_errno(data->context)));
511 ppa_threaded_mainloop_unlock(data->loop);
512 pulse_close(device);
513 return ALC_FALSE;
516 ppa_stream_set_state_callback(data->stream, stream_state_callback, data);
518 if(ppa_stream_connect_record(data->stream, NULL, &data->attr, PA_STREAM_ADJUST_LATENCY) < 0)
520 AL_PRINT("Stream did not connect: %s\n",
521 ppa_strerror(ppa_context_errno(data->context)));
523 ppa_stream_unref(data->stream);
524 ppa_threaded_mainloop_unlock(data->loop);
526 data->stream = NULL;
527 pulse_close(device);
528 return ALC_FALSE;
531 while(ppa_stream_get_state(data->stream) != PA_STREAM_READY)
533 if(!PA_STREAM_IS_GOOD(ppa_stream_get_state(data->stream)))
535 AL_PRINT("Stream did not get ready: %s\n",
536 ppa_strerror(ppa_context_errno(data->context)));
538 ppa_stream_unref(data->stream);
539 ppa_threaded_mainloop_unlock(data->loop);
541 data->stream = NULL;
542 pulse_close(device);
543 return ALC_FALSE;
546 ppa_threaded_mainloop_wait(data->loop);
547 ppa_threaded_mainloop_accept(data->loop);
550 ppa_threaded_mainloop_unlock(data->loop);
551 return ALC_TRUE;
552 } //}}}
554 static void pulse_close_capture(ALCdevice *device) //{{{
556 pulse_close(device);
557 } //}}}
559 static void pulse_start_capture(ALCdevice *device) //{{{
561 pulse_data *data = device->ExtraData;
563 ppa_threaded_mainloop_lock(data->loop);
564 ppa_stream_set_read_callback(data->stream, stream_read_callback, device);
565 ppa_threaded_mainloop_unlock(data->loop);
566 } //}}}
568 static void pulse_stop_capture(ALCdevice *device) //{{{
570 pulse_data *data = device->ExtraData;
572 ppa_threaded_mainloop_lock(data->loop);
573 ppa_stream_set_read_callback(data->stream, NULL, NULL);
574 ppa_threaded_mainloop_unlock(data->loop);
575 } //}}}
577 static void pulse_capture_samples(ALCdevice *device, ALCvoid *buffer, ALCuint samples) //{{{
579 pulse_data *data = device->ExtraData;
580 ALCuint available = RingBufferSize(data->ring);
582 if(available < samples)
583 SetALCError(ALC_INVALID_VALUE);
584 else
585 ReadRingBuffer(data->ring, buffer, samples);
586 } //}}}
588 static ALCuint pulse_available_samples(ALCdevice *device) //{{{
590 pulse_data *data = device->ExtraData;
591 return RingBufferSize(data->ring);
592 } //}}}
594 BackendFuncs pulse_funcs = { //{{{
595 pulse_open_playback,
596 pulse_close_playback,
597 pulse_start_context,
598 pulse_stop_context,
599 pulse_open_capture,
600 pulse_close_capture,
601 pulse_start_capture,
602 pulse_stop_capture,
603 pulse_capture_samples,
604 pulse_available_samples
605 }; //}}}
607 void alc_pulse_init(BackendFuncs *func_list) //{{{
609 *func_list = pulse_funcs;
611 #ifdef _WIN32
612 pa_handle = LoadLibrary("libpulse-0.dll");
613 #define LOAD_FUNC(x) do { \
614 p##x = GetProcAddress(pa_handle, #x); \
615 if(!(p##x)) { \
616 AL_PRINT("Could not load %s from libpulse-0.dll\n", #x); \
617 FreeLibrary(pa_handle); \
618 pa_handle = NULL; \
619 return; \
621 } while(0)
623 #elif defined (HAVE_DLFCN_H)
625 #if defined(__APPLE__) && defined(__MACH__)
626 pa_handle = dlopen("libpulse.0.dylib", RTLD_NOW);
627 #else
628 pa_handle = dlopen("libpulse.so.0", RTLD_NOW);
629 #endif
630 #define LOAD_FUNC(x) do { \
631 p##x = dlsym(pa_handle, #x); \
632 if(!(p##x)) { \
633 AL_PRINT("Could not load %s from libpulse\n", #x); \
634 dlclose(pa_handle); \
635 pa_handle = NULL; \
636 return; \
638 } while(0)
640 #else
642 pa_handle = (void*)0xDEADBEEF;
643 #define LOAD_FUNC(x) p##x = (x)
645 #endif
646 if(!pa_handle)
647 return;
649 LOAD_FUNC(pa_context_unref);
650 LOAD_FUNC(pa_sample_spec_valid);
651 LOAD_FUNC(pa_stream_drop);
652 LOAD_FUNC(pa_strerror);
653 LOAD_FUNC(pa_context_get_state);
654 LOAD_FUNC(pa_stream_get_state);
655 LOAD_FUNC(pa_threaded_mainloop_signal);
656 LOAD_FUNC(pa_stream_peek);
657 LOAD_FUNC(pa_threaded_mainloop_wait);
658 LOAD_FUNC(pa_threaded_mainloop_unlock);
659 LOAD_FUNC(pa_context_new);
660 LOAD_FUNC(pa_threaded_mainloop_stop);
661 LOAD_FUNC(pa_context_disconnect);
662 LOAD_FUNC(pa_threaded_mainloop_start);
663 LOAD_FUNC(pa_threaded_mainloop_get_api);
664 LOAD_FUNC(pa_context_set_state_callback);
665 LOAD_FUNC(pa_stream_write);
666 LOAD_FUNC(pa_xfree);
667 LOAD_FUNC(pa_stream_connect_record);
668 LOAD_FUNC(pa_stream_connect_playback);
669 LOAD_FUNC(pa_path_get_filename);
670 LOAD_FUNC(pa_get_binary_name);
671 LOAD_FUNC(pa_threaded_mainloop_free);
672 LOAD_FUNC(pa_context_errno);
673 LOAD_FUNC(pa_xmalloc0);
674 LOAD_FUNC(pa_stream_unref);
675 LOAD_FUNC(pa_threaded_mainloop_accept);
676 LOAD_FUNC(pa_stream_set_write_callback);
677 LOAD_FUNC(pa_threaded_mainloop_new);
678 LOAD_FUNC(pa_context_connect);
679 LOAD_FUNC(pa_stream_set_read_callback);
680 LOAD_FUNC(pa_stream_set_state_callback);
681 LOAD_FUNC(pa_stream_new);
682 LOAD_FUNC(pa_stream_disconnect);
683 LOAD_FUNC(pa_threaded_mainloop_lock);
685 #undef LOAD_FUNC
687 pulse_device = AppendDeviceList("PulseAudio Software");
688 AppendAllDeviceList(pulse_device);
690 pulse_capture_device = AppendCaptureDeviceList("PulseAudio Capture");
691 } //}}}
692 //}}}