[project] Create new common module

Remove timecode module and move contents into common.

Author: Breakthrough

scenedetect/backends/opencv.py

@@ -26,9 +26,9 @@
 import cv2
 import numpy as np
 
+from scenedetect.common import Timecode
 from scenedetect.frame_timecode import MAX_FPS_DELTA, FrameTimecode
 from scenedetect.platform import get_file_name
-from scenedetect.timecode import Timecode
 from scenedetect.video_stream import (
     FrameRateUnavailable,
     SeekError,

scenedetect/backends/pyav.py

@@ -17,9 +17,9 @@
 import av
 import numpy as np
 
+from scenedetect.common import Timecode
 from scenedetect.frame_timecode import MAX_FPS_DELTA, FrameTimecode
 from scenedetect.platform import get_file_name
-from scenedetect.timecode import Timecode
 from scenedetect.video_stream import FrameRateUnavailable, VideoFrame, VideoOpenFailure, VideoStream
 
 logger = getLogger("pyscenedetect")

scenedetect/timecode.py scenedetect/common.pyscenedetect/timecode.py renamed to scenedetect/common.py

@@ -9,17 +9,38 @@
 # PySceneDetect is licensed under the BSD 3-Clause License; see the
 # included LICENSE file, or visit one of the above pages for details.
 #
-"""``scenedetect.timecode`` Module
+"""``scenedetect.common`` Module
 
-This module contains types and functions for handling video timecodes, including parsing user input
-and timecode format conversion.
-"""
+This module contains common types and functions used throughout PySceneDetect."""
 
+import typing as ty
 from dataclasses import dataclass
 from fractions import Fraction
 
+# TODO(v0.7): We should move frame_timecode into this file.
+from scenedetect.frame_timecode import FrameTimecode
+
+##
+## Type Aliases
+##
+
+SceneList = ty.List[ty.Tuple[FrameTimecode, FrameTimecode]]
+"""Type hint for a list of scenes in the form (start time, end time)."""
+
+CutList = ty.List[FrameTimecode]
+"""Type hint for a list of cuts, where each timecode represents the first frame of a new shot."""
+
+CropRegion = ty.Tuple[int, int, int, int]
+"""Type hint for rectangle of the form X0 Y0 X1 Y1 for cropping frames. Coordinates are relative
+to source frame without downscaling.
+"""
+
+TimecodePair = ty.Tuple[FrameTimecode, FrameTimecode]
+"""Named type for pairs of timecodes, which typically represents the start/end of a scene."""
+
 
-# TODO(@Breakthrough): Add conversion from Timecode -> FrameTimecode for backwards compatibility.
+# TODO(@Breakthrough): Figure out interop with FrameTimecode. We can probably just store this inside
+# of FrameTimecode.
 # TODO(@Breakthrough): How should we deal with frame numbers? We might need to detect if a video is
 # VFR or not, and if so, either omit them or always start them from 0 regardless of the start seek.
 # With PyAV we can probably assume the video is VFR if the guessed rate of the stream differs
@@ -33,8 +54,6 @@
 #     This is probably sufficient, since we could just use 1ms as a timebase.
 #   - MoviePy: Assumes fixed framerate and doesn't include timing information. Fixing this is
 #     probably not feasible, so we should make sure the docs warn users about this.
-#
-#
 @dataclass
 class Timecode:
     """Timing information associated with a given frame."""

scenedetect/scene_manager.py

@@ -100,6 +100,7 @@ def on_new_scene(frame_img: numpy.ndarray, frame_num: int):
     SimpleTableImage,
     SimpleTableRow,
 )
+from scenedetect.common import CropRegion, CutList, SceneList
 from scenedetect.frame_timecode import FrameTimecode
 from scenedetect.platform import get_and_create_path, get_cv2_imwrite_params, tqdm
 from scenedetect.scene_detector import SceneDetector, SparseSceneDetector
@@ -108,17 +109,6 @@ def on_new_scene(frame_img: numpy.ndarray, frame_num: int):
 
 logger = logging.getLogger("pyscenedetect")
 
-SceneList = ty.List[ty.Tuple[FrameTimecode, FrameTimecode]]
-"""Type hint for a list of scenes in the form (start time, end time)."""
-
-CutList = ty.List[FrameTimecode]
-"""Type hint for a list of cuts, where each timecode represents the first frame of a new shot."""
-
-CropRegion = ty.Tuple[int, int, int, int]
-"""Type hint for rectangle of the form X0 Y0 X1 Y1 for cropping frames. Coordinates are relative
-to source frame without downscaling.
-"""
-
 # TODO: This value can and should be tuned for performance improvements as much as possible,
 # until accuracy falls, on a large enough dataset. This has yet to be done, but the current
 # value doesn't seem to have caused any issues at least.

scenedetect/video_splitter.py

@@ -40,14 +40,12 @@
 from dataclasses import dataclass
 from pathlib import Path
 
+from scenedetect.common import TimecodePair
 from scenedetect.frame_timecode import FrameTimecode
 from scenedetect.platform import CommandTooLong, Template, get_ffmpeg_path, invoke_command, tqdm
 
 logger = logging.getLogger("pyscenedetect")
 
-TimecodePair = ty.Tuple[FrameTimecode, FrameTimecode]
-"""Named type for pairs of timecodes, which typically represents the start/end of a scene."""
-
 COMMAND_TOO_LONG_STRING = """
 Cannot split video due to too many scenes (resulting command
 is too large to process). To work around this issue, you can

scenedetect/video_stream.py

@@ -37,8 +37,8 @@
 
 import numpy as np
 
+from scenedetect.common import Timecode
 from scenedetect.frame_timecode import FrameTimecode
-from scenedetect.timecode import Timecode
 
 
 class SeekError(Exception):