diff --git a/scenedetect/detectors/adaptive_detector.py b/scenedetect/detectors/adaptive_detector.py index 0cbb4895..5e638a63 100644 --- a/scenedetect/detectors/adaptive_detector.py +++ b/scenedetect/detectors/adaptive_detector.py @@ -50,7 +50,8 @@ def __init__( Arguments: adaptive_threshold: Threshold (float) that score ratio must exceed to trigger a new scene (see frame metric adaptive_ratio in stats file). - min_scene_len: Minimum length of any scene. + min_scene_len: Once a cut is detected, this many frames must pass before a new one can + be added to the scene list. Can be an int or FrameTimecode type. window_width: Size of window (number of frames) before and after each frame to average together in order to detect deviations from the mean. Must be at least 1. min_content_val: Minimum threshold (float) that the content_val must exceed in order to diff --git a/scenedetect/detectors/content_detector.py b/scenedetect/detectors/content_detector.py index 75c06ae9..4b8b2e19 100644 --- a/scenedetect/detectors/content_detector.py +++ b/scenedetect/detectors/content_detector.py @@ -113,7 +113,7 @@ def __init__( Arguments: threshold: Threshold the average change in pixel intensity must exceed to trigger a cut. min_scene_len: Once a cut is detected, this many frames must pass before a new one can - be added to the scene list. + be added to the scene list. Can be an int or FrameTimecode type. weights: Weight to place on each component when calculating frame score (`content_val` in a statsfile, the value `threshold` is compared against). luma_only: If True, only considers changes in the luminance channel of the video. diff --git a/scenedetect/detectors/hash_detector.py b/scenedetect/detectors/hash_detector.py index 36f7e1b5..2ca37afa 100644 --- a/scenedetect/detectors/hash_detector.py +++ b/scenedetect/detectors/hash_detector.py @@ -57,7 +57,8 @@ class HashDetector(SceneDetector): size: Size of square of low frequency data to use for the DCT lowpass: How much high frequency information to filter from the DCT. A value of 2 means keep lower 1/2 of the frequency data, 4 means only keep 1/4, etc... - min_scene_len: Minimum length of any given scene, in frames (int) or FrameTimecode + min_scene_len: Once a cut is detected, this many frames must pass before a new one can + be added to the scene list. Can be an int or FrameTimecode type. """ def __init__( diff --git a/scenedetect/detectors/histogram_detector.py b/scenedetect/detectors/histogram_detector.py index 9e37df09..15f63834 100644 --- a/scenedetect/detectors/histogram_detector.py +++ b/scenedetect/detectors/histogram_detector.py @@ -38,7 +38,8 @@ def __init__(self, threshold: float = 0.05, bins: int = 256, min_scene_len: int YUV, and normalized based on the number of bins. Higher dicfferences imply greater change in content, so larger threshold values are less sensitive to cuts. bins: Number of bins to use for the histogram. - min_scene_len: Minimum length of any scene. + min_scene_len: Once a cut is detected, this many frames must pass before a new one can + be added to the scene list. Can be an int or FrameTimecode type. """ super().__init__() # Internally, threshold represents the correlation between two histograms and has values diff --git a/scenedetect/detectors/threshold_detector.py b/scenedetect/detectors/threshold_detector.py index f14d1882..b93987b2 100644 --- a/scenedetect/detectors/threshold_detector.py +++ b/scenedetect/detectors/threshold_detector.py @@ -82,8 +82,8 @@ def __init__( Arguments: threshold: 8-bit intensity value that each pixel value (R, G, and B) must be <= to in order to trigger a fade in/out. - min_scene_len: FrameTimecode object or integer greater than 0 of the - minimum length, in frames, of a scene (or subsequent scene cut). + min_scene_len: Once a cut is detected, this many frames must pass before a new one can + be added to the scene list. Can be an int or FrameTimecode type. fade_bias: Float between -1.0 and +1.0 representing the percentage of timecode skew for the start of a scene (-1.0 causing a cut at the fade-to-black, 0.0 in the middle, and +1.0 causing the cut to be