[dist] Prepare for v0.6.4 release.

Author: Breakthrough

appveyor.yml

@@ -46,6 +46,7 @@ install:
   - echo * *                          BUILDING WINDOWS EXE                           * *
   - echo * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
   # Build Windows .EXE and create portable .ZIP
+  - python dist/pre_release.py
   - pyinstaller dist/scenedetect.spec
   - sphinx-build -b singlehtml docs dist/scenedetect/docs
   - mkdir dist\scenedetect\thirdparty
@@ -68,7 +69,7 @@ install:
   - appveyor-tools\secure-file -decrypt license65.dat.enc -secret %ai_license_secret% -salt %ai_license_salt%
   - appveyor DownloadFile https://www.advancedinstaller.com/downloads/advinst.msi
   - msiexec /i advinst.msi /qn
-  - 'SET PATH=%PATH%;C:\\Program Files (x86)\\Caphyon\\Advanced Installer 21.5\\bin\\x86'
+  - 'SET PATH=%PATH%;C:\\Program Files (x86)\\Caphyon\\Advanced Installer 21.8.1\\bin\\x86'
   # License path must be absolute
   - AdvancedInstaller.com /RegisterOffline "%cd%\license65.dat"
   # Create MSI installer

dist/.version_info renamed to dist/pre_release.py

@@ -1,15 +1,40 @@
-# UTF-8
-#
-# TODO: Generate this using Python.
+# -*- coding: utf-8 -*-
+import os
+import sys
+import xml
+sys.path.append(os.path.abspath("."))
+
+import scenedetect
+VERSION = scenedetect.__version__
+
+
+installer_aip = ''
+with open("dist/installer/PySceneDetect.aip", "r") as f:
+  installer_aip = f.read()
+
+aip_version = f"<ROW Property=\"ProductVersion\" Value=\"{VERSION}\" Options=\"32\"/>"
+
+assert aip_version in installer_aip, f"Installer project version does not match {VERSION}."
+
+with open("dist/.version_info", "wb") as f:
+    v = VERSION.split(".")
+    assert 2 <= len(v) <= 3, f"Unrecognized version format: {VERSION}"
+
+    if len(v) == 3:
+        (maj, min, pat) = int(v[0]), int(v[1]), int(v[2])
+    else:
+        (maj, min, pat) = int(v[0]), int(v[1]), 0
+
+    f.write(f"""# UTF-8
 #
 # For more details about fixed file info 'ffi' see:
 # http://msdn.microsoft.com/en-us/library/ms646997.aspx
 VSVersionInfo(
   ffi=FixedFileInfo(
 # filevers and prodvers should be always a tuple with four items: (1, 2, 3, 4)
 # Set not needed items to zero 0.
-filevers=(0, 6, 3, 0),
-prodvers=(0, 6, 3, 0),
+filevers=(0, {maj}, {min}, {pat}),
+prodvers=(0, {maj}, {min}, {pat}),
 # Contains a bitmask that specifies the valid bits 'flags'r
 mask=0x3f,
 # Contains a bitmask that specifies the Boolean attributes of the file.
@@ -33,13 +58,14 @@
     u'040904B0',
     [StringStruct(u'CompanyName', u'github.com/Breakthrough'),
     StringStruct(u'FileDescription', u'www.scenedetect.com'),
-    StringStruct(u'FileVersion', u'v0.6.3'),
+    StringStruct(u'FileVersion', u'{VERSION}'),
     StringStruct(u'InternalName', u'PySceneDetect'),
     StringStruct(u'LegalCopyright', u'Copyright © 2024 Brandon Castellano'),
     StringStruct(u'OriginalFilename', u'scenedetect.exe'),
     StringStruct(u'ProductName', u'PySceneDetect'),
-    StringStruct(u'ProductVersion', u'v0.6.3')])
+    StringStruct(u'ProductVersion', u'{VERSION}')])
   ]),
 VarFileInfo([VarStruct(u'Translation', [1033, 1200])])
   ]
 )
+""".encode())

scenedetect.cfg

@@ -119,8 +119,8 @@
 
 
 [detect-hash]
-# Threshold value from 0.0 and 1.0 representing the normalized difference between
-# perceptual hashes that is required to trigger a shot change.
+# Threshold between 0.0 and 1.0 to set the relative difference between
+# hashes required to trigger a shot change. Lower values are more sensitive.
 #threshold = 0.395
 
 # The ratio between 1 and 256 of how much low frequency information to keep.
@@ -137,11 +137,10 @@
 
 
 [detect-hist]
-# Threshold value from 0.0 to 1.0 representing the difference between Y channel
-# histograms after frame is converted to YUV. Values closer to 1.0 require higher
-# correlation (more similar to current frame), while lower values allow lower
-# correlation (higher difference between current frame).
-#threshold = 0.95
+# Threshold between 0.0 to 1.0 to set the relative difference between Y
+# channel histograms (YUV) required to trigger a shot change. Lower values
+# are more sensitive.
+#threshold = 0.05
 
 # Number of bins between 1 and 256 to use for the histogram.
 #bins = 256

scenedetect/__init__.py

@@ -47,7 +47,7 @@
 
 # Used for module identification and when printing version & about info
 # (e.g. calling `scenedetect version` or `scenedetect about`).
-__version__ = '0.7-dev0'
+__version__ = '0.6.4'
 
 init_logger()
 logger = getLogger('pyscenedetect')

scenedetect/_cli/__init__.py

@@ -155,8 +155,8 @@ def _print_command_help(ctx: click.Context, command: click.Command):
     invoke_without_command=True,
     epilog="""Type "scenedetect [command] --help" for command usage. See https://scenedetect.com/docs/ for online docs."""
 )
-# We cannot make this a required argument otherwise we will reject commands of the form
-# `scenedetect help detect-content` or `scenedetect detect-content --help`.
+# *NOTE*: Although input is required, we cannot mark it as `required=True`, otherwise we will reject
+# commands of the form `scenedetect detect-content --help`.
 @click.option(
     '--input',
     '-i',
@@ -767,7 +767,7 @@ def detect_hist_command(ctx: click.Context, threshold: Optional[float], bins: Op
 
     {scenedetect_with_video} detect-hist
 
-    {scenedetect_with_video} detect-hist --threshold 0.8 --size 64 --lowpass 3
+    {scenedetect_with_video} detect-hist --threshold 0.1 --bins 240
     """
     assert isinstance(ctx.obj, CliContext)
 
@@ -800,13 +800,13 @@ def detect_hist_command(ctx: click.Context, threshold: Optional[float], bins: Op
     (USER_CONFIG.get_help_string("detect-hash", "size")))
 @click.option(
     "--lowpass",
-    "-h",
+    "-l",
     metavar="FRAC",
     type=click.IntRange(CONFIG_MAP["detect-hash"]["lowpass"].min_val,
                         CONFIG_MAP["detect-hash"]["lowpass"].max_val),
     default=None,
     help=("How much high frequency information to filter from the DCT. 2 means keep lower 1/2 of "
-          "the frequency data, 4 means only keep 1/4, etc....%s" %
+          "the frequency data, 4 means only keep 1/4, etc...%s" %
           (USER_CONFIG.get_help_string("detect-hash", "lowpass"))))
 @click.option(
     "--min-scene-len",
@@ -817,7 +817,7 @@ def detect_hist_command(ctx: click.Context, threshold: Optional[float], bins: Op
     help="Minimum length of any scene. Overrides global min-scene-len (-m) setting."
     " TIMECODE can be specified as exact number of frames, a time in seconds followed by s,"
     " or a timecode in the format HH:MM:SS or HH:MM:SS.nnn.%s" %
-    ("" if USER_CONFIG.is_default("detect-hist", "min-scene-len") else USER_CONFIG.get_help_string(
+    ("" if USER_CONFIG.is_default("detect-hash", "min-scene-len") else USER_CONFIG.get_help_string(
         "detect-hash", "min-scene-len")))
 @click.pass_context
 def detect_hash_command(ctx: click.Context, threshold: Optional[float], size: Optional[int],