github-mirrors/librespot
1
0
Fork 0
mirror of https://github.com/librespot-org/librespot.git synced 2024-09-19 16:08:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Open Source Spotify client library
139 commits 4 branches 12 tags 7.1 MiB
Rust 97.9%
Shell 0.9%
Dockerfile 0.8%
Python 0.4%
Go to file
Paul Lietar 03634e0149 Add optional clippy dependency.
2016-03-16 00:23:17 +00:00
cache Fixes compilation errors 2015-12-18 19:59:10 +00:00
capi Intern returned C strings to avoid leaking them. 2016-02-05 21:11:55 +00:00
docs Add Facebook authentication protocol docs. 2016-03-16 00:23:03 +00:00
protocol Support building with rust stable, using syntex. 2016-03-07 18:22:41 +00:00
src Add Facebook based login. 2016-03-16 00:05:05 +00:00
.gitignore Add README with build and run instructions. 2015-07-14 23:27:03 +01:00
.travis.yml Add Facebook based login. 2016-03-16 00:05:05 +00:00
build.rs Support building with rust stable, using syntex. 2016-03-07 18:22:41 +00:00
Cargo.lock Add Facebook based login. 2016-03-16 00:05:05 +00:00
Cargo.toml Add optional clippy dependency. 2016-03-16 00:23:17 +00:00
LICENSE Initial commit. 2015-04-25 21:32:07 +01:00
README.md Add Facebook based login. 2016-03-16 00:05:05 +00:00

README.md

librespot

librespot is an open source client library for Spotify. It enables applications to use Spotify's service, without using the official but closed-source libspotify. Additionally, it will provide extra features which are not available in the official library.

Status

librespot is currently under development and is not fully functional yet. You are however welcome to experiment with it.

Building

Rust 1.7.0 or later is required to build librespot.

It also requires a C and C++ toolchain, with libprotoc and portaudio.

On debian / ubuntu, the following command will install these dependencies :

sudo apt-get install build-essential portaudio19-dev libprotoc-dev

On OS X, using homebrew :

brew install portaudio protobuf

Once you've cloned this repository you can build librespot 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 --appkey APPKEY --username USERNAME --cache CACHEDIR --name DEVICENAME

Discovery mode

librespot can be run in discovery mode, in which case no password is required at startup. dns-sd or avahi's compatibility layer is required for this. On debian/ubuntu this is the libavahi-compat-libdnssd-dev package. It come preinstalled on OS X.

It must be enabled at build time :

cargo build --release --features discovery

When running librespot simply omit the --username argument.

Facebook Accounts

librespot can be built with Facebook authentication support. OpenSSL is required for this.

cargo build --release --features facebook
target/release/librespot --appkey APPKEY --cache CACHEDIR --name DEVICENAME --facebook

This will print a link to the console, which must be visited on the same computer librespot is running on.

Development

When developing librespot, it is preferable to use Rust nightly, and build it using the following :

cargo build --no-default-features

This produces better compilation error messages than with the default configuration.

Disclaimer

Using this code to connect to Spotify's API is probably forbidden by them, and might result in you application key getting banned. Use at you own risk

Contact

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

License

Everything in this repository is licensed under the MIT license.