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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * Most thread locking is complete. There may be a few race
22 * conditions still lurking.
25 * Implement SetCooperativeLevel properly (need to address focus issues)
26 * Implement DirectSound3DBuffers (stubs in place)
27 * Use hardware 3D support if available
28 * Add critical section locking inside Release and AddRef methods
29 * Handle static buffers - put those in hardware, non-static not in hardware
30 * Hardware DuplicateSoundBuffer
31 * Proper volume calculation for 3d buffers
32 * Remove DS_HEL_FRAGS and use mixer fragment length for it
38 #define NONAMELESSSTRUCT
39 #define NONAMELESSUNION
48 #include "wine/debug.h"
56 #include "dsound_private.h"
58 WINE_DEFAULT_DEBUG_CHANNEL(dsound
);
60 DirectSoundDevice
* DSOUND_renderer
[MAXWAVEDRIVERS
];
61 GUID DSOUND_renderer_guids
[MAXWAVEDRIVERS
];
62 GUID DSOUND_capture_guids
[MAXWAVEDRIVERS
];
64 HRESULT
mmErr(UINT err
)
67 case MMSYSERR_NOERROR
:
69 case MMSYSERR_ALLOCATED
:
70 return DSERR_ALLOCATED
;
72 case MMSYSERR_INVALHANDLE
:
73 case WAVERR_STILLPLAYING
:
74 return DSERR_GENERIC
; /* FIXME */
75 case MMSYSERR_NODRIVER
:
76 return DSERR_NODRIVER
;
78 return DSERR_OUTOFMEMORY
;
79 case MMSYSERR_INVALPARAM
:
80 case WAVERR_BADFORMAT
:
81 case WAVERR_UNPREPARED
:
82 return DSERR_INVALIDPARAM
;
83 case MMSYSERR_NOTSUPPORTED
:
84 return DSERR_UNSUPPORTED
;
86 FIXME("Unknown MMSYS error %d\n",err
);
91 /* All default settings, you most likely don't want to touch these, see wiki on UsefulRegistryKeys */
92 int ds_emuldriver
= 0;
93 int ds_hel_buflen
= 32768 * 2;
94 int ds_snd_queue_max
= 10;
95 int ds_snd_queue_min
= 6;
96 int ds_snd_shadow_maxsize
= 2;
97 int ds_hw_accel
= DS_HW_ACCEL_FULL
;
98 int ds_default_sample_rate
= 44100;
99 int ds_default_bits_per_sample
= 16;
100 static int ds_default_playback
;
101 static int ds_default_capture
;
104 * Get a config key from either the app-specific or the default config
107 static inline DWORD
get_config_key( HKEY defkey
, HKEY appkey
, const char *name
,
108 char *buffer
, DWORD size
)
110 if (appkey
&& !RegQueryValueExA( appkey
, name
, 0, NULL
, (LPBYTE
)buffer
, &size
)) return 0;
111 if (defkey
&& !RegQueryValueExA( defkey
, name
, 0, NULL
, (LPBYTE
)buffer
, &size
)) return 0;
112 return ERROR_FILE_NOT_FOUND
;
117 * Setup the dsound options.
120 void setup_dsound_options(void)
122 char buffer
[MAX_PATH
+16];
123 HKEY hkey
, appkey
= 0;
126 buffer
[MAX_PATH
]='\0';
128 /* @@ Wine registry key: HKCU\Software\Wine\DirectSound */
129 if (RegOpenKeyA( HKEY_CURRENT_USER
, "Software\\Wine\\DirectSound", &hkey
)) hkey
= 0;
131 len
= GetModuleFileNameA( 0, buffer
, MAX_PATH
);
132 if (len
&& len
< MAX_PATH
)
135 /* @@ Wine registry key: HKCU\Software\Wine\AppDefaults\app.exe\DirectSound */
136 if (!RegOpenKeyA( HKEY_CURRENT_USER
, "Software\\Wine\\AppDefaults", &tmpkey
))
138 char *p
, *appname
= buffer
;
139 if ((p
= strrchr( appname
, '/' ))) appname
= p
+ 1;
140 if ((p
= strrchr( appname
, '\\' ))) appname
= p
+ 1;
141 strcat( appname
, "\\DirectSound" );
142 TRACE("appname = [%s]\n", appname
);
143 if (RegOpenKeyA( tmpkey
, appname
, &appkey
)) appkey
= 0;
144 RegCloseKey( tmpkey
);
150 if (!get_config_key( hkey
, appkey
, "EmulDriver", buffer
, MAX_PATH
))
151 ds_emuldriver
= strcmp(buffer
, "N");
153 if (!get_config_key( hkey
, appkey
, "HelBuflen", buffer
, MAX_PATH
))
154 ds_hel_buflen
= atoi(buffer
);
156 if (!get_config_key( hkey
, appkey
, "SndQueueMax", buffer
, MAX_PATH
))
157 ds_snd_queue_max
= atoi(buffer
);
159 if (!get_config_key( hkey
, appkey
, "SndQueueMin", buffer
, MAX_PATH
))
160 ds_snd_queue_min
= atoi(buffer
);
162 if (!get_config_key( hkey
, appkey
, "HardwareAcceleration", buffer
, MAX_PATH
)) {
163 if (strcmp(buffer
, "Full") == 0)
164 ds_hw_accel
= DS_HW_ACCEL_FULL
;
165 else if (strcmp(buffer
, "Standard") == 0)
166 ds_hw_accel
= DS_HW_ACCEL_STANDARD
;
167 else if (strcmp(buffer
, "Basic") == 0)
168 ds_hw_accel
= DS_HW_ACCEL_BASIC
;
169 else if (strcmp(buffer
, "Emulation") == 0)
170 ds_hw_accel
= DS_HW_ACCEL_EMULATION
;
173 if (!get_config_key( hkey
, appkey
, "DefaultPlayback", buffer
, MAX_PATH
))
174 ds_default_playback
= atoi(buffer
);
176 if (!get_config_key( hkey
, appkey
, "MaxShadowSize", buffer
, MAX_PATH
))
177 ds_snd_shadow_maxsize
= atoi(buffer
);
179 if (!get_config_key( hkey
, appkey
, "DefaultCapture", buffer
, MAX_PATH
))
180 ds_default_capture
= atoi(buffer
);
182 if (!get_config_key( hkey
, appkey
, "DefaultSampleRate", buffer
, MAX_PATH
))
183 ds_default_sample_rate
= atoi(buffer
);
185 if (!get_config_key( hkey
, appkey
, "DefaultBitsPerSample", buffer
, MAX_PATH
))
186 ds_default_bits_per_sample
= atoi(buffer
);
188 if (appkey
) RegCloseKey( appkey
);
189 if (hkey
) RegCloseKey( hkey
);
191 TRACE("ds_emuldriver = %d\n", ds_emuldriver
);
192 TRACE("ds_hel_buflen = %d\n", ds_hel_buflen
);
193 TRACE("ds_snd_queue_max = %d\n", ds_snd_queue_max
);
194 TRACE("ds_snd_queue_min = %d\n", ds_snd_queue_min
);
195 TRACE("ds_hw_accel = %s\n",
196 ds_hw_accel
==DS_HW_ACCEL_FULL
? "Full" :
197 ds_hw_accel
==DS_HW_ACCEL_STANDARD
? "Standard" :
198 ds_hw_accel
==DS_HW_ACCEL_BASIC
? "Basic" :
199 ds_hw_accel
==DS_HW_ACCEL_EMULATION
? "Emulation" :
201 TRACE("ds_default_playback = %d\n", ds_default_playback
);
202 TRACE("ds_default_capture = %d\n", ds_default_playback
);
203 TRACE("ds_default_sample_rate = %d\n", ds_default_sample_rate
);
204 TRACE("ds_default_bits_per_sample = %d\n", ds_default_bits_per_sample
);
205 TRACE("ds_snd_shadow_maxsize = %d\n", ds_snd_shadow_maxsize
);
208 static const char * get_device_id(LPCGUID pGuid
)
210 if (IsEqualGUID(&DSDEVID_DefaultPlayback
, pGuid
))
211 return "DSDEVID_DefaultPlayback";
212 else if (IsEqualGUID(&DSDEVID_DefaultVoicePlayback
, pGuid
))
213 return "DSDEVID_DefaultVoicePlayback";
214 else if (IsEqualGUID(&DSDEVID_DefaultCapture
, pGuid
))
215 return "DSDEVID_DefaultCapture";
216 else if (IsEqualGUID(&DSDEVID_DefaultVoiceCapture
, pGuid
))
217 return "DSDEVID_DefaultVoiceCapture";
218 return debugstr_guid(pGuid
);
221 /***************************************************************************
222 * GetDeviceID [DSOUND.9]
224 * Retrieves unique identifier of default device specified
227 * pGuidSrc [I] Address of device GUID.
228 * pGuidDest [O] Address to receive unique device GUID.
232 * Failure: DSERR_INVALIDPARAM
235 * pGuidSrc is a valid device GUID or DSDEVID_DefaultPlayback,
236 * DSDEVID_DefaultCapture, DSDEVID_DefaultVoicePlayback, or
237 * DSDEVID_DefaultVoiceCapture.
238 * Returns pGuidSrc if pGuidSrc is a valid device or the device
239 * GUID for the specified constants.
241 HRESULT WINAPI
GetDeviceID(LPCGUID pGuidSrc
, LPGUID pGuidDest
)
243 TRACE("(%s,%p)\n", get_device_id(pGuidSrc
),pGuidDest
);
245 if ( pGuidSrc
== NULL
) {
246 WARN("invalid parameter: pGuidSrc == NULL\n");
247 return DSERR_INVALIDPARAM
;
250 if ( pGuidDest
== NULL
) {
251 WARN("invalid parameter: pGuidDest == NULL\n");
252 return DSERR_INVALIDPARAM
;
255 if ( IsEqualGUID( &DSDEVID_DefaultPlayback
, pGuidSrc
) ||
256 IsEqualGUID( &DSDEVID_DefaultVoicePlayback
, pGuidSrc
) ) {
257 *pGuidDest
= DSOUND_renderer_guids
[ds_default_playback
];
258 TRACE("returns %s\n", get_device_id(pGuidDest
));
262 if ( IsEqualGUID( &DSDEVID_DefaultCapture
, pGuidSrc
) ||
263 IsEqualGUID( &DSDEVID_DefaultVoiceCapture
, pGuidSrc
) ) {
264 *pGuidDest
= DSOUND_capture_guids
[ds_default_capture
];
265 TRACE("returns %s\n", get_device_id(pGuidDest
));
269 *pGuidDest
= *pGuidSrc
;
270 TRACE("returns %s\n", get_device_id(pGuidDest
));
276 /***************************************************************************
277 * DirectSoundEnumerateA [DSOUND.2]
279 * Enumerate all DirectSound drivers installed in the system
282 * lpDSEnumCallback [I] Address of callback function.
283 * lpContext [I] Address of user defined context passed to callback function.
287 * Failure: DSERR_INVALIDPARAM
289 HRESULT WINAPI
DirectSoundEnumerateA(
290 LPDSENUMCALLBACKA lpDSEnumCallback
,
298 TRACE("lpDSEnumCallback = %p, lpContext = %p\n",
299 lpDSEnumCallback
, lpContext
);
301 if (lpDSEnumCallback
== NULL
) {
302 WARN("invalid parameter: lpDSEnumCallback == NULL\n");
303 return DSERR_INVALIDPARAM
;
306 devs
= waveOutGetNumDevs();
308 if (GetDeviceID(&DSDEVID_DefaultPlayback
, &guid
) == DS_OK
) {
309 for (wod
= 0; wod
< devs
; ++wod
) {
310 if (IsEqualGUID( &guid
, &DSOUND_renderer_guids
[wod
]) ) {
311 err
= mmErr(waveOutMessage(UlongToHandle(wod
),DRV_QUERYDSOUNDDESC
,(DWORD_PTR
)&desc
,0));
313 TRACE("calling lpDSEnumCallback(NULL,\"%s\",\"%s\",%p)\n",
314 "Primary Sound Driver","",lpContext
);
315 if (lpDSEnumCallback(NULL
, "Primary Sound Driver", "", lpContext
) == FALSE
)
323 for (wod
= 0; wod
< devs
; ++wod
) {
324 err
= mmErr(waveOutMessage(UlongToHandle(wod
),DRV_QUERYDSOUNDDESC
,(DWORD_PTR
)&desc
,0));
326 TRACE("calling lpDSEnumCallback(%s,\"%s\",\"%s\",%p)\n",
327 debugstr_guid(&DSOUND_renderer_guids
[wod
]),desc
.szDesc
,desc
.szDrvname
,lpContext
);
328 if (lpDSEnumCallback(&DSOUND_renderer_guids
[wod
], desc
.szDesc
, desc
.szDrvname
, lpContext
) == FALSE
)
335 /***************************************************************************
336 * DirectSoundEnumerateW [DSOUND.3]
338 * Enumerate all DirectSound drivers installed in the system
341 * lpDSEnumCallback [I] Address of callback function.
342 * lpContext [I] Address of user defined context passed to callback function.
346 * Failure: DSERR_INVALIDPARAM
348 HRESULT WINAPI
DirectSoundEnumerateW(
349 LPDSENUMCALLBACKW lpDSEnumCallback
,
356 WCHAR wDesc
[MAXPNAMELEN
];
357 WCHAR wName
[MAXPNAMELEN
];
359 TRACE("lpDSEnumCallback = %p, lpContext = %p\n",
360 lpDSEnumCallback
, lpContext
);
362 if (lpDSEnumCallback
== NULL
) {
363 WARN("invalid parameter: lpDSEnumCallback == NULL\n");
364 return DSERR_INVALIDPARAM
;
367 devs
= waveOutGetNumDevs();
369 if (GetDeviceID(&DSDEVID_DefaultPlayback
, &guid
) == DS_OK
) {
370 static const WCHAR empty
[] = { 0 };
371 for (wod
= 0; wod
< devs
; ++wod
) {
372 if (IsEqualGUID( &guid
, &DSOUND_renderer_guids
[wod
] ) ) {
373 err
= mmErr(waveOutMessage(UlongToHandle(wod
),DRV_QUERYDSOUNDDESC
,(DWORD_PTR
)&desc
,0));
375 TRACE("calling lpDSEnumCallback(NULL,\"%s\",\"%s\",%p)\n",
376 "Primary Sound Driver",desc
.szDrvname
,lpContext
);
377 MultiByteToWideChar( CP_ACP
, 0, "Primary Sound Driver", -1,
378 wDesc
, sizeof(wDesc
)/sizeof(WCHAR
) );
379 if (lpDSEnumCallback(NULL
, wDesc
, empty
, lpContext
) == FALSE
)
387 for (wod
= 0; wod
< devs
; ++wod
) {
388 err
= mmErr(waveOutMessage(UlongToHandle(wod
),DRV_QUERYDSOUNDDESC
,(DWORD_PTR
)&desc
,0));
390 TRACE("calling lpDSEnumCallback(%s,\"%s\",\"%s\",%p)\n",
391 debugstr_guid(&DSOUND_renderer_guids
[wod
]),desc
.szDesc
,desc
.szDrvname
,lpContext
);
392 MultiByteToWideChar( CP_ACP
, 0, desc
.szDesc
, -1,
393 wDesc
, sizeof(wDesc
)/sizeof(WCHAR
) );
394 MultiByteToWideChar( CP_ACP
, 0, desc
.szDrvname
, -1,
395 wName
, sizeof(wName
)/sizeof(WCHAR
) );
396 if (lpDSEnumCallback(&DSOUND_renderer_guids
[wod
], wDesc
, wName
, lpContext
) == FALSE
)
403 /*******************************************************************************
404 * DirectSound ClassFactory
407 typedef HRESULT (*FnCreateInstance
)(REFIID riid
, LPVOID
*ppobj
);
410 const IClassFactoryVtbl
*lpVtbl
;
413 FnCreateInstance pfnCreateInstance
;
416 static HRESULT WINAPI
417 DSCF_QueryInterface(LPCLASSFACTORY iface
, REFIID riid
, LPVOID
*ppobj
)
419 IClassFactoryImpl
*This
= (IClassFactoryImpl
*)iface
;
420 TRACE("(%p, %s, %p)\n", This
, debugstr_guid(riid
), ppobj
);
423 if (IsEqualIID(riid
, &IID_IUnknown
) ||
424 IsEqualIID(riid
, &IID_IClassFactory
))
427 IUnknown_AddRef(iface
);
431 return E_NOINTERFACE
;
434 static ULONG WINAPI
DSCF_AddRef(LPCLASSFACTORY iface
)
436 IClassFactoryImpl
*This
= (IClassFactoryImpl
*)iface
;
437 ULONG ref
= InterlockedIncrement(&(This
->ref
));
438 TRACE("(%p) ref was %d\n", This
, ref
- 1);
442 static ULONG WINAPI
DSCF_Release(LPCLASSFACTORY iface
)
444 IClassFactoryImpl
*This
= (IClassFactoryImpl
*)iface
;
445 ULONG ref
= InterlockedDecrement(&(This
->ref
));
446 TRACE("(%p) ref was %d\n", This
, ref
+ 1);
447 /* static class, won't be freed */
451 static HRESULT WINAPI
DSCF_CreateInstance(
452 LPCLASSFACTORY iface
,
457 IClassFactoryImpl
*This
= (IClassFactoryImpl
*)iface
;
458 TRACE("(%p, %p, %s, %p)\n", This
, pOuter
, debugstr_guid(riid
), ppobj
);
461 return CLASS_E_NOAGGREGATION
;
464 WARN("invalid parameter\n");
465 return DSERR_INVALIDPARAM
;
468 return This
->pfnCreateInstance(riid
, ppobj
);
471 static HRESULT WINAPI
DSCF_LockServer(LPCLASSFACTORY iface
, BOOL dolock
)
473 IClassFactoryImpl
*This
= (IClassFactoryImpl
*)iface
;
474 FIXME("(%p, %d) stub!\n", This
, dolock
);
478 static const IClassFactoryVtbl DSCF_Vtbl
= {
486 static IClassFactoryImpl DSOUND_CF
[] = {
487 { &DSCF_Vtbl
, 1, &CLSID_DirectSound
, (FnCreateInstance
)DSOUND_Create
},
488 { &DSCF_Vtbl
, 1, &CLSID_DirectSound8
, (FnCreateInstance
)DSOUND_Create8
},
489 { &DSCF_Vtbl
, 1, &CLSID_DirectSoundCapture
, (FnCreateInstance
)DSOUND_CaptureCreate
},
490 { &DSCF_Vtbl
, 1, &CLSID_DirectSoundCapture8
, (FnCreateInstance
)DSOUND_CaptureCreate8
},
491 { &DSCF_Vtbl
, 1, &CLSID_DirectSoundFullDuplex
, (FnCreateInstance
)DSOUND_FullDuplexCreate
},
492 { &DSCF_Vtbl
, 1, &CLSID_DirectSoundPrivate
, (FnCreateInstance
)IKsPrivatePropertySetImpl_Create
},
493 { NULL
, 0, NULL
, NULL
}
496 /*******************************************************************************
497 * DllGetClassObject [DSOUND.@]
498 * Retrieves class object from a DLL object
501 * Docs say returns STDAPI
504 * rclsid [I] CLSID for the class object
505 * riid [I] Reference to identifier of interface for class object
506 * ppv [O] Address of variable to receive interface pointer for riid
510 * Failure: CLASS_E_CLASSNOTAVAILABLE, E_OUTOFMEMORY, E_INVALIDARG,
513 HRESULT WINAPI
DllGetClassObject(REFCLSID rclsid
, REFIID riid
, LPVOID
*ppv
)
516 TRACE("(%s, %s, %p)\n", debugstr_guid(rclsid
), debugstr_guid(riid
), ppv
);
519 WARN("invalid parameter\n");
525 if (!IsEqualIID(riid
, &IID_IClassFactory
) &&
526 !IsEqualIID(riid
, &IID_IUnknown
)) {
527 WARN("no interface for %s\n", debugstr_guid(riid
));
528 return E_NOINTERFACE
;
531 while (NULL
!= DSOUND_CF
[i
].rclsid
) {
532 if (IsEqualGUID(rclsid
, DSOUND_CF
[i
].rclsid
)) {
533 DSCF_AddRef((IClassFactory
*) &DSOUND_CF
[i
]);
534 *ppv
= &DSOUND_CF
[i
];
540 WARN("(%s, %s, %p): no class found.\n", debugstr_guid(rclsid
),
541 debugstr_guid(riid
), ppv
);
542 return CLASS_E_CLASSNOTAVAILABLE
;
546 /*******************************************************************************
547 * DllCanUnloadNow [DSOUND.4]
548 * Determines whether the DLL is in use.
554 HRESULT WINAPI
DllCanUnloadNow(void)
556 FIXME("(void): stub\n");
560 #define INIT_GUID(guid, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \
561 guid.Data1 = l; guid.Data2 = w1; guid.Data3 = w2; \
562 guid.Data4[0] = b1; guid.Data4[1] = b2; guid.Data4[2] = b3; \
563 guid.Data4[3] = b4; guid.Data4[4] = b5; guid.Data4[5] = b6; \
564 guid.Data4[6] = b7; guid.Data4[7] = b8;
566 /***********************************************************************
567 * DllMain (DSOUND.init)
569 BOOL WINAPI
DllMain(HINSTANCE hInstDLL
, DWORD fdwReason
, LPVOID lpvReserved
)
572 TRACE("(%p %d %p)\n", hInstDLL
, fdwReason
, lpvReserved
);
575 case DLL_PROCESS_ATTACH
:
576 TRACE("DLL_PROCESS_ATTACH\n");
577 for (i
= 0; i
< MAXWAVEDRIVERS
; i
++) {
578 DSOUND_renderer
[i
] = NULL
;
579 DSOUND_capture
[i
] = NULL
;
580 INIT_GUID(DSOUND_renderer_guids
[i
], 0xbd6dd71a, 0x3deb, 0x11d1, 0xb1, 0x71, 0x00, 0xc0, 0x4f, 0xc2, 0x00, 0x00 + i
);
581 INIT_GUID(DSOUND_capture_guids
[i
], 0xbd6dd71b, 0x3deb, 0x11d1, 0xb1, 0x71, 0x00, 0xc0, 0x4f, 0xc2, 0x00, 0x00 + i
);
583 DisableThreadLibraryCalls(hInstDLL
);
584 /* Increase refcount on dsound by 1 */
585 GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
, (LPCWSTR
)hInstDLL
, &hInstDLL
);
587 case DLL_PROCESS_DETACH
:
588 TRACE("DLL_PROCESS_DETACH\n");
591 TRACE("UNKNOWN REASON\n");