mirror of
https://github.com/librespot-org/librespot.git
synced 2024-12-18 17:11:53 +00:00
106 lines
3.6 KiB
Markdown
106 lines
3.6 KiB
Markdown
# 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.
|
|
|
|
**I will be very busy with other stuff until July, and won't be able to
|
|
dedicate much time to librespot. Please keep using it and open issues,
|
|
but it's likely I won't be able to answer them until then. Non-trivial
|
|
pull requests will probably not be reviewed either.**
|
|
|
|
## Building
|
|
Rust 1.15.0 or later is required to build librespot.
|
|
|
|
It also requires a C, with portaudio.
|
|
|
|
On debian / ubuntu, the following command will install these dependencies :
|
|
```shell
|
|
sudo apt-get install build-essential portaudio19-dev
|
|
```
|
|
|
|
On Fedora systems, the following command will install these dependencies :
|
|
```shell
|
|
sudo dnf install portaudio-devel make gcc
|
|
```
|
|
|
|
On OS X, using homebrew :
|
|
```shell
|
|
brew install portaudio
|
|
```
|
|
|
|
Once you've cloned this repository you can build *librespot* using `cargo`.
|
|
```shell
|
|
cargo build --release
|
|
```
|
|
|
|
## Usage
|
|
A sample program implementing a headless Spotify Connect receiver is provided.
|
|
Once you've built *librespot*, run it using :
|
|
```shell
|
|
target/release/librespot --username USERNAME --cache CACHEDIR --name DEVICENAME
|
|
```
|
|
|
|
## Discovery mode
|
|
*librespot* can be run in discovery mode, in which case no password is required at startup.
|
|
For that, simply omit the `--username` argument.
|
|
|
|
## Audio Backends
|
|
*librespot* supports various audio backends. Multiple backends can be enabled at compile time by enabling the
|
|
corresponding cargo feature. By default, only PortAudio is enabled.
|
|
|
|
A specific backend can selected at runtime using the `--backend` switch.
|
|
|
|
```shell
|
|
cargo build --features portaudio-backend
|
|
target/release/librespot [...] --backend portaudio
|
|
```
|
|
|
|
The following backends are currently available :
|
|
- ALSA
|
|
- PortAudio
|
|
- PulseAudio
|
|
|
|
## Cross-compiling
|
|
A cross compilation environment is provided as a docker image.
|
|
Build the image from the root of the project with the following command :
|
|
|
|
```
|
|
$ docker build -t librespot-cross -f contrib/Dockerfile .
|
|
```
|
|
|
|
The resulting image can be used to build librespot for linux x86_64, armhf and armel.
|
|
The compiled binaries will be located in /tmp/librespot-build
|
|
|
|
```
|
|
docker run -v /tmp/librespot-build:/build librespot-cross
|
|
```
|
|
|
|
If only one architecture is desired, cargo can be invoked directly with the appropriate options :
|
|
```shell
|
|
docker run -v /tmp/librespot-build:/build librespot-cross cargo build --release --no-default-features --features alsa-backend
|
|
docker run -v /tmp/librespot-build:/build librespot-cross cargo build --release --target arm-unknown-linux-gnueabihf --no-default-features --features alsa-backend
|
|
docker run -v /tmp/librespot-build:/build librespot-cross cargo build --release --target arm-unknown-linux-gnueabi --no-default-features --features alsa-backend
|
|
```
|
|
|
|
Don't forget to set the `with-tremor` feature flag if your target device does not have floating-point capabilities.
|
|
|
|
## Development
|
|
When developing *librespot*, it is preferable to use Rust nightly, and build it using the following :
|
|
```shell
|
|
cargo build --no-default-features --features "nightly portaudio-backend"
|
|
```
|
|
|
|
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.
|
|
Use at your 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.
|
|
|