2 * QEMU ALSA audio driver
4 * Copyright (c) 2005 Vassili Karpov (malc)
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include <alsa/asoundlib.h>
27 #include "qemu/main-loop.h"
28 #include "qemu/module.h"
32 #pragma GCC diagnostic ignored "-Waddress"
34 #define AUDIO_CAP "alsa"
35 #include "audio_int.h"
45 typedef struct ALSAVoiceOut {
48 struct pollhlp pollhlp;
52 typedef struct ALSAVoiceIn {
55 struct pollhlp pollhlp;
59 struct alsa_params_req {
65 struct alsa_params_obt {
70 snd_pcm_uframes_t samples;
73 static void GCC_FMT_ATTR (2, 3) alsa_logerr (int err, const char *fmt, ...)
78 AUD_vlog (AUDIO_CAP, fmt, ap);
81 AUD_log (AUDIO_CAP, "Reason: %s\n", snd_strerror (err));
84 static void GCC_FMT_ATTR (3, 4) alsa_logerr2 (
93 AUD_log (AUDIO_CAP, "Could not initialize %s\n", typ);
96 AUD_vlog (AUDIO_CAP, fmt, ap);
99 AUD_log (AUDIO_CAP, "Reason: %s\n", snd_strerror (err));
102 static void alsa_fini_poll (struct pollhlp *hlp)
105 struct pollfd *pfds = hlp->pfds;
108 for (i = 0; i < hlp->count; ++i) {
109 qemu_set_fd_handler (pfds[i].fd, NULL, NULL, NULL);
118 static void alsa_anal_close1 (snd_pcm_t **handlep)
120 int err = snd_pcm_close (*handlep);
122 alsa_logerr (err, "Failed to close PCM handle %p\n", *handlep);
127 static void alsa_anal_close (snd_pcm_t **handlep, struct pollhlp *hlp)
129 alsa_fini_poll (hlp);
130 alsa_anal_close1 (handlep);
133 static int alsa_recover (snd_pcm_t *handle)
135 int err = snd_pcm_prepare (handle);
137 alsa_logerr (err, "Failed to prepare handle %p\n", handle);
143 static int alsa_resume (snd_pcm_t *handle)
145 int err = snd_pcm_resume (handle);
147 alsa_logerr (err, "Failed to resume handle %p\n", handle);
153 static void alsa_poll_handler (void *opaque)
156 snd_pcm_state_t state;
157 struct pollhlp *hlp = opaque;
158 unsigned short revents;
160 count = poll (hlp->pfds, hlp->count, 0);
162 dolog ("alsa_poll_handler: poll %s\n", strerror (errno));
170 /* XXX: ALSA example uses initial count, not the one returned by
172 err = snd_pcm_poll_descriptors_revents (hlp->handle, hlp->pfds,
173 hlp->count, &revents);
175 alsa_logerr (err, "snd_pcm_poll_descriptors_revents");
179 if (!(revents & hlp->mask)) {
180 trace_alsa_revents(revents);
184 state = snd_pcm_state (hlp->handle);
186 case SND_PCM_STATE_SETUP:
187 alsa_recover (hlp->handle);
190 case SND_PCM_STATE_XRUN:
191 alsa_recover (hlp->handle);
194 case SND_PCM_STATE_SUSPENDED:
195 alsa_resume (hlp->handle);
198 case SND_PCM_STATE_PREPARED:
199 audio_run(hlp->s, "alsa run (prepared)");
202 case SND_PCM_STATE_RUNNING:
203 audio_run(hlp->s, "alsa run (running)");
207 dolog ("Unexpected state %d\n", state);
211 static int alsa_poll_helper (snd_pcm_t *handle, struct pollhlp *hlp, int mask)
216 count = snd_pcm_poll_descriptors_count (handle);
218 dolog ("Could not initialize poll mode\n"
219 "Invalid number of poll descriptors %d\n", count);
223 pfds = audio_calloc ("alsa_poll_helper", count, sizeof (*pfds));
225 dolog ("Could not initialize poll mode\n");
229 err = snd_pcm_poll_descriptors (handle, pfds, count);
231 alsa_logerr (err, "Could not initialize poll mode\n"
232 "Could not obtain poll descriptors\n");
237 for (i = 0; i < count; ++i) {
238 if (pfds[i].events & POLLIN) {
239 qemu_set_fd_handler (pfds[i].fd, alsa_poll_handler, NULL, hlp);
241 if (pfds[i].events & POLLOUT) {
242 trace_alsa_pollout(i, pfds[i].fd);
243 qemu_set_fd_handler (pfds[i].fd, NULL, alsa_poll_handler, hlp);
245 trace_alsa_set_handler(pfds[i].events, i, pfds[i].fd, err);
250 hlp->handle = handle;
255 static int alsa_poll_out (HWVoiceOut *hw)
257 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
259 return alsa_poll_helper (alsa->handle, &alsa->pollhlp, POLLOUT);
262 static int alsa_poll_in (HWVoiceIn *hw)
264 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
266 return alsa_poll_helper (alsa->handle, &alsa->pollhlp, POLLIN);
269 static snd_pcm_format_t aud_to_alsafmt (AudioFormat fmt, int endianness)
272 case AUDIO_FORMAT_S8:
273 return SND_PCM_FORMAT_S8;
275 case AUDIO_FORMAT_U8:
276 return SND_PCM_FORMAT_U8;
278 case AUDIO_FORMAT_S16:
280 return SND_PCM_FORMAT_S16_BE;
283 return SND_PCM_FORMAT_S16_LE;
286 case AUDIO_FORMAT_U16:
288 return SND_PCM_FORMAT_U16_BE;
291 return SND_PCM_FORMAT_U16_LE;
294 case AUDIO_FORMAT_S32:
296 return SND_PCM_FORMAT_S32_BE;
299 return SND_PCM_FORMAT_S32_LE;
302 case AUDIO_FORMAT_U32:
304 return SND_PCM_FORMAT_U32_BE;
307 return SND_PCM_FORMAT_U32_LE;
310 case AUDIO_FORMAT_F32:
312 return SND_PCM_FORMAT_FLOAT_BE;
314 return SND_PCM_FORMAT_FLOAT_LE;
318 dolog ("Internal logic error: Bad audio format %d\n", fmt);
322 return SND_PCM_FORMAT_U8;
326 static int alsa_to_audfmt (snd_pcm_format_t alsafmt, AudioFormat *fmt,
330 case SND_PCM_FORMAT_S8:
332 *fmt = AUDIO_FORMAT_S8;
335 case SND_PCM_FORMAT_U8:
337 *fmt = AUDIO_FORMAT_U8;
340 case SND_PCM_FORMAT_S16_LE:
342 *fmt = AUDIO_FORMAT_S16;
345 case SND_PCM_FORMAT_U16_LE:
347 *fmt = AUDIO_FORMAT_U16;
350 case SND_PCM_FORMAT_S16_BE:
352 *fmt = AUDIO_FORMAT_S16;
355 case SND_PCM_FORMAT_U16_BE:
357 *fmt = AUDIO_FORMAT_U16;
360 case SND_PCM_FORMAT_S32_LE:
362 *fmt = AUDIO_FORMAT_S32;
365 case SND_PCM_FORMAT_U32_LE:
367 *fmt = AUDIO_FORMAT_U32;
370 case SND_PCM_FORMAT_S32_BE:
372 *fmt = AUDIO_FORMAT_S32;
375 case SND_PCM_FORMAT_U32_BE:
377 *fmt = AUDIO_FORMAT_U32;
380 case SND_PCM_FORMAT_FLOAT_LE:
382 *fmt = AUDIO_FORMAT_F32;
385 case SND_PCM_FORMAT_FLOAT_BE:
387 *fmt = AUDIO_FORMAT_F32;
391 dolog ("Unrecognized audio format %d\n", alsafmt);
398 static void alsa_dump_info (struct alsa_params_req *req,
399 struct alsa_params_obt *obt,
400 snd_pcm_format_t obtfmt,
401 AudiodevAlsaPerDirectionOptions *apdo)
403 dolog("parameter | requested value | obtained value\n");
404 dolog("format | %10d | %10d\n", req->fmt, obtfmt);
405 dolog("channels | %10d | %10d\n",
406 req->nchannels, obt->nchannels);
407 dolog("frequency | %10d | %10d\n", req->freq, obt->freq);
408 dolog("============================================\n");
409 dolog("requested: buffer len %" PRId32 " period len %" PRId32 "\n",
410 apdo->buffer_length, apdo->period_length);
411 dolog("obtained: samples %ld\n", obt->samples);
414 static void alsa_set_threshold (snd_pcm_t *handle, snd_pcm_uframes_t threshold)
417 snd_pcm_sw_params_t *sw_params;
419 snd_pcm_sw_params_alloca (&sw_params);
421 err = snd_pcm_sw_params_current (handle, sw_params);
423 dolog ("Could not fully initialize DAC\n");
424 alsa_logerr (err, "Failed to get current software parameters\n");
428 err = snd_pcm_sw_params_set_start_threshold (handle, sw_params, threshold);
430 dolog ("Could not fully initialize DAC\n");
431 alsa_logerr (err, "Failed to set software threshold to %ld\n",
436 err = snd_pcm_sw_params (handle, sw_params);
438 dolog ("Could not fully initialize DAC\n");
439 alsa_logerr (err, "Failed to set software parameters\n");
444 static int alsa_open(bool in, struct alsa_params_req *req,
445 struct alsa_params_obt *obt, snd_pcm_t **handlep,
448 AudiodevAlsaOptions *aopts = &dev->u.alsa;
449 AudiodevAlsaPerDirectionOptions *apdo = in ? aopts->in : aopts->out;
451 snd_pcm_hw_params_t *hw_params;
453 unsigned int freq, nchannels;
454 const char *pcm_name = apdo->has_dev ? apdo->dev : "default";
455 snd_pcm_uframes_t obt_buffer_size;
456 const char *typ = in ? "ADC" : "DAC";
457 snd_pcm_format_t obtfmt;
460 nchannels = req->nchannels;
462 snd_pcm_hw_params_alloca (&hw_params);
467 in ? SND_PCM_STREAM_CAPTURE : SND_PCM_STREAM_PLAYBACK,
471 alsa_logerr2 (err, typ, "Failed to open `%s':\n", pcm_name);
475 err = snd_pcm_hw_params_any (handle, hw_params);
477 alsa_logerr2 (err, typ, "Failed to initialize hardware parameters\n");
481 err = snd_pcm_hw_params_set_access (
484 SND_PCM_ACCESS_RW_INTERLEAVED
487 alsa_logerr2 (err, typ, "Failed to set access type\n");
491 err = snd_pcm_hw_params_set_format (handle, hw_params, req->fmt);
493 alsa_logerr2 (err, typ, "Failed to set format %d\n", req->fmt);
496 err = snd_pcm_hw_params_set_rate_near (handle, hw_params, &freq, 0);
498 alsa_logerr2 (err, typ, "Failed to set frequency %d\n", req->freq);
502 err = snd_pcm_hw_params_set_channels_near (
508 alsa_logerr2 (err, typ, "Failed to set number of channels %d\n",
513 if (apdo->buffer_length) {
515 unsigned int btime = apdo->buffer_length;
517 err = snd_pcm_hw_params_set_buffer_time_near(
518 handle, hw_params, &btime, &dir);
521 alsa_logerr2(err, typ, "Failed to set buffer time to %" PRId32 "\n",
522 apdo->buffer_length);
526 if (apdo->has_buffer_length && btime != apdo->buffer_length) {
527 dolog("Requested buffer time %" PRId32
528 " was rejected, using %u\n", apdo->buffer_length, btime);
532 if (apdo->period_length) {
534 unsigned int ptime = apdo->period_length;
536 err = snd_pcm_hw_params_set_period_time_near(handle, hw_params, &ptime,
540 alsa_logerr2(err, typ, "Failed to set period time to %" PRId32 "\n",
541 apdo->period_length);
545 if (apdo->has_period_length && ptime != apdo->period_length) {
546 dolog("Requested period time %" PRId32 " was rejected, using %d\n",
547 apdo->period_length, ptime);
551 err = snd_pcm_hw_params (handle, hw_params);
553 alsa_logerr2 (err, typ, "Failed to apply audio parameters\n");
557 err = snd_pcm_hw_params_get_buffer_size (hw_params, &obt_buffer_size);
559 alsa_logerr2 (err, typ, "Failed to get buffer size\n");
563 err = snd_pcm_hw_params_get_format (hw_params, &obtfmt);
565 alsa_logerr2 (err, typ, "Failed to get format\n");
569 if (alsa_to_audfmt (obtfmt, &obt->fmt, &obt->endianness)) {
570 dolog ("Invalid format was returned %d\n", obtfmt);
574 err = snd_pcm_prepare (handle);
576 alsa_logerr2 (err, typ, "Could not prepare handle %p\n", handle);
580 if (!in && aopts->has_threshold && aopts->threshold) {
581 struct audsettings as = { .freq = freq };
584 audio_buffer_frames(qapi_AudiodevAlsaPerDirectionOptions_base(apdo),
585 &as, aopts->threshold));
588 obt->nchannels = nchannels;
590 obt->samples = obt_buffer_size;
594 if (obtfmt != req->fmt ||
595 obt->nchannels != req->nchannels ||
596 obt->freq != req->freq) {
597 dolog ("Audio parameters for %s\n", typ);
598 alsa_dump_info(req, obt, obtfmt, apdo);
602 alsa_dump_info(req, obt, obtfmt, pdo);
607 alsa_anal_close1 (&handle);
611 static size_t alsa_write(HWVoiceOut *hw, void *buf, size_t len)
613 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
615 size_t len_frames = len / hw->info.bytes_per_frame;
618 char *src = advance(buf, pos);
619 snd_pcm_sframes_t written;
621 written = snd_pcm_writei(alsa->handle, src, len_frames);
626 trace_alsa_wrote_zero(len_frames);
630 if (alsa_recover(alsa->handle)) {
631 alsa_logerr(written, "Failed to write %zu frames\n",
635 trace_alsa_xrun_out();
640 * stream is suspended and waiting for an application
643 if (alsa_resume(alsa->handle)) {
644 alsa_logerr(written, "Failed to write %zu frames\n",
648 trace_alsa_resume_out();
655 alsa_logerr(written, "Failed to write %zu frames from %p\n",
661 pos += written * hw->info.bytes_per_frame;
662 if (written < len_frames) {
665 len_frames -= written;
671 static void alsa_fini_out (HWVoiceOut *hw)
673 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
675 ldebug ("alsa_fini\n");
676 alsa_anal_close (&alsa->handle, &alsa->pollhlp);
679 static int alsa_init_out(HWVoiceOut *hw, struct audsettings *as,
682 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
683 struct alsa_params_req req;
684 struct alsa_params_obt obt;
686 struct audsettings obt_as;
687 Audiodev *dev = drv_opaque;
689 req.fmt = aud_to_alsafmt (as->fmt, as->endianness);
691 req.nchannels = as->nchannels;
693 if (alsa_open(0, &req, &obt, &handle, dev)) {
697 obt_as.freq = obt.freq;
698 obt_as.nchannels = obt.nchannels;
699 obt_as.fmt = obt.fmt;
700 obt_as.endianness = obt.endianness;
702 audio_pcm_init_info (&hw->info, &obt_as);
703 hw->samples = obt.samples;
705 alsa->pollhlp.s = hw->s;
706 alsa->handle = handle;
711 #define VOICE_CTL_PAUSE 0
712 #define VOICE_CTL_PREPARE 1
713 #define VOICE_CTL_START 2
715 static int alsa_voice_ctl (snd_pcm_t *handle, const char *typ, int ctl)
719 if (ctl == VOICE_CTL_PAUSE) {
720 err = snd_pcm_drop (handle);
722 alsa_logerr (err, "Could not stop %s\n", typ);
727 err = snd_pcm_prepare (handle);
729 alsa_logerr (err, "Could not prepare handle for %s\n", typ);
732 if (ctl == VOICE_CTL_START) {
733 err = snd_pcm_start(handle);
735 alsa_logerr (err, "Could not start handle for %s\n", typ);
744 static void alsa_enable_out(HWVoiceOut *hw, bool enable)
746 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
747 AudiodevAlsaPerDirectionOptions *apdo = alsa->dev->u.alsa.out;
750 bool poll_mode = apdo->try_poll;
752 ldebug("enabling voice\n");
753 if (poll_mode && alsa_poll_out(hw)) {
756 hw->poll_mode = poll_mode;
757 alsa_voice_ctl(alsa->handle, "playback", VOICE_CTL_PREPARE);
759 ldebug("disabling voice\n");
762 alsa_fini_poll(&alsa->pollhlp);
764 alsa_voice_ctl(alsa->handle, "playback", VOICE_CTL_PAUSE);
768 static int alsa_init_in(HWVoiceIn *hw, struct audsettings *as, void *drv_opaque)
770 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
771 struct alsa_params_req req;
772 struct alsa_params_obt obt;
774 struct audsettings obt_as;
775 Audiodev *dev = drv_opaque;
777 req.fmt = aud_to_alsafmt (as->fmt, as->endianness);
779 req.nchannels = as->nchannels;
781 if (alsa_open(1, &req, &obt, &handle, dev)) {
785 obt_as.freq = obt.freq;
786 obt_as.nchannels = obt.nchannels;
787 obt_as.fmt = obt.fmt;
788 obt_as.endianness = obt.endianness;
790 audio_pcm_init_info (&hw->info, &obt_as);
791 hw->samples = obt.samples;
793 alsa->pollhlp.s = hw->s;
794 alsa->handle = handle;
799 static void alsa_fini_in (HWVoiceIn *hw)
801 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
803 alsa_anal_close (&alsa->handle, &alsa->pollhlp);
806 static size_t alsa_read(HWVoiceIn *hw, void *buf, size_t len)
808 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
812 void *dst = advance(buf, pos);
813 snd_pcm_sframes_t nread;
815 nread = snd_pcm_readi(
816 alsa->handle, dst, len / hw->info.bytes_per_frame);
821 trace_alsa_read_zero(len);
825 if (alsa_recover(alsa->handle)) {
826 alsa_logerr(nread, "Failed to read %zu frames\n", len);
829 trace_alsa_xrun_in();
836 alsa_logerr(nread, "Failed to read %zu frames to %p\n",
842 pos += nread * hw->info.bytes_per_frame;
843 len -= nread * hw->info.bytes_per_frame;
849 static void alsa_enable_in(HWVoiceIn *hw, bool enable)
851 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
852 AudiodevAlsaPerDirectionOptions *apdo = alsa->dev->u.alsa.in;
855 bool poll_mode = apdo->try_poll;
857 ldebug("enabling voice\n");
858 if (poll_mode && alsa_poll_in(hw)) {
861 hw->poll_mode = poll_mode;
863 alsa_voice_ctl(alsa->handle, "capture", VOICE_CTL_START);
865 ldebug ("disabling voice\n");
868 alsa_fini_poll(&alsa->pollhlp);
870 alsa_voice_ctl(alsa->handle, "capture", VOICE_CTL_PAUSE);
874 static void alsa_init_per_direction(AudiodevAlsaPerDirectionOptions *apdo)
876 if (!apdo->has_try_poll) {
877 apdo->try_poll = true;
878 apdo->has_try_poll = true;
882 static void *alsa_audio_init(Audiodev *dev)
884 AudiodevAlsaOptions *aopts;
885 assert(dev->driver == AUDIODEV_DRIVER_ALSA);
887 aopts = &dev->u.alsa;
888 alsa_init_per_direction(aopts->in);
889 alsa_init_per_direction(aopts->out);
892 * need to define them, as otherwise alsa produces no sound
893 * doesn't set has_* so alsa_open can identify it wasn't set by the user
895 if (!dev->u.alsa.out->has_period_length) {
896 /* 1024 frames assuming 44100Hz */
897 dev->u.alsa.out->period_length = 1024 * 1000000 / 44100;
899 if (!dev->u.alsa.out->has_buffer_length) {
900 /* 4096 frames assuming 44100Hz */
901 dev->u.alsa.out->buffer_length = 4096ll * 1000000 / 44100;
905 * OptsVisitor sets unspecified optional fields to zero, but do not depend
908 if (!dev->u.alsa.in->has_period_length) {
909 dev->u.alsa.in->period_length = 0;
911 if (!dev->u.alsa.in->has_buffer_length) {
912 dev->u.alsa.in->buffer_length = 0;
918 static void alsa_audio_fini (void *opaque)
922 static struct audio_pcm_ops alsa_pcm_ops = {
923 .init_out = alsa_init_out,
924 .fini_out = alsa_fini_out,
926 .run_buffer_out = audio_generic_run_buffer_out,
927 .enable_out = alsa_enable_out,
929 .init_in = alsa_init_in,
930 .fini_in = alsa_fini_in,
932 .enable_in = alsa_enable_in,
935 static struct audio_driver alsa_audio_driver = {
937 .descr = "ALSA http://www.alsa-project.org",
938 .init = alsa_audio_init,
939 .fini = alsa_audio_fini,
940 .pcm_ops = &alsa_pcm_ops,
942 .max_voices_out = INT_MAX,
943 .max_voices_in = INT_MAX,
944 .voice_size_out = sizeof (ALSAVoiceOut),
945 .voice_size_in = sizeof (ALSAVoiceIn)
948 static void register_audio_alsa(void)
950 audio_driver_register(&alsa_audio_driver);
952 type_init(register_audio_alsa);