[PATCH 0/2] MR5250: dsound: Initialize MTA in IDirectSound::Initialize().
On recent Windows, at least Windows 7, a multithread apartment (MTA) is initialized within IDirectSound::Initialize(). RE:D Cherish! (Trial ver) depends on this behavior. Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=53613 -- https://gitlab.winehq.org/wine/wine/-/merge_requests/5250
From: Akihiro Sagawa <sagawa.aki(a)gmail.com> On recent Windows, at least Windows 7, a multithread apartment (MTA) is initialized within IDirectSound::Initialize(). --- dlls/dsound/tests/dsound.c | 87 +++++++++++++++++++++++++++++++++ dlls/dsound/tests/dsound8.c | 53 ++++++++++++++++++++ dlls/dsound/tests/dsound_test.h | 9 ++++ 3 files changed, 149 insertions(+) diff --git a/dlls/dsound/tests/dsound.c b/dlls/dsound/tests/dsound.c index 500bc19f655..da430bb1411 100644 --- a/dlls/dsound/tests/dsound.c +++ b/dlls/dsound/tests/dsound.c @@ -41,6 +41,40 @@ DEFINE_GUID(GUID_NULL,0,0,0,0,0,0,0,0,0,0,0); +static DWORD WINAPI test_apt_thread(void *param) +{ + HRESULT hr; + struct apt_data *test_apt_data = (struct apt_data *)param; + + hr = CoGetApartmentType(&test_apt_data->type, &test_apt_data->qualifier); + if (hr == CO_E_NOTINITIALIZED) + { + test_apt_data->type = APTTYPE_UNITIALIZED; + test_apt_data->qualifier = 0; + } + + return 0; +} + +void check_apttype(struct apt_data *test_apt_data) +{ + HANDLE thread; + MSG msg; + + memset(test_apt_data, 0xde, sizeof(*test_apt_data)); + + thread = CreateThread(NULL, 0, test_apt_thread, test_apt_data, 0, NULL); + while (MsgWaitForMultipleObjects(1, &thread, FALSE, INFINITE, QS_ALLINPUT) != WAIT_OBJECT_0) + { + while (PeekMessageW(&msg, 0, 0, 0, PM_REMOVE)) + { + TranslateMessage(&msg); + DispatchMessageW(&msg); + } + } + CloseHandle(thread); +} + static void IDirectSound_test(LPDIRECTSOUND dso, BOOL initialized, LPCGUID lpGuid) { @@ -1823,10 +1857,63 @@ static void test_hw_buffers(void) IDirectSound_Release(ds); } +static void test_implicit_mta(void) +{ + HRESULT hr; + IDirectSound *dso; + struct apt_data test_apt_data; + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); + + /* test DirectSound object */ + hr = CoCreateInstance(&CLSID_DirectSound, NULL, CLSCTX_INPROC_SERVER, + &IID_IDirectSound, (void**)&dso); + ok(hr == S_OK, "CoCreateInstance(CLSID_DirectSound) failed: %08lx\n", hr); + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); + + hr = IDirectSound_Initialize(dso, NULL); + ok(hr == DS_OK || hr == DSERR_NODRIVER || hr == DSERR_ALLOCATED || hr == E_FAIL, + "IDirectSound_Initialize() failed: %08lx\n", hr); + if (hr == DS_OK) { + check_apttype(&test_apt_data); + todo_wine + ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); + todo_wine + ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, + "got apt type qualifier %d.\n", test_apt_data.qualifier); + } + IDirectSound_Release(dso); + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); + + /* test DirectSoundCreate */ + hr = DirectSoundCreate(NULL, &dso, NULL); + ok(hr == DS_OK || hr == DSERR_NODRIVER || hr == DSERR_ALLOCATED || hr == E_FAIL, + "DirectSoundCreate() failed: %08lx\n", hr); + if (hr == DS_OK) { + check_apttype(&test_apt_data); + todo_wine + ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); + todo_wine + ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, + "got apt type qualifier %d.\n", test_apt_data.qualifier); + IDirectSound_Release(dso); + } + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); +} + START_TEST(dsound) { CoInitialize(NULL); + /* Run implicit MTA tests before IDirectSound_test so that a MTA won't be created before this test is run. */ + test_implicit_mta(); IDirectSound_tests(); dsound_tests(); test_hw_buffers(); diff --git a/dlls/dsound/tests/dsound8.c b/dlls/dsound/tests/dsound8.c index 8103863e172..2bdeb49fe97 100644 --- a/dlls/dsound/tests/dsound8.c +++ b/dlls/dsound/tests/dsound8.c @@ -1881,6 +1881,57 @@ static void test_AcquireResources(void) IDirectSound_Release(dsound); } +static void test_implicit_mta(void) +{ + HRESULT hr; + IDirectSound8 *dso; + struct apt_data test_apt_data; + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); + + /* test DirectSound8 object */ + hr = CoCreateInstance(&CLSID_DirectSound8, NULL, CLSCTX_INPROC_SERVER, + &IID_IDirectSound8, (void**)&dso); + ok(hr == S_OK, "CoCreateInstance(CLSID_DirectSound8) failed: %08lx\n", hr); + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); + + hr = IDirectSound8_Initialize(dso, NULL); + ok(hr == DS_OK || hr == DSERR_NODRIVER || hr == DSERR_ALLOCATED || hr == E_FAIL, + "IDirectSound8_Initialize() failed: %08lx\n", hr); + if (hr == DS_OK) { + check_apttype(&test_apt_data); + todo_wine + ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); + todo_wine + ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, + "got apt type qualifier %d.\n", test_apt_data.qualifier); + } + IDirectSound8_Release(dso); + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); + + /* test DirectSoundCreate8 */ + hr = DirectSoundCreate8(NULL, &dso, NULL); + ok(hr == DS_OK || hr == DSERR_NODRIVER || hr == DSERR_ALLOCATED || hr == E_FAIL, + "DirectSoundCreate8() failed: %08lx\n", hr); + if (hr == DS_OK) { + check_apttype(&test_apt_data); + todo_wine + ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); + todo_wine + ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, + "got apt type qualifier %d.\n", test_apt_data.qualifier); + IDirectSound8_Release(dso); + } + + check_apttype(&test_apt_data); + ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type); +} + START_TEST(dsound8) { DWORD cookie; @@ -1888,6 +1939,8 @@ START_TEST(dsound8) CoInitialize(NULL); + /* Run implicit MTA tests before test COM so that a MTA won't be created before this test is run. */ + test_implicit_mta(); test_COM(); IDirectSound8_tests(); dsound8_tests(); diff --git a/dlls/dsound/tests/dsound_test.h b/dlls/dsound/tests/dsound_test.h index 04f995e359d..5ca0a8aa753 100644 --- a/dlls/dsound/tests/dsound_test.h +++ b/dlls/dsound/tests/dsound_test.h @@ -20,6 +20,7 @@ #include "wingdi.h" #include "mmreg.h" +#include "combaseapi.h" /* APTTYPE, APTTYPEQUALIFIER */ static const unsigned int formats[][4]={ { 8000, 8, 1, 0 }, @@ -74,6 +75,13 @@ static const unsigned int formats[][4]={ static const unsigned int format_tags[] = {WAVE_FORMAT_PCM, WAVE_FORMAT_IEEE_FLOAT}; +#define APTTYPE_UNITIALIZED APTTYPE_CURRENT +struct apt_data +{ + APTTYPE type; + APTTYPEQUALIFIER qualifier; +}; + /* The time slice determines how often we will service the buffer */ #define TIME_SLICE 31 #define BUFFER_LEN 400 @@ -90,3 +98,4 @@ extern void test_buffer8(LPDIRECTSOUND8,LPDIRECTSOUNDBUFFER*, extern const char * getDSBCAPS(DWORD xmask); extern int align(int length, int align); extern const char * format_string(const WAVEFORMATEX* wfx); +extern void check_apttype(struct apt_data *); -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/5250
From: Akihiro Sagawa <sagawa.aki(a)gmail.com> RE:D Cherish! (Trial ver) depends on this behavior. Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=53613 --- dlls/dsound/dsound.c | 3 +++ dlls/dsound/dsound_private.h | 1 + dlls/dsound/tests/dsound.c | 4 ---- dlls/dsound/tests/dsound8.c | 4 ---- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/dlls/dsound/dsound.c b/dlls/dsound/dsound.c index 57fd6c1a651..7629810db50 100644 --- a/dlls/dsound/dsound.c +++ b/dlls/dsound/dsound.c @@ -207,6 +207,8 @@ static ULONG DirectSoundDevice_Release(DirectSoundDevice * device) WaitForSingleObject(device->thread, INFINITE); CloseHandle(device->thread); } + if (device->mta_cookie) + CoDecrementMTAUsage(device->mta_cookie); EnterCriticalSection(&DSOUND_renderers_lock); list_remove(&device->entry); @@ -332,6 +334,7 @@ static HRESULT DirectSoundDevice_Initialize(DirectSoundDevice ** ppDevice, LPCGU WARN("DSOUND_ReopenDevice failed: %08lx\n", hr); return hr; } + CoIncrementMTAUsage(&device->mta_cookie); ZeroMemory(&device->drvcaps, sizeof(device->drvcaps)); diff --git a/dlls/dsound/dsound_private.h b/dlls/dsound/dsound_private.h index 34498125317..28bba6cd64e 100644 --- a/dlls/dsound/dsound_private.h +++ b/dlls/dsound/dsound_private.h @@ -90,6 +90,7 @@ struct DirectSoundDevice int lfe_channel; float *tmp_buffer, *cp_buffer; DWORD tmp_buffer_len, cp_buffer_len; + CO_MTA_USAGE_COOKIE mta_cookie; DSVOLUMEPAN volpan; diff --git a/dlls/dsound/tests/dsound.c b/dlls/dsound/tests/dsound.c index da430bb1411..7a815e0ce0b 100644 --- a/dlls/dsound/tests/dsound.c +++ b/dlls/dsound/tests/dsound.c @@ -1879,9 +1879,7 @@ static void test_implicit_mta(void) "IDirectSound_Initialize() failed: %08lx\n", hr); if (hr == DS_OK) { check_apttype(&test_apt_data); - todo_wine ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); - todo_wine ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, "got apt type qualifier %d.\n", test_apt_data.qualifier); } @@ -1896,9 +1894,7 @@ static void test_implicit_mta(void) "DirectSoundCreate() failed: %08lx\n", hr); if (hr == DS_OK) { check_apttype(&test_apt_data); - todo_wine ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); - todo_wine ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, "got apt type qualifier %d.\n", test_apt_data.qualifier); IDirectSound_Release(dso); diff --git a/dlls/dsound/tests/dsound8.c b/dlls/dsound/tests/dsound8.c index 2bdeb49fe97..e95800af83e 100644 --- a/dlls/dsound/tests/dsound8.c +++ b/dlls/dsound/tests/dsound8.c @@ -1903,9 +1903,7 @@ static void test_implicit_mta(void) "IDirectSound8_Initialize() failed: %08lx\n", hr); if (hr == DS_OK) { check_apttype(&test_apt_data); - todo_wine ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); - todo_wine ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, "got apt type qualifier %d.\n", test_apt_data.qualifier); } @@ -1920,9 +1918,7 @@ static void test_implicit_mta(void) "DirectSoundCreate8() failed: %08lx\n", hr); if (hr == DS_OK) { check_apttype(&test_apt_data); - todo_wine ok(test_apt_data.type == APTTYPE_MTA, "got apt type %d.\n", test_apt_data.type); - todo_wine ok(test_apt_data.qualifier == APTTYPEQUALIFIER_IMPLICIT_MTA, "got apt type qualifier %d.\n", test_apt_data.qualifier); IDirectSound8_Release(dso); -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/5250
Another possibility is that this initialization is a side effect of dsound creating a window internally. We have this thing implemented in imm32, and as I recall it was possible to test by disabling IMM with some user32 function. -- https://gitlab.winehq.org/wine/wine/-/merge_requests/5250#note_63854
On Sat Mar 9 10:04:47 2024 +0000, Nikolay Sivov wrote:
Another possibility is that this initialization is a side effect of dsound creating a window internally. We have this thing implemented in imm32, and as I recall it was possible to test by disabling IMM with some user32 function. Unfortunately, your assumption doesn't seem to be correct.
I have manually tested using SetWindowsHookEx(WH_CBT and HCBT_CREATEWND) and confirmed that dsound initialization does not create any windows other than the OleMainThreadWndClass window. -- https://gitlab.winehq.org/wine/wine/-/merge_requests/5250#note_64127
On Sat Mar 9 10:16:37 2024 +0000, Akihiro Sagawa wrote:
Unfortunately, your assumption doesn't seem to be correct. I have manually tested on Windows 10 (22H2) using SetWindowsHookEx(WH_CBT and HCBT_CREATEWND) and confirmed that dsound initialization does not create any windows other than the OleMainThreadWndClass window. Reading ImmSetActiveContext() in dlls/imm32/imm.c, it initializes COM with the COINIT_APARTMENTTHREADED parameter, not COINIT_MULTITHREADED.
My test shows that IDirectSound::Initialize() creates a multithread apartment. Could you share your thoughts on this point? -- https://gitlab.winehq.org/wine/wine/-/merge_requests/5250#note_64582
participants (3)
-
Akihiro Sagawa -
Akihiro Sagawa (＠sgwaki)
-
Nikolay Sivov (＠nsivov)