nickjillings@1682: /**
nickjillings@1682:  * core.js
nickjillings@1682:  * 
nickjillings@1682:  * Main script to run, calls all other core functions and manages loading/store to backend.
nickjillings@1682:  * Also contains all global variables.
nickjillings@1682:  */
nickjillings@1682: 
nickjillings@1682: /* create the web audio API context and store in audioContext*/
nickjillings@1643: var audioContext; // Hold the browser web audio API
nickjillings@1643: var projectXML; // Hold the parsed setup XML
nickjillings@1581: var specification;
nickjillings@1582: var interfaceContext;
nickjillings@1622: var popup; // Hold the interfacePopup object
nickjillings@1634: var testState;
nickjillings@1655: var currentTrackOrder = []; // Hold the current XML tracks in their (randomised) order
nickjillings@1643: var audioEngineContext; // The custome AudioEngine object
nickjillings@1643: var projectReturn; // Hold the URL for the return
nickjillings@2013: 
nickjillings@1642: 
nickjillings@1667: // Add a prototype to the bufferSourceNode to reference to the audioObject holding it
nickjillings@1667: AudioBufferSourceNode.prototype.owner = undefined;
nickjillings@1682: 
nickjillings@1682: window.onload = function() {
nickjillings@1682: 	// Function called once the browser has loaded all files.
nickjillings@1682: 	// This should perform any initial commands such as structure / loading documents
nickjillings@1682: 	
nickjillings@1682: 	// Create a web audio API context
nickjillings@1701: 	// Fixed for cross-browser support
nickjillings@1701: 	var AudioContext = window.AudioContext || window.webkitAudioContext;
nickjillings@1688: 	audioContext = new AudioContext;
nickjillings@1682: 	
nickjillings@1634: 	// Create test state
nickjillings@1634: 	testState = new stateMachine();
nickjillings@1634: 	
nickjillings@1682: 	// Create the audio engine object
nickjillings@1682: 	audioEngineContext = new AudioEngine();
nickjillings@1622: 	
nickjillings@1622: 	// Create the popup interface object
nickjillings@1622: 	popup = new interfacePopup();
nickjillings@1581: 	
nickjillings@1581: 	// Create the specification object
nickjillings@1581: 	specification = new Specification();
nickjillings@1582: 	
nickjillings@1582: 	// Create the interface object
nickjillings@1582: 	interfaceContext = new Interface(specification);
nickjillings@1697: };
nickjillings@1682: 
nickjillings@1622: function interfacePopup() {
nickjillings@1622: 	// Creates an object to manage the popup
nickjillings@1622: 	this.popup = null;
nickjillings@1622: 	this.popupContent = null;
nickjillings@1622: 	this.popupButton = null;
nickjillings@1622: 	this.popupOptions = null;
nickjillings@1622: 	this.currentIndex = null;
nickjillings@1622: 	this.responses = null;
nickjillings@1581: 	
nickjillings@1622: 	this.createPopup = function(){
nickjillings@1622: 		// Create popup window interface
nickjillings@1622: 		var insertPoint = document.getElementById("topLevelBody");
nickjillings@1622: 		var blank = document.createElement('div');
nickjillings@1622: 		blank.className = 'testHalt';
nickjillings@1622: 		
nickjillings@1622: 		this.popup = document.createElement('div');
nickjillings@1622: 		this.popup.id = 'popupHolder';
nickjillings@1622: 		this.popup.className = 'popupHolder';
nickjillings@1622: 		this.popup.style.position = 'absolute';
nickjillings@1622: 		this.popup.style.left = (window.innerWidth/2)-250 + 'px';
nickjillings@1622: 		this.popup.style.top = (window.innerHeight/2)-125 + 'px';
nickjillings@1622: 		
nickjillings@1622: 		this.popupContent = document.createElement('div');
nickjillings@1622: 		this.popupContent.id = 'popupContent';
nickjillings@1622: 		this.popupContent.style.marginTop = '25px';
nickjillings@1622: 		this.popupContent.align = 'center';
nickjillings@1622: 		this.popup.appendChild(this.popupContent);
nickjillings@1622: 		
nickjillings@1622: 		this.popupButton = document.createElement('button');
nickjillings@1622: 		this.popupButton.className = 'popupButton';
nickjillings@1622: 		this.popupButton.innerHTML = 'Next';
nickjillings@1622: 		this.popupButton.onclick = function(){popup.buttonClicked();};
nickjillings@1581: 		this.popup.style.zIndex = -1;
nickjillings@1581: 		this.popup.style.visibility = 'hidden';
nickjillings@1581: 		blank.style.zIndex = -2;
nickjillings@1581: 		blank.style.visibility = 'hidden';
nickjillings@1622: 		insertPoint.appendChild(this.popup);
nickjillings@1622: 		insertPoint.appendChild(blank);
nickjillings@1622: 	};
nickjillings@1621: 	
nickjillings@1622: 	this.showPopup = function(){
nickjillings@1581: 		if (this.popup == null) {
nickjillings@1622: 			this.createPopup();
nickjillings@1622: 		}
nickjillings@1622: 		this.popup.style.zIndex = 3;
nickjillings@1622: 		this.popup.style.visibility = 'visible';
nickjillings@1622: 		var blank = document.getElementsByClassName('testHalt')[0];
nickjillings@1622: 		blank.style.zIndex = 2;
nickjillings@1622: 		blank.style.visibility = 'visible';
nickjillings@1622: 	};
nickjillings@1622: 	
nickjillings@1622: 	this.hidePopup = function(){
nickjillings@1622: 		this.popup.style.zIndex = -1;
nickjillings@1622: 		this.popup.style.visibility = 'hidden';
nickjillings@1622: 		var blank = document.getElementsByClassName('testHalt')[0];
nickjillings@1622: 		blank.style.zIndex = -2;
nickjillings@1622: 		blank.style.visibility = 'hidden';
nickjillings@1622: 	};
nickjillings@1622: 	
nickjillings@1622: 	this.postNode = function() {
nickjillings@1622: 		// This will take the node from the popupOptions and display it
nickjillings@1622: 		var node = this.popupOptions[this.currentIndex];
nickjillings@1622: 		this.popupContent.innerHTML = null;
nickjillings@1581: 		if (node.type == 'statement') {
nickjillings@1622: 			var span = document.createElement('span');
nickjillings@1581: 			span.textContent = node.statement;
nickjillings@1622: 			this.popupContent.appendChild(span);
nickjillings@1581: 		} else if (node.type == 'question') {
nickjillings@1622: 			var span = document.createElement('span');
nickjillings@1581: 			span.textContent = node.question;
nickjillings@1622: 			var textArea = document.createElement('textarea');
nickjillings@2030: 			switch (node.boxsize) {
nickjillings@2030: 			case 'small':
nickjillings@2030: 				textArea.cols = "20";
nickjillings@2030: 				textArea.rows = "1";
nickjillings@2030: 				break;
nickjillings@2030: 			case 'normal':
nickjillings@2030: 				textArea.cols = "30";
nickjillings@2030: 				textArea.rows = "2";
nickjillings@2030: 				break;
nickjillings@2030: 			case 'large':
nickjillings@2030: 				textArea.cols = "40";
nickjillings@2030: 				textArea.rows = "5";
nickjillings@2030: 				break;
nickjillings@2030: 			case 'huge':
nickjillings@2030: 				textArea.cols = "50";
nickjillings@2030: 				textArea.rows = "10";
nickjillings@2030: 				break;
nickjillings@2030: 			}
nickjillings@1622: 			var br = document.createElement('br');
nickjillings@1622: 			this.popupContent.appendChild(span);
nickjillings@1622: 			this.popupContent.appendChild(br);
nickjillings@1622: 			this.popupContent.appendChild(textArea);
nickjillings@2015: 			this.popupContent.childNodes[2].focus();
nickjillings@1588: 		} else if (node.type == 'checkbox') {
nickjillings@1588: 			var span = document.createElement('span');
nickjillings@1588: 			span.textContent = node.statement;
nickjillings@1588: 			this.popupContent.appendChild(span);
nickjillings@1588: 			var optHold = document.createElement('div');
nickjillings@1588: 			optHold.id = 'option-holder';
nickjillings@1588: 			optHold.align = 'left';
nickjillings@1588: 			for (var i=0; i<node.options.length; i++) {
nickjillings@1588: 				var option = node.options[i];
nickjillings@1588: 				var input = document.createElement('input');
nickjillings@1588: 				input.id = option.id;
nickjillings@1588: 				input.type = 'checkbox';
nickjillings@1588: 				var span = document.createElement('span');
nickjillings@1588: 				span.textContent = option.text;
nickjillings@1588: 				var hold = document.createElement('div');
nickjillings@1588: 				hold.setAttribute('name','option');
nickjillings@1588: 				hold.style.float = 'left';
nickjillings@1588: 				hold.style.padding = '4px';
nickjillings@1588: 				hold.appendChild(input);
nickjillings@1588: 				hold.appendChild(span);
nickjillings@1588: 				optHold.appendChild(hold);
nickjillings@1588: 			}
nickjillings@1588: 			this.popupContent.appendChild(optHold);
nickjillings@1589: 		} else if (node.type == 'radio') {
nickjillings@1589: 			var span = document.createElement('span');
nickjillings@1589: 			span.textContent = node.statement;
nickjillings@1589: 			this.popupContent.appendChild(span);
nickjillings@1589: 			var optHold = document.createElement('div');
nickjillings@1589: 			optHold.id = 'option-holder';
nickjillings@1589: 			optHold.align = 'none';
nickjillings@1589: 			optHold.style.float = 'left';
nickjillings@1589: 			optHold.style.width = "100%";
nickjillings@1589: 			for (var i=0; i<node.options.length; i++) {
nickjillings@1589: 				var option = node.options[i];
nickjillings@1589: 				var input = document.createElement('input');
nickjillings@1589: 				input.id = option.name;
nickjillings@1589: 				input.type = 'radio';
nickjillings@1589: 				input.name = node.id;
nickjillings@1589: 				var span = document.createElement('span');
nickjillings@1589: 				span.textContent = option.text;
nickjillings@1589: 				var hold = document.createElement('div');
nickjillings@1589: 				hold.setAttribute('name','option');
nickjillings@1589: 				hold.style.padding = '4px';
nickjillings@1589: 				hold.appendChild(input);
nickjillings@1589: 				hold.appendChild(span);
nickjillings@1589: 				optHold.appendChild(hold);
nickjillings@1589: 			}
nickjillings@1589: 			this.popupContent.appendChild(optHold);
nickjillings@1622: 		}
nickjillings@1622: 		this.popupContent.appendChild(this.popupButton);
nickjillings@2015: 	};
nickjillings@1622: 	
nickjillings@1622: 	this.initState = function(node) {
nickjillings@1622: 		//Call this with your preTest and postTest nodes when needed to
nickjillings@1622: 		// initialise the popup procedure.
nickjillings@1581: 		this.popupOptions = node.options;
nickjillings@1622: 		if (this.popupOptions.length > 0) {
nickjillings@1581: 			if (node.type == 'pretest') {
nickjillings@1622: 				this.responses = document.createElement('PreTest');
nickjillings@1581: 			} else if (node.type == 'posttest') {
nickjillings@1622: 				this.responses = document.createElement('PostTest');
nickjillings@1622: 			} else {
nickjillings@1622: 				console.log ('WARNING - popup node neither pre or post!');
nickjillings@1622: 				this.responses = document.createElement('responses');
nickjillings@1622: 			}
nickjillings@1622: 			this.currentIndex = 0;
nickjillings@1622: 			this.showPopup();
nickjillings@1622: 			this.postNode();
nickjillings@1581: 		} else {
nickjillings@1581: 			advanceState();
nickjillings@1622: 		}
nickjillings@2015: 	};
nickjillings@1622: 	
nickjillings@1622: 	this.buttonClicked = function() {
nickjillings@1622: 		// Each time the popup button is clicked!
nickjillings@1622: 		var node = this.popupOptions[this.currentIndex];
nickjillings@1581: 		if (node.type == 'question') {
nickjillings@1622: 			// Must extract the question data
nickjillings@1622: 			var textArea = $(popup.popupContent).find('textarea')[0];
nickjillings@1581: 			if (node.mandatory == true && textArea.value.length == 0) {
nickjillings@1622: 				alert('This question is mandatory');
nickjillings@1622: 				return;
nickjillings@1622: 			} else {
nickjillings@1622: 				// Save the text content
nickjillings@1622: 				var hold = document.createElement('comment');
nickjillings@1581: 				hold.id = node.id;
nickjillings@1622: 				hold.innerHTML = textArea.value;
nickjillings@1623: 				console.log("Question: "+ node.textContent);
nickjillings@1623: 				console.log("Question Response: "+ textArea.value);
nickjillings@1622: 				this.responses.appendChild(hold);
nickjillings@1622: 			}
nickjillings@1588: 		} else if (node.type == 'checkbox') {
nickjillings@1588: 			// Must extract checkbox data
nickjillings@1588: 			var optHold = document.getElementById('option-holder');
nickjillings@1588: 			var hold = document.createElement('checkbox');
nickjillings@1588: 			console.log("Checkbox: "+ node.statement);
nickjillings@1589: 			hold.id = node.id;
nickjillings@1588: 			for (var i=0; i<optHold.childElementCount; i++) {
nickjillings@1588: 				var input = optHold.childNodes[i].getElementsByTagName('input')[0];
nickjillings@1588: 				var statement = optHold.childNodes[i].getElementsByTagName('span')[0];
nickjillings@1588: 				var response = document.createElement('option');
nickjillings@1588: 				response.setAttribute('id',input.id);
nickjillings@1588: 				response.setAttribute('checked',input.checked);
nickjillings@1588: 				hold.appendChild(response);
nickjillings@1588: 				console.log(input.id +': '+ input.checked);
nickjillings@1588: 			}
nickjillings@1588: 			this.responses.appendChild(hold);
nickjillings@1589: 		} else if (node.type == "radio") {
nickjillings@1589: 			var optHold = document.getElementById('option-holder');
nickjillings@1589: 			var hold = document.createElement('radio');
nickjillings@1589: 			var responseID = null;
nickjillings@1589: 			var i=0;
nickjillings@1589: 			while(responseID == null) {
nickjillings@1589: 				var input = optHold.childNodes[i].getElementsByTagName('input')[0];
nickjillings@1589: 				if (input.checked == true) {
nickjillings@1589: 					responseID = i;
nickjillings@1589: 				}
nickjillings@1589: 				i++;
nickjillings@1589: 			}
nickjillings@1589: 			hold.id = node.id;
nickjillings@1589: 			hold.setAttribute('name',node.options[responseID].name);
nickjillings@1589: 			hold.textContent = node.options[responseID].text;
nickjillings@1589: 			this.responses.appendChild(hold);
nickjillings@1622: 		}
nickjillings@1622: 		this.currentIndex++;
nickjillings@1622: 		if (this.currentIndex < this.popupOptions.length) {
nickjillings@1622: 			this.postNode();
nickjillings@1622: 		} else {
nickjillings@1622: 			// Reached the end of the popupOptions
nickjillings@1622: 			this.hidePopup();
nickjillings@1634: 			if (this.responses.nodeName == testState.stateResults[testState.stateIndex].nodeName) {
nickjillings@1634: 				testState.stateResults[testState.stateIndex] = this.responses;
nickjillings@1634: 			} else {
nickjillings@1634: 				testState.stateResults[testState.stateIndex].appendChild(this.responses);
nickjillings@1634: 			}
nickjillings@1622: 			advanceState();
nickjillings@1622: 		}
nickjillings@2015: 	};
nickjillings@1621: }
nickjillings@1621: 
nickjillings@1622: function advanceState()
nickjillings@1621: {
nickjillings@1634: 	// Just for complete clarity
nickjillings@1634: 	testState.advanceState();
nickjillings@1634: }
nickjillings@1634: 
nickjillings@1634: function stateMachine()
nickjillings@1634: {
nickjillings@1634: 	// Object prototype for tracking and managing the test state
nickjillings@1634: 	this.stateMap = [];
nickjillings@1634: 	this.stateIndex = null;
nickjillings@1634: 	this.currentStateMap = [];
nickjillings@1634: 	this.currentIndex = null;
nickjillings@1634: 	this.currentTestId = 0;
nickjillings@1634: 	this.stateResults = [];
nickjillings@1604: 	this.timerCallBackHolders = null;
nickjillings@1634: 	this.initialise = function(){
nickjillings@1634: 		if (this.stateMap.length > 0) {
nickjillings@1634: 			if(this.stateIndex != null) {
nickjillings@1634: 				console.log('NOTE - State already initialise');
nickjillings@1634: 			}
nickjillings@1634: 			this.stateIndex = -1;
nickjillings@1634: 			var that = this;
nickjillings@1634: 			for (var id=0; id<this.stateMap.length; id++){
nickjillings@1581: 				var name = this.stateMap[id].type;
nickjillings@1634: 				var obj = document.createElement(name);
nickjillings@1587: 				if (name == 'audioHolder') {
nickjillings@1600: 					obj.id = this.stateMap[id].id;
nickjillings@1600: 				}
nickjillings@1634: 				this.stateResults.push(obj);
nickjillings@1634: 			}
nickjillings@1634: 		} else {
nickjillings@1634: 			conolse.log('FATAL - StateMap not correctly constructed. EMPTY_STATE_MAP');
nickjillings@1622: 		}
nickjillings@1634: 	};
nickjillings@1634: 	this.advanceState = function(){
nickjillings@1634: 		if (this.stateIndex == null) {
nickjillings@1634: 			this.initialise();
nickjillings@1634: 		}
nickjillings@1634: 		if (this.stateIndex == -1) {
nickjillings@1634: 			console.log('Starting test...');
nickjillings@1634: 		}
nickjillings@1634: 		if (this.currentIndex == null){
nickjillings@1581: 			if (this.currentStateMap.type == "audioHolder") {
nickjillings@1634: 				// Save current page
nickjillings@1634: 				this.testPageCompleted(this.stateResults[this.stateIndex],this.currentStateMap,this.currentTestId);
nickjillings@1634: 				this.currentTestId++;
nickjillings@1634: 			}
nickjillings@1634: 			this.stateIndex++;
nickjillings@1634: 			if (this.stateIndex >= this.stateMap.length) {
nickjillings@1634: 				console.log('Test Completed');
nickjillings@1582: 				createProjectSave(specification.projectReturn);
nickjillings@1634: 			} else {
nickjillings@1634: 				this.currentStateMap = this.stateMap[this.stateIndex];
nickjillings@1581: 				if (this.currentStateMap.type == "audioHolder") {
nickjillings@1634: 					console.log('Loading test page');
nickjillings@1634: 					loadTest(this.currentStateMap);
nickjillings@1634: 					this.initialiseInnerState(this.currentStateMap);
nickjillings@1581: 				} else if (this.currentStateMap.type == "pretest" || this.currentStateMap.type == "posttest") {
nickjillings@1581: 					if (this.currentStateMap.options.length >= 1) {
nickjillings@1634: 						popup.initState(this.currentStateMap);
nickjillings@1634: 					} else {
nickjillings@1634: 						this.advanceState();
nickjillings@1634: 					}
nickjillings@1634: 				} else {
nickjillings@1634: 					this.advanceState();
nickjillings@1634: 				}
nickjillings@1634: 			}
nickjillings@1634: 		} else {
nickjillings@1634: 			this.advanceInnerState();
nickjillings@1634: 		}
nickjillings@1634: 	};
nickjillings@1634: 	
nickjillings@1634: 	this.testPageCompleted = function(store, testXML, testId) {
nickjillings@1634: 		// Function called each time a test page has been completed
nickjillings@1634: 		// Can be used to over-rule default behaviour
nickjillings@1634: 		
nickjillings@1581: 		pageXMLSave(store, testXML);
nickjillings@1576: 	};
nickjillings@1634: 	
nickjillings@1581: 	this.initialiseInnerState = function(node) {
nickjillings@1634: 		// Parses the received testXML for pre and post test options
nickjillings@1634: 		this.currentStateMap = [];
nickjillings@1581: 		var preTest = node.preTest;
nickjillings@1581: 		var postTest = node.postTest;
nickjillings@1634: 		if (preTest == undefined) {preTest = document.createElement("preTest");}
nickjillings@1634: 		if (postTest == undefined){postTest= document.createElement("postTest");}
nickjillings@1634: 		this.currentStateMap.push(preTest);
nickjillings@1581: 		this.currentStateMap.push(node);
nickjillings@1634: 		this.currentStateMap.push(postTest);
nickjillings@1634: 		this.currentIndex = -1;
nickjillings@1634: 		this.advanceInnerState();
nickjillings@1576: 	};
nickjillings@1634: 	
nickjillings@1634: 	this.advanceInnerState = function() {
nickjillings@1634: 		this.currentIndex++;
nickjillings@1634: 		if (this.currentIndex >= this.currentStateMap.length) {
nickjillings@1634: 			this.currentIndex = null;
nickjillings@1634: 			this.currentStateMap = this.stateMap[this.stateIndex];
nickjillings@1634: 			this.advanceState();
nickjillings@1634: 		} else {
nickjillings@1581: 			if (this.currentStateMap[this.currentIndex].type == "audioHolder") {
nickjillings@1634: 				console.log("Loading test page"+this.currentTestId);
nickjillings@1581: 			} else if (this.currentStateMap[this.currentIndex].type == "pretest") {
nickjillings@1634: 				popup.initState(this.currentStateMap[this.currentIndex]);
nickjillings@1581: 			} else if (this.currentStateMap[this.currentIndex].type == "posttest") {
nickjillings@1634: 				popup.initState(this.currentStateMap[this.currentIndex]);
nickjillings@1634: 			} else {
nickjillings@1634: 				this.advanceInnerState();
nickjillings@1634: 			}
nickjillings@1622: 		}
nickjillings@1576: 	};
nickjillings@1634: 	
nickjillings@1634: 	this.previousState = function(){};
nickjillings@1621: }
nickjillings@1621: 
nickjillings@1622: function testEnded(testId)
nickjillings@1621: {
nickjillings@1622: 	pageXMLSave(testId);
nickjillings@1622: 	if (testXMLSetups.length-1 > testId)
nickjillings@1622: 	{
nickjillings@1622: 		// Yes we have another test to perform
nickjillings@1622: 		testId = (Number(testId)+1);
nickjillings@1622: 		currentState = 'testRun-'+testId;
nickjillings@1622: 		loadTest(testId);
nickjillings@1622: 	} else {
nickjillings@1622: 		console.log('Testing Completed!');
nickjillings@1622: 		currentState = 'postTest';
nickjillings@1622: 		// Check for any post tests
nickjillings@1622: 		var xmlSetup = projectXML.find('setup');
nickjillings@1622: 		var postTest = xmlSetup.find('PostTest')[0];
nickjillings@1622: 		popup.initState(postTest);
nickjillings@1622: 	}
nickjillings@1621: }
nickjillings@1621: 
nickjillings@1682: function loadProjectSpec(url) {
nickjillings@1682: 	// Load the project document from the given URL, decode the XML and instruct audioEngine to get audio data
nickjillings@1682: 	// If url is null, request client to upload project XML document
nickjillings@1683: 	var r = new XMLHttpRequest();
nickjillings@1683: 	r.open('GET',url,true);
nickjillings@1683: 	r.onload = function() {
nickjillings@1683: 		loadProjectSpecCallback(r.response);
nickjillings@1697: 	};
nickjillings@1683: 	r.send();
nickjillings@1697: };
nickjillings@1683: 
nickjillings@1683: function loadProjectSpecCallback(response) {
nickjillings@1683: 	// Function called after asynchronous download of XML project specification
nickjillings@1580: 	//var decode = $.parseXML(response);
nickjillings@1580: 	//projectXML = $(decode);
nickjillings@1683: 	
nickjillings@1580: 	var parse = new DOMParser();
nickjillings@1580: 	projectXML = parse.parseFromString(response,'text/xml');
nickjillings@1575: 	
nickjillings@1581: 	// Build the specification
nickjillings@1581: 	specification.decode();
nickjillings@1576: 	
nickjillings@1581: 	testState.stateMap.push(specification.preTest);
nickjillings@1576: 	 
nickjillings@1576: 	// New check if we need to randomise the test order
nickjillings@1581: 	if (specification.randomiseOrder)
nickjillings@1581: 	{
nickjillings@1581:  		specification.audioHolders = randomiseOrder(specification.audioHolders);
nickjillings@1576: 	}
nickjillings@1576: 	
nickjillings@1581: 	$(specification.audioHolders).each(function(index,elem){
nickjillings@1576: 		testState.stateMap.push(elem);
nickjillings@1576: 	});
nickjillings@1576: 	 
nickjillings@1581: 	 testState.stateMap.push(specification.postTest);
nickjillings@1576: 	 
nickjillings@1576: 	// Obtain the metrics enabled
nickjillings@1581: 	$(specification.metrics).each(function(index,node){
nickjillings@1576: 		var enabled = node.textContent;
nickjillings@1581: 		switch(node.enabled)
nickjillings@1576: 		{
nickjillings@1576: 		case 'testTimer':
nickjillings@1576: 			sessionMetrics.prototype.enableTestTimer = true;
nickjillings@1576: 			break;
nickjillings@1576: 		case 'elementTimer':
nickjillings@1576: 			sessionMetrics.prototype.enableElementTimer = true;
nickjillings@1576: 			break;
nickjillings@1576: 		case 'elementTracker':
nickjillings@1576: 			sessionMetrics.prototype.enableElementTracker = true;
nickjillings@1576: 			break;
nickjillings@1576: 		case 'elementListenTracker':
nickjillings@1576: 			sessionMetrics.prototype.enableElementListenTracker = true;
nickjillings@1576: 			break;
nickjillings@1576: 		case 'elementInitialPosition':
nickjillings@1576: 			sessionMetrics.prototype.enableElementInitialPosition = true;
nickjillings@1576: 			break;
nickjillings@1576: 		case 'elementFlagListenedTo':
nickjillings@1576: 			sessionMetrics.prototype.enableFlagListenedTo = true;
nickjillings@1576: 			break;
nickjillings@1576: 		case 'elementFlagMoved':
nickjillings@1576: 			sessionMetrics.prototype.enableFlagMoved = true;
nickjillings@1576: 			break;
nickjillings@1576: 		case 'elementFlagComments':
nickjillings@1576: 			sessionMetrics.prototype.enableFlagComments = true;
nickjillings@1576: 			break;
nickjillings@1576: 		}
nickjillings@1576: 	});
nickjillings@1576: 	
nickjillings@1576: 	
nickjillings@1576: 	
nickjillings@1697: 	// Detect the interface to use and load the relevant javascripts.
nickjillings@1683: 	var interfaceJS = document.createElement('script');
nickjillings@1683: 	interfaceJS.setAttribute("type","text/javascript");
nickjillings@1581: 	if (specification.interfaceType == 'APE') {
nickjillings@1683: 		interfaceJS.setAttribute("src","ape.js");
nickjillings@1643: 		
nickjillings@1643: 		// APE comes with a css file
nickjillings@1643: 		var css = document.createElement('link');
nickjillings@1643: 		css.rel = 'stylesheet';
nickjillings@1643: 		css.type = 'text/css';
nickjillings@1643: 		css.href = 'ape.css';
nickjillings@1643: 		
nickjillings@1643: 		document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1683: 	}
nickjillings@1683: 	document.getElementsByTagName("head")[0].appendChild(interfaceJS);
nickjillings@1633: 	
nickjillings@1633: 	// Define window callbacks for interface
nickjillings@1633: 	window.onresize = function(event){resizeWindow(event);};
nickjillings@1682: }
nickjillings@1682: 
nickjillings@1682: function createProjectSave(destURL) {
nickjillings@1682: 	// Save the data from interface into XML and send to destURL
nickjillings@1682: 	// If destURL is null then download XML in client
nickjillings@1688: 	// Now time to render file locally
nickjillings@1688: 	var xmlDoc = interfaceXMLSave();
nickjillings@1628: 	var parent = document.createElement("div");
nickjillings@1628: 	parent.appendChild(xmlDoc);
nickjillings@1628: 	var file = [parent.innerHTML];
nickjillings@1688: 	if (destURL == "null" || destURL == undefined) {
nickjillings@1688: 		var bb = new Blob(file,{type : 'application/xml'});
nickjillings@1688: 		var dnlk = window.URL.createObjectURL(bb);
nickjillings@1688: 		var a = document.createElement("a");
nickjillings@1688: 		a.hidden = '';
nickjillings@1688: 		a.href = dnlk;
nickjillings@1688: 		a.download = "save.xml";
nickjillings@1688: 		a.textContent = "Save File";
nickjillings@1688: 		
nickjillings@1624: 		popup.showPopup();
nickjillings@1624: 		popup.popupContent.innerHTML = null;
nickjillings@1582: 		popup.popupContent.appendChild(a);
nickjillings@1628: 	} else {
nickjillings@1628: 		var xmlhttp = new XMLHttpRequest;
nickjillings@1628: 		xmlhttp.open("POST",destURL,true);
nickjillings@1628: 		xmlhttp.setRequestHeader('Content-Type', 'text/xml');
nickjillings@1629: 		xmlhttp.onerror = function(){
nickjillings@1629: 			console.log('Error saving file to server! Presenting download locally');
nickjillings@1629: 			createProjectSave(null);
nickjillings@1629: 		};
nickjillings@2018: 		xmlhttp.onreadystatechange  = function() {
nickjillings@2018: 			console.log(xmlhttp.status);
nickjillings@2018: 			if (xmlhttp.status != 200 && xmlhttp.readyState == 4) {
nickjillings@2018: 				createProjectSave(null);
nickjillings@2018: 			}
nickjillings@2018: 		};
nickjillings@1628: 		xmlhttp.send(file);
nickjillings@1688: 	}
nickjillings@1682: }
nickjillings@1682: 
nickjillings@1634: // Only other global function which must be defined in the interface class. Determines how to create the XML document.
nickjillings@1634: function interfaceXMLSave(){
nickjillings@1634: 	// Create the XML string to be exported with results
nickjillings@1634: 	var xmlDoc = document.createElement("BrowserEvaluationResult");
nickjillings@1634: 	xmlDoc.appendChild(returnDateNode());
nickjillings@1634: 	for (var i=0; i<testState.stateResults.length; i++)
nickjillings@1634: 	{
nickjillings@1634: 		xmlDoc.appendChild(testState.stateResults[i]);
nickjillings@1634: 	}
nickjillings@1634: 	
nickjillings@1634: 	return xmlDoc;
nickjillings@1634: }
nickjillings@1634: 
nickjillings@1682: function AudioEngine() {
nickjillings@1682: 	
nickjillings@1682: 	// Create two output paths, the main outputGain and fooGain.
nickjillings@1682: 	// Output gain is default to 1 and any items for playback route here
nickjillings@1682: 	// Foo gain is used for analysis to ensure paths get processed, but are not heard
nickjillings@1682: 	// because web audio will optimise and any route which does not go to the destination gets ignored.
nickjillings@1682: 	this.outputGain = audioContext.createGain();
nickjillings@1682: 	this.fooGain = audioContext.createGain();
nickjillings@1682: 	this.fooGain.gain = 0;
nickjillings@1682: 	
nickjillings@1688: 	// Use this to detect playback state: 0 - stopped, 1 - playing
nickjillings@1688: 	this.status = 0;
nickjillings@1620: 	this.audioObjectsReady = false;
nickjillings@1688: 	
nickjillings@1682: 	// Connect both gains to output
nickjillings@1682: 	this.outputGain.connect(audioContext.destination);
nickjillings@1682: 	this.fooGain.connect(audioContext.destination);
nickjillings@1682: 	
nickjillings@1659: 	// Create the timer Object
nickjillings@1659: 	this.timer = new timer();
nickjillings@1659: 	// Create session metrics
nickjillings@1659: 	this.metric = new sessionMetrics(this);
nickjillings@1659: 	
nickjillings@1667: 	this.loopPlayback = false;
nickjillings@1667: 	
nickjillings@1682: 	// Create store for new audioObjects
nickjillings@1682: 	this.audioObjects = [];
nickjillings@1682: 	
nickjillings@1620: 	this.play = function() {
nickjillings@1620: 		// Start the timer and set the audioEngine state to playing (1)
nickjillings@1620: 		if (this.status == 0) {
nickjillings@1620: 			// Check if all audioObjects are ready
nickjillings@1620: 			if (this.audioObjectsReady == false) {
nickjillings@1620: 				this.audioObjectsReady = this.checkAllReady();
nickjillings@1620: 			}
nickjillings@1620: 			if (this.audioObjectsReady == true) {
nickjillings@1620: 				this.timer.startTest();
nickjillings@1636: 				if (this.loopPlayback) {
nickjillings@1636: 					for(var i=0; i<this.audioObjects.length; i++) {
nickjillings@1636: 						this.audioObjects[i].play(this.timer.getTestTime()+1);
nickjillings@1636: 					}
nickjillings@1636: 				}
nickjillings@1620: 				this.status = 1;
nickjillings@1620: 			}
nickjillings@1620: 		}
nickjillings@1620: 	};
nickjillings@1682: 	
nickjillings@1620: 	this.stop = function() {
nickjillings@1620: 		// Send stop and reset command to all playback buffers and set audioEngine state to stopped (1)
nickjillings@1620: 		if (this.status == 1) {
nickjillings@1620: 			for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1620: 			{
nickjillings@1620: 				this.audioObjects[i].stop();
nickjillings@1620: 			}
nickjillings@1620: 			this.status = 0;
nickjillings@1620: 		}
nickjillings@1620: 	};
nickjillings@1689: 	
nickjillings@1689: 	
nickjillings@1582: 	this.newTrack = function(element) {
nickjillings@1682: 		// Pull data from given URL into new audio buffer
nickjillings@1682: 		// URLs must either be from the same source OR be setup to 'Access-Control-Allow-Origin'
nickjillings@1688: 		
nickjillings@1682: 		// Create the audioObject with ID of the new track length;
nickjillings@1659: 		audioObjectId = this.audioObjects.length;
nickjillings@1682: 		this.audioObjects[audioObjectId] = new audioObject(audioObjectId);
nickjillings@1688: 
nickjillings@1688: 		// AudioObject will get track itself.
nickjillings@1582: 		this.audioObjects[audioObjectId].specification = element;
nickjillings@1582: 		this.audioObjects[audioObjectId].constructTrack(element.parent.hostURL + element.url);
nickjillings@1579: 		return this.audioObjects[audioObjectId];
nickjillings@1697: 	};
nickjillings@1682: 	
nickjillings@1620: 	this.newTestPage = function() {
nickjillings@1620: 		this.state = 0;
nickjillings@1620: 		this.audioObjectsReady = false;
nickjillings@1620: 		this.metric.reset();
nickjillings@1620: 		this.audioObjects = [];
nickjillings@1620: 	};
nickjillings@1620: 	
nickjillings@1614: 	this.checkAllPlayed = function() {
nickjillings@1614: 		arr = [];
nickjillings@1614: 		for (var id=0; id<this.audioObjects.length; id++) {
nickjillings@2008: 			if (this.audioObjects[id].metric.wasListenedTo == false) {
nickjillings@1614: 				arr.push(this.audioObjects[id].id);
nickjillings@1614: 			}
nickjillings@1614: 		}
nickjillings@1614: 		return arr;
nickjillings@1614: 	};
nickjillings@1614: 	
nickjillings@1620: 	this.checkAllReady = function() {
nickjillings@1620: 		var ready = true;
nickjillings@1620: 		for (var i=0; i<this.audioObjects.length; i++) {
nickjillings@1620: 			if (this.audioObjects[i].state == 0) {
nickjillings@1620: 				// Track not ready
nickjillings@1620: 				console.log('WAIT -- audioObject '+i+' not ready yet!');
nickjillings@1620: 				ready = false;
nickjillings@1620: 			};
nickjillings@1620: 		}
nickjillings@1620: 		return ready;
nickjillings@1620: 	};
nickjillings@1620: 	
nickjillings@1682: }
nickjillings@1682: 
nickjillings@1682: function audioObject(id) {
nickjillings@1682: 	// The main buffer object with common control nodes to the AudioEngine
nickjillings@1682: 	
nickjillings@1582: 	this.specification;
nickjillings@1682: 	this.id = id;
nickjillings@1682: 	this.state = 0; // 0 - no data, 1 - ready
nickjillings@1704: 	this.url = null; // Hold the URL given for the output back to the results.
nickjillings@1602: 	this.metric = new metricTracker(this);
nickjillings@1682: 	
nickjillings@1577: 	// Bindings for GUI
nickjillings@1583: 	this.interfaceDOM = null;
nickjillings@1577: 	this.commentDOM = null;
nickjillings@1577: 	
nickjillings@1682: 	// Create a buffer and external gain control to allow internal patching of effects and volume leveling.
nickjillings@1667: 	this.bufferNode = undefined;
nickjillings@1682: 	this.outputGain = audioContext.createGain();
nickjillings@1682: 	
nickjillings@1689: 	// Default output gain to be zero
nickjillings@1689: 	this.outputGain.gain.value = 0.0;
nickjillings@1689: 	
nickjillings@1682: 	// Connect buffer to the audio graph
nickjillings@1682: 	this.outputGain.connect(audioEngineContext.outputGain);
nickjillings@1682: 	
nickjillings@1682: 	// the audiobuffer is not designed for multi-start playback
nickjillings@1682: 	// When stopeed, the buffer node is deleted and recreated with the stored buffer.
nickjillings@1682: 	this.buffer;
b@1639:     
nickjillings@1637: 	this.loopStart = function() {
nickjillings@1637: 		this.outputGain.gain.value = 1.0;
nickjillings@1637: 		this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1577: 	};
nickjillings@1637: 	
nickjillings@1637: 	this.loopStop = function() {
nickjillings@1637: 		if (this.outputGain.gain.value != 0.0) {
nickjillings@1637: 			this.outputGain.gain.value = 0.0;
nickjillings@1637: 			this.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@1637: 		}
nickjillings@1577: 	};
nickjillings@1637: 	
nickjillings@1682: 	this.play = function(startTime) {
nickjillings@1667: 		this.bufferNode = audioContext.createBufferSource();
nickjillings@1617: 		this.bufferNode.owner = this;
nickjillings@1667: 		this.bufferNode.connect(this.outputGain);
nickjillings@1667: 		this.bufferNode.buffer = this.buffer;
nickjillings@1667: 		this.bufferNode.loop = audioEngineContext.loopPlayback;
nickjillings@1637: 		this.bufferNode.onended = function() {
nickjillings@2008: 			// Safari does not like using 'this' to reference the calling object!
nickjillings@2009: 			event.srcElement.owner.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@2008: 		};
nickjillings@1617: 		if (this.bufferNode.loop == false) {
nickjillings@1637: 			this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1617: 		}
nickjillings@1682: 		this.bufferNode.start(startTime);
nickjillings@1697: 	};
nickjillings@1682: 	
nickjillings@1682: 	this.stop = function() {
nickjillings@2002: 		if (this.bufferNode != undefined)
nickjillings@2002: 		{
nickjillings@2002: 			this.bufferNode.stop(0);
nickjillings@2002: 			this.bufferNode = undefined;
nickjillings@1637: 			this.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@2002: 		}
nickjillings@1697: 	};
nickjillings@2019: 	
nickjillings@2019: 	this.getCurrentPosition = function() {
nickjillings@2019: 		var time = audioEngineContext.timer.getTestTime();
nickjillings@2019: 		if (this.bufferNode != undefined) {
nickjillings@2019: 			if (this.bufferNode.loop == true) {
nickjillings@2019: 				if (audioEngineContext.status  == 1) {
nickjillings@2019: 					return time%this.buffer.duration;
nickjillings@2019: 				} else {
nickjillings@2019: 					return 0;
nickjillings@2019: 				}
nickjillings@2019: 			} else {
nickjillings@2019: 				if (this.metric.listenHold) {
nickjillings@2019: 					return time - this.metric.listenStart;
nickjillings@2019: 				} else {
nickjillings@2019: 					return 0;
nickjillings@2019: 				}
nickjillings@2019: 			}
nickjillings@2019: 		} else {
nickjillings@2019: 			return 0;
nickjillings@2019: 		}
nickjillings@2019: 	};
nickjillings@1689: 
nickjillings@1688: 	this.constructTrack = function(url) {
nickjillings@1688: 		var request = new XMLHttpRequest();
nickjillings@1704: 		this.url = url;
nickjillings@1688: 		request.open('GET',url,true);
nickjillings@1688: 		request.responseType = 'arraybuffer';
nickjillings@1688: 		
nickjillings@1688: 		var audioObj = this;
nickjillings@1688: 		
nickjillings@1688: 		// Create callback to decode the data asynchronously
nickjillings@1688: 		request.onloadend = function() {
nickjillings@1688: 			audioContext.decodeAudioData(request.response, function(decodedData) {
nickjillings@1688: 				audioObj.buffer = decodedData;
nickjillings@1688: 				audioObj.state = 1;
nickjillings@1688: 			}, function(){
nickjillings@1688: 				// Should only be called if there was an error, but sometimes gets called continuously
nickjillings@1688: 				// Check here if the error is genuine
nickjillings@1688: 				if (audioObj.state == 0 || audioObj.buffer == undefined) {
nickjillings@1688: 					// Genuine error
nickjillings@1688: 					console.log('FATAL - Error loading buffer on '+audioObj.id);
nickjillings@1688: 				}
nickjillings@1688: 			});
nickjillings@1697: 		};
nickjillings@1688: 		request.send();
nickjillings@1697: 	};
nickjillings@1688: 	
nickjillings@1583: 	this.exportXMLDOM = function() {
nickjillings@1583: 		var root = document.createElement('audioElement');
nickjillings@1583: 		root.id = this.specification.id;
nickjillings@1583: 		root.setAttribute('url',this.url);
nickjillings@1583: 		root.appendChild(this.interfaceDOM.exportXMLDOM());
nickjillings@1583: 		root.appendChild(this.commentDOM.exportXMLDOM());
nickjillings@1583: 		root.appendChild(this.metric.exportXMLDOM());
nickjillings@1583: 		return root;
nickjillings@1583: 	};
nickjillings@1659: }
nickjillings@1659: 
nickjillings@1659: function timer()
nickjillings@1659: {
nickjillings@1659: 	/* Timer object used in audioEngine to keep track of session timings
nickjillings@1659: 	 * Uses the timer of the web audio API, so sample resolution
nickjillings@1659: 	 */
nickjillings@1659: 	this.testStarted = false;
nickjillings@1659: 	this.testStartTime = 0;
nickjillings@1659: 	this.testDuration = 0;
nickjillings@1659: 	this.minimumTestTime = 0; // No minimum test time
nickjillings@1659: 	this.startTest = function()
nickjillings@1659: 	{
nickjillings@1659: 		if (this.testStarted == false)
nickjillings@1659: 		{
nickjillings@1659: 			this.testStartTime = audioContext.currentTime;
nickjillings@1659: 			this.testStarted = true;
nickjillings@1659: 			this.updateTestTime();
nickjillings@1662: 			audioEngineContext.metric.initialiseTest();
nickjillings@1659: 		}
nickjillings@1659: 	};
nickjillings@1659: 	this.stopTest = function()
nickjillings@1659: 	{
nickjillings@1659: 		if (this.testStarted)
nickjillings@1659: 		{
nickjillings@1659: 			this.testDuration = this.getTestTime();
nickjillings@1659: 			this.testStarted = false;
nickjillings@1659: 		} else {
nickjillings@1659: 			console.log('ERR: Test tried to end before beginning');
nickjillings@1659: 		}
nickjillings@1659: 	};
nickjillings@1659: 	this.updateTestTime = function()
nickjillings@1659: 	{
nickjillings@1659: 		if (this.testStarted)
nickjillings@1659: 		{
nickjillings@1659: 			this.testDuration = audioContext.currentTime - this.testStartTime;
nickjillings@1659: 		}
nickjillings@1659: 	};
nickjillings@1659: 	this.getTestTime = function()
nickjillings@1659: 	{
nickjillings@1659: 		this.updateTestTime();
nickjillings@1659: 		return this.testDuration;
nickjillings@1659: 	};
nickjillings@1659: }
nickjillings@1659: 
nickjillings@1659: function sessionMetrics(engine)
nickjillings@1659: {
nickjillings@1659: 	/* Used by audioEngine to link to audioObjects to minimise the timer call timers;
nickjillings@1659: 	 */
nickjillings@1659: 	this.engine = engine;
nickjillings@1659: 	this.lastClicked = -1;
nickjillings@1659: 	this.data = -1;
nickjillings@1620: 	this.reset = function() {
nickjillings@1620: 		this.lastClicked = -1;
nickjillings@1620: 		this.data = -1;
nickjillings@1620: 	};
nickjillings@1662: 	this.initialiseTest = function(){};
nickjillings@1659: }
nickjillings@1659: 
nickjillings@1602: function metricTracker(caller)
nickjillings@1659: {
nickjillings@1659: 	/* Custom object to track and collect metric data
nickjillings@1659: 	 * Used only inside the audioObjects object.
nickjillings@1659: 	 */
nickjillings@1659: 	
nickjillings@1659: 	this.listenedTimer = 0;
nickjillings@1659: 	this.listenStart = 0;
nickjillings@1617: 	this.listenHold = false;
nickjillings@1661: 	this.initialPosition = -1;
nickjillings@1659: 	this.movementTracker = [];
nickjillings@2019: 	this.listenTracker =[];
nickjillings@1659: 	this.wasListenedTo = false;
nickjillings@1659: 	this.wasMoved = false;
nickjillings@1659: 	this.hasComments = false;
nickjillings@1602: 	this.parent = caller;
nickjillings@1659: 	
nickjillings@1659: 	this.initialised = function(position)
nickjillings@1659: 	{
nickjillings@1661: 		if (this.initialPosition == -1) {
nickjillings@1661: 			this.initialPosition = position;
nickjillings@1661: 		}
nickjillings@1659: 	};
nickjillings@1659: 	
nickjillings@1659: 	this.moved = function(time,position)
nickjillings@1659: 	{
nickjillings@1659: 		this.wasMoved = true;
nickjillings@1659: 		this.movementTracker[this.movementTracker.length] = [time, position];
nickjillings@1659: 	};
nickjillings@1659: 	
nickjillings@1637: 	this.startListening = function(time)
nickjillings@1659: 	{
nickjillings@1617: 		if (this.listenHold == false)
nickjillings@1659: 		{
nickjillings@1659: 			this.wasListenedTo = true;
nickjillings@1659: 			this.listenStart = time;
nickjillings@1617: 			this.listenHold = true;
nickjillings@2019: 			
nickjillings@2019: 			var evnt = document.createElement('event');
nickjillings@2019: 			var testTime = document.createElement('testTime');
nickjillings@2019: 			testTime.setAttribute('start',time);
nickjillings@2019: 			var bufferTime = document.createElement('bufferTime');
nickjillings@2019: 			bufferTime.setAttribute('start',this.parent.getCurrentPosition());
nickjillings@2019: 			evnt.appendChild(testTime);
nickjillings@2019: 			evnt.appendChild(bufferTime);
nickjillings@2019: 			this.listenTracker.push(evnt);
nickjillings@2019: 			
nickjillings@1602: 			console.log('slider ' + this.parent.id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1602: 		}
nickjillings@1602: 	};
nickjillings@1637: 	
nickjillings@1637: 	this.stopListening = function(time)
nickjillings@1637: 	{
nickjillings@1637: 		if (this.listenHold == true)
nickjillings@1637: 		{
nickjillings@2019: 			var diff = time - this.listenStart;
nickjillings@2019: 			this.listenedTimer += (diff);
nickjillings@1659: 			this.listenStart = 0;
nickjillings@1617: 			this.listenHold = false;
nickjillings@2019: 			
nickjillings@2019: 			var evnt = this.listenTracker[this.listenTracker.length-1];
nickjillings@2019: 			var testTime = evnt.getElementsByTagName('testTime')[0];
nickjillings@2019: 			var bufferTime = evnt.getElementsByTagName('bufferTime')[0];
nickjillings@2019: 			testTime.setAttribute('stop',time);
nickjillings@2019: 			bufferTime.setAttribute('stop',this.parent.getCurrentPosition());
nickjillings@2019: 			console.log('slider ' + this.parent.id + ' played for (' + diff + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1659: 		}
nickjillings@1659: 	};
nickjillings@1577: 	
nickjillings@1577: 	this.exportXMLDOM = function() {
nickjillings@1577: 		var root = document.createElement('metric');
nickjillings@1577: 		if (audioEngineContext.metric.enableElementTimer) {
nickjillings@1577: 			var mElementTimer = document.createElement('metricresult');
nickjillings@1577: 			mElementTimer.setAttribute('name','enableElementTimer');
nickjillings@1577: 			mElementTimer.textContent = this.listenedTimer;
nickjillings@1577: 			root.appendChild(mElementTimer);
nickjillings@1577: 		}
nickjillings@1577: 		if (audioEngineContext.metric.enableElementTracker) {
nickjillings@1577: 			var elementTrackerFull = document.createElement('metricResult');
nickjillings@1577: 			elementTrackerFull.setAttribute('name','elementTrackerFull');
nickjillings@1577: 			for (var k=0; k<this.movementTracker.length; k++)
nickjillings@1577: 			{
nickjillings@1577: 				var timePos = document.createElement('timePos');
nickjillings@1577: 				timePos.id = k;
nickjillings@1577: 				var time = document.createElement('time');
nickjillings@1577: 				time.textContent = this.movementTracker[k][0];
nickjillings@1577: 				var position = document.createElement('position');
nickjillings@1577: 				position.textContent = this.movementTracker[k][1];
nickjillings@1577: 				timePos.appendChild(time);
nickjillings@1577: 				timePos.appendChild(position);
nickjillings@1577: 				elementTrackerFull.appendChild(timePos);
nickjillings@1577: 			}
nickjillings@1577: 			root.appendChild(elementTrackerFull);
nickjillings@1577: 		}
nickjillings@1577: 		if (audioEngineContext.metric.enableElementListenTracker) {
nickjillings@1577: 			var elementListenTracker = document.createElement('metricResult');
nickjillings@1577: 			elementListenTracker.setAttribute('name','elementListenTracker');
nickjillings@1577: 			for (var k=0; k<this.listenTracker.length; k++) {
nickjillings@1577: 				elementListenTracker.appendChild(this.listenTracker[k]);
nickjillings@1577: 			}
nickjillings@1577: 			root.appendChild(elementListenTracker);
nickjillings@1577: 		}
nickjillings@1577: 		if (audioEngineContext.metric.enableElementInitialPosition) {
nickjillings@1577: 			var elementInitial = document.createElement('metricResult');
nickjillings@1577: 			elementInitial.setAttribute('name','elementInitialPosition');
nickjillings@1577: 			elementInitial.textContent = this.initialPosition;
nickjillings@1577: 			root.appendChild(elementInitial);
nickjillings@1577: 		}
nickjillings@1577: 		if (audioEngineContext.metric.enableFlagListenedTo) {
nickjillings@1577: 			var flagListenedTo = document.createElement('metricResult');
nickjillings@1577: 			flagListenedTo.setAttribute('name','elementFlagListenedTo');
nickjillings@1577: 			flagListenedTo.textContent = this.wasListenedTo;
nickjillings@1577: 			root.appendChild(flagListenedTo);
nickjillings@1577: 		}
nickjillings@1577: 		if (audioEngineContext.metric.enableFlagMoved) {
nickjillings@1577: 			var flagMoved = document.createElement('metricResult');
nickjillings@1577: 			flagMoved.setAttribute('name','elementFlagMoved');
nickjillings@1577: 			flagMoved.textContent = this.wasMoved;
nickjillings@1577: 			root.appendChild(flagMoved);
nickjillings@1577: 		}
nickjillings@1577: 		if (audioEngineContext.metric.enableFlagComments) {
nickjillings@1577: 			var flagComments = document.createElement('metricResult');
nickjillings@1577: 			flagComments.setAttribute('name','elementFlagComments');
nickjillings@1577: 			if (this.parent.commentDOM == null)
nickjillings@1577: 				{flag.textContent = 'false';}
nickjillings@1577: 			else if (this.parent.commentDOM.textContent.length == 0) 
nickjillings@1577: 				{flag.textContent = 'false';}
nickjillings@1577: 			else 
nickjillings@1577: 				{flag.textContet = 'true';}
nickjillings@1577: 			root.appendChild(flagComments);
nickjillings@1577: 		}
nickjillings@1577: 		
nickjillings@1577: 		return root;
nickjillings@1577: 	};
nickjillings@1664: }
nickjillings@1664: 
nickjillings@1664: function randomiseOrder(input)
nickjillings@1664: {
nickjillings@1664: 	// This takes an array of information and randomises the order
nickjillings@1664: 	var N = input.length;
nickjillings@1664: 	var K = N;
nickjillings@1664: 	var holdArr = [];
nickjillings@1664: 	for (var n=0; n<N; n++)
nickjillings@1664: 	{
nickjillings@1664: 		// First pick a random number
nickjillings@1664: 		var r = Math.random();
nickjillings@1664: 		// Multiply and floor by the number of elements left
nickjillings@1664: 		r = Math.floor(r*input.length);
nickjillings@1664: 		// Pick out that element and delete from the array
nickjillings@1664: 		holdArr.push(input.splice(r,1)[0]);
nickjillings@1664: 	}
nickjillings@1664: 	return holdArr;
nickjillings@1631: }
nickjillings@1631: 
nickjillings@1631: function returnDateNode()
nickjillings@1631: {
nickjillings@1631: 	// Create an XML Node for the Date and Time a test was conducted
nickjillings@1631: 	// Structure is
nickjillings@1631: 	// <datetime> 
nickjillings@1631: 	//	<date year="##" month="##" day="##">DD/MM/YY</date>
nickjillings@1631: 	//	<time hour="##" minute="##" sec="##">HH:MM:SS</time>
nickjillings@1631: 	// </datetime>
nickjillings@1631: 	var dateTime = new Date();
nickjillings@1631: 	var year = document.createAttribute('year');
nickjillings@1631: 	var month = document.createAttribute('month');
nickjillings@1631: 	var day = document.createAttribute('day');
nickjillings@1631: 	var hour = document.createAttribute('hour');
nickjillings@1631: 	var minute = document.createAttribute('minute');
nickjillings@1631: 	var secs = document.createAttribute('secs');
nickjillings@1631: 	
nickjillings@1631: 	year.nodeValue = dateTime.getFullYear();
nickjillings@1631: 	month.nodeValue = dateTime.getMonth()+1;
nickjillings@1631: 	day.nodeValue = dateTime.getDate();
nickjillings@1631: 	hour.nodeValue = dateTime.getHours();
nickjillings@1631: 	minute.nodeValue = dateTime.getMinutes();
nickjillings@1631: 	secs.nodeValue = dateTime.getSeconds();
nickjillings@1631: 	
nickjillings@1631: 	var hold = document.createElement("datetime");
nickjillings@1631: 	var date = document.createElement("date");
nickjillings@1631: 	date.textContent = year.nodeValue+'/'+month.nodeValue+'/'+day.nodeValue;
nickjillings@1631: 	var time = document.createElement("time");
nickjillings@1631: 	time.textContent = hour.nodeValue+':'+minute.nodeValue+':'+secs.nodeValue;
nickjillings@1631: 	
nickjillings@1631: 	date.setAttributeNode(year);
nickjillings@1631: 	date.setAttributeNode(month);
nickjillings@1631: 	date.setAttributeNode(day);
nickjillings@1631: 	time.setAttributeNode(hour);
nickjillings@1631: 	time.setAttributeNode(minute);
nickjillings@1631: 	time.setAttributeNode(secs);
nickjillings@1631: 	
nickjillings@1631: 	hold.appendChild(date);
nickjillings@1631: 	hold.appendChild(time);
nickjillings@1631: 	return hold
nickjillings@1631: 	
nickjillings@1604: }
nickjillings@1604: 
nickjillings@1604: function testWaitIndicator() {
nickjillings@2013: 	if (audioEngineContext.checkAllReady() == false) {
nickjillings@2013: 		var hold = document.createElement("div");
nickjillings@2013: 		hold.id = "testWaitIndicator";
nickjillings@2013: 		hold.className = "indicator-box";
nickjillings@1585: 		hold.style.zIndex = 3;
nickjillings@2013: 		var span = document.createElement("span");
nickjillings@2013: 		span.textContent = "Please wait! Elements still loading";
nickjillings@2013: 		hold.appendChild(span);
nickjillings@1585: 		var blank = document.createElement('div');
nickjillings@1585: 		blank.className = 'testHalt';
nickjillings@1585: 		blank.id = "testHaltBlank";
nickjillings@2013: 		var body = document.getElementsByTagName('body')[0];
nickjillings@2013: 		body.appendChild(hold);
nickjillings@1585: 		body.appendChild(blank);
nickjillings@2013: 		testWaitTimerIntervalHolder = setInterval(function(){
nickjillings@2013: 			var ready = audioEngineContext.checkAllReady();
nickjillings@2013: 			if (ready) {
nickjillings@2013: 				var elem = document.getElementById('testWaitIndicator');
nickjillings@1585: 				var blank = document.getElementById('testHaltBlank');
nickjillings@2013: 				var body = document.getElementsByTagName('body')[0];
nickjillings@2013: 				body.removeChild(elem);
nickjillings@1585: 				body.removeChild(blank);
nickjillings@2013: 				clearInterval(testWaitTimerIntervalHolder);
nickjillings@2013: 			}
nickjillings@2013: 		},500,false);
nickjillings@2013: 	}
nickjillings@1604: }
nickjillings@1604: 
nickjillings@2013: var testWaitTimerIntervalHolder = null;
nickjillings@1580: 
nickjillings@1580: function Specification() {
nickjillings@1580: 	// Handles the decoding of the project specification XML into a simple JavaScript Object.
nickjillings@1580: 	
nickjillings@1580: 	this.interfaceType;
nickjillings@1580: 	this.projectReturn;
nickjillings@1580: 	this.randomiseOrder;
nickjillings@1580: 	this.collectMetrics;
nickjillings@1580: 	this.preTest;
nickjillings@1580: 	this.postTest;
nickjillings@1580: 	this.metrics =[];
nickjillings@1580: 	
nickjillings@1580: 	this.audioHolders = [];
nickjillings@1580: 	
nickjillings@1580: 	this.decode = function() {
nickjillings@1580: 		// projectXML - DOM Parsed document
nickjillings@1580: 		var setupNode = projectXML.getElementsByTagName('setup')[0];
nickjillings@1580: 		this.interfaceType = setupNode.getAttribute('interface');
nickjillings@1580: 		this.projectReturn = setupNode.getAttribute('projectReturn');
nickjillings@1580: 		if (setupNode.getAttribute('randomiseOrder') == "true") {
nickjillings@1580: 			this.randomiseOrder = true;
nickjillings@1584: 		} else {this.randomiseOrder = false;}
nickjillings@1580: 		if (setupNode.getAttribute('collectMetrics') == "true") {
nickjillings@1580: 			this.collectMetrics = true;
nickjillings@1584: 		} else {this.collectMetrics = false;}
nickjillings@1580: 		var metricCollection = setupNode.getElementsByTagName('Metric');
nickjillings@1580: 		
nickjillings@1581: 		this.preTest = new this.prepostNode('pretest',setupNode.getElementsByTagName('PreTest'));
nickjillings@1581: 		this.postTest = new this.prepostNode('posttest',setupNode.getElementsByTagName('PostTest'));
nickjillings@1580: 		
nickjillings@1580: 		if (metricCollection.length > 0) {
nickjillings@1580: 			metricCollection = metricCollection[0].getElementsByTagName('metricEnable');
nickjillings@1580: 			for (var i=0; i<metricCollection.length; i++) {
nickjillings@1581: 				this.metrics.push(new this.metricNode(metricCollection[i].textContent));
nickjillings@1580: 			}
nickjillings@1580: 		}
nickjillings@1580: 		
nickjillings@1580: 		var audioHolders = projectXML.getElementsByTagName('audioHolder');
nickjillings@1580: 		for (var i=0; i<audioHolders.length; i++) {
nickjillings@1580: 			this.audioHolders.push(new this.audioHolderNode(this,audioHolders[i]));
nickjillings@1580: 		}
nickjillings@1580: 		
nickjillings@1580: 	};
nickjillings@1580: 	
nickjillings@1580: 	this.prepostNode = function(type,Collection) {
nickjillings@1580: 		this.type = type;
nickjillings@1580: 		this.options = [];
nickjillings@1580: 		
nickjillings@1580: 		this.OptionNode = function(child) {
nickjillings@1588: 			
nickjillings@1588: 			this.childOption = function(element) {
nickjillings@1588: 				this.type = 'option';
nickjillings@1588: 				this.id = element.id;
nickjillings@1589: 				this.name = element.getAttribute('name');
nickjillings@1588: 				this.text = element.textContent;
nickjillings@2030: 			};
nickjillings@1588: 			
nickjillings@1580: 			this.type = child.nodeName;
nickjillings@1580: 			if (child.nodeName == "question") {
nickjillings@1580: 				this.id = child.id;
nickjillings@1580: 				this.mandatory;
nickjillings@1580: 				if (child.getAttribute('mandatory') == "true") {this.mandatory = true;}
nickjillings@1580: 				else {this.mandatory = false;}
nickjillings@1580: 				this.question = child.textContent;
nickjillings@2030: 				if (child.getAttribute('boxsize') == null) {
nickjillings@2030: 					this.boxsize = 'normal';
nickjillings@2030: 				} else {
nickjillings@2030: 					this.boxsize = child.getAttribute('boxsize');
nickjillings@2030: 				}
nickjillings@1580: 			} else if (child.nodeName == "statement") {
nickjillings@1581: 				this.statement = child.textContent;
nickjillings@1589: 			} else if (child.nodeName == "checkbox" || child.nodeName == "radio") {
nickjillings@1588: 				var element = child.firstElementChild;
nickjillings@1589: 				this.id = child.id;
nickjillings@1588: 				if (element == null) {
nickjillings@1589: 					console.log('Malformed' +child.nodeName+ 'entry');
nickjillings@1589: 					this.statement = 'Malformed' +child.nodeName+ 'entry';
nickjillings@1588: 					this.type = 'statement';
nickjillings@1588: 				} else {
nickjillings@1588: 					this.options = [];
nickjillings@1588: 					while (element != null) {
nickjillings@1588: 						if (element.nodeName == 'statement' && this.statement == undefined){
nickjillings@1588: 							this.statement = element.textContent;
nickjillings@1588: 						} else if (element.nodeName == 'option') {
nickjillings@1588: 							this.options.push(new this.childOption(element));
nickjillings@1588: 						}
nickjillings@1588: 						element = element.nextElementSibling;
nickjillings@1588: 					}
nickjillings@1588: 				}
nickjillings@1580: 			}
nickjillings@1580: 		};
nickjillings@1580: 		
nickjillings@1580: 		// On construction:
nickjillings@1580: 		if (Collection.length != 0) {
nickjillings@1580: 			Collection = Collection[0];
nickjillings@1586: 			if (Collection.childElementCount != 0) {
nickjillings@1586: 				var child = Collection.firstElementChild;
nickjillings@1580: 				this.options.push(new this.OptionNode(child));
nickjillings@1586: 				while (child.nextElementSibling != null) {
nickjillings@1586: 					child = child.nextElementSibling;
nickjillings@1586: 					this.options.push(new this.OptionNode(child));
nickjillings@1586: 				}
nickjillings@1580: 			}
nickjillings@1580: 		}
nickjillings@1580: 	};
nickjillings@1580: 	
nickjillings@1580: 	this.metricNode = function(name) {
nickjillings@1580: 		this.enabled = name;
nickjillings@1580: 	};
nickjillings@1580: 	
nickjillings@1580: 	this.audioHolderNode = function(parent,xml) {
nickjillings@1581: 		this.type = 'audioHolder';
nickjillings@1580: 		this.interfaceNode = function(DOM) {
nickjillings@1580: 			var title = DOM.getElementsByTagName('title');
nickjillings@1580: 			if (title.length == 0) {this.title = null;}
nickjillings@1580: 			else {this.title = title[0].textContent;}
nickjillings@1580: 			
nickjillings@1580: 			var scale = DOM.getElementsByTagName('scale');
nickjillings@1580: 			this.scale = [];
nickjillings@1580: 			for (var i=0; i<scale.length; i++) {
nickjillings@1580: 				var arr = [null, null];
nickjillings@1580: 				arr[0] = scale[i].getAttribute('position');
nickjillings@1580: 				arr[1] = scale[i].textContent;
nickjillings@1580: 				this.scale.push(arr);
nickjillings@1580: 			}
nickjillings@1580: 		};
nickjillings@1580: 		
nickjillings@1582: 		this.audioElementNode = function(parent,xml) {
nickjillings@1580: 			this.url = xml.getAttribute('url');
nickjillings@1580: 			this.id = xml.id;
nickjillings@1582: 			this.parent = parent;
nickjillings@1580: 		};
nickjillings@1580: 		
nickjillings@1580: 		this.commentQuestionNode = function(xml) {
nickjillings@1580: 			this.id = xml.id;
nickjillings@1580: 			if (xml.getAttribute('mandatory') == 'true') {this.mandatory = true;}
nickjillings@1580: 			else {this.mandatory = false;}
nickjillings@1580: 			this.question = xml.textContent;
nickjillings@1580: 		};
nickjillings@1580: 		
nickjillings@1580: 		this.id = xml.id;
nickjillings@1580: 		this.hostURL = xml.getAttribute('hostURL');
nickjillings@1580: 		this.sampleRate = xml.getAttribute('sampleRate');
nickjillings@1580: 		if (xml.getAttribute('randomiseOrder') == "true") {this.randomiseOrder = true;}
nickjillings@1580: 		else {this.randomiseOrder = false;}
nickjillings@1580: 		this.repeatCount = xml.getAttribute('repeatCount');
nickjillings@1580: 		if (xml.getAttribute('loop') == 'true') {this.loop = true;}
nickjillings@1580: 		else {this.loop == false;}
nickjillings@1580: 		if (xml.getAttribute('elementComments') == "true") {this.elementComments = true;}
nickjillings@1580: 		else {this.elementComments = false;}
nickjillings@1580: 		
nickjillings@1581: 		this.preTest = new parent.prepostNode('pretest',xml.getElementsByTagName('PreTest'));
nickjillings@1581: 		this.postTest = new parent.prepostNode('posttest',xml.getElementsByTagName('PostTest'));
nickjillings@1580: 		
nickjillings@1580: 		this.interfaces = [];
nickjillings@1580: 		var interfaceDOM = xml.getElementsByTagName('interface');
nickjillings@1580: 		for (var i=0; i<interfaceDOM.length; i++) {
nickjillings@1580: 			this.interfaces.push(new this.interfaceNode(interfaceDOM[i]));
nickjillings@1580: 		}
nickjillings@1580: 		
nickjillings@1580: 		this.commentBoxPrefix = xml.getElementsByTagName('commentBoxPrefix');
nickjillings@1580: 		if (this.commentBoxPrefix.length != 0) {
nickjillings@1580: 			this.commentBoxPrefix = this.commentBoxPrefix[0].textContent;
nickjillings@1580: 		} else {
nickjillings@1580: 			this.commentBoxPrefix = "Comment on track";
nickjillings@1580: 		}
nickjillings@1580: 		
nickjillings@1580: 		this.audioElements  =[];
nickjillings@1580: 		var audioElementsDOM = xml.getElementsByTagName('audioElements');
nickjillings@1580: 		for (var i=0; i<audioElementsDOM.length; i++) {
nickjillings@1582: 			this.audioElements.push(new this.audioElementNode(this,audioElementsDOM[i]));
nickjillings@1580: 		}
nickjillings@1580: 		
nickjillings@1580: 		this.commentQuestions = [];
nickjillings@1580: 		var commentQuestionsDOM = xml.getElementsByTagName('CommentQuestion');
nickjillings@1580: 		for (var i=0; i<commentQuestionsDOM.length; i++) {
nickjillings@1580: 			this.commentQuestions.push(new this.commentQuestionNode(commentQuestionsDOM[i]));
nickjillings@1580: 		}
nickjillings@1580: 	};
nickjillings@1580: }
nickjillings@1580: 
nickjillings@1582: function Interface(specificationObject) {
nickjillings@1580: 	// This handles the bindings between the interface and the audioEngineContext;
nickjillings@1582: 	this.specification = specificationObject;
nickjillings@1582: 	this.insertPoint = document.getElementById("topLevelBody");
nickjillings@1580: 	
nickjillings@1582: 	// Bounded by interface!!
nickjillings@1582: 	// Interface object MUST have an exportXMLDOM method which returns the various DOM levels
nickjillings@1582: 	// For example, APE returns  the slider position normalised in a <value> tag.
nickjillings@1582: 	this.interfaceObjects = [];
nickjillings@1582: 	this.interfaceObject = function(){};
nickjillings@1582: 	
nickjillings@1582: 	this.commentBoxes = [];
nickjillings@1582: 	this.commentBox = function(audioObject) {
nickjillings@1582: 		var element = audioObject.specification;
nickjillings@1583: 		this.audioObject = audioObject;
nickjillings@1582: 		this.id = audioObject.id;
nickjillings@1582: 		var audioHolderObject = audioObject.specification.parent;
nickjillings@1582: 		// Create document objects to hold the comment boxes
nickjillings@1582: 		this.trackComment = document.createElement('div');
nickjillings@1582: 		this.trackComment.className = 'comment-div';
nickjillings@1582: 		this.trackComment.id = 'comment-div-'+audioObject.id;
nickjillings@1582: 		// Create a string next to each comment asking for a comment
nickjillings@1583: 		this.trackString = document.createElement('span');
nickjillings@1583: 		this.trackString.innerHTML = audioHolderObject.commentBoxPrefix+' '+audioObject.id;
nickjillings@1582: 		// Create the HTML5 comment box 'textarea'
nickjillings@1583: 		this.trackCommentBox = document.createElement('textarea');
nickjillings@1583: 		this.trackCommentBox.rows = '4';
nickjillings@1583: 		this.trackCommentBox.cols = '100';
nickjillings@1583: 		this.trackCommentBox.name = 'trackComment'+audioObject.id;
nickjillings@1583: 		this.trackCommentBox.className = 'trackComment';
nickjillings@1582: 		var br = document.createElement('br');
nickjillings@1582: 		// Add to the holder.
nickjillings@1583: 		this.trackComment.appendChild(this.trackString);
nickjillings@1582: 		this.trackComment.appendChild(br);
nickjillings@1583: 		this.trackComment.appendChild(this.trackCommentBox);
nickjillings@1583: 		
nickjillings@1583: 		this.exportXMLDOM = function() {
nickjillings@1583: 			var root = document.createElement('comment');
nickjillings@1583: 			if (this.audioObject.specification.parent.elementComments) {
nickjillings@1583: 				var question = document.createElement('question');
nickjillings@1583: 				question.textContent = this.trackString.textContent;
nickjillings@1583: 				var response = document.createElement('response');
nickjillings@1583: 				response.textContent = this.trackCommentBox.value;
nickjillings@1583: 				root.appendChild(question);
nickjillings@1583: 				root.appendChild(response);
nickjillings@1583: 			}
nickjillings@1583: 			return root;
nickjillings@1583: 		};
nickjillings@1582: 	};
nickjillings@1582: 	
nickjillings@1582: 	this.createCommentBox = function(audioObject) {
nickjillings@1582: 		var node = new this.commentBox(audioObject);
nickjillings@1582: 		this.commentBoxes.push(node);
nickjillings@1582: 		audioObject.commentDOM = node;
nickjillings@1582: 		return node;
nickjillings@1582: 	};
nickjillings@1582: 	
nickjillings@1582: 	this.sortCommentBoxes = function() {
nickjillings@1582: 		var holder = [];
nickjillings@1582: 		while (this.commentBoxes.length > 0) {
nickjillings@1582: 			var node = this.commentBoxes.pop(0);
nickjillings@1582: 			holder[node.id] = node;
nickjillings@1582: 		}
nickjillings@1582: 		this.commentBoxes = holder;
nickjillings@1582: 	};
nickjillings@1582: 	
nickjillings@1582: 	this.showCommentBoxes = function(inject, sort) {
nickjillings@1582: 		if (sort) {interfaceContext.sortCommentBoxes();}
nickjillings@1582: 		for (var i=0; i<interfaceContext.commentBoxes.length; i++) {
nickjillings@1582: 			inject.appendChild(this.commentBoxes[i].trackComment);
nickjillings@1582: 		}
nickjillings@1582: 	};
nickjillings@1580: }
nickjillings@1580: