Merge lp:~gabor-karsay/awn-extras/awnmediaplayers into lp:awn-extras

[Gabor Karsay]

mhr3, do you approve?

It's only about awnmediaplayes.py.

* It adds support for mediaplayers Clementine and Guayadeque and detects and launches already supported players Amarok, Audacious and VLC (searching for the binaries in path). I could have added more, but they are either not in Ubuntu repositories, so I couldn't/didn't want to test, or they have no GUI and are run from commandline. (Amarok launches, but it goes crazy in my Gnome environment.)

* Rhythmbox does not show artwork sometimes. I found the main reason, at least on my system: It doesn't show any artwork that has non-ASCII characters in its path. That is an encoding issue. It's also present in Dockmanager, I will report it later there. Onox reported a similar bug in Dockmanager, might be the same, it's bug #680681.

I've also taken and changed some code from Dockmanager to search in more places for artwork: in the song folder and in ID3 tags. This includes a new optional dependency on Mutagen. I wonder if that should be reported somewhere so that packagers can add it as a proposed dependency?

And a minor bugfix (catching an error while launching via DBus).

[Julien Lavergne (gilir)]

Is a review really necessary ? I think mhr3 would already complain if there is a problem :)

[Gabor Karsay (gabor-karsay)]

I sort of forgot this one and merged it now since I got only encouraging comments :)

=== modified file 'shared/python/awnmediaplayers.py'
--- shared/python/awnmediaplayers.py	2011-01-07 20:51:06 +0000
+++ shared/python/awnmediaplayers.py	2011-01-13 23:06:58 +0000
@@ -20,6 +20,8 @@
 
 import sys
 import os
+import subprocess
+import atexit
 
 import gobject
 import pygtk
@@ -31,9 +33,32 @@
 from dbus.mainloop.glib import DBusGMainLoop
 import string
 
+try:
+    import mutagen.mp3
+    import mutagen.mp4
+    from mutagen.id3 import ID3
+    import tempfile
+    album_art_file = "%s/awnmediaplayer_%s.png" % (tempfile.gettempdir(), os.getenv('USERNAME'))
+    art_icon_from_tag = True
+except ImportError:
+    art_icon_from_tag = False
+
+if gtk.gtk_version >= (2, 18):
+    from urllib import unquote
+
 DBusGMainLoop(set_as_default=True)
 
 
+def cleanup():
+    if art_icon_from_tag:
+        try:
+            os.remove(album_art_file)
+        except OSError:
+            pass
+
+atexit.register(cleanup)
+
+
 def get_app_name():
     player_name = None
     bus_obj = dbus.SessionBus().get_object('org.freedesktop.DBus', '/org/freedesktop/DBus')
@@ -67,9 +92,35 @@
         player_name = "DragonPlayer"
     elif bus_obj.NameHasOwner('org.freedesktop.MediaPlayer') == True:
         player_name = "mpDris"
+    elif bus_obj.NameHasOwner('org.mpris.clementine') == True:
+        player_name = "Clementine"
+    elif bus_obj.NameHasOwner('org.mpris.guayadeque') == True:
+        player_name = "Guayadeque"
     return player_name
 
 
+def player_available(executable):
+    """Check if player is installed if it's not in 'Activatable Services' on DBus"""
+
+    for path in os.getenv('PATH').split(':'):
+        if path == '':
+            continue
+        if os.path.isfile(os.path.join(path, executable)):
+            return True
+    return False
+
+
+def launch_player(args):
+    """Launch player if this can't be done via DBus"""
+
+    try:
+        subprocess.Popen(args)
+    except OSError, e:
+        print "awnmediaplayer: error launching %s: %s" % (args, e)
+        return False
+    return True
+
+
 class GenericPlayer(object):
     """Insert the level of support here"""
 
@@ -120,11 +171,13 @@
         """
         if (self.dbus_base_name != None):
             object_path = '/' + self.dbus_base_name.replace('.', '/')
-            bus = dbus.SessionBus()
-            obj = bus.get_object(self.dbus_base_name, object_path)
-            return True
-        else:
-            return False
+            try:
+                bus = dbus.SessionBus()
+                obj = bus.get_object(self.dbus_base_name, object_path)
+                return True
+            except Exception, e:
+                print "awnmediaplayer: error launching %s: %s" % (self.__class__.__name__, e)
+        return False
 
     def get_dbus_name(self):
         """
@@ -231,7 +284,6 @@
             if info['arturl'][0:7] == "file://":
                 result['album-art'] = str(info['arturl'][7:])
                 if gtk.gtk_version >= (2, 18):
-                    from urllib import unquote
                     result['album-art'] = unquote(result['album-art'])
             else:
                 print "Don't understand the album art location: %s" % info['arturl']
@@ -286,7 +338,8 @@
     def get_media_info(self):
         self.dbus_driver()
         ret_dict = {}
-        result = self.rbShell.getSongProperties(self.player.getPlayingUri())
+        playinguri = self.player.getPlayingUri()
+        result = self.rbShell.getSongProperties(playinguri)
 
         # Currently Playing Title
         if result['artist'] != '':
@@ -304,19 +357,77 @@
 
         # cover-art
         if 'rb:coverArt-uri' in result:
-            albumart_exact = result['rb:coverArt-uri']
+            albumart_exact = result['rb:coverArt-uri'].encode('utf8')
             # bug in rhythmbox 0.11.6 - returns uri, but not properly encoded,
             # but it's enough to remove the file:// prefix
             albumart_exact = albumart_exact.replace('file://', '', 1)
             if gtk.gtk_version >= (2, 18):
-                from urllib import unquote
                 albumart_exact = unquote(albumart_exact)
-            ret_dict['album-art'] = albumart_exact
+            # Sanity check if encoding and unquoting did work
+            if os.path.isfile(albumart_exact):
+                ret_dict['album-art'] = albumart_exact
+                return ret_dict
+            else:
+                print "awnmediaplayers: Unquoting error:\n%s\ndoes not match\n%s" % (result['rb:coverArt-uri'], albumart_exact)
+
+        # perhaps it's in the cache folder
+        if 'album' in result and 'artist' in result:
+            cache_dir = os.path.expanduser("~/.cache/rhythmbox/covers")
+            cache_file = '%s/%s - %s.jpg' % (cache_dir, result['artist'], result['album'])
+            if os.path.isfile(cache_file):
+                ret_dict['album-art'] = cache_file
+                return ret_dict
+
+        # The following is based on code from Dockmanager
+        # Copyright (C) 2009-2010 Jason Smith, Rico Tzschichholz, Robert Dyer
+
+        # Look in song folder
+        filename = playinguri.encode('utf8').replace('file://', '', 1)
+        if gtk.gtk_version >= (2, 18):
+            filename = unquote(filename)
+        coverdir = os.path.dirname(filename)
+        if os.path.isdir(coverdir):
+            covernames = ["cover", "album", "albumart", ".folder", "folder"]
+            extensions = [".jpg", ".jpeg", ".png"]
+            for f in os.listdir(coverdir):
+                for ext in extensions:
+                    if f.lower().endswith(ext):
+                        for name in covernames:
+                            if f.lower() == (name + ext):
+                                ret_dict['album-art'] = os.path.join(coverdir, f)
+                                return ret_dict
         else:
-            # perhaps it's in the cache folder
-            if 'album' in result and 'artist' in result:
-                cache_dir = ".cache/rhythmbox/covers"
-                ret_dict['album-art'] = '%s/%s - %s.jpg' % (cache_dir, result['artist'], result['album'])
+            print "awnmediaplayers: Unquoting error:\n%s (file)\ndoes not match\n%s (directory)" % (playinguri, coverdir)
+
+        # Look for image in tags
+        if art_icon_from_tag and 'mimetype' in result:
+            image_data = None
+            if result['mimetype'] == "application/x-id3":
+                try:
+                    f = ID3(filename)
+                    apicframes = f.getall("APIC")
+                    if len(apicframes) >= 1:
+                        frame = apicframes[0]
+                        image_data = frame.data
+                except:
+                    pass
+            elif result['mimetype'] == "audio/x-aac":
+                try:
+                    f = mutagen.mp4.MP4(filename)
+                    if "covr" in f.tags:
+                        covertag = f.tags["covr"][0]
+                        image_data = covertag
+                except:
+                    pass
+            if image_data:
+                try:
+                    loader = gtk.gdk.PixbufLoader()
+                    loader.write(image_data)
+                    loader.close()
+                    loader.get_pixbuf().save(album_art_file, "png", {})
+                    ret_dict['album-art'] = album_art_file
+                except:
+                    pass
 
         return ret_dict
 
@@ -627,6 +738,7 @@
 
 
 class Songbird(MPRISPlayer):
+    """Discontinued in 2010"""
 
     def __init__(self):
         MPRISPlayer.__init__(self, 'org.mpris.songbird')
@@ -637,14 +749,27 @@
     def __init__(self):
         MPRISPlayer.__init__(self, 'org.mpris.vlc')
 
+    def is_available(self):
+        return player_available('vlc')
+
+    def start(self):
+        return launch_player(['vlc', '--control', 'dbus'])
+
 
 class Audacious(MPRISPlayer):
 
     def __init__(self):
         MPRISPlayer.__init__(self, 'org.mpris.audacious')
 
+    def is_available(self):
+        return player_available('audacious')
+
+    def start(self):
+        return launch_player('audacious')
+
 
 class BMP(MPRISPlayer):
+    """Beep Media Player, discontinued"""
 
     def __init__(self):
         MPRISPlayer.__init__(self, 'org.mpris.bmp')
@@ -662,8 +787,15 @@
     def __init__(self):
         MPRISPlayer.__init__(self, 'org.mpris.amarok')
 
+    def is_available(self):
+        return player_available('amarok')
+
+    def start(self):
+        return launch_player('amarok')
+
 
 class Aeon(MPRISPlayer):
+    """Discontinued"""
 
     def __init__(self):
         MPRISPlayer.__init__(self, 'org.mpris.aeon')
@@ -681,3 +813,46 @@
 
     def __init__(self):
         MPRISPlayer.__init__(self, 'org.freedesktop.MediaPlayer')
+
+
+class Clementine(MPRISPlayer):
+
+    def __init__(self):
+        MPRISPlayer.__init__(self, 'org.mpris.clementine')
+
+    def is_available(self):
+        return player_available('clementine')
+
+    def start(self):
+        return launch_player('clementine')
+
+    def previous(self):
+        self.player.Prev()
+        # We have to emit song changed signal ourselves (Clementine 0.5)
+        self.song_changed_emitter()
+
+    def next(self):
+        self.player.Next()
+        # We have to emit song changed signal ourselves (Clementine 0.5)
+        self.song_changed_emitter()
+
+
+class Guayadeque(MPRISPlayer):
+
+    def __init__(self):
+        MPRISPlayer.__init__(self, 'org.mpris.guayadeque')
+
+    def dbus_driver(self):
+        bus_obj = dbus.SessionBus().get_object('org.freedesktop.DBus', '/org/freedesktop/DBus')
+        if bus_obj.NameHasOwner(self.dbus_base_name) == True:
+            self.session_bus = dbus.SessionBus()
+            self.proxy_obj = self.session_bus.get_object(self.dbus_base_name, '/Player')
+            self.player = dbus.Interface(self.proxy_obj, 'org.freedesktop.MediaPlayer')
+            self.player.connect_to_signal('TrackChange', self.song_changed_emitter, member_keyword='member')
+            self.player.connect_to_signal('StatusChange', self.playing_changed_emitter)
+
+    def is_available(self):
+        return player_available('guayadeque')
+
+    def start(self):
+        return launch_player('guayadeque')