Struct Comparator

pub struct Comparator<P: AsRef<Path>> { /* private fields */ }

Compares two or more video files using either existing FrameHashes or by running an Analyzer in-place.

Implementations

impl<P: AsRef<Path> + Ord> Comparator<P>

pub fn from_files(videos: impl Into<Vec<P>>) -> Self

Constructs a Comparator from a list of video paths.

impl<P: AsRef<Path>> Comparator<P>

pub fn videos(&self) -> &[P]

Returns the video paths used by this comparator.

pub fn with_openings_only(self, openings_only: bool) -> Self

Returns a new Comparator with the provided openings_only.

pub fn with_hash_match_threshold(self, hash_match_threshold: u32) -> Self

Returns a new Comparator with the provided hash_match_threshold.

pub fn with_opening_search_percentage( self, opening_search_percentage: f32, ) -> Self

Returns a new Comparator with the provided opening_search_percentage.

pub fn with_ending_search_percentage( self, ending_search_percentage: f32, ) -> Self

Returns a new Comparator with the provided ending_search_percentage.

pub fn with_min_opening_duration(self, min_opening_duration: Duration) -> Self

Returns a new Comparator with the provided min_opening_duration.

pub fn with_min_ending_duration(self, min_ending_duration: Duration) -> Self

Returns a new Comparator with the provided min_ending_duration.

pub fn with_time_padding(self, time_padding: Duration) -> Self

Returns a new Comparator with the provided time_padding.

impl<P: AsRef<Path> + Sync> Comparator<P>

pub fn run_with_frame_hashes( &self, frame_hashes: Vec<FrameHashes>, display: bool, use_skip_files: bool, write_skip_files: bool, threading: bool, ) -> Result<BTreeMap<PathBuf, SearchResult>>

Exactly the same as Self::run, but uses the provided FrameHashes instead of reading from disk or analyzing in-place.

Note that the provided FrameHashes must be generated from an Analyzer using the same list of video paths.

pub fn run( &self, analyze: bool, display: bool, use_skip_files: bool, write_skip_files: bool, threading: bool, ) -> Result<BTreeMap<PathBuf, SearchResult>>

Runs the comparator.

• If analyze is set to true, an Analyzer will be built for each video file and run in-place.
• If use_skip_files is set, if a skip file already exists for a video, the video will be skipped during this run. If write_skip_files is set, a skip file will be written to disk once the comparator is completed.
• If display is set, the final results will be printed to stdout.

Trait Implementations

impl<P: Debug + AsRef<Path>> Debug for Comparator<P>

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

Formats the value using the given formatter.

impl<P: AsRef<Path>> Default for Comparator<P>

fn default() -> Self

Returns the “default value” for a type.

impl<P: AsRef<Path>> From<Analyzer<P>> for Comparator<P>

fn from(analyzer: Analyzer<P>) -> Self

Constructs a Comparator from an Analyzer. This allows you to re-use the paths and destroy the Analyzer when you’re done with it.