nicholas@2224: /**
nicholas@2224:  * core.js
nicholas@2224:  * 
nicholas@2224:  * Main script to run, calls all other core functions and manages loading/store to backend.
nicholas@2224:  * Also contains all global variables.
nicholas@2224:  */
nicholas@2224: 
nicholas@2224: /* create the web audio API context and store in audioContext*/
nicholas@2224: var audioContext; // Hold the browser web audio API
nicholas@2224: var projectXML; // Hold the parsed setup XML
nicholas@2224: var schemaXSD; // Hold the parsed schema XSD
nicholas@2224: var specification;
nicholas@2224: var interfaceContext;
nicholas@2224: var storage;
nicholas@2224: var popup; // Hold the interfacePopup object
nicholas@2224: var testState;
nicholas@2224: var currentTrackOrder = []; // Hold the current XML tracks in their (randomised) order
nicholas@2224: var audioEngineContext; // The custome AudioEngine object
nicholas@2224: var projectReturn; // Hold the URL for the return
nicholas@2224: 
nicholas@2224: 
nicholas@2224: // Add a prototype to the bufferSourceNode to reference to the audioObject holding it
nicholas@2224: AudioBufferSourceNode.prototype.owner = undefined;
nicholas@2224: // Add a prototype to the bufferSourceNode to hold when the object was given a play command
nicholas@2224: AudioBufferSourceNode.prototype.playbackStartTime = undefined;
nicholas@2224: // Add a prototype to the bufferNode to hold the desired LINEAR gain
nicholas@2224: AudioBuffer.prototype.playbackGain = undefined;
nicholas@2224: // Add a prototype to the bufferNode to hold the computed LUFS loudness
nicholas@2224: AudioBuffer.prototype.lufs = undefined;
nicholas@2224: 
nicholas@2224: // Convert relative URLs into absolutes
nicholas@2224: function escapeHTML(s) {
nicholas@2224:     return s.split('&').join('&amp;').split('<').join('&lt;').split('"').join('&quot;');
nicholas@2224: }
nicholas@2224: function qualifyURL(url) {
nicholas@2224:     var el= document.createElement('div');
nicholas@2224:     el.innerHTML= '<a href="'+escapeHTML(url)+'">x</a>';
nicholas@2224:     return el.firstChild.href;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: // Firefox does not have an XMLDocument.prototype.getElementsByName
nicholas@2224: // and there is no searchAll style command, this custom function will
nicholas@2224: // search all children recusrively for the name. Used for XSD where all
nicholas@2224: // element nodes must have a name and therefore can pull the schema node
nicholas@2224: XMLDocument.prototype.getAllElementsByName = function(name)
nicholas@2224: {
nicholas@2224:     name = String(name);
nicholas@2224:     var selected = this.documentElement.getAllElementsByName(name);
nicholas@2224:     return selected;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: Element.prototype.getAllElementsByName = function(name)
nicholas@2224: {
nicholas@2224:     name = String(name);
nicholas@2224:     var selected = [];
nicholas@2224:     var node = this.firstElementChild;
nicholas@2224:     while(node != null)
nicholas@2224:     {
nicholas@2224:         if (node.getAttribute('name') == name)
nicholas@2224:         {
nicholas@2224:             selected.push(node);
nicholas@2224:         }
nicholas@2224:         if (node.childElementCount > 0)
nicholas@2224:         {
nicholas@2224:             selected = selected.concat(node.getAllElementsByName(name));
nicholas@2224:         }
nicholas@2224:         node = node.nextElementSibling;
nicholas@2224:     }
nicholas@2224:     return selected;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: XMLDocument.prototype.getAllElementsByTagName = function(name)
nicholas@2224: {
nicholas@2224:     name = String(name);
nicholas@2224:     var selected = this.documentElement.getAllElementsByTagName(name);
nicholas@2224:     return selected;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: Element.prototype.getAllElementsByTagName = function(name)
nicholas@2224: {
nicholas@2224:     name = String(name);
nicholas@2224:     var selected = [];
nicholas@2224:     var node = this.firstElementChild;
nicholas@2224:     while(node != null)
nicholas@2224:     {
nicholas@2224:         if (node.nodeName == name)
nicholas@2224:         {
nicholas@2224:             selected.push(node);
nicholas@2224:         }
nicholas@2224:         if (node.childElementCount > 0)
nicholas@2224:         {
nicholas@2224:             selected = selected.concat(node.getAllElementsByTagName(name));
nicholas@2224:         }
nicholas@2224:         node = node.nextElementSibling;
nicholas@2224:     }
nicholas@2224:     return selected;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: // Firefox does not have an XMLDocument.prototype.getElementsByName
nicholas@2224: if (typeof XMLDocument.prototype.getElementsByName != "function") {
nicholas@2224:     XMLDocument.prototype.getElementsByName = function(name)
nicholas@2224:     {
nicholas@2224:         name = String(name);
nicholas@2224:         var node = this.documentElement.firstElementChild;
nicholas@2224:         var selected = [];
nicholas@2224:         while(node != null)
nicholas@2224:         {
nicholas@2224:             if (node.getAttribute('name') == name)
nicholas@2224:             {
nicholas@2224:                 selected.push(node);
nicholas@2224:             }
nicholas@2224:             node = node.nextElementSibling;
nicholas@2224:         }
nicholas@2224:         return selected;
nicholas@2224:     }
nicholas@2224: }
nicholas@2224: 
nicholas@2224: window.onload = function() {
nicholas@2224: 	// Function called once the browser has loaded all files.
nicholas@2224: 	// This should perform any initial commands such as structure / loading documents
nicholas@2224: 	
nicholas@2224: 	// Create a web audio API context
nicholas@2224: 	// Fixed for cross-browser support
nicholas@2224: 	var AudioContext = window.AudioContext || window.webkitAudioContext;
nicholas@2224: 	audioContext = new AudioContext;
nicholas@2224: 	
nicholas@2224: 	// Create test state
nicholas@2224: 	testState = new stateMachine();
nicholas@2224: 	
nicholas@2224: 	// Create the popup interface object
nicholas@2224: 	popup = new interfacePopup();
nicholas@2224:     
nicholas@2224:     // Create the specification object
nicholas@2224: 	specification = new Specification();
nicholas@2224: 	
nicholas@2224: 	// Create the interface object
nicholas@2224: 	interfaceContext = new Interface(specification);
nicholas@2224: 	
nicholas@2224: 	// Create the storage object
nicholas@2224: 	storage = new Storage();
nicholas@2224: 	// Define window callbacks for interface
nicholas@2224: 	window.onresize = function(event){interfaceContext.resizeWindow(event);};
nicholas@2224: };
nicholas@2224: 
nicholas@2224: function loadProjectSpec(url) {
nicholas@2224: 	// Load the project document from the given URL, decode the XML and instruct audioEngine to get audio data
nicholas@2224: 	// If url is null, request client to upload project XML document
nicholas@2224: 	var xmlhttp = new XMLHttpRequest();
nicholas@2224: 	xmlhttp.open("GET",'xml/test-schema.xsd',true);
nicholas@2224: 	xmlhttp.onload = function()
nicholas@2224: 	{
nicholas@2224: 		schemaXSD = xmlhttp.response;
nicholas@2224: 		var parse = new DOMParser();
nicholas@2224: 		specification.schema = parse.parseFromString(xmlhttp.response,'text/xml');
nicholas@2224: 		var r = new XMLHttpRequest();
nicholas@2224: 		r.open('GET',url,true);
nicholas@2224: 		r.onload = function() {
nicholas@2224: 			loadProjectSpecCallback(r.response);
nicholas@2224: 		};
nicholas@2224:         r.onerror = function() {
nicholas@2224:             document.getElementsByTagName('body')[0].innerHTML = null;
nicholas@2224:             var msg = document.createElement("h3");
nicholas@2224:             msg.textContent = "FATAL ERROR";
nicholas@2224:             var span = document.createElement("p");
nicholas@2224:             span.textContent = "There was an error when loading your XML file. Please check your path in the URL. After the path to this page, there should be '?url=path/to/your/file.xml'. Check the spelling of your filename as well. If you are still having issues, check the log of the python server or your webserver distribution for 404 codes for your file.";
nicholas@2224:             document.getElementsByTagName('body')[0].appendChild(msg);
nicholas@2224:             document.getElementsByTagName('body')[0].appendChild(span);
nicholas@2224:         }
nicholas@2224: 		r.send();
nicholas@2224: 	};
nicholas@2224: 	xmlhttp.send();
nicholas@2224: };
nicholas@2224: 
nicholas@2224: function loadProjectSpecCallback(response) {
nicholas@2224: 	// Function called after asynchronous download of XML project specification
nicholas@2224: 	//var decode = $.parseXML(response);
nicholas@2224: 	//projectXML = $(decode);
nicholas@2224: 	
nicholas@2224:     // Check if XML is new or a resumption
nicholas@2224:     var parse = new DOMParser();
nicholas@2224: 	var responseDocument = parse.parseFromString(response,'text/xml');
nicholas@2224:     var errorNode = responseDocument.getElementsByTagName('parsererror');
nicholas@2224: 	if (errorNode.length >= 1)
nicholas@2224: 	{
nicholas@2224: 		var msg = document.createElement("h3");
nicholas@2224: 		msg.textContent = "FATAL ERROR";
nicholas@2224: 		var span = document.createElement("span");
nicholas@2224: 		span.textContent = "The XML parser returned the following errors when decoding your XML file";
nicholas@2224: 		document.getElementsByTagName('body')[0].innerHTML = null;
nicholas@2224: 		document.getElementsByTagName('body')[0].appendChild(msg);
nicholas@2224: 		document.getElementsByTagName('body')[0].appendChild(span);
nicholas@2224: 		document.getElementsByTagName('body')[0].appendChild(errorNode[0]);
nicholas@2224: 		return;
nicholas@2224: 	}
nicholas@2247:     if (responseDocument == undefined || responseDocument.firstChild == undefined) {
nicholas@2224:         var msg = document.createElement("h3");
nicholas@2224: 		msg.textContent = "FATAL ERROR";
nicholas@2224: 		var span = document.createElement("span");
nicholas@2224: 		span.textContent = "The project XML was not decoded properly, try refreshing your browser and clearing caches. If the problem persists, contact the test creator.";
nicholas@2224: 		document.getElementsByTagName('body')[0].innerHTML = null;
nicholas@2224: 		document.getElementsByTagName('body')[0].appendChild(msg);
nicholas@2224: 		document.getElementsByTagName('body')[0].appendChild(span);
nicholas@2224: 		return;
nicholas@2224:     }
nicholas@2247:     if (responseDocument.firstChild.nodeName == "waet") {
nicholas@2224:         // document is a specification
nicholas@2224:         
nicholas@2224:         // Perform XML schema validation
nicholas@2224:         var Module = {
nicholas@2224:             xml: response,
nicholas@2224:             schema: schemaXSD,
nicholas@2224:             arguments:["--noout", "--schema", 'test-schema.xsd','document.xml']
nicholas@2224:         };
nicholas@2224:             projectXML = responseDocument;
nicholas@2224:         var xmllint = validateXML(Module);
nicholas@2224:         console.log(xmllint);
nicholas@2224:         if(xmllint != 'document.xml validates\n')
nicholas@2224:         {
nicholas@2224:             document.getElementsByTagName('body')[0].innerHTML = null;
nicholas@2224:             var msg = document.createElement("h3");
nicholas@2224:             msg.textContent = "FATAL ERROR";
nicholas@2224:             var span = document.createElement("h4");
nicholas@2224:             span.textContent = "The XML validator returned the following errors when decoding your XML file";
nicholas@2224:             document.getElementsByTagName('body')[0].appendChild(msg);
nicholas@2224:             document.getElementsByTagName('body')[0].appendChild(span);
nicholas@2224:             xmllint = xmllint.split('\n');
nicholas@2224:             for (var i in xmllint)
nicholas@2224:             {
nicholas@2224:                 document.getElementsByTagName('body')[0].appendChild(document.createElement('br'));
nicholas@2224:                 var span = document.createElement("span");
nicholas@2224:                 span.textContent = xmllint[i];
nicholas@2224:                 document.getElementsByTagName('body')[0].appendChild(span);
nicholas@2224:             }
nicholas@2224:             return;
nicholas@2224:         }
nicholas@2224:         // Build the specification
nicholas@2224: 	   specification.decode(projectXML);
nicholas@2224:         // Generate the session-key
nicholas@2224:         storage.initialise();
nicholas@2224:         
nicholas@2247:     } else if (responseDocument.firstChild.nodeName == "waetresult") {
nicholas@2224:         // document is a result
nicholas@2224:         projectXML = document.implementation.createDocument(null,"waet");
nicholas@2224:         projectXML.children[0].appendChild(responseDocument.getElementsByTagName('waet')[0].getElementsByTagName("setup")[0].cloneNode(true));
nicholas@2224:         var child = responseDocument.children[0].children[0];
nicholas@2224:         while (child != null) {
nicholas@2224:             if (child.nodeName == "survey") {
nicholas@2224:                 // One of the global survey elements
nicholas@2224:                 if (child.getAttribute("state") == "complete") {
nicholas@2224:                     // We need to remove this survey from <setup>
nicholas@2224:                     var location = child.getAttribute("location");
nicholas@2224:                     var globalSurveys = projectXML.getElementsByTagName("setup")[0].getElementsByTagName("survey")[0];
nicholas@2224:                     while(globalSurveys != null) {
nicholas@2224:                         if (location == "pre" || location == "before") {
nicholas@2224:                             if (globalSurveys.getAttribute("location") == "pre" || globalSurveys.getAttribute("location") == "before") {
nicholas@2224:                                 projectXML.getElementsByTagName("setup")[0].removeChild(globalSurveys);
nicholas@2224:                                 break;
nicholas@2224:                             }
nicholas@2224:                         } else {
nicholas@2224:                             if (globalSurveys.getAttribute("location") == "post" || globalSurveys.getAttribute("location") == "after") {
nicholas@2224:                                 projectXML.getElementsByTagName("setup")[0].removeChild(globalSurveys);
nicholas@2224:                                 break;
nicholas@2224:                             }
nicholas@2224:                         }
nicholas@2224:                         globalSurveys = globalSurveys.nextElementSibling;
nicholas@2224:                     }
nicholas@2224:                 } else {
nicholas@2224:                     // We need to complete this, so it must be regenerated by store
nicholas@2224:                     var copy = child;
nicholas@2224:                     child = child.previousElementSibling;
nicholas@2224:                     responseDocument.children[0].removeChild(copy);
nicholas@2224:                 }
nicholas@2224:             } else if (child.nodeName == "page") {
nicholas@2224:                 if (child.getAttribute("state") == "empty") {
nicholas@2224:                     // We need to complete this page
nicholas@2224:                     projectXML.children[0].appendChild(responseDocument.getElementById(child.getAttribute("ref")).cloneNode(true));
nicholas@2224:                     var copy = child;
nicholas@2224:                     child = child.previousElementSibling;
nicholas@2224:                     responseDocument.children[0].removeChild(copy);
nicholas@2224:                 }
nicholas@2224:             }
nicholas@2224:             child = child.nextElementSibling;
nicholas@2224:         }
nicholas@2224:         // Build the specification
nicholas@2224: 	    specification.decode(projectXML);
nicholas@2224:         // Use the original
nicholas@2224:         storage.initialise(responseDocument);
nicholas@2224:     }
nicholas@2224: 	/// CHECK FOR SAMPLE RATE COMPATIBILITY
nicholas@2224: 	if (specification.sampleRate != undefined) {
nicholas@2224: 		if (Number(specification.sampleRate) != audioContext.sampleRate) {
nicholas@2224: 			var errStr = 'Sample rates do not match! Requested '+Number(specification.sampleRate)+', got '+audioContext.sampleRate+'. Please set the sample rate to match before completing this test.';
nicholas@2224: 			alert(errStr);
nicholas@2224: 			return;
nicholas@2224: 		}
nicholas@2224: 	}
nicholas@2224: 	
nicholas@2224: 	// Detect the interface to use and load the relevant javascripts.
nicholas@2224: 	var interfaceJS = document.createElement('script');
nicholas@2224: 	interfaceJS.setAttribute("type","text/javascript");
nicholas@2224: 	switch(specification.interface)
nicholas@2224: 	{
nicholas@2224: 		case "APE":
nicholas@2224:             interfaceJS.setAttribute("src","interfaces/ape.js");
nicholas@2224: 
nicholas@2224:             // APE comes with a css file
nicholas@2224:             var css = document.createElement('link');
nicholas@2224:             css.rel = 'stylesheet';
nicholas@2224:             css.type = 'text/css';
nicholas@2224:             css.href = 'interfaces/ape.css';
nicholas@2224: 
nicholas@2224:             document.getElementsByTagName("head")[0].appendChild(css);
nicholas@2224:             break;
nicholas@2224: 
nicholas@2224: 		case "MUSHRA":
nicholas@2224:             interfaceJS.setAttribute("src","interfaces/mushra.js");
nicholas@2224: 
nicholas@2224:             // MUSHRA comes with a css file
nicholas@2224:             var css = document.createElement('link');
nicholas@2224:             css.rel = 'stylesheet';
nicholas@2224:             css.type = 'text/css';
nicholas@2224:             css.href = 'interfaces/mushra.css';
nicholas@2224: 
nicholas@2224:             document.getElementsByTagName("head")[0].appendChild(css);
nicholas@2224:             break;
nicholas@2224: 		
nicholas@2224: 		case "AB":
nicholas@2224:             interfaceJS.setAttribute("src","interfaces/AB.js");
nicholas@2224: 
nicholas@2224:             // AB comes with a css file
nicholas@2224:             var css = document.createElement('link');
nicholas@2224:             css.rel = 'stylesheet';
nicholas@2224:             css.type = 'text/css';
nicholas@2224:             css.href = 'interfaces/AB.css';
nicholas@2224: 
nicholas@2224:             document.getElementsByTagName("head")[0].appendChild(css);
nicholas@2224:             break;
nicholas@2224:             
nicholas@2224:         case "ABX":
nicholas@2224:             interfaceJS.setAttribute("src","interfaces/ABX.js");
nicholas@2224: 
nicholas@2224:             // AB comes with a css file
nicholas@2224:             var css = document.createElement('link');
nicholas@2224:             css.rel = 'stylesheet';
nicholas@2224:             css.type = 'text/css';
nicholas@2224:             css.href = 'interfaces/ABX.css';
nicholas@2224: 
nicholas@2224:             document.getElementsByTagName("head")[0].appendChild(css);
nicholas@2224:             break;
nicholas@2224:         
nicholas@2224: 		case "Bipolar":
nicholas@2224: 		case "ACR":
nicholas@2224: 		case "DCR":
nicholas@2224: 		case "CCR":
nicholas@2224: 		case "ABC":
nicholas@2224:             // Above enumerate to horizontal sliders
nicholas@2224:             interfaceJS.setAttribute("src","interfaces/horizontal-sliders.js");
nicholas@2224: 
nicholas@2224:             // horizontal-sliders comes with a css file
nicholas@2224:             var css = document.createElement('link');
nicholas@2224:             css.rel = 'stylesheet';
nicholas@2224:             css.type = 'text/css';
nicholas@2224:             css.href = 'interfaces/horizontal-sliders.css';
nicholas@2224: 
nicholas@2224:             document.getElementsByTagName("head")[0].appendChild(css);
nicholas@2224:             break;
nicholas@2224: 		case "discrete":
nicholas@2224: 		case "likert":
nicholas@2224:             // Above enumerate to horizontal discrete radios
nicholas@2224:             interfaceJS.setAttribute("src","interfaces/discrete.js");
nicholas@2224: 
nicholas@2224:             // horizontal-sliders comes with a css file
nicholas@2224:             var css = document.createElement('link');
nicholas@2224:             css.rel = 'stylesheet';
nicholas@2224:             css.type = 'text/css';
nicholas@2224:             css.href = 'interfaces/discrete.css';
nicholas@2224: 
nicholas@2224:             document.getElementsByTagName("head")[0].appendChild(css);
nicholas@2224:             break;
nicholas@2224: 	}
nicholas@2224: 	document.getElementsByTagName("head")[0].appendChild(interfaceJS);
nicholas@2224: 	
nicholas@2224: 	// Create the audio engine object
nicholas@2224: 	audioEngineContext = new AudioEngine(specification);
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function createProjectSave(destURL) {
nicholas@2224:     // Clear the window.onbeforeunload
nicholas@2224:     window.onbeforeunload = null;
nicholas@2224: 	// Save the data from interface into XML and send to destURL
nicholas@2224: 	// If destURL is null then download XML in client
nicholas@2224: 	// Now time to render file locally
nicholas@2224: 	var xmlDoc = interfaceXMLSave();
nicholas@2224: 	var parent = document.createElement("div");
nicholas@2224: 	parent.appendChild(xmlDoc);
nicholas@2224: 	var file = [parent.innerHTML];
nicholas@2224: 	if (destURL == "local") {
nicholas@2224: 		var bb = new Blob(file,{type : 'application/xml'});
nicholas@2224: 		var dnlk = window.URL.createObjectURL(bb);
nicholas@2224: 		var a = document.createElement("a");
nicholas@2224: 		a.hidden = '';
nicholas@2224: 		a.href = dnlk;
nicholas@2224: 		a.download = "save.xml";
nicholas@2224: 		a.textContent = "Save File";
nicholas@2224: 		
nicholas@2224: 		popup.showPopup();
nicholas@2224: 		popup.popupContent.innerHTML = "</span>Please save the file below to give to your test supervisor</span><br>";
nicholas@2224: 		popup.popupContent.appendChild(a);
nicholas@2224: 	} else {
nicholas@2224: 		var xmlhttp = new XMLHttpRequest;
nicholas@2224: 		xmlhttp.open("POST","php/save.php?key="+storage.SessionKey.key,true);
nicholas@2224: 		xmlhttp.setRequestHeader('Content-Type', 'text/xml');
nicholas@2224: 		xmlhttp.onerror = function(){
nicholas@2224: 			console.log('Error saving file to server! Presenting download locally');
nicholas@2224: 			createProjectSave("local");
nicholas@2224: 		};
nicholas@2224: 		xmlhttp.onload = function() {
nicholas@2224:             console.log(xmlhttp);
nicholas@2224:             if (this.status >= 300) {
nicholas@2224:                 console.log("WARNING - Could not update at this time");
nicholas@2224:                 createProjectSave("local");
nicholas@2224:             } else {
nicholas@2224:                 var parser = new DOMParser();
nicholas@2224:                 var xmlDoc = parser.parseFromString(xmlhttp.responseText, "application/xml");
nicholas@2224:                 var response = xmlDoc.getElementsByTagName('response')[0];
nicholas@2224:                 if (response.getAttribute("state") == "OK") {
nicholas@2224:                     var file = response.getElementsByTagName("file")[0];
nicholas@2224:                     console.log("Save: OK, written "+file.getAttribute("bytes")+"B");
nicholas@2224:                     popup.popupContent.textContent = specification.exitText;
nicholas@2224:                 } else {
nicholas@2224:                     var message = response.getElementsByTagName("message");
nicholas@2224:                     console.log("Save: Error! "+message.textContent);
nicholas@2224:                     createProjectSave("local");
nicholas@2224:                 }
nicholas@2224:             }
nicholas@2224:         };
nicholas@2224: 		xmlhttp.send(file);
nicholas@2224: 		popup.showPopup();
nicholas@2224: 		popup.popupContent.innerHTML = null;
nicholas@2224: 		popup.popupContent.textContent = "Submitting. Please Wait";
nicholas@2224:         popup.hideNextButton();
nicholas@2224:         popup.hidePreviousButton();
nicholas@2224: 	}
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function errorSessionDump(msg){
nicholas@2224: 	// Create the partial interface XML save
nicholas@2224: 	// Include error node with message on why the dump occured
nicholas@2224: 	popup.showPopup();
nicholas@2224: 	popup.popupContent.innerHTML = null;
nicholas@2224: 	var err = document.createElement('error');
nicholas@2224: 	var parent = document.createElement("div");
nicholas@2224: 	if (typeof msg === "object")
nicholas@2224: 	{
nicholas@2224: 		err.appendChild(msg);
nicholas@2224: 		popup.popupContent.appendChild(msg);
nicholas@2224: 		
nicholas@2224: 	} else {
nicholas@2224: 		err.textContent = msg;
nicholas@2224: 		popup.popupContent.innerHTML = "ERROR : "+msg;
nicholas@2224: 	}
nicholas@2224: 	var xmlDoc = interfaceXMLSave();
nicholas@2224: 	xmlDoc.appendChild(err);
nicholas@2224: 	parent.appendChild(xmlDoc);
nicholas@2224: 	var file = [parent.innerHTML];
nicholas@2224: 	var bb = new Blob(file,{type : 'application/xml'});
nicholas@2224: 	var dnlk = window.URL.createObjectURL(bb);
nicholas@2224: 	var a = document.createElement("a");
nicholas@2224: 	a.hidden = '';
nicholas@2224: 	a.href = dnlk;
nicholas@2224: 	a.download = "save.xml";
nicholas@2224: 	a.textContent = "Save File";
nicholas@2224: 	
nicholas@2224: 	
nicholas@2224: 	
nicholas@2224: 	popup.popupContent.appendChild(a);
nicholas@2224: }
nicholas@2224: 
nicholas@2224: // Only other global function which must be defined in the interface class. Determines how to create the XML document.
nicholas@2224: function interfaceXMLSave(){
nicholas@2224: 	// Create the XML string to be exported with results
nicholas@2224: 	return storage.finish();
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function linearToDecibel(gain)
nicholas@2224: {
nicholas@2224: 	return 20.0*Math.log10(gain);
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function decibelToLinear(gain)
nicholas@2224: {
nicholas@2224: 	return Math.pow(10,gain/20.0);
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function secondsToSamples(time,fs) {
nicholas@2224:     return Math.round(time*fs);
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function samplesToSeconds(samples,fs) {
nicholas@2224:     return samples / fs;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function randomString(length) {
nicholas@2224:     return Math.round((Math.pow(36, length + 1) - Math.random() * Math.pow(36, length))).toString(36).slice(1);
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function randomiseOrder(input)
nicholas@2224: {
nicholas@2224: 	// This takes an array of information and randomises the order
nicholas@2224: 	var N = input.length;
nicholas@2224: 	
nicholas@2224: 	var inputSequence = []; // For safety purposes: keep track of randomisation
nicholas@2224: 	for (var counter = 0; counter < N; ++counter) 
nicholas@2224: 		inputSequence.push(counter) // Fill array
nicholas@2224: 	var inputSequenceClone = inputSequence.slice(0);
nicholas@2224: 	
nicholas@2224: 	var holdArr = [];
nicholas@2224: 	var outputSequence = [];
nicholas@2224: 	for (var n=0; n<N; n++)
nicholas@2224: 	{
nicholas@2224: 		// First pick a random number
nicholas@2224: 		var r = Math.random();
nicholas@2224: 		// Multiply and floor by the number of elements left
nicholas@2224: 		r = Math.floor(r*input.length);
nicholas@2224: 		// Pick out that element and delete from the array
nicholas@2224: 		holdArr.push(input.splice(r,1)[0]);
nicholas@2224: 		// Do the same with sequence
nicholas@2224: 		outputSequence.push(inputSequence.splice(r,1)[0]);
nicholas@2224: 	}
nicholas@2224: 	console.log(inputSequenceClone.toString()); // print original array to console
nicholas@2224: 	console.log(outputSequence.toString()); 	// print randomised array to console
nicholas@2224: 	return holdArr;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function randomSubArray(array,num) {
nicholas@2224:     if (num > array.length) {
nicholas@2224:         num = array.length;
nicholas@2224:     }
nicholas@2224:     var ret = [];
nicholas@2224:     while (num > 0) {
nicholas@2224:         var index = Math.floor(Math.random() * array.length);
nicholas@2224:         ret.push( array.splice(index,1)[0] );
nicholas@2224:         num--;
nicholas@2224:     }
nicholas@2224:     return ret;
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function interfacePopup() {
nicholas@2224: 	// Creates an object to manage the popup
nicholas@2224: 	this.popup = null;
nicholas@2224: 	this.popupContent = null;
nicholas@2224: 	this.popupTitle = null;
nicholas@2224: 	this.popupResponse = null;
nicholas@2224: 	this.buttonProceed = null;
nicholas@2224: 	this.buttonPrevious = null;
nicholas@2224: 	this.popupOptions = null;
nicholas@2224: 	this.currentIndex = null;
nicholas@2224: 	this.node = null;
nicholas@2224: 	this.store = null;
nicholas@2224: 	$(window).keypress(function(e){
nicholas@2224: 			if (e.keyCode == 13 && popup.popup.style.visibility == 'visible')
nicholas@2224: 			{
nicholas@2224: 				console.log(e);
nicholas@2224: 				popup.buttonProceed.onclick();
nicholas@2224: 				e.preventDefault();
nicholas@2224: 			}
nicholas@2224: 		});
nicholas@2224: 	
nicholas@2224: 	this.createPopup = function(){
nicholas@2224: 		// Create popup window interface
nicholas@2224: 		var insertPoint = document.getElementById("topLevelBody");
nicholas@2224: 		
nicholas@2224: 		this.popup = document.getElementById('popupHolder');
nicholas@2224: 		this.popup.style.left = (window.innerWidth/2)-250 + 'px';
nicholas@2224: 		this.popup.style.top = (window.innerHeight/2)-125 + 'px';
nicholas@2224: 		
nicholas@2224: 		this.popupContent = document.getElementById('popupContent');
nicholas@2224: 		
nicholas@2224: 		this.popupTitle = document.getElementById('popupTitle');
nicholas@2224: 		
nicholas@2224: 		this.popupResponse = document.getElementById('popupResponse');
nicholas@2224: 		
nicholas@2224: 		this.buttonProceed = document.getElementById('popup-proceed');
nicholas@2224: 		this.buttonProceed.onclick = function(){popup.proceedClicked();};
nicholas@2224: 		
nicholas@2224: 		this.buttonPrevious = document.getElementById('popup-previous');
nicholas@2224: 		this.buttonPrevious.onclick = function(){popup.previousClick();};
nicholas@2224: 		
nicholas@2224:         this.hidePopup();
nicholas@2224:         
nicholas@2224: 		this.popup.style.zIndex = -1;
nicholas@2224: 		this.popup.style.visibility = 'hidden';
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.showPopup = function(){
nicholas@2224: 		if (this.popup == null) {
nicholas@2224: 			this.createPopup();
nicholas@2224: 		}
nicholas@2224: 		this.popup.style.zIndex = 3;
nicholas@2224: 		this.popup.style.visibility = 'visible';
nicholas@2224: 		var blank = document.getElementsByClassName('testHalt')[0];
nicholas@2224: 		blank.style.zIndex = 2;
nicholas@2224: 		blank.style.visibility = 'visible';
nicholas@2224:         this.popupResponse.style.left="0%";
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.hidePopup = function(){
nicholas@2224:         if (this.popup) {
nicholas@2224:             this.popup.style.zIndex = -1;
nicholas@2224:             this.popup.style.visibility = 'hidden';
nicholas@2224:             var blank = document.getElementsByClassName('testHalt')[0];
nicholas@2224:             blank.style.zIndex = -2;
nicholas@2224:             blank.style.visibility = 'hidden';
nicholas@2224:             this.buttonPrevious.style.visibility = 'inherit';
nicholas@2224:         }
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.postNode = function() {
nicholas@2224: 		// This will take the node from the popupOptions and display it
nicholas@2224: 		var node = this.popupOptions[this.currentIndex];
nicholas@2224: 		this.popupResponse.innerHTML = null;
nicholas@2224: 		this.popupTitle.textContent = node.specification.statement;
nicholas@2224: 		if (node.specification.type == 'question') {
nicholas@2224: 			var textArea = document.createElement('textarea');
nicholas@2224: 			switch (node.specification.boxsize) {
nicholas@2224: 			case 'small':
nicholas@2224: 				textArea.cols = "20";
nicholas@2224: 				textArea.rows = "1";
nicholas@2224: 				break;
nicholas@2224: 			case 'normal':
nicholas@2224: 				textArea.cols = "30";
nicholas@2224: 				textArea.rows = "2";
nicholas@2224: 				break;
nicholas@2224: 			case 'large':
nicholas@2224: 				textArea.cols = "40";
nicholas@2224: 				textArea.rows = "5";
nicholas@2224: 				break;
nicholas@2224: 			case 'huge':
nicholas@2224: 				textArea.cols = "50";
nicholas@2224: 				textArea.rows = "10";
nicholas@2224: 				break;
nicholas@2224: 			}
nicholas@2224:             if (node.response == undefined) {
nicholas@2224:                 node.response = "";
nicholas@2224:             } else {
nicholas@2224:                 textArea.value = node.response;
nicholas@2224:             }
nicholas@2224: 			this.popupResponse.appendChild(textArea);
nicholas@2224: 			textArea.focus();
nicholas@2224:             this.popupResponse.style.textAlign="center";
nicholas@2224:             this.popupResponse.style.left="0%";
nicholas@2224: 		} else if (node.specification.type == 'checkbox') {
nicholas@2224:             if (node.response == undefined) {
nicholas@2224:                 node.response = Array(node.specification.options.length);
nicholas@2224:             }
nicholas@2224:             var index = 0;
nicholas@2224:             var max_w = 0;
nicholas@2224: 			for (var option of node.specification.options) {
nicholas@2224: 				var input = document.createElement('input');
nicholas@2224: 				input.id = option.name;
nicholas@2224: 				input.type = 'checkbox';
nicholas@2224: 				var span = document.createElement('span');
nicholas@2224: 				span.textContent = option.text;
nicholas@2224: 				var hold = document.createElement('div');
nicholas@2224: 				hold.setAttribute('name','option');
nicholas@2224:                 hold.className = "popup-option-checbox";
nicholas@2224: 				hold.appendChild(input);
nicholas@2224: 				hold.appendChild(span);
nicholas@2224: 				this.popupResponse.appendChild(hold);
nicholas@2224:                 if (node.response[index] != undefined){
nicholas@2224:                     if (node.response[index].checked == true) {
nicholas@2224:                         input.checked = "true";
nicholas@2224:                     }
nicholas@2224:                 }
nicholas@2224:                 var w = $(hold).width();
nicholas@2224:                 if (w > max_w)
nicholas@2224:                     max_w = w;
nicholas@2224:                 index++;
nicholas@2224: 			}
nicholas@2224:             this.popupResponse.style.textAlign="";
nicholas@2224:             var leftP = 50-(((max_w/$('#popupContent').width())/2)*100);
nicholas@2224:             this.popupResponse.style.left=leftP+"%";
nicholas@2224: 		} else if (node.specification.type == 'radio') {
nicholas@2224:             if (node.response == undefined) {
nicholas@2224:                 node.response = {name: "", text: ""};
nicholas@2224:             }
nicholas@2224:             var index = 0;
nicholas@2224:             var max_w = 0;
nicholas@2224: 			for (var option of node.specification.options) {
nicholas@2224: 				var input = document.createElement('input');
nicholas@2224: 				input.id = option.name;
nicholas@2224: 				input.type = 'radio';
nicholas@2224: 				input.name = node.specification.id;
nicholas@2224: 				var span = document.createElement('span');
nicholas@2224: 				span.textContent = option.text;
nicholas@2224: 				var hold = document.createElement('div');
nicholas@2224: 				hold.setAttribute('name','option');
nicholas@2224: 				hold.className = "popup-option-checbox";
nicholas@2224: 				hold.appendChild(input);
nicholas@2224: 				hold.appendChild(span);
nicholas@2224: 				this.popupResponse.appendChild(hold);
nicholas@2224:                 if (input.id == node.response.name) {
nicholas@2224:                     input.checked = "true";
nicholas@2224:                 }
nicholas@2224:                 var w = $(hold).width();
nicholas@2224:                 if (w > max_w)
nicholas@2224:                     max_w = w;
nicholas@2224: 			}
nicholas@2224:             this.popupResponse.style.textAlign="";
nicholas@2224:             var leftP = 50-(((max_w/$('#popupContent').width())/2)*100);
nicholas@2224:             this.popupResponse.style.left=leftP+"%";
nicholas@2224: 		} else if (node.specification.type == 'number') {
nicholas@2224: 			var input = document.createElement('input');
nicholas@2224: 			input.type = 'textarea';
nicholas@2224: 			if (node.min != null) {input.min = node.specification.min;}
nicholas@2224: 			if (node.max != null) {input.max = node.specification.max;}
nicholas@2224: 			if (node.step != null) {input.step = node.specification.step;}
nicholas@2224:             if (node.response != undefined) {
nicholas@2224:                 input.value = node.response;
nicholas@2224:             }
nicholas@2224: 			this.popupResponse.appendChild(input);
nicholas@2224:             this.popupResponse.style.textAlign="center";
nicholas@2224:             this.popupResponse.style.left="0%";
nicholas@2224: 		}
nicholas@2224: 		if(this.currentIndex+1 == this.popupOptions.length) {
nicholas@2224: 			if (this.node.location == "pre") {
nicholas@2224: 				this.buttonProceed.textContent = 'Start';
nicholas@2224: 			} else {
nicholas@2224: 				this.buttonProceed.textContent = 'Submit';
nicholas@2224: 			}
nicholas@2224: 		} else {
nicholas@2224: 			this.buttonProceed.textContent = 'Next';
nicholas@2224: 		}
nicholas@2224: 		if(this.currentIndex > 0)
nicholas@2224: 			this.buttonPrevious.style.visibility = 'visible';
nicholas@2224: 		else
nicholas@2224: 			this.buttonPrevious.style.visibility = 'hidden';
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.initState = function(node,store) {
nicholas@2224: 		//Call this with your preTest and postTest nodes when needed to
nicholas@2224: 		// initialise the popup procedure.
nicholas@2224: 		if (node.options.length > 0) {
nicholas@2224: 			this.popupOptions = [];
nicholas@2224: 			this.node = node;
nicholas@2224: 			this.store = store;
nicholas@2224: 			for (var opt of node.options)
nicholas@2224: 			{
nicholas@2224: 				this.popupOptions.push({
nicholas@2224: 					specification: opt,
nicholas@2224: 					response: null
nicholas@2224: 				});
nicholas@2224: 			}			
nicholas@2224: 			this.currentIndex = 0;
nicholas@2224: 			this.showPopup();
nicholas@2224: 			this.postNode();
nicholas@2224: 		} else {
nicholas@2224: 			advanceState();
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.proceedClicked = function() {
nicholas@2224: 		// Each time the popup button is clicked!
nicholas@2224:         if (testState.stateIndex == 0 && specification.calibration) {
nicholas@2224:             interfaceContext.calibrationModuleObject.collect();
nicholas@2224:             advanceState();
nicholas@2224:             return;
nicholas@2224:         }
nicholas@2224: 		var node = this.popupOptions[this.currentIndex];
nicholas@2224: 		if (node.specification.type == 'question') {
nicholas@2224: 			// Must extract the question data
nicholas@2224: 			var textArea = $(popup.popupContent).find('textarea')[0];
nicholas@2224: 			if (node.specification.mandatory == true && textArea.value.length == 0) {
nicholas@2224: 				alert('This question is mandatory');
nicholas@2224: 				return;
nicholas@2224: 			} else {
nicholas@2224: 				// Save the text content
nicholas@2224: 				console.log("Question: "+ node.specification.statement);
nicholas@2224: 				console.log("Question Response: "+ textArea.value);
nicholas@2224: 				node.response = textArea.value;
nicholas@2224: 			}
nicholas@2224: 		} else if (node.specification.type == 'checkbox') {
nicholas@2224: 			// Must extract checkbox data
nicholas@2224: 			console.log("Checkbox: "+ node.specification.statement);
nicholas@2224: 			var inputs = this.popupResponse.getElementsByTagName('input');
nicholas@2224: 			node.response = [];
nicholas@2224: 			for (var i=0; i<node.specification.options.length; i++) {
nicholas@2224: 				node.response.push({
nicholas@2224: 					name: node.specification.options[i].name,
nicholas@2224: 					text: node.specification.options[i].text,
nicholas@2224: 					checked: inputs[i].checked
nicholas@2224: 				});
nicholas@2224: 				console.log(node.specification.options[i].name+": "+ inputs[i].checked);
nicholas@2224: 			}
nicholas@2224: 		} else if (node.specification.type == "radio") {
nicholas@2224: 			var optHold = this.popupResponse;
nicholas@2224: 			console.log("Radio: "+ node.specification.statement);
nicholas@2224: 			node.response = null;
nicholas@2224: 			var i=0;
nicholas@2224: 			var inputs = optHold.getElementsByTagName('input');
nicholas@2224: 			while(node.response == null) {
nicholas@2224: 				if (i == inputs.length)
nicholas@2224: 				{
nicholas@2224: 					if (node.specification.mandatory == true)
nicholas@2224: 					{
nicholas@2224: 						alert("This radio is mandatory");
nicholas@2224: 					} else {
nicholas@2224: 						node.response = -1;
nicholas@2224: 					}
nicholas@2224: 					return;
nicholas@2224: 				}
nicholas@2224: 				if (inputs[i].checked == true) {
nicholas@2224: 					node.response = node.specification.options[i];
nicholas@2224: 					console.log("Selected: "+ node.specification.options[i].name);
nicholas@2224: 				}
nicholas@2224: 				i++;
nicholas@2224: 			}
nicholas@2224: 		} else if (node.specification.type == "number") {
nicholas@2224: 			var input = this.popupContent.getElementsByTagName('input')[0];
nicholas@2224: 			if (node.mandatory == true && input.value.length == 0) {
nicholas@2224: 				alert('This question is mandatory. Please enter a number');
nicholas@2224: 				return;
nicholas@2224: 			}
nicholas@2224: 			var enteredNumber = Number(input.value);
nicholas@2224: 			if (isNaN(enteredNumber)) {
nicholas@2224: 				alert('Please enter a valid number');
nicholas@2224: 				return;
nicholas@2224: 			}
nicholas@2224: 			if (enteredNumber < node.min && node.min != null) {
nicholas@2224: 				alert('Number is below the minimum value of '+node.min);
nicholas@2224: 				return;
nicholas@2224: 			}
nicholas@2224: 			if (enteredNumber > node.max && node.max != null) {
nicholas@2224: 				alert('Number is above the maximum value of '+node.max);
nicholas@2224: 				return;
nicholas@2224: 			}
nicholas@2224: 			node.response = input.value;
nicholas@2224: 		}
nicholas@2224: 		this.currentIndex++;
nicholas@2224: 		if (this.currentIndex < this.popupOptions.length) {
nicholas@2224: 			this.postNode();
nicholas@2224: 		} else {
nicholas@2224: 			// Reached the end of the popupOptions
nicholas@2224: 			this.hidePopup();
nicholas@2224: 			for (var node of this.popupOptions)
nicholas@2224: 			{
nicholas@2224: 				this.store.postResult(node);
nicholas@2224: 			}
nicholas@2224:             this.store.complete();
nicholas@2224: 			advanceState();
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.previousClick = function() {
nicholas@2224: 		// Triggered when the 'Back' button is clicked in the survey
nicholas@2224: 		if (this.currentIndex > 0) {
nicholas@2224: 			this.currentIndex--;
nicholas@2224: 			this.postNode();
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.resize = function(event)
nicholas@2224: 	{
nicholas@2224: 		// Called on window resize;
nicholas@2224: 		if (this.popup != null) {
nicholas@2224: 			this.popup.style.left = (window.innerWidth/2)-250 + 'px';
nicholas@2224: 			this.popup.style.top = (window.innerHeight/2)-125 + 'px';
nicholas@2224: 			var blank = document.getElementsByClassName('testHalt')[0];
nicholas@2224: 			blank.style.width = window.innerWidth;
nicholas@2224: 			blank.style.height = window.innerHeight;
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224:     this.hideNextButton = function() {
nicholas@2224:         this.buttonProceed.style.visibility = "hidden";
nicholas@2224:     }
nicholas@2224:     this.hidePreviousButton = function() {
nicholas@2224:         this.buttonPrevious.style.visibility = "hidden";
nicholas@2224:     }
nicholas@2224:     this.showNextButton = function() {
nicholas@2224:         this.buttonProceed.style.visibility = "visible";
nicholas@2224:     }
nicholas@2224:     this.showPreviousButton = function() {
nicholas@2224:         this.buttonPrevious.style.visibility = "visible";
nicholas@2224:     }
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function advanceState()
nicholas@2224: {
nicholas@2224: 	// Just for complete clarity
nicholas@2224: 	testState.advanceState();
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function stateMachine()
nicholas@2224: {
nicholas@2224: 	// Object prototype for tracking and managing the test state
nicholas@2224: 	this.stateMap = [];
nicholas@2224: 	this.preTestSurvey = null;
nicholas@2224: 	this.postTestSurvey = null;
nicholas@2224: 	this.stateIndex = null;
nicholas@2224: 	this.currentStateMap = null;
nicholas@2224: 	this.currentStatePosition = null;
nicholas@2224:     this.currentStore = null;
nicholas@2224: 	this.initialise = function(){
nicholas@2224:         
nicholas@2224: 		// Get the data from Specification
nicholas@2224: 		var pagePool = [];
nicholas@2224:         var pageInclude = [];
nicholas@2224: 		for (var page of specification.pages)
nicholas@2224: 		{
nicholas@2224:             if (page.alwaysInclude) {
nicholas@2224:                 pageInclude.push(page);
nicholas@2224:             } else {
nicholas@2224:                 pagePool.push(page);
nicholas@2224:             }
nicholas@2224: 		}
nicholas@2224:         
nicholas@2224:         // Find how many are left to get
nicholas@2224:         var numPages = specification.poolSize;
nicholas@2224:         if (numPages > pagePool.length) {
nicholas@2224:             console.log("WARNING - You have specified more pages in <setup poolSize> than you have created!!");
nicholas@2224:             numPages = specification.pages.length;
nicholas@2224:         }
nicholas@2224:         if (specification.poolSize == 0) {
nicholas@2224:             numPages = specification.pages.length;
nicholas@2224:         }
nicholas@2224:         numPages -= pageInclude.length;
nicholas@2224:         
nicholas@2224:         if (numPages > 0) {
nicholas@2224:             // Go find the rest of the pages from the pool
nicholas@2224:             var subarr = null;
nicholas@2224:             if (specification.randomiseOrder) {
nicholas@2224:                 // Append a random sub-array
nicholas@2224:                 subarr = randomSubArray(pagePool,numPages);
nicholas@2224:             } else {
nicholas@2224:                 // Append the matching number
nicholas@2224:                 subarr = pagePool.slice(0,numPages);
nicholas@2224:             }
nicholas@2224:             pageInclude = pageInclude.concat(subarr);
nicholas@2224:         }
nicholas@2224:         
nicholas@2224:         // We now have our selected pages in pageInclude array
nicholas@2224: 		if (specification.randomiseOrder)
nicholas@2224: 		{
nicholas@2224: 			pageInclude = randomiseOrder(pageInclude);
nicholas@2224: 		}
nicholas@2224: 		for (var i=0; i<pageInclude.length; i++)
nicholas@2224: 		{
nicholas@2224:             pageInclude[i].presentedId = i;
nicholas@2224: 			this.stateMap.push(pageInclude[i]);
nicholas@2224:             // For each selected page, we must get the sub pool
nicholas@2224:             if (pageInclude[i].poolSize != 0 && pageInclude[i].poolSize != pageInclude[i].audioElements.length) {
nicholas@2224:                 var elemInclude = [];
nicholas@2224:                 var elemPool = [];
nicholas@2224:                 for (var elem of pageInclude[i].audioElements) {
nicholas@2224:                     if (elem.include || elem.type != "normal") {
nicholas@2224:                         elemInclude.push(elem);
nicholas@2224:                     } else {
nicholas@2224:                         elemPool.push(elem);
nicholas@2224:                     }
nicholas@2224:                 }
nicholas@2224:                 var numElems = pageInclude[i].poolSize - elemInclude.length;
nicholas@2224:                 pageInclude[i].audioElements = elemInclude.concat(randomSubArray(elemPool,numElems));
nicholas@2224:             }
nicholas@2224:             storage.createTestPageStore(pageInclude[i]);
nicholas@2224:             audioEngineContext.loadPageData(pageInclude[i]);
nicholas@2224: 		}
nicholas@2224:         
nicholas@2224: 		if (specification.preTest != null) {this.preTestSurvey = specification.preTest;}
nicholas@2224: 		if (specification.postTest != null) {this.postTestSurvey = specification.postTest;}
nicholas@2224: 		
nicholas@2224: 		if (this.stateMap.length > 0) {
nicholas@2224: 			if(this.stateIndex != null) {
nicholas@2224: 				console.log('NOTE - State already initialise');
nicholas@2224: 			}
nicholas@2224: 			this.stateIndex = -2;
nicholas@2224:             console.log('Starting test...');
nicholas@2224: 		} else {
nicholas@2224: 			console.log('FATAL - StateMap not correctly constructed. EMPTY_STATE_MAP');
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	this.advanceState = function(){
nicholas@2224: 		if (this.stateIndex == null) {
nicholas@2224: 			this.initialise();
nicholas@2224: 		}
nicholas@2224:         storage.update();
nicholas@2224: 		if (this.stateIndex == -2) {
nicholas@2224:             this.stateIndex++;
nicholas@2224: 			if (this.preTestSurvey != null)
nicholas@2224: 			{
nicholas@2224: 				popup.initState(this.preTestSurvey,storage.globalPreTest);
nicholas@2224: 			} else {
nicholas@2224: 				this.advanceState();
nicholas@2224: 			}
nicholas@2224: 		} else if (this.stateIndex == -1) {
nicholas@2224:             this.stateIndex++;
nicholas@2224:             if (specification.calibration) {
nicholas@2224:                 popup.showPopup();
nicholas@2224:                 popup.popupTitle.textContent = "Calibration. Set the levels so all tones are of equal amplitude. Move your mouse over the sliders to hear the tones. The red slider is the reference tone";
nicholas@2224:                 interfaceContext.calibrationModuleObject = new interfaceContext.calibrationModule();
nicholas@2224:                 interfaceContext.calibrationModuleObject.build(popup.popupResponse);
nicholas@2224:                 popup.hidePreviousButton();
nicholas@2224:             } else {
nicholas@2224:                 this.advanceState();
nicholas@2224:             }
nicholas@2224:         } 
nicholas@2224:         else if (this.stateIndex == this.stateMap.length)
nicholas@2224: 		{
nicholas@2224: 			// All test pages complete, post test
nicholas@2224: 			console.log('Ending test ...');
nicholas@2224: 			this.stateIndex++;
nicholas@2224: 			if (this.postTestSurvey == null) {
nicholas@2224: 				this.advanceState();
nicholas@2224: 			} else {
nicholas@2224: 				popup.initState(this.postTestSurvey,storage.globalPostTest);
nicholas@2224: 			}
nicholas@2224: 		} else if (this.stateIndex > this.stateMap.length)
nicholas@2224: 		{
nicholas@2224: 			createProjectSave(specification.projectReturn);
nicholas@2224: 		}
nicholas@2224: 		else
nicholas@2224: 		{
nicholas@2224:             popup.hidePopup();
nicholas@2224: 			if (this.currentStateMap == null)
nicholas@2224: 			{
nicholas@2224: 				this.currentStateMap = this.stateMap[this.stateIndex];
nicholas@2224: 				if (this.currentStateMap.randomiseOrder)
nicholas@2224: 				{
nicholas@2224: 					this.currentStateMap.audioElements = randomiseOrder(this.currentStateMap.audioElements);
nicholas@2224: 				}
nicholas@2224:                 this.currentStore = storage.testPages[this.stateIndex];
nicholas@2224: 				if (this.currentStateMap.preTest != null)
nicholas@2224: 				{
nicholas@2224: 					this.currentStatePosition = 'pre';
nicholas@2224: 					popup.initState(this.currentStateMap.preTest,storage.testPages[this.stateIndex].preTest);
nicholas@2224: 				} else {
nicholas@2224: 					this.currentStatePosition = 'test';
nicholas@2224: 				}
nicholas@2224: 				interfaceContext.newPage(this.currentStateMap,storage.testPages[this.stateIndex]);
nicholas@2224: 				return;
nicholas@2224: 			}
nicholas@2224: 			switch(this.currentStatePosition)
nicholas@2224: 			{
nicholas@2224: 			case 'pre':
nicholas@2224: 				this.currentStatePosition = 'test';
nicholas@2224: 				break;
nicholas@2224: 			case 'test':
nicholas@2224: 				this.currentStatePosition = 'post';
nicholas@2224: 				// Save the data
nicholas@2224: 				this.testPageCompleted();
nicholas@2224: 				if (this.currentStateMap.postTest == null)
nicholas@2224: 				{
nicholas@2224: 					this.advanceState();
nicholas@2224: 					return;
nicholas@2224: 				} else {
nicholas@2224: 					popup.initState(this.currentStateMap.postTest,storage.testPages[this.stateIndex].postTest);
nicholas@2224: 				}
nicholas@2224: 				break;
nicholas@2224: 			case 'post':
nicholas@2224: 				this.stateIndex++;
nicholas@2224: 				this.currentStateMap = null;
nicholas@2224: 				this.advanceState();
nicholas@2224: 				break;
nicholas@2224: 			};
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.testPageCompleted = function() {
nicholas@2224: 		// Function called each time a test page has been completed
nicholas@2224: 		var storePoint = storage.testPages[this.stateIndex];
nicholas@2224: 		// First get the test metric
nicholas@2224: 		
nicholas@2224: 		var metric = storePoint.XMLDOM.getElementsByTagName('metric')[0];
nicholas@2224: 		if (audioEngineContext.metric.enableTestTimer)
nicholas@2224: 		{
nicholas@2224: 			var testTime = storePoint.parent.document.createElement('metricresult');
nicholas@2224: 			testTime.id = 'testTime';
nicholas@2224: 			testTime.textContent = audioEngineContext.timer.testDuration;
nicholas@2224: 			metric.appendChild(testTime);
nicholas@2224: 		}
nicholas@2224: 		
nicholas@2224: 		var audioObjects = audioEngineContext.audioObjects;
nicholas@2224: 		for (var ao of audioEngineContext.audioObjects) 
nicholas@2224: 		{
nicholas@2224: 			ao.exportXMLDOM();
nicholas@2224: 		}
nicholas@2224: 		for (var element of interfaceContext.commentQuestions)
nicholas@2224: 		{
nicholas@2224: 			element.exportXMLDOM(storePoint);
nicholas@2224: 		}
nicholas@2224: 		pageXMLSave(storePoint.XMLDOM, this.currentStateMap);
nicholas@2224:         storePoint.complete();
nicholas@2224: 	};
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function AudioEngine(specification) {
nicholas@2224: 	
nicholas@2224: 	// Create two output paths, the main outputGain and fooGain.
nicholas@2224: 	// Output gain is default to 1 and any items for playback route here
nicholas@2224: 	// Foo gain is used for analysis to ensure paths get processed, but are not heard
nicholas@2224: 	// because web audio will optimise and any route which does not go to the destination gets ignored.
nicholas@2224: 	this.outputGain = audioContext.createGain();
nicholas@2224: 	this.fooGain = audioContext.createGain();
nicholas@2224: 	this.fooGain.gain = 0;
nicholas@2224: 	
nicholas@2224: 	// Use this to detect playback state: 0 - stopped, 1 - playing
nicholas@2224: 	this.status = 0;
nicholas@2224: 	
nicholas@2224: 	// Connect both gains to output
nicholas@2224: 	this.outputGain.connect(audioContext.destination);
nicholas@2224: 	this.fooGain.connect(audioContext.destination);
nicholas@2224: 	
nicholas@2224: 	// Create the timer Object
nicholas@2224: 	this.timer = new timer();
nicholas@2224: 	// Create session metrics
nicholas@2224: 	this.metric = new sessionMetrics(this,specification);
nicholas@2224: 	
nicholas@2224: 	this.loopPlayback = false;
nicholas@2224: 	
nicholas@2224: 	this.pageStore = null;
nicholas@2224: 	
nicholas@2224: 	// Create store for new audioObjects
nicholas@2224: 	this.audioObjects = [];
nicholas@2224: 	
nicholas@2224: 	this.buffers = [];
nicholas@2224: 	this.bufferObj = function()
nicholas@2224: 	{
nicholas@2224: 		this.url = null;
nicholas@2224: 		this.buffer = null;
nicholas@2224: 		this.xmlRequest = new XMLHttpRequest();
nicholas@2224: 		this.xmlRequest.parent = this;
nicholas@2224: 		this.users = [];
nicholas@2224:         this.progress = 0;
nicholas@2224:         this.status = 0;
nicholas@2224: 		this.ready = function()
nicholas@2224: 		{
nicholas@2224:             if (this.status >= 2)
nicholas@2224:             {
nicholas@2224:                 this.status = 3;
nicholas@2224:             }
nicholas@2224: 			for (var i=0; i<this.users.length; i++)
nicholas@2224: 			{
nicholas@2224: 				this.users[i].state = 1;
nicholas@2224: 				if (this.users[i].interfaceDOM != null)
nicholas@2224: 				{
nicholas@2224: 					this.users[i].bufferLoaded(this);
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224: 		this.getMedia = function(url) {
nicholas@2224: 			this.url = url;
nicholas@2224: 			this.xmlRequest.open('GET',this.url,true);
nicholas@2224: 			this.xmlRequest.responseType = 'arraybuffer';
nicholas@2224: 			
nicholas@2224: 			var bufferObj = this;
nicholas@2224: 			
nicholas@2224: 			// Create callback to decode the data asynchronously
nicholas@2224: 			this.xmlRequest.onloadend = function() {
nicholas@2224:                 // Use inbuilt WAVE decoder first
nicholas@2224:                 if (this.status == -1) {return;}
nicholas@2224:                 var waveObj = new WAVE();
nicholas@2224:                 if (waveObj.open(bufferObj.xmlRequest.response) == 0)
nicholas@2224:                 {
nicholas@2224:                     bufferObj.buffer = audioContext.createBuffer(waveObj.num_channels,waveObj.num_samples,waveObj.sample_rate);
nicholas@2224:                     for (var c=0; c<waveObj.num_channels; c++)
nicholas@2224:                     {
nicholas@2224:                         var buffer_ptr = bufferObj.buffer.getChannelData(c);
nicholas@2224:                         for (var n=0; n<waveObj.num_samples; n++)
nicholas@2224:                         {
nicholas@2224:                             buffer_ptr[n] = waveObj.decoded_data[c][n];
nicholas@2224:                         }
nicholas@2224:                     }
nicholas@2224:                     
nicholas@2224:                     delete waveObj;
nicholas@2224:                 } else {
nicholas@2224:                     audioContext.decodeAudioData(bufferObj.xmlRequest.response, function(decodedData) {
nicholas@2224:                         bufferObj.buffer = decodedData;
nicholas@2244:                         bufferObj.status = 2;
nicholas@2244:                         calculateLoudness(bufferObj,"I");
nicholas@2224:                     }, function(e){
nicholas@2224:                         // Should only be called if there was an error, but sometimes gets called continuously
nicholas@2224:                         // Check here if the error is genuine
nicholas@2224:                         if (bufferObj.xmlRequest.response == undefined) {
nicholas@2224:                             // Genuine error
nicholas@2224:                             console.log('FATAL - Error loading buffer on '+audioObj.id);
nicholas@2224:                             if (request.status == 404)
nicholas@2224:                             {
nicholas@2224:                                 console.log('FATAL - Fragment '+audioObj.id+' 404 error');
nicholas@2224:                                 console.log('URL: '+audioObj.url);
nicholas@2224:                                 errorSessionDump('Fragment '+audioObj.id+' 404 error');
nicholas@2224:                             }
nicholas@2224:                             this.parent.status = -1;
nicholas@2224:                         }
nicholas@2224:                     });
nicholas@2224:                 }
nicholas@2224:                 if (bufferObj.buffer != undefined)
nicholas@2224:                 {
nicholas@2224:                     bufferObj.status = 2;
nicholas@2224:                     calculateLoudness(bufferObj,"I");
nicholas@2224:                 }
nicholas@2224: 			};
nicholas@2224:             
nicholas@2224:             // Create callback for any error in loading
nicholas@2224:             this.xmlRequest.onerror = function() {
nicholas@2224:                 this.parent.status = -1;
nicholas@2224:                 for (var i=0; i<this.parent.users.length; i++)
nicholas@2224:                 {
nicholas@2224:                     this.parent.users[i].state = -1;
nicholas@2224:                     if (this.parent.users[i].interfaceDOM != null)
nicholas@2224:                     {
nicholas@2224:                         this.parent.users[i].bufferLoaded(this);
nicholas@2224:                     }
nicholas@2224:                 }
nicholas@2224:             }
nicholas@2224:             
nicholas@2224: 			this.progress = 0;
nicholas@2224: 			this.progressCallback = function(event){
nicholas@2224: 				if (event.lengthComputable)
nicholas@2224: 				{
nicholas@2224: 					this.parent.progress = event.loaded / event.total;
nicholas@2224: 					for (var i=0; i<this.parent.users.length; i++)
nicholas@2224: 					{
nicholas@2224: 						if(this.parent.users[i].interfaceDOM != null)
nicholas@2224: 						{
nicholas@2224: 							if (typeof this.parent.users[i].interfaceDOM.updateLoading === "function")
nicholas@2224: 							{
nicholas@2224: 								this.parent.users[i].interfaceDOM.updateLoading(this.parent.progress*100);
nicholas@2224: 							}
nicholas@2224: 						}
nicholas@2224: 					}
nicholas@2224: 				}
nicholas@2224: 			};
nicholas@2224: 			this.xmlRequest.addEventListener("progress", this.progressCallback);
nicholas@2224:             this.status = 1;
nicholas@2224: 			this.xmlRequest.send();
nicholas@2224: 		};
nicholas@2224:         
nicholas@2224:         this.registerAudioObject = function(audioObject)
nicholas@2224:         {
nicholas@2224:             // Called by an audioObject to register to the buffer for use
nicholas@2224:             // First check if already in the register pool
nicholas@2224:             for (var objects of this.users)
nicholas@2224:             {
nicholas@2224:                 if (audioObject.id == objects.id){return 0;}
nicholas@2224:             }
nicholas@2224:             this.users.push(audioObject);
nicholas@2224:             if (this.status == 3 || this.status == -1)
nicholas@2224:             {
nicholas@2224:                 // The buffer is already ready, trigger bufferLoaded
nicholas@2224:                 audioObject.bufferLoaded(this);
nicholas@2224:             }
nicholas@2224:         };
nicholas@2224:         
nicholas@2224:         this.copyBuffer = function(preSilenceTime,postSilenceTime) {
nicholas@2224:             // Copies the entire bufferObj.
nicholas@2224:             if (preSilenceTime == undefined) {preSilenceTime = 0;}
nicholas@2224:             if (postSilenceTime == undefined) {postSilenceTime = 0;}
nicholas@2224:             var copy = new this.constructor();
nicholas@2224:             copy.url = this.url;
nicholas@2224:             var preSilenceSamples = secondsToSamples(preSilenceTime,this.buffer.sampleRate);
nicholas@2224:             var postSilenceSamples = secondsToSamples(postSilenceTime,this.buffer.sampleRate);
nicholas@2224:             var newLength = this.buffer.length+preSilenceSamples+postSilenceSamples;
nicholas@2224:             copy.buffer = audioContext.createBuffer(this.buffer.numberOfChannels, newLength, this.buffer.sampleRate);
nicholas@2224:             // Now we can use some efficient background copy schemes if we are just padding the end
nicholas@2224:             if (preSilenceSamples == 0 && typeof copy.buffer.copyToChannel == "function") {
nicholas@2224:                 for (var c=0; c<this.buffer.numberOfChannels; c++) {
nicholas@2224:                     copy.buffer.copyToChannel(this.buffer.getChannelData(c),c);
nicholas@2224:                 }
nicholas@2224:             } else {
nicholas@2224:                 for (var c=0; c<this.buffer.numberOfChannels; c++) {
nicholas@2224:                     var src = this.buffer.getChannelData(c);
nicholas@2224:                     var dst = copy.buffer.getChannelData(c);
nicholas@2224:                     for (var n=0; n<src.length; n++)
nicholas@2224:                         dst[n+preSilenceSamples] = src[n];
nicholas@2224:                 }
nicholas@2224:             }
nicholas@2224:             // Copy in the rest of the buffer information
nicholas@2224:             copy.buffer.lufs = this.buffer.lufs;
nicholas@2224:             copy.buffer.playbackGain = this.buffer.playbackGain;
nicholas@2224:             return copy;
nicholas@2224:         }
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224:     this.loadPageData = function(page) {
nicholas@2224:         // Load the URL from pages
nicholas@2224:         for (var element of page.audioElements) {
nicholas@2224:             var URL = page.hostURL + element.url;
nicholas@2224:             var buffer = null;
nicholas@2224:             for (var buffObj of this.buffers) {
nicholas@2224:                 if (URL == buffObj.url) {
nicholas@2224:                     buffer = buffObj;
nicholas@2224:                     break;
nicholas@2224:                 }
nicholas@2224:             }
nicholas@2224:             if (buffer == null) {
nicholas@2224:                 buffer = new this.bufferObj();
nicholas@2224:                 buffer.getMedia(URL);
nicholas@2224:                 this.buffers.push(buffer);
nicholas@2224:             }
nicholas@2224:         }
nicholas@2224:     };
nicholas@2224: 	
nicholas@2224: 	this.play = function(id) {
nicholas@2224: 		// Start the timer and set the audioEngine state to playing (1)
nicholas@2224: 		if (this.status == 0 && this.loopPlayback) {
nicholas@2224: 			// Check if all audioObjects are ready
nicholas@2224: 			if(this.checkAllReady())
nicholas@2224: 			{
nicholas@2224: 				this.status = 1;
nicholas@2224: 				this.setSynchronousLoop();
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		else
nicholas@2224: 		{
nicholas@2224: 			this.status = 1;
nicholas@2224: 		}
nicholas@2224: 		if (this.status== 1) {
nicholas@2224: 			this.timer.startTest();
nicholas@2224: 			if (id == undefined) {
nicholas@2224: 				id = -1;
nicholas@2224: 				console.error('FATAL - Passed id was undefined - AudioEngineContext.play(id)');
nicholas@2224: 				return;
nicholas@2224: 			} else {
nicholas@2224: 				interfaceContext.playhead.setTimePerPixel(this.audioObjects[id]);
nicholas@2224: 			}
nicholas@2224: 			if (this.loopPlayback) {
nicholas@2224:                 var setTime = audioContext.currentTime+specification.crossFade;
nicholas@2224: 				for (var i=0; i<this.audioObjects.length; i++)
nicholas@2224: 				{
nicholas@2224: 					this.audioObjects[i].play(audioContext.currentTime);
nicholas@2224: 					if (id == i) {
nicholas@2224: 						this.audioObjects[i].loopStart(setTime);
nicholas@2224: 					} else {
nicholas@2224: 						this.audioObjects[i].loopStop(setTime);
nicholas@2224: 					}
nicholas@2224: 				}
nicholas@2224: 			} else {
nicholas@2224:                 var setTime = audioContext.currentTime+specification.crossFade;
nicholas@2224: 				for (var i=0; i<this.audioObjects.length; i++)
nicholas@2224: 				{
nicholas@2224: 					if (i != id) {
nicholas@2224: 						this.audioObjects[i].stop(setTime);
nicholas@2224: 					} else if (i == id) {
nicholas@2224: 						this.audioObjects[id].play(setTime);
nicholas@2224: 					}
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 			interfaceContext.playhead.start();
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.stop = function() {
nicholas@2224: 		// Send stop and reset command to all playback buffers
nicholas@2224: 		if (this.status == 1) {
nicholas@2224:             var setTime = audioContext.currentTime+0.1;
nicholas@2224: 			for (var i=0; i<this.audioObjects.length; i++)
nicholas@2224: 			{
nicholas@2224: 				this.audioObjects[i].stop(setTime);
nicholas@2224: 			}
nicholas@2224: 			interfaceContext.playhead.stop();
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.newTrack = function(element) {
nicholas@2224: 		// Pull data from given URL into new audio buffer
nicholas@2224: 		// URLs must either be from the same source OR be setup to 'Access-Control-Allow-Origin'
nicholas@2224: 		
nicholas@2224: 		// Create the audioObject with ID of the new track length;
nicholas@2224: 		audioObjectId = this.audioObjects.length;
nicholas@2224: 		this.audioObjects[audioObjectId] = new audioObject(audioObjectId);
nicholas@2224: 
nicholas@2224: 		// Check if audioObject buffer is currently stored by full URL
nicholas@2224: 		var URL = testState.currentStateMap.hostURL + element.url;
nicholas@2224: 		var buffer = null;
nicholas@2224: 		for (var i=0; i<this.buffers.length; i++)
nicholas@2224: 		{
nicholas@2224: 			if (URL == this.buffers[i].url)
nicholas@2224: 			{
nicholas@2224: 				buffer = this.buffers[i];
nicholas@2224: 				break;
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		if (buffer == null)
nicholas@2224: 		{
nicholas@2224: 			console.log("[WARN]: Buffer was not loaded in pre-test! "+URL);
nicholas@2224: 			buffer = new this.bufferObj();
nicholas@2224:             this.buffers.push(buffer);
nicholas@2224: 			buffer.getMedia(URL);
nicholas@2224: 		}
nicholas@2224: 		this.audioObjects[audioObjectId].specification = element;
nicholas@2224: 		this.audioObjects[audioObjectId].url = URL;
nicholas@2224: 		// Obtain store node
nicholas@2224: 		var aeNodes = this.pageStore.XMLDOM.getElementsByTagName('audioelement');
nicholas@2224: 		for (var i=0; i<aeNodes.length; i++)
nicholas@2224: 		{
nicholas@2224: 			if(aeNodes[i].getAttribute("ref") == element.id)
nicholas@2224: 			{
nicholas@2224: 				this.audioObjects[audioObjectId].storeDOM = aeNodes[i];
nicholas@2224: 				break;
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224:         buffer.registerAudioObject(this.audioObjects[audioObjectId]);
nicholas@2224: 		return this.audioObjects[audioObjectId];
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.newTestPage = function(audioHolderObject,store) {
nicholas@2224: 		this.pageStore = store;
nicholas@2224: 		this.status = 0;
nicholas@2224: 		this.audioObjectsReady = false;
nicholas@2224: 		this.metric.reset();
nicholas@2224: 		for (var i=0; i < this.buffers.length; i++)
nicholas@2224: 		{
nicholas@2224: 			this.buffers[i].users = [];
nicholas@2224: 		}
nicholas@2224: 		this.audioObjects = [];
nicholas@2224:         this.timer = new timer();
nicholas@2224:         this.loopPlayback = audioHolderObject.loop;
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.checkAllPlayed = function() {
nicholas@2224: 		arr = [];
nicholas@2224: 		for (var id=0; id<this.audioObjects.length; id++) {
nicholas@2224: 			if (this.audioObjects[id].metric.wasListenedTo == false) {
nicholas@2224: 				arr.push(this.audioObjects[id].id);
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		return arr;
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.checkAllReady = function() {
nicholas@2224: 		var ready = true;
nicholas@2224: 		for (var i=0; i<this.audioObjects.length; i++) {
nicholas@2224: 			if (this.audioObjects[i].state == 0) {
nicholas@2224: 				// Track not ready
nicholas@2224: 				console.log('WAIT -- audioObject '+i+' not ready yet!');
nicholas@2224: 				ready = false;
nicholas@2224: 			};
nicholas@2224: 		}
nicholas@2224: 		return ready;
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.setSynchronousLoop = function() {
nicholas@2224: 		// Pads the signals so they are all exactly the same length
nicholas@2224:         // Get the length of the longest signal.
nicholas@2224: 		var length = 0;
nicholas@2224: 		var maxId;
nicholas@2224: 		for (var i=0; i<this.audioObjects.length; i++)
nicholas@2224: 		{
nicholas@2224: 			if (length < this.audioObjects[i].buffer.buffer.length)
nicholas@2224: 			{
nicholas@2224: 				length = this.audioObjects[i].buffer.buffer.length;
nicholas@2224: 				maxId = i;
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		// Extract the audio and zero-pad
nicholas@2224: 		for (var ao of this.audioObjects)
nicholas@2224: 		{
nicholas@2224:             var lengthDiff = length - ao.buffer.buffer.length;
nicholas@2224: 			ao.buffer = ao.buffer.copyBuffer(0,samplesToSeconds(lengthDiff,ao.buffer.buffer.sampleRate));
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224:     this.exportXML = function()
nicholas@2224:     {
nicholas@2224:         
nicholas@2224:     };
nicholas@2224: 	
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function audioObject(id) {
nicholas@2224: 	// The main buffer object with common control nodes to the AudioEngine
nicholas@2224: 	
nicholas@2224: 	this.specification;
nicholas@2224: 	this.id = id;
nicholas@2224: 	this.state = 0; // 0 - no data, 1 - ready
nicholas@2224: 	this.url = null; // Hold the URL given for the output back to the results.
nicholas@2224: 	this.metric = new metricTracker(this);
nicholas@2224: 	this.storeDOM = null;
nicholas@2224: 	
nicholas@2224: 	// Bindings for GUI
nicholas@2224: 	this.interfaceDOM = null;
nicholas@2224: 	this.commentDOM = null;
nicholas@2224: 	
nicholas@2224: 	// Create a buffer and external gain control to allow internal patching of effects and volume leveling.
nicholas@2224: 	this.bufferNode = undefined;
nicholas@2224: 	this.outputGain = audioContext.createGain();
nicholas@2224: 	
nicholas@2224: 	this.onplayGain = 1.0;
nicholas@2224: 	
nicholas@2224: 	// Connect buffer to the audio graph
nicholas@2224: 	this.outputGain.connect(audioEngineContext.outputGain);
nicholas@2224: 	
nicholas@2224: 	// the audiobuffer is not designed for multi-start playback
nicholas@2224: 	// When stopeed, the buffer node is deleted and recreated with the stored buffer.
nicholas@2224: 	this.buffer;
nicholas@2224: 	
nicholas@2224: 	this.bufferLoaded = function(callee)
nicholas@2224: 	{
nicholas@2224: 		// Called by the associated buffer when it has finished loading, will then 'bind' the buffer to the
nicholas@2224: 		// audioObject and trigger the interfaceDOM.enable() function for user feedback
nicholas@2224:         if (callee.status == -1) {
nicholas@2224:             // ERROR
nicholas@2224:             this.state = -1;
nicholas@2224:             if (this.interfaceDOM != null) {this.interfaceDOM.error();}
nicholas@2224:             this.buffer = callee;
nicholas@2224:             return;
nicholas@2224:         }
nicholas@2224:         this.buffer = callee;
nicholas@2224:         var preSilenceTime = this.specification.preSilence || this.specification.parent.preSilence || specification.preSilence || 0.0;
nicholas@2224:         var postSilenceTime = this.specification.postSilence || this.specification.parent.postSilence || specification.postSilence || 0.0;
nicholas@2224:         if (preSilenceTime != 0 || postSilenceTime != 0) {
nicholas@2224:             this.buffer = callee.copyBuffer(preSilenceTime,postSilenceTime);    
nicholas@2224:         }
nicholas@2224: 		this.state = 1;
nicholas@2224: 		var targetLUFS = this.specification.parent.loudness || specification.loudness;
nicholas@2224: 		if (typeof targetLUFS === "number")
nicholas@2224: 		{
nicholas@2224: 			this.buffer.buffer.playbackGain = decibelToLinear(targetLUFS - this.buffer.buffer.lufs);
nicholas@2224: 		} else {
nicholas@2224: 			this.buffer.buffer.playbackGain = 1.0;
nicholas@2224: 		}
nicholas@2224: 		if (this.interfaceDOM != null) {
nicholas@2224: 			this.interfaceDOM.enable();
nicholas@2224: 		}
nicholas@2224: 		this.onplayGain = decibelToLinear(this.specification.gain)*this.buffer.buffer.playbackGain;
nicholas@2224: 		this.storeDOM.setAttribute('playGain',linearToDecibel(this.onplayGain));
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.bindInterface = function(interfaceObject)
nicholas@2224: 	{
nicholas@2224: 		this.interfaceDOM = interfaceObject;
nicholas@2224: 		this.metric.initialise(interfaceObject.getValue());
nicholas@2224: 		if (this.state == 1)
nicholas@2224: 		{
nicholas@2224: 			this.interfaceDOM.enable();
nicholas@2224: 		} else if (this.state == -1) {
nicholas@2224:             // ERROR
nicholas@2224:             this.interfaceDOM.error();
nicholas@2224:             return;
nicholas@2224:         }
nicholas@2224: 		this.storeDOM.setAttribute('presentedId',interfaceObject.getPresentedId());
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224: 	this.loopStart = function(setTime) {
nicholas@2224: 		this.outputGain.gain.linearRampToValueAtTime(this.onplayGain,setTime);
nicholas@2224: 		this.metric.startListening(audioEngineContext.timer.getTestTime());
nicholas@2224:         this.interfaceDOM.startPlayback();
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.loopStop = function(setTime) {
nicholas@2224: 		if (this.outputGain.gain.value != 0.0) {
nicholas@2224: 			this.outputGain.gain.linearRampToValueAtTime(0.0,setTime);
nicholas@2224: 			this.metric.stopListening(audioEngineContext.timer.getTestTime());
nicholas@2224: 		}
nicholas@2224:         this.interfaceDOM.stopPlayback();
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.play = function(startTime) {
nicholas@2224: 		if (this.bufferNode == undefined && this.buffer.buffer != undefined) {
nicholas@2224: 			this.bufferNode = audioContext.createBufferSource();
nicholas@2224: 			this.bufferNode.owner = this;
nicholas@2224: 			this.bufferNode.connect(this.outputGain);
nicholas@2224: 			this.bufferNode.buffer = this.buffer.buffer;
nicholas@2224: 			this.bufferNode.loop = audioEngineContext.loopPlayback;
nicholas@2224: 			this.bufferNode.onended = function(event) {
nicholas@2224: 				// Safari does not like using 'this' to reference the calling object!
nicholas@2224: 				//event.currentTarget.owner.metric.stopListening(audioEngineContext.timer.getTestTime(),event.currentTarget.owner.getCurrentPosition());
nicholas@2224:                 if (event.currentTarget != null) {
nicholas@2224: 				    event.currentTarget.owner.stop(audioContext.currentTime+1);
nicholas@2224:                 }
nicholas@2224: 			};
nicholas@2224: 			if (this.bufferNode.loop == false) {
nicholas@2224: 				this.metric.startListening(audioEngineContext.timer.getTestTime());
nicholas@2224:                 this.outputGain.gain.setValueAtTime(this.onplayGain,startTime);
nicholas@2224:                 this.interfaceDOM.startPlayback();
nicholas@2224: 			} else {
nicholas@2224:                  this.outputGain.gain.setValueAtTime(0.0,startTime);
nicholas@2224:             }
nicholas@2224: 			this.bufferNode.start(startTime);
nicholas@2224:             this.bufferNode.playbackStartTime = audioEngineContext.timer.getTestTime();
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.stop = function(stopTime) {
nicholas@2224:         this.outputGain.gain.cancelScheduledValues(audioContext.currentTime);
nicholas@2224: 		if (this.bufferNode != undefined)
nicholas@2224: 		{
nicholas@2224: 			this.metric.stopListening(audioEngineContext.timer.getTestTime(),this.getCurrentPosition());
nicholas@2224: 			this.bufferNode.stop(stopTime);
nicholas@2224: 			this.bufferNode = undefined;
nicholas@2224: 		}
nicholas@2224:         this.outputGain.gain.value = 0.0;
nicholas@2224:         this.interfaceDOM.stopPlayback();
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.getCurrentPosition = function() {
nicholas@2224: 		var time = audioEngineContext.timer.getTestTime();
nicholas@2224: 		if (this.bufferNode != undefined) {
nicholas@2224:             var position = (time - this.bufferNode.playbackStartTime)%this.buffer.buffer.duration;
nicholas@2224:             if (isNaN(position)){return 0;}
nicholas@2224:             return position;
nicholas@2224: 		} else {
nicholas@2224: 			return 0;
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.exportXMLDOM = function() {
nicholas@2224: 		var file = storage.document.createElement('file');
nicholas@2224: 		file.setAttribute('sampleRate',this.buffer.buffer.sampleRate);
nicholas@2224: 		file.setAttribute('channels',this.buffer.buffer.numberOfChannels);
nicholas@2224: 		file.setAttribute('sampleCount',this.buffer.buffer.length);
nicholas@2224: 		file.setAttribute('duration',this.buffer.buffer.duration);
nicholas@2224: 		this.storeDOM.appendChild(file);
nicholas@2224: 		if (this.specification.type != 'outside-reference') {
nicholas@2224: 			var interfaceXML = this.interfaceDOM.exportXMLDOM(this);
nicholas@2224: 			if (interfaceXML != null)
nicholas@2224: 			{
nicholas@2224: 				if (interfaceXML.length == undefined) {
nicholas@2224: 					this.storeDOM.appendChild(interfaceXML);
nicholas@2224: 				} else {
nicholas@2224: 					for (var i=0; i<interfaceXML.length; i++)
nicholas@2224: 					{
nicholas@2224: 						this.storeDOM.appendChild(interfaceXML[i]);
nicholas@2224: 					}
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 			if (this.commentDOM != null) {
nicholas@2224: 				this.storeDOM.appendChild(this.commentDOM.exportXMLDOM(this));
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		var nodes = this.metric.exportXMLDOM();
nicholas@2224: 		var mroot = this.storeDOM.getElementsByTagName('metric')[0];
nicholas@2224: 		for (var i=0; i<nodes.length; i++)
nicholas@2224: 		{
nicholas@2224: 			mroot.appendChild(nodes[i]);
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function timer()
nicholas@2224: {
nicholas@2224: 	/* Timer object used in audioEngine to keep track of session timings
nicholas@2224: 	 * Uses the timer of the web audio API, so sample resolution
nicholas@2224: 	 */
nicholas@2224: 	this.testStarted = false;
nicholas@2224: 	this.testStartTime = 0;
nicholas@2224: 	this.testDuration = 0;
nicholas@2224: 	this.minimumTestTime = 0; // No minimum test time
nicholas@2224: 	this.startTest = function()
nicholas@2224: 	{
nicholas@2224: 		if (this.testStarted == false)
nicholas@2224: 		{
nicholas@2224: 			this.testStartTime = audioContext.currentTime;
nicholas@2224: 			this.testStarted = true;
nicholas@2224: 			this.updateTestTime();
nicholas@2224: 			audioEngineContext.metric.initialiseTest();
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	this.stopTest = function()
nicholas@2224: 	{
nicholas@2224: 		if (this.testStarted)
nicholas@2224: 		{
nicholas@2224: 			this.testDuration = this.getTestTime();
nicholas@2224: 			this.testStarted = false;
nicholas@2224: 		} else {
nicholas@2224: 			console.log('ERR: Test tried to end before beginning');
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	this.updateTestTime = function()
nicholas@2224: 	{
nicholas@2224: 		if (this.testStarted)
nicholas@2224: 		{
nicholas@2224: 			this.testDuration = audioContext.currentTime - this.testStartTime;
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	this.getTestTime = function()
nicholas@2224: 	{
nicholas@2224: 		this.updateTestTime();
nicholas@2224: 		return this.testDuration;
nicholas@2224: 	};
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function sessionMetrics(engine,specification)
nicholas@2224: {
nicholas@2224: 	/* Used by audioEngine to link to audioObjects to minimise the timer call timers;
nicholas@2224: 	 */
nicholas@2224: 	this.engine = engine;
nicholas@2224: 	this.lastClicked = -1;
nicholas@2224: 	this.data = -1;
nicholas@2224: 	this.reset = function() {
nicholas@2224: 		this.lastClicked = -1;
nicholas@2224: 		this.data = -1;
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.enableElementInitialPosition = false;
nicholas@2224: 	this.enableElementListenTracker = false;
nicholas@2224: 	this.enableElementTimer = false;
nicholas@2224: 	this.enableElementTracker = false;
nicholas@2224: 	this.enableFlagListenedTo = false;
nicholas@2224: 	this.enableFlagMoved = false;
nicholas@2224: 	this.enableTestTimer = false;
nicholas@2224: 	// Obtain the metrics enabled
nicholas@2224: 	for (var i=0; i<specification.metrics.enabled.length; i++)
nicholas@2224: 	{
nicholas@2224: 		var node = specification.metrics.enabled[i];
nicholas@2224: 		switch(node)
nicholas@2224: 		{
nicholas@2224: 		case 'testTimer':
nicholas@2224: 			this.enableTestTimer = true;
nicholas@2224: 			break;
nicholas@2224: 		case 'elementTimer':
nicholas@2224: 			this.enableElementTimer = true;
nicholas@2224: 			break;
nicholas@2224: 		case 'elementTracker':
nicholas@2224: 			this.enableElementTracker = true;
nicholas@2224: 			break;
nicholas@2224: 		case 'elementListenTracker':
nicholas@2224: 			this.enableElementListenTracker = true;
nicholas@2224: 			break;
nicholas@2224: 		case 'elementInitialPosition':
nicholas@2224: 			this.enableElementInitialPosition = true;
nicholas@2224: 			break;
nicholas@2224: 		case 'elementFlagListenedTo':
nicholas@2224: 			this.enableFlagListenedTo = true;
nicholas@2224: 			break;
nicholas@2224: 		case 'elementFlagMoved':
nicholas@2224: 			this.enableFlagMoved = true;
nicholas@2224: 			break;
nicholas@2224: 		case 'elementFlagComments':
nicholas@2224: 			this.enableFlagComments = true;
nicholas@2224: 			break;
nicholas@2224: 		}
nicholas@2224: 	}
nicholas@2224: 	this.initialiseTest = function(){};
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function metricTracker(caller)
nicholas@2224: {
nicholas@2224: 	/* Custom object to track and collect metric data
nicholas@2224: 	 * Used only inside the audioObjects object.
nicholas@2224: 	 */
nicholas@2224: 	
nicholas@2224: 	this.listenedTimer = 0;
nicholas@2224: 	this.listenStart = 0;
nicholas@2224: 	this.listenHold = false;
nicholas@2224: 	this.initialPosition = -1;
nicholas@2224: 	this.movementTracker = [];
nicholas@2224: 	this.listenTracker =[];
nicholas@2224: 	this.wasListenedTo = false;
nicholas@2224: 	this.wasMoved = false;
nicholas@2224: 	this.hasComments = false;
nicholas@2224: 	this.parent = caller;
nicholas@2224: 	
nicholas@2224: 	this.initialise = function(position)
nicholas@2224: 	{
nicholas@2224: 		if (this.initialPosition == -1) {
nicholas@2224: 			this.initialPosition = position;
nicholas@2224: 			this.moved(0,position);
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.moved = function(time,position)
nicholas@2224: 	{
nicholas@2224: 		if (time > 0) {this.wasMoved = true;}
nicholas@2224: 		this.movementTracker[this.movementTracker.length] = [time, position];
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.startListening = function(time)
nicholas@2224: 	{
nicholas@2224: 		if (this.listenHold == false)
nicholas@2224: 		{
nicholas@2224: 			this.wasListenedTo = true;
nicholas@2224: 			this.listenStart = time;
nicholas@2224: 			this.listenHold = true;
nicholas@2224: 			
nicholas@2224: 			var evnt = document.createElement('event');
nicholas@2224: 			var testTime = document.createElement('testTime');
nicholas@2224: 			testTime.setAttribute('start',time);
nicholas@2224: 			var bufferTime = document.createElement('bufferTime');
nicholas@2224: 			bufferTime.setAttribute('start',this.parent.getCurrentPosition());
nicholas@2224: 			evnt.appendChild(testTime);
nicholas@2224: 			evnt.appendChild(bufferTime);
nicholas@2224: 			this.listenTracker.push(evnt);
nicholas@2224: 			
nicholas@2224: 			console.log('slider ' + this.parent.id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.stopListening = function(time,bufferStopTime)
nicholas@2224: 	{
nicholas@2224: 		if (this.listenHold == true)
nicholas@2224: 		{
nicholas@2224: 			var diff = time - this.listenStart;
nicholas@2224: 			this.listenedTimer += (diff);
nicholas@2224: 			this.listenStart = 0;
nicholas@2224: 			this.listenHold = false;
nicholas@2224: 			
nicholas@2224: 			var evnt = this.listenTracker[this.listenTracker.length-1];
nicholas@2224: 			var testTime = evnt.getElementsByTagName('testTime')[0];
nicholas@2224: 			var bufferTime = evnt.getElementsByTagName('bufferTime')[0];
nicholas@2224: 			testTime.setAttribute('stop',time);
nicholas@2224: 			if (bufferStopTime == undefined) {
nicholas@2224: 				bufferTime.setAttribute('stop',this.parent.getCurrentPosition());
nicholas@2224: 			} else {
nicholas@2224: 				bufferTime.setAttribute('stop',bufferStopTime);
nicholas@2224: 			}
nicholas@2224: 			console.log('slider ' + this.parent.id + ' played for (' + diff + ')'); // DEBUG/SAFETY: show played slider id
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.exportXMLDOM = function() {
nicholas@2224: 		var storeDOM = [];
nicholas@2224: 		if (audioEngineContext.metric.enableElementTimer) {
nicholas@2224: 			var mElementTimer = storage.document.createElement('metricresult');
nicholas@2224: 			mElementTimer.setAttribute('name','enableElementTimer');
nicholas@2224: 			mElementTimer.textContent = this.listenedTimer;
nicholas@2224: 			storeDOM.push(mElementTimer);
nicholas@2224: 		}
nicholas@2224: 		if (audioEngineContext.metric.enableElementTracker) {
b@2281: 			var elementTrackerFull = storage.document.createElement('metricresult');
nicholas@2224: 			elementTrackerFull.setAttribute('name','elementTrackerFull');
nicholas@2224: 			for (var k=0; k<this.movementTracker.length; k++)
nicholas@2224: 			{
nicholas@2224: 				var timePos = storage.document.createElement('movement');
nicholas@2224:                 timePos.setAttribute("time",this.movementTracker[k][0]);
nicholas@2224:                 timePos.setAttribute("value",this.movementTracker[k][1]);
nicholas@2224: 				elementTrackerFull.appendChild(timePos);
nicholas@2224: 			}
nicholas@2224: 			storeDOM.push(elementTrackerFull);
nicholas@2224: 		}
nicholas@2224: 		if (audioEngineContext.metric.enableElementListenTracker) {
b@2281: 			var elementListenTracker = storage.document.createElement('metricresult');
nicholas@2224: 			elementListenTracker.setAttribute('name','elementListenTracker');
nicholas@2224: 			for (var k=0; k<this.listenTracker.length; k++) {
nicholas@2224: 				elementListenTracker.appendChild(this.listenTracker[k]);
nicholas@2224: 			}
nicholas@2224: 			storeDOM.push(elementListenTracker);
nicholas@2224: 		}
nicholas@2224: 		if (audioEngineContext.metric.enableElementInitialPosition) {
b@2281: 			var elementInitial = storage.document.createElement('metricresult');
nicholas@2224: 			elementInitial.setAttribute('name','elementInitialPosition');
nicholas@2224: 			elementInitial.textContent = this.initialPosition;
nicholas@2224: 			storeDOM.push(elementInitial);
nicholas@2224: 		}
nicholas@2224: 		if (audioEngineContext.metric.enableFlagListenedTo) {
b@2281: 			var flagListenedTo = storage.document.createElement('metricresult');
nicholas@2224: 			flagListenedTo.setAttribute('name','elementFlagListenedTo');
nicholas@2224: 			flagListenedTo.textContent = this.wasListenedTo;
nicholas@2224: 			storeDOM.push(flagListenedTo);
nicholas@2224: 		}
nicholas@2224: 		if (audioEngineContext.metric.enableFlagMoved) {
b@2281: 			var flagMoved = storage.document.createElement('metricresult');
nicholas@2224: 			flagMoved.setAttribute('name','elementFlagMoved');
nicholas@2224: 			flagMoved.textContent = this.wasMoved;
nicholas@2224: 			storeDOM.push(flagMoved);
nicholas@2224: 		}
nicholas@2224: 		if (audioEngineContext.metric.enableFlagComments) {
b@2281: 			var flagComments = storage.document.createElement('metricresult');
nicholas@2224: 			flagComments.setAttribute('name','elementFlagComments');
nicholas@2224: 			if (this.parent.commentDOM == null)
nicholas@2224: 				{flag.textContent = 'false';}
nicholas@2224: 			else if (this.parent.commentDOM.textContent.length == 0) 
nicholas@2224: 				{flag.textContent = 'false';}
nicholas@2224: 			else 
nicholas@2224: 				{flag.textContet = 'true';}
nicholas@2224: 			storeDOM.push(flagComments);
nicholas@2224: 		}
nicholas@2224: 		return storeDOM;
nicholas@2224: 	};
nicholas@2224: }
nicholas@2224: 			
nicholas@2224: function Interface(specificationObject) {
nicholas@2224: 	// This handles the bindings between the interface and the audioEngineContext;
nicholas@2224: 	this.specification = specificationObject;
nicholas@2224: 	this.insertPoint = document.getElementById("topLevelBody");
nicholas@2224: 	
nicholas@2224: 	this.newPage = function(audioHolderObject,store)
nicholas@2224: 	{
nicholas@2224: 		audioEngineContext.newTestPage(audioHolderObject,store);
nicholas@2224: 		interfaceContext.commentBoxes.deleteCommentBoxes();
nicholas@2224: 		interfaceContext.deleteCommentQuestions();
nicholas@2224: 		loadTest(audioHolderObject,store);
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	// Bounded by interface!!
nicholas@2224: 	// Interface object MUST have an exportXMLDOM method which returns the various DOM levels
nicholas@2224: 	// For example, APE returns  the slider position normalised in a <value> tag.
nicholas@2224: 	this.interfaceObjects = [];
nicholas@2224: 	this.interfaceObject = function(){};
nicholas@2224: 	
nicholas@2224: 	this.resizeWindow = function(event)
nicholas@2224: 	{
nicholas@2224: 		popup.resize(event);
nicholas@2224: 		for(var i=0; i<this.commentBoxes.length; i++)
nicholas@2224: 		{this.commentBoxes[i].resize();}
nicholas@2224: 		for(var i=0; i<this.commentQuestions.length; i++)
nicholas@2224: 		{this.commentQuestions[i].resize();}
nicholas@2224: 		try
nicholas@2224: 		{
nicholas@2224: 			resizeWindow(event);
nicholas@2224: 		}
nicholas@2224: 		catch(err)
nicholas@2224: 		{
nicholas@2224: 			console.log("Warning - Interface does not have Resize option");
nicholas@2224: 			console.log(err);
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.returnNavigator = function()
nicholas@2224: 	{
nicholas@2224: 		var node = storage.document.createElement("navigator");
nicholas@2224: 		var platform = storage.document.createElement("platform");
nicholas@2224: 		platform.textContent = navigator.platform;
nicholas@2224: 		var vendor = storage.document.createElement("vendor");
nicholas@2224: 		vendor.textContent = navigator.vendor;
nicholas@2224: 		var userAgent = storage.document.createElement("uagent");
nicholas@2224: 		userAgent.textContent = navigator.userAgent;
nicholas@2224:         var screen = storage.document.createElement("window");
nicholas@2224:         screen.setAttribute('innerWidth',window.innerWidth);
nicholas@2224:         screen.setAttribute('innerHeight',window.innerHeight);
nicholas@2224: 		node.appendChild(platform);
nicholas@2224: 		node.appendChild(vendor);
nicholas@2224: 		node.appendChild(userAgent);
nicholas@2224:         node.appendChild(screen);
nicholas@2224: 		return node;
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224:     this.returnDateNode = function()
nicholas@2224:     {
nicholas@2224:         // Create an XML Node for the Date and Time a test was conducted
nicholas@2224:         // Structure is
nicholas@2224:         // <datetime> 
nicholas@2224:         //	<date year="##" month="##" day="##">DD/MM/YY</date>
nicholas@2224:         //	<time hour="##" minute="##" sec="##">HH:MM:SS</time>
nicholas@2224:         // </datetime>
nicholas@2224:         var dateTime = new Date();
nicholas@2224:         var hold = storage.document.createElement("datetime");
nicholas@2224:         var date = storage.document.createElement("date");
nicholas@2224:         var time = storage.document.createElement("time");
nicholas@2224:         date.setAttribute('year',dateTime.getFullYear());
nicholas@2224:         date.setAttribute('month',dateTime.getMonth()+1);
nicholas@2224:         date.setAttribute('day',dateTime.getDate());
nicholas@2224:         time.setAttribute('hour',dateTime.getHours());
nicholas@2224:         time.setAttribute('minute',dateTime.getMinutes());
nicholas@2224:         time.setAttribute('secs',dateTime.getSeconds());
nicholas@2224:         
nicholas@2224:         hold.appendChild(date);
nicholas@2224:         hold.appendChild(time);
nicholas@2224:         return hold;
nicholas@2224: 
nicholas@2224:     }
nicholas@2224: 	
nicholas@2224: 	this.commentBoxes = new function() {
nicholas@2224:         this.boxes = [];
nicholas@2224:         this.injectPoint = null;
nicholas@2224:         this.elementCommentBox = function(audioObject) {
nicholas@2224:             var element = audioObject.specification;
nicholas@2224:             this.audioObject = audioObject;
nicholas@2224:             this.id = audioObject.id;
nicholas@2224:             var audioHolderObject = audioObject.specification.parent;
nicholas@2224:             // Create document objects to hold the comment boxes
nicholas@2224:             this.trackComment = document.createElement('div');
nicholas@2224:             this.trackComment.className = 'comment-div';
nicholas@2224:             this.trackComment.id = 'comment-div-'+audioObject.id;
nicholas@2224:             // Create a string next to each comment asking for a comment
nicholas@2224:             this.trackString = document.createElement('span');
nicholas@2224:             this.trackString.innerHTML = audioHolderObject.commentBoxPrefix+' '+audioObject.interfaceDOM.getPresentedId();
nicholas@2224:             // Create the HTML5 comment box 'textarea'
nicholas@2224:             this.trackCommentBox = document.createElement('textarea');
nicholas@2224:             this.trackCommentBox.rows = '4';
nicholas@2224:             this.trackCommentBox.cols = '100';
nicholas@2224:             this.trackCommentBox.name = 'trackComment'+audioObject.id;
nicholas@2224:             this.trackCommentBox.className = 'trackComment';
nicholas@2224:             var br = document.createElement('br');
nicholas@2224:             // Add to the holder.
nicholas@2224:             this.trackComment.appendChild(this.trackString);
nicholas@2224:             this.trackComment.appendChild(br);
nicholas@2224:             this.trackComment.appendChild(this.trackCommentBox);
nicholas@2224: 
nicholas@2224:             this.exportXMLDOM = function() {
nicholas@2224:                 var root = document.createElement('comment');
nicholas@2224:                 var question = document.createElement('question');
nicholas@2224:                 question.textContent = this.trackString.textContent;
nicholas@2224:                 var response = document.createElement('response');
nicholas@2224:                 response.textContent = this.trackCommentBox.value;
nicholas@2224:                 console.log("Comment frag-"+this.id+": "+response.textContent);
nicholas@2224:                 root.appendChild(question);
nicholas@2224:                 root.appendChild(response);
nicholas@2224:                 return root;
nicholas@2224:             };
nicholas@2224:             this.resize = function()
nicholas@2224:             {
nicholas@2224:                 var boxwidth = (window.innerWidth-100)/2;
nicholas@2224:                 if (boxwidth >= 600)
nicholas@2224:                 {
nicholas@2224:                     boxwidth = 600;
nicholas@2224:                 }
nicholas@2224:                 else if (boxwidth < 400)
nicholas@2224:                 {
nicholas@2224:                     boxwidth = 400;
nicholas@2224:                 }
nicholas@2224:                 this.trackComment.style.width = boxwidth+"px";
nicholas@2224:                 this.trackCommentBox.style.width = boxwidth-6+"px";
nicholas@2224:             };
nicholas@2224:             this.resize();
nicholas@2224:         };
nicholas@2224:         this.createCommentBox = function(audioObject) {
nicholas@2224:             var node = new this.elementCommentBox(audioObject);
nicholas@2224:             this.boxes.push(node);
nicholas@2224:             audioObject.commentDOM = node;
nicholas@2224:             return node;
nicholas@2224:         };
nicholas@2224:         this.sortCommentBoxes = function() {
nicholas@2224:             this.boxes.sort(function(a,b){return a.id - b.id;});
nicholas@2224:         };
nicholas@2224: 
nicholas@2224:         this.showCommentBoxes = function(inject, sort) {
nicholas@2224:             this.injectPoint = inject;
nicholas@2224:             if (sort) {this.sortCommentBoxes();}
nicholas@2224:             for (var box of this.boxes) {
nicholas@2224:                 inject.appendChild(box.trackComment);
nicholas@2224:             }
nicholas@2224:         };
nicholas@2224: 
nicholas@2224:         this.deleteCommentBoxes = function() {
nicholas@2224:             if (this.injectPoint != null) {
nicholas@2224:                 for (var box of this.boxes) {
nicholas@2224:                     this.injectPoint.removeChild(box.trackComment);
nicholas@2224:                 }
nicholas@2224:                 this.injectPoint = null;
nicholas@2224:             }
nicholas@2224:             this.boxes = [];
nicholas@2224:         };
nicholas@2224:     }
nicholas@2224: 	
nicholas@2224: 	this.commentQuestions = [];
nicholas@2224: 	
nicholas@2224: 	this.commentBox = function(commentQuestion) {
nicholas@2224: 		this.specification = commentQuestion;
nicholas@2224: 		// Create document objects to hold the comment boxes
nicholas@2224: 		this.holder = document.createElement('div');
nicholas@2224: 		this.holder.className = 'comment-div';
nicholas@2224: 		// Create a string next to each comment asking for a comment
nicholas@2224: 		this.string = document.createElement('span');
nicholas@2224: 		this.string.innerHTML = commentQuestion.statement;
nicholas@2224: 		// Create the HTML5 comment box 'textarea'
nicholas@2224: 		this.textArea = document.createElement('textarea');
nicholas@2224: 		this.textArea.rows = '4';
nicholas@2224: 		this.textArea.cols = '100';
nicholas@2224: 		this.textArea.className = 'trackComment';
nicholas@2224: 		var br = document.createElement('br');
nicholas@2224: 		// Add to the holder.
nicholas@2224: 		this.holder.appendChild(this.string);
nicholas@2224: 		this.holder.appendChild(br);
nicholas@2224: 		this.holder.appendChild(this.textArea);
nicholas@2224: 		
nicholas@2224: 		this.exportXMLDOM = function(storePoint) {
nicholas@2224: 			var root = storePoint.parent.document.createElement('comment');
nicholas@2224: 			root.id = this.specification.id;
nicholas@2224: 			root.setAttribute('type',this.specification.type);
nicholas@2224: 			console.log("Question: "+this.string.textContent);
nicholas@2224: 			console.log("Response: "+root.textContent);
nicholas@2224:             var question = storePoint.parent.document.createElement('question');
nicholas@2224:             question.textContent = this.string.textContent;
nicholas@2224:             var response = storePoint.parent.document.createElement('response');
nicholas@2224:             response.textContent = this.textArea.value;
nicholas@2224:             root.appendChild(question);
nicholas@2224:             root.appendChild(response);
nicholas@2224:             storePoint.XMLDOM.appendChild(root);
nicholas@2224: 			return root;
nicholas@2224: 		};
nicholas@2224: 		this.resize = function()
nicholas@2224: 		{
nicholas@2224: 			var boxwidth = (window.innerWidth-100)/2;
nicholas@2224: 			if (boxwidth >= 600)
nicholas@2224: 			{
nicholas@2224: 				boxwidth = 600;
nicholas@2224: 			}
nicholas@2224: 			else if (boxwidth < 400)
nicholas@2224: 			{
nicholas@2224: 				boxwidth = 400;
nicholas@2224: 			}
nicholas@2224: 			this.holder.style.width = boxwidth+"px";
nicholas@2224: 			this.textArea.style.width = boxwidth-6+"px";
nicholas@2224: 		};
nicholas@2224: 		this.resize();
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.radioBox = function(commentQuestion) {
nicholas@2224: 		this.specification = commentQuestion;
nicholas@2224: 		// Create document objects to hold the comment boxes
nicholas@2224: 		this.holder = document.createElement('div');
nicholas@2224: 		this.holder.className = 'comment-div';
nicholas@2224: 		// Create a string next to each comment asking for a comment
nicholas@2224: 		this.string = document.createElement('span');
nicholas@2224: 		this.string.innerHTML = commentQuestion.statement;
nicholas@2224: 		var br = document.createElement('br');
nicholas@2224: 		// Add to the holder.
nicholas@2224: 		this.holder.appendChild(this.string);
nicholas@2224: 		this.holder.appendChild(br);
nicholas@2224: 		this.options = [];
nicholas@2224: 		this.inputs = document.createElement('div');
nicholas@2224: 		this.span = document.createElement('div');
nicholas@2224: 		this.inputs.align = 'center';
nicholas@2224: 		this.inputs.style.marginLeft = '12px';
nicholas@2224: 		this.span.style.marginLeft = '12px';
nicholas@2224: 		this.span.align = 'center';
nicholas@2224: 		this.span.style.marginTop = '15px';
nicholas@2224: 		
nicholas@2224: 		var optCount = commentQuestion.options.length;
nicholas@2224: 		for (var optNode of commentQuestion.options)
nicholas@2224: 		{
nicholas@2224: 			var div = document.createElement('div');
nicholas@2224: 			div.style.width = '80px';
nicholas@2224: 			div.style.float = 'left';
nicholas@2224: 			var input = document.createElement('input');
nicholas@2224: 			input.type = 'radio';
nicholas@2224: 			input.name = commentQuestion.id;
nicholas@2224: 			input.setAttribute('setvalue',optNode.name);
nicholas@2224: 			input.className = 'comment-radio';
nicholas@2224: 			div.appendChild(input);
nicholas@2224: 			this.inputs.appendChild(div);
nicholas@2224: 			
nicholas@2224: 			
nicholas@2224: 			div = document.createElement('div');
nicholas@2224: 			div.style.width = '80px';
nicholas@2224: 			div.style.float = 'left';
nicholas@2224: 			div.align = 'center';
nicholas@2224: 			var span = document.createElement('span');
nicholas@2224: 			span.textContent = optNode.text;
nicholas@2224: 			span.className = 'comment-radio-span';
nicholas@2224: 			div.appendChild(span);
nicholas@2224: 			this.span.appendChild(div);
nicholas@2224: 			this.options.push(input);
nicholas@2224: 		}
nicholas@2224: 		this.holder.appendChild(this.span);
nicholas@2224: 		this.holder.appendChild(this.inputs);
nicholas@2224: 		
nicholas@2224: 		this.exportXMLDOM = function(storePoint) {
nicholas@2224: 			var root = storePoint.parent.document.createElement('comment');
nicholas@2224: 			root.id = this.specification.id;
nicholas@2224: 			root.setAttribute('type',this.specification.type);
nicholas@2224: 			var question = document.createElement('question');
nicholas@2224: 			question.textContent = this.string.textContent;
nicholas@2224: 			var response = document.createElement('response');
nicholas@2224: 			var i=0;
nicholas@2224: 			while(this.options[i].checked == false) {
nicholas@2224: 				i++;
nicholas@2224: 				if (i >= this.options.length) {
nicholas@2224: 					break;
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 			if (i >= this.options.length) {
nicholas@2224: 				response.textContent = 'null';
nicholas@2224: 			} else {
nicholas@2224: 				response.textContent = this.options[i].getAttribute('setvalue');
nicholas@2224: 				response.setAttribute('number',i);
nicholas@2224: 			}
nicholas@2224: 			console.log('Comment: '+question.textContent);
nicholas@2224: 			console.log('Response: '+response.textContent);
nicholas@2224: 			root.appendChild(question);
nicholas@2224: 			root.appendChild(response);
nicholas@2224:             storePoint.XMLDOM.appendChild(root);
nicholas@2224: 			return root;
nicholas@2224: 		};
nicholas@2224: 		this.resize = function()
nicholas@2224: 		{
nicholas@2224: 			var boxwidth = (window.innerWidth-100)/2;
nicholas@2224: 			if (boxwidth >= 600)
nicholas@2224: 			{
nicholas@2224: 				boxwidth = 600;
nicholas@2224: 			}
nicholas@2224: 			else if (boxwidth < 400)
nicholas@2224: 			{
nicholas@2224: 				boxwidth = 400;
nicholas@2224: 			}
nicholas@2224: 			this.holder.style.width = boxwidth+"px";
nicholas@2224: 			var text = this.holder.children[2];
nicholas@2224: 			var options = this.holder.children[3];
nicholas@2224: 			var optCount = options.children.length;
nicholas@2224: 			var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nicholas@2224: 			var options = options.firstChild;
nicholas@2224: 			var text = text.firstChild;
nicholas@2224: 			options.style.marginRight = spanMargin;
nicholas@2224: 			options.style.marginLeft = spanMargin;
nicholas@2224: 			text.style.marginRight = spanMargin;
nicholas@2224: 			text.style.marginLeft = spanMargin;
nicholas@2224: 			while(options.nextSibling != undefined)
nicholas@2224: 			{
nicholas@2224: 				options = options.nextSibling;
nicholas@2224: 				text = text.nextSibling;
nicholas@2224: 				options.style.marginRight = spanMargin;
nicholas@2224: 				options.style.marginLeft = spanMargin;
nicholas@2224: 				text.style.marginRight = spanMargin;
nicholas@2224: 				text.style.marginLeft = spanMargin;
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224: 		this.resize();
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.checkboxBox = function(commentQuestion) {
nicholas@2224: 		this.specification = commentQuestion;
nicholas@2224: 		// Create document objects to hold the comment boxes
nicholas@2224: 		this.holder = document.createElement('div');
nicholas@2224: 		this.holder.className = 'comment-div';
nicholas@2224: 		// Create a string next to each comment asking for a comment
nicholas@2224: 		this.string = document.createElement('span');
nicholas@2224: 		this.string.innerHTML = commentQuestion.statement;
nicholas@2224: 		var br = document.createElement('br');
nicholas@2224: 		// Add to the holder.
nicholas@2224: 		this.holder.appendChild(this.string);
nicholas@2224: 		this.holder.appendChild(br);
nicholas@2224: 		this.options = [];
nicholas@2224: 		this.inputs = document.createElement('div');
nicholas@2224: 		this.span = document.createElement('div');
nicholas@2224: 		this.inputs.align = 'center';
nicholas@2224: 		this.inputs.style.marginLeft = '12px';
nicholas@2224: 		this.span.style.marginLeft = '12px';
nicholas@2224: 		this.span.align = 'center';
nicholas@2224: 		this.span.style.marginTop = '15px';
nicholas@2224: 		
nicholas@2224: 		var optCount = commentQuestion.options.length;
nicholas@2224: 		for (var i=0; i<optCount; i++)
nicholas@2224: 		{
nicholas@2224: 			var div = document.createElement('div');
nicholas@2224: 			div.style.width = '80px';
nicholas@2224: 			div.style.float = 'left';
nicholas@2224: 			var input = document.createElement('input');
nicholas@2224: 			input.type = 'checkbox';
nicholas@2224: 			input.name = commentQuestion.id;
nicholas@2224: 			input.setAttribute('setvalue',commentQuestion.options[i].name);
nicholas@2224: 			input.className = 'comment-radio';
nicholas@2224: 			div.appendChild(input);
nicholas@2224: 			this.inputs.appendChild(div);
nicholas@2224: 			
nicholas@2224: 			
nicholas@2224: 			div = document.createElement('div');
nicholas@2224: 			div.style.width = '80px';
nicholas@2224: 			div.style.float = 'left';
nicholas@2224: 			div.align = 'center';
nicholas@2224: 			var span = document.createElement('span');
nicholas@2224: 			span.textContent = commentQuestion.options[i].text;
nicholas@2224: 			span.className = 'comment-radio-span';
nicholas@2224: 			div.appendChild(span);
nicholas@2224: 			this.span.appendChild(div);
nicholas@2224: 			this.options.push(input);
nicholas@2224: 		}
nicholas@2224: 		this.holder.appendChild(this.span);
nicholas@2224: 		this.holder.appendChild(this.inputs);
nicholas@2224: 		
nicholas@2224: 		this.exportXMLDOM = function(storePoint) {
nicholas@2224: 			var root = storePoint.parent.document.createElement('comment');
nicholas@2224: 			root.id = this.specification.id;
nicholas@2224: 			root.setAttribute('type',this.specification.type);
nicholas@2224: 			var question = document.createElement('question');
nicholas@2224: 			question.textContent = this.string.textContent;
nicholas@2224: 			root.appendChild(question);
nicholas@2224: 			console.log('Comment: '+question.textContent);
nicholas@2224: 			for (var i=0; i<this.options.length; i++) {
nicholas@2224: 				var response = document.createElement('response');
nicholas@2224: 				response.textContent = this.options[i].checked;
nicholas@2224: 				response.setAttribute('name',this.options[i].getAttribute('setvalue'));
nicholas@2224: 				root.appendChild(response);
nicholas@2224: 				console.log('Response '+response.getAttribute('name') +': '+response.textContent);
nicholas@2224: 			}
nicholas@2224:             storePoint.XMLDOM.appendChild(root);
nicholas@2224: 			return root;
nicholas@2224: 		};
nicholas@2224: 		this.resize = function()
nicholas@2224: 		{
nicholas@2224: 			var boxwidth = (window.innerWidth-100)/2;
nicholas@2224: 			if (boxwidth >= 600)
nicholas@2224: 			{
nicholas@2224: 				boxwidth = 600;
nicholas@2224: 			}
nicholas@2224: 			else if (boxwidth < 400)
nicholas@2224: 			{
nicholas@2224: 				boxwidth = 400;
nicholas@2224: 			}
nicholas@2224: 			this.holder.style.width = boxwidth+"px";
nicholas@2224: 			var text = this.holder.children[2];
nicholas@2224: 			var options = this.holder.children[3];
nicholas@2224: 			var optCount = options.children.length;
nicholas@2224: 			var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nicholas@2224: 			var options = options.firstChild;
nicholas@2224: 			var text = text.firstChild;
nicholas@2224: 			options.style.marginRight = spanMargin;
nicholas@2224: 			options.style.marginLeft = spanMargin;
nicholas@2224: 			text.style.marginRight = spanMargin;
nicholas@2224: 			text.style.marginLeft = spanMargin;
nicholas@2224: 			while(options.nextSibling != undefined)
nicholas@2224: 			{
nicholas@2224: 				options = options.nextSibling;
nicholas@2224: 				text = text.nextSibling;
nicholas@2224: 				options.style.marginRight = spanMargin;
nicholas@2224: 				options.style.marginLeft = spanMargin;
nicholas@2224: 				text.style.marginRight = spanMargin;
nicholas@2224: 				text.style.marginLeft = spanMargin;
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224: 		this.resize();
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.createCommentQuestion = function(element) {
nicholas@2224: 		var node;
nicholas@2224: 		if (element.type == 'question') {
nicholas@2224: 			node = new this.commentBox(element);
nicholas@2224: 		} else if (element.type == 'radio') {
nicholas@2224: 			node = new this.radioBox(element);
nicholas@2224: 		} else if (element.type == 'checkbox') {
nicholas@2224: 			node = new this.checkboxBox(element);
nicholas@2224: 		}
nicholas@2224: 		this.commentQuestions.push(node);
nicholas@2224: 		return node;
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.deleteCommentQuestions = function()
nicholas@2224: 	{
nicholas@2224: 		this.commentQuestions = [];
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224:     this.outsideReferenceDOM = function(audioObject,index,inject)
nicholas@2224:     {
nicholas@2224:         this.parent = audioObject;
nicholas@2224:         this.outsideReferenceHolder = document.createElement('button');
nicholas@2224:         this.outsideReferenceHolder.id = 'outside-reference';
nicholas@2224:         this.outsideReferenceHolder.className = 'outside-reference';
nicholas@2224:         this.outsideReferenceHolder.setAttribute('track-id',index);
nicholas@2224:         this.outsideReferenceHolder.textContent = "Play Reference";
nicholas@2224:         this.outsideReferenceHolder.disabled = true;
nicholas@2224: 
nicholas@2224:         this.outsideReferenceHolder.onclick = function(event)
nicholas@2224:         {
nicholas@2224:             audioEngineContext.play(event.currentTarget.getAttribute('track-id'));
nicholas@2224:         };
nicholas@2224:         inject.appendChild(this.outsideReferenceHolder);
nicholas@2224:         this.enable = function()
nicholas@2224:         {
nicholas@2224:             if (this.parent.state == 1)
nicholas@2224:             {
nicholas@2224:                 this.outsideReferenceHolder.disabled = false;
nicholas@2224:             }
nicholas@2224:         };
nicholas@2224:         this.updateLoading = function(progress)
nicholas@2224:         {
nicholas@2224:             if (progress != 100)
nicholas@2224:             {
nicholas@2224:                 progress = String(progress);
nicholas@2224:                 progress = progress.split('.')[0];
nicholas@2224:                 this.outsideReferenceHolder.textContent = progress+'%';
nicholas@2224:             } else {
nicholas@2224:                 this.outsideReferenceHolder.textContent = "Play Reference";
nicholas@2224:             }
nicholas@2224:         };
nicholas@2224:         this.startPlayback = function()
nicholas@2224:         {
nicholas@2224:             // Called when playback has begun
nicholas@2224:             $('.track-slider').removeClass('track-slider-playing');
nicholas@2224:             $('.comment-div').removeClass('comment-box-playing');
nicholas@2224:             this.outsideReferenceHolder.style.backgroundColor = "#FDD";
nicholas@2224:         };
nicholas@2224:         this.stopPlayback = function()
nicholas@2224:         {
nicholas@2224:             // Called when playback has stopped. This gets called even if playback never started!
nicholas@2224:             this.outsideReferenceHolder.style.backgroundColor = "";
nicholas@2224:         };
nicholas@2224:         this.exportXMLDOM = function(audioObject)
nicholas@2224:         {
nicholas@2224:             return null;
nicholas@2224:         };
nicholas@2224:         this.getValue = function()
nicholas@2224:         {
nicholas@2224:             return 0;
nicholas@2224:         };
nicholas@2224:         this.getPresentedId = function()
nicholas@2224:         {
nicholas@2224:             return 'Reference';
nicholas@2224:         };
nicholas@2224:         this.canMove = function()
nicholas@2224:         {
nicholas@2224:             return false;
nicholas@2224:         };
nicholas@2224:         this.error = function() {
nicholas@2224:                 // audioObject has an error!!
nicholas@2224:             this.outsideReferenceHolder.textContent = "Error";
nicholas@2224:             this.outsideReferenceHolder.style.backgroundColor = "#F00";
nicholas@2224:         }
nicholas@2224:     }
nicholas@2224: 	
nicholas@2224: 	this.playhead = new function()
nicholas@2224: 	{
nicholas@2224: 		this.object = document.createElement('div');
nicholas@2224: 		this.object.className = 'playhead';
nicholas@2224: 		this.object.align = 'left';
nicholas@2224: 		var curTime = document.createElement('div');
nicholas@2224: 		curTime.style.width = '50px';
nicholas@2224: 		this.curTimeSpan = document.createElement('span');
nicholas@2224: 		this.curTimeSpan.textContent = '00:00';
nicholas@2224: 		curTime.appendChild(this.curTimeSpan);
nicholas@2224: 		this.object.appendChild(curTime);
nicholas@2224: 		this.scrubberTrack = document.createElement('div');
nicholas@2224: 		this.scrubberTrack.className = 'playhead-scrub-track';
nicholas@2224: 		
nicholas@2224: 		this.scrubberHead = document.createElement('div');
nicholas@2224: 		this.scrubberHead.id = 'playhead-scrubber';
nicholas@2224: 		this.scrubberTrack.appendChild(this.scrubberHead);
nicholas@2224: 		this.object.appendChild(this.scrubberTrack);
nicholas@2224: 		
nicholas@2224: 		this.timePerPixel = 0;
nicholas@2224: 		this.maxTime = 0;
nicholas@2224: 		
nicholas@2224: 		this.playbackObject;
nicholas@2224: 		
nicholas@2224: 		this.setTimePerPixel = function(audioObject) {
nicholas@2224: 			//maxTime must be in seconds
nicholas@2224: 			this.playbackObject = audioObject;
nicholas@2224: 			this.maxTime = audioObject.buffer.buffer.duration;
nicholas@2224: 			var width = 490; //500 - 10, 5 each side of the tracker head
nicholas@2224: 			this.timePerPixel = this.maxTime/490;
nicholas@2224: 			if (this.maxTime < 60) {
nicholas@2224: 				this.curTimeSpan.textContent = '0.00';
nicholas@2224: 			} else {
nicholas@2224: 				this.curTimeSpan.textContent = '00:00';
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224: 		
nicholas@2224: 		this.update = function() {
nicholas@2224: 			// Update the playhead position, startPlay must be called
nicholas@2224: 			if (this.timePerPixel > 0) {
nicholas@2224: 				var time = this.playbackObject.getCurrentPosition();
nicholas@2224: 				if (time > 0 && time < this.maxTime) {
nicholas@2224: 					var width = 490;
nicholas@2224: 					var pix = Math.floor(time/this.timePerPixel);
nicholas@2224: 					this.scrubberHead.style.left = pix+'px';
nicholas@2224: 					if (this.maxTime > 60.0) {
nicholas@2224: 						var secs = time%60;
nicholas@2224: 						var mins = Math.floor((time-secs)/60);
nicholas@2224: 						secs = secs.toString();
nicholas@2224: 						secs = secs.substr(0,2);
nicholas@2224: 						mins = mins.toString();
nicholas@2224: 						this.curTimeSpan.textContent = mins+':'+secs;
nicholas@2224: 					} else {
nicholas@2224: 						time = time.toString();
nicholas@2224: 						this.curTimeSpan.textContent = time.substr(0,4);
nicholas@2224: 					}
nicholas@2224: 				} else {
nicholas@2224: 					this.scrubberHead.style.left = '0px';
nicholas@2224: 					if (this.maxTime < 60) {
nicholas@2224: 						this.curTimeSpan.textContent = '0.00';
nicholas@2224: 					} else {
nicholas@2224: 						this.curTimeSpan.textContent = '00:00';
nicholas@2224: 					}
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224: 		
nicholas@2224: 		this.interval = undefined;
nicholas@2224: 		
nicholas@2224: 		this.start = function() {
nicholas@2224: 			if (this.playbackObject != undefined && this.interval == undefined) {
nicholas@2224: 				if (this.maxTime < 60) {
nicholas@2224: 					this.interval = setInterval(function(){interfaceContext.playhead.update();},10);
nicholas@2224: 				} else {
nicholas@2224: 					this.interval = setInterval(function(){interfaceContext.playhead.update();},100);
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224: 		this.stop = function() {
nicholas@2224: 			clearInterval(this.interval);
nicholas@2224: 			this.interval = undefined;
nicholas@2224:             this.scrubberHead.style.left = '0px';
nicholas@2224: 			if (this.maxTime < 60) {
nicholas@2224: 				this.curTimeSpan.textContent = '0.00';
nicholas@2224: 			} else {
nicholas@2224: 				this.curTimeSpan.textContent = '00:00';
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224:     this.volume = new function()
nicholas@2224:     {
nicholas@2224:         // An in-built volume module which can be viewed on page
nicholas@2224:         // Includes trackers on page-by-page data
nicholas@2224:         // Volume does NOT reset to 0dB on each page load
nicholas@2224:         this.valueLin = 1.0;
nicholas@2224:         this.valueDB = 0.0;
nicholas@2224:         this.object = document.createElement('div');
nicholas@2224:         this.object.id = 'master-volume-holder';
nicholas@2224:         this.slider = document.createElement('input');
nicholas@2224:         this.slider.id = 'master-volume-control';
nicholas@2224:         this.slider.type = 'range';
nicholas@2224:         this.valueText = document.createElement('span');
nicholas@2224:         this.valueText.id = 'master-volume-feedback';
nicholas@2224:         this.valueText.textContent = '0dB';
nicholas@2224:         
nicholas@2224:         this.slider.min = -60;
nicholas@2224:         this.slider.max = 12;
nicholas@2224:         this.slider.value = 0;
nicholas@2224:         this.slider.step = 1;
nicholas@2224:         this.slider.onmousemove = function(event)
nicholas@2224:         {
nicholas@2224:             interfaceContext.volume.valueDB = event.currentTarget.value;
nicholas@2224:             interfaceContext.volume.valueLin = decibelToLinear(interfaceContext.volume.valueDB);
nicholas@2224:             interfaceContext.volume.valueText.textContent = interfaceContext.volume.valueDB+'dB';
nicholas@2224:             audioEngineContext.outputGain.gain.value = interfaceContext.volume.valueLin;
nicholas@2224:         }
nicholas@2224:         this.slider.onmouseup = function(event)
nicholas@2224:         {
nicholas@2224:             var storePoint = testState.currentStore.XMLDOM.getElementsByTagName('metric')[0].getAllElementsByName('volumeTracker');
nicholas@2224:             if (storePoint.length == 0)
nicholas@2224:             {
nicholas@2224:                 storePoint = storage.document.createElement('metricresult');
nicholas@2224:                 storePoint.setAttribute('name','volumeTracker');
nicholas@2224:                 testState.currentStore.XMLDOM.getElementsByTagName('metric')[0].appendChild(storePoint);
nicholas@2224:             }
nicholas@2224:             else {
nicholas@2224:                 storePoint = storePoint[0];
nicholas@2224:             }
nicholas@2224:             var node = storage.document.createElement('movement');
nicholas@2224:             node.setAttribute('test-time',audioEngineContext.timer.getTestTime());
nicholas@2224:             node.setAttribute('volume',interfaceContext.volume.valueDB);
nicholas@2224:             node.setAttribute('format','dBFS');
nicholas@2224:             storePoint.appendChild(node);
nicholas@2224:         }
nicholas@2224:         
nicholas@2224:         var title = document.createElement('div');
nicholas@2224:         title.innerHTML = '<span>Master Volume Control</span>';
nicholas@2224:         title.style.fontSize = '0.75em';
nicholas@2224:         title.style.width = "100%";
nicholas@2224:         title.align = 'center';
nicholas@2224:         this.object.appendChild(title);
nicholas@2224:         
nicholas@2224:         this.object.appendChild(this.slider);
nicholas@2224:         this.object.appendChild(this.valueText);
nicholas@2224:     }
nicholas@2224:     
nicholas@2224:     this.calibrationModuleObject = null;
nicholas@2224:     this.calibrationModule = function() {
nicholas@2224:         // This creates an on-page calibration module
nicholas@2224:         this.storeDOM = storage.document.createElement("calibration");
nicholas@2224:         storage.root.appendChild(this.storeDOM);
nicholas@2224:         // The calibration is a fixed state module
nicholas@2224:         this.calibrationNodes = [];
nicholas@2224:         this.holder = null;
nicholas@2224:         this.build = function(inject) {
nicholas@2224:             var f0 = 62.5;
nicholas@2224:             this.holder = document.createElement("div");
nicholas@2224:             this.holder.className = "calibration-holder";
nicholas@2224:             this.calibrationNodes = [];
nicholas@2224:             while(f0 < 20000) {
nicholas@2224:                 var obj = {
nicholas@2224:                     root: document.createElement("div"),
nicholas@2224:                     input: document.createElement("input"),
nicholas@2224:                     oscillator: audioContext.createOscillator(),
nicholas@2224:                     gain: audioContext.createGain(),
nicholas@2224:                     f: f0,
nicholas@2224:                     parent: this,
nicholas@2224:                     handleEvent: function(event) {
nicholas@2224:                         switch(event.type) {
nicholas@2224:                             case "mouseenter":
nicholas@2224:                                 this.oscillator.start(0);
nicholas@2224:                                 break;
nicholas@2224:                             case "mouseleave":
nicholas@2224:                                 this.oscillator.stop(0);
nicholas@2224:                                 this.oscillator = audioContext.createOscillator();
nicholas@2224:                                 this.oscillator.connect(this.gain);
nicholas@2224:                                 this.oscillator.frequency.value = this.f;
nicholas@2224:                                 break;
nicholas@2224:                             case "mousemove":
nicholas@2224:                                 var value = Math.pow(10,this.input.value/20);
nicholas@2224:                                 if (this.f == 1000) {
nicholas@2224:                                     audioEngineContext.outputGain.gain.value = value;
nicholas@2224:                                     interfaceContext.volume.slider.value = this.input.value;
nicholas@2224:                                 } else {
nicholas@2224:                                     this.gain.gain.value = value
nicholas@2224:                                 }
nicholas@2224:                                 break;
nicholas@2224:                         }
nicholas@2224:                     },
nicholas@2224:                     disconnect: function() {
nicholas@2224:                         this.gain.disconnect();
nicholas@2224:                     }
nicholas@2224:                 }
nicholas@2224:                 obj.root.className = "calibration-slider";
nicholas@2224:                 obj.root.appendChild(obj.input);
nicholas@2224:                 obj.oscillator.connect(obj.gain);
nicholas@2224:                 obj.gain.connect(audioEngineContext.outputGain);
nicholas@2224:                 obj.gain.gain.value = Math.random()*2;
nicholas@2224:                 obj.input.value = obj.gain.gain.value;
nicholas@2224:                 obj.input.setAttribute('orient','vertical');
nicholas@2224:                 obj.input.type = "range";
nicholas@2224:                 obj.input.min = -6;
nicholas@2224:                 obj.input.max = 6;
nicholas@2224:                 obj.input.step = 0.25;
nicholas@2224:                 if (f0 != 1000) {
nicholas@2224:                     obj.input.value = (Math.random()*12)-6;
nicholas@2224:                 } else {
nicholas@2224:                     obj.input.value = 0;
nicholas@2224:                     obj.root.style.backgroundColor="rgb(255,125,125)";
nicholas@2224:                 }
nicholas@2224:                 obj.input.addEventListener("mousemove",obj);
nicholas@2224:                 obj.input.addEventListener("mouseenter",obj);
nicholas@2224:                 obj.input.addEventListener("mouseleave",obj);
nicholas@2224:                 obj.gain.gain.value = Math.pow(10,obj.input.value/20);
nicholas@2224:                 obj.oscillator.frequency.value = f0;
nicholas@2224:                 this.calibrationNodes.push(obj);
nicholas@2224:                 this.holder.appendChild(obj.root);
nicholas@2224:                 f0 *= 2;
nicholas@2224:             }
nicholas@2224:             inject.appendChild(this.holder);
nicholas@2224:         }
nicholas@2224:         this.collect = function() {
nicholas@2224:             for (var obj of this.calibrationNodes) {
nicholas@2224:                 var node = storage.document.createElement("calibrationresult");
nicholas@2224:                 node.setAttribute("frequency",obj.f);
nicholas@2224:                 node.setAttribute("range-min",obj.input.min);
nicholas@2224:                 node.setAttribute("range-max",obj.input.max);
nicholas@2224:                 node.setAttribute("gain-lin",obj.gain.gain.value);
nicholas@2224:                 this.storeDOM.appendChild(node);
nicholas@2224:             }
nicholas@2224:         }
nicholas@2224:     }
nicholas@2224:     
nicholas@2224:     
nicholas@2224: 	// Global Checkers
nicholas@2224: 	// These functions will help enforce the checkers
nicholas@2224: 	this.checkHiddenAnchor = function()
nicholas@2224: 	{
nicholas@2224: 		for (var ao of audioEngineContext.audioObjects)
nicholas@2224: 		{
nicholas@2224: 			if (ao.specification.type == "anchor")
nicholas@2224: 			{
nicholas@2224: 				if (ao.interfaceDOM.getValue() > (ao.specification.marker/100) && ao.specification.marker > 0) {
nicholas@2224: 					// Anchor is not set below
nicholas@2224: 					console.log('Anchor node not below marker value');
nicholas@2224: 					alert('Please keep listening');
nicholas@2224:                     this.storeErrorNode('Anchor node not below marker value');
nicholas@2224: 					return false;
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		return true;
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.checkHiddenReference = function()
nicholas@2224: 	{
nicholas@2224: 		for (var ao of audioEngineContext.audioObjects)
nicholas@2224: 		{
nicholas@2224: 			if (ao.specification.type == "reference")
nicholas@2224: 			{
nicholas@2224: 				if (ao.interfaceDOM.getValue() < (ao.specification.marker/100) && ao.specification.marker > 0) {
nicholas@2224: 					// Anchor is not set below
nicholas@2224: 					console.log('Reference node not above marker value');
nicholas@2224:                     this.storeErrorNode('Reference node not above marker value');
nicholas@2224: 					alert('Please keep listening');
nicholas@2224: 					return false;
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		return true;
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.checkFragmentsFullyPlayed = function ()
nicholas@2224: 	{
nicholas@2224: 		// Checks the entire file has been played back
nicholas@2224: 		// NOTE ! This will return true IF playback is Looped!!!
nicholas@2224: 		if (audioEngineContext.loopPlayback)
nicholas@2224: 		{
nicholas@2224: 			console.log("WARNING - Looped source: Cannot check fragments are fully played");
nicholas@2224: 			return true;
nicholas@2224: 		}
nicholas@2224: 		var check_pass = true;
nicholas@2224: 		var error_obj = [];
nicholas@2224: 		for (var i = 0; i<audioEngineContext.audioObjects.length; i++)
nicholas@2224: 		{
nicholas@2224: 			var object = audioEngineContext.audioObjects[i];
nicholas@2224: 			var time = object.buffer.buffer.duration;
nicholas@2224: 			var metric = object.metric;
nicholas@2224: 			var passed = false;
nicholas@2224: 			for (var j=0; j<metric.listenTracker.length; j++)
nicholas@2224: 			{
nicholas@2224: 				var bt = metric.listenTracker[j].getElementsByTagName('buffertime');
nicholas@2224: 				var start_time = Number(bt[0].getAttribute('start'));
nicholas@2224: 				var stop_time = Number(bt[0].getAttribute('stop'));
nicholas@2224: 				var delta = stop_time - start_time;
nicholas@2224: 				if (delta >= time)
nicholas@2224: 				{
nicholas@2224: 					passed = true;
nicholas@2224: 					break;
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 			if (passed == false)
nicholas@2224: 			{
nicholas@2224: 				check_pass = false;
b@2258: 				console.log("Continue listening to track-"+object.interfaceDOM.getPresentedId());
nicholas@2224: 				error_obj.push(object.interfaceDOM.getPresentedId());
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		if (check_pass == false)
nicholas@2224: 		{
nicholas@2224: 			var str_start = "You have not completely listened to fragments ";
nicholas@2224: 			for (var i=0; i<error_obj.length; i++)
nicholas@2224: 			{
nicholas@2224: 				str_start += error_obj[i];
nicholas@2224: 				if (i != error_obj.length-1)
nicholas@2224: 				{
nicholas@2224: 					str_start += ', ';
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 			str_start += ". Please keep listening";
nicholas@2224: 			console.log("[ALERT]: "+str_start);
nicholas@2224:             this.storeErrorNode("[ALERT]: "+str_start);
nicholas@2224: 			alert(str_start);
nicholas@2224: 		}
nicholas@2224: 	};
nicholas@2224: 	this.checkAllMoved = function()
nicholas@2224: 	{
nicholas@2224: 		var str = "You have not moved ";
nicholas@2224: 		var failed = [];
nicholas@2224: 		for (var ao of audioEngineContext.audioObjects)
nicholas@2224: 		{
nicholas@2224: 			if(ao.metric.wasMoved == false && ao.interfaceDOM.canMove() == true)
nicholas@2224: 			{
b@2258: 				failed.push(ao.interfaceDOM.getPresentedId());
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		if (failed.length == 0)
nicholas@2224: 		{
nicholas@2224: 			return true;
nicholas@2224: 		} else if (failed.length == 1)
nicholas@2224: 		{
nicholas@2224: 			str += 'track '+failed[0];
nicholas@2224: 		} else {
nicholas@2224: 			str += 'tracks ';
nicholas@2224: 			for (var i=0; i<failed.length-1; i++)
nicholas@2224: 			{
nicholas@2224: 				str += failed[i]+', ';
nicholas@2224: 			}
nicholas@2224: 			str += 'and '+failed[i];
nicholas@2224: 		}
nicholas@2224: 		str +='.';
nicholas@2224: 		alert(str);
nicholas@2224: 		console.log(str);
nicholas@2224:         this.storeErrorNode(str);
nicholas@2224: 		return false;
nicholas@2224: 	};
nicholas@2224: 	this.checkAllPlayed = function()
nicholas@2224: 	{
nicholas@2224: 		var str = "You have not played ";
nicholas@2224: 		var failed = [];
nicholas@2224: 		for (var ao of audioEngineContext.audioObjects)
nicholas@2224: 		{
nicholas@2224: 			if(ao.metric.wasListenedTo == false)
nicholas@2224: 			{
b@2258: 				failed.push(ao.interfaceDOM.getPresentedId());
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		if (failed.length == 0)
nicholas@2224: 		{
nicholas@2224: 			return true;
nicholas@2224: 		} else if (failed.length == 1)
nicholas@2224: 		{
nicholas@2224: 			str += 'track '+failed[0];
nicholas@2224: 		} else {
nicholas@2224: 			str += 'tracks ';
nicholas@2224: 			for (var i=0; i<failed.length-1; i++)
nicholas@2224: 			{
nicholas@2224: 				str += failed[i]+', ';
nicholas@2224: 			}
nicholas@2224: 			str += 'and '+failed[i];
nicholas@2224: 		}
nicholas@2224: 		str +='.';
nicholas@2224: 		alert(str);
nicholas@2224: 		console.log(str);
nicholas@2224:         this.storeErrorNode(str);
nicholas@2224: 		return false;
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224:     this.storeErrorNode = function(errorMessage)
nicholas@2224:     {
nicholas@2224:         var time = audioEngineContext.timer.getTestTime();
nicholas@2224:         var node = storage.document.createElement('error');
nicholas@2224:         node.setAttribute('time',time);
nicholas@2224:         node.textContent = errorMessage;
nicholas@2224:         testState.currentStore.XMLDOM.appendChild(node);
nicholas@2224:     };
nicholas@2224: }
nicholas@2224: 
nicholas@2224: function Storage()
nicholas@2224: {
nicholas@2224: 	// Holds results in XML format until ready for collection
nicholas@2224: 	this.globalPreTest = null;
nicholas@2224: 	this.globalPostTest = null;
nicholas@2224: 	this.testPages = [];
nicholas@2224: 	this.document = null;
nicholas@2224: 	this.root = null;
nicholas@2224: 	this.state = 0;
nicholas@2224: 	
nicholas@2224: 	this.initialise = function(existingStore)
nicholas@2224: 	{
nicholas@2224:         if (existingStore == undefined) {
nicholas@2224:             // We need to get the sessionKey
nicholas@2224:             this.SessionKey.generateKey();
nicholas@2224:             this.document = document.implementation.createDocument(null,"waetresult");
nicholas@2224:             this.root = this.document.childNodes[0];
nicholas@2224:             var projectDocument = specification.projectXML;
nicholas@2224:             projectDocument.setAttribute('file-name',url);
nicholas@2224:             projectDocument.setAttribute('url',qualifyURL(url));
nicholas@2224:             this.root.appendChild(projectDocument);
nicholas@2224:             this.root.appendChild(interfaceContext.returnDateNode());
nicholas@2224:             this.root.appendChild(interfaceContext.returnNavigator());
nicholas@2224:         } else {
nicholas@2224:             this.document = existingStore;
nicholas@2224:             this.root = existingStore.children[0];
nicholas@2224:             this.SessionKey.key = this.root.getAttribute("key");
nicholas@2224:         }
nicholas@2224:         if (specification.preTest != undefined){this.globalPreTest = new this.surveyNode(this,this.root,specification.preTest);}
nicholas@2224:         if (specification.postTest != undefined){this.globalPostTest = new this.surveyNode(this,this.root,specification.postTest);}
nicholas@2224: 	};
nicholas@2224:     
nicholas@2224:     this.SessionKey = {
nicholas@2224:         key: null,
nicholas@2224:         request: new XMLHttpRequest(),
nicholas@2224:         parent: this,
nicholas@2224:         handleEvent: function() {
nicholas@2224:             var parse = new DOMParser();
nicholas@2224:             var xml = parse.parseFromString(this.request.response,"text/xml");
nicholas@2224:             if (xml.getAllElementsByTagName("state")[0].textContent == "OK") {
nicholas@2224:                 this.key = xml.getAllElementsByTagName("key")[0].textContent;
nicholas@2224:                 this.parent.root.setAttribute("key",this.key);
nicholas@2224:                 this.parent.root.setAttribute("state","empty");
nicholas@2224:             } else {
nicholas@2224:                 this.generateKey();
nicholas@2224:             }
nicholas@2224:         },
nicholas@2224:         generateKey: function() {
nicholas@2224:             var temp_key = randomString(32);
nicholas@2224:             this.request.open("GET","php/keygen.php?key="+temp_key,true);
nicholas@2224:             this.request.addEventListener("load",this);
nicholas@2224:             this.request.send();
nicholas@2224:         },
nicholas@2224:         update: function() {
nicholas@2224:             this.parent.root.setAttribute("state","update");
nicholas@2224:             var xmlhttp = new XMLHttpRequest();
nicholas@2224:             xmlhttp.open("POST","php/"+specification.projectReturn+"?key="+this.key);
nicholas@2224:             xmlhttp.setRequestHeader('Content-Type', 'text/xml');
nicholas@2224:             xmlhttp.onerror = function(){
nicholas@2224:                 console.log('Error updating file to server!');
nicholas@2224:             };
nicholas@2224:             var hold = document.createElement("div");
nicholas@2224:             var clone = this.parent.root.cloneNode(true);
nicholas@2224:             hold.appendChild(clone);
nicholas@2224:             xmlhttp.onload = function() {
nicholas@2224:                 if (this.status >= 300) {
nicholas@2224:                     console.log("WARNING - Could not update at this time");
nicholas@2224:                 } else {
nicholas@2224:                     var parser = new DOMParser();
nicholas@2224:                     var xmlDoc = parser.parseFromString(xmlhttp.responseText, "application/xml");
nicholas@2224:                     var response = xmlDoc.getElementsByTagName('response')[0];
nicholas@2224:                     if (response.getAttribute("state") == "OK") {
nicholas@2224:                         var file = response.getElementsByTagName("file")[0];
nicholas@2224:                         console.log("Intermediate save: OK, written "+file.getAttribute("bytes")+"B");
nicholas@2224:                     } else {
nicholas@2224:                         var message = response.getElementsByTagName("message");
nicholas@2224:                         console.log("Intermediate save: Error! "+message.textContent);
nicholas@2224:                     }
nicholas@2224:                 }
nicholas@2224:             }
nicholas@2224:             xmlhttp.send([hold.innerHTML]);
nicholas@2224:         }
nicholas@2224:     }
nicholas@2224: 	
nicholas@2224: 	this.createTestPageStore = function(specification)
nicholas@2224: 	{
nicholas@2224: 		var store = new this.pageNode(this,specification);
nicholas@2224: 		this.testPages.push(store);
nicholas@2224: 		return this.testPages[this.testPages.length-1];
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.surveyNode = function(parent,root,specification)
nicholas@2224: 	{
nicholas@2224: 		this.specification = specification;
nicholas@2224: 		this.parent = parent;
nicholas@2224:         this.state = "empty";
nicholas@2224: 		this.XMLDOM = this.parent.document.createElement('survey');
nicholas@2224: 		this.XMLDOM.setAttribute('location',this.specification.location);
nicholas@2224:         this.XMLDOM.setAttribute("state",this.state);
nicholas@2224: 		for (var optNode of this.specification.options)
nicholas@2224: 		{
nicholas@2224: 			if (optNode.type != 'statement')
nicholas@2224: 			{
nicholas@2224: 				var node = this.parent.document.createElement('surveyresult');
nicholas@2224: 				node.setAttribute("ref",optNode.id);
nicholas@2224: 				node.setAttribute('type',optNode.type);
nicholas@2224: 				this.XMLDOM.appendChild(node);
nicholas@2224: 			}
nicholas@2224: 		}
nicholas@2224: 		root.appendChild(this.XMLDOM);
nicholas@2224: 		
nicholas@2224: 		this.postResult = function(node)
nicholas@2224: 		{
nicholas@2224: 			// From popup: node is the popupOption node containing both spec. and results
nicholas@2224: 			// ID is the position
nicholas@2224: 			if (node.specification.type == 'statement'){return;}
nicholas@2224: 			var surveyresult = this.XMLDOM.children[0];
nicholas@2224:             while(surveyresult != null) {
nicholas@2224:                 if (surveyresult.getAttribute("ref") == node.specification.id)
nicholas@2224:                 {
nicholas@2224:                     break;
nicholas@2224:                 }
nicholas@2224:                 surveyresult = surveyresult.nextElementSibling;
nicholas@2224:             }
nicholas@2224: 			switch(node.specification.type)
nicholas@2224: 			{
nicholas@2224: 			case "number":
nicholas@2224: 			case "question":
nicholas@2224: 				var child = this.parent.document.createElement('response');
nicholas@2224: 				child.textContent = node.response;
nicholas@2224: 				surveyresult.appendChild(child);
nicholas@2224: 				break;
nicholas@2224: 			case "radio":
nicholas@2224: 				var child = this.parent.document.createElement('response');
nicholas@2224: 				child.setAttribute('name',node.response.name);
nicholas@2224: 				child.textContent = node.response.text;
nicholas@2224: 				surveyresult.appendChild(child);
nicholas@2224: 				break;
nicholas@2224: 			case "checkbox":
nicholas@2224: 				for (var i=0; i<node.response.length; i++)
nicholas@2224: 				{
nicholas@2224: 					var checkNode = this.parent.document.createElement('response');
nicholas@2224: 					checkNode.setAttribute('name',node.response[i].name);
nicholas@2224: 					checkNode.setAttribute('checked',node.response[i].checked);
nicholas@2224: 					surveyresult.appendChild(checkNode);
nicholas@2224: 				}
nicholas@2224: 				break;
nicholas@2224: 			}
nicholas@2224: 		};
nicholas@2224:         this.complete = function() {
nicholas@2224:             this.state = "complete";
nicholas@2224:             this.XMLDOM.setAttribute("state",this.state);
nicholas@2224:         }
nicholas@2224: 	};
nicholas@2224: 	
nicholas@2224: 	this.pageNode = function(parent,specification)
nicholas@2224: 	{
nicholas@2224: 		// Create one store per test page
nicholas@2224: 		this.specification = specification;
nicholas@2224: 		this.parent = parent;
nicholas@2224:         this.state = "empty";
nicholas@2224: 		this.XMLDOM = this.parent.document.createElement('page');
nicholas@2224: 		this.XMLDOM.setAttribute('ref',specification.id);
nicholas@2224: 		this.XMLDOM.setAttribute('presentedId',specification.presentedId);
nicholas@2224:         this.XMLDOM.setAttribute("state",this.state);
nicholas@2224: 		if (specification.preTest != undefined){this.preTest = new this.parent.surveyNode(this.parent,this.XMLDOM,this.specification.preTest);}
nicholas@2224: 		if (specification.postTest != undefined){this.postTest = new this.parent.surveyNode(this.parent,this.XMLDOM,this.specification.postTest);}
nicholas@2224: 		
nicholas@2224: 		// Add any page metrics
nicholas@2224: 		var page_metric = this.parent.document.createElement('metric');
nicholas@2224: 		this.XMLDOM.appendChild(page_metric);
nicholas@2224: 		
nicholas@2224: 		// Add the audioelement
nicholas@2224: 		for (var element of this.specification.audioElements)
nicholas@2224: 		{
nicholas@2224: 			var aeNode = this.parent.document.createElement('audioelement');
nicholas@2224: 			aeNode.setAttribute('ref',element.id);
nicholas@2224:             if (element.name != undefined){aeNode.setAttribute('name',element.name)};
nicholas@2224: 			aeNode.setAttribute('type',element.type);
nicholas@2224: 			aeNode.setAttribute('url', element.url);
nicholas@2224:             aeNode.setAttribute('fqurl',qualifyURL(element.url));
nicholas@2224: 			aeNode.setAttribute('gain', element.gain);
nicholas@2224: 			if (element.type == 'anchor' || element.type == 'reference')
nicholas@2224: 			{
nicholas@2224: 				if (element.marker > 0)
nicholas@2224: 				{
nicholas@2224: 					aeNode.setAttribute('marker',element.marker);
nicholas@2224: 				}
nicholas@2224: 			}
nicholas@2224: 			var ae_metric = this.parent.document.createElement('metric');
nicholas@2224: 			aeNode.appendChild(ae_metric); 
nicholas@2224: 			this.XMLDOM.appendChild(aeNode);
nicholas@2224: 		}
nicholas@2224: 		
nicholas@2224: 		this.parent.root.appendChild(this.XMLDOM);
nicholas@2224:         
nicholas@2224:         this.complete = function() {
nicholas@2224:             this.state = "complete";
nicholas@2224:             this.XMLDOM.setAttribute("state","complete");
nicholas@2224:         }
nicholas@2224: 	};
nicholas@2224:     this.update = function() {
nicholas@2224:         this.SessionKey.update();
nicholas@2224:     }
nicholas@2224: 	this.finish = function()
nicholas@2224: 	{
nicholas@2224: 		if (this.state == 0)
nicholas@2224: 		{
nicholas@2224:             this.update();
nicholas@2224: 		}
nicholas@2224: 		this.state = 1;
nicholas@2224: 		return this.root;
nicholas@2224: 	};
nicholas@2224: }