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
nicholas@2: loadInterface(projectXML);
nicholas@2: 
nicholas@2: function loadInterface(xmlDoc) {
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
nicholas@2: 	var insertPoint = document.getElementById("topLevelBody");
n@706: 	var testContent = document.createElement('div');
nicholas@934: 	
n@706: 	testContent.id = 'testContent';
nicholas@2: 	
nicholas@7: 	
nicholas@2: 	// Decode parts of the xmlDoc that are needed
nicholas@2: 	// xmlDoc MUST already be parsed by jQuery!
nicholas@2: 	var xmlSetup = xmlDoc.find('setup');
nicholas@2: 	// Should put in an error function here incase of malprocessed or malformed XML
nicholas@2: 	
nicholas@964: 	// Create pre and post test questions
nicholas@964: 	
nicholas@964: 	var preTest = xmlSetup.find('PreTest');
nicholas@964: 	var postTest = xmlSetup.find('PostTest');
nicholas@964: 	preTest = preTest[0];
nicholas@964: 	postTest = postTest[0];
nicholas@964: 	
nicholas@964: 	if (preTest == undefined) {preTest = document.createElement("preTest");}
nicholas@964: 	if (postTest == undefined){postTest= document.createElement("postTest");}
nicholas@964: 	
nicholas@964: 	testState.stateMap.push(preTest);
nicholas@964: 	
n@658: 	// Extract the different test XML DOM trees
n@674: 	var audioHolders = xmlDoc.find('audioHolder');
nicholas@964: 	var testXMLSetups = [];
n@674: 	audioHolders.each(function(index,element) {
n@674: 		var repeatN = element.attributes['repeatCount'].value;
n@674: 		for (var r=0; r<=repeatN; r++) {
nicholas@964: 			testXMLSetups.push(element);
n@674: 		}
n@674: 	});
n@668: 	 
n@674: 	// New check if we need to randomise the test order
n@674: 	var randomise = xmlSetup[0].attributes['randomiseOrder'];
n@674: 	if (randomise != undefined) {
nicholas@946: 		if (randomise.value === 'true'){
nicholas@946: 			randomise = true;
nicholas@946: 		} else {
nicholas@946: 			randomise = false;
nicholas@946: 		}
n@674: 	} else {
n@674: 		randomise = false;
n@674: 	}
nicholas@946: 	
n@674: 	if (randomise)
n@674: 	{
n@678:  		testXMLSetups = randomiseOrder(testXMLSetups);
n@674: 	}
nicholas@964: 	
nicholas@964: 	$(testXMLSetups).each(function(index,elem){
nicholas@964: 		testState.stateMap.push(elem);
nicholas@964: 	})
nicholas@964: 	 
nicholas@964: 	 testState.stateMap.push(postTest);
n@668: 	 
n@674: 	// Obtain the metrics enabled
n@674: 	var metricNode = xmlSetup.find('Metric');
n@674: 	var metricNode = metricNode.find('metricEnable');
n@674: 	metricNode.each(function(index,node){
n@674: 		var enabled = node.textContent;
n@674: 		switch(enabled)
n@674: 		{
n@674: 		case 'testTimer':
n@674: 			sessionMetrics.prototype.enableTestTimer = true;
n@674: 			break;
n@674: 		case 'elementTimer':
n@674: 			sessionMetrics.prototype.enableElementTimer = true;
n@674: 			break;
n@674: 		case 'elementTracker':
n@674: 			sessionMetrics.prototype.enableElementTracker = true;
n@674: 			break;
n@674: 		case 'elementInitalPosition':
n@674: 			sessionMetrics.prototype.enableElementInitialPosition = true;
n@674: 			break;
n@674: 		case 'elementFlagListenedTo':
n@674: 			sessionMetrics.prototype.enableFlagListenedTo = true;
n@674: 			break;
n@674: 		case 'elementFlagMoved':
n@674: 			sessionMetrics.prototype.enableFlagMoved = true;
n@674: 			break;
n@674: 		case 'elementFlagComments':
n@674: 			sessionMetrics.prototype.enableFlagComments = true;
n@674: 			break;
n@674: 		}
n@674: 	});
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.sliderMoveStart = function(id)
n@676: 	{
n@676: 		if (this.data == -1)
n@676: 		{
n@676: 			this.data = id;
n@676: 		} else {
n@676: 			console.log('ERROR: Metric tracker detecting two moves!');
n@676: 			this.data = -1;
n@676: 		}
n@676: 	};
n@676: 	audioEngineContext.metric.sliderMoved = function()
n@676: 	{
n@676: 		var time = audioEngineContext.timer.getTestTime();
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: 	
nicholas@2: 	// Create the top div for the Title element
nicholas@2: 	var titleAttr = xmlSetup[0].attributes['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@709: 		titleSpan.innerHTML = titleAttr.value;
nicholas@2: 	} else {
BrechtDeMan@975: 		titleSpan.innerHTML =  '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: 	// Store the return URL path in global projectReturn
n@933: 	projectReturn = xmlSetup[0].attributes['projectReturn'];
n@933: 	if (projectReturn == undefined) {
n@933: 		console.log("WARNING - projectReturn not specified! Will assume null.");
n@933: 		projectReturn = "null";
n@933: 	} else {
n@933: 		projectReturn = projectReturn.value;
n@933: 	}
nicholas@7: 	
nicholas@7: 	// Create Interface buttons!
nicholas@7: 	var interfaceButtons = document.createElement('div');
nicholas@7: 	interfaceButtons.id = 'interface-buttons';
nicholas@7: 	
nicholas@7: 	// MANUAL DOWNLOAD POINT
nicholas@7: 	// If project return is null, this MUST be specified as the location to create the download link
nicholas@7: 	var downloadPoint = document.createElement('div');
nicholas@7: 	downloadPoint.id = 'download-point';
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: 	interfaceButtons.appendChild(downloadPoint);
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@662: 	insertPoint.innerHTML = null; // Clear the current schema
n@662: 	
n@662: 	currentState = 'preTest';
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@662: 	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: 
nicholas@964: function loadTest(textXML)
n@658: {
nicholas@947: 	
nicholas@947: 	// Reset audioEngineContext.Metric globals for new test
n@950: 	audioEngineContext.newTestPage();
nicholas@947: 	
nicholas@964: 	var id = textXML.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@671: 	var interfaceObj = $(textXML).find('interface');
n@671: 	var titleNode = interfaceObj.find('title');
n@671: 	if (titleNode[0] != undefined)
n@671: 	{
n@671: 		document.getElementById('pageTitle').textContent = titleNode[0].textContent;
n@671: 	}
n@671: 	var positionScale = canvas.style.width.substr(0,canvas.style.width.length-2);
n@963: 	var offset = Number(document.getElementById('slider').attributes['marginsize'].value);
n@671: 	var scale = document.getElementById('sliderScaleHolder');
n@671: 	scale.innerHTML = null;
n@671: 	interfaceObj.find('scale').each(function(index,scaleObj){
n@963: 		var value = document.createAttribute('value');
n@671: 		var position = Number(scaleObj.attributes['position'].value)*0.01;
n@963: 		value.nodeValue = position;
n@671: 		var pixelPosition = (position*positionScale)+offset;
n@671: 		var scaleDOM = document.createElement('span');
n@671: 		scaleDOM.textContent = scaleObj.textContent;
n@671: 		scale.appendChild(scaleDOM);
n@671: 		scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px';
n@963: 		scaleDOM.setAttributeNode(value);
n@671: 	});
n@658: 
n@701: 	// Extract the hostURL attribute. If not set, create an empty string.
n@658: 	var hostURL = textXML.attributes['hostURL'];
nicholas@7: 	if (hostURL == undefined) {
nicholas@7: 		hostURL = "";
nicholas@7: 	} else {
nicholas@7: 		hostURL = hostURL.value;
nicholas@7: 	}
n@701: 	// Extract the sampleRate. If set, convert the string to a Number.
n@658: 	var hostFs = textXML.attributes['sampleRate'];
n@700: 	if (hostFs != undefined) {
n@700: 		hostFs = Number(hostFs.value);
nicholas@7: 	}
nicholas@7: 	
nicholas@7: 	/// CHECK FOR SAMPLE RATE COMPATIBILITY
n@700: 	if (hostFs != undefined) {
nicholas@7: 		if (Number(hostFs) != audioContext.sampleRate) {
nicholas@7: 			var errStr = 'Sample rates do not match! Requested '+Number(hostFs)+', 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: 	
nicholas@689: 	var commentShow = textXML.attributes['elementComments'];
nicholas@689: 	if (commentShow != undefined) {
nicholas@689: 		if (commentShow.value == 'false') {commentShow = false;}
nicholas@689: 		else {commentShow = true;}
nicholas@689: 	} else {commentShow = true;}
nicholas@689: 	
n@681: 	var loopPlayback = textXML.attributes['loop'];
n@681: 	if (loopPlayback != undefined)
n@681: 	{
n@681: 		loopPlayback = loopPlayback.value;
n@681: 		if (loopPlayback == 'true') {
n@681: 			loopPlayback = true;
n@681: 		} else {
n@681: 			loopPlayback = false;
n@681: 		}
n@681: 	} else {
n@681: 		loopPlayback = false;
n@681: 	}
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@670: 	currentTestHolder.id = textXML.id;
n@670: 	currentTestHolder.repeatCount = textXML.attributes['repeatCount'].value;
n@670: 	
n@669: 	var randomise = textXML.attributes['randomiseOrder'];
n@669: 	if (randomise != undefined) {randomise = randomise.value;}
n@669: 	else {randomise = false;}
n@669: 	
n@658: 	var audioElements = $(textXML).find('audioElements');
nicholas@682: 	currentTrackOrder = [];
n@658: 	audioElements.each(function(index,element){
n@669: 		// Find any blind-repeats
BrechtDeMan@938: 		// Not implemented yet, but just in case
n@669: 		currentTrackOrder[index] = element;
n@669: 	});
n@669: 	if (randomise) {
n@678: 		currentTrackOrder = randomiseOrder(currentTrackOrder);
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@669: 	$(currentTrackOrder).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
nicholas@7: 		var trackURL = hostURL + this.attributes['url'].value;
nicholas@7: 		audioEngineContext.newTrack(trackURL);
nicholas@689: 		
nicholas@689: 		if (commentShow) {
nicholas@689: 			// Create document objects to hold the comment boxes
nicholas@689: 			var trackComment = document.createElement('div');
nicholas@689: 			trackComment.className = 'comment-div';
nicholas@689: 			// Create a string next to each comment asking for a comment
nicholas@689: 			var trackString = document.createElement('span');
nicholas@689: 			trackString.innerHTML = 'Comment on track '+index;
nicholas@689: 			// Create the HTML5 comment box 'textarea'
nicholas@689: 			var trackCommentBox = document.createElement('textarea');
nicholas@689: 			trackCommentBox.rows = '4';
nicholas@689: 			trackCommentBox.cols = '100';
nicholas@689: 			trackCommentBox.name = 'trackComment'+index;
nicholas@689: 			trackCommentBox.className = 'trackComment';
nicholas@689: 			var br = document.createElement('br');
nicholas@689: 			// Add to the holder.
nicholas@689: 			trackComment.appendChild(trackString);
nicholas@689: 			trackComment.appendChild(br);
nicholas@689: 			trackComment.appendChild(trackCommentBox);
nicholas@689: 			feedbackHolder.appendChild(trackComment);
nicholas@689: 		}
n@701: 		
nicholas@5: 		// Create a slider per track
nicholas@5: 		
nicholas@5: 		var trackSliderObj = document.createElement('div');
nicholas@5: 		trackSliderObj.className = 'track-slider';
nicholas@5: 		trackSliderObj.id = 'track-slider-'+index;
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@1000: 		trackSliderObj.style.left = w+'px';
nicholas@5: 		trackSliderObj.innerHTML = '<span>'+index+'</span>';
nicholas@5: 		trackSliderObj.draggable = true;
nicholas@5: 		trackSliderObj.ondragend = dragEnd;
n@673: 		trackSliderObj.ondragstart = function()
n@673: 		{
n@673: 			var id = Number(this.id.substr(13,2)); // Maximum theoretical tracks is 99!
n@673: 			audioEngineContext.metric.sliderMoveStart(id);
n@673: 		};
nicholas@8: 		
nicholas@8: 		// Onclick, switch playback to that track
nicholas@8: 		trackSliderObj.onclick = function() {
nicholas@945: 			// Start the test on first click, that way timings are more accurate.
nicholas@945: 			audioEngineContext.play();
nicholas@934: 			if (audioEngineContext.audioObjectsReady) {
nicholas@934: 				// Cannot continue to issue play command until audioObjects reported as ready!
nicholas@934: 				// Get the track ID from the object ID
nicholas@934: 				var id = Number(this.id.substr(13,2)); // Maximum theoretical tracks is 99!
nicholas@934: 				//audioEngineContext.metric.sliderPlayed(id);
nicholas@934: 				audioEngineContext.selectedTrack(id);
nicholas@934: 	            // Currently playing track red, rest green
nicholas@934: 	            document.getElementById('track-slider-'+index).style.backgroundColor = "#FF0000";
nicholas@934: 	            for (var i = 0; i<$(currentTrackOrder).length; i++)
nicholas@934: 	            {
nicholas@934: 	                if (i!=index) // Make all other sliders green
nicholas@934: 	                {
nicholas@934: 	           	        document.getElementById('track-slider-'+i).style.backgroundColor = "rgb(100,200,100)";
nicholas@934: 	                }
nicholas@934: 	                              
nicholas@934: 	            }
nicholas@934: 			}
n@700: 		};
nicholas@8: 		
nicholas@5: 		canvas.appendChild(trackSliderObj);
n@1000: 		audioEngineContext.audioObjects[index].metric.initialised(convSliderPosToRate(index));
BrechtDeMan@940:         
n@700: 	});
nicholas@3: 	
nicholas@688: 	// Append any commentQuestion boxes
nicholas@688: 	var commentQuestions = $(textXML).find('CommentQuestion');
nicholas@688: 	$(commentQuestions).each(function(index,element) {
nicholas@688: 		// Create document objects to hold the comment boxes
nicholas@688: 		var trackComment = document.createElement('div');
nicholas@688: 		trackComment.className = 'comment-div commentQuestion';
nicholas@688: 		trackComment.id = element.attributes['id'].value;
nicholas@688: 		// Create a string next to each comment asking for a comment
nicholas@688: 		var trackString = document.createElement('span');
nicholas@688: 		trackString.innerHTML = element.textContent;
nicholas@688: 		// Create the HTML5 comment box 'textarea'
nicholas@688: 		var trackCommentBox = document.createElement('textarea');
nicholas@688: 		trackCommentBox.rows = '4';
nicholas@688: 		trackCommentBox.cols = '100';
nicholas@688: 		trackCommentBox.name = 'commentQuestion'+index;
nicholas@688: 		trackCommentBox.className = 'trackComment';
nicholas@688: 		var br = document.createElement('br');
nicholas@688: 		// Add to the holder.
nicholas@688: 		trackComment.appendChild(trackString);
nicholas@688: 		trackComment.appendChild(br);
nicholas@688: 		trackComment.appendChild(trackCommentBox);
nicholas@688: 		feedbackHolder.appendChild(trackComment);
nicholas@688: 	});
n@1007: 	
n@1007: 	
n@1007: 	testWaitIndicator();
n@663: }
n@663: 
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@673: 	audioEngineContext.metric.sliderMoved();
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@675: function convSliderPosToRate(id)
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 slider = document.getElementsByClassName('track-slider')[id];
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: 
nicholas@964: function pageXMLSave(store, testXML, testId)
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: 	
nicholas@964: 	var commentShow = testXML.attributes['elementComments'];
nicholas@690: 	if (commentShow != undefined) {
nicholas@690: 		if (commentShow.value == 'false') {commentShow = false;}
nicholas@690: 		else {commentShow = true;}
nicholas@690: 	} else {commentShow = true;}
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@669: 	var trackSliderObjects = document.getElementsByClassName('track-slider');
n@669: 	var commentObjects = document.getElementsByClassName('comment-div');
n@669: 	for (var i=0; i<trackSliderObjects.length; i++) 
n@669: 	{
n@669: 		var audioElement = document.createElement('audioElement');
n@669: 		audioElement.id = currentTrackOrder[i].attributes['id'].value;
n@669: 		audioElement.url = currentTrackOrder[i].attributes['url'].value;
n@675: 		var value = document.createElement('value');
n@675: 		value.innerHTML = convSliderPosToRate(i);
nicholas@690: 		if (commentShow) {
nicholas@690: 			var comment = document.createElement("comment");
nicholas@690: 			var question = document.createElement("question");
nicholas@690: 			var response = document.createElement("response");
nicholas@690: 			question.textContent = commentObjects[i].children[0].textContent;
nicholas@690: 			response.textContent = commentObjects[i].children[2].value;
BrechtDeMan@936:             console.log('Comment ' + i + ': ' + commentObjects[i].children[2].value); // DEBUG/SAFETY
nicholas@690: 			comment.appendChild(question);
nicholas@690: 			comment.appendChild(response);
nicholas@690: 			audioElement.appendChild(comment);
nicholas@690: 		}
n@669: 		audioElement.appendChild(value);
n@674: 		// Check for any per element metrics
n@674: 		var metric = document.createElement('metric');
n@674: 		var elementMetric = audioEngineContext.audioObjects[i].metric;
n@674: 		if (audioEngineContext.metric.enableElementTimer) {
n@674: 			var elementTimer = document.createElement('metricResult');
n@674: 			elementTimer.id = 'elementTimer';
n@674: 			elementTimer.textContent = elementMetric.listenedTimer;
n@674: 			metric.appendChild(elementTimer);
n@674: 		}
n@674: 		if (audioEngineContext.metric.enableElementTracker) {
n@674: 			var elementTrackerFull = document.createElement('metricResult');
n@674: 			elementTrackerFull.id = 'elementTrackerFull';
n@674: 			var data = elementMetric.movementTracker;
n@674: 			for (var k=0; k<data.length; k++)
n@674: 			{
n@674: 				var timePos = document.createElement('timePos');
n@674: 				timePos.id = k;
n@674: 				var time = document.createElement('time');
n@674: 				time.textContent = data[k][0];
n@674: 				var position = document.createElement('position');
n@674: 				position.textContent = data[k][1];
n@674: 				timePos.appendChild(time);
n@674: 				timePos.appendChild(position);
n@674: 				elementTrackerFull.appendChild(timePos);
n@674: 			}
n@674: 			metric.appendChild(elementTrackerFull);
n@674: 		}
n@674: 		if (audioEngineContext.metric.enableElementInitialPosition) {
n@674: 			var elementInitial = document.createElement('metricResult');
n@674: 			elementInitial.id = 'elementInitialPosition';
n@674: 			elementInitial.textContent = elementMetric.initialPosition;
n@674: 			metric.appendChild(elementInitial);
n@674: 		}
n@674: 		if (audioEngineContext.metric.enableFlagListenedTo) {
n@674: 			var flagListenedTo = document.createElement('metricResult');
n@674: 			flagListenedTo.id = 'elementFlagListenedTo';
n@674: 			flagListenedTo.textContent = elementMetric.wasListenedTo;
n@674: 			metric.appendChild(flagListenedTo);
n@674: 		}
n@674: 		if (audioEngineContext.metric.enableFlagMoved) {
n@674: 			var flagMoved = document.createElement('metricResult');
n@674: 			flagMoved.id = 'elementFlagMoved';
n@674: 			flagMoved.textContent = elementMetric.wasMoved;
n@674: 			metric.appendChild(flagMoved);
n@674: 		}
n@674: 		if (audioEngineContext.metric.enableFlagComments) {
n@674: 			var flagComments = document.createElement('metricResult');
n@674: 			flagComments.id = 'elementFlagComments';
n@674: 			if (response.textContent.length == 0) {flag.textContent = 'false';}
n@674: 			else {flag.textContet = 'true';}
n@674: 			metric.appendChild(flagComments);
n@674: 		}
n@674: 		audioElement.appendChild(metric);
n@669: 		xmlDoc.appendChild(audioElement);
n@669: 	}
nicholas@688: 	var commentQuestion = document.getElementsByClassName('commentQuestion');
nicholas@688: 	for (var i=0; i<commentQuestion.length; i++)
nicholas@688: 	{
nicholas@688: 		var cqHolder = document.createElement('CommentQuestion');
nicholas@688: 		var comment = document.createElement('comment');
nicholas@688: 		var question = document.createElement('question');
nicholas@688: 		cqHolder.id = commentQuestion[i].id;
nicholas@688: 		comment.textContent = commentQuestion[i].children[2].value;
nicholas@688: 		question.textContent = commentQuestion[i].children[0].textContent;
n@960:         console.log('Question ' + i + ': ' + commentQuestion[i].children[2].value); // DEBUG/SAFETY
nicholas@688: 		cqHolder.appendChild(question);
nicholas@688: 		cqHolder.appendChild(comment);
nicholas@688: 		xmlDoc.appendChild(cqHolder);
nicholas@688: 	}
nicholas@964: 	store = xmlDoc;
nicholas@690: }