[timecode] Ensure timecodes always use most accurate representation when calculating seconds #168

Author: Breakthrough

scenedetect/common.py

@@ -352,26 +352,19 @@ def get_seconds(self) -> float:
         )
         return self.seconds
 
-    def get_timecode(
-        self, precision: int = 3, use_rounding: bool = True, nearest_frame: bool = True
-    ) -> str:
+    def get_timecode(self, precision: int = 3, use_rounding: bool = True) -> str:
         """Get a formatted timecode string of the form HH:MM:SS[.nnn].
 
         Args:
             precision: The number of decimal places to include in the output ``[.nnn]``.
             use_rounding: Rounds the output to the desired precision. If False, the value
                 will be truncated to the specified precision.
-            nearest_frame: Ensures that the timecode is moved to the nearest frame boundary if this
-                object has a defined framerate, otherwise has no effect.
 
         Returns:
             str: The current time in the form ``"HH:MM:SS[.nnn]"``.
         """
         # Compute hours and minutes based off of seconds, and update seconds.
-        if nearest_frame and self.framerate:
-            secs = self.frame_num / self.framerate
-        else:
-            secs = self.seconds
+        secs = self.seconds
         hrs = int(secs / _SECONDS_PER_HOUR)
         secs -= hrs * _SECONDS_PER_HOUR
         mins = int(secs / _SECONDS_PER_MINUTE)

scenedetect/scene_manager.py

@@ -423,7 +423,7 @@ def detect_scenes(
         end_time: ty.Optional[FrameTimecode] = None,
         frame_skip: int = 0,
         show_progress: bool = False,
-        callback: ty.Optional[ty.Callable[[np.ndarray, int], None]] = None,
+        callback: ty.Optional[ty.Callable[[np.ndarray, FrameTimecode], None]] = None,
         frame_source: ty.Optional[VideoStream] = None,
     ) -> int:
         """Perform scene detection on the given video using the added SceneDetectors, returning the

tests/test_api.py

@@ -108,11 +108,11 @@ def test_api_scene_manager_callback(test_video_file: str):
     """Demonstrate how to use a callback with the SceneManager detect_scenes method."""
     import numpy
 
-    from scenedetect import ContentDetector, SceneManager, open_video
+    from scenedetect import ContentDetector, FrameTimecode, SceneManager, open_video
 
     # Callback to invoke on the first frame of every new scene detection.
-    def on_new_scene(frame_img: numpy.ndarray, frame_num: int):
-        print("New scene found at frame %d." % frame_num)
+    def on_new_scene(frame_img: numpy.ndarray, frame_num: FrameTimecode):
+        print("New scene found at {frame_num}")
 
     video = open_video(test_video_file)
     scene_manager = SceneManager()

tests/test_timecode.py

@@ -192,14 +192,7 @@ def test_get_timecode():
     assert FrameTimecode(timecode="00:00:02.0000", fps=1.0).get_timecode() == "00:00:02.000"
     assert FrameTimecode(timecode="00:00:00.5", fps=10.0).get_timecode() == "00:00:00.500"
     # If a value is provided in seconds, we store that value internally now.
-    assert (
-        FrameTimecode(timecode="00:00:01.501", fps=10.0).get_timecode(nearest_frame=False)
-        == "00:00:01.501"
-    )
-    assert (
-        FrameTimecode(timecode="00:00:01.501", fps=10.0).get_timecode(nearest_frame=True)
-        == "00:00:01.500"
-    )
+    assert FrameTimecode(timecode="00:00:01.501", fps=10.0).get_timecode() == "00:00:01.501"
 
 
 def test_equality():
@@ -239,6 +232,7 @@ def test_equality():
 
     assert FrameTimecode(timecode="00:00:00.5", fps=10.0) == "00:00:00.500"
     assert FrameTimecode(timecode="00:00:01.500", fps=10.0) == "00:00:01.500"
+    assert FrameTimecode(timecode="999999:59:59.999999", fps=10.0) == "999999:59:59.999999"
 
 
 def test_addition():