Plugins: dcopResponder.py

# -*- coding: utf-8 -*-
# Copyright 2007 Andy Caldwell <andrew.caldwell at sjc.ox.ac.uk>
#
#
# This plugin allows KDE applications (initially designed for KMess) to
# communicate with QuodLibet through DCOP calls.  It currently responds to
# the following DCOP requests:
#
#   + artist()  - returns current artist
#   + album()   - returns current album
#   + title()   - returns current track title
#   + playing() - returns true if a track is currently playing and false
#                 if the current track is paused or stopped
#
# These functions can easily be added to.  Just add to the DCopServer's
# self.setMethods arguments and add the respective functions to its
# methods.  DCOP calls can take strings, integers or bools as arguments
# and can return strings, integers, bools or void.
#
# As it stands, the plugin is running all the time.  Even if it is
# disabled in the plugins menu.  This should really be changed...
#
# ------------------------------------------------------------------------
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation


# pcop must be imported before pydcop (prevents segfault)
import pcop
import pydcop
from time import sleep
import threading
from player import playlist as player
from parse import XMLFromPattern
from plugins.events import EventPlugin

class DCopResponder(EventPlugin):
    PLUGIN_ID = "DCopResponder"
    PLUGIN_NAME = _("DCOP Responder")
    PLUGIN_DESC = _("Reply to DCOP calls from external KDE apps.\n"
                    "By Andy Caldwell")
    PLUGIN_VERSION = "0.1"

    def __init__(self):
        self.appid = pydcop.registerAs('QuodLibet')
        self.server = DCopServer()
        self.firststart = True
        if player.song is not None:
            self.server.artist = player.song["artist"]
            self.server.title = player.song["title"]
            self.server.album = player.song["album"]
            self.server.playing = False
    
    def enabled(self):
        self.server.setEnabled(True)
    
    def disabled(self):
        self.server.setEnabled(False)
        
    def plugin_on_song_started(self, song):
        self.server.song = song
        self.server.artist = song["artist"]
        self.server.title = song["title"]
        self.server.album = song["album"]
        if self.firststart:
            self.firststart = False
        else:
            self.server.playing = True

    def plugin_on_song_ended(self, song, stopped):
        if stopped:
            self.server.playing = False

    def plugin_on_paused(self):
        self.server.playing = False

    def plugin_on_unpaused(self):
        self.server.playing = True

class DCopServer(pydcop.DCOPServerObject):
    def __init__(self):
        pydcop.DCOPServerObject.__init__(self,'quodlibet')
        self.setMethods( [
            ('QString artist()', self.getArtist),
            ('QString album()', self.getAlbum),
            ('QString title()', self.getTitle),
            ('bool playing()', self.isPlaying)
            ] )
        self._enabled = False
        self.playing = False
        self.song = ""
        self.artist = ""
        self.title = ""
        self.album = ""
        self.DCopEventProcessor = DCopEventProcessLoop()
        self.DCopEventProcessor.setDaemon(True)
        self.DCopEventProcessor.start()
        
    def getArtist(self):
        return str(self.artist)
    
    def getAlbum(self):
        return str(self.album)
    
    def getTitle(self):
        return str(self.title)
    
    def isPlaying(self):
        return self.playing

    def setEnabled(self, state):
        self._enabled = state

class DCopEventProcessLoop(threading.Thread):
    def run(self):
        while 1:
            sleep(0.01)
            pydcop.processEvents()