[PATCH v3 0/3] MR8544: sapi/xml: Parse the prosody SSML element.
Used by Diablo IV's screen reader. -- v3: sapi/xml: Parse the pitch attribute in the <prosody> SSML element. sapi/xml: Parse the volume attribute in the <prosody> SSML element. sapi/xml: Parse the rate attribute in the SSML <prosody> element. https://gitlab.winehq.org/wine/wine/-/merge_requests/8544
From: Shaun Ren <sren(a)codeweavers.com> --- dlls/sapi/tests/tts.c | 26 +++++------ dlls/sapi/xml.c | 100 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+), 14 deletions(-) diff --git a/dlls/sapi/tests/tts.c b/dlls/sapi/tests/tts.c index 569ee918164..86b484b268e 100644 --- a/dlls/sapi/tests/tts.c +++ b/dlls/sapi/tests/tts.c @@ -1052,24 +1052,22 @@ static void test_spvoice_ssml(void) reset_engine_params(&test_engine); hr = ISpVoice_Speak(voice, text4, SPF_DEFAULT, NULL); - todo_wine ok(hr == S_OK, "got %#lx.\n", hr); - todo_wine ok(test_engine.frag_count == 2, "got %Iu.\n", test_engine.frag_count); + ok(hr == S_OK, "got %#lx.\n", hr); + ok(test_engine.frag_count == 2, "got %Iu.\n", test_engine.frag_count); - if (test_engine.frag_count == 2) { - check_frag_text(0, L"One, "); - check_frag_state_field(0, eAction, SPVA_Speak, "%d"); - check_frag_state_field(0, RateAdj, 0, "%ld"); + check_frag_text(0, L"One, "); + check_frag_state_field(0, eAction, SPVA_Speak, "%d"); + check_frag_state_field(0, RateAdj, 0, "%ld"); - check_frag_text(1, L"two."); - check_frag_state_field(1, eAction, SPVA_Speak, "%d"); - check_frag_state_field(1, RateAdj, -17, "%ld"); /* 3^(-17/10) ~= 0.15 */ - } + check_frag_text(1, L"two."); + check_frag_state_field(1, eAction, SPVA_Speak, "%d"); + check_frag_state_field(1, RateAdj, -17, "%ld"); /* 3^(-17/10) ~= 0.15 */ reset_engine_params(&test_engine); hr = ISpVoice_Speak(voice, text5, SPF_IS_XML | SPF_PARSE_SSML, NULL); - todo_wine ok(hr == S_OK, "got %#lx.\n", hr); - todo_wine ok(test_engine.frag_count == 8 || broken(test_engine.frag_count == 3) /* win7 */, + ok(hr == S_OK, "got %#lx.\n", hr); + ok(test_engine.frag_count == 8 || broken(test_engine.frag_count == 3) /* win7 */, "got %Iu.\n", test_engine.frag_count); if (test_engine.frag_count == 8) { @@ -1086,7 +1084,7 @@ static void test_spvoice_ssml(void) reset_engine_params(&test_engine); hr = ISpVoice_Speak(voice, text6, SPF_IS_XML | SPF_PARSE_SSML, NULL); - todo_wine ok(hr == S_OK || broken(hr == SPERR_UNSUPPORTED_FORMAT) /* win7 */, "got %#lx.\n", hr); + ok(hr == S_OK || broken(hr == SPERR_UNSUPPORTED_FORMAT) /* win7 */, "got %#lx.\n", hr); if (hr == S_OK) { ok(test_engine.frag_count == 5, "got %Iu.\n", test_engine.frag_count); @@ -1101,7 +1099,7 @@ static void test_spvoice_ssml(void) reset_engine_params(&test_engine); hr = ISpVoice_Speak(voice, text7, SPF_IS_XML | SPF_PARSE_SSML, NULL); - todo_wine ok(hr == S_OK || broken(hr == SPERR_UNSUPPORTED_FORMAT) /* win7 */, "got %#lx.\n", hr); + ok(hr == S_OK || broken(hr == SPERR_UNSUPPORTED_FORMAT) /* win7 */, "got %#lx.\n", hr); if (hr == S_OK) { ok(test_engine.frag_count == 5, "got %Iu.\n", test_engine.frag_count); diff --git a/dlls/sapi/xml.c b/dlls/sapi/xml.c index aad32462272..d6faa45277a 100644 --- a/dlls/sapi/xml.c +++ b/dlls/sapi/xml.c @@ -25,6 +25,7 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA */ +#include <math.h> #include <assert.h> #define COBJMACROS @@ -457,6 +458,101 @@ static HRESULT add_sapi_text_fragment(struct xml_parser *parser, const SPVSTATE return S_OK; } +struct string_value +{ + const WCHAR *str; + LONG value; +}; + +static BOOL lookup_string_value(const struct string_value *table, size_t count, const xmlstr_t *str, LONG *res) +{ + size_t i; + + for (i = 0; i < count; i++) + { + if (xmlstr_eq(str, table[i].str)) + { + *res = table[i].value; + return TRUE; + } + } + return FALSE; +} + +static HRESULT parse_double_value(const xmlstr_t *value, double *res, size_t *read_len) +{ + WCHAR *buf, *end; + + if (!value->len) + return SPERR_UNSUPPORTED_FORMAT; + + if (!(buf = xmlstrdupW(value))) + return E_OUTOFMEMORY; + + *res = wcstod(buf, &end); + *read_len = end - buf; + + free(buf); + return S_OK; +} + +static HRESULT parse_ssml_elems(struct xml_parser *parser, const SPVSTATE *state, const struct xml_elem *parent); + +static HRESULT parse_ssml_prosody_elem(struct xml_parser *parser, SPVSTATE state, const struct xml_elem *parent) +{ + static const struct string_value rate_values[] = + { + { L"x-slow", -9 }, + { L"slow", -4 }, + { L"medium", 0 }, + { L"fast", 4 }, + { L"x-fast", 9 }, + }; + + struct xml_attr attr; + BOOL end = FALSE; + size_t read_len; + HRESULT hr; + + while (next_xml_attr(parser, &attr, &end)) + { + if (xml_attr_eq(&attr, L"rate")) + { + double rate; + + if (lookup_string_value(rate_values, ARRAY_SIZE(rate_values), &attr.value, &state.RateAdj)) + continue; + + if (FAILED(hr = parse_double_value(&attr.value, &rate, &read_len))) + return hr; + if (read_len < attr.value.len - 1 || + (read_len == attr.value.len - 1 && attr.value.ptr[read_len] != '%')) + { + ERR("Invalid value %s for the rate attribute in <prosody>.\n", debugstr_xmlstr(&attr.value)); + return SPERR_UNSUPPORTED_FORMAT; + } + + if (attr.value.ptr[attr.value.len - 1] == '%') + rate = 1 + rate / 100; + + if (rate < 0) + state.RateAdj = 0; + else if (rate <= 0.01) + state.RateAdj = -10; + else + state.RateAdj = lround(log(rate) * (10 / log(3))); + } + else + { + FIXME("Unknown <prosody> attribute %s.\n", debugstr_xmlstr(&attr.name)); + return E_NOTIMPL; + } + } + + if (end) return S_OK; + return parse_ssml_elems(parser, &state, parent); +} + static HRESULT parse_ssml_elems(struct xml_parser *parser, const SPVSTATE *state, const struct xml_elem *parent) { struct xml_attr attr; @@ -476,6 +572,10 @@ static HRESULT parse_ssml_elems(struct xml_parser *parser, const SPVSTATE *state if (end) continue; hr = parse_ssml_elems(parser, state, &elem); } + else if (xml_elem_eq(&elem, ssml_ns, L"prosody")) + { + hr = parse_ssml_prosody_elem(parser, *state, &elem); + } else { FIXME("Unknown element %s.\n", debugstr_xmlstr(&elem.name)); -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/8544
From: Shaun Ren <sren(a)codeweavers.com> --- dlls/sapi/tests/tts.c | 4 ++-- dlls/sapi/xml.c | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 2 deletions(-) diff --git a/dlls/sapi/tests/tts.c b/dlls/sapi/tests/tts.c index 86b484b268e..4f75aa88cac 100644 --- a/dlls/sapi/tests/tts.c +++ b/dlls/sapi/tests/tts.c @@ -1123,7 +1123,7 @@ static void test_spvoice_ssml(void) reset_engine_params(&test_engine); hr = ISpVoice_Speak(voice, text8, SPF_IS_XML | SPF_PARSE_SSML, NULL); - todo_wine ok(hr == S_OK, "got %#lx.\n", hr); + ok(hr == S_OK, "got %#lx.\n", hr); if (hr == S_OK) { ok(test_engine.frag_count == 9, "got %Iu.\n", test_engine.frag_count); @@ -1147,7 +1147,7 @@ static void test_spvoice_ssml(void) reset_engine_params(&test_engine); hr = ISpVoice_Speak(voice, text9, SPF_IS_XML | SPF_PARSE_SSML, NULL); - todo_wine ok(hr == S_OK || broken(hr == SPERR_UNSUPPORTED_FORMAT) /* win7 */, "got %#lx.\n", hr); + ok(hr == S_OK || broken(hr == SPERR_UNSUPPORTED_FORMAT) /* win7 */, "got %#lx.\n", hr); if (hr == S_OK) { ok(test_engine.frag_count == 7, "got %Iu.\n", test_engine.frag_count); diff --git a/dlls/sapi/xml.c b/dlls/sapi/xml.c index d6faa45277a..d54df1ef88f 100644 --- a/dlls/sapi/xml.c +++ b/dlls/sapi/xml.c @@ -496,6 +496,13 @@ static HRESULT parse_double_value(const xmlstr_t *value, double *res, size_t *re return S_OK; } +static inline long lclamp(long value, long value_min, long value_max) +{ + if (value < value_min) return value_min; + if (value > value_max) return value_max; + return value; +} + static HRESULT parse_ssml_elems(struct xml_parser *parser, const SPVSTATE *state, const struct xml_elem *parent); static HRESULT parse_ssml_prosody_elem(struct xml_parser *parser, SPVSTATE state, const struct xml_elem *parent) @@ -509,6 +516,16 @@ static HRESULT parse_ssml_prosody_elem(struct xml_parser *parser, SPVSTATE state { L"x-fast", 9 }, }; + static const struct string_value volume_values[] = + { + { L"silent", 0 }, + { L"x-soft", 20 }, + { L"soft", 40 }, + { L"medium", 60 }, + { L"loud", 80 }, + { L"x-loud", 100 }, + }; + struct xml_attr attr; BOOL end = FALSE; size_t read_len; @@ -542,6 +559,29 @@ static HRESULT parse_ssml_prosody_elem(struct xml_parser *parser, SPVSTATE state else state.RateAdj = lround(log(rate) * (10 / log(3))); } + else if (xml_attr_eq(&attr, L"volume")) + { + double volume; + + if (lookup_string_value(volume_values, ARRAY_SIZE(volume_values), &attr.value, (LONG *)&state.Volume)) + continue; + + if (FAILED(hr = parse_double_value(&attr.value, &volume, &read_len))) + return hr; + if (read_len < attr.value.len - 1 || + (read_len == attr.value.len - 1 && attr.value.ptr[read_len] != '%')) + { + ERR("Invalid value %s for the volume attribute in <prosody>.\n", debugstr_xmlstr(&attr.value)); + return SPERR_UNSUPPORTED_FORMAT; + } + + if (attr.value.ptr[attr.value.len - 1] == '%') + volume = state.Volume * (1 + volume / 100); + else if (attr.value.ptr[0] == '+' || attr.value.ptr[0] == '-') + volume = state.Volume + volume; + + state.Volume = lclamp(lround(volume), 0, 100); + } else { FIXME("Unknown <prosody> attribute %s.\n", debugstr_xmlstr(&attr.name)); -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/8544
From: Shaun Ren <sren(a)codeweavers.com> --- dlls/sapi/tests/tts.c | 53 +++++++++++++++++++++++++++++++++++++++++++ dlls/sapi/xml.c | 36 +++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+) diff --git a/dlls/sapi/tests/tts.c b/dlls/sapi/tests/tts.c index 4f75aa88cac..43f8f93de1f 100644 --- a/dlls/sapi/tests/tts.c +++ b/dlls/sapi/tests/tts.c @@ -922,6 +922,28 @@ static void test_spvoice_ssml(void) L"<prosody volume='loud'><prosody volume='soft'>soft.</prosody></prosody>" L"</speak>"; + static const WCHAR text10[] = + L"<speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='en-us'>" + L"<prosody pitch='300Hz'>300Hz.</prosody>" + L"<prosody pitch='600Hz'>600Hz.</prosody>" + L"<prosody pitch='+300Hz'>+300Hz.</prosody>" + L"<prosody pitch='-300Hz'>-300Hz.</prosody>" + L"<prosody pitch='41.4%'>41.4%.</prosody>" + L"<prosody pitch='+41.4%'>+41.4%.</prosody>" + L"<prosody pitch='-50%'>-50%.</prosody>" + L"<prosody pitch='-98.99999%'>-98.99999%.</prosody>" + L"<prosody pitch='-99%'>-99%.</prosody>" + L"<prosody pitch='-101%'>-101%.</prosody>" + L"<prosody pitch='41.4%'><prosody pitch='+41.4%'>+100%.</prosody></prosody>" + L"<prosody pitch='41.4%'><prosody pitch='-50%'>-29%.</prosody></prosody>" + L"<prosody pitch='x-low'>x-low.</prosody>" + L"<prosody pitch='low'>low.</prosody>" + L"<prosody pitch='medium'>medium.</prosody>" + L"<prosody pitch='high'>high.</prosody>" + L"<prosody pitch='x-high'>x-high.</prosody>" + L"<prosody pitch='high'><prosody pitch='low'>high-low.</prosody></prosody>" + L"</speak>"; + ISpVoice *voice; ISpObjectToken *token; @@ -1162,6 +1184,37 @@ static void test_spvoice_ssml(void) check_frag_state_field(6, Volume, 40, "%lu"); /* soft */ } + reset_engine_params(&test_engine); + + hr = ISpVoice_Speak(voice, text10, SPF_IS_XML | SPF_PARSE_SSML, NULL); + ok(hr == S_OK || broken(hr == SPERR_UNSUPPORTED_FORMAT) /* win7 */, "got %#lx.\n", hr); + + if (hr == S_OK) { + ok(test_engine.frag_count == 18, "got %Iu.\n", test_engine.frag_count); + + check_frag_state_field(0, PitchAdj.MiddleAdj, 0, "%ld"); /* Absolute Hz values are ignored. */ + check_frag_state_field(1, PitchAdj.MiddleAdj, 0, "%ld"); + check_frag_state_field(2, PitchAdj.MiddleAdj, 0, "%ld"); + check_frag_state_field(3, PitchAdj.MiddleAdj, 0, "%ld"); + check_frag_state_field(4, PitchAdj.MiddleAdj, 12, "%ld"); /* 2^(12/24) ~= 1.414. */ + check_frag_state_field(5, PitchAdj.MiddleAdj, 12, "%ld"); /* 2^(12/24) ~= 1.414. */ + check_frag_state_field(6, PitchAdj.MiddleAdj, -24, "%ld"); /* 2^(-24/24) = 0.5. */ + check_frag_state_field(7, PitchAdj.MiddleAdj, -159, "%ld"); /* 2^(-159/24) ~= 0.0100001. */ + check_frag_state_field(8, PitchAdj.MiddleAdj, -10, "%ld"); /* -99%. */ + check_frag_state_field(9, PitchAdj.MiddleAdj, -10, "%ld"); /* -101%. */ + check_frag_state_field(10, PitchAdj.MiddleAdj, 24, "%ld"); /* 2^(24/24) = 1. */ + check_frag_state_field(11, PitchAdj.MiddleAdj, -12, "%ld"); /* 2^(-12/24) ~= 0.707. */ + + check_frag_state_field(12, PitchAdj.MiddleAdj, -9, "%ld"); /* x-low */ + check_frag_state_field(13, PitchAdj.MiddleAdj, -4, "%ld"); /* low */ + check_frag_state_field(14, PitchAdj.MiddleAdj, 0, "%ld"); /* medium */ + check_frag_state_field(15, PitchAdj.MiddleAdj, 4, "%ld"); /* high */ + check_frag_state_field(16, PitchAdj.MiddleAdj, 9, "%ld"); /* x-high */ + + check_frag_state_field(17, PitchAdj.MiddleAdj, -4, "%ld"); /* low */ + } + + reset_engine_params(&test_engine); ISpVoice_Release(voice); ISpObjectToken_Release(token); diff --git a/dlls/sapi/xml.c b/dlls/sapi/xml.c index d54df1ef88f..e6fb9a17c70 100644 --- a/dlls/sapi/xml.c +++ b/dlls/sapi/xml.c @@ -526,6 +526,15 @@ static HRESULT parse_ssml_prosody_elem(struct xml_parser *parser, SPVSTATE state { L"x-loud", 100 }, }; + static const struct string_value pitch_values[] = + { + { L"x-low", -9 }, + { L"low", -4 }, + { L"medium", 0 }, + { L"high", 4 }, + { L"x-high", 9 }, + }; + struct xml_attr attr; BOOL end = FALSE; size_t read_len; @@ -582,6 +591,33 @@ static HRESULT parse_ssml_prosody_elem(struct xml_parser *parser, SPVSTATE state state.Volume = lclamp(lround(volume), 0, 100); } + else if (xml_attr_eq(&attr, L"pitch")) + { + double pitch; + + if (lookup_string_value(pitch_values, ARRAY_SIZE(pitch_values), &attr.value, &state.PitchAdj.MiddleAdj)) + continue; + + if (FAILED(hr = parse_double_value(&attr.value, &pitch, &read_len))) + return hr; + + if (attr.value.len > 2 && read_len == attr.value.len - 2 && + attr.value.ptr[read_len] == 'H' && attr.value.ptr[read_len + 1] == 'z') + { + WARN("Ignoring Hz pitch value %s in <prosody>.\n", debugstr_xmlstr(&attr.value)); + continue; + } + else if (read_len != attr.value.len - 1 || attr.value.ptr[read_len] != '%') + { + ERR("Invalid value %s for the pitch attribute in <prosody>.\n", debugstr_xmlstr(&attr.value)); + return SPERR_UNSUPPORTED_FORMAT; + } + + if (pitch > -99) + state.PitchAdj.MiddleAdj += lround(log2(1 + pitch / 100) * 24); + else + state.PitchAdj.MiddleAdj -= 10; + } else { FIXME("Unknown <prosody> attribute %s.\n", debugstr_xmlstr(&attr.name)); -- GitLab https://gitlab.winehq.org/wine/wine/-/merge_requests/8544
This merge request was approved by Huw Davies. -- https://gitlab.winehq.org/wine/wine/-/merge_requests/8544
participants (3)
-
Huw Davies (＠huw) -
Shaun Ren
-
Shaun Ren (＠shaunren)