Function detect

scenedetect/__init__.py:144–196

Perform scene detection on a given video `path` using the specified `detector`. Arguments: video_path: Path to input video (absolute or relative to working directory). detector: A `SceneDetector` instance (see :mod:`scenedetect.detectors` for a full list of detectors

(
    video_path: StrPath,
    detector: SceneDetector,
    stats_file_path: StrPath | None = None,
    show_progress: bool = False,
    start_time: TimecodeLike | None = None,
    end_time: TimecodeLike | None = None,
    start_in_scene: bool = False,
)

def detect(
    video_path: StrPath,
    detector: SceneDetector,
    stats_file_path: StrPath | None = None,
    show_progress: bool = False,
    start_time: TimecodeLike | None = None,
    end_time: TimecodeLike | None = None,
    start_in_scene: bool = False,
) -> SceneList:
    """Perform scene detection on a given video `path` using the specified `detector`.

    Arguments:
        video_path: Path to input video (absolute or relative to working directory).
        detector: A `SceneDetector` instance (see :mod:`scenedetect.detectors` for a full list
            of detectors).
        stats_file_path: Path to save per-frame metrics to for statistical analysis or to
            determine a better threshold value.
        show_progress: Show a progress bar with estimated time remaining. Default is False.
        start_time: Starting point in video, in the form of a timecode ``HH:MM:SS[.nnn]`` (`str`),
            number of seconds ``123.45`` (`float`), or number of frames ``200`` (`int`).
        end_time: Starting point in video, in the form of a timecode ``HH:MM:SS[.nnn]`` (`str`),
            number of seconds ``123.45`` (`float`), or number of frames ``200`` (`int`).
        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).
            When detecting fades with `ThresholdDetector`, the beginning portion of the video
            will always be included until the first fade-out event is detected.

    Returns:
        List of scenes as pairs of (start, end) :class:`FrameTimecode` objects.

    Raises:
        :class:`VideoOpenFailure`: `video_path` could not be opened.
        :class:`StatsFileCorrupt`: `stats_file_path` is an invalid stats file
        ValueError: `start_time` or `end_time` are incorrectly formatted.
        TypeError: `start_time` or `end_time` are invalid types.
    """
    video = open_video(video_path)
    if start_time is not None:
        video.seek(FrameTimecode(start_time, video.frame_rate))
    end_timecode = FrameTimecode(end_time, video.frame_rate) if end_time is not None else None
    # To reduce memory consumption when not required, we only add a StatsManager if we
    # need to save frame metrics to disk.
    scene_manager = SceneManager(StatsManager() if stats_file_path else None)
    scene_manager.add_detector(detector)
    scene_manager.detect_scenes(
        video=video,
        show_progress=show_progress,
        end_time=end_timecode,
    )
    if scene_manager.stats_manager is not None and stats_file_path is not None:
        scene_manager.stats_manager.save_to_csv(csv_file=stats_file_path)
    return scene_manager.get_scene_list(start_in_scene=start_in_scene)