[region-editor] Transition to Tcl/Tk for GUI #181 (#182)

This allows for better control over window events and makes input handling
more consistent across platforms. It also allows better customization, for
example, the system undo/redo commands are used instead of key binds.

There is still much work to do, however this is a good starting point, and
has feature parity with the existing editor.

Author: Breakthrough

.gitignore

@@ -9,8 +9,8 @@ site/
 build/
 # Working directory for distribution assembly
 dist/dvr-scan/*
-dist/dvr-scan*
-dist/dvr_scan*
+dist/dvr-scan-*
+dist/dvr_scan-*
 
 # Location where docs are built before assembling distributions
 dvr_scan/docs/

MANIFEST.in

@@ -1,12 +1,11 @@
-recursive-exclude .github *
-recursive-exclude dist *
-recursive-exclude tests *
 exclude *
-recursive-include
 include dist/package-info.rst
 include dvr_scan/LICENSE
 recursive-include dvr_scan/docs
-include dvr-scan.cfg
+include dvr_scan/dvr-scan.cfg
+include dvr_scan/dvr-scan.ico
+include dvr_scan/dvr-scan.png
+include dvr_scan/dvr-scan-logo.png
 include LICENSE
 include pyproject.toml
 include README.md

dist/dvr-scan.spec

@@ -2,14 +2,13 @@
 
 block_cipher = None
 
-a = Analysis(['../dvr_scan/__main__.py'],
+cli = Analysis(['../dvr_scan/__main__.py'],
              pathex=['.'],
              binaries=None,
              datas=[
-                ('../dvr-scan.cfg', 'dvr-scan'),
-                ('../dist/dvr-scan.ico', 'dvr-scan'),
-                ('../dist/README.txt', 'dvr-scan'),
-                ('../dvr_scan/LICENSE*', 'dvr-scan'),
+                ('../dvr_scan/dvr-scan.ico', 'dvr_scan'),
+                ('../dvr_scan/dvr-scan-logo.png', 'dvr_scan'),
+                ('../dvr_scan/LICENSE*', 'dvr_scan'),
             ],
              hiddenimports=[],
              hookspath=[],
@@ -19,22 +18,24 @@ a = Analysis(['../dvr_scan/__main__.py'],
              win_private_assemblies=False,
              cipher=block_cipher)
 
-pyz = PYZ(a.pure, a.zipped_data,
+cli_pyz = PYZ(cli.pure, cli.zipped_data,
              cipher=block_cipher)
-exe = EXE(pyz,
-          a.scripts,
+
+cli_exe = EXE(cli_pyz,
+          cli.scripts,
           exclude_binaries=True,
           name='dvr-scan',
           debug=False,
           strip=False,
           upx=True,
           console=True,
           version='.version_info',
-          icon='dvr-scan.ico')
-coll = COLLECT(exe,
-               a.binaries,
-               a.zipfiles,
-               a.datas,
+          icon='../dvr_scan/dvr-scan.ico')
+
+coll = COLLECT(cli_exe,
+               cli.binaries,
+               cli.zipfiles,
+               cli.datas,
                strip=False,
                upx=True,
                name='dvr-scan')

dist/installer/DVR-Scan.aip

@@ -60,6 +60,7 @@
     <ROW Directory="LocalAppDataFolder" Directory_Parent="TARGETDIR" DefaultDir="LOCALA~1|LocalAppDataFolder" IsPseudoRoot="1"/>
     <ROW Directory="Mexico_Dir" Directory_Parent="tzdata_Dir" DefaultDir="Mexico"/>
     <ROW Directory="North_Dakota_Dir" Directory_Parent="America_Dir" DefaultDir="NORTH_~1|North_Dakota"/>
+    <ROW Directory="PIL_Dir" Directory_Parent="_internal_Dir" DefaultDir="PIL"/>
     <ROW Directory="Pacific_Dir" Directory_Parent="tzdata_Dir" DefaultDir="Pacific"/>
     <ROW Directory="SystemV_Dir" Directory_Parent="tzdata_Dir" DefaultDir="SystemV"/>
     <ROW Directory="TARGETDIR" DefaultDir="SourceDir"/>
@@ -72,6 +73,7 @@
     <ROW Directory="cv2_Dir" Directory_Parent="_internal_Dir" DefaultDir="cv2"/>
     <ROW Directory="data_Dir" Directory_Parent="cv2_Dir" DefaultDir="data"/>
     <ROW Directory="docs_Dir" Directory_Parent="APPDIR" DefaultDir="docs"/>
+    <ROW Directory="dvrscan_Dir" Directory_Parent="_internal_Dir" DefaultDir="dvr_scan"/>
     <ROW Directory="encoding_Dir" Directory_Parent="_tcl_data_Dir" DefaultDir="encoding"/>
     <ROW Directory="fft_Dir" Directory_Parent="numpy_Dir" DefaultDir="fft"/>
     <ROW Directory="gapi_Dir" Directory_Parent="cv2_Dir" DefaultDir="gapi"/>
@@ -120,7 +122,6 @@
     <ROW Component="Indianapolis" ComponentId="{8608A342-2888-4A1C-9EDD-7C5F3C8053E5}" Directory_="Indiana_Dir" Attributes="0" KeyPath="Indianapolis" Type="0"/>
     <ROW Component="LICENSE" ComponentId="{72CE02CB-34F8-4662-9A9D-CE17C62EFCE7}" Directory_="APPDIR" Attributes="0" KeyPath="LICENSE" Type="0"/>
     <ROW Component="LICENSEFFMPEG" ComponentId="{7FF009E0-E703-4184-A411-754BF36869CA}" Directory_="APPDIR" Attributes="0" KeyPath="LICENSEFFMPEG"/>
-    <ROW Component="LICENSETHIRDPARTY" ComponentId="{B83DCCDB-6E77-4561-A446-03035E5DA7C8}" Directory_="APPDIR" Attributes="0" KeyPath="LICENSETHIRDPARTY"/>
     <ROW Component="Longyearbyen" ComponentId="{E6D75BF6-A209-4CC1-8812-C3F531C7F159}" Directory_="Arctic_Dir" Attributes="0" KeyPath="Longyearbyen" Type="0"/>
     <ROW Component="Louisville" ComponentId="{2CF12F54-8910-4C81-99CA-C4CAA06F792C}" Directory_="Kentucky_Dir" Attributes="0" KeyPath="Louisville" Type="0"/>
     <ROW Component="ProductInformation" ComponentId="{C45D033C-5DD4-40D4-AABA-C6639AF83796}" Directory_="APPDIR" Attributes="4" KeyPath="Version"/>
@@ -131,6 +132,7 @@
     <ROW Component="__init__.py_2" ComponentId="{CC81E13B-98B6-4123-B58B-508564936E49}" Directory_="mat_wrapper_Dir" Attributes="0" KeyPath="__init__.py_2" Type="0"/>
     <ROW Component="__init__.py_3" ComponentId="{19547ADA-5843-4723-8981-D734D6E2C993}" Directory_="typing_Dir" Attributes="0" KeyPath="__init__.py_4" Type="0"/>
     <ROW Component="__init__.py_4" ComponentId="{5C768E9C-4B68-4767-B916-01019FE7E779}" Directory_="utils_Dir" Attributes="0" KeyPath="__init__.py_5" Type="0"/>
+    <ROW Component="_imaging.cp313win_amd64.pyd" ComponentId="{AE5F8B25-77F8-4A00-B377-383C04518134}" Directory_="PIL_Dir" Attributes="256" KeyPath="_imaging.cp313win_amd64.pyd" Type="0"/>
     <ROW Component="_multiarray_tests.cp313win_amd64.pyd" ComponentId="{1B5C3446-2796-4F07-9C5A-029986CA6FD2}" Directory_="_core_Dir" Attributes="256" KeyPath="_multiarray_tests.cp313win_amd64.pyd" Type="0"/>
     <ROW Component="_pocketfft_umath.cp313win_amd64.pyd" ComponentId="{F38BD11F-54AE-410A-ACF9-057065D807F7}" Directory_="fft_Dir" Attributes="256" KeyPath="_pocketfft_umath.cp313win_amd64.pyd" Type="0"/>
     <ROW Component="_umath_linalg.cp313win_amd64.pyd" ComponentId="{9DDB3DD3-4795-4C0B-BD3B-106E2EBADAE0}" Directory_="linalg_Dir" Attributes="256" KeyPath="_umath_linalg.cp313win_amd64.pyd" Type="0"/>
@@ -186,6 +188,7 @@
     <ROW Component="cs.msg" ComponentId="{F24A8C57-F6F8-447B-93DA-551D1537AEB6}" Directory_="msgs_1_Dir" Attributes="0" KeyPath="cs.msg_1" Type="0"/>
     <ROW Component="dvrscan.cfg" ComponentId="{18A37A49-86C6-42DF-A130-DC5499CD6677}" Directory_="DVRScan_Dir" Attributes="16" KeyPath="dvrscan.cfg_1" Type="0"/>
     <ROW Component="dvrscan.exe" ComponentId="{BFAC0A4B-76D6-4EF9-B2B5-DFB8B5AC8885}" Directory_="APPDIR" Attributes="256" KeyPath="dvrscan.exe"/>
+    <ROW Component="dvrscanlogo.png" ComponentId="{E99B7CDA-3F11-4A2A-8329-41CF25B01541}" Directory_="dvrscan_Dir" Attributes="0" KeyPath="dvrscanlogo.png_1" Type="0"/>
     <ROW Component="ffmpeg.exe" ComponentId="{BBCE1F27-65DC-461F-B81C-CF84ED2D7201}" Directory_="APPDIR" Attributes="256" KeyPath="ffmpeg.exe"/>
     <ROW Component="html" ComponentId="{4C35D225-4654-4A96-BABB-5A69EF7F4260}" Directory_="docs_Dir" Attributes="0" KeyPath="html" Type="0"/>
     <ROW Component="http.tcl" ComponentId="{10B85E89-AAB5-47BE-9CCA-FA767C015062}" Directory_="http1.0_Dir" Attributes="0" KeyPath="http.tcl" Type="0"/>
@@ -217,9 +220,7 @@
     <ROW File="dvrscan.exe" Component_="dvrscan.exe" FileName="dvr-scan.exe" Attributes="0" SourcePath="..\dvr-scan\dvr-scan.exe" SelfReg="false"/>
     <ROW File="LICENSE" Component_="LICENSE" FileName="LICENSE" Attributes="0" SourcePath="..\dvr-scan\LICENSE" SelfReg="false"/>
     <ROW File="LICENSEFFMPEG" Component_="LICENSEFFMPEG" FileName="LICENS~1|LICENSE-FFMPEG" Attributes="0" SourcePath="..\dvr-scan\LICENSE-FFMPEG" SelfReg="false"/>
-    <ROW File="LICENSETHIRDPARTY" Component_="LICENSETHIRDPARTY" FileName="LICENS~2|LICENSE-THIRDPARTY" Attributes="0" SourcePath="..\dvr-scan\LICENSE-THIRDPARTY" SelfReg="false"/>
     <ROW File="dvrscan.cfg" Component_="LICENSE" FileName="dvr-scan.cfg" Attributes="0" SourcePath="..\dvr-scan\dvr-scan.cfg" SelfReg="false"/>
-    <ROW File="dvrscan.ico" Component_="LICENSE" FileName="dvr-scan.ico" Attributes="0" SourcePath="..\dvr-scan\dvr-scan.ico" SelfReg="false"/>
     <ROW File="apimswincoreconsolel110.dll" Component_="apimswincoreconsolel110.dll" FileName="API-MS~1.DLL|api-ms-win-core-console-l1-1-0.dll" Attributes="0" SourcePath="..\dvr-scan\_internal\api-ms-win-core-console-l1-1-0.dll" SelfReg="false"/>
     <ROW File="apimswincoredatetimel110.dll" Component_="apimswincoredatetimel110.dll" FileName="API-MS~2.DLL|api-ms-win-core-datetime-l1-1-0.dll" Attributes="0" SourcePath="..\dvr-scan\_internal\api-ms-win-core-datetime-l1-1-0.dll" SelfReg="false"/>
     <ROW File="apimswincoredebugl110.dll" Component_="apimswincoredebugl110.dll" FileName="API-MS~3.DLL|api-ms-win-core-debug-l1-1-0.dll" Attributes="0" SourcePath="..\dvr-scan\_internal\api-ms-win-core-debug-l1-1-0.dll" SelfReg="false"/>
@@ -1246,12 +1247,18 @@
     <ROW File="palette.ecc896b0.min.css" Component_="main.eebd395e.min.css" FileName="PALETT~1.CSS|palette.ecc896b0.min.css" Attributes="0" SourcePath="..\dvr-scan\docs\assets\stylesheets\palette.ecc896b0.min.css" SelfReg="false"/>
     <ROW File="changelog.html" Component_="html" FileName="CHANGE~1.HTM|changelog.html" Attributes="0" SourcePath="..\dvr-scan\docs\changelog.html" SelfReg="false"/>
     <ROW File="docs.html" Component_="html" FileName="DOCS~1.HTM|docs.html" Attributes="0" SourcePath="..\dvr-scan\docs\docs.html" SelfReg="false"/>
-    <ROW File="download.html" Component_="html" FileName="DOWNLO~1.HTM|download.html" Attributes="0" SourcePath="..\dvr-scan\docs\download.html" SelfReg="false"/>
     <ROW File="faq.html" Component_="html" FileName="FAQ~1.HTM|faq.html" Attributes="0" SourcePath="..\dvr-scan\docs\faq.html" SelfReg="false"/>
     <ROW File="guide.html" Component_="html" FileName="GUIDE~1.HTM|guide.html" Attributes="0" SourcePath="..\dvr-scan\docs\guide.html" SelfReg="false"/>
     <ROW File="index.html" Component_="html" FileName="INDEX~1.HTM|index.html" Attributes="0" SourcePath="..\dvr-scan\docs\index.html" SelfReg="false"/>
     <ROW File="resources.html" Component_="html" FileName="RESOUR~1.HTM|resources.html" Attributes="0" SourcePath="..\dvr-scan\docs\resources.html" SelfReg="false"/>
     <ROW File="style.css" Component_="html" FileName="style.css" Attributes="0" SourcePath="..\dvr-scan\docs\style.css" SelfReg="false"/>
+    <ROW File="dvrscanlogo.png_1" Component_="dvrscanlogo.png" FileName="DVR-SC~1.PNG|dvr-scan-logo.png" Attributes="0" SourcePath="..\dvr-scan\_internal\dvr_scan\dvr-scan-logo.png" SelfReg="false"/>
+    <ROW File="dvrscan.ico" Component_="dvrscanlogo.png" FileName="dvr-scan.ico" Attributes="0" SourcePath="..\dvr-scan\_internal\dvr_scan\dvr-scan.ico" SelfReg="false"/>
+    <ROW File="_imaging.cp313win_amd64.pyd" Component_="_imaging.cp313win_amd64.pyd" FileName="_IMAGI~1.PYD|_imaging.cp313-win_amd64.pyd" Attributes="0" SourcePath="..\dvr-scan\_internal\PIL\_imaging.cp313-win_amd64.pyd" SelfReg="false"/>
+    <ROW File="_imagingcms.cp313win_amd64.pyd" Component_="_imaging.cp313win_amd64.pyd" FileName="_IMAGI~2.PYD|_imagingcms.cp313-win_amd64.pyd" Attributes="0" SourcePath="..\dvr-scan\_internal\PIL\_imagingcms.cp313-win_amd64.pyd" SelfReg="false"/>
+    <ROW File="_imagingmath.cp313win_amd64.pyd" Component_="_imaging.cp313win_amd64.pyd" FileName="_IMAGI~3.PYD|_imagingmath.cp313-win_amd64.pyd" Attributes="0" SourcePath="..\dvr-scan\_internal\PIL\_imagingmath.cp313-win_amd64.pyd" SelfReg="false"/>
+    <ROW File="_imagingtk.cp313win_amd64.pyd" Component_="_imaging.cp313win_amd64.pyd" FileName="_IMAGI~4.PYD|_imagingtk.cp313-win_amd64.pyd" Attributes="0" SourcePath="..\dvr-scan\_internal\PIL\_imagingtk.cp313-win_amd64.pyd" SelfReg="false"/>
+    <ROW File="_webp.cp313win_amd64.pyd" Component_="_imaging.cp313win_amd64.pyd" FileName="_WEBPC~1.PYD|_webp.cp313-win_amd64.pyd" Attributes="0" SourcePath="..\dvr-scan\_internal\PIL\_webp.cp313-win_amd64.pyd" SelfReg="false"/>
   </COMPONENT>
   <COMPONENT cid="caphyon.advinst.msicomp.AiPersistentDataComponent">
     <ROW PersistentRow="dvrscan.cfg_1" Type="0" Condition="1"/>
@@ -1485,7 +1492,6 @@
     <ROW Feature_="DVRScan" Component_="af.msg"/>
     <ROW Feature_="DVRScan" Component_="optparse.tcl"/>
     <ROW Feature_="DVRScan" Component_="Abidjan"/>
-    <ROW Feature_="DVRScan" Component_="LICENSETHIRDPARTY"/>
     <ROW Feature_="ffmpeg" Component_="LICENSEFFMPEG"/>
     <ROW Feature_="DVRScan" Component_="Adak"/>
     <ROW Feature_="DVRScan" Component_="Buenos_Aires"/>
@@ -1517,6 +1523,8 @@
     <ROW Feature_="DVRScan" Component_="boundingbox.gif"/>
     <ROW Feature_="DVRScan" Component_="bundle.220ee61c.min.js"/>
     <ROW Feature_="DVRScan" Component_="main.eebd395e.min.css"/>
+    <ROW Feature_="DVRScan" Component_="dvrscanlogo.png"/>
+    <ROW Feature_="DVRScan" Component_="_imaging.cp313win_amd64.pyd"/>
   </COMPONENT>
   <COMPONENT cid="caphyon.advinst.msicomp.MsiIconsComponent">
     <ROW Name="dvr_scan_icon.exe" SourcePath="dvr_scan_icon.ico" Index="0"/>

dist/post_release.py

@@ -14,6 +14,7 @@
 import glob
 import os
 import shutil
+from pathlib import Path
 
 
 def finalize_exe_distribution():
@@ -29,17 +30,17 @@ def finalize_exe_distribution():
         "imageio_ffmpeg",
         "importlib_metadata-*.dist-info",
         "matplotlib",
-        "PIL",
         "PyQt5",
         "pip-*.dist-info",
         "psutil",
         "pyinstaller-*.dist-info",
         "setuptools-*.dist-info",
         "tcl8",
+        "pywin32_system32",
         "wheel-*.dist-info",
+        "win32",
         "wx",
     ]
-
     FILE_GLOBS = [
         "_bz2.pyd",
         "_decimal.pyd",
@@ -66,13 +67,15 @@ def finalize_exe_distribution():
         for file_path in glob.glob(os.path.join(BASE_PATH, file_glob)):
             os.remove(file_path)
 
-    # Collect self dependencies.
-    # TODO: See if the following can be added to COLLECT instead of including
-    # these files as part of the .spec file Analysis step.
-    for f in glob.glob(os.path.join(BASE_PATH, "dvr-scan/*")):
-        shutil.move(f, DIST_PATH)
-    os.rmdir(os.path.join(BASE_PATH, "dvr-scan"))
-    shutil.copytree("dvr_scan/docs", "dist/dvr-scan/docs", dirs_exist_ok=True)
+    shutil.copytree("dvr_scan/docs", Path(DIST_PATH).joinpath("docs"), dirs_exist_ok=True)
+
+    EXE_ASSETS = [
+        "dist/README.txt",
+        "dvr_scan/LICENSE",
+        "dvr-scan.cfg",
+    ]
+    for asset in EXE_ASSETS:
+        shutil.copy(asset, DIST_PATH)
 
 
 if __name__ == "__main__":

dist/pre_release.py

@@ -91,6 +91,7 @@ def build_docs(use_local_images=True):
         index_path = tmp.joinpath("docs", "index.md")
         new_index = tmp.joinpath("docs", "index_docs.md")
         new_index.replace(index_path)
+        tmp.joinpath("docs", "download.md").unlink()
 
         mkdocs_path = tmp.joinpath("mkdocs.yml")
         curr_mkdocs_path = tmp.joinpath("docs", "mkdocs.yml")
@@ -143,6 +144,7 @@ def build_docs(use_local_images=True):
                 docs_build_path.joinpath(path).unlink(missing_ok=False)
 
         for to_remove in (
+            "requirements.txt",
             "sitemap.xml",
             "sitemap.xml.gz",
             "assets/images",
@@ -170,5 +172,9 @@ def remove_mapping():
 
 
 if __name__ == "__main__":
+    if not (len(sys.argv) == 1 or (len(sys.argv) == 2 and sys.argv[1] == "--use-local-images")):
+        print("Usage: pre_release.py [--use-local-images]")
+        raise SystemExit(1)
+
     write_version_info_for_windows_exe()
     build_docs(use_local_images=bool(len(sys.argv) == 2 and sys.argv[1] == "--use-local-images"))

dist/requirements_windows.txt

@@ -4,6 +4,7 @@
 numpy
 opencv-python==4.10.0.84
 opencv-contrib-python==4.10.0.84
+pillow
 platformdirs
 pyinstaller>=6.0
 pytest

docs/changelog.md

@@ -3,14 +3,15 @@
 
 ----------------------------------------------------------
 
-## DVR-Scan 1.7
+## DVR-Scan 1.6
 
-### 1.7 (In Development)
+### 1.6.2 (In Development)
 
  - [general] Add new `variance-threshold` [config option](https://www.dvr-scan.com/docs/#config-file) to control how MOG2 controls which pixels are described by the current background model [#163](https://github.com/Breakthrough/DVR-Scan/issues/163)
-
-
-## DVR-Scan 1.6
+ - [feature] Rework region editor to provide more consistent experience across all platforms
+    - The region editor is now much more usable and has UI controls in addition to keyboard shortcuts
+    - System-specific shortcuts like undo/redo now work as expected
+    - Various performance and usability improvements including zoom/pan and shape selection
 
 ### 1.6.1 (May 18, 2024)
 

dvr_scan/__init__.py

@@ -31,7 +31,6 @@
   ``platform``: library/platform specific helpers
 """
 
-import os
 import pkgutil
 import sys
 
@@ -46,32 +45,11 @@
 
 def get_license_info() -> str:
     """Get license/copyright information for the package or standalone executable."""
-    try:
-        # If we're running a frozen/standalone executable distribution, make sure we include
-        # the license information for the third-party components we redistribute.
-        if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
-            app_folder = os.path.abspath(os.path.dirname(sys.executable))
-            license_files = ["LICENSE", "LICENSE-THIRDPARTY"]
-            license_text = "\n".join(
-                [
-                    open(os.path.join(app_folder, license_file), "rb")
-                    .read()
-                    .decode("ascii", "ignore")
-                    for license_file in license_files
-                ]
-            )
-        # Use the LICENSE file included with the package distribution.
-        else:
-            license_text = pkgutil.get_data(__name__, "LICENSE").decode("ascii", "ignore")
-        return license_text
-    # During development this is normal since the package paths won't be correct.
-    except FileNotFoundError:
-        pass
-    return (
-        "[DVR-Scan] Error: Missing LICENSE files.\n"
-        "See the following URL for license/copyright information:\n"
-        " < https://www.dvr-scan.com/resources >\n"
-    )
+    license_text = pkgutil.get_data(__name__, "LICENSE").decode()
+    # Include additional third-party license text if they were bundled into this release.
+    if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
+        license_text += pkgutil.get_data(__name__, "LICENSE-THIRDPARTY").decode()
+    return license_text
 
 
 # Initialize logger.

dvr_scan/__main__.py

@@ -33,6 +33,7 @@ def main():
         sys.exit(EXIT_ERROR)
     logger = logging.getLogger("dvr_scan")
     redirect = FakeTqdmLoggingRedirect if settings.get("quiet-mode") else logging_redirect_tqdm
+    # TODO: Use Python __debug__ mode instead of hard-coding as config option.
     debug_mode = settings.get("debug")
     show_traceback = getattr(logging, settings.get("verbosity").upper()) == logging.DEBUG
     with redirect(loggers=[logger]):
@@ -47,6 +48,7 @@ def main():
             if debug_mode:
                 raise
         except KeyboardInterrupt:
+            # TODO: This doesn't always work when the GUI is running.
             logger.info("Stopping (interrupt received)...", exc_info=show_traceback)
             if debug_mode:
                 raise