fix a typo in the docstring
[toast/gimp_passport.git] / gimp_passport.py
index 481c26c..245024f 100644 (file)
@@ -1,7 +1,8 @@
 import argparse
 from itertools import count
 from numbers import Integral
-from PIL import Image
+from typing import Tuple
+from PIL import Image, ImageDraw
 
 
 MM_PER_INCH = 25.4
@@ -42,6 +43,83 @@ def make_passport(img_rgba: Image, fpr: float, width_mm: float, height_mm: float
     return pic
 
 
+def num_tiles(paper_size: float, tile_size: float, margin: float, spacing: float) -> int:
+    """Returns the number of tiles that fit in the space described by the parameres.
+    All length units have to be the same (e.g. milimeter or pixel).
+
+    :param paper_size: paper width or paper height
+    :para tile_size: tile width or tile height
+    :param margin: space between paper border and first tile
+    :param spacing: space between tiles
+    """
+    size = paper_size - 2 * margin
+    return max(0, int((size + spacing) // (tile_size + spacing)))
+
+
+def num_tiles_xy(paper_size: Tuple[float, float], tile_size: Tuple[float, float],
+                 margin: float, spacing: float) -> Tuple[int, int]:
+    """Returns the number of tiles that fit in the space described by the parameters.
+    All length units have to be the same (e.g. milimeter or pixel).
+
+    :param paper_size: tuple with paper width and height
+    :param tile_size: tuple with tile width and height
+    :param margin: space between paper border and first tile
+    :param spacing: space between tiles
+    """
+    return tuple(num_tiles(ps, ts, margin, spacing) for ps, ts in zip(paper_size, tile_size))
+
+
+def line(img: Image, pos: int, axis: int) -> Image:
+    """Creates a horizontal (axis == 0) or vertical (axis == 1) line over the whole
+    width or height of the image.
+
+    :param img: Image that is modified inline.
+    :param pos: Position in pixel from left or top (0 based)
+    :param axis: 0 means horizontal, 1 means vertical
+    """
+    draw = ImageDraw.ImageDraw(img)
+    color = 'black'
+    if axis == 0:
+        draw.line(((0, pos), (img.width, pos)), color=color)
+    else:
+        draw.line(((pos, 0), (pos, img.height)), color=color)
+
+
+def make_cut_lines(img: Image, count_x: int, count_y: int, width: int, margin: int, spacing: int, 
+                   margin_mm: float,
+         spacing_mm: float) -> Image:
+    """Create and return image representing paper with specified dimensions and copy the given
+    image as often as possible to the paper.
+
+    :param img: source image that should be copied.
+    :param paper_width_mm: width of the image representing the paper
+    :param paper_height_mm: height of the image representing the paper
+    :param margin_mm: Free space from the paper borders to the edges of the tiled images.
+    :param spacing_mm: Additional space between tiled images.
+    """
+    dpi = img.info['dpi'][0]
+    paper_width_pixel = mm_to_pixel(paper_width_mm, dpi)
+    paper_height_pixel = mm_to_pixel(paper_height_mm, dpi)
+    margin_pixel = mm_to_pixel(margin_mm, dpi)
+    spacing_pixel = mm_to_pixel(spacing_mm, dpi)
+    paper = Image.new('RGB', (paper_width_pixel, paper_height_pixel), 'white')
+    paper.info['dpi'] = (dpi, dpi)
+    top = margin_pixel
+    for iy in count():
+        bottom = top + img.height
+        if bottom > paper_height_pixel - margin_pixel:
+            break
+        left = margin_pixel
+        for ix in count():
+            right = left + img.width
+            if right > paper_width_pixel - margin_pixel:
+                break
+            paper.paste(img, (left, top))
+            left = right + spacing_pixel
+        top = bottom + spacing_pixel
+    return paper
+
+
 def tile(img: Image, paper_width_mm: float, paper_height_mm: float, margin_mm: float,
          spacing_mm: float) -> Image:
     """Create and return image representing paper with specified dimensions and copy the given