Merge lp:~zestoi/mixxx/controller_scripts into lp:~mixxxdevelopers/mixxx/trunk

[Zestoi]

* use engine.spinback() and engine.brake() in launchpad and mk2 mappings and the common-controller-scripts.js file in the thin wrappers which allow direct xml mapping (leave the js implementation in there for now)

* add in missing led feedback for channel2 eq kills in the herc mapping

* fix for the led feedback in the launchpad mapping - cause by the different runtime environment after the merge of madjester's code last night (i think) where 'this' is now in the engine as opposed to the controller instance

[lp:~zestoi/mixxx/controller_scripts]

3218. By Zestoi on 2012-05-27

remove debug

3219. By Zestoi on 2012-05-28

removed javascript implementation of spinback/brake and renamed script.spinbackDefault to script.spinback and script.brakeDefault to script.brake

3220. By Zestoi on 2012-05-28

whitespace

3221. By Zestoi on 2012-05-29

fixed new context for incomingData() and used new lambda style calling of engine.connectControl()

=== modified file 'mixxx/res/controllers/Hercules-DJ-Console-Mk2-hid-scripts.js'
--- mixxx/res/controllers/Hercules-DJ-Console-Mk2-hid-scripts.js	2012-05-26 14:22:39 +0000
+++ mixxx/res/controllers/Hercules-DJ-Console-Mk2-hid-scripts.js	2012-05-29 18:21:20 +0000
@@ -231,6 +231,9 @@
 	c.feedback("[Channel1]", "filterHighKill", c.kill_status);
 	c.feedback("[Channel1]", "filterMidKill", c.kill_status);
 	c.feedback("[Channel1]", "filterLowKill", c.kill_status);
+	c.feedback("[Channel2]", "filterHighKill", c.kill_status);
+	c.feedback("[Channel2]", "filterMidKill", c.kill_status);
+	c.feedback("[Channel2]", "filterLowKill", c.kill_status);
 
 	//
 	// clear/setup any initial leds
@@ -261,10 +264,10 @@
 					engine.setValue(g, "flanger", v > 0);
 					break;
 				case 2:
-					script.spinback(g, v > 0);
+					engine.spinback(parseInt(g.substring(8,9)), v > 0);
 					break;
 				case 3:
-					script.brake(g, v > 0);
+					engine.brake(parseInt(g.substring(8,9)), v > 0);
 			}
 			break;
 		case "hotcue":
 
=== modified file 'mixxx/res/controllers/Novation-Launchpad-scripts.js'
--- mixxx/res/controllers/Novation-Launchpad-scripts.js	2012-05-26 14:22:39 +0000
+++ mixxx/res/controllers/Novation-Launchpad-scripts.js	2012-05-29 18:21:20 +0000
@@ -25,6 +25,8 @@
 		this.vumeters = [];
 
 		var self = NovationLaunchpad;
+		self.instance = this; // needed for incoming data from the launchpad
+
 		this.colors = self.colors();
 		this.capture = self.capture;
 		this.feedback = self.feedback;
@@ -153,10 +155,11 @@
 
 			// led feedback for loop in/out buttons to show loop status
 
-			this.feedback(group, "loop_enabled", function(self, g, e, value) {
-				var offset = g == "[Channel1]" ? 0 : 4; // ????
-				self.send("3," + (offset + 0), self.colors[value > 0 ? 'hi_green' : 'lo_green'], page);
-				self.send("3," + (offset + 1), self.colors[value > 0 ? 'hi_green' : 'lo_green'], page);
+			engine.connectControl(group, "loop_enabled", function(value, g, e) {
+				var offset = g == "[Channel1]" ? 0 : 4; // value not closed
+				this.send("3," + (offset + 0), this.colors[value > 0 ? 'hi_green' : 'lo_green'], 1);
+				this.send("3," + (offset + 1), this.colors[value > 0 ? 'hi_green' : 'lo_green'], 1);
+				this.feedback_cache[g + e] = value;
 			});
 
 			// hotcues or needle drop with shift2 pressed
@@ -185,10 +188,11 @@
 			this.toggle("7," + (offset + 0), "press", 1, 'hi_yellow', 'lo_red', group, "play");
 
 			// flash play button when near end of track
-			this.feedback(group, "playposition", function(self, g, e, value) {
+			engine.connectControl(group, "playposition", function(value, g, e) {
 				if (value > 0.9 && engine.getValue(g, "play") > 0) {
-					self.send(g == "[Channel1]" ? "7,0" : "7,4", self.colors['flash_hi_red'], 1);
+					this.send(g == "[Channel1]" ? "7,0" : "7,4", this.colors['flash_hi_red'], 1);
 				}
+				this.feedback_cache[g + e] = value;
 			});
 			
 			// sync or move beatgrid when shift is pressed
@@ -233,15 +237,23 @@
 	},
 
 	//
+	// empty shutdown method
+	//
+
+	shutdown: function() {
+	},
+
+	//
 	// convert incoming midi to a 'name' and call callbacks (if any)
 	//
 
 	incomingData: function(channel, control, value, status, group) {
-		if ((name = this.control2name["" + status + control]) != undefined) {
-			if (this.callbacks[name] != undefined) {
-				var callbacks = this.callbacks[name];
+		var me = NovationLaunchpad.instance;
+		if ((name = me.control2name["" + status + control]) != undefined) {
+			if (me.callbacks[name] != undefined) {
+				var callbacks = me.callbacks[name];
 				for (var i=0; i<callbacks.length; i++) {
-					if ((callbacks[i][1] == 0 || callbacks[i][1] == this.page) && typeof(callbacks[i][2]) == 'function') {
+					if ((callbacks[i][1] == 0 || callbacks[i][1] == me.page) && typeof(callbacks[i][2]) == 'function') {
 
 						//
 						// check we need to call for this value change: all, press, release
@@ -255,7 +267,7 @@
 							// call a callback function for this control
 							//
 
-							callbacks[i][2](this, group, name, value);
+							callbacks[i][2].call(me, group, name, value);
 						}
 					}
 				}
@@ -351,35 +363,6 @@
 	},
 
 	//
-	// map a callback to an event from mixxx
-	//
-
-	feedback: function(g, e, f) {
-		if (g != "" && e != "") {
-			engine.connectControl(g, e, "NovationLaunchpad.feedbackData");
-			if (this.feedbacks[g + e] == undefined) {
-				this.feedbacks[g + e] = [];
-			}
-			this.feedbacks[g + e].push(f);
-		}
-	},
-
-	//
-	// call callbacks from mixxx events
-	//
-
-	feedbackData: function(v, g, e) {
-		this.feedback_cache[g + e] = v;
-		if (this.feedbacks[g + e] != undefined) {
-			for (func in this.feedbacks[g + e]) {
-				if (typeof(this.feedbacks[g + e][func]) == "function") {
-					this.feedbacks[g + e][func](this, g, e, v);
-				}
-			}
-		}
-	},
-
-	//
 	// map a callback to a launchpad button name
 	//
 
@@ -414,25 +397,27 @@
 
 		// launchpad => mixxx
 
-		this.capture(name, "all", page, function(self, g, name, value) {
+		this.capture(name, "all", page, function(g, name, value) {
+
 			if (callback == undefined) {
 				engine.setValue(group, event, value);
 			}
 			else if (typeof(callback) == "function") {
 				if (values == "all" || (values == "press" && value > 0) || (values == "release" && value == 0)) {
-					callback(group, event, value);
+					callback.call(this, group, event, value);
 				}
 			}
 
 			if (values == "all" || (values == "press" && value > 0) || (values == "release" && value == 0)) {
-				self.send(name, self.colors[value > 0 ? on_color : off_color], page);
+				this.send(name, this.colors[value > 0 ? on_color : off_color], page);
 			}
 		});
 
 		// mixxx => launchpad
 
-		this.feedback(group, event, function(self, g, e, value) {
-			self.send(name, self.colors[value > 0 ? on_color : off_color], page);
+		engine.connectControl(group, event, function(value, g, e) {
+			this.send(name, this.colors[value > 0 ? on_color : off_color], page);
+			this.feedback_cache[g + e] = value;
 		});
 
 		// init led
@@ -445,27 +430,28 @@
 	//
 
 	toggle:  function(name, values, page, on_color, off_color, group, event, callback) {
-		this.capture(name, "press", page, function(self, g, name, value) {
-			if (typeof(self.toggle_cache[page][name]) == "undefined") {
-				self.toggle_cache[page][name] = 0;
+		this.capture(name, "press", page, function(g, name, value) {
+			if (typeof(this.toggle_cache[page][name]) == "undefined") {
+				this.toggle_cache[page][name] = 0;
 			}
-			self.toggle_cache[page][name] = self.toggle_cache[page][name] == 0 ? 1 : 0;
+			this.toggle_cache[page][name] = this.toggle_cache[page][name] == 0 ? 1 : 0;
 
 			if (callback == undefined) {
-				engine.setValue(group, event, self.toggle_cache[page][name]);
+				engine.setValue(group, event, this.toggle_cache[page][name]);
 			}
 			else if (typeof(callback) == "function") {
-				callback(group, event, self.toggle_cache[page][name]);
+				callback.call(this, group, event, this.toggle_cache[page][name]);
 			}
 
-			self.send(name, self.colors[self.toggle_cache[page][name] > 0 ? on_color : off_color], page);
+			this.send(name, this.colors[this.toggle_cache[page][name] > 0 ? on_color : off_color], page);
 		});
 
 		// mixxx => launchpad
 
-		this.feedback(group, event, function(self, g, e, value) {
-			self.send(name, self.colors[value > 0 ? on_color : off_color], page);
-			self.toggle_cache[page][name] = value > 0 ? 1 : 0;
+		engine.connectControl(group, event, function(value, g, e) {
+			this.send(name, this.colors[value > 0 ? on_color : off_color], page);
+			this.toggle_cache[page][name] = value > 0 ? 1 : 0;
+			this.feedback_cache[g + e] = value;
 		});
 
 		// init led
@@ -478,11 +464,14 @@
 	//
 
 	hotcue: function(name, page, group, num) {
-		this.capture(name, "press", page, function(self, g, name, value) {
-			if (self.shift2) {
+
+		// launchpad => mixxx
+
+		this.capture(name, "press", page, function(g, name, value) {
+			if (this.shift2) {
 				engine.setValue(group, "playposition", (num-1)/8);
 			}
-			else if (self.shift) {
+			else if (this.shift) {
 				engine.setValue(group, "hotcue_" + num + "_clear", 1);
 			}
 			else {
@@ -490,8 +479,11 @@
 			}
 		});
 
-		this.feedback(group, "hotcue_" + num + "_enabled", function(self, g, e, value) { 
-			self.send(name, self.colors[value > 0 ? 'hi_red' : 'black'], page);
+		// mixxx => launchpad
+
+		engine.connectControl(group, "hotcue_" + num + "_enabled", function(value, g, e) { 
+			this.send(name, this.colors[value > 0 ? 'hi_red' : 'black'], page);
+			this.feedback_cache[g + e] = value;
 		});
 	},
 
@@ -538,8 +530,8 @@
 		// launchpad => mixxx
 
 		for (var btn=0; btn<nbtns; btn++) {
-			this.capture((y-btn)+","+x, "press", page, function(self, g, name, value) {
-				var cap = name.match(/^(\d+),\d+/);
+			this.capture((y-btn)+","+x, "press", page, function(g, name, value) {
+				var cap = name.match(/^(\d+),\d+/); // value not closed
 				var num = y - cap[1] + 1;
 				engine.setValue(group, action, incr * num);
 			});
@@ -548,15 +540,16 @@
 
 		// mixxx => launchpad
 
-		this.feedback(group, action, function(self, g, e, value) { 
+		engine.connectControl(group, action, function(value, g, e) { 
 			for (btn=0; btn<nbtns; btn++) {
 				if (value > btn*incr) {
-					self.send((y-btn)+","+x, self.colors[on_color], page);
+					this.send((y-btn)+","+x, this.colors[on_color], page);
 				}
 				else {
-					self.send((y-btn)+","+x, self.colors[off_color], page);
+					this.send((y-btn)+","+x, this.colors[off_color], page);
 				}
 			}
+			this.feedback_cache[g + e] = value;
 		});
 	},
 
@@ -567,17 +560,18 @@
 	vumeter: function(y, x, page, nbtns, on_color, off_color, group, action) {
 		var incr = 1 / nbtns;
 		this.vumeters.push([ y, x, page, nbtns, on_color, off_color, group, action ]);
-		this.feedback(group, action, function(self, g, e, value) { 
-			if (self.vumeter_shift > 0) {
+		engine.connectControl(group, action, function(value, g, e) { 
+			if (this.vumeter_shift > 0) {
 				for (btn=0; btn<nbtns; btn++) {
 					if (value > btn*incr) {
-						self.send((y-btn)+","+x, self.colors[on_color], page);
+						this.send((y-btn)+","+x, this.colors[on_color], page);
 					}
 					else {
-						self.send((y-btn)+","+x, self.colors[off_color], page);
+						this.send((y-btn)+","+x, this.colors[off_color], page);
 					}
 				}
 			}
+			this.feedback_cache[g + e] = value;
 		});
 	},
 
 
=== modified file 'mixxx/res/controllers/common-controller-scripts.js'
--- mixxx/res/controllers/common-controller-scripts.js	2012-05-27 12:48:11 +0000
+++ mixxx/res/controllers/common-controller-scripts.js	2012-05-29 18:21:20 +0000
@@ -123,112 +123,29 @@
 }
 
 /* -------- ------------------------------------------------------
-     script.spinbackDefault
-   Purpose: wrapper around spinback() that can be directly mapped 
+     script.spinback
+   Purpose: wrapper around engine.spinback() that can be directly mapped 
             from xml for a spinback effect
+            e.g: <key>script.spinback</key>
    Input:   channel, control, value, status, group
    Output:  none
    -------- ------------------------------------------------------ */
-script.spinbackDefault = function(channel, control, value, status, group) {
-	// disable on note-off or zero value note/cc
-    script.spinback(group, ((status & 0xF0) != 0x80 && value > 0));
+script.spinback = function(channel, control, value, status, group) {
+    // disable on note-off or zero value note/cc
+    engine.spinback(parseInt(group.substring(8,9)), ((status & 0xF0) != 0x80 && value > 0));
 }
 
 /* -------- ------------------------------------------------------
-     script.brakeDefault
-   Purpose: wrapper around brake() that can be directly mapped 
+     script.brake
+   Purpose: wrapper around engine.brake() that can be directly mapped 
             from xml for a brake effect
+            e.g: <key>script.brake</key>
    Input:   channel, control, value, status, group
    Output:  none
    -------- ------------------------------------------------------ */
-script.brakeDefault = function(channel, control, value, status, group) {
-	// disable on note-off or zero value note/cc
-    script.brake(group, ((status & 0xF0) != 0x80 && value > 0));
-}
-
-/* -------- ------------------------------------------------------
-     script.spinback
-   Purpose: Activate or disable a spinback effect on the chosen deck
-   Input:   group, enable/disable, [delay], [factor], [inital rate]
-   Output:  None
-   -------- ------------------------------------------------------ */
-script.spinback = function(group, activate, factor, rate, delay) {
-    if (factor == undefined) factor = 0.8;
-    if (rate == undefined) rate = -10;
-    if (delay == undefined) delay = 5;
-    script.deckSpinbackBrake(group, activate, factor, rate, delay);
-}
-
-/* -------- ------------------------------------------------------
-     script.brake
-   Purpose: Activate or disable a brake effect on the chosen deck
-   Input:   group, enable/disable, [delay], [factor], [inital rate]
-   Output:  None
-   -------- ------------------------------------------------------ */
-script.brake = function(group, activate, factor, rate, delay) {
-    if (factor == undefined) factor = 0.95;
-    if (rate == undefined) rate = 1;
-    if (delay == undefined) delay = 0;
-    script.deckSpinbackBrake(group, activate, factor, rate, delay);
-}
-
-script.deckSpinbackBrakeData = {};
-
-script.deckSpinbackBrake = function(group, activate, factor, rate, delay) {
-
-    if (activate != undefined) {
-
-        // store the current settings
-
-        if (script.deckSpinbackBrakeData[group] == undefined) {
-            script.deckSpinbackBrakeData[group] = { timer: null, delay: delay, factor: factor, rate: rate };
-        }
-        else {
-            script.deckSpinbackBrakeData[group].delay = delay;
-            script.deckSpinbackBrakeData[group].factor = factor;
-            script.deckSpinbackBrakeData[group].rate = rate;
-        }
-
-        // kill timer when both enabling or disabling
-
-        if (script.deckSpinbackBrakeData[group].timer != null) {
-            engine.stopTimer(script.deckSpinbackBrakeData[group].timer);
-            script.deckSpinbackBrakeData[group].timer = null;
-        }
-
-        // enable/disable scratch2 mode
-
-        engine.setValue(group, 'scratch2_enable', activate ? 1 : 0);
-
-        if (activate) {
-            // save keylock status and disable it
-            if ((script.deckSpinbackBrakeData[group].keylock = engine.getValue(group, "keylock")) > 0) {
-                engine.setValue(group, "keylock", 0);
-            }
-
-            // setup timer and send first scratch2 'tick' if activating
-            script.deckSpinbackBrakeData[group].timer = engine.beginTimer(50, 'script.deckSpinbackBrake("' + group + '")');
-            engine.setValue(group, 'scratch2', script.deckSpinbackBrakeData[group].rate);
-        }
-
-        // re-enable keylock if needed
-
-        else if (script.deckSpinbackBrakeData[group].keylock) {
-            engine.setValue(group, "keylock", 1);
-        }
-    }
-    else {
-        // being called from a timer
-
-        engine.setValue(group, 'scratch2', script.deckSpinbackBrakeData[group].rate);
-
-        if (script.deckSpinbackBrakeData[group].delay > 0) {
-            script.deckSpinbackBrakeData[group].delay--;
-        }
-        else {
-            script.deckSpinbackBrakeData[group].rate *= script.deckSpinbackBrakeData[group].factor;
-        }
-    }
+script.brake = function(channel, control, value, status, group) {
+    // disable on note-off or zero value note/cc
+    engine.brake(parseInt(group.substring(8,9)), ((status & 0xF0) != 0x80 && value > 0));
 }
 
 // bpm - Used for tapping the desired BPM for a deck