librosa
=======
A python package for music and audio analysis.
[![PyPI](https://img.shields.io/pypi/v/librosa.svg)](https://pypi.python.org/pypi/librosa)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/librosa/badges/version.svg)](https://anaconda.org/conda-forge/librosa)
[![License](https://img.shields.io/pypi/l/librosa.svg)](https://github.com/librosa/librosa/blob/main/LICENSE.md)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.591533.svg)](https://doi.org/10.5281/zenodo.591533)
[![CI](https://github.com/librosa/librosa/actions/workflows/ci.yml/badge.svg)](https://github.com/librosa/librosa/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/librosa/librosa/branch/main/graph/badge.svg?token=ULWnUHaIJC)](https://codecov.io/gh/librosa/librosa)
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.
Installation
------------
The latest stable release is available on PyPI, and you can install it by saying
```
pip install librosa
```
Anaconda users can install using ``conda-forge``:
```
conda install -c conda-forge librosa
```
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 demo scripts under `examples/`
(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
pip install -e librosa
```
or
```
git clone https://github.com/librosa/librosa.git
pip install -e librosa
```
By calling `pip list` you should see `librosa` now as an installed package:
```
librosa (0.x.x, /path/to/librosa)
```
### Hints for the Installation
`librosa` uses `soundfile` and `audioread` to load audio files.
Note that `soundfile` does not currently support MP3, which will cause librosa to
fall back on the `audioread` library.
#### soundfile
If you're using `conda` to install librosa, then most audio coding dependencies (except MP3) 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
```
pip install pygobject
```
Discussion
----------
Please direct non-development questions and discussion topics to our web forum at
https://groups.google.com/forum/#!forum/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:
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.591533.svg)](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.
Raw data
{
"_id": null,
"home_page": "https://librosa.org",
"name": "vflibrosa",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Brian McFee, librosa development team",
"author_email": "brian.mcfee@nyu.edu",
"download_url": "https://files.pythonhosted.org/packages/1d/5c/aaa2c0042436f3af301dd15b79b6a4f27c972af6e22456d004ddcbd0836e/vflibrosa-0.8.1.tar.gz",
"platform": null,
"description": "librosa\n=======\nA python package for music and audio analysis. \n\n[![PyPI](https://img.shields.io/pypi/v/librosa.svg)](https://pypi.python.org/pypi/librosa)\n[![Anaconda-Server Badge](https://anaconda.org/conda-forge/librosa/badges/version.svg)](https://anaconda.org/conda-forge/librosa)\n[![License](https://img.shields.io/pypi/l/librosa.svg)](https://github.com/librosa/librosa/blob/main/LICENSE.md)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.591533.svg)](https://doi.org/10.5281/zenodo.591533)\n\n[![CI](https://github.com/librosa/librosa/actions/workflows/ci.yml/badge.svg)](https://github.com/librosa/librosa/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/librosa/librosa/branch/main/graph/badge.svg?token=ULWnUHaIJC)](https://codecov.io/gh/librosa/librosa)\n\n\nDocumentation\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\nInstallation\n------------\n\nThe latest stable release is available on PyPI, and you can install it by saying\n```\npip install librosa\n```\n\nAnaconda users can install using ``conda-forge``:\n```\nconda install -c conda-forge librosa\n```\n\nTo build librosa from source, say `python setup.py build`.\nThen, to install librosa, say `python setup.py install`.\nIf all went well, you should be able to execute the demo scripts under `examples/`\n(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\npip install -e librosa\n```\nor\n```\ngit clone https://github.com/librosa/librosa.git\npip 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### Hints for the Installation\n\n`librosa` uses `soundfile` and `audioread` to load audio files.\nNote that `soundfile` does not currently support MP3, which will cause librosa to\nfall back on the `audioread` library.\n\n#### soundfile\n\nIf you're using `conda` to install librosa, then most audio coding dependencies (except MP3) 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://pysoundfile.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*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```\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): `apt-get install ffmpeg` or `apt-get install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly`\n* Linux (yum): `yum install ffmpeg` or `yum install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly`\n* Mac: `brew install ffmpeg` or `brew install gstreamer`\n* Windows: download 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```\npip install pygobject\n```\n\nDiscussion\n----------\n\nPlease direct non-development questions and discussion topics to our web forum at\nhttps://groups.google.com/forum/#!forum/librosa\n\n\nCiting\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 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.591533.svg)](https://doi.org/10.5281/zenodo.591533)\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",
"bugtrack_url": null,
"license": "ISC",
"summary": "Python module for audio and music processing",
"version": "0.8.1",
"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": "1d5caaa2c0042436f3af301dd15b79b6a4f27c972af6e22456d004ddcbd0836e",
"md5": "60319515b513c1af5b7e85b632a26825",
"sha256": "fc60e4a1f6cf3d525dbcdeeca5df7ac40397ecda6f8f8c27bf7afa21b033eabc"
},
"downloads": -1,
"filename": "vflibrosa-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "60319515b513c1af5b7e85b632a26825",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 191619,
"upload_time": "2023-11-16T03:00:48",
"upload_time_iso_8601": "2023-11-16T03:00:48.356642Z",
"url": "https://files.pythonhosted.org/packages/1d/5c/aaa2c0042436f3af301dd15b79b6a4f27c972af6e22456d004ddcbd0836e/vflibrosa-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-16 03:00:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "librosa",
"github_project": "librosa",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "vflibrosa"
}