Add ImageLabel node and FontManager

ImageLabel adds a label to the top or bottom of an image, extending its
dimensions as required.

This also introduces the FontManager class and ships the Roboto font.

comfy/fonts.py

@@ -0,0 +1,77 @@
+import logging
+from pathlib import Path
+from typing import Tuple, Union
+
+from PIL.ImageFont import FreeTypeFont, ImageFont, load_default as load_default_font, truetype as load_truetype
+
+from folder_paths import base_path
+
+
+default_font_path = Path(base_path) / "fonts"
+
+AnyFont = Union[FreeTypeFont, ImageFont]
+
+class FontCollection(dict):
+    """
+    A dictionary that maps font names to PIL font objects.
+    """
+
+    def __init__(self, directory: Path = default_font_path):
+        """
+        Initialize the FontCollection with fonts found in the given directory (including subdirectories).
+
+        Args:
+            directory (Path): The path to the directory containing font files.
+        """
+
+        paths = [font for font in directory.rglob("*.[tT][tT][fF]") if font.is_file()]
+        self.default_font_name, self.default_font = self.load_default_font()
+        fonts = {
+            self.default_font_name: self.default_font,
+        }
+        for path in paths:
+            font_info = self.load_font(path)
+            if font_info:
+                if font_info[0] in fonts:
+                    logging.warning(f"Fonts with duplicate names found: {font_info[0]}")
+                fonts[font_info[0]] = font_info[1]
+        super().__init__(fonts)
+
+    @classmethod
+    def load_default_font(cls) -> Tuple[str, AnyFont]:
+        """
+        Load the default PIL font.
+
+        Returns:
+            tuple[str, AnyFont]: The font's name and the font object.
+        """
+
+        font = load_default_font()
+        family, style = None, None
+        if isinstance(font, FreeTypeFont):
+            family, style = font.getname()
+        family = family or "Unknown"
+        style = style or "Regular"
+        return " ".join([family, style]), font
+
+    @classmethod
+    def load_font(cls, path: Path) -> Tuple[str, FreeTypeFont]:
+        """
+        Load a font and extract its name and style.
+
+        Args:
+            path (Path): The path to the font file.
+
+        Returns:
+            tuple[str, ImageFont.FreeTypeFont]: A tuple containing the font's name and the font object.
+
+        Raises:
+            OSError: If the font file could not be read.
+            ValueError: If the font size is not greater than zero.
+        """
+
+        font = load_truetype(path)
+        family, style = font.getname()
+        family = family or "Unknown"
+        style = style or "Regular"
+        return " ".join([family, style]), font

comfy_extras/nodes_images.py

@@ -1,10 +1,17 @@
+from typing import Tuple
+from math import ceil
+
 import nodes
 import folder_paths
 from comfy.cli_args import args
 
-from PIL import Image
+from torch import Tensor
+from torchvision.transforms.v2.functional import to_pil_image, to_image  # type: ignore
+from PIL import Image, ImageDraw
 from PIL.PngImagePlugin import PngInfo
 
+from comfy.fonts import FontCollection, AnyFont
+
 import numpy as np
 import json
 import os
@@ -33,6 +40,163 @@ class ImageCrop:
         img = image[:,y:to_y, x:to_x, :]
         return (img,)
 
+class ImageLabel:
+    fonts = FontCollection()
+
+    @classmethod
+    def INPUT_TYPES(s):
+        font_names = list(s.fonts.keys())
+        return {
+            "required": {
+                "image": ("IMAGE",),
+                "font": (font_names, {"default": s.fonts.default_font_name}),
+                "label": ("STRING", {"multiline": True}),
+                "position": (["top", "bottom"],),
+                "text_size": ("INT", {"default": 48, "min": 4}),
+                "padding": ("INT", {"default": 24}),
+                "line_spacing": ("INT", {"default": 5}),
+                "text_color": ("STRING", {"default": "#fff"}),
+                "background_color": ("STRING", {"default": "#000"}),
+            },
+        }
+
+    RETURN_TYPES = ("IMAGE",)
+    RETURN_NAMES = ("image",)
+    FUNCTION = "label"
+
+    CATEGORY = "image/transform"
+
+    def label(
+        self,
+        image: Tensor,
+        font: str,
+        label: str,
+        text_size: int,
+        padding: int,
+        line_spacing: int,
+        position: str,
+        text_color: str,
+        background_color: str,
+    ):
+        """
+        Extends an image at the top or bottom to add a label.
+
+        Args:
+            image (Tensor): The input image as a tensor with shape [1, H, W, C].
+            font (str): The font name to be used for the label.
+            label (str): The text of the label.
+            text_size (int): The size of the label text in pixels.
+            padding (int): Padding around the label text in pixels.
+            line_spacing (int): Spacing between lines of the label.
+            position (str): Position of the label, either 'top' or 'bottom'.
+            text_color (str): Color of the label text as a hex reference.
+            background_color (str): Background color of the label area as a hex reference.
+
+        Returns:
+            Tensor: The image with the label added, as a tensor with shape [1, H, W, C].
+
+        Raises:
+            ValueError: If an invalid position is provided.
+        """
+
+        original_image = to_pil_image(image.squeeze(0).permute(2, 0, 1))
+        width, height = original_image.size
+        font_obj: AnyFont = self.fonts[font].font_variant(size=text_size)
+
+        _, label_height, text_size = self.calculate_label_dimensions(
+            font_obj, label, text_size, line_spacing, padding, width
+        )
+
+        label_image = self.draw_label(
+            font_obj, label, width, label_height, line_spacing, text_color, background_color
+        )
+
+        combined_image = Image.new("RGB", (width, height + label_height + line_spacing), (0, 0, 0))
+        if position == "top":
+            combined_image.paste(original_image, (0, label_height))
+            combined_image.paste(label_image, (0, 0))
+        elif position == "bottom":
+            combined_image.paste(label_image, (0, height))
+            combined_image.paste(original_image, (0, 0))
+        else:
+            raise ValueError(f"Unknown position: {position}")
+
+        return (to_image(combined_image) / 255.0).permute(1, 2, 0)[None, None, ...]
+
+    def calculate_label_dimensions(
+        self, font: AnyFont, label: str, text_size: int, line_spacing: int, padding: int, max_width: float
+    ) -> Tuple[int, int, int]:
+        """
+        Calculate the dimensions needed to draw a label within an image.
+
+        This will reduce the font size where necessary to make the text fit.
+
+        Args:
+            font (AnyFont): The Pillow font to use.
+            label (str): The text to calculate dimensions for.
+            text_size (int): Starting font size for the label.
+            line_spacing (int): Spacing between lines of text.
+            padding (int): Padding around the text.
+            max_width (float): Maximum allowed width for the text box.
+
+        Returns:
+            tuple[int, int, int]: The calculated width, height, and final font size.
+        """
+
+        while True:
+            temp_image = Image.new("RGB", (1, 1))
+            x1, y1, x2, y2 = ImageDraw.Draw(temp_image).textbbox(
+                xy=(0, 0), text=label, font=font, spacing=line_spacing, align="center"
+            )
+            width = ceil(x2 - x1 + padding * 2)
+            height = ceil(y2 - y1 + padding * 2)
+            if width <= max_width:
+                break
+            text_size -= 1
+            if text_size <= 8:
+                break
+
+        return width, height, text_size
+
+    def draw_label(
+        self,
+        font: AnyFont,
+        label: str,
+        width: int,
+        height: int,
+        line_spacing: int,
+        text_color: str,
+        background_color: str,
+    ) -> Image.Image:
+        """
+        Draws an image containing a label.
+
+        Args:
+            font (AnyFont): The Pillow font to use for text rendering.
+            label (str): The text to use as the label.
+            width (int): Width of the image in pixels.
+            height (int): Height of the image in pixels.
+            line_spacing (int): Spacing between lines of text.
+            text_color (str): Color of the text as a hex reference.
+            background_color (str): Background color of the image as a hex reference.
+
+        Returns:
+            Image: An image object with the label drawn on it.
+        """
+
+        image = Image.new("RGB", (width, height), background_color)
+        draw = ImageDraw.Draw(image)
+        draw.multiline_text(
+            xy=(width / 2, height / 2),
+            text=label,
+            fill=text_color,
+            font=font,
+            anchor="mm",
+            spacing=line_spacing,
+            align="center",
+        )
+        return image
+
 class RepeatImageBatch:
     @classmethod
     def INPUT_TYPES(s):
@@ -188,6 +352,7 @@ class SaveAnimatedPNG:
 
 NODE_CLASS_MAPPINGS = {
     "ImageCrop": ImageCrop,
+    "ImageLabel": ImageLabel,
     "RepeatImageBatch": RepeatImageBatch,
     "ImageFromBatch": ImageFromBatch,
     "SaveAnimatedWEBP": SaveAnimatedWEBP,

fonts/Roboto/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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.