nicholas@2: /**
nicholas@2:  *  ape.js
nicholas@2:  *  Create the APE interface
nicholas@2:  */
nicholas@2: 
n@662: // preTest - In preTest state
n@662: // testRun-ID - In test running, test Id number at the end 'testRun-2'
n@662: // testRunPost-ID - Post test of test ID
n@662: // testRunPre-ID - Pre-test of test ID
n@662: // postTest - End of test, final submission!
n@662: 
n@656: 
nicholas@2: // Once this is loaded and parsed, begin execution
n@911: loadInterface();
nicholas@2: 
n@911: function loadInterface() {
nicholas@2: 	
n@701: 	// 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@912: 	interfaceContext.insertPoint = document.getElementById("topLevelBody");
n@706: 	var testContent = document.createElement('div');
nicholas@934: 	
n@706: 	testContent.id = 'testContent';
n@906: 
n@658: 	
n@676: 	// Create APE specific metric functions
n@676: 	audioEngineContext.metric.initialiseTest = function()
n@676: 	{
n@676: 	};
n@676: 	
n@676: 	audioEngineContext.metric.sliderMoved = function()
n@676: 	{
n@913: 		
n@676: 		var id = this.data;
n@676: 		this.data = -1;
n@676: 		var position = convSliderPosToRate(id);
BrechtDeMan@936:         console.log('slider ' + id + ': '+ position + ' (' + time + ')'); // DEBUG/SAFETY: show position and slider id
n@676: 		if (audioEngineContext.timer.testStarted)
n@676: 		{
n@676: 			audioEngineContext.audioObjects[id].metric.moved(time,position);
n@676: 		}
n@676: 	};
n@676: 	
n@676: 	audioEngineContext.metric.sliderPlayed = function(id)
n@676: 	{
n@676: 		var time = audioEngineContext.timer.getTestTime();
n@676: 		if (audioEngineContext.timer.testStarted)
n@676: 		{
n@676: 			if (this.lastClicked >= 0)
n@676: 			{
n@676: 				audioEngineContext.audioObjects[this.lastClicked].metric.listening(time);
n@676: 			}
n@676: 			this.lastClicked = id;
n@676: 			audioEngineContext.audioObjects[id].metric.listening(time);
n@676: 		}
BrechtDeMan@936:         console.log('slider ' + id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
n@676: 	};
n@676: 	
n@907: 	// Bindings for audioObjects
n@907: 	
nicholas@2: 	// Create the top div for the Title element
n@911: 	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@911: 		titleSpan.textContent = titleAttr;
nicholas@2: 	} else {
n@911: 		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@671: 	var pagetitle = document.createElement('div');
n@671: 	pagetitle.className = "pageTitle";
n@671: 	pagetitle.align = "center";
n@671: 	var titleSpan = document.createElement('span');
n@671: 	titleSpan.id = "pageTitle";
n@671: 	pagetitle.appendChild(titleSpan);
n@671: 	
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");
BrechtDeMan@939: 	playback.innerHTML = 'Stop';
n@673: 	playback.id = 'playback-button';
n@701: 	// onclick function. Check if it is playing or not, call the correct function in the
n@701: 	// audioEngine, change the button text to reflect the next state.
nicholas@7: 	playback.onclick = function() {
BrechtDeMan@939: 		if (audioEngineContext.status == 1) {
BrechtDeMan@939: 			audioEngineContext.stop();
n@709: 			this.innerHTML = 'Stop';
BrechtDeMan@936:             var time = audioEngineContext.timer.getTestTime();
BrechtDeMan@936:             console.log('Stopped at ' + time); // DEBUG/SAFETY
nicholas@7: 		}
n@701: 	};
nicholas@7: 	// Create Submit (save) button
nicholas@7: 	var submit = document.createElement("button");
n@709: 	submit.innerHTML = 'Submit';
n@667: 	submit.onclick = buttonSubmitClick;
n@673: 	submit.id = 'submit-button';
n@701: 	// 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@701: 	// Create the div box to center align
nicholas@2: 	var sliderBox = document.createElement('div');
nicholas@2: 	sliderBox.className = 'sliderCanvasDiv';
n@701: 	sliderBox.id = 'sliderCanvasHolder';
nicholas@2: 	
n@701: 	// Create the slider box to hold the slider elements
nicholas@5: 	var canvas = document.createElement('div');
nicholas@2: 	canvas.id = 'slider';
n@963: 	canvas.align = "left";
n@963: 	canvas.addEventListener('dragover',function(event){
n@963: 		event.preventDefault();
n@963: 		return false;
n@963: 	},false);
n@963: 	var sliderMargin = document.createAttribute('marginsize');
n@963: 	sliderMargin.nodeValue = 42; // Set default margins to 42px either side
n@701: 	// Must have a known EXACT width, as this is used later to determine the ratings
n@963: 	var w = (Number(sliderMargin.nodeValue)+8)*2;
n@963: 	canvas.style.width = width - w +"px";
n@963: 	canvas.style.marginLeft = sliderMargin.nodeValue +'px';
n@963: 	canvas.setAttributeNode(sliderMargin);
nicholas@2: 	sliderBox.appendChild(canvas);
n@701: 	
n@671: 	// Create the div to hold any scale objects
n@671: 	var scale = document.createElement('div');
n@671: 	scale.className = 'sliderScale';
n@671: 	scale.id = 'sliderScaleHolder';
n@671: 	scale.align = 'left';
n@671: 	sliderBox.appendChild(scale);
n@671: 	
n@701: 	// Global parent for the comment boxes on the page
nicholas@3: 	var feedbackHolder = document.createElement('div');
n@658: 	feedbackHolder.id = 'feedbackHolder';
n@656: 	
n@662: 	testContent.style.zIndex = 1;
n@912: 	interfaceContext.insertPoint.innerHTML = null; // Clear the current schema
n@656: 	
n@662: 	// Inject into HTML
n@662: 	testContent.appendChild(title); // Insert the title
n@671: 	testContent.appendChild(pagetitle);
n@662: 	testContent.appendChild(interfaceButtons);
n@662: 	testContent.appendChild(sliderBox);
n@662: 	testContent.appendChild(feedbackHolder);
n@912: 	interfaceContext.insertPoint.appendChild(testContent);
n@656: 
n@660: 	// Load the full interface
nicholas@964: 	testState.initialise();
nicholas@964: 	testState.advanceState();
n@663: 	
n@656: }
n@656: 
n@911: function loadTest(audioHolderObject)
n@658: {
nicholas@947: 	
nicholas@947: 	// Reset audioEngineContext.Metric globals for new test
n@950: 	audioEngineContext.newTestPage();
nicholas@947: 	
n@911: 	var id = audioHolderObject.id;
n@658: 	
n@658: 	var feedbackHolder = document.getElementById('feedbackHolder');
n@658: 	var canvas = document.getElementById('slider');
n@658: 	feedbackHolder.innerHTML = null;
n@658: 	canvas.innerHTML = null;
n@671: 	
n@671: 	// Setup question title
n@914: 	var interfaceObj = audioHolderObject.interfaces;
n@914: 	var commentBoxPrefix = "Comment on track";
n@914: 	if (interfaceObj.length != 0) {
n@914: 		interfaceObj = interfaceObj[0];
n@914: 		var titleNode = interfaceObj.title;
n@914: 		if (titleNode != undefined)
n@914: 		{
n@914: 			document.getElementById('pageTitle').textContent = titleNode;
n@914: 		}
n@914: 		var positionScale = canvas.style.width.substr(0,canvas.style.width.length-2);
n@914: 		var offset = Number(document.getElementById('slider').attributes['marginsize'].value);
n@914: 		var scale = document.getElementById('sliderScaleHolder');
n@914: 		scale.innerHTML = null;
n@914: 		$(interfaceObj.scale).each(function(index,scaleObj){
n@914: 			var value = document.createAttribute('value');
n@914: 			var position = Number(scaleObj[0])*0.01;
n@914: 			value.nodeValue = position;
n@914: 			var pixelPosition = (position*positionScale)+offset;
n@914: 			var scaleDOM = document.createElement('span');
n@914: 			scaleDOM.textContent = scaleObj[1];
n@914: 			scale.appendChild(scaleDOM);
n@914: 			scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px';
n@914: 			scaleDOM.setAttributeNode(value);
n@914: 		});
n@914: 		
n@914: 		if (interfaceObj.commentBoxPrefix != undefined) {
n@914: 			commentBoxPrefix = interfaceObj.commentBoxPrefix;
n@914: 		}
n@1022: 	}
n@658: 
nicholas@7: 	/// CHECK FOR SAMPLE RATE COMPATIBILITY
n@911: 	if (audioHolderObject.sampleRate != undefined) {
n@911: 		if (Number(audioHolderObject.sampleRate) != audioContext.sampleRate) {
n@914: 			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.';
nicholas@7: 			alert(errStr);
nicholas@7: 			return;
nicholas@7: 		}
nicholas@7: 	}
n@669: 	
n@911: 	var commentShow = audioHolderObject.elementComments;
nicholas@689: 	
n@911: 	var loopPlayback = audioHolderObject.loop;
n@911: 
n@681: 	audioEngineContext.loopPlayback = loopPlayback;
n@681: 	// Create AudioEngine bindings for playback
n@681: 	if (loopPlayback) {
n@681: 		audioEngineContext.selectedTrack = function(id) {
n@681: 			for (var i=0; i<this.audioObjects.length; i++)
n@681: 			{
n@681: 				if (id == i) {
nicholas@967: 					this.audioObjects[i].loopStart();
n@681: 				} else {
nicholas@967: 					this.audioObjects[i].loopStop();
n@681: 				}
n@681: 			}
n@681: 		};
n@681: 	} else {
n@681: 		audioEngineContext.selectedTrack = function(id) {
n@681: 			for (var i=0; i<this.audioObjects.length; i++)
n@681: 			{
n@996: 				this.audioObjects[i].outputGain.gain.value = 0.0;
n@996: 				this.audioObjects[i].stop();
n@681: 			}
n@998: 			if (this.status == 1) {
n@998: 				this.audioObjects[id].outputGain.gain.value = 1.0;
n@998: 				this.audioObjects[id].play(audioContext.currentTime+0.01);
n@998: 			}
n@681: 		};
n@681: 	}
n@681: 	
n@670: 	currentTestHolder = document.createElement('audioHolder');
n@911: 	currentTestHolder.id = audioHolderObject.id;
n@911: 	currentTestHolder.repeatCount = audioHolderObject.repeatCount;
n@670: 	
n@911: 	var randomise = audioHolderObject.randomiseOrder;
n@669: 	
n@911: 	var audioElements = audioHolderObject.audioElements;
nicholas@682: 	currentTrackOrder = [];
n@669: 	if (randomise) {
n@911: 		audioHolderObject.audioElements = randomiseOrder(audioHolderObject.audioElements);
n@669: 	}
n@669: 	
nicholas@682: 	// Delete any previous audioObjects associated with the audioEngine
nicholas@682: 	audioEngineContext.audioObjects = [];
nicholas@682: 	
n@701: 	// Find all the audioElements from the audioHolder
n@911: 	$(audioHolderObject.audioElements).each(function(index,element){
nicholas@7: 		// Find URL of track
n@701: 		// In this jQuery loop, variable 'this' holds the current audioElement.
n@701: 		
n@701: 		// Now load each audio sample. First create the new track by passing the full URL
n@911: 		var trackURL = audioHolderObject.hostURL + element.url;
n@912: 		var audioObject = audioEngineContext.newTrack(element);
nicholas@689: 		
nicholas@689: 		if (commentShow) {
n@912: 			var node = interfaceContext.createCommentBox(audioObject);
nicholas@689: 		}
n@701: 		
nicholas@5: 		// Create a slider per track
n@913: 		audioObject.interfaceDOM = new sliderObject(audioObject);
n@1008: 		
nicholas@5: 		// Distribute it randomnly
n@1000: 		var w = window.innerWidth - (offset+8)*2;
nicholas@5: 		w = Math.random()*w;
n@1000: 		w = Math.floor(w+(offset+8));
n@913: 		audioObject.interfaceDOM.trackSliderObj.style.left = w+'px';
nicholas@8: 		
n@913: 		canvas.appendChild(audioObject.interfaceDOM.trackSliderObj);
n@913: 		audioObject.metric.initialised(convSliderPosToRate(audioObject.interfaceDOM.trackSliderObj));
BrechtDeMan@940:         
n@700: 	});
n@912: 	if (commentShow) {
n@912: 		interfaceContext.showCommentBoxes(feedbackHolder,true);
n@912: 	}
nicholas@3: 	
n@911: 	$(audioHolderObject.commentQuestions).each(function(index,element) {
n@1026: 		var node = interfaceContext.createCommentQuestion(element);
n@1026: 		feedbackHolder.appendChild(node.holder);
nicholas@688: 	});
n@1007: 	
n@1007: 	
n@1007: 	testWaitIndicator();
n@663: }
n@663: 
n@913: function sliderObject(audioObject) {
n@913: 	// Create a new slider object;
n@913: 	this.parent = audioObject;
n@913: 	this.trackSliderObj = document.createElement('div');
n@913: 	this.trackSliderObj.className = 'track-slider';
n@913: 	this.trackSliderObj.id = 'track-slider-'+audioObject.id;
n@913: 
n@913: 	this.trackSliderObj.setAttribute('trackIndex',audioObject.id);
n@913: 	this.trackSliderObj.innerHTML = '<span>'+audioObject.id+'</span>';
n@913: 	this.trackSliderObj.draggable = true;
n@913: 	this.trackSliderObj.ondragend = dragEnd;
n@913: 
n@913: 	// Onclick, switch playback to that track
n@913: 	this.trackSliderObj.onclick = function() {
n@913: 		// Start the test on first click, that way timings are more accurate.
n@913: 		audioEngineContext.play();
n@913: 		if (audioEngineContext.audioObjectsReady) {
n@913: 			// Cannot continue to issue play command until audioObjects reported as ready!
n@913: 			// Get the track ID from the object ID
n@913: 			var id = Number(event.srcElement.attributes['trackIndex'].value);
n@913: 			//audioEngineContext.metric.sliderPlayed(id);
n@913: 			audioEngineContext.selectedTrack(id);
n@913:             // Currently playing track red, rest green
n@913:             
n@913:             //document.getElementById('track-slider-'+index).style.backgroundColor = "#FF0000";
n@913:             $('.track-slider').removeClass('track-slider-playing');
n@913:             $(event.srcElement).addClass('track-slider-playing');
n@913:             $('.comment-div').removeClass('comment-box-playing');
n@913:             $('#comment-div-'+id).addClass('comment-box-playing');
n@913: 		}
n@913: 	};
n@913: 	
n@913: 	this.exportXMLDOM = function() {
n@913: 		// Called by the audioObject holding this element. Must be present
n@913: 		var node = document.createElement('value');
n@913: 		node.textContent = convSliderPosToRate(this.trackSliderObj);
n@913: 		return node;
n@913: 	};
n@913: }
nicholas@5: 
nicholas@5: function dragEnd(ev) {
nicholas@5: 	// Function call when a div has been dropped
n@657: 	var slider = document.getElementById('slider');
n@963: 	var marginSize = Number(slider.attributes['marginsize'].value);
n@675: 	var w = slider.style.width;
n@675: 	w = Number(w.substr(0,w.length-2));
n@675: 	var x = ev.x;
n@963: 	if (x >= marginSize && x < w+marginSize) {
n@675: 		this.style.left = (x)+'px';
nicholas@5: 	} else {
n@963: 		if (x<marginSize) {
n@963: 			this.style.left = marginSize+'px';
nicholas@5: 		} else {
n@963: 			this.style.left = (w+marginSize) + 'px';
nicholas@5: 		}
nicholas@5: 	}
n@913: 	var time = audioEngineContext.timer.getTestTime();
n@913: 	var id = Number(ev.srcElement.getAttribute('trackindex'));
n@913: 	audioEngineContext.audioObjects[id].metric.moved(time,convSliderPosToRate(ev.srcElement));
n@656: }
n@656: 
BrechtDeMan@939: function buttonSubmitClick() // TODO: Only when all songs have been played!
n@663: {
nicholas@944:     hasBeenPlayed = audioEngineContext.checkAllPlayed();
nicholas@944:     if (hasBeenPlayed.length == 0) {
nicholas@944: 	    if (audioEngineContext.status == 1) {
nicholas@944: 	        var playback = document.getElementById('playback-button');
nicholas@944: 	        playback.click();
nicholas@944: 	    // This function is called when the submit button is clicked. Will check for any further tests to perform, or any post-test options
nicholas@944: 	    } else
nicholas@944: 	    {
nicholas@944: 	        if (audioEngineContext.timer.testStarted == false)
nicholas@944: 	        {
nicholas@944: 	            alert('You have not started the test! Please press start to begin the test!');
nicholas@944: 	            return;
nicholas@944: 	        }
nicholas@944: 	    }
nicholas@964: 	    testState.advanceState();
BrechtDeMan@940:     } else // if a fragment has not been played yet
BrechtDeMan@940:     {
nicholas@944:     	str = "";
nicholas@944:     	if (hasBeenPlayed.length > 1) {
nicholas@944: 	    	for (var i=0; i<hasBeenPlayed.length; i++) {
nicholas@944: 	    		str = str + hasBeenPlayed[i];
nicholas@944: 	    		if (i < hasBeenPlayed.length-2){
nicholas@944: 	    			str += ", ";
nicholas@944: 	    		} else if (i == hasBeenPlayed.length-2) {
nicholas@944: 	    			str += " or ";
nicholas@944: 	    		}
nicholas@944: 	    	}
nicholas@944: 	    	alert('You have not played fragments ' + str + ' yet. Please listen, rate and comment all samples before submitting.');
nicholas@944:        } else {
nicholas@944:        		alert('You have not played fragment ' + hasBeenPlayed[0] + ' yet. Please listen, rate and comment all samples before submitting.');
nicholas@944:        }
BrechtDeMan@940:         return;
BrechtDeMan@940:     }
n@664: }
n@664: 
n@913: function convSliderPosToRate(slider)
n@675: {
n@675: 	var w = document.getElementById('slider').style.width;
n@963: 	var marginsize = Number(document.getElementById('slider').attributes['marginsize'].value);
n@675: 	var maxPix = w.substr(0,w.length-2);
n@675: 	var pix = slider.style.left;
n@675: 	pix = pix.substr(0,pix.length-2);
n@963: 	var rate = (pix-marginsize)/maxPix;
n@675: 	return rate;
n@675: }
n@675: 
n@963: function resizeWindow(event){
n@963: 	// Function called when the window has been resized.
n@963: 	// MANDATORY FUNCTION
n@963: 	
n@963: 	// Store the slider marker values
n@963: 	var holdValues = [];
n@963: 	$(".track-slider").each(function(index,sliderObj){
n@963: 		holdValues.push(convSliderPosToRate(index));
n@963: 	});
n@963: 	
n@963: 	var width = event.target.innerWidth;
n@963: 	var canvas = document.getElementById('sliderCanvasHolder');
n@963: 	var sliderDiv = canvas.children[0];
n@963: 	var sliderScaleDiv = canvas.children[1];
n@963: 	var marginsize = Number(sliderDiv.attributes['marginsize'].value);
n@963: 	var w = (marginsize+8)*2;
n@963: 	sliderDiv.style.width = width - w + 'px';
n@963: 	var width = width - w;
n@963: 	// Move sliders into new position
n@963: 	$(".track-slider").each(function(index,sliderObj){
n@963: 		var pos = holdValues[index];
n@963: 		var pix = pos * width;
n@963: 		sliderObj.style.left = pix+marginsize+'px';
n@963: 	});
n@963: 	
n@963: 	// Move scale labels
n@963: 	$(sliderScaleDiv.children).each(function(index,scaleObj){
n@963: 		var position = Number(scaleObj.attributes['value'].value);
n@963: 		var pixelPosition = (position*width)+marginsize;
n@963: 		scaleObj.style.left = Math.floor((pixelPosition-($(scaleObj).width()/2)))+'px';
n@963: 	});
n@963: }
n@963: 
n@911: function pageXMLSave(store, testXML)
n@668: {
n@668: 	// Saves a specific test page
nicholas@964: 	var xmlDoc = store;
n@674: 	// Check if any session wide metrics are enabled
nicholas@690: 	
n@911: 	var commentShow = testXML.elementComments;
nicholas@690: 	
n@674: 	var metric = document.createElement('metric');
n@674: 	if (audioEngineContext.metric.enableTestTimer)
n@674: 	{
n@674: 		var testTime = document.createElement('metricResult');
n@674: 		testTime.id = 'testTime';
n@674: 		testTime.textContent = audioEngineContext.timer.testDuration;
n@674: 		metric.appendChild(testTime);
n@674: 	}
n@674: 	xmlDoc.appendChild(metric);
n@908: 	var audioObjects = audioEngineContext.audioObjects;
n@908: 	for (var i=0; i<audioObjects.length; i++) 
n@669: 	{
n@913: 		var audioElement = audioEngineContext.audioObjects[i].exportXMLDOM();
n@669: 		xmlDoc.appendChild(audioElement);
n@669: 	}
n@1026: 	
n@1026: 	$(interfaceContext.commentQuestions).each(function(index,element){
n@1026: 		var node = element.exportXMLDOM();
n@1026: 		xmlDoc.appendChild(node);
n@1026: 	});
nicholas@964: 	store = xmlDoc;
nicholas@690: }