Multi Player Support

ci/installation/run_install_common.sh

@@ -21,6 +21,7 @@ export ENABLE_WEBAPP_PROD_DOWNLOAD=true
 # n - deactivate bluetooth
 # n - disable on-chip audio
 # - - mpd overwrite config (only with existing installation)
+# n - setup Spotify
 # n - setup rfid reader
 # y - setup samba
 # y - setup webapp
@@ -36,6 +37,7 @@ n
 n
 n
 n
+n
 y
 y
 n

ci/installation/run_install_faststartup.sh

@@ -19,6 +19,7 @@ LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
 # y - deactivate bluetooth
 # y - disable on-chip audio
 # - - mpd overwrite config (only with existing installation)
+# n - setup Spotify
 # n - setup rfid reader
 # n - setup samba
 # n - setup webapp
@@ -36,4 +37,5 @@ n
 n
 n
 n
+n
 '

docker/config/docker.mpd.conf

@@ -11,7 +11,7 @@
 # be disabled and audio files will only be accepted over ipc socket (using
 # file:// protocol) or streaming files over an accepted protocol.
 #
-music_directory		        "/home/pi/RPi-Jukebox-RFID/shared/audiofolders"
+music_directory		        "~/RPi-Jukebox-RFID/shared/audiofolders"
 #
 # This setting sets the MPD internal playlist directory. The purpose of this
 # directory is storage for playlists created by MPD. The server will use
@@ -98,7 +98,7 @@ port				"6600"
 # argument is recommended for troubleshooting, though can quickly stretch
 # available resources on limited hardware storage.
 #
-log_level			"default"
+log_level			"verbose"
 #
 # Setting "restore_paused" to "yes" puts MPD into pause mode instead
 # of starting playback after startup.

docker/config/docker.spotifyd.conf

@@ -0,0 +1,13 @@
+[global]
+username = USER
+password = PASS
+backend = pulse
+device = default # Given by `aplay -L`
+mixer = PCM
+volume-control = alsa # or alsa_linear, or softvol
+#onevent = command_run_on_playback_event
+device_name = phoniebox_docker # Cannot contain spaces
+bitrate = 160
+cache_path = cache_directory
+volume-normalisation = true
+normalisation-pregain = -10

docker/docker-compose.linux.yml

@@ -10,9 +10,9 @@ services:
     environment:
       - PULSE_SERVER=unix:/tmp/pulse-sock
     volumes:
-      - ../shared/audiofolders:/home/pi/RPi-Jukebox-RFID/shared/audiofolders
-      - ../shared/playlists:/home/pi/.config/mpd/playlists
-      - ./config/docker.pulse.mpd.conf:/home/pi/.config/mpd/mpd.conf
+      - ../shared/audiofolders:${HOME}/RPi-Jukebox-RFID/shared/audiofolders
+      - ../shared/playlists:${HOME}/.config/mpd/playlists
+      - ./config/docker.pulse.mpd.conf:${HOME}/.config/mpd/mpd.conf
       - $XDG_RUNTIME_DIR/pulse/native:/tmp/pulse-sock
 
   jukebox:
@@ -24,6 +24,6 @@ services:
     environment:
       - PULSE_SERVER=unix:/tmp/pulse-sock
     volumes:
-      - ../shared:/home/pi/RPi-Jukebox-RFID/shared
-      - ./config/docker.pulse.mpd.conf:/home/pi/.config/mpd/mpd.conf
+      - ../shared:${HOME}/RPi-Jukebox-RFID/shared
+      - ./config/docker.pulse.mpd.conf:${HOME}/.config/mpd/mpd.conf
       - $XDG_RUNTIME_DIR/pulse/native:/tmp/pulse-sock

docker/docker-compose.yml

@@ -37,6 +37,7 @@ services:
       - 5555:5555
       - 5556:5556
       - 5557:5557
+      - 3001:3001
     restart: unless-stopped
     tty: true
     volumes:
@@ -61,3 +62,18 @@ services:
     volumes:
       - ../src/webapp:/home/node/webapp
       - /home/node/webapp/node_modules
+
+  spotifyd:
+      build:
+          context: ../
+          dockerfile: ./docker/spotifyd.Dockerfile
+      container_name: spotifyd
+      ports:
+          - 1234:1234
+      restart: unless-stopped
+      environment:
+          - PULSE_SERVER=unix:/tmp/pulseaudio.socket
+          - PULSE_COOKIE=/tmp/pulseaudio.cookie
+      volumes:
+          - ../shared/spotify/docker.spotifyd.conf:/etc/spotifyd.conf
+          - $XDG_RUNTIME_DIR/pulse/native:/tmp/pulseaudio.socket

docker/jukebox.Dockerfile

@@ -4,6 +4,7 @@ FROM debian:bullseye-slim
 # Raspberry Pi environment as possible.
 RUN apt-get update && apt-get install -y \
     libasound2-dev \
+    libzmq3-dev \
     pulseaudio \
     pulseaudio-utils \
     --no-install-recommends \
@@ -21,16 +22,17 @@ RUN usermod -aG pulse ${USER}
 # Install all Jukebox dependencies
 RUN apt-get update && apt-get install -qq -y \
     --allow-downgrades --allow-remove-essential --allow-change-held-packages \
-    gcc at wget \
+    g++ at wget \
     espeak mpc mpg123 git ffmpeg spi-tools netcat \
     python3 python3-venv python3-dev python3-mutagen
 
+USER ${USER}
+WORKDIR ${HOME}
+
 ENV VIRTUAL_ENV=${INSTALLATION_PATH}/.venv
 RUN python3 -m venv $VIRTUAL_ENV
 ENV PATH="$VIRTUAL_ENV/bin:$PATH"
 
-USER ${USER}
-WORKDIR ${HOME}
 COPY --chown=${USER}:${USER} . ${INSTALLATION_PATH}/
 
 RUN pip install --no-cache-dir -r ${INSTALLATION_PATH}/requirements.txt
@@ -45,7 +47,8 @@ RUN [ "$(uname -m)" = "aarch64" ] && ARCH="arm64" || ARCH="$(uname -m)"; \
     rm -f libzmq.tar.gz;
 
 RUN export ZMQ_PREFIX=${PREFIX} && export ZMQ_DRAFT_API=1
-RUN pip install -v --no-binary pyzmq --pre pyzmq
+#RUN pip install -v --no-binary pyzmq --pre pyzmq
+RUN pip install -v --no-binary=:all: pyzmq --pre pyzmq
 
 EXPOSE 5555 5556
 

docker/spotifyd.Dockerfile

@@ -0,0 +1,40 @@
+#An extra layer to get around this bug https://github.com/docker/buildx/issues/395
+#It's there simply to download add required libraries for cargo build
+FROM --platform=$BUILDPLATFORM rust:bullseye AS rust_fix
+
+ENV USER=root
+ENV V_spotifyd=v0.3.5
+
+WORKDIR /usr/src/spotifyd
+RUN apt-get -y update && \
+    apt-get install --no-install-recommends -y apt-transport-https ca-certificates git && \
+    git clone --depth 1 --branch=${V_spotifyd} https://github.com/Spotifyd/spotifyd.git .
+
+# Don't do `cargo init` or --> error: `cargo init` cannot be run on existing Cargo packages
+# RUN cargo init
+RUN mkdir -p .cargo \
+  && cargo vendor > .cargo/config
+
+FROM rust:bullseye as build
+
+RUN apt-get -y update && \
+    apt-get install --no-install-recommends -y libasound2-dev build-essential pulseaudio libpulse-dev libdbus-1-dev
+
+COPY --from=rust_fix /usr/src/spotifyd /usr/src/spotifyd
+WORKDIR /usr/src/spotifyd
+
+RUN cargo build -j 2 --release --features pulseaudio_backend,dbus_mpris --offline
+
+FROM debian:bullseye-slim as release
+
+CMD ["dbus-run-session", "/usr/bin/spotifyd", "--no-daemon"]
+
+RUN apt-get update && \
+    apt-get install -yqq --no-install-recommends libasound2 pulseaudio dbus libssl1.1 && \
+    rm -rf /var/lib/apt/lists/* && \
+    groupadd -r spotify && \
+    useradd --no-log-init -r -g spotify -G audio spotify
+
+COPY --from=build /usr/src/spotifyd/target/release/spotifyd /usr/bin/
+
+USER spotify

documentation/builders/README.md

@@ -9,6 +9,7 @@
 ## Configuration
 
 * [Audio](./audio.md)
+* [Spotify](./spotify.md)
 * [RFID](./rfid.md)
 * [Card Database](./card-database.md)
 * [Troubleshooting](./troubleshooting.md)

documentation/builders/spotify.md

@@ -0,0 +1,39 @@
+# Spotify Integration
+
+The Spotify integration allows to play music directly from Spotify.
+
+> [!IMPORTANT]
+> You need a Spotify Premium subscription to use this functionality
+
+## Needed credentials
+
+For the spotifyd daemon, you need to provide username and password of your Spotify account
+during installation. This is used to enable the Phoniebox to play music from Spotify.
+
+To control the playback (spotipy), you need to create an app as Spotify developer and provide the
+`client_id` and `client_secret` therefore follow the steps:
+
+1. Access [Developers Dashboard](https://developer.spotify.com/dashboard)
+2. Create an App via the button on the top right
+3. Fill in following fields:
+    - App name: `your_desired_name`
+    - Redirect URI: `http://localhost:3001`
+4. Save the `client_id` and `client_secret` for the installation
+
+## Post installation configuration
+### spotifyd
+
+The spotifyd daemon is using the username and password of your Spotify account.
+
+If the credentials have changed, you can update them in the config file located at `/etc/spotifyd.conf`
+
+### spotipy
+
+Spotipy is using `client_id` and `client_secret` to control the playback of the Phoniebox.
+
+To update the credentials, please modify the file located at `~/RPi-Jukebox-RFID/shared/settings/player.yaml`
+
+## Resources
+
+- [spotifyd](https://spotifyd.rs/)
+- [spotipy](https://spotipy.readthedocs.io)

installation/includes/01_default_config.sh

@@ -11,6 +11,11 @@ DISABLE_SSH_QOS=true
 DISABLE_BOOT_SCREEN=true
 DISABLE_BOOT_LOGS_PRINT=true
 SETUP_MPD=true
+ENABLE_SPOTIFY=false
+SPOT_USERNAME=NONE
+SPOT_PASSWORD=NONE
+SPOT_CLIENT_ID=NONE
+SPOT_CLIENT_SECRET=NONE
 ENABLE_MPD_OVERWRITE_INSTALL=true
 UPDATE_RASPI_OS=${UPDATE_RASPI_OS:-"true"}
 ENABLE_RFID_READER=true

installation/routines/customize_options.sh

@@ -142,6 +142,58 @@ Would you like to overwrite your configuration? [Y/n]"
     fi
 }
 
+_option_spotify() {
+  # ENABLE_SPOTIFY
+  clear_c
+  print_c "---------------------- SPOTIFY ----------------------
+
+Installs an additional player, so that you can
+play music from spotify. You will need to create
+an app in the Spotify developer dashboard to use
+Spotify properly
+
+Note: Spotify Premium is needed to operate player!
+
+
+Do you want to enable the spotify player? [y/N]"
+  read -r response
+  case "$response" in
+    [yY][eE][sS]|[yY])
+      ENABLE_SPOTIFY=true
+      ;;
+    *)
+      ;;
+  esac
+
+  if [ "$ENABLE_SPOTIFY" = true ]; then
+      print_c "To configure Spotify properly, you need to create
+an App at https://developer.spotify.com/dashboard and provide the
+client_id and client_secret in the following prompts."
+      print_c ""
+      print_c ""
+      print_c "Please provide the Spotify username"
+      read -r response_username
+      SPOT_USERNAME="${response_username}"
+
+      print_c "Please provide the Spotify password"
+      read -r response_password
+      SPOT_PASSWORD="${response_password}"
+
+      print_c "Please provide the client_id of the Spotify App"
+      read -r response_client_id
+      SPOT_CLIENT_ID="${response_client_id}"
+
+      print_c "Please provide the client_secret of the Spotify App"
+      read -r response_client_secret
+      SPOT_CLIENT_SECRET="${response_client_secret}"
+  fi
+
+  log "ENABLE_SPOTIFY=${ENABLE_SPOTIFY}"
+  if [ "$ENABLE_SPOTIFY" = true ]; then
+    log "Spotify service will be enabled with username ${SPOT_USERNAME} and client_id ${SPOT_CLIENT_ID}"
+  fi
+}
+
 _option_rfid_reader() {
   # ENABLE_RFID_READER
   clear_c
@@ -328,6 +380,7 @@ _run_customize_options() {
   _option_bluetooth
   _option_disable_onboard_audio
   _option_mpd
+  _option_spotify
   _option_rfid_reader
   _option_samba
   _option_webapp

installation/routines/install.sh

@@ -8,6 +8,7 @@ install() {
   init_git_repo_from_tardir
   setup_jukebox_core
   setup_mpd
+  setup_spotifyd
   setup_samba
   setup_jukebox_webapp
   setup_kiosk_mode

installation/routines/setup_jukebox_core.sh

@@ -108,6 +108,7 @@ _jukebox_core_build_and_install_pyzmq() {
 _jukebox_core_install_settings() {
   print_lc "  Register Jukebox settings"
   cp -f "${INSTALLATION_PATH}/resources/default-settings/jukebox.default.yaml" "${SETTINGS_PATH}/jukebox.yaml"
+  cp -f "${INSTALLATION_PATH}/resources/default-settings/player.default.yaml" "${SETTINGS_PATH}/player.yaml"
   cp -f "${INSTALLATION_PATH}/resources/default-settings/logger.default.yaml" "${SETTINGS_PATH}/logger.yaml"
 }