2 * QEMU OSS audio driver
4 * Copyright (c) 2003-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 <sys/ioctl.h>
27 #include <sys/soundcard.h>
28 #include "qemu/main-loop.h"
29 #include "qemu/module.h"
30 #include "qemu/host-utils.h"
34 #define AUDIO_CAP "oss"
35 #include "audio_int.h"
37 #if defined OSS_GETVERSION && defined SNDCTL_DSP_POLICY
38 #define USE_DSP_POLICY
41 typedef struct OSSVoiceOut {
53 typedef struct OSSVoiceIn {
70 static void GCC_FMT_ATTR (2, 3) oss_logerr (int err, const char *fmt, ...)
75 AUD_vlog (AUDIO_CAP, fmt, ap);
78 AUD_log (AUDIO_CAP, "Reason: %s\n", strerror (err));
81 static void GCC_FMT_ATTR (3, 4) oss_logerr2 (
90 AUD_log (AUDIO_CAP, "Could not initialize %s\n", typ);
93 AUD_vlog (AUDIO_CAP, fmt, ap);
96 AUD_log (AUDIO_CAP, "Reason: %s\n", strerror (err));
99 static void oss_anal_close (int *fdp)
103 qemu_set_fd_handler (*fdp, NULL, NULL, NULL);
106 oss_logerr (errno, "Failed to close file(fd=%d)\n", *fdp);
111 static void oss_helper_poll_out (void *opaque)
113 AudioState *s = opaque;
114 audio_run(s, "oss_poll_out");
117 static void oss_helper_poll_in (void *opaque)
119 AudioState *s = opaque;
120 audio_run(s, "oss_poll_in");
123 static void oss_poll_out (HWVoiceOut *hw)
125 OSSVoiceOut *oss = (OSSVoiceOut *) hw;
127 qemu_set_fd_handler(oss->fd, NULL, oss_helper_poll_out, hw->s);
130 static void oss_poll_in (HWVoiceIn *hw)
132 OSSVoiceIn *oss = (OSSVoiceIn *) hw;
134 qemu_set_fd_handler(oss->fd, oss_helper_poll_in, NULL, hw->s);
137 static int aud_to_ossfmt (AudioFormat fmt, int endianness)
140 case AUDIO_FORMAT_S8:
143 case AUDIO_FORMAT_U8:
146 case AUDIO_FORMAT_S16:
154 case AUDIO_FORMAT_U16:
163 dolog ("Internal logic error: Bad audio format %d\n", fmt);
171 static int oss_to_audfmt (int ossfmt, AudioFormat *fmt, int *endianness)
176 *fmt = AUDIO_FORMAT_S8;
181 *fmt = AUDIO_FORMAT_U8;
186 *fmt = AUDIO_FORMAT_S16;
191 *fmt = AUDIO_FORMAT_U16;
196 *fmt = AUDIO_FORMAT_S16;
201 *fmt = AUDIO_FORMAT_U16;
205 dolog ("Unrecognized audio format %d\n", ossfmt);
212 #if defined DEBUG_MISMATCHES || defined DEBUG
213 static void oss_dump_info (struct oss_params *req, struct oss_params *obt)
215 dolog ("parameter | requested value | obtained value\n");
216 dolog ("format | %10d | %10d\n", req->fmt, obt->fmt);
217 dolog ("channels | %10d | %10d\n",
218 req->nchannels, obt->nchannels);
219 dolog ("frequency | %10d | %10d\n", req->freq, obt->freq);
220 dolog ("nfrags | %10d | %10d\n", req->nfrags, obt->nfrags);
221 dolog ("fragsize | %10d | %10d\n",
222 req->fragsize, obt->fragsize);
226 #ifdef USE_DSP_POLICY
227 static int oss_get_version (int fd, int *version, const char *typ)
229 if (ioctl (fd, OSS_GETVERSION, &version)) {
230 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
232 * Looks like atm (20100109) FreeBSD knows OSS_GETVERSION
233 * since 7.x, but currently only on the mixer device (or in
234 * the Linuxolator), and in the native version that part of
235 * the code is in fact never reached so the ioctl fails anyway.
236 * Until this is fixed, just check the errno and if its what
237 * FreeBSD's sound drivers return atm assume they are new enough.
239 if (errno == EINVAL) {
244 oss_logerr2 (errno, typ, "Failed to get OSS version\n");
251 static int oss_open(int in, struct oss_params *req, audsettings *as,
252 struct oss_params *obt, int *pfd, Audiodev *dev)
254 AudiodevOssOptions *oopts = &dev->u.oss;
255 AudiodevOssPerDirectionOptions *opdo = in ? oopts->in : oopts->out;
257 int oflags = (oopts->has_exclusive && oopts->exclusive) ? O_EXCL : 0;
258 audio_buf_info abinfo;
259 int fmt, freq, nchannels;
261 const char *dspname = opdo->has_dev ? opdo->dev : "/dev/dsp";
262 const char *typ = in ? "ADC" : "DAC";
263 #ifdef USE_DSP_POLICY
264 int policy = oopts->has_dsp_policy ? oopts->dsp_policy : 5;
267 /* Kludge needed to have working mmap on Linux */
268 oflags |= (oopts->has_try_mmap && oopts->try_mmap) ?
269 O_RDWR : (in ? O_RDONLY : O_WRONLY);
271 fd = open (dspname, oflags | O_NONBLOCK);
273 oss_logerr2 (errno, typ, "Failed to open `%s'\n", dspname);
278 nchannels = req->nchannels;
280 req->nfrags = opdo->has_buffer_count ? opdo->buffer_count : 4;
281 req->fragsize = audio_buffer_bytes(
282 qapi_AudiodevOssPerDirectionOptions_base(opdo), as, 23220);
284 if (ioctl (fd, SNDCTL_DSP_SAMPLESIZE, &fmt)) {
285 oss_logerr2 (errno, typ, "Failed to set sample size %d\n", req->fmt);
289 if (ioctl (fd, SNDCTL_DSP_CHANNELS, &nchannels)) {
290 oss_logerr2 (errno, typ, "Failed to set number of channels %d\n",
295 if (ioctl (fd, SNDCTL_DSP_SPEED, &freq)) {
296 oss_logerr2 (errno, typ, "Failed to set frequency %d\n", req->freq);
300 if (ioctl (fd, SNDCTL_DSP_NONBLOCK, NULL)) {
301 oss_logerr2 (errno, typ, "Failed to set non-blocking mode\n");
305 #ifdef USE_DSP_POLICY
309 if (!oss_get_version (fd, &version, typ)) {
310 trace_oss_version(version);
312 if (version >= 0x040000) {
313 int policy2 = policy;
314 if (ioctl(fd, SNDCTL_DSP_POLICY, &policy2)) {
315 oss_logerr2 (errno, typ,
316 "Failed to set timing policy to %d\n",
327 int mmmmssss = (req->nfrags << 16) | ctz32 (req->fragsize);
328 if (ioctl (fd, SNDCTL_DSP_SETFRAGMENT, &mmmmssss)) {
329 oss_logerr2 (errno, typ, "Failed to set buffer length (%d, %d)\n",
330 req->nfrags, req->fragsize);
335 if (ioctl (fd, in ? SNDCTL_DSP_GETISPACE : SNDCTL_DSP_GETOSPACE, &abinfo)) {
336 oss_logerr2 (errno, typ, "Failed to get buffer length\n");
340 if (!abinfo.fragstotal || !abinfo.fragsize) {
341 AUD_log (AUDIO_CAP, "Returned bogus buffer information(%d, %d) for %s\n",
342 abinfo.fragstotal, abinfo.fragsize, typ);
347 obt->nchannels = nchannels;
349 obt->nfrags = abinfo.fragstotal;
350 obt->fragsize = abinfo.fragsize;
353 #ifdef DEBUG_MISMATCHES
354 if ((req->fmt != obt->fmt) ||
355 (req->nchannels != obt->nchannels) ||
356 (req->freq != obt->freq) ||
357 (req->fragsize != obt->fragsize) ||
358 (req->nfrags != obt->nfrags)) {
359 dolog ("Audio parameters mismatch\n");
360 oss_dump_info (req, obt);
365 oss_dump_info (req, obt);
370 oss_anal_close (&fd);
374 static void oss_write_pending (OSSVoiceOut *oss)
376 HWVoiceOut *hw = &oss->hw;
382 while (oss->pending) {
384 ssize_t bytes_written;
385 int samples_till_end = hw->samples - oss->wpos;
386 int samples_to_write = MIN (oss->pending, samples_till_end);
387 int bytes_to_write = samples_to_write << hw->info.shift;
388 void *pcm = advance (oss->pcm_buf, oss->wpos << hw->info.shift);
390 bytes_written = write (oss->fd, pcm, bytes_to_write);
391 if (bytes_written < 0) {
392 if (errno != EAGAIN) {
393 oss_logerr (errno, "failed to write %d bytes\n",
399 if (bytes_written & hw->info.align) {
400 dolog ("misaligned write asked for %d, but got %zd\n",
401 bytes_to_write, bytes_written);
405 samples_written = bytes_written >> hw->info.shift;
406 oss->pending -= samples_written;
407 oss->wpos = (oss->wpos + samples_written) % hw->samples;
408 if (bytes_written - bytes_to_write) {
414 static size_t oss_run_out(HWVoiceOut *hw, size_t live)
416 OSSVoiceOut *oss = (OSSVoiceOut *) hw;
419 struct audio_buf_info abinfo;
420 struct count_info cntinfo;
423 bufsize = hw->samples << hw->info.shift;
428 err = ioctl (oss->fd, SNDCTL_DSP_GETOPTR, &cntinfo);
430 oss_logerr (errno, "SNDCTL_DSP_GETOPTR failed\n");
434 pos = hw->rpos << hw->info.shift;
435 bytes = audio_ring_dist (cntinfo.ptr, pos, bufsize);
436 decr = MIN (bytes >> hw->info.shift, live);
439 err = ioctl (oss->fd, SNDCTL_DSP_GETOSPACE, &abinfo);
441 oss_logerr (errno, "SNDCTL_DSP_GETOPTR failed\n");
445 if (abinfo.bytes > bufsize) {
446 trace_oss_invalid_available_size(abinfo.bytes, bufsize);
447 abinfo.bytes = bufsize;
450 if (abinfo.bytes < 0) {
451 trace_oss_invalid_available_size(abinfo.bytes, bufsize);
455 decr = MIN (abinfo.bytes >> hw->info.shift, live);
461 decr = audio_pcm_hw_clip_out (hw, oss->pcm_buf, decr, oss->pending);
462 oss->pending += decr;
463 oss_write_pending (oss);
468 static void oss_fini_out (HWVoiceOut *hw)
471 OSSVoiceOut *oss = (OSSVoiceOut *) hw;
473 ldebug ("oss_fini\n");
474 oss_anal_close (&oss->fd);
478 err = munmap (oss->pcm_buf, hw->samples << hw->info.shift);
480 oss_logerr(errno, "Failed to unmap buffer %p, size %zu\n",
481 oss->pcm_buf, hw->samples << hw->info.shift);
485 g_free (oss->pcm_buf);
491 static int oss_init_out(HWVoiceOut *hw, struct audsettings *as,
494 OSSVoiceOut *oss = (OSSVoiceOut *) hw;
495 struct oss_params req, obt;
499 AudioFormat effective_fmt;
500 struct audsettings obt_as;
501 Audiodev *dev = drv_opaque;
502 AudiodevOssOptions *oopts = &dev->u.oss;
506 req.fmt = aud_to_ossfmt (as->fmt, as->endianness);
508 req.nchannels = as->nchannels;
510 if (oss_open(0, &req, as, &obt, &fd, dev)) {
514 err = oss_to_audfmt (obt.fmt, &effective_fmt, &endianness);
516 oss_anal_close (&fd);
520 obt_as.freq = obt.freq;
521 obt_as.nchannels = obt.nchannels;
522 obt_as.fmt = effective_fmt;
523 obt_as.endianness = endianness;
525 audio_pcm_init_info (&hw->info, &obt_as);
526 oss->nfrags = obt.nfrags;
527 oss->fragsize = obt.fragsize;
529 if (obt.nfrags * obt.fragsize & hw->info.align) {
530 dolog ("warning: Misaligned DAC buffer, size %d, alignment %d\n",
531 obt.nfrags * obt.fragsize, hw->info.align + 1);
534 hw->samples = (obt.nfrags * obt.fragsize) >> hw->info.shift;
537 if (oopts->has_try_mmap && oopts->try_mmap) {
538 oss->pcm_buf = mmap (
540 hw->samples << hw->info.shift,
541 PROT_READ | PROT_WRITE,
546 if (oss->pcm_buf == MAP_FAILED) {
547 oss_logerr(errno, "Failed to map %zu bytes of DAC\n",
548 hw->samples << hw->info.shift);
553 if (ioctl (fd, SNDCTL_DSP_SETTRIGGER, &trig) < 0) {
554 oss_logerr (errno, "SNDCTL_DSP_SETTRIGGER 0 failed\n");
557 trig = PCM_ENABLE_OUTPUT;
558 if (ioctl (fd, SNDCTL_DSP_SETTRIGGER, &trig) < 0) {
561 "SNDCTL_DSP_SETTRIGGER PCM_ENABLE_OUTPUT failed\n"
570 err = munmap (oss->pcm_buf, hw->samples << hw->info.shift);
572 oss_logerr(errno, "Failed to unmap buffer %p size %zu\n",
573 oss->pcm_buf, hw->samples << hw->info.shift);
580 oss->pcm_buf = audio_calloc(__func__,
582 1 << hw->info.shift);
585 "Could not allocate DAC buffer (%zu samples, each %d bytes)\n",
589 oss_anal_close (&fd);
599 static int oss_ctl_out (HWVoiceOut *hw, int cmd, ...)
602 OSSVoiceOut *oss = (OSSVoiceOut *) hw;
603 AudiodevOssPerDirectionOptions *opdo = oss->dev->u.oss.out;
608 bool poll_mode = opdo->try_poll;
610 ldebug ("enabling voice\n");
615 hw->poll_mode = poll_mode;
621 audio_pcm_info_clear_buf (&hw->info, oss->pcm_buf, hw->samples);
622 trig = PCM_ENABLE_OUTPUT;
623 if (ioctl (oss->fd, SNDCTL_DSP_SETTRIGGER, &trig) < 0) {
626 "SNDCTL_DSP_SETTRIGGER PCM_ENABLE_OUTPUT failed\n"
635 qemu_set_fd_handler (oss->fd, NULL, NULL, NULL);
643 ldebug ("disabling voice\n");
645 if (ioctl (oss->fd, SNDCTL_DSP_SETTRIGGER, &trig) < 0) {
646 oss_logerr (errno, "SNDCTL_DSP_SETTRIGGER 0 failed\n");
654 static int oss_init_in(HWVoiceIn *hw, struct audsettings *as, void *drv_opaque)
656 OSSVoiceIn *oss = (OSSVoiceIn *) hw;
657 struct oss_params req, obt;
661 AudioFormat effective_fmt;
662 struct audsettings obt_as;
663 Audiodev *dev = drv_opaque;
667 req.fmt = aud_to_ossfmt (as->fmt, as->endianness);
669 req.nchannels = as->nchannels;
670 if (oss_open(1, &req, as, &obt, &fd, dev)) {
674 err = oss_to_audfmt (obt.fmt, &effective_fmt, &endianness);
676 oss_anal_close (&fd);
680 obt_as.freq = obt.freq;
681 obt_as.nchannels = obt.nchannels;
682 obt_as.fmt = effective_fmt;
683 obt_as.endianness = endianness;
685 audio_pcm_init_info (&hw->info, &obt_as);
686 oss->nfrags = obt.nfrags;
687 oss->fragsize = obt.fragsize;
689 if (obt.nfrags * obt.fragsize & hw->info.align) {
690 dolog ("warning: Misaligned ADC buffer, size %d, alignment %d\n",
691 obt.nfrags * obt.fragsize, hw->info.align + 1);
694 hw->samples = (obt.nfrags * obt.fragsize) >> hw->info.shift;
695 oss->pcm_buf = audio_calloc(__func__, hw->samples, 1 << hw->info.shift);
697 dolog("Could not allocate ADC buffer (%zu samples, each %d bytes)\n",
698 hw->samples, 1 << hw->info.shift);
699 oss_anal_close (&fd);
708 static void oss_fini_in (HWVoiceIn *hw)
710 OSSVoiceIn *oss = (OSSVoiceIn *) hw;
712 oss_anal_close (&oss->fd);
714 g_free(oss->pcm_buf);
718 static size_t oss_run_in(HWVoiceIn *hw)
720 OSSVoiceIn *oss = (OSSVoiceIn *) hw;
721 int hwshift = hw->info.shift;
723 size_t live = audio_pcm_hw_get_live_in (hw);
724 size_t dead = hw->samples - live;
725 size_t read_samples = 0;
730 { .add = hw->wpos, .len = 0 },
731 { .add = 0, .len = 0 }
738 if (hw->wpos + dead > hw->samples) {
739 bufs[0].len = (hw->samples - hw->wpos) << hwshift;
740 bufs[1].len = (dead - (hw->samples - hw->wpos)) << hwshift;
743 bufs[0].len = dead << hwshift;
746 for (i = 0; i < 2; ++i) {
750 void *p = advance (oss->pcm_buf, bufs[i].add << hwshift);
751 nread = read (oss->fd, p, bufs[i].len);
754 if (nread & hw->info.align) {
755 dolog("warning: Misaligned read %zd (requested %zu), "
756 "alignment %d\n", nread, bufs[i].add << hwshift,
759 read_samples += nread >> hwshift;
760 hw->conv (hw->conv_buf + bufs[i].add, p, nread >> hwshift);
763 if (bufs[i].len - nread) {
772 "Failed to read %zu bytes of audio (to %p)\n",
783 hw->wpos = (hw->wpos + read_samples) % hw->samples;
787 static int oss_ctl_in (HWVoiceIn *hw, int cmd, ...)
789 OSSVoiceIn *oss = (OSSVoiceIn *) hw;
790 AudiodevOssPerDirectionOptions *opdo = oss->dev->u.oss.out;
795 bool poll_mode = opdo->try_poll;
801 hw->poll_mode = poll_mode;
808 qemu_set_fd_handler (oss->fd, NULL, NULL, NULL);
815 static void oss_init_per_direction(AudiodevOssPerDirectionOptions *opdo)
817 if (!opdo->has_try_poll) {
818 opdo->try_poll = true;
819 opdo->has_try_poll = true;
823 static void *oss_audio_init(Audiodev *dev)
825 AudiodevOssOptions *oopts;
826 assert(dev->driver == AUDIODEV_DRIVER_OSS);
829 oss_init_per_direction(oopts->in);
830 oss_init_per_direction(oopts->out);
832 if (access(oopts->in->has_dev ? oopts->in->dev : "/dev/dsp",
834 access(oopts->out->has_dev ? oopts->out->dev : "/dev/dsp",
841 static void oss_audio_fini (void *opaque)
845 static struct audio_pcm_ops oss_pcm_ops = {
846 .init_out = oss_init_out,
847 .fini_out = oss_fini_out,
848 .run_out = oss_run_out,
849 .ctl_out = oss_ctl_out,
851 .init_in = oss_init_in,
852 .fini_in = oss_fini_in,
853 .run_in = oss_run_in,
857 static struct audio_driver oss_audio_driver = {
859 .descr = "OSS http://www.opensound.com",
860 .init = oss_audio_init,
861 .fini = oss_audio_fini,
862 .pcm_ops = &oss_pcm_ops,
864 .max_voices_out = INT_MAX,
865 .max_voices_in = INT_MAX,
866 .voice_size_out = sizeof (OSSVoiceOut),
867 .voice_size_in = sizeof (OSSVoiceIn)
870 static void register_audio_oss(void)
872 audio_driver_register(&oss_audio_driver);
874 type_init(register_audio_oss);