272 lines
8.1 KiB
Plaintext
272 lines
8.1 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: librosa
|
|
Version: 0.10.1
|
|
Summary: Python module for audio and music processing
|
|
Home-page: https://librosa.org
|
|
Author: Brian McFee, librosa development team
|
|
Author-email: brian.mcfee@nyu.edu
|
|
License: ISC
|
|
Project-URL: Documentation, https://librosa.org/doc
|
|
Project-URL: Download, https://github.com/librosa/librosa/releases
|
|
Project-URL: Source, https://github.com/librosa/librosa
|
|
Project-URL: Tracker, https://github.com/librosa/librosa/issues
|
|
Project-URL: Discussion forum, https://groups.google.com/g/librosa
|
|
Classifier: License :: OSI Approved :: ISC License (ISCL)
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Development Status :: 3 - Alpha
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
|
|
Classifier: Framework :: Matplotlib
|
|
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
|
|
Requires-Python: >=3.7
|
|
Description-Content-Type: text/markdown; charset=UTF-8
|
|
License-File: LICENSE.md
|
|
Requires-Dist: audioread >=2.1.9
|
|
Requires-Dist: numpy !=1.22.0,!=1.22.1,!=1.22.2,>=1.20.3
|
|
Requires-Dist: scipy >=1.2.0
|
|
Requires-Dist: scikit-learn >=0.20.0
|
|
Requires-Dist: joblib >=0.14
|
|
Requires-Dist: decorator >=4.3.0
|
|
Requires-Dist: numba >=0.51.0
|
|
Requires-Dist: soundfile >=0.12.1
|
|
Requires-Dist: pooch >=1.0
|
|
Requires-Dist: soxr >=0.3.2
|
|
Requires-Dist: typing-extensions >=4.1.1
|
|
Requires-Dist: lazy-loader >=0.1
|
|
Requires-Dist: msgpack >=1.0
|
|
Provides-Extra: display
|
|
Requires-Dist: matplotlib >=3.3.0 ; extra == 'display'
|
|
Provides-Extra: docs
|
|
Requires-Dist: numpydoc ; extra == 'docs'
|
|
Requires-Dist: sphinx !=1.3.1 ; extra == 'docs'
|
|
Requires-Dist: sphinx-rtd-theme >=1.2.0 ; extra == 'docs'
|
|
Requires-Dist: numba >=0.51 ; extra == 'docs'
|
|
Requires-Dist: matplotlib >=3.3.0 ; extra == 'docs'
|
|
Requires-Dist: sphinx-multiversion >=0.2.3 ; extra == 'docs'
|
|
Requires-Dist: sphinx-gallery >=0.7 ; extra == 'docs'
|
|
Requires-Dist: mir-eval >=0.5 ; extra == 'docs'
|
|
Requires-Dist: ipython >=7.0 ; extra == 'docs'
|
|
Requires-Dist: sphinxcontrib-svg2pdfconverter ; extra == 'docs'
|
|
Requires-Dist: presets ; extra == 'docs'
|
|
Provides-Extra: tests
|
|
Requires-Dist: matplotlib >=3.3.0 ; extra == 'tests'
|
|
Requires-Dist: packaging >=20.0 ; extra == 'tests'
|
|
Requires-Dist: pytest-mpl ; extra == 'tests'
|
|
Requires-Dist: pytest-cov ; extra == 'tests'
|
|
Requires-Dist: pytest ; extra == 'tests'
|
|
Requires-Dist: samplerate ; extra == 'tests'
|
|
Requires-Dist: resampy >=0.2.2 ; extra == 'tests'
|
|
Requires-Dist: types-decorator ; extra == 'tests'
|
|
|
|
[](https://librosa.org/)
|
|
|
|
# librosa
|
|
|
|
|
|
A python package for music and audio analysis.
|
|
|
|
[](https://pypi.python.org/pypi/librosa)
|
|
[](https://anaconda.org/conda-forge/librosa)
|
|
[](https://github.com/librosa/librosa/blob/main/LICENSE.md)
|
|
[](https://doi.org/10.5281/zenodo.591533)
|
|
|
|
[](https://github.com/librosa/librosa/actions/workflows/ci.yml)
|
|
[](https://codecov.io/gh/librosa/librosa)
|
|
[](https://librosa.org/doc/latest/index.html)
|
|
|
|
# Table of Contents
|
|
|
|
- [Documentation](#Documentation)
|
|
- [Installation](#Installation)
|
|
- [Using PyPI](#using-pypi)
|
|
- [Using Anaconda](#using-anaconda)
|
|
- [Building From Source](#building-from-source)
|
|
- [Hints for Installation](#hints-for-the-installation)
|
|
- [`soundfile`](#soundfile)
|
|
- [`audioread`](#audioread-and-mp3-support)
|
|
- [Linux (`apt get`)](#linux-apt-get)
|
|
- [Linux (`yum`)](#linux-yum)
|
|
- [Mac](#mac)
|
|
- [Windows](#windows)
|
|
- [Discussion](#discussion)
|
|
- [Citing](#citing)
|
|
|
|
---
|
|
|
|
## Documentation
|
|
|
|
|
|
See https://librosa.org/doc/ for a complete reference manual and introductory tutorials.
|
|
|
|
The [advanced example gallery](https://librosa.org/doc/latest/advanced.html) should give you a quick sense of the kinds
|
|
of things that librosa can do.
|
|
|
|
---
|
|
|
|
[Back To Top ↥](#librosa)
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
### Using PyPI
|
|
|
|
The latest stable release is available on PyPI, and you can install it by saying
|
|
```
|
|
python -m pip install librosa
|
|
```
|
|
|
|
### Using Anaconda
|
|
|
|
Anaconda users can install using ```conda-forge```:
|
|
```
|
|
conda install -c conda-forge librosa
|
|
```
|
|
|
|
### Building from source
|
|
|
|
To build librosa from source, say
|
|
```
|
|
python setup.py build
|
|
```
|
|
Then, to install librosa, say
|
|
```
|
|
python setup.py install
|
|
```
|
|
If all went well, you should be able to execute the following commands from a python console:
|
|
```
|
|
import librosa
|
|
librosa.show_versions()
|
|
```
|
|
This should print out a description of your software environment, along with the installed versions of other packages used by librosa.
|
|
|
|
📝 OS X users should follow the installation guide given below.
|
|
|
|
Alternatively, you can download or clone the repository and use `pip` to handle dependencies:
|
|
|
|
```
|
|
unzip librosa.zip
|
|
python -m pip install -e librosa
|
|
```
|
|
or
|
|
|
|
```
|
|
git clone https://github.com/librosa/librosa.git
|
|
python -m pip install -e librosa
|
|
```
|
|
|
|
By calling `pip list` you should see `librosa` now as an installed package:
|
|
```
|
|
librosa (0.x.x, /path/to/librosa)
|
|
```
|
|
|
|
---
|
|
|
|
[Back To Top ↥](#librosa)
|
|
|
|
### Hints for the Installation
|
|
|
|
`librosa` uses `soundfile` and `audioread` to load audio files.
|
|
|
|
📝 Note that older releases of `soundfile` (prior to 0.11) do not support MP3, which will cause librosa to fall back on the `audioread` library.
|
|
|
|
### `soundfile`
|
|
|
|
If you're using `conda` to install librosa, then audio encoding dependencies will be handled automatically.
|
|
|
|
If you're using `pip` on a Linux environment, you may need to install `libsndfile`
|
|
manually. Please refer to the [SoundFile installation documentation](https://pysoundfile.readthedocs.io/#installation) for details.
|
|
|
|
### `audioread` and MP3 support
|
|
|
|
To fuel `audioread` with more audio-decoding power (e.g., for reading MP3 files),
|
|
you may need to install either *ffmpeg* or *GStreamer*.
|
|
|
|
📝*Note that on some platforms, `audioread` needs at least one of the programs to work properly.*
|
|
|
|
If you are using Anaconda, install *ffmpeg* by calling
|
|
|
|
```
|
|
conda install -c conda-forge ffmpeg
|
|
```
|
|
|
|
If you are not using Anaconda, here are some common commands for different operating systems:
|
|
|
|
- #### Linux (`apt-get`):
|
|
|
|
```
|
|
apt-get install ffmpeg
|
|
```
|
|
or
|
|
|
|
```
|
|
apt-get install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly
|
|
```
|
|
- #### Linux (`yum`):
|
|
```
|
|
yum install ffmpeg
|
|
```
|
|
or
|
|
|
|
|
|
```
|
|
yum install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly
|
|
```
|
|
|
|
- #### Mac:
|
|
```
|
|
brew install ffmpeg
|
|
```
|
|
or
|
|
|
|
```
|
|
brew install gstreamer
|
|
```
|
|
|
|
- #### Windows:
|
|
|
|
download ffmpeg binaries from this [website](https://www.gyan.dev/ffmpeg/builds/) or gstreamer binaries from this [website](https://gstreamer.freedesktop.org/)
|
|
|
|
For GStreamer, you also need to install the Python bindings with
|
|
|
|
```
|
|
python -m pip install pygobject
|
|
```
|
|
|
|
---
|
|
|
|
[Back To Top ↥](#librosa)
|
|
|
|
## Discussion
|
|
|
|
|
|
Please direct non-development questions and discussion topics to our web forum at
|
|
https://groups.google.com/forum/#!forum/librosa
|
|
|
|
---
|
|
|
|
[Back To Top ↥](#librosa)
|
|
|
|
## Citing
|
|
|
|
|
|
If you want to cite librosa in a scholarly work, there are two ways to do it.
|
|
|
|
- If you are using the library for your work, for the sake of reproducibility, please cite
|
|
the version you used as indexed at Zenodo:
|
|
|
|
[](https://doi.org/10.5281/zenodo.591533)
|
|
|
|
- If you wish to cite librosa for its design, motivation, etc., please cite the paper
|
|
published at SciPy 2015:
|
|
|
|
McFee, Brian, Colin Raffel, Dawen Liang, Daniel PW Ellis, Matt McVicar, Eric Battenberg, and Oriol Nieto. "librosa: Audio and music signal analysis in python." In Proceedings of the 14th python in science conference, pp. 18-25. 2015.
|
|
|
|
---
|
|
|
|
[Back To Top ↥](#librosa)
|