Skip to main content

NonMonotonicDetector

Struct NonMonotonicDetector 

Source
pub struct NonMonotonicDetector { /* private fields */ }
Expand description

Scans a timecode sequence and reports positions where the timecode does not advance monotonically by the expected one frame per step.

Only jumps whose absolute value exceeds threshold_frames are reported, so callers can ignore minor jitter (e.g. threshold_frames = 0 reports every non-unit step; threshold_frames = 1 only reports jumps ≥ 2 frames).

§Example

use oximedia_timecode::{Timecode, FrameRate};
use oximedia_timecode::tc_validator::NonMonotonicDetector;

let tc0 = Timecode::new(0, 0, 0, 0, FrameRate::Fps25)?;
let tc1 = Timecode::new(0, 0, 2, 0, FrameRate::Fps25)?; // 2-second jump
let events = NonMonotonicDetector::new(1).scan_sequence(&[tc0, tc1]);
assert_eq!(events.len(), 1);
assert_eq!(events[0].frame_index, 1);

Implementations§

Source§

impl NonMonotonicDetector

Source

pub fn new(threshold_frames: i64) -> Self

Create a new detector with the given threshold.

threshold_frames is the exclusive lower bound on |jump| for events to be emitted. Set to 0 to report every non-unit step.

Source

pub fn scan_sequence(self, timecodes: &[Timecode]) -> Vec<NonMonotonicEvent>

Scan timecodes and return all non-monotonic events.

The slice must contain at least 2 elements for any events to be produced; a slice of 0 or 1 elements always returns an empty Vec.

Trait Implementations§

Source§

impl Clone for NonMonotonicDetector

Source§

fn clone(&self) -> NonMonotonicDetector

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NonMonotonicDetector

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.