Metadata-Version: 2.1
Name: audresample
Version: 1.3.1
Summary: Provides functions to resample and remix a signal
Home-page: https://github.com/audeering/audresample/
Author: Johannes Wagner, Andrea Crespi, Hagen Wierstorf
Author-email: jwagner@audeering.com, acrespi@audeering.com, hwierstorf@audeering.com
License: MIT
Project-URL: Documentation, https://audeering.github.io/audresample/
Keywords: audio,dsp,resample,remix
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
License-File: LICENSE
Requires-Dist: numpy

===========
audresample
===========

|tests| |coverage| |docs| |python-versions| |license|

**audresample** remixes or resamples your signals.

Resampling is supported
for signals in single precision floating-point format,
and based on the `soxr`_ implementation
as provided by `audresamplelib`_.

Have a look at the installation_ and usage_ instructions.

.. code-block:: python

    >>> import numpy as np
    >>> import audresample
    >>> signal = np.zeros((2, 8000), dtype='float32')
    >>> signal.shape
    (2, 8000)
    >>> audresample.remix(signal, mixdown=True).shape
    (1, 8000)
    >>> audresample.remix(signal, channels=[0, 0, 1, 1]).shape
    (4, 8000)
    >>> audresample.resample(signal, 8000, 16000).shape
    (2, 16000)

.. _soxr: https://sourceforge.net/projects/soxr/
.. _audresamplelib: https://github.com/audeering/audresamplelib
.. _installation: https://audeering.github.io/audresample/install.html
.. _usage: https://audeering.github.io/audresample/usage.html


.. badges images and links:
.. |tests| image:: https://github.com/audeering/audresample/workflows/Test/badge.svg
    :target: https://github.com/audeering/audresample/actions?query=workflow%3ATest
    :alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/audresample/branch/master/graph/badge.svg?token=NPQDJ5T7HI
    :target: https://codecov.io/gh/audeering/audresample/
    :alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/audresample?label=docs
    :target: https://audeering.github.io/audresample/
    :alt: audresample's documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :target: https://github.com/audeering/audfactory/blob/master/LICENSE
    :alt: audfactory's MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audresample.svg
    :target: https://pypi.org/project/audresample/
    :alt: audresamples's supported Python versions

Changelog
=========

All notable changes to this project will be documented in this file.

The format is based on `Keep a Changelog`_,
and this project adheres to `Semantic Versioning`_.


Version 1.3.1 (2023-05-30)
--------------------------

* Fixed: documentation building in deploy step
  of ``publish`` Action on Github
* Changed: switch versions of MacOS wheel to
  ``macosx_11_0_arm64``,
  ``macosx_10_4_x86_64``


Version 1.3.0 (2023-05-30)
--------------------------

* Added: support for Raspberry Pi
  64-bit (aarch64)
  and 32-bit (armv7l)
* Added: code example to README
  that highlights the functionality
  of the package
* Changed: replace universal wheel
  of Python package
  by dedicated platform wheels for
  ``macosx_12_0_arm64``,
  ``macosx_12_0_x86_64``,
  ``manylinux_2_17_aarch64``,
  ``manylinux_2_17_armv7l``,
  ``manylinux_2_17_x86_64``,
  ``win_amd64``


Version 1.2.1 (2023-01-27)
--------------------------

* Fixed: require ``sphinx-audeering-theme>=1.2.1``
  to ensure the correct theme is used
  for the public documentation


Version 1.2.0 (2023-01-27)
--------------------------

* Added: support for MacOS M1 architecture


Version 1.1.1 (2022-12-23)
--------------------------

* Added: support for Python 3.11
* Added: support for Python 3.10
* Changed: split API documentation into sub-pages
  for each function
* Fixed: missing ``__init__.py`` file for
  ``audresample.define``


Version 1.1.0 (2022-02-03)
--------------------------

* Added: support for non single precision floating-point formats
  in ``audresample.remix()``
* Changed: raise a ``RuntimeError`` in ``audresample.resample()``
  when a non single precision floating-point input signal is given
  instead of converting it silently


Version 1.0.0 (2022-01-04)
--------------------------

* Added: Python 3.9 support
* Removed: Python 3.6 support


Version 0.1.6 (2021-06-17)
--------------------------

* Added: Windows support


Version 0.1.5 (2021-05-10)
--------------------------

* Added: macOS support


Version 0.1.4 (2021-03-26)
--------------------------

* Fixed: "Edit on Github" link in the docs


Version 0.1.3 (2021-03-25)
--------------------------

* Changed: move to Github and release as open source


Version 0.1.2 (2021-03-18)
--------------------------

* Added: ``upmix`` argument to ``remix()``


Version 0.1.1 (2021-01-15)
--------------------------

* Fixed: Updating binaries to RELEASE versions (execution time greatly reduced!)


Version 0.1.0 (2020-02-12)
--------------------------

* Added: Initial release


.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/
.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
