Get a dict containing user options to construct a ContentDetector with.

Handle detect-hash command options and return args to construct one with.

Handle detect-hist command options and return args to construct one with.

Handle detect-threshold command options and return args to construct one with.

Get path to ffmpeg if available on the current system. First looks at PATH, then checks if one is available from the `imageio_ffmpeg` package. Ret

Get initialization log. Consumes the log, so subsequent calls will return None.

Get number of registered scene detectors added via add_detector.

Returns a list of tuples of start/end FrameTimecodes for each scene based on a list of detected scene cuts/breaks. This function is called wh

Calculates the perceptual hash of a frame and returns it. Based on phash from https://github.com/JohannesBuchner/imagehash.

Initializes logging for PySceneDetect. The logger instance used is named 'pyscenedetect'. By default the logger has no handlers to suppress output

Is ffmpeg Available: Gracefully checks if ffmpeg command is available. Returns: True if `ffmpeg` can be invoked, False otherwise.

Is mkvmerge Available: Gracefully checks if mkvmerge command is available. Returns: True if `mkvmerge` can be invoked, False otherwise.

Print help/usage for a given command. Modifies `ctx` in-place.

Register a list of metric keys that will be used by the detector.

Perform main CLI application control logic. Run once all command-line options and configuration file options have been validated. Arguments:

No-op.

Check that the given CSV row is a valid header for a statsfile. Arguments: row: A row decoded from the CSV reader. Retur

Bail unless `path` carries a Valid Authenticode signature. Catches the wrong-artifact case: e.g. someone drops the AppVeyor pre-signing bundl

Arguments: message: Additional context the backend can provide for the open failure.

Initialize a new StatsManager. Arguments: base_timecode: Timecode associated with this object. Must not be None (default value

Open a video file, image sequence, or network stream. Arguments: path: Path to the video. Can be a file, image sequence (`'folder

Calculate score representing relative amount of motion in `frame_img` compared to the last time the function was called (returns 0.0 on the fi

Detect edges using the luma channel of a frame. Arguments: lum: 2D 8-bit image representing the luma channel of a frame.

Estimate kernel size based on video resolution.

Get video duration as number of frames based on the video and set framerate.

Fix for issue where if thread_type is 'AUTO' the whole video is not decoded. Re-open video if the threading mode is AUTO and we didn't decode

Process the given configuration into a key-value mapping. Returns a tuple of the config dict itself (or None on failure), and a list of log messag

Parse a SMPTE ``HH:MM:SS:FF`` (or 8-digit ``HHMMSSFF``) start timecode into a frame count.

Add remaining cuts to the cutting list, after processing the last frame.

Add any cuts detected with the current frame to the cutting list. Returns True if any new cuts were detected, False otherwise.

Return version of an installed package, querying PyPI metadata first then falling back to the module's `__version__` attribute when metadata is mi

Handles saving the statsfile if -s/--stats was specified.

Validates the layout of the section/option mapping. Returns a bool indicating if validation was successful, and a list of log messages for the ini

Returns a transformation function that backquotes command examples, adding backquotes and references to any found options.

Add a SimpleTableCell object to the list of cells.

Adds a copy of `command` that can be invoked under the name `alias`.

Add a SimpleTableRow object to the list of rows.

Calculates and optionally normalizes the histogram of the luma (Y) channel of an image converted from BGR to YUV color space.

Validates that the proper tool is available on the system to perform the `split-video` command. Arguments: use_mkvmerge: True if mkvm

Remove all scene detectors added to the SceneManager via add_detector().

Get the optimal default downscale factor based on a video's resolution (currently only the width in pixels is considered). The resulting effe

Formats filenames using a template string which allows the following variables: `$VIDEO_NAME`, `$SCENE_NUMBER`, `$START_TIME`, `$END_TIME`, `$STA

Ensures at least one detector has been instantiated, otherwise adds a default one.

Writes the epilog into the formatter if it exists.

Writes the help text to the formatter if it exists.

Generates a video with specific codec and container.

Generates a list of timecodes for each scene in `scene_list` based on the current config parameters. Uses PTS-accurate seconds-based

Generates H.264 video with B-frames to exercise DTS/PTS divergence.

Generates a video where setpts filter drops 3 frames mid-clip.

Generates a VFR video with three segments separated by visible luma steps. Segments: black @ 1 fps (5s) -> gray @ 60 fps (5s) -> white @ 1 fps (5

[DEPRECATED] Return a list of FrameTimecodes of the detected scene changes/cuts. Unlike get_scene_list, the cutting list returns a list of Fr

Get ffmpeg version identifier, or None if ffmpeg is not found. Uses `get_ffmpeg_path()`.

[DEPRECATED] Get the current time/position in number of frames. Use the `frame_num` property instead. :meta private:

Returns a list of all metric names/keys used by this detector. Returns: List of strings of frame metric key names that will be us

Get path to mkvmerge if available on the current system by checking PATH. Returns None if mkvmerge couldn't be found.

Get mkvmerge version identifier, or None if mkvmerge is not found in PATH.

Get the system's operating system, Python, packages, and external tool versions. Useful for debugging or filing bug reports. Used for the `sc

Parse all global options/arguments passed to the main scenedetect command, before other sub-commands (e.g. this function processes the [option