Skip to content

EffectCraft: An open-source motion graphics and compositing tool written by scratch in pure Rust

Merge pull request #1043 from vbasky/fix/1000-sampleimage-footage

Brandon Thomas0e4f3bfb8f70
diff --cc crates/script/src/tests.rs
index bfffdee59,0ef923f62..71d3843f2
--- a/crates/script/src/tests.rs
+++ b/crates/script/src/tests.rs
@@@ -776,43 -731,42 +776,79 @@@ fn import_options_sequence_picks_one_st
let _ = std::fs::remove_dir_all(&dir);
}
+/// #813: FootageItem proxies, replaceWithSequence and mainSource.conformFrameRate.
+#[test]
+fn footage_proxies_sequences_and_conform_rate() {
+ use effectcraft_engine::project::ItemKind;
+ let dir = std::env::temp_dir().join(format!("ec-script-proxy-{}", std::process::id()));
+ std::fs::create_dir_all(&dir).unwrap();
+ for n in ["shot_0001.png", "shot_0002.png", "take_0001.png", "take_0002.png", "proxy.png"] {
+ std::fs::write(dir.join(n), b"").unwrap();
+ }
+ let p = |n: &str| dir.join(n).to_string_lossy().replace('\\', "/");
+ let mut s = session();
+ s.importer = Some(Arc::new(Stills));
+ let o = ok(
+ &mut s,
+ &format!(
+ "var io = new ImportOptions(new File('{}')); io.sequence = true; var item = app.project.importFile(io);\
+ var same = item.mainSource === item.mainSource;\
+ item.mainSource.conformFrameRate = 12; var c12 = item.mainSource.conformFrameRate, fr = item.frameRate;\
+ item.mainSource.conformFrameRate = 0; var c0 = item.mainSource.conformFrameRate;\
+ var before = [item.useProxy, item.proxySource];\
+ item.setProxy(new File('{}')); var set = [item.useProxy, item.proxySource.file.name];\
+ item.useProxy = false; var off = item.useProxy;\
+ item.setProxyToNone(); var none = item.proxySource;\
+ item.replaceWithSequence(new File('{}'), false);\
+ [same, c12, fr, c0, before[0], before[1], set[0], set[1], off, none]",
+ p("shot_0001.png"),
+ p("proxy.png"),
+ p("take_0001.png")
+ ),
+ );
+ assert_eq!(o.result, json!([true, 12, 12, 0, false, null, true, "proxy.png", false, null]));
+ let paths: Vec<String> =
+ s.project.items.values().filter_map(|i| if let ItemKind::Footage(f) = &i.kind { Some(f.path.replace('\\', "/")) } else { None }).collect();
+ assert!(paths.iter().any(|f| f.contains("take_")), "replaced with the take sequence: {paths:?}");
+ let _ = std::fs::remove_dir_all(&dir);
+}
+
+ /// A flat green footage source, so `sampleImage` on a footage layer has known pixels.
+ struct Flat;
+ impl effectcraft_engine::render::FootageSource for Flat {
+ fn frame(
+ &self,
+ _item: effectcraft_engine::project::ItemId,
+ f: &effectcraft_engine::project::Footage,
+ _t: effectcraft_engine::time::Tick,
+ ) -> Option<Arc<effectcraft_engine::render::Image>> {
+ Some(Arc::new(effectcraft_engine::render::Image::filled(f.width.max(1), f.height.max(1), [0.0, 1.0, 0.0, 1.0])))
+ }
+ }
+
+ /// `sampleImage` on a footage layer reads the footage's pixels from a script, not transparent
+ /// black: the expression evaluator needs the session's footage source (#1000).
+ #[test]
+ fn sample_image_reads_footage_pixels_in_scripts() {
+ let mut s = session();
+ s.footage = Arc::new(Flat);
+ s.importer = Some(Arc::new(Stills));
+ let out = ok(
+ &mut s,
+ r#"
+ var comp = app.project.items.addComp("Scene", 640, 360, 1, 1, 25);
+ comp.openInViewer();
+ var img = comp.layers.add(app.project.importFile(new ImportOptions(new File("/tmp/ec-flat.png"))));
+ img.name = "Img";
+ var cc = comp.layers.addNull().property("ADBE Effect Parade").addProperty("ADBE Color Control").property(1);
+ cc.expression = 'thisComp.layer("Img").sampleImage([32, 16], [0.5, 0.5], true, time);';
+ var v = cc.valueAtTime(0, false);
+ [v[0], v[1], v[2], v[3], cc.expressionError];
+ "#,
+ );
+ assert_eq!(out.result, json!([0, 1, 0, 1, ""]), "green footage sampled, not transparent black");
+ }
+
#[test]
fn binary_file_io_preserves_all_byte_values() {
let dir = std::env::temp_dir().join(format!("ec-script-binary-{}", std::process::id()));