samplerate 0.1.0__tar.gz → 0.2.0__tar.gz

samplerate-0.2.0/.gitattributes

@@ -0,0 +1 @@
+samplerate/_version.py export-subst

samplerate-0.2.0/.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/*

samplerate-0.2.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+
+.coverage
+.cache/
+.eggs/
+*.egg-info
+dist/
+build/
+
+docs/_build
+
+tags
+.vscode/
+
+samplerate/_src.py

samplerate-0.2.0/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)

samplerate-0.2.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.rst
+include LICENSE.rst
+include versioneer.py
+include src/*.cpp
+include CMakeLists.txt
+include external/CMakeLists.txt
+include requirements.txt
+include examples/*.py

samplerate-0.2.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.1
+Name: samplerate
+Version: 0.2.0
+Summary: Monolithic python wrapper for libsamplerate based on pybind11 and NumPy
+Author-email: Robin Scheibler <fakufaku@gmail.com>, Tino Wagner <ich@tinowagner.com>
+License: MIT
+Keywords: samplerate,converter,signal processing,audio
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Multimedia :: Sound/Audio
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: numpy
+
+python-samplerate
+=================
+
+.. image:: https://img.shields.io/pypi/v/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://img.shields.io/pypi/l/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://img.shields.io/pypi/wheel/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://img.shields.io/pypi/pyversions/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://readthedocs.org/projects/python-samplerate/badge/?version=latest
+   :target: http://python-samplerate.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+
+This is a wrapper around Erik de Castro Lopo's `libsamplerate`_ (aka Secret
+Rabbit Code) for high-quality sample rate conversion.
+
+It implements all three `APIs
+<http://www.mega-nerd.com/libsamplerate/api.html>`_ available in
+`libsamplerate`_:
+
+* **Simple API**: for resampling a large chunk of data with a single library
+  call
+* **Full API**: for obtaining the resampled signal from successive chunks of
+  data
+* **Callback API**: like Full API, but input samples are provided by a callback
+  function
+
+The `libsamplerate`_ library is statically built together with the python bindings
+using `pybind11 <https://github.com/pybind/pybind11/>`_.
+
+
+Installation
+------------
+
+    $ pip install samplerate
+
+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
+-----
+
+.. code-block:: python
+
+   import numpy as np
+   import samplerate
+
+   # Synthesize data
+   fs = 1000.
+   t = np.arange(fs * 2) / fs
+   input_data = np.sin(2 * np.pi * 5 * t)
+
+   # Simple API
+   ratio = 1.5
+   converter = 'sinc_best'  # or 'sinc_fastest', ...
+   output_data_simple = samplerate.resample(input_data, ratio, converter)
+
+   # Full API
+   resampler = samplerate.Resampler(converter, channels=1)
+   output_data_full = resampler.process(input_data, ratio, end_of_input=True)
+
+   # The result is the same for both APIs.
+   assert np.allclose(output_data_simple, output_data_full)
+
+   # See `samplerate.CallbackResampler` for the Callback API, or
+   # `examples/play_modulation.py` for an example.
+
+See ``samplerate.resample``, ``samplerate.Resampler``, and
+``samplerate.CallbackResampler`` in the API documentation for details.
+
+
+See also
+--------
+
+* `scikits.samplerate <https://pypi.python.org/pypi/scikits.samplerate>`_
+  implements only the Simple API and uses `Cython <http://cython.org/>`_ for
+  extern calls. The `resample` function of `scikits.samplerate` and this package
+  share the same function signature for compatiblity.
+
+* `resampy <https://github.com/bmcfee/resampy>`_: sample rate conversion in
+  Python + Cython.
+
+
+License
+-------
+
+This project is licensed under the `MIT license
+<https://opensource.org/licenses/MIT>`_.
+
+As of version 0.1.9, `libsamplerate`_ is licensed under the `2-clause BSD
+license <https://opensource.org/licenses/BSD-2-Clause>`_.
+
+
+.. _libsamplerate: http://www.mega-nerd.com/libsamplerate/

{samplerate-0.1.0 → samplerate-0.2.0}/README.rst

@@ -1,6 +1,23 @@
 python-samplerate
 =================
 
+.. image:: https://img.shields.io/pypi/v/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://img.shields.io/pypi/l/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://img.shields.io/pypi/wheel/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://img.shields.io/pypi/pyversions/samplerate.svg
+    :target: https://pypi.python.org/pypi/samplerate
+
+.. image:: https://readthedocs.org/projects/python-samplerate/badge/?version=latest
+   :target: http://python-samplerate.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+
 This is a wrapper around Erik de Castro Lopo's `libsamplerate`_ (aka Secret
 Rabbit Code) for high-quality sample rate conversion.
 
@@ -15,8 +32,8 @@ 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
@@ -24,8 +41,8 @@ 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.
+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

samplerate-0.2.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = python-samplerate
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

samplerate-0.2.0/docs/changelog.rst

@@ -0,0 +1,7 @@
+Change Log
+##########
+
+0.1.0
+=====
+
+* Initial release.

samplerate-0.2.0/docs/conf.py

@@ -0,0 +1,189 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# python-samplerate documentation build configuration file, created by
+# sphinx-quickstart on Thu Feb  9 12:32:39 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+
+# sys.path.insert(0, os.path.abspath('.'))
+
+import samplerate
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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"]
+
+# Add any paths that contain templates here, relative to this directory.
+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"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+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
+# built documents.
+#
+
+# 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("+")]
+    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 = "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"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+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,
+}
+
+html_sidebars = {
+    "**": [
+        "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"]
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "python-sampleratedoc"
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # 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',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (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",
+    ),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# 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)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (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",
+    ),
+]

samplerate-0.2.0/docs/index.rst

@@ -0,0 +1,29 @@
+.. include:: ../README.rst
+
+
+API documentation
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+
+   samplerate/index
+
+
+Change Log
+----------
+.. toctree::
+   :maxdepth: 2
+
+   changelog
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+.. _libsamplerate: http://www.mega-nerd.com/libsamplerate/

samplerate-0.2.0/docs/samplerate/converters.rst

@@ -0,0 +1,34 @@
+:mod:`samplerate.converters` -- Sample rate converters
+======================================================
+.. module:: samplerate.converters
+
+Converter types
+---------------
+
+.. autoclass:: ConverterType
+    :members:
+    :undoc-members:
+
+
+Sample rate converters
+----------------------
+
+Simple
+^^^^^^
+.. autofunction:: resample
+
+
+Full API
+^^^^^^^^
+
+.. autoclass:: Resampler
+    :members:
+    :undoc-members:
+
+
+Callback API
+^^^^^^^^^^^^
+
+.. autoclass:: CallbackResampler
+    :members:
+    :undoc-members:

samplerate-0.2.0/docs/samplerate/exceptions.rst

@@ -0,0 +1,7 @@
+:mod:`samplerate.exceptions` -- Sample rate exceptions
+======================================================
+.. module:: samplerate.exceptions
+
+.. autoclass:: ResamplingError
+    :members:
+    :undoc-members:

samplerate-0.2.0/docs/samplerate/index.rst

@@ -0,0 +1,9 @@
+`samplerate` module documentation
+=================================
+
+.. toctree::
+   :maxdepth: 2
+
+   samplerate
+   converters
+   exceptions

samplerate-0.2.0/docs/samplerate/samplerate.rst

@@ -0,0 +1,35 @@
+:mod:`samplerate` -- Python bindings for libsamplerate based on CFFI and NumPy
+==============================================================================
+.. module:: samplerate
+
+
+Simple API
+----------
+
+.. function:: samplerate.resample
+
+   See :func:`samplerate.converters.resample`.
+
+
+Full API
+--------
+
+.. class:: samplerate.Resampler
+
+   See :func:`samplerate.converters.Resampler`.
+
+
+Callback API
+------------
+
+.. class:: samplerate.CallbackResampler
+
+   See :func:`samplerate.converters.CallbackResampler`.
+
+
+Exceptions
+----------
+
+.. class:: samplerate.ResamplingError
+
+   See :func:`samplerate.converters.CallbackResampler`.

{samplerate-0.1.0 → samplerate-0.2.0}/examples/play_modulation.py

@@ -6,9 +6,11 @@ played back on the default sound output. During playback, the modulation signal
 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