Merge main into enhance/avi-import

This commit is contained in:
tylerjenningsw
2026-10-25 14:26:28 -04:00
427 changed files with 24699 additions and 4513 deletions
+329
View File
@@ -0,0 +1,329 @@
//! A cheap check that a project file will read back, without parsing it.
//!
//! `serde_json` writes a non-finite float as `null` and refuses to parse nesting deeper than 128
//! containers, so a project holding either would be saved to a file that can't be opened. Walking
//! the value once, writing nothing, finds both without building the project again.
use std::fmt;
use serde::ser::{
self, Serialize, SerializeMap, SerializeSeq, SerializeStruct, SerializeStructVariant, SerializeTuple, SerializeTupleStruct, SerializeTupleVariant,
Serializer,
};
/// serde_json refuses to parse the 128th nested array/object (its recursion limit is 128).
const MAX_DEPTH: u32 = 127;
const NOT_FINITE: &str = "a number that isn't finite (NaN or infinity)";
const TOO_DEEP: &str = "nesting deeper than 127 levels";
/// Why a value can't be written to a project file.
#[derive(Debug)]
pub(crate) struct Unstorable(String);
impl fmt::Display for Unstorable {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(&self.0)
}
}
impl std::error::Error for Unstorable {}
impl ser::Error for Unstorable {
fn custom<T: fmt::Display>(msg: T) -> Self {
Unstorable(msg.to_string())
}
}
/// Walk `value` as `serde_json` would write it, producing no text and allocating only on error.
pub(crate) fn check<T: Serialize + ?Sized>(value: &T) -> Result<(), Unstorable> {
let mut walker = Walker { depth: 0 };
value.serialize(&mut walker)
}
/// The current nesting depth of the value being walked.
struct Walker {
depth: u32,
}
impl Walker {
/// Enter `levels` nested containers, refusing anything serde_json couldn't parse back.
fn enter(&mut self, levels: u32) -> Result<(), Unstorable> {
let depth = self.depth.checked_add(levels).ok_or_else(|| Unstorable(TOO_DEEP.into()))?;
if depth > MAX_DEPTH {
return Err(Unstorable(TOO_DEEP.into()));
}
self.depth = depth;
Ok(())
}
fn leave(&mut self, levels: u32) {
self.depth = self.depth.saturating_sub(levels);
}
}
/// One compound value being walked; leaving it when it ends keeps the depth exact.
struct Compound<'a> {
walker: &'a mut Walker,
levels: u32,
}
impl<'a> Compound<'a> {
fn new(walker: &'a mut Walker, levels: u32) -> Result<Self, Unstorable> {
walker.enter(levels)?;
Ok(Self { walker, levels })
}
fn value<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Unstorable> {
value.serialize(&mut *self.walker)
}
fn finish(self) -> Result<(), Unstorable> {
self.walker.leave(self.levels);
Ok(())
}
}
impl SerializeSeq for Compound<'_> {
type Ok = ();
type Error = Unstorable;
fn serialize_element<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Unstorable> {
self.value(value)
}
fn end(self) -> Result<(), Unstorable> {
self.finish()
}
}
impl SerializeTuple for Compound<'_> {
type Ok = ();
type Error = Unstorable;
fn serialize_element<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Unstorable> {
self.value(value)
}
fn end(self) -> Result<(), Unstorable> {
self.finish()
}
}
impl SerializeTupleStruct for Compound<'_> {
type Ok = ();
type Error = Unstorable;
fn serialize_field<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Unstorable> {
self.value(value)
}
fn end(self) -> Result<(), Unstorable> {
self.finish()
}
}
impl SerializeTupleVariant for Compound<'_> {
type Ok = ();
type Error = Unstorable;
fn serialize_field<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Unstorable> {
self.value(value)
}
fn end(self) -> Result<(), Unstorable> {
self.finish()
}
}
impl SerializeMap for Compound<'_> {
type Ok = ();
type Error = Unstorable;
fn serialize_key<T: Serialize + ?Sized>(&mut self, key: &T) -> Result<(), Unstorable> {
self.value(key)
}
fn serialize_value<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Unstorable> {
self.value(value)
}
fn end(self) -> Result<(), Unstorable> {
self.finish()
}
}
impl SerializeStruct for Compound<'_> {
type Ok = ();
type Error = Unstorable;
fn serialize_field<T: Serialize + ?Sized>(&mut self, _key: &'static str, value: &T) -> Result<(), Unstorable> {
self.value(value)
}
fn end(self) -> Result<(), Unstorable> {
self.finish()
}
}
impl SerializeStructVariant for Compound<'_> {
type Ok = ();
type Error = Unstorable;
fn serialize_field<T: Serialize + ?Sized>(&mut self, _key: &'static str, value: &T) -> Result<(), Unstorable> {
self.value(value)
}
fn end(self) -> Result<(), Unstorable> {
self.finish()
}
}
impl<'a> Serializer for &'a mut Walker {
type Ok = ();
type Error = Unstorable;
type SerializeSeq = Compound<'a>;
type SerializeTuple = Compound<'a>;
type SerializeTupleStruct = Compound<'a>;
type SerializeTupleVariant = Compound<'a>;
type SerializeMap = Compound<'a>;
type SerializeStruct = Compound<'a>;
type SerializeStructVariant = Compound<'a>;
fn serialize_bool(self, _v: bool) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_i8(self, _v: i8) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_i16(self, _v: i16) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_i32(self, _v: i32) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_i64(self, _v: i64) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_i128(self, _v: i128) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_u8(self, _v: u8) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_u16(self, _v: u16) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_u32(self, _v: u32) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_u64(self, _v: u64) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_u128(self, _v: u128) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_f32(self, v: f32) -> Result<(), Unstorable> {
if v.is_finite() { Ok(()) } else { Err(Unstorable(NOT_FINITE.into())) }
}
fn serialize_f64(self, v: f64) -> Result<(), Unstorable> {
if v.is_finite() { Ok(()) } else { Err(Unstorable(NOT_FINITE.into())) }
}
fn serialize_char(self, _v: char) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_str(self, _v: &str) -> Result<(), Unstorable> {
Ok(())
}
/// serde_json writes bytes as an array of numbers: one level of nesting.
fn serialize_bytes(self, _v: &[u8]) -> Result<(), Unstorable> {
Compound::new(self, 1)?.finish()
}
/// Writes text for a `Display` value; it is a scalar, not a container.
fn collect_str<T: fmt::Display + ?Sized>(self, _v: &T) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_none(self) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_some<T: Serialize + ?Sized>(self, value: &T) -> Result<(), Unstorable> {
value.serialize(&mut *self)
}
fn serialize_unit(self) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_unit_struct(self, _name: &'static str) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_unit_variant(self, _name: &'static str, _index: u32, _variant: &'static str) -> Result<(), Unstorable> {
Ok(())
}
fn serialize_newtype_struct<T: Serialize + ?Sized>(self, _name: &'static str, value: &T) -> Result<(), Unstorable> {
value.serialize(self)
}
fn serialize_newtype_variant<T: Serialize + ?Sized>(self, _name: &'static str, _index: u32, _variant: &'static str, value: &T) -> Result<(), Unstorable> {
let mut compound = Compound::new(self, 1)?;
compound.value(value)?;
compound.finish()
}
fn serialize_seq(self, _len: Option<usize>) -> Result<Compound<'a>, Unstorable> {
Compound::new(self, 1)
}
fn serialize_tuple(self, _len: usize) -> Result<Compound<'a>, Unstorable> {
Compound::new(self, 1)
}
fn serialize_tuple_struct(self, _name: &'static str, _len: usize) -> Result<Compound<'a>, Unstorable> {
Compound::new(self, 1)
}
fn serialize_tuple_variant(self, _name: &'static str, _index: u32, _variant: &'static str, _len: usize) -> Result<Compound<'a>, Unstorable> {
Compound::new(self, 2)
}
fn serialize_map(self, _len: Option<usize>) -> Result<Compound<'a>, Unstorable> {
Compound::new(self, 1)
}
fn serialize_struct(self, _name: &'static str, _len: usize) -> Result<Compound<'a>, Unstorable> {
Compound::new(self, 1)
}
fn serialize_struct_variant(self, _name: &'static str, _index: u32, _variant: &'static str, _len: usize) -> Result<Compound<'a>, Unstorable> {
Compound::new(self, 2)
}
}
#[cfg(test)]
mod tests {
use std::collections::BTreeMap;
use super::check;
#[test]
fn refuses_non_finite_numbers_anywhere() {
assert!(check(&1.5f64).is_ok());
assert!(check(&vec![Some(1.0f64), None]).is_ok());
assert!(check(&BTreeMap::from([("a".to_string(), 2.0f32)])).is_ok(), "finite floats in a map");
assert!(check(&f64::NAN).is_err());
assert!(check(&f64::INFINITY).is_err());
assert!(check(&vec![Some(f64::NEG_INFINITY)]).is_err(), "inside an option in a list");
assert!(check(&BTreeMap::from([("a".to_string(), f32::NAN)])).is_err(), "as a map value");
}
#[test]
fn depth_limit_matches_serde_json() {
for n in [127, 128] {
let mut v = serde_json::Value::Null;
for _ in 0..n {
v = serde_json::Value::Array(vec![v]);
}
let text = serde_json::to_string(&v).unwrap();
let reads_back = serde_json::from_str::<serde_json::Value>(&text).is_ok();
assert_eq!(check(&v).is_ok(), reads_back, "depth {n} agrees with serde_json");
assert_eq!(check(&v).is_ok(), n == 127, "depth {n}");
}
}
/// `n` nested lists around bytes, which serde_json writes as one more array.
struct BytesUnder(u32);
impl serde::Serialize for BytesUnder {
fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
use serde::ser::SerializeSeq;
let Some(inner) = self.0.checked_sub(1) else {
return s.serialize_bytes(&[1]);
};
let mut seq = s.serialize_seq(Some(1))?;
seq.serialize_element(&BytesUnder(inner))?;
seq.end()
}
}
#[test]
fn bytes_count_as_one_level() {
for n in [126, 127] {
let text = serde_json::to_string(&BytesUnder(n)).unwrap();
let reads_back = serde_json::from_str::<serde_json::Value>(&text).is_ok();
assert_eq!(check(&BytesUnder(n)).is_ok(), reads_back, "depth {n} agrees with serde_json");
assert_eq!(check(&BytesUnder(n)).is_ok(), n == 126, "depth {n}");
}
}
}
+100 -10
View File
@@ -8,6 +8,7 @@
pub mod build;
pub mod essential;
mod file_check;
pub mod limits;
pub mod props;
pub mod render_queue;
@@ -851,7 +852,12 @@ impl Comp {
/// Draws the same pixels as `o`: equal but for its layers' Audio, Lock and Shy switches, Hide
/// Shy Layers and the viewer's Resolution.
pub fn same_pixels(&self, o: &Comp) -> bool {
// Every field (no `..`: a new field must be considered here); the layers last.
self.same_settings(o) && self.layers.len() == o.layers.len() && self.layers.iter().zip(&o.layers).all(|(a, b)| a.same_pixels(b))
}
/// [`Self::same_pixels`] but for the layers.
fn same_settings(&self, o: &Comp) -> bool {
// Every field (no `..`: a new field must be considered here).
let Comp {
width,
height,
@@ -861,7 +867,7 @@ impl Comp {
display_start,
background,
work_area,
layers,
layers: _,
markers,
shutter_angle,
shutter_phase,
@@ -903,8 +909,61 @@ impl Comp {
&& *global_light == o.global_light
&& *guides == o.guides
&& *essential == o.essential
&& layers.len() == o.layers.len()
&& layers.iter().zip(&o.layers).all(|(a, b)| a.same_pixels(b))
}
/// The comp-time span (`in_point..out_point` of every layer changed, added or removed,
/// widened by the shutter) outside which `self` draws the same pixels as `o`, so cached
/// frames there stay valid (#1641). `None` when the edit can reach any frame: a comp setting,
/// a layer reorder, Solo turning on or off, an expression (it reads anything), or a changed
/// layer another layer parents to, mattes with or picks in an effect.
pub fn changed_span(&self, o: &Comp) -> Option<(Tick, Tick)> {
fn reads(g: &PropGroup, changed: &[LayerId]) -> bool {
g.children.iter().any(|c| match c {
Node::Prop(p) => {
p.expr.is_some()
|| std::iter::once(&p.value)
.chain(p.keys.iter().map(|k| &k.value))
.any(|v| matches!(v, Value::Layer(Some(id)) if changed.contains(&LayerId(*id))))
}
Node::Group(g) => reads(g, changed),
})
}
// Solo hides every other layer at every frame.
if !self.same_settings(o) || self.any_solo() != o.any_solo() {
return None;
}
let common = |a: &Comp, b: &Comp| a.layers.iter().map(|l| l.id).filter(|id| b.layer(*id).is_some()).collect::<Vec<_>>();
if common(self, o) != common(o, self) {
return None;
}
let mut changed = Vec::new();
let mut span: Option<(Tick, Tick)> = None;
// Each changed layer comes up from both sides: its old and its new span.
for (l, other) in self.layers.iter().map(|l| (l, o.layer(l.id))).chain(o.layers.iter().map(|l| (l, self.layer(l.id)))) {
if other.is_some_and(|b| l.same_pixels(b)) {
continue;
}
changed.push(l.id);
let (s, e) = (l.in_point.min(l.out_point), l.in_point.max(l.out_point));
span = Some(span.map_or((s, e), |(a, b)| (a.min(s), b.max(e))));
}
let reaches = |l: &Layer| {
l.parent.is_some_and(|p| changed.contains(&p)) || l.track_matte.as_ref().is_some_and(|m| changed.contains(&m.layer)) || reads(&l.props, &changed)
};
if self.layers.iter().chain(&o.layers).any(reaches) {
return None;
}
// A frame at `t` samples cameras, lights and transforms over its shutter,
// `t + (phase + angle * 0..=1) / 360` frames, and draws the layers active at `t` itself.
let (a, p) = (self.shutter_angle / 360.0, self.shutter_phase / 360.0);
let fd = self.frame_duration().seconds();
let (before, after) = (Tick::from_seconds_f64(p.max(p + a).max(0.0) * fd), Tick::from_seconds_f64(-p.min(p + a).min(0.0) * fd));
span.map(|(s, e)| (s - before, e + after))
}
/// Some layer is soloed: only the soloed layers draw.
pub fn any_solo(&self) -> bool {
self.layers.iter().any(|l| l.switches.solo && l.source.is_av())
}
/// Draws the same pixels as `o` once plain markers are ignored: they change no pixels. Protected
@@ -1483,11 +1542,32 @@ impl Project {
}
/// Whether comp `inner` is (transitively) nested inside comp `outer` (to prevent cycles).
pub fn comp_contains(&self, outer: ItemId, inner: ItemId) -> bool {
// A walk with a stack and a visited set rather than recursion (#1237): a damaged project
// may hold a precomp cycle that doesn't pass `inner` (recursion never ended), a long
// chain must not use up the call stack, and comps shared by many paths are visited once
// (recursion re-walked them for every path).
if outer == inner {
return true;
}
let Some(c) = self.comp(outer) else { return false };
c.layers.iter().any(|l| matches!(l.source, LayerSource::Comp { item } if self.comp_contains(item, inner)))
let mut seen = std::collections::HashSet::new();
let mut stack = vec![outer];
while let Some(id) = stack.pop() {
if !seen.insert(id) {
continue;
}
let Some(c) = self.comp(id) else { continue };
for l in &c.layers {
if let LayerSource::Comp { item } = l.source {
if item == inner {
return true;
}
if !seen.contains(&item) {
stack.push(item);
}
}
}
}
false
}
/// Make sure `next_id` exceeds every id in the project (after loading or merging).
pub fn fix_next_id(&mut self) {
@@ -1524,13 +1604,20 @@ impl Project {
&& self.render_prefs == other.render_prefs
}
/// The project file's text: the project with the version that wrote it (`savedBy`), checked
/// to read back, so a save never writes a file that can't be opened (JSON has no NaN or
/// infinity: such a value would be written as `null`).
/// to read back, so a save never writes a file that can't be opened. Values JSON can't hold
/// (NaN or infinity, written as `null`, and nesting too deep to parse) are refused on every
/// save; debug builds also read the text back.
pub fn to_file_json(&self) -> Result<String, ProjectError> {
self.to_file_json_with_view(&SavedView::default())
}
/// [`Project::to_file_json`] that also records the open compositions ([`SavedView`]).
pub fn to_file_json_with_view(&self, view: &SavedView) -> Result<String, ProjectError> {
if self.schema > SCHEMA_VERSION {
return Err(ProjectError::Invalid(format!(
"the project can't be saved: it holds a value a project file can't store (project schema {} is newer than this version supports ({SCHEMA_VERSION}))",
self.schema
)));
}
#[derive(Serialize)]
struct File<'a> {
#[serde(rename = "savedBy")]
@@ -1540,8 +1627,11 @@ impl Project {
#[serde(flatten)]
project: &'a Project,
}
let text = serde_json::to_string_pretty(&File { saved_by: APP_VERSION, view, project: self })
.map_err(|e| ProjectError::Invalid(format!("the project can't be saved: {e}")))?;
let file = File { saved_by: APP_VERSION, view, project: self };
file_check::check(&file)
.map_err(|e| ProjectError::Invalid(format!("the project can't be saved: it holds a value a project file can't store ({e})")))?;
let text = serde_json::to_string_pretty(&file).map_err(|e| ProjectError::Invalid(format!("the project can't be saved: {e}")))?;
#[cfg(debug_assertions)]
Project::from_json(&text)
.map_err(|e| ProjectError::Invalid(format!("the project can't be saved: it holds a value a project file can't store ({e})")))?;
Ok(text)
+78
View File
@@ -166,10 +166,33 @@ fn project_files_name_their_version_and_always_read_back() {
p.comp_mut(cid).unwrap().layers[0].props.prop_mut("transform/opacity").unwrap().value = Value::Scalar(f64::NAN);
let e = p.to_file_json().unwrap_err().to_string();
assert!(e.contains("can't be saved"), "{e}");
// Infinity too, in either profile: the check doesn't rely on reading the file back.
p.comp_mut(cid).unwrap().layers[0].props.prop_mut("transform/opacity").unwrap().value = Value::Scalar(f64::INFINITY);
let e = p.to_file_json().unwrap_err().to_string();
assert!(e.contains("can't be saved"), "{e}");
assert!(crate::is_newer_version("0.2.0", "0.1.9") && crate::is_newer_version("1.0.0-rc.1", "0.9.9"));
assert!(!crate::is_newer_version("0.1.1", "0.1.1") && !crate::is_newer_version("0.1.0", "0.1.1"));
}
#[test]
fn project_files_refuse_newer_schemas() {
let p = Project { schema: crate::SCHEMA_VERSION + 1, ..Project::default() };
let expected = format!(
"the project can't be saved: it holds a value a project file can't store (project schema {} is newer than this version supports ({}))",
p.schema,
crate::SCHEMA_VERSION
);
assert_eq!(p.to_file_json().unwrap_err().to_string(), expected);
assert_eq!(p.to_file_json_with_view(&crate::SavedView::default()).unwrap_err().to_string(), expected);
}
#[test]
fn saved_files_reopen_in_pretty_and_compact_form() {
let (p, _cid) = project_with_layer();
assert_eq!(Project::from_json(&p.to_file_json().unwrap()).unwrap(), p, "the pretty project file");
assert_eq!(Project::from_json(&p.to_json_compact()).unwrap(), p, "compact JSON");
}
#[test]
fn project_files_remember_the_open_comps() {
let (p, cid) = project_with_layer();
@@ -212,3 +235,58 @@ fn item_users_count_layers_in_every_comp() {
assert!(p.item_users(unused).is_empty());
assert!(p.item_users(main).is_empty());
}
/// A project of `n` empty comps; `links` adds a precomp layer of comp `b` inside comp `a`
/// (indexes into the returned ids).
fn comp_graph(n: usize, links: &[(usize, usize)]) -> (Project, Vec<crate::ItemId>) {
let mut p = Project::default();
let ids: Vec<crate::ItemId> = (0..n)
.map(|i| {
p.add_item(
&format!("C{i}"),
effectcraft_color::Label::None,
None,
ItemKind::Comp(Comp::new(8, 8, FrameRate::FPS_25, Tick::from_seconds_f64(1.0)).into()),
)
})
.collect();
for &(a, b) in links {
let outer = p.comp(ids[a]).unwrap().clone();
let l = build::layer(&mut p, &outer, "pre", LayerSource::Comp { item: ids[b] }, (8, 8), None);
let ItemKind::Comp(c) = &mut p.item_mut(ids[a]).unwrap().kind else { panic!("comp") };
std::sync::Arc::make_mut(c).layers.push(l);
}
(p, ids)
}
#[test]
fn comp_contains_ends_on_cycles_long_chains_and_shared_precomps() {
// A ⇄ B cycle, C unrelated: the walk used to recurse until the stack ran out (#1237).
let (p, c) = comp_graph(3, &[(0, 1), (1, 0)]);
assert!(!p.comp_contains(c[0], c[2]));
assert!(p.comp_contains(c[0], c[1]) && p.comp_contains(c[1], c[0]));
// A comp nesting itself.
let (p, c) = comp_graph(2, &[(0, 0)]);
assert!(!p.comp_contains(c[0], c[1]));
assert!(p.comp_contains(c[0], c[0]));
// A target reached through a cycle.
let (p, c) = comp_graph(3, &[(0, 1), (1, 0), (1, 2)]);
assert!(p.comp_contains(c[0], c[2]));
assert!(!p.comp_contains(c[2], c[0]));
// 40 levels of diamonds: 2^40 paths, each comp visited once.
let mut links = vec![];
for i in 0..40 {
let (top, l, r, bottom) = (i * 3, i * 3 + 1, i * 3 + 2, i * 3 + 3);
links.extend([(top, l), (top, r), (l, bottom), (r, bottom)]);
}
let (p, c) = comp_graph(121, &links);
let t0 = std::time::Instant::now();
assert!(p.comp_contains(c[0], c[120]));
assert!(!p.comp_contains(c[120], c[0]));
assert!(t0.elapsed() < std::time::Duration::from_secs(1), "{:?}", t0.elapsed());
// A chain 20 000 comps deep (a deep recursion's stack frames).
let n = 20_000;
let (p, c) = comp_graph(n, &(0..n - 1).map(|i| (i, i + 1)).collect::<Vec<_>>());
assert!(p.comp_contains(c[0], c[n - 1]));
assert!(!p.comp_contains(c[n - 1], c[0]));
}