3 * Copyright 1998 Marcus Meissner
4 * Copyright 1998 Rob Riggs
5 * Copyright 2000-2002 TransGaming Technologies, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * Most thread locking is complete. There may be a few race
23 * conditions still lurking.
25 * Tested with a Soundblaster clone, a Gravis UltraSound Classic,
26 * and a Turtle Beach Tropez+.
29 * Implement SetCooperativeLevel properly (need to address focus issues)
30 * Implement DirectSound3DBuffers (stubs in place)
31 * Use hardware 3D support if available
32 * Add critical section locking inside Release and AddRef methods
33 * Handle static buffers - put those in hardware, non-static not in hardware
34 * Hardware DuplicateSoundBuffer
35 * Proper volume calculation, and setting volume in HEL primary buffer
36 * Optimize WINMM and negotiate fragment size, decrease DS_HEL_MARGIN
40 #include "wine/port.h"
45 #include <sys/types.h>
46 #include <sys/fcntl.h>
54 #define NONAMELESSSTRUCT
55 #define NONAMELESSUNION
66 #include "wine/windef16.h"
67 #include "wine/winbase16.h"
68 #include "wine/debug.h"
71 #include "dsound_private.h"
74 WINE_DEFAULT_DEBUG_CHANNEL(dsound);
76 /* these are eligible for tuning... they must be high on slow machines... */
77 /* some stuff may get more responsive with lower values though... */
78 #define DS_EMULDRIVER 0 /* some games (Quake 2, UT) refuse to accept
79 emulated dsound devices. set to 0 ! */
80 #define DS_HEL_MARGIN 5 /* HEL only: number of waveOut fragments ahead to mix in new buffers
81 * (keep this close or equal to DS_HEL_QUEUE for best results) */
82 #define DS_HEL_QUEUE 5 /* HEL only: number of waveOut fragments ahead to queue to driver
83 * (this will affect HEL sound reliability and latency) */
85 #define DS_SND_QUEUE_MAX 28 /* max number of fragments to prebuffer */
86 #define DS_SND_QUEUE_MIN 12 /* min number of fragments to prebuffer */
88 IDirectSoundImpl* dsound = NULL;
90 HRESULT mmErr(UINT err)
93 case MMSYSERR_NOERROR:
95 case MMSYSERR_ALLOCATED:
96 return DSERR_ALLOCATED;
98 case MMSYSERR_INVALHANDLE:
99 case WAVERR_STILLPLAYING:
100 return DSERR_GENERIC; /* FIXME */
101 case MMSYSERR_NODRIVER:
102 return DSERR_NODRIVER;
104 return DSERR_OUTOFMEMORY;
105 case MMSYSERR_INVALPARAM:
106 case WAVERR_BADFORMAT:
107 case WAVERR_UNPREPARED:
108 return DSERR_INVALIDPARAM;
109 case MMSYSERR_NOTSUPPORTED:
110 return DSERR_UNSUPPORTED;
112 FIXME("Unknown MMSYS error %d\n",err);
113 return DSERR_GENERIC;
117 int ds_emuldriver = DS_EMULDRIVER;
118 int ds_hel_margin = DS_HEL_MARGIN;
119 int ds_hel_queue = DS_HEL_QUEUE;
120 int ds_snd_queue_max = DS_SND_QUEUE_MAX;
121 int ds_snd_queue_min = DS_SND_QUEUE_MIN;
122 int ds_hw_accel = DS_HW_ACCEL_FULL;
123 int ds_default_playback = 0;
124 int ds_default_capture = 0;
127 * Get a config key from either the app-specific or the default config
130 inline static DWORD get_config_key( HKEY defkey, HKEY appkey, const char *name,
131 char *buffer, DWORD size )
133 if (appkey && !RegQueryValueExA( appkey, name, 0, NULL, buffer, &size )) return 0;
134 return RegQueryValueExA( defkey, name, 0, NULL, buffer, &size );
139 * Setup the dsound options.
142 void setup_dsound_options(void)
144 char buffer[MAX_PATH+1];
145 HKEY hkey, appkey = 0;
148 buffer[MAX_PATH]='\0';
150 if (RegCreateKeyExA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\dsound", 0, NULL,
151 REG_OPTION_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, NULL ))
153 ERR("Cannot create config registry key\n" );
157 len = GetModuleFileNameA( 0, buffer, MAX_PATH );
158 if (len && len < MAX_PATH)
162 if (!RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\AppDefaults", &tmpkey ))
164 char appname[MAX_PATH+16];
165 char *p = strrchr( buffer, '\\' );
167 appname[MAX_PATH]='\0';
168 strncpy(appname,p+1,MAX_PATH);
169 strcat(appname,"\\dsound");
170 TRACE("appname = [%s] \n",appname);
171 if (RegOpenKeyA( tmpkey, appname, &appkey )) appkey = 0;
172 RegCloseKey( tmpkey );
179 if (!get_config_key( hkey, appkey, "EmulDriver", buffer, MAX_PATH ))
180 ds_emuldriver = strcmp(buffer, "N");
182 if (!get_config_key( hkey, appkey, "HELmargin", buffer, MAX_PATH ))
183 ds_hel_margin = atoi(buffer);
185 if (!get_config_key( hkey, appkey, "HELqueue", buffer, MAX_PATH ))
186 ds_hel_queue = atoi(buffer);
188 if (!get_config_key( hkey, appkey, "SndQueueMax", buffer, MAX_PATH ))
189 ds_snd_queue_max = atoi(buffer);
191 if (!get_config_key( hkey, appkey, "SndQueueMin", buffer, MAX_PATH ))
192 ds_snd_queue_min = atoi(buffer);
194 if (!get_config_key( hkey, appkey, "HardwareAcceleration", buffer, MAX_PATH )) {
195 if (strcmp(buffer, "Full") == 0)
196 ds_hw_accel = DS_HW_ACCEL_FULL;
197 else if (strcmp(buffer, "Standard") == 0)
198 ds_hw_accel = DS_HW_ACCEL_STANDARD;
199 else if (strcmp(buffer, "Basic") == 0)
200 ds_hw_accel = DS_HW_ACCEL_BASIC;
201 else if (strcmp(buffer, "Emulation") == 0)
202 ds_hw_accel = DS_HW_ACCEL_EMULATION;
205 if (!get_config_key( hkey, appkey, "DefaultPlayback", buffer, MAX_PATH ))
206 ds_default_playback = atoi(buffer);
208 if (!get_config_key( hkey, appkey, "DefaultCapture", buffer, MAX_PATH ))
209 ds_default_capture = atoi(buffer);
211 if (appkey) RegCloseKey( appkey );
214 if (ds_emuldriver != DS_EMULDRIVER )
215 WARN("ds_emuldriver = %d (default=%d)\n",ds_emuldriver, DS_EMULDRIVER);
216 if (ds_hel_margin != DS_HEL_MARGIN )
217 WARN("ds_hel_margin = %d (default=%d)\n",ds_hel_margin, DS_HEL_MARGIN );
218 if (ds_hel_queue != DS_HEL_QUEUE )
219 WARN("ds_hel_queue = %d (default=%d)\n",ds_hel_queue, DS_HEL_QUEUE );
220 if (ds_snd_queue_max != DS_SND_QUEUE_MAX)
221 WARN("ds_snd_queue_max = %d (default=%d)\n",ds_snd_queue_max ,DS_SND_QUEUE_MAX);
222 if (ds_snd_queue_min != DS_SND_QUEUE_MIN)
223 WARN("ds_snd_queue_min = %d (default=%d)\n",ds_snd_queue_min ,DS_SND_QUEUE_MIN);
224 if (ds_hw_accel != DS_HW_ACCEL_FULL)
225 WARN("ds_hw_accel = %s (default=Full)\n",
226 ds_hw_accel==DS_HW_ACCEL_FULL ? "Full" :
227 ds_hw_accel==DS_HW_ACCEL_STANDARD ? "Standard" :
228 ds_hw_accel==DS_HW_ACCEL_BASIC ? "Basic" :
229 ds_hw_accel==DS_HW_ACCEL_EMULATION ? "Emulation" :
231 if (ds_default_playback != 0)
232 WARN("ds_default_playback = %d (default=0)\n",ds_default_playback);
233 if (ds_default_capture != 0)
234 WARN("ds_default_capture = %d (default=0)\n",ds_default_playback);
239 /***************************************************************************
240 * GetDeviceID [DSOUND.9]
242 * Retrieves unique identifier of default device specified
245 * pGuidSrc [I] Address of device GUID.
246 * pGuidDest [O] Address to receive unique device GUID.
250 * Failure: DSERR_INVALIDPARAM
253 * pGuidSrc is a valid device GUID or DSDEVID_DefaultPlayback,
254 * DSDEVID_DefaultCapture, DSDEVID_DefaultVoicePlayback, or
255 * DSDEVID_DefaultVoiceCapture.
256 * Returns pGuidSrc if pGuidSrc is a valid device or the device
257 * GUID for the specified constants.
259 HRESULT WINAPI GetDeviceID(LPCGUID pGuidSrc, LPGUID pGuidDest)
261 TRACE("(%p,%p)\n",pGuidSrc,pGuidDest);
263 if ( pGuidSrc == NULL) {
264 WARN("invalid parameter: pGuidSrc == NULL\n");
265 return DSERR_INVALIDPARAM;
268 if ( pGuidDest == NULL ) {
269 WARN("invalid parameter: pGuidDest == NULL\n");
270 return DSERR_INVALIDPARAM;
273 if ( IsEqualGUID( &DSDEVID_DefaultPlayback, pGuidSrc ) ||
274 IsEqualGUID( &DSDEVID_DefaultVoicePlayback, pGuidSrc ) ) {
276 int err = mmErr(waveOutMessage((HWAVEOUT)ds_default_playback,DRV_QUERYDSOUNDGUID,(DWORD)&guid,0));
278 memcpy(pGuidDest, &guid, sizeof(GUID));
283 if ( IsEqualGUID( &DSDEVID_DefaultCapture, pGuidSrc ) ||
284 IsEqualGUID( &DSDEVID_DefaultVoiceCapture, pGuidSrc ) ) {
286 int err = mmErr(waveInMessage((HWAVEIN)ds_default_capture,DRV_QUERYDSOUNDGUID,(DWORD)&guid,0));
288 memcpy(pGuidDest, &guid, sizeof(GUID));
293 memcpy(pGuidDest, pGuidSrc, sizeof(GUID));
299 /***************************************************************************
300 * DirectSoundEnumerateA [DSOUND.2]
302 * Enumerate all DirectSound drivers installed in the system
305 * lpDSEnumCallback [I] Address of callback function.
306 * lpContext [I] Address of user defined context passed to callback function.
310 * Failure: DSERR_INVALIDPARAM
312 HRESULT WINAPI DirectSoundEnumerateA(
313 LPDSENUMCALLBACKA lpDSEnumCallback,
321 TRACE("lpDSEnumCallback = %p, lpContext = %p\n",
322 lpDSEnumCallback, lpContext);
324 if (lpDSEnumCallback == NULL) {
325 WARN("invalid parameter: lpDSEnumCallback == NULL\n");
326 return DSERR_INVALIDPARAM;
329 devs = waveOutGetNumDevs();
331 if (GetDeviceID(&DSDEVID_DefaultPlayback, &guid) == DS_OK) {
333 for (wod = 0; wod < devs; ++wod) {
334 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDGUID,(DWORD)&temp,0));
336 if (IsEqualGUID( &guid, &temp ) ) {
337 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDDESC,(DWORD)&desc,0));
339 TRACE("calling lpDSEnumCallback(NULL,\"%s\",\"%s\",%p)\n",
340 "Primary Sound Driver",desc.szDrvName,lpContext);
341 if (lpDSEnumCallback(NULL, "Primary Sound Driver", desc.szDrvName, lpContext) == FALSE)
350 for (wod = 0; wod < devs; ++wod) {
351 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDDESC,(DWORD)&desc,0));
353 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDGUID,(DWORD)&guid,0));
355 TRACE("calling lpDSEnumCallback(%s,\"%s\",\"%s\",%p)\n",
356 debugstr_guid(&guid),desc.szDesc,desc.szDrvName,lpContext);
357 if (lpDSEnumCallback(&guid, desc.szDesc, desc.szDrvName, lpContext) == FALSE)
365 /***************************************************************************
366 * DirectSoundEnumerateW [DSOUND.3]
368 * Enumerate all DirectSound drivers installed in the system
371 * lpDSEnumCallback [I] Address of callback function.
372 * lpContext [I] Address of user defined context passed to callback function.
376 * Failure: DSERR_INVALIDPARAM
378 HRESULT WINAPI DirectSoundEnumerateW(
379 LPDSENUMCALLBACKW lpDSEnumCallback,
386 WCHAR wDesc[MAXPNAMELEN];
387 WCHAR wName[MAXPNAMELEN];
389 TRACE("lpDSEnumCallback = %p, lpContext = %p\n",
390 lpDSEnumCallback, lpContext);
392 if (lpDSEnumCallback == NULL) {
393 WARN("invalid parameter: lpDSEnumCallback == NULL\n");
394 return DSERR_INVALIDPARAM;
397 devs = waveOutGetNumDevs();
399 if (GetDeviceID(&DSDEVID_DefaultPlayback, &guid) == DS_OK) {
401 for (wod = 0; wod < devs; ++wod) {
402 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDGUID,(DWORD)&temp,0));
404 if (IsEqualGUID( &guid, &temp ) ) {
405 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDDESC,(DWORD)&desc,0));
407 TRACE("calling lpDSEnumCallback(NULL,\"%s\",\"%s\",%p)\n",
408 "Primary Sound Driver",desc.szDrvName,lpContext);
409 MultiByteToWideChar( CP_ACP, 0, "Primary Sound Driver", -1,
410 wDesc, sizeof(wDesc)/sizeof(WCHAR) );
411 MultiByteToWideChar( CP_ACP, 0, desc.szDrvName, -1,
412 wName, sizeof(wName)/sizeof(WCHAR) );
413 if (lpDSEnumCallback(NULL, wDesc, wName, lpContext) == FALSE)
422 for (wod = 0; wod < devs; ++wod) {
423 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDDESC,(DWORD)&desc,0));
425 err = mmErr(waveOutMessage((HWAVEOUT)wod,DRV_QUERYDSOUNDGUID,(DWORD)&guid,0));
427 TRACE("calling lpDSEnumCallback(%s,\"%s\",\"%s\",%p)\n",
428 debugstr_guid(&guid),desc.szDesc,desc.szDrvName,lpContext);
429 MultiByteToWideChar( CP_ACP, 0, desc.szDesc, -1,
430 wDesc, sizeof(wDesc)/sizeof(WCHAR) );
431 MultiByteToWideChar( CP_ACP, 0, desc.szDrvName, -1,
432 wName, sizeof(wName)/sizeof(WCHAR) );
433 if (lpDSEnumCallback(&guid, wDesc, wName, lpContext) == FALSE)
441 /*******************************************************************************
442 * DirectSound ClassFactory
445 static HRESULT WINAPI
446 DSCF_QueryInterface(LPCLASSFACTORY iface,REFIID riid,LPVOID *ppobj) {
447 ICOM_THIS(IClassFactoryImpl,iface);
449 FIXME("(%p)->(%s,%p),stub!\n",This,debugstr_guid(riid),ppobj);
450 return E_NOINTERFACE;
454 DSCF_AddRef(LPCLASSFACTORY iface) {
455 ICOM_THIS(IClassFactoryImpl,iface);
456 TRACE("(%p) ref was %ld\n", This, This->ref);
457 return ++(This->ref);
460 static ULONG WINAPI DSCF_Release(LPCLASSFACTORY iface) {
461 ICOM_THIS(IClassFactoryImpl,iface);
462 /* static class, won't be freed */
463 TRACE("(%p) ref was %ld\n", This, This->ref);
464 return --(This->ref);
467 static HRESULT WINAPI DSCF_CreateInstance(
468 LPCLASSFACTORY iface,LPUNKNOWN pOuter,REFIID riid,LPVOID *ppobj
470 ICOM_THIS(IClassFactoryImpl,iface);
471 TRACE("(%p)->(%p,%s,%p)\n",This,pOuter,debugstr_guid(riid),ppobj);
474 WARN("invalid parameter\n");
475 return DSERR_INVALIDPARAM;
480 if ( IsEqualIID( &IID_IDirectSound, riid ) )
481 return DirectSoundCreate(0,(LPDIRECTSOUND*)ppobj,pOuter);
483 if ( IsEqualIID( &IID_IDirectSound8, riid ) )
484 return DirectSoundCreate8(0,(LPDIRECTSOUND8*)ppobj,pOuter);
486 WARN("(%p,%p,%s,%p) Interface not found!\n",This,pOuter,debugstr_guid(riid),ppobj);
487 return E_NOINTERFACE;
490 static HRESULT WINAPI DSCF_LockServer(LPCLASSFACTORY iface,BOOL dolock) {
491 ICOM_THIS(IClassFactoryImpl,iface);
492 FIXME("(%p)->(%d),stub!\n",This,dolock);
496 static ICOM_VTABLE(IClassFactory) DSCF_Vtbl = {
497 ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
505 static IClassFactoryImpl DSOUND_CF = { &DSCF_Vtbl, 1 };
507 /*******************************************************************************
508 * DirectSoundPrivate ClassFactory
511 static HRESULT WINAPI
512 DSPCF_QueryInterface(LPCLASSFACTORY iface,REFIID riid,LPVOID *ppobj) {
513 ICOM_THIS(IClassFactoryImpl,iface);
515 FIXME("(%p)->(%s,%p),stub!\n",This,debugstr_guid(riid),ppobj);
516 return E_NOINTERFACE;
520 DSPCF_AddRef(LPCLASSFACTORY iface) {
521 ICOM_THIS(IClassFactoryImpl,iface);
522 TRACE("(%p) ref was %ld\n", This, This->ref);
523 return ++(This->ref);
527 DSPCF_Release(LPCLASSFACTORY iface) {
528 ICOM_THIS(IClassFactoryImpl,iface);
529 /* static class, won't be freed */
530 TRACE("(%p) ref was %ld\n", This, This->ref);
531 return --(This->ref);
534 static HRESULT WINAPI
535 DSPCF_CreateInstance(
536 LPCLASSFACTORY iface,LPUNKNOWN pOuter,REFIID riid,LPVOID *ppobj
538 ICOM_THIS(IClassFactoryImpl,iface);
539 TRACE("(%p)->(%p,%s,%p)\n",This,pOuter,debugstr_guid(riid),ppobj);
542 WARN("invalid parameter\n");
543 return DSERR_INVALIDPARAM;
548 if ( IsEqualGUID( &IID_IKsPropertySet, riid ) ) {
549 return IKsPrivatePropertySetImpl_Create((IKsPrivatePropertySetImpl**)ppobj);
552 WARN("(%p,%p,%s,%p) Interface not found!\n",This,pOuter,debugstr_guid(riid),ppobj);
553 return E_NOINTERFACE;
556 static HRESULT WINAPI
557 DSPCF_LockServer(LPCLASSFACTORY iface,BOOL dolock) {
558 ICOM_THIS(IClassFactoryImpl,iface);
559 FIXME("(%p)->(%d),stub!\n",This,dolock);
563 static ICOM_VTABLE(IClassFactory) DSPCF_Vtbl = {
564 ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
565 DSPCF_QueryInterface,
568 DSPCF_CreateInstance,
572 static IClassFactoryImpl DSOUND_PRIVATE_CF = { &DSPCF_Vtbl, 1 };
574 /*******************************************************************************
575 * DllGetClassObject [DSOUND.5]
576 * Retrieves class object from a DLL object
579 * Docs say returns STDAPI
582 * rclsid [I] CLSID for the class object
583 * riid [I] Reference to identifier of interface for class object
584 * ppv [O] Address of variable to receive interface pointer for riid
588 * Failure: CLASS_E_CLASSNOTAVAILABLE, E_OUTOFMEMORY, E_INVALIDARG,
591 DWORD WINAPI DSOUND_DllGetClassObject(REFCLSID rclsid,REFIID riid,LPVOID *ppv)
593 TRACE("(%s,%s,%p)\n", debugstr_guid(rclsid), debugstr_guid(riid), ppv);
596 WARN("invalid parameter\n");
602 if ( IsEqualCLSID( &CLSID_DirectSound, rclsid ) ||
603 IsEqualCLSID( &CLSID_DirectSound8, rclsid ) ) {
604 if ( IsEqualCLSID( &IID_IClassFactory, riid ) ) {
605 *ppv = (LPVOID)&DSOUND_CF;
606 IClassFactory_AddRef((IClassFactory*)*ppv);
609 WARN("(%s,%s,%p): no interface found.\n",
610 debugstr_guid(rclsid), debugstr_guid(riid), ppv);
614 if ( IsEqualCLSID( &CLSID_DirectSoundCapture, rclsid ) ||
615 IsEqualCLSID( &CLSID_DirectSoundCapture8, rclsid ) ) {
616 if ( IsEqualCLSID( &IID_IClassFactory, riid ) ) {
617 *ppv = (LPVOID)&DSOUND_CAPTURE_CF;
618 IClassFactory_AddRef((IClassFactory*)*ppv);
621 WARN("(%s,%s,%p): no interface found.\n",
622 debugstr_guid(rclsid), debugstr_guid(riid), ppv);
626 if ( IsEqualCLSID( &CLSID_DirectSoundFullDuplex, rclsid ) ) {
627 if ( IsEqualCLSID( &IID_IClassFactory, riid ) ) {
628 *ppv = (LPVOID)&DSOUND_FULLDUPLEX_CF;
629 IClassFactory_AddRef((IClassFactory*)*ppv);
632 WARN("(%s,%s,%p): no interface found.\n",
633 debugstr_guid(rclsid), debugstr_guid(riid), ppv);
637 if ( IsEqualCLSID( &CLSID_DirectSoundPrivate, rclsid ) ) {
638 if ( IsEqualCLSID( &IID_IClassFactory, riid ) ) {
639 *ppv = (LPVOID)&DSOUND_PRIVATE_CF;
640 IClassFactory_AddRef((IClassFactory*)*ppv);
643 WARN("(%s,%s,%p): no interface found.\n",
644 debugstr_guid(rclsid), debugstr_guid(riid), ppv);
648 WARN("(%s,%s,%p): no class found.\n", debugstr_guid(rclsid), debugstr_guid(riid), ppv);
649 return CLASS_E_CLASSNOTAVAILABLE;
653 /*******************************************************************************
654 * DllCanUnloadNow [DSOUND.4]
655 * Determines whether the DLL is in use.
661 DWORD WINAPI DSOUND_DllCanUnloadNow(void)
663 FIXME("(void): stub\n");