thorvg-python 1.0.0__tar.gz → 1.0.1__tar.gz

{thorvg_python-1.0.0/src/thorvg_python.egg-info → thorvg_python-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: thorvg-python
-Version: 1.0.0
+Version: 1.0.1
 Summary: A ctypes API for thorvg, a vector graphics engine supporting SVG and Lottie formats.
 Author-email: chaudominic <chaudominic2@gmail.com>
 License:                   GNU LESSER GENERAL PUBLIC LICENSE
@@ -514,6 +514,7 @@ Project-URL: Tracker, https://github.com/laggykiller/thorvg-python/issues
 Keywords: thorvg,lottie,svg,ctypes,python
 Classifier: Topic :: Multimedia :: Graphics
 Requires-Python: >=3.7
+Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: full
 Requires-Dist: Pillow; extra == "full"
@@ -526,3 +527,121 @@ Requires-Dist: mypy; extra == "lint"
 Requires-Dist: isort; extra == "lint"
 Requires-Dist: types-Pillow; extra == "lint"
 Dynamic: license-file
+
+# thorvg-python
+
+A ctypes API for thorvg, with additional functions for getting Pillow Image.
+
+The functions mostly follow [thorvg/src/bindings/capi/thorvg_capi.h](https://github.com/thorvg/thorvg/blob/v0.15.16/src/bindings/capi/thorvg_capi.h)
+
+Documentations: https://thorvg-python.readthedocs.io/en/latest/
+
+## Table of contents
+- [Installing](#installing)
+- [Building from source](#building-from-source)
+- [Examples](#examples)
+- [Credits](#credits)
+
+## Installing
+
+Note that thorvg is included in the wheel package, you need not install libthorvg.
+Version bundled is the version available on [Conan](https://conan.io/center/recipes/thorvg)
+(Currently 0.15.16)
+
+To install, run the following:
+```bash
+pip3 install thorvg-python
+```
+
+`Pillow` is optional dependency. It is required for `SwCanvas.get_pillow()`. To also install Pillow, run:
+```bash
+pip3 install thorvg-python[full]
+```
+
+## Examples
+Drawing and getting pillow image
+```python
+import thorvg_python as tvg
+
+engine = tvg.Engine(threads=4)
+canvas = tvg.SwCanvas(engine)
+canvas.set_target(512, 256)  # w, h
+
+rect = tvg.Shape(engine)
+rect.append_rect(10, 10, 64, 64, 10, 10)  # x, y, w, h, rx, ry
+rect.set_fill_color(32, 64, 128, 100)  # r, g, b, a
+canvas.push(rect)
+
+canvas.update()
+canvas.draw()
+canvas.sync()
+
+im = canvas.get_pillow()
+canvas.destroy()
+engine.term()
+```
+
+Rendering lottie animation
+```python
+import thorvg_python as tvg
+from PIL import Image
+
+engine = tvg.Engine(threads=4)
+canvas = tvg.SwCanvas(engine)
+canvas.set_target(512, 512)  # w, h
+
+animation = tvg.LottieAnimation(engine)
+picture = animation.get_picture()
+picture.load("tests/test.json")
+picture.set_size(512, 512)
+
+canvas.push(picture)
+
+ims: list[Image.Image] = []
+result, total_frame = animation.get_total_frame()
+result, duration = animation.get_duration()
+frame_duration = duration / total_frame
+# fps = total_frame / duration
+for i in range(int(total_frame)):
+    animation.set_frame(i)
+    canvas.update()
+    canvas.draw()
+    canvas.sync()
+    im = canvas.get_pillow()
+    ims.append(im)
+
+ims[0].save("test.apng", save_all=True, append_images=ims[1:], duration=frame_duration * 1000)
+```
+
+## Building from source
+
+To build wheel, run the following:
+```bash
+git clone --recursive https://github.com/laggykiller/thorvg-python.git
+cd thorvg-python
+
+# To build wheel
+python3 -m build .
+
+# To install directly
+pip3 install .
+```
+
+## Development
+To run tests:
+```bash
+pip install pytest
+pytest
+```
+
+To lint:
+```bash
+pip install ruff mypy isort
+mypy
+isort .
+ruff check
+ruff format
+```
+
+## Credits
+- thorvg library: https://github.com/thorvg/thorvg

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/pyproject.toml

@@ -2,12 +2,13 @@
 name = "thorvg-python"
 description = "A ctypes API for thorvg, a vector graphics engine supporting SVG and Lottie formats."
 requires-python = ">=3.7"
+readme = "README.md"
 license = { file = "LICENSE" }
 authors = [{ "name" = "chaudominic", "email" = "chaudominic2@gmail.com" }]
 keywords = ["thorvg", "lottie", "svg", "ctypes", "python"]
 classifiers = ["Topic :: Multimedia :: Graphics"]
 dependencies = []
-version = "1.0.0"
+version = "1.0.1"
 
 [project.urls]
 Repository = "https://github.com/laggykiller/thorvg-python"
@@ -34,8 +35,7 @@ lint = [
 [build-system]
 requires = [
     "conan>=2.0",
-    "setuptools>=45",
-    "lipomerge>=0.1.1"
+    "setuptools>=45"
 ]
 build-backend = "setuptools.build_meta"
 

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/setup.py

@@ -178,12 +178,12 @@ def compile():
         print(f"{lib_paths=}")
         subprocess.run(
             [
-                "python3",
-                "-m",
-                "lipomerge",
+                "lipo",
+                "-create",
                 lib_paths[0],
                 lib_paths[1],
-                "src/thorvg_python/",
+                "-output",
+                "src/thorvg_python/libthorvg.dylib",
             ]
         )
     else:

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/src/thorvg_python/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 """thorvg-python"""
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 
 from .animation import Animation  # type: ignore  # noqa: F401
 from .animation.lottie import LottieAnimation  # type: ignore  # noqa: F401

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/src/thorvg_python/animation/lottie.py

@@ -55,9 +55,10 @@ class LottieAnimation(Animation):
             Experimental API
         """
         if slot is not None and slot != "":
-            slot_arr_type = ctypes.c_char * len(slot.encode())
+            slot_bytes = slot.encode() + b"\x00"
+            slot_arr_type = ctypes.c_char * len(slot_bytes)
             slot_arr_type_ptr = ctypes.POINTER(slot_arr_type)
-            slot_arr_ptr = ctypes.pointer(slot_arr_type.from_buffer_copy(slot.encode()))
+            slot_arr_ptr = ctypes.pointer(slot_arr_type.from_buffer_copy(slot_bytes))
         else:
             slot_arr_type_ptr = ctypes.c_void_p  # type: ignore
             slot_arr_ptr = ctypes.c_void_p()  # type: ignore
@@ -88,8 +89,9 @@ class LottieAnimation(Animation):
         .. note::
             Experimental API
         """
-        marker_arr_type = ctypes.c_char * len(marker.encode())
-        marker_arr = marker_arr_type.from_buffer_copy(marker.encode())
+        marker_bytes = marker.encode() + b"\x00"
+        marker_arr_type = ctypes.c_char * len(marker_bytes)
+        marker_arr = marker_arr_type.from_buffer_copy(marker_bytes)
         self.thorvg_lib.tvg_lottie_animation_set_marker.argtypes = [
             ctypes.POINTER(AnimationStruct),
             ctypes.POINTER(marker_arr_type),

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/src/thorvg_python/engine.py

@@ -245,8 +245,9 @@ class Engine:
 
         .. versionadded:: 0.15
         """
-        path_arr_type = ctypes.c_char * len(path.encode())
-        path_arr = path_arr_type.from_buffer_copy(path.encode())
+        path_bytes = path.encode() + b"\x00"
+        path_arr_type = ctypes.c_char * len(path_bytes)
+        path_arr = path_arr_type.from_buffer_copy(path_bytes)
         self.thorvg_lib.tvg_font_load.argtypes = [
             ctypes.POINTER(path_arr_type),
         ]
@@ -285,14 +286,17 @@ class Engine:
 
         .. versionadded:: 0.15
         """
-        name_char_type = ctypes.c_char * len(name.encode())
-        name_char = name_char_type.from_buffer_copy(name.encode())
+        name_bytes = name.encode() + b"\x00"
+        name_bytes += b"\x00"
+        name_char_type = ctypes.c_char * len(name_bytes)
+        name_char = name_char_type.from_buffer_copy(name_bytes)
         data_arr_type = ctypes.c_ubyte * len(data)
         data_arr = data_arr_type.from_buffer_copy(data)
         if mimetype is not None and mimetype != "":
-            mimetype_char_type = ctypes.c_char * len(mimetype.encode())
+            mimetype_bytes = name.encode() + b"\x00"
+            mimetype_char_type = ctypes.c_char * len(mimetype_bytes)
             mimetype_char_ptr_type = ctypes.POINTER(mimetype_char_type)
-            mimetype_char = mimetype_char_type.from_buffer_copy(mimetype.encode())
+            mimetype_char = mimetype_char_type.from_buffer_copy(mimetype_bytes)
             mimetype_char_ptr = ctypes.pointer(mimetype_char)
         else:
             mimetype_char_ptr_type = ctypes.c_void_p  # type: ignore
@@ -331,8 +335,9 @@ class Engine:
 
         .. versionadded:: 0.15
         """
-        path_arr_type = ctypes.c_char * len(path.encode())
-        path_arr = path_arr_type.from_buffer_copy(path.encode())
+        path_bytes = path.encode() + b"\x00"
+        path_arr_type = ctypes.c_char * len(path_bytes)
+        path_arr = path_arr_type.from_buffer_copy(path_bytes)
         self.thorvg_lib.tvg_font_unload.argtypes = [
             ctypes.POINTER(path_arr_type),
         ]
@@ -356,8 +361,9 @@ class Engine:
         .. note::
             Experimental API
         """
-        name_char_type = ctypes.c_char * len(name.encode())
-        name_char = name_char_type.from_buffer_copy(name.encode())
+        name_bytes = name.encode() + b"\x00"
+        name_char_type = ctypes.c_char * len(name_bytes)
+        name_char = name_char_type.from_buffer_copy(name_bytes)
         self.thorvg_lib.tvg_accessor_generate_id.argtypes = [
             ctypes.POINTER(name_char_type)
         ]

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/src/thorvg_python/paint/picture.py

@@ -50,7 +50,8 @@ class Picture(Paint):
             - NOT_SUPPORTED A file with an unknown extension.
         :rtype: Result
         """
-        path_char = ctypes.create_string_buffer(path.encode())
+        path_bytes = path.encode() + b"\x00"
+        path_char = ctypes.create_string_buffer(path_bytes)
         self.thorvg_lib.tvg_picture_load.argtypes = [
             ctypes.POINTER(PaintStruct),
             ctypes.c_char * ctypes.sizeof(path_char),
@@ -124,10 +125,11 @@ class Picture(Paint):
         .. warning::
             : It's the user responsibility to release the ``data`` memory if the ``copy`` is ``true``.
         """
+        mimetype_bytes = mimetype.encode() + b"\x00"
         data_arr_type = ctypes.c_char * len(data)
         data_arr = data_arr_type.from_buffer_copy(data)
-        mimetype_char_type = ctypes.c_char * len(mimetype.encode())
-        mimetype_char = mimetype_char_type.from_buffer_copy(mimetype.encode())
+        mimetype_char_type = ctypes.c_char * len(mimetype_bytes)
+        mimetype_char = mimetype_char_type.from_buffer_copy(mimetype_bytes)
         self.thorvg_lib.tvg_picture_load_data.argtypes = [
             ctypes.POINTER(PaintStruct),
             ctypes.POINTER(data_arr_type),

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/src/thorvg_python/paint/text.py

@@ -70,18 +70,20 @@ class Text(Paint):
                 text.set_font(None, 24, None)
         """
         if name is not None and name != "":
-            name_arr_type = ctypes.c_char * len(name.encode())
+            name_bytes = name.encode() + b"\x00"
+            name_arr_type = ctypes.c_char * len(name_bytes)
             name_arr_type_ptr = ctypes.POINTER(name_arr_type)
-            name_arr = name_arr_type.from_buffer_copy(name.encode())
+            name_arr = name_arr_type.from_buffer_copy(name_bytes)
             name_arr_ptr = ctypes.pointer(name_arr)
         else:
             name_arr_type_ptr = ctypes.c_void_p  # type: ignore
             name_arr_ptr = ctypes.c_void_p()  # type: ignore
 
         if style is not None and style != "":
-            style_arr_type = ctypes.c_char * len(style.encode())
+            style_bytes = style.encode() + b"\x00"
+            style_arr_type = ctypes.c_char * len(style_bytes)
             style_arr_type_ptr = ctypes.POINTER(style_arr_type)
-            style_arr = style_arr_type.from_buffer_copy(style.encode())
+            style_arr = style_arr_type.from_buffer_copy(style_bytes)
             style_arr_ptr = ctypes.pointer(style_arr)
         else:
             style_arr_type_ptr = ctypes.c_void_p  # type: ignore
@@ -118,8 +120,9 @@ class Text(Paint):
         .. note::
             Experimental API
         """
-        text_arr_type = ctypes.c_char * len(text.encode())
-        text_arr = text_arr_type.from_buffer_copy(text.encode())
+        text_bytes = text.encode() + b"\x00"
+        text_arr_type = ctypes.c_char * len(text_bytes)
+        text_arr = text_arr_type.from_buffer_copy(text_bytes)
         self.thorvg_lib.tvg_text_set_text.argtypes = [
             ctypes.POINTER(PaintStruct),
             ctypes.POINTER(text_arr_type),

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/src/thorvg_python/saver.py

@@ -62,8 +62,9 @@ class Saver:
             Saving can be asynchronous if the assigned thread number is greater than zero. To guarantee the saving is done, call Saver.sync() afterwards.
         .. seealso:: Saver.sync()
         """
+        path_bytes = path.encode() + b"\x00"
         path_arr_type = ctypes.c_char * len(path)
-        path_arr = path_arr_type.from_buffer_copy(path.encode())
+        path_arr = path_arr_type.from_buffer_copy(path_bytes)
         self.thorvg_lib.tvg_saver_save.argtypes = [
             ctypes.POINTER(SaverStruct),
             ctypes.POINTER(PaintStruct),

{thorvg_python-1.0.0 → thorvg_python-1.0.1/src/thorvg_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: thorvg-python
-Version: 1.0.0
+Version: 1.0.1
 Summary: A ctypes API for thorvg, a vector graphics engine supporting SVG and Lottie formats.
 Author-email: chaudominic <chaudominic2@gmail.com>
 License:                   GNU LESSER GENERAL PUBLIC LICENSE
@@ -514,6 +514,7 @@ Project-URL: Tracker, https://github.com/laggykiller/thorvg-python/issues
 Keywords: thorvg,lottie,svg,ctypes,python
 Classifier: Topic :: Multimedia :: Graphics
 Requires-Python: >=3.7
+Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: full
 Requires-Dist: Pillow; extra == "full"
@@ -526,3 +527,121 @@ Requires-Dist: mypy; extra == "lint"
 Requires-Dist: isort; extra == "lint"
 Requires-Dist: types-Pillow; extra == "lint"
 Dynamic: license-file
+
+# thorvg-python
+
+A ctypes API for thorvg, with additional functions for getting Pillow Image.
+
+The functions mostly follow [thorvg/src/bindings/capi/thorvg_capi.h](https://github.com/thorvg/thorvg/blob/v0.15.16/src/bindings/capi/thorvg_capi.h)
+
+Documentations: https://thorvg-python.readthedocs.io/en/latest/
+
+## Table of contents
+- [Installing](#installing)
+- [Building from source](#building-from-source)
+- [Examples](#examples)
+- [Credits](#credits)
+
+## Installing
+
+Note that thorvg is included in the wheel package, you need not install libthorvg.
+Version bundled is the version available on [Conan](https://conan.io/center/recipes/thorvg)
+(Currently 0.15.16)
+
+To install, run the following:
+```bash
+pip3 install thorvg-python
+```
+
+`Pillow` is optional dependency. It is required for `SwCanvas.get_pillow()`. To also install Pillow, run:
+```bash
+pip3 install thorvg-python[full]
+```
+
+## Examples
+Drawing and getting pillow image
+```python
+import thorvg_python as tvg
+
+engine = tvg.Engine(threads=4)
+canvas = tvg.SwCanvas(engine)
+canvas.set_target(512, 256)  # w, h
+
+rect = tvg.Shape(engine)
+rect.append_rect(10, 10, 64, 64, 10, 10)  # x, y, w, h, rx, ry
+rect.set_fill_color(32, 64, 128, 100)  # r, g, b, a
+canvas.push(rect)
+
+canvas.update()
+canvas.draw()
+canvas.sync()
+
+im = canvas.get_pillow()
+canvas.destroy()
+engine.term()
+```
+
+Rendering lottie animation
+```python
+import thorvg_python as tvg
+from PIL import Image
+
+engine = tvg.Engine(threads=4)
+canvas = tvg.SwCanvas(engine)
+canvas.set_target(512, 512)  # w, h
+
+animation = tvg.LottieAnimation(engine)
+picture = animation.get_picture()
+picture.load("tests/test.json")
+picture.set_size(512, 512)
+
+canvas.push(picture)
+
+ims: list[Image.Image] = []
+result, total_frame = animation.get_total_frame()
+result, duration = animation.get_duration()
+frame_duration = duration / total_frame
+# fps = total_frame / duration
+for i in range(int(total_frame)):
+    animation.set_frame(i)
+    canvas.update()
+    canvas.draw()
+    canvas.sync()
+    im = canvas.get_pillow()
+    ims.append(im)
+
+ims[0].save("test.apng", save_all=True, append_images=ims[1:], duration=frame_duration * 1000)
+```
+
+## Building from source
+
+To build wheel, run the following:
+```bash
+git clone --recursive https://github.com/laggykiller/thorvg-python.git
+cd thorvg-python
+
+# To build wheel
+python3 -m build .
+
+# To install directly
+pip3 install .
+```
+
+## Development
+To run tests:
+```bash
+pip install pytest
+pytest
+```
+
+To lint:
+```bash
+pip install ruff mypy isort
+mypy
+isort .
+ruff check
+ruff format
+```
+
+## Credits
+- thorvg library: https://github.com/thorvg/thorvg

{thorvg_python-1.0.0 → thorvg_python-1.0.1}/tests/test_all.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 import os
+import platform
 from importlib.util import find_spec
 from typing import TYPE_CHECKING, List, Tuple
 
@@ -10,6 +11,11 @@ import thorvg_python as tvg
 PILLOW_LOADED = True if find_spec("PIL") else False
 file_dir = os.path.split(__file__)[0]
 
+if platform.system() == "Windows":
+    ref_dir = os.path.join(file_dir, "ref_win")
+else:
+    ref_dir = os.path.join(file_dir, "ref")
+
 if TYPE_CHECKING:
     from PIL import Image
 
@@ -17,7 +23,7 @@ if TYPE_CHECKING:
 def check_im_same(im: "Image.Image", im_ref_name: str):
     from PIL import Image, ImageChops
 
-    im_ref = Image.open(os.path.join(file_dir, im_ref_name))
+    im_ref = Image.open(os.path.join(ref_dir, im_ref_name))
     return ImageChops.difference(im_ref, im).getbbox() is None
 
 
@@ -653,6 +659,9 @@ def test_picture_load_raw_copy_true():
 
 
 @pytest.mark.skipif(PILLOW_LOADED is False, reason="Pillow not installed")
+@pytest.mark.skipif(
+    platform.system() == "Windows", reason="Known failure if on Windows"
+)
 def test_picture_load_raw_copy_false():
     _test_picture_load_raw("test.png", "test_picture_png_ref.png", False)