[dist] Update docs for upcoming v1.7 release.

Breakthrough · Breakthrough · commit ec274ad836dd · 2025-02-27T18:02:33.000-05:00
diff --git a/README.md b/README.md
@@ -4,15 +4,7 @@
 
 ------------------------------------------------
 
-### Beta Release: v1.7-dev0 (January 16, 2025)
-
-The latest beta of DVR-Scan includes a new GUI.  See [the release page](https://github.com/Breakthrough/DVR-Scan/releases/tag/v1.7-dev0) for download links and screenshots.  Feedback is most welcome (see issue [#198](https://github.com/Breakthrough/DVR-Scan/issues/198)).
-
-![GUI Beta Screenshot](https://github.com/user-attachments/assets/6d6bb509-f40c-48ba-95d9-a7912935e9eb)
-
-------------------------------------------------
-
-### Latest Release: v1.6.2 (December 17, 2024)
+### Latest Release: v1.7 (In Development)
 
 **Website**: [dvr-scan.com](https://www.dvr-scan.com)
 
@@ -28,9 +20,17 @@ DVR-Scan is a command-line application that **automatically detects motion event
 
     pip install dvr-scan[opencv] --upgrade
 
-Windows builds are also available on [the Downloads page](https://www.dvr-scan.com/download/).
+Windows builds (installer + portable) are also available on [the Downloads page](https://www.dvr-scan.com/download/).
+
+## Quickstart (UI)
+
+Start DVR-Scan (run `dvr-scan-app` or click the app shortcut), **Add** your input videos, and hit **Start**:
+
+<img alt="main app window" src="https://raw.githubusercontent.com/Breakthrough/DVR-Scan/releases/1.7/docs/assets/app-main-window.jpg" width="480"/>
+
+See the [User Guide](https://www.dvr-scan.com/guide/) for a more comprehensive overview.
 
-## Quickstart
+## Quickstart (CLI)
 
 Scan `video.mp4` (separate clips for each event):
 
@@ -40,7 +40,7 @@ Select a region to scan using [the region editor](https://www.dvr-scan.com/guide
 
     dvr-scan -i video.mp4 -r
 
-<img alt="example of region editor" src="https://raw.githubusercontent.com/Breakthrough/DVR-Scan/releases/1.6/docs/assets/region-editor-mask.jpg" width="480"/>
+<img alt="example of region editor" src="https://raw.githubusercontent.com/Breakthrough/DVR-Scan/releases/1.7/docs/assets/region-editor-mask.jpg" width="480"/>
 
 Select a region to scan using command line (list of points as X Y):
 
@@ -50,7 +50,7 @@ Draw boxes around motion:
 
     dvr-scan -i video.mp4 -bb
 
-<img alt="example of bounding boxes" src="https://raw.githubusercontent.com/Breakthrough/DVR-Scan/releases/1.6/docs/assets/bounding-box.gif" width="480"/>
+<img alt="example of bounding boxes" src="https://raw.githubusercontent.com/Breakthrough/DVR-Scan/releases/1.7/docs/assets/bounding-box.gif" width="480"/>
 
 Use `ffmpeg` to extract events:
 
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,23 +5,26 @@
 
 ## DVR-Scan 1.7
 
-### 1.7 (In Development)
+### 1.7 (TBD)
 
-#### Beta 1 (1.7-dev0)
+#### Release Notes
+
+DVR-Scan 1.7 ships with a completely new UI, and supports faster video decoders (up to 50% better scanning performance):
+
+<img alt="example of region editor" src="https://raw.githubusercontent.com/Breakthrough/DVR-Scan/releases/1.7/docs/assets/app-main-window.jpg" width="480"/>
+
+The UI can be started by running `dvr-scan-app`, and is installed alongside the existing command line interface `dvr-scan`.  Config settings and region files can be shared seamlessly between both. Feedback on the new UI is welcome.
+
+#### Changelog
 
  - [feature] New GUI now available across all platforms, can be launched via `dvr-scan-app`
     - Has UI elements for all settings, supports editing motion regions
     - Shows scan progress in real-time
-    - Supports loading/saving config files compatible with the `dvr-scan` CLI command
+ - [feature] Add ability to control video decoder via `input-mode` config option (`opencv`, `pyav`, `moviepy`)
+    - Allows switching between `OpenCV` (default), `PyAV`, and `MoviePy` for video decoding
+    - Certain backends provide substantial performance benefits, up to 50% in some cases (let us know which one works best!)
  - [general] Minimum supported Python version is now 3.9
 
-#### Beta 2 (1.7-dev1)
-
- - [bugfix] Fix "too many values to unpack" exception when scanning video
- - [bugfix] Fix incorrect calculation of total frames when showing progress
- - [bugfix] Fix drag-and-drop shortcut not working due to not parsing input paths from command line
- - [general] Show alert on any errors during motion scanning
-
 ----------------------------------------------------------
 
 ## DVR-Scan 1.6
diff --git a/docs/download.md b/docs/download.md
@@ -9,15 +9,7 @@ hide:
 
 -------------------------------
 
-## GUI Release (Beta)
-
-A new GUI is under development for the next version of DVR-Scan and is available now for beta testing. The beta release can be [downloaded from Github](https://github.com/Breakthrough/DVR-Scan/releases/tag/v1.7-dev0). All current stable versions of DVR-Scan are command-line only.
-
-Feedback for the new GUI is welcome. Users can download and install the beta ontop of an existing DVR-Scan installation, and it is compatible with all existing config and region files.
-
--------------------------------
-
-## Python <span class="dvr-scan-download-icons">:fontawesome-brands-windows::fontawesome-brands-apple::fontawesome-brands-linux:</span>
+## Python<span class="dvr-scan-download-icons">:fontawesome-brands-windows::fontawesome-brands-apple::fontawesome-brands-linux:</span>
 
 !!! python-download "**1.6.2**<span class="dvr-scan-release-date">December 17, 2024</span>"
 
@@ -35,7 +27,7 @@ Linux users may need to install the `python3-tk` package (e.g. `sudo apt install
 
 -------------------------------
 
-## Windows Distribution<span class="dvr-scan-download-icons">:fontawesome-brands-windows:</span>
+## Windows<span class="dvr-scan-download-icons">:fontawesome-brands-windows:</span>
 
 !!! windows-download "**1.6.2**<span class="dvr-scan-release-date">December 17, 2024</span>"
 
@@ -46,9 +38,9 @@ The installer is recommended for most users.  Windows builds include all require
 
 -------------------------------
 
-## Servers and Headless Systems
+## Servers
 
-For installation on servers and other headless systems that do not require a GUI, install `dvr-scan[opencv-headless]` instead of `dvr-scan[opencv]`.  This will make sure that [the headless version of OpenCV](https://pypi.org/project/opencv-python-headless/) is installed, which avoids any dependencies on X11 libraries or any other GUI components.  This allows DVR-Scan to run with less dependencies, and can result in smaller Docker images.
+For headless systems that do not require the UI,  you can install `dvr-scan[opencv-headless]`.  This will make sure that [the headless version of OpenCV](https://pypi.org/project/opencv-python-headless/) is installed, which avoids any dependencies on X11 libraries or any other GUI components.  This allows DVR-Scan to run with less dependencies, and can result in smaller Docker images.
 
 -------------------------------
 
@@ -59,13 +51,15 @@ The source code for [DVR-Scan is available on Github](https://github.com/Breakth
 -------------------------------
 
 
-## CUDA®-Enabled Builds
+## CUDA® Support
+
+DVR-Scan works with CUDA graphics cards *if* you are using the Python distribution, *and* you have a CUDA-enabled verison of the `opencv-python` package.
 
-GPU support currently requires a development environment setup including the Nvidia CUDA® SDK.
+!!! warning "GPU support requires a development environment setup including the Nvidia CUDA® SDK."
 
-DVR-Scan works with CUDA graphics cards if you are using the Python distribution, and you have a CUDA-enabled verison of the `opencv-python` package. Unfortunately pre-built binaries are not available, so this requires that you build from source (there are various tutorials online for how to do this).
+It is recommended to build and install OpenCV with the CUDA module enabled (there are various tutorials online for how to do this).  There is also an [unofficial pre-built Python wheel](https://github.com/cudawarped/opencv-python-cuda-wheels/releases/tag/4.11.0.20250124) maintained by James Bowley which can be downloaded and installed via `pip`.
 
-When available, you should see `cv2.cuda: Installed` under the features list when running `dvr-scan --version`. Make sure to set `-b MOG2_CUDA` when running DVR-Scan (e.g. `dvr-scan -i video.mp4 -b MOG2_CUDA`).
+When available, you should see `cv2.cuda: Installed` under the features list when running `dvr-scan --version`. Make sure to set `-b MOG2_CUDA` when running DVR-Scan (e.g. `dvr-scan -i video.mp4 -b MOG2_CUDA`).  In the UI, under this can be found under Settings -> Motion -> Subtractor.
 
 -------------------------------
 
diff --git a/docs/index.md b/docs/index.md
@@ -19,7 +19,17 @@ hide:
 
 DVR-Scan is a command-line application that **automatically detects motion events in video files** (e.g. security camera footage).  DVR-Scan looks for areas in footage containing motion, and saves each event to a separate video clip.  DVR-Scan is free and open-source software, and works on Windows, Linux, and Mac.
 
-## :fontawesome-solid-person-running:Quickstart
+## Quickstart <span class="dvr-scan-download-icons">:fontawesome-brands-windows::fontawesome-brands-apple::fontawesome-brands-linux:</span>
+
+### UI
+
+Launch DVR-Scan from the shortcut or run the `dvr-scan-app` command.  Press **Add** to add your input videos, and press **Start** to find and extract segments with motion:
+
+<img alt="ui example" src="assets/app-main-window.jpg" width="480"/>
+
+To limit detection to certain areas, press **Set Regions** and use [the **Region Editor**](guide.md#region-editor). Motion sensitivity can be adjusted under **Settings -> Motion**.  See the [User Guide](guide.md) for more information.
+
+### CLI
 
 Scan `video.mp4` (separate clips for each event):
 
diff --git a/setup.cfg b/setup.cfg
@@ -47,7 +47,7 @@ packages =
     dvr_scan
     dvr_scan.app
     dvr_scan.shared
-# Documentation (pre-built HTML but without images to keep size small)
+# Documentation (minified HTML without images to keep package download size small)
     dvr_scan.docs
     dvr_scan.docs.assets
     dvr_scan.docs.assets.javascripts
