Merge branch 'main' into add-backend-test

Author: Breakthrough

.github/workflows/build.yml

@@ -26,21 +26,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-13, macos-14, ubuntu-22.04, ubuntu-latest, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
-        exclude:
-          # macos-14 builders use M1 (ARM64) which does not have a Python 3.7 package available.
-          - os: macos-14
-            python-version: "3.7"
-          # ubuntu 24+ does not have Python 3.7
-          - os: ubuntu-latest
-            python-version: "3.7"
-
+        os: [macos-14, macos-latest, ubuntu-22.04, ubuntu-latest, windows-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
     env:
       # Version is extracted below and used to find correct package install path.
       scenedetect_version: ""
-      # Setuptools must be pinned for the Python 3.7 builders.
-      setuptools_version: "${{ matrix.python-version == '3.7' && '==62.3.4' || '' }}"
 
     steps:
       - uses: actions/checkout@v4
@@ -61,7 +51,7 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          python -m pip install --upgrade pip build wheel virtualenv setuptools${{ env.setuptools_version }}
+          python -m pip install --upgrade pip build wheel virtualenv setuptools
           pip install -r requirements_headless.txt --only-binary av,opencv-python-headless
 
       - name: Install MoviePy

.github/workflows/generate-docs.yml

@@ -16,7 +16,7 @@ jobs:
     env:
       # TODO: Figure out a better way to handle figuring out what version /latest should be,
       # e.g. add a latest version file in main.
-      scenedetect_docs_latest: '0.6.6'
+      scenedetect_docs_latest: '0.6.7'
       scenedetect_docs_dest: ''
 
     steps:

.github/workflows/publish-pypi.yml

@@ -0,0 +1,119 @@
+name: Publish PyPI Package
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag To Publish'
+        required: true
+      environment:
+        description: 'PyPI Environment'
+        required: true
+        type: choice
+        options:
+          - test
+          - release
+        default: 'test'
+
+jobs:
+  verify:
+    name: Verify Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check workflows
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const { owner, repo } = context.repo;
+            const tag = "${{ github.event.inputs.tag }}";
+            const requiredWorkflows = ['Windows Distribution', 'Python Distribution'];
+            let workflowConclusions = {};
+
+            console.log(`Checking for successful workflow runs for tag: ${tag}`);
+
+            const { data: response } = await github.rest.actions.listWorkflowRunsForRepo({
+              owner,
+              repo,
+              event: 'push',
+            });
+
+            const runsForTag = response.workflow_runs.filter(run => run.head_branch === tag);
+
+            for (const run of runsForTag) {
+              if (requiredWorkflows.includes(run.name)) {
+                if (!workflowConclusions[run.name] || new Date(run.created_at) > new Date(workflowConclusions[run.name].created_at)) {
+                  workflowConclusions[run.name] = {
+                    conclusion: run.conclusion,
+                    created_at: run.created_at,
+                    html_url: run.html_url,
+                  };
+                }
+              }
+            }
+
+            let allSuccess = true;
+            for (const workflowName of requiredWorkflows) {
+              if (!workflowConclusions[workflowName]) {
+                core.setFailed(`Workflow "${workflowName}" was not found for tag ${tag}.`);
+                allSuccess = false;
+              } else if (workflowConclusions[workflowName].conclusion !== 'success') {
+                core.setFailed(`Workflow "${workflowName}" did not succeed for tag ${tag}. Conclusion was "${workflowConclusions[workflowName].conclusion}". See: ${workflowConclusions[workflowName].html_url}`);
+                allSuccess = false;
+              } else {
+                console.log(`✅ Workflow "${workflowName}" succeeded for tag ${tag}.`);
+              }
+            }
+
+            if (!allSuccess) {
+              throw new Error("One or more required build workflows did not succeed.");
+            }
+
+  publish:
+    name: Building and Publishing to ${{ github.event.inputs.environment }} PyPI
+    runs-on: ubuntu-latest
+    needs: verify
+
+    environment:
+      name: ${{ github.event.inputs.environment == 'test' && 'test' || 'release' }}
+      url: ${{ github.event.inputs.environment == 'test' && 'https://test.pypi.org/p/scenedetect' || 'https://pypi.org/p/scenedetect' }}
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Checkout ${{ github.event.inputs.tag }}
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.inputs.tag }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.x"
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build Package
+        run: |
+          python -m build
+          mkdir pkg
+          mv dist/*.tar.gz pkg/
+          mv dist/*.whl pkg/
+
+      - name: Upload Package
+        uses: actions/upload-artifact@v4
+        with:
+          name: scenedetect-dist
+          path: |
+            pkg/*.tar.gz
+            pkg/*.whl
+
+      - name: Publish Package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: ${{ github.event.inputs.environment == 'test' && 'https://test.pypi.org/legacy/' || 'https://upload.pypi.org/legacy/' }}
+          packages-dir: pkg/
+          print-hash: true

README.md

@@ -11,7 +11,7 @@ Video Cut Detection and Analysis Tool
 
 ----------------------------------------------------------
 
-### Latest Release: v0.6.6 (March 9, 2025)
+### Latest Release: v0.6.7 (August 24, 2025)
 
 **Website**:  [scenedetect.com](https://www.scenedetect.com)
 
@@ -66,8 +66,8 @@ scene_list = detect('my_video.mp4', ContentDetector())
 for i, scene in enumerate(scene_list):
     print('    Scene %2d: Start %s / Frame %d, End %s / Frame %d' % (
         i+1,
-        scene[0].get_timecode(), scene[0].get_frames(),
-        scene[1].get_timecode(), scene[1].get_frames(),))
+        scene[0].get_timecode(), scene[0].frame_num,
+        scene[1].get_timecode(), scene[1].frame_num,))
 ```
 
 We can also split the video into each scene if `ffmpeg` is installed (`mkvmerge` is also supported):

appveyor.yml

@@ -20,6 +20,7 @@ environment:
     secure: of3o1pInqCJYwKLFsiadbsRYazCmCuZq7r2roaYvYXmBvm6e6JHsRU47waylTmhm
   ai_license_salt:
     secure: +NKWwlkEptlThgfeL35pLo7EsnkJc+4WODm8tTg1aO5fc0duQ4r100fHQYj6nzhyUdy3Dhs/mOLkxD8rNbBiEQ==
+  ffmpeg_version: "8.0"
 
 # SignPath Config for Code Signing
 deploy:
@@ -41,8 +42,8 @@ install:
   - python -m pip install --upgrade -r dist/requirements_windows.txt --no-binary imageio-ffmpeg
   # Checkout build resources and third party software used for testing.
   - git checkout refs/remotes/origin/resources -- dist/
-  - appveyor DownloadFile https://github.com/GyanD/codexffmpeg/releases/download/7.1/ffmpeg-7.1-full_build.7z
-  - 7z e ffmpeg-7.1-full_build.7z -odist/ffmpeg ffmpeg.exe LICENSE -r
+  - appveyor DownloadFile https://github.com/GyanD/codexffmpeg/releases/download/%ffmpeg_version%/ffmpeg-%ffmpeg_version%-full_build.7z
+  - 7z e ffmpeg-%ffmpeg_version%-full_build.7z -odist/ffmpeg ffmpeg.exe LICENSE -r
   - 'SET IMAGEIO_FFMPEG_EXE=%APPVEYOR_BUILD_FOLDER%\\dist\\ffmpeg\\ffmpeg.exe'
 
   - echo * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
@@ -72,7 +73,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 22.5\\bin\\x86'
+  - 'SET PATH=%PATH%;C:\\Program Files (x86)\\Caphyon\\Advanced Installer 22.9.1\\bin\\x86'
   # License path must be absolute
   - AdvancedInstaller.com /RegisterOffline "%cd%\license65.dat"
   # Create MSI installer
@@ -98,7 +99,9 @@ test_script:
   - git checkout refs/remotes/origin/resources -- tests/resources/
   - move dist\scenedetect\ffmpeg.exe ffmpeg.exe
   # Run unit tests
-  - pytest
+  # TODO: We are at the new build time limit for this plan apparently, 10 mins. Figure out a
+  # strategy to deal with that (see if we can use Github as a builder?).
+  # - pytest
   # Test Windows build
   - move ffmpeg.exe dist\scenedetect\ffmpeg.exe
   - cd dist/scenedetect

dist/installer/PySceneDetect.aip

@@ -23,10 +23,10 @@
     <ROW Property="DialogBitmap" Value="dialog.jpg" MultiBuildValue="DefaultBuild:installer_logo.jpg" Type="1" MsiKey="DialogBitmap"/>
     <ROW Property="MSIFASTINSTALL" MultiBuildValue="DefaultBuild:3"/>
     <ROW Property="Manufacturer" Value="Brandon Castellano"/>
-    <ROW Property="ProductCode" Value="1033:{5F017601-DFDD-4381-A35F-79634ED91632} " Type="16"/>
+    <ROW Property="ProductCode" Value="1033:{AA389A8A-489B-403A-9EF6-B8AF31DE1D0D} " Type="16"/>
     <ROW Property="ProductLanguage" Value="1033"/>
     <ROW Property="ProductName" Value="PySceneDetect"/>
-    <ROW Property="ProductVersion" Value="0.6.6" Options="32"/>
+    <ROW Property="ProductVersion" Value="0.6.7" Options="32"/>
     <ROW Property="SecureCustomProperties" Value="OLDPRODUCTS;AI_NEWERPRODUCTFOUND;AI_SETUPEXEPATH;SETUPEXEDIR"/>
     <ROW Property="UpgradeCode" Value="{D0AF0419-DBD5-455C-A4AC-4518A35DD23E}"/>
     <ROW Property="WindowsType9X" MultiBuildValue="DefaultBuild:Windows 9x/ME" ValueLocId="-"/>
@@ -125,7 +125,7 @@
     <ROW Directory="wheel0.45.1.distinfo_Dir" Directory_Parent="_internal_Dir" DefaultDir="WHEEL-~1.DIS|wheel-0.45.1.dist-info"/>
   </COMPONENT>
   <COMPONENT cid="caphyon.advinst.msicomp.SideBySideGuidComponent">
-    <ROW Component="AI_CustomARPName" Value="{F7C45B12-D093-4D1A-96D3-9D79D73D8DD1}"/>
+    <ROW Component="AI_CustomARPName" Value="{1EE8167C-7E52-48AD-9053-BD9A132F2918}"/>
     <ROW Component="AI_DisableModify" Value="{5AB8A335-BCAB-4C0A-8A69-E2AE7542AB47}"/>
     <ROW Component="AI_ExePath" Value="{F7DEDE0C-FDB1-411C-B347-A482CE69721F}"/>
     <ROW Component="APPDIR" Value="{6B122BDD-2BF8-41D4-92E0-884DD60467B4}"/>
@@ -366,7 +366,6 @@
     <ROW Component="context.cp313win_amd64.pyd" ComponentId="{3F46B25C-6AF9-4049-A39B-9211FFF611B2}" Directory_="filter_Dir" Attributes="256" KeyPath="context.cp313win_amd64.pyd_1" Type="0"/>
     <ROW Component="core.cp313win_amd64.pyd" ComponentId="{239884C9-D5A8-4EAC-BB80-98940D72772E}" Directory_="container_Dir" Attributes="256" KeyPath="core.cp313win_amd64.pyd" Type="0"/>
     <ROW Component="cs.msg" ComponentId="{CA47D90F-CA31-4D5E-8EB4-2BE8724900E9}" Directory_="msgs_1_Dir" Attributes="0" KeyPath="cs.msg_1" Type="0"/>
-    <ROW Component="entry_points.txt" ComponentId="{E6C2334A-40CF-4B41-B7E9-ECC421D6A28A}" Directory_="wheel0.45.1.distinfo_Dir" Attributes="0" KeyPath="entry_points.txt_1" Type="0"/>
     <ROW Component="ffmpeg.exe" ComponentId="{B7CA4B2A-DE88-42CD-AD38-AC30FD29D506}" Directory_="APPDIR" Attributes="256" KeyPath="ffmpeg.exe"/>
     <ROW Component="http.tcl" ComponentId="{E68A9C81-9D27-40F2-88A7-4B2CF7388062}" Directory_="http1.0_Dir" Attributes="0" KeyPath="http.tcl" Type="0"/>
     <ROW Component="http2.9.8.tm" ComponentId="{80BA6FC3-9CCC-4A73-8673-F6C6BC2106B5}" Directory_="__2_Dir" Attributes="0" KeyPath="http2.9.8.tm" Type="0"/>
@@ -639,13 +638,6 @@
     <ROW File="unicodedata.pyd" Component_="base_library.zip" FileName="UNICOD~1.PYD|unicodedata.pyd" Attributes="0" SourcePath="..\scenedetect\_internal\unicodedata.pyd" SelfReg="false"/>
     <ROW File="VCRUNTIME140.dll" Component_="VCRUNTIME140.dll" FileName="VCRUNT~1.DLL|VCRUNTIME140.dll" Attributes="0" SourcePath="..\scenedetect\_internal\VCRUNTIME140.dll" SelfReg="false"/>
     <ROW File="VCRUNTIME140_1.dll" Component_="VCRUNTIME140_1.dll" FileName="VCRUNT~2.DLL|VCRUNTIME140_1.dll" Attributes="0" SourcePath="..\scenedetect\_internal\VCRUNTIME140_1.dll" SelfReg="false"/>
-    <ROW File="entry_points.txt_1" Component_="entry_points.txt" FileName="ENTRY_~1.TXT|entry_points.txt" Attributes="0" SourcePath="..\scenedetect\_internal\wheel-0.45.1.dist-info\entry_points.txt" SelfReg="false"/>
-    <ROW File="INSTALLER_2" Component_="entry_points.txt" FileName="INSTAL~1|INSTALLER" Attributes="0" SourcePath="..\scenedetect\_internal\wheel-0.45.1.dist-info\INSTALLER" SelfReg="false"/>
-    <ROW File="LICENSE.txt_1" Component_="entry_points.txt" FileName="LICENSE.txt" Attributes="0" SourcePath="..\scenedetect\_internal\wheel-0.45.1.dist-info\LICENSE.txt" SelfReg="false"/>
-    <ROW File="METADATA_2" Component_="entry_points.txt" FileName="METADATA" Attributes="0" SourcePath="..\scenedetect\_internal\wheel-0.45.1.dist-info\METADATA" SelfReg="false"/>
-    <ROW File="RECORD_2" Component_="entry_points.txt" FileName="RECORD" Attributes="0" SourcePath="..\scenedetect\_internal\wheel-0.45.1.dist-info\RECORD" SelfReg="false"/>
-    <ROW File="REQUESTED_2" Component_="entry_points.txt" FileName="REQUES~1|REQUESTED" Attributes="0" SourcePath="..\scenedetect\_internal\wheel-0.45.1.dist-info\REQUESTED" SelfReg="false"/>
-    <ROW File="WHEEL_2" Component_="entry_points.txt" FileName="WHEEL" Attributes="0" SourcePath="..\scenedetect\_internal\wheel-0.45.1.dist-info\WHEEL" SelfReg="false"/>
     <ROW File="zlib1.dll" Component_="zlib1.dll" FileName="zlib1.dll" Attributes="0" SourcePath="..\scenedetect\_internal\zlib1.dll" SelfReg="false"/>
     <ROW File="_asyncio.pyd" Component_="base_library.zip" FileName="_asyncio.pyd" Attributes="0" SourcePath="..\scenedetect\_internal\_asyncio.pyd" SelfReg="false"/>
     <ROW File="_bz2.pyd" Component_="base_library.zip" FileName="_bz2.pyd" Attributes="0" SourcePath="..\scenedetect\_internal\_bz2.pyd" SelfReg="false"/>
@@ -1642,7 +1634,7 @@
     <ROW Action="AI_CleanPrePrereq" Condition="AI_BOOTSTRAPPER AND (NOT AI_PrereqsFulfilled)" Sequence="699"/>
   </COMPONENT>
   <COMPONENT cid="caphyon.advinst.msicomp.BuildComponent">
-    <ROW BuildKey="DefaultBuild" BuildName="DefaultBuild" BuildOrder="1" BuildType="0" PackageFolder="." PackageFileName="PySceneDetect-0.6.6-win64" Languages="en" InstallationType="4" ExtUI="true" UseLargeSchema="true" MsiPackageType="x64"/>
+    <ROW BuildKey="DefaultBuild" BuildName="DefaultBuild" BuildOrder="1" BuildType="0" PackageFolder="." PackageFileName="PySceneDetect-0.6.7-win64" Languages="en" InstallationType="4" ExtUI="true" UseLargeSchema="true" MsiPackageType="x64"/>
   </COMPONENT>
   <COMPONENT cid="caphyon.advinst.msicomp.DictionaryComponent">
     <ROW Path="&lt;AI_DICTS&gt;ui.ail"/>
@@ -1897,7 +1889,6 @@
     <ROW Feature_="PySceneDetect" Component_="ucrtbase.dll"/>
     <ROW Feature_="PySceneDetect" Component_="VCRUNTIME140.dll"/>
     <ROW Feature_="PySceneDetect" Component_="VCRUNTIME140_1.dll"/>
-    <ROW Feature_="PySceneDetect" Component_="entry_points.txt"/>
     <ROW Feature_="PySceneDetect" Component_="zlib1.dll"/>
     <ROW Feature_="PySceneDetect" Component_="auto.tcl"/>
     <ROW Feature_="PySceneDetect" Component_="ascii.enc"/>

docs/cli.rst

@@ -178,11 +178,7 @@ Options
 
   Default: ``15.0``
 
-.. option:: -d VAL, --min-delta-hsv VAL
 
-  [DEPRECATED] Use :option:`-c/--min-content-val <-c>` instead.
-
-  Default: ``15.0``
 
 .. option:: -f VAL, --frame-window VAL
 

requirements.txt

@@ -2,7 +2,8 @@
 # PySceneDetect Requirements
 #
 av>=9.2
-click>=8.0
+# click 8.3.0 is excluded as per https://scenedetect.com/issues/521
+click~=8.0,<8.3.0
 numpy
 opencv-python
 platformdirs

requirements_headless.txt

@@ -2,7 +2,8 @@
 # PySceneDetect Requirements for Headless Machines
 #
 av>=9.2
-click>=8.0
+# click 8.3.0 is excluded as per https://scenedetect.com/issues/521
+click~=8.0,<8.3.0
 numpy
 opencv-python-headless
 platformdirs

scenedetect/_cli/__init__.py

@@ -615,16 +615,6 @@ def detect_content_command(
     help='Minimum threshold (float) that "content_val" must exceed to trigger a cut.%s'
     % (USER_CONFIG.get_help_string("detect-adaptive", "min-content-val")),
 )
-@click.option(
-    "--min-delta-hsv",
-    "-d",
-    metavar="VAL",
-    type=click.FLOAT,
-    default=None,
-    help="[DEPRECATED] Use -c/--min-content-val instead.%s"
-    % (USER_CONFIG.get_help_string("detect-adaptive", "min-delta-hsv")),
-    hidden=True,
-)
 @click.option(
     "--frame-window",
     "-f",
@@ -677,7 +667,6 @@ def detect_adaptive_command(
     ctx: click.Context,
     threshold: ty.Optional[float],
     min_content_val: ty.Optional[float],
-    min_delta_hsv: ty.Optional[float],
     frame_window: ty.Optional[int],
     weights: ty.Optional[ty.Tuple[float, float, float, float]],
     luma_only: bool,
@@ -689,7 +678,6 @@ def detect_adaptive_command(
     detector_args = ctx.get_detect_adaptive_params(
         threshold=threshold,
         min_content_val=min_content_val,
-        min_delta_hsv=min_delta_hsv,
         frame_window=frame_window,
         luma_only=luma_only,
         min_scene_len=min_scene_len,