PySceneDetect Manual

This manual refers to both the PySceneDetect command-line interface (the scenedetect command) and the PySceneDetect Python API (the scenedetect module). The latest release of PySceneDetect can be installed via pip install scenedetect[opencv], or Windows builds and source releases can be found at scenedetect.com/download. Note that PySceneDetect requires ffmpeg or mkvmerge for video splitting support.

Note

If you see any errors in this manual, or have any recommendations, feel free to raise an issue on the PySceneDetect issue tracker.

The latest source code for PySceneDetect can be found on Github at github.com/Breakthrough/PySceneDetect.

Table of Contents

scenedetect Command Reference 🖥️

Command-Line Interface [CLI]:

• scenedetect 🎬 Application
  • Quickstart
  • Overview
  • Global Options
• Detectors
  • detect-content
  • detect-threshold
  • detect-adaptive
• Commands
  • help, version, and about
  • time
  • list-scenes
  • save-images
  • split-video
  • export-html
• Configuration File
  • Example
  • Template
• Backends
  • OpenCV
  • PyAV

scenedetect Python Module 🐍

Python API Documentation:

• scenedetect 🎬 Package
  • Overview
  • Quickstart
  • Example
  • Migrating From 0.5
  • Module-Level Functions
    • detect
    • open_video
  • Logging
• SceneManager
  • Usage
  • Storing Per-Frame Statistics
  • SceneManager Class
    • SceneManager
  • scene_manager Functions
    • save_images()
    • write_scene_list()
    • write_scene_list_html()
    • get_scenes_from_cuts()
• Detection Algorithms
  • ContentDetector
    • ContentDetector
    • estimated_kernel_size()
    • mean_pixel_distance()
  • AdaptiveDetector
    • AdaptiveDetector
  • ThresholdDetector
    • ThresholdDetector
    • compute_frame_average()
• Backends
  • Video Files
  • Devices / Cameras / Pipes
  • AVAILABLE_BACKENDS
  • OpenCV
    • VideoCaptureAdapter
    • VideoStreamCv2
    • get_aspect_ratio()
  • PyAV
    • VideoStreamAv
  • MoviePy
• Video Splitting
  • DEFAULT_FFMPEG_ARGS
  • FFMPEG_PATH
  • TimecodePair
  • is_ffmpeg_available()
  • is_mkvmerge_available()
  • split_video_ffmpeg()
  • split_video_mkvmerge()
• FrameTimecode
  • Usage Examples
  • FrameTimecode Class
    • FrameTimecode
  • Constants
    • MAX_FPS_DELTA
• SceneDetector
  • SceneDetector
    • SceneDetector.event_buffer_length
    • SceneDetector.get_metrics()
    • SceneDetector.is_processing_required()
    • SceneDetector.post_process()
    • SceneDetector.process_frame()
    • SceneDetector.stats_manager
    • SceneDetector.stats_manager_required()
  • SparseSceneDetector
    • SparseSceneDetector.post_process()
    • SparseSceneDetector.process_frame()
• StatsManager
  • StatsManager Class
    • StatsManager
  • Exceptions
    • FrameMetricRegistered
    • FrameMetricNotRegistered
    • StatsFileCorrupt
• VideoStream
  • VideoStream Interface
    • VideoStream
  • video_stream Functions and Constants
    • DEFAULT_MIN_WIDTH
    • compute_downscale_factor()
  • Exceptions
    • VideoOpenFailure
    • SeekError
• Platform & Logging
  • Functions
    • get_and_create_path()
    • get_file_name()
    • init_logger()
    • invoke_command()
  • Exceptions
    • CommandTooLong
• Migration Guide
  • VideoManager Class
    • Seeking and Start/End Times
  • SceneManager Class
  • save_images Function
  • split_video_* Functions
  • StatsManager Class
  • AdaptiveDetector Class
  • Other
    • ThresholdDetector Class
    • ContentDetector Class
    • MINIMUM_FRAMES_PER_SECOND_* Constants
    • get_aspect_ratio Function

Indices and Tables

• Index

• Module Index

• Search Page