nicholas@2: /**
nicholas@2:  *  ape.js
nicholas@2:  *  Create the APE interface
nicholas@2:  */
nicholas@2: 
n@38: // preTest - In preTest state
n@38: // testRun-ID - In test running, test Id number at the end 'testRun-2'
n@38: // testRunPost-ID - Post test of test ID
n@38: // testRunPre-ID - Pre-test of test ID
n@38: // postTest - End of test, final submission!
n@38: 
n@32: 
nicholas@2: // Once this is loaded and parsed, begin execution
n@181: loadInterface();
nicholas@2: 
n@181: function loadInterface() {
nicholas@2: 	
n@16: 	// Get the dimensions of the screen available to the page
nicholas@2: 	var width = window.innerWidth;
nicholas@2: 	var height = window.innerHeight;
nicholas@2: 	
nicholas@2: 	// The injection point into the HTML page
n@182: 	interfaceContext.insertPoint = document.getElementById("topLevelBody");
n@22: 	var testContent = document.createElement('div');
nicholas@135: 	
n@22: 	testContent.id = 'testContent';
n@176: 
n@34: 	
n@52: 	// Create APE specific metric functions
n@52: 	audioEngineContext.metric.initialiseTest = function()
n@52: 	{
n@52: 	};
n@52: 	
n@52: 	audioEngineContext.metric.sliderMoved = function()
n@52: 	{
n@183: 		
n@52: 		var id = this.data;
n@52: 		this.data = -1;
n@52: 		var position = convSliderPosToRate(id);
b@115:         console.log('slider ' + id + ': '+ position + ' (' + time + ')'); // DEBUG/SAFETY: show position and slider id
n@52: 		if (audioEngineContext.timer.testStarted)
n@52: 		{
n@52: 			audioEngineContext.audioObjects[id].metric.moved(time,position);
n@52: 		}
n@52: 	};
n@52: 	
n@52: 	audioEngineContext.metric.sliderPlayed = function(id)
n@52: 	{
n@52: 		var time = audioEngineContext.timer.getTestTime();
n@52: 		if (audioEngineContext.timer.testStarted)
n@52: 		{
n@52: 			if (this.lastClicked >= 0)
n@52: 			{
n@52: 				audioEngineContext.audioObjects[this.lastClicked].metric.listening(time);
n@52: 			}
n@52: 			this.lastClicked = id;
n@52: 			audioEngineContext.audioObjects[id].metric.listening(time);
n@52: 		}
b@115:         console.log('slider ' + id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
n@52: 	};
n@52: 	
n@177: 	// Bindings for audioObjects
n@177: 	
nicholas@2: 	// Create the top div for the Title element
n@181: 	var titleAttr = specification.title;
nicholas@2: 	var title = document.createElement('div');
nicholas@2: 	title.className = "title";
nicholas@2: 	title.align = "center";
nicholas@2: 	var titleSpan = document.createElement('span');
nicholas@2: 	
nicholas@2: 	// Set title to that defined in XML, else set to default
nicholas@2: 	if (titleAttr != undefined) {
n@181: 		titleSpan.textContent = titleAttr;
nicholas@2: 	} else {
n@181: 		titleSpan.textContent =  'Listening test';
nicholas@2: 	}
nicholas@2: 	// Insert the titleSpan element into the title div element.
nicholas@2: 	title.appendChild(titleSpan);
nicholas@2: 	
n@47: 	var pagetitle = document.createElement('div');
n@47: 	pagetitle.className = "pageTitle";
n@47: 	pagetitle.align = "center";
n@47: 	var titleSpan = document.createElement('span');
n@47: 	titleSpan.id = "pageTitle";
n@47: 	pagetitle.appendChild(titleSpan);
n@47: 	
nicholas@7: 	// Create Interface buttons!
nicholas@7: 	var interfaceButtons = document.createElement('div');
nicholas@7: 	interfaceButtons.id = 'interface-buttons';
nicholas@7: 	
nicholas@7: 	// Create playback start/stop points
nicholas@7: 	var playback = document.createElement("button");
b@101: 	playback.innerHTML = 'Stop';
n@49: 	playback.id = 'playback-button';
n@16: 	// onclick function. Check if it is playing or not, call the correct function in the
n@16: 	// audioEngine, change the button text to reflect the next state.
nicholas@7: 	playback.onclick = function() {
b@101: 		if (audioEngineContext.status == 1) {
b@101: 			audioEngineContext.stop();
n@25: 			this.innerHTML = 'Stop';
b@115:             var time = audioEngineContext.timer.getTestTime();
b@115:             console.log('Stopped at ' + time); // DEBUG/SAFETY
nicholas@7: 		}
n@16: 	};
nicholas@7: 	// Create Submit (save) button
nicholas@7: 	var submit = document.createElement("button");
n@25: 	submit.innerHTML = 'Submit';
n@43: 	submit.onclick = buttonSubmitClick;
n@49: 	submit.id = 'submit-button';
n@16: 	// Append the interface buttons into the interfaceButtons object.
nicholas@7: 	interfaceButtons.appendChild(playback);
nicholas@7: 	interfaceButtons.appendChild(submit);
nicholas@7: 	
nicholas@2: 	// Now create the slider and HTML5 canvas boxes
nicholas@2: 	
n@16: 	// Create the div box to center align
nicholas@2: 	var sliderBox = document.createElement('div');
nicholas@2: 	sliderBox.className = 'sliderCanvasDiv';
n@16: 	sliderBox.id = 'sliderCanvasHolder';
nicholas@2: 	
n@16: 	// Create the slider box to hold the slider elements
nicholas@5: 	var canvas = document.createElement('div');
nicholas@2: 	canvas.id = 'slider';
n@127: 	canvas.align = "left";
n@127: 	canvas.addEventListener('dragover',function(event){
n@127: 		event.preventDefault();
n@127: 		return false;
n@127: 	},false);
n@127: 	var sliderMargin = document.createAttribute('marginsize');
n@127: 	sliderMargin.nodeValue = 42; // Set default margins to 42px either side
n@16: 	// Must have a known EXACT width, as this is used later to determine the ratings
n@127: 	var w = (Number(sliderMargin.nodeValue)+8)*2;
n@127: 	canvas.style.width = width - w +"px";
n@127: 	canvas.style.marginLeft = sliderMargin.nodeValue +'px';
n@127: 	canvas.setAttributeNode(sliderMargin);
nicholas@2: 	sliderBox.appendChild(canvas);
n@16: 	
n@47: 	// Create the div to hold any scale objects
n@47: 	var scale = document.createElement('div');
n@47: 	scale.className = 'sliderScale';
n@47: 	scale.id = 'sliderScaleHolder';
n@47: 	scale.align = 'left';
n@47: 	sliderBox.appendChild(scale);
n@47: 	
n@16: 	// Global parent for the comment boxes on the page
nicholas@3: 	var feedbackHolder = document.createElement('div');
n@34: 	feedbackHolder.id = 'feedbackHolder';
nicholas@2: 	
n@38: 	testContent.style.zIndex = 1;
n@182: 	interfaceContext.insertPoint.innerHTML = null; // Clear the current schema
n@38: 	
n@38: 	// Inject into HTML
n@38: 	testContent.appendChild(title); // Insert the title
n@47: 	testContent.appendChild(pagetitle);
n@38: 	testContent.appendChild(interfaceButtons);
n@38: 	testContent.appendChild(sliderBox);
n@38: 	testContent.appendChild(feedbackHolder);
n@182: 	interfaceContext.insertPoint.appendChild(testContent);
n@22: 
n@36: 	// Load the full interface
nicholas@129: 	testState.initialise();
nicholas@129: 	testState.advanceState();
nicholas@135: 	
nicholas@2: }
nicholas@5: 
n@181: function loadTest(audioHolderObject)
n@34: {
nicholas@110: 	
nicholas@110: 	// Reset audioEngineContext.Metric globals for new test
n@113: 	audioEngineContext.newTestPage();
nicholas@110: 	
n@181: 	var id = audioHolderObject.id;
n@34: 	
n@34: 	var feedbackHolder = document.getElementById('feedbackHolder');
n@34: 	var canvas = document.getElementById('slider');
n@34: 	feedbackHolder.innerHTML = null;
n@34: 	canvas.innerHTML = null;
n@47: 	
n@201: 	var playbackHolder = document.createElement('div');
n@201: 	playbackHolder.style.width = "100%";
n@201: 	playbackHolder.align = 'center';
n@201: 	playbackHolder.appendChild(interfaceContext.playhead.object);
n@201: 	feedbackHolder.appendChild(playbackHolder);
n@47: 	// Setup question title
n@184: 	var interfaceObj = audioHolderObject.interfaces;
n@184: 	var commentBoxPrefix = "Comment on track";
n@184: 	if (interfaceObj.length != 0) {
n@184: 		interfaceObj = interfaceObj[0];
n@184: 		var titleNode = interfaceObj.title;
n@184: 		if (titleNode != undefined)
n@184: 		{
n@184: 			document.getElementById('pageTitle').textContent = titleNode;
n@184: 		}
n@184: 		var positionScale = canvas.style.width.substr(0,canvas.style.width.length-2);
n@184: 		var offset = Number(document.getElementById('slider').attributes['marginsize'].value);
n@184: 		var scale = document.getElementById('sliderScaleHolder');
n@184: 		scale.innerHTML = null;
n@184: 		$(interfaceObj.scale).each(function(index,scaleObj){
n@184: 			var value = document.createAttribute('value');
n@184: 			var position = Number(scaleObj[0])*0.01;
n@184: 			value.nodeValue = position;
n@184: 			var pixelPosition = (position*positionScale)+offset;
n@184: 			var scaleDOM = document.createElement('span');
n@184: 			scaleDOM.textContent = scaleObj[1];
n@184: 			scale.appendChild(scaleDOM);
n@184: 			scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px';
n@184: 			scaleDOM.setAttributeNode(value);
n@184: 		});
n@184: 		
n@184: 		if (interfaceObj.commentBoxPrefix != undefined) {
n@184: 			commentBoxPrefix = interfaceObj.commentBoxPrefix;
n@184: 		}
n@174: 	}
n@34: 
n@34: 	/// CHECK FOR SAMPLE RATE COMPATIBILITY
n@181: 	if (audioHolderObject.sampleRate != undefined) {
n@181: 		if (Number(audioHolderObject.sampleRate) != audioContext.sampleRate) {
n@184: 			var errStr = 'Sample rates do not match! Requested '+Number(audioHolderObject.sampleRate)+', got '+audioContext.sampleRate+'. Please set the sample rate to match before completing this test.';
n@34: 			alert(errStr);
n@34: 			return;
n@34: 		}
n@34: 	}
n@45: 	
n@181: 	var commentShow = audioHolderObject.elementComments;
nicholas@66: 	
n@181: 	var loopPlayback = audioHolderObject.loop;
n@181: 
n@57: 	audioEngineContext.loopPlayback = loopPlayback;
n@57: 	// Create AudioEngine bindings for playback
n@202: 	audioEngineContext.selectedTrack = function(id) {
n@202: 		console.log('Deprecated');
n@202: 	};
n@57: 	
n@46: 	currentTestHolder = document.createElement('audioHolder');
n@181: 	currentTestHolder.id = audioHolderObject.id;
n@181: 	currentTestHolder.repeatCount = audioHolderObject.repeatCount;
n@46: 	
n@181: 	var randomise = audioHolderObject.randomiseOrder;
n@45: 	
n@181: 	var audioElements = audioHolderObject.audioElements;
nicholas@58: 	currentTrackOrder = [];
n@45: 	if (randomise) {
n@181: 		audioHolderObject.audioElements = randomiseOrder(audioHolderObject.audioElements);
n@45: 	}
n@45: 	
nicholas@58: 	// Delete any previous audioObjects associated with the audioEngine
nicholas@58: 	audioEngineContext.audioObjects = [];
nicholas@58: 	
n@45: 	// Find all the audioElements from the audioHolder
n@181: 	$(audioHolderObject.audioElements).each(function(index,element){
n@34: 		// Find URL of track
n@34: 		// In this jQuery loop, variable 'this' holds the current audioElement.
n@34: 		
n@34: 		// Now load each audio sample. First create the new track by passing the full URL
n@181: 		var trackURL = audioHolderObject.hostURL + element.url;
n@182: 		var audioObject = audioEngineContext.newTrack(element);
nicholas@66: 		
nicholas@66: 		if (commentShow) {
n@182: 			var node = interfaceContext.createCommentBox(audioObject);
nicholas@66: 		}
n@34: 		
n@34: 		// Create a slider per track
n@183: 		audioObject.interfaceDOM = new sliderObject(audioObject);
n@154: 		
n@34: 		// Distribute it randomnly
n@138: 		var w = window.innerWidth - (offset+8)*2;
n@34: 		w = Math.random()*w;
n@138: 		w = Math.floor(w+(offset+8));
n@183: 		audioObject.interfaceDOM.trackSliderObj.style.left = w+'px';
n@34: 		
n@183: 		canvas.appendChild(audioObject.interfaceDOM.trackSliderObj);
n@183: 		audioObject.metric.initialised(convSliderPosToRate(audioObject.interfaceDOM.trackSliderObj));
b@102:         
n@34: 	});
n@182: 	if (commentShow) {
n@182: 		interfaceContext.showCommentBoxes(feedbackHolder,true);
n@182: 	}
n@39: 	
n@181: 	$(audioHolderObject.commentQuestions).each(function(index,element) {
n@193: 		var node = interfaceContext.createCommentQuestion(element);
n@193: 		feedbackHolder.appendChild(node.holder);
nicholas@65: 	});
n@153: 	
n@153: 	
n@153: 	testWaitIndicator();
n@39: }
n@39: 
n@183: function sliderObject(audioObject) {
n@183: 	// Create a new slider object;
n@183: 	this.parent = audioObject;
n@183: 	this.trackSliderObj = document.createElement('div');
n@183: 	this.trackSliderObj.className = 'track-slider';
n@183: 	this.trackSliderObj.id = 'track-slider-'+audioObject.id;
n@183: 
n@183: 	this.trackSliderObj.setAttribute('trackIndex',audioObject.id);
n@183: 	this.trackSliderObj.innerHTML = '<span>'+audioObject.id+'</span>';
n@183: 	this.trackSliderObj.draggable = true;
n@183: 	this.trackSliderObj.ondragend = dragEnd;
n@183: 
n@183: 	// Onclick, switch playback to that track
n@183: 	this.trackSliderObj.onclick = function() {
n@183: 		// Start the test on first click, that way timings are more accurate.
n@183: 		audioEngineContext.play();
n@183: 		if (audioEngineContext.audioObjectsReady) {
n@183: 			// Cannot continue to issue play command until audioObjects reported as ready!
n@183: 			// Get the track ID from the object ID
n@183: 			var id = Number(event.srcElement.attributes['trackIndex'].value);
n@183: 			//audioEngineContext.metric.sliderPlayed(id);
n@202: 			audioEngineContext.play(id);
n@183:             // Currently playing track red, rest green
n@183:             
n@183:             //document.getElementById('track-slider-'+index).style.backgroundColor = "#FF0000";
n@183:             $('.track-slider').removeClass('track-slider-playing');
n@183:             $(event.srcElement).addClass('track-slider-playing');
n@183:             $('.comment-div').removeClass('comment-box-playing');
n@183:             $('#comment-div-'+id).addClass('comment-box-playing');
n@183: 		}
n@183: 	};
n@183: 	
n@183: 	this.exportXMLDOM = function() {
n@183: 		// Called by the audioObject holding this element. Must be present
n@183: 		var node = document.createElement('value');
n@183: 		node.textContent = convSliderPosToRate(this.trackSliderObj);
n@183: 		return node;
n@183: 	};
n@183: }
nicholas@119: 
nicholas@5: function dragEnd(ev) {
nicholas@5: 	// Function call when a div has been dropped
n@33: 	var slider = document.getElementById('slider');
n@127: 	var marginSize = Number(slider.attributes['marginsize'].value);
n@51: 	var w = slider.style.width;
n@51: 	w = Number(w.substr(0,w.length-2));
nicholas@133: 	var x = ev.x;
n@127: 	if (x >= marginSize && x < w+marginSize) {
n@51: 		this.style.left = (x)+'px';
nicholas@5: 	} else {
n@127: 		if (x<marginSize) {
n@127: 			this.style.left = marginSize+'px';
nicholas@5: 		} else {
n@127: 			this.style.left = (w+marginSize) + 'px';
nicholas@5: 		}
nicholas@5: 	}
n@183: 	var time = audioEngineContext.timer.getTestTime();
n@183: 	var id = Number(ev.srcElement.getAttribute('trackindex'));
n@183: 	audioEngineContext.audioObjects[id].metric.moved(time,convSliderPosToRate(ev.srcElement));
nicholas@5: }
nicholas@7: 
b@101: function buttonSubmitClick() // TODO: Only when all songs have been played!
n@40: {
nicholas@107:     hasBeenPlayed = audioEngineContext.checkAllPlayed();
nicholas@107:     if (hasBeenPlayed.length == 0) {
nicholas@107: 	    if (audioEngineContext.status == 1) {
nicholas@107: 	        var playback = document.getElementById('playback-button');
nicholas@107: 	        playback.click();
nicholas@107: 	    // This function is called when the submit button is clicked. Will check for any further tests to perform, or any post-test options
nicholas@107: 	    } else
nicholas@107: 	    {
nicholas@107: 	        if (audioEngineContext.timer.testStarted == false)
nicholas@107: 	        {
nicholas@107: 	            alert('You have not started the test! Please press start to begin the test!');
nicholas@107: 	            return;
nicholas@107: 	        }
nicholas@107: 	    }
nicholas@129: 	    testState.advanceState();
b@102:     } else // if a fragment has not been played yet
b@102:     {
nicholas@107:     	str = "";
nicholas@107:     	if (hasBeenPlayed.length > 1) {
nicholas@107: 	    	for (var i=0; i<hasBeenPlayed.length; i++) {
nicholas@107: 	    		str = str + hasBeenPlayed[i];
nicholas@107: 	    		if (i < hasBeenPlayed.length-2){
nicholas@107: 	    			str += ", ";
nicholas@107: 	    		} else if (i == hasBeenPlayed.length-2) {
nicholas@107: 	    			str += " or ";
nicholas@107: 	    		}
nicholas@107: 	    	}
nicholas@107: 	    	alert('You have not played fragments ' + str + ' yet. Please listen, rate and comment all samples before submitting.');
nicholas@107:        } else {
nicholas@107:        		alert('You have not played fragment ' + hasBeenPlayed[0] + ' yet. Please listen, rate and comment all samples before submitting.');
nicholas@107:        }
b@102:         return;
b@102:     }
n@40: }
n@40: 
n@183: function convSliderPosToRate(slider)
n@51: {
n@51: 	var w = document.getElementById('slider').style.width;
n@127: 	var marginsize = Number(document.getElementById('slider').attributes['marginsize'].value);
n@51: 	var maxPix = w.substr(0,w.length-2);
n@51: 	var pix = slider.style.left;
n@51: 	pix = pix.substr(0,pix.length-2);
n@127: 	var rate = (pix-marginsize)/maxPix;
n@51: 	return rate;
n@51: }
n@51: 
n@127: function resizeWindow(event){
n@127: 	// Function called when the window has been resized.
n@127: 	// MANDATORY FUNCTION
n@127: 	
n@127: 	// Store the slider marker values
n@127: 	var holdValues = [];
n@127: 	$(".track-slider").each(function(index,sliderObj){
n@127: 		holdValues.push(convSliderPosToRate(index));
n@127: 	});
n@127: 	
n@127: 	var width = event.target.innerWidth;
n@127: 	var canvas = document.getElementById('sliderCanvasHolder');
n@127: 	var sliderDiv = canvas.children[0];
n@127: 	var sliderScaleDiv = canvas.children[1];
n@127: 	var marginsize = Number(sliderDiv.attributes['marginsize'].value);
n@127: 	var w = (marginsize+8)*2;
n@127: 	sliderDiv.style.width = width - w + 'px';
n@127: 	var width = width - w;
n@127: 	// Move sliders into new position
n@127: 	$(".track-slider").each(function(index,sliderObj){
n@127: 		var pos = holdValues[index];
n@127: 		var pix = pos * width;
n@127: 		sliderObj.style.left = pix+marginsize+'px';
n@127: 	});
n@127: 	
n@127: 	// Move scale labels
n@127: 	$(sliderScaleDiv.children).each(function(index,scaleObj){
n@127: 		var position = Number(scaleObj.attributes['value'].value);
n@127: 		var pixelPosition = (position*width)+marginsize;
n@127: 		scaleObj.style.left = Math.floor((pixelPosition-($(scaleObj).width()/2)))+'px';
n@127: 	});
n@127: }
n@127: 
n@181: function pageXMLSave(store, testXML)
n@44: {
n@44: 	// Saves a specific test page
nicholas@129: 	var xmlDoc = store;
n@50: 	// Check if any session wide metrics are enabled
nicholas@67: 	
n@181: 	var commentShow = testXML.elementComments;
nicholas@67: 	
n@50: 	var metric = document.createElement('metric');
n@50: 	if (audioEngineContext.metric.enableTestTimer)
n@50: 	{
n@50: 		var testTime = document.createElement('metricResult');
n@50: 		testTime.id = 'testTime';
n@50: 		testTime.textContent = audioEngineContext.timer.testDuration;
n@50: 		metric.appendChild(testTime);
n@50: 	}
n@50: 	xmlDoc.appendChild(metric);
n@178: 	var audioObjects = audioEngineContext.audioObjects;
n@178: 	for (var i=0; i<audioObjects.length; i++) 
n@45: 	{
n@183: 		var audioElement = audioEngineContext.audioObjects[i].exportXMLDOM();
n@45: 		xmlDoc.appendChild(audioElement);
n@45: 	}
n@193: 	
n@193: 	$(interfaceContext.commentQuestions).each(function(index,element){
n@193: 		var node = element.exportXMLDOM();
n@193: 		xmlDoc.appendChild(node);
n@193: 	});
nicholas@129: 	store = xmlDoc;
nicholas@67: }