From 608e8249a2815b9332e590750b7f1bfece6901ac Mon Sep 17 00:00:00 2001 From: Colm Date: Tue, 23 Jan 2018 00:25:58 +0000 Subject: [PATCH 1/9] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bd8bf64c..be46aebf 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ which are not available in the official library. Note: librespot only works with Spotify Premium -# THIS FORK +# This fork As the origin is no longer maintained I wanted to have a place for a version of librespot with other peoples forks and features merged. -# THANKS -I've done noting more than make this pretty so big thanks to: +# Credits +I've done nothing more than make this pretty so big thanks to: [plietar](https://github.com/plietar/) for making the thing in the first place. [kingosticks](https://github.com/kingosticks/) for the Suffling and Repeat. [ipha](https://github.com/ipha/) for the start stop audio sink. From 1442e9a1a11b92e37dbf8030d8fc576ff104e44c Mon Sep 17 00:00:00 2001 From: Colm Date: Tue, 23 Jan 2018 19:30:28 +0000 Subject: [PATCH 2/9] Update README.md --- README.md | 76 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index be46aebf..25c80d0d 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ Note: librespot only works with Spotify Premium # This fork As the origin is no longer maintained I wanted to have a place for a version of librespot with other peoples forks and features merged. +# Wiki +More information can befound in the [wiki](https://github.com/ComlOnline/librespot/wiki) # Credits I've done nothing more than make this pretty so big thanks to: @@ -51,80 +53,8 @@ cargo build --release 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 [--initial-volume 20] +target/release/librespot --name DEVICENAME ``` - -### All options - -| Type | Short | Long | Description | Hint | -|----------|-------|---------------------|-------------------------------------------------|-------------| -| Option | c | cache | Path to a directory where files will be cached. | CACHE | -| Flag | | disable-audio-cache | Disable caching of the audio data. | | -| Required | n | name | Device name | NAME | -| Option | | device-type | Displayed device type | DEVICE_TYPE | -| Option | b | bitrate | Bitrate (96, 160 or 320). Defaults to 160 | BITRATE | -| Option | | onstart | Run PROGRAM when playback is about to begin. | | -| Option | | onstop | Run PROGRAM when playback has ended. | PROGRAM | -| Flag | v | verbose | Enable verbose output | PROGRAM | -| Option | u | username | Username to sign in with | USERNAME | -| Option | p | password | Password | PASSWORD | -| Flag | | disable-discovery | Disable discovery mode | | -| Option | | backend | Audio backend to use. Use '?' to list options | BACKEND | -| Option | | device | Audio device to use. Use '?' to list options | DEVICE | -| Option | | mixer | Mixer to use | MIXER | -| Option | | initial-volume | Initial volume in %, once connected [0-100] | VOLUME | - -Taken from here: -https://github.com/ComlOnline/librespot/blob/master/src/main.rs#L88 - -## 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 (compatible e. g. with Raspberry Pi 2 or 3, but not with Raspberry Pi 1 or Zero) 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. From 838523d49de7fac0b59aeabc0fc6120a230cb1f2 Mon Sep 17 00:00:00 2001 From: Colm Date: Tue, 23 Jan 2018 19:31:27 +0000 Subject: [PATCH 3/9] Update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 25c80d0d..b02f1c25 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,6 @@ As the origin is no longer maintained I wanted to have a place for a version of # Wiki More information can befound in the [wiki](https://github.com/ComlOnline/librespot/wiki) -# Credits -I've done nothing more than make this pretty so big thanks to: -[plietar](https://github.com/plietar/) for making the thing in the first place. -[kingosticks](https://github.com/kingosticks/) for the Suffling and Repeat. -[ipha](https://github.com/ipha/) for the start stop audio sink. -[fossedihelm](https://github.com/fossedihelm/) for [addind a default inital volume and options for it](https://github.com/ComlOnline/librespot/pull/5) -[brain0](https://github.com/brain0/) for [making pluseaudio more robust against audio failures](https://github.com/ComlOnline/librespot/pull/6) - ## Building Rust 1.17.0 or later is required to build librespot. @@ -55,6 +47,15 @@ Once you've built *librespot*, run it using : ```shell target/release/librespot --name DEVICENAME ``` + +# Credits +I've done nothing more than make this pretty so big thanks to: +[plietar](https://github.com/plietar/) for making the thing in the first place. +[kingosticks](https://github.com/kingosticks/) for the Suffling and Repeat. +[ipha](https://github.com/ipha/) for the start stop audio sink. +[fossedihelm](https://github.com/fossedihelm/) for [addind a default inital volume and options for it](https://github.com/ComlOnline/librespot/pull/5) +[brain0](https://github.com/brain0/) for [making pluseaudio more robust against audio failures](https://github.com/ComlOnline/librespot/pull/6) + ## Disclaimer Using this code to connect to Spotify's API is probably forbidden by them. Use at your own risk. From 977664f5fe22befd84938a21711ada7d196959b3 Mon Sep 17 00:00:00 2001 From: Colm Date: Tue, 23 Jan 2018 19:31:49 +0000 Subject: [PATCH 4/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b02f1c25..33a8ecd6 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ which are not available in the official library. Note: librespot only works with Spotify Premium -# This fork +## This fork As the origin is no longer maintained I wanted to have a place for a version of librespot with other peoples forks and features merged. # Wiki From b819f632cf9de164d0c6957511ca3095436c8318 Mon Sep 17 00:00:00 2001 From: Colm Date: Tue, 23 Jan 2018 19:32:29 +0000 Subject: [PATCH 5/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 33a8ecd6..fd8ec429 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ As the origin is no longer maintained I wanted to have a place for a version of # Wiki More information can befound in the [wiki](https://github.com/ComlOnline/librespot/wiki) -## Building +# Building Rust 1.17.0 or later is required to build librespot. **If you are building librespot on macOS, the homebrew provided rust may fail due to the way in which homebrew installs rust. In this case, uninstall the homebrew version of rust and use [rustup](https://www.rustup.rs/), and librespot should then build.** @@ -48,7 +48,7 @@ Once you've built *librespot*, run it using : target/release/librespot --name DEVICENAME ``` -# Credits +## Credits I've done nothing more than make this pretty so big thanks to: [plietar](https://github.com/plietar/) for making the thing in the first place. [kingosticks](https://github.com/kingosticks/) for the Suffling and Repeat. From f966440f987b1e9ce9bd4fb785b9ccef97df663d Mon Sep 17 00:00:00 2001 From: Colm Date: Thu, 25 Jan 2018 01:34:56 +0000 Subject: [PATCH 6/9] Updated links and Travis badge --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fd8ec429..881663bb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build Status](https://travis-ci.org/ComlOnline/librespot.svg?branch=master)](https://travis-ci.org/ComlOnline/librespot) +[![Build Status](https://travis-ci.org/librespot-org/librespot.svg?branch=master)](https://travis-ci.org/librespot-org/librespot) # librespot *librespot* is an open source client library for Spotify. It enables @@ -12,7 +12,7 @@ Note: librespot only works with Spotify Premium As the origin is no longer maintained I wanted to have a place for a version of librespot with other peoples forks and features merged. # Wiki -More information can befound in the [wiki](https://github.com/ComlOnline/librespot/wiki) +More information can befound in the [wiki](https://github.com/librespot-org/librespot/wiki) # Building Rust 1.17.0 or later is required to build librespot. @@ -53,8 +53,8 @@ I've done nothing more than make this pretty so big thanks to: [plietar](https://github.com/plietar/) for making the thing in the first place. [kingosticks](https://github.com/kingosticks/) for the Suffling and Repeat. [ipha](https://github.com/ipha/) for the start stop audio sink. -[fossedihelm](https://github.com/fossedihelm/) for [addind a default inital volume and options for it](https://github.com/ComlOnline/librespot/pull/5) -[brain0](https://github.com/brain0/) for [making pluseaudio more robust against audio failures](https://github.com/ComlOnline/librespot/pull/6) +[fossedihelm](https://github.com/fossedihelm/) for [addind a default inital volume and options for it](https://github.com/librespot-org/librespot/pull/5) +[brain0](https://github.com/brain0/) for [making pluseaudio more robust against audio failures](https://github.com/librespot-org/librespot/pull/6) ## Disclaimer Using this code to connect to Spotify's API is probably forbidden by them. From 364f912885eb1880c70e1c709d6c40f245411d86 Mon Sep 17 00:00:00 2001 From: Colm Date: Fri, 26 Jan 2018 21:21:36 +0000 Subject: [PATCH 7/9] Update README.md --- README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index 881663bb..a2b0f4b2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ which are not available in the official library. Note: librespot only works with Spotify Premium ## This fork -As the origin is no longer maintained I wanted to have a place for a version of librespot with other peoples forks and features merged. +As the origin by [plietar](https://github.com/plietar/) is no longer actively maintained I wanted to have a place for a version of librespot with other peoples forks and features merged. # Wiki More information can befound in the [wiki](https://github.com/librespot-org/librespot/wiki) @@ -48,14 +48,6 @@ Once you've built *librespot*, run it using : target/release/librespot --name DEVICENAME ``` -## Credits -I've done nothing more than make this pretty so big thanks to: -[plietar](https://github.com/plietar/) for making the thing in the first place. -[kingosticks](https://github.com/kingosticks/) for the Suffling and Repeat. -[ipha](https://github.com/ipha/) for the start stop audio sink. -[fossedihelm](https://github.com/fossedihelm/) for [addind a default inital volume and options for it](https://github.com/librespot-org/librespot/pull/5) -[brain0](https://github.com/brain0/) for [making pluseaudio more robust against audio failures](https://github.com/librespot-org/librespot/pull/6) - ## Disclaimer Using this code to connect to Spotify's API is probably forbidden by them. Use at your own risk. From 08959c23c41f29c969e67639211ea9a4c433e725 Mon Sep 17 00:00:00 2001 From: Colm Date: Fri, 26 Jan 2018 21:29:24 +0000 Subject: [PATCH 8/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2b0f4b2..596a7edc 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ As the origin by [plietar](https://github.com/plietar/) is no longer actively ma More information can befound in the [wiki](https://github.com/librespot-org/librespot/wiki) # Building -Rust 1.17.0 or later is required to build librespot. +Rust 1.18.0 or later is required to build librespot. **If you are building librespot on macOS, the homebrew provided rust may fail due to the way in which homebrew installs rust. In this case, uninstall the homebrew version of rust and use [rustup](https://www.rustup.rs/), and librespot should then build.** From 1358fc7995382ba9d98510ba277051380a9b9c2c Mon Sep 17 00:00:00 2001 From: Colm Date: Fri, 26 Jan 2018 21:44:57 +0000 Subject: [PATCH 9/9] Typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 596a7edc..277a1b56 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Note: librespot only works with Spotify Premium As the origin by [plietar](https://github.com/plietar/) is no longer actively maintained I wanted to have a place for a version of librespot with other peoples forks and features merged. # Wiki -More information can befound in the [wiki](https://github.com/librespot-org/librespot/wiki) +More information can be found in the [wiki](https://github.com/librespot-org/librespot/wiki) # Building Rust 1.18.0 or later is required to build librespot.