Release Notes

This page features release notes for releases of degirum-tools. You may download degirum-tools versions listed here from PyPI.org.

Version 1.2.0 (2/23/2026)

New Features and Modifications

1. SceneCutDetector analyzer is implemented.

   SceneCutDetector analyzer detects scene cuts in video streams by comparing frame-to-frame differences using an adaptive thresholding approach.

   Key Features:

   • Adaptive Thresholding: Uses rolling average of previous frames to adapt to gradual changes

   • HSV Color Space: Analyzes differences in hue, saturation, and luminance channels

   • Configurable Parameters: Adjustable sensitivity, minimum scene length, and window size

   • Real-time Detection: Causal approach using only past frames for zero latency

   • Scene Cut Flag: Adds scene_cut boolean attribute to inference results

   Typical Usage:

   1. Create a SceneCutDetector instance with desired parameters

   2. Attach it to a model or inference pipeline

   3. Process video frames through the analyzer

   4. Check result.scene_cut flag to detect scene transitions

   5. Use scene cut information for downstream processing or triggering actions

   Put it before ObjectTracker in the analyzer pipeline to ensure cuts are detected before tracking is applied, allowing you to reset object tracker on scene changes.

   Integration Notes:

   • Works with any inference results that contain image data

   • Can be combined with other analyzers in a pipeline

   • Useful for video segmentation, activity detection, and content analysis

   • Maintains internal state to track frame history

   Configuration Options:

   • adaptive_threshold: Sensitivity ratio for detecting cuts (higher = less sensitive)

   • min_scene_len: Minimum frames between detected cuts to avoid false positives

   • window_width: Number of previous frames for rolling average calculation

   • min_content_val: Minimum absolute change threshold for scene cuts

   • luma_only: Use only brightness changes for faster processing

2. reset_at_scene_cut parameter is added to the ObjectTracker analyzer. When True, all tracks are cleared when a scene cut is detected. Requires the result to have a scene_cut attribute (set by SceneCutDetector, see above). Use this feature to avoid tracking objects across scene transitions in videos with cuts or edits.

---

Version 1.1.0 (2/11/2026)

New Features and Modifications

1. IteratorSourceGizmo: fps constructor parameter is added. This is optional parameter with default value 0.0. It specifies the FPS value to be included in the metadata.

Bug Fixes

1. VideoStreamerGizmo: check for zero FPS is added to prevent division by zero in case of zero-FPS sources.

---

Version 1.0.0 (1/27/2026)

First official release of degirum-tools.