tellers-timeline-core 0.1.0

An OpenTimelineIO timeline engine with policy-driven editing, sync, sanitization, and effect conventions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

use std::collections::HashMap;
use tellers_timeline_core::{
    Clip, IdMetadataExt, Item, MediaReference, RationalTime, Stack, TimeRange, Timeline, Track,
};

fn make_clip(name: &str, duration: f64, media_start: f64) -> Item {
    let sr = TimeRange {
        otio_schema: "TimeRange.1".to_string(),
        duration: RationalTime {
            otio_schema: "RationalTime.1".to_string(),
            rate: 1.0,
            value: duration,
        },
        start_time: RationalTime {
            otio_schema: "RationalTime.1".to_string(),
            rate: 1.0,
            value: media_start,
        },
    };
    let mut refs: HashMap<String, MediaReference> = HashMap::new();
    refs.insert(
        "DEFAULT_MEDIA".to_string(),
        MediaReference::ExternalReference {
            target_url: "media://dummy".to_string(),
            available_range: None,
            name: None,
            available_image_bounds: None,
            metadata: serde_json::Value::Null,
        },
    );
    Item::Clip(Clip {
        otio_schema: "Clip.2".to_string(),
        enabled: true,
        name: Some(name.to_string()),
        source_range: sr,
        media_references: refs,
        active_media_reference_key: Some("DEFAULT_MEDIA".to_string()),
        metadata: serde_json::Value::Null,
        effects: Vec::new(),
        markers: Vec::new(),
    })
}

#[test]
fn delete_clip_by_index_no_gap() {
    let mut track = Track::default();
    let mut c1 = match make_clip("c1", 5.0, 0.0) {
        Item::Clip(c) => c,
        _ => unreachable!(),
    };
    c1.set_id(Some("c1".to_string()));
    let c2 = make_clip("c2", 3.0, 0.0);
    track.items.push(Item::Clip(c1.clone()));
    track.items.push(c2.clone());
    let mut stack = Stack {
        children: vec![track],
        ..Stack::default()
    };

    let deleted = stack.delete_item("c1", false, true);
    assert_eq!(deleted.len(), 1);
    let track = &stack.children[0];
    assert_eq!(track.items.len(), 1);
    match &track.items[0] {
        Item::Clip(c) => assert!((c.source_range.duration.value - 3.0).abs() < 1e-9),
        _ => panic!("expected clip"),
    }
}

#[test]
fn delete_clip_by_index_with_gap_and_merge() {
    let mut track = Track::default();
    let mut c1 = make_clip("c1", 5.0, 0.0);
    c1.set_id(Some("c1".to_string()));
    track.items.push(c1);
    track
        .items
        .push(Item::Gap(tellers_timeline_core::Gap::make_gap(2.0)));
    track.items.push(make_clip("c2", 3.0, 0.0));
    let mut stack = Stack {
        children: vec![track],
        ..Stack::default()
    };

    let deleted = stack.delete_item("c1", true, true);
    assert_eq!(deleted.len(), 1);
    let track = &stack.children[0];
    // Expect leading gap of 5.0 merged with following 2.0 -> 7.0, then c2
    assert_eq!(track.items.len(), 2);
    match (&track.items[0], &track.items[1]) {
        (Item::Gap(g), Item::Clip(c2)) => {
            assert!((g.source_range.duration.value - 7.0).abs() < 1e-9);
            assert!((c2.source_range.duration.value - 3.0).abs() < 1e-9);
        }
        _ => panic!("unexpected items: {:#?}", track.items),
    }
}

#[test]
fn delete_clip_via_getter_with_gap() {
    let mut track = Track::default();
    // Build two clips and set an id on the first
    let mut c1 = match make_clip("c1", 4.0, 0.0) {
        Item::Clip(c) => c,
        _ => unreachable!(),
    };
    let id = "id-c1".to_string();
    c1.set_id(Some(id.clone()));
    track.items.push(Item::Clip(c1));
    track.items.push(make_clip("c2", 6.0, 0.0));
    let mut stack = Stack {
        children: vec![track],
        ..Stack::default()
    };

    let deleted = stack.delete_item(&id, true, true);
    assert_eq!(deleted.len(), 1);
    let track = &stack.children[0];
    // Expect gap(4.0) then c2, and no adjacent gaps to merge
    assert_eq!(track.items.len(), 2);
    match (&track.items[0], &track.items[1]) {
        (Item::Gap(g), Item::Clip(c2)) => {
            assert!((g.source_range.duration.value - 4.0).abs() < 1e-9);
            assert!((c2.source_range.duration.value - 6.0).abs() < 1e-9);
        }
        _ => panic!("unexpected items: {:#?}", track.items),
    }
}

#[test]
fn delete_item_sanitizes_stack_after_successful_delete() {
    let mut track = Track::default();
    let mut c1 = make_clip("c1", 4.0, 0.0);
    let mut c2 = make_clip("c2", 3.0, 0.0);
    c1.set_id(Some("c1".to_string()));
    c2.set_id(Some("c2".to_string()));
    track.items.push(c1);
    track.items.push(c2);
    track
        .items
        .push(Item::Gap(tellers_timeline_core::Gap::make_gap(2.0)));
    let mut stack = Stack {
        children: vec![track],
        ..Stack::default()
    };

    let deleted = stack.delete_item("c2", false, true);

    assert_eq!(deleted.len(), 1);
    assert_eq!(stack.children[0].items.len(), 1);
    assert!(matches!(stack.children[0].items[0], Item::Clip(_)));
}

fn fixture_path(name: &str) -> std::path::PathBuf {
    std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("tests/fixtures")
        .join(name)
}

fn track_index_by_id(stack: &Stack, id: &str) -> usize {
    stack
        .children
        .iter()
        .position(|track| track.get_id().as_deref() == Some(id))
        .unwrap_or_else(|| panic!("track {id:?} not found"))
}

fn assert_item_span(track: &Track, item_index: usize, expected_start: f64, expected_duration: f64) {
    let start = track.start_time_of_item(item_index);
    let duration = track.items[item_index].duration();
    assert!(
        (start - expected_start).abs() < 1e-9,
        "item {item_index} start: got {start}, expected {expected_start}"
    );
    assert!(
        (duration - expected_duration).abs() < 1e-9,
        "item {item_index} duration: got {duration}, expected {expected_duration}"
    );
}

#[test]
fn delete_new_project_clip_454bfdad4796_without_gap_collapses_sync_cluster() {
    let json = std::fs::read_to_string(fixture_path("new_project_delete.otio")).expect("fixture");
    let mut tl: Timeline = serde_json::from_str(&json).expect("parse");
    tl.sanitize();

    let removed = tl.tracks.delete_item("454bfdad4796", false, true);
    assert_eq!(removed.len(), 2);
    assert!(tl.tracks.get_item("454bfdad4796").is_none());
    assert!(tl.tracks.get_item("4f85c014f851").is_some());
    assert!(tl.tracks.get_item("6f5b5c689849").is_some());

    let video = track_index_by_id(&tl.tracks, "536db79b4178");
    let audio = track_index_by_id(&tl.tracks, "A3");
    let other_video = track_index_by_id(&tl.tracks, "20c3a044a84b");

    let video_track = &tl.tracks.children[video];
    assert_eq!(video_track.items.len(), 1);
    assert_item_span(video_track, 0, 0.0, 47.0);
    assert_eq!(video_track.items[0].get_id().as_deref(), Some("4f85c014f851"));

    let audio_track = &tl.tracks.children[audio];
    assert_eq!(audio_track.items.len(), 1);
    assert_item_span(audio_track, 0, 0.0, 47.0);
    assert_eq!(audio_track.items[0].get_id().as_deref(), Some("6f5b5c689849"));

    let other_video_track = &tl.tracks.children[other_video];
    assert_eq!(other_video_track.items.len(), 2);
    assert_item_span(other_video_track, 0, 0.0, 5.0);
    assert_item_span(other_video_track, 1, 5.0, 43.96);
}