Skip to content

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

fix(script): forward ImportOptions.importAs for layered PSD imports (#838)

Nigel Ihza Firdausy8b25dc713fff
diff --git a/crates/script/Cargo.toml b/crates/script/Cargo.toml
index ef756107c..85c8f35bb 100644
--- a/crates/script/Cargo.toml
+++ b/crates/script/Cargo.toml
@@ -25,3 +25,4 @@ boa_engine = { workspace = true, features = ["js"] }
[dev-dependencies]
effectcraft-expr = { workspace = true }
+effectcraft-psd = { workspace = true }
diff --git a/crates/script/src/prelude.js b/crates/script/src/prelude.js
index f50a968c5..2d0002dcb 100644
--- a/crates/script/src/prelude.js
+++ b/crates/script/src/prelude.js
@@ -67,6 +67,9 @@ var MaskMode = __enum("MaskMode", ["NONE", "ADD", "SUBTRACT", "INTERSECT", "LIGH
var RQItemStatus = __enum("RQItemStatus", ["WILL_CONTINUE", "NEEDS_OUTPUT", "UNQUEUED", "QUEUED", "RENDERING", "USER_STOPPED", "ERR_STOPPED", "DONE"], 3012);
var CloseOptions = __enum("CloseOptions", ["DO_NOT_SAVE_CHANGES", "PROMPT_TO_SAVE_CHANGES", "SAVE_CHANGES"], 1212);
var ImportAsType = __enum("ImportAsType", ["COMP_CROPPED_LAYERS", "FOOTAGE", "COMP", "PROJECT"], 3812);
+// Accept the longer names used by some ExtendScript hosts.
+ImportAsType.COMPOSITION_CROPPED_LAYERS = ImportAsType.COMP_CROPPED_LAYERS;
+ImportAsType.COMPOSITION = ImportAsType.COMP;
var TimeDisplayType = __enum("TimeDisplayType", ["FRAMES", "TIMECODE"], 2012);
var LogType = __enum("LogType", ["ERRORS_ONLY", "ERRORS_AND_SETTINGS", "ERRORS_AND_PER_FRAME_INFO"], 3212);
var KeyframeLabel = __enum("KeyframeLabel", ["NONE"], 0);
@@ -1674,7 +1677,11 @@ function ImportOptions(file) {
this.rangeStart = 0;
this.rangeEnd = 0;
}
-ImportOptions.prototype.canImportAs = function (t) { return t === ImportAsType.FOOTAGE; };
+ImportOptions.prototype.canImportAs = function (t) {
+ if (t === ImportAsType.FOOTAGE) return true;
+ return (t === ImportAsType.COMP || t === ImportAsType.COMP_CROPPED_LAYERS) &&
+ /\.(psd|psb|pdf|ai|eps)$/i.test(__str(this.file));
+};
function Project() {}
Project.prototype = {
@@ -1728,10 +1735,19 @@ Project.prototype = {
if (!f) throw __err("importFile(): no file");
var args = { paths: [__str(f)] };
// After Effects imports just the picked file unless ImportOptions.sequence is set.
- if (opts instanceof ImportOptions) args.sequence = !!opts.sequence;
+ if (opts instanceof ImportOptions) {
+ args.sequence = !!opts.sequence;
+ switch (opts.importAs) {
+ case ImportAsType.FOOTAGE: args.importAs = "footage"; break;
+ case ImportAsType.COMP: args.importAs = "composition"; break;
+ case ImportAsType.COMP_CROPPED_LAYERS: args.importAs = "compositionLayerSizes"; break;
+ default: throw __err("importFile(): unsupported ImportOptions.importAs value " + opts.importAs);
+ }
+ }
var r = __call("file.import", args);
if (r.errors && r.errors.length) throw __err(r.errors.join("; "));
- return __item(r.items[0]);
+ // Composition imports create several footage items, but callers need the comp.
+ return __item(r.comps && r.comps.length ? r.comps[0] : r.items[0]);
},
importFileWithDialog: function () { return null; },
importPlaceholder: function (name, w, h, rate, dur) {
diff --git a/crates/script/src/tests.rs b/crates/script/src/tests.rs
index b50a7bfb2..2fb5d381b 100644
--- a/crates/script/src/tests.rs
+++ b/crates/script/src/tests.rs
@@ -730,3 +730,32 @@ fn import_options_sequence_picks_one_still_or_the_run() {
assert_eq!(kind_of(&s, "shot_[0001-0003].png"), FootageKind::Sequence);
let _ = std::fs::remove_dir_all(&dir);
}
+
+#[test]
+fn import_options_preserve_layered_psd_compositions() {
+ use effectcraft_psd::Rect;
+ use effectcraft_psd::write::{WDoc, WLayer, write};
+
+ let dir = std::env::temp_dir().join(format!("ec-script-import-as-{}", std::process::id()));
+ std::fs::create_dir_all(&dir).unwrap();
+ let source = dir.join("layers.psd");
+ let mut doc = WDoc::new(12, 12);
+ doc.layers.push(WLayer::solid("Background", Rect::new(0, 0, 12, 12), [1.0, 1.0, 1.0, 1.0]));
+ doc.layers.push(WLayer::solid("Accent", Rect::new(2, 2, 4, 4), [0.0, 0.4, 1.0, 1.0]));
+ std::fs::write(&source, write(&doc)).unwrap();
+ let file = serde_json::to_string(&source.to_string_lossy()).unwrap();
+ let mut s = session();
+ let o = ok(
+ &mut s,
+ &format!(
+ "var io = new ImportOptions(new File({file})); io.importAs = ImportAsType.COMPOSITION_CROPPED_LAYERS; \
+ [io.canImportAs(io.importAs), app.project.importFile(io).typeName]"
+ ),
+ );
+ assert_eq!(o.result, json!([true, "Composition"]));
+ let imported = s.project.comps().next().unwrap().1;
+ assert_eq!(imported.layers.len(), 2);
+ let bad = ok(&mut s, &format!("new ImportOptions(new File({file})).canImportAs(ImportAsType.PROJECT)"));
+ assert_eq!(bad.result, json!(false));
+ let _ = std::fs::remove_dir_all(&dir);
+}