mirror of
https://github.com/storytold/effectcraft.git
synced 2026-10-25 10:36:56 -06:00
bflatasticandClaude Opus 5.5
69dc1b26fb
Importing a glTF / OBJ model opened Interpret Footage: the probe reports straight alpha and the file has no alpha label, so with Settings ▸ Import ▸ Interpret Unlabeled Alpha As at Ask User (the default) the model was listed as unlabeled. Only image footage (stills, sequences, video) can have unlabeled alpha; a model renders its own, and audio and data have none. Test: importing_a_model_does_not_ask_about_alpha (engine). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
720 lines
34 KiB
Rust
720 lines
34 KiB
Rust
//! File menu.
|
||
|
||
use effectcraft_color::Label;
|
||
use effectcraft_project::{FootageKind, ItemId, ItemKind, LayerSource, Project};
|
||
use serde_json::{Value, json};
|
||
|
||
use super::{CommandSpec, always, b_p, bad, str_p};
|
||
use crate::{EngineError, Result, Session, cmd};
|
||
|
||
fn has_path(s: &Session) -> std::result::Result<(), String> {
|
||
if s.path.is_some() { Ok(()) } else { Err("the project has not been saved yet".into()) }
|
||
}
|
||
|
||
fn new_project(s: &mut Session, _: &Value) -> Result<Value> {
|
||
// Settings ▸ Project ▸ New Project Loads Template: open the template as an untitled project.
|
||
let tpl = s.prefs.project.template_path.trim().to_string();
|
||
if s.prefs.project.use_template && !tpl.is_empty() {
|
||
let bytes = s.services.read_file(&tpl).map_err(|e| EngineError::Other(format!("cannot read the new project template {tpl}: {e}")))?;
|
||
let text = String::from_utf8(bytes).map_err(|_| EngineError::Other("the new project template is not a project file".into()))?;
|
||
s.replace_project(Project::from_json(&text)?, None);
|
||
s.update_sentinel();
|
||
return Ok(json!({"template": tpl}));
|
||
}
|
||
s.replace_project(Project::default(), None);
|
||
s.update_sentinel();
|
||
Ok(Value::Null)
|
||
}
|
||
|
||
fn demo(s: &mut Session, _: &Value) -> Result<Value> {
|
||
let p = crate::demo::demo_project();
|
||
s.replace_project(p, None);
|
||
if let Some(id) = s.project.items.values().find(|i| i.name == crate::demo::MAIN_COMP).map(|i| i.id) {
|
||
s.open_comp(id);
|
||
s.set_time(effectcraft_time::Tick::from_seconds_f64(2.5));
|
||
}
|
||
Ok(json!({"comp": s.state.active_comp.map(|c| c.0)}))
|
||
}
|
||
|
||
pub(crate) fn open(s: &mut Session, p: &Value) -> Result<Value> {
|
||
let path = str_p(p, "path").ok_or_else(|| bad("file.open", "missing `path`"))?;
|
||
let bytes = s.services.read_file(path).map_err(|e| EngineError::Other(format!("cannot read {path}: {e}")))?;
|
||
let text = String::from_utf8(bytes).map_err(|_| EngineError::Other("not a text project file".into()))?;
|
||
// XML copies (File ▸ Save a Copy As XML…) open like the JSON project.
|
||
let text = if crate::xml_project::is_xml(&text) { crate::xml_project::from_xml(&text).map_err(EngineError::Other)? } else { text };
|
||
let proj = Project::from_json(&text).map_err(|e| EngineError::Other(format!("{path} is not a project EffectCraft can open: {e}")))?;
|
||
s.replace_project(proj, Some(path.to_string()));
|
||
s.note_project_path(path);
|
||
// Written by a newer EffectCraft: what this version doesn't know would be lost on saving.
|
||
let saved_by = effectcraft_project::saved_by(&text);
|
||
if let Some(v) = saved_by.as_deref().filter(|v| effectcraft_project::is_newer_version(v, effectcraft_project::APP_VERSION)) {
|
||
s.toast(format!(
|
||
"This project was saved by EffectCraft {v}, newer than this version ({}). Settings this version doesn't know are lost if you save it.",
|
||
effectcraft_project::APP_VERSION
|
||
));
|
||
}
|
||
// Lazy open: footage is checked in the background (Progress panel), not before the
|
||
// project shows.
|
||
if s.check_footage_on_open {
|
||
crate::footage_check::start(s, None, false)?;
|
||
}
|
||
Ok(json!({"path": path, "savedBy": saved_by}))
|
||
}
|
||
|
||
/// The project file's text for `path`: `.ecproj` JSON, or XML for `.ecprojx` / `.xml` (a
|
||
/// project opened from an XML copy saves as XML again). Fails, writing nothing, when the project
|
||
/// wouldn't read back.
|
||
pub(crate) fn file_text(s: &Session, path: &str) -> Result<String> {
|
||
let json = s.project.to_file_json()?;
|
||
if crate::xml_project::is_xml_path(path) { crate::xml_project::to_xml(&json).map_err(EngineError::Other) } else { Ok(json) }
|
||
}
|
||
|
||
fn save_to(s: &mut Session, path: &str) -> Result<Value> {
|
||
let json = file_text(s, path)?;
|
||
s.services.write_file(path, json.as_bytes()).map_err(|e| EngineError::Other(format!("cannot write {path}: {e}")))?;
|
||
s.path = Some(path.to_string());
|
||
s.mark_saved();
|
||
s.note_project_path(path);
|
||
s.toast(format!("Saved {path}"));
|
||
Ok(json!({"path": path, "bytes": json.len()}))
|
||
}
|
||
|
||
fn save(s: &mut Session, p: &Value) -> Result<Value> {
|
||
let path = str_p(p, "path").map(str::to_string).or_else(|| s.path.clone()).ok_or_else(|| bad("file.save", "no path: use file.saveAs {path}"))?;
|
||
save_to(s, &path)
|
||
}
|
||
|
||
fn save_as(s: &mut Session, p: &Value) -> Result<Value> {
|
||
let path = str_p(p, "path").ok_or_else(|| bad("file.saveAs", "missing `path`"))?;
|
||
save_to(s, path)
|
||
}
|
||
|
||
fn increment_save(s: &mut Session, _: &Value) -> Result<Value> {
|
||
let cur = s.path.clone().ok_or_else(|| bad("file.incrementAndSave", "save the project first"))?;
|
||
// After Effects: `Intro.aep` → `Intro 2.aep` → `Intro 3.aep`.
|
||
let next = crate::autosave::increment_path(&cur, |p| s.file_ops().is_file(std::path::Path::new(p)));
|
||
save_to(s, &next)
|
||
}
|
||
|
||
fn revert(s: &mut Session, _: &Value) -> Result<Value> {
|
||
let path = s.path.clone().ok_or_else(|| bad("file.revert", "not saved"))?;
|
||
open(s, &json!({"path": path}))
|
||
}
|
||
|
||
/// File ▸ Import; with `addToComp` (files dropped on the Timeline or the Composition viewer) they
|
||
/// also become layers of the active comp ([`add_to_comp`]).
|
||
///
|
||
/// With `background` (files dropped on the window or picked in the Import dialog) the files are
|
||
/// probed on a background thread, so decoding a slow video doesn't freeze the app: the job shows
|
||
/// the file being read and how many are left (Window ▸ Progress, `jobs.list`), then adds them in
|
||
/// one undo step, selects them and reports how many arrived ("Imported 3 items").
|
||
fn import_cmd(s: &mut Session, p: &Value) -> Result<Value> {
|
||
let target = s.active_comp_id();
|
||
let mut pending = prepare_import(s, p)?;
|
||
if b_p(p, "background").unwrap_or(false) && !pending.paths.is_empty() {
|
||
let paths = std::mem::take(&mut pending.paths);
|
||
let total = paths.len();
|
||
let label = match paths.first() {
|
||
Some(one) if total == 1 => format!("Importing {}", file_name(one)),
|
||
_ => format!("Importing {total} files"),
|
||
};
|
||
let p = p.clone();
|
||
return s.spawn_task("import", label, false, move |ctl| {
|
||
let mut probed = Vec::with_capacity(total);
|
||
for (k, path) in paths.into_iter().enumerate() {
|
||
ctl.message(format!("{} ({} of {total})", file_name(&path), k + 1));
|
||
if !ctl.progress(k as u64, total as u64) {
|
||
return Err(crate::render_queue::CANCELLED.into());
|
||
}
|
||
let r = pending.prober.probe(&path);
|
||
probed.push(r);
|
||
}
|
||
ctl.progress(total as u64, total as u64);
|
||
let apply: crate::jobs::Apply = Box::new(move |s: &mut Session| {
|
||
let made = pending.comps.len() + probed.iter().filter(|r| r.is_ok()).count();
|
||
let mut r = add_footage(s, pending, probed)?;
|
||
finish_import(s, &mut r, target, &p);
|
||
let mut toast = format!("Imported {made} item{}", if made == 1 { "" } else { "s" });
|
||
let errors: Vec<&str> = r["errors"].as_array().into_iter().flatten().filter_map(Value::as_str).collect();
|
||
match errors.as_slice() {
|
||
[] => {}
|
||
[one] => toast = format!("{toast}. {one}"),
|
||
[first, rest @ ..] => toast = format!("{toast}. {first} (and {} more)", rest.len()),
|
||
}
|
||
r["toast"] = json!(toast);
|
||
Ok(r)
|
||
});
|
||
Ok(apply)
|
||
});
|
||
}
|
||
let probed = pending.paths.iter().map(|path| pending.prober.probe(path)).collect();
|
||
let mut r = add_footage(s, pending, probed)?;
|
||
finish_import(s, &mut r, target, p);
|
||
Ok(r)
|
||
}
|
||
|
||
/// The file name of a path, for labels.
|
||
fn file_name(path: &str) -> String {
|
||
std::path::Path::new(path).file_name().map(|n| n.to_string_lossy().to_string()).unwrap_or_else(|| path.to_string())
|
||
}
|
||
|
||
/// After an import (its result `r`): with `addToComp`, the new items become layers of `target`;
|
||
/// what couldn't be added joins the result's errors.
|
||
fn finish_import(s: &mut Session, r: &mut Value, target: Option<ItemId>, p: &Value) {
|
||
let errors = add_to_comp(s, r, target, p);
|
||
if !errors.is_empty()
|
||
&& let Some(e) = r.get_mut("errors").and_then(Value::as_array_mut)
|
||
{
|
||
e.extend(errors.into_iter().map(Value::from));
|
||
}
|
||
}
|
||
|
||
/// With `addToComp`, put what an import (its result `r`) made into `target`, the comp that was
|
||
/// active before it, one layer under the other, at the drop's `time`, `index` and `position`
|
||
/// (as in `layer.addItem`): the comps of layered files (their layers' footage stays in the
|
||
/// Project panel) and the other footage. `target` stays open. Returns what couldn't be added.
|
||
pub(crate) fn add_to_comp(s: &mut Session, r: &Value, target: Option<ItemId>, p: &Value) -> Vec<String> {
|
||
let Some(cid) = target.filter(|_| p.get("addToComp").and_then(Value::as_bool).unwrap_or(false)) else { return vec![] };
|
||
let ids = |k: &str| r.get(k).and_then(Value::as_array).into_iter().flatten().filter_map(Value::as_u64).collect::<Vec<u64>>();
|
||
let comps = ids("comps");
|
||
let in_comps: std::collections::HashSet<u64> = comps
|
||
.iter()
|
||
.filter_map(|c| s.project.comp(ItemId(*c)))
|
||
.flat_map(|c| c.layers.iter())
|
||
.filter_map(|l| match l.source {
|
||
LayerSource::Footage { item } | LayerSource::Comp { item } | LayerSource::Solid { item } => Some(item.0),
|
||
_ => None,
|
||
})
|
||
.collect();
|
||
let add: Vec<u64> = comps.iter().copied().chain(ids("items").into_iter().filter(|i| !in_comps.contains(i))).collect();
|
||
let mut errors = vec![];
|
||
for (k, item) in add.into_iter().enumerate() {
|
||
let mut params = json!({"comp": cid.0, "item": item, "time": p.get("time"), "position": p.get("position")});
|
||
if let Some(i) = p.get("index").and_then(Value::as_u64) {
|
||
params["index"] = json!(i.saturating_add(k as u64));
|
||
}
|
||
if let Err(e) = s.execute("layer.addItem", params) {
|
||
errors.push(e.to_string());
|
||
}
|
||
}
|
||
if s.active_comp_id() != Some(cid) {
|
||
s.open_comp(cid);
|
||
}
|
||
errors
|
||
}
|
||
|
||
/// File ▸ Import, all in one go (scripts and commands built on it); see [`import_cmd`].
|
||
pub(crate) fn import(s: &mut Session, p: &Value) -> Result<Value> {
|
||
let pending = prepare_import(s, p)?;
|
||
let probed = pending.paths.iter().map(|path| pending.prober.probe(path)).collect();
|
||
add_footage(s, pending, probed)
|
||
}
|
||
|
||
/// An import whose layered files are already compositions: the files left to probe as footage,
|
||
/// how, and what the import made so far.
|
||
struct PendingImport {
|
||
paths: Vec<String>,
|
||
prober: Prober,
|
||
comps: Vec<u64>,
|
||
items: Vec<u64>,
|
||
errors: Vec<String>,
|
||
}
|
||
|
||
/// Everything probing a file needs, apart from the session (it can run on a background thread).
|
||
struct Prober {
|
||
importer: Option<std::sync::Arc<dyn crate::Importer>>,
|
||
services: std::sync::Arc<dyn crate::Services>,
|
||
/// Settings ▸ Import ▸ Report Missing Frames.
|
||
report_missing_frames: bool,
|
||
/// Settings ▸ Import ▸ Interpret Unlabeled Alpha As, for stills and for movies.
|
||
still_alpha: Option<effectcraft_project::AlphaMode>,
|
||
movie_alpha: Option<effectcraft_project::AlphaMode>,
|
||
/// Settings ▸ Import ▸ Sequence Footage frames per second.
|
||
sequence_rate: effectcraft_time::FrameRate,
|
||
/// PDF / Illustrator page (0-based).
|
||
page: u32,
|
||
/// Choose Layer: one layer of a Photoshop document.
|
||
psd_layer: Option<Value>,
|
||
}
|
||
|
||
/// A file probed as footage.
|
||
struct Probed {
|
||
path: String,
|
||
footage: effectcraft_project::Footage,
|
||
/// Its alpha is unlabeled and Settings say Ask User: open Interpret Footage.
|
||
ask_alpha: bool,
|
||
warning: Option<String>,
|
||
}
|
||
|
||
impl Prober {
|
||
/// Probe `path` as footage; the error names the file.
|
||
fn probe(&self, path: &str) -> std::result::Result<Probed, String> {
|
||
let fail = |e: String| format!("{path}: {e}");
|
||
// Data files (JSON, CSV, TSV) for data-driven animation: kept as text in the project.
|
||
if let Some(f) = data_footage(self.services.as_ref(), path) {
|
||
return f.map(|footage| Probed { path: path.to_string(), footage, ask_alpha: false, warning: None }).map_err(fail);
|
||
}
|
||
let importer = self.importer.as_ref().ok_or_else(|| fail("media import is not available in this build".into()))?;
|
||
let mut f = importer.probe(path).map_err(fail)?;
|
||
let mut warning = None;
|
||
// Settings ▸ Import ▸ Report Missing Frames.
|
||
if f.kind == FootageKind::Sequence
|
||
&& self.report_missing_frames
|
||
&& let Some(gaps) = missing_frames(&f.sequence)
|
||
{
|
||
warning = Some(format!("{path}: {gaps}"));
|
||
}
|
||
// Settings ▸ Import ▸ Interpret Unlabeled Alpha As: images only (a 3D model renders its
|
||
// own alpha, and audio and data have none).
|
||
let mut ask_alpha = false;
|
||
if matches!(f.kind, FootageKind::Still | FootageKind::Sequence | FootageKind::Video)
|
||
&& f.alpha != effectcraft_project::AlphaMode::Ignore
|
||
&& !alpha_is_labeled(path, &f.codec)
|
||
{
|
||
let setting = if f.kind == FootageKind::Video { self.movie_alpha } else { self.still_alpha };
|
||
match setting {
|
||
Some(a) => f.alpha = a,
|
||
None => ask_alpha = true,
|
||
}
|
||
}
|
||
// Settings ▸ Import ▸ Sequence Footage frames per second.
|
||
if f.kind == FootageKind::Sequence {
|
||
let r = self.sequence_rate;
|
||
let frames = f.frame_rate.frame_at(f.duration);
|
||
f.frame_rate = r;
|
||
f.duration = r.tick_of(frames.max(1));
|
||
}
|
||
// Page: another page of a PDF / Illustrator file.
|
||
if self.page > 0 && matches!(f.codec.as_str(), "PDF" | "AI") {
|
||
let doc = self
|
||
.services
|
||
.read_file(path)
|
||
.map_err(|e| e.to_string())
|
||
.and_then(|b| effectcraft_pdf::parse_page(&b, self.page as usize).map_err(|e| e.to_string()))
|
||
.map_err(fail)?;
|
||
(f.width, f.height) = doc.pixel_size();
|
||
f.page = self.page;
|
||
}
|
||
// Choose Layer: one layer of a Photoshop document (document-sized).
|
||
if let Some(sel) = &self.psd_layer
|
||
&& f.codec == "PSD"
|
||
{
|
||
let (index, name) = self
|
||
.services
|
||
.read_file(path)
|
||
.ok()
|
||
.and_then(|b| effectcraft_psd::Psd::parse(b).ok())
|
||
.and_then(|d| find_psd_layer(&d, sel))
|
||
.ok_or_else(|| fail(format!("no layer {sel}")))?;
|
||
f.layer = Some(effectcraft_project::SourceLayer { index: index as u32, name, layer_size: false, embedded: None, placed: false });
|
||
}
|
||
Ok(Probed { path: path.to_string(), footage: f, ask_alpha, warning })
|
||
}
|
||
}
|
||
|
||
/// The first part of an import: read the parameters, note the files as recent footage, and
|
||
/// import layered files (Photoshop, PDF, Illustrator, EPS) as compositions when `importAs` (or,
|
||
/// for dropped files, Default Drag Import As) asks for that. The other files are left to probe.
|
||
fn prepare_import(s: &mut Session, p: &Value) -> Result<PendingImport> {
|
||
let paths: Vec<String> = match p.get("paths").or(p.get("path")) {
|
||
Some(Value::Array(a)) => a.iter().filter_map(|v| v.as_str().map(str::to_string)).collect(),
|
||
Some(Value::String(x)) => vec![x.clone()],
|
||
_ => return Err(bad("file.import", "missing `paths`")),
|
||
};
|
||
// Photoshop documents as compositions (Import As: Composition / – Retain Layer Sizes).
|
||
// Files dragged in follow Settings ▸ Import ▸ Default Drag Import As.
|
||
let drag = p.get("drag").and_then(Value::as_bool).unwrap_or(false);
|
||
let import_as = str_p(p, "importAs").unwrap_or(if drag { s.prefs.drag_import_as() } else { "footage" });
|
||
for path in &paths {
|
||
s.prefs.push_recent_footage(path);
|
||
}
|
||
s.save_prefs();
|
||
let retain = match import_as {
|
||
"footage" => None,
|
||
"composition" | "comp" => Some(false),
|
||
"compositionLayerSizes" | "compositionRetainLayerSizes" | "layerSizes" => Some(true),
|
||
other => return Err(bad("file.import", format!("importAs: footage|composition|compositionLayerSizes, not `{other}`"))),
|
||
};
|
||
// PDF / Illustrator: which page (1-based, as in the Import dialog).
|
||
let page = match p.get("page") {
|
||
None | Some(Value::Null) => 0,
|
||
Some(v) => match v.as_u64().or_else(|| v.as_f64().filter(|x| x.fract() == 0.0 && *x >= 1.0).map(|x| x as u64)) {
|
||
Some(n) if n >= 1 => (n - 1) as u32,
|
||
_ => return Err(bad("file.import", "page: a page number from 1")),
|
||
},
|
||
};
|
||
let mut paths = paths;
|
||
let mut comps = vec![];
|
||
let mut items = vec![];
|
||
let mut errors = vec![];
|
||
if let Some(retain) = retain {
|
||
let mut rest = vec![];
|
||
for path in paths {
|
||
let bytes = match s.services.read_file(&path) {
|
||
Ok(b) if effectcraft_psd::is_psd(&b) => b,
|
||
Ok(b) if effectcraft_pdf::sniff(&b).is_some() && !path.to_ascii_lowercase().ends_with(".svg") => {
|
||
// PDF / Illustrator / EPS: one layer per file layer.
|
||
match import_vector_comp(s, &path, &b, page) {
|
||
Ok((comp, made)) => {
|
||
comps.push(comp);
|
||
items.extend(made);
|
||
}
|
||
Err(e) => errors.push(e.to_string()),
|
||
}
|
||
continue;
|
||
}
|
||
_ => {
|
||
rest.push(path);
|
||
continue;
|
||
}
|
||
};
|
||
match import_psd_comp(s, &path, bytes, retain) {
|
||
Ok((comp, made, warnings)) => {
|
||
comps.push(comp);
|
||
items.extend(made);
|
||
errors.extend(warnings);
|
||
}
|
||
Err(e) => errors.push(format!("{path}: {e}")),
|
||
}
|
||
}
|
||
paths = rest;
|
||
}
|
||
let prober = Prober {
|
||
importer: s.importer.clone(),
|
||
services: s.services.clone(),
|
||
report_missing_frames: s.prefs.import.report_missing_frames,
|
||
still_alpha: s.prefs.unlabeled_alpha(false),
|
||
movie_alpha: s.prefs.unlabeled_alpha(true),
|
||
sequence_rate: effectcraft_time::FrameRate::from_f64(s.prefs.import.sequence_fps),
|
||
page,
|
||
psd_layer: p.get("layer").cloned(),
|
||
};
|
||
Ok(PendingImport { paths, prober, comps, items, errors })
|
||
}
|
||
|
||
/// The last part of an import: add the probed files to the project (one undo step) and select
|
||
/// everything the import made, so the Project panel shows it.
|
||
fn add_footage(s: &mut Session, pending: PendingImport, probed: Vec<std::result::Result<Probed, String>>) -> Result<Value> {
|
||
let PendingImport { comps, mut items, mut errors, .. } = pending;
|
||
let mut found = vec![];
|
||
let mut warnings = vec![];
|
||
for r in probed {
|
||
match r {
|
||
Ok(f) => {
|
||
warnings.extend(f.warning.clone());
|
||
found.push(f);
|
||
}
|
||
Err(e) => errors.push(e),
|
||
}
|
||
}
|
||
let mut asked: Vec<u64> = vec![];
|
||
let made: Vec<ItemId> = comps.iter().map(|c| ItemId(*c)).collect();
|
||
if !found.is_empty() {
|
||
s.edit("Import", None, |proj, st| {
|
||
let mut selection = made;
|
||
for f in found {
|
||
let name = file_name(&f.path);
|
||
let footage = f.footage;
|
||
let name = match &footage.layer {
|
||
Some(l) => format!("{}/{name}", l.name),
|
||
None if footage.page > 0 => format!("{name} (Page {})", footage.page + 1),
|
||
None => name,
|
||
};
|
||
let label = match footage.kind {
|
||
FootageKind::Still | FootageKind::Sequence => Label::Lavender,
|
||
FootageKind::Audio => Label::SeaFoam,
|
||
FootageKind::Video | FootageKind::Model => Label::Aqua,
|
||
FootageKind::Data => Label::Sandstone,
|
||
};
|
||
let id = proj.add_item(&name, label, None, ItemKind::Footage(footage));
|
||
items.push(id.0);
|
||
if f.ask_alpha {
|
||
asked.push(id.0);
|
||
}
|
||
selection.push(id);
|
||
}
|
||
st.project_selection = selection;
|
||
Ok(())
|
||
})?;
|
||
}
|
||
if let Some(c) = comps.first() {
|
||
s.open_comp(ItemId(*c));
|
||
}
|
||
for w in &warnings {
|
||
s.events.push(crate::Event::Toast { message: w.clone(), error: true });
|
||
}
|
||
// Ask User: the frontend opens Interpret Footage for footage with unlabeled alpha.
|
||
if let Some(first) = asked.first() {
|
||
s.events.push(crate::Event::Frontend { command: "file.interpretFootage".into(), params: json!({"item": first, "reason": "unlabeledAlpha"}) });
|
||
}
|
||
Ok(json!({"items": items, "comps": comps, "errors": errors, "warnings": warnings, "unlabeledAlpha": asked}))
|
||
}
|
||
|
||
/// Whether a file format states how its alpha is stored (PNG, GIF, WebP and PSD are straight by
|
||
/// definition, OpenEXR premultiplied); TGA, TIFF and movies with alpha don't.
|
||
fn alpha_is_labeled(path: &str, codec: &str) -> bool {
|
||
let ext = std::path::Path::new(path).extension().map(|e| e.to_string_lossy().to_ascii_lowercase()).unwrap_or_default();
|
||
matches!(ext.as_str(), "png" | "gif" | "webp" | "psd" | "psb" | "exr" | "svg" | "jpg" | "jpeg" | "ai" | "pdf" | "eps") || codec.eq_ignore_ascii_case("PSD")
|
||
}
|
||
|
||
/// Gaps in an image sequence's frame numbers ("missing frames 4–6, 9"), from the digit run at the
|
||
/// end of each file name. `None` when the numbering is continuous (or there is none).
|
||
pub(crate) fn missing_frames(files: &[String]) -> Option<String> {
|
||
let num = |f: &String| -> Option<i64> {
|
||
let stem = std::path::Path::new(f).file_stem()?.to_string_lossy().to_string();
|
||
let digits: String = stem.chars().rev().take_while(char::is_ascii_digit).collect::<Vec<_>>().into_iter().rev().collect();
|
||
digits.parse().ok()
|
||
};
|
||
let mut ns: Vec<i64> = files.iter().filter_map(num).collect();
|
||
ns.sort_unstable();
|
||
ns.dedup();
|
||
let mut gaps = vec![];
|
||
let mut total = 0;
|
||
for w in ns.windows(2) {
|
||
if w[1] - w[0] > 1 {
|
||
let (a, b) = (w[0] + 1, w[1] - 1);
|
||
total += b - a + 1;
|
||
gaps.push(if a == b { a.to_string() } else { format!("{a}–{b}") });
|
||
}
|
||
}
|
||
(!gaps.is_empty()).then(|| format!("{total} missing frame{} ({})", if total == 1 { "" } else { "s" }, gaps.join(", ")))
|
||
}
|
||
|
||
/// A Photoshop layer by index or name (pixel layers only).
|
||
fn find_psd_layer(d: &effectcraft_psd::Psd, sel: &Value) -> Option<(usize, String)> {
|
||
let l = match sel {
|
||
Value::Number(n) => d.layers.get(n.as_u64()? as usize)?,
|
||
Value::String(name) => d.layers.iter().find(|l| &l.name == name)?,
|
||
_ => return None,
|
||
};
|
||
Some((l.index, l.name.clone()))
|
||
}
|
||
|
||
/// Import a Photoshop document as a composition (one undo step). Returns (comp, items, warnings).
|
||
pub(crate) fn import_psd_comp(s: &mut Session, path: &str, bytes: Vec<u8>, retain: bool) -> Result<(u64, Vec<u64>, Vec<String>)> {
|
||
let psd = effectcraft_psd::Psd::parse(bytes).map_err(|e| EngineError::Other(e.to_string()))?;
|
||
let name = std::path::Path::new(path).file_stem().map(|n| n.to_string_lossy().to_string()).unwrap_or_else(|| "Photoshop".into());
|
||
let rate = effectcraft_time::FrameRate::FPS_29_97;
|
||
let secs = if s.prefs.import.still_footage == "seconds" { s.prefs.import.still_seconds } else { 10.0 };
|
||
let duration = rate.snap_nearest(effectcraft_time::Tick::from_seconds_f64(secs));
|
||
let r = s.edit("Import", None, |proj, st| {
|
||
let r = crate::psd_import::import(proj, &psd, path, &name, retain, rate, duration);
|
||
st.project_selection = vec![r.comp];
|
||
Ok(r)
|
||
})?;
|
||
let mut items = vec![r.folder.0];
|
||
items.extend(r.items.iter().map(|i| i.0));
|
||
Ok((r.comp.0, items, r.warnings))
|
||
}
|
||
|
||
/// Import page `page` of a PDF / Illustrator / EPS file as a composition (one undo step).
|
||
/// Returns (comp, items).
|
||
fn import_vector_comp(s: &mut Session, path: &str, bytes: &[u8], page: u32) -> Result<(u64, Vec<u64>)> {
|
||
let mut name = std::path::Path::new(path).file_stem().map(|n| n.to_string_lossy().to_string()).unwrap_or_else(|| "Vector".into());
|
||
if page > 0 {
|
||
name = format!("{name} (Page {})", page + 1);
|
||
}
|
||
let rate = effectcraft_time::FrameRate::FPS_29_97;
|
||
let secs = if s.prefs.import.still_footage == "seconds" { s.prefs.import.still_seconds } else { 10.0 };
|
||
let duration = rate.snap_nearest(effectcraft_time::Tick::from_seconds_f64(secs));
|
||
let (comp, folder, items) = s.edit("Import", None, |proj, st| {
|
||
let r = crate::vector::import_vector_comp(proj, path, bytes, &name, page, rate, duration).map_err(EngineError::Other)?;
|
||
st.project_selection = vec![r.0];
|
||
Ok(r)
|
||
})?;
|
||
let mut out = vec![folder.0];
|
||
out.extend(items.iter().map(|i| i.0));
|
||
Ok((comp.0, out))
|
||
}
|
||
|
||
/// Extensions imported as data footage.
|
||
pub const DATA_EXTENSIONS: &[&str] = &["json", "csv", "tsv"];
|
||
|
||
/// A data footage item for `path` (JSON / CSV / TSV), `None` for other files.
|
||
pub(crate) fn data_footage(services: &dyn crate::Services, path: &str) -> Option<std::result::Result<effectcraft_project::Footage, String>> {
|
||
let ext = std::path::Path::new(path).extension().and_then(|e| e.to_str()).unwrap_or("").to_ascii_lowercase();
|
||
if !DATA_EXTENSIONS.contains(&ext.as_str()) {
|
||
return None;
|
||
}
|
||
Some((|| {
|
||
let bytes = services.read_file(path).map_err(|e| e.to_string())?;
|
||
let text = String::from_utf8(bytes).map_err(|_| "data files must be UTF-8 text".to_string())?;
|
||
if ext == "json" {
|
||
serde_json::from_str::<Value>(text.trim_start_matches('\u{feff}')).map_err(|e| format!("invalid JSON: {e}"))?;
|
||
}
|
||
Ok(effectcraft_project::Footage { path: path.to_string(), kind: FootageKind::Data, codec: ext.to_uppercase(), data: Some(text), ..Default::default() })
|
||
})())
|
||
}
|
||
|
||
fn project_settings(s: &mut Session, p: &Value) -> Result<Value> {
|
||
s.edit("Project Settings", None, |proj, _| {
|
||
if let Some(b) = str_p(p, "bitDepth") {
|
||
proj.settings.bit_depth = match b {
|
||
"8" | "8bpc" | "8 bpc" => effectcraft_project::BitDepth::Bpc8,
|
||
"16" | "16bpc" | "16 bpc" => effectcraft_project::BitDepth::Bpc16,
|
||
"32" | "32bpc" | "32 bpc" => effectcraft_project::BitDepth::Bpc32,
|
||
_ => return Err(bad("file.projectSettings", "bitDepth must be 8, 16 or 32")),
|
||
};
|
||
} else if let Some(n) = p.get("bitDepth").and_then(Value::as_u64) {
|
||
proj.settings.bit_depth = match n {
|
||
16 => effectcraft_project::BitDepth::Bpc16,
|
||
32 => effectcraft_project::BitDepth::Bpc32,
|
||
_ => effectcraft_project::BitDepth::Bpc8,
|
||
};
|
||
}
|
||
if let Some(l) = p.get("linearize").and_then(Value::as_bool) {
|
||
proj.settings.linearize = l;
|
||
}
|
||
if let Some(l) = p.get("blendLinear").or_else(|| p.get("blendColorsUsing1Gamma")).and_then(Value::as_bool) {
|
||
proj.settings.blend_linear = l;
|
||
}
|
||
use effectcraft_project::{ColorEngine, ColorSpace, HdrMode};
|
||
let cmd = "file.projectSettings";
|
||
if let Some(e) = str_p(p, "colorEngine") {
|
||
let engine = match e.to_ascii_lowercase().replace([' ', '-', '_'], "").as_str() {
|
||
"adobe" | "adobemanaged" | "builtin" => ColorEngine::Adobe,
|
||
"ocio" | "ociomanaged" => ColorEngine::Ocio,
|
||
_ => return Err(bad(cmd, format!("colorEngine: adobe|ocio, not `{e}`"))),
|
||
};
|
||
if engine == ColorEngine::Ocio && proj.settings.color_engine != ColorEngine::Ocio {
|
||
// The OCIO built-in config works in ACES and renders the display through its
|
||
// tone-mapped view.
|
||
if !proj.settings.working_space.is_some_and(|w| w.is_linear()) {
|
||
proj.settings.working_space = Some(ColorSpace::AcesCg);
|
||
}
|
||
if proj.settings.hdr == HdrMode::Clip {
|
||
proj.settings.hdr = HdrMode::ToneMap;
|
||
}
|
||
}
|
||
proj.settings.color_engine = engine;
|
||
}
|
||
if let Some(w) = p.get("workingSpace") {
|
||
let ids = ColorSpace::WORKING.iter().map(|c| c.id()).collect::<Vec<_>>().join("|");
|
||
proj.settings.working_space = match w.as_str() {
|
||
None | Some("none" | "None" | "") => None,
|
||
Some(n) => Some(
|
||
ColorSpace::parse(n).filter(|c| ColorSpace::WORKING.contains(c)).ok_or_else(|| bad(cmd, format!("workingSpace: none|{ids}, not `{n}`")))?,
|
||
),
|
||
};
|
||
}
|
||
if proj.settings.color_engine == ColorEngine::Ocio && !proj.settings.working_space.is_some_and(|w| w.is_linear()) {
|
||
return Err(bad(cmd, "the OCIO built-in config's working spaces are acescg and aces2065"));
|
||
}
|
||
if let Some(h) = str_p(p, "hdr") {
|
||
proj.settings.hdr = match h.to_ascii_lowercase().replace([' ', '-', '_'], "").as_str() {
|
||
"clip" | "off" | "none" => HdrMode::Clip,
|
||
"compand" => HdrMode::Compand,
|
||
"tonemap" | "tonemapped" => HdrMode::ToneMap,
|
||
_ => return Err(bad(cmd, format!("hdr: clip|compand|toneMap, not `{h}`"))),
|
||
};
|
||
}
|
||
if let Some(o) = p.get("outputSpace") {
|
||
proj.settings.output_space = match o.as_str() {
|
||
None | Some("none" | "None" | "" | "default") => None,
|
||
Some(n) => Some(ColorSpace::parse(n).ok_or_else(|| bad(cmd, format!("outputSpace: srgb|rec709|rec2020|p3|rec2100pq|rec2100hlg, not `{n}`")))?),
|
||
};
|
||
}
|
||
if let Some(r) = p.get("renderer").or_else(|| p.get("gpuAcceleration")) {
|
||
proj.settings.gpu_acceleration = match r {
|
||
Value::Bool(b) => *b,
|
||
Value::String(s) => match effectcraft_render::Backend::parse(s) {
|
||
Some(effectcraft_render::Backend::Cpu) => false,
|
||
Some(_) => true,
|
||
None => return Err(bad("file.projectSettings", format!("renderer: gpu|software, not `{s}`"))),
|
||
},
|
||
_ => return Err(bad("file.projectSettings", "renderer: gpu|software")),
|
||
};
|
||
}
|
||
if let Some(t) = str_p(p, "timeDisplay") {
|
||
proj.settings.time_display = effectcraft_project::TimeDisplayStyle::parse(t)
|
||
.ok_or_else(|| bad("file.projectSettings", format!("timeDisplay: timecode|frames|feet35|feet16, not `{t}`")))?;
|
||
}
|
||
Ok(())
|
||
})?;
|
||
Ok(serde_json::to_value(&s.project.settings).unwrap_or_default())
|
||
}
|
||
|
||
/// Video Rendering and Effects: report or set the renderer (Mercury GPU Acceleration when a GPU
|
||
/// adapter exists, else Mercury Software Only).
|
||
fn render_backend(s: &mut Session, p: &Value) -> Result<Value> {
|
||
if let Some(b) = p.get("backend").or_else(|| p.get("renderer")) {
|
||
let gpu = match b {
|
||
Value::Bool(b) => *b,
|
||
Value::String(v) => match effectcraft_render::Backend::parse(v) {
|
||
Some(effectcraft_render::Backend::Cpu) => false,
|
||
Some(_) => true,
|
||
None => return Err(bad("render.backend", format!("backend: gpu|cpu, not `{v}`"))),
|
||
},
|
||
_ => return Err(bad("render.backend", "backend: gpu|cpu")),
|
||
};
|
||
if gpu != s.project.settings.gpu_acceleration {
|
||
s.edit("Project Settings", None, |proj, _| {
|
||
proj.settings.gpu_acceleration = gpu;
|
||
Ok(())
|
||
})?;
|
||
}
|
||
}
|
||
Ok(backend_status(s))
|
||
}
|
||
|
||
/// The renderer setting and what renders with it.
|
||
pub fn backend_status(s: &Session) -> Value {
|
||
let adapter = s.accel.as_ref().map(|a| a.name());
|
||
let gpu = s.project.settings.gpu_acceleration;
|
||
// Why it renders on the CPU (#262).
|
||
let why = if !gpu {
|
||
Some("the project's renderer is Mercury Software Only".to_string())
|
||
} else if adapter.is_none() {
|
||
Some(s.accel_note.clone().unwrap_or_else(|| "no GPU compositor is attached".into()))
|
||
} else {
|
||
None
|
||
};
|
||
json!({
|
||
"renderer": if gpu { "Mercury GPU Acceleration" } else { "Mercury Software Only" },
|
||
"gpuAcceleration": gpu,
|
||
"adapter": adapter,
|
||
"active": if gpu && adapter.is_some() { "gpu" } else { "cpu" },
|
||
"why": why,
|
||
})
|
||
}
|
||
|
||
fn cycle_depth(s: &mut Session, _: &Value) -> Result<Value> {
|
||
s.edit("Project Bit Depth", None, |proj, _| {
|
||
proj.settings.bit_depth = proj.settings.bit_depth.next();
|
||
Ok(())
|
||
})?;
|
||
Ok(json!(s.project.settings.bit_depth.label()))
|
||
}
|
||
|
||
pub fn specs() -> Vec<CommandSpec> {
|
||
vec![
|
||
cmd!("file.newProject", "New Project", ["File", "New"], Some("Cmd+Alt+N"), "{}", always, new_project),
|
||
cmd!("file.openDemoProject", "Open Demo Project", ["Help"], None, "{}", always, demo),
|
||
cmd!("file.open", "Open Project...", ["File"], Some("Cmd+O"), "{path}", always, open),
|
||
cmd!("file.save", "Save", ["File"], Some("Cmd+S"), "{path?}", always, save),
|
||
cmd!("file.saveAs", "Save As...", ["File", "Save As"], Some("Cmd+Shift+S"), "{path}", always, save_as),
|
||
cmd!("file.incrementAndSave", "Increment and Save", ["File"], Some("Cmd+Alt+Shift+S"), "{}", has_path, increment_save),
|
||
cmd!("file.revert", "Revert", ["File"], None, "{}", has_path, revert),
|
||
cmd!(
|
||
"file.import",
|
||
"File...",
|
||
["File", "Import"],
|
||
Some("Cmd+I"),
|
||
"{paths: [string], importAs?: footage|composition|compositionLayerSizes (Photoshop, PDF, Illustrator and EPS files), layer?: name|index (footage of one Photoshop layer), page?: number from 1 (PDF / Illustrator page), drag?: bool (dropped files: Settings ▸ Import ▸ Default Drag Import As), addToComp?: bool (also add them to the active comp, at time?, index?, position? as in layer.addItem), background?: bool (probe the files in a background job, jobs.list / jobs.wait; returns {job})}",
|
||
always,
|
||
import_cmd
|
||
),
|
||
cmd!(
|
||
"file.projectSettings",
|
||
"Project Settings...",
|
||
["File"],
|
||
Some("Cmd+Alt+Shift+K"),
|
||
"{bitDepth?: 8|16|32, colorEngine?: adobe|ocio, workingSpace?: none|srgb|rec709|rec2020|p3|acescg|aces2065, linearize?, blendLinear?, hdr?: clip|compand|toneMap, outputSpace?: srgb|rec709|rec2020|p3|rec2100pq|rec2100hlg, renderer?: gpu|software, timeDisplay?: timecode|frames|feet35|feet16}",
|
||
always,
|
||
project_settings
|
||
),
|
||
cmd!("file.cycleBitDepth", "Cycle Project Bit Depth", [], None, "{}", always, cycle_depth),
|
||
cmd!("render.backend", "Video Rendering and Effects", [], None, "{backend?: gpu|cpu}", always, render_backend),
|
||
]
|
||
}
|