feat: add option for text stroke width

README.md

@@ -228,6 +228,7 @@ Find all effect/layout config example at [link](https://github.com/oh-my-ocr/tex
 | 21 | perspective_transform                | ![perspective_transform.jpg](https://github.com/oh-my-ocr/text_renderer/raw/master/example_data/effect_layout_image/perspective_transform.jpg)                               |
 | 22 | same_line_layout_different_font_size | ![same_line_layout_different_font_size.jpg](https://github.com/oh-my-ocr/text_renderer/raw/master/example_data/effect_layout_image/same_line_layout_different_font_size.jpg) |
 | 23 | vertical_text                        | ![vertical_text.jpg](https://github.com/oh-my-ocr/text_renderer/raw/master/example_data/effect_layout_image/vertical_text.jpg)                                               |
+| 24 | text_stroke_width                        | ![text_stroke_width.jpg](https://github.com/oh-my-ocr/text_renderer/raw/master/example_data/effect_layout_image/text_stroke_width.jpg)                                               |
 
 
 ## Contribution

example_data/effect_layout_example.py

@@ -213,10 +213,15 @@ def emboss():
 
     return cfg
 
+def text_stroke_width():
+    cfg = base_cfg(inspect.currentframe().f_code.co_name)
+    cfg.render_cfg.corpus.cfg.stroke_width = (0, 2)
+    return cfg
+
 
 configs = [
     # bg_and_text_mask()
-    emboss()
+    # emboss()
     # vertical_text()
     # extra_text_line_layout()
     # char_spacing_compact(),
@@ -229,4 +234,5 @@ def emboss():
     # dropout_vertical(),
     # padding(),
     # same_line_layout_different_font_size(),
+    text_stroke_width()
 ]

text_renderer/corpus/corpus.py

@@ -38,6 +38,9 @@ class CorpusCfg:
         horizontal : bool
             generate the horizontal(default) or vertical text
             Set False to generate vertical text
+        stroke_width: (Union[int, tuple[int, int]])
+            Add stroke width to text. If tuple, random choice between (min, max)
+            Set -1 to disable
     """
     font_dir: Path
     font_size: Tuple[int, int]
@@ -46,6 +49,7 @@ class CorpusCfg:
     char_spacing: Union[float, Tuple[float, float]] = -1
     text_color_cfg: TextColorCfg = field(default_factory=SimpleTextColorCfg)
     horizontal: bool = True
+    stroke_width: Union[int, Tuple[int, int]] = -1
 
     def __init_subclass__(cls, **kwargs):
         super().__init_subclass__(**kwargs)

text_renderer/render.py

@@ -149,7 +149,7 @@ def gen_single_corpus(self) -> Tuple[PILImage, str, PILImage, PILImage]:
             text_color = self.corpus.cfg.text_color_cfg.get_color(bg)
 
         text_mask = draw_text_on_bg(
-            font_text, text_color, char_spacing=self.corpus.cfg.char_spacing
+            font_text, text_color, char_spacing=self.corpus.cfg.char_spacing, stroke_width=self.corpus.cfg.stroke_width
         )
 
         if self.cfg.corpus_effects is not None:
@@ -217,7 +217,7 @@ def gen_multi_corpus(self) -> Tuple[PILImage, str, PILImage, PILImage]:
             else:
                 _text_color = text_color
             text_mask = draw_text_on_bg(
-                font_text, _text_color, char_spacing=self.corpus[i].cfg.char_spacing
+                font_text, _text_color, char_spacing=self.corpus[i].cfg.char_spacing, stroke_width=self.corpus[i].cfg.stroke_width
             )
 
             text_bbox = BBox.from_size(text_mask.size)

text_renderer/utils/draw_utils.py

@@ -23,6 +23,7 @@ def draw_text_on_bg(
     font_text: FontText,
     text_color: Tuple[int, int, int, int] = (0, 0, 0, 255),
     char_spacing: Union[float, Tuple[float, float]] = -1,
+    stroke_width: Union[int, Tuple[int, int]] = -1
 ) -> PILImage:
     """
 
@@ -34,17 +35,32 @@ def draw_text_on_bg(
     char_spacing : Union[float, Tuple[float, float]]
         Draw character with spacing. If tuple, random choice between [min, max)
         Set -1 to disable
-
+    stroke_width: (Union[int, tuple[int, int]])
+        Add stroke width to text. If tuple, random choice between (min, max)
+        Set -1 to disable
     Returns
     -------
         PILImage:
             RGBA Pillow image with text on a transparent image
     -------
 
     """
+    # Determine the text stroke width
+    if stroke_width == -1:
+        actual_stroke_width = 0
+    elif isinstance(stroke_width, int):
+        actual_stroke_width = max(0, stroke_width)
+    elif isinstance(stroke_width, Tuple) and len(stroke_width) == 2:
+        try:
+            actual_stroke_width = max(0, int(np.random.uniform(stroke_width[0], stroke_width[1])))
+        except (ValueError, TypeError):
+            actual_stroke_width = 0
+    else:
+        actual_stroke_width = 0
+
     if char_spacing == -1:
         if font_text.horizontal:
-            return _draw_text_on_bg(font_text, text_color)
+            return _draw_text_on_bg(font_text, text_color, actual_stroke_width)
         else:
             char_spacing = 0
 
@@ -95,12 +111,12 @@ def draw_text_on_bg(
     if font_text.horizontal:
         y_offset = font_text.offset[1]
         for i, c in enumerate(font_text.text):
-            draw.text((c_x, c_y - y_offset), c, fill=text_color, font=font_text.font)
+            draw.text((c_x, c_y - y_offset), c, fill=text_color, font=font_text.font, stroke_width=actual_stroke_width, stroke_fill=text_color)
             c_x += chars_size[i][0] + char_spacings[i]
     else:
         x_offset = font_text.offset[0]
         for i, c in enumerate(font_text.text):
-            draw.text((c_x - x_offset, c_y), c, fill=text_color, font=font_text.font)
+            draw.text((c_x - x_offset, c_y), c, fill=text_color, font=font_text.font, stroke_width=actual_stroke_width, stroke_fill=text_color)
             c_y += chars_size[i][1] + char_spacings[i]
         text_mask = text_mask.rotate(90, expand=True)
 
@@ -110,6 +126,7 @@ def draw_text_on_bg(
 def _draw_text_on_bg(
     font_text: FontText,
     text_color: Tuple[int, int, int, int] = (0, 0, 0, 255),
+    stroke_width: Union[int, Tuple[int, int]] = -1
 ) -> PILImage:
     """
     Draw text
@@ -119,7 +136,9 @@ def _draw_text_on_bg(
     font_text : FontText
     text_color : RGBA
         Default is black
-
+    stroke_width: (Union[int, tuple[int, int]])
+        Add stroke width to text. If tuple, random choice between (min, max)
+        Set -1 to disable
     Returns
     -------
         PILImage:
@@ -138,6 +157,8 @@ def _draw_text_on_bg(
         font=font_text.font,
         fill=text_color,
         anchor=None,
+        stroke_width=stroke_width,
+        stroke_fill=text_color
     )
 
     return text_mask