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 .pcm_name_out = "default",
62 .pcm_name_in = "default",
65 struct alsa_params_req {
70 unsigned int buffer_size;
71 unsigned int period_size;
74 struct alsa_params_obt {
79 snd_pcm_uframes_t samples;
82 static void GCC_FMT_ATTR (2, 3) alsa_logerr (int err, const char *fmt, ...)
87 AUD_vlog (AUDIO_CAP, fmt, ap);
90 AUD_log (AUDIO_CAP, "Reason: %s\n", snd_strerror (err));
93 static void GCC_FMT_ATTR (3, 4) alsa_logerr2 (
102 AUD_log (AUDIO_CAP, "Could not initialize %s\n", typ);
105 AUD_vlog (AUDIO_CAP, fmt, ap);
108 AUD_log (AUDIO_CAP, "Reason: %s\n", snd_strerror (err));
111 static void alsa_anal_close (snd_pcm_t **handlep)
113 int err = snd_pcm_close (*handlep);
115 alsa_logerr (err, "Failed to close PCM handle %p\n", *handlep);
120 static int alsa_write (SWVoiceOut *sw, void *buf, int len)
122 return audio_pcm_sw_write (sw, buf, len);
125 static snd_pcm_format_t aud_to_alsafmt (audfmt_e fmt)
129 return SND_PCM_FORMAT_S8;
132 return SND_PCM_FORMAT_U8;
135 return SND_PCM_FORMAT_S16_LE;
138 return SND_PCM_FORMAT_U16_LE;
141 return SND_PCM_FORMAT_S32_LE;
144 return SND_PCM_FORMAT_U32_LE;
147 dolog ("Internal logic error: Bad audio format %d\n", fmt);
151 return SND_PCM_FORMAT_U8;
155 static int alsa_to_audfmt (snd_pcm_format_t alsafmt, audfmt_e *fmt,
159 case SND_PCM_FORMAT_S8:
164 case SND_PCM_FORMAT_U8:
169 case SND_PCM_FORMAT_S16_LE:
174 case SND_PCM_FORMAT_U16_LE:
179 case SND_PCM_FORMAT_S16_BE:
184 case SND_PCM_FORMAT_U16_BE:
189 case SND_PCM_FORMAT_S32_LE:
194 case SND_PCM_FORMAT_U32_LE:
199 case SND_PCM_FORMAT_S32_BE:
204 case SND_PCM_FORMAT_U32_BE:
210 dolog ("Unrecognized audio format %d\n", alsafmt);
217 static void alsa_dump_info (struct alsa_params_req *req,
218 struct alsa_params_obt *obt)
220 dolog ("parameter | requested value | obtained value\n");
221 dolog ("format | %10d | %10d\n", req->fmt, obt->fmt);
222 dolog ("channels | %10d | %10d\n",
223 req->nchannels, obt->nchannels);
224 dolog ("frequency | %10d | %10d\n", req->freq, obt->freq);
225 dolog ("============================================\n");
226 dolog ("requested: buffer size %d period size %d\n",
227 req->buffer_size, req->period_size);
228 dolog ("obtained: samples %ld\n", obt->samples);
231 static void alsa_set_threshold (snd_pcm_t *handle, snd_pcm_uframes_t threshold)
234 snd_pcm_sw_params_t *sw_params;
236 snd_pcm_sw_params_alloca (&sw_params);
238 err = snd_pcm_sw_params_current (handle, sw_params);
240 dolog ("Could not fully initialize DAC\n");
241 alsa_logerr (err, "Failed to get current software parameters\n");
245 err = snd_pcm_sw_params_set_start_threshold (handle, sw_params, threshold);
247 dolog ("Could not fully initialize DAC\n");
248 alsa_logerr (err, "Failed to set software threshold to %ld\n",
253 err = snd_pcm_sw_params (handle, sw_params);
255 dolog ("Could not fully initialize DAC\n");
256 alsa_logerr (err, "Failed to set software parameters\n");
261 static int alsa_open (int in, struct alsa_params_req *req,
262 struct alsa_params_obt *obt, snd_pcm_t **handlep)
265 snd_pcm_hw_params_t *hw_params;
268 unsigned int freq, nchannels;
269 const char *pcm_name = in ? conf.pcm_name_in : conf.pcm_name_out;
270 snd_pcm_uframes_t obt_buffer_size;
271 const char *typ = in ? "ADC" : "DAC";
272 snd_pcm_format_t obtfmt;
275 nchannels = req->nchannels;
276 size_in_usec = req->size_in_usec;
278 snd_pcm_hw_params_alloca (&hw_params);
283 in ? SND_PCM_STREAM_CAPTURE : SND_PCM_STREAM_PLAYBACK,
287 alsa_logerr2 (err, typ, "Failed to open `%s':\n", pcm_name);
291 err = snd_pcm_hw_params_any (handle, hw_params);
293 alsa_logerr2 (err, typ, "Failed to initialize hardware parameters\n");
297 err = snd_pcm_hw_params_set_access (
300 SND_PCM_ACCESS_RW_INTERLEAVED
303 alsa_logerr2 (err, typ, "Failed to set access type\n");
307 err = snd_pcm_hw_params_set_format (handle, hw_params, req->fmt);
308 if (err < 0 && conf.verbose) {
309 alsa_logerr2 (err, typ, "Failed to set format %d\n", req->fmt);
312 err = snd_pcm_hw_params_set_rate_near (handle, hw_params, &freq, 0);
314 alsa_logerr2 (err, typ, "Failed to set frequency %d\n", req->freq);
318 err = snd_pcm_hw_params_set_channels_near (
324 alsa_logerr2 (err, typ, "Failed to set number of channels %d\n",
329 if (nchannels != 1 && nchannels != 2) {
330 alsa_logerr2 (err, typ,
331 "Can not handle obtained number of channels %d\n",
336 if (req->buffer_size) {
339 unsigned int btime = req->buffer_size;
341 err = snd_pcm_hw_params_set_buffer_time_near (
349 snd_pcm_uframes_t bsize = req->buffer_size;
351 err = snd_pcm_hw_params_set_buffer_size_near (
358 alsa_logerr2 (err, typ, "Failed to set buffer %s to %d\n",
359 size_in_usec ? "time" : "size", req->buffer_size);
364 if (req->period_size) {
367 unsigned int ptime = req->period_size;
369 err = snd_pcm_hw_params_set_period_time_near (
377 snd_pcm_uframes_t psize = req->period_size;
379 err = snd_pcm_hw_params_set_buffer_size_near (
387 alsa_logerr2 (err, typ, "Failed to set period %s to %d\n",
388 size_in_usec ? "time" : "size", req->period_size);
393 err = snd_pcm_hw_params (handle, hw_params);
395 alsa_logerr2 (err, typ, "Failed to apply audio parameters\n");
399 err = snd_pcm_hw_params_get_buffer_size (hw_params, &obt_buffer_size);
401 alsa_logerr2 (err, typ, "Failed to get buffer size\n");
405 err = snd_pcm_hw_params_get_format (hw_params, &obtfmt);
407 alsa_logerr2 (err, typ, "Failed to get format\n");
411 if (alsa_to_audfmt (obtfmt, &obt->fmt, &obt->endianness)) {
412 dolog ("Invalid format was returned %d\n", obtfmt);
416 err = snd_pcm_prepare (handle);
418 alsa_logerr2 (err, typ, "Could not prepare handle %p\n", handle);
422 if (!in && conf.threshold) {
423 snd_pcm_uframes_t threshold;
426 bytes_per_sec = freq << (nchannels == 2);
444 threshold = (conf.threshold * bytes_per_sec) / 1000;
445 alsa_set_threshold (handle, threshold);
448 obt->nchannels = nchannels;
450 obt->samples = obt_buffer_size;
455 (obt->fmt != req->fmt ||
456 obt->nchannels != req->nchannels ||
457 obt->freq != req->freq)) {
458 dolog ("Audio paramters for %s\n", typ);
459 alsa_dump_info (req, obt);
463 alsa_dump_info (req, obt);
468 alsa_anal_close (&handle);
472 static int alsa_recover (snd_pcm_t *handle)
474 int err = snd_pcm_prepare (handle);
476 alsa_logerr (err, "Failed to prepare handle %p\n", handle);
482 static snd_pcm_sframes_t alsa_get_avail (snd_pcm_t *handle)
484 snd_pcm_sframes_t avail;
486 avail = snd_pcm_avail_update (handle);
488 if (avail == -EPIPE) {
489 if (!alsa_recover (handle)) {
490 avail = snd_pcm_avail_update (handle);
496 "Could not obtain number of available frames\n");
504 static int alsa_run_out (HWVoiceOut *hw)
506 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
507 int rpos, live, decr;
511 snd_pcm_sframes_t avail;
513 live = audio_pcm_hw_get_live_out (hw);
518 avail = alsa_get_avail (alsa->handle);
520 dolog ("Could not get number of available playback frames\n");
524 decr = audio_MIN (live, avail);
528 int left_till_end_samples = hw->samples - rpos;
529 int len = audio_MIN (samples, left_till_end_samples);
530 snd_pcm_sframes_t written;
532 src = hw->mix_buf + rpos;
533 dst = advance (alsa->pcm_buf, rpos << hw->info.shift);
535 hw->clip (dst, src, len);
538 written = snd_pcm_writei (alsa->handle, dst, len);
544 dolog ("Failed to write %d frames (wrote zero)\n", len);
549 if (alsa_recover (alsa->handle)) {
550 alsa_logerr (written, "Failed to write %d frames\n",
555 dolog ("Recovering from playback xrun\n");
563 alsa_logerr (written, "Failed to write %d frames to %p\n",
569 rpos = (rpos + written) % hw->samples;
572 dst = advance (dst, written << hw->info.shift);
582 static void alsa_fini_out (HWVoiceOut *hw)
584 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
586 ldebug ("alsa_fini\n");
587 alsa_anal_close (&alsa->handle);
590 qemu_free (alsa->pcm_buf);
591 alsa->pcm_buf = NULL;
595 static int alsa_init_out (HWVoiceOut *hw, audsettings_t *as)
597 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
598 struct alsa_params_req req;
599 struct alsa_params_obt obt;
601 audsettings_t obt_as;
603 req.fmt = aud_to_alsafmt (as->fmt);
605 req.nchannels = as->nchannels;
606 req.period_size = conf.period_size_out;
607 req.buffer_size = conf.buffer_size_out;
608 req.size_in_usec = conf.size_in_usec_in;
610 if (alsa_open (0, &req, &obt, &handle)) {
614 obt_as.freq = obt.freq;
615 obt_as.nchannels = obt.nchannels;
616 obt_as.fmt = obt.fmt;
617 obt_as.endianness = obt.endianness;
619 audio_pcm_init_info (&hw->info, &obt_as);
620 hw->samples = obt.samples;
622 alsa->pcm_buf = audio_calloc (AUDIO_FUNC, obt.samples, 1 << hw->info.shift);
623 if (!alsa->pcm_buf) {
624 dolog ("Could not allocate DAC buffer (%d samples, each %d bytes)\n",
625 hw->samples, 1 << hw->info.shift);
626 alsa_anal_close (&handle);
630 alsa->handle = handle;
634 static int alsa_voice_ctl (snd_pcm_t *handle, const char *typ, int pause)
639 err = snd_pcm_drop (handle);
641 alsa_logerr (err, "Could not stop %s\n", typ);
646 err = snd_pcm_prepare (handle);
648 alsa_logerr (err, "Could not prepare handle for %s\n", typ);
656 static int alsa_ctl_out (HWVoiceOut *hw, int cmd, ...)
658 ALSAVoiceOut *alsa = (ALSAVoiceOut *) hw;
662 ldebug ("enabling voice\n");
663 return alsa_voice_ctl (alsa->handle, "playback", 0);
666 ldebug ("disabling voice\n");
667 return alsa_voice_ctl (alsa->handle, "playback", 1);
673 static int alsa_init_in (HWVoiceIn *hw, audsettings_t *as)
675 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
676 struct alsa_params_req req;
677 struct alsa_params_obt obt;
679 audsettings_t obt_as;
681 req.fmt = aud_to_alsafmt (as->fmt);
683 req.nchannels = as->nchannels;
684 req.period_size = conf.period_size_in;
685 req.buffer_size = conf.buffer_size_in;
686 req.size_in_usec = conf.size_in_usec_in;
688 if (alsa_open (1, &req, &obt, &handle)) {
692 obt_as.freq = obt.freq;
693 obt_as.nchannels = obt.nchannels;
694 obt_as.fmt = obt.fmt;
695 obt_as.endianness = obt.endianness;
697 audio_pcm_init_info (&hw->info, &obt_as);
698 hw->samples = obt.samples;
700 alsa->pcm_buf = audio_calloc (AUDIO_FUNC, hw->samples, 1 << hw->info.shift);
701 if (!alsa->pcm_buf) {
702 dolog ("Could not allocate ADC buffer (%d samples, each %d bytes)\n",
703 hw->samples, 1 << hw->info.shift);
704 alsa_anal_close (&handle);
708 alsa->handle = handle;
712 static void alsa_fini_in (HWVoiceIn *hw)
714 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
716 alsa_anal_close (&alsa->handle);
719 qemu_free (alsa->pcm_buf);
720 alsa->pcm_buf = NULL;
724 static int alsa_run_in (HWVoiceIn *hw)
726 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
727 int hwshift = hw->info.shift;
729 int live = audio_pcm_hw_get_live_in (hw);
730 int dead = hw->samples - live;
739 snd_pcm_sframes_t avail;
740 snd_pcm_uframes_t read_samples = 0;
746 avail = alsa_get_avail (alsa->handle);
748 dolog ("Could not get number of captured frames\n");
752 if (!avail && (snd_pcm_state (alsa->handle) == SND_PCM_STATE_PREPARED)) {
756 decr = audio_MIN (dead, avail);
761 if (hw->wpos + decr > hw->samples) {
762 bufs[0].len = (hw->samples - hw->wpos);
763 bufs[1].len = (decr - (hw->samples - hw->wpos));
769 for (i = 0; i < 2; ++i) {
772 snd_pcm_sframes_t nread;
773 snd_pcm_uframes_t len;
777 src = advance (alsa->pcm_buf, bufs[i].add << hwshift);
778 dst = hw->conv_buf + bufs[i].add;
781 nread = snd_pcm_readi (alsa->handle, src, len);
787 dolog ("Failed to read %ld frames (read zero)\n", len);
792 if (alsa_recover (alsa->handle)) {
793 alsa_logerr (nread, "Failed to read %ld frames\n", len);
797 dolog ("Recovering from capture xrun\n");
807 "Failed to read %ld frames from %p\n",
815 hw->conv (dst, src, nread, &nominal_volume);
817 src = advance (src, nread << hwshift);
820 read_samples += nread;
826 hw->wpos = (hw->wpos + read_samples) % hw->samples;
830 static int alsa_read (SWVoiceIn *sw, void *buf, int size)
832 return audio_pcm_sw_read (sw, buf, size);
835 static int alsa_ctl_in (HWVoiceIn *hw, int cmd, ...)
837 ALSAVoiceIn *alsa = (ALSAVoiceIn *) hw;
841 ldebug ("enabling voice\n");
842 return alsa_voice_ctl (alsa->handle, "capture", 0);
845 ldebug ("disabling voice\n");
846 return alsa_voice_ctl (alsa->handle, "capture", 1);
852 static void *alsa_audio_init (void)
857 static void alsa_audio_fini (void *opaque)
862 static struct audio_option alsa_options[] = {
863 {"DAC_SIZE_IN_USEC", AUD_OPT_BOOL, &conf.size_in_usec_out,
864 "DAC period/buffer size in microseconds (otherwise in frames)", NULL, 0},
865 {"DAC_PERIOD_SIZE", AUD_OPT_INT, &conf.period_size_out,
866 "DAC period size (0 to go with system default)",
867 &conf.period_size_out_overridden, 0},
868 {"DAC_BUFFER_SIZE", AUD_OPT_INT, &conf.buffer_size_out,
869 "DAC buffer size (0 to go with system default)",
870 &conf.buffer_size_out_overridden, 0},
872 {"ADC_SIZE_IN_USEC", AUD_OPT_BOOL, &conf.size_in_usec_in,
873 "ADC period/buffer size in microseconds (otherwise in frames)", NULL, 0},
874 {"ADC_PERIOD_SIZE", AUD_OPT_INT, &conf.period_size_in,
875 "ADC period size (0 to go with system default)",
876 &conf.period_size_in_overridden, 0},
877 {"ADC_BUFFER_SIZE", AUD_OPT_INT, &conf.buffer_size_in,
878 "ADC buffer size (0 to go with system default)",
879 &conf.buffer_size_in_overridden, 0},
881 {"THRESHOLD", AUD_OPT_INT, &conf.threshold,
882 "(undocumented)", NULL, 0},
884 {"DAC_DEV", AUD_OPT_STR, &conf.pcm_name_out,
885 "DAC device name (for instance dmix)", NULL, 0},
887 {"ADC_DEV", AUD_OPT_STR, &conf.pcm_name_in,
888 "ADC device name", NULL, 0},
890 {"VERBOSE", AUD_OPT_BOOL, &conf.verbose,
891 "Behave in a more verbose way", NULL, 0},
893 {NULL, 0, NULL, NULL, NULL, 0}
896 static struct audio_pcm_ops alsa_pcm_ops = {
910 struct audio_driver alsa_audio_driver = {
911 INIT_FIELD (name = ) "alsa",
912 INIT_FIELD (descr = ) "ALSA http://www.alsa-project.org",
913 INIT_FIELD (options = ) alsa_options,
914 INIT_FIELD (init = ) alsa_audio_init,
915 INIT_FIELD (fini = ) alsa_audio_fini,
916 INIT_FIELD (pcm_ops = ) &alsa_pcm_ops,
917 INIT_FIELD (can_be_default = ) 1,
918 INIT_FIELD (max_voices_out = ) INT_MAX,
919 INIT_FIELD (max_voices_in = ) INT_MAX,
920 INIT_FIELD (voice_size_out = ) sizeof (ALSAVoiceOut),
921 INIT_FIELD (voice_size_in = ) sizeof (ALSAVoiceIn)