Fixed crashes when opening from LiveSplit

- NotImplementedError from the CaptureInterface
- and OutOfRange errors from CaptureMethodDict

Author: Avasam

scripts/install.ps1

@@ -1,7 +1,7 @@
 # Installing Python dependencies
 $dev = If ($env:GITHUB_JOB -eq 'Build') { '' } Else { '-dev' }
 pip install wheel --upgrade
-pip install -r "$PSScriptRoot/requirements$dev-win32.txt"
+pip install -r "$PSScriptRoot/requirements$dev.txt"
 
 # Don't compile resources on the Build CI job as it'll do so in build script
 If ($dev) {

src/capture_method/__init__.py

@@ -66,6 +66,7 @@ def __eq__(self, other: object):
     def __hash__(self):
         return self.value.__hash__()
 
+    NONE = ""
     BITBLT = "BITBLT"
     WINDOWS_GRAPHICS_CAPTURE = "WINDOWS_GRAPHICS_CAPTURE"
     PRINTWINDOW_RENDERFULLCONTENT = "PRINTWINDOW_RENDERFULLCONTENT"
@@ -74,11 +75,35 @@ def __hash__(self):
 
 
 class CaptureMethodDict(OrderedDict[CaptureMethodEnum, CaptureMethodInfo]):
+
     def get_method_by_index(self, index: int):
+        if len(self) <= 0:
+            return CaptureMethodEnum.NONE
         if index < 0:
             return next(iter(self))
         return list(self.keys())[index]
 
+    def __getitem__(self, key: CaptureMethodEnum):
+        if key == CaptureMethodEnum.NONE:
+            return NONE_CAPTURE_METHOD
+        try:
+            return super().__getitem__(key)
+        # If requested method does not exists...
+        except KeyError:
+            try:
+                # ...fallback to the first one
+                return super().__getitem__(self.get_method_by_index(0))
+            except KeyError:
+                # ...fallback to an empty capture method to avoid crashes
+                return NONE_CAPTURE_METHOD
+
+
+NONE_CAPTURE_METHOD = CaptureMethodInfo(
+    name="None",
+    short_description="",
+    description="",
+    implementation=CaptureMethodInterface
+)
 
 CAPTURE_METHODS = CaptureMethodDict({
     CaptureMethodEnum.BITBLT: CaptureMethodInfo(

src/capture_method/interface.py

@@ -28,10 +28,10 @@ def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]:
 
         @return: The image of the region in the window in BGRA format
         """
-        raise NotImplementedError()
+        return None, False
 
     def recover_window(self, captured_window_title: str, autosplit: AutoSplit) -> bool:
-        raise NotImplementedError()
+        return False
 
     def check_selected_region_exists(self, autosplit: AutoSplit) -> bool:
         return is_valid_hwnd(autosplit.hwnd)

src/menu_bar.py

@@ -194,7 +194,7 @@ def __init__(self, autosplit: AutoSplit):
         # Assuming all options take 2 lines (except camera and BitBlt which have 1).
         # And all lines take 16 pixels
         # And all separators take 2 pixels
-        doubled_len = 2 * len(capture_method_values)
+        doubled_len = 2 * len(capture_method_values) or 2
         list_view.setMinimumHeight((doubled_len - 2) * 16 + doubled_len)
         list_view.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff)
         self.capture_method_combobox.setView(list_view)

src/user_profile.py

@@ -163,12 +163,16 @@ def load_settings_on_open(autosplit: AutoSplit):
         if file.endswith(".toml")]
 
     # Find all .tomls in AutoSplit folder, error if there is not exactly 1
+    error = None
     if len(settings_files) < 1:
-        error_messages.no_settings_file_on_open()
-        return
-    if len(settings_files) > 1:
-        error_messages.too_many_settings_files_on_open()
+        error = error_messages.no_settings_file_on_open
+    elif len(settings_files) > 1:
+        error = error_messages.too_many_settings_files_on_open
+    if error:
+        change_capture_method(CAPTURE_METHODS.get_method_by_index(0), autosplit)
+        error()
         return
+
     load_settings(autosplit, os.path.join(auto_split_directory, settings_files[0]))