Merge pull request #4 from nateshmbhat/master

update to master in upstream

.github/workflows/python_publish.yml

@@ -1,4 +1,4 @@
-# This workflows will upload a Python Package using Twine when a release is created.
+# This workflow will upload a Python Package using Twine when a release is created.
 # https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
 name: CI
 
@@ -24,17 +24,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [macos-latest, ubuntu-latest, windows-latest]
         python-version: ['3.9', '3.11', '3.13']
       max-parallel: 9
     runs-on: ${{ matrix.os }}
-    timeout-minutes: 10  # Save resources while our pytests are hanging
     steps:
       - if: runner.os == 'Linux'
+        run: sudo apt-get update -q -q && sudo apt-get install --yes espeak-ng libespeak1
+      - if: runner.os == 'macOS'
+        run: brew install espeak-ng
+      - name: Download and install eSpeak-NG
+        if: runner.os == 'Windows'
+        shell: pwsh
         run: |
-          sudo apt-get update -q -q
-          sudo apt-get install --yes espeak-ng libespeak1
+          Invoke-WebRequest -Uri "https://github.com/espeak-ng/espeak-ng/releases/download/1.51/espeak-ng-X64.msi" -OutFile "espeak-ng.msi"
+          Start-Process msiexec.exe -ArgumentList '/i espeak-ng.msi /quiet /norestart' -Wait
+          # dir "$env:ProgramFiles\eSpeak NG"
+          $env:Path += ";$env:ProgramFiles\eSpeak NG"
           espeak-ng --version
+      - if: runner.os != 'Windows'
+        run: espeak-ng --version
+
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
@@ -43,10 +53,11 @@ jobs:
       - name: Install dependencies
         run: |
           pip install --upgrade pip
-          pip install pytest pytest-timeout
+          pip install pytest
           pip install --editable .
 
-      - run: pytest -s -vvv --timeout=600
+      - timeout-minutes: 10  # Save resources while our pytests are hanging
+        run: pytest -s -vvv --strict
 
   build:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -49,7 +49,9 @@ repos:
           - tomli
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.2
+    rev: v0.7.3
     hooks:  # Format before linting
-      - id: ruff-format
       - id: ruff
+      - id: ruff-format
+        args: [ --diff ]
+      - id: ruff-format

MANIFEST

@@ -1,13 +1,13 @@
 # file GENERATED by distutils, do NOT edit
-setup.cfg
-setup.py
+pyproject.toml
 pyttsx3\__init__.py
 pyttsx3\driver.py
-pyttsx3\engine.py
-pyttsx3\voice.py
 pyttsx3\drivers\__init__.py
 pyttsx3\drivers\_espeak.py
+pyttsx3\drivers\avspeech.py
 pyttsx3\drivers\dummy.py
 pyttsx3\drivers\espeak.py
 pyttsx3\drivers\nsss.py
 pyttsx3\drivers\sapi5.py
+pyttsx3\engine.py
+pyttsx3\voice.py

README.md

@@ -93,13 +93,24 @@ engine.runAndWait()
 
 ### **Full documentation of the Library**
 
-https://pyttsx3.readthedocs.io/en/latest/
-
-#### Included TTS engines:
-
-* espeak
-* nsss
-* sapi5
+https://pyttsx3.readthedocs.io
+
+#### Included Text-To-Speech Engines by Operating System
+|                         | Linux | macOS | Windows |
+|-------------------------|:-----:|:-----:|:-------:|
+| [AVSpeech][]            |       |   ✅︎  |         |
+| [eSpeak][]              |   ✅︎  |   ✅︎  |    ✅︎   |
+| [NSSpeechSynthesizer][] |       |   ✅︎  |         |
+| [SAPI5][]               |       |       |    ✅︎   |
+
+> [!NOTE]
+> * AVSpeechSynthesizer support is still experimental.
+> * NSSpeechSynthesizer is deprecated by Apple.
+
+[AVSpeech]: https://developer.apple.com/documentation/avfoundation/speech_synthesis
+[eSpeak]: https://github.com/espeak-ng/espeak-ng?tab=readme-ov-file#readme
+[NSSpeechSynthesizer]: https://developer.apple.com/documentation/appkit/nsspeechsynthesizer
+[SAPI5]: https://learn.microsoft.com/en-us/previous-versions/windows/desktop/ms723627(v=vs.85)
 
 Feel free to wrap another text-to-speech engine for use with ``pyttsx3``.
 

docs/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # pyttsx3 documentation build configuration file, created by
 # sphinx-quickstart on Sun Jun 25 11:19:31 2017.

docs/engine.rst

@@ -15,9 +15,10 @@ The Engine factory
 
    :param driverName: Name of the :mod:`pyttsx3.drivers` module to load and use. Defaults to the best available driver for the platform, currently:
 
+      * `avspeech` - AVSynthesizer on macOS
+      * `espeak` - eSpeak on all platforms
+      * `nsss` - NSSpeechSynthesizer on macOS (Deprecated by Apple)
       * `sapi5` - SAPI5 on Windows
-      * `nsss` - NSSpeechSynthesizer on Mac OS X
-      * `espeak` - eSpeak on every other platform
 
    :param debug: Enable debug output or not.
    :raises ImportError: When the requested driver is not found

example/repeatvoice.py

@@ -1,7 +1,7 @@
-import pyttsx3  # pyttsx3 is a text-to-speech conversion library in Python
-import speech_recognition as s  # Google Speech API in Python
+# pip3 install SpeechRecognition
+import speech_recognition  # A speech-to-text conversion library in Python
 
-# Functional programming Model
+import pyttsx3  # A text-to-speech conversion library in Python
 
 
 def text_to_speech(text):
@@ -14,11 +14,13 @@ def text_to_speech(text):
 
 
 def speech_to_text():
-    r = s.Recognizer()  # an object r which recognises the voice
-    with s.Microphone():
-        # when using with statement. The with statement itself ensures proper acquisition and release of resources
-        print(r.recognize_google(audio))
-        text_to_speech(r.recognize_google(audio))
+    recognizer = speech_recognition.Recognizer()
+    with speech_recognition.Microphone() as microphone:
+        audio = recognizer.listen(microphone)
+    text = recognizer.recognize_google(audio)
+    print(text)
+    text_to_speech(text)
 
 
-speech_to_text()
+if __name__ == "__main__":
+    speech_to_text()

pyproject.toml

@@ -56,4 +56,3 @@ include-package-data = false
 [tool.ruff]
 target-version = "py39"
 line-length = 88
-lint.extend-ignore = [ "F403", "F405", "F821" ]

pyttsx3/__init__.py

@@ -1,6 +1,7 @@
-from .engine import Engine
 import weakref
 
+from .engine import Engine
+
 _activeEngines = weakref.WeakValueDictionary()
 
 

pyttsx3/driver.py

@@ -3,7 +3,7 @@
 import weakref
 
 
-class DriverProxy(object):
+class DriverProxy:
     """
     Proxy to a driver implementation.
 

pyttsx3/drivers/_espeak.py

@@ -1,5 +1,3 @@
-from __future__ import print_function
-
 import time
 from ctypes import (
     CFUNCTYPE,
@@ -20,7 +18,7 @@
 
 
 def cfunc(name, dll, result, *args):
-    """build and apply a ctypes prototype complete with parameter flags"""
+    """Build and apply a ctypes prototype complete with parameter flags"""
     atypes = []
     aflags = []
     for arg in args:
@@ -36,6 +34,7 @@ def load_library():
     global dll
     paths = [
         # macOS paths
+        "/opt/homebrew/lib/libespeak-ng.1.dylib",
         "/usr/local/lib/libespeak-ng.1.dylib",
         "/usr/local/lib/libespeak.dylib",
         # Linux paths
@@ -212,6 +211,8 @@ def Synth(
     flags=0,
     user_data=None,
 ):
+    if isinstance(text, str):
+        text = text.encode("utf-8")
     return cSynth(
         text,
         len(text) * 10,
@@ -279,7 +280,7 @@ def Synth(
    Return: EE_OK: operation achieved
            EE_BUFFER_FULL: the command can not be buffered;
              you may try after a while to call the function again.
-	   EE_INTERNAL_ERROR."""
+           EE_INTERNAL_ERROR."""
 
 
 def Synth_Mark(text, index_mark, end_position=0, flags=CHARS_AUTO):
@@ -309,7 +310,7 @@ def Synth_Mark(text, index_mark, end_position=0, flags=CHARS_AUTO):
    Return:  EE_OK: operation achieved
             EE_BUFFER_FULL: the command can not be buffered;
              you may try after a while to call the function again.
-	        EE_INTERNAL_ERROR."""
+                EE_INTERNAL_ERROR."""
 
 Key = cfunc("espeak_Key", dll, c_int, ("key_name", c_char_p, 1))
 Key.__doc__ = """Speak the name of a keyboard key.
@@ -318,15 +319,15 @@ def Synth_Mark(text, index_mark, end_position=0, flags=CHARS_AUTO):
    Return: EE_OK: operation achieved
            EE_BUFFER_FULL: the command can not be buffered;
              you may try after a while to call the function again.
-	   EE_INTERNAL_ERROR."""
+           EE_INTERNAL_ERROR."""
 
 Char = cfunc("espeak_Char", dll, c_int, ("character", c_wchar, 1))
 Char.__doc__ = """Speak the name of the given character
 
    Return: EE_OK: operation achieved
            EE_BUFFER_FULL: the command can not be buffered;
              you may try after a while to call the function again.
-	   EE_INTERNAL_ERROR."""
+           EE_INTERNAL_ERROR."""
 
 # Speech Parameters
 SILENCE = 0  # internal use
@@ -451,11 +452,13 @@ def __repr__(self):
 
 
 def ListVoices(voice_spec=None):
-    """Reads the voice files from espeak-data/voices and returns a list of VOICE objects.
+    """
+    Reads the voice files from espeak-data/voices and returns a list of VOICE objects.
 
     If voice_spec is None then all voices are listed.
     If voice spec is given, then only the voices which are compatible with the voice_spec
-    are listed, and they are listed in preference order."""
+    are listed, and they are listed in preference order.
+    """
     ppv = cListVoices(voice_spec)
     res = []
     i = 0
@@ -514,12 +517,12 @@ def ListVoices(voice_spec=None):
 Synchronize = cfunc("espeak_Synchronize", dll, c_int)
 Synchronize.__doc__ = """This function returns when all data have been spoken.
    Return:  EE_OK: operation achieved
-	        EE_INTERNAL_ERROR."""
+                EE_INTERNAL_ERROR."""
 
 Terminate = cfunc("espeak_Terminate", dll, c_int)
 Terminate.__doc__ = """last function to be called.
    Return:  EE_OK: operation achieved
-	        EE_INTERNAL_ERROR."""
+                EE_INTERNAL_ERROR."""
 
 Info = cfunc("espeak_Info", dll, c_char_p, ("ptr", c_void_p, 1, 0))
 Info.__doc__ = """Returns the version number string.
@@ -541,7 +544,7 @@ def synth_cb(wav, numsample, events):
     SetSynthCallback(synth_cb)
     s = "This is a test, only a test. "
     uid = c_uint(0)
-    # print 'pitch=',GetParameter(PITCH)
+    # print('pitch=',GetParameter(PITCH))
     # SetParameter(PITCH, 50, 0)
     print(Synth(s))
     while IsPlaying():