Metadata-Version: 2.1
Name: soxr
Version: 0.2.1
Summary: High quality, one-dimensional sample-rate conversion library
Home-page: https://github.com/dofuuz/python-soxr
Author: dofuuz
License: LGPLv2
Project-URL: Source, https://github.com/dofuuz/python-soxr
Project-URL: Bug Tracker, https://github.com/dofuuz/python-soxr/issues/
Description: # Python-SoXR
        
        High quality, one-dimensional sample-rate conversion library for Python
        
        
        ## Installation
        
        ```
        pip install soxr
        ```
        
        If installation fails, upgrade pip with `python -m pip install --upgrade pip` and try again.
        
        
        ## Basic usage
        
        ```python
        import soxr
        
        y = soxr.resample(
            x,          # 1D(mono) or 2D(frames, channels) array input
            48000,      # input samplerate
            16000       # target samplerate
        )
        ```
        If input is 1D array, output is 1D numpy.ndarray with shape (frames).
        
        If input is 2D array, output is 2D numpy.ndarray with shape (frames, channels).
        
        
        ## Streaming usage
        
        Use `ResampleStream` for real-time processing or very long signal.
        
        ```python
        import soxr
        
        rs = soxr.ResampleStream(
            44100,              # input samplerate
            16000,              # target samplerate
            1,                  # channel(s)
            dtype='float32'     # optional data type (default = np.float32)
        )
        
        eof = False
        while not eof:
            # Get chunk
            ...
        
            y_chunk = rs.resample_chunk(
                x,              # 1D(mono) or 2D(frames, channels) array input
                last=eof        # Set True at end of input
            )
        ```
        
        Output frame count may not be consistent. This is normal operation.  
        (ex. [0, 0, 0, 186, 186, 166, 186, 186, 168, ...])
        
        
        ## OSS libraries used
        
        ### libsoxr (LGPLv2.1+)
        The SoX Resampler library  
        https://sourceforge.net/projects/soxr/
        
        Python-SoXR is a Python wrapper of libsoxr.
        
        
        ### PFFFT (BSD-like)
        PFFFT: a pretty fast FFT.  
        https://bitbucket.org/jpommier/pffft/  
        
        libsoxr dependency.
        
Keywords: samplerate conversion,SRC
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
