AnimateDiffCombine Node Documentation

Overview

The AnimateDiffCombine node is a component in the ComfyUI ecosystem designed specifically for assembling and outputting animated content, such as GIFs and videos. It takes individual image frames and combines them into a cohesive animation, offering multiple output formats and customizable playback settings.

Node Functionality

Purpose

The primary function of AnimateDiffCombine is to compile a series of image frames into a single animated output. It allows users to specify the frame rate, looping behavior, and file format for the final animation, making it a versatile tool for generating GIFs, animated webp files, and various video formats.

Inputs

Required Inputs

1. images: A collection of image frames that you want to combine into an animation. Each image serves as a frame in the resulting animation.

2. frame_rate: The number of frames per second in the final animation. Allows users to control the speed and smoothness of playback. Accepts integer values ranging from 1 to 24.

3. loop_count: The number of times the animation should repeat. Use a value of 0 for infinite looping. Accepts integer values between 0 and 100.

4. save_image: A boolean option that determines whether the created GIF or video should be saved to disk (True) or temporarily created and discarded (False).

5. filename_prefix: A string to specify the prefix for the saved file's name, providing organizational clarity when saving files.

6. format: The desired output format for the animation. Supported formats are image/gif, image/webp, video/webm, video/h264-mp4, and video/h265-mp4. Note that video formats require ffmpeg to be installed and accessible in the system PATH.

7. pingpong: A boolean option that, when enabled, causes the animation to reverse back to the start frame, creating a seamless "ping-pong" effect which can add visual interest to the output.

Hidden Inputs

• prompt: Metadata related to the prompt used in the generation of frames.
• extra_pnginfo: Additional metadata embedded in the output for storage of state or provenance information.

Outputs

This node does not explicitly produce a returned output for use by other nodes, but it saves the compiled animation to the designated output directory or a temporary location based on the save_image setting. A preview of the constructed animation is also provided in the form of video metadata, including its filename, subfolder, and format used. This output appears in the ComfyUI interface.

Usage in ComfyUI Workflows

The AnimateDiffCombine node is typically positioned at the end of workflows involving animation sequences within the ComfyUI pipeline. It can follow nodes responsible for generating, processing, or temporally manipulating image frames, such as samplers or motion modules. This node is essential for concluding animation workflows as it outputs the final animated product suitable for viewing or further use.

Example Workflow Applications

• Simple Text-to-GIF Animation: After generating frames from text prompts, this node combines them into a looping GIF.
• Enhanced Video Creation: By using other nodes to alter or enhance frames, such as the application of filters or transformations, and stitching them into diverse video formats for professional or artistic purposes.

Special Features and Considerations

• Video Format Support: To output as a video, ensure that ffmpeg is installed and fully operational in your environment. This is a critical dependency for handling multiple video codecs and ensures multimedia versatility.
• Metadata Embedding: Prompts and additional metadata can be associated with the output, which is particularly useful for tracking or debugging.
• Performance and Storage Implications: Saving high-resolution or long-duration animations can result in large files requiring significant storage, so consider resource management and file output settings in complex applications.

Summary

The AnimateDiffCombine node is a powerful tool for assembling animations from image sequences in ComfyUI, offering a range of output formats and customization options essential for creative control in digital animation and GIF/video creation workflows.