PyPatchMatch 2.0.0b1__py3-none-macosx_11_0_arm64.whl

patchmatch/__init__.py

@@ -0,0 +1,19 @@
+"""PatchMatch based inpainting."""
+
+from ._version import __version__
+from .patch_match import (
+    inpaint,
+    inpaint_regularity,
+    patchmatch_available,
+    set_random_seed,
+    set_verbose,
+)
+
+__all__ = [
+    "__version__",
+    "inpaint",
+    "inpaint_regularity",
+    "patchmatch_available",
+    "set_random_seed",
+    "set_verbose",
+]

patchmatch/_lib.py

@@ -0,0 +1,124 @@
+"""ctypes bindings for the native patchmatch library."""
+
+from __future__ import annotations
+
+import ctypes
+import sys
+from pathlib import Path
+
+import numpy as np
+
+if sys.platform == "win32":
+    LIBRARY_NAME = "patchmatch.dll"
+elif sys.platform == "darwin":
+    LIBRARY_NAME = "libpatchmatch.dylib"
+else:
+    LIBRARY_NAME = "libpatchmatch.so"
+
+
+class CShapeT(ctypes.Structure):
+    _fields_ = [
+        ("width", ctypes.c_int),
+        ("height", ctypes.c_int),
+        ("channels", ctypes.c_int),
+    ]
+
+
+class CMatT(ctypes.Structure):
+    _fields_ = [
+        ("data_ptr", ctypes.c_void_p),
+        ("shape", CShapeT),
+        ("dtype", ctypes.c_int),
+    ]
+
+
+# Order matches the PM_dtype_e enum in csrc/pyinterface.h.
+_PYMAT_DTYPES = [
+    np.dtype(np.uint8),
+    np.dtype(np.int8),
+    np.dtype(np.uint16),
+    np.dtype(np.int16),
+    np.dtype(np.int32),
+    np.dtype(np.float32),
+    np.dtype(np.float64),
+]
+_PYMAT_DTYPE_IDS = {dtype: i for i, dtype in enumerate(_PYMAT_DTYPES)}
+
+
+def np_to_pymat(npmat: np.ndarray) -> CMatT:
+    """Wrap a contiguous HxWxC array without copying it."""
+    if npmat.ndim != 3:
+        raise ValueError(f"expected a 3-dimensional array, got {npmat.ndim} dims")
+    if not npmat.flags.c_contiguous:
+        raise ValueError("expected a C-contiguous array")
+    try:
+        dtype_id = _PYMAT_DTYPE_IDS[npmat.dtype]
+    except KeyError:
+        raise TypeError(f"unsupported dtype {npmat.dtype}") from None
+    height, width, channels = npmat.shape
+    return CMatT(
+        ctypes.c_void_p(npmat.ctypes.data),
+        CShapeT(width, height, channels),
+        dtype_id,
+    )
+
+
+def pymat_to_np(pymat: CMatT) -> np.ndarray:
+    """Copy the data referenced by ``pymat`` into a new numpy array."""
+    dtype = _PYMAT_DTYPES[pymat.dtype]
+    shape = (pymat.shape.height, pymat.shape.width, pymat.shape.channels)
+    buffer = (ctypes.c_byte * (int(np.prod(shape)) * dtype.itemsize)).from_address(
+        pymat.data_ptr
+    )
+    return np.frombuffer(buffer, dtype=dtype).reshape(shape).copy()
+
+
+def find_library() -> Path:
+    """Locate the shared library that is installed next to this package."""
+    package = sys.modules[__package__]
+    for directory in package.__path__:
+        candidate = Path(directory) / LIBRARY_NAME
+        if candidate.is_file():
+            return candidate
+    raise OSError(
+        f"{LIBRARY_NAME} not found in {list(package.__path__)}; "
+        "reinstall PyPatchMatch or build it from source with OpenCV available"
+    )
+
+
+def load_library() -> ctypes.CDLL:
+    lib = ctypes.CDLL(str(find_library()))
+
+    lib.PM_set_random_seed.argtypes = [ctypes.c_uint]
+    lib.PM_set_random_seed.restype = None
+    lib.PM_set_verbose.argtypes = [ctypes.c_int]
+    lib.PM_set_verbose.restype = None
+    lib.PM_free_pymat.argtypes = [CMatT]
+    lib.PM_free_pymat.restype = None
+
+    lib.PM_inpaint.argtypes = [CMatT, CMatT, ctypes.c_int]
+    lib.PM_inpaint2.argtypes = [CMatT, CMatT, CMatT, ctypes.c_int]
+    lib.PM_inpaint_regularity.argtypes = [
+        CMatT,
+        CMatT,
+        CMatT,
+        ctypes.c_int,
+        ctypes.c_float,
+    ]
+    lib.PM_inpaint2_regularity.argtypes = [
+        CMatT,
+        CMatT,
+        CMatT,
+        CMatT,
+        ctypes.c_int,
+        ctypes.c_float,
+    ]
+    for func in (
+        lib.PM_inpaint,
+        lib.PM_inpaint2,
+        lib.PM_inpaint_regularity,
+        lib.PM_inpaint2_regularity,
+    ):
+        func.restype = CMatT
+
+    return lib

patchmatch/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '2.0.0b1'
+__version_tuple__ = version_tuple = (2, 0, 0, 'b1')
+
+__commit_id__ = commit_id = None

patchmatch/patch_match.py

@@ -0,0 +1,183 @@
+# File   : patch_match.py
+# Author : Jiayuan Mao
+# Email  : maojiayuan@gmail.com
+# Date   : 01/09/2020
+#
+# Distributed under terms of the MIT license.
+#
+# Additional modifications by Kyle Schouviller and Matthias Wild
+
+"""PatchMatch based inpainting.
+
+PatchMatch: A Randomized Correspondence Algorithm for Structural Image Editing.
+C. Barnes, E. Shechtman, A. Finkelstein and Dan B. Goldman. SIGGRAPH 2009.
+"""
+
+from __future__ import annotations
+
+import ctypes
+import logging
+from collections.abc import Callable
+from typing import TypeAlias
+
+import numpy as np
+from PIL import Image
+
+from ._lib import CMatT, load_library, np_to_pymat, pymat_to_np
+from ._lib import CShapeT as CShapeT  # re-exported for backwards compatibility
+
+__all__ = [
+    "inpaint",
+    "inpaint_regularity",
+    "patchmatch_available",
+    "set_random_seed",
+    "set_verbose",
+]
+
+logger = logging.getLogger(__name__)
+
+ImageLike: TypeAlias = np.ndarray | Image.Image
+
+try:
+    _lib: ctypes.CDLL | None = load_library()
+except OSError as e:
+    _lib = None
+    logger.warning("patchmatch failed to load: %s", e)
+
+# True if the native library was loaded successfully.
+patchmatch_available = _lib is not None
+
+
+def _get_lib() -> ctypes.CDLL:
+    if _lib is None:
+        raise RuntimeError("the patchmatch native library is not available")
+    return _lib
+
+
+def set_random_seed(seed: int) -> None:
+    _get_lib().PM_set_random_seed(ctypes.c_uint(seed))
+
+
+def set_verbose(verbose: bool) -> None:
+    _get_lib().PM_set_verbose(ctypes.c_int(verbose))
+
+
+def inpaint(
+    image: ImageLike,
+    mask: ImageLike | None = None,
+    *,
+    global_mask: ImageLike | None = None,
+    patch_size: int = 15,
+) -> np.ndarray:
+    """Fill the masked regions of ``image`` using PatchMatch.
+
+    Args:
+        image: 3-channel uint8 RGB/BGR image.
+        mask: 1-channel uint8 or bool mask of the hole(s) to fill (non-zero = hole),
+            with the same height and width as ``image``. If ``None``, all pure
+            white pixels (255, 255, 255) are treated as holes.
+        global_mask: mask like ``mask`` of pixels that must not be used as a source.
+        patch_size: patch size for the inpainting algorithm.
+
+    Returns:
+        The repaired image, with the same shape as ``image``.
+    """
+    lib = _get_lib()
+    image, mask, global_mask = _prepare_inputs(image, mask, global_mask)
+
+    if global_mask is None:
+        return _call(lib.PM_inpaint, image, mask, ctypes.c_int(patch_size))
+    return _call(lib.PM_inpaint2, image, mask, global_mask, ctypes.c_int(patch_size))
+
+
+def inpaint_regularity(
+    image: ImageLike,
+    mask: ImageLike | None,
+    ijmap: np.ndarray,
+    *,
+    global_mask: ImageLike | None = None,
+    patch_size: int = 15,
+    guide_weight: float = 0.25,
+) -> np.ndarray:
+    """Like :func:`inpaint`, additionally guided by a regularity map.
+
+    Args:
+        ijmap: HxWx3 float32 array with the regularity coordinates of each pixel;
+            a map of a different size is scaled to the image.
+        guide_weight: weight of the regularity term relative to the patch distance.
+    """
+    lib = _get_lib()
+    image, mask, global_mask = _prepare_inputs(image, mask, global_mask)
+
+    if not (
+        isinstance(ijmap, np.ndarray)
+        and ijmap.ndim == 3
+        and ijmap.shape[2] == 3
+        and ijmap.dtype == np.float32
+    ):
+        raise ValueError("ijmap must be an HxWx3 float32 array")
+    ijmap = np.ascontiguousarray(ijmap)
+
+    args = (ijmap, ctypes.c_int(patch_size), ctypes.c_float(guide_weight))
+    if global_mask is None:
+        return _call(lib.PM_inpaint_regularity, image, mask, *args)
+    return _call(lib.PM_inpaint2_regularity, image, mask, global_mask, *args)
+
+
+def _prepare_inputs(
+    image: ImageLike, mask: ImageLike | None, global_mask: ImageLike | None
+) -> tuple[np.ndarray, np.ndarray, np.ndarray | None]:
+    """Validate the inputs and convert them to contiguous arrays."""
+    image = _canonize_image_array(image)
+    mask = _default_mask(image) if mask is None else _canonize_mask_array(mask)
+    if global_mask is not None:
+        global_mask = _canonize_mask_array(global_mask)
+
+    # the native code indexes the masks with the image coordinates
+    for name, m in (("mask", mask), ("global_mask", global_mask)):
+        if m is not None and m.shape[:2] != image.shape[:2]:
+            raise ValueError(
+                f"{name} must have the same height and width as the image, "
+                f"got {m.shape[:2]} for an image of {image.shape[:2]}"
+            )
+    return image, mask, global_mask
+
+
+def _call(func: Callable[..., CMatT], *args: object) -> np.ndarray:
+    """Call ``func`` with arrays converted to pymats and copy the result."""
+    c_args = [np_to_pymat(a) if isinstance(a, np.ndarray) else a for a in args]
+    ret = func(*c_args)
+    try:
+        return pymat_to_np(ret)
+    finally:
+        _get_lib().PM_free_pymat(ret)
+
+
+def _canonize_image_array(image: ImageLike) -> np.ndarray:
+    image = np.asarray(image)
+    if not (image.ndim == 3 and image.shape[2] == 3 and image.dtype == np.uint8):
+        raise ValueError(
+            "image must be an HxWx3 uint8 array, "
+            f"got shape {image.shape} and dtype {image.dtype}"
+        )
+    return np.ascontiguousarray(image)
+
+
+def _canonize_mask_array(mask: ImageLike) -> np.ndarray:
+    mask = np.asarray(mask)
+    if mask.dtype == np.bool_:  # e.g. boolean arrays or PIL images in mode "1"
+        mask = mask.astype(np.uint8)
+    if mask.ndim == 2:
+        mask = mask[..., np.newaxis]
+    if not (mask.ndim == 3 and mask.shape[2] == 1 and mask.dtype == np.uint8):
+        raise ValueError(
+            "mask must be an HxW or HxWx1 uint8 array, "
+            f"got shape {mask.shape} and dtype {mask.dtype}"
+        )
+    return np.ascontiguousarray(mask)
+
+
+def _default_mask(image: np.ndarray) -> np.ndarray:
+    """Treat all pure white pixels as holes."""
+    mask = (image == 255).all(axis=2, keepdims=True).astype(np.uint8)
+    return np.ascontiguousarray(mask)

pypatchmatch-2.0.0b1.dist-info/METADATA

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: PyPatchMatch
+Version: 2.0.0b1
+Summary: This library implements the PatchMatch based inpainting algorithm.
+Author-Email: The InvokeAI Project <lincoln.stein@gmail.com>, Kyle Schouviller <kyle0654@hotmail.com>, Matthias Wild <mauwii@outlook.de>, Younesse ANDAM <younesse.andam@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Project-URL: Source Code, https://github.com/mauwii/PyPatchMatch
+Requires-Python: >=3.10
+Requires-Dist: numpy
+Requires-Dist: pillow
+Description-Content-Type: text/markdown
+
+# PatchMatch based Inpainting
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blueviolet.svg)](https://github.com/mauwii/PyPatchMatch/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/PyPatchMatch)](https://pypi.org/project/PyPatchMatch/)
+[![Downloads](https://static.pepy.tech/badge/pypatchmatch)](https://pepy.tech/project/pypatchmatch)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+This library implements the PatchMatch based inpainting algorithm. It provides both C++
+and Python interfaces. This implementation is heavily based on the implementation by
+Younesse ANDAM: [younesse-cv/PatchMatch](https://github.com/younesse-cv/PatchMatch),
+with some bug fixes, and updates.
+
+## Installation
+
+```sh
+pip install PyPatchMatch
+```
+
+Wheels for Linux, macOS and Windows ship the compiled library including the required
+OpenCV runtime, so no compiler or OpenCV installation is needed. On other platforms pip
+builds from the source distribution, which requires a C++17 compiler, CMake and the
+OpenCV development files (e.g. `apt install libopencv-dev` or `brew install opencv`).
+
+## Usage
+
+Python (see [examples/py_example.py](examples/py_example.py)):
+
+```python
+import patchmatch
+
+image = ...  # HxWx3 uint8 numpy array or PIL image
+mask = ...  # HxW uint8 or bool numpy array or PIL image, non-zero marks the holes
+result = patchmatch.inpaint(image, mask, patch_size=3)
+```
+
+The mask must have the same height and width as the image. If `mask` is omitted, all
+pure white pixels are treated as holes.
+`patchmatch.patchmatch_available` tells whether the native library could be loaded.
+The previous import path `from patchmatch import patch_match` keeps working.
+
+C++ (see [examples/cpp_example.cpp](examples/cpp_example.cpp), build and run it with
+[examples/cpp_example_run.sh](examples/cpp_example_run.sh)):
+
+```cpp
+#include "inpaint.h"
+
+int main() {
+    cv::Mat image = ...;
+    cv::Mat mask = ...;
+
+    auto metric = PatchSSDDistanceMetric(5);
+    cv::Mat result = Inpainting(image, mask, &metric).run();
+}
+```
+
+The library is built with CMake; `PATCHMATCH_BUILD_EXAMPLES` builds the example and
+`PATCHMATCH_WITH_HIGHGUI` enables the debug visualization of `Inpainting::run`.
+
+## Development
+
+The project is managed with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync                        # create .venv, build the library, install dev deps
+uv run pre-commit install      # enable ruff and the other hooks on commit
+uv run pytest                  # run the test suite
+uv run pytest -m "not e2e"     # only the fast unit tests
+```
+
+Releases are published to PyPI by creating a GitHub release; the version is taken from
+its tag (e.g. `v1.1.0`).
+
+## README and COPYRIGHT by Younesse ANDAM
+
+@Author: Younesse ANDAM
+
+@Contact: younesse.andam@gmail.com
+
+Description:
+
+This project is a personal implementation of an algorithm called PATCHMATCH
+that restores missing areas in an image. The algorithm is presented in the following
+paper PatchMatch A Randomized Correspondence Algorithm for Structural Image Editing by
+C.Barnes, E.Shechtman, A.Finkelstein and Dan B.Goldman ACM Transactions on Graphics
+(Proc. SIGGRAPH), vol.28, aug-2009
+
+For more information please refer to
+http://www.cs.princeton.edu/gfx/pubs/Barnes_2009_PAR/index.php
+
+Copyright (c) 2010-2011
+
+## Requirements
+
+To run the project you need to install Opencv library and link it to your project.
+Opencv can be download it here
+http://opencv.org/downloads.html

pypatchmatch-2.0.0b1.dist-info/RECORD

@@ -0,0 +1,10 @@
+patchmatch/_version.py,sha256=5Mjj8BHQfkFMFCymzp7wS1ihg7-kJNbFLOz8wmyJ-mY,528
+patchmatch/__init__.py,sha256=Xg_AyDjCY9obrk95tzu6h0ox1fttEczi_OKu3ycsSvM,345
+patchmatch/libpatchmatch.dylib,sha256=E-eoa7S9iNra1JAUtNyoOQW8ayILHoABPyhZLtSwTq8,2809024
+patchmatch/patch_match.py,sha256=774tjbBg1HVEfyrf4V9fMYr4KBrRDPUtdJL4aG926Vw,5998
+patchmatch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+patchmatch/_lib.py,sha256=1DayYVBWlQ2b8AB_4fCL4Cyxicue77_eURyVhTX1mGU,3448
+pypatchmatch-2.0.0b1.dist-info/RECORD,,
+pypatchmatch-2.0.0b1.dist-info/WHEEL,sha256=1Big0Cn6LCpgYnkzxn-ESHZfABrxq9SG62kfQRLXJmA,137
+pypatchmatch-2.0.0b1.dist-info/METADATA,sha256=-PEXUIFHHlgbC4J_bkwdLjraBWsrI599MqUTS7PwvKM,4539
+pypatchmatch-2.0.0b1.dist-info/licenses/LICENSE,sha256=6VGSBzoFC-2RWaUpfSom3IlBW3AZfOwDuZrVzOmfN_E,1101

pypatchmatch-2.0.0b1.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 1.0.3
+Root-Is-Purelib: false
+Tag: py3-none-macosx_11_0_arm64
+Generator: delocate 0.13.0
+

pypatchmatch-2.0.0b1.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Matthias Wild
+Copyright (c) 2020 Jiayuan Mao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.