f67d38b35cc5
transcript_cache.rs
//! Derived transcript data survives playhead movement and UI redraws, but never project edits.
use std::ops::Range;
use std::sync::{Arc, Weak};
use filmcraft_edit::transcript::{SeqWord, paragraphs, search};
use filmcraft_engine::Session;
use filmcraft_project::{ItemId, Project};
use filmcraft_time::Tick;
#[derive(Default)]
pub(crate) struct Content {
pub words: Vec<SeqWord>,
pub paragraphs: Vec<Range<usize>>,
}
#[derive(Default)]
pub(crate) struct TranscriptCache {
// A weak key neither retains a closed project nor allows an allocation address to be reused.
project: Weak<Project>,
view: Option<ItemId>,
content: Arc<Content>,
query: Option<String>,
highlights: Arc<Vec<bool>>,
}
impl TranscriptCache {
pub fn content(&mut self, session: &Session) -> Arc<Content> {
let view = session.state.active_sequence;
let project = Arc::downgrade(&session.project);
if !self.project.ptr_eq(&project) || self.view != view {
let words = filmcraft_engine::transcript::sequence_words(session);
let paragraphs = paragraphs(&words, Tick::from_seconds_f64(1.5));
self.content = Arc::new(Content { words, paragraphs });
self.project = project;
self.view = view;
self.query = None;
}
self.content.clone()
}
pub fn highlights(&mut self, query: &str) -> Arc<Vec<bool>> {
if self.query.as_deref() != Some(query) {
let mut flags = vec![false; self.content.words.len()];
// Search ranges can overlap. Mark their union in linear time rather than checking
// every match for every word on every redraw.
let mut marked = 0;
for hit in search(&self.content.words, query) {
let start = hit.start.max(marked);
if let Some(slice) = flags.get_mut(start..hit.end) {
slice.fill(true);
}
marked = marked.max(hit.end);
}
self.highlights = Arc::new(flags);
self.query = Some(query.to_owned());
}
self.highlights.clone()
}
}
#[cfg(test)]
mod tests {
use super::*;
use serde_json::json;
#[test]
fn cached_sequence_refreshes_after_edit_undo_and_project_replacement() {
let mut s = Session::default();
s.execute("file.openDemoProject", json!({})).unwrap();
let clip = s.active_sequence().unwrap().audio_tracks[0].items[0].clone();
let transcript = |middle: &str| {
json!({"words": [
{"text": "hello", "start": clip.source_in.0, "end": clip.source_in.0 + 100},
{"text": middle, "start": clip.source_in.0 + 100, "end": clip.source_in.0 + 200},
{"text": "hello", "start": clip.source_in.0 + 200, "end": clip.source_in.0 + 300}]})
};
s.execute("transcript.set", json!({"item": clip.item.0, "transcript": transcript("hello")})).unwrap();
let mut cache = TranscriptCache::default();
let first = cache.content(&s);
assert_eq!(&*cache.highlights("hello hello"), &[true, true, true]);
assert_eq!(&*cache.highlights("missing"), &[false, false, false]);
s.set_playhead(Tick(150));
assert!(Arc::ptr_eq(&first, &cache.content(&s)));
s.execute("transcript.set", json!({"item": clip.item.0, "transcript": transcript("world")})).unwrap();
assert_eq!(cache.content(&s).words[1].text, "world");
assert_eq!(&*cache.highlights("hello hello"), &[false, false, false]);
s.undo();
assert_eq!(cache.content(&s).words[1].text, "hello");
s.execute("file.openDemoProject", json!({})).unwrap();
assert!(cache.content(&s).words.is_empty());
assert!(cache.highlights("hello").is_empty());
}
#[test]
fn changing_sequence_invalidates_content_without_a_project_edit() {
let mut s = Session::default();
s.execute("file.openDemoProject", json!({})).unwrap();
let mut cache = TranscriptCache::default();
let first = cache.content(&s);
s.state.active_sequence = None;
let empty = cache.content(&s);
assert!(!Arc::ptr_eq(&first, &empty));
assert!(empty.words.is_empty());
}
}
No file is open. Choose one in the tree, or press Ctrl+O (⌘O on a Mac) to find one by name.
Syntax highlighting could not load. The unmodified read-only text remains available above.