ComfyUI Node: 𝙆 Custom Save Image

𝙆 Custom Save Image:

The Custom_Save_Image node is designed to facilitate the saving of images with customizable metadata and format options, making it an essential tool for AI artists who wish to preserve their work with detailed information. This node allows you to save images in either PNG or JPG formats, with the ability to embed metadata such as author information, copyright details, and prompts used during image creation. It supports the inclusion of additional metadata through the extra_pnginfo parameter, providing flexibility in how images are documented. The node also offers options for color profile management, ensuring that images are saved with the desired color accuracy. By using this node, you can efficiently manage and archive your AI-generated images with comprehensive metadata, enhancing the traceability and authenticity of your digital artwork.

𝙆 Custom Save Image Input Parameters:

preview_only

This parameter determines whether the images are saved or only previewed. When set to True, the images are not saved to disk, allowing you to preview the output without committing to storage. The default value is False, meaning images will be saved by default.

images

This parameter accepts the images to be processed and saved. It is a required input and represents the actual image data that the node will handle.

filename_prefix

This parameter allows you to specify a prefix for the saved image filenames. It supports dynamic content such as date, time, and image dimensions, which can be embedded into the filename. The default value is "Custom_Save_Image".

color_profile

This parameter specifies the color profile to be used when saving images. You can choose between "sRGB IEC61966-2.1" and "Adobe RGB (1998)", with the default being "sRGB IEC61966-2.1". This choice affects the color accuracy and appearance of the saved images.

format

This parameter determines the file format for saving images, with options "PNG" and "JPG". The default format is "PNG", which supports lossless compression and metadata embedding.

jpg_quality

This parameter sets the quality level for JPG images, ranging from 0 to 100. A higher value results in better image quality but larger file size. The default value is 95, providing a balance between quality and file size.

author

This parameter allows you to embed the author's name into the image metadata. It is a string value that can be left empty if not needed.

copyright_info

This parameter enables you to include copyright information in the image metadata. It is a string value that can be left empty if not applicable.

save_metadata

This parameter controls whether metadata is saved with the image. When set to True, metadata such as author, copyright, and prompt information is embedded into the image file. The default value is False.

prompt

This hidden parameter allows you to include the prompt used for generating the image in the metadata. It is useful for documenting the creative process.

extra_pnginfo

This hidden parameter provides a way to add additional metadata to PNG images. It accepts a dictionary of key-value pairs, allowing for extensive customization of the image metadata.

𝙆 Custom Save Image Output Parameters:

The Custom_Save_Image node does not have explicit output parameters listed in the context. However, it returns a dictionary indicating the status of the operation, with a message confirming that images have been saved successfully.

𝙆 Custom Save Image Usage Tips:

• Use the filename_prefix parameter to organize your saved images systematically by embedding dynamic content like date and time.
• Choose the appropriate color_profile based on your display or print requirements to ensure color accuracy.
• Set save_metadata to True to preserve important information about the image creation process, which can be valuable for future reference or sharing.

𝙆 Custom Save Image Common Errors and Solutions:

Error: "Image format not supported"

• Explanation: This error occurs if an unsupported image format is specified.
• Solution: Ensure that the format parameter is set to either "PNG" or "JPG".

Error: "Invalid color profile"

• Explanation: This error arises when an unsupported color profile is selected.
• Solution: Verify that the color_profile parameter is set to either "sRGB IEC61966-2.1" or "Adobe RGB (1998)".

Error: "Failed to save image"

• Explanation: This error may occur due to file permission issues or incorrect file paths.
• Solution: Check the file path and ensure that the application has the necessary permissions to write to the specified directory.