2 * QEMU DirectSound 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
26 * SEAL 1.07 by Carlos 'pel' Hasan was used as documentation
31 #define AUDIO_CAP "dsound"
32 #include "audio_int.h"
38 /* #define DEBUG_DSOUND */
43 int getstatus_retries;
47 audsettings_t settings;
66 LPDIRECTSOUNDCAPTURE dsound_capture;
67 LPDIRECTSOUNDBUFFER dsound_primary_buffer;
68 audsettings_t settings;
71 static dsound glob_dsound;
75 LPDIRECTSOUNDBUFFER dsound_buffer;
88 LPDIRECTSOUNDCAPTUREBUFFER dsound_capture_buffer;
91 static void dsound_log_hresult (HRESULT hr)
93 const char *str = "BUG";
97 str = "The method succeeded";
99 #ifdef DS_NO_VIRTUALIZATION
100 case DS_NO_VIRTUALIZATION:
101 str = "The buffer was created, but another 3D algorithm was substituted";
106 str = "The method succeeded, but not all the optional effects were obtained";
109 #ifdef DSERR_ACCESSDENIED
110 case DSERR_ACCESSDENIED:
111 str = "The request failed because access was denied";
114 #ifdef DSERR_ALLOCATED
115 case DSERR_ALLOCATED:
116 str = "The request failed because resources, such as a priority level, were already in use by another caller";
119 #ifdef DSERR_ALREADYINITIALIZED
120 case DSERR_ALREADYINITIALIZED:
121 str = "The object is already initialized";
124 #ifdef DSERR_BADFORMAT
125 case DSERR_BADFORMAT:
126 str = "The specified wave format is not supported";
129 #ifdef DSERR_BADSENDBUFFERGUID
130 case DSERR_BADSENDBUFFERGUID:
131 str = "The GUID specified in an audiopath file does not match a valid mix-in buffer";
134 #ifdef DSERR_BUFFERLOST
135 case DSERR_BUFFERLOST:
136 str = "The buffer memory has been lost and must be restored";
139 #ifdef DSERR_BUFFERTOOSMALL
140 case DSERR_BUFFERTOOSMALL:
141 str = "The buffer size is not great enough to enable effects processing";
144 #ifdef DSERR_CONTROLUNAVAIL
145 case DSERR_CONTROLUNAVAIL:
146 str = "The buffer control (volume, pan, and so on) requested by the caller is not available. Controls must be specified when the buffer is created, using the dwFlags member of DSBUFFERDESC";
149 #ifdef DSERR_DS8_REQUIRED
150 case DSERR_DS8_REQUIRED:
151 str = "A DirectSound object of class CLSID_DirectSound8 or later is required for the requested functionality. For more information, see IDirectSound8 Interface";
154 #ifdef DSERR_FXUNAVAILABLE
155 case DSERR_FXUNAVAILABLE:
156 str = "The effects requested could not be found on the system, or they are in the wrong order or in the wrong location; for example, an effect expected in hardware was found in software";
161 str = "An undetermined error occurred inside the DirectSound subsystem";
164 #ifdef DSERR_INVALIDCALL
165 case DSERR_INVALIDCALL:
166 str = "This function is not valid for the current state of this object";
169 #ifdef DSERR_INVALIDPARAM
170 case DSERR_INVALIDPARAM:
171 str = "An invalid parameter was passed to the returning function";
174 #ifdef DSERR_NOAGGREGATION
175 case DSERR_NOAGGREGATION:
176 str = "The object does not support aggregation";
179 #ifdef DSERR_NODRIVER
181 str = "No sound driver is available for use, or the given GUID is not a valid DirectSound device ID";
184 #ifdef DSERR_NOINTERFACE
185 case DSERR_NOINTERFACE:
186 str = "The requested COM interface is not available";
189 #ifdef DSERR_OBJECTNOTFOUND
190 case DSERR_OBJECTNOTFOUND:
191 str = "The requested object was not found";
194 #ifdef DSERR_OTHERAPPHASPRIO
195 case DSERR_OTHERAPPHASPRIO:
196 str = "Another application has a higher priority level, preventing this call from succeeding";
199 #ifdef DSERR_OUTOFMEMORY
200 case DSERR_OUTOFMEMORY:
201 str = "The DirectSound subsystem could not allocate sufficient memory to complete the caller's request";
204 #ifdef DSERR_PRIOLEVELNEEDED
205 case DSERR_PRIOLEVELNEEDED:
206 str = "A cooperative level of DSSCL_PRIORITY or higher is required";
209 #ifdef DSERR_SENDLOOP
211 str = "A circular loop of send effects was detected";
214 #ifdef DSERR_UNINITIALIZED
215 case DSERR_UNINITIALIZED:
216 str = "The Initialize method has not been called or has not been called successfully before other methods were called";
219 #ifdef DSERR_UNSUPPORTED
220 case DSERR_UNSUPPORTED:
221 str = "The function called is not supported at this time";
225 AUD_log (AUDIO_CAP, "Reason: Unknown (HRESULT %#lx)\n", hr);
229 AUD_log (AUDIO_CAP, "Reason: %s\n", str);
232 static void GCC_FMT_ATTR (2, 3) dsound_logerr (
241 AUD_vlog (AUDIO_CAP, fmt, ap);
244 dsound_log_hresult (hr);
247 static void GCC_FMT_ATTR (3, 4) dsound_logerr2 (
256 AUD_log (AUDIO_CAP, "Could not initialize %s\n", typ);
258 AUD_vlog (AUDIO_CAP, fmt, ap);
261 dsound_log_hresult (hr);
264 static DWORD millis_to_bytes (struct audio_pcm_info *info, DWORD millis)
266 return (millis * info->bytes_per_second) / 1000;
270 static void print_wave_format (WAVEFORMATEX *wfx)
272 dolog ("tag = %d\n", wfx->wFormatTag);
273 dolog ("nChannels = %d\n", wfx->nChannels);
274 dolog ("nSamplesPerSec = %ld\n", wfx->nSamplesPerSec);
275 dolog ("nAvgBytesPerSec = %ld\n", wfx->nAvgBytesPerSec);
276 dolog ("nBlockAlign = %d\n", wfx->nBlockAlign);
277 dolog ("wBitsPerSample = %d\n", wfx->wBitsPerSample);
278 dolog ("cbSize = %d\n", wfx->cbSize);
282 static int dsound_restore_out (LPDIRECTSOUNDBUFFER dsb)
287 for (i = 0; i < conf.restore_retries; ++i) {
288 hr = IDirectSoundBuffer_Restore (dsb);
294 case DSERR_BUFFERLOST:
298 dsound_logerr (hr, "Could not restore playback buffer\n");
303 dolog ("%d attempts to restore playback buffer failed\n", i);
307 static int waveformat_from_audio_settings (WAVEFORMATEX *wfx, audsettings_t *as)
309 memset (wfx, 0, sizeof (*wfx));
311 wfx->wFormatTag = WAVE_FORMAT_PCM;
312 wfx->nChannels = as->nchannels;
313 wfx->nSamplesPerSec = as->freq;
314 wfx->nAvgBytesPerSec = as->freq << (as->nchannels == 2);
315 wfx->nBlockAlign = 1 << (as->nchannels == 2);
320 wfx->wBitsPerSample = 8;
324 wfx->wBitsPerSample = 8;
328 wfx->wBitsPerSample = 16;
329 wfx->nAvgBytesPerSec <<= 1;
330 wfx->nBlockAlign <<= 1;
334 wfx->wBitsPerSample = 16;
335 wfx->nAvgBytesPerSec <<= 1;
336 wfx->nBlockAlign <<= 1;
340 dolog ("Internal logic error: Bad audio format %d\n", as->freq);
347 static int waveformat_to_audio_settings (WAVEFORMATEX *wfx, audsettings_t *as)
349 if (wfx->wFormatTag != WAVE_FORMAT_PCM) {
350 dolog ("Invalid wave format, tag is not PCM, but %d\n",
355 if (!wfx->nSamplesPerSec) {
356 dolog ("Invalid wave format, frequency is zero\n");
359 as->freq = wfx->nSamplesPerSec;
361 switch (wfx->nChannels) {
372 "Invalid wave format, number of channels is not 1 or 2, but %d\n",
378 switch (wfx->wBitsPerSample) {
380 as->fmt = AUD_FMT_U8;
384 as->fmt = AUD_FMT_S16;
388 dolog ("Invalid wave format, bits per sample is not 8 or 16, but %d\n",
389 wfx->wBitsPerSample);
396 #include "dsound_template.h"
398 #include "dsound_template.h"
401 static int dsound_get_status_out (LPDIRECTSOUNDBUFFER dsb, DWORD *statusp)
406 for (i = 0; i < conf.getstatus_retries; ++i) {
407 hr = IDirectSoundBuffer_GetStatus (dsb, statusp);
409 dsound_logerr (hr, "Could not get playback buffer status\n");
413 if (*statusp & DSERR_BUFFERLOST) {
414 if (dsound_restore_out (dsb)) {
425 static int dsound_get_status_in (LPDIRECTSOUNDCAPTUREBUFFER dscb,
430 hr = IDirectSoundCaptureBuffer_GetStatus (dscb, statusp);
432 dsound_logerr (hr, "Could not get capture buffer status\n");
439 static void dsound_write_sample (HWVoiceOut *hw, uint8_t *dst, int dst_len)
441 int src_len1 = dst_len;
443 int pos = hw->rpos + dst_len;
444 st_sample_t *src1 = hw->mix_buf + hw->rpos;
445 st_sample_t *src2 = NULL;
447 if (pos > hw->samples) {
448 src_len1 = hw->samples - hw->rpos;
450 src_len2 = dst_len - src_len1;
455 hw->clip (dst, src1, src_len1);
459 dst = advance (dst, src_len1 << hw->info.shift);
460 hw->clip (dst, src2, src_len2);
463 hw->rpos = pos % hw->samples;
466 static void dsound_clear_sample (HWVoiceOut *hw, LPDIRECTSOUNDBUFFER dsb)
470 DWORD blen1, blen2, len1, len2;
472 err = dsound_lock_out (
476 hw->samples << hw->info.shift,
485 len1 = blen1 >> hw->info.shift;
486 len2 = blen2 >> hw->info.shift;
489 dolog ("clear %p,%ld,%ld %p,%ld,%ld\n",
495 audio_pcm_info_clear_buf (&hw->info, p1, len1);
499 audio_pcm_info_clear_buf (&hw->info, p2, len2);
502 dsound_unlock_out (dsb, p1, p2, blen1, blen2);
505 static void dsound_close (dsound *s)
509 if (s->dsound_primary_buffer) {
510 hr = IDirectSoundBuffer_Release (s->dsound_primary_buffer);
512 dsound_logerr (hr, "Could not release primary buffer\n");
514 s->dsound_primary_buffer = NULL;
518 static int dsound_open (dsound *s)
526 hwnd = GetForegroundWindow ();
527 hr = IDirectSound_SetCooperativeLevel (
534 dsound_logerr (hr, "Could not set cooperative level for window %p\n",
539 if (!conf.set_primary) {
543 err = waveformat_from_audio_settings (&wfx, &conf.settings);
548 memset (&dsbd, 0, sizeof (dsbd));
549 dsbd.dwSize = sizeof (dsbd);
550 dsbd.dwFlags = DSBCAPS_PRIMARYBUFFER;
551 dsbd.dwBufferBytes = 0;
552 dsbd.lpwfxFormat = NULL;
554 hr = IDirectSound_CreateSoundBuffer (
557 &s->dsound_primary_buffer,
561 dsound_logerr (hr, "Could not create primary playback buffer\n");
565 hr = IDirectSoundBuffer_SetFormat (s->dsound_primary_buffer, &wfx);
567 dsound_logerr (hr, "Could not set primary playback buffer format\n");
570 hr = IDirectSoundBuffer_GetFormat (
571 s->dsound_primary_buffer,
577 dsound_logerr (hr, "Could not get primary playback buffer format\n");
583 print_wave_format (&wfx);
586 err = waveformat_to_audio_settings (&wfx, &s->settings);
598 static int dsound_ctl_out (HWVoiceOut *hw, int cmd, ...)
602 DSoundVoiceOut *ds = (DSoundVoiceOut *) hw;
603 LPDIRECTSOUNDBUFFER dsb = ds->dsound_buffer;
606 dolog ("Attempt to control voice without a buffer\n");
612 if (dsound_get_status_out (dsb, &status)) {
616 if (status & DSBSTATUS_PLAYING) {
617 dolog ("warning: Voice is already playing\n");
621 dsound_clear_sample (hw, dsb);
623 hr = IDirectSoundBuffer_Play (dsb, 0, 0, DSBPLAY_LOOPING);
625 dsound_logerr (hr, "Could not start playing buffer\n");
631 if (dsound_get_status_out (dsb, &status)) {
635 if (status & DSBSTATUS_PLAYING) {
636 hr = IDirectSoundBuffer_Stop (dsb);
638 dsound_logerr (hr, "Could not stop playing buffer\n");
643 dolog ("warning: Voice is not playing\n");
650 static int dsound_write (SWVoiceOut *sw, void *buf, int len)
652 return audio_pcm_sw_write (sw, buf, len);
655 static int dsound_run_out (HWVoiceOut *hw)
659 DSoundVoiceOut *ds = (DSoundVoiceOut *) hw;
660 LPDIRECTSOUNDBUFFER dsb = ds->dsound_buffer;
661 int live, len, hwshift;
665 DWORD wpos, ppos, old_pos;
670 dolog ("Attempt to run empty with playback buffer\n");
674 hwshift = hw->info.shift;
675 bufsize = hw->samples << hwshift;
677 live = audio_pcm_hw_get_live_out (hw);
679 hr = IDirectSoundBuffer_GetCurrentPosition (
682 ds->first_time ? &wpos : NULL
685 dsound_logerr (hr, "Could not get playback buffer position\n");
689 len = live << hwshift;
691 if (ds->first_time) {
692 if (conf.latency_millis) {
695 cur_blat = audio_ring_dist (wpos, ppos, bufsize);
699 millis_to_bytes (&hw->info, conf.latency_millis) - cur_blat;
701 old_pos &= ~hw->info.align;
712 if (ds->old_pos == ppos) {
714 dolog ("old_pos == ppos\n");
720 ds->played += audio_ring_dist (ds->old_pos, ppos, hw->bufsize);
722 old_pos = ds->old_pos;
725 if ((old_pos < ppos) && ((old_pos + len) > ppos)) {
726 len = ppos - old_pos;
729 if ((old_pos > ppos) && ((old_pos + len) > (ppos + bufsize))) {
730 len = bufsize - old_pos + ppos;
734 if (audio_bug (AUDIO_FUNC, len < 0 || len > bufsize)) {
735 dolog ("len=%d bufsize=%d old_pos=%ld ppos=%ld\n",
736 len, bufsize, old_pos, ppos);
740 len &= ~hw->info.align;
748 err = dsound_lock_out (
761 len1 = blen1 >> hwshift;
762 len2 = blen2 >> hwshift;
766 dsound_write_sample (hw, p1, len1);
770 dsound_write_sample (hw, p2, len2);
773 dsound_unlock_out (dsb, p1, p2, blen1, blen2);
774 ds->old_pos = (old_pos + (decr << hwshift)) % bufsize;
777 ds->mixed += decr << hwshift;
779 dolog ("played %lu mixed %lu diff %ld sec %f\n",
782 ds->mixed - ds->played,
783 abs (ds->mixed - ds->played) / (double) hw->info.bytes_per_second);
788 static int dsound_ctl_in (HWVoiceIn *hw, int cmd, ...)
792 DSoundVoiceIn *ds = (DSoundVoiceIn *) hw;
793 LPDIRECTSOUNDCAPTUREBUFFER dscb = ds->dsound_capture_buffer;
796 dolog ("Attempt to control capture voice without a buffer\n");
802 if (dsound_get_status_in (dscb, &status)) {
806 if (status & DSCBSTATUS_CAPTURING) {
807 dolog ("warning: Voice is already capturing\n");
813 hr = IDirectSoundCaptureBuffer_Start (dscb, DSCBSTART_LOOPING);
815 dsound_logerr (hr, "Could not start capturing\n");
821 if (dsound_get_status_in (dscb, &status)) {
825 if (status & DSCBSTATUS_CAPTURING) {
826 hr = IDirectSoundCaptureBuffer_Stop (dscb);
828 dsound_logerr (hr, "Could not stop capturing\n");
833 dolog ("warning: Voice is not capturing\n");
840 static int dsound_read (SWVoiceIn *sw, void *buf, int len)
842 return audio_pcm_sw_read (sw, buf, len);
845 static int dsound_run_in (HWVoiceIn *hw)
849 DSoundVoiceIn *ds = (DSoundVoiceIn *) hw;
850 LPDIRECTSOUNDCAPTUREBUFFER dscb = ds->dsound_capture_buffer;
860 dolog ("Attempt to run without capture buffer\n");
864 hwshift = hw->info.shift;
866 live = audio_pcm_hw_get_live_in (hw);
867 dead = hw->samples - live;
872 hr = IDirectSoundCaptureBuffer_GetCurrentPosition (
875 ds->first_time ? &rpos : NULL
878 dsound_logerr (hr, "Could not get capture buffer position\n");
882 if (ds->first_time) {
884 if (rpos & hw->info.align) {
885 ldebug ("warning: Misaligned capture read position %ld(%d)\n",
886 rpos, hw->info.align);
888 hw->wpos = rpos >> hwshift;
891 if (cpos & hw->info.align) {
892 ldebug ("warning: Misaligned capture position %ld(%d)\n",
893 cpos, hw->info.align);
897 len = audio_ring_dist (cpos, hw->wpos, hw->samples);
901 len = audio_MIN (len, dead);
903 err = dsound_lock_in (
918 len1 = blen1 >> hwshift;
919 len2 = blen2 >> hwshift;
923 hw->conv (hw->conv_buf + hw->wpos, p1, len1, &nominal_volume);
927 hw->conv (hw->conv_buf, p2, len2, &nominal_volume);
930 dsound_unlock_in (dscb, p1, p2, blen1, blen2);
931 hw->wpos = (hw->wpos + decr) % hw->samples;
935 static void dsound_audio_fini (void *opaque)
944 hr = IDirectSound_Release (s->dsound);
946 dsound_logerr (hr, "Could not release DirectSound\n");
950 if (!s->dsound_capture) {
954 hr = IDirectSoundCapture_Release (s->dsound_capture);
956 dsound_logerr (hr, "Could not release DirectSoundCapture\n");
958 s->dsound_capture = NULL;
961 static void *dsound_audio_init (void)
965 dsound *s = &glob_dsound;
967 hr = CoInitialize (NULL);
969 dsound_logerr (hr, "Could not initialize COM\n");
973 hr = CoCreateInstance (
981 dsound_logerr (hr, "Could not create DirectSound instance\n");
985 hr = IDirectSound_Initialize (s->dsound, NULL);
987 dsound_logerr (hr, "Could not initialize DirectSound\n");
989 hr = IDirectSound_Release (s->dsound);
991 dsound_logerr (hr, "Could not release DirectSound\n");
997 hr = CoCreateInstance (
998 &CLSID_DirectSoundCapture,
1001 &IID_IDirectSoundCapture,
1002 (void **) &s->dsound_capture
1005 dsound_logerr (hr, "Could not create DirectSoundCapture instance\n");
1008 hr = IDirectSoundCapture_Initialize (s->dsound_capture, NULL);
1010 dsound_logerr (hr, "Could not initialize DirectSoundCapture\n");
1012 hr = IDirectSoundCapture_Release (s->dsound_capture);
1014 dsound_logerr (hr, "Could not release DirectSoundCapture\n");
1016 s->dsound_capture = NULL;
1020 err = dsound_open (s);
1022 dsound_audio_fini (s);
1029 static struct audio_option dsound_options[] = {
1030 {"LOCK_RETRIES", AUD_OPT_INT, &conf.lock_retries,
1031 "Number of times to attempt locking the buffer", NULL, 0},
1032 {"RESTOURE_RETRIES", AUD_OPT_INT, &conf.restore_retries,
1033 "Number of times to attempt restoring the buffer", NULL, 0},
1034 {"GETSTATUS_RETRIES", AUD_OPT_INT, &conf.getstatus_retries,
1035 "Number of times to attempt getting status of the buffer", NULL, 0},
1036 {"SET_PRIMARY", AUD_OPT_BOOL, &conf.set_primary,
1037 "Set the parameters of primary buffer", NULL, 0},
1038 {"LATENCY_MILLIS", AUD_OPT_INT, &conf.latency_millis,
1039 "(undocumented)", NULL, 0},
1040 {"PRIMARY_FREQ", AUD_OPT_INT, &conf.settings.freq,
1041 "Primary buffer frequency", NULL, 0},
1042 {"PRIMARY_CHANNELS", AUD_OPT_INT, &conf.settings.nchannels,
1043 "Primary buffer number of channels (1 - mono, 2 - stereo)", NULL, 0},
1044 {"PRIMARY_FMT", AUD_OPT_FMT, &conf.settings.fmt,
1045 "Primary buffer format", NULL, 0},
1046 {"BUFSIZE_OUT", AUD_OPT_INT, &conf.bufsize_out,
1047 "(undocumented)", NULL, 0},
1048 {"BUFSIZE_IN", AUD_OPT_INT, &conf.bufsize_in,
1049 "(undocumented)", NULL, 0},
1050 {NULL, 0, NULL, NULL, NULL, 0}
1053 static struct audio_pcm_ops dsound_pcm_ops = {
1067 struct audio_driver dsound_audio_driver = {
1068 INIT_FIELD (name = ) "dsound",
1069 INIT_FIELD (descr = )
1070 "DirectSound http://wikipedia.org/wiki/DirectSound",
1071 INIT_FIELD (options = ) dsound_options,
1072 INIT_FIELD (init = ) dsound_audio_init,
1073 INIT_FIELD (fini = ) dsound_audio_fini,
1074 INIT_FIELD (pcm_ops = ) &dsound_pcm_ops,
1075 INIT_FIELD (can_be_default = ) 1,
1076 INIT_FIELD (max_voices_out = ) INT_MAX,
1077 INIT_FIELD (max_voices_in = ) 1,
1078 INIT_FIELD (voice_size_out = ) sizeof (DSoundVoiceOut),
1079 INIT_FIELD (voice_size_in = ) sizeof (DSoundVoiceIn)