scenedetect-core 0.7.1.dev0__tar.gz

scenedetect_core-0.7.1.dev0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (C) 2014, 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
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

scenedetect_core-0.7.1.dev0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: scenedetect-core
+Version: 0.7.1.dev0
+Summary: The detection pipeline for PySceneDetect (core library, minimal dependencies).
+Author-email: Brandon Castellano <brandon248@gmail.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://www.scenedetect.com
+Project-URL: Documentation, https://www.scenedetect.com/docs/
+Project-URL: Source, https://github.com/Breakthrough/PySceneDetect
+Project-URL: Issues, https://github.com/Breakthrough/PySceneDetect/issues
+Keywords: video,computer-vision,analysis
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Console :: Curses
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Multimedia :: Video :: Conversion
+Classifier: Topic :: Multimedia :: Video :: Non-Linear Editor
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: numpy
+Provides-Extra: opencv
+Requires-Dist: opencv-python; extra == "opencv"
+Provides-Extra: opencv-headless
+Requires-Dist: opencv-python-headless; extra == "opencv-headless"
+Provides-Extra: pyav
+Requires-Dist: av>=9.2; extra == "pyav"
+Provides-Extra: moviepy
+Requires-Dist: moviepy; extra == "moviepy"
+Provides-Extra: dev
+Requires-Dist: av>=9.2; extra == "dev"
+Requires-Dist: click!=8.3.0,~=8.0; extra == "dev"
+Requires-Dist: moviepy; extra == "dev"
+Requires-Dist: opencv-python; extra == "dev"
+Requires-Dist: platformdirs; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-rerunfailures; extra == "dev"
+Requires-Dist: tqdm; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: Sphinx==7.0.1; extra == "docs"
+Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
+Provides-Extra: website
+Requires-Dist: mkdocs==1.5.2; extra == "website"
+Requires-Dist: jinja2>=3.1.6; extra == "website"
+Dynamic: license-file
+
+
+PySceneDetect
+==========================================================
+
+Video Scene Cut Detection and Analysis Tool
+----------------------------------------------------------
+
+.. image:: https://img.shields.io/pypi/status/scenedetect.svg
+   :target: https://github.com/Breakthrough/PySceneDetect
+
+.. image:: https://img.shields.io/github/release/Breakthrough/PySceneDetect.svg
+   :target: https://github.com/Breakthrough/PySceneDetect
+
+.. image:: https://img.shields.io/pypi/l/scenedetect.svg
+   :target: https://www.scenedetect.com/copyright/
+
+.. image:: https://img.shields.io/github/stars/Breakthrough/PySceneDetect.svg?style=social&label=View%20on%20Github
+   :target: https://github.com/Breakthrough/PySceneDetect
+
+----------------------------------------------------------
+
+Documentation: https://www.scenedetect.com/docs
+
+Github Repo: https://github.com/Breakthrough/PySceneDetect/
+
+Install: ``pip install --upgrade scenedetect`` (or ``scenedetect-headless`` for servers)
+
+Packages: `scenedetect <https://pypi.org/project/scenedetect/>`_ (CLI + ``opencv-python``), `scenedetect-headless <https://pypi.org/project/scenedetect-headless/>`_ (CLI + ``opencv-python-headless``), and `scenedetect-core <https://pypi.org/project/scenedetect-core/>`_ (library only, minimal dependencies, bring your own OpenCV variant). All provide the same ``scenedetect`` module -- install only one.
+
+----------------------------------------------------------
+
+**PySceneDetect** is a tool for detecting shot changes in videos, and can automatically split videos into separate clips.  PySceneDetect is free and open-source software, and has several detection methods to find fast-cuts and threshold-based fades.
+
+For example, to split a video: ``scenedetect -i video.mp4 split-video``
+
+You can also use the Python API (`docs <https://www.scenedetect.com/docs/latest/>`_) to do the same:
+
+.. code-block:: python
+
+    from scenedetect import detect, AdaptiveDetector, split_video_ffmpeg
+    scene_list = detect('my_video.mp4', AdaptiveDetector())
+    split_video_ffmpeg('my_video.mp4', scene_list)
+
+----------------------------------------------------------
+
+Licensed under BSD 3-Clause (see the ``LICENSE`` file for details).
+
+Copyright (C) 2014 Brandon Castellano.
+All rights reserved.
+

scenedetect_core-0.7.1.dev0/README.md

@@ -0,0 +1,131 @@
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Breakthrough/PySceneDetect/main/website/pages/img/pyscenedetect_logo_small_darkmode.png">
+  <img alt="PySceneDetect" src="https://raw.githubusercontent.com/Breakthrough/PySceneDetect/main/website/pages/img/pyscenedetect_logo_small.png">
+</picture>
+
+# 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)
+[![PyPI Status](https://img.shields.io/pypi/status/scenedetect.svg)](https://pypi.python.org/pypi/scenedetect/)
+[![PyPI Version](https://img.shields.io/pypi/v/scenedetect?color=blue)](https://pypi.python.org/pypi/scenedetect/)
+[![PyPI License](https://img.shields.io/pypi/l/scenedetect.svg)](https://scenedetect.com/copyright/)
+
+----------------------------------------------------------
+
+### Latest Release: v0.7 (May 3, 2026)
+
+**Website**:  [scenedetect.com](https://www.scenedetect.com)
+
+**Quickstart Example**: [scenedetect.com/cli/](https://www.scenedetect.com/cli/)
+
+**Documentation**:  [scenedetect.com/docs/](https://www.scenedetect.com/docs/)
+
+**Discord**: https://discord.gg/H83HbJngk7
+
+----------------------------------------------------------
+
+**Quick Install**:
+
+    pip install scenedetect --upgrade
+
+Requires ffmpeg/mkvmerge for video splitting support. Windows builds (MSI installer/portable ZIP) can be found on [the download page](https://scenedetect.com/download/).
+
+----------------------------------------------------------
+
+**Quick Start (Command Line)**:
+
+Split input video on each fast cut using `ffmpeg`:
+
+    scenedetect -i video.mp4 split-video
+
+Save some frames from each cut:
+
+    scenedetect -i video.mp4 save-images
+
+Skip the first 10 seconds of the input video:
+
+    scenedetect -i video.mp4 time -s 10s
+
+More examples can be found throughout [the documentation](https://www.scenedetect.com/docs/latest/cli.html).
+
+**Quick Start (Python API)**:
+
+To get started, there is a high level function in the library that performs content-aware scene detection on a video (try it from a Python prompt):
+
+```python
+from scenedetect import detect, ContentDetector
+scene_list = detect('my_video.mp4', ContentDetector())
+```
+
+`scene_list` will now be a list containing the start/end times of all scenes found in the video.  There also exists a two-pass version `AdaptiveDetector` which handles fast camera movement better, and `ThresholdDetector` for handling fade out/fade in events.
+
+Try calling `print(scene_list)`, or iterating over each scene:
+
+```python
+from scenedetect import detect, ContentDetector
+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].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):
+
+```python
+from scenedetect import detect, ContentDetector, split_video_ffmpeg
+scene_list = detect('my_video.mp4', ContentDetector())
+split_video_ffmpeg('my_video.mp4', scene_list)
+```
+
+For more advanced usage, the API is highly configurable, and can easily integrate with any pipeline. This includes using different detection algorithms, splitting the input video, and much more. The following example shows how to implement a function similar to the above, but using [the `scenedetect` API](https://www.scenedetect.com/docs/latest/api.html):
+
+```python
+from scenedetect import open_video, SceneManager, split_video_ffmpeg
+from scenedetect.detectors import ContentDetector
+from scenedetect.video_splitter import split_video_ffmpeg
+
+def split_video_into_scenes(video_path, threshold=27.0):
+    # Open our video, create a scene manager, and add a detector.
+    video = open_video(video_path)
+    scene_manager = SceneManager()
+    scene_manager.add_detector(
+        ContentDetector(threshold=threshold))
+    scene_manager.detect_scenes(video, show_progress=True)
+    scene_list = scene_manager.get_scene_list()
+    split_video_ffmpeg(video_path, scene_list, show_progress=True)
+```
+
+See [the documentation](https://www.scenedetect.com/docs/latest/api.html) for more examples.
+
+**Benchmark**:
+
+We evaluate the performance of different detectors in terms of accuracy and processing speed. See the [benchmark report](benchmark/README.md) for details.
+
+## Reference
+
+ - [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.4/cli/config_file.html)
+
+## Help & Contributing
+
+Please submit any bugs/issues or feature requests to [the Issue Tracker](https://github.com/Breakthrough/PySceneDetect/issues). Before submission, ensure you search through existing issues (both open and closed) to avoid creating duplicate entries.
+Pull requests are welcome and encouraged.  PySceneDetect is released under the BSD 3-Clause license, and submitted code should be compliant.
+
+For help or other issues, you can join [the official PySceneDetect Discord Server](https://discord.gg/H83HbJngk7), submit an issue/bug report [here on Github](https://github.com/Breakthrough/PySceneDetect/issues), or contact me via [my website](https://bcastell.com/about/).
+
+## Code Signing
+
+This program uses free code signing provided by [SignPath.io](https://signpath.io?utm_source=foundation&utm_medium=github&utm_campaign=PySceneDetect), and a free code signing certificate by the [SignPath Foundation](https://signpath.org?utm_source=foundation&utm_medium=github&utm_campaign=PySceneDetect)
+
+## License
+
+BSD-3-Clause; see [`LICENSE`](LICENSE) and [`THIRD-PARTY.md`](THIRD-PARTY.md) for details.
+
+----------------------------------------------------------
+
+Copyright (C) 2014 Brandon Castellano.
+All rights reserved.

scenedetect_core-0.7.1.dev0/docs/LATEST_VERSION

@@ -0,0 +1 @@
+0.7

scenedetect_core-0.7.1.dev0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = PySceneDetect
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

scenedetect_core-0.7.1.dev0/docs/_static/pyscenedetect.css

@@ -0,0 +1,34 @@
+.sig {
+    padding-bottom: 8px;
+}
+.field-list {
+    padding-bottom: 8px;
+}
+.class {
+    padding-bottom: 12px;
+    padding-top: 4px;
+}
+.function {
+    padding-bottom: 12px;
+    padding-top: 12px;
+}
+.data {
+    padding-bottom: 12px;
+    padding-top: 12px;
+}
+.method {
+    padding-bottom: 12px;
+    padding-top: 12px;
+}
+.attribute {
+    padding-bottom: 12px;
+    padding-top: 12px;
+}
+.exception {
+    padding-bottom: 12px;
+    padding-top: 12px;
+}
+.property {
+    padding-bottom: 12px;
+    padding-top: 12px;
+}

scenedetect_core-0.7.1.dev0/docs/_templates/navigation.html

@@ -0,0 +1,10 @@
+<h3>{{ _('Navigation') }}</h3>
+{{ toctree(maxdepth=2, includehidden=theme_sidebar_includehidden, collapse=theme_sidebar_collapse) }}
+{% if theme_extra_nav_links %}
+<hr />
+<ul>
+    {% for text, uri in theme_extra_nav_links.items() %}
+    <li class="toctree-l1"><a href="{{ uri }}">{{ text }}</a></li>
+    {% endfor %}
+</ul>
+{% endif %}

scenedetect_core-0.7.1.dev0/docs/api/backends.rst

@@ -0,0 +1,21 @@
+
+.. _scenedetect-backends:
+
+--------------
+Video Backends
+--------------
+
+.. automodule:: scenedetect.backends
+   :members:
+
+.. automodule:: scenedetect.backends.opencv
+   :members:
+
+.. automodule:: scenedetect.backends.pyav
+   :members:
+
+.. automodule:: scenedetect.backends.moviepy
+   :members:
+
+.. automodule:: scenedetect.backends.concat
+   :members:

scenedetect_core-0.7.1.dev0/docs/api/common.rst

@@ -0,0 +1,9 @@
+
+.. _scenedetect-common:
+
+------
+Common
+------
+
+.. automodule:: scenedetect.common
+   :members:

scenedetect_core-0.7.1.dev0/docs/api/detector.rst

@@ -0,0 +1,9 @@
+
+.. _scenedetect-detector:
+
+------------------
+Detector Interface
+------------------
+
+.. automodule:: scenedetect.detector
+   :members:

scenedetect_core-0.7.1.dev0/docs/api/detectors.rst

@@ -0,0 +1,53 @@
+
+.. _scenedetect-detectors:
+
+---------
+Detectors
+---------
+
+.. automodule:: scenedetect.detectors
+
+AdaptiveDetector
+================
+
+.. automodule:: scenedetect.detectors.adaptive_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.adaptive_detector.AdaptiveDetector
+   :members:
+
+ContentDetector
+===============
+
+.. automodule:: scenedetect.detectors.content_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.content_detector.ContentDetector
+   :members:
+
+HashDetector
+============
+
+.. automodule:: scenedetect.detectors.hash_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.hash_detector.HashDetector
+   :members:
+
+HistogramDetector
+=================
+
+.. automodule:: scenedetect.detectors.histogram_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.histogram_detector.HistogramDetector
+   :members:
+
+ThresholdDetector
+=================
+
+.. automodule:: scenedetect.detectors.threshold_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.threshold_detector.ThresholdDetector
+   :members: