Metadata-Version: 1.2
Name: audinterface
Version: 0.10.1
Summary: Generic interfaces for signal processing
Home-page: https://github.com/audeering/audinterface/
Author: Johannes Wagner, Hagen Wierstorf, Andreas Triantafyllopoulos
Author-email: jwagner@audeering.com, hwierstorf@audeering.com, atriant@audeering.com
License: MIT
Project-URL: Documentation, https://audeering.github.io/audinterface/
Description: ============
        audinterface
        ============
        
        |tests| |coverage| |docs| |python-versions| |license|
        
        Generic interfaces for signal processing.
        
        **audinterface** provides user interfaces
        to apply any machine learning model
        or digital signal processing algorithm
        to audio files or databases_.
        
        Have a look at the installation_ and usage_ instructions.
        
        .. _databases: https://audeering.github.io/audformat/
        .. _installation: https://audeering.github.io/audinterface/install.html
        .. _usage: https://audeering.github.io/audinterface/usage.html
        
        
        .. badges images and links:
        .. |tests| image:: https://github.com/audeering/audinterface/workflows/Test/badge.svg
            :target: https://github.com/audeering/audinterface/actions?query=workflow%3ATest
            :alt: Test status
        .. |coverage| image:: https://codecov.io/gh/audeering/audinterface/branch/master/graph/badge.svg?token=dNAlTQNVBt
            :target: https://codecov.io/gh/audeering/audinterface/
            :alt: code coverage
        .. |docs| image:: https://img.shields.io/pypi/v/audinterface?label=docs
            :target: https://audeering.github.io/audinterface/
            :alt: audinterface's documentation
        .. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
            :target: https://github.com/audeering/audinterface/blob/master/LICENSE
            :alt: audinterface's MIT license
        .. |python-versions| image:: https://img.shields.io/pypi/pyversions/audinterface.svg
            :target: https://pypi.org/project/audinterface/
            :alt: audinterfaces'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 0.10.1 (2023/01/19)
        ---------------------------
        
        * Changed: split API documentation into sub-pages
          for each function
        * Fixed: typo in multi-channel usage example
          in the documentation
        
        
        Version 0.10.0 (2022-10-24)
        ---------------------------
        
        * Changed: ``audinterface.Feature``
          uses multi-level column format
          and names columns after channel ID
          when result has more than one channel
        
        
        Version 0.9.2 (2022-10-07)
        --------------------------
        
        * Changed: require ``audformat>=0.15.3``
        * Fixed: segmented indices are returned
          with ``file`` level
          as dtype ``string``
          as introduced with ``audformat`` 0.15.0
        * Removed: support for Python 3.7
        
        
        Version 0.9.1 (2022-07-22)
        --------------------------
        
        * Changed: support special arguments
          ``idx``,
          ``file``,
          ``root``
          in processing function
        
        
        Version 0.9.0 (2022-07-11)
        --------------------------
        
        * Added: ``auinterface.utils.sliding_window()``
        * Added: ``auinterface.utils.to_timedelta()``
        * Added: argument
          ``process_func_applies_sliding_window``
          to
          ``audinterface.Feature``
        * Added: arguments
          ``win_dur`` and ``hop_dur``
          to
          ``audinterface.Process``
        * Added: arguments
          ``min_signal_dur`` and ``max_signal_dur``
          to
          ``audinterface.Feature``,
          ``audinterface.Process``,
          ``audinterface.Segment``
        * Added: argument
          ``cache_root``
          to
          ``audinterface.Feature.process_index()``,
          ``audinterface.Process.process_index()``
        * Changed: extend documentation with docstring examples and usage section
        * Deprecated: ``unit`` argument of ``audinterface.Feature``,
          instead specify unit directly when providing duration arguments,
          compare ``audinterface.utils.to_timedelta()``
        * Fixed: ``audinterface.ProcessWithContext``
          requires one output for every segment
        
        
        Version 0.8.1 (2022-02-07)
        --------------------------
        
        * Added: ``audinterface.Feature`` does support
          specification of single feature as string
          in addition to list
        * Changed: depend on ``audresample>=1.1``
        * Fixed: handle empty and non-existing folder
          in ``process_folder()`` methods
        
        
        Version 0.8.0 (2022-01-04)
        --------------------------
        
        * Added: Python 3.9 support
        * Added: ``process_func_args`` argument to process methods
        * Deprecated: ``**kwargs`` in process methods,
          use ``process_func_args`` argument instead
        * Removed: deprecated ``process_unified_format_index()`` methods
        * Removed: Python 3.6 support
        
        
        Version 0.7.0 (2021-07-23)
        --------------------------
        
        * Changed: ``Feature.process_func()`` supports more shapes, namely
          ``(features)``
          ``(channels, features)``
          ``(features, frames)``
          ``(channels, features, frames)``
        * Changed: ``Feature.process_func()`` supports more types
          (e.g. scalars, lists, strings, etc.)
        * Fixed: ``Feature.__call__()`` always returns ``(channels, features, frames)``
        
        
        Version 0.6.8 (2021-07-06)
        --------------------------
        
        * Fixed: CHANGELOG
        
        
        Version 0.6.7 (2021-07-06)
        --------------------------
        
        * Added: ``utils.signal_index()`` to create a segmented index without file level
        * Changed: use keyword argument with ``pandas.MultiIndex.set_levels()``
        * Fixed: raise error if multiple frames are returned but ``win_dur`` is not set
        * Fixed: remove ``num_channels`` from ``Feature`` docstring
        
        
        Version 0.6.6 (2021-06-18)
        --------------------------
        
        * Added: tests on Windows and macOC
        
        
        Version 0.6.5 (2021-06-08)
        --------------------------
        
        * Added: ``root`` argument to all functions processing file input
        
        
        Version 0.6.4 (2021-06-07)
        --------------------------
        
        * Fixed: avoid using 'sec' as unit in ``pd.to_timedelta()`` for backward compatibility
        
        
        Version 0.6.3 (2021-05-03)
        --------------------------
        
        * Fixed: empty API section in documentation
        
        
        Version 0.6.2 (2021-04-28)
        --------------------------
        
        * Added: open source release on Github
        * Changed: switch to MIT license
        
        
        Version 0.6.1 (2021-04-16)
        --------------------------
        
        * Fixed: ``Process``, ``Feature``: do not apply segmentation twice when ``segment`` object is given
        
        
        Version 0.6.0 (2021-04-15)
        --------------------------
        
        * Added: ``invert`` argument to ``Segment``
        * Added: ``Segment.process_index()`` and ``Segment.process_signal_from_index()``
        * Changed: ``Process.process_index()`` and ``Process.process_signal_from_index()`` do not ignore segment object
        * Changed: ``Feature.process_index()`` and ``Feature.process_signal_from_index()`` do not ignore segment object
        
        
        Version 0.5.5 (2021-02-17)
        --------------------------
        
        * Fixed: PyPI publishing pipeline
        * Changed: use new tokenizer in CI pipeline
        
        
        Version 0.5.4 (2021-02-17)
        --------------------------
        
        * Added: support for providing ``start`` and ``end`` time values
          in the same format as done in ``audformat``,
          e.g. as integer, floats, or ``pandas.Timedelta``
        * Changed: improve speed of CI pipelines
        * Fixed: ``audinterface.Feature`` handles empty index
        
        
        Version 0.5.3 (2021-01-07)
        --------------------------
        
        * Changed: rename
          ``audinterface.Feature.process_unified_format_index``,
          ``audinterface.Process.process_unified_format_index``,
          ``audinterface.ProcessWithContext.process_unified_format_index``
          to
          ``audinterface.Feature.process_index``,
          ``audinterface.Process.process_index``,
          ``audinterface.ProcessWithContext.process_index``
        
        
        Version 0.5.2 (2020-12-10)
        --------------------------
        
        * Fixed: ``audinterface.Feature`` allow
          ``win_dur=None`` with ``unit='samples'``
        
        
        Version 0.5.1 (2020-12-04)
        --------------------------
        
        * Changed: store ``Process.channels`` always as a list
        * Changed: keep ``Feature.win_dur`` and ``Feature.hop_dur`` in original format
        
        
        Version 0.5.0 (2020-12-03)
        --------------------------
        
        * Added: arguments ``channels`` and ``mixdown`` to
          ``audinterface.Process``,
          ``audinterface.ProcessWithContext``,
          ``audinterface.Feature``,
          ``audinterface.Segment``
        * Removed: ``channel`` argument from all ``process_*`` functions
        
        
        Version 0.4.3 (2020-11-24)
        --------------------------
        
        * Fixed: ``audinterface.Feature.__call__``
          always returns ``numpy.ndarray``
        
        
        Version 0.4.2 (2020-11-23)
        --------------------------
        
        * Changed: ``audinterface.Process.process_unified_format_index`` and
          ``audinterface.Feature.process_unified_format_index``
          support filewise index
        
        
        Version 0.4.1 (2020-11-20)
        --------------------------
        
        * Added: ``process_func_is_mono`` argument to
          ``audinterface.Feature``,
          ``audinterface.Process``
        * Fixed: avoid nested progress bars
        
        
        Version 0.4.0 (2020-10-21)
        --------------------------
        
        * Changed: make
          ``audinterface.Feature``,
          ``audinterface.Process``,
          ``audinterface.ProcessWithContext``,
          ``audinterface.Segment``,
          callable
        * Changed: use ``name`` and ``params`` arguments
          in ``audinterface.Feature``
        
        
        Version 0.3.2 (2020-09-21)
        --------------------------
        
        * Changed: switch to ``audeer.run_tasks``
        * Changed: cut signal before resampling is applied
        
        
        Version 0.3.1 (2020-09-18)
        --------------------------
        
        * Fixed: ``audinterface.Feature`` raises an due to missing sampling rate
          now only if ``win_dur`` is given
        
        
        Version 0.3.0 (2020-08-07)
        --------------------------
        
        * Changed: switch to ``audsp`` >=0.9.2, which fixes a critical resampling
          issue and introduces a new keyword arg name
        
        
        Version 0.2.4 (2020-06-12)
        --------------------------
        
        * Fixed: description and keywords of package in ``setup.cfg``
        
        
        Version 0.2.3 (2020-06-11)
        --------------------------
        
        * Fixed: syntax error in CHANGELOG
        
        
        Version 0.2.2 (2020-06-11)
        --------------------------
        
        * Fixed: ``audinterface.Process.process_file`` was changing end times
          when process a segmented index
        
        
        Version 0.2.1 (2020-06-10)
        --------------------------
        
        * Changed: ``utils.check_index`` ignores ``datetime``
        
        
        Version 0.2.0 (2020-06-10)
        --------------------------
        
        * Added: ``segment`` argument to ``audinterface.Process`` and ``audinterface.Feature``
        * Removed: ``name`` argument from ``audinterface.Feature``
        
        
        Version 0.1.0 (2020-06-05)
        --------------------------
        
        * Added: initial release
        
        
        .. _Keep a Changelog:
            https://keepachangelog.com/en/1.0.0/
        .. _Semantic Versioning:
            https://semver.org/spec/v2.0.0.html
        
Keywords: dsp,audio,machine learning
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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
