[scene_manager] Remove unused base_timecode argument

Author: Breakthrough

scenedetect/scene_manager.py

@@ -169,7 +169,6 @@ def get_scenes_from_cuts(
     cut_list: CutList,
     start_pos: ty.Union[int, FrameTimecode],
     end_pos: ty.Union[int, FrameTimecode],
-    base_timecode: ty.Optional[FrameTimecode] = None,
 ) -> SceneList:
     """Returns a list of tuples of start/end FrameTimecodes for each scene based on a
     list of detected scene cuts/breaks.
@@ -181,20 +180,15 @@ def get_scenes_from_cuts(
 
     Arguments:
         cut_list: List of FrameTimecode objects where scene cuts/breaks occur.
-        base_timecode: The base_timecode of which all FrameTimecodes in the cut_list are based on.
         num_frames: The number of frames, or FrameTimecode representing duration, of the video that
             was processed (used to generate last scene's end time).
         start_frame: The start frame or FrameTimecode of the cut list. Used to generate the first
             scene's start time.
-        base_timecode: [DEPRECATED] DO NOT USE. For backwards compatibility only.
     Returns:
         List of tuples in the form (start_time, end_time), where both start_time and
         end_time are FrameTimecode objects representing the exact time/frame where each
         scene occupies based on the input cut_list.
     """
-    # TODO(v0.7): Use the warnings module to turn this into a warning.
-    if base_timecode is not None:
-        logger.error("`base_timecode` argument is deprecated has no effect.")
 
     # Scene list, where scenes are tuples of (Start FrameTimecode, End FrameTimecode).
     scene_list = []
@@ -1099,13 +1093,10 @@ def clear_detectors(self) -> None:
         """Remove all scene detectors added to the SceneManager via add_detector()."""
         self._detector_list.clear()
 
-    def get_scene_list(
-        self, base_timecode: ty.Optional[FrameTimecode] = None, start_in_scene: bool = False
-    ) -> SceneList:
+    def get_scene_list(self, start_in_scene: bool = False) -> SceneList:
         """Return a list of tuples of start/end FrameTimecodes for each detected scene.
 
         Arguments:
-            base_timecode: [DEPRECATED] DO NOT USE. For backwards compatibility.
             start_in_scene: Assume the video begins in a scene. This means that when detecting
                 fast cuts with `ContentDetector`, if no cuts are found, the resulting scene list
                 will contain a single scene spanning the entire video (instead of no scenes).
@@ -1117,9 +1108,6 @@ def get_scene_list(
             end_time are FrameTimecode objects representing the exact time/frame where each
             detected scene in the video begins and ends.
         """
-        # TODO(v0.7): Replace with DeprecationWarning that `base_timecode` will be removed in v0.8.
-        if base_timecode is not None:
-            logger.error("`base_timecode` argument is deprecated and has no effect.")
         if self._base_timecode is None:
             return []
         cut_list = self._get_cutting_list()
@@ -1424,7 +1412,6 @@ def _decode_thread(
 
     def get_cut_list(
         self,
-        base_timecode: ty.Optional[FrameTimecode] = None,
         show_warning: bool = True,
     ) -> CutList:
         """[DEPRECATED] Return a list of FrameTimecodes of the detected scene changes/cuts.
@@ -1436,7 +1423,6 @@ def get_cut_list(
         and ending at the last frame detected.
 
         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,
                 this will have no effect and the error will become a Python warning.
 

website/pages/changelog.md

@@ -659,22 +659,21 @@ Development
 
 #### Breaking
 
- * Many types and interfaces now use timecodes instead of frame numbers, which is a breaking change for:
+ * Replace `frame_num` parameter (`int`) with `timecode` (`FrameTimecode`) in `SceneDetector` interface:
       * The detector interface: `SceneDetector.process_frame()` and `SceneDetector.post_process()`
       * Statistics: `StatsManager.get_metrics()`, `StatsManager.set_metrics()`, and `StatsManager.metrics_exist()`
- * The `SceneDetector` interface now uses timecodes instead of frame numbers
- * 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:
+ * Reorganized submodules:
       * `scenedetect.scene_detector` is now `scenedetect.detector`
       * `scenedetect.frame_timecode` is now `scenedetect.common`
+ * Remove deprecated module `scenedetect.video_manager`, use [the `scenedetect.open_video()` function](https://www.scenedetect.com/docs/head/api.html#scenedetect.open_video) instead
+ * Remove deprecated parameter `base_timecode` from various functions, there is no need to provide it
+ * Remove deprecated parameter `video_manager` from various functions, use `video` parameter instead
  * `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
- * Remove deprecated `base_timecode` argument in `SceneManager.save_to_csv()`
  * Remove deprecated `AdaptiveDetector.get_content_val()` method (the same information can be obtained using a `StatsManager`)
 
 #### Deprecation