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
24 #include <alsa/asoundlib.h>
25 #include "qemu-common.h"
28 #define AUDIO_CAP "alsa"
29 #include "audio_int.h"
31 typedef struct ALSAVoiceOut {
37 typedef struct ALSAVoiceIn {
46 const char *pcm_name_in;
47 const char *pcm_name_out;
48 unsigned int buffer_size_in;
49 unsigned int period_size_in;
50 unsigned int buffer_size_out;
51 unsigned int period_size_out;
52 unsigned int threshold;
54 int buffer_size_in_overridden;
55 int period_size_in_overridden;
57 int buffer_size_out_overridden;
58 int period_size_out_overridden;
61 #define DEFAULT_BUFFER_SIZE 1024
62 #define DEFAULT_PERIOD_SIZE 256
65 .size_in_usec_out = 1,
67 .pcm_name_out = "default",
68 .pcm_name_in = "default",
70 .buffer_size_in = 400000,
71 .period_size_in = 400000 / 4,
72 .buffer_size_out = 400000,
73 .period_size_out = 400000 / 4,
75 .buffer_size_in = DEFAULT_BUFFER_SIZE * 4,
76 .period_size_in = DEFAULT_PERIOD_SIZE * 4,
77 .buffer_size_out = DEFAULT_BUFFER_SIZE,
78 .period_size_out = DEFAULT_PERIOD_SIZE,
79 .buffer_size_in_overridden = 0,
80 .buffer_size_out_overridden = 0,
81 .period_size_in_overridden = 0,
82 .period_size_out_overridden = 0,
88 struct alsa_params_req {
92 unsigned int buffer_size;
93 unsigned int period_size;
96 struct alsa_params_obt {
101 snd_pcm_uframes_t samples;
104 static void GCC_FMT_ATTR (2, 3) alsa_logerr (int err, const char *fmt, ...)
109 AUD_vlog (AUDIO_CAP, fmt, ap);
112 AUD_log (AUDIO_CAP, "Reason: %s\n", snd_strerror (err));
115 static void GCC_FMT_ATTR (3, 4) alsa_logerr2 (
124 AUD_log (AUDIO_CAP, "Could not initialize %s\n", typ);
127 AUD_vlog (AUDIO_CAP, fmt, ap);
130 AUD_log (AUDIO_CAP, "Reason: %s\n", snd_strerror (err));
133 static void alsa_anal_close (snd_pcm_t **handlep)
135 int err = snd_pcm_close (*handlep);
137 alsa_logerr (err, "Failed to close PCM handle %p\n", *handlep);
142 static int alsa_write (SWVoiceOut *sw, void *buf, int len)
144 return audio_pcm_sw_write (sw, buf, len);
147 static snd_pcm_format_t aud_to_alsafmt (audfmt_e fmt)
151 return SND_PCM_FORMAT_S8;
154 return SND_PCM_FORMAT_U8;
157 return SND_PCM_FORMAT_S16_LE;
160 return SND_PCM_FORMAT_U16_LE;
163 return SND_PCM_FORMAT_S32_LE;
166 return SND_PCM_FORMAT_U32_LE;
169 dolog ("Internal logic error: Bad audio format %d\n", fmt);
173 return SND_PCM_FORMAT_U8;
177 static int alsa_to_audfmt (snd_pcm_format_t alsafmt, audfmt_e *fmt,
181 case SND_PCM_FORMAT_S8:
186 case SND_PCM_FORMAT_U8:
191 case SND_PCM_FORMAT_S16_LE:
196 case SND_PCM_FORMAT_U16_LE:
201 case SND_PCM_FORMAT_S16_BE:
206 case SND_PCM_FORMAT_U16_BE:
211 case SND_PCM_FORMAT_S32_LE:
216 case SND_PCM_FORMAT_U32_LE:
221 case SND_PCM_FORMAT_S32_BE:
226 case SND_PCM_FORMAT_U32_BE:
232 dolog ("Unrecognized audio format %d\n", alsafmt);
239 static void alsa_dump_info (struct alsa_params_req *req,
240 struct alsa_params_obt *obt)
242 dolog ("parameter | requested value | obtained value\n");
243 dolog ("format | %10d | %10d\n", req->fmt, obt->fmt);
244 dolog ("channels | %10d | %10d\n",
245 req->nchannels, obt->nchannels);
246 dolog ("frequency | %10d | %10d\n", req->freq, obt->freq);
247 dolog ("============================================\n");
248 dolog ("requested: buffer size %d period size %d\n",
249 req->buffer_size, req->period_size);
250 dolog ("obtained: samples %ld\n", obt->samples);
253 static void alsa_set_threshold (snd_pcm_t *handle, snd_pcm_uframes_t threshold)
256 snd_pcm_sw_params_t *sw_params;
258 snd_pcm_sw_params_alloca (&sw_params);
260 err = snd_pcm_sw_params_current (handle, sw_params);
262 dolog ("Could not fully initialize DAC\n");
263 alsa_logerr (err, "Failed to get current software parameters\n");
267 err = snd_pcm_sw_params_set_start_threshold (handle, sw_params, threshold);
269 dolog ("Could not fully initialize DAC\n");
270 alsa_logerr (err, "Failed to set software threshold to %ld\n",
275 err = snd_pcm_sw_params (handle, sw_params);
277 dolog ("Could not fully initialize DAC\n");
278 alsa_logerr (err, "Failed to set software parameters\n");
283 static int alsa_open (int in, struct alsa_params_req *req,
284 struct alsa_params_obt *obt, snd_pcm_t **handlep)
287 snd_pcm_hw_params_t *hw_params;
289 unsigned int freq, nchannels;
290 const char *pcm_name = in ? conf.pcm_name_in : conf.pcm_name_out;
291 unsigned int period_size, buffer_size;
292 snd_pcm_uframes_t obt_buffer_size;
293 const char *typ = in ? "ADC" : "DAC";
294 snd_pcm_format_t obtfmt;
297 period_size = req->period_size;
298 buffer_size = req->buffer_size;
299 nchannels = req->nchannels;
301 snd_pcm_hw_params_alloca (&hw_params);
306 in ? SND_PCM_STREAM_CAPTURE : SND_PCM_STREAM_PLAYBACK,
310 alsa_logerr2 (err, typ, "Failed to open `%s':\n", pcm_name);
314 err = snd_pcm_hw_params_any (handle, hw_params);
316 alsa_logerr2 (err, typ, "Failed to initialize hardware parameters\n");
320 err = snd_pcm_hw_params_set_access (
323 SND_PCM_ACCESS_RW_INTERLEAVED
326 alsa_logerr2 (err, typ, "Failed to set access type\n");
330 err = snd_pcm_hw_params_set_format (handle, hw_params, req->fmt);
331 if (err < 0 && conf.verbose) {
332 alsa_logerr2 (err, typ, "Failed to set format %d\n", req->fmt);
335 err = snd_pcm_hw_params_set_rate_near (handle, hw_params, &freq, 0);
337 alsa_logerr2 (err, typ, "Failed to set frequency %d\n", req->freq);
341 err = snd_pcm_hw_params_set_channels_near (
347 alsa_logerr2 (err, typ, "Failed to set number of channels %d\n",
352 if (nchannels != 1 && nchannels != 2) {
353 alsa_logerr2 (err, typ,
354 "Can not handle obtained number of channels %d\n",
359 if (!((in && conf.size_in_usec_in) || (!in && conf.size_in_usec_out))) {
361 buffer_size = DEFAULT_BUFFER_SIZE;
362 period_size= DEFAULT_PERIOD_SIZE;
367 if ((in && conf.size_in_usec_in) || (!in && conf.size_in_usec_out)) {
369 err = snd_pcm_hw_params_set_period_time_near (
376 alsa_logerr2 (err, typ,
377 "Failed to set period time %d\n",
383 err = snd_pcm_hw_params_set_buffer_time_near (
391 alsa_logerr2 (err, typ,
392 "Failed to set buffer time %d\n",
399 snd_pcm_uframes_t minval;
402 minval = period_size;
405 err = snd_pcm_hw_params_get_period_size_min (
413 "Could not get minmal period size for %s\n",
418 if (period_size < minval) {
419 if ((in && conf.period_size_in_overridden)
420 || (!in && conf.period_size_out_overridden)) {
421 dolog ("%s period size(%d) is less "
422 "than minmal period size(%ld)\n",
427 period_size = minval;
431 err = snd_pcm_hw_params_set_period_size (
438 alsa_logerr2 (err, typ, "Failed to set period size %d\n",
444 minval = buffer_size;
445 err = snd_pcm_hw_params_get_buffer_size_min (
450 alsa_logerr (err, "Could not get minmal buffer size for %s\n",
454 if (buffer_size < minval) {
455 if ((in && conf.buffer_size_in_overridden)
456 || (!in && conf.buffer_size_out_overridden)) {
458 "%s buffer size(%d) is less "
459 "than minimal buffer size(%ld)\n",
465 buffer_size = minval;
469 err = snd_pcm_hw_params_set_buffer_size (
475 alsa_logerr2 (err, typ, "Failed to set buffer size %d\n",
482 dolog ("warning: Buffer size is not set\n");
485 err = snd_pcm_hw_params (handle, hw_params);
487 alsa_logerr2 (err, typ, "Failed to apply audio parameters\n");
491 err = snd_pcm_hw_params_get_buffer_size (hw_params, &obt_buffer_size);
493 alsa_logerr2 (err, typ, "Failed to get buffer size\n");
497 err = snd_pcm_hw_params_get_format (hw_params, &obtfmt);
499 alsa_logerr2 (err, typ, "Failed to get format\n");
503 if (alsa_to_audfmt (obtfmt, &obt->fmt, &obt->endianness)) {
504 dolog ("Invalid format was returned %d\n", obtfmt);
508 err = snd_pcm_prepare (handle);
510 alsa_logerr2 (err, typ, "Could not prepare handle %p\n", handle);
514 if (!in && conf.threshold) {
515 snd_pcm_uframes_t threshold;
518 bytes_per_sec = freq << (nchannels == 2);
536 threshold = (conf.threshold * bytes_per_sec) / 1000;
537 alsa_set_threshold (handle, threshold);
540 obt->nchannels = nchannels;
542 obt->samples = obt_buffer_size;
547 (obt->fmt != req->fmt ||
548 obt->nchannels != req->nchannels ||
549 obt->freq != req->freq)) {
550 dolog ("Audio paramters for %s\n", typ);
551 alsa_dump_info (req, obt);
555 alsa_dump_info (req, obt);
560 alsa_anal_close (&handle);
564 static int alsa_recover (snd_pcm_t *handle)
566 int err = snd_pcm_prepare (handle);
568 alsa_logerr (err, "Failed to prepare handle %p\n", handle);
574 static snd_pcm_sframes_t alsa_get_avail (snd_pcm_t *handle)
576 snd_pcm_sframes_t avail;
578 avail = snd_pcm_avail_update (handle);
580 if (avail == -EPIPE) {
581 if (!alsa_recover (handle)) {
582 avail = snd_pcm_avail_update (handle);
588 "Could not obtain number of available frames\n");
596 static int alsa_run_out (HWVoiceOut *hw)
598 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
599 int rpos, live, decr;
603 snd_pcm_sframes_t avail;
605 live = audio_pcm_hw_get_live_out (hw);
610 avail = alsa_get_avail (alsa->handle);
612 dolog ("Could not get number of available playback frames\n");
616 decr = audio_MIN (live, avail);
620 int left_till_end_samples = hw->samples - rpos;
621 int len = audio_MIN (samples, left_till_end_samples);
622 snd_pcm_sframes_t written;
624 src = hw->mix_buf + rpos;
625 dst = advance (alsa->pcm_buf, rpos << hw->info.shift);
627 hw->clip (dst, src, len);
630 written = snd_pcm_writei (alsa->handle, dst, len);
636 dolog ("Failed to write %d frames (wrote zero)\n", len);
641 if (alsa_recover (alsa->handle)) {
642 alsa_logerr (written, "Failed to write %d frames\n",
647 dolog ("Recovering from playback xrun\n");
655 alsa_logerr (written, "Failed to write %d frames to %p\n",
661 rpos = (rpos + written) % hw->samples;
664 dst = advance (dst, written << hw->info.shift);
674 static void alsa_fini_out (HWVoiceOut *hw)
676 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
678 ldebug ("alsa_fini\n");
679 alsa_anal_close (&alsa->handle);
682 qemu_free (alsa->pcm_buf);
683 alsa->pcm_buf = NULL;
687 static int alsa_init_out (HWVoiceOut *hw, audsettings_t *as)
689 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
690 struct alsa_params_req req;
691 struct alsa_params_obt obt;
693 audsettings_t obt_as;
695 req.fmt = aud_to_alsafmt (as->fmt);
697 req.nchannels = as->nchannels;
698 req.period_size = conf.period_size_out;
699 req.buffer_size = conf.buffer_size_out;
701 if (alsa_open (0, &req, &obt, &handle)) {
705 obt_as.freq = obt.freq;
706 obt_as.nchannels = obt.nchannels;
707 obt_as.fmt = obt.fmt;
708 obt_as.endianness = obt.endianness;
710 audio_pcm_init_info (&hw->info, &obt_as);
711 hw->samples = obt.samples;
713 alsa->pcm_buf = audio_calloc (AUDIO_FUNC, obt.samples, 1 << hw->info.shift);
714 if (!alsa->pcm_buf) {
715 dolog ("Could not allocate DAC buffer (%d samples, each %d bytes)\n",
716 hw->samples, 1 << hw->info.shift);
717 alsa_anal_close (&handle);
721 alsa->handle = handle;
725 static int alsa_voice_ctl (snd_pcm_t *handle, const char *typ, int pause)
730 err = snd_pcm_drop (handle);
732 alsa_logerr (err, "Could not stop %s\n", typ);
737 err = snd_pcm_prepare (handle);
739 alsa_logerr (err, "Could not prepare handle for %s\n", typ);
747 static int alsa_ctl_out (HWVoiceOut *hw, int cmd, ...)
749 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
753 ldebug ("enabling voice\n");
754 return alsa_voice_ctl (alsa->handle, "playback", 0);
757 ldebug ("disabling voice\n");
758 return alsa_voice_ctl (alsa->handle, "playback", 1);
764 static int alsa_init_in (HWVoiceIn *hw, audsettings_t *as)
766 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
767 struct alsa_params_req req;
768 struct alsa_params_obt obt;
770 audsettings_t obt_as;
772 req.fmt = aud_to_alsafmt (as->fmt);
774 req.nchannels = as->nchannels;
775 req.period_size = conf.period_size_in;
776 req.buffer_size = conf.buffer_size_in;
778 if (alsa_open (1, &req, &obt, &handle)) {
782 obt_as.freq = obt.freq;
783 obt_as.nchannels = obt.nchannels;
784 obt_as.fmt = obt.fmt;
785 obt_as.endianness = obt.endianness;
787 audio_pcm_init_info (&hw->info, &obt_as);
788 hw->samples = obt.samples;
790 alsa->pcm_buf = audio_calloc (AUDIO_FUNC, hw->samples, 1 << hw->info.shift);
791 if (!alsa->pcm_buf) {
792 dolog ("Could not allocate ADC buffer (%d samples, each %d bytes)\n",
793 hw->samples, 1 << hw->info.shift);
794 alsa_anal_close (&handle);
798 alsa->handle = handle;
802 static void alsa_fini_in (HWVoiceIn *hw)
804 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
806 alsa_anal_close (&alsa->handle);
809 qemu_free (alsa->pcm_buf);
810 alsa->pcm_buf = NULL;
814 static int alsa_run_in (HWVoiceIn *hw)
816 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
817 int hwshift = hw->info.shift;
819 int live = audio_pcm_hw_get_live_in (hw);
820 int dead = hw->samples - live;
829 snd_pcm_sframes_t avail;
830 snd_pcm_uframes_t read_samples = 0;
836 avail = alsa_get_avail (alsa->handle);
838 dolog ("Could not get number of captured frames\n");
842 if (!avail && (snd_pcm_state (alsa->handle) == SND_PCM_STATE_PREPARED)) {
846 decr = audio_MIN (dead, avail);
851 if (hw->wpos + decr > hw->samples) {
852 bufs[0].len = (hw->samples - hw->wpos);
853 bufs[1].len = (decr - (hw->samples - hw->wpos));
859 for (i = 0; i < 2; ++i) {
862 snd_pcm_sframes_t nread;
863 snd_pcm_uframes_t len;
867 src = advance (alsa->pcm_buf, bufs[i].add << hwshift);
868 dst = hw->conv_buf + bufs[i].add;
871 nread = snd_pcm_readi (alsa->handle, src, len);
877 dolog ("Failed to read %ld frames (read zero)\n", len);
882 if (alsa_recover (alsa->handle)) {
883 alsa_logerr (nread, "Failed to read %ld frames\n", len);
887 dolog ("Recovering from capture xrun\n");
897 "Failed to read %ld frames from %p\n",
905 hw->conv (dst, src, nread, &nominal_volume);
907 src = advance (src, nread << hwshift);
910 read_samples += nread;
916 hw->wpos = (hw->wpos + read_samples) % hw->samples;
920 static int alsa_read (SWVoiceIn *sw, void *buf, int size)
922 return audio_pcm_sw_read (sw, buf, size);
925 static int alsa_ctl_in (HWVoiceIn *hw, int cmd, ...)
927 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
931 ldebug ("enabling voice\n");
932 return alsa_voice_ctl (alsa->handle, "capture", 0);
935 ldebug ("disabling voice\n");
936 return alsa_voice_ctl (alsa->handle, "capture", 1);
942 static void *alsa_audio_init (void)
947 static void alsa_audio_fini (void *opaque)
952 static struct audio_option alsa_options[] = {
953 {"DAC_SIZE_IN_USEC", AUD_OPT_BOOL, &conf.size_in_usec_out,
954 "DAC period/buffer size in microseconds (otherwise in frames)", NULL, 0},
955 {"DAC_PERIOD_SIZE", AUD_OPT_INT, &conf.period_size_out,
956 "DAC period size", &conf.period_size_out_overridden, 0},
957 {"DAC_BUFFER_SIZE", AUD_OPT_INT, &conf.buffer_size_out,
958 "DAC buffer size", &conf.buffer_size_out_overridden, 0},
960 {"ADC_SIZE_IN_USEC", AUD_OPT_BOOL, &conf.size_in_usec_in,
961 "ADC period/buffer size in microseconds (otherwise in frames)", NULL, 0},
962 {"ADC_PERIOD_SIZE", AUD_OPT_INT, &conf.period_size_in,
963 "ADC period size", &conf.period_size_in_overridden, 0},
964 {"ADC_BUFFER_SIZE", AUD_OPT_INT, &conf.buffer_size_in,
965 "ADC buffer size", &conf.buffer_size_in_overridden, 0},
967 {"THRESHOLD", AUD_OPT_INT, &conf.threshold,
968 "(undocumented)", NULL, 0},
970 {"DAC_DEV", AUD_OPT_STR, &conf.pcm_name_out,
971 "DAC device name (for instance dmix)", NULL, 0},
973 {"ADC_DEV", AUD_OPT_STR, &conf.pcm_name_in,
974 "ADC device name", NULL, 0},
976 {"VERBOSE", AUD_OPT_BOOL, &conf.verbose,
977 "Behave in a more verbose way", NULL, 0},
979 {NULL, 0, NULL, NULL, NULL, 0}
982 static struct audio_pcm_ops alsa_pcm_ops = {
996 struct audio_driver alsa_audio_driver = {
997 INIT_FIELD (name = ) "alsa",
998 INIT_FIELD (descr = ) "ALSA http://www.alsa-project.org",
999 INIT_FIELD (options = ) alsa_options,
1000 INIT_FIELD (init = ) alsa_audio_init,
1001 INIT_FIELD (fini = ) alsa_audio_fini,
1002 INIT_FIELD (pcm_ops = ) &alsa_pcm_ops,
1003 INIT_FIELD (can_be_default = ) 1,
1004 INIT_FIELD (max_voices_out = ) INT_MAX,
1005 INIT_FIELD (max_voices_in = ) INT_MAX,
1006 INIT_FIELD (voice_size_out = ) sizeof (ALSAVoiceOut),
1007 INIT_FIELD (voice_size_in = ) sizeof (ALSAVoiceIn)