ComfyUI Node: Image Saver

Image Saver:

The Image Saver node is designed to facilitate the saving of generated images with a variety of customizable options. This node allows you to save images in different formats such as PNG, JPEG, and WebP, while also embedding metadata and additional information into the image files. It supports the inclusion of workflow and prompt data within the image metadata, making it easier to track and reproduce the generation process. The node is highly configurable, offering options to optimize image quality, manage file naming conventions, and control the embedding of extra information. This makes it an essential tool for AI artists who need to save and organize their generated images efficiently.

Image Saver Input Parameters:

images

A list of images to be saved. This parameter is essential as it contains the actual image data that will be processed and saved.

seed_value

An integer value used to seed the random number generator for reproducibility. Default is 0, with a minimum of 0 and a maximum of 0xffffffffffffffff.

steps

An integer representing the number of steps used in the image generation process. Default is 20, with a minimum of 1 and a maximum of 10000.

cfg

A floating-point value that controls the classifier-free guidance scale. Default is 7.0, with a minimum of 0.0 and a maximum of 100.0.

sampler_name

A string specifying the name of the sampler used in the image generation process. Default is an empty string.

scheduler

A string indicating the type of scheduler used. Default is 'normal'.

positive

A string containing positive prompts used during image generation. Default is 'unknown'.

negative

A string containing negative prompts used during image generation. Default is 'unknown'.

modelname

A string specifying the name of the model used for image generation. Default is an empty string.

quality_jpeg_or_webp

An integer value that sets the quality of JPEG or WebP images. Default is 100, with a minimum of 1 and a maximum of 100.

lossless_webp

A boolean indicating whether to save WebP images in a lossless format. Default is True.

optimize_png

A boolean indicating whether to optimize PNG images. Default is False.

width

An integer specifying the width of the image. Default is 512, with a minimum of 1 and a maximum defined by MAX_RESOLUTION, in steps of 8.

height

An integer specifying the height of the image. Default is 512, with a minimum of 1 and a maximum defined by MAX_RESOLUTION, in steps of 8.

counter

An integer used to keep track of the number of images saved. Default is 0, with a minimum of 0 and a maximum of 0xffffffffffffffff.

filename

A string specifying the base name for the saved files. This helps in organizing and identifying saved images.

path

A string indicating the directory path where the images will be saved. This is crucial for file organization.

extension

A string specifying the file extension for the saved images (e.g., 'png', 'jpg', 'webp').

time_format

A string defining the format for timestamping the saved files. Default is "%Y-%m-%d-%H%M%S".

denoise

A floating-point value that controls the denoising strength. Default is 1.0, with a minimum of 0.0 and a maximum of 1.0.

save_workflow_as_json

A boolean indicating whether to save the workflow as a JSON file. Default is False.

embed_workflow_in_png

A boolean indicating whether to embed the workflow and prompt data in the PNG metadata. Default is True.

strip_a1111_params

A string specifying how to handle additional parameters. Default is 'nothing'.

prompt

A hidden parameter for the prompt data to be embedded in the image metadata.

extra_pnginfo

A hidden parameter for additional PNG information to be embedded in the image metadata.

Image Saver Output Parameters:

paths

A list of file paths where the images have been saved. This output is crucial for locating and accessing the saved images.

Image Saver Usage Tips:

• Ensure that the path parameter is set to a valid directory to avoid file saving errors.
• Use the filename parameter to create a consistent naming convention for your saved images, making them easier to organize and retrieve.
• Adjust the quality_jpeg_or_webp parameter to balance between image quality and file size, especially when saving a large number of images.
• Enable optimize_png to reduce the file size of PNG images without compromising quality, which is useful for web usage.
• Utilize the embed_workflow_in_png option to keep track of the generation parameters directly within the image file, aiding in reproducibility.

Image Saver Common Errors and Solutions:

"Invalid file path"

• Explanation: The specified directory path does not exist or is not accessible.
• Solution: Ensure that the path parameter is set to a valid and accessible directory.

"Unsupported file extension"

• Explanation: The specified file extension is not supported for saving images.
• Solution: Use a supported file extension such as 'png', 'jpg', or 'webp'.

"Image save failed due to insufficient permissions"

• Explanation: The application does not have the necessary permissions to write to the specified directory.
• Solution: Check and modify the directory permissions to allow write access.

"Metadata embedding failed"

• Explanation: There was an issue embedding metadata into the image file.
• Solution: Ensure that the metadata parameters such as prompt and extra_pnginfo are correctly formatted and not too large.

"File name conflict"

• Explanation: A file with the same name already exists in the specified directory.
• Solution: Use a unique filename or enable timestamping with the time_format parameter to avoid conflicts.