av-scenechange 0.23.0

Estimates frames in a video where a scenecut would be ideal
Documentation
use std::{cmp, sync::Arc};

use log::debug;
use v_frame::{frame::Frame, pixel::Pixel, plane::Plane};

use super::{ScaleFunction, SceneChangeDetector, ScenecutResult, fast_idiv};
use crate::{SceneDetectionSpeed, data::sad::sad_plane};

/// Experiments have determined this to be an optimal threshold
pub(super) const FAST_THRESHOLD: f64 = 18.0;

impl<T: Pixel> SceneChangeDetector<T> {
    /// The fast algorithm detects fast cuts using a raw difference
    /// in pixel values between the scaled frames.
    pub(super) fn fast_scenecut(
        &mut self,
        frame1: &Arc<Frame<T>>,
        frame2: &Arc<Frame<T>>,
    ) -> ScenecutResult {
        if let Some(scale_func) = &self.scale_func {
            // downscale both frames for faster comparison
            if let Some(frame_buffer) = &mut self.downscaled_frame_buffer {
                frame_buffer.swap(0, 1);
                (scale_func.downscale_in_place)(&frame2.y_plane, &mut frame_buffer[1]);
            } else {
                self.downscaled_frame_buffer = Some([
                    (scale_func.downscale)(&frame1.y_plane, frame1.bit_depth),
                    (scale_func.downscale)(&frame2.y_plane, frame2.bit_depth),
                ]);
            }

            if let Some(frame_buffer) = &self.downscaled_frame_buffer {
                let &[first, second] = &frame_buffer;
                let delta = self.delta_in_planes(first, second);

                ScenecutResult {
                    threshold: self.threshold,
                    inter_cost: delta,
                    imp_block_cost: delta,
                    forward_adjusted_cost: delta,
                    backward_adjusted_cost: delta,
                }
            } else {
                unreachable!()
            }
        } else {
            let delta = self.delta_in_planes(&frame1.y_plane, &frame2.y_plane);

            ScenecutResult {
                threshold: self.threshold,
                inter_cost: delta,
                imp_block_cost: delta,
                backward_adjusted_cost: delta,
                forward_adjusted_cost: delta,
            }
        }
    }

    /// Calculates the average sum of absolute difference (SAD) per pixel
    /// between 2 planes
    fn delta_in_planes(&self, plane1: &Plane<T>, plane2: &Plane<T>) -> f64 {
        let delta = sad_plane(plane1, plane2);

        delta as f64 / self.scaled_pixels as f64
    }
}

/// Scaling factor for frame in scene detection
pub(super) fn detect_scale_factor<T: Pixel>(
    resolution: (usize, usize),
    speed_mode: SceneDetectionSpeed,
) -> Option<ScaleFunction<T>> {
    let small_edge = cmp::min(resolution.0, resolution.1);
    let scale_func = if speed_mode == SceneDetectionSpeed::Fast {
        match small_edge {
            0..=240 => None,
            241..=480 => Some(ScaleFunction::from_scale::<2>()),
            481..=720 => Some(ScaleFunction::from_scale::<4>()),
            721..=1080 => Some(ScaleFunction::from_scale::<8>()),
            1081..=1600 => Some(ScaleFunction::from_scale::<16>()),
            1601..=usize::MAX => Some(ScaleFunction::from_scale::<32>()),
            _ => None,
        }
    } else {
        None
    };

    if let Some(scale_factor) = scale_func.as_ref().map(|x| x.factor) {
        debug!(
            "Scene detection scale factor {}, [{},{}] -> [{},{}]",
            scale_factor,
            resolution.0,
            resolution.1,
            fast_idiv(resolution.0, scale_factor),
            fast_idiv(resolution.1, scale_factor)
        );
    }

    scale_func
}