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
29
#include "qemu-common.h"
32
#define AUDIO_CAP "dsound"
33
#include "audio_int.h"
35
#define WIN32_LEAN_AND_MEAN
41
/* #define DEBUG_DSOUND */
46
int getstatus_retries;
50
audsettings_t settings;
69
LPDIRECTSOUNDCAPTURE dsound_capture;
70
LPDIRECTSOUNDBUFFER dsound_primary_buffer;
71
audsettings_t settings;
74
static dsound glob_dsound;
78
LPDIRECTSOUNDBUFFER dsound_buffer;
91
LPDIRECTSOUNDCAPTUREBUFFER dsound_capture_buffer;
94
static void dsound_log_hresult (HRESULT hr)
96
const char *str = "BUG";
100
str = "The method succeeded";
102
#ifdef DS_NO_VIRTUALIZATION
103
case DS_NO_VIRTUALIZATION:
104
str = "The buffer was created, but another 3D algorithm was substituted";
109
str = "The method succeeded, but not all the optional effects were obtained";
112
#ifdef DSERR_ACCESSDENIED
113
case DSERR_ACCESSDENIED:
114
str = "The request failed because access was denied";
117
#ifdef DSERR_ALLOCATED
118
case DSERR_ALLOCATED:
119
str = "The request failed because resources, such as a priority level, were already in use by another caller";
122
#ifdef DSERR_ALREADYINITIALIZED
123
case DSERR_ALREADYINITIALIZED:
124
str = "The object is already initialized";
127
#ifdef DSERR_BADFORMAT
128
case DSERR_BADFORMAT:
129
str = "The specified wave format is not supported";
132
#ifdef DSERR_BADSENDBUFFERGUID
133
case DSERR_BADSENDBUFFERGUID:
134
str = "The GUID specified in an audiopath file does not match a valid mix-in buffer";
137
#ifdef DSERR_BUFFERLOST
138
case DSERR_BUFFERLOST:
139
str = "The buffer memory has been lost and must be restored";
142
#ifdef DSERR_BUFFERTOOSMALL
143
case DSERR_BUFFERTOOSMALL:
144
str = "The buffer size is not great enough to enable effects processing";
147
#ifdef DSERR_CONTROLUNAVAIL
148
case DSERR_CONTROLUNAVAIL:
149
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";
152
#ifdef DSERR_DS8_REQUIRED
153
case DSERR_DS8_REQUIRED:
154
str = "A DirectSound object of class CLSID_DirectSound8 or later is required for the requested functionality. For more information, see IDirectSound8 Interface";
157
#ifdef DSERR_FXUNAVAILABLE
158
case DSERR_FXUNAVAILABLE:
159
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";
164
str = "An undetermined error occurred inside the DirectSound subsystem";
167
#ifdef DSERR_INVALIDCALL
168
case DSERR_INVALIDCALL:
169
str = "This function is not valid for the current state of this object";
172
#ifdef DSERR_INVALIDPARAM
173
case DSERR_INVALIDPARAM:
174
str = "An invalid parameter was passed to the returning function";
177
#ifdef DSERR_NOAGGREGATION
178
case DSERR_NOAGGREGATION:
179
str = "The object does not support aggregation";
182
#ifdef DSERR_NODRIVER
184
str = "No sound driver is available for use, or the given GUID is not a valid DirectSound device ID";
187
#ifdef DSERR_NOINTERFACE
188
case DSERR_NOINTERFACE:
189
str = "The requested COM interface is not available";
192
#ifdef DSERR_OBJECTNOTFOUND
193
case DSERR_OBJECTNOTFOUND:
194
str = "The requested object was not found";
197
#ifdef DSERR_OTHERAPPHASPRIO
198
case DSERR_OTHERAPPHASPRIO:
199
str = "Another application has a higher priority level, preventing this call from succeeding";
202
#ifdef DSERR_OUTOFMEMORY
203
case DSERR_OUTOFMEMORY:
204
str = "The DirectSound subsystem could not allocate sufficient memory to complete the caller's request";
207
#ifdef DSERR_PRIOLEVELNEEDED
208
case DSERR_PRIOLEVELNEEDED:
209
str = "A cooperative level of DSSCL_PRIORITY or higher is required";
212
#ifdef DSERR_SENDLOOP
214
str = "A circular loop of send effects was detected";
217
#ifdef DSERR_UNINITIALIZED
218
case DSERR_UNINITIALIZED:
219
str = "The Initialize method has not been called or has not been called successfully before other methods were called";
222
#ifdef DSERR_UNSUPPORTED
223
case DSERR_UNSUPPORTED:
224
str = "The function called is not supported at this time";
228
AUD_log (AUDIO_CAP, "Reason: Unknown (HRESULT %#lx)\n", hr);
232
AUD_log (AUDIO_CAP, "Reason: %s\n", str);
235
static void GCC_FMT_ATTR (2, 3) dsound_logerr (
244
AUD_vlog (AUDIO_CAP, fmt, ap);
247
dsound_log_hresult (hr);
250
static void GCC_FMT_ATTR (3, 4) dsound_logerr2 (
259
AUD_log (AUDIO_CAP, "Could not initialize %s\n", typ);
261
AUD_vlog (AUDIO_CAP, fmt, ap);
264
dsound_log_hresult (hr);
267
static DWORD millis_to_bytes (struct audio_pcm_info *info, DWORD millis)
269
return (millis * info->bytes_per_second) / 1000;
273
static void print_wave_format (WAVEFORMATEX *wfx)
275
dolog ("tag = %d\n", wfx->wFormatTag);
276
dolog ("nChannels = %d\n", wfx->nChannels);
277
dolog ("nSamplesPerSec = %ld\n", wfx->nSamplesPerSec);
278
dolog ("nAvgBytesPerSec = %ld\n", wfx->nAvgBytesPerSec);
279
dolog ("nBlockAlign = %d\n", wfx->nBlockAlign);
280
dolog ("wBitsPerSample = %d\n", wfx->wBitsPerSample);
281
dolog ("cbSize = %d\n", wfx->cbSize);
285
static int dsound_restore_out (LPDIRECTSOUNDBUFFER dsb)
290
for (i = 0; i < conf.restore_retries; ++i) {
291
hr = IDirectSoundBuffer_Restore (dsb);
297
case DSERR_BUFFERLOST:
301
dsound_logerr (hr, "Could not restore playback buffer\n");
306
dolog ("%d attempts to restore playback buffer failed\n", i);
310
static int waveformat_from_audio_settings (WAVEFORMATEX *wfx, audsettings_t *as)
312
memset (wfx, 0, sizeof (*wfx));
314
wfx->wFormatTag = WAVE_FORMAT_PCM;
315
wfx->nChannels = as->nchannels;
316
wfx->nSamplesPerSec = as->freq;
317
wfx->nAvgBytesPerSec = as->freq << (as->nchannels == 2);
318
wfx->nBlockAlign = 1 << (as->nchannels == 2);
323
wfx->wBitsPerSample = 8;
327
wfx->wBitsPerSample = 8;
331
wfx->wBitsPerSample = 16;
332
wfx->nAvgBytesPerSec <<= 1;
333
wfx->nBlockAlign <<= 1;
337
wfx->wBitsPerSample = 16;
338
wfx->nAvgBytesPerSec <<= 1;
339
wfx->nBlockAlign <<= 1;
343
dolog ("Internal logic error: Bad audio format %d\n", as->freq);
350
static int waveformat_to_audio_settings (WAVEFORMATEX *wfx, audsettings_t *as)
352
if (wfx->wFormatTag != WAVE_FORMAT_PCM) {
353
dolog ("Invalid wave format, tag is not PCM, but %d\n",
358
if (!wfx->nSamplesPerSec) {
359
dolog ("Invalid wave format, frequency is zero\n");
362
as->freq = wfx->nSamplesPerSec;
364
switch (wfx->nChannels) {
375
"Invalid wave format, number of channels is not 1 or 2, but %d\n",
381
switch (wfx->wBitsPerSample) {
383
as->fmt = AUD_FMT_U8;
387
as->fmt = AUD_FMT_S16;
391
dolog ("Invalid wave format, bits per sample is not 8 or 16, but %d\n",
392
wfx->wBitsPerSample);
399
#include "dsound_template.h"
401
#include "dsound_template.h"
404
static int dsound_get_status_out (LPDIRECTSOUNDBUFFER dsb, DWORD *statusp)
409
for (i = 0; i < conf.getstatus_retries; ++i) {
410
hr = IDirectSoundBuffer_GetStatus (dsb, statusp);
412
dsound_logerr (hr, "Could not get playback buffer status\n");
416
if (*statusp & DSERR_BUFFERLOST) {
417
if (dsound_restore_out (dsb)) {
428
static int dsound_get_status_in (LPDIRECTSOUNDCAPTUREBUFFER dscb,
433
hr = IDirectSoundCaptureBuffer_GetStatus (dscb, statusp);
435
dsound_logerr (hr, "Could not get capture buffer status\n");
442
static void dsound_write_sample (HWVoiceOut *hw, uint8_t *dst, int dst_len)
444
int src_len1 = dst_len;
446
int pos = hw->rpos + dst_len;
447
st_sample_t *src1 = hw->mix_buf + hw->rpos;
448
st_sample_t *src2 = NULL;
450
if (pos > hw->samples) {
451
src_len1 = hw->samples - hw->rpos;
453
src_len2 = dst_len - src_len1;
458
hw->clip (dst, src1, src_len1);
462
dst = advance (dst, src_len1 << hw->info.shift);
463
hw->clip (dst, src2, src_len2);
466
hw->rpos = pos % hw->samples;
469
static void dsound_clear_sample (HWVoiceOut *hw, LPDIRECTSOUNDBUFFER dsb)
473
DWORD blen1, blen2, len1, len2;
475
err = dsound_lock_out (
479
hw->samples << hw->info.shift,
488
len1 = blen1 >> hw->info.shift;
489
len2 = blen2 >> hw->info.shift;
492
dolog ("clear %p,%ld,%ld %p,%ld,%ld\n",
498
audio_pcm_info_clear_buf (&hw->info, p1, len1);
502
audio_pcm_info_clear_buf (&hw->info, p2, len2);
505
dsound_unlock_out (dsb, p1, p2, blen1, blen2);
508
static void dsound_close (dsound *s)
512
if (s->dsound_primary_buffer) {
513
hr = IDirectSoundBuffer_Release (s->dsound_primary_buffer);
515
dsound_logerr (hr, "Could not release primary buffer\n");
517
s->dsound_primary_buffer = NULL;
521
static int dsound_open (dsound *s)
529
hwnd = GetForegroundWindow ();
530
hr = IDirectSound_SetCooperativeLevel (
537
dsound_logerr (hr, "Could not set cooperative level for window %p\n",
542
if (!conf.set_primary) {
546
err = waveformat_from_audio_settings (&wfx, &conf.settings);
551
memset (&dsbd, 0, sizeof (dsbd));
552
dsbd.dwSize = sizeof (dsbd);
553
dsbd.dwFlags = DSBCAPS_PRIMARYBUFFER;
554
dsbd.dwBufferBytes = 0;
555
dsbd.lpwfxFormat = NULL;
557
hr = IDirectSound_CreateSoundBuffer (
560
&s->dsound_primary_buffer,
564
dsound_logerr (hr, "Could not create primary playback buffer\n");
568
hr = IDirectSoundBuffer_SetFormat (s->dsound_primary_buffer, &wfx);
570
dsound_logerr (hr, "Could not set primary playback buffer format\n");
573
hr = IDirectSoundBuffer_GetFormat (
574
s->dsound_primary_buffer,
580
dsound_logerr (hr, "Could not get primary playback buffer format\n");
586
print_wave_format (&wfx);
589
err = waveformat_to_audio_settings (&wfx, &s->settings);
601
static int dsound_ctl_out (HWVoiceOut *hw, int cmd, ...)
605
DSoundVoiceOut *ds = (DSoundVoiceOut *) hw;
606
LPDIRECTSOUNDBUFFER dsb = ds->dsound_buffer;
609
dolog ("Attempt to control voice without a buffer\n");
615
if (dsound_get_status_out (dsb, &status)) {
619
if (status & DSBSTATUS_PLAYING) {
620
dolog ("warning: Voice is already playing\n");
624
dsound_clear_sample (hw, dsb);
626
hr = IDirectSoundBuffer_Play (dsb, 0, 0, DSBPLAY_LOOPING);
628
dsound_logerr (hr, "Could not start playing buffer\n");
634
if (dsound_get_status_out (dsb, &status)) {
638
if (status & DSBSTATUS_PLAYING) {
639
hr = IDirectSoundBuffer_Stop (dsb);
641
dsound_logerr (hr, "Could not stop playing buffer\n");
646
dolog ("warning: Voice is not playing\n");
653
static int dsound_write (SWVoiceOut *sw, void *buf, int len)
655
return audio_pcm_sw_write (sw, buf, len);
658
static int dsound_run_out (HWVoiceOut *hw)
662
DSoundVoiceOut *ds = (DSoundVoiceOut *) hw;
663
LPDIRECTSOUNDBUFFER dsb = ds->dsound_buffer;
664
int live, len, hwshift;
668
DWORD wpos, ppos, old_pos;
673
dolog ("Attempt to run empty with playback buffer\n");
677
hwshift = hw->info.shift;
678
bufsize = hw->samples << hwshift;
680
live = audio_pcm_hw_get_live_out (hw);
682
hr = IDirectSoundBuffer_GetCurrentPosition (
685
ds->first_time ? &wpos : NULL
688
dsound_logerr (hr, "Could not get playback buffer position\n");
692
len = live << hwshift;
694
if (ds->first_time) {
695
if (conf.latency_millis) {
698
cur_blat = audio_ring_dist (wpos, ppos, bufsize);
702
millis_to_bytes (&hw->info, conf.latency_millis) - cur_blat;
704
old_pos &= ~hw->info.align;
715
if (ds->old_pos == ppos) {
717
dolog ("old_pos == ppos\n");
723
ds->played += audio_ring_dist (ds->old_pos, ppos, hw->bufsize);
725
old_pos = ds->old_pos;
728
if ((old_pos < ppos) && ((old_pos + len) > ppos)) {
729
len = ppos - old_pos;
732
if ((old_pos > ppos) && ((old_pos + len) > (ppos + bufsize))) {
733
len = bufsize - old_pos + ppos;
737
if (audio_bug (AUDIO_FUNC, len < 0 || len > bufsize)) {
738
dolog ("len=%d bufsize=%d old_pos=%ld ppos=%ld\n",
739
len, bufsize, old_pos, ppos);
743
len &= ~hw->info.align;
751
err = dsound_lock_out (
764
len1 = blen1 >> hwshift;
765
len2 = blen2 >> hwshift;
769
dsound_write_sample (hw, p1, len1);
773
dsound_write_sample (hw, p2, len2);
776
dsound_unlock_out (dsb, p1, p2, blen1, blen2);
777
ds->old_pos = (old_pos + (decr << hwshift)) % bufsize;
780
ds->mixed += decr << hwshift;
782
dolog ("played %lu mixed %lu diff %ld sec %f\n",
785
ds->mixed - ds->played,
786
abs (ds->mixed - ds->played) / (double) hw->info.bytes_per_second);
791
static int dsound_ctl_in (HWVoiceIn *hw, int cmd, ...)
795
DSoundVoiceIn *ds = (DSoundVoiceIn *) hw;
796
LPDIRECTSOUNDCAPTUREBUFFER dscb = ds->dsound_capture_buffer;
799
dolog ("Attempt to control capture voice without a buffer\n");
805
if (dsound_get_status_in (dscb, &status)) {
809
if (status & DSCBSTATUS_CAPTURING) {
810
dolog ("warning: Voice is already capturing\n");
816
hr = IDirectSoundCaptureBuffer_Start (dscb, DSCBSTART_LOOPING);
818
dsound_logerr (hr, "Could not start capturing\n");
824
if (dsound_get_status_in (dscb, &status)) {
828
if (status & DSCBSTATUS_CAPTURING) {
829
hr = IDirectSoundCaptureBuffer_Stop (dscb);
831
dsound_logerr (hr, "Could not stop capturing\n");
836
dolog ("warning: Voice is not capturing\n");
843
static int dsound_read (SWVoiceIn *sw, void *buf, int len)
845
return audio_pcm_sw_read (sw, buf, len);
848
static int dsound_run_in (HWVoiceIn *hw)
852
DSoundVoiceIn *ds = (DSoundVoiceIn *) hw;
853
LPDIRECTSOUNDCAPTUREBUFFER dscb = ds->dsound_capture_buffer;
863
dolog ("Attempt to run without capture buffer\n");
867
hwshift = hw->info.shift;
869
live = audio_pcm_hw_get_live_in (hw);
870
dead = hw->samples - live;
875
hr = IDirectSoundCaptureBuffer_GetCurrentPosition (
878
ds->first_time ? &rpos : NULL
881
dsound_logerr (hr, "Could not get capture buffer position\n");
885
if (ds->first_time) {
887
if (rpos & hw->info.align) {
888
ldebug ("warning: Misaligned capture read position %ld(%d)\n",
889
rpos, hw->info.align);
891
hw->wpos = rpos >> hwshift;
894
if (cpos & hw->info.align) {
895
ldebug ("warning: Misaligned capture position %ld(%d)\n",
896
cpos, hw->info.align);
900
len = audio_ring_dist (cpos, hw->wpos, hw->samples);
904
len = audio_MIN (len, dead);
906
err = dsound_lock_in (
921
len1 = blen1 >> hwshift;
922
len2 = blen2 >> hwshift;
926
hw->conv (hw->conv_buf + hw->wpos, p1, len1, &nominal_volume);
930
hw->conv (hw->conv_buf, p2, len2, &nominal_volume);
933
dsound_unlock_in (dscb, p1, p2, blen1, blen2);
934
hw->wpos = (hw->wpos + decr) % hw->samples;
938
static void dsound_audio_fini (void *opaque)
947
hr = IDirectSound_Release (s->dsound);
949
dsound_logerr (hr, "Could not release DirectSound\n");
953
if (!s->dsound_capture) {
957
hr = IDirectSoundCapture_Release (s->dsound_capture);
959
dsound_logerr (hr, "Could not release DirectSoundCapture\n");
961
s->dsound_capture = NULL;
964
static void *dsound_audio_init (void)
968
dsound *s = &glob_dsound;
970
hr = CoInitialize (NULL);
972
dsound_logerr (hr, "Could not initialize COM\n");
976
hr = CoCreateInstance (
984
dsound_logerr (hr, "Could not create DirectSound instance\n");
988
hr = IDirectSound_Initialize (s->dsound, NULL);
990
dsound_logerr (hr, "Could not initialize DirectSound\n");
992
hr = IDirectSound_Release (s->dsound);
994
dsound_logerr (hr, "Could not release DirectSound\n");
1000
hr = CoCreateInstance (
1001
&CLSID_DirectSoundCapture,
1004
&IID_IDirectSoundCapture,
1005
(void **) &s->dsound_capture
1008
dsound_logerr (hr, "Could not create DirectSoundCapture instance\n");
1011
hr = IDirectSoundCapture_Initialize (s->dsound_capture, NULL);
1013
dsound_logerr (hr, "Could not initialize DirectSoundCapture\n");
1015
hr = IDirectSoundCapture_Release (s->dsound_capture);
1017
dsound_logerr (hr, "Could not release DirectSoundCapture\n");
1019
s->dsound_capture = NULL;
1023
err = dsound_open (s);
1025
dsound_audio_fini (s);
1032
static struct audio_option dsound_options[] = {
1033
{"LOCK_RETRIES", AUD_OPT_INT, &conf.lock_retries,
1034
"Number of times to attempt locking the buffer", NULL, 0},
1035
{"RESTOURE_RETRIES", AUD_OPT_INT, &conf.restore_retries,
1036
"Number of times to attempt restoring the buffer", NULL, 0},
1037
{"GETSTATUS_RETRIES", AUD_OPT_INT, &conf.getstatus_retries,
1038
"Number of times to attempt getting status of the buffer", NULL, 0},
1039
{"SET_PRIMARY", AUD_OPT_BOOL, &conf.set_primary,
1040
"Set the parameters of primary buffer", NULL, 0},
1041
{"LATENCY_MILLIS", AUD_OPT_INT, &conf.latency_millis,
1042
"(undocumented)", NULL, 0},
1043
{"PRIMARY_FREQ", AUD_OPT_INT, &conf.settings.freq,
1044
"Primary buffer frequency", NULL, 0},
1045
{"PRIMARY_CHANNELS", AUD_OPT_INT, &conf.settings.nchannels,
1046
"Primary buffer number of channels (1 - mono, 2 - stereo)", NULL, 0},
1047
{"PRIMARY_FMT", AUD_OPT_FMT, &conf.settings.fmt,
1048
"Primary buffer format", NULL, 0},
1049
{"BUFSIZE_OUT", AUD_OPT_INT, &conf.bufsize_out,
1050
"(undocumented)", NULL, 0},
1051
{"BUFSIZE_IN", AUD_OPT_INT, &conf.bufsize_in,
1052
"(undocumented)", NULL, 0},
1053
{NULL, 0, NULL, NULL, NULL, 0}
1056
static struct audio_pcm_ops dsound_pcm_ops = {
1070
struct audio_driver dsound_audio_driver = {
1071
INIT_FIELD (name = ) "dsound",
1072
INIT_FIELD (descr = )
1073
"DirectSound http://wikipedia.org/wiki/DirectSound",
1074
INIT_FIELD (options = ) dsound_options,
1075
INIT_FIELD (init = ) dsound_audio_init,
1076
INIT_FIELD (fini = ) dsound_audio_fini,
1077
INIT_FIELD (pcm_ops = ) &dsound_pcm_ops,
1078
INIT_FIELD (can_be_default = ) 1,
1079
INIT_FIELD (max_voices_out = ) INT_MAX,
1080
INIT_FIELD (max_voices_in = ) 1,
1081
INIT_FIELD (voice_size_out = ) sizeof (DSoundVoiceOut),
1082
INIT_FIELD (voice_size_in = ) sizeof (DSoundVoiceIn)