#spotify

bin+lib librespot

An open source client library for Spotify, with support for Spotify Connect

3 unstable releases

✓ Uses Rust 2018 edition

0.1.1 Jan 30, 2020
0.1.0 Nov 6, 2019
0.0.0 Feb 24, 2018

#4 in #spotify

Download history 31/week @ 2019-12-02 37/week @ 2019-12-09 53/week @ 2019-12-16 51/week @ 2019-12-23 50/week @ 2019-12-30 432/week @ 2020-01-06 1031/week @ 2020-01-13 890/week @ 2020-01-20 665/week @ 2020-01-27 667/week @ 2020-02-03 645/week @ 2020-02-10 547/week @ 2020-02-17 764/week @ 2020-02-24 772/week @ 2020-03-02 644/week @ 2020-03-09 744/week @ 2020-03-16

1,062 downloads per month
Used in spotifyd

MIT license

41KB
547 lines

Build Status Gitter chat Crates.io

Current maintainer is @awiouy folks.

librespot

librespot is an open source client library for Spotify. It enables applications to use Spotify's service to control and play music via various backends, and to act as a Spotify Connect receiver. It is an alternative to the official and now deprecated closed-source libspotify. Additionally, it will provide extra features which are not available in the official library.

Note: librespot only works with Spotify Premium. This will remain the case for the foreseeable future, as we are unlikely to work on implementing the features such as limited skips and adverts that would be required to make librespot compliant with free accounts.

Quick start

We're available on crates.io as the librespot package. Simply run cargo install librespot to install librespot on your system. Check the wiki for more info and possible usage options.

After installation, you can run librespot from the CLI using a command such as librespot -n "Librespot Speaker" -b 160 to create a speaker called Librespot Speaker serving 160kbps audio.

This fork

As the origin by plietar is no longer actively maintained, this organisation and repository have been set up so that the project may be maintained and upgraded in the future.

Documentation

Documentation is currently a work in progress, contributions are welcome!

There is some brief documentation on how the protocol works in the docs folder,

COMPILING.md contains detailed instructions on setting up a development environment, and compiling librespot. More general usage and compilation information is available on the wiki. CONTRIBUTING.md also contains our contributing guidelines.

If you wish to learn more about how librespot works overall, the best way is to simply read the code, and ask any questions you have in our Gitter Room.

Issues

If you run into a bug when using librespot, please search the existing issues before opening a new one. Chances are, we've encountered it before, and have provided a resolution. If not, please open a new one, and where possible, include the backtrace librespot generates on crashing, along with anything we can use to reproduce the issue, eg. the Spotify URI of the song that caused the crash.

Building

A quick walk through of the build process is outlined here, while a detailed compilation guide can be found here.

Additional Dependencies

We recently switched to using Rodio for audio playback by default, hence for macOS and Windows, you should just be able to clone and build librespot (with the command below). For Linux, you will need to run the additional commands below, depending on your distro.

On Debian/Ubuntu, the following command will install these dependencies :

sudo apt-get install build-essential libasound2-dev

On Fedora systems, the following command will install these dependencies :

sudo dnf install alsa-lib-devel make gcc

librespot currently offers the a selection of audio backends.

Rodio (default)
ALSA
PortAudio
PulseAudio
JACK
SDL
Pipe

Please check the corresponding compiling entry for backend specific dependencies.

Once you've installed the dependencies and cloned this repository you can build librespot with the default backend using Cargo.

cargo build --release

Usage

A sample program implementing a headless Spotify Connect receiver is provided. Once you've built librespot, run it using :

target/release/librespot --name DEVICENAME

The above is a minimal example. Here is a more fully fledged one:

target/release/librespot -n "Librespot" -b 320 -c ./cache --enable-volume-normalisation --initial-volume 75 --device-type avr

The above command will create a receiver named Librespot, with bitrate set to 320kbps, initial volume at 75%, with volume normalisation enabled, and the device displayed in the app as an Audio/Video Receiver. A folder named cache will be created/used in the current directory, and be used to cache audio data and credentials.

A full list of runtime options are available here

Contact

Come and hang out on gitter if you need help or want to offer some. https://gitter.im/librespot-org/spotify-connect-resources

Disclaimer

Using this code to connect to Spotify's API is probably forbidden by them. Use at your own risk.

License

Everything in this repository is licensed under the MIT license.

Related Projects

This is a non exhaustive list of projects that either use or have modified librespot. If you'd like to include yours, submit a PR.

Dependencies

~24MB
~367K SLoC