BREAKING: feat: integer position support + numpy return + decode/encode functions + normals (#24)

* feat: add flag for integer positions

* feat: use parallel builds

* install: add numpy dependency

* feat: automatically detect integer encoding for position attribute

* perf: use correct optimization flags for MSVC

* chore: add myself as author

* chore: update appveyor to install numpy

* BREAKING: DracoPy returns numpy arrays with dimension 2

* chore: update build system, include arm64 linux

* build: fix QEMU for arm64 linux

* chore: we're not dropping py36 support yet

* refactor: collapse all encoding options into encode/decode functions

* docs: update examples

* docs: show function sigs

* feat: add assertions to check inputs for known ranges

* fix: incorrect type annotation

* feat: add normal decoding (thanks FaruNuriSonmez!)

Also adds integer positions for point cloud

* test: add bunny with normals

* docs: credit authors of normal decoding

Author: william-silversmith

.github/workflows/build_wheel.yml

@@ -12,12 +12,20 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-20.04, macos-latest]
+        arch: [auto]
+        include:
+          - os: ubuntu-20.04
+            arch: aarch64
 
     steps:
       - uses: actions/checkout@v2
 
+      - name: Set up QEMU
+        if:  ${{ matrix.arch == 'aarch64' }}
+        uses: docker/setup-qemu-action@v1
+
       - name: Build wheels
-        uses: joerick/cibuildwheel@v1.10.0
+        uses: joerick/cibuildwheel@v1.12.0
         # to supply options, put them in 'env', like:
         env:
           CIBW_BEFORE_BUILD: git submodule init && git submodule update && pip install oldest-supported-numpy scikit-build 

README.md

@@ -8,19 +8,19 @@ import os
 import DracoPy
 
 with open('bunny.drc', 'rb') as draco_file:
-  file_content = draco_file.read()
-  mesh_object = DracoPy.decode_buffer_to_mesh(file_content)
-  print('number of points in original file: {0}'.format(len(mesh_object.points)))
-  print('number of faces in original file: {0}'.format(len(mesh_object.faces)))
-  encoding_test = DracoPy.encode_mesh_to_buffer(mesh_object.points, mesh_object.faces)
-  with open('bunny_test.drc', 'wb') as test_file:
-    test_file.write(encoding_test)
-
-with open('bunny_test.drc', 'rb') as test_file:
-  file_content = test_file.read()
-  mesh_object = DracoPy.decode_buffer_to_mesh(file_content)
-  print('number of points in test file: {0}'.format(len(mesh_object.points)))
-  print('number of faces in test file: {0}'.format(len(mesh_object.faces)))
+  mesh = DracoPy.decode(draco_file.read())
+
+print(f"number of points: {len(mesh.points)}")
+print(f"number of faces: {len(mesh.faces)}")
+print(f"number of normals: {len(mesh.normals)}")
+
+# Note: If mesh.points is an integer numpy array,
+# it will be encoded as an integer attribute. Otherwise,
+# it will be encoded as floating point.
+binary = DracoPy.encode(mesh.points, mesh.faces)
+with open('bunny_test.drc', 'wb') as test_file:
+  test_file.write(encoding_test)
+
 ```
 
 DracoPy is a Python wrapper for Google's Draco mesh compression library.
@@ -31,7 +31,7 @@ Binary wheels are available for users with Python >= 3.6 and pip >= 20.
 
 Installation from source requires Python >= 3.6, pip >= 10, and a C++ compiler that is fully compatible with C++11.
 
-It supports Linux, OS X, and Windows. 
+It supports Linux, OS X, and Windows. Numpy is required.
 
 ```bash
 pip install DracoPy 

appveyor.yml

@@ -14,7 +14,7 @@ environment:
 install:
   # We need wheel installed to build wheels
   - "git submodule update --init --recursive"
-  - "%PYTHON%\\python.exe -m pip install wheel scikit-build"
+  - "%PYTHON%\\python.exe -m pip install wheel scikit-build  oldest-supported-numpy"
 
 build: off
 

pyproject.toml

@@ -1,2 +1,7 @@
 [build-system]
-requires = ["setuptools", "scikit-build >= 0.9.0", "wheel"]
+requires = [
+	"setuptools", 
+	"scikit-build >= 0.9.0", 
+	"wheel", 
+	"numpy"
+]

setup.py

@@ -7,6 +7,12 @@
 from skbuild.exceptions import SKBuildError
 from skbuild.cmaker import get_cmake_version
 
+import numpy as np
+import multiprocessing as mp
+
+if not "CMAKE_BUILD_PARALLEL_LEVEL" in os.environ:
+    os.environ["CMAKE_BUILD_PARALLEL_LEVEL"] = str(mp.cpu_count())
+
 def read(fname):
   with open(os.path.join(os.path.dirname(__file__), fname), 'rt') as f:
     return f.read()
@@ -51,21 +57,20 @@ def read(fname):
 if sys.platform == 'win32':
     extra_link_args = ['/LIBPATH:{0}'.format(lib_dir)] + library_link_args
     extra_compile_args = [
-              '/std:c++17','-O3'
-            ]
+      '/std:c++17', '/O2',
+    ]
 else:
     extra_link_args = ['-L{0}'.format(lib_dir)] + library_link_args
     extra_compile_args = [
-              '-std=c++11','-O3'
-            ]
-
+      '-std=c++11','-O3'
+    ]
 
 setup(
     name='DracoPy',
     version='0.0.19',
     description = 'Python wrapper for Google\'s Draco Mesh Compression Library',
-    author = 'Manuel Castro',
-    author_email = 'macastro@princeton.edu',
+    author = 'Manuel Castro, William Silversmith :: Contributors :: Fatih Erol, Faru Nuri Sonmez',
+    author_email = 'macastro@princeton.edu, ws9@princeton.edu',
     url = 'https://github.com/seung-lab/DracoPy',
     long_description=read('README.md'),
     long_description_content_type="text/markdown",
@@ -80,7 +85,10 @@ def read(fname):
             sources=[ os.path.join(src_dir, 'DracoPy.cpp') ],
             depends=[ os.path.join(src_dir, 'DracoPy.h') ],
             language='c++',
-            include_dirs = [ os.path.join(CMAKE_INSTALL_DIR(), 'include/')],
+            include_dirs = [ 
+                np.get_include(),
+                os.path.join(CMAKE_INSTALL_DIR(), 'include/'),
+            ],
             extra_compile_args=extra_compile_args,
             extra_link_args=extra_link_args
         )