EffectCraft: An open-source motion graphics and compositing tool written by scratch in pure Rust
fix(engine): respect frame default template and force RGB only on transparent: false
Kushagra Kumarc31fad1b9008
diff --git a/crates/engine/src/cmd/comp_more.rs b/crates/engine/src/cmd/comp_more.rsindex 0a1f63cb4..478dc8259 100644--- a/crates/engine/src/cmd/comp_more.rs+++ b/crates/engine/src/cmd/comp_more.rs@@ -91,13 +91,8 @@ fn queue_frame(s: &mut Session, p: &Value) -> Result<Value> {it.settings = s.project.render_templates.default_render_settings(TemplateSlot::Still);it.settings.time_span = TimeSpan::Custom { start: t, end: t + comp.frame_duration() };it.output = s.project.render_templates.default_output_module(TemplateSlot::Still);- let transparent = b_p(p, "transparent").unwrap_or(true);- if !transparent {+ if b_p(p, "transparent") == Some(false) {it.output.channels = Channels::Rgb;- } else if it.output.supports_alpha() {- it.output.channels = Channels::Rgba;- } else {- return Err(bad("comp.saveFrameAs", format!("{} doesn't support an alpha channel", it.output.format.label())));}if let Some(path) = str_p(p, "path") {it.output.output = path.to_string();diff --git a/crates/engine/src/tests/frame_export.rs b/crates/engine/src/tests/frame_export.rsindex d4273bc6c..a8dc938fb 100644--- a/crates/engine/src/tests/frame_export.rs+++ b/crates/engine/src/tests/frame_export.rs@@ -191,50 +191,42 @@ fn save_frame_as_png_preserves_alpha_channel() {}#[test]-fn save_frame_as_defaults_to_png_sequence_with_alpha() {+fn save_frame_as_queued_respects_frame_default_template() {let mut s = Session::default();s.execute("comp.new", json!({"name": "Comp", "width": 32, "height": 32, "frameRate": 24, "duration": 1})).unwrap();++ // Default Still template is "PNG Sequence" (Channels::Rgb)let r = s.execute_checked("comp.saveFrameAs", json!({"queue": true})).unwrap();assert_eq!(r["queued"], true);let it = s.project.render_queue.last().unwrap();- assert_eq!(it.output.name, "PNG Sequence with Alpha");- assert_eq!(it.output.channels, effectcraft_project::render_queue::Channels::Rgba);-- // Queued save with transparent: false sets Channels::Rgb (composited over background).- s.execute_checked("comp.saveFrameAs", json!({"queue": true, "transparent": false})).unwrap();- let it = s.project.render_queue.last().unwrap();+ assert_eq!(it.output.name, "PNG Sequence");assert_eq!(it.output.channels, effectcraft_project::render_queue::Channels::Rgb);- // Queued save with transparent: true preserves Channels::Rgba.- s.execute_checked("comp.saveFrameAs", json!({"queue": true, "transparent": true})).unwrap();- let it = s.project.render_queue.last().unwrap();- assert_eq!(it.output.channels, effectcraft_project::render_queue::Channels::Rgba);-- s.execute("edit.undo", json!({})).unwrap();- s.execute("edit.undo", json!({})).unwrap();+ // Test undo and redo of queuing a frames.execute("edit.undo", json!({})).unwrap();assert!(s.project.render_queue.is_empty());s.execute("edit.redo", json!({})).unwrap();let it = s.project.render_queue.last().unwrap();- assert_eq!(it.output.name, "PNG Sequence with Alpha");- assert_eq!(it.output.channels, effectcraft_project::render_queue::Channels::Rgba);-}--#[test]-fn save_frame_as_defaults_to_transparent_even_with_rgb_frame_template() {- let mut s = Session::default();- s.execute("comp.new", json!({"name": "Comp", "width": 32, "height": 32, "frameRate": 24, "duration": 1})).unwrap();+ assert_eq!(it.output.name, "PNG Sequence");- // Set Frame Default to an RGB output template ("PNG Sequence")- s.execute_checked("renderQueue.setTemplateDefault", json!({"kind": "outputModule", "slot": "still", "name": "PNG Sequence"})).unwrap();+ // Explicit transparent: false forces Channels::Rgb+ s.execute_checked("comp.saveFrameAs", json!({"queue": true, "transparent": false})).unwrap();+ let it = s.project.render_queue.last().unwrap();+ assert_eq!(it.output.channels, effectcraft_project::render_queue::Channels::Rgb);- // Omitting `transparent` must default to true and promote to Channels::Rgba+ // When Frame Default is set to an RGBA template, it is respected+ s.execute_checked("renderQueue.setTemplateDefault", json!({"kind": "outputModule", "slot": "still", "name": "PNG Sequence with Alpha"})).unwrap();s.execute_checked("comp.saveFrameAs", json!({"queue": true})).unwrap();let it = s.project.render_queue.last().unwrap();+ assert_eq!(it.output.name, "PNG Sequence with Alpha");assert_eq!(it.output.channels, effectcraft_project::render_queue::Channels::Rgba);- // Explicit `transparent: false` respects the request and stays Channels::Rgb+ // Passing transparent: false forces Channels::Rgb even with an RGBA templates.execute_checked("comp.saveFrameAs", json!({"queue": true, "transparent": false})).unwrap();let it = s.project.render_queue.last().unwrap();assert_eq!(it.output.channels, effectcraft_project::render_queue::Channels::Rgb);++ // With JPEG Sequence as Frame Default (non-alpha format), queue succeeds without error+ s.execute_checked("renderQueue.setTemplateDefault", json!({"kind": "outputModule", "slot": "still", "name": "JPEG Sequence"})).unwrap();+ assert!(s.execute_checked("comp.saveFrameAs", json!({"queue": true})).is_ok());}diff --git a/crates/project/src/render_templates.rs b/crates/project/src/render_templates.rsindex 8de342f4c..cf52b000e 100644--- a/crates/project/src/render_templates.rs+++ b/crates/project/src/render_templates.rs@@ -88,7 +88,7 @@ impl Default for TemplateDefaults {]),output_modules: s(&[(Movie, "H.264 - Match Render Settings - 15 Mbps"),- (Still, "PNG Sequence with Alpha"),+ (Still, "PNG Sequence"),(PreRender, "Lossless with Alpha"),(MovieProxy, "Lossless with Alpha"),(StillProxy, "PNG Sequence with Alpha"),