Merge pull request #57 from gurgalex/ocr_lang_check

Speak if english lang pack not installed

Author: gurgalex

CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.9.28
+## feat
+- Speak if the required English language pack is not installed on the system
 # v0.9.27
 # fix
 - Attempt yet another fix for sporadic startup crashes

VERSION

@@ -1 +1 @@
-0.9.27
+0.9.28

subot/main.py

@@ -24,19 +24,18 @@ def set_dpi_aware():
 import queue
 from logging.handlers import QueueHandler, QueueListener
 from multiprocessing import Queue
-from pathlib import Path
 from threading import Thread
 from typing import Optional, Union
 
-from subot import models
+from subot import models, ocr
 from subot.hang_monitor import HangMonitorWorker, HangMonitorChan, HangAnnotation, HangMonitorAlert, Shutdown
 
 import cv2
 import numpy as np
 import mss
 from subot.settings import Session, GameControl
 import subot.settings as settings
-from subot.ocr import recognize_cv2_image, detect_green_text, detect_dialog_text
+from subot.ocr import detect_green_text, detect_dialog_text, recognize_cv2_image, english_installed
 import win32gui
 import pygame
 import pygame.freetype
@@ -51,7 +50,7 @@ def set_dpi_aware():
 from subot.audio import AudioSystem, AudioLocation, SoundType
 from subot.datatypes import Rect
 from subot.menu import MenuItem, Menu
-from subot.messageTypes import NewFrame, MessageImpl, MessageType, CheckWhatRealmIn, WindowDim, ConfigMsg, ScanForItems, \
+from subot.messageTypes import NewFrame, MessageImpl, MessageType, WindowDim, ScanForItems, \
     Resume, Pause
 from subot.pathfinder.map import TileType, Map, Color, Movement
 
@@ -61,12 +60,12 @@ def set_dpi_aware():
 
 from dataclasses import dataclass
 
-from subot.models import Sprite, SpriteFrame, Quest, FloorSprite, Realm, RealmLookup, NPCSprite, OverlaySprite, HashFrameWithFloor, \
+from subot.models import Sprite, SpriteFrame, Quest, FloorSprite, Realm, RealmLookup, NPCSprite, HashFrameWithFloor, \
     QuestType, ResourceNodeSprite, \
     SpriteTypeLookup, SpriteType, ChestSprite
 
 
-from subot.utils import Point, read_version, PlayerDirection
+from subot.utils import Point, read_version
 import traceback
 
 # sentry annotation for pyinstaller
@@ -1048,6 +1047,7 @@ def run(self):
         self.activity_notify = self.hang_monitor.register_component(threading.current_thread(), 3.0)
 
         TARGET_MS = 1 / settings.FPS
+
         try:
             should_stop = False
             with mss.mss() as sct:
@@ -1434,6 +1434,11 @@ def run(self):
 def init_bot() -> Bot:
     config = settings.load_config()
     audio_system = AudioSystem(config)
+    if not english_installed():
+        audio_system.speak_blocking(ocr.ENGLISH_NOT_INSTALLED_EXCEPTION.args[0])
+        root.error(ocr.ENGLISH_NOT_INSTALLED_EXCEPTION.args[0])
+        audio_system.speak_blocking("Shutting down")
+        sys.exit(1)
 
     is_minimized = True
     while is_minimized:

subot/ocr.py

@@ -107,10 +107,35 @@ def blocking_wait(awaitable):
     return asyncio.run(ensure_coroutine(awaitable))
 
 
-def recognize_cv2_image(img, lang="en-US"):
+class LanguageNotInstalledException(Exception):
+    pass
+
+
+class OCR:
+    def __init__(self):
+        lang = Language("en-US")
+        if not OcrEngine.is_language_supported(lang):
+            raise LanguageNotInstalledException("English United States language pack not installed")
+        self.ocr_engine = OcrEngine.try_create_from_language(lang)
+
+
+ENGLISH_NOT_INSTALLED_EXCEPTION = LanguageNotInstalledException("English United States language pack not installed")
+
+
+def language_is_installed(lang: str) -> bool:
     lang = Language(lang)
-    assert (OcrEngine.is_language_supported(lang))
-    eng = OcrEngine.try_create_from_language(lang)
+    return OcrEngine.is_language_supported(lang)
+
+
+def english_installed() -> bool:
+    return language_is_installed("en-US")
+
+
+def recognize_cv2_image(img):
+    language = Language("en-US")
+    if not english_installed:
+        raise ENGLISH_NOT_INSTALLED_EXCEPTION
+    eng = OcrEngine.try_create_from_language(language)
     swbmp = swbmp_from_cv2_image(img)
     return dump_ocrresult(blocking_wait(eng.recognize_async(swbmp)))