simple_kivy.py

"""
simple_kivy Example
====================================================
This example demonstrates a simple use of the AirplayListener and AirplayRemote.
It shows a window with the current artwork, song title, artist and album.
Additionally it displays five buttons to control the playback.
"""
import logging
loggers = ["ShairportLogger", "AirplayListenerLogger", "AirplayServiceListenerLogger"]

fh = logging.FileHandler("airplay2file.log")
fh.setLevel(logging.DEBUG)

for logger_name in loggers:
    logger = logging.getLogger(logger_name)
    logger.propagate = False
    logger.addHandler(fh)

from kivy.app import App
from kivy.lang import Builder
from kivy.properties import StringProperty, ObjectProperty # pylint: disable=E0611
from kivy.uix.boxlayout import BoxLayout
from kivy.clock import mainthread

from shairportmetadatareader import AirplayUDPListener

Builder.load_string("""

#:import AirplayCommand shairportmetadatareader.AirplayCommand

<RootLayout>:
    artist: "artist"
    title: "title"
    album: "album"
    artwork: "" # for some reason this string must no be empty, otherwise changing the artwork crashes the app

    orientation: 'vertical'

    BoxLayout:
        size_hint_y: 0.8
        orientation: 'horizontal'
        
        AsyncImage:
            source: root.artwork
        
        BoxLayout:
            orientation: 'vertical'
            
            Label:
                text: root.title
            Label:
                text: root.artist
            Label:
                text: root.album               

    BoxLayout:
        size_hint_y: 0.2
        orientation: 'horizontal'
    
        Button:
            text: 'Play'
            disabled: root.remote is None
            on_press: root.remote.send_command(AirplayCommand.PLAY)
        Button:
            text: 'Pause'
            disabled: root.remote is None
            on_press: root.remote.send_command(AirplayCommand.PAUSE)
        Button:
            text: 'Stop'
            disabled: root.remote is None
            on_press: root.remote.send_command(AirplayCommand.STOP)
        Button:
            text: '<<'
            disabled: root.remote is None
            on_press: root.remote.send_command(AirplayCommand.PREVIOUS_SONG)
        Button:
            text: '>>'
            disabled: root.remote is None
            on_press: root.remote.send_command(AirplayCommand.NEXT_SONG)
""")


class RootLayout(BoxLayout):
    """
    Main application layout containing the information and control widgets.
    """
    # metadata information
    title = StringProperty("")
    artist = StringProperty("")
    album = StringProperty("")
    artwork = StringProperty("")

    # remote to control airplay playback
    remote = ObjectProperty(None, allownone=True)

    def on_track_info(self, listener, info):
        """
        Called when the current track information changes.
        :param listener: airplaylistener instance
        :param info: new track information
        """
        # pylint: disable=W0613
        self.title = info["itemname"] if "itemname" in info else "title"
        self.album = info["songalbum"] if "songalbum" in info else "album"
        self.artist = info["songartist"] if "songartist" in info else "artist"

    @mainthread
    def on_artwork(self, listener, artwork):
        """
        Called when the current artwork changes.
        :param listener: airplaylistener instance
        :param artwork: path to new artwork file
        """
        # pylint: disable=W0613
        self.artwork = artwork

    def on_has_remote(self, listener, has_remote):
        """
        Called when all data to create an airplay remote is available.
        :param listener: airplaylistener instance
        :param has_remote: True if all remote data is available, False otherwise
        """
        if has_remote:
            # this might block the gui for 5 seconds
            self.remote = listener.get_remote(timeout=5)
        else:
            self.remote = None


class MusicPlayer(App):
    """
    Main kivy application to display shairport information and control the corresponding airplay device.
    """
    listener = ObjectProperty(None)

    def build(self):
        self.root = RootLayout()

        # start shairport-sync and listen for airplay events
        self.listener = AirplayUDPListener()
        self.listener.bind(track_info=self.root.on_track_info,
                           artwork=self.root.on_artwork,
                           has_remote_data=self.root.on_has_remote)
        self.listener.start_listening()

        return self.root

    def on_stop(self):
        # stop listening for events an close shairport-sync
        self.listener.stop_listening()


if __name__ == '__main__':
    MusicPlayer().run()