Studio Headless Mode (#36)

This PR adds the capaibility to run Stroyteller studio from the command line, rendering the result to images. This is the basic functionality, and there are somethings that I am saving for later when we make this a more fully fledged feature. Limitations: - Right now, you cannot do image output resolutions that aren't 2^n. This is a bug I plan on tackling later. If you have questions on how the command line works, use the --help argument. Let me know what you think! --------- Co-authored-by: Danny McGee <dannymcgee@gmail.com>
2026-10-26 08:38:10 +00:00 · 2024-02-19 16:00:30 -07:00
parent a1779fb1ec
commit f1c1b85a98
11 changed files with 1016 additions and 28 deletions
@@ -0,0 +1,137 @@
+use bevy::render::render_resource::Extent3d;
+use clap::{Args, Parser, Subcommand};
+use studio::{start_headless, HeadlessMode};
+
+#[derive(Parser)]
+#[command(name = "StorytellerStudioHeadless")]
+#[command(author = "The Storyteller Team")]
+#[command(version = "1.0")]
+#[command(
+    about = "Executable for Storyteller Studio Headless. Allows you to render frames to images."
+)]
+#[command(propagate_version = true)]
+struct StudioArgs {
+    #[command(subcommand)]
+    subcommand: Subcommands,
+}
+
+#[derive(Subcommand)]
+enum Subcommands {
+    Scene {
+        scene_dir: String,
+        #[arg(long, short)]
+        output_dir: Option<String>,
+        #[arg(long)]
+        skybox: Option<String>,
+        #[arg(long = "res", value_parser = extent3d_parser)]
+        output_resolution: Option<Extent3d>,
+        #[arg(long, value_parser = clap::value_parser!(u32).range(1..))]
+        fps: Option<u32>,
+        #[arg(long, value_parser = clap::value_parser!(u32).range(1..))]
+        frames: Option<u32>,
+    },
+    Bvh {
+        bvh_dir: String,
+        #[arg(long, short = 'o', short)]
+        out: Option<String>,
+        #[arg(long)]
+        skybox: Option<String>,
+        #[arg(long = "res", value_parser = extent3d_parser)]
+        output_resolution: Option<Extent3d>,
+        #[arg(long, value_parser = clap::value_parser!(u32).range(1..))]
+        fps: Option<u32>,
+        #[arg(long, value_parser = clap::value_parser!(u32).range(1..))]
+        frames: Option<u32>,
+    },
+}
+
+#[derive(Args, Clone)]
+struct CommonArgs {}
+
+fn main() {
+    let args = StudioArgs::parse();
+
+    let mut app = match args.subcommand {
+        Subcommands::Scene {
+            scene_dir,
+            skybox,
+            output_dir,
+            output_resolution,
+            fps,
+            frames,
+        } => {
+            let output_dir = output_dir.unwrap_or("./screen_shots/".to_string());
+            let output_res = output_resolution.unwrap_or(Extent3d {
+                width: 1280,
+                height: 720,
+                depth_or_array_layers: 1,
+            });
+            let fps = fps.unwrap_or(24);
+            let frames = frames.unwrap_or(30);
+            let skybox = skybox.unwrap_or("gum_trees_4k".to_string());
+            start_headless(
+                HeadlessMode::Scene(scene_dir, skybox),
+                fps,
+                &output_dir,
+                frames,
+                output_res,
+            )
+        }
+        Subcommands::Bvh {
+            bvh_dir,
+            skybox,
+            out: output_dir,
+            output_resolution,
+            fps,
+            frames,
+        } => {
+            let output_dir = output_dir.unwrap_or("./screen_shots/".to_string());
+            let output_res = output_resolution.unwrap_or(Extent3d {
+                width: 1280,
+                height: 720,
+                depth_or_array_layers: 1,
+            });
+            let fps = fps.unwrap_or(24);
+            let frames = frames.unwrap_or(u32::MAX);
+            let skybox = skybox.unwrap_or("gum_trees_4k".to_string());
+            start_headless(
+                HeadlessMode::Bvh(bvh_dir, skybox),
+                fps,
+                &output_dir,
+                frames,
+                output_res,
+            )
+        }
+    };
+
+    app.run();
+}
+
+//==============================================================================
+//                        Parsers
+//==============================================================================
+
+fn extent3d_parser(input: &str) -> Result<Extent3d, String> {
+    let split = input.split('x').collect::<Vec<_>>();
+
+    if split.len() != 2 {
+        return Err(
+            "Invalid format for the Resolution argument, must follow the following pattern: <WIDTH>x<HEIGHT>"
+                .to_string()
+        );
+    }
+
+    let Ok(width) = split[0].parse::<u32>() else {
+        return Err("Width must be a number when defining the output resolution.".to_string());
+    };
+
+    let Ok(height) = split[1].parse::<u32>() else {
+        return Err("Width must be a number when defining the output resolution.".to_string());
+    };
+
+    Ok(Extent3d {
+        width,
+        height,
+        depth_or_array_layers: 1,
+    })
+}