Get the current setting or default value of the specified command option. Returns ``ty.Any`` because each (command, option) pair has a known

Get a formatted timecode string of the form HH:MM:SS[.nnn]. Args: precision: The number of decimal places to include in the outpu

Invokes the scenedetect CLI with the specified arguments and returns the exit code. The kwargs are passed to the args format method, for example:

Add/register a SceneDetector (e.g. ContentDetector, ThresholdDetector) to run when detect_scenes is called. The SceneManager owns the detector

Open a video at the given path. If `backend` is specified but not available on the current system, OpenCV (`VideoStreamCv2`) will be used as a fal

Perform scene detection on the given video using the added SceneDetectors, returning the number of frames processed. Results can be obtained b

Return a list of tuples of start/end FrameTimecodes for each detected scene. Arguments: start_in_scene: Assume the video begins i

Add `command` to the processing pipeline. Will be called after processing the input.

Read and decode the next frame as a np.ndarray. Returns False when video ends. Arguments: decode: Return the frame image itself.

Convert a framerate value to an exact rational Fraction. Detects NTSC-derived framerates of the form ``N * 1000/1001`` (e.g. 23.976 -> 24000/1001

Invoke the scenedetect CLI in-process using Click's CliRunner. Replicates the two-step execution of ``__main__.py``: 1. ``scenedetect.main(o

Run image extraction on `video` using the current parameters. Thread-safe. Arguments: video: The video to process. sc

Seek to the given timecode. If given as a frame number, represents the current seek pointer (e.g. if seeking to 0, the next frame decoded will

Writes the given list of scenes to `output_path` in CMX 3600 EDL format. Arguments: output_path: Path to write the EDL file to. Parent di

Get the time in seconds from `other` for arithmetic operations.

Get & Create Path: Gets and returns the full/absolute path to file_path in the specified output_directory if set, creating any required directorie

No-op.

Get the frame number from `other` for arithmetic operations.

No-op.

Returns the absolute path to a (relative) path of a file that should exist within the tests/ directory. Throws FileNotFoundError if the file

Returns the absolute path to a (relative) path of a file that should exist within the tests/ directory. Throws FileNotFoundError if the file

Return the requested statistics/metrics for a given timecode. Returns: A list containing the requested frame metrics for the give

Save HTML page to a file using the proper encoding

Save a set number of images from each scene, given a list of scenes and the associated video/frame source. Arguments: scene_list: A l

Seek to the given timecode. If given as a frame number, represents the current seek pointer (e.g. if seeking to 0, the next frame decoded will

Set Metrics: Sets the provided statistics/metrics for a given frame. Arguments: timecode: Timecode to set metrics for.

Type guard: True (and narrows `other` to `FrameTimecode`) iff both timecodes have a known framerate, in which case frame-based comparison is exact

Instantiate and add `detector` to the processing pipeline.

Metrics Exist: Checks if the given metrics/stats exist for the given frame. Returns: bool: True if the given metric keys exist fo

Parses a user input string into a FrameTimecode assuming the given framerate. If `value` is None it will be passed through without processing.

Resolve the minimum scene length (in frames) for a `detect-*` command, honoring the `--drop-short-scenes` flag, command-specific config, and g

Convert `seconds` to the nearest number of frames using the current framerate. *NOTE*: This will not be correct for variable framerate videos

Perform scene detection on a given video `path` using the specified `detector`. Arguments: video_path: Path to input video (absolute or r

Determine whether the passed frame rate equals this object's frame rate. Arguments: other: Frame rate to compare against within t

Same as calling Python's subprocess.call() method, but explicitly raises a different exception when the command length is too long. See https

True if specified config option is unset (i.e. the default), False otherwise.

Is Save Required: Checks if the stats have been updated since loading. Returns: bool: True if there are frame metrics/statistics

Save To CSV: Saves all frame metrics stored in the StatsManager to a CSV file. Arguments: csv_file: A file handle opened in write

Writes the given list of scenes to `output_path` as an OTIO Timeline.1 JSON document. OTIO (OpenTimelineIO) timelines can be imported by many vid

Return the mean average distance in pixel values between `left` and `right`. Both `left and `right` should be 2 dimensional 8-bit images of the sa

Format a `Fraction` as an FCPXML rational time string. FCPXML expresses time as ``<num>/<denom>s`` (or ``<int>s`` for whole seconds). See htt

Render the slate icon at exact size with Inkscape. With inverted=False, the slate renders with its native FG body / BG stripes (right for pla

Clear all cuts/scenes and resets the SceneManager's position. Any statistics generated are still saved in the StatsManager object passed to t

Returns the absolute path to a (relative) path of a file that should exist within the tests/ directory. Throws FileNotFoundError if the file

[DEPRECATED] DO NOT USE Load all metrics stored in a CSV file into the StatsManager instance. Will be removed in a future release aft

Split `input_video_path` using `ffmpeg` based on the scenes in `scene_list`. Arguments: input_video_path: Path to the video to be split.

Writes the given list of scenes to an output file handle in CSV format. Arguments: output_csv_file: Handle to open file in write mode.

Exact seconds for `tc` as a `Fraction`, derived from PTS * time base.

Run ``fn``, retrying up to ``_FFMPEG_RETRY_COUNT`` times on ``OSError``.

Parses a string based on the three possible forms (in timecode format, as an integer number of frames, or floating-point seconds, ending with

Run scene detection for test case. Should only be called once.

Return the file name that `file_path` refers to, optionally removing the extension. E.g. /tmp/foo.bar -> foo

Render the per-scale baseline JPEGs that ship inside the MSI. Outputs `Generated Images/installer_{banner,logo}{,.scale-125,.scale-150,.scale-200

Render an SVG to a PNG at the given dimensions using Inkscape.

Writes the given list of scenes to `output_path` in Final Cut Pro 7 XML (xmeml) format. See the xmeml element reference at https://developer.

Writes the given list of scenes to `output_path` in Final Cut Pro X XML format (FCPXML 1.9). The output follows Apple's FCPXML schema with ration

Banner = full-bleed BG (light blue) canvas with the FG slate on the right.

Dialog = white canvas with FG strip on the left holding a BG-tinted slate.

Format `timecode` as ``HH:MM:SS:FF`` for a CMX 3600 EDL entry.

Validate and convert an `fps` argument into a positive `Fraction`. NTSC-like frame rates are handled via :func:`framerate_to_fraction`.

Generate per-scene image timecodes using PTS-accurate seconds-based timing. `frame_margin` accepts any :data:`TimecodeLike` value (e.g. ``int`` f

Display/pixel aspect ratio of the VideoCapture as a float (1.0 represents square pixels).

Return a sorted list of unique frame numbers of any detected scene cuts.

Setup logging based on CLI args and user configuration settings.

Opens capture referenced by this object and resets internal state.

Save as baseline (non-progressive) sRGB JPEG. Required by Windows Installer's dialog renderer; progressive JPEGs decode as solid black at install

Parse a HH:MM:SS.mmm timecode string to seconds.

Add a SimpleTable to the page list of tables

[DEPRECATED] Use :meth:`equal_frame_rate` instead.

Find the Inkscape executable.

For testing using a callback function.

For testing using a lambda..

Get OpenCV imwrite Params: Returns a dict of supported image formats and their associated quality/compression parameter index, or None if that for

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