Metadata-Version: 2.1
Name: pysndfx
Version: 0.3.5
Summary: Apply audio effects such as reverb and EQ directly to audio files or NumPy ndarrays.
Home-page: https://github.com/carlthome/python-audio-effects
Author: Carl Thomé
Author-email: carlthome@gmail.com
License: MIT
Description: # pysndfx
        [![Build Status](https://travis-ci.org/carlthome/python-audio-effects.svg?branch=master)](https://travis-ci.org/carlthome/python-audio-effects) [![PyPI](https://img.shields.io/pypi/v/pysndfx.svg)](https://pypi.python.org/pypi/pysndfx) [![PyPI](https://img.shields.io/pypi/pyversions/pysndfx.svg)](http://py3readiness.org/) [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)
        
        **Apply audio effects such as reverb and EQ directly to audio files or NumPy ndarrays.**
        
        This is a lightweight Python wrapper for SoX, the Swiss Army knife of sound processing programs. Supported effects range from EQ and compression to phasers, reverb and pitch shifters.
        
        ## Install
        Install with pip as:
        ```sh
        pip install pysndfx
        ```
        The system must also have [SoX](http://sox.sourceforge.net/) installed (for Debian-based operating systems: `apt install sox`, or with Anaconda as `conda install -c conda-forge sox`)
        
        ## Usage
        First create an audio effects chain.
        ```python
        # Import the package and create an audio effects chain function.
        from pysndfx import AudioEffectsChain
        
        fx = (
            AudioEffectsChain()
            .highshelf()
            .reverb()
            .phaser()
            .delay()
            .lowshelf()
        )
        ```
        Then we can call the effects chain object with paths to audio files, or directly with NumPy ndarrays.
        ```python
        infile = 'my_audio_file.wav'
        outfile = 'my_processed_audio_file.ogg'
        
        # Apply phaser and reverb directly to an audio file.
        fx(infile, outfile)
        
        # Or, apply the effects directly to a ndarray.
        from librosa import load
        y, sr = load(infile, sr=None)
        y = fx(y)
        
        # Apply the effects and return the results as a ndarray.
        y = fx(infile)
        
        # Apply the effects to a ndarray but store the resulting audio to disk.
        fx(x, outfile)
        ```
        There's also experimental streaming support. Try applying reverb to a microphone input and listening to the results live like this:
        ```sh
        python -c "from pysndfx import AudioEffectsChain; AudioEffectsChain().reverb()(None, None)"
        ```
        
Keywords: audio music sound
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
