Merge branch 'camera-capture-split-cam-option' of https://github.com/Avasam/Auto-Split into More-capture-options

Author: Avasam

.flake8

@@ -18,7 +18,6 @@ per-file-ignores=
     ; Line too long
     ; Naming conventions can't be controlled for external libraries
     typings/**:                     Q000,E704,E501,N8
-
 ; PyQt methods
 ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent
 ; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there

.github/workflows/codeql-analysis.yml

@@ -39,7 +39,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +50,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +64,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/lint-and-build.yml

@@ -36,15 +36,15 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: 'scripts/requirements-dev.txt'
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install wheel
-          pip install -r "scripts/requirements.txt"
+          pip install -r "scripts/requirements-dev.txt"
           npm install -g pyright
           npm list -g pyright
-      - run: scripts/compile_resources.bat
-      - name: Analysing the code with ${{ github.job }}
+      - run: scripts/compile_resources.ps1
+      - name: Analysing the code with Pyright
         run: pyright --warnings
   Pylint:
     runs-on: windows-latest
@@ -59,14 +59,13 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: 'scripts/requirements-dev.txt'
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install wheel
-          pip install -r "scripts/requirements.txt"
-      - run: scripts/compile_resources.bat
-      - name: Analysing the code with ${{ github.job }}
-        run: pylint --reports=y --output-format=colorized $(git ls-files '**/*.py')
+        run: pip install -r "scripts/requirements-dev.txt"
+      - run: scripts/compile_resources.ps1
+      - name: Analysing the code with Pylint
+        run: pylint --reports=y --output-format=colorized src/
   Flake8:
     runs-on: windows-latest
     strategy:
@@ -80,13 +79,12 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: 'scripts/requirements-dev.txt'
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install wheel
-          pip install -r "scripts/requirements.txt"
-      - run: scripts/compile_resources.bat
-      - name: Analysing the code with ${{ github.job }}
+        run: pip install -r "scripts/requirements-dev.txt"
+      - run: scripts/compile_resources.ps1
+      - name: Analysing the code with Flake8
         run: flake8
   Bandit:
     runs-on: windows-latest
@@ -101,13 +99,12 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: 'scripts/requirements-dev.txt'
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install wheel
-          pip install -r "scripts/requirements.txt"
-      - run: scripts/compile_resources.bat
-      - name: Analysing the code with ${{ github.job }}
+        run: pip install -r "scripts/requirements-dev.txt"
+      - run: scripts/compile_resources.ps1
+      - name: Analysing the code with Bandit
         run: bandit -n 1 --severity-level medium --recursive src
   Build:
     runs-on: windows-latest
@@ -122,12 +119,10 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install wheel
-          pip install -r "scripts/requirements.txt"
-      - run: scripts/build.bat
+        run: pip install -r "scripts/requirements.txt"
+      - run: scripts/build.ps1
       - name: Upload Build Artifact
         uses: actions/upload-artifact@v3
         with:

.gitignore

@@ -1,5 +1,8 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
+# Caches
+.cache/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 

.vscode/settings.json

@@ -77,4 +77,11 @@
   // Just another wrapper, use Flake8 OR this
   "python.linting.pylamaEnabled": false,
   "python.linting.banditEnabled": true,
+  "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
+  "powershell.codeFormatting.autoCorrectAliases": true,
+  "powershell.codeFormatting.trimWhitespaceAroundPipe": true,
+  "powershell.codeFormatting.useConstantStrings": true,
+  "powershell.codeFormatting.useCorrectCasing": true,
+  "powershell.codeFormatting.whitespaceBetweenParameters": true,
+  "powershell.integratedConsole.showOnStartup": false,
 }

.vscode/tasks.json

@@ -0,0 +1,14 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build AutoSplit",
+      "type": "shell",
+      "command": "scripts/build.ps1",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ],
+}

README.md

@@ -18,27 +18,25 @@ This program can be used to automatically start, split, and reset your preferred
 
 ## DOWNLOAD AND OPEN
 
-### Compatibility
-
-- Windows 7, 10, and 11.
+- Download the [latest version](/../../releases/latest)
 
-### Opening the program
+### Compatibility
 
-- Download the [latest version](/../../releases/latest)
-- Extract the file and open AutoSplit.exe.
+- Windows 10 and 11.
 
 ### Building
 
 (This is not required for normal use)
 
-- Python 3.8 - 3.10
-- 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/)
+- Python 3.9 - 3.10.
+- 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 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 `.\scripts\start.bat [--auto-controlled]`
-  - Run `.\scripts\build.bat` to build an executable
-- Recompile resources after modifications by running `.\scripts\compile_resources.bat`
+- Read [requirements.txt](/scripts/requirements.txt) for more information on how to install, run and build the python code.
+  - Run `./scripts/install.ps1` to install all dependencies.
+  - Run the app directly with `./scripts/start.ps1 [--auto-controlled]`.
+  - Run `./scripts/build.ps1` to build an executable.
+- Recompile resources after modifications by running `.\scripts\compile_resources.ps1`.
+- All configured for VSCode, including Run (F5) and Build (Ctrl+Shift+B) commands.
 
 ## OPTIONS
 
@@ -54,36 +52,37 @@ This program can be used to automatically start, split, and reset your preferred
 #### Capture Region
 
 - This is the region that your split images are compared to. Usually, this is going to be the full game screen.
-- Click "Select Region"
+- Click "Select Region".
 - Click and drag to form a rectangle over the region you want to capture.
 - Adjust the x, y, width, and height of the capture region manually to make adjustments as needed.
-- If you want to align your capture region by using a reference image, click "Align Region"
+- If you want to align your capture region by using a reference image, click "Align Region".
 - You can freely move the window that the program is capturing, but resizing the window will cause the capture region to change.
 - 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.
 
 #### Avg. FPS
 
-- 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.
+- Calculates the average 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.
 
 ### Settings
 
 #### Comparison Method
 
 - There are three comparison methods to choose from: L2 Norm, Histograms, and Perceptual Hash (or pHash).
-  - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, and sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different.
+  - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different.
   - 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.
   - Perceptual Hash: 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.
 
 #### Capture Method
 
 - **BitBlt** (fastest, least compatible)  
-    A good default fast option. Also allows recording background windows (as long as they still actually render when in the background), but it cannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows.  
-    The smaller the region, the more efficient it is.  
-- **Windows Graphics Capture** (fast, most compatible but less features)  
+    A good default fast option. But it cannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows.  
+    The smaller the selected region, the more efficient it is.  
+- **Windows Graphics Capture** (fast, most compatible, capped at 60fps)  
     Only available in Windows 10.0.17134 and up.  
     Due to current technical limitations, it requires having at least one audio or video Capture Device connected and enabled. Even if it won't be used.  
     Allows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows.  
+    Adds a yellow border on Windows 10 (not on Windows 11).
     Caps at around 60 FPS.  
 - **Direct3D Desktop Duplication** (slower, bound to display)  
     Duplicates the desktop using Direct3D.  
@@ -93,6 +92,10 @@ This program can be used to automatically start, split, and reset your preferred
 - **Force Full Content Rendering** (very slow, can affect rendering pipeline)  
     Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the entire desktop.  
     About 10-15x slower than BitBlt based on original window size and can mess up some applications' rendering pipelines.  
+- **Video Capture Device** (very slow, see below)  
+    Uses a Video Capture Device, like a webcam, virtual cam, or capture card.  
+    There are currently performance issues, but it might be more convenient.  
+    If you want to use this with OBS' Virtual Camera, use the [Virtualcam plugin](https://obsproject.com/forum/resources/obs-virtualcam.949/) instead.  
 
 #### Show Live Similarity
 

pyproject.toml

@@ -78,9 +78,9 @@ ignore-paths = [
   # Auto generated
   "^src/gen/.*$",
   # We expect stub files to be incomplete or contain useless statements
-  "^.*\\.pyi$",
+  "^.*.pyi$",
 ]
-extension-pkg-allow-list = ["PyQt6", "win32ui"]
+extension-pkg-allow-list = ["PyQt6", "PySide6", "win32ui"]
 
 [tool.pylint.FORMAT]
 max-line-length = 120