Shaun Ren : sapi: Implement ISpeechVoice::GetVoices.

[Alexandre Julliard]

Module: wine
Branch: master
Commit: 62aec0318b958655a86d25a8baad8b37525fa564
URL:    https://gitlab.winehq.org/wine/wine/-/commit/62aec0318b958655a86d25a8baad8b3...

Author: Shaun Ren 
Date:   Fri Feb 16 15:21:28 2024 -0500

sapi: Implement ISpeechVoice::GetVoices.

---

dlls/sapi/tests/tts.c | 31 +++++++++++++++++++++++++++++--
 dlls/sapi/tts.c       | 21 +++++++++++++++++++--
 2 files changed, 48 insertions(+), 4 deletions(-)

diff --git a/dlls/sapi/tests/tts.c b/dlls/sapi/tests/tts.c
index 87711eac61a..8f88d74b9ef 100644
--- a/dlls/sapi/tests/tts.c
+++ b/dlls/sapi/tests/tts.c
@@ -416,7 +416,7 @@ static IClassFactory test_engine_cf = { &ClassFactoryVtbl };

static void test_spvoice(void)
 {
-    static const WCHAR test_token_id[] = L"HKEY_LOCAL_MACHINE\Software\Wine\Winetest\sapi\tts\TestEngine";
+    static const WCHAR test_token_id[] = L"HKEY_LOCAL_MACHINE\Software\Microsoft\Speech\Voices\Tokens\WinetestVoice";
     static const WCHAR test_text[] = L"Hello! This is a test sentence.";

ISpVoice *voice;
@@ -432,6 +432,9 @@ static void test_spvoice(void)
     DWORD regid;
     DWORD start, duration;
     ISpeechVoice *speech_voice;
+    ISpeechObjectTokens *speech_tokens;
+    LONG count;
+    BSTR req = NULL, opt = NULL;
     HRESULT hr;

if (waveOutGetNumDevs() == 0) {
@@ -439,6 +442,8 @@ static void test_spvoice(void)
         return;
     }

+    RegDeleteTreeA(HKEY_LOCAL_MACHINE, "Software\Microsoft\Speech\Voices\WinetestVoice");
+
     check_apttype();
     ok(test_apt_data.type == APTTYPE_UNITIALIZED, "got apt type %d.\n", test_apt_data.type);

@@ -588,6 +593,7 @@ static void test_spvoice(void)
     hr = ISpObjectToken_CreateKey(token, L"Attributes", &attrs_key);
     ok(hr == S_OK, "got %#lx.\n", hr);
     ISpDataKey_SetStringValue(attrs_key, L"Language", L"409");
+    ISpDataKey_SetStringValue(attrs_key, L"Vendor", L"Winetest");
     ISpDataKey_Release(attrs_key);

hr = ISpVoice_SetVoice(voice, token);
@@ -685,6 +691,25 @@ static void test_spvoice(void)
     hr = ISpVoice_QueryInterface(voice, &IID_ISpeechVoice, (void **)&speech_voice);
     ok(hr == S_OK, "got %#lx.\n", hr);

+    count = -1;
+    hr = ISpeechVoice_GetVoices(speech_voice, NULL, NULL, &speech_tokens);
+    ok(hr == S_OK, "got %#lx.\n", hr);
+    hr = ISpeechObjectTokens_get_Count(speech_tokens, &count);
+    ok(hr == S_OK, "got %#lx.\n", hr);
+    ok(count > 0, "got %ld.\n", count);
+    ISpeechObjectTokens_Release(speech_tokens);
+
+    req = SysAllocString(L"Vendor=Winetest");
+    opt = SysAllocString(L"Language=409;Gender=Male");
+
+    count = 0xdeadbeef;
+    hr = ISpeechVoice_GetVoices(speech_voice, req, opt, &speech_tokens);
+    ok(hr == S_OK, "got %#lx.\n", hr);
+    hr = ISpeechObjectTokens_get_Count(speech_tokens, &count);
+    ok(hr == S_OK, "got %#lx.\n", hr);
+    ok(count == 1, "got %ld.\n", count);
+    ISpeechObjectTokens_Release(speech_tokens);
+
     hr = ISpeechVoice_Speak(speech_voice, NULL, SVSFPurgeBeforeSpeak, NULL);
     ok(hr == S_OK, "got %#lx.\n", hr);

@@ -695,8 +720,10 @@ done:
     ISpVoice_Release(voice);
     ISpObjectToken_Release(token);
     ISpMMSysAudio_Release(audio_out);
+    SysFreeString(req);
+    SysFreeString(opt);

-    RegDeleteTreeA( HKEY_LOCAL_MACHINE, "Software\Wine\Winetest\sapi" );
+    RegDeleteTreeA(HKEY_LOCAL_MACHINE, "Software\Microsoft\Speech\Voices\WinetestVoice");
 }

START_TEST(tts)
diff --git a/dlls/sapi/tts.c b/dlls/sapi/tts.c
index 381558659b8..6fe01373e56 100644
--- a/dlls/sapi/tts.c
+++ b/dlls/sapi/tts.c
@@ -401,9 +401,26 @@ static HRESULT WINAPI speech_voice_Skip(ISpeechVoice *iface, const BSTR type, LO
 static HRESULT WINAPI speech_voice_GetVoices(ISpeechVoice *iface, BSTR required, BSTR optional,
                                              ISpeechObjectTokens **tokens)
 {
-    FIXME("(%p, %s, %s, %p): stub.\n", iface, debugstr_w(required), debugstr_w(optional), tokens);

-    return E_NOTIMPL;
+    ISpObjectTokenCategory *cat;
+    IEnumSpObjectTokens *token_enum;
+    HRESULT hr;
+
+    TRACE("(%p, %s, %s, %p).\n", iface, debugstr_w(required), debugstr_w(optional), tokens);
+
+    if (!tokens) return E_POINTER;
+
+    if (FAILED(hr = create_token_category(SPCAT_VOICES, &cat)))
+        return hr;
+
+    if (SUCCEEDED(hr = ISpObjectTokenCategory_EnumTokens(cat, required, optional, &token_enum)))
+    {
+        hr = IEnumSpObjectTokens_QueryInterface(token_enum, &IID_ISpeechObjectTokens, (void **)tokens);
+        IEnumSpObjectTokens_Release(token_enum);
+    }
+
+    ISpObjectTokenCategory_Release(cat);
+    return hr;
 }

static HRESULT WINAPI speech_voice_GetAudioOutputs(ISpeechVoice *iface, BSTR required, BSTR optional,