[output] Move post processing into new scenedetect.output module

Author: Breakthrough

docs/api.rst

@@ -7,7 +7,7 @@ The `scenedetect` API is easy to integrate with most application workflows, whil
 
     * :ref:`scenedetect 🎬 <scenedetect-functions>`: Includes the :func:`scenedetect.detect <scenedetect.detect>` function which takes a path and a  :ref:`detector <scenedetect-detectors>` to find scene transitions (:ref:`example <scenedetect-quickstart>`), and :func:`scenedetect.open_video <scenedetect.open_video>` for video input
 
-    * :ref:`scenedetect.scene_manager 🎞️ <scenedetect-scene_manager>`: The :class:`SceneManager <scenedetect.scene_manager.SceneManager>` acts as a way to coordinate detecting scenes (via `SceneDetector` instances) on video frames (via :ref:`VideoStream <scenedetect-video_stream>` instances). This module also contains functionality to export information about scenes in various formats: :func:`save_images <scenedetect.scene_manager.save_images>` to save images for each scene, :func:`write_scene_list <scenedetect.scene_manager.write_scene_list>` to save scene/cut info as CSV, and :func:`write_scene_list_html <scenedetect.scene_manager.write_scene_list_html>` to export scenes in viewable HTML format.
+    * :ref:`scenedetect.scene_manager 🎞️ <scenedetect-scene_manager>`: The :class:`SceneManager <scenedetect.scene_manager.SceneManager>` acts as a way to coordinate detecting scenes (via `SceneDetector` instances) on video frames (via :ref:`VideoStream <scenedetect-video_stream>` instances).
 
     * :ref:`scenedetect.detectors 🕵️ <scenedetect-detectors>`: Detection algorithms:
 
@@ -27,7 +27,13 @@ The `scenedetect` API is easy to integrate with most application workflows, whil
         * PyAV: :class:`VideoStreamAv <scenedetect.backends.pyav.VideoStreamAv>`
         * MoviePy: :class:`VideoStreamMoviePy <scenedetect.backends.moviepy.VideoStreamMoviePy>`
 
-    * :ref:`scenedetect.video_splitter ✂️ <scenedetect-video_splitter>`: Contains :func:`split_video_ffmpeg <scenedetect.video_splitter.split_video_ffmpeg>` and :func:`split_video_mkvmerge <scenedetect.video_splitter.split_video_mkvmerge>` to split a video based on the detected scenes.
+     * :ref:`scenedetect.output ✂️ <scenedetect-output>`: Output formats:
+
+        * :func:`split_video_ffmpeg <scenedetect.output.split_video_ffmpeg>` and :func:`split_video_mkvmerge <scenedetect.output.split_video_mkvmerge>` split a video based on the detected scenes
+
+        * :func:`save_images <scenedetect.scene_manager.save_images>` can save an arbitrary number of images from each scene
+
+        * :func:`write_scene_list <scenedetect.scene_manager.write_scene_list>` can be used to save scene/cut info as CSV, :func:`write_scene_list_html <scenedetect.scene_manager.write_scene_list_html>` for HTML
 
     * :ref:`scenedetect.common ⏱️ <scenedetect-common>`: Contains common types such as :class:`FrameTimecode <scenedetect.common.FrameTimecode>` used for timecode handing.
 
@@ -67,7 +73,7 @@ PySceneDetect makes it very easy to find scene transitions in a video with the :
 
 ``scenes`` now contains a list of :class:`FrameTimecode <scenedetect.common.FrameTimecode>` pairs representing the start/end of each scene. Note that you can set ``show_progress=True`` when calling :func:`detect <scenedetect.detect>` to display a progress bar with estimated time remaining.
 
-Here, we use :mod:`ContentDetector <scenedetect.detectors.content_detector>` to detect fast cuts. There are :ref:`many detector types <scenedetect-detectors>` which can be used to find fast cuts and fades in/out.  PySceneDetect can also export scene data in various formats, and can  :ref:`split the input video <scenedetect-video_splitter>` automatically if `ffmpeg` is available:
+Here, we use :mod:`ContentDetector <scenedetect.detectors.content_detector>` to detect fast cuts. There are :ref:`many detector types <scenedetect-detectors>` which can be used to find fast cuts and fades in/out.  PySceneDetect can also export scene data in various formats, and can  :ref:`split the input video <scenedetect-output>` automatically if `ffmpeg` is available:
 
 .. code:: python
 
@@ -98,7 +104,7 @@ Module Reference
     api/detectors
     api/scene_manager
     api/common
-    api/video_splitter
+    api/output
     api/backends
     api/stats_manager
     api/detector

docs/api/migration_guide.rst

@@ -0,0 +1,19 @@
+
+
+.. _scenedetect-output:
+
+---------------------------------------------------------------
+Ouptut
+---------------------------------------------------------------
+
+.. automodule:: scenedetect.output
+   :members:
+
+.. autofunction:: scenedetect.output.image.save_images
+
+---------------------------------------------------------------
+Video
+---------------------------------------------------------------
+
+.. automodule:: scenedetect.output.video
+   :members:

docs/api/output.rst

@@ -49,7 +49,7 @@ Table of Contents
     api/scene_manager
     api/common
     api/backends
-    api/video_splitter
+    api/output
     api/stats_manager
     api/detector
     api/video_stream

docs/api/video_splitter.rst

@@ -32,9 +32,27 @@
 # Commonly used classes/functions exported under the `scenedetect` namespace for brevity.
 # Note that order of importants is important!
 from scenedetect.platform import init_logger  # noqa: I001
-from scenedetect.common import FrameTimecode, SceneList, CutList, CropRegion, TimecodePair
+from scenedetect.common import (
+    FrameTimecode,
+    SceneList,
+    CutList,
+    CropRegion,
+    TimecodePair,
+    Interpolation,
+)
 from scenedetect.video_stream import VideoStream, VideoOpenFailure
-from scenedetect.video_splitter import split_video_ffmpeg, split_video_mkvmerge
+from scenedetect.output import (
+    save_images,
+    split_video_ffmpeg,
+    split_video_mkvmerge,
+    is_ffmpeg_available,
+    is_mkvmerge_available,
+    write_scene_list,
+    write_scene_list_html,
+    PathFormatter,
+    VideoMetadata,
+    SceneMetadata,
+)
 from scenedetect.detector import SceneDetector
 from scenedetect.detectors import (
     ContentDetector,
@@ -51,7 +69,7 @@
     VideoCaptureAdapter,
 )
 from scenedetect.stats_manager import StatsManager, StatsFileCorrupt
-from scenedetect.scene_manager import SceneManager, save_images, Interpolation
+from scenedetect.scene_manager import SceneManager
 
 # Used for module identification and when printing version & about info
 # (e.g. calling `scenedetect version` or `scenedetect about`).

docs/index.rst

@@ -30,16 +30,19 @@
 from scenedetect._cli.config import XmlFormat
 from scenedetect._cli.context import CliContext
 from scenedetect.common import FrameTimecode
+from scenedetect.output import save_images as save_images_impl
+from scenedetect.output import (
+    split_video_ffmpeg,
+    split_video_mkvmerge,
+    write_scene_list,
+    write_scene_list_html,
+)
 from scenedetect.platform import get_and_create_path
 from scenedetect.scene_manager import (
     CutList,
     Interpolation,
     SceneList,
-    write_scene_list,
-    write_scene_list_html,
 )
-from scenedetect.scene_manager import save_images as save_images_impl
-from scenedetect.video_splitter import split_video_ffmpeg, split_video_mkvmerge
 
 logger = logging.getLogger("pyscenedetect")
 

scenedetect/__init__.py

@@ -28,8 +28,8 @@
 from scenedetect.common import FrameTimecode
 from scenedetect.detector import FlashFilter
 from scenedetect.detectors import ContentDetector
+from scenedetect.output.video import DEFAULT_FFMPEG_ARGS
 from scenedetect.scene_manager import Interpolation
-from scenedetect.video_splitter import DEFAULT_FFMPEG_ARGS
 
 PYAV_THREADING_MODES = ["NONE", "SLICE", "FRAME", "AUTO"]
 

scenedetect/_cli/commands.py

@@ -33,10 +33,10 @@
     HistogramDetector,
     ThresholdDetector,
 )
+from scenedetect.output import is_ffmpeg_available, is_mkvmerge_available
 from scenedetect.platform import init_logger
 from scenedetect.scene_manager import Interpolation, SceneManager
 from scenedetect.stats_manager import StatsManager
-from scenedetect.video_splitter import is_ffmpeg_available, is_mkvmerge_available
 from scenedetect.video_stream import FrameRateUnavailable, VideoOpenFailure, VideoStream
 
 logger = logging.getLogger("pyscenedetect")

scenedetect/_cli/config.py

@@ -64,8 +64,11 @@
 import math
 import typing as ty
 from dataclasses import dataclass
+from enum import Enum
 from fractions import Fraction
 
+import cv2
+
 _USE_PTS_IN_DEVELOPMENT = False
 
 ##
@@ -94,6 +97,21 @@
 _MINUTES_PER_HOUR = 60.0
 
 
+class Interpolation(Enum):
+    """Interpolation method used for image resizing. Based on constants defined in OpenCV."""
+
+    NEAREST = cv2.INTER_NEAREST
+    """Nearest neighbor interpolation."""
+    LINEAR = cv2.INTER_LINEAR
+    """Bilinear interpolation."""
+    CUBIC = cv2.INTER_CUBIC
+    """Bicubic interpolation."""
+    AREA = cv2.INTER_AREA
+    """Pixel area relation resampling. Provides moire'-free downscaling."""
+    LANCZOS4 = cv2.INTER_LANCZOS4
+    """Lanczos interpolation over 8x8 neighborhood."""
+
+
 # TODO(@Breakthrough): How should we deal with frame numbers when we have a `Timecode`?
 #
 # Each backend has slight nuances we have to take into account: