[api] Remove SparseSceneDetector and SceneManager.get_event_list()

Author: Breakthrough

scenedetect/detector.py

@@ -102,45 +102,6 @@ def event_buffer_length(self) -> int:
         return 0
 
 
-# TODO(v0.7): Remove this early, no point in keeping it around.
-class SparseSceneDetector(SceneDetector):
-    """Base class to inherit from when implementing a sparse scene detection algorithm.
-
-    This class will be removed in v1.0 and should not be used.
-
-    Unlike dense detectors, sparse detectors detect "events" and return a *pair* of frames,
-    as opposed to just a single cut.
-
-    An example of a SparseSceneDetector is the MotionDetector.
-
-    :meta private:
-    """
-
-    def process_frame(
-        self, frame_num: int, frame_img: numpy.ndarray
-    ) -> ty.List[ty.Tuple[int, int]]:
-        """Process Frame: Computes/stores metrics and detects any scene changes.
-
-        Prototype method, no actual detection.
-
-        Returns:
-            List of frame pairs representing individual scenes
-            to be added to the output scene list directly.
-        """
-        return []
-
-    def post_process(self, frame_num: int) -> ty.List[ty.Tuple[int, int]]:
-        """Post Process: Performs any processing after the last frame has been read.
-
-        Prototype method, no actual detection.
-
-        Returns:
-            List of frame pairs representing individual scenes
-            to be added to the output scene list directly.
-        """
-        return []
-
-
 class FlashFilter:
     """Filters fast-cuts to enforce minimum scene length."""
 

scenedetect/scene_manager.py

@@ -101,7 +101,7 @@ def on_new_scene(frame_img: numpy.ndarray, frame_num: int):
     SimpleTableRow,
 )
 from scenedetect.common import CropRegion, CutList, SceneList
-from scenedetect.detector import SceneDetector, SparseSceneDetector
+from scenedetect.detector import SceneDetector
 from scenedetect.frame_timecode import FrameTimecode
 from scenedetect.platform import get_and_create_path, get_cv2_imwrite_params, tqdm
 from scenedetect.stats_manager import StatsManager
@@ -947,9 +947,7 @@ def __init__(
                 accessed via the `stats_manager` property of the resulting object to save to disk.
         """
         self._cutting_list = []
-        self._event_list = []
         self._detector_list: ty.List[SceneDetector] = []
-        self._sparse_detector_list = []
         # TODO(v1.0): This class should own a StatsManager instead of taking an optional one.
         # Expose a new `stats_manager` @property from the SceneManager, and either change the
         # `stats_manager` argument to to `store_stats: bool=False`, or lazy-init one.
@@ -1063,19 +1061,14 @@ def add_detector(self, detector: SceneDetector) -> None:
             detector (SceneDetector): Scene detector to add to the SceneManager.
         """
         if self._stats_manager is None and detector.stats_manager_required():
-            # Make sure the lists are empty so that the detectors don't get
-            # out of sync (require an explicit statsmanager instead)
-            assert not self._detector_list and not self._sparse_detector_list
+            assert not self._detector_list
             self._stats_manager = StatsManager()
 
         detector.stats_manager = self._stats_manager
         if self._stats_manager is not None:
             self._stats_manager.register_metrics(detector.get_metrics())
 
-        if not issubclass(type(detector), SparseSceneDetector):
-            self._detector_list.append(detector)
-        else:
-            self._sparse_detector_list.append(detector)
+        self._detector_list.append(detector)
 
         self._frame_buffer_size = max(detector.event_buffer_length, self._frame_buffer_size)
 
@@ -1092,7 +1085,6 @@ def clear(self) -> None:
         cached frame metrics that were computed and saved in the previous call to detect_scenes.
         """
         self._cutting_list.clear()
-        self._event_list.clear()
         self._last_pos = None
         self._start_pos = None
         self._frame_size = None
@@ -1101,7 +1093,6 @@ def clear(self) -> None:
     def clear_detectors(self) -> None:
         """Remove all scene detectors added to the SceneManager via add_detector()."""
         self._detector_list.clear()
-        self._sparse_detector_list.clear()
 
     def get_scene_list(
         self, base_timecode: ty.Optional[FrameTimecode] = None, start_in_scene: bool = False
@@ -1134,7 +1125,7 @@ def get_scene_list(
         # unless start_in_scene is True.
         if not cut_list and not start_in_scene:
             scene_list = []
-        return sorted(self._get_event_list() + scene_list)
+        return sorted(scene_list)
 
     def _get_cutting_list(self) -> ty.List[int]:
         """Return a sorted list of unique frame numbers of any detected scene cuts."""
@@ -1144,15 +1135,6 @@ def _get_cutting_list(self) -> ty.List[int]:
         # Ensure all cuts are unique by using a set to remove all duplicates.
         return [self._base_timecode + cut for cut in sorted(set(self._cutting_list))]
 
-    def _get_event_list(self) -> SceneList:
-        if not self._event_list:
-            return []
-        assert self._base_timecode is not None
-        return [
-            (self._base_timecode + start, self._base_timecode + end)
-            for start, end in self._event_list
-        ]
-
     def _process_frame(
         self,
         frame_num: int,
@@ -1177,13 +1159,6 @@ def _process_frame(
                 for cut_frame_num in cuts:
                     buffer_index = cut_frame_num - (frame_num + 1)
                     callback(self._frame_buffer[buffer_index], cut_frame_num)
-        for detector in self._sparse_detector_list:
-            events = detector.process_frame(frame_num, frame_im)
-            self._event_list += events
-            if callback:
-                for event_start, _ in events:
-                    buffer_index = event_start - (frame_num + 1)
-                    callback(self._frame_buffer[buffer_index], event_start)
         return new_cuts
 
     def _post_process(self, frame_num: int) -> None:
@@ -1452,8 +1427,6 @@ def get_cut_list(
         the scene list, noting that each scene is contiguous starting from the first frame
         and ending at the last frame detected.
 
-        If only sparse detectors are used (e.g. MotionDetector), this will always be empty.
-
         Arguments:
             base_timecode: [DEPRECATED] DO NOT USE. For backwards compatibility only.
             show_warning: If set to False, suppresses the error from being warned. In v0.7,
@@ -1470,24 +1443,3 @@ def get_cut_list(
         if show_warning:
             logger.error("`get_cut_list()` is deprecated and will be removed in a future release.")
         return self._get_cutting_list()
-
-    def get_event_list(self, base_timecode: ty.Optional[FrameTimecode] = None) -> SceneList:
-        """[DEPRECATED] DO NOT USE.
-
-        Get a list of start/end timecodes of sparse detection events.
-
-        Unlike get_scene_list, the event list returns a list of FrameTimecodes representing
-        the point in the input video where a new scene was detected only by sparse detectors,
-        otherwise it is the same.
-
-        Arguments:
-            base_timecode: [DEPRECATED] DO NOT USE. For backwards compatibility only.
-
-        Returns:
-            List of pairs of FrameTimecode objects denoting the detected scenes.
-
-        :meta private:
-        """
-        # TODO(v0.7): Use the warnings module to turn this into a warning.
-        logger.error("`get_event_list()` is deprecated and will be removed in a future release.")
-        return self._get_event_list()

website/pages/changelog.md

@@ -658,17 +658,20 @@ Development
 ### API Changes
 
 #### Breaking
- - Refactoring to make code less verbose:
-    - `scenedetect.scene_detector` is now `scenedetect.detector`
-    - `scenedetect.frame_timecode` is now `scenedetect.common`
- - `FrameTimecode` fields `frame_num` and `framerate` are now read-only properties, construct a new `FrameTimecode` to change them
- - Remove `FrameTimecode.previous_frame()` method
- - Remove `SceneDetector.is_processing_required()` method, already had no effect in v0.6 as part of deprecation
- - `SceneDetector` instances can now assume they always have frame data to process when `process_frame` is called
- - Remove `scenedetect.video_manager` module ([use `scenedetect.open_video()` function](https://www.scenedetect.com/docs/head/api.html#scenedetect.open_video) instead)
+
+ * Remove deprecated `scenedetect.video_manager` module ([use `scenedetect.open_video()` function](https://www.scenedetect.com/docs/head/api.html#scenedetect.open_video) instead)
  * Deprecated `video_manager` parameter has been removed from many functions and constructors, use `video` parameter instead when required
+ * Refactoring to make code less verbose:
+      * `scenedetect.scene_detector` is now `scenedetect.detector`
+      * `scenedetect.frame_timecode` is now `scenedetect.common`
+ * `FrameTimecode` fields `frame_num` and `framerate` are now read-only properties, construct a new `FrameTimecode` to change them
+ * Remove `FrameTimecode.previous_frame()` method
+ * Remove `SceneDetector.is_processing_required()` method, already had no effect in v0.6 as part of deprecation
+ * `SceneDetector` instances can now assume they always have frame data to process when `process_frame` is called
+ * Remove deprecated `SparseSceneDetector` interface
+ * Remove deprecated `SceneManager.get_event_list()` method
 
 #### Deprecation
 
-- `scenedetect.scene_detector` module is now deprecated, use `scenedetect.detector` (or `scenedetect`) instead
-
+ * `scenedetect.scene_detector` module is now deprecated, import from `scenedetect` or `scenedetect.detector` instead
+ * `scenedetect.frame_timecode` module is now deprecated, import from `scenedetect` or `scenedetect.common` instead