Differentiate "undo/skip split" from "previous/next image"

Skip/udo will now actually call command
This makes grouping option obsolete as user now has finer control anyway
UI is a bit cramped, but that should be resolved with UI revamp
Updated README

Author: Avasam

README.md

@@ -33,9 +33,9 @@ This program can be used to automatically start, split, and reset your preferred
 
 - Microsoft Visual C++ 14.0 or greater may be required to build the executable. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
 - Node is optional, but required for complete linting (using Pyright).
-- Read [requirements.txt](/scripts/requirements.txt) for information on how to install, run and build the python code
+- Read [requirements.txt](/scripts/requirements.txt) for more information on how to install, run and build the python code
   - Run `.\scripts\install.bat` to install all dependencies
-  - Run the app directly with `py .\src\AutoSplit.py [--auto-controlled]`
+  - Run the app directly with `.\scripts\start.bat [--auto-controlled]`
   - Run `.\scripts\build.bat` to build an executable
 - Recompile resources after modifications by running `.\scripts\compile_resources.bat`
 
@@ -59,9 +59,9 @@ This program can be used to automatically start, split, and reset your preferred
 - Once you are happy with your capture region, you may unselect Live Capture Region to decrease CPU usage if you wish.
 - You can save a screenshot of the capture region to your split image folder using the Take Screenshot button.
 
-## Max FPS
+## Avg. FPS
 
-- Calculates the maximum comparison rate of the capture region to split images. This value will likely be much higher than needed, so it is highly recommended to limit your FPS depending on the frame rate of the game you are capturing.
+- Calculates the average comparison rate of the capture region to split images. This value will likely be much higher than needed (unless you [Force Full-Content-Rendering](#Full-Content-Rendering)), so it is highly recommended to limit your FPS depending on the frame rate of the game you are capturing.
 
 ## OPTIONS
 
@@ -72,6 +72,10 @@ This program can be used to automatically start, split, and reset your preferred
   - Histograms: An explanation on Histograms comparison can be found [here](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html). This is a great method to use if you are using several masked images.
   - pHash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate.
 
+### Full Content Rendering
+
+- Certain windows (namely hardware accelerated ones) won't always render their content. To work around this, you can "Force Full Content Rendering". This option is not reocmmended unless you really need it. It will cause a 10-15x performance drop based on the size of the complete window that's being captured (not the selected region, but rather the actual window size). It can also mess with some applications' rendering pipeline.
+
 ### Show Live Similarity
 
 - Displays the live similarity between the capture region and the current split image. This number is between 0 and 1, with 1 being a perfect match.
@@ -142,11 +146,9 @@ The start image is similar to the reset image. You can only have one start image
 - All of these actions can also be handled by their corresponding buttons.
 - Note that pressing your Pause Hotkey does not serve any function in AutoSplit itself and is strictly used for the Pause flag.
 
-### Group dummy splits when undoing / skipping
-
-If this option is disabled, AutoSplit will not account for dummy splits when undoing/skipping. Meaning it will cycle through the images normally even if they have the dummy flag `{d}` applied to them.
+### Dummy splits when undoing / skipping
 
-If it is enabled, AutoSplit will group dummy splits together with a real split when undoing/skipping. This basically allows you to tie one or more dummy splits to a real split to keep it as in sync as possible with the real splits in LiveSplit/wsplit.
+AutoSplit will group dummy splits together with a real split when undoing/skipping. This basically allows you to tie one or more dummy splits to a real split to keep it as in sync as possible with the real splits in LiveSplit/wsplit. If they are out of sync, you can always use "Previous Image" and "Next Image".
 
 Examples:
 Given these splits: 1 dummy, 2 normal, 3 dummy, 4 dummy, 5 normal, 6 normal.
@@ -192,13 +194,11 @@ The AutoSplit LiveSplit Component will directly connect AutoSplit with LiveSplit
 - Click the Browse buttons to locate your AutoSplit Path (path to AutoSplit.exe) and Settings Path (path to your AutoSplit `.pkl` settings file) respectively.
   - If you have not yet set saved a settings file, you can do so using AutoSplit, and then go back and set your Settings Path.
 - Once set, click OK, and then OK again to close the Layout Editor. Right click LiveSplit -> Save Layout to save your layout. AutoSplit and its settings will now open automatically when opening that LiveSplit Layout `.lsl` file.
-- If you are using any dummy splits, it is recommended that you check the "Group dummy splits when undoing / skipping" checkbox when using LiveSplit integration so that your LiveSplit splits stay in sync with AutoSplit.
 
 ## Known Limitations
 
 - For many games, it will be difficult to find a split image for the last split of the run.
 - The window of the capture region cannot be minimized.
-- Capturing a hardware accelerated window or using Windows 11 altogether will cause performance drops. But as long as the window you are capturing (not the selected region, but rather the actual window size) is not too large, you should still be able to obtain a Max FPS of over 60.
 
 ## Resources
 

res/design.ui

@@ -213,10 +213,10 @@
     </property>
     <property name="geometry">
      <rect>
-      <x>494</x>
-      <y>250</y>
+      <x>340</x>
+      <y>440</y>
       <width>64</width>
-      <height>24</height>
+      <height>21</height>
      </rect>
     </property>
     <property name="focusPolicy">
@@ -232,10 +232,10 @@
     </property>
     <property name="geometry">
      <rect>
-      <x>560</x>
-      <y>250</y>
+      <x>410</x>
+      <y>440</y>
       <width>61</width>
-      <height>24</height>
+      <height>21</height>
      </rect>
     </property>
     <property name="focusPolicy">
@@ -786,7 +786,7 @@
       <x>260</x>
       <y>250</y>
       <width>101</width>
-      <height>24</height>
+      <height>23</height>
      </rect>
     </property>
     <property name="focusPolicy">
@@ -866,9 +866,9 @@
     <property name="geometry">
      <rect>
       <x>125</x>
-      <y>296</y>
+      <y>295</y>
       <width>91</width>
-      <height>22</height>
+      <height>23</height>
      </rect>
     </property>
     <item>
@@ -935,22 +935,6 @@
      <string>Align Region</string>
     </property>
    </widget>
-   <widget class="QCheckBox" name="group_dummy_splits_checkbox">
-    <property name="geometry">
-     <rect>
-      <x>230</x>
-      <y>442</y>
-      <width>261</width>
-      <height>20</height>
-     </rect>
-    </property>
-    <property name="text">
-     <string>Group dummy splits when undoing/skipping</string>
-    </property>
-    <property name="checked">
-     <bool>false</bool>
-    </property>
-   </widget>
    <widget class="QPushButton" name="select_window_button">
     <property name="geometry">
      <rect>
@@ -993,7 +977,7 @@
      <string>Pause</string>
     </property>
    </widget>
-   <widget class="QLineEdit" name="pause_hotkey_input">
+   <widget class="QLineEdit" name="pause_input">
     <property name="geometry">
      <rect>
       <x>300</x>
@@ -1153,6 +1137,44 @@
      <string>Force Full Content Rendering (slower)</string>
     </property>
    </widget>
+   <widget class="QPushButton" name="next_image_button">
+    <property name="enabled">
+     <bool>false</bool>
+    </property>
+    <property name="geometry">
+     <rect>
+      <x>560</x>
+      <y>250</y>
+      <width>61</width>
+      <height>23</height>
+     </rect>
+    </property>
+    <property name="focusPolicy">
+     <enum>Qt::NoFocus</enum>
+    </property>
+    <property name="text">
+     <string>Next Img.</string>
+    </property>
+   </widget>
+   <widget class="QPushButton" name="previous_image_button">
+    <property name="enabled">
+     <bool>false</bool>
+    </property>
+    <property name="geometry">
+     <rect>
+      <x>494</x>
+      <y>250</y>
+      <width>64</width>
+      <height>23</height>
+     </rect>
+    </property>
+    <property name="focusPolicy">
+     <enum>Qt::NoFocus</enum>
+    </property>
+    <property name="text">
+     <string>Prev. Img.</string>
+    </property>
+   </widget>
    <zorder>split_image_folder_label</zorder>
    <zorder>split_image_folder_input</zorder>
    <zorder>browse_button</zorder>
@@ -1207,11 +1229,10 @@
    <zorder>pause_spinbox</zorder>
    <zorder>comparison_method_label</zorder>
    <zorder>align_region_button</zorder>
-   <zorder>group_dummy_splits_checkbox</zorder>
    <zorder>select_window_button</zorder>
    <zorder>image_loop_label</zorder>
    <zorder>pause_hotkey_label</zorder>
-   <zorder>pause_hotkey_input</zorder>
+   <zorder>pause_input</zorder>
    <zorder>set_pause_hotkey_button</zorder>
    <zorder>loop_checkbox</zorder>
    <zorder>auto_start_on_reset_checkbox</zorder>
@@ -1221,6 +1242,8 @@
    <zorder>current_similarity_threshold_number_label</zorder>
    <zorder>capture_region_window_label</zorder>
    <zorder>force_print_window_checkbox</zorder>
+   <zorder>next_image_button</zorder>
+   <zorder>previous_image_button</zorder>
   </widget>
   <widget class="QMenuBar" name="menu_bar">
    <property name="geometry">
@@ -1313,7 +1336,6 @@
   <tabstop>reset_input</tabstop>
   <tabstop>skip_split_input</tabstop>
   <tabstop>undo_split_input</tabstop>
-  <tabstop>group_dummy_splits_checkbox</tabstop>
  </tabstops>
  <resources>
   <include location="resources.qrc"/>

src/AutoSplit.py

@@ -158,7 +158,7 @@ def __init__(self, parent: Optional[QWidget] = None):
             self.reset_input.setEnabled(False)
             self.skip_split_input.setEnabled(False)
             self.undo_split_input.setEnabled(False)
-            self.pause_hotkey_input.setEnabled(False)
+            self.pause_input.setEnabled(False)
             self.timer_global_hotkeys_label.setText("Hotkeys Inactive - Use LiveSplit Hotkeys")
 
             # Send version and process ID to stdout
@@ -183,6 +183,8 @@ def __init__(self, parent: Optional[QWidget] = None):
         self.reset_button.clicked.connect(self.reset)
         self.skip_split_button.clicked.connect(self.__skip_split)
         self.undo_split_button.clicked.connect(self.__undo_split)
+        self.next_image_button.clicked.connect(lambda: self.__skip_split(True))
+        self.previous_image_button.clicked.connect(lambda: self.__undo_split(True))
         self.set_split_hotkey_button.clicked.connect(lambda: set_split_hotkey(self))
         self.set_reset_hotkey_button.clicked.connect(lambda: set_reset_hotkey(self))
         self.set_skip_split_hotkey_button.clicked.connect(lambda: set_skip_split_hotkey(self))
@@ -278,7 +280,7 @@ def load_start_image(self, started_by_button: bool = False, wait_for_delay: bool
         if not self.is_auto_controlled \
             and (not self.split_input.text()
                  or not self.reset_input.text()
-                 or not self.pause_hotkey_input.text()):
+                 or not self.pause_input.text()):
             error_messages.load_start_image()
             return
 
@@ -457,8 +459,10 @@ def __is_current_split_out_of_range(self):
         return self.split_image_number < 0 \
             or self.split_image_number > len(self.split_images_and_loop_number) - 1
 
-    # undo split button and hotkey connect to here
-    def __undo_split(self):
+    def __undo_split(self, navigate_image_only: bool = False):
+        """
+        "Undo Split" and "Prev. Img." buttons and hotkey connect to here
+        """
         # Can't undo until timer is started
         # or Undoing past the first image
         if self.start_auto_splitter_button.text() == START_AUTO_SPLITTER_TEXT \
@@ -467,7 +471,7 @@ def __undo_split(self):
                 or self.__is_current_split_out_of_range():
             return
 
-        if self.group_dummy_splits_checkbox.isChecked():
+        if not navigate_image_only:
             for i, group in enumerate(self.split_groups):
                 if i > 0 and self.split_image_number in group:
                     self.split_image_number = self.split_groups[i - 1][0]
@@ -476,9 +480,13 @@ def __undo_split(self):
             self.split_image_number -= 1
 
         self.__update_split_image()
+        if not navigate_image_only:
+            send_command(self, "undo")
 
-    # skip split button and hotkey connect to here
-    def __skip_split(self):
+    def __skip_split(self, navigate_image_only: bool = True):
+        """
+        "Skip Split" and "Next Img." buttons and hotkey connect to here
+        """
         # Can't skip or split until timer is started
         # or Splitting/skipping when there are no images left
         if self.start_auto_splitter_button.text() == START_AUTO_SPLITTER_TEXT \
@@ -487,7 +495,7 @@ def __skip_split(self):
                 or self.__is_current_split_out_of_range():
             return
 
-        if self.group_dummy_splits_checkbox.isChecked():
+        if not navigate_image_only:
             for group in self.split_groups:
                 if self.split_image_number in group:
                     self.split_image_number = group[-1] + 1
@@ -496,6 +504,8 @@ def __skip_split(self):
             self.split_image_number += 1
 
         self.__update_split_image()
+        if not navigate_image_only:
+            send_command(self, "skip")
 
     def pause(self):
         # TODO add what to do when you hit pause hotkey, if this even needs to be done
@@ -546,18 +556,17 @@ def __auto_splitter(self):
                 in self.split_images]
             for item in flattenlist]
 
-        # Construct groups of splits if needed
+        # Construct groups of splits
         self.split_groups = []
-        if self.group_dummy_splits_checkbox.isChecked():
-            current_group: list[int] = []
-            self.split_groups.append(current_group)
+        current_group: list[int] = []
+        self.split_groups.append(current_group)
+        for i, image in enumerate(self.split_images_and_loop_number):
+            current_group.append(i)
 
-            for i, image in enumerate(self.split_images_and_loop_number):
-                current_group.append(i)
+            if not image[0].check_flag(DUMMY_FLAG) and i < len(self.split_images_and_loop_number) - 1:
+                current_group = []
+                self.split_groups.append(current_group)
 
-                if not image[0].check_flag(DUMMY_FLAG) and i < len(self.split_images_and_loop_number) - 1:
-                    current_group = []
-                    self.split_groups.append(current_group)
         self.gui_changes_on_start()
 
         # Initialize a few attributes
@@ -615,14 +624,15 @@ def __auto_splitter(self):
                     if self.show_highest_similarity_checkbox.isChecked()
                     else " ")
 
+                # If its the last split image and last loop number, disable skip split button
+                # If its the first split image, disable the undo split button
+                is_last = self.split_image_number == number_of_split_images - 1 \
+                    or dummy_splits_array[self.split_image_number:].count(False) <= 1
+                self.next_image_button.setEnabled(not is_last)
+                self.previous_image_button.setEnabled(self.split_image_number != 0)
                 if not self.is_auto_controlled:
-                    # if its the last split image or can't skip due to grouped dummy splits, disable skip split button
-                    is_last = self.split_image_number == number_of_split_images - 1 \
-                        or (self.group_dummy_splits_checkbox.isChecked()
-                            and dummy_splits_array[self.split_image_number:].count(False) <= 1)
                     self.skip_split_button.setEnabled(not is_last)
 
-                    # if its the first split image, disable the undo split button
                     self.undo_split_button.setEnabled(self.split_image_number != 0)
 
                 # if the b flag is set, let similarity go above threshold first,
@@ -694,14 +704,15 @@ def __auto_splitter(self):
             # if its not the last split image, pause for the amount set by the user
             if number_of_split_images != self.split_image_number:
 
+                # If its the last split image and last loop number, disable skip split button
+                # If its the first split image, disable the undo split button
+                is_last = self.split_image_number == number_of_split_images - 1 \
+                    or dummy_splits_array[self.split_image_number:].count(False) <= 1
+                self.next_image_button.setEnabled(not is_last)
+                self.previous_image_button.setEnabled(self.split_image_number != 0)
                 if not self.is_auto_controlled:
-                    # if its the last split image and last loop number, disable skip split button
-                    is_last = self.split_image_number == number_of_split_images - 1 \
-                        or (self.group_dummy_splits_checkbox.isChecked()
-                            and dummy_splits_array[self.split_image_number:].count(False) <= 1)
                     self.skip_split_button.setEnabled(not is_last)
 
-                    # if its the first split image, disable the undo split button
                     self.undo_split_button.setEnabled(self.split_image_number != 0)
                 QApplication.processEvents()
 
@@ -737,8 +748,9 @@ def gui_changes_on_start(self):
         self.timer_start_image.stop()
         self.start_auto_splitter_button.setText("Running...")
         self.browse_button.setEnabled(False)
-        self.group_dummy_splits_checkbox.setEnabled(False)
         self.start_image_reload_button.setEnabled(False)
+        self.previous_image_button.setEnabled(True)
+        self.next_image_button.setEnabled(True)
 
         if not self.is_auto_controlled:
             self.start_auto_splitter_button.setEnabled(False)
@@ -762,8 +774,9 @@ def gui_changes_on_reset(self):
         self.highest_similarity_label.setText(" ")
         self.current_similarity_threshold_number_label.setText(" ")
         self.browse_button.setEnabled(True)
-        self.group_dummy_splits_checkbox.setEnabled(True)
         self.start_image_reload_button.setEnabled(True)
+        self.previous_image_button.setEnabled(False)
+        self.next_image_button.setEnabled(False)
 
         if not self.is_auto_controlled:
             self.start_auto_splitter_button.setEnabled(True)