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
{
91 unsigned int nchannels
;
92 unsigned int buffer_size
;
93 unsigned int period_size
;
96 struct alsa_params_obt
{
100 snd_pcm_uframes_t samples
;
103 static void GCC_FMT_ATTR (2, 3) alsa_logerr (int err
, const char *fmt
, ...)
108 AUD_vlog (AUDIO_CAP
, fmt
, ap
);
111 AUD_log (AUDIO_CAP
, "Reason: %s\n", snd_strerror (err
));
114 static void GCC_FMT_ATTR (3, 4) alsa_logerr2 (
123 AUD_log (AUDIO_CAP
, "Could not initialize %s\n", typ
);
126 AUD_vlog (AUDIO_CAP
, fmt
, ap
);
129 AUD_log (AUDIO_CAP
, "Reason: %s\n", snd_strerror (err
));
132 static void alsa_anal_close (snd_pcm_t
**handlep
)
134 int err
= snd_pcm_close (*handlep
);
136 alsa_logerr (err
, "Failed to close PCM handle %p\n", *handlep
);
141 static int alsa_write (SWVoiceOut
*sw
, void *buf
, int len
)
143 return audio_pcm_sw_write (sw
, buf
, len
);
146 static int aud_to_alsafmt (audfmt_e fmt
)
150 return SND_PCM_FORMAT_S8
;
153 return SND_PCM_FORMAT_U8
;
156 return SND_PCM_FORMAT_S16_LE
;
159 return SND_PCM_FORMAT_U16_LE
;
162 return SND_PCM_FORMAT_S32_LE
;
165 return SND_PCM_FORMAT_U32_LE
;
168 dolog ("Internal logic error: Bad audio format %d\n", fmt
);
172 return SND_PCM_FORMAT_U8
;
176 static int alsa_to_audfmt (int alsafmt
, audfmt_e
*fmt
, int *endianness
)
179 case SND_PCM_FORMAT_S8
:
184 case SND_PCM_FORMAT_U8
:
189 case SND_PCM_FORMAT_S16_LE
:
194 case SND_PCM_FORMAT_U16_LE
:
199 case SND_PCM_FORMAT_S16_BE
:
204 case SND_PCM_FORMAT_U16_BE
:
209 case SND_PCM_FORMAT_S32_LE
:
214 case SND_PCM_FORMAT_U32_LE
:
219 case SND_PCM_FORMAT_S32_BE
:
224 case SND_PCM_FORMAT_U32_BE
:
230 dolog ("Unrecognized audio format %d\n", alsafmt
);
237 #if defined DEBUG_MISMATCHES || defined DEBUG
238 static void alsa_dump_info (struct alsa_params_req
*req
,
239 struct alsa_params_obt
*obt
)
241 dolog ("parameter | requested value | obtained value\n");
242 dolog ("format | %10d | %10d\n", req
->fmt
, obt
->fmt
);
243 dolog ("channels | %10d | %10d\n",
244 req
->nchannels
, obt
->nchannels
);
245 dolog ("frequency | %10d | %10d\n", req
->freq
, obt
->freq
);
246 dolog ("============================================\n");
247 dolog ("requested: buffer size %d period size %d\n",
248 req
->buffer_size
, req
->period_size
);
249 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";
296 period_size
= req
->period_size
;
297 buffer_size
= req
->buffer_size
;
298 nchannels
= req
->nchannels
;
300 snd_pcm_hw_params_alloca (&hw_params
);
305 in
? SND_PCM_STREAM_CAPTURE
: SND_PCM_STREAM_PLAYBACK
,
309 alsa_logerr2 (err
, typ
, "Failed to open `%s':\n", pcm_name
);
313 err
= snd_pcm_hw_params_any (handle
, hw_params
);
315 alsa_logerr2 (err
, typ
, "Failed to initialize hardware parameters\n");
319 err
= snd_pcm_hw_params_set_access (
322 SND_PCM_ACCESS_RW_INTERLEAVED
325 alsa_logerr2 (err
, typ
, "Failed to set access type\n");
329 err
= snd_pcm_hw_params_set_format (handle
, hw_params
, req
->fmt
);
331 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_prepare (handle
);
499 alsa_logerr2 (err
, typ
, "Could not prepare handle %p\n", handle
);
503 if (!in
&& conf
.threshold
) {
504 snd_pcm_uframes_t threshold
;
509 << (req
->fmt
== AUD_FMT_S16
|| req
->fmt
== AUD_FMT_U16
);
511 threshold
= (conf
.threshold
* bytes_per_sec
) / 1000;
512 alsa_set_threshold (handle
, threshold
);
516 obt
->nchannels
= nchannels
;
518 obt
->samples
= obt_buffer_size
;
521 #if defined DEBUG_MISMATCHES || defined DEBUG
522 if (obt
->fmt
!= req
->fmt
||
523 obt
->nchannels
!= req
->nchannels
||
524 obt
->freq
!= req
->freq
) {
525 dolog ("Audio paramters mismatch for %s\n", typ
);
526 alsa_dump_info (req
, obt
);
531 alsa_dump_info (req
, obt
);
536 alsa_anal_close (&handle
);
540 static int alsa_recover (snd_pcm_t
*handle
)
542 int err
= snd_pcm_prepare (handle
);
544 alsa_logerr (err
, "Failed to prepare handle %p\n", handle
);
550 static snd_pcm_sframes_t
alsa_get_avail (snd_pcm_t
*handle
)
552 snd_pcm_sframes_t avail
;
554 avail
= snd_pcm_avail_update (handle
);
556 if (avail
== -EPIPE
) {
557 if (!alsa_recover (handle
)) {
558 avail
= snd_pcm_avail_update (handle
);
564 "Could not obtain number of available frames\n");
572 static int alsa_run_out (HWVoiceOut
*hw
)
574 ALSAVoiceOut
*alsa
= (ALSAVoiceOut
*) hw
;
575 int rpos
, live
, decr
;
579 snd_pcm_sframes_t avail
;
581 live
= audio_pcm_hw_get_live_out (hw
);
586 avail
= alsa_get_avail (alsa
->handle
);
588 dolog ("Could not get number of available playback frames\n");
592 decr
= audio_MIN (live
, avail
);
596 int left_till_end_samples
= hw
->samples
- rpos
;
597 int len
= audio_MIN (samples
, left_till_end_samples
);
598 snd_pcm_sframes_t written
;
600 src
= hw
->mix_buf
+ rpos
;
601 dst
= advance (alsa
->pcm_buf
, rpos
<< hw
->info
.shift
);
603 hw
->clip (dst
, src
, len
);
606 written
= snd_pcm_writei (alsa
->handle
, dst
, len
);
612 dolog ("Failed to write %d frames (wrote zero)\n", len
);
617 if (alsa_recover (alsa
->handle
)) {
618 alsa_logerr (written
, "Failed to write %d frames\n",
623 dolog ("Recovering from playback xrun\n");
631 alsa_logerr (written
, "Failed to write %d frames to %p\n",
637 rpos
= (rpos
+ written
) % hw
->samples
;
640 dst
= advance (dst
, written
<< hw
->info
.shift
);
650 static void alsa_fini_out (HWVoiceOut
*hw
)
652 ALSAVoiceOut
*alsa
= (ALSAVoiceOut
*) hw
;
654 ldebug ("alsa_fini\n");
655 alsa_anal_close (&alsa
->handle
);
658 qemu_free (alsa
->pcm_buf
);
659 alsa
->pcm_buf
= NULL
;
663 static int alsa_init_out (HWVoiceOut
*hw
, audsettings_t
*as
)
665 ALSAVoiceOut
*alsa
= (ALSAVoiceOut
*) hw
;
666 struct alsa_params_req req
;
667 struct alsa_params_obt obt
;
668 audfmt_e effective_fmt
;
672 audsettings_t obt_as
;
674 req
.fmt
= aud_to_alsafmt (as
->fmt
);
676 req
.nchannels
= as
->nchannels
;
677 req
.period_size
= conf
.period_size_out
;
678 req
.buffer_size
= conf
.buffer_size_out
;
680 if (alsa_open (0, &req
, &obt
, &handle
)) {
684 err
= alsa_to_audfmt (obt
.fmt
, &effective_fmt
, &endianness
);
686 alsa_anal_close (&handle
);
690 obt_as
.freq
= obt
.freq
;
691 obt_as
.nchannels
= obt
.nchannels
;
692 obt_as
.fmt
= effective_fmt
;
693 obt_as
.endianness
= endianness
;
695 audio_pcm_init_info (&hw
->info
, &obt_as
);
696 hw
->samples
= obt
.samples
;
698 alsa
->pcm_buf
= audio_calloc (AUDIO_FUNC
, obt
.samples
, 1 << hw
->info
.shift
);
699 if (!alsa
->pcm_buf
) {
700 dolog ("Could not allocate DAC buffer (%d samples, each %d bytes)\n",
701 hw
->samples
, 1 << hw
->info
.shift
);
702 alsa_anal_close (&handle
);
706 alsa
->handle
= handle
;
710 static int alsa_voice_ctl (snd_pcm_t
*handle
, const char *typ
, int pause
)
715 err
= snd_pcm_drop (handle
);
717 alsa_logerr (err
, "Could not stop %s\n", typ
);
722 err
= snd_pcm_prepare (handle
);
724 alsa_logerr (err
, "Could not prepare handle for %s\n", typ
);
732 static int alsa_ctl_out (HWVoiceOut
*hw
, int cmd
, ...)
734 ALSAVoiceOut
*alsa
= (ALSAVoiceOut
*) hw
;
738 ldebug ("enabling voice\n");
739 return alsa_voice_ctl (alsa
->handle
, "playback", 0);
742 ldebug ("disabling voice\n");
743 return alsa_voice_ctl (alsa
->handle
, "playback", 1);
749 static int alsa_init_in (HWVoiceIn
*hw
, audsettings_t
*as
)
751 ALSAVoiceIn
*alsa
= (ALSAVoiceIn
*) hw
;
752 struct alsa_params_req req
;
753 struct alsa_params_obt obt
;
756 audfmt_e effective_fmt
;
758 audsettings_t obt_as
;
760 req
.fmt
= aud_to_alsafmt (as
->fmt
);
762 req
.nchannels
= as
->nchannels
;
763 req
.period_size
= conf
.period_size_in
;
764 req
.buffer_size
= conf
.buffer_size_in
;
766 if (alsa_open (1, &req
, &obt
, &handle
)) {
770 err
= alsa_to_audfmt (obt
.fmt
, &effective_fmt
, &endianness
);
772 alsa_anal_close (&handle
);
776 obt_as
.freq
= obt
.freq
;
777 obt_as
.nchannels
= obt
.nchannels
;
778 obt_as
.fmt
= effective_fmt
;
779 obt_as
.endianness
= endianness
;
781 audio_pcm_init_info (&hw
->info
, &obt_as
);
782 hw
->samples
= obt
.samples
;
784 alsa
->pcm_buf
= audio_calloc (AUDIO_FUNC
, hw
->samples
, 1 << hw
->info
.shift
);
785 if (!alsa
->pcm_buf
) {
786 dolog ("Could not allocate ADC buffer (%d samples, each %d bytes)\n",
787 hw
->samples
, 1 << hw
->info
.shift
);
788 alsa_anal_close (&handle
);
792 alsa
->handle
= handle
;
796 static void alsa_fini_in (HWVoiceIn
*hw
)
798 ALSAVoiceIn
*alsa
= (ALSAVoiceIn
*) hw
;
800 alsa_anal_close (&alsa
->handle
);
803 qemu_free (alsa
->pcm_buf
);
804 alsa
->pcm_buf
= NULL
;
808 static int alsa_run_in (HWVoiceIn
*hw
)
810 ALSAVoiceIn
*alsa
= (ALSAVoiceIn
*) hw
;
811 int hwshift
= hw
->info
.shift
;
813 int live
= audio_pcm_hw_get_live_in (hw
);
814 int dead
= hw
->samples
- live
;
823 snd_pcm_sframes_t avail
;
824 snd_pcm_uframes_t read_samples
= 0;
830 avail
= alsa_get_avail (alsa
->handle
);
832 dolog ("Could not get number of captured frames\n");
836 if (!avail
&& (snd_pcm_state (alsa
->handle
) == SND_PCM_STATE_PREPARED
)) {
840 decr
= audio_MIN (dead
, avail
);
845 if (hw
->wpos
+ decr
> hw
->samples
) {
846 bufs
[0].len
= (hw
->samples
- hw
->wpos
);
847 bufs
[1].len
= (decr
- (hw
->samples
- hw
->wpos
));
853 for (i
= 0; i
< 2; ++i
) {
856 snd_pcm_sframes_t nread
;
857 snd_pcm_uframes_t len
;
861 src
= advance (alsa
->pcm_buf
, bufs
[i
].add
<< hwshift
);
862 dst
= hw
->conv_buf
+ bufs
[i
].add
;
865 nread
= snd_pcm_readi (alsa
->handle
, src
, len
);
871 dolog ("Failed to read %ld frames (read zero)\n", len
);
876 if (alsa_recover (alsa
->handle
)) {
877 alsa_logerr (nread
, "Failed to read %ld frames\n", len
);
881 dolog ("Recovering from capture xrun\n");
891 "Failed to read %ld frames from %p\n",
899 hw
->conv (dst
, src
, nread
, &nominal_volume
);
901 src
= advance (src
, nread
<< hwshift
);
904 read_samples
+= nread
;
910 hw
->wpos
= (hw
->wpos
+ read_samples
) % hw
->samples
;
914 static int alsa_read (SWVoiceIn
*sw
, void *buf
, int size
)
916 return audio_pcm_sw_read (sw
, buf
, size
);
919 static int alsa_ctl_in (HWVoiceIn
*hw
, int cmd
, ...)
921 ALSAVoiceIn
*alsa
= (ALSAVoiceIn
*) hw
;
925 ldebug ("enabling voice\n");
926 return alsa_voice_ctl (alsa
->handle
, "capture", 0);
929 ldebug ("disabling voice\n");
930 return alsa_voice_ctl (alsa
->handle
, "capture", 1);
936 static void *alsa_audio_init (void)
941 static void alsa_audio_fini (void *opaque
)
946 static struct audio_option alsa_options
[] = {
947 {"DAC_SIZE_IN_USEC", AUD_OPT_BOOL
, &conf
.size_in_usec_out
,
948 "DAC period/buffer size in microseconds (otherwise in frames)", NULL
, 0},
949 {"DAC_PERIOD_SIZE", AUD_OPT_INT
, &conf
.period_size_out
,
950 "DAC period size", &conf
.period_size_out_overridden
, 0},
951 {"DAC_BUFFER_SIZE", AUD_OPT_INT
, &conf
.buffer_size_out
,
952 "DAC buffer size", &conf
.buffer_size_out_overridden
, 0},
954 {"ADC_SIZE_IN_USEC", AUD_OPT_BOOL
, &conf
.size_in_usec_in
,
955 "ADC period/buffer size in microseconds (otherwise in frames)", NULL
, 0},
956 {"ADC_PERIOD_SIZE", AUD_OPT_INT
, &conf
.period_size_in
,
957 "ADC period size", &conf
.period_size_in_overridden
, 0},
958 {"ADC_BUFFER_SIZE", AUD_OPT_INT
, &conf
.buffer_size_in
,
959 "ADC buffer size", &conf
.buffer_size_in_overridden
, 0},
961 {"THRESHOLD", AUD_OPT_INT
, &conf
.threshold
,
962 "(undocumented)", NULL
, 0},
964 {"DAC_DEV", AUD_OPT_STR
, &conf
.pcm_name_out
,
965 "DAC device name (for instance dmix)", NULL
, 0},
967 {"ADC_DEV", AUD_OPT_STR
, &conf
.pcm_name_in
,
968 "ADC device name", NULL
, 0},
970 {"VERBOSE", AUD_OPT_BOOL
, &conf
.verbose
,
971 "Behave in a more verbose way", NULL
, 0},
973 {NULL
, 0, NULL
, NULL
, NULL
, 0}
976 static struct audio_pcm_ops alsa_pcm_ops
= {
990 struct audio_driver alsa_audio_driver
= {
991 INIT_FIELD (name
= ) "alsa",
992 INIT_FIELD (descr
= ) "ALSA http://www.alsa-project.org",
993 INIT_FIELD (options
= ) alsa_options
,
994 INIT_FIELD (init
= ) alsa_audio_init
,
995 INIT_FIELD (fini
= ) alsa_audio_fini
,
996 INIT_FIELD (pcm_ops
= ) &alsa_pcm_ops
,
997 INIT_FIELD (can_be_default
= ) 1,
998 INIT_FIELD (max_voices_out
= ) INT_MAX
,
999 INIT_FIELD (max_voices_in
= ) INT_MAX
,
1000 INIT_FIELD (voice_size_out
= ) sizeof (ALSAVoiceOut
),
1001 INIT_FIELD (voice_size_in
= ) sizeof (ALSAVoiceIn
)