Multi Player Support

documentation/developers/status.md

@@ -27,7 +27,6 @@ Topics marked _in progress_ are already in the process of implementation by comm
     - [Volume](#volume)
     - [GPIO](#gpio)
     - [WLAN](#wlan)
-    - [Spotify](#spotify)
     - [Others](#others)
     - [Start-up stuff](#start-up-stuff)
   - [Debug Tools](#debug-tools)

installation/routines/setup_jukebox_core.sh

@@ -95,6 +95,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"
 }
 

requirements.txt

@@ -19,6 +19,8 @@ ruamel.yaml
 requests
 # For the publisher event reactor loop:
 tornado
+# for collecting audiofiles
+pyyaml
 
 # RPi's GPIO packages:
 RPi.GPIO

resources/default-settings/jukebox.default.yaml

@@ -11,7 +11,7 @@ modules:
     jingle: jingle
     jingle.alsawave: jingle.alsawave
     jingle.jinglemp3: jingle.jinglemp3
-    player: playermpd
+    player: player.plugin
     cards: rfid.cards
     rfid: rfid.reader
     timers: timers
@@ -76,23 +76,6 @@ jinglemp3:
 alsawave:
   # Config of the Wave through ALSA Jingle Service
   device: default
-playermpd:
-  host: localhost
-  status_file: ../../shared/settings/music_player_status.json
-  second_swipe_action:
-    # Note: Does not follow the RPC alias convention (yet)
-    # Must be one of: 'toggle', 'play', 'skip', 'rewind', 'replay', 'none'
-    alias: toggle
-  library:
-    update_on_startup: true
-    check_user_rights: true
-  mpd_conf: ~/.config/mpd/mpd.conf
-  # Must be one of: 'none', 'stop', 'rewind':
-  end_of_playlist_next_action: none
-  # Must be one of: 'none', 'prev', 'rewind':
-  stopped_prev_action: prev
-  # Must be one of: 'none', 'next', 'rewind':
-  stopped_next_action: next
 rpc:
   tcp_port: 5555
   websocket_port: 5556

resources/default-settings/player.default.yaml

@@ -0,0 +1,17 @@
+# IMPORTANT:
+# Always use relative path from settingsfile `../../`, but do not use relative paths with `~/`.
+# Sole (!) exception is in playermpd.mpd_conf
+players:
+  content:
+    audiofile: /../../shared/audiofolders/audiofiles.yaml
+playermpd:
+  host: localhost
+  status_file: ../../shared/settings/music_player_status.json
+  second_swipe_action:
+    # Note: Does not follow the RPC alias convention (yet)
+    # Must be one of: 'toggle', 'play', 'skip', 'rewind', 'replay', 'none'
+    alias: toggle
+  library:
+    update_on_startup: true
+    check_user_rights: true
+  mpd_conf: ~/.config/mpd/mpd.conf

src/jukebox/components/player/backends/__init__.py

@@ -0,0 +1,96 @@
+from abc import ABC, abstractmethod
+
+
+class BackendPlayer(ABC):
+    """
+    Abstract Class to inherit, so that you can build a proper new Player
+    """
+
+    @abstractmethod
+    def next(self):
+        pass
+
+    @abstractmethod
+    def prev(self):
+        pass
+
+    @abstractmethod
+    def play(self):
+        pass
+
+    @abstractmethod
+    def play_single(self, uri):
+        pass
+
+    @abstractmethod
+    def play_album(self, albumartist, album):
+        pass
+
+    @abstractmethod
+    def play_folder(self, folder: str, recursive: bool):
+        """
+        Playback a music folder.
+
+        :param folder: Folder path relative to music library path
+        :param recursive: Add folder recursively
+        """
+        pass
+
+    @abstractmethod
+    def toggle(self):
+        pass
+
+    @abstractmethod
+    def shuffle(self):
+        pass
+
+    @abstractmethod
+    def pause(self):
+        pass
+
+    @abstractmethod
+    def stop(self):
+        pass
+
+    @abstractmethod
+    def get_queue(self):
+        pass
+
+    @abstractmethod
+    def repeat(self):
+        pass
+
+    @abstractmethod
+    def seek(self):
+        pass
+
+    @abstractmethod
+    def get_albums(self):
+        pass
+
+    @abstractmethod
+    def get_single_coverart(self, song_url):
+        pass
+
+    @abstractmethod
+    def get_album_coverart(self):
+        pass
+
+    @abstractmethod
+    def list_dirs(self):
+        pass
+
+    @abstractmethod
+    def get_song_by_url(self, song_url):
+        pass
+
+    @abstractmethod
+    def get_folder_content(self, folder):
+        """
+        Get the folder content as content list with meta-information. Depth is always 1.
+
+        Call repeatedly to descend in hierarchy
+
+        :param folder: Folder path relative to music library path
+        """
+        pass