Update DBUS MediaSource to use org.mpris.MediaPlayer2 interfaces.

Change-Id: I487c654af9ca04ae130c607171bc9c535e4c7e89
Reviewed-on: http://gerrit.dmdirc.com/2602
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/addons/mediasource_dbus/BansheeSource.java

@@ -1,175 +0,0 @@
-/*
- * Copyright (c) 2006-2012 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package com.dmdirc.addons.mediasource_dbus;
-
-import com.dmdirc.addons.nowplaying.MediaSource;
-import com.dmdirc.addons.nowplaying.MediaSourceState;
-
-import java.util.List;
-import java.util.Map;
-
-/**
- * A media source for Banshee.
- *
- * @author chris
- */
-public class BansheeSource implements MediaSource {
-
-    /** The dbus service name. */
-    private static final String SERVICE = "org.bansheeproject.Banshee";
-    /** The dbus interface name. */
-    private static final String IFACE = "/org/bansheeproject/Banshee/PlayerEngine";
-    /** The method to get the current state. */
-    private static final String STATE = "org.bansheeproject.Banshee.PlayerEngine.GetCurrentState";
-    /** The method to get the current track. */
-    private static final String TRACK = "org.bansheeproject.Banshee.PlayerEngine.GetCurrentTrack";
-    /** The method to get the current position. */
-    private static final String POSITION = "org.bansheeproject.Banshee.PlayerEngine.GetPosition";
-
-    /** The media source that owns this source. */
-    private final DBusMediaSource source;
-    /** A cache of track information. */
-    private Map<String, String> trackInfo;
-
-    public BansheeSource(final DBusMediaSource source) {
-        this.source = source;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public MediaSourceState getState() {
-        final List<String> res = source.doDBusCall(SERVICE, IFACE, STATE);
-
-        if (res.isEmpty()) {
-            trackInfo = null;
-            return MediaSourceState.CLOSED;
-        } else if ("playing".equals(res.get(0))) {
-            trackInfo = getTrackInfo();
-            return MediaSourceState.PLAYING;
-        } else if ("paused".equals(res.get(0))) {
-            trackInfo = getTrackInfo();
-            return MediaSourceState.PAUSED;
-        } else if ("idle".equals(res.get(0))) {
-            trackInfo = getTrackInfo();
-            return MediaSourceState.STOPPED;
-        } else {
-            trackInfo = null;
-            return MediaSourceState.NOTKNOWN;
-        }
-    }
-
-    /**
-     * Retrieves a map of track information from the dbus service.
-     *
-     * @return A map of track information
-     */
-    protected Map<String, String> getTrackInfo() {
-        return DBusMediaSource.parseDictionary(source.doDBusCall(SERVICE, IFACE, TRACK));
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getAppName() {
-        return "Banshee";
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getArtist() {
-        return trackInfo == null ? "Unknown" : trackInfo.get("artist");
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getTitle() {
-        return trackInfo == null ? "Unknown" : trackInfo.get("name");
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getAlbum() {
-        return trackInfo == null ? "Unknown" : trackInfo.get("album");
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getLength() {
-        return trackInfo == null ? "Unknown" : duration((long)
-                Double.parseDouble(trackInfo.get("length")));
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getTime() {
-        return duration((long) Double.parseDouble(source.doDBusCall(SERVICE,
-                IFACE, POSITION).get(0)) / 1000);
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getFormat() {
-        return trackInfo == null ? "Unknown" : trackInfo.get("mime-type");
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String getBitrate() {
-        return trackInfo == null ? "Unknown" : trackInfo.get("bit-rate");
-    }
-
-    /**
-     * Get the duration in seconds as a string.
-     *
-     * @param seconds Input to get duration for
-     * @return Duration as a string
-     */
-    private String duration(final long secondsInput) {
-        final StringBuilder result = new StringBuilder();
-        final long hours = secondsInput / 3600;
-        final long minutes = secondsInput / 60 % 60;
-        final long seconds = secondsInput % 60;
-
-        if (hours > 0) {
-            if (hours < 10) {
-                result.append('0');
-            }
-
-            result.append(hours).append(":");
-        }
-
-        if (minutes < 10) {
-            result.append('0');
-        }
-
-        result.append(minutes).append(":");
-
-        if (seconds < 10) {
-            result.append('0');
-        }
-
-        result.append(seconds);
-
-        return result.toString();
-    }
-
-}

src/com/dmdirc/addons/mediasource_dbus/DBusMediaSource.java

@@ -33,7 +33,6 @@ import java.io.File;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -54,9 +53,7 @@ public class DBusMediaSource extends BasePlugin implements MediaSourceManager {
     /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        sources = new ArrayList<MediaSource>(Arrays.asList(new MediaSource[]{
-            new BansheeSource(this),
-        }));
+        sources = new ArrayList<MediaSource>();
 
         if (new File("/usr/bin/qdbus").exists()) {
             qdbus = "/usr/bin/qdbus";
@@ -160,7 +157,7 @@ public class DBusMediaSource extends BasePlugin implements MediaSourceManager {
         final Map<String, String> res = new HashMap<String, String>();
 
         for (String line : lines) {
-            final int index = line.indexOf(':');
+            final int index = line.indexOf(':', line.indexOf(':') + 1);
 
             if (index == -1 || index >= line.length() - 2) {
                 continue;

src/com/dmdirc/addons/mediasource_dbus/MPRISSource.java

@@ -54,20 +54,33 @@ public class MPRISSource implements MediaSource {
         this.source = source;
         this.service = service;
 
-        final List<String> info = source.doDBusCall("org.mpris." + service, "/",
-                "org.freedesktop.MediaPlayer.Identity");
+        final String info = getFirstValue("org.mpris.MediaPlayer2.Identity");
 
         if (info.isEmpty()) {
             throw new IllegalArgumentException("No service with that name found");
         }
 
-        this.name = info.get(0).replace(' ', '_');
+        this.name = info.replace(' ', '_');
+    }
+
+    /**
+     * Get the first line of the output for a dbus call to the given function
+     * against this service in the /org/mpris/MediaPlayer2 obejct.
+     *
+     * @param function Function to get data for.
+     * @return First line of output.
+     */
+    protected String getFirstValue(final String function) {
+        final List<String> info = source.doDBusCall("org.mpris." + service,
+                "/org/mpris/MediaPlayer2", function);
+
+        return info.isEmpty() ? "" : info.get(0);
     }
 
     /** {@inheritDoc} */
     @Override
     public MediaSourceState getState() {
-        final char[] status = getStatus();
+        final String status = getStatus();
 
         if (status == null) {
             data = null;
@@ -76,11 +89,11 @@ public class MPRISSource implements MediaSource {
 
         data = getTrackInfo();
 
-        if (status[0] == '0') {
+        if (status.equalsIgnoreCase("Playing")) {
             return MediaSourceState.PLAYING;
-        } else if (status[0] == '1') {
+        } else if (status.equalsIgnoreCase("Paused")) {
             return MediaSourceState.PAUSED;
-        } else if (status[0] == '2') {
+        } else if (status.equalsIgnoreCase("Stopped")) {
             return MediaSourceState.STOPPED;
         } else {
             return MediaSourceState.NOTKNOWN;
@@ -108,31 +121,46 @@ public class MPRISSource implements MediaSource {
     /** {@inheritDoc} */
     @Override
     public String getArtist() {
-        return getData("artist");
+        return getData("xesam:artist");
     }
 
     /** {@inheritDoc} */
     @Override
     public String getTitle() {
-        return getData("title");
+        return getData("xesam:title");
     }
 
     /** {@inheritDoc} */
     @Override
     public String getAlbum() {
-        return getData("album");
+        return getData("xesam:album");
     }
 
     /** {@inheritDoc} */
     @Override
     public String getLength() {
-        return getData("time");
+        try {
+            final Long len = Long.parseLong(getData("mpris:length"));
+            return duration(len / 1000);
+        } catch (final NumberFormatException nfe) {
+            return "Unknown";
+        }
     }
 
     /** {@inheritDoc} */
     @Override
     public String getTime() {
-        return "Unknown";
+        try {
+            final String position = getFirstValue("org.mpris.MediaPlayer2.Player.Position");
+            final Long len = Long.parseLong(position);
+            if (len == 0) {
+                return "Unknown";
+            } else {
+                return duration(len / 1000);
+            }
+        } catch (final NumberFormatException nfe) {
+            return "Unknown";
+        }
     }
 
     /** {@inheritDoc} */
@@ -144,7 +172,7 @@ public class MPRISSource implements MediaSource {
     /** {@inheritDoc} */
     @Override
     public String getBitrate() {
-        return getData("audio-bitrate");
+        return "Unknown";
     }
 
     /**
@@ -153,11 +181,8 @@ public class MPRISSource implements MediaSource {
      * @return A map of metadata returned by the MPRIS service
      */
     protected Map<String, String> getTrackInfo() {
-        // If only there were a standard...
         final List<String> list = source.doDBusCall("org.mpris." + service,
-                "/Player", "org.freedesktop.MediaPlayer.GetMetadata");
-        list.addAll(source.doDBusCall("org.mpris." + service,
-                "/Player", "org.freedesktop.MediaPlayer.GetMetaData"));
+                "/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2.Player.Metadata");
         return DBusMediaSource.parseDictionary(list);
     }
 
@@ -166,35 +191,46 @@ public class MPRISSource implements MediaSource {
      *
      * @return The returned status or null if the service isn't running
      */
-    protected char[] getStatus() {
-        if (source.doDBusCall("org.mpris." + service, "/",
-                "org.freedesktop.MediaPlayer.Identity").isEmpty()) {
-            // Calling dbus-send can seemingly start applications that have
-            // quit (not entirely sure how), so check that it's running first.
+    protected String getStatus() {
+        if (getFirstValue("org.mpris.MediaPlayer2.Identity").isEmpty()) {
             return null;
         }
 
-        final List<String> res = DBusMediaSource.getInfo(new String[]{
-            "/usr/bin/dbus-send", "--print-reply", "--dest=org.mpris." + service,
-            "/Player", "org.freedesktop.MediaPlayer.GetStatus"
-        });
+        return getFirstValue("org.mpris.MediaPlayer2.Player.PlaybackStatus");
+    }
 
-        if (res.isEmpty()) {
-            return null;
+    /**
+     * Get the duration in seconds as a string.
+     *
+     * @param seconds Input to get duration for
+     * @return Duration as a string
+     */
+    private String duration(final long secondsInput) {
+        final StringBuilder result = new StringBuilder();
+        final long hours = secondsInput / 3600;
+        final long minutes = secondsInput / 60 % 60;
+        final long seconds = secondsInput % 60;
+
+        if (hours > 0) {
+            if (hours < 10) {
+                result.append('0');
+            }
+
+            result.append(hours).append(":");
         }
 
-        final char[] result = new char[4];
-        int i = 0;
+        if (minutes < 10) {
+            result.append('0');
+        }
 
-        for (String line : res) {
-            final String tline = line.trim();
+        result.append(minutes).append(":");
 
-            if (tline.startsWith("int32")) {
-                result[i++] = tline.charAt(tline.length() - 1);
-            }
+        if (seconds < 10) {
+            result.append('0');
         }
 
-        return result;
-    }
+        result.append(seconds);
 
+        return result.toString();
+    }
 }

src/com/dmdirc/addons/mediasource_dbus/plugin.config

@@ -20,10 +20,9 @@ updates:
   id=39
 
 version:
-  friendly=1.0
+  friendly=2.0
 
 provides:
-  banshee mediasource
   mpris mediasource
 
 requires: