Skip to content

Add gif file export via graphene cli#3846

Open
TrueDoctor wants to merge 1 commit intomasterfrom
gif
Open

Add gif file export via graphene cli#3846
TrueDoctor wants to merge 1 commit intomasterfrom
gif

Conversation

@TrueDoctor
Copy link
Member

No description provided.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the graphene-cli by introducing support for exporting documents as animated GIF files. This new capability allows users to render dynamic content from their .graphite documents into a widely supported animation format, complete with configurable animation parameters. The change integrates GIF encoding into the existing export pipeline, providing a more versatile output option for animated graph compositions.

Highlights

  • GIF Export Functionality: Added the ability to export .graphite documents as animated GIF files via the graphene-cli.
  • Animation Parameters: Introduced new command-line arguments (--fps, --frames, --duration) for controlling GIF animation properties like frame rate, total frames, and animation duration.
  • Image Crate Update: Enabled the gif feature for the image crate in Cargo.toml to support GIF encoding.
Changelog
  • Cargo.toml
    • Enabled the 'gif' feature for the 'image' crate.
  • node-graph/graphene-cli/src/export.rs
    • Added TimingInformation and Duration imports.
    • Extended the FileType enum to include Gif.
    • Updated detect_file_type to recognize .gif file extensions.
    • Modified write_raster_image to correctly handle FileType::Gif as an unreachable case, indicating it's handled by a separate function.
    • Introduced a new AnimationParams struct to encapsulate GIF animation settings (frames per second, total frames).
    • Implemented the export_gif asynchronous function for rendering and encoding animated GIFs from multiple frames.
  • node-graph/graphene-cli/src/main.rs
    • Updated the Export command description to include GIF as a supported output format.
    • Added new command-line arguments (--fps, --frames, --duration) to the Export command for configuring GIF animation.
    • Modified the main function to conditionally call the new export_gif function when the output file type is GIF, passing the animation parameters.
  • node-graph/interpreted-executor/benches/benchmark_util.rs
    • Removed two println! debug statements related to network processing.
Activity
  • No human activity (comments, reviews) has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a significant new feature: exporting animations as GIF files from the command line. The implementation is well-structured, introducing AnimationParams to handle animation settings and a dedicated export_gif function for the rendering loop. The changes to the CLI arguments are also correctly implemented. I have a few suggestions to improve robustness and clarity, particularly around input validation for animation parameters.

Comment on lines +133 to +142
pub fn new(fps: f64, frames: Option<u32>, duration: Option<f64>) -> Self {
let frames = match (frames, duration) {
// Duration takes precedence if both provided
(_, Some(dur)) => (dur * fps).round() as u32,
(Some(f), None) => f,
// Default to 1 frame if neither provided
(None, None) => 1,
};
Self { fps, frames }
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The fps argument can be provided by the user and could be zero or negative, which would lead to a panic or incorrect calculations in frame_delay_centiseconds. It's better to validate this input and return a Result to handle the error gracefully. The call site in main.rs will also need to be updated to handle this Result.

pub fn new(fps: f64, frames: Option<u32>, duration: Option<f64>) -> Result<Self, String> {
	if fps <= 0.0 {
		return Err("FPS must be a positive number.".to_string());
	}

	let frames = match (frames, duration) {
		// Duration takes precedence if both provided
		(_, Some(dur)) => (dur * fps).round() as u32,
		(Some(f), None) => f,
		// Default to 1 frame if neither provided
		(None, None) => 1,
	};
	Ok(Self { fps, frames })
}

Comment on lines +145 to +147
pub fn frame_delay_centiseconds(&self) -> u16 {
((100.0 / self.fps).round() as u16).max(1)
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While as casts from float to integer are saturating in recent Rust editions, this behavior can be subtle. Using clamp makes the intention of handling both lower and upper bounds explicit, improving code clarity and robustness.

	pub fn frame_delay_centiseconds(&self) -> u16 {
		let delay = (100.0 / self.fps).round();
		// Clamp to the valid range for GIF frame delay (1 to u16::MAX centiseconds).
		delay.clamp(1.0, u16::MAX as f64) as u16
	}

export::export_document(&executor, wgpu_executor_ref, output, file_type, scale, (width, height), transparent).await?;
// Perform export based on file type
if file_type == export::FileType::Gif {
let animation = export::AnimationParams::new(fps, frames, duration);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To handle the Result now returned by AnimationParams::new (as suggested in another comment), you can use the ? operator to propagate any errors.

Suggested change
let animation = export::AnimationParams::new(fps, frames, duration);
let animation = export::AnimationParams::new(fps, frames, duration)?;

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 4 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="node-graph/graphene-cli/src/main.rs">

<violation number="1" location="node-graph/graphene-cli/src/main.rs:80">
P2: The `fps` parameter accepts zero or negative values, which will cause a panic at runtime when rendering GIF frames. `Duration::from_secs_f64(NaN)` (from `0/0`) or `Duration::from_secs_f64(-x)` both panic. Consider adding a `value_parser` constraint or validating `fps > 0` before use.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.


/// Frames per second for GIF animation (default: 30)
#[clap(long, default_value = "30")]
fps: f64,
Copy link

@cubic-dev-ai cubic-dev-ai bot Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The fps parameter accepts zero or negative values, which will cause a panic at runtime when rendering GIF frames. Duration::from_secs_f64(NaN) (from 0/0) or Duration::from_secs_f64(-x) both panic. Consider adding a value_parser constraint or validating fps > 0 before use.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At node-graph/graphene-cli/src/main.rs, line 80:

<comment>The `fps` parameter accepts zero or negative values, which will cause a panic at runtime when rendering GIF frames. `Duration::from_secs_f64(NaN)` (from `0/0`) or `Duration::from_secs_f64(-x)` both panic. Consider adding a `value_parser` constraint or validating `fps > 0` before use.</comment>

<file context>
@@ -74,6 +74,18 @@ enum Command {
+
+		/// Frames per second for GIF animation (default: 30)
+		#[clap(long, default_value = "30")]
+		fps: f64,
+
+		/// Total number of frames for GIF animation
</file context>
Fix with Cubic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant