nicholas@934: /**
nicholas@934:  *  ape.js
nicholas@934:  *  Create the APE interface
nicholas@934:  */
nicholas@934: 
nicholas@934: // preTest - In preTest state
nicholas@934: // testRun-ID - In test running, test Id number at the end 'testRun-2'
nicholas@934: // testRunPost-ID - Post test of test ID
nicholas@934: // testRunPre-ID - Pre-test of test ID
nicholas@934: // postTest - End of test, final submission!
nicholas@934: 
nicholas@934: 
nicholas@934: // Once this is loaded and parsed, begin execution
nicholas@934: loadInterface(projectXML);
nicholas@934: 
nicholas@934: function loadInterface(xmlDoc) {
nicholas@934: 	
nicholas@934: 	// Get the dimensions of the screen available to the page
nicholas@934: 	var width = window.innerWidth;
nicholas@934: 	var height = window.innerHeight;
nicholas@934: 	
nicholas@934: 	// The injection point into the HTML page
nicholas@934: 	var insertPoint = document.getElementById("topLevelBody");
nicholas@934: 	var testContent = document.createElement('div');
nicholas@934: 	
nicholas@934: 	testContent.id = 'testContent';
nicholas@934: 	
nicholas@934: 	
nicholas@934: 	// Decode parts of the xmlDoc that are needed
nicholas@934: 	// xmlDoc MUST already be parsed by jQuery!
nicholas@934: 	var xmlSetup = xmlDoc.find('setup');
nicholas@934: 	// Should put in an error function here incase of malprocessed or malformed XML
nicholas@934: 	
nicholas@934: 	// Create pre and post test questions
nicholas@934: 	
nicholas@934: 	var preTest = xmlSetup.find('PreTest');
nicholas@934: 	var postTest = xmlSetup.find('PostTest');
nicholas@934: 	preTest = preTest[0];
nicholas@934: 	postTest = postTest[0];
nicholas@934: 	
nicholas@934: 	if (preTest == undefined) {preTest = document.createElement("preTest");}
nicholas@934: 	if (postTest == undefined){postTest= document.createElement("postTest");}
nicholas@934: 	
nicholas@934: 	testState.stateMap.push(preTest);
nicholas@934: 	
nicholas@934: 	// Extract the different test XML DOM trees
nicholas@934: 	var audioHolders = xmlDoc.find('audioHolder');
nicholas@934: 	var testXMLSetups = [];
nicholas@934: 	audioHolders.each(function(index,element) {
nicholas@934: 		var repeatN = element.attributes['repeatCount'].value;
nicholas@934: 		for (var r=0; r<=repeatN; r++) {
nicholas@934: 			testXMLSetups.push(element);
nicholas@934: 		}
nicholas@934: 	});
nicholas@934: 	 
nicholas@934: 	// New check if we need to randomise the test order
nicholas@934: 	var randomise = xmlSetup[0].attributes['randomiseOrder'];
nicholas@934: 	if (randomise != undefined) {
nicholas@934: 		if (randomise.value === 'true'){
nicholas@934: 			randomise = true;
nicholas@934: 		} else {
nicholas@934: 			randomise = false;
nicholas@934: 		}
nicholas@934: 	} else {
nicholas@934: 		randomise = false;
nicholas@934: 	}
nicholas@934: 	
nicholas@934: 	if (randomise)
nicholas@934: 	{
nicholas@934:  		testXMLSetups = randomiseOrder(testXMLSetups);
nicholas@934: 	}
nicholas@934: 	
nicholas@934: 	$(testXMLSetups).each(function(index,elem){
nicholas@934: 		testState.stateMap.push(elem);
nicholas@934: 	})
nicholas@934: 	 
nicholas@934: 	 testState.stateMap.push(postTest);
nicholas@934: 	 
nicholas@934: 	// Obtain the metrics enabled
nicholas@934: 	var metricNode = xmlSetup.find('Metric');
nicholas@934: 	var metricNode = metricNode.find('metricEnable');
nicholas@934: 	metricNode.each(function(index,node){
nicholas@934: 		var enabled = node.textContent;
nicholas@934: 		switch(enabled)
nicholas@934: 		{
nicholas@934: 		case 'testTimer':
nicholas@934: 			sessionMetrics.prototype.enableTestTimer = true;
nicholas@934: 			break;
nicholas@934: 		case 'elementTimer':
nicholas@934: 			sessionMetrics.prototype.enableElementTimer = true;
nicholas@934: 			break;
nicholas@934: 		case 'elementTracker':
nicholas@934: 			sessionMetrics.prototype.enableElementTracker = true;
nicholas@934: 			break;
nicholas@934: 		case 'elementInitalPosition':
nicholas@934: 			sessionMetrics.prototype.enableElementInitialPosition = true;
nicholas@934: 			break;
nicholas@934: 		case 'elementFlagListenedTo':
nicholas@934: 			sessionMetrics.prototype.enableFlagListenedTo = true;
nicholas@934: 			break;
nicholas@934: 		case 'elementFlagMoved':
nicholas@934: 			sessionMetrics.prototype.enableFlagMoved = true;
nicholas@934: 			break;
nicholas@934: 		case 'elementFlagComments':
nicholas@934: 			sessionMetrics.prototype.enableFlagComments = true;
nicholas@934: 			break;
nicholas@934: 		}
nicholas@934: 	});
nicholas@934: 	
nicholas@934: 	// Create APE specific metric functions
nicholas@934: 	audioEngineContext.metric.initialiseTest = function()
nicholas@934: 	{
nicholas@934: 		var sliders = document.getElementsByClassName('track-slider');
nicholas@934: 		for (var i=0; i<sliders.length; i++)
nicholas@934: 		{
nicholas@934: 			audioEngineContext.audioObjects[i].metric.initialised(convSliderPosToRate(i));
nicholas@934: 		}
nicholas@934: 	};
nicholas@934: 	
nicholas@934: 	audioEngineContext.metric.sliderMoveStart = function(id)
nicholas@934: 	{
nicholas@934: 		if (this.data == -1)
nicholas@934: 		{
nicholas@934: 			this.data = id;
nicholas@934: 		} else {
nicholas@934: 			console.log('ERROR: Metric tracker detecting two moves!');
nicholas@934: 			this.data = -1;
nicholas@934: 		}
nicholas@934: 	};
nicholas@934: 	audioEngineContext.metric.sliderMoved = function()
nicholas@934: 	{
nicholas@934: 		var time = audioEngineContext.timer.getTestTime();
nicholas@934: 		var id = this.data;
nicholas@934: 		this.data = -1;
nicholas@934: 		var position = convSliderPosToRate(id);
nicholas@934:         console.log('slider ' + id + ': '+ position + ' (' + time + ')'); // DEBUG/SAFETY: show position and slider id
nicholas@934: 		if (audioEngineContext.timer.testStarted)
nicholas@934: 		{
nicholas@934: 			audioEngineContext.audioObjects[id].metric.moved(time,position);
nicholas@934: 		}
nicholas@934: 	};
nicholas@934: 	
nicholas@934: 	audioEngineContext.metric.sliderPlayed = function(id)
nicholas@934: 	{
nicholas@934: 		var time = audioEngineContext.timer.getTestTime();
nicholas@934: 		if (audioEngineContext.timer.testStarted)
nicholas@934: 		{
nicholas@934: 			if (this.lastClicked >= 0)
nicholas@934: 			{
nicholas@934: 				audioEngineContext.audioObjects[this.lastClicked].metric.listening(time);
nicholas@934: 			}
nicholas@934: 			this.lastClicked = id;
nicholas@934: 			audioEngineContext.audioObjects[id].metric.listening(time);
nicholas@934: 		}
nicholas@934:         console.log('slider ' + id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nicholas@934: 	};
nicholas@934: 	
nicholas@934: 	// Create the top div for the Title element
nicholas@934: 	var titleAttr = xmlSetup[0].attributes['title'];
nicholas@934: 	var title = document.createElement('div');
nicholas@934: 	title.className = "title";
nicholas@934: 	title.align = "center";
nicholas@934: 	var titleSpan = document.createElement('span');
nicholas@934: 	
nicholas@934: 	// Set title to that defined in XML, else set to default
nicholas@934: 	if (titleAttr != undefined) {
nicholas@934: 		titleSpan.innerHTML = titleAttr.value;
nicholas@934: 	} else {
nicholas@934: 		titleSpan.innerHTML =  'Listening test';
nicholas@934: 	}
nicholas@934: 	// Insert the titleSpan element into the title div element.
nicholas@934: 	title.appendChild(titleSpan);
nicholas@934: 	
nicholas@934: 	var pagetitle = document.createElement('div');
nicholas@934: 	pagetitle.className = "pageTitle";
nicholas@934: 	pagetitle.align = "center";
nicholas@934: 	var titleSpan = document.createElement('span');
nicholas@934: 	titleSpan.id = "pageTitle";
nicholas@934: 	pagetitle.appendChild(titleSpan);
nicholas@934: 	
nicholas@934: 	// Store the return URL path in global projectReturn
nicholas@934: 	projectReturn = xmlSetup[0].attributes['projectReturn'].value;
nicholas@934: 	
nicholas@934: 	// Create Interface buttons!
nicholas@934: 	var interfaceButtons = document.createElement('div');
nicholas@934: 	interfaceButtons.id = 'interface-buttons';
nicholas@934: 	
nicholas@934: 	// MANUAL DOWNLOAD POINT
nicholas@934: 	// If project return is null, this MUST be specified as the location to create the download link
nicholas@934: 	var downloadPoint = document.createElement('div');
nicholas@934: 	downloadPoint.id = 'download-point';
nicholas@934: 	
nicholas@934: 	// Create playback start/stop points
nicholas@934: 	var playback = document.createElement("button");
nicholas@934: 	playback.innerHTML = 'Stop';
nicholas@934: 	playback.id = 'playback-button';
nicholas@934: 	// onclick function. Check if it is playing or not, call the correct function in the
nicholas@934: 	// audioEngine, change the button text to reflect the next state.
nicholas@934: 	playback.onclick = function() {
nicholas@934: 		if (audioEngineContext.status == 1) {
nicholas@934: 			audioEngineContext.stop();
nicholas@934: 			this.innerHTML = 'Stop';
nicholas@934:             var time = audioEngineContext.timer.getTestTime();
nicholas@934:             console.log('Stopped at ' + time); // DEBUG/SAFETY
nicholas@934: 		}
nicholas@934: 	};
nicholas@934: 	// Create Submit (save) button
nicholas@934: 	var submit = document.createElement("button");
nicholas@934: 	submit.innerHTML = 'Submit';
nicholas@934: 	submit.onclick = buttonSubmitClick;
nicholas@934: 	submit.id = 'submit-button';
nicholas@934: 	// Append the interface buttons into the interfaceButtons object.
nicholas@934: 	interfaceButtons.appendChild(playback);
nicholas@934: 	interfaceButtons.appendChild(submit);
nicholas@934: 	interfaceButtons.appendChild(downloadPoint);
nicholas@934: 	
nicholas@934: 	// Now create the slider and HTML5 canvas boxes
nicholas@934: 	
nicholas@934: 	// Create the div box to center align
nicholas@934: 	var sliderBox = document.createElement('div');
nicholas@934: 	sliderBox.className = 'sliderCanvasDiv';
nicholas@934: 	sliderBox.id = 'sliderCanvasHolder';
nicholas@934: 	
nicholas@934: 	// Create the slider box to hold the slider elements
nicholas@934: 	var canvas = document.createElement('div');
nicholas@934: 	canvas.id = 'slider';
nicholas@934: 	canvas.align = "left";
nicholas@934: 	canvas.addEventListener('dragover',function(event){
nicholas@934: 		event.preventDefault();
nicholas@934: 		return false;
nicholas@934: 	},false);
nicholas@934: 	var sliderMargin = document.createAttribute('marginsize');
nicholas@934: 	sliderMargin.nodeValue = 42; // Set default margins to 42px either side
nicholas@934: 	// Must have a known EXACT width, as this is used later to determine the ratings
nicholas@934: 	var w = (Number(sliderMargin.nodeValue)+8)*2;
nicholas@934: 	canvas.style.width = width - w +"px";
nicholas@934: 	canvas.style.marginLeft = sliderMargin.nodeValue +'px';
nicholas@934: 	canvas.setAttributeNode(sliderMargin);
nicholas@934: 	sliderBox.appendChild(canvas);
nicholas@934: 	
nicholas@934: 	// Create the div to hold any scale objects
nicholas@934: 	var scale = document.createElement('div');
nicholas@934: 	scale.className = 'sliderScale';
nicholas@934: 	scale.id = 'sliderScaleHolder';
nicholas@934: 	scale.align = 'left';
nicholas@934: 	sliderBox.appendChild(scale);
nicholas@934: 	
nicholas@934: 	// Global parent for the comment boxes on the page
nicholas@934: 	var feedbackHolder = document.createElement('div');
nicholas@934: 	feedbackHolder.id = 'feedbackHolder';
nicholas@934: 	
nicholas@934: 	testContent.style.zIndex = 1;
nicholas@934: 	insertPoint.innerHTML = null; // Clear the current schema
nicholas@934: 	
nicholas@934: 	currentState = 'preTest';
nicholas@934: 	
nicholas@934: 	// Inject into HTML
nicholas@934: 	testContent.appendChild(title); // Insert the title
nicholas@934: 	testContent.appendChild(pagetitle);
nicholas@934: 	testContent.appendChild(interfaceButtons);
nicholas@934: 	testContent.appendChild(sliderBox);
nicholas@934: 	testContent.appendChild(feedbackHolder);
nicholas@934: 	insertPoint.appendChild(testContent);
nicholas@934: 
nicholas@934: 	// Load the full interface
nicholas@934: 	testState.initialise();
nicholas@934: 	testState.advanceState();
nicholas@934: 	
nicholas@934: 	testWaitIndicator();
nicholas@934: }
nicholas@934: 
nicholas@934: function loadTest(textXML)
nicholas@934: {
nicholas@934: 	
nicholas@934: 	// Reset audioEngineContext.Metric globals for new test
nicholas@934: 	audioEngineContext.newTestPage();
nicholas@934: 	
nicholas@934: 	var id = textXML.id;
nicholas@934: 	
nicholas@934: 	var feedbackHolder = document.getElementById('feedbackHolder');
nicholas@934: 	var canvas = document.getElementById('slider');
nicholas@934: 	feedbackHolder.innerHTML = null;
nicholas@934: 	canvas.innerHTML = null;
nicholas@934: 	
nicholas@934: 	// Setup question title
nicholas@934: 	var interfaceObj = $(textXML).find('interface');
nicholas@934: 	var titleNode = interfaceObj.find('title');
nicholas@934: 	if (titleNode[0] != undefined)
nicholas@934: 	{
nicholas@934: 		document.getElementById('pageTitle').textContent = titleNode[0].textContent;
nicholas@934: 	}
nicholas@934: 	var positionScale = canvas.style.width.substr(0,canvas.style.width.length-2);
nicholas@934: 	var offset = Number(document.getElementById('slider').attributes['marginsize'].value);
nicholas@934: 	var scale = document.getElementById('sliderScaleHolder');
nicholas@934: 	scale.innerHTML = null;
nicholas@934: 	interfaceObj.find('scale').each(function(index,scaleObj){
nicholas@934: 		var value = document.createAttribute('value');
nicholas@934: 		var position = Number(scaleObj.attributes['position'].value)*0.01;
nicholas@934: 		value.nodeValue = position;
nicholas@934: 		var pixelPosition = (position*positionScale)+offset;
nicholas@934: 		var scaleDOM = document.createElement('span');
nicholas@934: 		scaleDOM.textContent = scaleObj.textContent;
nicholas@934: 		scale.appendChild(scaleDOM);
nicholas@934: 		scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px';
nicholas@934: 		scaleDOM.setAttributeNode(value);
nicholas@934: 	});
nicholas@934: 
nicholas@934: 	// Extract the hostURL attribute. If not set, create an empty string.
nicholas@934: 	var hostURL = textXML.attributes['hostURL'];
nicholas@934: 	if (hostURL == undefined) {
nicholas@934: 		hostURL = "";
nicholas@934: 	} else {
nicholas@934: 		hostURL = hostURL.value;
nicholas@934: 	}
nicholas@934: 	// Extract the sampleRate. If set, convert the string to a Number.
nicholas@934: 	var hostFs = textXML.attributes['sampleRate'];
nicholas@934: 	if (hostFs != undefined) {
nicholas@934: 		hostFs = Number(hostFs.value);
nicholas@934: 	}
nicholas@934: 	
nicholas@934: 	/// CHECK FOR SAMPLE RATE COMPATIBILITY
nicholas@934: 	if (hostFs != undefined) {
nicholas@934: 		if (Number(hostFs) != audioContext.sampleRate) {
nicholas@934: 			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@934: 			alert(errStr);
nicholas@934: 			return;
nicholas@934: 		}
nicholas@934: 	}
nicholas@934: 	
nicholas@934: 	var commentShow = textXML.attributes['elementComments'];
nicholas@934: 	if (commentShow != undefined) {
nicholas@934: 		if (commentShow.value == 'false') {commentShow = false;}
nicholas@934: 		else {commentShow = true;}
nicholas@934: 	} else {commentShow = true;}
nicholas@934: 	
nicholas@934: 	var loopPlayback = textXML.attributes['loop'];
nicholas@934: 	if (loopPlayback != undefined)
nicholas@934: 	{
nicholas@934: 		loopPlayback = loopPlayback.value;
nicholas@934: 		if (loopPlayback == 'true') {
nicholas@934: 			loopPlayback = true;
nicholas@934: 		} else {
nicholas@934: 			loopPlayback = false;
nicholas@934: 		}
nicholas@934: 	} else {
nicholas@934: 		loopPlayback = false;
nicholas@934: 	}
nicholas@934: 	audioEngineContext.loopPlayback = loopPlayback;
nicholas@934: 	// Create AudioEngine bindings for playback
nicholas@934: 	if (loopPlayback) {
nicholas@934: 		audioEngineContext.selectedTrack = function(id) {
nicholas@934: 			for (var i=0; i<this.audioObjects.length; i++)
nicholas@934: 			{
nicholas@934: 				if (id == i) {
nicholas@934: 					this.audioObjects[i].loopStart();
nicholas@934: 				} else {
nicholas@934: 					this.audioObjects[i].loopStop();
nicholas@934: 				}
nicholas@934: 			}
nicholas@934: 		};
nicholas@934: 	} else {
nicholas@934: 		audioEngineContext.selectedTrack = function(id) {
nicholas@934: 			for (var i=0; i<this.audioObjects.length; i++)
nicholas@934: 			{
nicholas@934: 				this.audioObjects[i].outputGain.gain.value = 0.0;
nicholas@934: 				this.audioObjects[i].stop();
nicholas@934: 			}
nicholas@934: 			if (this.status == 1) {
nicholas@934: 				this.audioObjects[id].outputGain.gain.value = 1.0;
nicholas@934: 				this.audioObjects[id].play(audioContext.currentTime+0.01);
nicholas@934: 			}
nicholas@934: 		};
nicholas@934: 	}
nicholas@934: 	
nicholas@934: 	currentTestHolder = document.createElement('audioHolder');
nicholas@934: 	currentTestHolder.id = textXML.id;
nicholas@934: 	currentTestHolder.repeatCount = textXML.attributes['repeatCount'].value;
nicholas@934: 	
nicholas@934: 	var randomise = textXML.attributes['randomiseOrder'];
nicholas@934: 	if (randomise != undefined) {randomise = randomise.value;}
nicholas@934: 	else {randomise = false;}
nicholas@934: 	
nicholas@934: 	var audioElements = $(textXML).find('audioElements');
nicholas@934: 	currentTrackOrder = [];
nicholas@934: 	audioElements.each(function(index,element){
nicholas@934: 		// Find any blind-repeats
nicholas@934: 		// Not implemented yet, but just in case
nicholas@934: 		currentTrackOrder[index] = element;
nicholas@934: 	});
nicholas@934: 	if (randomise) {
nicholas@934: 		currentTrackOrder = randomiseOrder(currentTrackOrder);
nicholas@934: 	}
nicholas@934: 	
nicholas@934: 	// Delete any previous audioObjects associated with the audioEngine
nicholas@934: 	audioEngineContext.audioObjects = [];
nicholas@934: 	
nicholas@934: 	// Find all the audioElements from the audioHolder
nicholas@934: 	$(currentTrackOrder).each(function(index,element){
nicholas@934: 		// Find URL of track
nicholas@934: 		// In this jQuery loop, variable 'this' holds the current audioElement.
nicholas@934: 		
nicholas@934: 		// Now load each audio sample. First create the new track by passing the full URL
nicholas@934: 		var trackURL = hostURL + this.attributes['url'].value;
nicholas@934: 		audioEngineContext.newTrack(trackURL);
nicholas@934: 		
nicholas@934: 		if (commentShow) {
nicholas@934: 			// Create document objects to hold the comment boxes
nicholas@934: 			var trackComment = document.createElement('div');
nicholas@934: 			trackComment.className = 'comment-div';
nicholas@934: 			// Create a string next to each comment asking for a comment
nicholas@934: 			var trackString = document.createElement('span');
nicholas@934: 			trackString.innerHTML = 'Comment on track '+index;
nicholas@934: 			// Create the HTML5 comment box 'textarea'
nicholas@934: 			var trackCommentBox = document.createElement('textarea');
nicholas@934: 			trackCommentBox.rows = '4';
nicholas@934: 			trackCommentBox.cols = '100';
nicholas@934: 			trackCommentBox.name = 'trackComment'+index;
nicholas@934: 			trackCommentBox.className = 'trackComment';
nicholas@934: 			var br = document.createElement('br');
nicholas@934: 			// Add to the holder.
nicholas@934: 			trackComment.appendChild(trackString);
nicholas@934: 			trackComment.appendChild(br);
nicholas@934: 			trackComment.appendChild(trackCommentBox);
nicholas@934: 			feedbackHolder.appendChild(trackComment);
nicholas@934: 		}
nicholas@934: 		
nicholas@934: 		// Create a slider per track
nicholas@934: 		
nicholas@934: 		var trackSliderObj = document.createElement('div');
nicholas@934: 		trackSliderObj.className = 'track-slider';
nicholas@934: 		trackSliderObj.id = 'track-slider-'+index;
nicholas@934: 		// Distribute it randomnly
nicholas@934: 		var w = window.innerWidth - 100;
nicholas@934: 		w = Math.random()*w;
nicholas@934: 		trackSliderObj.style.left = Math.floor(w)+50+'px';
nicholas@934: 		trackSliderObj.innerHTML = '<span>'+index+'</span>';
nicholas@934: 		trackSliderObj.draggable = true;
nicholas@934: 		trackSliderObj.ondragend = dragEnd;
nicholas@934: 		trackSliderObj.ondragstart = function()
nicholas@934: 		{
nicholas@934: 			var id = Number(this.id.substr(13,2)); // Maximum theoretical tracks is 99!
nicholas@934: 			audioEngineContext.metric.sliderMoveStart(id);
nicholas@934: 		};
nicholas@934: 		
nicholas@934: 		// Onclick, switch playback to that track
nicholas@934: 		trackSliderObj.onclick = function() {
nicholas@934: 			// Start the test on first click, that way timings are more accurate.
nicholas@934: 			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: 			}
nicholas@934: 		};
nicholas@934: 		
nicholas@934: 		canvas.appendChild(trackSliderObj);
nicholas@934:         
nicholas@934: 	});
nicholas@934: 	
nicholas@934: 	// Append any commentQuestion boxes
nicholas@934: 	var commentQuestions = $(textXML).find('CommentQuestion');
nicholas@934: 	$(commentQuestions).each(function(index,element) {
nicholas@934: 		// Create document objects to hold the comment boxes
nicholas@934: 		var trackComment = document.createElement('div');
nicholas@934: 		trackComment.className = 'comment-div commentQuestion';
nicholas@934: 		trackComment.id = element.attributes['id'].value;
nicholas@934: 		// Create a string next to each comment asking for a comment
nicholas@934: 		var trackString = document.createElement('span');
nicholas@934: 		trackString.innerHTML = element.textContent;
nicholas@934: 		// Create the HTML5 comment box 'textarea'
nicholas@934: 		var trackCommentBox = document.createElement('textarea');
nicholas@934: 		trackCommentBox.rows = '4';
nicholas@934: 		trackCommentBox.cols = '100';
nicholas@934: 		trackCommentBox.name = 'commentQuestion'+index;
nicholas@934: 		trackCommentBox.className = 'trackComment';
nicholas@934: 		var br = document.createElement('br');
nicholas@934: 		// Add to the holder.
nicholas@934: 		trackComment.appendChild(trackString);
nicholas@934: 		trackComment.appendChild(br);
nicholas@934: 		trackComment.appendChild(trackCommentBox);
nicholas@934: 		feedbackHolder.appendChild(trackComment);
nicholas@934: 	});
nicholas@934: }
nicholas@934: 
nicholas@934: 
nicholas@934: function dragEnd(ev) {
nicholas@934: 	// Function call when a div has been dropped
nicholas@934: 	var slider = document.getElementById('slider');
nicholas@934: 	var marginSize = Number(slider.attributes['marginsize'].value);
nicholas@934: 	var w = slider.style.width;
nicholas@934: 	w = Number(w.substr(0,w.length-2));
nicholas@934: 	var x = ev.x;
nicholas@934: 	if (x >= marginSize && x < w+marginSize) {
nicholas@934: 		this.style.left = (x)+'px';
nicholas@934: 	} else {
nicholas@934: 		if (x<marginSize) {
nicholas@934: 			this.style.left = marginSize+'px';
nicholas@934: 		} else {
nicholas@934: 			this.style.left = (w+marginSize) + 'px';
nicholas@934: 		}
nicholas@934: 	}
nicholas@934: 	audioEngineContext.metric.sliderMoved();
nicholas@934: }
nicholas@934: 
nicholas@934: function buttonSubmitClick() // TODO: Only when all songs have been played!
nicholas@934: {
nicholas@934:     hasBeenPlayed = audioEngineContext.checkAllPlayed();
nicholas@934:     if (hasBeenPlayed.length == 0) {
nicholas@934: 	    if (audioEngineContext.status == 1) {
nicholas@934: 	        var playback = document.getElementById('playback-button');
nicholas@934: 	        playback.click();
nicholas@934: 	    // This function is called when the submit button is clicked. Will check for any further tests to perform, or any post-test options
nicholas@934: 	    } else
nicholas@934: 	    {
nicholas@934: 	        if (audioEngineContext.timer.testStarted == false)
nicholas@934: 	        {
nicholas@934: 	            alert('You have not started the test! Please press start to begin the test!');
nicholas@934: 	            return;
nicholas@934: 	        }
nicholas@934: 	    }
nicholas@934: 	    testState.advanceState();
nicholas@934:     } else // if a fragment has not been played yet
nicholas@934:     {
nicholas@934:     	str = "";
nicholas@934:     	if (hasBeenPlayed.length > 1) {
nicholas@934: 	    	for (var i=0; i<hasBeenPlayed.length; i++) {
nicholas@934: 	    		str = str + hasBeenPlayed[i];
nicholas@934: 	    		if (i < hasBeenPlayed.length-2){
nicholas@934: 	    			str += ", ";
nicholas@934: 	    		} else if (i == hasBeenPlayed.length-2) {
nicholas@934: 	    			str += " or ";
nicholas@934: 	    		}
nicholas@934: 	    	}
nicholas@934: 	    	alert('You have not played fragments ' + str + ' yet. Please listen, rate and comment all samples before submitting.');
nicholas@934:        } else {
nicholas@934:        		alert('You have not played fragment ' + hasBeenPlayed[0] + ' yet. Please listen, rate and comment all samples before submitting.');
nicholas@934:        }
nicholas@934:         return;
nicholas@934:     }
nicholas@934: }
nicholas@934: 
nicholas@934: function convSliderPosToRate(id)
nicholas@934: {
nicholas@934: 	var w = document.getElementById('slider').style.width;
nicholas@934: 	var marginsize = Number(document.getElementById('slider').attributes['marginsize'].value);
nicholas@934: 	var maxPix = w.substr(0,w.length-2);
nicholas@934: 	var slider = document.getElementsByClassName('track-slider')[id];
nicholas@934: 	var pix = slider.style.left;
nicholas@934: 	pix = pix.substr(0,pix.length-2);
nicholas@934: 	var rate = (pix-marginsize)/maxPix;
nicholas@934: 	return rate;
nicholas@934: }
nicholas@934: 
nicholas@934: function resizeWindow(event){
nicholas@934: 	// Function called when the window has been resized.
nicholas@934: 	// MANDATORY FUNCTION
nicholas@934: 	
nicholas@934: 	// Store the slider marker values
nicholas@934: 	var holdValues = [];
nicholas@934: 	$(".track-slider").each(function(index,sliderObj){
nicholas@934: 		holdValues.push(convSliderPosToRate(index));
nicholas@934: 	});
nicholas@934: 	
nicholas@934: 	var width = event.target.innerWidth;
nicholas@934: 	var canvas = document.getElementById('sliderCanvasHolder');
nicholas@934: 	var sliderDiv = canvas.children[0];
nicholas@934: 	var sliderScaleDiv = canvas.children[1];
nicholas@934: 	var marginsize = Number(sliderDiv.attributes['marginsize'].value);
nicholas@934: 	var w = (marginsize+8)*2;
nicholas@934: 	sliderDiv.style.width = width - w + 'px';
nicholas@934: 	var width = width - w;
nicholas@934: 	// Move sliders into new position
nicholas@934: 	$(".track-slider").each(function(index,sliderObj){
nicholas@934: 		var pos = holdValues[index];
nicholas@934: 		var pix = pos * width;
nicholas@934: 		sliderObj.style.left = pix+marginsize+'px';
nicholas@934: 	});
nicholas@934: 	
nicholas@934: 	// Move scale labels
nicholas@934: 	$(sliderScaleDiv.children).each(function(index,scaleObj){
nicholas@934: 		var position = Number(scaleObj.attributes['value'].value);
nicholas@934: 		var pixelPosition = (position*width)+marginsize;
nicholas@934: 		scaleObj.style.left = Math.floor((pixelPosition-($(scaleObj).width()/2)))+'px';
nicholas@934: 	});
nicholas@934: }
nicholas@934: 
nicholas@934: function pageXMLSave(store, testXML, testId)
nicholas@934: {
nicholas@934: 	// Saves a specific test page
nicholas@934: 	var xmlDoc = store;
nicholas@934: 	// Check if any session wide metrics are enabled
nicholas@934: 	
nicholas@934: 	var commentShow = testXML.attributes['elementComments'];
nicholas@934: 	if (commentShow != undefined) {
nicholas@934: 		if (commentShow.value == 'false') {commentShow = false;}
nicholas@934: 		else {commentShow = true;}
nicholas@934: 	} else {commentShow = true;}
nicholas@934: 	
nicholas@934: 	var metric = document.createElement('metric');
nicholas@934: 	if (audioEngineContext.metric.enableTestTimer)
nicholas@934: 	{
nicholas@934: 		var testTime = document.createElement('metricResult');
nicholas@934: 		testTime.id = 'testTime';
nicholas@934: 		testTime.textContent = audioEngineContext.timer.testDuration;
nicholas@934: 		metric.appendChild(testTime);
nicholas@934: 	}
nicholas@934: 	xmlDoc.appendChild(metric);
nicholas@934: 	var trackSliderObjects = document.getElementsByClassName('track-slider');
nicholas@934: 	var commentObjects = document.getElementsByClassName('comment-div');
nicholas@934: 	for (var i=0; i<trackSliderObjects.length; i++) 
nicholas@934: 	{
nicholas@934: 		var audioElement = document.createElement('audioElement');
nicholas@934: 		audioElement.id = currentTrackOrder[i].attributes['id'].value;
nicholas@934: 		audioElement.url = currentTrackOrder[i].attributes['url'].value;
nicholas@934: 		var value = document.createElement('value');
nicholas@934: 		value.innerHTML = convSliderPosToRate(i);
nicholas@934: 		if (commentShow) {
nicholas@934: 			var comment = document.createElement("comment");
nicholas@934: 			var question = document.createElement("question");
nicholas@934: 			var response = document.createElement("response");
nicholas@934: 			question.textContent = commentObjects[i].children[0].textContent;
nicholas@934: 			response.textContent = commentObjects[i].children[2].value;
nicholas@934:             console.log('Comment ' + i + ': ' + commentObjects[i].children[2].value); // DEBUG/SAFETY
nicholas@934: 			comment.appendChild(question);
nicholas@934: 			comment.appendChild(response);
nicholas@934: 			audioElement.appendChild(comment);
nicholas@934: 		}
nicholas@934: 		audioElement.appendChild(value);
nicholas@934: 		// Check for any per element metrics
nicholas@934: 		var metric = document.createElement('metric');
nicholas@934: 		var elementMetric = audioEngineContext.audioObjects[i].metric;
nicholas@934: 		if (audioEngineContext.metric.enableElementTimer) {
nicholas@934: 			var elementTimer = document.createElement('metricResult');
nicholas@934: 			elementTimer.id = 'elementTimer';
nicholas@934: 			elementTimer.textContent = elementMetric.listenedTimer;
nicholas@934: 			metric.appendChild(elementTimer);
nicholas@934: 		}
nicholas@934: 		if (audioEngineContext.metric.enableElementTracker) {
nicholas@934: 			var elementTrackerFull = document.createElement('metricResult');
nicholas@934: 			elementTrackerFull.id = 'elementTrackerFull';
nicholas@934: 			var data = elementMetric.movementTracker;
nicholas@934: 			for (var k=0; k<data.length; k++)
nicholas@934: 			{
nicholas@934: 				var timePos = document.createElement('timePos');
nicholas@934: 				timePos.id = k;
nicholas@934: 				var time = document.createElement('time');
nicholas@934: 				time.textContent = data[k][0];
nicholas@934: 				var position = document.createElement('position');
nicholas@934: 				position.textContent = data[k][1];
nicholas@934: 				timePos.appendChild(time);
nicholas@934: 				timePos.appendChild(position);
nicholas@934: 				elementTrackerFull.appendChild(timePos);
nicholas@934: 			}
nicholas@934: 			metric.appendChild(elementTrackerFull);
nicholas@934: 		}
nicholas@934: 		if (audioEngineContext.metric.enableElementInitialPosition) {
nicholas@934: 			var elementInitial = document.createElement('metricResult');
nicholas@934: 			elementInitial.id = 'elementInitialPosition';
nicholas@934: 			elementInitial.textContent = elementMetric.initialPosition;
nicholas@934: 			metric.appendChild(elementInitial);
nicholas@934: 		}
nicholas@934: 		if (audioEngineContext.metric.enableFlagListenedTo) {
nicholas@934: 			var flagListenedTo = document.createElement('metricResult');
nicholas@934: 			flagListenedTo.id = 'elementFlagListenedTo';
nicholas@934: 			flagListenedTo.textContent = elementMetric.wasListenedTo;
nicholas@934: 			metric.appendChild(flagListenedTo);
nicholas@934: 		}
nicholas@934: 		if (audioEngineContext.metric.enableFlagMoved) {
nicholas@934: 			var flagMoved = document.createElement('metricResult');
nicholas@934: 			flagMoved.id = 'elementFlagMoved';
nicholas@934: 			flagMoved.textContent = elementMetric.wasMoved;
nicholas@934: 			metric.appendChild(flagMoved);
nicholas@934: 		}
nicholas@934: 		if (audioEngineContext.metric.enableFlagComments) {
nicholas@934: 			var flagComments = document.createElement('metricResult');
nicholas@934: 			flagComments.id = 'elementFlagComments';
nicholas@934: 			if (response.textContent.length == 0) {flag.textContent = 'false';}
nicholas@934: 			else {flag.textContet = 'true';}
nicholas@934: 			metric.appendChild(flagComments);
nicholas@934: 		}
nicholas@934: 		audioElement.appendChild(metric);
nicholas@934: 		xmlDoc.appendChild(audioElement);
nicholas@934: 	}
nicholas@934: 	var commentQuestion = document.getElementsByClassName('commentQuestion');
nicholas@934: 	for (var i=0; i<commentQuestion.length; i++)
nicholas@934: 	{
nicholas@934: 		var cqHolder = document.createElement('CommentQuestion');
nicholas@934: 		var comment = document.createElement('comment');
nicholas@934: 		var question = document.createElement('question');
nicholas@934: 		cqHolder.id = commentQuestion[i].id;
nicholas@934: 		comment.textContent = commentQuestion[i].children[2].value;
nicholas@934: 		question.textContent = commentQuestion[i].children[0].textContent;
nicholas@934:         console.log('Question ' + i + ': ' + commentQuestion[i].children[2].value); // DEBUG/SAFETY
nicholas@934: 		cqHolder.appendChild(question);
nicholas@934: 		cqHolder.appendChild(comment);
nicholas@934: 		xmlDoc.appendChild(cqHolder);
nicholas@934: 	}
nicholas@934: 	store = xmlDoc;
nicholas@934: }