ComfyUI Node: 🌻 Image Saver

🌻 Image Saver:

The AD_ImageSaver node is designed to facilitate the efficient saving of images generated or processed within the ComfyUI environment. This node is particularly beneficial for AI artists who need to manage and store their creative outputs systematically. It offers a robust mechanism to handle file naming, ensuring that images are saved with unique identifiers to prevent overwriting. Additionally, it supports the inclusion of metadata, which can be crucial for documenting the creative process, such as prompts or additional information related to the image. The node is versatile, allowing for the saving of images in different formats like PNG and JPG, with options to adjust quality and compression settings. By automating the image-saving process, AD_ImageSaver streamlines workflow, allowing artists to focus more on creativity rather than file management.

🌻 Image Saver Input Parameters:

images

This parameter expects a list of images that you want to save. The images should be in a format that can be processed by the node, typically as arrays or image objects. The function of this parameter is to provide the node with the actual content that needs to be stored on disk.

folder

The folder parameter specifies the directory where the images will be saved. It impacts the node's execution by determining the storage location, and it should be a valid path on your system. There are no specific minimum or maximum values, but it should be a string representing a valid directory path.

filename_prefix

This parameter is used to define the prefix for the filenames of the saved images. It allows for batch processing by including a placeholder for batch numbers, ensuring unique filenames. The prefix should be a string, and it can include the placeholder %batch_num% to automatically insert batch numbers.

overwrite_warning

A boolean parameter that, when set to true, will trigger a warning if a file with the same name already exists in the target directory. This helps prevent accidental overwriting of existing files. The default value is typically false, meaning no warning will be issued unless specified.

include_metadata

This boolean parameter determines whether metadata should be included in the saved image files. When true, it allows for the embedding of additional information such as prompts or custom data into the image file, which can be useful for documentation or future reference.

extension

Specifies the file format for the saved images, such as "png" or "jpg". This parameter affects the image's compression and quality settings, with PNG supporting lossless compression and metadata, while JPG allows for adjustable quality settings.

quality

An integer parameter that sets the quality level for JPG images, typically ranging from 1 to 100. Higher values result in better image quality but larger file sizes. This parameter is only applicable when the extension is set to "jpg".

open_output_directory

A boolean parameter that, when true, will automatically open the directory where the images are saved after the operation is complete. This can be useful for quickly accessing and reviewing the saved images.

filename_opt

An optional parameter that allows you to specify a custom filename for the saved image. If provided, it overrides the automatic filename generation. This should be a string, and it is particularly useful when saving a single image to avoid overwriting.

prompt

This parameter allows you to include a text prompt as part of the image's metadata. It is a string that can be used to document the creative input or inspiration behind the image, providing context for future reference.

extra_pnginfo

A dictionary parameter that allows for the inclusion of additional metadata in PNG files. Each key-value pair in the dictionary represents a piece of metadata to be embedded in the image, offering flexibility in documenting various aspects of the image creation process.

🌻 Image Saver Output Parameters:

ui

The ui output parameter provides a structured response containing information about the saved images. It includes details such as filenames and subfolder paths, which are useful for verifying the save operation and accessing the images. This output is essential for integrating the node's functionality into larger workflows, as it provides feedback on the success and location of the saved files.

🌻 Image Saver Usage Tips:

• Use the filename_prefix with the %batch_num% placeholder to automatically generate unique filenames for batch processing, preventing accidental overwrites.
• Set include_metadata to true to embed prompts and other relevant information directly into your image files, which can be invaluable for tracking the creative process.
• Adjust the quality parameter for JPG images to balance between file size and image quality, especially when working with large batches of images.

🌻 Image Saver Common Errors and Solutions:

"Multiple images and filename detected: Images will overwrite themselves!"

• Explanation: This error occurs when you attempt to save multiple images with a single specified filename, which would result in overwriting.
• Solution: Ensure that you either provide a unique filename for each image or use the filename_prefix with batch numbering to generate distinct filenames automatically.

"Filename already exists."

• Explanation: This error indicates that a file with the same name already exists in the target directory, and the node is set to prevent overwriting.
• Solution: Either change the filename or adjust the overwrite_warning parameter to allow overwriting if intentional. Alternatively, use the filename_prefix to generate unique filenames.