3 #include "qemu/osdep.h"
4 #include "qemu/module.h"
5 #include "qemu-common.h"
7 #include "qapi/opts-visitor.h"
9 #include <pulse/pulseaudio.h>
11 #define AUDIO_CAP "pulseaudio"
12 #include "audio_int.h"
14 typedef struct PAConnection
{
17 QTAILQ_ENTRY(PAConnection
) list
;
19 pa_threaded_mainloop
*mainloop
;
23 static QTAILQ_HEAD(PAConnectionHead
, PAConnection
) pa_conns
=
24 QTAILQ_HEAD_INITIALIZER(pa_conns
);
41 const void *read_data
;
47 static void qpa_conn_fini(PAConnection
*c
);
49 static void GCC_FMT_ATTR (2, 3) qpa_logerr (int err
, const char *fmt
, ...)
54 AUD_vlog (AUDIO_CAP
, fmt
, ap
);
57 AUD_log (AUDIO_CAP
, "Reason: %s\n", pa_strerror (err
));
60 #ifndef PA_CONTEXT_IS_GOOD
61 static inline int PA_CONTEXT_IS_GOOD(pa_context_state_t x
)
64 x
== PA_CONTEXT_CONNECTING
||
65 x
== PA_CONTEXT_AUTHORIZING
||
66 x
== PA_CONTEXT_SETTING_NAME
||
67 x
== PA_CONTEXT_READY
;
71 #ifndef PA_STREAM_IS_GOOD
72 static inline int PA_STREAM_IS_GOOD(pa_stream_state_t x
)
75 x
== PA_STREAM_CREATING
||
80 #define CHECK_SUCCESS_GOTO(c, expression, label, msg) \
82 if (!(expression)) { \
83 qpa_logerr(pa_context_errno((c)->context), msg); \
88 #define CHECK_DEAD_GOTO(c, stream, label, msg) \
90 if (!(c)->context || !PA_CONTEXT_IS_GOOD (pa_context_get_state((c)->context)) || \
91 !(stream) || !PA_STREAM_IS_GOOD (pa_stream_get_state ((stream)))) { \
92 if (((c)->context && pa_context_get_state ((c)->context) == PA_CONTEXT_FAILED) || \
93 ((stream) && pa_stream_get_state ((stream)) == PA_STREAM_FAILED)) { \
94 qpa_logerr(pa_context_errno((c)->context), msg); \
96 qpa_logerr(PA_ERR_BADSTATE, msg); \
102 static void *qpa_get_buffer_in(HWVoiceIn
*hw
, size_t *size
)
104 PAVoiceIn
*p
= (PAVoiceIn
*) hw
;
105 PAConnection
*c
= p
->g
->conn
;
108 pa_threaded_mainloop_lock(c
->mainloop
);
110 CHECK_DEAD_GOTO(c
, p
->stream
, unlock_and_fail
,
111 "pa_threaded_mainloop_lock failed\n");
113 if (!p
->read_length
) {
114 r
= pa_stream_peek(p
->stream
, &p
->read_data
, &p
->read_length
);
115 CHECK_SUCCESS_GOTO(c
, r
== 0, unlock_and_fail
,
116 "pa_stream_peek failed\n");
119 *size
= MIN(p
->read_length
, *size
);
121 pa_threaded_mainloop_unlock(c
->mainloop
);
122 return (void *) p
->read_data
;
125 pa_threaded_mainloop_unlock(c
->mainloop
);
130 static void qpa_put_buffer_in(HWVoiceIn
*hw
, void *buf
, size_t size
)
132 PAVoiceIn
*p
= (PAVoiceIn
*) hw
;
133 PAConnection
*c
= p
->g
->conn
;
136 pa_threaded_mainloop_lock(c
->mainloop
);
138 CHECK_DEAD_GOTO(c
, p
->stream
, unlock
,
139 "pa_threaded_mainloop_lock failed\n");
141 assert(buf
== p
->read_data
&& size
<= p
->read_length
);
143 p
->read_data
+= size
;
144 p
->read_length
-= size
;
146 if (size
&& !p
->read_length
) {
147 r
= pa_stream_drop(p
->stream
);
148 CHECK_SUCCESS_GOTO(c
, r
== 0, unlock
, "pa_stream_drop failed\n");
152 pa_threaded_mainloop_unlock(c
->mainloop
);
155 static size_t qpa_read(HWVoiceIn
*hw
, void *data
, size_t length
)
157 PAVoiceIn
*p
= (PAVoiceIn
*) hw
;
158 PAConnection
*c
= p
->g
->conn
;
161 pa_threaded_mainloop_lock(c
->mainloop
);
163 CHECK_DEAD_GOTO(c
, p
->stream
, unlock_and_fail
,
164 "pa_threaded_mainloop_lock failed\n");
166 while (total
< length
) {
170 if (!p
->read_length
) {
171 r
= pa_stream_peek(p
->stream
, &p
->read_data
, &p
->read_length
);
172 CHECK_SUCCESS_GOTO(c
, r
== 0, unlock_and_fail
,
173 "pa_stream_peek failed\n");
174 if (!p
->read_length
) {
175 /* buffer is empty */
180 l
= MIN(p
->read_length
, length
- total
);
181 memcpy((char *)data
+ total
, p
->read_data
, l
);
187 if (!p
->read_length
) {
188 r
= pa_stream_drop(p
->stream
);
189 CHECK_SUCCESS_GOTO(c
, r
== 0, unlock_and_fail
,
190 "pa_stream_drop failed\n");
194 pa_threaded_mainloop_unlock(c
->mainloop
);
198 pa_threaded_mainloop_unlock(c
->mainloop
);
202 static void *qpa_get_buffer_out(HWVoiceOut
*hw
, size_t *size
)
204 PAVoiceOut
*p
= (PAVoiceOut
*) hw
;
205 PAConnection
*c
= p
->g
->conn
;
209 pa_threaded_mainloop_lock(c
->mainloop
);
211 CHECK_DEAD_GOTO(c
, p
->stream
, unlock_and_fail
,
212 "pa_threaded_mainloop_lock failed\n");
215 r
= pa_stream_begin_write(p
->stream
, &ret
, size
);
216 CHECK_SUCCESS_GOTO(c
, r
>= 0, unlock_and_fail
,
217 "pa_stream_begin_write failed\n");
219 pa_threaded_mainloop_unlock(c
->mainloop
);
223 pa_threaded_mainloop_unlock(c
->mainloop
);
228 static size_t qpa_write(HWVoiceOut
*hw
, void *data
, size_t length
)
230 PAVoiceOut
*p
= (PAVoiceOut
*) hw
;
231 PAConnection
*c
= p
->g
->conn
;
235 pa_threaded_mainloop_lock(c
->mainloop
);
237 CHECK_DEAD_GOTO(c
, p
->stream
, unlock_and_fail
,
238 "pa_threaded_mainloop_lock failed\n");
240 l
= pa_stream_writable_size(p
->stream
);
242 CHECK_SUCCESS_GOTO(c
, l
!= (size_t) -1, unlock_and_fail
,
243 "pa_stream_writable_size failed\n");
249 r
= pa_stream_write(p
->stream
, data
, l
, NULL
, 0LL, PA_SEEK_RELATIVE
);
250 CHECK_SUCCESS_GOTO(c
, r
>= 0, unlock_and_fail
, "pa_stream_write failed\n");
252 pa_threaded_mainloop_unlock(c
->mainloop
);
256 pa_threaded_mainloop_unlock(c
->mainloop
);
260 static pa_sample_format_t
audfmt_to_pa (AudioFormat afmt
, int endianness
)
265 case AUDIO_FORMAT_S8
:
266 case AUDIO_FORMAT_U8
:
267 format
= PA_SAMPLE_U8
;
269 case AUDIO_FORMAT_S16
:
270 case AUDIO_FORMAT_U16
:
271 format
= endianness
? PA_SAMPLE_S16BE
: PA_SAMPLE_S16LE
;
273 case AUDIO_FORMAT_S32
:
274 case AUDIO_FORMAT_U32
:
275 format
= endianness
? PA_SAMPLE_S32BE
: PA_SAMPLE_S32LE
;
278 dolog ("Internal logic error: Bad audio format %d\n", afmt
);
279 format
= PA_SAMPLE_U8
;
285 static AudioFormat
pa_to_audfmt (pa_sample_format_t fmt
, int *endianness
)
289 return AUDIO_FORMAT_U8
;
290 case PA_SAMPLE_S16BE
:
292 return AUDIO_FORMAT_S16
;
293 case PA_SAMPLE_S16LE
:
295 return AUDIO_FORMAT_S16
;
296 case PA_SAMPLE_S32BE
:
298 return AUDIO_FORMAT_S32
;
299 case PA_SAMPLE_S32LE
:
301 return AUDIO_FORMAT_S32
;
303 dolog ("Internal logic error: Bad pa_sample_format %d\n", fmt
);
304 return AUDIO_FORMAT_U8
;
308 static void context_state_cb (pa_context
*c
, void *userdata
)
310 PAConnection
*conn
= userdata
;
312 switch (pa_context_get_state(c
)) {
313 case PA_CONTEXT_READY
:
314 case PA_CONTEXT_TERMINATED
:
315 case PA_CONTEXT_FAILED
:
316 pa_threaded_mainloop_signal(conn
->mainloop
, 0);
319 case PA_CONTEXT_UNCONNECTED
:
320 case PA_CONTEXT_CONNECTING
:
321 case PA_CONTEXT_AUTHORIZING
:
322 case PA_CONTEXT_SETTING_NAME
:
327 static void stream_state_cb (pa_stream
*s
, void * userdata
)
329 PAConnection
*c
= userdata
;
331 switch (pa_stream_get_state (s
)) {
333 case PA_STREAM_READY
:
334 case PA_STREAM_FAILED
:
335 case PA_STREAM_TERMINATED
:
336 pa_threaded_mainloop_signal(c
->mainloop
, 0);
339 case PA_STREAM_UNCONNECTED
:
340 case PA_STREAM_CREATING
:
345 static pa_stream
*qpa_simple_new (
348 pa_stream_direction_t dir
,
350 const pa_sample_spec
*ss
,
351 const pa_buffer_attr
*attr
,
355 pa_stream
*stream
= NULL
;
356 pa_stream_flags_t flags
;
359 pa_threaded_mainloop_lock(c
->mainloop
);
361 pa_channel_map_init(&map
);
362 map
.channels
= ss
->channels
;
365 * TODO: This currently expects the only frontend supporting more than 2
366 * channels is the usb-audio. We will need some means to set channel
367 * order when a new frontend gains multi-channel support.
369 switch (ss
->channels
) {
371 map
.map
[0] = PA_CHANNEL_POSITION_MONO
;
375 map
.map
[0] = PA_CHANNEL_POSITION_LEFT
;
376 map
.map
[1] = PA_CHANNEL_POSITION_RIGHT
;
380 map
.map
[0] = PA_CHANNEL_POSITION_FRONT_LEFT
;
381 map
.map
[1] = PA_CHANNEL_POSITION_FRONT_RIGHT
;
382 map
.map
[2] = PA_CHANNEL_POSITION_CENTER
;
383 map
.map
[3] = PA_CHANNEL_POSITION_LFE
;
384 map
.map
[4] = PA_CHANNEL_POSITION_REAR_LEFT
;
385 map
.map
[5] = PA_CHANNEL_POSITION_REAR_RIGHT
;
389 map
.map
[0] = PA_CHANNEL_POSITION_FRONT_LEFT
;
390 map
.map
[1] = PA_CHANNEL_POSITION_FRONT_RIGHT
;
391 map
.map
[2] = PA_CHANNEL_POSITION_CENTER
;
392 map
.map
[3] = PA_CHANNEL_POSITION_LFE
;
393 map
.map
[4] = PA_CHANNEL_POSITION_REAR_LEFT
;
394 map
.map
[5] = PA_CHANNEL_POSITION_REAR_RIGHT
;
395 map
.map
[6] = PA_CHANNEL_POSITION_SIDE_LEFT
;
396 map
.map
[7] = PA_CHANNEL_POSITION_SIDE_RIGHT
;
400 dolog("Internal error: unsupported channel count %d\n", ss
->channels
);
404 stream
= pa_stream_new(c
->context
, name
, ss
, &map
);
409 pa_stream_set_state_callback(stream
, stream_state_cb
, c
);
412 PA_STREAM_INTERPOLATE_TIMING
413 | PA_STREAM_AUTO_TIMING_UPDATE
414 | PA_STREAM_EARLY_REQUESTS
;
417 /* don't move the stream if the user specified a sink/source */
418 flags
|= PA_STREAM_DONT_MOVE
;
421 if (dir
== PA_STREAM_PLAYBACK
) {
422 r
= pa_stream_connect_playback(stream
, dev
, attr
, flags
, NULL
, NULL
);
424 r
= pa_stream_connect_record(stream
, dev
, attr
, flags
);
431 pa_threaded_mainloop_unlock(c
->mainloop
);
436 pa_threaded_mainloop_unlock(c
->mainloop
);
439 pa_stream_unref (stream
);
442 *rerror
= pa_context_errno(c
->context
);
447 static int qpa_init_out(HWVoiceOut
*hw
, struct audsettings
*as
,
453 struct audsettings obt_as
= *as
;
454 PAVoiceOut
*pa
= (PAVoiceOut
*) hw
;
455 paaudio
*g
= pa
->g
= drv_opaque
;
456 AudiodevPaOptions
*popts
= &g
->dev
->u
.pa
;
457 AudiodevPaPerDirectionOptions
*ppdo
= popts
->out
;
458 PAConnection
*c
= g
->conn
;
460 ss
.format
= audfmt_to_pa (as
->fmt
, as
->endianness
);
461 ss
.channels
= as
->nchannels
;
464 ba
.tlength
= pa_usec_to_bytes(ppdo
->latency
, &ss
);
469 obt_as
.fmt
= pa_to_audfmt (ss
.format
, &obt_as
.endianness
);
471 pa
->stream
= qpa_simple_new (
473 ppdo
->has_stream_name
? ppdo
->stream_name
: g
->dev
->id
,
475 ppdo
->has_name
? ppdo
->name
: NULL
,
477 &ba
, /* buffering attributes */
481 qpa_logerr (error
, "pa_simple_new for playback failed\n");
485 audio_pcm_init_info (&hw
->info
, &obt_as
);
486 hw
->samples
= pa
->samples
= audio_buffer_samples(
487 qapi_AudiodevPaPerDirectionOptions_base(ppdo
),
488 &obt_as
, ppdo
->buffer_length
);
496 static int qpa_init_in(HWVoiceIn
*hw
, struct audsettings
*as
, void *drv_opaque
)
501 struct audsettings obt_as
= *as
;
502 PAVoiceIn
*pa
= (PAVoiceIn
*) hw
;
503 paaudio
*g
= pa
->g
= drv_opaque
;
504 AudiodevPaOptions
*popts
= &g
->dev
->u
.pa
;
505 AudiodevPaPerDirectionOptions
*ppdo
= popts
->in
;
506 PAConnection
*c
= g
->conn
;
508 ss
.format
= audfmt_to_pa (as
->fmt
, as
->endianness
);
509 ss
.channels
= as
->nchannels
;
512 ba
.fragsize
= pa_usec_to_bytes(ppdo
->latency
, &ss
);
513 ba
.maxlength
= pa_usec_to_bytes(ppdo
->latency
* 2, &ss
);
517 obt_as
.fmt
= pa_to_audfmt (ss
.format
, &obt_as
.endianness
);
519 pa
->stream
= qpa_simple_new (
521 ppdo
->has_stream_name
? ppdo
->stream_name
: g
->dev
->id
,
523 ppdo
->has_name
? ppdo
->name
: NULL
,
525 &ba
, /* buffering attributes */
529 qpa_logerr (error
, "pa_simple_new for capture failed\n");
533 audio_pcm_init_info (&hw
->info
, &obt_as
);
534 hw
->samples
= pa
->samples
= audio_buffer_samples(
535 qapi_AudiodevPaPerDirectionOptions_base(ppdo
),
536 &obt_as
, ppdo
->buffer_length
);
544 static void qpa_simple_disconnect(PAConnection
*c
, pa_stream
*stream
)
549 * wait until actually connects. workaround pa bug #247
550 * https://gitlab.freedesktop.org/pulseaudio/pulseaudio/issues/247
552 while (pa_stream_get_state(stream
) == PA_STREAM_CREATING
) {
553 pa_threaded_mainloop_wait(c
->mainloop
);
556 err
= pa_stream_disconnect(stream
);
558 dolog("Failed to disconnect! err=%d\n", err
);
560 pa_stream_unref(stream
);
563 static void qpa_fini_out (HWVoiceOut
*hw
)
565 PAVoiceOut
*pa
= (PAVoiceOut
*) hw
;
568 PAConnection
*c
= pa
->g
->conn
;
570 pa_threaded_mainloop_lock(c
->mainloop
);
571 qpa_simple_disconnect(c
, pa
->stream
);
573 pa_threaded_mainloop_unlock(c
->mainloop
);
577 static void qpa_fini_in (HWVoiceIn
*hw
)
579 PAVoiceIn
*pa
= (PAVoiceIn
*) hw
;
582 PAConnection
*c
= pa
->g
->conn
;
584 pa_threaded_mainloop_lock(c
->mainloop
);
585 if (pa
->read_length
) {
586 int r
= pa_stream_drop(pa
->stream
);
588 qpa_logerr(pa_context_errno(c
->context
),
589 "pa_stream_drop failed\n");
593 qpa_simple_disconnect(c
, pa
->stream
);
595 pa_threaded_mainloop_unlock(c
->mainloop
);
599 static void qpa_volume_out(HWVoiceOut
*hw
, Volume
*vol
)
601 PAVoiceOut
*pa
= (PAVoiceOut
*) hw
;
604 PAConnection
*c
= pa
->g
->conn
;
607 #ifdef PA_CHECK_VERSION /* macro is present in 0.9.16+ */
608 pa_cvolume_init (&v
); /* function is present in 0.9.13+ */
611 v
.channels
= vol
->channels
;
612 for (i
= 0; i
< vol
->channels
; ++i
) {
613 v
.values
[i
] = ((PA_VOLUME_NORM
- PA_VOLUME_MUTED
) * vol
->vol
[i
]) / 255;
616 pa_threaded_mainloop_lock(c
->mainloop
);
618 op
= pa_context_set_sink_input_volume(c
->context
,
619 pa_stream_get_index(pa
->stream
),
622 qpa_logerr(pa_context_errno(c
->context
),
623 "set_sink_input_volume() failed\n");
625 pa_operation_unref(op
);
628 op
= pa_context_set_sink_input_mute(c
->context
,
629 pa_stream_get_index(pa
->stream
),
630 vol
->mute
, NULL
, NULL
);
632 qpa_logerr(pa_context_errno(c
->context
),
633 "set_sink_input_mute() failed\n");
635 pa_operation_unref(op
);
638 pa_threaded_mainloop_unlock(c
->mainloop
);
641 static void qpa_volume_in(HWVoiceIn
*hw
, Volume
*vol
)
643 PAVoiceIn
*pa
= (PAVoiceIn
*) hw
;
646 PAConnection
*c
= pa
->g
->conn
;
649 #ifdef PA_CHECK_VERSION
650 pa_cvolume_init (&v
);
653 v
.channels
= vol
->channels
;
654 for (i
= 0; i
< vol
->channels
; ++i
) {
655 v
.values
[i
] = ((PA_VOLUME_NORM
- PA_VOLUME_MUTED
) * vol
->vol
[i
]) / 255;
658 pa_threaded_mainloop_lock(c
->mainloop
);
660 op
= pa_context_set_source_output_volume(c
->context
,
661 pa_stream_get_index(pa
->stream
),
664 qpa_logerr(pa_context_errno(c
->context
),
665 "set_source_output_volume() failed\n");
667 pa_operation_unref(op
);
670 op
= pa_context_set_source_output_mute(c
->context
,
671 pa_stream_get_index(pa
->stream
),
672 vol
->mute
, NULL
, NULL
);
674 qpa_logerr(pa_context_errno(c
->context
),
675 "set_source_output_mute() failed\n");
677 pa_operation_unref(op
);
680 pa_threaded_mainloop_unlock(c
->mainloop
);
683 static int qpa_validate_per_direction_opts(Audiodev
*dev
,
684 AudiodevPaPerDirectionOptions
*pdo
)
686 if (!pdo
->has_buffer_length
) {
687 pdo
->has_buffer_length
= true;
688 pdo
->buffer_length
= 46440;
690 if (!pdo
->has_latency
) {
691 pdo
->has_latency
= true;
692 pdo
->latency
= 15000;
698 static void *qpa_conn_init(const char *server
)
701 PAConnection
*c
= g_malloc0(sizeof(PAConnection
));
702 QTAILQ_INSERT_TAIL(&pa_conns
, c
, list
);
704 c
->mainloop
= pa_threaded_mainloop_new();
709 vm_name
= qemu_get_vm_name();
710 c
->context
= pa_context_new(pa_threaded_mainloop_get_api(c
->mainloop
),
711 vm_name
? vm_name
: "qemu");
716 pa_context_set_state_callback(c
->context
, context_state_cb
, c
);
718 if (pa_context_connect(c
->context
, server
, 0, NULL
) < 0) {
719 qpa_logerr(pa_context_errno(c
->context
),
720 "pa_context_connect() failed\n");
724 pa_threaded_mainloop_lock(c
->mainloop
);
726 if (pa_threaded_mainloop_start(c
->mainloop
) < 0) {
727 goto unlock_and_fail
;
731 pa_context_state_t state
;
733 state
= pa_context_get_state(c
->context
);
735 if (state
== PA_CONTEXT_READY
) {
739 if (!PA_CONTEXT_IS_GOOD(state
)) {
740 qpa_logerr(pa_context_errno(c
->context
),
741 "Wrong context state\n");
742 goto unlock_and_fail
;
745 /* Wait until the context is ready */
746 pa_threaded_mainloop_wait(c
->mainloop
);
749 pa_threaded_mainloop_unlock(c
->mainloop
);
753 pa_threaded_mainloop_unlock(c
->mainloop
);
755 AUD_log (AUDIO_CAP
, "Failed to initialize PA context");
760 static void *qpa_audio_init(Audiodev
*dev
)
763 AudiodevPaOptions
*popts
= &dev
->u
.pa
;
767 assert(dev
->driver
== AUDIODEV_DRIVER_PA
);
769 if (!popts
->has_server
) {
774 runtime
= getenv("XDG_RUNTIME_DIR");
778 snprintf(pidfile
, sizeof(pidfile
), "%s/pulse/pid", runtime
);
779 if (stat(pidfile
, &st
) != 0) {
784 if (!qpa_validate_per_direction_opts(dev
, popts
->in
)) {
787 if (!qpa_validate_per_direction_opts(dev
, popts
->out
)) {
791 g
= g_malloc0(sizeof(paaudio
));
792 server
= popts
->has_server
? popts
->server
: NULL
;
796 QTAILQ_FOREACH(c
, &pa_conns
, list
) {
797 if (server
== NULL
|| c
->server
== NULL
?
798 server
== c
->server
:
799 strcmp(server
, c
->server
) == 0) {
805 g
->conn
= qpa_conn_init(server
);
816 static void qpa_conn_fini(PAConnection
*c
)
819 pa_threaded_mainloop_stop(c
->mainloop
);
823 pa_context_disconnect(c
->context
);
824 pa_context_unref(c
->context
);
828 pa_threaded_mainloop_free(c
->mainloop
);
831 QTAILQ_REMOVE(&pa_conns
, c
, list
);
835 static void qpa_audio_fini (void *opaque
)
838 PAConnection
*c
= g
->conn
;
840 if (--c
->refcount
== 0) {
847 static struct audio_pcm_ops qpa_pcm_ops
= {
848 .init_out
= qpa_init_out
,
849 .fini_out
= qpa_fini_out
,
851 .get_buffer_out
= qpa_get_buffer_out
,
852 .put_buffer_out
= qpa_write
, /* pa handles it */
853 .volume_out
= qpa_volume_out
,
855 .init_in
= qpa_init_in
,
856 .fini_in
= qpa_fini_in
,
858 .get_buffer_in
= qpa_get_buffer_in
,
859 .put_buffer_in
= qpa_put_buffer_in
,
860 .volume_in
= qpa_volume_in
863 static struct audio_driver pa_audio_driver
= {
865 .descr
= "http://www.pulseaudio.org/",
866 .init
= qpa_audio_init
,
867 .fini
= qpa_audio_fini
,
868 .pcm_ops
= &qpa_pcm_ops
,
870 .max_voices_out
= INT_MAX
,
871 .max_voices_in
= INT_MAX
,
872 .voice_size_out
= sizeof (PAVoiceOut
),
873 .voice_size_in
= sizeof (PAVoiceIn
),
876 static void register_audio_pa(void)
878 audio_driver_register(&pa_audio_driver
);
880 type_init(register_audio_pa
);