Fix SAPI4 prosody regressions by LeonarddeR · Pull Request #15502 · nvaccess/nvda

LeonarddeR · 2023-09-23T09:59:05Z

CC @cary-rowen

Link to issue number:

Fixes #15500
Follow up of #15271

Summary of the issue:

Some SAPI4 synthesizers reset all their prosody values to their defaults when they come across prosody in a sequence.

Description of user facing changes

Capital pitch changes no longer cause some SAPI4 voices to reset their rate and volume.

Description of development approach

When a sequence contains any prosody command, for the other prosody commands supported by the synth, we add commands to set them to the currently configured value.

Testing strategy:

Tested str from #15500.
Tested a sequence with a prosody command in the middle of a sequence, ensure that the prosody change is reflected in the speech.

Known issues with pull request:

None known

Code Review Checklist:

Documentation:
- Change log entry
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
API is compatible with existing add-ons.
Security precautions taken.

AppVeyorBot · 2023-09-23T10:58:11Z

PASS: Translation comments check.
PASS: Unit tests.
FAIL: Lint check. See test results for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/2g28avq5oo54rkco/artifacts/output/nvda_snapshot_pr15502-29332,ee2ef6db.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 24.4,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 22.4,
FINISH_END 0.2

See test results for failed build of commit ee2ef6db67

cary-rowen · 2023-09-23T11:34:00Z

Thanks @LeonarddeR I confirm this PR has been fixed #15500.

LeonarddeR · 2023-09-23T14:45:32Z

I fixed one additional issue, a generator's bool value is always True.

AppVeyorBot · 2023-09-23T15:57:47Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/upawodon9jnoayem/artifacts/output/nvda_snapshot_pr15502-29334,b57305dd.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 22.2,
TESTSETUP_START 0.0,
TESTSETUP_END 0.2,
TEST_START 0.0,
TEST_END 13.5,
FINISH_END 0.1

See test results for failed build of commit b57305ddca

cary-rowen · 2023-09-23T16:13:40Z

Hi @LeonarddeR
There is an additional problem that I don't know if it can be easily fixed. If you need me to create another Issue please let me know.
But this is not a regression bug.

Steps to reproduce

Switch to Sapi4 speech synthesizer(IBMTTS).
Press Windows+B to navigate to the System tray.
Keep pressing the up arrow for 5 seconds or more to quickly cycle focus between items in the tray.
NVDA throws an error, the log is as follows:

Input: kb(laptop):upArrow
ERROR - queueHandler.flushQueue (00:02:59.245) - MainThread (11828):
Error in func cancelSpeech
Traceback (most recent call last):
  File "queueHandler.pyc", line 64, in flushQueue
  File "speech\speech.pyc", line 158, in cancelSpeech
  File "speech\manager.pyc", line 753, in cancel
  File "synthDrivers\sapi4.pyc", line 200, in cancel
  File "monkeyPatches\comtypesMonkeyPatches.pyc", line 32, in __call__
_ctypes.COMError: (-2147418107, '在消息筛选器里时，不可对外调用。', (None, None, None, 0, None))

LeonarddeR · 2023-09-23T17:06:59Z

I've seen more errors like this. I guess we should just log these errors.

seanbudd

thanks @LeonarddeR, changes generally look good

seanbudd · 2023-09-24T23:22:40Z

+		try:
+			self._ttsCentral.AudioReset()
+		except COMError:
+			log.error("Error cancelling speech", exc_info=True)


is there a reason why this logs at a different level to the pause changes

Errors for pause just passed, I didn't want to introduce logging at the error level for this, though it made sense to me to at least something. Cancel, on the other hand, didn't catch any errors, so it made sense to log them at the error level.

seanbudd

Thanks @LeonarddeR

…ce (#15583) Fixes #15580 Follow up of #15502 Summary of the issue: In #15502, I fixed some regressions regarding capital pitch changes introduced in #15271. This meant that we'd add prosody commands to every speech sequence to support a specific version of IBM TTS that seemed to need that. However, it introduced a regression in that it was no longer possible to change speech parameters using the gui. Description of user facing changes It is again possible to change SAPI4 parameters using the GUI. Description of development approach Only add blank prosody commands when there is any prosody in the sequence. IF not, don't do anything.

LeonarddeR requested a review from a team as a code owner September 23, 2023 09:59

LeonarddeR requested a review from seanbudd September 23, 2023 09:59

Fix SAPI4 prosody regressions

a5f81e3

LeonarddeR force-pushed the sapi4prosody branch from 8f70ef1 to a5f81e3 Compare September 23, 2023 16:12

Improve error handling for pause and cancel

a682aa1

LeonarddeR force-pushed the sapi4prosody branch from 4aee33d to a682aa1 Compare September 23, 2023 17:11

seanbudd reviewed Sep 24, 2023

View reviewed changes

seanbudd approved these changes Sep 25, 2023

View reviewed changes

seanbudd merged commit 87d5b5a into nvaccess:master Sep 25, 2023

nvaccessAuto added this to the 2024.1 milestone Sep 25, 2023

LeonarddeR mentioned this pull request Oct 4, 2023

Sapi4: Only send prosody commands when there is prosody in the sequence #15583

Merged

5 tasks

gexgd0419 mentioned this pull request Apr 25, 2025

Some problems with Sapi4 infovox #17964

Closed

LeonarddeR deleted the sapi4prosody branch August 23, 2025 06:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix SAPI4 prosody regressions#15502

Fix SAPI4 prosody regressions#15502
seanbudd merged 2 commits into
nvaccess:masterfrom
LeonarddeR:sapi4prosody

LeonarddeR commented Sep 23, 2023

Uh oh!

AppVeyorBot commented Sep 23, 2023

Uh oh!

cary-rowen commented Sep 23, 2023

Uh oh!

LeonarddeR commented Sep 23, 2023

Uh oh!

AppVeyorBot commented Sep 23, 2023

Uh oh!

cary-rowen commented Sep 23, 2023

Uh oh!

LeonarddeR commented Sep 23, 2023

Uh oh!

seanbudd left a comment

Uh oh!

seanbudd Sep 24, 2023

Uh oh!

LeonarddeR Sep 25, 2023

Uh oh!

seanbudd left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

LeonarddeR commented Sep 23, 2023

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Uh oh!

AppVeyorBot commented Sep 23, 2023

Uh oh!

cary-rowen commented Sep 23, 2023

Uh oh!

LeonarddeR commented Sep 23, 2023

Uh oh!

AppVeyorBot commented Sep 23, 2023

Uh oh!

cary-rowen commented Sep 23, 2023

Steps to reproduce

Uh oh!

LeonarddeR commented Sep 23, 2023

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

seanbudd Sep 24, 2023

Choose a reason for hiding this comment

Uh oh!

LeonarddeR Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants