Espeak - event loop and recurrent say calls fix #363

willwade · 2024-11-04T00:23:34Z

So this fixes

External Event Loop in espeak
Calling say multiple times and then runAndWait

it now has its own internal queue - which seems crazy since driver has a queue but it just was not easy making use of it

I feel this should be ok since sapi and mac dont really make use of the driver queue..

In time this whole library needs better reactoring around queues. Its really horrible to get your head around.

@cclauss - can you run this through your tests - it is an attempt to fix the external event loop

Its got a lot of debug lines in it ..

If it basically works i'll remove these.

willwade · 2024-11-04T00:32:51Z

NB I used test code of this @cclauss I'm not sure now how accurate this is to our pytest code..

import pyttsx3
from pyinstrument import Profiler
import time

# Initialize the pyttsx3 engine
engine = pyttsx3.init("espeak")


# Set up event listeners for debugging
def on_start(name):
    print(f"[DEBUG] Started utterance: {name}")
    print(f"Started utterance: {name}")


def on_word(name, location, length):
    print(f"Word: {name} at {location} with length {length}")
    # Interrupt the utterance if location is above a threshold to simulate test_interrupting_utterance
    if location > 10:
        print("Interrupting utterance by calling endLoop...")
        engine.stop()  # Directly call endLoop instead of stop


def on_end(name, completed):
    print(f"Finished utterance: {name}, completed: {completed}")


# Connect the listeners
# engine.connect("started-utterance", on_start)
# engine.connect("started-word", on_word)
# engine.connect("finished-utterance", on_end)


# Demo for test_interrupting_utterance
def demo_interrupting_utterance():
    print("\nRunning demo_interrupting_utterance...")
    engine.say("The quick brown fox jumped over the lazy dog.")
    engine.runAndWait()


# Demo for test_external_event_loop
def demo_external_event_loop():
    print("\nRunning demo_external_event_loop...")

    def external_loop():
        # Simulate external loop iterations
        for _ in range(5):
            engine.iterate()  # Process engine events
            time.sleep(0.5)  # Adjust timing as needed

    engine.say("The quick brown fox jumped over the lazy dog.")
    engine.startLoop(False)  # Start loop without blocking
    external_loop()
    print("Calling endLoop from external demo...")
    engine.endLoop()  # End the event loop explicitly


# Demo for testing multiple `say` calls followed by `runAndWait`
def demo_multiple_say_calls():
    print("\nRunning demo_multiple_say_calls...")
    engine.say("The first sentence.")
    engine.runAndWait()  # Should speak "The first sentence."

    print("Calling say after the first runAndWait()...")
    engine.say("The second sentence follows immediately.")
    engine.runAndWait()  # Should speak "The second sentence follows immediately."

    print("Calling say after the second runAndWait()...")
    engine.say("Finally, the third sentence is spoken.")
    engine.runAndWait()  # Should speak "Finally, the third sentence is spoken."


# Run demos
demo_interrupting_utterance()

# Initialize the profiler
profiler = Profiler()

# Start profiling for the external event loop demo
profiler.start()

# Run the external event loop demo
demo_external_event_loop()

# Stop profiling
profiler.stop()
# Print the profiling report
profiler.print()

# Run the multiple `say` calls demo
demo_multiple_say_calls()

…onficts

… as was

pyttsx3/drivers/_espeak.py

pyttsx3/drivers/espeak.py

Co-authored-by: Christian Clauss <cclauss@me.com>

cclauss · 2024-11-13T14:53:58Z

.github/workflows/python_publish.yml

@@ -30,7 +30,7 @@ jobs:
    runs-on: ${{ matrix.os }}
    steps:
      - if: runner.os == 'Linux'
-        run: sudo apt-get update -q -q && sudo apt-get install --yes espeak-ng libespeak1
+        run: sudo apt-get update -q -q && sudo apt-get install --yes espeak-ng libespeak1 alsa-utils


Suggested change

run: sudo apt-get update -q -q && sudo apt-get install --yes espeak-ng libespeak1 alsa-utils

run: sudo apt-get update -q -q && sudo apt-get install --yes alsa-utils espeak-ng libespeak1

cclauss · 2024-11-13T14:55:10Z

modprobe: FATAL: Module snd-dummy not found in directory /lib/modules/6.5.0-1025-azure

???

.github/workflows/python_publish.yml

cclauss · 2024-11-13T15:34:27Z

Maybe skip the tests AFTER tests/test_pyttsx3.py::test_changing_volume PASSED if $CI is defined.

cclauss

Use the logger

pyttsx3/drivers/espeak.py

cclauss · 2024-11-15T16:00:33Z

pyttsx3/drivers/espeak.py

@@ -7,12 +10,12 @@
 from tempfile import NamedTemporaryFile
 import logging

+logger = logging.getLogger(__name__)


Great! Now we need to use logger instead of logger below.

Co-authored-by: Christian Clauss <cclauss@me.com>

cclauss

Please do not merge with failing tests.

willwade · 2024-11-15T16:23:58Z

Please do not merge with failing tests.

No worries! I wont!

attempt at fixing event loop

6a6e2ef

willwade changed the title ~~DRAFT attempt at fixing event loop~~ DRAFT attempt at fixing event loop in espeak Nov 4, 2024

willwade added 10 commits November 4, 2024 05:52

resetting test code as expected

d59af8e

reworking to minimise changes in driver proxy

c5d231c

working on the test code now

414551e

8000

remove test.py from repo

a5c83a5

reverting engine py - no real change and import order in driver for c…

9dcfabb

…onficts

Merge branch 'master' into fix-espeak-eventloop

0ae012a

remove sys

84b9af6

switching print lines to logging

ba57098

reverting to print traceback

65da48f

putting changes to runAndWait in espeak to keep other engines working…

656f638

… as was

willwade changed the title ~~DRAFT attempt at fixing event loop in espeak~~ Espeak - event loop and recurrent say calls fix Nov 4, 2024