From c899e4b8c842b8c429e0b50d1a4bb83f8ed70a23 Mon Sep 17 00:00:00 2001 From: Aimeri Baddouh Date: Thu, 12 Sep 2024 15:10:43 -0400 Subject: [PATCH] Add 16bit and 32bit support This initial version of the node saves successfully to your output folder using the configured settings for format and bit depth --- LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 21 +++++ __init__.py | 10 +++ pyproject.toml | 15 ++++ save_image_node.py | 118 ++++++++++++++++++++++++++ 5 files changed, 365 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 __init__.py create mode 100644 pyproject.toml create mode 100644 save_image_node.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4d83d4f --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Higher Bit Density SaveImage Node +This is a ComfyUI node that allows you to save images with a higher bit depth. + +## Installation +1. Download the `save_image_node.py` file. +2. Place the file in the `custom_nodes` directory of your ComfyUI installation. + +## Usage +1. Add the `Save Image (Higher Bit Depth)` node to your graph. +2. Connect the image you want to save to the `IMAGE` input of the node. +3. Set the `filename_prefix` to the directory where you want to save the image. +4. Set the `bit_depth` to the bit depth of the image you want to save. +5. Set the `format` to the format of the image you want to save. Default is `PNG`. + + + +## Notes +- The `format` can be `PNG`, `TIFF`, or `JPEG`. +- The `filename_prefix` is the prefix of the filename of the image you want to save. +- The `bit_depth` is the bit depth of the image you want to save. +- For 32 bit images, only TIFF is supported, and will be automatically used if selected. diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..079a254 --- /dev/null +++ b/__init__.py @@ -0,0 +1,10 @@ +from .save_image_node import SaveImageHigherBitDepth + +NODE_CLASS_MAPPINGS = { + "SaveImageHigherBitDepth": SaveImageHigherBitDepth, +} +NODE_DISPLAY_NAME_MAPPINGS = { + "SaveImageHigherBitDepth": "Save Image Higher Bit Depth", +} + +__all__ = ["NODE_CLASS_MAPPINGS", "NODE_DISPLAY_NAME_MAPPINGS"] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..8fd603b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,15 @@ +[project] +name = "higher_bit_depth_save_image" +description = "A comfyui node that provides save image with higher bit depth." +version = "1.0.0" +license = {file = "LICENSE"} +dependencies = ["opencv-python-headless", "Pillow", "numpy"] + +[project.urls] +Repository = "https://github.com/aimerib/ComfyUI-HigherBitDepthSaveImage" +# Used by Comfy Registry https://ceomfyregistry.org + +[tool.comfy] +PublisherId = "aimerib" +DisplayName = "ComfyUI-HigherBitDepthSaveImage" +Icon = "" diff --git a/save_image_node.py b/save_image_node.py new file mode 100644 index 0000000..d7e933e --- /dev/null +++ b/save_image_node.py @@ -0,0 +1,118 @@ +from PIL import Image +import numpy as np +import cv2 +import folder_paths +from PIL.PngImagePlugin import PngInfo +import os +import json + +from comfy.cli_args import args +import comfy.utils + +class SaveImageHigherBitDepth: + def __init__(self): + self.output_dir = folder_paths.get_output_directory() + self.type = "output" + self.prefix_append = "" + self.compress_level = 4 + + @classmethod + def INPUT_TYPES(s): + return { + "required": { + "images": ("IMAGE", {"tooltip": "The images to save."}), + "filename_prefix": ("STRING", {"default": "ComfyUI", "tooltip": "The prefix of the filename of the image you want to save."}), + "bit_depth": (["8", "16", "32"], {"default": "8", "tooltip": "The bit depth of the image you want to save."}), + "format": (["PNG", "TIFF", "JPEG"], {"default": "PNG", "tooltip": "The format of the image you want to save."}) + }, + } + + RETURN_TYPES = () + FUNCTION = "save_images" + + OUTPUT_NODE = True + + CATEGORY = "image" + DESCRIPTION = "Save image with higher bit depth and format." + + def save_images(self, images, bit_depth, format="PNG", filename_prefix="ComfyUI", prompt=None, extra_pnginfo=None): + filename_prefix += self.prefix_append + full_output_folder, filename, counter, subfolder, filename_prefix = folder_paths.get_save_image_path(filename_prefix, self.output_dir, images[0].shape[1], images[0].shape[0]) + results = list() + for (batch_number, image) in enumerate(images): + img_np = image.cpu().numpy() + + if img_np.ndim != 3 or img_np.shape[2] != 3: + raise ValueError("Expected an RGB image with 3 channels.") + + if bit_depth == "32": + format = "TIFF" + img = img_np.astype(np.float32) + # img = self.convert_opencv_to_pil(img_np) + elif bit_depth == "16": + format = "TIFF" if format == "TIFF" else "PNG" + img = np.clip(img_np * 65535.0, 0, 65535).astype(np.uint16) + # img = self.convert_opencv_to_pil(img_np) + else: + i = np.clip(img_np * 255.0, 0, 255).astype(np.uint8) + img = Image.fromarray(i, mode='RGB') + metadata = None + if not args.disable_metadata and format == "PNG": + metadata = PngInfo() + if prompt is not None: + metadata.add_text("prompt", json.dumps(prompt)) + if extra_pnginfo is not None: + for x in extra_pnginfo: + metadata.add_text(x, json.dumps(extra_pnginfo[x])) + + filename_with_batch_num = filename.replace("%batch_num%", str(batch_number)) + # file = f"{filename_with_batch_num}_{counter:05}_.png" + # img.save(os.path.join(full_output_folder, file), pnginfo=metadata, compress_level=self.compress_level) + if format == "JPEG": + file = f"{filename_with_batch_num}_{counter:05}_.jpg" + img.save(os.path.join(full_output_folder, file)) + elif format == "PNG" and bit_depth == "8": + file = f"{filename_with_batch_num}_{counter:05}_.png" + img.save(os.path.join(full_output_folder, file), pnginfo=metadata, compress_level=self.compress_level) + elif format == "PNG": + file = f"{filename_with_batch_num}_{counter:05}_.png" + cv2.imwrite(os.path.join(full_output_folder, file), img) + # img.save(os.path.join(full_output_folder, file), pnginfo=metadata, compress_level=self.compress_level) + elif format == "TIFF": + file = f"{filename_with_batch_num}_{counter:05}_.tiff" + cv2.imwrite(os.path.join(full_output_folder, file), img) + # img.save(os.path.join(full_output_folder, file)) + results.append({ + "filename": file, + "subfolder": subfolder, + "type": self.type + }) + counter += 1 + + return { "ui": { "images": results } } + + def convert_opencv_to_pil(self, img_np): + try: + if img_np.dtype == np.float32: + # For 32-bit float images + img_np = (img_np * 65535).astype(np.uint16) + elif img_np.dtype == np.uint8: + # For 8-bit images, no change needed + pass + elif img_np.dtype == np.uint16: + # For 16-bit images, no change needed + pass + else: + raise ValueError(f"Unsupported image dtype: {img_np.dtype}") + + # Convert BGR to RGB + img_np = cv2.cvtColor(img_np, cv2.COLOR_BGR2RGB) + + # Create PIL Image directly from numpy array + img = Image.fromarray(img_np) + + return img + + except Exception as e: + print(f"Error converting OpenCV image to PIL: {e}") + raise