Adding behaviour on no voices found

- Warning user to download voices if no voices found, and closing Hear2Read if no voices found
- Correcting bug where pause and synth change were not working

Author: krishnshyam

globalPlugins/hear2readng_global_plugin/__init__.py

@@ -13,9 +13,11 @@
 import core
 import globalPluginHandler
 import gui
+import queueHandler
 import wx
+from gui.message import DisplayableError
 from logHandler import log
-from synthDriverHandler import getSynth, synthChanged
+from synthDriverHandler import findAndSetNextSynth, getSynth, synthChanged
 
 from globalPlugins.hear2readng_global_plugin.english_settings import (
     EnglishSpeechSettingsDialog,
@@ -31,9 +33,16 @@ class GlobalPlugin(globalPluginHandler.GlobalPlugin):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.__voice_manager_shown = False
+        curr_synth_name = getSynth().name
         self._voice_checker = lambda: wx.CallLater(2000, 
-                                                   self._perform_voice_check)
+                                                    self._perform_voice_check)
         core.postNvdaStartup.register(self._voice_checker)
+
+        # if "Hear2Read NG" not in curr_synth_name:
+        #     self._voice_checker = lambda: wx.CallLater(2000, 
+        #                                             self._perform_voice_check)
+        #     core.postNvdaStartup.register(self._voice_checker)
+
         self.itemHandle = gui.mainFrame.sysTrayIcon.menu.Insert(
             4,
             wx.ID_ANY,
@@ -45,14 +54,10 @@ def __init__(self, *args, **kwargs):
         gui.mainFrame.sysTrayIcon.menu.Bind(wx.EVT_MENU, self.on_manager, 
                                             self.itemHandle)
 
-        # TODO make this work?
-        # if "Hear2Read NG" not in getSynth().name:
-        #     return
-        
         self.eng_settings_active = False
         self.eng_settings_id = wx.Window.NewControlId()
 
-        if "Hear2Read NG" in getSynth().name:
+        if "Hear2Read NG" in curr_synth_name:
             # self.eng_settings_id = wx.Window.NewControlId()
             self.make_eng_settings_menu()
             self.eng_settings_active = True
@@ -64,6 +69,7 @@ def on_synth_changed(self, synth):
             # self.eng_settings_id = wx.Window.NewControlId()
             self.make_eng_settings_menu()
             self.eng_settings_active = True
+            self._perform_voice_check()
 
         elif self.eng_settings_active:
             gui.mainFrame.sysTrayIcon.menu.Remove(self.eng_settings_id)
@@ -83,20 +89,43 @@ def make_eng_settings_menu(self):
                                     EnglishSpeechSettingsDialog), 
                                 self.itemHandle)
 
-    def on_manager(self, event):
+    def on_manager(self, event=None):
         manager_dialog = Hear2ReadNGVoiceManagerDialog()
         try:
-            gui.runScriptModalDialog(manager_dialog)
+            gui.runScriptModalDialog(manager_dialog, callback=self.on_manager_close)
             self.__voice_manager_shown = True
         except Exception as e:
             log.error(f"Failed to open Manager: {e}")
 
-    def _perform_voice_check(self):
-        if self.__voice_manager_shown:
-            return
-
+    def on_manager_close(self, res):
         if not any(Hear2ReadNGVoiceManagerDialog.get_installed_voices()):
+            self.on_no_voices(getSynth().name)
 
+    def on_no_voices(self, curr_synth_name):
+        
+        if "Hear2Read NG" in curr_synth_name:    
+            msg_res = gui.messageBox(
+                # Translators: message telling the user that no voice is installed
+                _(
+                    "No Indic Hear2Read voice was found.\n"
+                    "Please download a voice from the manager to continue using Hear2Read Synthesizer.\n"
+                    "Do you want to open the voice manager now?"
+                ),
+                # Translators: title of a message telling the user that no Hear2Read Indic voice was found
+                _("Hear2Read Indic Voices"),
+                wx.YES_NO | wx.ICON_WARNING,)
+            
+            if msg_res == wx.YES:
+                wx.CallAfter(self.on_manager)
+            else:
+                noVoiceDisplayError = DisplayableError(
+                    titleMessage="Shutting Hear2Read Down", 
+                    displayMessage="No Hear2Read voices found. \n"
+                    "Please install voices to use Hear2Read. \n"
+                    "Voices can be installed from the Hear2Read voice manager in the NVDA menu")
+                noVoiceDisplayError.displayError(gui.mainFrame)
+                queueHandler.queueFunction(queueHandler.eventQueue, findAndSetNextSynth, curr_synth_name)
+        else:
             if wx.YES == gui.messageBox(
                 # Translators: message telling the user that no voice is installed
                 _(
@@ -107,9 +136,17 @@ def _perform_voice_check(self):
                 # Translators: title of a message telling the user that no Hear2Read Indic voice was found
                 _("Hear2Read Indic Voices"),
                 wx.YES_NO | wx.ICON_WARNING,):
+                wx.CallAfter(self.on_manager)
 
-                self.on_manager(None)
+    # @gui.blockAction.when(gui.blockAction.Context.MODAL_DIALOG_OPEN)         
+    def _perform_voice_check(self):
+        if self.__voice_manager_shown:# or gui.isModalMessageBoxActive():
+            return
 
+        if not any(Hear2ReadNGVoiceManagerDialog.get_installed_voices()):
+            curr_synth_name = getSynth().name
+            # queueHandler.queueFunction(queueHandler.eventQueue, self.on_no_voices, curr_synth_name)
+            self.on_no_voices(curr_synth_name)
 
     def terminate(self):
         try:

globalPlugins/hear2readng_global_plugin/utils.py

@@ -21,6 +21,28 @@
     H2RNG_WAVS_DIR,
 )
 
+# H2RNG_DATA_DIR = os.path.join(os.getenv("APPDATA"), "Hear2Read-NG")
+# H2RNG_PHONEME_DIR = os.path.join(H2RNG_DATA_DIR, "espeak-ng-data")
+# H2RNG_ENGINE_DLL_PATH = os.path.join(H2RNG_DATA_DIR, "Hear2ReadNG_addon_engine.dll")
+# H2RNG_VOICES_DIR = os.path.join(H2RNG_DATA_DIR, "Voices")
+# H2RNG_WAVS_DIR = os.path.join(H2RNG_DATA_DIR, "wavs")
+# EN_VOICE_ALOK = "en_US-arctic-medium"
+
+lang_names = {"as":"Assamese", 
+                "bn":"Bengali", 
+                "gu":"Gujarati", 
+                "hi":"Hindi", 
+                "kn":"Kannada", 
+                "ml":"Malayalam", 
+                "mr":"Marathi", 
+                "ne":"Nepali", 
+                "or":"Odia", 
+                "pa":"Punjabi", 
+                "si":"Sinhala",
+                "ta":"Tamil", 
+                "te":"Telugu", 
+                "en":"English"}
+
 try:
     _dir=os.path.dirname(__file__.decode("mbcs"))
 except AttributeError:
@@ -83,6 +105,34 @@ def check_files():
     # return dll_is_present and phonedir_is_present and voice_is_present
 
 
+def populateVoices():
+    pathName = os.path.join(H2RNG_VOICES_DIR)
+    voices = dict()
+    #list all files in Language directory
+    file_list = os.listdir(pathName)
+    #FIXME: the english voice is obsolete, maybe remove the voiceid?
+    en_voice = EN_VOICE_ALOK
+    voices[en_voice] = "English"
+    for file in file_list:
+        list = file.split(".")
+        if list[-1] == "onnx":
+            if f"{file}.json" not in file_list:
+                continue
+            nameList = list[0].split("-")
+            lang = nameList[0].split("_")[0]
+            
+            # Already set the sole English voice
+            if lang == "en":
+                continue
+            
+            language = lang_names.get(lang)
+            if language:
+                voices[list[0]] = language
+            else:
+                voices[list[0]] = f"Unknown language ({list[0]})"
+
+    return voices
+
 def move_old_voices():
     """Tries to move voices downloaded in addon version 1.4 and lower to the 
     new dir structure to be usable by this addon. This is slightly different 
@@ -140,6 +190,7 @@ def move_old_voices():
 
     return voices_moved
 
+# def show_voice_manager():
 
 def onInstall():
     """A fallback that tries moving the required data files in case it wasn't

globalPlugins/hear2readng_global_plugin/voice_manager.py

@@ -18,15 +18,17 @@
 import wx
 from logHandler import log
 
-from synthDrivers._H2R_NG_Speak import (
+from .utils import (
     H2RNG_DATA_DIR,
     H2RNG_VOICES_DIR,
+    DownloadThread,
+    Voice,
+    check_files,
     lang_names,
+    onInstall,
     populateVoices,
 )
 
-from .utils import DownloadThread, Voice, check_files, onInstall
-
 # Constants and global variables:
 
 DLL_FILE_NAME_PREFIX = "Hear2ReadNG_addon_engine"

manifest.ini

@@ -1,6 +1,6 @@
 name = "Hear2Read NG"
 summary = "Hear2Read Indic Speech Synthesizer"
-version = "1.6.0"
+version = "1.6.1"
 description = "This is a speech synthesizer for 11 Indic languages and English (with Indian accent) that generates natural human speech. It is based on the work done by the piper TTS team (https://github.com/rhasspy/piper). The addon includes a voice manager for installing one or more Indic voices. Supported languages: Assamese, Bengali, Gujarati, Hindi, Kannada, Malayalam, Nepali, Odia, Punjabi, Tamil, Telugu"
 author = "Hear2Read Contributers<info@Hear2Read.org>"
 url = "https://hear2read.org"