clipasm 0.3.2

A strict, typed language for compiling and rendering Video and Audio graphs
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use std::collections::{BTreeMap, BTreeSet};

use crate::compiler::evaluate::Evaluation;
use crate::compiler::{CompiledProgram, ExplainEntry, ExplainOutput};
use crate::diagnostic::{BuiltinDiagnostic, Diagnostic, Result};
use crate::model::{AudioSpec, ValueId, VideoSpec};
use crate::semantic::{CompiledNode, DraftNode, SemanticDependency, SemanticNodeKind, SymbolId};
use crate::source::{SourceUnit, Spanned};
use std::path::PathBuf;

struct SymbolFrame {
    symbol: SymbolId,
    next_target: usize,
}

pub(super) fn finalize(
    entrypoint: &SourceUnit,
    output: Option<Spanned<PathBuf>>,
    video: VideoSpec,
    audio: AudioSpec,
    evaluation: Evaluation,
    format_version: u32,
) -> Result<CompiledProgram> {
    validate_references(&evaluation)?;
    detect_cycles(&evaluation)?;
    let symbol_values = evaluation
        .symbols
        .iter()
        .map(|symbol| symbol.value.expect("every collected symbol is evaluated"))
        .collect::<Vec<_>>();
    let roots = evaluation
        .public_symbols
        .values()
        .map(|symbol| symbol_values[symbol.index()])
        .chain(evaluation.outputs.iter().copied());
    let order = super::traversal::topological_order(&evaluation.nodes, &symbol_values, roots)?;
    let domains = super::domain::infer_domains(&evaluation, &video, &order)?;
    let structure_hash = super::fingerprint::compiled_structure_hash(
        &evaluation,
        &domains,
        &video,
        audio,
        format_version,
        &order,
    )?;

    let nodes = evaluation
        .nodes
        .iter()
        .enumerate()
        .map(|(index, node)| {
            CompiledNode::from_draft(
                ValueId::new(u32::try_from(index).expect("draft node IDs already fit in u32")),
                node,
                domains[index],
            )
        })
        .collect();
    let named_values = evaluation
        .public_symbols
        .iter()
        .map(|(name, key)| {
            (
                name.clone(),
                evaluation.symbols[key.index()]
                    .value
                    .expect("every collected symbol is evaluated"),
            )
        })
        .collect();
    let explain = evaluation
        .surface
        .into_iter()
        .map(|record| ExplainEntry {
            construct: record.construct,
            outputs: record
                .outputs
                .into_iter()
                .map(|output| ExplainOutput {
                    value: output.value,
                    id: output.id,
                })
                .collect(),
            span: record.span,
        })
        .collect::<Vec<_>>();
    Ok(CompiledProgram {
        format_version,
        engine_version: env!("CARGO_PKG_VERSION").to_owned(),
        structure_hash,
        video,
        audio,
        nodes,
        outputs: evaluation.outputs,
        named_values,
        symbol_values,
        explain,
        output,
        entrypoint_source: entrypoint.source().clone(),
    })
}

fn validate_references(evaluation: &Evaluation) -> Result<()> {
    for node in &evaluation.nodes {
        if let SemanticNodeKind::Reference { symbol, .. } = node.kind() {
            let Some(binding) = evaluation.symbols.get(symbol.index()) else {
                return Err(Diagnostic::builtin(
                    BuiltinDiagnostic::MissingReference,
                    format!("reference names unknown symbol {}", symbol.index()),
                    node.origin().span.clone(),
                ));
            };
            if binding.value.is_none() {
                return Err(Diagnostic::builtin(
                    BuiltinDiagnostic::MissingReference,
                    format!("name `{}` has no compiled value", binding.name),
                    node.origin().span.clone(),
                ));
            }
            let symbol_type = binding.value_type;
            if symbol_type != node.value_type() {
                return Err(Diagnostic::builtin(
                    BuiltinDiagnostic::TypeMismatch,
                    format!(
                        "reference `${}` has type {}, but its expression was recorded as {}",
                        binding.name,
                        symbol_type,
                        node.value_type()
                    ),
                    node.origin().span.clone(),
                ));
            }
        }
    }
    Ok(())
}

fn detect_cycles(evaluation: &Evaluation) -> Result<()> {
    let references_by_value = collect_references_by_value(&evaluation.nodes);
    let mut edges = BTreeMap::<SymbolId, Vec<SymbolId>>::new();
    for index in 0..evaluation.symbols.len() {
        let symbol = SymbolId::new(u32::try_from(index).expect("symbol ID"));
        let value = evaluation.symbols[symbol.index()]
            .value
            .expect("every collected symbol is evaluated");
        edges.insert(
            symbol,
            references_by_value[value.id().get() as usize]
                .iter()
                .copied()
                .collect(),
        );
    }
    let mut states = BTreeMap::<SymbolId, u8>::new();
    let mut path = Vec::<SymbolId>::new();
    let mut positions = BTreeMap::<SymbolId, usize>::new();
    let mut stack = Vec::<SymbolFrame>::new();

    for index in 0..evaluation.symbols.len() {
        let root = SymbolId::new(u32::try_from(index).expect("symbol ID"));
        if states.get(&root).copied().unwrap_or(0) != 0 {
            continue;
        }
        states.insert(root, 1);
        positions.insert(root, 0);
        path.push(root);
        stack.push(SymbolFrame {
            symbol: root,
            next_target: 0,
        });

        while let Some(frame) = stack.last_mut() {
            if let Some(target) = edges[&frame.symbol].get(frame.next_target).copied() {
                frame.next_target += 1;
                match states.get(&target).copied().unwrap_or(0) {
                    0 => {
                        states.insert(target, 1);
                        positions.insert(target, path.len());
                        path.push(target);
                        stack.push(SymbolFrame {
                            symbol: target,
                            next_target: 0,
                        });
                    }
                    1 => {
                        let start = positions[&target];
                        let mut cycle = path[start..]
                            .iter()
                            .map(|symbol| evaluation.symbols[symbol.index()].name.clone())
                            .collect::<Vec<_>>();
                        cycle.push(evaluation.symbols[target.index()].name.clone());
                        return Err(Diagnostic::builtin(
                            BuiltinDiagnostic::DependencyCycle,
                            format!("named-value dependency cycle: {}", cycle.join(" -> ")),
                            evaluation.symbols[target.index()].declared_at.clone(),
                        ));
                    }
                    2 => {}
                    _ => unreachable!("cycle state is closed"),
                }
            } else {
                let frame = stack.pop().expect("active cycle frame");
                let popped = path.pop().expect("active cycle path");
                debug_assert_eq!(popped, frame.symbol);
                positions.remove(&frame.symbol);
                states.insert(frame.symbol, 2);
            }
        }
    }
    Ok(())
}

fn collect_references_by_value(nodes: &[DraftNode]) -> Vec<BTreeSet<SymbolId>> {
    let mut references_by_value = Vec::<BTreeSet<SymbolId>>::with_capacity(nodes.len());
    for node in nodes {
        let mut references = BTreeSet::new();
        node.kind()
            .visit_dependencies(|dependency| match dependency {
                SemanticDependency::Value(value) => {
                    let upstream = references_by_value
                        .get(value.id().get() as usize)
                        .expect("semantic value dependencies precede their consumers");
                    references.extend(upstream);
                }
                SemanticDependency::Symbol(symbol) => {
                    references.insert(symbol);
                }
            });
        references_by_value.push(references);
    }
    references_by_value
}

#[cfg(test)]
mod tests {
    use std::num::NonZeroU64;

    use super::*;
    use crate::compiler::evaluate::{SurfaceRecord, Symbol};
    use crate::model::{FrameCount, ImageFit, ValueRef, ValueType};
    use crate::semantic::{GraphBuilder, SourceOrigin};
    use crate::source::SourceSpan;

    fn origin() -> SourceOrigin {
        SourceOrigin::new("test", SourceSpan::file_start("test.clipasm"))
    }

    fn symbol(name: String, value: ValueRef) -> Symbol {
        Symbol {
            name,
            declared_at: SourceSpan::file_start("test.clipasm"),
            value: Some(value),
            timeline_view: None,
            value_type: ValueType::Video,
        }
    }

    fn make_evaluation(nodes: Vec<DraftNode>, symbols: Vec<Symbol>, root: ValueRef) -> Evaluation {
        Evaluation {
            nodes,
            symbols,
            public_symbols: BTreeMap::new(),
            surface: Vec::<SurfaceRecord>::new(),
            outputs: vec![root],
        }
    }

    #[test]
    fn detects_a_deep_named_cycle_iteratively() {
        const NAMES: usize = 20_001;
        let video = VideoSpec::default();
        let mut nodes = Vec::with_capacity(NAMES);
        let mut symbols = Vec::with_capacity(NAMES);
        let mut builder = GraphBuilder::for_program(
            &mut nodes,
            &video,
            crate::model::AudioSpec::default(),
            1,
            origin(),
        );
        let mut root = None;
        for index in 0..NAMES {
            let symbol_id = SymbolId::new(u32::try_from(index).expect("test symbol ID"));
            let target =
                SymbolId::new(u32::try_from((index + 1) % NAMES).expect("test target symbol ID"));
            let name = format!("name_{index:05}");
            let value = builder
                .reference(target, ValueType::Video)
                .expect("reference");
            root.get_or_insert(value);
            debug_assert_eq!(symbol_id.index(), symbols.len());
            symbols.push(symbol(name, value));
        }
        let evaluation = make_evaluation(nodes, symbols, root.expect("root"));

        let error = detect_cycles(&evaluation).expect_err("named cycle");

        assert_eq!(error.code, "E_DEPENDENCY_CYCLE");
        assert!(error.message.starts_with("named-value dependency cycle:"));
        assert!(error.message.ends_with("name_00000"));
    }

    #[test]
    fn reference_collection_reuses_shared_value_prefixes() {
        const NODES: usize = 20_000;
        let video = VideoSpec::default();
        let mut nodes = Vec::with_capacity(NODES + 1);
        let mut values = Vec::with_capacity(NODES + 1);
        let mut builder = GraphBuilder::for_program(
            &mut nodes,
            &video,
            crate::model::AudioSpec::default(),
            1,
            origin(),
        );
        let mut value = builder
            .image_video("source.png".into(), FrameCount(1), ImageFit::Cover)
            .expect("source");
        values.push(value);
        for _ in 0..NODES {
            value = builder
                .repeat(value, NonZeroU64::new(2).expect("nonzero"))
                .expect("repeat");
            values.push(value);
        }
        drop(builder);

        let references = collect_references_by_value(&nodes);

        assert_eq!(references.len(), values.len());
        assert!(references.iter().all(BTreeSet::is_empty));
    }

    #[test]
    fn deferred_repeat_chains_are_memoized_and_remain_deferred() {
        let video = VideoSpec::default();
        let mut nodes = Vec::new();
        let mut builder = GraphBuilder::for_program(
            &mut nodes,
            &video,
            crate::model::AudioSpec::default(),
            2,
            origin(),
        );
        let mut root = builder
            .video_source("source.mp4".into(), ImageFit::Cover)
            .expect("video source");
        for _ in 0..64 {
            root = builder
                .repeat(root, NonZeroU64::new(2).expect("nonzero"))
                .expect("repeat");
        }
        let evaluation = make_evaluation(nodes, Vec::new(), root);
        let order = super::super::traversal::topological_order(&evaluation.nodes, &[], [root])
            .expect("order");

        let domains =
            super::super::domain::infer_domains(&evaluation, &video, &order).expect("domains");

        assert_eq!(order.len(), 65);
        assert!(domains.into_iter().all(|domain| domain.is_none()));
    }

    #[test]
    fn repeat_domains_multiply_exactly_and_check_overflow() {
        let video = VideoSpec::default();
        let mut nodes = Vec::new();
        let mut builder = GraphBuilder::for_program(
            &mut nodes,
            &video,
            crate::model::AudioSpec::default(),
            2,
            origin(),
        );
        let source = builder
            .image_video("source.png".into(), FrameCount(5), ImageFit::Cover)
            .expect("source");
        let root = builder
            .repeat(source, NonZeroU64::new(3).expect("nonzero"))
            .expect("repeat");
        let evaluation = make_evaluation(nodes, Vec::new(), root);
        let order = super::super::traversal::topological_order(&evaluation.nodes, &[], [root])
            .expect("order");
        let domains =
            super::super::domain::infer_domains(&evaluation, &video, &order).expect("domains");
        assert_eq!(
            domains[root.id().get() as usize]
                .as_ref()
                .expect("known repeat")
                .frames(),
            FrameCount(15)
        );

        let mut nodes = Vec::new();
        let mut builder = GraphBuilder::for_program(
            &mut nodes,
            &video,
            crate::model::AudioSpec::default(),
            2,
            origin(),
        );
        let source = builder
            .image_video("huge.png".into(), FrameCount(u64::MAX), ImageFit::Cover)
            .expect("source");
        let root = builder
            .repeat(source, NonZeroU64::new(2).expect("nonzero"))
            .expect("repeat");
        let evaluation = make_evaluation(nodes, Vec::new(), root);
        let order = super::super::traversal::topological_order(&evaluation.nodes, &[], [root])
            .expect("order");
        let error =
            super::super::domain::infer_domains(&evaluation, &video, &order).expect_err("overflow");
        assert_eq!(error.code, "E_FRAME_OVERFLOW");
    }
}