Merge lp:~mims-michael/nuvola-player/bugfix1049253 into lp:nuvola-player/2.5.x

[Michael Mims]

Updated integration to JSApi 2. Added a hack/fix to toggle playback on the first play to address initial muted playback. The problem appears to be with the AudioFactory of the Rdio client side js and not with WebkitGTK.

[Jiří Janoušek (fenryxo)]

Thanks, Michael, for your work. I'm sorry for a late reply, but I have time for Nuvola Player only during weekends.

=== modified file 'data/nuvolaplayer/services/rdio/integration.js'
8 - Copyright 2012 Stefan Lohmaier <email address hidden>
9 + Copyright 2012 Michael Mims <email address hidden>

Did you rewrite this script from scratch? If not, you cannot remove Stefan's copyright.

-----8<------

=== modified file 'data/nuvolaplayer/services/rdio/integration.js'
36 + * client js side). See Nuvola bug #1049253.

Please use notation "LP:1049253".

-----8<------

=== modified file 'data/nuvolaplayer/services/rdio/metadata.conf'
178 version = 2
179 -version_minor = 4
180 -flash_plugin = no
181 +version_minor = 5

Increase version to 3.0 instead of 2.5.

review: Needs Fixing

[Michael Mims (mims-michael)]

There's not really anything remaining from Stefan's original code as I also contributed the last major update to this integration (https://code.launchpad.net/~mims-michael/nuvola-player/rdio-fix/+merge/114234) that he did not respond to. However, I will add his credits back in this next commit.

[lp:~mims-michael/nuvola-player/bugfix1049253]

659. By Michael Mims on 2013-04-14

Added credits for original Rdio maintainer; Changed version to 3.0.

[Jiří Janoušek (fenryxo)]

> There's not really anything remaining from Stefan's original code as I also contributed the last major update to this integration.

I see, in that case you can remove Stefan's copyright again. Could you also relicense the code under 2-Clause BSD license? You can use license header from /data/nuvolaplayer/services/googleplay/integration.js.

review: Needs Information

[lp:~mims-michael/nuvola-player/bugfix1049253]

660. By Michael Mims on 2013-04-16

Updated license to 2-Clause BSD.

[Jiří Janoušek (fenryxo)]

review: Approve

=== modified file 'data/nuvolaplayer/services/rdio/integration.js'
--- data/nuvolaplayer/services/rdio/integration.js	2012-08-17 17:50:56 +0000
+++ data/nuvolaplayer/services/rdio/integration.js	2013-04-16 14:00:44 +0000
@@ -1,25 +1,27 @@
 /*
-	Nuvola Player :: Cloud music integration
-	
-	This script provides integration of the Rdio streaming service
-	on the JavaScript side. It's executed when Rdio page is completely
-	loaded.
-
-
-	Copyright 2012 Stefan Lohmaier <[e-mail]>
-
-This program is free software: you can redistribute it and/or modify it 
-under the terms of the GNU General Public License version 3, as published 
-by the Free Software Foundation.
-
-This program is distributed in the hope that it will be useful, but 
-WITHOUT ANY WARRANTY; without even the implied warranties of 
-MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
-PURPOSE.  See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along 
-with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
+ * Copyright 2013 Michael Mims <[e-mail]>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met: 
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer. 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution. 
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
 
 /* Anonymous function is used not to pollute environment */
 (function(Nuvola){
@@ -27,18 +29,43 @@
 	 * Creates Rdio integration binded to Nuvola JS API
 	 */
 	var Integration = function(){
-		/* Overwrite default commnad function */
-		Nuvola.command = Nuvola.bind(this, this.command);
+		/* Overwrite default command function */
+		Nuvola.onMessageReceived = Nuvola.bind(this, this.messageHandler);
 		
 		/* For debug output */
 		this.name = "Rdio";		
 		
 		/* Let's run */
 		this.state = Nuvola.STATE_NONE;
+		this.firstPlayToggled = false;
 		this.update();
-		this.timeout = setInterval(Nuvola.bind(this, this.update), 500);
 	};
 
+	/**
+	 * Toggles playback the first time a play action is received
+	 * This is a temporary hack to try to work around a known issue with WebkitGTK
+	 * initial volume levels (although testing seems to indicate it might be on rdio
+	 * client js side). See Nuvola bug LP:1049253.
+	 */
+	Integration.prototype.firstPlayToggle = function () {
+		if(this.firstPlayToggled != true) {
+			try {
+				var player = R.Services.Player;
+				player.playPause();
+				
+				setTimeout(function () {
+					player.playPause();
+					console.debug("[firstPlayToggle] First play toggle completed");
+				}, 750);
+
+				console.debug("[firstPlayToggle] First play toggle began");
+				this.firstPlayToggled = true;
+			}
+			catch(e) {
+				console.debug("[firstPlayToggle] Player service not available");
+			}
+		}
+	}
 
 	/**
 	 * Updates current playback state
@@ -52,10 +79,7 @@
 		var song = null;
 		var can_prev;
 		var can_next;
-		var can_thumbs_up = false;
-		var can_thumbs_down = false;
-		var can_favorite = false;
-			
+
 		try{
 			var playingTrack = R.Services.Player.model.get("playingTrack").attributes;				
 			album_art = playingTrack.icon;
@@ -64,17 +88,22 @@
 			song = playingTrack.name;
 		}
 		catch(e){
-			//~ console.debug("Unable to obtain song info: " + e.message);
+			console.debug("Unable to obtain song info: " + e.message);
 		}
 		
 		try{
 			var state = Nuvola.STATE_NONE;
 
-			var rdiostate = R.Services.Player.model.attributes.playState;//new
+			var rdiostate = R.Services.Player.model.attributes.playState;
 
 			switch (rdiostate){
-				case 0: state = Nuvola.STATE_PAUSED; break;
-				case 1: state = Nuvola.STATE_PLAYING; break;
+			case 0:
+				state = Nuvola.STATE_PAUSED;
+				break;
+			case 1:
+				state = Nuvola.STATE_PLAYING;
+				this.firstPlayToggle();
+				break;
 			}
 			
 			if(state != Nuvola.STATE_NONE){
@@ -86,38 +115,47 @@
 			
 		}
 		catch(e){
+			// console.debug("Unable to obtain state info: " + e.message);
 			can_prev = can_next = false;
 		}
 
 		this.state = state;
 		
 		// Submit data to Nuvola backend
-		Nuvola.dataChanged(
-			song, artist, album, album_art,
-			state, can_prev, can_next,
-			can_thumbs_up, can_thumbs_down, can_favorite);
+		Nuvola.updateSong(song, artist, album, album_art, state);
+
+		if(this.can_next !== can_next){
+			this.can_next = can_next;
+			Nuvola.updateAction(Nuvola.ACTION_NEXT_SONG, can_next);
+		}
+		if(this.can_prev !== can_prev){
+			this.can_prev = can_prev;
+			Nuvola.updateAction(Nuvola.ACTION_PREV_SONG, can_prev);
+		}
+		
+		setTimeout(Nuvola.bind(this, this.update), 500);
 	}
 	
 	/**
 	 * Command handler
 	 * @param cmd command to execute
 	 */
-	Integration.prototype.command = function(cmd){
+	Integration.prototype.messageHandler = function(cmd){
 		try{
 			switch(cmd){
-			case Nuvola.CMD_PLAY:
+			case Nuvola.ACTION_PLAY:
 				if(this.state != Nuvola.STATE_PLAYING) R.Services.Player.playPause();
 				break;
-			case Nuvola.CMD_PAUSE:
+			case Nuvola.ACTION_PAUSE:
 				if(this.state == Nuvola.STATE_PLAYING) R.Services.Player.playPause();
 				break;
-			case Nuvola.CMD_TOGGLE:
+			case Nuvola.ACTION_TOGGLE_PLAY:
 				R.Services.Player.playPause();
 				break;
-			case Nuvola.CMD_PREV_SONG:
+			case Nuvola.ACTION_PREV_SONG:
 				R.Services.Player.previous();
 				break;
-			case Nuvola.CMD_NEXT_SONG:
+			case Nuvola.ACTION_NEXT_SONG:
 				R.Services.Player.next();
 				break;
 			default:
@@ -135,5 +173,5 @@
 	/* Store reference */ 
 	Nuvola.integration = new Integration(); // Singleton
 	
-// Call anonymous function with Nuvola object as an argument
-})(window._Nuvola);
+// Call anonymous function with JS API object as an argument
+})(this);
\ No newline at end of file

=== modified file 'data/nuvolaplayer/services/rdio/metadata.conf'
--- data/nuvolaplayer/services/rdio/metadata.conf	2013-04-06 12:42:57 +0000
+++ data/nuvolaplayer/services/rdio/metadata.conf	2013-04-16 14:00:44 +0000
@@ -1,8 +1,9 @@
 name = Rdio
 home_page = http://www.rdio.com/
 sandbox_pattern = https?://((www\.)?rdio\.com/|ak.rdio\.com|)
-maintainer_name = Orphaned service
-maintainer_link = https://answers.launchpad.net/nuvola-player/+faq/2012
-version = 2
-version_minor = 4
-flash_plugin = no
+maintainer_name = Michael Mims
+maintainer_link = https://launchpad.net/~mims-michael
+version = 3
+version_minor = 0
+api_major = 2
+flash_plugin = yes