//-----------------------------------------------------------------------------
//------------ Copyright (c)2003-2018 Xylio. All Rights Reserved. -------------
//-----------------------------------------------------------------------------
// file implementing MIDI controller 'Hercules DJ Console MK4'
//-----------------------------------------------------------------------------
function getLanguageVersion()
{
	return 1;// do not modify this, this should be 1 for all scripts
}
//-----------------------------------------------------------------------------
function getFileVersion()
{
	return 1;// update this as needed
}
//-----------------------------------------------------------------------------
// return a user friendly name for the controller supported
function getControllerUserFriendlyName()
{
	return "Hercules DJ Console MK4";
}
//-----------------------------------------------------------------------------
// return the communication type that the controller supports
// this can be either 'midi' or 'hid' (please return only one of them in case the controller supports both)
function getControllerType()
{
	return 'midi';
}
//-----------------------------------------------------------------------------
// preferred way to identify the controller (using the USB device VID and PID -- vendor and product id)
// return false if the controller does not support this kind of identification
// osId -- 0 Windows; 1 MacOSX; 2 Linux; -1 unknown
function getSupportedMidiDeviceVID(osId)
{
	return 0x06F8;
}
//-----------------------------------------------------------------------------
function getSupportedMidiDevicePID(osId)
{
	return 0xB107;
}
//-----------------------------------------------------------------------------
/*
function getSupportedMidiDeviceVID2(osId)
{
	return 0x15E4;
}
//-----------------------------------------------------------------------------
function getSupportedMidiDevicePID2(osId)
{
	return 0x0027;
}
*/
//-----------------------------------------------------------------------------
// preferred way to identify the controller (if it supports MIDI SysEx)
// return false if the controller does not support this kind of identification
function getSupportedMidiSysExIdString(osId)
{
	// sysex response to 'F0 7E 7F 06 01 F7' (identification request sysex)
	// please note that the response contains 5 bytes in hex format containing
	// the Manufacturer ID (3 bytes) and Model Number (2 bytes)
	// ATTN: the returned value should omit the standard 'F0 7E 00 06 02' message start
	//if(osId==1) return false;
	return "00014E020008";
	// F0 7E 00 06 02 00 01 4E 02 00 02 00 01 00 00 00 F7 -- Hercules DJ Console MK2 complete sysex
	// F0 7E 00 06 02 00 01 4E 01 00 03 00 01 00 00 00 F7 -- Hercules DJ Control MP3 complete sysex
	// F0 7E 00 06 02 00 01 4E 02 00 04 00 01 00 00 00 F7 -- Hercules DJ Console RMX complete sysex
	// F0 7E 00 06 02 00 01 4E 01 00 05 00 01 00 00 00 F7 -- Hercules DJ Control Steel complete sysex
	// F0 7E 00 06 02 00 01 4E 01 00 07 00 01 00 00 00 F7 -- Hercules DJ Control MP3e2 complete sysex
	// F0 7E 00 06 02 00 01 4E 02 00 08 00 01 00 00 00 F7 -- Hercules DJ Console MK4 complete sysex
}
//-----------------------------------------------------------------------------
// this is NOT the preferred way to identify the controller but you should use
// it if the controller does not support standard MIDI SysEx identification
// return false if the controller does not support this kind of identification
// osId -- 0 Windows; 1 MacOSX; 2 Linux; -1 unknown
function getSupportedMidiDeviceNameForInput(osId)
{
	//if(osId==1) return "DJ Console Mk4";
	return false;
}
//-----------------------------------------------------------------------------
function getSupportedMidiDeviceNameForOutput(osId)
{
	//if(osId==1) return "DJ Console Mk4";
	return false;
}
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
// some variables necessary only for this particular script
var jogWheelsInScratchMode=0;
var loopEffectsMode=[0,0];// 0x00 loop; 0x7F effects
var previousAutoLoopLightLed=[-1,-1];// 2 decks leds
//-----------------------------------------------------------------------------
// this is called when the controller is initialized and the control is passed to this script
// use this to initialize any variables you might need, the controller' leds, etc
// uniqueId is a unique integer between 0..15 that is guaranteed not to change for
// a certain opened controller -- please note that there can be many controllers
// of the same type in use at the same time ! Use uniqueId to identify between them
function controllerInit(uniqueId)
{
	debug('controllerInit ['+uniqueId+']');// this outputs a string to DebugView app on Win
	//sendMidi(uniqueId, status, channel, data1, data2);
	sendMidi(uniqueId,0x90,0,0x2D,0x00);// scratch mode off
	//------------------------------------
	callSendAllNotifications(uniqueId, true);// send all notifications to the controller (so that we don't have to manually init all leds/lcd screens)

	// setting audio (the actual routing is done automatically for this controller so
	// we don't need to manually set "RoutingOutHeadphones", "RoutingOutDeckA", etc
	if(setAudioDevice("Hercules DJ Console Mk4 ASIO|||Hercules DJ Console Mk4|||Hercules DJ Console Mk4 Aggregate|||DJ Console Mk4|||Speakers (Hercules DJ Console Mk4)"))
	{
		//debug('AudioDevice was set OK');
		setSetting('AudioDevice2', "NO AUDIO");
	}
}
//-----------------------------------------------------------------------------
// called just before the controller will be deinitialized and the control will go away from the script
// use to power off any powered leds, etc
function controllerDeinit(uniqueId)
{
	debug('controllerDeinit ['+uniqueId+']');
	// set leds off
	sendMidi(uniqueId, 0x90, 0, 0x2D, 0x00);// scratch mode
	//------------------------------------
	callSendAllNotifications(uniqueId, false);// send all notifications to the controller (so that we don't have to manually de-init all leds/lcd screens)
}
//-----------------------------------------------------------------------------
// this is your main target function to implement the controller -- this is called
// for each and every MIDI message that comes from the controller itself
// return true if the message was processed by the script and false to let it
// pass thru the software (eg. so it can be assigned by the user using the LEARN function)
function messageReceived(uniqueId,status,channel,data1,data2)
{
	var messageNotProcessed=false;
	switch(status)
	{
	//-----------------------------------------------
	// controllers: sliders, knobs, jog-wheels, encoders ('moving' things)
	case 0xB0:
		switch(data1)
		{
		// global
		case 0x38: call('setCrossfader', data2); break;
		case 0x3D: call('setCuePgmMix', data2); break;
		// per deck
		// deck A
		case 0x37: call('setDeckEqLow', 0, data2); break;
		case 0x36: call('setDeckEqMid', 0, data2); break;
		case 0x35: call('setDeckEqHigh', 0, data2); break;
		case 0x34: call('setDeckVolume', 0, data2); break;
		case 0x32: call('moveDeckPitch', 0, (data2>0x40 ? data2-0x80 : data2)); break;// increment mode
		case 0x30: // params: (deck, increment, total positions per complete revolution)
			var val1 = (data2>0x40 ? data2-0x80 : data2);
			if(jogWheelsInScratchMode) call('scratchDeckJW', 0, val1, 128);else call('moveDeckJogWheel', 0, val1, 128);
			break;

		// deck B
		case 0x3C: call('setDeckEqLow', 1, data2); break;
		case 0x3B: call('setDeckEqMid', 1, data2); break;
		case 0x3A: call('setDeckEqHigh', 1, data2); break;
		case 0x39: call('setDeckVolume', 1, data2); break;
		case 0x33: call('moveDeckPitch', 1, (data2>0x40 ? data2-0x80 : data2)); break;// increment mode
		case 0x31: // params: (deck, increment, total positions per complete revolution)
			var val1 = (data2>0x40 ? data2-0x80 : data2);
			if(jogWheelsInScratchMode) call('scratchDeckJW', 1, val1, 128);else call('moveDeckJogWheel', 1, val1, 128);
			break;

		default: messageNotProcessed = true;
		}
		break;
	//-----------------------------------------------
	// note on/off: buttons, switches ('pressing' things)
	case 0x80:
	case 0x90:
		switch(data1)
		{
		// global
		case 0x29: if(data2>0x3F) call('lbMoveCursor', -1); break;
		case 0x2A: if(data2>0x3F) call('lbMoveCursor', +1); break;
		case 0x2B: if(data2>0x3F) call('lbListSelect', 1); break;
		case 0x2C: if(data2>0x3F) call('lbBrowserSelect', 1); break;
		case 0x2D: if(data2>0x3F){ jogWheelsInScratchMode = (jogWheelsInScratchMode+1)%2; sendMidi(uniqueId,0x90,0,0x2D,(jogWheelsInScratchMode ? 0x7F : 0x00));} break;
		case 0x2E: call('micOnAir', data2); /*call('micTalkOver', data2);*/ break;
		// per deck
		// deck A
		case 0x01: call('deckLoop1', 0, data2); break;
		case 0x02: call('deckLoop2', 0, data2); break;
		case 0x03: call('deckLoop4', 0, data2); break;
		case 0x04: call('deckLoop8', 0, data2); break;
		case 0x05: call('deckFxFlanger', 0, data2); break;
		case 0x06: call('deckFxEcho', 0, data2); break;
		case 0x07: call('deckFxBeatwaw', 0, data2); break;
		case 0x08: call('deckFxReverb', 0, data2); break;

		case 0x0A: call('deckBendDown', 0, data2); sendMidi(uniqueId,0x90,0,data1,data2); break;
		case 0x0B: call('deckBendUp', 0, data2); sendMidi(uniqueId,0x90,0,data1,data2); break;
		case 0x0C: call('deckSearchLeft', 0, data2); break;
		case 0x0D: call('deckSearchRight', 0, data2); break;
		case 0x0E: call('deckCue', 0, data2); break;
		case 0x0F: call('deckPlayPause', 0, data2); break;
		case 0x10: call('deckMonitor', 0, data2); break;
		case 0x11: if(data2>0x3F) call('deckLBLoad', 0, data2); break;
		case 0x12: call('deckSync', 0, data2); break;
		case 0x13: call('deckAnalogIn', 0, data2); break;
		case 0x14: loopEffectsMode[0] = data2; break;

		// deck B
		case 0x15: call('deckLoop1', 1, data2); break;
		case 0x16: call('deckLoop2', 1, data2); break;
		case 0x17: call('deckLoop4', 1, data2); break;
		case 0x18: call('deckLoop8', 1, data2); break;
		case 0x19: call('deckFxFlanger', 1, data2); break;
		case 0x1A: call('deckFxEcho', 1, data2); break;
		case 0x1B: call('deckFxBeatwaw', 1, data2); break;
		case 0x1C: call('deckFxReverb', 1, data2); break;

		case 0x1E: call('deckBendDown', 1, data2); sendMidi(uniqueId,0x90,0,data1,data2); break;
		case 0x1F: call('deckBendUp', 1, data2); sendMidi(uniqueId,0x90,0,data1,data2); break;
		case 0x20: call('deckSearchLeft', 1, data2); break;
		case 0x21: call('deckSearchRight', 1, data2); break;
		case 0x22: call('deckCue', 1, data2); break;
		case 0x23: call('deckPlayPause', 1, data2); break;
		case 0x24: call('deckMonitor', 1, data2); break;
		case 0x25: if(data2>0x3F) call('deckLBLoad', 1, data2); break;
		case 0x26: call('deckSync', 1, data2); break;
		case 0x27: call('deckAnalogIn', 1, data2); break;
		case 0x28: loopEffectsMode[1] = data2; break;

		default: messageNotProcessed = true;
		}
		break;
	//-----------------------------------------------
	default: messageNotProcessed = true;
	}
	if(messageNotProcessed) debug('messageReceived ['+uniqueId+'] - status:'+status+' channel:'+channel+' data1:'+data1+' data2:'+data2);
	return !messageNotProcessed;
}
//-----------------------------------------------------------------------------
// this is called by the software whenever something important changes (eg. play status, song changed, etc)
// depending on the notification type it may refer to a global event (deck is -1) or a specific deck (deck >= 0)
// and can contain any/all of the parameters: param 1 is an integer, param 2 is a float, param 3 is a string
function notificationReceived(uniqueId,name,deck,param1,param2,param3)
{
	//debug('notif ['+uniqueId+'] name='+name + ' deck='+deck + ' p1(int)='+param1 + ' p2(float)='+param2 + ' p3(str)='+param3);
	if(deck>=2) return;
	if(name=='fxFlanger') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x05:0x19,(param1 ? 0x7F : 0x00));
	if(name=='fxEcho') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x06:0x1A,(param1 ? 0x7F : 0x00));
	if(name=='fxBeatwaw') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x07:0x1B,(param1 ? 0x7F : 0x00));
	if(name=='fxReverb') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x08:0x1C,(param1 ? 0x7F : 0x00));
	if(name=='cue') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x0E:0x22,(param1 ? 0x7F : 0x00));
	if(name=='play') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x0F:0x23,(param1 ? 0x7F : 0x00));
	if(name=='monitor') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x10:0x24,(param1 ? 0x7F : 0x00));
	if(name=='onbeat') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x12:0x26,(param1 ? 0x7F : 0x00));
	if(name=='analogIn') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x13:0x27,(param1 ? 0x7F : 0x00));
	//if(name=='onAir') 		sendMidi(uniqueId,0x90,0,0x2E,(param1 ? 0x7F : 0x00));// hardware controlled

	// justLoaded: 1,2 (loading in progress), 4 (loading ended), 8 (progress), 16 (detection started), 32 (detection finished);
	// no leds for the Load buttons
	//if(name=='justLoaded') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x11:0x25,((param1!=0 && param1!=32) ? 0x7F : 0x00));// set led on during loading

	if(name=='loopSize')
	{
		// turn off last led (if any is on)
		if(previousAutoLoopLightLed[deck]>-1)
			sendMidi(uniqueId,0x90,0,previousAutoLoopLightLed[deck],0x00);
		// calculate the new led to power on
		switch(param1)
		{
		case   64: previousAutoLoopLightLed[deck] = (deck==0)?0x01:0x15; break;// 1 beat
		case  128: previousAutoLoopLightLed[deck] = (deck==0)?0x02:0x16; break;// 2 beats
		case  256: previousAutoLoopLightLed[deck] = (deck==0)?0x03:0x17; break;// 4 beats
		case  512: previousAutoLoopLightLed[deck] = (deck==0)?0x04:0x18; break;// 8 beats
		default:   previousAutoLoopLightLed[deck] = -1;
		}
		// actually light the led
		if(previousAutoLoopLightLed[deck]>-1)
			sendMidi(uniqueId,0x90,0,previousAutoLoopLightLed[deck],0x7F);
	}
}
//-----------------------------------------------------------------------------
// this is called from time to time by the software (several times per second)
// (it is guaranteed that 'timerTick' will get executed ALWAYS right after notificationReceived)
function timerTick(uniqueId)
{
	//debug('timerTick ['+uniqueId+']');
}
//-----------------------------------------------------------------------------
