Skip to main content

rightkit_transcript/
align.rs

1//! Word-boundary alignment check (used by qualifiers).
2
3use crate::segment::{normalize_words, Cue};
4use crate::words::TimedWord;
5
6/// Default tolerance between a cue edge and the nearest word boundary.
7pub const ALIGNMENT_TOLERANCE_MS: u64 = 100;
8
9#[derive(Debug, Clone, PartialEq, Eq)]
10pub enum AlignmentIssue {
11    StartNotOnWord { cue: usize, start_ms: u64 },
12    EndNotOnWord { cue: usize, end_ms: u64 },
13    Overlap { cue: usize },
14    Empty { cue: usize },
15}
16
17/// Checks that every cue edge lies on a word boundary (within `tolerance_ms`),
18/// that cues are non-empty and do not overlap. Empty result means aligned.
19pub fn check_alignment(
20    cues: &[Cue],
21    words: &[TimedWord],
22    tolerance_ms: u64,
23) -> Vec<AlignmentIssue> {
24    let words = normalize_words(words);
25    let near =
26        |t: u64, f: fn(&TimedWord) -> u64| words.iter().any(|w| f(w).abs_diff(t) <= tolerance_ms);
27    let mut issues = Vec::new();
28    for (i, c) in cues.iter().enumerate() {
29        if c.end_ms <= c.start_ms {
30            issues.push(AlignmentIssue::Empty { cue: i });
31        }
32        if !near(c.start_ms, |w| w.start_ms) {
33            issues.push(AlignmentIssue::StartNotOnWord {
34                cue: i,
35                start_ms: c.start_ms,
36            });
37        }
38        if !near(c.end_ms, |w| w.end_ms) {
39            issues.push(AlignmentIssue::EndNotOnWord {
40                cue: i,
41                end_ms: c.end_ms,
42            });
43        }
44        if i > 0 && cues[i - 1].end_ms > c.start_ms {
45            issues.push(AlignmentIssue::Overlap { cue: i });
46        }
47    }
48    issues
49}