Breakthrough · Jun 26, 2024 · May 11, 2024 · May 26, 2024 · May 26, 2024 · Jun 9, 2024
diff --git a/.github/workflows/build-windows.yml b/.github/workflows/build-windows.yml
@@ -67,11 +67,13 @@ jobs:
 
       - name: Build PySceneDetect
         run: |
+          python dist/pre_release.py --ignore-installer
           pyinstaller dist/scenedetect.spec
 
       - name: Build Documentation
         run: |
           sphinx-build -b singlehtml docs dist/scenedetect/docs
+          rm -r dist/scenedetect/docs/.doctrees
 
       - name: Assemble Portable Distribution
         run: |

diff --git a/.github/workflows/generate-docs.yml b/.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.3'
+      scenedetect_docs_latest: '0.6.4'
       scenedetect_docs_dest: ''
 
     steps:

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,12 @@
+cff-version: 1.2.0
+title: PySceneDetect
+message: www.scenedetect.com
+type: software
+authors:
+  - given-names: Brandon
+    family-names: Castellano
+    affiliation: www.bcastell.com
+repository-code: 'https://github.com/Breakthrough/PySceneDetect'
+url: 'https://www.scenedetect.com'
+abstract: Video Cut Detection and Analysis Tool
+license: BSD-3-Clause
diff --git a/LICENSE b/LICENSE
@@ -1,103 +1,28 @@
-By downloading, copying, installing, or using this software, you agree
-to the terms of this license, and those contained in the "Ancillary
-Software Licenses" section below. If you do not agree to any of these
-terms or licenses, do not download, install, copy, or use the software
-or any other material included in in distribution.
+BSD 3-Clause License
 
------------------------------------------------------------------------
-
-                PySceneDetect License (BSD 3-Clause)
-          < http://www.bcastell.com/projects/PySceneDetect >
-
-Copyright (C) 2014-2024, Brandon Castellano.
-All rights reserved.
+Copyright (C) 2024, Brandon Castellano
 
 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-    1. Redistributions of source code must retain the above copyright
-       notice, this list of conditions and the following disclaimer.
-
-    2. Redistributions in binary form must reproduce the above
-       copyright notice, this list of conditions and the following
-       disclaimer in the documentation and/or other materials
-       provided with the distribution.
-
-    3. Neither the name of the copyright holder nor the names of its
-       contributors may be used to endorse or promote products derived
-       from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
------------------------------------------------------------------------
-
-                   Ancillary Software Licenses
-
-This software uses the following third-party open source libraries and
-are released under the terms detailed below. By downloading, copying,
-installing or using this software/tutorial, you agree to these terms.
-
------------------------------------------------------------------------
-
-
-> click [Copyright (C) 2017, Armin Ronacher]:
-    This software uses OpenCV; see thirdparty/LICENSE-CLICK or visit:
-    [ http://click.pocoo.org/license/ ]
-
-> NumPy [Copyright (C) 2005-2016, Numpy Developers]:
-    This software uses Numpy; see thirdparty/LICENSE-NUMPY or visit:
-    [ http://www.numpy.org/license.html ]
-
-> OpenCV [Copyright (C) 2017, Itseez]:
-    This software uses OpenCV; see thirdparty/LICENSE-OPENCV or visit:
-    [ http://opencv.org/license.html ]
-
-> PyAV [Copyright (C) 2017, Mike Boers and others]:
-    This software uses PyAV; see thirdparty/LICENSE-PYAV or visit:
-    [ https://github.com/PyAV-Org/PyAV/blob/main/LICENSE.txt ]
-
-> pytest [Copyright (C) 2004-2017, Holger Krekel and others]:
-    This software uses pytest; see thirdparty/LICENSE-PYTEST or visit:
-    [ https://docs.pytest.org/en/latest/license.html ]
-
-> simpletable [Copyright (C) 2014-2019, Matheus Vieira Portela and others]:
-    This software uses simpletable; see thirdparty/LICENSE-SIMPLETABLE or visit:
-    [ https://github.com/matheusportela/simpletable/blob/master/LICENSE ]
-
-> tqdm [Copyright (C) 2013-2018, Casper da Costa-Luis,
-        Google Inc., and Noam Yorav-Raphael]:
-    This software uses tqdm; see thirdparty/LICENSE-TQDM or visit:
-    [ https://github.com/tqdm/tqdm/blob/master/LICENCE ]
-
-
------------------------------------------------------------------------
-
-This software may also invoke FFmpeg or mkvmerge, if available. If required,
-these programs can be obtained from following URLs:
-
-    FFmpeg:   [ https://ffmpeg.org/download.html ]
-    mkvmerge: [ https://mkvtoolnix.download/downloads.html ]
-
-Once installed, ensure the program is in your PATH variable (i.e. you can
-run the `ffmpeg` or `mkvmerge` command from any location).
-
-Certain distributions of PySceneDetect may include ffmpeg. See
-thirdparty/LICENSE-FFMPEG file or visit [ https://ffmpeg.org ]
-
-FFmpeg is a trademark of Fabrice Bellard
-mkvmerge is Copyright (C) 2005-2016, Matroska
-
-Windows distributions may include a compiled Python distribution. For license
-information regarding the distributed version of Python, see the
-thirdparty/LICENSE-PYTHON file, or visit [ https://docs.python.org/3/license.html ]
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 
 ![PySceneDetect](https://raw.githubusercontent.com/Breakthrough/PySceneDetect/main/website/pages/img/pyscenedetect_logo_small.png)
 ==========================================================
-Video Scene Cut Detection and Analysis Tool
+Video Cut Detection and Analysis Tool
 ----------------------------------------------------------
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/Breakthrough/PySceneDetect/build.yml)](https://github.com/Breakthrough/PySceneDetect/actions)
@@ -11,7 +11,7 @@ Video Scene Cut Detection and Analysis Tool
 
 ----------------------------------------------------------
 
-### Latest Release: v0.6.3 (March 9, 2024)
+### Latest Release: v0.6.4 (June 10, 2024)
 
 **Website**:  [scenedetect.com](https://www.scenedetect.com)
 
@@ -102,7 +102,7 @@ See [the documentation](https://www.scenedetect.com/docs/latest/api.html) for mo
 
  - [Documentation](https://www.scenedetect.com/docs/) (covers application and Python API)
  - [CLI Example](https://www.scenedetect.com/cli/)
- - [Config File](https://www.scenedetect.com/docs/0.6.3/cli/config_file.html)
+ - [Config File](https://www.scenedetect.com/docs/0.6.4/cli/config_file.html)
 
 ## Help & Contributing
 
@@ -117,7 +117,9 @@ This program uses free code signing provided by [SignPath.io](https://signpath.i
 
 ## License
 
-Licensed under BSD 3-Clause (see the `LICENSE` file for details).
+BSD-3-Clause; see [`LICENSE`](LICENSE) and [`THIRD-PARTY.md`](THIRD-PARTY.md) for details.
+
+----------------------------------------------------------
 
 Copyright (C) 2014-2024 Brandon Castellano.
 All rights reserved.
diff --git a/THIRD-PARTY.md b/THIRD-PARTY.md
@@ -0,0 +1,75 @@
+# Ancillary Software Licenses
+
+This file includes license information for various open-source projects
+that are imported, derived into, or distributed with PySceneDetect.
+See [LICENSE](LICENSE) for the main PySceneDetect license.
+
+Depending on the features being used, PySceneDetect uses the following
+third-party software which are released under the terms detailed below.
+By downloading, copying, installing or using this software, you agree
+to these terms.
+
+In no particular order:
+
+-----------------------------------------------------------------------
+
+> click [Copyright (C) 2017, Armin Ronacher]:
+    This software uses OpenCV; see thirdparty/LICENSE-CLICK or visit:
+    [ http://click.pocoo.org/license/ ]
+
+> NumPy [Copyright (C) 2005-2016, Numpy Developers]:
+    This software uses Numpy; see thirdparty/LICENSE-NUMPY or visit:
+    [ http://www.numpy.org/license.html ]
+
+> OpenCV [Copyright (C) 2017, Itseez]:
+    This software uses OpenCV; see thirdparty/LICENSE-OPENCV or visit:
+    [ http://opencv.org/license.html ]
+
+> PyAV [Copyright (C) 2017, Mike Boers and others]:
+    This software uses PyAV; see thirdparty/LICENSE-PYAV or visit:
+    [ https://github.com/PyAV-Org/PyAV/blob/main/LICENSE.txt ]
+
+> pytest [Copyright (C) 2004-2017, Holger Krekel and others]:
+    This software uses pytest; see thirdparty/LICENSE-PYTEST or visit:
+    [ https://docs.pytest.org/en/latest/license.html ]
+
+> simpletable [Copyright (C) 2014-2019, Matheus Vieira Portela and others]:
+    This software uses simpletable; see thirdparty/LICENSE-SIMPLETABLE or visit:
+    [ https://github.com/matheusportela/simpletable/blob/master/LICENSE ]
+
+> tqdm [Copyright (C) 2013-2018, Casper da Costa-Luis,
+        Google Inc., and Noam Yorav-Raphael]:
+    This software uses tqdm; see thirdparty/LICENSE-TQDM or visit:
+    [ https://github.com/tqdm/tqdm/blob/master/LICENCE ]
+
+> MoviePy [ Copyright (C) 2015 Zulko ]
+    This software uses tqdm; see thirdparty/LICENSE-TQDM or visit:
+    [ https://github.com/Zulko/moviepy/blob/master/LICENCE.txt ]
+
+-----------------------------------------------------------------------
+
+This software may also invoke FFmpeg or mkvmerge, if available. If required,
+these programs can be obtained from following URLs:
+
+    FFmpeg:   [ https://ffmpeg.org/download.html ]
+    mkvmerge: [ https://mkvtoolnix.download/downloads.html ]
+
+Once installed, ensure the program is in your PATH variable (i.e. you can
+run the `ffmpeg` or `mkvmerge` command from any location).
+
+Certain distributions of PySceneDetect may include ffmpeg. See
+thirdparty/LICENSE-FFMPEG file or visit [ https://ffmpeg.org ]
+
+FFmpeg is a trademark of Fabrice Bellard
+mkvmerge is Copyright (C) 2005-2016, Matroska
+
+Windows distributions may include a compiled Python distribution. For license
+information regarding the distributed version of Python, see the
+thirdparty/LICENSE-PYTHON file, or visit [ https://docs.python.org/3/license.html ]
+
+-----------------------------------------------------------------------
+
+If any information above is incorrect, please let us know.
+Visit [ https://www.scenedetect.com ] for contact information.
+
+
diff --git a/appveyor.yml b/appveyor.yml
@@ -35,8 +35,8 @@ install:
   - 'SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%'
   - python --version
   - python -m pip install --upgrade pip
-  - python -m pip install -r dist/requirements_windows.txt
   - python -m pip install -r docs/requirements.txt
+  - python -m pip install --upgrade -r dist/requirements_windows.txt
   # 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/6.0/ffmpeg-6.0-full_build.7z
@@ -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