Merge lp:~scottwferg/ubuntuone-android-music/last-fm-scrobbling into lp:ubuntuone-android-music

[Scott Ferguson]

Adds Last.fm scrobbling support via the official Last.fm app or Simple Last.fm Scrobbler. The SLS API was used for it's simplicity, and implicit support in the official app. The changes also include a settings option to enable/disable scrobbling (defaulting to off). The user is not required to login in any way within the app, it simply broadcasts an intent with the song information at relevant playstate changes.

[Chad Miller (cmiller)]

Nice! Thank you.

Approving, but I'm emailing last.fm about their plans for future support of the SLS API.

review: Approve

[Scott Ferguson (scottwferg)]

> Nice! Thank you.
>
> Approving, but I'm emailing last.fm about their plans for future support of
> the SLS API.

Sounds good!

[Scott Ferguson (scottwferg)]

Just pushed up a small commit to address sending the STATE_COMPLETE intent when currentPlaying is null. Caused a crash when exiting the app or finishing a playlist.

[lp:~scottwferg/ubuntuone-android-music/last-fm-scrobbling]

447. By Scott Ferguson <scott@scott-laptop> on 2010-10-06

Only set song information if it's available, otherwise just mark the scrobble as complete

448. By Scott Ferguson on 2010-10-07

Merge lp:~cmiller/ubuntuone-android-music/last-fm-scrobbling

[Chad Miller (cmiller)]

Okay. I'm happy with this.

=== modified file 'assets/html/en/index.html'
--- assets/html/en/index.html	2010-09-01 14:23:38 +0000
+++ assets/html/en/index.html	2010-10-07 03:11:04 +0000
@@ -30,5 +30,17 @@
 	<li>Includes photos and contacts sync for iPhone and Android devices.</li><!-- May need to alter depending on the delivery date of photos sync -->
 </ul>
 
+	<h2>Scrobbling</h2>
+
+	<p>If you use <a href="http://last.fm/">Last.fm</a> to track your music and get recommendations, then you can install an "scrobbling" app to to send playlist events.  Ubuntu One Mobile Music Streaming supports a number of apps:</a></p>
+
+	<ul>
+		<li><i><disableda href="http://market.android.com/details?id=com.adam.aslfms">Simple Last.fm Scrobbler</disableda></i></li>
+		<li>official <i><disableda href="http://market.android.com/search?q=fm.last.android">Last.fm</disableda></i></li>
+	</ul>
+
+	<p>To use, enable scrobbling in the Ubuntu One Mobile Music Streaming settings, after you install and set up a scrobbling app.</p>
+
+
 </body>
 </html>
 
=== modified file 'res/values/strings.xml'
--- res/values/strings.xml	2010-10-01 12:16:53 +0000
+++ res/values/strings.xml	2010-10-07 03:11:04 +0000
@@ -137,6 +137,9 @@
     <string name="settings.cache_size_10000">10 GB</string>
     <string name="settings.cache_size_20000">20 GB</string>
     <string name="settings.cache_size_unlimited">Unlimited</string>
+    <string name="settings.lastfm_title">Last.fm</string>
+    <string name="settings.lastfm_scrobble">Scrobbling Support</string>
+    <string name="settings.lastfm_description">Report plays to Last.fm app (see Help)</string>
 
     <string name="music_service.retry">A network error occurred. Retrying %d of %d.</string>
 
 
=== modified file 'res/xml/settings.xml'
--- res/xml/settings.xml	2010-09-07 09:14:31 +0000
+++ res/xml/settings.xml	2010-10-07 03:11:04 +0000
@@ -34,4 +34,14 @@
 
     </PreferenceCategory>
 
+    <PreferenceCategory
+        a:title="@string/settings.lastfm_title">
+        <CheckBoxPreference
+            a:title="@string/settings.lastfm_scrobble"
+            a:key="lastfmScrobbling"
+            a:defaultValue="false"
+            a:summary="@string/settings.lastfm_description"
+        />
+    </PreferenceCategory>
+
 </PreferenceScreen>
 
=== modified file 'src/net/sourceforge/subsonic/androidapp/activity/SettingsActivity.java'
--- src/net/sourceforge/subsonic/androidapp/activity/SettingsActivity.java	2010-08-23 06:27:00 +0000
+++ src/net/sourceforge/subsonic/androidapp/activity/SettingsActivity.java	2010-10-07 03:11:04 +0000
@@ -20,6 +20,7 @@
 
 import android.content.SharedPreferences;
 import android.os.Bundle;
+import android.preference.CheckBoxPreference;
 import android.preference.ListPreference;
 import android.preference.PreferenceActivity;
 import android.util.Log;
@@ -33,6 +34,7 @@
     private ListPreference theme;
     private ListPreference cacheSize;
     private ListPreference preloadCount;
+    private CheckBoxPreference lastfmScrobbling;
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
@@ -42,6 +44,7 @@
         theme = (ListPreference) findPreference(Constants.PREFERENCES_KEY_THEME);
         cacheSize = (ListPreference) findPreference(Constants.PREFERENCES_KEY_CACHE_SIZE);
         preloadCount = (ListPreference) findPreference(Constants.PREFERENCES_KEY_PRELOAD_COUNT);
+        lastfmScrobbling = (CheckBoxPreference) findPreference(Constants.PREFERENCES_KEY_LASTFM_SCROBBLING);
 
         SharedPreferences prefs = Util.getPreferences(this);
         prefs.registerOnSharedPreferenceChangeListener(this);
@@ -69,4 +72,4 @@
         preloadCount.setSummary(preloadCount.getEntry());
     }
 
-}
 \ No newline at end of file
+}
 
=== modified file 'src/net/sourceforge/subsonic/androidapp/service/DownloadServiceImpl.java'
--- src/net/sourceforge/subsonic/androidapp/service/DownloadServiceImpl.java	2010-09-07 09:14:31 +0000
+++ src/net/sourceforge/subsonic/androidapp/service/DownloadServiceImpl.java	2010-10-07 03:11:04 +0000
@@ -28,6 +28,7 @@
 import android.app.Service;
 import android.content.Context;
 import android.content.Intent;
+import android.content.SharedPreferences;
 import android.media.AudioManager;
 import android.media.MediaPlayer;
 import android.os.Handler;
@@ -38,6 +39,7 @@
 import net.sourceforge.subsonic.androidapp.domain.MusicDirectory;
 import net.sourceforge.subsonic.androidapp.domain.PlayerState;
 import net.sourceforge.subsonic.androidapp.util.CancellableTask;
+import net.sourceforge.subsonic.androidapp.util.Constants;
 import net.sourceforge.subsonic.androidapp.util.ShufflePlayBuffer;
 import net.sourceforge.subsonic.androidapp.util.SimpleServiceBinder;
 import net.sourceforge.subsonic.androidapp.util.Util;
@@ -226,8 +228,10 @@
 
         if (currentPlaying != null && showNotification) {
             Util.showPlayingNotification(this, handler, currentPlaying.getSong());
+            scrobbleLastfm(Constants.LASTFM_STATE_START);
         } else {
             Util.hidePlayingNotification(this, handler);
+            scrobbleLastfm(Constants.LASTFM_STATE_COMPLETE);
         }
     }
 
@@ -380,8 +384,10 @@
 
         if (this.playerState == PAUSED && playerState == PlayerState.STARTED) {
             Util.showPlayingNotification(this, handler, currentPlaying.getSong());
+            scrobbleLastfm(Constants.LASTFM_STATE_START);
         } else if (this.playerState == STARTED && playerState == PlayerState.PAUSED) {
             Util.hidePlayingNotification(this, handler);
+            scrobbleLastfm(Constants.LASTFM_STATE_PAUSE);
         }
 
         this.playerState = playerState;
@@ -572,6 +578,31 @@
         return revision;
     }
 
+    private void scrobbleLastfm(final int aState) {
+        SharedPreferences prefs = Util.getPreferences(this);
+        
+        if (prefs.getBoolean(Constants.PREFERENCES_KEY_LASTFM_SCROBBLING, false)) {
+            // Launch Last.fm intent here
+            Intent lastfm = new Intent();
+
+            lastfm.setAction(Constants.INTENT_SCROBBLE_LASTFM);
+            lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_APP_NAME, Constants.LASTFM_APP_NAME);
+            lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_APP_PACKAGE, Constants.LASTFM_APP_PACKAGE);
+
+            if (currentPlaying != null && currentPlaying.getSong() != null) {
+                lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_TRACK, currentPlaying.getSong().getTitle());
+                lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_ARTIST, currentPlaying.getSong().getArtist());
+                lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_ALBUM, currentPlaying.getSong().getAlbum());
+                // lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_PLAYER, Constants.LASTFM_APP_NAME);
+                lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_DURATION, currentPlaying.getSong().getDuration());
+            }
+
+            lastfm.putExtra(Constants.INTENT_EXTRA_LASTFM_STATE, aState);
+
+            sendBroadcast(lastfm);
+        }
+    }
+
     private synchronized void cleanup() {
         Iterator<DownloadFile> iterator = cleanupCandidates.iterator();
         while (iterator.hasNext()) {
 
=== modified file 'src/net/sourceforge/subsonic/androidapp/util/Constants.java'
--- src/net/sourceforge/subsonic/androidapp/util/Constants.java	2010-09-29 21:08:46 +0000
+++ src/net/sourceforge/subsonic/androidapp/util/Constants.java	2010-10-07 03:11:04 +0000
@@ -44,7 +44,25 @@
     public static final String INTENT_EXTRA_NAME_ALBUM_LIST_OFFSET = "subsonic.albumlistoffset";
     public static final String INTENT_EXTRA_NAME_SHUFFLE = "subsonic.shuffle";
     public static final String INTENT_EXTRA_NAME_REFRESH = "subsonic.refresh";
-
+    public static final String INTENT_EXTRA_LASTFM_APP_NAME = "app-name";
+    public static final String INTENT_EXTRA_LASTFM_APP_PACKAGE = "app-package";
+    public static final String INTENT_EXTRA_LASTFM_TRACK = "track";
+    public static final String INTENT_EXTRA_LASTFM_ARTIST = "artist";
+    public static final String INTENT_EXTRA_LASTFM_ALBUM = "album";
+    public static final String INTENT_EXTRA_LASTFM_PLAYER = "player";
+    public static final String INTENT_EXTRA_LASTFM_DURATION = "duration";
+    public static final String INTENT_EXTRA_LASTFM_STATE = "state";
+
+    // Names for external intents
+    public static final String INTENT_SCROBBLE_LASTFM = "com.adam.aslfms.notify.playstatechanged";
+
+    // Last.fm scrobbling values
+    public static final String LASTFM_APP_NAME = "Ubuntu One Music";
+    public static final String LASTFM_APP_PACKAGE = "net.sourceforge.subsonic.androidapp";
+    public static final int LASTFM_STATE_START = 0;
+    public static final int LASTFM_STATE_RESUME = 1;
+    public static final int LASTFM_STATE_PAUSE = 2;
+    public static final int LASTFM_STATE_COMPLETE = 3;
 
     // Notification IDs.
     public static final int NOTIFICATION_ID_PLAYING = 100;
@@ -62,6 +80,7 @@
     public static final String PREFERENCES_KEY_MAX_BITRATE_MOBILE = "maxBitrateMobile";
     public static final String PREFERENCES_KEY_CACHE_SIZE = "cacheSize";
     public static final String PREFERENCES_KEY_PRELOAD_COUNT = "preloadCount";
+    public static final String PREFERENCES_KEY_LASTFM_SCROBBLING = "lastfmScrobbling";
 
     // Name of the preferences file.
     public static final String PREFERENCES_FILE_NAME = "net.sourceforge.subsonic.u1m_preferences";