[](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://python-soundfile.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)
From librosa version 0.10.2 or later, you can also use `librosa.cite()`
to get the DOI link for any version of librosa.
- 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)
Raw data
{
"_id": null,
"home_page": "https://librosa.org",
"name": "librosa",
"maintainer": null,
"docs_url": "https://pythonhosted.org/librosa/",
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Brian McFee, librosa development team",
"author_email": "brian.mcfee@nyu.edu",
"download_url": "https://files.pythonhosted.org/packages/0e/2d/77783a52641a21ff7e2230aa588e4fb4a61422a64673096a36776b7e5bd9/librosa-0.10.2.post1.tar.gz",
"platform": null,
"description": "[](https://librosa.org/)\n\n# librosa\n\n\nA python package for music and audio analysis. \n\n[](https://pypi.python.org/pypi/librosa)\n[](https://anaconda.org/conda-forge/librosa)\n[](https://github.com/librosa/librosa/blob/main/LICENSE.md)\n[](https://doi.org/10.5281/zenodo.591533)\n\n[](https://github.com/librosa/librosa/actions/workflows/ci.yml)\n[](https://codecov.io/gh/librosa/librosa)\n[](https://librosa.org/doc/latest/index.html)\n\n# Table of Contents\n\n- [Documentation](#Documentation)\n- [Installation](#Installation)\n - [Using PyPI](#using-pypi)\n - [Using Anaconda](#using-anaconda)\n - [Building From Source](#building-from-source)\n - [Hints for Installation](#hints-for-the-installation)\n - [`soundfile`](#soundfile)\n - [`audioread`](#audioread-and-mp3-support)\n - [Linux (`apt get`)](#linux-apt-get)\n - [Linux (`yum`)](#linux-yum)\n - [Mac](#mac)\n - [Windows](#windows)\n- [Discussion](#discussion)\n- [Citing](#citing)\n\n---\n\n## Documentation\n\n\nSee https://librosa.org/doc/ for a complete reference manual and introductory tutorials.\n\nThe [advanced example gallery](https://librosa.org/doc/latest/advanced.html) should give you a quick sense of the kinds\nof things that librosa can do.\n\n---\n\n[Back To Top \u21a5](#librosa)\n\n\n## Installation\n\n\n### Using PyPI\n\nThe latest stable release is available on PyPI, and you can install it by saying\n```\npython -m pip install librosa\n```\n\n### Using Anaconda\n\nAnaconda users can install using ```conda-forge```:\n```\nconda install -c conda-forge librosa\n```\n\n### Building from source\n\nTo build librosa from source, say \n```\npython setup.py build\n```\nThen, to install librosa, say \n```\npython setup.py install\n```\nIf all went well, you should be able to execute the following commands from a python console:\n```\nimport librosa\nlibrosa.show_versions()\n```\nThis should print out a description of your software environment, along with the installed versions of other packages used by librosa.\n\n\ud83d\udcdd OS X users should follow the installation guide given below.\n\nAlternatively, you can download or clone the repository and use `pip` to handle dependencies:\n\n```\nunzip librosa.zip\npython -m pip install -e librosa\n```\nor\n\n```\ngit clone https://github.com/librosa/librosa.git\npython -m pip install -e librosa\n```\n\nBy calling `pip list` you should see `librosa` now as an installed package:\n```\nlibrosa (0.x.x, /path/to/librosa)\n```\n\n---\n\n[Back To Top \u21a5](#librosa)\n\n### Hints for the Installation\n\n`librosa` uses `soundfile` and `audioread` to load audio files.\n\n\ud83d\udcdd 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.\n\n### `soundfile`\n\nIf you're using `conda` to install librosa, then audio encoding dependencies will be handled automatically.\n\nIf you're using `pip` on a Linux environment, you may need to install `libsndfile`\nmanually. Please refer to the [SoundFile installation documentation](https://python-soundfile.readthedocs.io/#installation) for details.\n\n### `audioread` and MP3 support\n\nTo fuel `audioread` with more audio-decoding power (e.g., for reading MP3 files),\nyou may need to install either *ffmpeg* or *GStreamer*.\n\n\ud83d\udcdd*Note that on some platforms, `audioread` needs at least one of the programs to work properly.*\n\nIf you are using Anaconda, install *ffmpeg* by calling\n\n```\nconda install -c conda-forge ffmpeg\n```\n\nIf you are not using Anaconda, here are some common commands for different operating systems:\n\n- #### Linux (`apt-get`): \n\n```\napt-get install ffmpeg\n```\nor\n \n```\napt-get install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly\n```\n- #### Linux (`yum`):\n```\nyum install ffmpeg\n```\nor\n\n\n```\nyum install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly\n```\n\n- #### Mac: \n```\nbrew install ffmpeg\n```\nor\n\n```\nbrew install gstreamer\n```\n\n- #### Windows: \n\ndownload ffmpeg binaries from this [website](https://www.gyan.dev/ffmpeg/builds/) or gstreamer binaries from this [website](https://gstreamer.freedesktop.org/)\n\nFor GStreamer, you also need to install the Python bindings with \n\n```\npython -m pip install pygobject\n```\n\n---\n\n[Back To Top \u21a5](#librosa)\n\n## Discussion\n\n\nPlease direct non-development questions and discussion topics to our web forum at\nhttps://groups.google.com/forum/#!forum/librosa\n\n---\n\n[Back To Top \u21a5](#librosa)\n\n## Citing\n\n\nIf you want to cite librosa in a scholarly work, there are two ways to do it.\n\n- If you are using the library for your work, for the sake of reproducibility, please cite\n the version you used as indexed at Zenodo:\n\n [](https://doi.org/10.5281/zenodo.591533)\n\n From librosa version 0.10.2 or later, you can also use `librosa.cite()`\n to get the DOI link for any version of librosa.\n\n- If you wish to cite librosa for its design, motivation, etc., please cite the paper\n published at SciPy 2015:\n\n 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.\n\n---\n\n[Back To Top \u21a5](#librosa)\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "Python module for audio and music processing",
"version": "0.10.2.post1",
"project_urls": {
"Discussion forum": "https://groups.google.com/g/librosa",
"Documentation": "https://librosa.org/doc",
"Download": "https://github.com/librosa/librosa/releases",
"Homepage": "https://librosa.org",
"Source": "https://github.com/librosa/librosa",
"Tracker": "https://github.com/librosa/librosa/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8c8a2d231b35456506b7c98b3ab9bbf07917b205fed8615d2e59e976ab497fff",
"md5": "11e2c4c9f2d1a370ffe7dc3098b585c4",
"sha256": "dc882750e8b577a63039f25661b7e39ec4cfbacc99c1cffba666cd664fb0a7a0"
},
"downloads": -1,
"filename": "librosa-0.10.2.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11e2c4c9f2d1a370ffe7dc3098b585c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 260089,
"upload_time": "2024-05-14T15:49:38",
"upload_time_iso_8601": "2024-05-14T15:49:38.919710Z",
"url": "https://files.pythonhosted.org/packages/8c/8a/2d231b35456506b7c98b3ab9bbf07917b205fed8615d2e59e976ab497fff/librosa-0.10.2.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e2d77783a52641a21ff7e2230aa588e4fb4a61422a64673096a36776b7e5bd9",
"md5": "363ea06f0ab197842fdfbc3e5d2d5462",
"sha256": "cd99f16717cbcd1e0983e37308d1db46a6f7dfc2e396e5a9e61e6821e44bd2e7"
},
"downloads": -1,
"filename": "librosa-0.10.2.post1.tar.gz",
"has_sig": false,
"md5_digest": "363ea06f0ab197842fdfbc3e5d2d5462",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 325533,
"upload_time": "2024-05-14T15:49:40",
"upload_time_iso_8601": "2024-05-14T15:49:40.530530Z",
"url": "https://files.pythonhosted.org/packages/0e/2d/77783a52641a21ff7e2230aa588e4fb4a61422a64673096a36776b7e5bd9/librosa-0.10.2.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-14 15:49:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "librosa",
"github_project": "librosa",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "librosa"
}
JSON
