Replaces CFFI bindings by pybind11 bindings (#10)

Replaces CFFI bindings by pybind11 bindings, adds github action workflow for binary wheels compile, modifies setup to use pyproject file.

Author: fakufaku

.github/workflows/pythonpackage.yml

@@ -0,0 +1,78 @@
+name: samplerate
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      max-parallel: 12
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.8, 3.9, "3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Checkout submodules
+      shell: bash
+      run: |
+        auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+        git submodule sync --recursive
+        git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -U setuptools setuptools_scm wheel build twine
+        pip install -r requirements.txt
+    - name: Build package
+      run: |
+        python -m pip install -e .
+    - name: Test with pytest
+      run: |
+        pytest
+    - name: Test the universal wheels
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        # do not build binary wheels on linux
+        python -m build --sdist
+        twine check dist/*
+    - name: Test the binary wheels
+      if: matrix.os != 'ubuntu-latest'
+      run: |
+        python -m build
+        twine check dist/*
+    - name: Publish sdist to pypi
+      if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v') && matrix.os == 'ubuntu-latest'
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        twine upload --skip-existing dist/*
+    - name: Publish bdist to pypi
+      if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v') && matrix.os != 'ubuntu-latest'
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        twine upload --skip-existing dist/*
+    - name: Publish sdist to pypi-test
+      if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/test-') && matrix.os == 'ubuntu-latest'
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPITEST_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPITEST_PASSWORD }}
+        TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/
+      run: |
+        twine upload --skip-existing dist/*
+    - name: Publish bdist to pypi-test
+      if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/test-') && matrix.os != 'ubuntu-latest'
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPITEST_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPITEST_PASSWORD }}
+        TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/
+      run: |
+        twine upload --skip-existing dist/*

CMakeLists.txt

@@ -0,0 +1,46 @@
+# https://stackoverflow.com/questions/51907755/building-a-pybind11-module-with-cpp-and-cuda-sources-using-cmake
+
+cmake_minimum_required(VERSION 3.15)
+
+message(STATUS "Found Python prefix ${PYTHON_PREFIX}")
+list(PREPEND CMAKE_PREFIX_PATH "${PYTHON_PREFIX}")
+
+project(python-samplerate)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+cmake_policy(SET CMP0094 NEW)
+
+# adds the external dependencies
+add_subdirectory(external)
+
+pybind11_add_module(python-samplerate src/samplerate.cpp)
+
+target_include_directories(python-samplerate PRIVATE ./external/libsamplerate/include)
+
+if(MSVC)
+    target_compile_options(python-samplerate PRIVATE /EHsc /MP /bigobj)
+    set(CMAKE_EXE_LINKER_FLAGS /MANIFEST:NO)
+endif()
+
+if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR
+    CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR
+    (CMAKE_CXX_COMPILER_ID MATCHES "Intel" AND NOT WIN32))
+    target_compile_options(python-samplerate PRIVATE -std=c++14 -O3 -Wall -Wextra)
+endif()
+
+### stick the package and libsamplerate version into the module
+target_compile_definitions(python-samplerate
+    PUBLIC LIBSAMPLERATE_VERSION="${LIBSAMPLERATE_VERSION}"
+    PRIVATE $<$<BOOL:${PACKAGE_VERSION_INFO}>:VERSION_INFO="${PACKAGE_VERSION_INFO}">
+)
+
+### Final target setup
+set_target_properties(
+    python-samplerate
+    PROPERTIES
+        PREFIX ""
+        OUTPUT_NAME "samplerate"
+        LINKER_LANGUAGE C
+    )
+
+target_link_libraries(python-samplerate PUBLIC samplerate)

MANIFEST.in

@@ -1,7 +1,8 @@
 include README.rst
 include LICENSE.rst
 include versioneer.py
-include samplerate/_version.py
-include samplerate/_samplerate_data/*.dylib
-include samplerate/_samplerate_data/*.dll
+include src/*.cpp
+include CMakeLists.txt
+include external/CMakeLists.txt
+include requirements.txt
 include examples/*.py

README.rst

@@ -32,18 +32,17 @@ It implements all three `APIs
 * **Callback API**: like Full API, but input samples are provided by a callback
   function
 
-Library calls to `libsamplerate`_ are performed using `CFFI
-<http://cffi.readthedocs.io/en/latest/>`_.
+The `libsamplerate`_ library is statically built together with the python bindings
+using `pybind11 <https://github.com/pybind/pybind11/>`_.
 
 
 Installation
 ------------
 
     $ pip install samplerate
 
-Binaries of `libsamplerate`_ for macOS and Windows (32 and 64 bit) are included
-and used if not present on the system. On Linux systems, you should also install
-`libsamplerate0` (Debian derivatives), `libsamplerate` (Arch), or similar.
+Binary wheels of `libsamplerate`_ for macOS and Windows (64 bit) are available.
+For other systems, a C++ 14 or above compiler is required to build the package.
 
 
 Usage

docs/conf.py

@@ -18,25 +18,9 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 # import os
-import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-# Mock C modules
-try:
-    from unittest.Mock import MagicMock  # Python >3.3
-except ImportError:
-    try:
-        from mock import MagicMock
-    except ImportError:
-        raise ImportError('No module named mock')
-
-class Mock(MagicMock):
-    @classmethod
-    def __getattr__(cls, name):
-        return MagicMock()
+# import sys
 
-mock_modules = ['numpy', 'samplerate._src']
-sys.modules.update((mod_name, Mock()) for mod_name in mock_modules)
+# sys.path.insert(0, os.path.abspath('.'))
 
 import samplerate
 
@@ -49,25 +33,24 @@ def __getattr__(cls, name):
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode',
-              'sphinx.ext.napoleon']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.napoleon"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'python-samplerate'
-copyright = '2017, Tino Wagner'
-author = 'Tino Wagner'
+project = "python-samplerate"
+copyright = "2017, Tino Wagner"
+author = "Tino Wagner"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -77,28 +60,31 @@ def __getattr__(cls, name):
 # The full version, including alpha/beta/rc tags.
 release = samplerate.__version__
 
+
 # The short X.Y version.
 def get_short_version(version):
     """Return short version from PEP-440 compatible version string."""
-    if '+' in version:
-        return version[:version.find('+')]
+    if "+" in version:
+        return version[: version.find("+")]
     return version
+
+
 version = get_short_version(release)
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -109,40 +95,40 @@ def get_short_version(version):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 html_theme_options = {
-    'description': 'Sample rate conversion in Python using libsamplerate',
-    'github_user': 'tuxu',
-    'github_repo': 'python-samplerate',
-    'github_banner': True,
-    'fixed_sidebar': True,
+    "description": "Sample rate conversion in Python using libsamplerate",
+    "github_user": "tuxu",
+    "github_repo": "python-samplerate",
+    "github_banner": True,
+    "fixed_sidebar": True,
 }
 
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',
-        'searchbox.html',
-        'donate.html',
+    "**": [
+        "about.html",
+        "navigation.html",
+        "relations.html",
+        "searchbox.html",
+        "donate.html",
     ]
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'python-sampleratedoc'
+htmlhelp_basename = "python-sampleratedoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -151,15 +137,12 @@ def get_short_version(version):
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -169,8 +152,13 @@ def get_short_version(version):
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'python-samplerate.tex', 'python-samplerate Documentation',
-     'Tino Wagner', 'manual'),
+    (
+        master_doc,
+        "python-samplerate.tex",
+        "python-samplerate Documentation",
+        "Tino Wagner",
+        "manual",
+    ),
 ]
 
 
@@ -179,8 +167,7 @@ def get_short_version(version):
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'python-samplerate', 'python-samplerate Documentation',
-     [author], 1)
+    (master_doc, "python-samplerate", "python-samplerate Documentation", [author], 1)
 ]
 
 
@@ -190,7 +177,13 @@ def get_short_version(version):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'python-samplerate', 'python-samplerate Documentation',
-     author, 'python-samplerate', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "python-samplerate",
+        "python-samplerate Documentation",
+        author,
+        "python-samplerate",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

docs/samplerate/index.rst

@@ -7,4 +7,3 @@
    samplerate
    converters
    exceptions
-   lowlevel

docs/samplerate/lowlevel.rst

@@ -6,9 +6,11 @@
 is generated at source samplerate, then resampled to target samplerate, and
 mixed onto the carrier.
 """
-from __future__ import print_function, division
+from __future__ import division, print_function
+
 import numpy as np
 import sounddevice as sd
+
 import samplerate as sr
 
 source_samplerate = 3600