//-----------------------------------------------------------------------------
//------------ Copyright (c)2003-2018 Xylio. All Rights Reserved. -------------
//-----------------------------------------------------------------------------
// file implementing MIDI controller 'Hercules DJ Control Compact'
//-----------------------------------------------------------------------------
function getLanguageVersion()
{
	return 1;// do not modify this, this should be 1 for all scripts
}
//-----------------------------------------------------------------------------
function getFileVersion()
{
	return 2;// update this as needed
}
//-----------------------------------------------------------------------------
// return a user friendly name for the controller supported
function getControllerUserFriendlyName()
{
	return "DJControl Compact";
}
//-----------------------------------------------------------------------------
// 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 0xB11E;
}
//-----------------------------------------------------------------------------
// 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 "00014E020016";
	// 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
	// F0 7E 00 06 02 00 01 4E 02 00 0B 00 01 00 00 00 F7 -- Hercules DJ Control Air complete sysex
	// F0 7E 00 06 02 00 01 4E 02 00 0C 00 01 00 00 00 F7 -- Hercules DJ Control Instinct complete sysex
	// F0 7E 00 06 02 00 01 4E 02 00 10 00 01 00 00 00 F7 -- Hercules DJ Control Air+ complete sysex
	// F0 7E 00 06 02 00 01 4E 02 00 0A 00 01 00 00 00 F7 -- Hercules DJ4Set complete sysex
	// F0 7E 00 06 02 00 01 4E 02 00 09 00 01 00 00 00 F7 -- Hercules DJ Console 4-Mx
	// F0 7E 7F 06 02 00 01 4E 02 00 16 00 01 00 00 00 F7 -- Hercules DJ Control Compact
	// F0 7E 7F 06 02 00 01 4E 02 00 12 00 01 00 00 00 F7 -- Hercules Universal DJ
}
//-----------------------------------------------------------------------------
// 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 "DJControl Compact";
	return "DJControl Compact";
}
//-----------------------------------------------------------------------------
function getSupportedMidiDeviceNameForOutput(osId)
{
	//if(osId==1) return "DJControl Compact";
	return "DJControl Compact";
}
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
// some variables necessary only for this particular script
var jogWheelsInScratchMode=0;
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 Hercules DJControl Compact ['+uniqueId+']');// this outputs a string to DebugView app on Win

	//sendMidi(uniqueId, status, channel, data1, data2);
	sendMidi(uniqueId,0x90,0,0x2D,(jogWheelsInScratchMode ? 0x7F : 0x00));// scratch mode
	//------------------------------------
	callSendAllNotifications(uniqueId, true);// send all notifications to the controller (so that we don't have to manually init all leds/lcd screens)

}
//-----------------------------------------------------------------------------
// 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 0x36: call('setCrossfader', data2); break;

		// per deck
		// deck A
		case 0x3C: call('setDeckEqLow', 0, data2); break;
		case 0x3B: call('setDeckEqMid', 0, data2); break;
		case 0x39: call('setDeckVolume', 0, data2); break;
		case 0x30: // params: (deck, increment, total positions per complete revolution)
		{
			var val1 = (data2>0x40 ? data2-0x80 : data2);
			if(jogWheelsInScratchMode)
				call('scratchDeckJW', 0, val1, 250);
			else
				call('moveDeckJogWheel', 0, val1, 250);
			break;
		}
		case 0x37:
		{
			var val1 = (data2>0x40 ? data2-0x80 : data2);
			call('searchDeckJW', 0, val1, 250);
			break;
		}

		// deck B
		case 0x40: call('setDeckEqLow', 1, data2); break;
		case 0x3F: call('setDeckEqMid', 1, data2); break;
		case 0x3D: call('setDeckVolume', 1, data2); break;
		case 0x31: // params: (deck, increment, total positions per complete revolution)
		{
			var val1 = (data2>0x40 ? data2-0x80 : data2);
			if(jogWheelsInScratchMode)
				call('scratchDeckJW', 1, val1, 250);
			else
				call('moveDeckJogWheel', 1, val1, 250);
			break;
		}
		case 0x38:
		{
			var val1 = (data2>0x40 ? data2-0x80 : data2);
			call('searchDeckJW', 1, val1, 250);
			break;
		}

		default: messageNotProcessed = true;
		}
		break;
	//-----------------------------------------------
	// note on/off: buttons, switches ('pressing' things)
	case 0x80:
	case 0x90:
		switch(data1)
		{
		// global
		case 0x2D:
			if(data2>0x3F)
			{
				jogWheelsInScratchMode = (jogWheelsInScratchMode+1) % 2;
				sendMidi(uniqueId,0x90,0,0x2D,(jogWheelsInScratchMode ? 0x7F : 0x00));
				break;
			}
		case 0x2E: call('setAutoDj', data2); break;
		case 0x2B: call('record', data2); break;

		// deck A
		//Pads - Loop:
		case 0x19: call('deckLoop1', 0, data2); break;
		case 0x1A: call('deckLoop2', 0, data2); break;
		case 0x1B: call('deckLoop4', 0, data2); break;
		case 0x1C: call('deckLoop8', 0, data2); break;
		// with Shift
		case 0x1D: call('deckLoopInEnd', 0, data2); break;
		case 0x1E: call('deckLoopExitOrReloop', 0, data2); break;
		case 0x1F: call('deckLoopPrev', 0, data2); break;
		case 0x20: call('deckLoopNext', 0, data2); break;

		//Pads - FX:
		case 0x09: call('deckFxFlanger', 0, data2); break;
		case 0x0A: call('deckFxEcho', 0, data2); break;
		case 0x0B: call('deckFxBeatwaw', 0, data2); break;
		case 0x0C: call('deckFxReverb', 0, data2); break;
		case 0x0D: call('deckBrake', 0, data2); break;
		case 0x0E: call('deckReverse', 0, data2); break;

		//Pads - Sample
		case 0x11: call('sampler1', data2); break;
		case 0x12: call('sampler2', data2); break;
		case 0x13: call('sampler3', data2); break;
		case 0x14: call('sampler4', data2); break;
		//Shift 0x15...

		//Pads - Cue
		case 0x01: call('deckCuePos1', 0, data2); break;
		case 0x02: call('deckCuePos2', 0, data2); break;
		case 0x03: call('deckCuePos3', 0, data2); break;
		case 0x04: call('deckCuePos4', 0, data2); break;
		// with Shift
		case 0x05: call('deckCuePos5', 0, data2); break;
		case 0x06: call('deckCuePos6', 0, data2); break;
		case 0x07: call('deckCuePos7', 0, data2); break;
		case 0x08: call('deckCuePos8', 0, data2); break;


		case 0x21: call('deckPlayPause', 0, data2); break;
		case 0x22: call('deckCue', 0, data2); break;
		case 0x23: call('deckSync', 0, data2); break;
		// with Shift
		case 0x24: call('deckReverse', 0, data2); break;
		case 0x25: call('deckCuePlay', 0, data2); break;
		case 0x26: call('deckMatch', 0, data2); break;


		// deck B
		//Pads - Loop:
		case 0x49: call('deckLoop1', 1, data2); break;
		case 0x4A: call('deckLoop2', 1, data2); break;
		case 0x4B: call('deckLoop4', 1, data2); break;
		case 0x4C: call('deckLoop8', 1, data2); break;
		// with Shift
		case 0x4D: call('deckLoopInEnd', 1, data2); break;
		case 0x4E: call('deckLoopExitOrReloop', 1, data2); break;
		case 0x4F: call('deckLoopPrev', 1, data2); break;
		case 0x50: call('deckLoopNext', 1, data2); break;

		//Pads - FX:
		case 0x39: call('deckFxFlanger', 1, data2); break;
		case 0x3A: call('deckFxEcho', 1, data2); break;
		case 0x3B: call('deckFxBeatwaw', 1, data2); break;
		case 0x3C: call('deckFxReverb', 1, data2); break;
		case 0x3D: call('deckBrake', 1, data2); break;
		case 0x3E: call('deckReverse', 1, data2); break;

		//Pads - Sample
		case 0x41: call('sampler5', data2); break;
		case 0x42: call('sampler6', data2); break;
		case 0x43: call('sampler7', data2); break;
		case 0x44: call('sampler8', data2); break;
		//Shift 0x45...

		//Pads - Cue
		case 0x31: call('deckCuePos1', 1, data2); break;
		case 0x32: call('deckCuePos2', 1, data2); break;
		case 0x33: call('deckCuePos3', 1, data2); break;
		case 0x34: call('deckCuePos4', 1, data2); break;
		// with Shift
		case 0x35: call('deckCuePos5', 1, data2); break;
		case 0x36: call('deckCuePos6', 1, data2); break;
		case 0x37: call('deckCuePos7', 1, data2); break;
		case 0x38: call('deckCuePos8', 1, data2); break;


		case 0x51: call('deckPlayPause', 1, data2); break;
		case 0x52: call('deckCue', 1, data2); break;
		case 0x53: call('deckSync', 1, data2); break;
		// with Shift
		case 0x54: call('deckReverse', 1, data2); break;
		case 0x55: call('deckCuePlay', 1, data2); break;
		case 0x56: call('deckMatch', 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;
	var nameLen = name.length;

	if(name=='autoDj') 		sendMidi(uniqueId,0x90,0,0x2E,(param1 ? 0x7F : 0x00));// automix
	if(name=='recording')	sendMidi(uniqueId,0x90,0,0x2B,(param1 ? 0x7F : 0x00));// record

	if(name=='onbeat') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x23:0x53,(param1 ? 0x7F : 0x00));
	if(name=='cue') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x22:0x52,(param1 ? 0x7F : 0x00));
	if(name=='play') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x21:0x51,(param1 ? 0x7F : 0x00));


	//Pads - Loop:
	if(name=='loopSize')
	{
		var loopSize = getValue('loopSize', deck);
		sendMidi(uniqueId,0x90,0,(deck==0)?0x19:0x49, (loopSize==64  ? 0x7F : 0x00));// loop 1
		sendMidi(uniqueId,0x90,0,(deck==0)?0x1A:0x4A, (loopSize==128 ? 0x7F : 0x00));// loop 2
		sendMidi(uniqueId,0x90,0,(deck==0)?0x1B:0x4B, (loopSize==256 ? 0x7F : 0x00));// loop 4
		sendMidi(uniqueId,0x90,0,(deck==0)?0x1C:0x4C, (loopSize==512 ? 0x7F : 0x00));// loop 8
	}
	if(name=='loopBlink')
	{
		sendMidi(uniqueId,0x90,0,(deck==0)?0x1D:0x4E,(param1 ? 0x7F : 0x00));// deckLoopInEnd
		sendMidi(uniqueId,0x90,0,(deck==0)?0x1E:0x4D,(param1 ? 0x7F : 0x00));// deckLoopExitOrReloop
	}

	//Pads - FX:
	if(name=='fxFlanger') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x09:0x39,(param1 ? 0x7F : 0x00));
	if(name=='fxEcho') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x0A:0x3A,(param1 ? 0x7F : 0x00));
	if(name=='fxBeatwaw') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x0B:0x3B,(param1 ? 0x7F : 0x00));
	if(name=='fxReverb') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x0C:0x3C,(param1 ? 0x7F : 0x00));
	// with shift
	if(name=='brake') 		sendMidi(uniqueId,0x90,0,(deck==0)?0x0D:0x3D,(param1 ? 0x7F : 0x00));
	if(name=='reverse')
	{
		sendMidi(uniqueId,0x90,0,(deck==0)?0x24:0x54,(param1 ? 0x7F : 0x00));// play
		sendMidi(uniqueId,0x90,0,(deck==0)?0x0E:0x3E,(param1 ? 0x7F : 0x00));// pad
	}

	//Pads - Sample
	if(nameLen==13)
	{
		var name1 = name.substr(0, nameLen-1);
		if(name1=='samplerBlink')
		{
			// deck A
			if(name=='samplerBlink1') sendMidi(uniqueId,0x90,0,0x11,(param1 ? 0x7F : 0x00));
			if(name=='samplerBlink2') sendMidi(uniqueId,0x90,0,0x12,(param1 ? 0x7F : 0x00));
			if(name=='samplerBlink3') sendMidi(uniqueId,0x90,0,0x13,(param1 ? 0x7F : 0x00));
			if(name=='samplerBlink4') sendMidi(uniqueId,0x90,0,0x14,(param1 ? 0x7F : 0x00));
			// deck B
			if(name=='samplerBlink5') sendMidi(uniqueId,0x90,0,0x41,(param1 ? 0x7F : 0x00));
			if(name=='samplerBlink6') sendMidi(uniqueId,0x90,0,0x42,(param1 ? 0x7F : 0x00));
			if(name=='samplerBlink7') sendMidi(uniqueId,0x90,0,0x43,(param1 ? 0x7F : 0x00));
			if(name=='samplerBlink8') sendMidi(uniqueId,0x90,0,0x44,(param1 ? 0x7F : 0x00));
		}
	}

	//Pads - Cue
	if(name=='cuepos1') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x01:0x31,(param1 ? 0x7F : 0x00));
	if(name=='cuepos2') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x02:0x32,(param1 ? 0x7F : 0x00));
	if(name=='cuepos3') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x03:0x33,(param1 ? 0x7F : 0x00));
	if(name=='cuepos4') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x04:0x34,(param1 ? 0x7F : 0x00));
	if(name=='cuepos5') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x05:0x35,(param1 ? 0x7F : 0x00));
	if(name=='cuepos6') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x06:0x36,(param1 ? 0x7F : 0x00));
	if(name=='cuepos7') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x07:0x37,(param1 ? 0x7F : 0x00));
	if(name=='cuepos8') 	sendMidi(uniqueId,0x90,0,(deck==0)?0x08:0x38,(param1 ? 0x7F : 0x00));
}
//-----------------------------------------------------------------------------
// 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+']');
}
//-----------------------------------------------------------------------------
