annotate core.js @ 1361:10ddee18db8d

Feature #1234: Completed fix
author Nicholas Jillings <nickjillings@users.noreply.github.com>
date Tue, 26 Jan 2016 14:20:43 +0000
parents a9eb4f6443d8
children a679987d13cc
rev   line source
nickjillings@1318 1 /**
nickjillings@1318 2 * core.js
nickjillings@1318 3 *
nickjillings@1318 4 * Main script to run, calls all other core functions and manages loading/store to backend.
nickjillings@1318 5 * Also contains all global variables.
nickjillings@1318 6 */
nickjillings@1318 7
nickjillings@1318 8 /* create the web audio API context and store in audioContext*/
nickjillings@1318 9 var audioContext; // Hold the browser web audio API
nickjillings@1318 10 var projectXML; // Hold the parsed setup XML
nickjillings@1324 11 var schemaXSD; // Hold the parsed schema XSD
nickjillings@1318 12 var specification;
nickjillings@1318 13 var interfaceContext;
nickjillings@1324 14 var storage;
nickjillings@1318 15 var popup; // Hold the interfacePopup object
nickjillings@1318 16 var testState;
nickjillings@1318 17 var currentTrackOrder = []; // Hold the current XML tracks in their (randomised) order
nickjillings@1318 18 var audioEngineContext; // The custome AudioEngine object
nickjillings@1318 19 var projectReturn; // Hold the URL for the return
nickjillings@1318 20
nickjillings@1318 21
nickjillings@1318 22 // Add a prototype to the bufferSourceNode to reference to the audioObject holding it
nickjillings@1318 23 AudioBufferSourceNode.prototype.owner = undefined;
nickjillings@1318 24 // Add a prototype to the bufferNode to hold the desired LINEAR gain
nickjillings@1320 25 AudioBuffer.prototype.playbackGain = undefined;
nickjillings@1318 26 // Add a prototype to the bufferNode to hold the computed LUFS loudness
nickjillings@1318 27 AudioBuffer.prototype.lufs = undefined;
nickjillings@1318 28
nickjillings@1348 29 // Firefox does not have an XMLDocument.prototype.getElementsByName
nickjillings@1348 30 // and there is no searchAll style command, this custom function will
nickjillings@1348 31 // search all children recusrively for the name. Used for XSD where all
nickjillings@1348 32 // element nodes must have a name and therefore can pull the schema node
nickjillings@1348 33 XMLDocument.prototype.getAllElementsByName = function(name)
nickjillings@1348 34 {
nickjillings@1348 35 name = String(name);
nickjillings@1348 36 var selected = this.documentElement.getAllElementsByName(name);
nickjillings@1348 37 return selected;
nickjillings@1348 38 }
nickjillings@1348 39
nickjillings@1348 40 Element.prototype.getAllElementsByName = function(name)
nickjillings@1348 41 {
nickjillings@1348 42 name = String(name);
nickjillings@1348 43 var selected = [];
nickjillings@1348 44 var node = this.firstElementChild;
nickjillings@1348 45 while(node != null)
nickjillings@1348 46 {
nickjillings@1348 47 if (node.getAttribute('name') == name)
nickjillings@1348 48 {
nickjillings@1348 49 selected.push(node);
nickjillings@1348 50 }
nickjillings@1348 51 if (node.childElementCount > 0)
nickjillings@1348 52 {
nickjillings@1348 53 selected = selected.concat(node.getAllElementsByName(name));
nickjillings@1348 54 }
nickjillings@1348 55 node = node.nextElementSibling;
nickjillings@1348 56 }
nickjillings@1348 57 return selected;
nickjillings@1348 58 }
nickjillings@1348 59
nickjillings@1348 60 XMLDocument.prototype.getAllElementsByTagName = function(name)
nickjillings@1348 61 {
nickjillings@1348 62 name = String(name);
nickjillings@1348 63 var selected = this.documentElement.getAllElementsByTagName(name);
nickjillings@1348 64 return selected;
nickjillings@1348 65 }
nickjillings@1348 66
nickjillings@1348 67 Element.prototype.getAllElementsByTagName = function(name)
nickjillings@1348 68 {
nickjillings@1348 69 name = String(name);
nickjillings@1348 70 var selected = [];
nickjillings@1348 71 var node = this.firstElementChild;
nickjillings@1348 72 while(node != null)
nickjillings@1348 73 {
nickjillings@1348 74 if (node.nodeName == name)
nickjillings@1348 75 {
nickjillings@1348 76 selected.push(node);
nickjillings@1348 77 }
nickjillings@1348 78 if (node.childElementCount > 0)
nickjillings@1348 79 {
nickjillings@1348 80 selected = selected.concat(node.getAllElementsByTagName(name));
nickjillings@1348 81 }
nickjillings@1348 82 node = node.nextElementSibling;
nickjillings@1348 83 }
nickjillings@1348 84 return selected;
nickjillings@1348 85 }
nickjillings@1348 86
nickjillings@1348 87 // Firefox does not have an XMLDocument.prototype.getElementsByName
nickjillings@1348 88 if (typeof XMLDocument.prototype.getElementsByName != "function") {
nickjillings@1348 89 XMLDocument.prototype.getElementsByName = function(name)
nickjillings@1348 90 {
nickjillings@1348 91 name = String(name);
nickjillings@1348 92 var node = this.documentElement.firstElementChild;
nickjillings@1348 93 var selected = [];
nickjillings@1348 94 while(node != null)
nickjillings@1348 95 {
nickjillings@1348 96 if (node.getAttribute('name') == name)
nickjillings@1348 97 {
nickjillings@1348 98 selected.push(node);
nickjillings@1348 99 }
nickjillings@1348 100 node = node.nextElementSibling;
nickjillings@1348 101 }
nickjillings@1348 102 return selected;
nickjillings@1348 103 }
nickjillings@1348 104 }
nickjillings@1348 105
nickjillings@1318 106 window.onload = function() {
nickjillings@1318 107 // Function called once the browser has loaded all files.
nickjillings@1318 108 // This should perform any initial commands such as structure / loading documents
nickjillings@1318 109
nickjillings@1318 110 // Create a web audio API context
nickjillings@1318 111 // Fixed for cross-browser support
nickjillings@1318 112 var AudioContext = window.AudioContext || window.webkitAudioContext;
nickjillings@1318 113 audioContext = new AudioContext;
nickjillings@1318 114
nickjillings@1318 115 // Create test state
nickjillings@1318 116 testState = new stateMachine();
nickjillings@1318 117
nickjillings@1318 118 // Create the popup interface object
nickjillings@1318 119 popup = new interfacePopup();
nickjillings@1318 120
nickjillings@1318 121 // Create the specification object
nickjillings@1318 122 specification = new Specification();
nickjillings@1318 123
nickjillings@1318 124 // Create the interface object
nickjillings@1318 125 interfaceContext = new Interface(specification);
nickjillings@1324 126
nickjillings@1324 127 // Create the storage object
nickjillings@1324 128 storage = new Storage();
nickjillings@1318 129 // Define window callbacks for interface
nickjillings@1318 130 window.onresize = function(event){interfaceContext.resizeWindow(event);};
nickjillings@1318 131 };
nickjillings@1318 132
nickjillings@1318 133 function loadProjectSpec(url) {
nickjillings@1318 134 // Load the project document from the given URL, decode the XML and instruct audioEngine to get audio data
nickjillings@1318 135 // If url is null, request client to upload project XML document
nickjillings@1324 136 var xmlhttp = new XMLHttpRequest();
nickjillings@1324 137 xmlhttp.open("GET",'test-schema.xsd',true);
nickjillings@1324 138 xmlhttp.onload = function()
nickjillings@1324 139 {
nickjillings@1324 140 schemaXSD = xmlhttp.response;
nickjillings@1324 141 var parse = new DOMParser();
nickjillings@1324 142 specification.schema = parse.parseFromString(xmlhttp.response,'text/xml');
nickjillings@1324 143 var r = new XMLHttpRequest();
nickjillings@1324 144 r.open('GET',url,true);
nickjillings@1324 145 r.onload = function() {
nickjillings@1324 146 loadProjectSpecCallback(r.response);
nickjillings@1324 147 };
nickjillings@1324 148 r.send();
nickjillings@1318 149 };
nickjillings@1324 150 xmlhttp.send();
nickjillings@1318 151 };
nickjillings@1318 152
nickjillings@1318 153 function loadProjectSpecCallback(response) {
nickjillings@1318 154 // Function called after asynchronous download of XML project specification
nickjillings@1318 155 //var decode = $.parseXML(response);
nickjillings@1318 156 //projectXML = $(decode);
nickjillings@1318 157
nickjillings@1324 158 // First perform XML schema validation
nickjillings@1324 159 var Module = {
nickjillings@1324 160 xml: response,
nickjillings@1324 161 schema: schemaXSD,
nickjillings@1324 162 arguments:["--noout", "--schema", 'test-schema.xsd','document.xml']
nickjillings@1324 163 };
nickjillings@1324 164
nickjillings@1324 165 var xmllint = validateXML(Module);
nickjillings@1324 166 console.log(xmllint);
nickjillings@1324 167 if(xmllint != 'document.xml validates\n')
nickjillings@1324 168 {
nickjillings@1324 169 document.getElementsByTagName('body')[0].innerHTML = null;
nickjillings@1324 170 var msg = document.createElement("h3");
nickjillings@1324 171 msg.textContent = "FATAL ERROR";
nickjillings@1324 172 var span = document.createElement("h4");
nickjillings@1324 173 span.textContent = "The XML validator returned the following errors when decoding your XML file";
nickjillings@1324 174 document.getElementsByTagName('body')[0].appendChild(msg);
nickjillings@1324 175 document.getElementsByTagName('body')[0].appendChild(span);
nickjillings@1324 176 xmllint = xmllint.split('\n');
nickjillings@1324 177 for (var i in xmllint)
nickjillings@1324 178 {
nickjillings@1324 179 document.getElementsByTagName('body')[0].appendChild(document.createElement('br'));
nickjillings@1324 180 var span = document.createElement("span");
nickjillings@1324 181 span.textContent = xmllint[i];
nickjillings@1324 182 document.getElementsByTagName('body')[0].appendChild(span);
nickjillings@1324 183 }
nickjillings@1324 184 return;
nickjillings@1324 185 }
nickjillings@1324 186
nickjillings@1318 187 var parse = new DOMParser();
nickjillings@1318 188 projectXML = parse.parseFromString(response,'text/xml');
nickjillings@1318 189 var errorNode = projectXML.getElementsByTagName('parsererror');
nickjillings@1318 190 if (errorNode.length >= 1)
nickjillings@1318 191 {
nickjillings@1318 192 var msg = document.createElement("h3");
nickjillings@1318 193 msg.textContent = "FATAL ERROR";
nickjillings@1318 194 var span = document.createElement("span");
nickjillings@1318 195 span.textContent = "The XML parser returned the following errors when decoding your XML file";
nickjillings@1318 196 document.getElementsByTagName('body')[0].innerHTML = null;
nickjillings@1318 197 document.getElementsByTagName('body')[0].appendChild(msg);
nickjillings@1318 198 document.getElementsByTagName('body')[0].appendChild(span);
nickjillings@1318 199 document.getElementsByTagName('body')[0].appendChild(errorNode[0]);
nickjillings@1318 200 return;
nickjillings@1318 201 }
nickjillings@1318 202
nickjillings@1318 203 // Build the specification
nickjillings@1318 204 specification.decode(projectXML);
nickjillings@1324 205 storage.initialise();
nickjillings@1339 206 /// CHECK FOR SAMPLE RATE COMPATIBILITY
nickjillings@1339 207 if (specification.sampleRate != undefined) {
nickjillings@1339 208 if (Number(specification.sampleRate) != audioContext.sampleRate) {
nickjillings@1339 209 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.';
nickjillings@1339 210 alert(errStr);
nickjillings@1339 211 return;
nickjillings@1339 212 }
nickjillings@1339 213 }
nickjillings@1318 214
nickjillings@1318 215 // Detect the interface to use and load the relevant javascripts.
nickjillings@1318 216 var interfaceJS = document.createElement('script');
nickjillings@1318 217 interfaceJS.setAttribute("type","text/javascript");
nickjillings@1329 218 switch(specification.interface)
nickjillings@1329 219 {
nickjillings@1329 220 case "APE":
nickjillings@1341 221 interfaceJS.setAttribute("src","interfaces/ape.js");
nickjillings@1318 222
nickjillings@1318 223 // APE comes with a css file
nickjillings@1318 224 var css = document.createElement('link');
nickjillings@1318 225 css.rel = 'stylesheet';
nickjillings@1318 226 css.type = 'text/css';
nickjillings@1341 227 css.href = 'interfaces/ape.css';
nickjillings@1318 228
nickjillings@1318 229 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1329 230 break;
nickjillings@1329 231
nickjillings@1329 232 case "MUSHRA":
nickjillings@1341 233 interfaceJS.setAttribute("src","interfaces/mushra.js");
nickjillings@1318 234
nickjillings@1318 235 // MUSHRA comes with a css file
nickjillings@1318 236 var css = document.createElement('link');
nickjillings@1318 237 css.rel = 'stylesheet';
nickjillings@1318 238 css.type = 'text/css';
nickjillings@1341 239 css.href = 'interfaces/mushra.css';
nickjillings@1318 240
nickjillings@1318 241 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1329 242 break;
nickjillings@1329 243
nickjillings@1329 244 case "AB":
nickjillings@1341 245 interfaceJS.setAttribute("src","interfaces/AB.js");
nickjillings@1329 246
nickjillings@1329 247 // AB comes with a css file
nickjillings@1329 248 var css = document.createElement('link');
nickjillings@1329 249 css.rel = 'stylesheet';
nickjillings@1329 250 css.type = 'text/css';
nickjillings@1341 251 css.href = 'interfaces/AB.css';
nickjillings@1329 252
nickjillings@1329 253 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1345 254 break;
nickjillings@1345 255 case "Bipolar":
nickjillings@1345 256 case "ACR":
nickjillings@1345 257 case "DCR":
nickjillings@1345 258 case "CCR":
nickjillings@1343 259 case "ABC":
nickjillings@1343 260 // Above enumerate to horizontal sliders
nickjillings@1343 261 interfaceJS.setAttribute("src","interfaces/horizontal-sliders.js");
nickjillings@1343 262
nickjillings@1343 263 // horizontal-sliders comes with a css file
nickjillings@1343 264 var css = document.createElement('link');
nickjillings@1343 265 css.rel = 'stylesheet';
nickjillings@1343 266 css.type = 'text/css';
nickjillings@1343 267 css.href = 'interfaces/horizontal-sliders.css';
nickjillings@1343 268
nickjillings@1343 269 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1345 270 break;
nickjillings@1345 271 case "discrete":
nickjillings@1345 272 case "likert":
nickjillings@1345 273 // Above enumerate to horizontal discrete radios
nickjillings@1345 274 interfaceJS.setAttribute("src","interfaces/discrete.js");
nickjillings@1345 275
nickjillings@1345 276 // horizontal-sliders comes with a css file
nickjillings@1345 277 var css = document.createElement('link');
nickjillings@1345 278 css.rel = 'stylesheet';
nickjillings@1345 279 css.type = 'text/css';
nickjillings@1345 280 css.href = 'interfaces/discrete.css';
nickjillings@1345 281
nickjillings@1345 282 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1345 283 break;
nickjillings@1318 284 }
nickjillings@1318 285 document.getElementsByTagName("head")[0].appendChild(interfaceJS);
nickjillings@1318 286
nickjillings@1318 287 // Create the audio engine object
nickjillings@1318 288 audioEngineContext = new AudioEngine(specification);
nickjillings@1318 289
nickjillings@1324 290 $(specification.pages).each(function(index,elem){
nickjillings@1318 291 $(elem.audioElements).each(function(i,audioElem){
nickjillings@1324 292 var URL = elem.hostURL + audioElem.url;
nickjillings@1318 293 var buffer = null;
nickjillings@1318 294 for (var i=0; i<audioEngineContext.buffers.length; i++)
nickjillings@1318 295 {
nickjillings@1318 296 if (URL == audioEngineContext.buffers[i].url)
nickjillings@1318 297 {
nickjillings@1318 298 buffer = audioEngineContext.buffers[i];
nickjillings@1318 299 break;
nickjillings@1318 300 }
nickjillings@1318 301 }
nickjillings@1318 302 if (buffer == null)
nickjillings@1318 303 {
nickjillings@1318 304 buffer = new audioEngineContext.bufferObj();
nickjillings@1318 305 buffer.getMedia(URL);
nickjillings@1318 306 audioEngineContext.buffers.push(buffer);
nickjillings@1318 307 }
nickjillings@1318 308 });
nickjillings@1318 309 });
nickjillings@1318 310 }
nickjillings@1318 311
nickjillings@1318 312 function createProjectSave(destURL) {
nickjillings@1318 313 // Save the data from interface into XML and send to destURL
nickjillings@1318 314 // If destURL is null then download XML in client
nickjillings@1318 315 // Now time to render file locally
nickjillings@1318 316 var xmlDoc = interfaceXMLSave();
nickjillings@1318 317 var parent = document.createElement("div");
nickjillings@1318 318 parent.appendChild(xmlDoc);
nickjillings@1318 319 var file = [parent.innerHTML];
nickjillings@1318 320 if (destURL == "null" || destURL == undefined) {
nickjillings@1318 321 var bb = new Blob(file,{type : 'application/xml'});
nickjillings@1318 322 var dnlk = window.URL.createObjectURL(bb);
nickjillings@1318 323 var a = document.createElement("a");
nickjillings@1318 324 a.hidden = '';
nickjillings@1318 325 a.href = dnlk;
nickjillings@1318 326 a.download = "save.xml";
nickjillings@1318 327 a.textContent = "Save File";
nickjillings@1318 328
nickjillings@1318 329 popup.showPopup();
nickjillings@1332 330 popup.popupContent.innerHTML = "</span>Please save the file below to give to your test supervisor</span><br>";
nickjillings@1318 331 popup.popupContent.appendChild(a);
nickjillings@1318 332 } else {
nickjillings@1318 333 var xmlhttp = new XMLHttpRequest;
nickjillings@1318 334 xmlhttp.open("POST",destURL,true);
nickjillings@1318 335 xmlhttp.setRequestHeader('Content-Type', 'text/xml');
nickjillings@1318 336 xmlhttp.onerror = function(){
nickjillings@1318 337 console.log('Error saving file to server! Presenting download locally');
nickjillings@1318 338 createProjectSave(null);
nickjillings@1318 339 };
nickjillings@1318 340 xmlhttp.onreadystatechange = function() {
nickjillings@1318 341 console.log(xmlhttp.status);
nickjillings@1318 342 if (xmlhttp.status != 200 && xmlhttp.readyState == 4) {
nickjillings@1318 343 createProjectSave(null);
nickjillings@1318 344 } else {
nickjillings@1318 345 if (xmlhttp.responseXML == null)
nickjillings@1318 346 {
nickjillings@1324 347 createProjectSave('null');
nickjillings@1318 348 }
nickjillings@1318 349 var response = xmlhttp.responseXML.childNodes[0];
nickjillings@1318 350 if (response.getAttribute('state') == "OK")
nickjillings@1318 351 {
nickjillings@1318 352 var file = response.getElementsByTagName('file')[0];
nickjillings@1318 353 console.log('Save OK: Filename '+file.textContent+','+file.getAttribute('bytes')+'B');
nickjillings@1318 354 popup.showPopup();
nickjillings@1318 355 popup.popupContent.innerHTML = null;
nickjillings@1318 356 popup.popupContent.textContent = "Thank you!";
nickjillings@1318 357 } else {
nickjillings@1318 358 var message = response.getElementsByTagName('message')[0];
nickjillings@1318 359 errorSessionDump(message.textContent);
nickjillings@1318 360 }
nickjillings@1318 361 }
nickjillings@1318 362 };
nickjillings@1318 363 xmlhttp.send(file);
nickjillings@1332 364 popup.showPopup();
nickjillings@1332 365 popup.popupContent.innerHTML = null;
nickjillings@1332 366 popup.popupContent.textContent = "Submitting. Please Wait";
nickjillings@1318 367 }
nickjillings@1318 368 }
nickjillings@1318 369
nickjillings@1318 370 function errorSessionDump(msg){
nickjillings@1318 371 // Create the partial interface XML save
nickjillings@1318 372 // Include error node with message on why the dump occured
nickjillings@1318 373 popup.showPopup();
nickjillings@1318 374 popup.popupContent.innerHTML = null;
nickjillings@1318 375 var err = document.createElement('error');
nickjillings@1318 376 var parent = document.createElement("div");
nickjillings@1318 377 if (typeof msg === "object")
nickjillings@1318 378 {
nickjillings@1318 379 err.appendChild(msg);
nickjillings@1318 380 popup.popupContent.appendChild(msg);
nickjillings@1318 381
nickjillings@1318 382 } else {
nickjillings@1318 383 err.textContent = msg;
nickjillings@1318 384 popup.popupContent.innerHTML = "ERROR : "+msg;
nickjillings@1318 385 }
nickjillings@1318 386 var xmlDoc = interfaceXMLSave();
nickjillings@1318 387 xmlDoc.appendChild(err);
nickjillings@1318 388 parent.appendChild(xmlDoc);
nickjillings@1318 389 var file = [parent.innerHTML];
nickjillings@1318 390 var bb = new Blob(file,{type : 'application/xml'});
nickjillings@1318 391 var dnlk = window.URL.createObjectURL(bb);
nickjillings@1318 392 var a = document.createElement("a");
nickjillings@1318 393 a.hidden = '';
nickjillings@1318 394 a.href = dnlk;
nickjillings@1318 395 a.download = "save.xml";
nickjillings@1318 396 a.textContent = "Save File";
nickjillings@1318 397
nickjillings@1318 398
nickjillings@1318 399
nickjillings@1318 400 popup.popupContent.appendChild(a);
nickjillings@1318 401 }
nickjillings@1318 402
nickjillings@1318 403 // Only other global function which must be defined in the interface class. Determines how to create the XML document.
nickjillings@1318 404 function interfaceXMLSave(){
nickjillings@1318 405 // Create the XML string to be exported with results
nickjillings@1324 406 return storage.finish();
nickjillings@1318 407 }
nickjillings@1318 408
nickjillings@1318 409 function linearToDecibel(gain)
nickjillings@1318 410 {
nickjillings@1318 411 return 20.0*Math.log10(gain);
nickjillings@1318 412 }
nickjillings@1318 413
nickjillings@1318 414 function decibelToLinear(gain)
nickjillings@1318 415 {
nickjillings@1318 416 return Math.pow(10,gain/20.0);
nickjillings@1318 417 }
nickjillings@1318 418
nickjillings@1318 419 function interfacePopup() {
nickjillings@1318 420 // Creates an object to manage the popup
nickjillings@1318 421 this.popup = null;
nickjillings@1318 422 this.popupContent = null;
nickjillings@1318 423 this.popupTitle = null;
nickjillings@1318 424 this.popupResponse = null;
nickjillings@1318 425 this.buttonProceed = null;
nickjillings@1318 426 this.buttonPrevious = null;
nickjillings@1318 427 this.popupOptions = null;
nickjillings@1318 428 this.currentIndex = null;
nickjillings@1324 429 this.node = null;
nickjillings@1324 430 this.store = null;
nickjillings@1318 431 $(window).keypress(function(e){
nickjillings@1318 432 if (e.keyCode == 13 && popup.popup.style.visibility == 'visible')
nickjillings@1318 433 {
nickjillings@1318 434 console.log(e);
nickjillings@1318 435 popup.buttonProceed.onclick();
nickjillings@1318 436 e.preventDefault();
nickjillings@1318 437 }
nickjillings@1318 438 });
nickjillings@1318 439
nickjillings@1318 440 this.createPopup = function(){
nickjillings@1318 441 // Create popup window interface
nickjillings@1318 442 var insertPoint = document.getElementById("topLevelBody");
nickjillings@1318 443 var blank = document.createElement('div');
nickjillings@1318 444 blank.className = 'testHalt';
nickjillings@1318 445
nickjillings@1318 446 this.popup = document.createElement('div');
nickjillings@1318 447 this.popup.id = 'popupHolder';
nickjillings@1318 448 this.popup.className = 'popupHolder';
nickjillings@1318 449 this.popup.style.position = 'absolute';
nickjillings@1318 450 this.popup.style.left = (window.innerWidth/2)-250 + 'px';
nickjillings@1318 451 this.popup.style.top = (window.innerHeight/2)-125 + 'px';
nickjillings@1318 452
nickjillings@1318 453 this.popupContent = document.createElement('div');
nickjillings@1318 454 this.popupContent.id = 'popupContent';
nickjillings@1318 455 this.popupContent.style.marginTop = '20px';
nickjillings@1318 456 this.popupContent.style.marginBottom = '5px';
nickjillings@1318 457 this.popup.appendChild(this.popupContent);
nickjillings@1318 458
nickjillings@1318 459 var titleHolder = document.createElement('div');
nickjillings@1318 460 titleHolder.id = 'popupTitleHolder';
nickjillings@1318 461 titleHolder.align = 'center';
nickjillings@1318 462 titleHolder.style.width = 'inherit';
nickjillings@1318 463 titleHolder.style.minHeight = '25px';
nickjillings@1318 464 titleHolder.style.maxHeight = '250px';
nickjillings@1318 465 titleHolder.style.overflow = 'auto';
nickjillings@1318 466 titleHolder.style.marginBottom = '5px';
nickjillings@1318 467
nickjillings@1318 468 this.popupTitle = document.createElement('span');
nickjillings@1318 469 this.popupTitle.id = 'popupTitle';
nickjillings@1318 470 titleHolder.appendChild(this.popupTitle);
nickjillings@1318 471 this.popupContent.appendChild(titleHolder);
nickjillings@1318 472
nickjillings@1318 473 this.popupResponse = document.createElement('div');
nickjillings@1318 474 this.popupResponse.id = 'popupResponse';
nickjillings@1318 475 this.popupResponse.align = 'center';
nickjillings@1318 476 this.popupResponse.style.width = 'inherit';
nickjillings@1318 477 this.popupResponse.style.minHeight = '50px';
nickjillings@1318 478 this.popupResponse.style.maxHeight = '320px';
nickjillings@1318 479 this.popupResponse.style.overflow = 'auto';
nickjillings@1318 480 this.popupContent.appendChild(this.popupResponse);
nickjillings@1318 481
nickjillings@1318 482 this.buttonProceed = document.createElement('button');
nickjillings@1318 483 this.buttonProceed.className = 'popupButton';
nickjillings@1318 484 this.buttonProceed.position = 'relative';
nickjillings@1318 485 this.buttonProceed.style.left = '390px';
nickjillings@1318 486 this.buttonProceed.innerHTML = 'Next';
nickjillings@1318 487 this.buttonProceed.onclick = function(){popup.proceedClicked();};
nickjillings@1318 488
nickjillings@1318 489 this.buttonPrevious = document.createElement('button');
nickjillings@1318 490 this.buttonPrevious.className = 'popupButton';
nickjillings@1318 491 this.buttonPrevious.position = 'relative';
nickjillings@1318 492 this.buttonPrevious.style.left = '10px';
nickjillings@1318 493 this.buttonPrevious.innerHTML = 'Back';
nickjillings@1318 494 this.buttonPrevious.onclick = function(){popup.previousClick();};
nickjillings@1318 495
nickjillings@1318 496 this.popupContent.appendChild(this.buttonPrevious);
nickjillings@1318 497 this.popupContent.appendChild(this.buttonProceed);
nickjillings@1318 498
nickjillings@1318 499 this.popup.style.zIndex = -1;
nickjillings@1318 500 this.popup.style.visibility = 'hidden';
nickjillings@1318 501 blank.style.zIndex = -2;
nickjillings@1318 502 blank.style.visibility = 'hidden';
nickjillings@1318 503 insertPoint.appendChild(this.popup);
nickjillings@1318 504 insertPoint.appendChild(blank);
nickjillings@1318 505 };
nickjillings@1318 506
nickjillings@1318 507 this.showPopup = function(){
nickjillings@1318 508 if (this.popup == null) {
nickjillings@1318 509 this.createPopup();
nickjillings@1318 510 }
nickjillings@1318 511 this.popup.style.zIndex = 3;
nickjillings@1318 512 this.popup.style.visibility = 'visible';
nickjillings@1318 513 var blank = document.getElementsByClassName('testHalt')[0];
nickjillings@1318 514 blank.style.zIndex = 2;
nickjillings@1318 515 blank.style.visibility = 'visible';
nickjillings@1318 516 };
nickjillings@1318 517
nickjillings@1318 518 this.hidePopup = function(){
nickjillings@1318 519 this.popup.style.zIndex = -1;
nickjillings@1318 520 this.popup.style.visibility = 'hidden';
nickjillings@1318 521 var blank = document.getElementsByClassName('testHalt')[0];
nickjillings@1318 522 blank.style.zIndex = -2;
nickjillings@1318 523 blank.style.visibility = 'hidden';
nickjillings@1318 524 this.buttonPrevious.style.visibility = 'inherit';
nickjillings@1318 525 };
nickjillings@1318 526
nickjillings@1318 527 this.postNode = function() {
nickjillings@1318 528 // This will take the node from the popupOptions and display it
nickjillings@1318 529 var node = this.popupOptions[this.currentIndex];
nickjillings@1318 530 this.popupResponse.innerHTML = null;
nickjillings@1324 531 this.popupTitle.textContent = node.specification.statement;
nickjillings@1324 532 if (node.specification.type == 'question') {
nickjillings@1318 533 var textArea = document.createElement('textarea');
nickjillings@1324 534 switch (node.specification.boxsize) {
nickjillings@1318 535 case 'small':
nickjillings@1318 536 textArea.cols = "20";
nickjillings@1318 537 textArea.rows = "1";
nickjillings@1318 538 break;
nickjillings@1318 539 case 'normal':
nickjillings@1318 540 textArea.cols = "30";
nickjillings@1318 541 textArea.rows = "2";
nickjillings@1318 542 break;
nickjillings@1318 543 case 'large':
nickjillings@1318 544 textArea.cols = "40";
nickjillings@1318 545 textArea.rows = "5";
nickjillings@1318 546 break;
nickjillings@1318 547 case 'huge':
nickjillings@1318 548 textArea.cols = "50";
nickjillings@1318 549 textArea.rows = "10";
nickjillings@1318 550 break;
nickjillings@1318 551 }
nickjillings@1361 552 if (node.response == undefined) {
nickjillings@1361 553 node.response = "";
nickjillings@1361 554 } else {
nickjillings@1361 555 textArea.value = node.response;
nickjillings@1361 556 }
nickjillings@1318 557 this.popupResponse.appendChild(textArea);
nickjillings@1318 558 textArea.focus();
nickjillings@1324 559 } else if (node.specification.type == 'checkbox') {
nickjillings@1361 560 if (node.response == undefined) {
nickjillings@1361 561 node.response = Array(node.specification.options.length);
nickjillings@1361 562 }
nickjillings@1361 563 var index = 0;
nickjillings@1324 564 for (var option of node.specification.options) {
nickjillings@1318 565 var input = document.createElement('input');
nickjillings@1320 566 input.id = option.name;
nickjillings@1318 567 input.type = 'checkbox';
nickjillings@1318 568 var span = document.createElement('span');
nickjillings@1318 569 span.textContent = option.text;
nickjillings@1318 570 var hold = document.createElement('div');
nickjillings@1318 571 hold.setAttribute('name','option');
nickjillings@1318 572 hold.style.padding = '4px';
nickjillings@1318 573 hold.appendChild(input);
nickjillings@1318 574 hold.appendChild(span);
nickjillings@1324 575 this.popupResponse.appendChild(hold);
nickjillings@1361 576 if (node.response[index] != undefined){
nickjillings@1361 577 if (node.response[index].checked == true) {
nickjillings@1361 578 input.checked = "true";
nickjillings@1361 579 }
nickjillings@1361 580 }
nickjillings@1361 581 index++;
nickjillings@1318 582 }
nickjillings@1324 583 } else if (node.specification.type == 'radio') {
nickjillings@1361 584 if (node.response == undefined) {
nickjillings@1361 585 node.response = {name: "", text: ""};
nickjillings@1361 586 }
nickjillings@1361 587 var index = 0;
nickjillings@1324 588 for (var option of node.specification.options) {
nickjillings@1318 589 var input = document.createElement('input');
nickjillings@1318 590 input.id = option.name;
nickjillings@1318 591 input.type = 'radio';
nickjillings@1324 592 input.name = node.specification.id;
nickjillings@1318 593 var span = document.createElement('span');
nickjillings@1318 594 span.textContent = option.text;
nickjillings@1318 595 var hold = document.createElement('div');
nickjillings@1318 596 hold.setAttribute('name','option');
nickjillings@1318 597 hold.style.padding = '4px';
nickjillings@1318 598 hold.appendChild(input);
nickjillings@1318 599 hold.appendChild(span);
nickjillings@1324 600 this.popupResponse.appendChild(hold);
nickjillings@1361 601 if (input.id == node.response.name) {
nickjillings@1361 602 input.checked = "true";
nickjillings@1361 603 }
nickjillings@1318 604 }
nickjillings@1324 605 } else if (node.specification.type == 'number') {
nickjillings@1318 606 var input = document.createElement('input');
nickjillings@1318 607 input.type = 'textarea';
nickjillings@1324 608 if (node.min != null) {input.min = node.specification.min;}
nickjillings@1324 609 if (node.max != null) {input.max = node.specification.max;}
nickjillings@1324 610 if (node.step != null) {input.step = node.specification.step;}
nickjillings@1361 611 if (node.response != undefined) {
nickjillings@1361 612 input.value = node.response;
nickjillings@1361 613 }
nickjillings@1318 614 this.popupResponse.appendChild(input);
nickjillings@1318 615 }
nickjillings@1318 616 var content_height = Number(this.popup.offsetHeight.toFixed());
nickjillings@1318 617 content_height -= Number(this.popupContent.offsetHeight.toFixed());
nickjillings@1318 618 content_height -=Number(this.buttonProceed.offsetHeight.toFixed());
nickjillings@1318 619 content_height = content_height + "px";
nickjillings@1318 620 this.buttonProceed.style.top = content_height;
nickjillings@1318 621 this.buttonPrevious.style.top = content_height;
nickjillings@1318 622 if(this.currentIndex+1 == this.popupOptions.length) {
nickjillings@1324 623 if (this.node.location == "pre") {
nickjillings@1318 624 this.buttonProceed.textContent = 'Start';
nickjillings@1318 625 } else {
nickjillings@1318 626 this.buttonProceed.textContent = 'Submit';
nickjillings@1318 627 }
nickjillings@1318 628 } else {
nickjillings@1318 629 this.buttonProceed.textContent = 'Next';
nickjillings@1318 630 }
nickjillings@1318 631 if(this.currentIndex > 0)
nickjillings@1318 632 this.buttonPrevious.style.visibility = 'visible';
nickjillings@1318 633 else
nickjillings@1318 634 this.buttonPrevious.style.visibility = 'hidden';
nickjillings@1318 635 };
nickjillings@1318 636
nickjillings@1324 637 this.initState = function(node,store) {
nickjillings@1318 638 //Call this with your preTest and postTest nodes when needed to
nickjillings@1318 639 // initialise the popup procedure.
nickjillings@1324 640 if (node.options.length > 0) {
nickjillings@1324 641 this.popupOptions = [];
nickjillings@1324 642 this.node = node;
nickjillings@1324 643 this.store = store;
nickjillings@1324 644 for (var opt of node.options)
nickjillings@1324 645 {
nickjillings@1324 646 this.popupOptions.push({
nickjillings@1324 647 specification: opt,
nickjillings@1324 648 response: null
nickjillings@1324 649 });
nickjillings@1324 650 }
nickjillings@1318 651 this.currentIndex = 0;
nickjillings@1318 652 this.showPopup();
nickjillings@1318 653 this.postNode();
nickjillings@1318 654 } else {
nickjillings@1318 655 advanceState();
nickjillings@1318 656 }
nickjillings@1318 657 };
nickjillings@1318 658
nickjillings@1318 659 this.proceedClicked = function() {
nickjillings@1318 660 // Each time the popup button is clicked!
nickjillings@1318 661 var node = this.popupOptions[this.currentIndex];
nickjillings@1324 662 if (node.specification.type == 'question') {
nickjillings@1318 663 // Must extract the question data
nickjillings@1318 664 var textArea = $(popup.popupContent).find('textarea')[0];
nickjillings@1324 665 if (node.specification.mandatory == true && textArea.value.length == 0) {
nickjillings@1318 666 alert('This question is mandatory');
nickjillings@1318 667 return;
nickjillings@1318 668 } else {
nickjillings@1318 669 // Save the text content
nickjillings@1324 670 console.log("Question: "+ node.specification.statement);
nickjillings@1318 671 console.log("Question Response: "+ textArea.value);
nickjillings@1324 672 node.response = textArea.value;
nickjillings@1318 673 }
nickjillings@1324 674 } else if (node.specification.type == 'checkbox') {
nickjillings@1318 675 // Must extract checkbox data
nickjillings@1326 676 console.log("Checkbox: "+ node.specification.statement);
nickjillings@1324 677 var inputs = this.popupResponse.getElementsByTagName('input');
nickjillings@1324 678 node.response = [];
nickjillings@1324 679 for (var i=0; i<node.specification.options.length; i++) {
nickjillings@1324 680 node.response.push({
nickjillings@1324 681 name: node.specification.options[i].name,
nickjillings@1324 682 text: node.specification.options[i].text,
nickjillings@1324 683 checked: inputs[i].checked
nickjillings@1324 684 });
nickjillings@1326 685 console.log(node.specification.options[i].name+": "+ inputs[i].checked);
nickjillings@1324 686 }
nickjillings@1324 687 } else if (node.specification.type == "radio") {
nickjillings@1318 688 var optHold = this.popupResponse;
nickjillings@1324 689 console.log("Radio: "+ node.specification.statement);
nickjillings@1324 690 node.response = null;
nickjillings@1318 691 var i=0;
nickjillings@1324 692 var inputs = optHold.getElementsByTagName('input');
nickjillings@1324 693 while(node.response == null) {
nickjillings@1324 694 if (i == inputs.length)
nickjillings@1324 695 {
nickjillings@1324 696 if (node.specification.mandatory == true)
nickjillings@1324 697 {
nickjillings@1324 698 alert("This radio is mandatory");
nickjillings@1324 699 } else {
nickjillings@1324 700 node.response = -1;
nickjillings@1324 701 }
nickjillings@1324 702 return;
nickjillings@1324 703 }
nickjillings@1324 704 if (inputs[i].checked == true) {
nickjillings@1324 705 node.response = node.specification.options[i];
nickjillings@1324 706 console.log("Selected: "+ node.specification.options[i].name);
nickjillings@1318 707 }
nickjillings@1318 708 i++;
nickjillings@1318 709 }
nickjillings@1324 710 } else if (node.specification.type == "number") {
nickjillings@1318 711 var input = this.popupContent.getElementsByTagName('input')[0];
nickjillings@1318 712 if (node.mandatory == true && input.value.length == 0) {
nickjillings@1318 713 alert('This question is mandatory. Please enter a number');
nickjillings@1318 714 return;
nickjillings@1318 715 }
nickjillings@1318 716 var enteredNumber = Number(input.value);
nickjillings@1318 717 if (isNaN(enteredNumber)) {
nickjillings@1318 718 alert('Please enter a valid number');
nickjillings@1318 719 return;
nickjillings@1318 720 }
nickjillings@1318 721 if (enteredNumber < node.min && node.min != null) {
nickjillings@1318 722 alert('Number is below the minimum value of '+node.min);
nickjillings@1318 723 return;
nickjillings@1318 724 }
nickjillings@1318 725 if (enteredNumber > node.max && node.max != null) {
nickjillings@1318 726 alert('Number is above the maximum value of '+node.max);
nickjillings@1318 727 return;
nickjillings@1318 728 }
nickjillings@1324 729 node.response = input.value;
nickjillings@1318 730 }
nickjillings@1318 731 this.currentIndex++;
nickjillings@1318 732 if (this.currentIndex < this.popupOptions.length) {
nickjillings@1318 733 this.postNode();
nickjillings@1318 734 } else {
nickjillings@1318 735 // Reached the end of the popupOptions
nickjillings@1318 736 this.hidePopup();
nickjillings@1324 737 for (var node of this.popupOptions)
nickjillings@1324 738 {
nickjillings@1324 739 this.store.postResult(node);
nickjillings@1318 740 }
nickjillings@1318 741 advanceState();
nickjillings@1318 742 }
nickjillings@1318 743 };
nickjillings@1318 744
nickjillings@1318 745 this.previousClick = function() {
nickjillings@1318 746 // Triggered when the 'Back' button is clicked in the survey
nickjillings@1318 747 if (this.currentIndex > 0) {
nickjillings@1318 748 this.currentIndex--;
nickjillings@1318 749 this.postNode();
nickjillings@1318 750 }
nickjillings@1318 751 };
nickjillings@1318 752
nickjillings@1318 753 this.resize = function(event)
nickjillings@1318 754 {
nickjillings@1318 755 // Called on window resize;
nickjillings@1344 756 if (this.popup != null) {
nickjillings@1344 757 this.popup.style.left = (window.innerWidth/2)-250 + 'px';
nickjillings@1344 758 this.popup.style.top = (window.innerHeight/2)-125 + 'px';
nickjillings@1344 759 var blank = document.getElementsByClassName('testHalt')[0];
nickjillings@1344 760 blank.style.width = window.innerWidth;
nickjillings@1344 761 blank.style.height = window.innerHeight;
nickjillings@1344 762 }
nickjillings@1318 763 };
nickjillings@1318 764 }
nickjillings@1318 765
nickjillings@1318 766 function advanceState()
nickjillings@1318 767 {
nickjillings@1318 768 // Just for complete clarity
nickjillings@1318 769 testState.advanceState();
nickjillings@1318 770 }
nickjillings@1318 771
nickjillings@1318 772 function stateMachine()
nickjillings@1318 773 {
nickjillings@1318 774 // Object prototype for tracking and managing the test state
nickjillings@1318 775 this.stateMap = [];
nickjillings@1324 776 this.preTestSurvey = null;
nickjillings@1324 777 this.postTestSurvey = null;
nickjillings@1318 778 this.stateIndex = null;
nickjillings@1324 779 this.currentStateMap = null;
nickjillings@1324 780 this.currentStatePosition = null;
nickjillings@1354 781 this.currentStore = null;
nickjillings@1318 782 this.initialise = function(){
nickjillings@1324 783
nickjillings@1324 784 // Get the data from Specification
nickjillings@1324 785 var pageHolder = [];
nickjillings@1324 786 for (var page of specification.pages)
nickjillings@1324 787 {
nickjillings@1324 788 pageHolder.push(page);
nickjillings@1324 789 }
nickjillings@1324 790 if (specification.randomiseOrder)
nickjillings@1324 791 {
nickjillings@1324 792 pageHolder = randomiseOrder(pageHolder);
nickjillings@1324 793 }
nickjillings@1324 794 for (var i=0; i<pageHolder.length; i++)
nickjillings@1324 795 {
nickjillings@1324 796 pageHolder[i].presentedId = i;
nickjillings@1324 797 }
nickjillings@1324 798 for (var i=0; i<specification.pages.length; i++)
nickjillings@1324 799 {
nickjillings@1324 800 if (specification.testPages < i && specification.testPages != 0) {break;}
nickjillings@1324 801 this.stateMap.push(pageHolder[i]);
nickjillings@1324 802
nickjillings@1324 803 }
nickjillings@1324 804 if (specification.preTest != null) {this.preTestSurvey = specification.preTest;}
nickjillings@1324 805 if (specification.postTest != null) {this.postTestSurvey = specification.postTest;}
nickjillings@1324 806
nickjillings@1318 807 if (this.stateMap.length > 0) {
nickjillings@1318 808 if(this.stateIndex != null) {
nickjillings@1318 809 console.log('NOTE - State already initialise');
nickjillings@1318 810 }
nickjillings@1318 811 this.stateIndex = -1;
nickjillings@1318 812 } else {
nickjillings@1318 813 console.log('FATAL - StateMap not correctly constructed. EMPTY_STATE_MAP');
nickjillings@1318 814 }
nickjillings@1318 815 };
nickjillings@1318 816 this.advanceState = function(){
nickjillings@1318 817 if (this.stateIndex == null) {
nickjillings@1318 818 this.initialise();
nickjillings@1318 819 }
nickjillings@1318 820 if (this.stateIndex == -1) {
nickjillings@1342 821 this.stateIndex++;
nickjillings@1318 822 console.log('Starting test...');
nickjillings@1324 823 if (this.preTestSurvey != null)
nickjillings@1324 824 {
nickjillings@1324 825 popup.initState(this.preTestSurvey,storage.globalPreTest);
nickjillings@1342 826 } else {
nickjillings@1342 827 this.advanceState();
nickjillings@1318 828 }
nickjillings@1324 829 } else if (this.stateIndex == this.stateMap.length)
nickjillings@1324 830 {
nickjillings@1324 831 // All test pages complete, post test
nickjillings@1324 832 console.log('Ending test ...');
nickjillings@1324 833 this.stateIndex++;
nickjillings@1324 834 if (this.postTestSurvey == null) {
nickjillings@1324 835 this.advanceState();
nickjillings@1318 836 } else {
nickjillings@1324 837 popup.initState(this.postTestSurvey,storage.globalPostTest);
nickjillings@1324 838 }
nickjillings@1324 839 } else if (this.stateIndex > this.stateMap.length)
nickjillings@1324 840 {
nickjillings@1324 841 createProjectSave(specification.projectReturn);
nickjillings@1324 842 }
nickjillings@1324 843 else
nickjillings@1324 844 {
nickjillings@1324 845 if (this.currentStateMap == null)
nickjillings@1324 846 {
nickjillings@1318 847 this.currentStateMap = this.stateMap[this.stateIndex];
nickjillings@1334 848 if (this.currentStateMap.randomiseOrder)
nickjillings@1334 849 {
nickjillings@1334 850 this.currentStateMap.audioElements = randomiseOrder(this.currentStateMap.audioElements);
nickjillings@1334 851 }
nickjillings@1354 852 this.currentStore = storage.createTestPageStore(this.currentStateMap);
nickjillings@1324 853 if (this.currentStateMap.preTest != null)
nickjillings@1324 854 {
nickjillings@1324 855 this.currentStatePosition = 'pre';
nickjillings@1324 856 popup.initState(this.currentStateMap.preTest,storage.testPages[this.stateIndex].preTest);
nickjillings@1318 857 } else {
nickjillings@1324 858 this.currentStatePosition = 'test';
nickjillings@1324 859 }
nickjillings@1324 860 interfaceContext.newPage(this.currentStateMap,storage.testPages[this.stateIndex]);
nickjillings@1324 861 return;
nickjillings@1324 862 }
nickjillings@1324 863 switch(this.currentStatePosition)
nickjillings@1324 864 {
nickjillings@1324 865 case 'pre':
nickjillings@1324 866 this.currentStatePosition = 'test';
nickjillings@1324 867 break;
nickjillings@1324 868 case 'test':
nickjillings@1324 869 this.currentStatePosition = 'post';
nickjillings@1324 870 // Save the data
nickjillings@1324 871 this.testPageCompleted();
nickjillings@1324 872 if (this.currentStateMap.postTest == null)
nickjillings@1324 873 {
nickjillings@1318 874 this.advanceState();
nickjillings@1324 875 return;
nickjillings@1324 876 } else {
nickjillings@1324 877 popup.initState(this.currentStateMap.postTest,storage.testPages[this.stateIndex].postTest);
nickjillings@1318 878 }
nickjillings@1324 879 break;
nickjillings@1324 880 case 'post':
nickjillings@1324 881 this.stateIndex++;
nickjillings@1324 882 this.currentStateMap = null;
nickjillings@1324 883 this.advanceState();
nickjillings@1324 884 break;
nickjillings@1324 885 };
nickjillings@1318 886 }
nickjillings@1318 887 };
nickjillings@1318 888
nickjillings@1324 889 this.testPageCompleted = function() {
nickjillings@1318 890 // Function called each time a test page has been completed
nickjillings@1324 891 var storePoint = storage.testPages[this.stateIndex];
nickjillings@1324 892 // First get the test metric
nickjillings@1324 893
nickjillings@1324 894 var metric = storePoint.XMLDOM.getElementsByTagName('metric')[0];
nickjillings@1318 895 if (audioEngineContext.metric.enableTestTimer)
nickjillings@1318 896 {
nickjillings@1324 897 var testTime = storePoint.parent.document.createElement('metricresult');
nickjillings@1318 898 testTime.id = 'testTime';
nickjillings@1318 899 testTime.textContent = audioEngineContext.timer.testDuration;
nickjillings@1318 900 metric.appendChild(testTime);
nickjillings@1318 901 }
nickjillings@1324 902
nickjillings@1318 903 var audioObjects = audioEngineContext.audioObjects;
nickjillings@1324 904 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 905 {
nickjillings@1324 906 ao.exportXMLDOM();
nickjillings@1318 907 }
nickjillings@1324 908 for (var element of interfaceContext.commentQuestions)
nickjillings@1324 909 {
nickjillings@1324 910 element.exportXMLDOM(storePoint);
nickjillings@1324 911 }
nickjillings@1324 912 pageXMLSave(storePoint.XMLDOM, this.currentStateMap);
nickjillings@1318 913 };
nickjillings@1318 914 }
nickjillings@1318 915
nickjillings@1318 916 function AudioEngine(specification) {
nickjillings@1318 917
nickjillings@1318 918 // Create two output paths, the main outputGain and fooGain.
nickjillings@1318 919 // Output gain is default to 1 and any items for playback route here
nickjillings@1318 920 // Foo gain is used for analysis to ensure paths get processed, but are not heard
nickjillings@1318 921 // because web audio will optimise and any route which does not go to the destination gets ignored.
nickjillings@1318 922 this.outputGain = audioContext.createGain();
nickjillings@1318 923 this.fooGain = audioContext.createGain();
nickjillings@1318 924 this.fooGain.gain = 0;
nickjillings@1318 925
nickjillings@1318 926 // Use this to detect playback state: 0 - stopped, 1 - playing
nickjillings@1318 927 this.status = 0;
nickjillings@1318 928
nickjillings@1318 929 // Connect both gains to output
nickjillings@1318 930 this.outputGain.connect(audioContext.destination);
nickjillings@1318 931 this.fooGain.connect(audioContext.destination);
nickjillings@1318 932
nickjillings@1318 933 // Create the timer Object
nickjillings@1318 934 this.timer = new timer();
nickjillings@1318 935 // Create session metrics
nickjillings@1318 936 this.metric = new sessionMetrics(this,specification);
nickjillings@1318 937
nickjillings@1318 938 this.loopPlayback = false;
nickjillings@1318 939
nickjillings@1324 940 this.pageStore = null;
nickjillings@1324 941
nickjillings@1318 942 // Create store for new audioObjects
nickjillings@1318 943 this.audioObjects = [];
nickjillings@1318 944
nickjillings@1318 945 this.buffers = [];
nickjillings@1318 946 this.bufferObj = function()
nickjillings@1318 947 {
nickjillings@1318 948 this.url = null;
nickjillings@1318 949 this.buffer = null;
nickjillings@1318 950 this.xmlRequest = new XMLHttpRequest();
nickjillings@1318 951 this.xmlRequest.parent = this;
nickjillings@1318 952 this.users = [];
nickjillings@1342 953 this.ready = function()
nickjillings@1342 954 {
nickjillings@1342 955 for (var i=0; i<this.users.length; i++)
nickjillings@1342 956 {
nickjillings@1342 957 this.users[i].state = 1;
nickjillings@1342 958 if (this.users[i].interfaceDOM != null)
nickjillings@1342 959 {
nickjillings@1342 960 this.users[i].bufferLoaded(this);
nickjillings@1342 961 }
nickjillings@1342 962 }
nickjillings@1342 963 };
nickjillings@1318 964 this.getMedia = function(url) {
nickjillings@1318 965 this.url = url;
nickjillings@1318 966 this.xmlRequest.open('GET',this.url,true);
nickjillings@1318 967 this.xmlRequest.responseType = 'arraybuffer';
nickjillings@1318 968
nickjillings@1318 969 var bufferObj = this;
nickjillings@1318 970
nickjillings@1318 971 // Create callback to decode the data asynchronously
nickjillings@1318 972 this.xmlRequest.onloadend = function() {
nickjillings@1353 973 // Use inbuilt WAVE decoder first
nickjillings@1353 974 var waveObj = new WAVE();
nickjillings@1353 975 if (waveObj.open(bufferObj.xmlRequest.response) == 0)
nickjillings@1353 976 {
nickjillings@1353 977 bufferObj.buffer = audioContext.createBuffer(waveObj.num_channels,waveObj.num_samples,waveObj.sample_rate);
nickjillings@1353 978 for (var c=0; c<waveObj.num_channels; c++)
nickjillings@1353 979 {
nickjillings@1353 980 var buffer_ptr = bufferObj.buffer.getChannelData(c);
nickjillings@1353 981 for (var n=0; n<waveObj.num_samples; n++)
nickjillings@1353 982 {
nickjillings@1353 983 buffer_ptr[n] = waveObj.decoded_data[c][n];
nickjillings@1353 984 }
nickjillings@1353 985 }
nickjillings@1353 986 delete waveObj;
nickjillings@1353 987 } else {
nickjillings@1353 988 audioContext.decodeAudioData(bufferObj.xmlRequest.response, function(decodedData) {
nickjillings@1353 989 bufferObj.buffer = decodedData;
nickjillings@1353 990 }, function(e){
nickjillings@1353 991 // Should only be called if there was an error, but sometimes gets called continuously
nickjillings@1353 992 // Check here if the error is genuine
nickjillings@1353 993 if (bufferObj.xmlRequest.response == undefined) {
nickjillings@1353 994 // Genuine error
nickjillings@1353 995 console.log('FATAL - Error loading buffer on '+audioObj.id);
nickjillings@1353 996 if (request.status == 404)
nickjillings@1353 997 {
nickjillings@1353 998 console.log('FATAL - Fragment '+audioObj.id+' 404 error');
nickjillings@1353 999 console.log('URL: '+audioObj.url);
nickjillings@1353 1000 errorSessionDump('Fragment '+audioObj.id+' 404 error');
nickjillings@1353 1001 }
nickjillings@1353 1002 }
nickjillings@1353 1003 });
nickjillings@1353 1004 }
nickjillings@1353 1005 if (bufferObj.buffer != undefined)
nickjillings@1353 1006 {
nickjillings@1353 1007 calculateLoudness(bufferObj,"I");
nickjillings@1353 1008 }
nickjillings@1318 1009 };
nickjillings@1318 1010 this.progress = 0;
nickjillings@1318 1011 this.progressCallback = function(event){
nickjillings@1318 1012 if (event.lengthComputable)
nickjillings@1318 1013 {
nickjillings@1318 1014 this.parent.progress = event.loaded / event.total;
nickjillings@1318 1015 for (var i=0; i<this.parent.users.length; i++)
nickjillings@1318 1016 {
nickjillings@1318 1017 if(this.parent.users[i].interfaceDOM != null)
nickjillings@1318 1018 {
nickjillings@1318 1019 if (typeof this.parent.users[i].interfaceDOM.updateLoading === "function")
nickjillings@1318 1020 {
nickjillings@1318 1021 this.parent.users[i].interfaceDOM.updateLoading(this.parent.progress*100);
nickjillings@1318 1022 }
nickjillings@1318 1023 }
nickjillings@1318 1024 }
nickjillings@1318 1025 }
nickjillings@1318 1026 };
nickjillings@1318 1027 this.xmlRequest.addEventListener("progress", this.progressCallback);
nickjillings@1318 1028 this.xmlRequest.send();
nickjillings@1318 1029 };
nickjillings@1318 1030 };
nickjillings@1318 1031
nickjillings@1318 1032 this.play = function(id) {
nickjillings@1318 1033 // Start the timer and set the audioEngine state to playing (1)
nickjillings@1318 1034 if (this.status == 0 && this.loopPlayback) {
nickjillings@1318 1035 // Check if all audioObjects are ready
nickjillings@1318 1036 if(this.checkAllReady())
nickjillings@1318 1037 {
nickjillings@1318 1038 this.status = 1;
nickjillings@1318 1039 this.setSynchronousLoop();
nickjillings@1318 1040 }
nickjillings@1318 1041 }
nickjillings@1318 1042 else
nickjillings@1318 1043 {
nickjillings@1318 1044 this.status = 1;
nickjillings@1318 1045 }
nickjillings@1318 1046 if (this.status== 1) {
nickjillings@1318 1047 this.timer.startTest();
nickjillings@1318 1048 if (id == undefined) {
nickjillings@1318 1049 id = -1;
nickjillings@1318 1050 console.log('FATAL - Passed id was undefined - AudioEngineContext.play(id)');
nickjillings@1318 1051 return;
nickjillings@1318 1052 } else {
nickjillings@1318 1053 interfaceContext.playhead.setTimePerPixel(this.audioObjects[id]);
nickjillings@1318 1054 }
nickjillings@1318 1055 if (this.loopPlayback) {
nickjillings@1360 1056 var setTime = audioContext.currentTime+2;
nickjillings@1318 1057 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1058 {
nickjillings@1360 1059 this.audioObjects[i].play(setTime-2);
nickjillings@1318 1060 if (id == i) {
nickjillings@1360 1061 this.audioObjects[i].loopStart(setTime);
nickjillings@1318 1062 } else {
nickjillings@1360 1063 this.audioObjects[i].loopStop(setTime);
nickjillings@1318 1064 }
nickjillings@1318 1065 }
nickjillings@1318 1066 } else {
nickjillings@1360 1067 var setTime = audioContext.currentTime+0.1;
nickjillings@1318 1068 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1069 {
nickjillings@1318 1070 if (i != id) {
nickjillings@1360 1071 this.audioObjects[i].stop(setTime);
nickjillings@1318 1072 } else if (i == id) {
nickjillings@1360 1073 this.audioObjects[id].play(setTime);
nickjillings@1318 1074 }
nickjillings@1318 1075 }
nickjillings@1318 1076 }
nickjillings@1318 1077 interfaceContext.playhead.start();
nickjillings@1318 1078 }
nickjillings@1318 1079 };
nickjillings@1318 1080
nickjillings@1318 1081 this.stop = function() {
nickjillings@1318 1082 // Send stop and reset command to all playback buffers and set audioEngine state to stopped (1)
nickjillings@1318 1083 if (this.status == 1) {
nickjillings@1360 1084 var setTime = audioContext.currentTime+0.1;
nickjillings@1318 1085 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1086 {
nickjillings@1360 1087 this.audioObjects[i].stop(setTime);
nickjillings@1318 1088 }
nickjillings@1318 1089 interfaceContext.playhead.stop();
nickjillings@1318 1090 this.status = 0;
nickjillings@1318 1091 }
nickjillings@1318 1092 };
nickjillings@1318 1093
nickjillings@1318 1094 this.newTrack = function(element) {
nickjillings@1318 1095 // Pull data from given URL into new audio buffer
nickjillings@1318 1096 // URLs must either be from the same source OR be setup to 'Access-Control-Allow-Origin'
nickjillings@1318 1097
nickjillings@1318 1098 // Create the audioObject with ID of the new track length;
nickjillings@1318 1099 audioObjectId = this.audioObjects.length;
nickjillings@1318 1100 this.audioObjects[audioObjectId] = new audioObject(audioObjectId);
nickjillings@1318 1101
nickjillings@1318 1102 // Check if audioObject buffer is currently stored by full URL
nickjillings@1324 1103 var URL = testState.currentStateMap.hostURL + element.url;
nickjillings@1318 1104 var buffer = null;
nickjillings@1318 1105 for (var i=0; i<this.buffers.length; i++)
nickjillings@1318 1106 {
nickjillings@1318 1107 if (URL == this.buffers[i].url)
nickjillings@1318 1108 {
nickjillings@1318 1109 buffer = this.buffers[i];
nickjillings@1318 1110 break;
nickjillings@1318 1111 }
nickjillings@1318 1112 }
nickjillings@1318 1113 if (buffer == null)
nickjillings@1318 1114 {
nickjillings@1318 1115 console.log("[WARN]: Buffer was not loaded in pre-test! "+URL);
nickjillings@1318 1116 buffer = new this.bufferObj();
nickjillings@1318 1117 buffer.getMedia(URL);
nickjillings@1318 1118 this.buffers.push(buffer);
nickjillings@1318 1119 }
nickjillings@1318 1120 this.audioObjects[audioObjectId].specification = element;
nickjillings@1318 1121 this.audioObjects[audioObjectId].url = URL;
nickjillings@1318 1122 buffer.users.push(this.audioObjects[audioObjectId]);
nickjillings@1324 1123 // Obtain store node
nickjillings@1324 1124 var aeNodes = this.pageStore.XMLDOM.getElementsByTagName('audioelement');
nickjillings@1324 1125 for (var i=0; i<aeNodes.length; i++)
nickjillings@1324 1126 {
nickjillings@1324 1127 if(aeNodes[i].id == element.id)
nickjillings@1324 1128 {
nickjillings@1324 1129 this.audioObjects[audioObjectId].storeDOM = aeNodes[i];
nickjillings@1324 1130 break;
nickjillings@1324 1131 }
nickjillings@1324 1132 }
nickjillings@1359 1133 if (buffer.buffer.lufs != undefined)
nickjillings@1318 1134 {
nickjillings@1318 1135 this.audioObjects[audioObjectId].bufferLoaded(buffer);
nickjillings@1318 1136 }
nickjillings@1318 1137 return this.audioObjects[audioObjectId];
nickjillings@1318 1138 };
nickjillings@1318 1139
nickjillings@1324 1140 this.newTestPage = function(store) {
nickjillings@1324 1141 this.pageStore = store;
nickjillings@1318 1142 this.state = 0;
nickjillings@1318 1143 this.audioObjectsReady = false;
nickjillings@1318 1144 this.metric.reset();
nickjillings@1318 1145 for (var i=0; i < this.buffers.length; i++)
nickjillings@1318 1146 {
nickjillings@1318 1147 this.buffers[i].users = [];
nickjillings@1318 1148 }
nickjillings@1318 1149 this.audioObjects = [];
nickjillings@1318 1150 };
nickjillings@1318 1151
nickjillings@1318 1152 this.checkAllPlayed = function() {
nickjillings@1318 1153 arr = [];
nickjillings@1318 1154 for (var id=0; id<this.audioObjects.length; id++) {
nickjillings@1318 1155 if (this.audioObjects[id].metric.wasListenedTo == false) {
nickjillings@1318 1156 arr.push(this.audioObjects[id].id);
nickjillings@1318 1157 }
nickjillings@1318 1158 }
nickjillings@1318 1159 return arr;
nickjillings@1318 1160 };
nickjillings@1318 1161
nickjillings@1318 1162 this.checkAllReady = function() {
nickjillings@1318 1163 var ready = true;
nickjillings@1318 1164 for (var i=0; i<this.audioObjects.length; i++) {
nickjillings@1318 1165 if (this.audioObjects[i].state == 0) {
nickjillings@1318 1166 // Track not ready
nickjillings@1318 1167 console.log('WAIT -- audioObject '+i+' not ready yet!');
nickjillings@1318 1168 ready = false;
nickjillings@1318 1169 };
nickjillings@1318 1170 }
nickjillings@1318 1171 return ready;
nickjillings@1318 1172 };
nickjillings@1318 1173
nickjillings@1318 1174 this.setSynchronousLoop = function() {
nickjillings@1318 1175 // Pads the signals so they are all exactly the same length
nickjillings@1318 1176 var length = 0;
nickjillings@1318 1177 var maxId;
nickjillings@1318 1178 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1179 {
nickjillings@1318 1180 if (length < this.audioObjects[i].buffer.buffer.length)
nickjillings@1318 1181 {
nickjillings@1318 1182 length = this.audioObjects[i].buffer.buffer.length;
nickjillings@1318 1183 maxId = i;
nickjillings@1318 1184 }
nickjillings@1318 1185 }
nickjillings@1318 1186 // Extract the audio and zero-pad
nickjillings@1318 1187 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1188 {
nickjillings@1318 1189 var orig = this.audioObjects[i].buffer.buffer;
nickjillings@1318 1190 var hold = audioContext.createBuffer(orig.numberOfChannels,length,orig.sampleRate);
nickjillings@1318 1191 for (var c=0; c<orig.numberOfChannels; c++)
nickjillings@1318 1192 {
nickjillings@1318 1193 var inData = hold.getChannelData(c);
nickjillings@1318 1194 var outData = orig.getChannelData(c);
nickjillings@1318 1195 for (var n=0; n<orig.length; n++)
nickjillings@1318 1196 {inData[n] = outData[n];}
nickjillings@1318 1197 }
nickjillings@1320 1198 hold.playbackGain = orig.playbackGain;
nickjillings@1318 1199 hold.lufs = orig.lufs;
nickjillings@1318 1200 this.audioObjects[i].buffer.buffer = hold;
nickjillings@1318 1201 }
nickjillings@1318 1202 };
nickjillings@1318 1203
nickjillings@1318 1204 }
nickjillings@1318 1205
nickjillings@1318 1206 function audioObject(id) {
nickjillings@1318 1207 // The main buffer object with common control nodes to the AudioEngine
nickjillings@1318 1208
nickjillings@1318 1209 this.specification;
nickjillings@1318 1210 this.id = id;
nickjillings@1318 1211 this.state = 0; // 0 - no data, 1 - ready
nickjillings@1318 1212 this.url = null; // Hold the URL given for the output back to the results.
nickjillings@1318 1213 this.metric = new metricTracker(this);
nickjillings@1324 1214 this.storeDOM = null;
nickjillings@1318 1215
nickjillings@1318 1216 // Bindings for GUI
nickjillings@1318 1217 this.interfaceDOM = null;
nickjillings@1318 1218 this.commentDOM = null;
nickjillings@1318 1219
nickjillings@1318 1220 // Create a buffer and external gain control to allow internal patching of effects and volume leveling.
nickjillings@1318 1221 this.bufferNode = undefined;
nickjillings@1318 1222 this.outputGain = audioContext.createGain();
nickjillings@1318 1223
nickjillings@1324 1224 this.onplayGain = 1.0;
nickjillings@1318 1225
nickjillings@1318 1226 // Connect buffer to the audio graph
nickjillings@1318 1227 this.outputGain.connect(audioEngineContext.outputGain);
nickjillings@1318 1228
nickjillings@1318 1229 // the audiobuffer is not designed for multi-start playback
nickjillings@1318 1230 // When stopeed, the buffer node is deleted and recreated with the stored buffer.
nickjillings@1318 1231 this.buffer;
nickjillings@1318 1232
nickjillings@1318 1233 this.bufferLoaded = function(callee)
nickjillings@1318 1234 {
nickjillings@1318 1235 // Called by the associated buffer when it has finished loading, will then 'bind' the buffer to the
nickjillings@1318 1236 // audioObject and trigger the interfaceDOM.enable() function for user feedback
nickjillings@1318 1237 if (audioEngineContext.loopPlayback){
nickjillings@1318 1238 // First copy the buffer into this.buffer
nickjillings@1318 1239 this.buffer = new audioEngineContext.bufferObj();
nickjillings@1318 1240 this.buffer.url = callee.url;
nickjillings@1318 1241 this.buffer.buffer = audioContext.createBuffer(callee.buffer.numberOfChannels, callee.buffer.length, callee.buffer.sampleRate);
nickjillings@1318 1242 for (var c=0; c<callee.buffer.numberOfChannels; c++)
nickjillings@1318 1243 {
nickjillings@1318 1244 var src = callee.buffer.getChannelData(c);
nickjillings@1318 1245 var dst = this.buffer.buffer.getChannelData(c);
nickjillings@1318 1246 for (var n=0; n<src.length; n++)
nickjillings@1318 1247 {
nickjillings@1318 1248 dst[n] = src[n];
nickjillings@1318 1249 }
nickjillings@1318 1250 }
nickjillings@1318 1251 } else {
nickjillings@1318 1252 this.buffer = callee;
nickjillings@1318 1253 }
nickjillings@1318 1254 this.state = 1;
nickjillings@1320 1255 this.buffer.buffer.playbackGain = callee.buffer.playbackGain;
nickjillings@1318 1256 this.buffer.buffer.lufs = callee.buffer.lufs;
nickjillings@1348 1257 var targetLUFS = this.specification.parent.loudness || specification.loudness;
nickjillings@1318 1258 if (typeof targetLUFS === "number")
nickjillings@1318 1259 {
nickjillings@1320 1260 this.buffer.buffer.playbackGain = decibelToLinear(targetLUFS - this.buffer.buffer.lufs);
nickjillings@1318 1261 } else {
nickjillings@1320 1262 this.buffer.buffer.playbackGain = 1.0;
nickjillings@1318 1263 }
nickjillings@1318 1264 if (this.interfaceDOM != null) {
nickjillings@1318 1265 this.interfaceDOM.enable();
nickjillings@1318 1266 }
nickjillings@1324 1267 this.onplayGain = decibelToLinear(this.specification.gain)*this.buffer.buffer.playbackGain;
nickjillings@1324 1268 this.storeDOM.setAttribute('playGain',linearToDecibel(this.onplayGain));
nickjillings@1318 1269 };
nickjillings@1325 1270
nickjillings@1325 1271 this.bindInterface = function(interfaceObject)
nickjillings@1325 1272 {
nickjillings@1325 1273 this.interfaceDOM = interfaceObject;
nickjillings@1325 1274 this.metric.initialise(interfaceObject.getValue());
nickjillings@1325 1275 if (this.state == 1)
nickjillings@1325 1276 {
nickjillings@1325 1277 this.interfaceDOM.enable();
nickjillings@1325 1278 }
nickjillings@1338 1279 this.storeDOM.setAttribute('presentedId',interfaceObject.getPresentedId());
nickjillings@1325 1280 };
nickjillings@1318 1281
nickjillings@1360 1282 this.loopStart = function(setTime) {
nickjillings@1360 1283 this.outputGain.gain.linearRampToValueAtTime(this.onplayGain,setTime);
nickjillings@1318 1284 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1360 1285 this.interfaceDOM.startPlayback();
nickjillings@1318 1286 };
nickjillings@1318 1287
nickjillings@1360 1288 this.loopStop = function(setTime) {
nickjillings@1318 1289 if (this.outputGain.gain.value != 0.0) {
nickjillings@1360 1290 this.outputGain.gain.linearRampToValueAtTime(0.0,setTime);
nickjillings@1318 1291 this.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@1318 1292 }
nickjillings@1360 1293 this.interfaceDOM.stopPlayback();
nickjillings@1318 1294 };
nickjillings@1318 1295
nickjillings@1318 1296 this.play = function(startTime) {
nickjillings@1318 1297 if (this.bufferNode == undefined && this.buffer.buffer != undefined) {
nickjillings@1318 1298 this.bufferNode = audioContext.createBufferSource();
nickjillings@1318 1299 this.bufferNode.owner = this;
nickjillings@1318 1300 this.bufferNode.connect(this.outputGain);
nickjillings@1318 1301 this.bufferNode.buffer = this.buffer.buffer;
nickjillings@1318 1302 this.bufferNode.loop = audioEngineContext.loopPlayback;
nickjillings@1318 1303 this.bufferNode.onended = function(event) {
nickjillings@1318 1304 // Safari does not like using 'this' to reference the calling object!
nickjillings@1318 1305 //event.currentTarget.owner.metric.stopListening(audioEngineContext.timer.getTestTime(),event.currentTarget.owner.getCurrentPosition());
nickjillings@1360 1306 event.currentTarget.owner.stop(audioContext.currentTime+1);
nickjillings@1318 1307 };
nickjillings@1318 1308 if (this.bufferNode.loop == false) {
nickjillings@1318 1309 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1360 1310 this.outputGain.gain.setValueAtTime(this.onplayGain,startTime);
nickjillings@1360 1311 this.interfaceDOM.startPlayback();
nickjillings@1360 1312 } else {
nickjillings@1360 1313 this.outputGain.gain.setValueAtTime(0.0,startTime);
nickjillings@1360 1314 }
nickjillings@1318 1315 this.bufferNode.start(startTime);
nickjillings@1318 1316 }
nickjillings@1318 1317 };
nickjillings@1318 1318
nickjillings@1360 1319 this.stop = function(stopTime) {
nickjillings@1360 1320 this.outputGain.gain.cancelScheduledValues(audioContext.currentTime);
nickjillings@1318 1321 if (this.bufferNode != undefined)
nickjillings@1318 1322 {
nickjillings@1318 1323 this.metric.stopListening(audioEngineContext.timer.getTestTime(),this.getCurrentPosition());
nickjillings@1360 1324 this.bufferNode.stop(stopTime);
nickjillings@1318 1325 this.bufferNode = undefined;
nickjillings@1318 1326 }
nickjillings@1360 1327 this.outputGain.gain.value = 0.0;
nickjillings@1360 1328 this.interfaceDOM.stopPlayback();
nickjillings@1318 1329 };
nickjillings@1318 1330
nickjillings@1318 1331 this.getCurrentPosition = function() {
nickjillings@1318 1332 var time = audioEngineContext.timer.getTestTime();
nickjillings@1318 1333 if (this.bufferNode != undefined) {
nickjillings@1318 1334 if (this.bufferNode.loop == true) {
nickjillings@1318 1335 if (audioEngineContext.status == 1) {
nickjillings@1318 1336 return (time-this.metric.listenStart)%this.buffer.buffer.duration;
nickjillings@1318 1337 } else {
nickjillings@1318 1338 return 0;
nickjillings@1318 1339 }
nickjillings@1318 1340 } else {
nickjillings@1318 1341 if (this.metric.listenHold) {
nickjillings@1318 1342 return time - this.metric.listenStart;
nickjillings@1318 1343 } else {
nickjillings@1318 1344 return 0;
nickjillings@1318 1345 }
nickjillings@1318 1346 }
nickjillings@1318 1347 } else {
nickjillings@1318 1348 return 0;
nickjillings@1318 1349 }
nickjillings@1318 1350 };
nickjillings@1318 1351
nickjillings@1318 1352 this.exportXMLDOM = function() {
nickjillings@1324 1353 var file = storage.document.createElement('file');
nickjillings@1318 1354 file.setAttribute('sampleRate',this.buffer.buffer.sampleRate);
nickjillings@1318 1355 file.setAttribute('channels',this.buffer.buffer.numberOfChannels);
nickjillings@1318 1356 file.setAttribute('sampleCount',this.buffer.buffer.length);
nickjillings@1318 1357 file.setAttribute('duration',this.buffer.buffer.duration);
nickjillings@1324 1358 this.storeDOM.appendChild(file);
nickjillings@1324 1359 if (this.specification.type != 'outside-reference') {
nickjillings@1318 1360 var interfaceXML = this.interfaceDOM.exportXMLDOM(this);
nickjillings@1340 1361 if (interfaceXML != null)
nickjillings@1340 1362 {
nickjillings@1340 1363 if (interfaceXML.length == undefined) {
nickjillings@1340 1364 this.storeDOM.appendChild(interfaceXML);
nickjillings@1340 1365 } else {
nickjillings@1340 1366 for (var i=0; i<interfaceXML.length; i++)
nickjillings@1340 1367 {
nickjillings@1340 1368 this.storeDOM.appendChild(interfaceXML[i]);
nickjillings@1340 1369 }
nickjillings@1318 1370 }
nickjillings@1318 1371 }
nickjillings@1330 1372 if (this.commentDOM != null) {
nickjillings@1330 1373 this.storeDOM.appendChild(this.commentDOM.exportXMLDOM(this));
nickjillings@1330 1374 }
nickjillings@1318 1375 }
nickjillings@1324 1376 var nodes = this.metric.exportXMLDOM();
nickjillings@1324 1377 var mroot = this.storeDOM.getElementsByTagName('metric')[0];
nickjillings@1324 1378 for (var i=0; i<nodes.length; i++)
nickjillings@1324 1379 {
nickjillings@1324 1380 mroot.appendChild(nodes[i]);
nickjillings@1324 1381 }
nickjillings@1318 1382 };
nickjillings@1318 1383 }
nickjillings@1318 1384
nickjillings@1318 1385 function timer()
nickjillings@1318 1386 {
nickjillings@1318 1387 /* Timer object used in audioEngine to keep track of session timings
nickjillings@1318 1388 * Uses the timer of the web audio API, so sample resolution
nickjillings@1318 1389 */
nickjillings@1318 1390 this.testStarted = false;
nickjillings@1318 1391 this.testStartTime = 0;
nickjillings@1318 1392 this.testDuration = 0;
nickjillings@1318 1393 this.minimumTestTime = 0; // No minimum test time
nickjillings@1318 1394 this.startTest = function()
nickjillings@1318 1395 {
nickjillings@1318 1396 if (this.testStarted == false)
nickjillings@1318 1397 {
nickjillings@1318 1398 this.testStartTime = audioContext.currentTime;
nickjillings@1318 1399 this.testStarted = true;
nickjillings@1318 1400 this.updateTestTime();
nickjillings@1318 1401 audioEngineContext.metric.initialiseTest();
nickjillings@1318 1402 }
nickjillings@1318 1403 };
nickjillings@1318 1404 this.stopTest = function()
nickjillings@1318 1405 {
nickjillings@1318 1406 if (this.testStarted)
nickjillings@1318 1407 {
nickjillings@1318 1408 this.testDuration = this.getTestTime();
nickjillings@1318 1409 this.testStarted = false;
nickjillings@1318 1410 } else {
nickjillings@1318 1411 console.log('ERR: Test tried to end before beginning');
nickjillings@1318 1412 }
nickjillings@1318 1413 };
nickjillings@1318 1414 this.updateTestTime = function()
nickjillings@1318 1415 {
nickjillings@1318 1416 if (this.testStarted)
nickjillings@1318 1417 {
nickjillings@1318 1418 this.testDuration = audioContext.currentTime - this.testStartTime;
nickjillings@1318 1419 }
nickjillings@1318 1420 };
nickjillings@1318 1421 this.getTestTime = function()
nickjillings@1318 1422 {
nickjillings@1318 1423 this.updateTestTime();
nickjillings@1318 1424 return this.testDuration;
nickjillings@1318 1425 };
nickjillings@1318 1426 }
nickjillings@1318 1427
nickjillings@1318 1428 function sessionMetrics(engine,specification)
nickjillings@1318 1429 {
nickjillings@1318 1430 /* Used by audioEngine to link to audioObjects to minimise the timer call timers;
nickjillings@1318 1431 */
nickjillings@1318 1432 this.engine = engine;
nickjillings@1318 1433 this.lastClicked = -1;
nickjillings@1318 1434 this.data = -1;
nickjillings@1318 1435 this.reset = function() {
nickjillings@1318 1436 this.lastClicked = -1;
nickjillings@1318 1437 this.data = -1;
nickjillings@1318 1438 };
nickjillings@1318 1439
nickjillings@1318 1440 this.enableElementInitialPosition = false;
nickjillings@1318 1441 this.enableElementListenTracker = false;
nickjillings@1318 1442 this.enableElementTimer = false;
nickjillings@1318 1443 this.enableElementTracker = false;
nickjillings@1318 1444 this.enableFlagListenedTo = false;
nickjillings@1318 1445 this.enableFlagMoved = false;
nickjillings@1318 1446 this.enableTestTimer = false;
nickjillings@1318 1447 // Obtain the metrics enabled
nickjillings@1324 1448 for (var i=0; i<specification.metrics.enabled.length; i++)
nickjillings@1318 1449 {
nickjillings@1324 1450 var node = specification.metrics.enabled[i];
nickjillings@1324 1451 switch(node)
nickjillings@1318 1452 {
nickjillings@1318 1453 case 'testTimer':
nickjillings@1318 1454 this.enableTestTimer = true;
nickjillings@1318 1455 break;
nickjillings@1318 1456 case 'elementTimer':
nickjillings@1318 1457 this.enableElementTimer = true;
nickjillings@1318 1458 break;
nickjillings@1318 1459 case 'elementTracker':
nickjillings@1318 1460 this.enableElementTracker = true;
nickjillings@1318 1461 break;
nickjillings@1318 1462 case 'elementListenTracker':
nickjillings@1318 1463 this.enableElementListenTracker = true;
nickjillings@1318 1464 break;
nickjillings@1318 1465 case 'elementInitialPosition':
nickjillings@1318 1466 this.enableElementInitialPosition = true;
nickjillings@1318 1467 break;
nickjillings@1318 1468 case 'elementFlagListenedTo':
nickjillings@1318 1469 this.enableFlagListenedTo = true;
nickjillings@1318 1470 break;
nickjillings@1318 1471 case 'elementFlagMoved':
nickjillings@1318 1472 this.enableFlagMoved = true;
nickjillings@1318 1473 break;
nickjillings@1318 1474 case 'elementFlagComments':
nickjillings@1318 1475 this.enableFlagComments = true;
nickjillings@1318 1476 break;
nickjillings@1318 1477 }
nickjillings@1318 1478 }
nickjillings@1318 1479 this.initialiseTest = function(){};
nickjillings@1318 1480 }
nickjillings@1318 1481
nickjillings@1318 1482 function metricTracker(caller)
nickjillings@1318 1483 {
nickjillings@1318 1484 /* Custom object to track and collect metric data
nickjillings@1318 1485 * Used only inside the audioObjects object.
nickjillings@1318 1486 */
nickjillings@1318 1487
nickjillings@1318 1488 this.listenedTimer = 0;
nickjillings@1318 1489 this.listenStart = 0;
nickjillings@1318 1490 this.listenHold = false;
nickjillings@1318 1491 this.initialPosition = -1;
nickjillings@1318 1492 this.movementTracker = [];
nickjillings@1318 1493 this.listenTracker =[];
nickjillings@1318 1494 this.wasListenedTo = false;
nickjillings@1318 1495 this.wasMoved = false;
nickjillings@1318 1496 this.hasComments = false;
nickjillings@1318 1497 this.parent = caller;
nickjillings@1318 1498
nickjillings@1324 1499 this.initialise = function(position)
nickjillings@1318 1500 {
nickjillings@1318 1501 if (this.initialPosition == -1) {
nickjillings@1318 1502 this.initialPosition = position;
nickjillings@1325 1503 this.moved(0,position);
nickjillings@1318 1504 }
nickjillings@1318 1505 };
nickjillings@1318 1506
nickjillings@1318 1507 this.moved = function(time,position)
nickjillings@1318 1508 {
nickjillings@1325 1509 if (time > 0) {this.wasMoved = true;}
nickjillings@1318 1510 this.movementTracker[this.movementTracker.length] = [time, position];
nickjillings@1318 1511 };
nickjillings@1318 1512
nickjillings@1318 1513 this.startListening = function(time)
nickjillings@1318 1514 {
nickjillings@1318 1515 if (this.listenHold == false)
nickjillings@1318 1516 {
nickjillings@1318 1517 this.wasListenedTo = true;
nickjillings@1318 1518 this.listenStart = time;
nickjillings@1318 1519 this.listenHold = true;
nickjillings@1318 1520
nickjillings@1318 1521 var evnt = document.createElement('event');
nickjillings@1318 1522 var testTime = document.createElement('testTime');
nickjillings@1318 1523 testTime.setAttribute('start',time);
nickjillings@1318 1524 var bufferTime = document.createElement('bufferTime');
nickjillings@1318 1525 bufferTime.setAttribute('start',this.parent.getCurrentPosition());
nickjillings@1318 1526 evnt.appendChild(testTime);
nickjillings@1318 1527 evnt.appendChild(bufferTime);
nickjillings@1318 1528 this.listenTracker.push(evnt);
nickjillings@1318 1529
nickjillings@1318 1530 console.log('slider ' + this.parent.id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1318 1531 }
nickjillings@1318 1532 };
nickjillings@1318 1533
nickjillings@1318 1534 this.stopListening = function(time,bufferStopTime)
nickjillings@1318 1535 {
nickjillings@1318 1536 if (this.listenHold == true)
nickjillings@1318 1537 {
nickjillings@1318 1538 var diff = time - this.listenStart;
nickjillings@1318 1539 this.listenedTimer += (diff);
nickjillings@1318 1540 this.listenStart = 0;
nickjillings@1318 1541 this.listenHold = false;
nickjillings@1318 1542
nickjillings@1318 1543 var evnt = this.listenTracker[this.listenTracker.length-1];
nickjillings@1318 1544 var testTime = evnt.getElementsByTagName('testTime')[0];
nickjillings@1318 1545 var bufferTime = evnt.getElementsByTagName('bufferTime')[0];
nickjillings@1318 1546 testTime.setAttribute('stop',time);
nickjillings@1318 1547 if (bufferStopTime == undefined) {
nickjillings@1318 1548 bufferTime.setAttribute('stop',this.parent.getCurrentPosition());
nickjillings@1318 1549 } else {
nickjillings@1318 1550 bufferTime.setAttribute('stop',bufferStopTime);
nickjillings@1318 1551 }
nickjillings@1318 1552 console.log('slider ' + this.parent.id + ' played for (' + diff + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1318 1553 }
nickjillings@1318 1554 };
nickjillings@1318 1555
nickjillings@1318 1556 this.exportXMLDOM = function() {
nickjillings@1324 1557 var storeDOM = [];
nickjillings@1318 1558 if (audioEngineContext.metric.enableElementTimer) {
nickjillings@1324 1559 var mElementTimer = storage.document.createElement('metricresult');
nickjillings@1318 1560 mElementTimer.setAttribute('name','enableElementTimer');
nickjillings@1318 1561 mElementTimer.textContent = this.listenedTimer;
nickjillings@1324 1562 storeDOM.push(mElementTimer);
nickjillings@1318 1563 }
nickjillings@1318 1564 if (audioEngineContext.metric.enableElementTracker) {
nickjillings@1324 1565 var elementTrackerFull = storage.document.createElement('metricResult');
nickjillings@1318 1566 elementTrackerFull.setAttribute('name','elementTrackerFull');
nickjillings@1318 1567 for (var k=0; k<this.movementTracker.length; k++)
nickjillings@1318 1568 {
nickjillings@1324 1569 var timePos = storage.document.createElement('timePos');
nickjillings@1318 1570 timePos.id = k;
nickjillings@1324 1571 var time = storage.document.createElement('time');
nickjillings@1318 1572 time.textContent = this.movementTracker[k][0];
nickjillings@1318 1573 var position = document.createElement('position');
nickjillings@1318 1574 position.textContent = this.movementTracker[k][1];
nickjillings@1318 1575 timePos.appendChild(time);
nickjillings@1318 1576 timePos.appendChild(position);
nickjillings@1318 1577 elementTrackerFull.appendChild(timePos);
nickjillings@1318 1578 }
nickjillings@1324 1579 storeDOM.push(elementTrackerFull);
nickjillings@1318 1580 }
nickjillings@1318 1581 if (audioEngineContext.metric.enableElementListenTracker) {
nickjillings@1324 1582 var elementListenTracker = storage.document.createElement('metricResult');
nickjillings@1318 1583 elementListenTracker.setAttribute('name','elementListenTracker');
nickjillings@1318 1584 for (var k=0; k<this.listenTracker.length; k++) {
nickjillings@1318 1585 elementListenTracker.appendChild(this.listenTracker[k]);
nickjillings@1318 1586 }
nickjillings@1324 1587 storeDOM.push(elementListenTracker);
nickjillings@1318 1588 }
nickjillings@1318 1589 if (audioEngineContext.metric.enableElementInitialPosition) {
nickjillings@1324 1590 var elementInitial = storage.document.createElement('metricResult');
nickjillings@1318 1591 elementInitial.setAttribute('name','elementInitialPosition');
nickjillings@1318 1592 elementInitial.textContent = this.initialPosition;
nickjillings@1324 1593 storeDOM.push(elementInitial);
nickjillings@1318 1594 }
nickjillings@1318 1595 if (audioEngineContext.metric.enableFlagListenedTo) {
nickjillings@1324 1596 var flagListenedTo = storage.document.createElement('metricResult');
nickjillings@1318 1597 flagListenedTo.setAttribute('name','elementFlagListenedTo');
nickjillings@1318 1598 flagListenedTo.textContent = this.wasListenedTo;
nickjillings@1324 1599 storeDOM.push(flagListenedTo);
nickjillings@1318 1600 }
nickjillings@1318 1601 if (audioEngineContext.metric.enableFlagMoved) {
nickjillings@1324 1602 var flagMoved = storage.document.createElement('metricResult');
nickjillings@1318 1603 flagMoved.setAttribute('name','elementFlagMoved');
nickjillings@1318 1604 flagMoved.textContent = this.wasMoved;
nickjillings@1324 1605 storeDOM.push(flagMoved);
nickjillings@1318 1606 }
nickjillings@1318 1607 if (audioEngineContext.metric.enableFlagComments) {
nickjillings@1324 1608 var flagComments = storage.document.createElement('metricResult');
nickjillings@1318 1609 flagComments.setAttribute('name','elementFlagComments');
nickjillings@1318 1610 if (this.parent.commentDOM == null)
nickjillings@1318 1611 {flag.textContent = 'false';}
nickjillings@1318 1612 else if (this.parent.commentDOM.textContent.length == 0)
nickjillings@1318 1613 {flag.textContent = 'false';}
nickjillings@1318 1614 else
nickjillings@1318 1615 {flag.textContet = 'true';}
nickjillings@1324 1616 storeDOM.push(flagComments);
nickjillings@1318 1617 }
nickjillings@1324 1618 return storeDOM;
nickjillings@1318 1619 };
nickjillings@1318 1620 }
nickjillings@1318 1621
nickjillings@1318 1622 function randomiseOrder(input)
nickjillings@1318 1623 {
nickjillings@1318 1624 // This takes an array of information and randomises the order
nickjillings@1318 1625 var N = input.length;
nickjillings@1318 1626
nickjillings@1318 1627 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1318 1628 for (var counter = 0; counter < N; ++counter)
nickjillings@1318 1629 inputSequence.push(counter) // Fill array
nickjillings@1318 1630 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1318 1631
nickjillings@1318 1632 var holdArr = [];
nickjillings@1318 1633 var outputSequence = [];
nickjillings@1318 1634 for (var n=0; n<N; n++)
nickjillings@1318 1635 {
nickjillings@1318 1636 // First pick a random number
nickjillings@1318 1637 var r = Math.random();
nickjillings@1318 1638 // Multiply and floor by the number of elements left
nickjillings@1318 1639 r = Math.floor(r*input.length);
nickjillings@1318 1640 // Pick out that element and delete from the array
nickjillings@1318 1641 holdArr.push(input.splice(r,1)[0]);
nickjillings@1318 1642 // Do the same with sequence
nickjillings@1318 1643 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1318 1644 }
nickjillings@1318 1645 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1318 1646 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1318 1647 return holdArr;
nickjillings@1318 1648 }
nickjillings@1318 1649
nickjillings@1318 1650 function returnDateNode()
nickjillings@1318 1651 {
nickjillings@1318 1652 // Create an XML Node for the Date and Time a test was conducted
nickjillings@1318 1653 // Structure is
nickjillings@1318 1654 // <datetime>
nickjillings@1318 1655 // <date year="##" month="##" day="##">DD/MM/YY</date>
nickjillings@1318 1656 // <time hour="##" minute="##" sec="##">HH:MM:SS</time>
nickjillings@1318 1657 // </datetime>
nickjillings@1318 1658 var dateTime = new Date();
nickjillings@1318 1659 var year = document.createAttribute('year');
nickjillings@1318 1660 var month = document.createAttribute('month');
nickjillings@1318 1661 var day = document.createAttribute('day');
nickjillings@1318 1662 var hour = document.createAttribute('hour');
nickjillings@1318 1663 var minute = document.createAttribute('minute');
nickjillings@1318 1664 var secs = document.createAttribute('secs');
nickjillings@1318 1665
nickjillings@1318 1666 year.nodeValue = dateTime.getFullYear();
nickjillings@1318 1667 month.nodeValue = dateTime.getMonth()+1;
nickjillings@1318 1668 day.nodeValue = dateTime.getDate();
nickjillings@1318 1669 hour.nodeValue = dateTime.getHours();
nickjillings@1318 1670 minute.nodeValue = dateTime.getMinutes();
nickjillings@1318 1671 secs.nodeValue = dateTime.getSeconds();
nickjillings@1318 1672
nickjillings@1318 1673 var hold = document.createElement("datetime");
nickjillings@1318 1674 var date = document.createElement("date");
nickjillings@1318 1675 date.textContent = year.nodeValue+'/'+month.nodeValue+'/'+day.nodeValue;
nickjillings@1318 1676 var time = document.createElement("time");
nickjillings@1318 1677 time.textContent = hour.nodeValue+':'+minute.nodeValue+':'+secs.nodeValue;
nickjillings@1318 1678
nickjillings@1318 1679 date.setAttributeNode(year);
nickjillings@1318 1680 date.setAttributeNode(month);
nickjillings@1318 1681 date.setAttributeNode(day);
nickjillings@1318 1682 time.setAttributeNode(hour);
nickjillings@1318 1683 time.setAttributeNode(minute);
nickjillings@1318 1684 time.setAttributeNode(secs);
nickjillings@1318 1685
nickjillings@1318 1686 hold.appendChild(date);
nickjillings@1318 1687 hold.appendChild(time);
nickjillings@1318 1688 return hold;
nickjillings@1318 1689
nickjillings@1318 1690 }
nickjillings@1318 1691
nickjillings@1318 1692 function Specification() {
nickjillings@1318 1693 // Handles the decoding of the project specification XML into a simple JavaScript Object.
nickjillings@1318 1694
nickjillings@1324 1695 this.interface = null;
nickjillings@1324 1696 this.projectReturn = null;
nickjillings@1324 1697 this.randomiseOrder = null;
nickjillings@1324 1698 this.testPages = null;
nickjillings@1324 1699 this.pages = [];
nickjillings@1324 1700 this.metrics = null;
nickjillings@1324 1701 this.interfaces = null;
nickjillings@1324 1702 this.loudness = null;
nickjillings@1324 1703 this.errors = [];
nickjillings@1324 1704 this.schema = null;
nickjillings@1318 1705
nickjillings@1318 1706 this.randomiseOrder = function(input)
nickjillings@1318 1707 {
nickjillings@1318 1708 // This takes an array of information and randomises the order
nickjillings@1318 1709 var N = input.length;
nickjillings@1318 1710
nickjillings@1318 1711 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1318 1712 for (var counter = 0; counter < N; ++counter)
nickjillings@1318 1713 inputSequence.push(counter) // Fill array
nickjillings@1318 1714 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1318 1715
nickjillings@1318 1716 var holdArr = [];
nickjillings@1318 1717 var outputSequence = [];
nickjillings@1318 1718 for (var n=0; n<N; n++)
nickjillings@1318 1719 {
nickjillings@1318 1720 // First pick a random number
nickjillings@1318 1721 var r = Math.random();
nickjillings@1318 1722 // Multiply and floor by the number of elements left
nickjillings@1318 1723 r = Math.floor(r*input.length);
nickjillings@1318 1724 // Pick out that element and delete from the array
nickjillings@1318 1725 holdArr.push(input.splice(r,1)[0]);
nickjillings@1318 1726 // Do the same with sequence
nickjillings@1318 1727 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1318 1728 }
nickjillings@1318 1729 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1318 1730 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1318 1731 return holdArr;
nickjillings@1318 1732 };
nickjillings@1324 1733
nickjillings@1324 1734 this.processAttribute = function(attribute,schema)
nickjillings@1324 1735 {
nickjillings@1324 1736 // attribute is the string returned from getAttribute on the XML
nickjillings@1324 1737 // schema is the <xs:attribute> node
nickjillings@1324 1738 if (schema.getAttribute('name') == undefined && schema.getAttribute('ref') != undefined)
nickjillings@1324 1739 {
nickjillings@1348 1740 schema = this.schema.getAllElementsByName(schema.getAttribute('ref'))[0];
nickjillings@1324 1741 }
nickjillings@1324 1742 var defaultOpt = schema.getAttribute('default');
nickjillings@1324 1743 if (attribute == null) {
nickjillings@1324 1744 attribute = defaultOpt;
nickjillings@1324 1745 }
nickjillings@1324 1746 var dataType = schema.getAttribute('type');
nickjillings@1324 1747 if (typeof dataType == "string") { dataType = dataType.substr(3);}
nickjillings@1324 1748 else {dataType = "string";}
nickjillings@1324 1749 if (attribute == null)
nickjillings@1324 1750 {
nickjillings@1324 1751 return attribute;
nickjillings@1324 1752 }
nickjillings@1324 1753 switch(dataType)
nickjillings@1324 1754 {
nickjillings@1324 1755 case "boolean":
nickjillings@1324 1756 if (attribute == 'true'){attribute = true;}else{attribute=false;}
nickjillings@1324 1757 break;
nickjillings@1324 1758 case "negativeInteger":
nickjillings@1324 1759 case "positiveInteger":
nickjillings@1324 1760 case "nonNegativeInteger":
nickjillings@1324 1761 case "nonPositiveInteger":
nickjillings@1324 1762 case "integer":
nickjillings@1324 1763 case "decimal":
nickjillings@1324 1764 case "short":
nickjillings@1324 1765 attribute = Number(attribute);
nickjillings@1324 1766 break;
nickjillings@1324 1767 case "string":
nickjillings@1324 1768 default:
nickjillings@1324 1769 attribute = String(attribute);
nickjillings@1324 1770 break;
nickjillings@1324 1771 }
nickjillings@1324 1772 return attribute;
nickjillings@1324 1773 };
nickjillings@1318 1774
nickjillings@1318 1775 this.decode = function(projectXML) {
nickjillings@1324 1776 this.errors = [];
nickjillings@1318 1777 // projectXML - DOM Parsed document
nickjillings@1318 1778 this.projectXML = projectXML.childNodes[0];
nickjillings@1318 1779 var setupNode = projectXML.getElementsByTagName('setup')[0];
nickjillings@1348 1780 var schemaSetup = this.schema.getAllElementsByName('setup')[0];
nickjillings@1324 1781 // First decode the attributes
nickjillings@1348 1782 var attributes = schemaSetup.getAllElementsByTagName('xs:attribute');
nickjillings@1324 1783 for (var i in attributes)
nickjillings@1318 1784 {
nickjillings@1324 1785 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1786 var attributeName = attributes[i].getAttribute('name');
nickjillings@1324 1787 var projectAttr = setupNode.getAttribute(attributeName);
nickjillings@1324 1788 projectAttr = this.processAttribute(projectAttr,attributes[i]);
nickjillings@1324 1789 switch(typeof projectAttr)
nickjillings@1318 1790 {
nickjillings@1324 1791 case "number":
nickjillings@1324 1792 case "boolean":
nickjillings@1324 1793 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 1794 break;
nickjillings@1324 1795 case "string":
nickjillings@1324 1796 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1797 break;
nickjillings@1318 1798 }
nickjillings@1324 1799
nickjillings@1318 1800 }
nickjillings@1318 1801
nickjillings@1324 1802 this.metrics = {
nickjillings@1324 1803 enabled: [],
nickjillings@1324 1804 decode: function(parent, xml) {
nickjillings@1324 1805 var children = xml.getElementsByTagName('metricenable');
nickjillings@1324 1806 for (var i in children) {
nickjillings@1324 1807 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1808 this.enabled.push(children[i].textContent);
nickjillings@1324 1809 }
nickjillings@1324 1810 },
nickjillings@1324 1811 encode: function(root) {
nickjillings@1324 1812 var node = root.createElement('metric');
nickjillings@1324 1813 for (var i in this.enabled)
nickjillings@1324 1814 {
nickjillings@1324 1815 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1816 var child = root.createElement('metricenable');
nickjillings@1324 1817 child.textContent = this.enabled[i];
nickjillings@1324 1818 node.appendChild(child);
nickjillings@1324 1819 }
nickjillings@1324 1820 return node;
nickjillings@1324 1821 }
nickjillings@1324 1822 };
nickjillings@1318 1823
nickjillings@1324 1824 this.metrics.decode(this,setupNode.getElementsByTagName('metric')[0]);
nickjillings@1324 1825
nickjillings@1324 1826 // Now process the survey node options
nickjillings@1324 1827 var survey = setupNode.getElementsByTagName('survey');
nickjillings@1348 1828 var surveySchema = specification.schema.getAllElementsByName('survey')[0];
nickjillings@1324 1829 for (var i in survey) {
nickjillings@1324 1830 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1831 var location = survey[i].getAttribute('location');
nickjillings@1324 1832 if (location == 'pre' || location == 'before')
nickjillings@1324 1833 {
nickjillings@1324 1834 if (this.preTest != null){this.errors.push("Already a pre/before test survey defined! Ignoring second!!");}
nickjillings@1324 1835 else {
nickjillings@1324 1836 this.preTest = new this.surveyNode();
nickjillings@1324 1837 this.preTest.decode(this,survey[i],surveySchema);
nickjillings@1324 1838 }
nickjillings@1324 1839 } else if (location == 'post' || location == 'after') {
nickjillings@1324 1840 if (this.postTest != null){this.errors.push("Already a post/after test survey defined! Ignoring second!!");}
nickjillings@1324 1841 else {
nickjillings@1324 1842 this.postTest = new this.surveyNode();
nickjillings@1324 1843 this.postTest.decode(this,survey[i],surveySchema);
nickjillings@1324 1844 }
nickjillings@1318 1845 }
nickjillings@1318 1846 }
nickjillings@1318 1847
nickjillings@1324 1848 var interfaceNode = setupNode.getElementsByTagName('interface');
nickjillings@1324 1849 if (interfaceNode.length > 1)
nickjillings@1324 1850 {
nickjillings@1324 1851 this.errors.push("Only one <interface> node in the <setup> node allowed! Others except first ingnored!");
nickjillings@1324 1852 }
nickjillings@1324 1853 this.interfaces = new this.interfaceNode();
nickjillings@1324 1854 if (interfaceNode.length != 0)
nickjillings@1324 1855 {
nickjillings@1324 1856 interfaceNode = interfaceNode[0];
nickjillings@1348 1857 this.interfaces.decode(this,interfaceNode,this.schema.getAllElementsByName('interface')[1]);
nickjillings@1318 1858 }
nickjillings@1318 1859
nickjillings@1324 1860 // Page tags
nickjillings@1324 1861 var pageTags = projectXML.getElementsByTagName('page');
nickjillings@1348 1862 var pageSchema = this.schema.getAllElementsByName('page')[0];
nickjillings@1324 1863 for (var i=0; i<pageTags.length; i++)
nickjillings@1318 1864 {
nickjillings@1324 1865 var node = new this.page();
nickjillings@1324 1866 node.decode(this,pageTags[i],pageSchema);
nickjillings@1324 1867 this.pages.push(node);
nickjillings@1318 1868 }
nickjillings@1318 1869 };
nickjillings@1318 1870
nickjillings@1318 1871 this.encode = function()
nickjillings@1318 1872 {
nickjillings@1324 1873 var root = document.implementation.createDocument(null,"waet");
nickjillings@1318 1874
nickjillings@1324 1875 // Build setup node
nickjillings@1318 1876
nickjillings@1318 1877 return root;
nickjillings@1318 1878 };
nickjillings@1318 1879
nickjillings@1324 1880 this.surveyNode = function() {
nickjillings@1324 1881 this.location = null;
nickjillings@1318 1882 this.options = [];
nickjillings@1324 1883 this.schema = null;
nickjillings@1318 1884
nickjillings@1318 1885 this.OptionNode = function() {
nickjillings@1318 1886 this.type = undefined;
nickjillings@1324 1887 this.schema = undefined;
nickjillings@1318 1888 this.id = undefined;
nickjillings@1318 1889 this.mandatory = undefined;
nickjillings@1318 1890 this.statement = undefined;
nickjillings@1318 1891 this.boxsize = undefined;
nickjillings@1318 1892 this.options = [];
nickjillings@1318 1893 this.min = undefined;
nickjillings@1318 1894 this.max = undefined;
nickjillings@1318 1895 this.step = undefined;
nickjillings@1318 1896
nickjillings@1324 1897 this.decode = function(parent,child,schema)
nickjillings@1318 1898 {
nickjillings@1324 1899 this.schema = schema;
nickjillings@1348 1900 var attributeMap = schema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 1901 for (var i in attributeMap){
nickjillings@1324 1902 if(isNaN(Number(i)) == true){break;}
nickjillings@1324 1903 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 1904 var projectAttr = child.getAttribute(attributeName);
nickjillings@1324 1905 projectAttr = parent.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 1906 switch(typeof projectAttr)
nickjillings@1324 1907 {
nickjillings@1324 1908 case "number":
nickjillings@1324 1909 case "boolean":
nickjillings@1324 1910 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 1911 break;
nickjillings@1324 1912 case "string":
nickjillings@1324 1913 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1914 break;
nickjillings@1318 1915 }
nickjillings@1324 1916 }
nickjillings@1324 1917 this.statement = child.getElementsByTagName('statement')[0].textContent;
nickjillings@1324 1918 if (this.type == "checkbox" || this.type == "radio") {
nickjillings@1324 1919 var children = child.getElementsByTagName('option');
nickjillings@1324 1920 if (children.length == null) {
nickjillings@1318 1921 console.log('Malformed' +child.nodeName+ 'entry');
nickjillings@1318 1922 this.statement = 'Malformed' +child.nodeName+ 'entry';
nickjillings@1318 1923 this.type = 'statement';
nickjillings@1318 1924 } else {
nickjillings@1318 1925 this.options = [];
nickjillings@1324 1926 for (var i in children)
nickjillings@1324 1927 {
nickjillings@1324 1928 if (isNaN(Number(i))==true){break;}
nickjillings@1324 1929 this.options.push({
nickjillings@1324 1930 name: children[i].getAttribute('name'),
nickjillings@1324 1931 text: children[i].textContent
nickjillings@1324 1932 });
nickjillings@1318 1933 }
nickjillings@1318 1934 }
nickjillings@1318 1935 }
nickjillings@1318 1936 };
nickjillings@1318 1937
nickjillings@1318 1938 this.exportXML = function(root)
nickjillings@1318 1939 {
nickjillings@1324 1940 var node = root.createElement('surveyelement');
nickjillings@1324 1941 node.setAttribute('type',this.type);
nickjillings@1324 1942 var statement = root.createElement('statement');
nickjillings@1324 1943 statement.textContent = this.statement;
nickjillings@1324 1944 node.appendChild(statement);
nickjillings@1318 1945 switch(this.type)
nickjillings@1318 1946 {
nickjillings@1318 1947 case "statement":
nickjillings@1318 1948 break;
nickjillings@1318 1949 case "question":
nickjillings@1318 1950 node.id = this.id;
nickjillings@1318 1951 node.setAttribute("mandatory",this.mandatory);
nickjillings@1318 1952 node.setAttribute("boxsize",this.boxsize);
nickjillings@1318 1953 break;
nickjillings@1318 1954 case "number":
nickjillings@1318 1955 node.id = this.id;
nickjillings@1318 1956 node.setAttribute("mandatory",this.mandatory);
nickjillings@1318 1957 node.setAttribute("min", this.min);
nickjillings@1318 1958 node.setAttribute("max", this.max);
nickjillings@1318 1959 node.setAttribute("step", this.step);
nickjillings@1318 1960 break;
nickjillings@1318 1961 case "checkbox":
nickjillings@1318 1962 case "radio":
nickjillings@1318 1963 node.id = this.id;
nickjillings@1318 1964 for (var i=0; i<this.options.length; i++)
nickjillings@1318 1965 {
nickjillings@1318 1966 var option = this.options[i];
nickjillings@1318 1967 var optionNode = root.createElement("option");
nickjillings@1318 1968 optionNode.setAttribute("name",option.name);
nickjillings@1318 1969 optionNode.textContent = option.text;
nickjillings@1318 1970 node.appendChild(optionNode);
nickjillings@1318 1971 }
nickjillings@1318 1972 break;
nickjillings@1318 1973 }
nickjillings@1318 1974 return node;
nickjillings@1318 1975 };
nickjillings@1318 1976 };
nickjillings@1324 1977 this.decode = function(parent,xml,schema) {
nickjillings@1324 1978 this.schema = schema;
nickjillings@1324 1979 this.location = xml.getAttribute('location');
nickjillings@1324 1980 if (this.location == 'before'){this.location = 'pre';}
nickjillings@1324 1981 else if (this.location == 'after'){this.location = 'post';}
nickjillings@1348 1982 var surveyentrySchema = schema.getAllElementsByName('surveyentry')[0];
nickjillings@1324 1983 for (var i in xml.children)
nickjillings@1324 1984 {
nickjillings@1324 1985 if(isNaN(Number(i))==true){break;}
nickjillings@1318 1986 var node = new this.OptionNode();
nickjillings@1324 1987 node.decode(parent,xml.children[i],surveyentrySchema);
nickjillings@1318 1988 this.options.push(node);
nickjillings@1324 1989 }
nickjillings@1324 1990 };
nickjillings@1324 1991 this.encode = function(root) {
nickjillings@1324 1992 var node = root.createElement('survey');
nickjillings@1324 1993 node.setAttribute('location',this.location);
nickjillings@1324 1994 for (var i=0; i<this.options.length; i++)
nickjillings@1324 1995 {
nickjillings@1324 1996 node.appendChild(this.options[i].exportXML());
nickjillings@1324 1997 }
nickjillings@1324 1998 return node;
nickjillings@1324 1999 };
nickjillings@1324 2000 };
nickjillings@1324 2001
nickjillings@1324 2002 this.interfaceNode = function()
nickjillings@1324 2003 {
nickjillings@1324 2004 this.title = null;
nickjillings@1324 2005 this.name = null;
nickjillings@1324 2006 this.options = [];
nickjillings@1324 2007 this.scales = [];
nickjillings@1324 2008 this.schema = null;
nickjillings@1324 2009
nickjillings@1324 2010 this.decode = function(parent,xml,schema) {
nickjillings@1324 2011 this.schema = schema;
nickjillings@1324 2012 this.name = xml.getAttribute('name');
nickjillings@1324 2013 var titleNode = xml.getElementsByTagName('title');
nickjillings@1324 2014 if (titleNode.length == 1)
nickjillings@1324 2015 {
nickjillings@1324 2016 this.title = titleNode[0].textContent;
nickjillings@1324 2017 }
nickjillings@1324 2018 var interfaceOptionNodes = xml.getElementsByTagName('interfaceoption');
nickjillings@1324 2019 // Extract interfaceoption node schema
nickjillings@1348 2020 var interfaceOptionNodeSchema = schema.getAllElementsByName('interfaceoption')[0];
nickjillings@1348 2021 var attributeMap = interfaceOptionNodeSchema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 2022 for (var i=0; i<interfaceOptionNodes.length; i++)
nickjillings@1324 2023 {
nickjillings@1324 2024 var ioNode = interfaceOptionNodes[i];
nickjillings@1324 2025 var option = {};
nickjillings@1324 2026 for (var j=0; j<attributeMap.length; j++)
nickjillings@1324 2027 {
nickjillings@1324 2028 var attributeName = attributeMap[j].getAttribute('name') || attributeMap[j].getAttribute('ref');
nickjillings@1324 2029 var projectAttr = ioNode.getAttribute(attributeName);
nickjillings@1324 2030 projectAttr = parent.processAttribute(projectAttr,attributeMap[j]);
nickjillings@1324 2031 switch(typeof projectAttr)
nickjillings@1324 2032 {
nickjillings@1324 2033 case "number":
nickjillings@1324 2034 case "boolean":
nickjillings@1324 2035 eval('option.'+attributeName+' = '+projectAttr);
nickjillings@1324 2036 break;
nickjillings@1324 2037 case "string":
nickjillings@1324 2038 eval('option.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 2039 break;
nickjillings@1324 2040 }
nickjillings@1324 2041 }
nickjillings@1324 2042 this.options.push(option);
nickjillings@1324 2043 }
nickjillings@1324 2044
nickjillings@1324 2045 // Now the scales nodes
nickjillings@1324 2046 var scaleParent = xml.getElementsByTagName('scales');
nickjillings@1324 2047 if (scaleParent.length == 1) {
nickjillings@1324 2048 scaleParent = scaleParent[0];
nickjillings@1324 2049 for (var i=0; i<scaleParent.children.length; i++) {
nickjillings@1324 2050 var child = scaleParent.children[i];
nickjillings@1324 2051 this.scales.push({
nickjillings@1324 2052 text: child.textContent,
nickjillings@1324 2053 position: Number(child.getAttribute('position'))
nickjillings@1324 2054 });
nickjillings@1318 2055 }
nickjillings@1318 2056 }
nickjillings@1318 2057 };
nickjillings@1324 2058
nickjillings@1324 2059 this.encode = function(root) {
nickjillings@1324 2060
nickjillings@1324 2061 };
nickjillings@1318 2062 };
nickjillings@1318 2063
nickjillings@1324 2064 this.page = function() {
nickjillings@1318 2065 this.presentedId = undefined;
nickjillings@1318 2066 this.id = undefined;
nickjillings@1318 2067 this.hostURL = undefined;
nickjillings@1318 2068 this.randomiseOrder = undefined;
nickjillings@1318 2069 this.loop = undefined;
nickjillings@1324 2070 this.showElementComments = undefined;
nickjillings@1318 2071 this.outsideReference = null;
nickjillings@1318 2072 this.loudness = null;
nickjillings@1324 2073 this.preTest = null;
nickjillings@1324 2074 this.postTest = null;
nickjillings@1318 2075 this.interfaces = [];
nickjillings@1318 2076 this.commentBoxPrefix = "Comment on track";
nickjillings@1318 2077 this.audioElements = [];
nickjillings@1318 2078 this.commentQuestions = [];
nickjillings@1324 2079 this.schema = null;
nickjillings@1318 2080
nickjillings@1324 2081 this.decode = function(parent,xml,schema)
nickjillings@1318 2082 {
nickjillings@1324 2083 this.schema = schema;
nickjillings@1348 2084 var attributeMap = this.schema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 2085 for (var i=0; i<attributeMap.length; i++)
nickjillings@1318 2086 {
nickjillings@1324 2087 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 2088 var projectAttr = xml.getAttribute(attributeName);
nickjillings@1324 2089 projectAttr = parent.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 2090 switch(typeof projectAttr)
nickjillings@1318 2091 {
nickjillings@1324 2092 case "number":
nickjillings@1324 2093 case "boolean":
nickjillings@1324 2094 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 2095 break;
nickjillings@1324 2096 case "string":
nickjillings@1324 2097 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 2098 break;
nickjillings@1318 2099 }
nickjillings@1318 2100 }
nickjillings@1318 2101
nickjillings@1324 2102 // Get the Comment Box Prefix
nickjillings@1324 2103 var CBP = xml.getElementsByTagName('commentboxprefix');
nickjillings@1324 2104 if (CBP.length != 0) {
nickjillings@1324 2105 this.commentBoxPrefix = CBP[0].textContent;
nickjillings@1318 2106 }
nickjillings@1318 2107
nickjillings@1324 2108 // Now decode the interfaces
nickjillings@1324 2109 var interfaceNode = xml.getElementsByTagName('interface');
nickjillings@1324 2110 for (var i=0; i<interfaceNode.length; i++)
nickjillings@1324 2111 {
nickjillings@1324 2112 var node = new parent.interfaceNode();
nickjillings@1348 2113 node.decode(this,interfaceNode[i],parent.schema.getAllElementsByName('interface')[1]);
nickjillings@1324 2114 this.interfaces.push(node);
nickjillings@1324 2115 }
nickjillings@1318 2116
nickjillings@1324 2117 // Now process the survey node options
nickjillings@1324 2118 var survey = xml.getElementsByTagName('survey');
nickjillings@1348 2119 var surveySchema = parent.schema.getAllElementsByName('survey')[0];
nickjillings@1324 2120 for (var i in survey) {
nickjillings@1324 2121 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 2122 var location = survey[i].getAttribute('location');
nickjillings@1324 2123 if (location == 'pre' || location == 'before')
nickjillings@1324 2124 {
nickjillings@1324 2125 if (this.preTest != null){this.errors.push("Already a pre/before test survey defined! Ignoring second!!");}
nickjillings@1324 2126 else {
nickjillings@1324 2127 this.preTest = new parent.surveyNode();
nickjillings@1324 2128 this.preTest.decode(parent,survey[i],surveySchema);
nickjillings@1324 2129 }
nickjillings@1324 2130 } else if (location == 'post' || location == 'after') {
nickjillings@1324 2131 if (this.postTest != null){this.errors.push("Already a post/after test survey defined! Ignoring second!!");}
nickjillings@1324 2132 else {
nickjillings@1324 2133 this.postTest = new parent.surveyNode();
nickjillings@1324 2134 this.postTest.decode(parent,survey[i],surveySchema);
nickjillings@1324 2135 }
nickjillings@1324 2136 }
nickjillings@1324 2137 }
nickjillings@1324 2138
nickjillings@1324 2139 // Now process the audioelement tags
nickjillings@1324 2140 var audioElements = xml.getElementsByTagName('audioelement');
nickjillings@1348 2141 var audioElementSchema = parent.schema.getAllElementsByName('audioelement')[0];
nickjillings@1324 2142 for (var i=0; i<audioElements.length; i++)
nickjillings@1324 2143 {
nickjillings@1324 2144 var node = new this.audioElementNode();
nickjillings@1324 2145 node.decode(this,audioElements[i],audioElementSchema);
nickjillings@1324 2146 this.audioElements.push(node);
nickjillings@1324 2147 }
nickjillings@1324 2148
nickjillings@1324 2149 // Now decode the commentquestions
nickjillings@1324 2150 var commentQuestions = xml.getElementsByTagName('commentquestion');
nickjillings@1348 2151 var commentQuestionSchema = parent.schema.getAllElementsByName('commentquestion')[0];
nickjillings@1324 2152 for (var i=0; i<commentQuestions.length; i++)
nickjillings@1324 2153 {
nickjillings@1318 2154 var node = new this.commentQuestionNode();
nickjillings@1324 2155 node.decode(parent,commentQuestions[i],commentQuestionSchema);
nickjillings@1318 2156 this.commentQuestions.push(node);
nickjillings@1318 2157 }
nickjillings@1318 2158 };
nickjillings@1318 2159
nickjillings@1318 2160 this.encode = function(root)
nickjillings@1318 2161 {
nickjillings@1318 2162 var AHNode = root.createElement("audioHolder");
nickjillings@1318 2163 AHNode.id = this.id;
nickjillings@1318 2164 AHNode.setAttribute("hostURL",this.hostURL);
nickjillings@1318 2165 AHNode.setAttribute("sampleRate",this.sampleRate);
nickjillings@1318 2166 AHNode.setAttribute("randomiseOrder",this.randomiseOrder);
nickjillings@1318 2167 AHNode.setAttribute("repeatCount",this.repeatCount);
nickjillings@1318 2168 AHNode.setAttribute("loop",this.loop);
nickjillings@1318 2169 AHNode.setAttribute("elementComments",this.elementComments);
nickjillings@1318 2170 if(this.loudness != null) {AHNode.setAttribute("loudness",this.loudness);}
nickjillings@1318 2171 if(this.initialPosition != null) {
nickjillings@1318 2172 AHNode.setAttribute("loudness",this.initialPosition*100);
nickjillings@1318 2173 }
nickjillings@1318 2174 for (var i=0; i<this.interfaces.length; i++)
nickjillings@1318 2175 {
nickjillings@1318 2176 AHNode.appendChild(this.interfaces[i].encode(root));
nickjillings@1318 2177 }
nickjillings@1318 2178
nickjillings@1318 2179 for (var i=0; i<this.audioElements.length; i++) {
nickjillings@1318 2180 AHNode.appendChild(this.audioElements[i].encode(root));
nickjillings@1318 2181 }
nickjillings@1318 2182 // Create <CommentQuestion>
nickjillings@1318 2183 for (var i=0; i<this.commentQuestions.length; i++)
nickjillings@1318 2184 {
nickjillings@1318 2185 AHNode.appendChild(this.commentQuestions[i].exportXML(root));
nickjillings@1318 2186 }
nickjillings@1318 2187
nickjillings@1318 2188 // Create <PreTest>
nickjillings@1318 2189 var AHPreTest = root.createElement("PreTest");
nickjillings@1318 2190 for (var i=0; i<this.preTest.options.length; i++)
nickjillings@1318 2191 {
nickjillings@1318 2192 AHPreTest.appendChild(this.preTest.options[i].exportXML(root));
nickjillings@1318 2193 }
nickjillings@1318 2194
nickjillings@1318 2195 var AHPostTest = root.createElement("PostTest");
nickjillings@1318 2196 for (var i=0; i<this.postTest.options.length; i++)
nickjillings@1318 2197 {
nickjillings@1318 2198 AHPostTest.appendChild(this.postTest.options[i].exportXML(root));
nickjillings@1318 2199 }
nickjillings@1318 2200 AHNode.appendChild(AHPreTest);
nickjillings@1318 2201 AHNode.appendChild(AHPostTest);
nickjillings@1318 2202 return AHNode;
nickjillings@1318 2203 };
nickjillings@1318 2204
nickjillings@1324 2205 this.commentQuestionNode = function() {
nickjillings@1324 2206 this.id = null;
nickjillings@1324 2207 this.type = undefined;
nickjillings@1318 2208 this.options = [];
nickjillings@1324 2209 this.statement = undefined;
nickjillings@1324 2210 this.schema = null;
nickjillings@1324 2211 this.decode = function(parent,xml,schema)
nickjillings@1318 2212 {
nickjillings@1324 2213 this.id = xml.id;
nickjillings@1324 2214 this.type = xml.getAttribute('type');
nickjillings@1324 2215 this.statement = xml.getElementsByTagName('statement')[0].textContent;
nickjillings@1324 2216 var optNodes = xml.getElementsByTagName('option');
nickjillings@1324 2217 for (var i=0; i<optNodes.length; i++)
nickjillings@1324 2218 {
nickjillings@1324 2219 var optNode = optNodes[i];
nickjillings@1324 2220 this.options.push({
nickjillings@1324 2221 name: optNode.getAttribute('name'),
nickjillings@1324 2222 text: optNode.textContent
nickjillings@1324 2223 });
nickjillings@1318 2224 }
nickjillings@1318 2225 };
nickjillings@1324 2226
nickjillings@1318 2227 this.encode = function(root)
nickjillings@1318 2228 {
nickjillings@1324 2229
nickjillings@1318 2230 };
nickjillings@1318 2231 };
nickjillings@1318 2232
nickjillings@1318 2233 this.audioElementNode = function() {
nickjillings@1318 2234 this.url = null;
nickjillings@1318 2235 this.id = null;
nickjillings@1318 2236 this.parent = null;
nickjillings@1324 2237 this.type = null;
nickjillings@1318 2238 this.marker = false;
nickjillings@1318 2239 this.enforce = false;
nickjillings@1318 2240 this.gain = 1.0;
nickjillings@1324 2241 this.schema = null;
nickjillings@1324 2242 this.parent = null;
nickjillings@1324 2243 this.decode = function(parent,xml,schema)
nickjillings@1318 2244 {
nickjillings@1324 2245 this.schema = schema;
nickjillings@1318 2246 this.parent = parent;
nickjillings@1348 2247 var attributeMap = this.schema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 2248 for (var i=0; i<attributeMap.length; i++)
nickjillings@1318 2249 {
nickjillings@1324 2250 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 2251 var projectAttr = xml.getAttribute(attributeName);
nickjillings@1324 2252 projectAttr = specification.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 2253 switch(typeof projectAttr)
nickjillings@1318 2254 {
nickjillings@1324 2255 case "number":
nickjillings@1324 2256 case "boolean":
nickjillings@1324 2257 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 2258 break;
nickjillings@1324 2259 case "string":
nickjillings@1324 2260 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 2261 break;
nickjillings@1318 2262 }
nickjillings@1318 2263 }
nickjillings@1324 2264
nickjillings@1318 2265 };
nickjillings@1318 2266 this.encode = function(root)
nickjillings@1318 2267 {
nickjillings@1318 2268 var AENode = root.createElement("audioElements");
nickjillings@1318 2269 AENode.id = this.id;
nickjillings@1318 2270 AENode.setAttribute("url",this.url);
nickjillings@1318 2271 AENode.setAttribute("type",this.type);
nickjillings@1318 2272 AENode.setAttribute("gain",linearToDecibel(this.gain));
nickjillings@1318 2273 if (this.marker != false)
nickjillings@1318 2274 {
nickjillings@1318 2275 AENode.setAttribute("marker",this.marker*100);
nickjillings@1318 2276 }
nickjillings@1318 2277 return AENode;
nickjillings@1318 2278 };
nickjillings@1318 2279 };
nickjillings@1318 2280 };
nickjillings@1318 2281 }
nickjillings@1318 2282
nickjillings@1318 2283 function Interface(specificationObject) {
nickjillings@1318 2284 // This handles the bindings between the interface and the audioEngineContext;
nickjillings@1318 2285 this.specification = specificationObject;
nickjillings@1318 2286 this.insertPoint = document.getElementById("topLevelBody");
nickjillings@1318 2287
nickjillings@1324 2288 this.newPage = function(audioHolderObject,store)
nickjillings@1318 2289 {
nickjillings@1324 2290 audioEngineContext.newTestPage(store);
nickjillings@1318 2291 audioEngineContext.loopPlayback = audioHolderObject.loop;
nickjillings@1318 2292 // Delete any previous audioObjects associated with the audioEngine
nickjillings@1318 2293 audioEngineContext.audioObjects = [];
nickjillings@1318 2294 interfaceContext.deleteCommentBoxes();
nickjillings@1318 2295 interfaceContext.deleteCommentQuestions();
nickjillings@1324 2296 loadTest(audioHolderObject,store);
nickjillings@1318 2297 };
nickjillings@1318 2298
nickjillings@1318 2299 // Bounded by interface!!
nickjillings@1318 2300 // Interface object MUST have an exportXMLDOM method which returns the various DOM levels
nickjillings@1318 2301 // For example, APE returns the slider position normalised in a <value> tag.
nickjillings@1318 2302 this.interfaceObjects = [];
nickjillings@1318 2303 this.interfaceObject = function(){};
nickjillings@1318 2304
nickjillings@1318 2305 this.resizeWindow = function(event)
nickjillings@1318 2306 {
nickjillings@1318 2307 popup.resize(event);
nickjillings@1318 2308 for(var i=0; i<this.commentBoxes.length; i++)
nickjillings@1318 2309 {this.commentBoxes[i].resize();}
nickjillings@1318 2310 for(var i=0; i<this.commentQuestions.length; i++)
nickjillings@1318 2311 {this.commentQuestions[i].resize();}
nickjillings@1318 2312 try
nickjillings@1318 2313 {
nickjillings@1318 2314 resizeWindow(event);
nickjillings@1318 2315 }
nickjillings@1318 2316 catch(err)
nickjillings@1318 2317 {
nickjillings@1318 2318 console.log("Warning - Interface does not have Resize option");
nickjillings@1318 2319 console.log(err);
nickjillings@1318 2320 }
nickjillings@1318 2321 };
nickjillings@1318 2322
nickjillings@1318 2323 this.returnNavigator = function()
nickjillings@1318 2324 {
nickjillings@1318 2325 var node = document.createElement("navigator");
nickjillings@1318 2326 var platform = document.createElement("platform");
nickjillings@1318 2327 platform.textContent = navigator.platform;
nickjillings@1318 2328 var vendor = document.createElement("vendor");
nickjillings@1318 2329 vendor.textContent = navigator.vendor;
nickjillings@1318 2330 var userAgent = document.createElement("uagent");
nickjillings@1318 2331 userAgent.textContent = navigator.userAgent;
nickjillings@1318 2332 node.appendChild(platform);
nickjillings@1318 2333 node.appendChild(vendor);
nickjillings@1318 2334 node.appendChild(userAgent);
nickjillings@1318 2335 return node;
nickjillings@1318 2336 };
nickjillings@1318 2337
nickjillings@1318 2338 this.commentBoxes = [];
nickjillings@1318 2339 this.elementCommentBox = function(audioObject) {
nickjillings@1318 2340 var element = audioObject.specification;
nickjillings@1318 2341 this.audioObject = audioObject;
nickjillings@1318 2342 this.id = audioObject.id;
nickjillings@1318 2343 var audioHolderObject = audioObject.specification.parent;
nickjillings@1318 2344 // Create document objects to hold the comment boxes
nickjillings@1318 2345 this.trackComment = document.createElement('div');
nickjillings@1318 2346 this.trackComment.className = 'comment-div';
nickjillings@1318 2347 this.trackComment.id = 'comment-div-'+audioObject.id;
nickjillings@1318 2348 // Create a string next to each comment asking for a comment
nickjillings@1318 2349 this.trackString = document.createElement('span');
nickjillings@1318 2350 this.trackString.innerHTML = audioHolderObject.commentBoxPrefix+' '+audioObject.id;
nickjillings@1318 2351 // Create the HTML5 comment box 'textarea'
nickjillings@1318 2352 this.trackCommentBox = document.createElement('textarea');
nickjillings@1318 2353 this.trackCommentBox.rows = '4';
nickjillings@1318 2354 this.trackCommentBox.cols = '100';
nickjillings@1318 2355 this.trackCommentBox.name = 'trackComment'+audioObject.id;
nickjillings@1318 2356 this.trackCommentBox.className = 'trackComment';
nickjillings@1318 2357 var br = document.createElement('br');
nickjillings@1318 2358 // Add to the holder.
nickjillings@1318 2359 this.trackComment.appendChild(this.trackString);
nickjillings@1318 2360 this.trackComment.appendChild(br);
nickjillings@1318 2361 this.trackComment.appendChild(this.trackCommentBox);
nickjillings@1318 2362
nickjillings@1318 2363 this.exportXMLDOM = function() {
nickjillings@1318 2364 var root = document.createElement('comment');
nickjillings@1318 2365 if (this.audioObject.specification.parent.elementComments) {
nickjillings@1318 2366 var question = document.createElement('question');
nickjillings@1318 2367 question.textContent = this.trackString.textContent;
nickjillings@1318 2368 var response = document.createElement('response');
nickjillings@1318 2369 response.textContent = this.trackCommentBox.value;
nickjillings@1318 2370 console.log("Comment frag-"+this.id+": "+response.textContent);
nickjillings@1318 2371 root.appendChild(question);
nickjillings@1318 2372 root.appendChild(response);
nickjillings@1318 2373 }
nickjillings@1318 2374 return root;
nickjillings@1318 2375 };
nickjillings@1318 2376 this.resize = function()
nickjillings@1318 2377 {
nickjillings@1318 2378 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2379 if (boxwidth >= 600)
nickjillings@1318 2380 {
nickjillings@1318 2381 boxwidth = 600;
nickjillings@1318 2382 }
nickjillings@1318 2383 else if (boxwidth < 400)
nickjillings@1318 2384 {
nickjillings@1318 2385 boxwidth = 400;
nickjillings@1318 2386 }
nickjillings@1318 2387 this.trackComment.style.width = boxwidth+"px";
nickjillings@1318 2388 this.trackCommentBox.style.width = boxwidth-6+"px";
nickjillings@1318 2389 };
nickjillings@1318 2390 this.resize();
nickjillings@1318 2391 };
nickjillings@1318 2392
nickjillings@1318 2393 this.commentQuestions = [];
nickjillings@1318 2394
nickjillings@1318 2395 this.commentBox = function(commentQuestion) {
nickjillings@1318 2396 this.specification = commentQuestion;
nickjillings@1318 2397 // Create document objects to hold the comment boxes
nickjillings@1318 2398 this.holder = document.createElement('div');
nickjillings@1318 2399 this.holder.className = 'comment-div';
nickjillings@1318 2400 // Create a string next to each comment asking for a comment
nickjillings@1318 2401 this.string = document.createElement('span');
nickjillings@1324 2402 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2403 // Create the HTML5 comment box 'textarea'
nickjillings@1318 2404 this.textArea = document.createElement('textarea');
nickjillings@1318 2405 this.textArea.rows = '4';
nickjillings@1318 2406 this.textArea.cols = '100';
nickjillings@1318 2407 this.textArea.className = 'trackComment';
nickjillings@1318 2408 var br = document.createElement('br');
nickjillings@1318 2409 // Add to the holder.
nickjillings@1318 2410 this.holder.appendChild(this.string);
nickjillings@1318 2411 this.holder.appendChild(br);
nickjillings@1318 2412 this.holder.appendChild(this.textArea);
nickjillings@1318 2413
nickjillings@1318 2414 this.exportXMLDOM = function() {
nickjillings@1318 2415 var root = document.createElement('comment');
nickjillings@1318 2416 root.id = this.specification.id;
nickjillings@1318 2417 root.setAttribute('type',this.specification.type);
nickjillings@1318 2418 root.textContent = this.textArea.value;
nickjillings@1318 2419 console.log("Question: "+this.string.textContent);
nickjillings@1318 2420 console.log("Response: "+root.textContent);
nickjillings@1318 2421 return root;
nickjillings@1318 2422 };
nickjillings@1318 2423 this.resize = function()
nickjillings@1318 2424 {
nickjillings@1318 2425 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2426 if (boxwidth >= 600)
nickjillings@1318 2427 {
nickjillings@1318 2428 boxwidth = 600;
nickjillings@1318 2429 }
nickjillings@1318 2430 else if (boxwidth < 400)
nickjillings@1318 2431 {
nickjillings@1318 2432 boxwidth = 400;
nickjillings@1318 2433 }
nickjillings@1318 2434 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2435 this.textArea.style.width = boxwidth-6+"px";
nickjillings@1318 2436 };
nickjillings@1318 2437 this.resize();
nickjillings@1318 2438 };
nickjillings@1318 2439
nickjillings@1318 2440 this.radioBox = function(commentQuestion) {
nickjillings@1318 2441 this.specification = commentQuestion;
nickjillings@1318 2442 // Create document objects to hold the comment boxes
nickjillings@1318 2443 this.holder = document.createElement('div');
nickjillings@1318 2444 this.holder.className = 'comment-div';
nickjillings@1318 2445 // Create a string next to each comment asking for a comment
nickjillings@1318 2446 this.string = document.createElement('span');
nickjillings@1318 2447 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2448 var br = document.createElement('br');
nickjillings@1318 2449 // Add to the holder.
nickjillings@1318 2450 this.holder.appendChild(this.string);
nickjillings@1318 2451 this.holder.appendChild(br);
nickjillings@1318 2452 this.options = [];
nickjillings@1318 2453 this.inputs = document.createElement('div');
nickjillings@1318 2454 this.span = document.createElement('div');
nickjillings@1318 2455 this.inputs.align = 'center';
nickjillings@1318 2456 this.inputs.style.marginLeft = '12px';
nickjillings@1318 2457 this.span.style.marginLeft = '12px';
nickjillings@1318 2458 this.span.align = 'center';
nickjillings@1318 2459 this.span.style.marginTop = '15px';
nickjillings@1318 2460
nickjillings@1318 2461 var optCount = commentQuestion.options.length;
nickjillings@1324 2462 for (var optNode of commentQuestion.options)
nickjillings@1318 2463 {
nickjillings@1318 2464 var div = document.createElement('div');
nickjillings@1318 2465 div.style.width = '80px';
nickjillings@1318 2466 div.style.float = 'left';
nickjillings@1318 2467 var input = document.createElement('input');
nickjillings@1318 2468 input.type = 'radio';
nickjillings@1318 2469 input.name = commentQuestion.id;
nickjillings@1324 2470 input.setAttribute('setvalue',optNode.name);
nickjillings@1318 2471 input.className = 'comment-radio';
nickjillings@1318 2472 div.appendChild(input);
nickjillings@1318 2473 this.inputs.appendChild(div);
nickjillings@1318 2474
nickjillings@1318 2475
nickjillings@1318 2476 div = document.createElement('div');
nickjillings@1318 2477 div.style.width = '80px';
nickjillings@1318 2478 div.style.float = 'left';
nickjillings@1318 2479 div.align = 'center';
nickjillings@1318 2480 var span = document.createElement('span');
nickjillings@1324 2481 span.textContent = optNode.text;
nickjillings@1318 2482 span.className = 'comment-radio-span';
nickjillings@1318 2483 div.appendChild(span);
nickjillings@1318 2484 this.span.appendChild(div);
nickjillings@1318 2485 this.options.push(input);
nickjillings@1318 2486 }
nickjillings@1318 2487 this.holder.appendChild(this.span);
nickjillings@1318 2488 this.holder.appendChild(this.inputs);
nickjillings@1318 2489
nickjillings@1318 2490 this.exportXMLDOM = function() {
nickjillings@1318 2491 var root = document.createElement('comment');
nickjillings@1318 2492 root.id = this.specification.id;
nickjillings@1318 2493 root.setAttribute('type',this.specification.type);
nickjillings@1318 2494 var question = document.createElement('question');
nickjillings@1318 2495 question.textContent = this.string.textContent;
nickjillings@1318 2496 var response = document.createElement('response');
nickjillings@1318 2497 var i=0;
nickjillings@1318 2498 while(this.options[i].checked == false) {
nickjillings@1318 2499 i++;
nickjillings@1318 2500 if (i >= this.options.length) {
nickjillings@1318 2501 break;
nickjillings@1318 2502 }
nickjillings@1318 2503 }
nickjillings@1318 2504 if (i >= this.options.length) {
nickjillings@1318 2505 response.textContent = 'null';
nickjillings@1318 2506 } else {
nickjillings@1318 2507 response.textContent = this.options[i].getAttribute('setvalue');
nickjillings@1318 2508 response.setAttribute('number',i);
nickjillings@1318 2509 }
nickjillings@1318 2510 console.log('Comment: '+question.textContent);
nickjillings@1318 2511 console.log('Response: '+response.textContent);
nickjillings@1318 2512 root.appendChild(question);
nickjillings@1318 2513 root.appendChild(response);
nickjillings@1318 2514 return root;
nickjillings@1318 2515 };
nickjillings@1318 2516 this.resize = function()
nickjillings@1318 2517 {
nickjillings@1318 2518 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2519 if (boxwidth >= 600)
nickjillings@1318 2520 {
nickjillings@1318 2521 boxwidth = 600;
nickjillings@1318 2522 }
nickjillings@1318 2523 else if (boxwidth < 400)
nickjillings@1318 2524 {
nickjillings@1318 2525 boxwidth = 400;
nickjillings@1318 2526 }
nickjillings@1318 2527 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2528 var text = this.holder.children[2];
nickjillings@1318 2529 var options = this.holder.children[3];
nickjillings@1318 2530 var optCount = options.children.length;
nickjillings@1318 2531 var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nickjillings@1318 2532 var options = options.firstChild;
nickjillings@1318 2533 var text = text.firstChild;
nickjillings@1318 2534 options.style.marginRight = spanMargin;
nickjillings@1318 2535 options.style.marginLeft = spanMargin;
nickjillings@1318 2536 text.style.marginRight = spanMargin;
nickjillings@1318 2537 text.style.marginLeft = spanMargin;
nickjillings@1318 2538 while(options.nextSibling != undefined)
nickjillings@1318 2539 {
nickjillings@1318 2540 options = options.nextSibling;
nickjillings@1318 2541 text = text.nextSibling;
nickjillings@1318 2542 options.style.marginRight = spanMargin;
nickjillings@1318 2543 options.style.marginLeft = spanMargin;
nickjillings@1318 2544 text.style.marginRight = spanMargin;
nickjillings@1318 2545 text.style.marginLeft = spanMargin;
nickjillings@1318 2546 }
nickjillings@1318 2547 };
nickjillings@1318 2548 this.resize();
nickjillings@1318 2549 };
nickjillings@1318 2550
nickjillings@1318 2551 this.checkboxBox = function(commentQuestion) {
nickjillings@1318 2552 this.specification = commentQuestion;
nickjillings@1318 2553 // Create document objects to hold the comment boxes
nickjillings@1318 2554 this.holder = document.createElement('div');
nickjillings@1318 2555 this.holder.className = 'comment-div';
nickjillings@1318 2556 // Create a string next to each comment asking for a comment
nickjillings@1318 2557 this.string = document.createElement('span');
nickjillings@1318 2558 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2559 var br = document.createElement('br');
nickjillings@1318 2560 // Add to the holder.
nickjillings@1318 2561 this.holder.appendChild(this.string);
nickjillings@1318 2562 this.holder.appendChild(br);
nickjillings@1318 2563 this.options = [];
nickjillings@1318 2564 this.inputs = document.createElement('div');
nickjillings@1318 2565 this.span = document.createElement('div');
nickjillings@1318 2566 this.inputs.align = 'center';
nickjillings@1318 2567 this.inputs.style.marginLeft = '12px';
nickjillings@1318 2568 this.span.style.marginLeft = '12px';
nickjillings@1318 2569 this.span.align = 'center';
nickjillings@1318 2570 this.span.style.marginTop = '15px';
nickjillings@1318 2571
nickjillings@1318 2572 var optCount = commentQuestion.options.length;
nickjillings@1318 2573 for (var i=0; i<optCount; i++)
nickjillings@1318 2574 {
nickjillings@1318 2575 var div = document.createElement('div');
nickjillings@1318 2576 div.style.width = '80px';
nickjillings@1318 2577 div.style.float = 'left';
nickjillings@1318 2578 var input = document.createElement('input');
nickjillings@1318 2579 input.type = 'checkbox';
nickjillings@1318 2580 input.name = commentQuestion.id;
nickjillings@1318 2581 input.setAttribute('setvalue',commentQuestion.options[i].name);
nickjillings@1318 2582 input.className = 'comment-radio';
nickjillings@1318 2583 div.appendChild(input);
nickjillings@1318 2584 this.inputs.appendChild(div);
nickjillings@1318 2585
nickjillings@1318 2586
nickjillings@1318 2587 div = document.createElement('div');
nickjillings@1318 2588 div.style.width = '80px';
nickjillings@1318 2589 div.style.float = 'left';
nickjillings@1318 2590 div.align = 'center';
nickjillings@1318 2591 var span = document.createElement('span');
nickjillings@1318 2592 span.textContent = commentQuestion.options[i].text;
nickjillings@1318 2593 span.className = 'comment-radio-span';
nickjillings@1318 2594 div.appendChild(span);
nickjillings@1318 2595 this.span.appendChild(div);
nickjillings@1318 2596 this.options.push(input);
nickjillings@1318 2597 }
nickjillings@1318 2598 this.holder.appendChild(this.span);
nickjillings@1318 2599 this.holder.appendChild(this.inputs);
nickjillings@1318 2600
nickjillings@1318 2601 this.exportXMLDOM = function() {
nickjillings@1318 2602 var root = document.createElement('comment');
nickjillings@1318 2603 root.id = this.specification.id;
nickjillings@1318 2604 root.setAttribute('type',this.specification.type);
nickjillings@1318 2605 var question = document.createElement('question');
nickjillings@1318 2606 question.textContent = this.string.textContent;
nickjillings@1318 2607 root.appendChild(question);
nickjillings@1318 2608 console.log('Comment: '+question.textContent);
nickjillings@1318 2609 for (var i=0; i<this.options.length; i++) {
nickjillings@1318 2610 var response = document.createElement('response');
nickjillings@1318 2611 response.textContent = this.options[i].checked;
nickjillings@1318 2612 response.setAttribute('name',this.options[i].getAttribute('setvalue'));
nickjillings@1318 2613 root.appendChild(response);
nickjillings@1318 2614 console.log('Response '+response.getAttribute('name') +': '+response.textContent);
nickjillings@1318 2615 }
nickjillings@1318 2616 return root;
nickjillings@1318 2617 };
nickjillings@1318 2618 this.resize = function()
nickjillings@1318 2619 {
nickjillings@1318 2620 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2621 if (boxwidth >= 600)
nickjillings@1318 2622 {
nickjillings@1318 2623 boxwidth = 600;
nickjillings@1318 2624 }
nickjillings@1318 2625 else if (boxwidth < 400)
nickjillings@1318 2626 {
nickjillings@1318 2627 boxwidth = 400;
nickjillings@1318 2628 }
nickjillings@1318 2629 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2630 var text = this.holder.children[2];
nickjillings@1318 2631 var options = this.holder.children[3];
nickjillings@1318 2632 var optCount = options.children.length;
nickjillings@1318 2633 var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nickjillings@1318 2634 var options = options.firstChild;
nickjillings@1318 2635 var text = text.firstChild;
nickjillings@1318 2636 options.style.marginRight = spanMargin;
nickjillings@1318 2637 options.style.marginLeft = spanMargin;
nickjillings@1318 2638 text.style.marginRight = spanMargin;
nickjillings@1318 2639 text.style.marginLeft = spanMargin;
nickjillings@1318 2640 while(options.nextSibling != undefined)
nickjillings@1318 2641 {
nickjillings@1318 2642 options = options.nextSibling;
nickjillings@1318 2643 text = text.nextSibling;
nickjillings@1318 2644 options.style.marginRight = spanMargin;
nickjillings@1318 2645 options.style.marginLeft = spanMargin;
nickjillings@1318 2646 text.style.marginRight = spanMargin;
nickjillings@1318 2647 text.style.marginLeft = spanMargin;
nickjillings@1318 2648 }
nickjillings@1318 2649 };
nickjillings@1318 2650 this.resize();
nickjillings@1318 2651 };
nickjillings@1318 2652
nickjillings@1318 2653 this.createCommentBox = function(audioObject) {
nickjillings@1318 2654 var node = new this.elementCommentBox(audioObject);
nickjillings@1318 2655 this.commentBoxes.push(node);
nickjillings@1318 2656 audioObject.commentDOM = node;
nickjillings@1318 2657 return node;
nickjillings@1318 2658 };
nickjillings@1318 2659
nickjillings@1318 2660 this.sortCommentBoxes = function() {
nickjillings@1338 2661 this.commentBoxes.sort(function(a,b){return a.id - b.id;});
nickjillings@1318 2662 };
nickjillings@1318 2663
nickjillings@1318 2664 this.showCommentBoxes = function(inject, sort) {
nickjillings@1318 2665 if (sort) {interfaceContext.sortCommentBoxes();}
nickjillings@1338 2666 for (var box of interfaceContext.commentBoxes) {
nickjillings@1338 2667 inject.appendChild(box.trackComment);
nickjillings@1318 2668 }
nickjillings@1318 2669 };
nickjillings@1318 2670
nickjillings@1318 2671 this.deleteCommentBoxes = function() {
nickjillings@1318 2672 this.commentBoxes = [];
nickjillings@1318 2673 };
nickjillings@1318 2674
nickjillings@1318 2675 this.createCommentQuestion = function(element) {
nickjillings@1318 2676 var node;
nickjillings@1324 2677 if (element.type == 'question') {
nickjillings@1318 2678 node = new this.commentBox(element);
nickjillings@1318 2679 } else if (element.type == 'radio') {
nickjillings@1318 2680 node = new this.radioBox(element);
nickjillings@1318 2681 } else if (element.type == 'checkbox') {
nickjillings@1318 2682 node = new this.checkboxBox(element);
nickjillings@1318 2683 }
nickjillings@1318 2684 this.commentQuestions.push(node);
nickjillings@1318 2685 return node;
nickjillings@1318 2686 };
nickjillings@1318 2687
nickjillings@1318 2688 this.deleteCommentQuestions = function()
nickjillings@1318 2689 {
nickjillings@1318 2690 this.commentQuestions = [];
nickjillings@1318 2691 };
nickjillings@1318 2692
nickjillings@1318 2693 this.playhead = new function()
nickjillings@1318 2694 {
nickjillings@1318 2695 this.object = document.createElement('div');
nickjillings@1318 2696 this.object.className = 'playhead';
nickjillings@1318 2697 this.object.align = 'left';
nickjillings@1318 2698 var curTime = document.createElement('div');
nickjillings@1318 2699 curTime.style.width = '50px';
nickjillings@1318 2700 this.curTimeSpan = document.createElement('span');
nickjillings@1318 2701 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2702 curTime.appendChild(this.curTimeSpan);
nickjillings@1318 2703 this.object.appendChild(curTime);
nickjillings@1318 2704 this.scrubberTrack = document.createElement('div');
nickjillings@1318 2705 this.scrubberTrack.className = 'playhead-scrub-track';
nickjillings@1318 2706
nickjillings@1318 2707 this.scrubberHead = document.createElement('div');
nickjillings@1318 2708 this.scrubberHead.id = 'playhead-scrubber';
nickjillings@1318 2709 this.scrubberTrack.appendChild(this.scrubberHead);
nickjillings@1318 2710 this.object.appendChild(this.scrubberTrack);
nickjillings@1318 2711
nickjillings@1318 2712 this.timePerPixel = 0;
nickjillings@1318 2713 this.maxTime = 0;
nickjillings@1318 2714
nickjillings@1318 2715 this.playbackObject;
nickjillings@1318 2716
nickjillings@1318 2717 this.setTimePerPixel = function(audioObject) {
nickjillings@1318 2718 //maxTime must be in seconds
nickjillings@1318 2719 this.playbackObject = audioObject;
nickjillings@1318 2720 this.maxTime = audioObject.buffer.buffer.duration;
nickjillings@1318 2721 var width = 490; //500 - 10, 5 each side of the tracker head
nickjillings@1318 2722 this.timePerPixel = this.maxTime/490;
nickjillings@1318 2723 if (this.maxTime < 60) {
nickjillings@1318 2724 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2725 } else {
nickjillings@1318 2726 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2727 }
nickjillings@1318 2728 };
nickjillings@1318 2729
nickjillings@1318 2730 this.update = function() {
nickjillings@1318 2731 // Update the playhead position, startPlay must be called
nickjillings@1318 2732 if (this.timePerPixel > 0) {
nickjillings@1318 2733 var time = this.playbackObject.getCurrentPosition();
nickjillings@1318 2734 if (time > 0) {
nickjillings@1318 2735 var width = 490;
nickjillings@1318 2736 var pix = Math.floor(time/this.timePerPixel);
nickjillings@1318 2737 this.scrubberHead.style.left = pix+'px';
nickjillings@1318 2738 if (this.maxTime > 60.0) {
nickjillings@1318 2739 var secs = time%60;
nickjillings@1318 2740 var mins = Math.floor((time-secs)/60);
nickjillings@1318 2741 secs = secs.toString();
nickjillings@1318 2742 secs = secs.substr(0,2);
nickjillings@1318 2743 mins = mins.toString();
nickjillings@1318 2744 this.curTimeSpan.textContent = mins+':'+secs;
nickjillings@1318 2745 } else {
nickjillings@1318 2746 time = time.toString();
nickjillings@1318 2747 this.curTimeSpan.textContent = time.substr(0,4);
nickjillings@1318 2748 }
nickjillings@1318 2749 } else {
nickjillings@1318 2750 this.scrubberHead.style.left = '0px';
nickjillings@1318 2751 if (this.maxTime < 60) {
nickjillings@1318 2752 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2753 } else {
nickjillings@1318 2754 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2755 }
nickjillings@1318 2756 }
nickjillings@1318 2757 }
nickjillings@1318 2758 };
nickjillings@1318 2759
nickjillings@1318 2760 this.interval = undefined;
nickjillings@1318 2761
nickjillings@1318 2762 this.start = function() {
nickjillings@1318 2763 if (this.playbackObject != undefined && this.interval == undefined) {
nickjillings@1318 2764 if (this.maxTime < 60) {
nickjillings@1318 2765 this.interval = setInterval(function(){interfaceContext.playhead.update();},10);
nickjillings@1318 2766 } else {
nickjillings@1318 2767 this.interval = setInterval(function(){interfaceContext.playhead.update();},100);
nickjillings@1318 2768 }
nickjillings@1318 2769 }
nickjillings@1318 2770 };
nickjillings@1318 2771 this.stop = function() {
nickjillings@1318 2772 clearInterval(this.interval);
nickjillings@1318 2773 this.interval = undefined;
nickjillings@1318 2774 if (this.maxTime < 60) {
nickjillings@1318 2775 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2776 } else {
nickjillings@1318 2777 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2778 }
nickjillings@1318 2779 };
nickjillings@1318 2780 };
nickjillings@1354 2781
nickjillings@1354 2782 this.volume = new function()
nickjillings@1354 2783 {
nickjillings@1354 2784 // An in-built volume module which can be viewed on page
nickjillings@1354 2785 // Includes trackers on page-by-page data
nickjillings@1354 2786 // Volume does NOT reset to 0dB on each page load
nickjillings@1354 2787 this.valueLin = 1.0;
nickjillings@1354 2788 this.valueDB = 0.0;
nickjillings@1354 2789 this.object = document.createElement('div');
nickjillings@1354 2790 this.object.id = 'master-volume-holder';
nickjillings@1354 2791 this.slider = document.createElement('input');
nickjillings@1354 2792 this.slider.id = 'master-volume-control';
nickjillings@1354 2793 this.slider.type = 'range';
nickjillings@1354 2794 this.valueText = document.createElement('span');
nickjillings@1354 2795 this.valueText.id = 'master-volume-feedback';
nickjillings@1354 2796 this.valueText.textContent = '0dB';
nickjillings@1354 2797
nickjillings@1354 2798 this.slider.min = -60;
nickjillings@1354 2799 this.slider.max = 12;
nickjillings@1354 2800 this.slider.value = 0;
nickjillings@1354 2801 this.slider.step = 1;
nickjillings@1354 2802 this.slider.onmousemove = function(event)
nickjillings@1354 2803 {
nickjillings@1354 2804 interfaceContext.volume.valueDB = event.currentTarget.value;
nickjillings@1354 2805 interfaceContext.volume.valueLin = decibelToLinear(interfaceContext.volume.valueDB);
nickjillings@1354 2806 interfaceContext.volume.valueText.textContent = interfaceContext.volume.valueDB+'dB';
nickjillings@1354 2807 audioEngineContext.outputGain.gain.value = interfaceContext.volume.valueLin;
nickjillings@1354 2808 }
nickjillings@1354 2809 this.slider.onmouseup = function(event)
nickjillings@1354 2810 {
nickjillings@1354 2811 var storePoint = testState.currentStore.XMLDOM.children[0].getAllElementsByName('volumeTracker');
nickjillings@1354 2812 if (storePoint.length == 0)
nickjillings@1354 2813 {
nickjillings@1354 2814 storePoint = storage.document.createElement('metricresult');
nickjillings@1354 2815 storePoint.setAttribute('name','volumeTracker');
nickjillings@1354 2816 testState.currentStore.XMLDOM.children[0].appendChild(storePoint);
nickjillings@1354 2817 }
nickjillings@1354 2818 else {
nickjillings@1354 2819 storePoint = storePoint[0];
nickjillings@1354 2820 }
nickjillings@1354 2821 var node = storage.document.createElement('movement');
nickjillings@1354 2822 node.setAttribute('test-time',audioEngineContext.timer.getTestTime());
nickjillings@1354 2823 node.setAttribute('volume',interfaceContext.volume.valueDB);
nickjillings@1354 2824 node.setAttribute('format','dBFS');
nickjillings@1354 2825 storePoint.appendChild(node);
nickjillings@1354 2826 }
nickjillings@1354 2827
nickjillings@1355 2828 var title = document.createElement('div');
nickjillings@1355 2829 title.innerHTML = '<span>Master Volume Control</span>';
nickjillings@1355 2830 title.style.fontSize = '0.75em';
nickjillings@1355 2831 title.style.width = "100%";
nickjillings@1355 2832 title.align = 'center';
nickjillings@1355 2833 this.object.appendChild(title);
nickjillings@1355 2834
nickjillings@1354 2835 this.object.appendChild(this.slider);
nickjillings@1354 2836 this.object.appendChild(this.valueText);
nickjillings@1354 2837 }
nickjillings@1318 2838 // Global Checkers
nickjillings@1318 2839 // These functions will help enforce the checkers
nickjillings@1318 2840 this.checkHiddenAnchor = function()
nickjillings@1318 2841 {
nickjillings@1324 2842 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2843 {
nickjillings@1324 2844 if (ao.specification.type == "anchor")
nickjillings@1318 2845 {
nickjillings@1325 2846 if (ao.interfaceDOM.getValue() > (ao.specification.marker/100) && ao.specification.marker > 0) {
nickjillings@1324 2847 // Anchor is not set below
nickjillings@1324 2848 console.log('Anchor node not below marker value');
nickjillings@1324 2849 alert('Please keep listening');
nickjillings@1324 2850 return false;
nickjillings@1324 2851 }
nickjillings@1318 2852 }
nickjillings@1318 2853 }
nickjillings@1318 2854 return true;
nickjillings@1318 2855 };
nickjillings@1318 2856
nickjillings@1318 2857 this.checkHiddenReference = function()
nickjillings@1318 2858 {
nickjillings@1324 2859 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2860 {
nickjillings@1324 2861 if (ao.specification.type == "reference")
nickjillings@1318 2862 {
nickjillings@1325 2863 if (ao.interfaceDOM.getValue() < (ao.specification.marker/100) && ao.specification.marker > 0) {
nickjillings@1324 2864 // Anchor is not set below
nickjillings@1324 2865 console.log('Reference node not below marker value');
nickjillings@1324 2866 alert('Please keep listening');
nickjillings@1324 2867 return false;
nickjillings@1324 2868 }
nickjillings@1318 2869 }
nickjillings@1318 2870 }
nickjillings@1318 2871 return true;
nickjillings@1318 2872 };
nickjillings@1318 2873
nickjillings@1318 2874 this.checkFragmentsFullyPlayed = function ()
nickjillings@1318 2875 {
nickjillings@1318 2876 // Checks the entire file has been played back
nickjillings@1318 2877 // NOTE ! This will return true IF playback is Looped!!!
nickjillings@1318 2878 if (audioEngineContext.loopPlayback)
nickjillings@1318 2879 {
nickjillings@1318 2880 console.log("WARNING - Looped source: Cannot check fragments are fully played");
nickjillings@1318 2881 return true;
nickjillings@1318 2882 }
nickjillings@1318 2883 var check_pass = true;
nickjillings@1318 2884 var error_obj = [];
nickjillings@1318 2885 for (var i = 0; i<audioEngineContext.audioObjects.length; i++)
nickjillings@1318 2886 {
nickjillings@1318 2887 var object = audioEngineContext.audioObjects[i];
nickjillings@1318 2888 var time = object.buffer.buffer.duration;
nickjillings@1318 2889 var metric = object.metric;
nickjillings@1318 2890 var passed = false;
nickjillings@1318 2891 for (var j=0; j<metric.listenTracker.length; j++)
nickjillings@1318 2892 {
nickjillings@1318 2893 var bt = metric.listenTracker[j].getElementsByTagName('buffertime');
nickjillings@1318 2894 var start_time = Number(bt[0].getAttribute('start'));
nickjillings@1318 2895 var stop_time = Number(bt[0].getAttribute('stop'));
nickjillings@1318 2896 var delta = stop_time - start_time;
nickjillings@1318 2897 if (delta >= time)
nickjillings@1318 2898 {
nickjillings@1318 2899 passed = true;
nickjillings@1318 2900 break;
nickjillings@1318 2901 }
nickjillings@1318 2902 }
nickjillings@1318 2903 if (passed == false)
nickjillings@1318 2904 {
nickjillings@1318 2905 check_pass = false;
nickjillings@1340 2906 console.log("Continue listening to track-"+audioEngineContext.audioObjects.interfaceDOM.getPresentedId());
nickjillings@1340 2907 error_obj.push(audioEngineContext.audioObjects.interfaceDOM.getPresentedId());
nickjillings@1318 2908 }
nickjillings@1318 2909 }
nickjillings@1318 2910 if (check_pass == false)
nickjillings@1318 2911 {
nickjillings@1318 2912 var str_start = "You have not completely listened to fragments ";
nickjillings@1318 2913 for (var i=0; i<error_obj.length; i++)
nickjillings@1318 2914 {
nickjillings@1318 2915 str_start += error_obj[i];
nickjillings@1318 2916 if (i != error_obj.length-1)
nickjillings@1318 2917 {
nickjillings@1318 2918 str_start += ', ';
nickjillings@1318 2919 }
nickjillings@1318 2920 }
nickjillings@1318 2921 str_start += ". Please keep listening";
nickjillings@1318 2922 console.log("[ALERT]: "+str_start);
nickjillings@1318 2923 alert(str_start);
nickjillings@1318 2924 }
nickjillings@1318 2925 };
nickjillings@1318 2926 this.checkAllMoved = function()
nickjillings@1318 2927 {
nickjillings@1318 2928 var str = "You have not moved ";
nickjillings@1318 2929 var failed = [];
nickjillings@1340 2930 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2931 {
nickjillings@1340 2932 if(ao.metric.wasMoved == false && ao.interfaceDOM.canMove() == true)
nickjillings@1318 2933 {
nickjillings@1340 2934 failed.push(ao.interfaceDOM.getPresentedId());
nickjillings@1318 2935 }
nickjillings@1318 2936 }
nickjillings@1318 2937 if (failed.length == 0)
nickjillings@1318 2938 {
nickjillings@1318 2939 return true;
nickjillings@1318 2940 } else if (failed.length == 1)
nickjillings@1318 2941 {
nickjillings@1318 2942 str += 'track '+failed[0];
nickjillings@1318 2943 } else {
nickjillings@1318 2944 str += 'tracks ';
nickjillings@1318 2945 for (var i=0; i<failed.length-1; i++)
nickjillings@1318 2946 {
nickjillings@1318 2947 str += failed[i]+', ';
nickjillings@1318 2948 }
nickjillings@1318 2949 str += 'and '+failed[i];
nickjillings@1318 2950 }
nickjillings@1318 2951 str +='.';
nickjillings@1318 2952 alert(str);
nickjillings@1318 2953 console.log(str);
nickjillings@1318 2954 return false;
nickjillings@1318 2955 };
nickjillings@1318 2956 this.checkAllPlayed = function()
nickjillings@1318 2957 {
nickjillings@1318 2958 var str = "You have not played ";
nickjillings@1318 2959 var failed = [];
nickjillings@1340 2960 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2961 {
nickjillings@1340 2962 if(ao.metric.wasListenedTo == false)
nickjillings@1318 2963 {
nickjillings@1340 2964 failed.push(ao.interfaceDOM.getPresentedId());
nickjillings@1318 2965 }
nickjillings@1318 2966 }
nickjillings@1318 2967 if (failed.length == 0)
nickjillings@1318 2968 {
nickjillings@1318 2969 return true;
nickjillings@1318 2970 } else if (failed.length == 1)
nickjillings@1318 2971 {
nickjillings@1318 2972 str += 'track '+failed[0];
nickjillings@1318 2973 } else {
nickjillings@1318 2974 str += 'tracks ';
nickjillings@1318 2975 for (var i=0; i<failed.length-1; i++)
nickjillings@1318 2976 {
nickjillings@1318 2977 str += failed[i]+', ';
nickjillings@1318 2978 }
nickjillings@1318 2979 str += 'and '+failed[i];
nickjillings@1318 2980 }
nickjillings@1318 2981 str +='.';
nickjillings@1318 2982 alert(str);
nickjillings@1318 2983 console.log(str);
nickjillings@1318 2984 return false;
nickjillings@1318 2985 };
nickjillings@1324 2986 }
nickjillings@1324 2987
nickjillings@1324 2988 function Storage()
nickjillings@1324 2989 {
nickjillings@1324 2990 // Holds results in XML format until ready for collection
nickjillings@1324 2991 this.globalPreTest = null;
nickjillings@1324 2992 this.globalPostTest = null;
nickjillings@1324 2993 this.testPages = [];
nickjillings@1324 2994 this.document = document.implementation.createDocument(null,"waetresult");
nickjillings@1324 2995 this.root = this.document.children[0];
nickjillings@1324 2996 this.state = 0;
nickjillings@1324 2997
nickjillings@1324 2998 this.initialise = function()
nickjillings@1324 2999 {
nickjillings@1342 3000 if (specification.preTest != undefined){this.globalPreTest = new this.surveyNode(this,this.root,specification.preTest);}
nickjillings@1342 3001 if (specification.postTest != undefined){this.globalPostTest = new this.surveyNode(this,this.root,specification.postTest);}
nickjillings@1324 3002 };
nickjillings@1324 3003
nickjillings@1324 3004 this.createTestPageStore = function(specification)
nickjillings@1324 3005 {
nickjillings@1324 3006 var store = new this.pageNode(this,specification);
nickjillings@1324 3007 this.testPages.push(store);
nickjillings@1324 3008 return this.testPages[this.testPages.length-1];
nickjillings@1324 3009 };
nickjillings@1324 3010
nickjillings@1324 3011 this.surveyNode = function(parent,root,specification)
nickjillings@1324 3012 {
nickjillings@1324 3013 this.specification = specification;
nickjillings@1324 3014 this.parent = parent;
nickjillings@1324 3015 this.XMLDOM = this.parent.document.createElement('survey');
nickjillings@1324 3016 this.XMLDOM.setAttribute('location',this.specification.location);
nickjillings@1324 3017 for (var optNode of this.specification.options)
nickjillings@1324 3018 {
nickjillings@1324 3019 if (optNode.type != 'statement')
nickjillings@1324 3020 {
nickjillings@1324 3021 var node = this.parent.document.createElement('surveyresult');
nickjillings@1324 3022 node.id = optNode.id;
nickjillings@1324 3023 node.setAttribute('type',optNode.type);
nickjillings@1324 3024 this.XMLDOM.appendChild(node);
nickjillings@1324 3025 }
nickjillings@1324 3026 }
nickjillings@1324 3027 root.appendChild(this.XMLDOM);
nickjillings@1324 3028
nickjillings@1324 3029 this.postResult = function(node)
nickjillings@1324 3030 {
nickjillings@1324 3031 // From popup: node is the popupOption node containing both spec. and results
nickjillings@1324 3032 // ID is the position
nickjillings@1324 3033 if (node.specification.type == 'statement'){return;}
nickjillings@1324 3034 var surveyresult = this.parent.document.getElementById(node.specification.id);
nickjillings@1324 3035 switch(node.specification.type)
nickjillings@1324 3036 {
nickjillings@1324 3037 case "number":
nickjillings@1324 3038 case "question":
nickjillings@1324 3039 var child = this.parent.document.createElement('response');
nickjillings@1324 3040 child.textContent = node.response;
nickjillings@1324 3041 surveyresult.appendChild(child);
nickjillings@1324 3042 break;
nickjillings@1324 3043 case "radio":
nickjillings@1324 3044 var child = this.parent.document.createElement('response');
nickjillings@1324 3045 child.setAttribute('name',node.response.name);
nickjillings@1324 3046 child.textContent = node.response.text;
nickjillings@1324 3047 surveyresult.appendChild(child);
nickjillings@1324 3048 break;
nickjillings@1324 3049 case "checkbox":
nickjillings@1324 3050 for (var i=0; i<node.response.length; i++)
nickjillings@1324 3051 {
nickjillings@1324 3052 var checkNode = this.parent.document.createElement('response');
nickjillings@1347 3053 checkNode.setAttribute('name',node.response[i].name);
nickjillings@1347 3054 checkNode.setAttribute('checked',node.response[i].checked);
nickjillings@1326 3055 surveyresult.appendChild(checkNode);
nickjillings@1324 3056 }
nickjillings@1324 3057 break;
nickjillings@1324 3058 }
nickjillings@1324 3059 };
nickjillings@1324 3060 };
nickjillings@1324 3061
nickjillings@1324 3062 this.pageNode = function(parent,specification)
nickjillings@1324 3063 {
nickjillings@1324 3064 // Create one store per test page
nickjillings@1324 3065 this.specification = specification;
nickjillings@1324 3066 this.parent = parent;
nickjillings@1324 3067 this.XMLDOM = this.parent.document.createElement('page');
nickjillings@1324 3068 this.XMLDOM.setAttribute('id',specification.id);
nickjillings@1324 3069 this.XMLDOM.setAttribute('presentedId',specification.presentedId);
nickjillings@1345 3070 if (specification.preTest != undefined){this.preTest = new this.parent.surveyNode(this.parent,this.XMLDOM,this.specification.preTest);}
nickjillings@1345 3071 if (specification.postTest != undefined){this.postTest = new this.parent.surveyNode(this.parent,this.XMLDOM,this.specification.postTest);}
nickjillings@1324 3072
nickjillings@1324 3073 // Add any page metrics
nickjillings@1324 3074 var page_metric = this.parent.document.createElement('metric');
nickjillings@1324 3075 this.XMLDOM.appendChild(page_metric);
nickjillings@1324 3076
nickjillings@1324 3077 // Add the audioelement
nickjillings@1324 3078 for (var element of this.specification.audioElements)
nickjillings@1324 3079 {
nickjillings@1324 3080 var aeNode = this.parent.document.createElement('audioelement');
nickjillings@1324 3081 aeNode.id = element.id;
nickjillings@1324 3082 aeNode.setAttribute('type',element.type);
nickjillings@1324 3083 aeNode.setAttribute('url', element.url);
nickjillings@1324 3084 aeNode.setAttribute('gain', element.gain);
nickjillings@1324 3085 if (element.type == 'anchor' || element.type == 'reference')
nickjillings@1324 3086 {
nickjillings@1324 3087 if (element.marker > 0)
nickjillings@1324 3088 {
nickjillings@1324 3089 aeNode.setAttribute('marker',element.marker);
nickjillings@1324 3090 }
nickjillings@1324 3091 }
nickjillings@1324 3092 var ae_metric = this.parent.document.createElement('metric');
nickjillings@1324 3093 aeNode.appendChild(ae_metric);
nickjillings@1324 3094 this.XMLDOM.appendChild(aeNode);
nickjillings@1324 3095 }
nickjillings@1324 3096
nickjillings@1324 3097 // Add any commentQuestions
nickjillings@1324 3098 for (var element of this.specification.commentQuestions)
nickjillings@1324 3099 {
nickjillings@1324 3100 var cqNode = this.parent.document.createElement('commentquestion');
nickjillings@1324 3101 cqNode.id = element.id;
nickjillings@1324 3102 cqNode.setAttribute('type',element.type);
nickjillings@1324 3103 var statement = this.parent.document.createElement('statement');
nickjillings@1324 3104 statement.textContent = cqNode.statement;
nickjillings@1324 3105 cqNode.appendChild(statement);
nickjillings@1324 3106 var response = this.parent.document.createElement('response');
nickjillings@1324 3107 cqNode.appendChild(response);
nickjillings@1324 3108 this.XMLDOM.appendChild(cqNode);
nickjillings@1324 3109 }
nickjillings@1324 3110
nickjillings@1324 3111 this.parent.root.appendChild(this.XMLDOM);
nickjillings@1324 3112 };
nickjillings@1324 3113 this.finish = function()
nickjillings@1324 3114 {
nickjillings@1324 3115 if (this.state == 0)
nickjillings@1324 3116 {
nickjillings@1324 3117 var projectDocument = specification.projectXML;
nickjillings@1324 3118 projectDocument.setAttribute('file-name',url);
nickjillings@1324 3119 this.root.appendChild(projectDocument);
nickjillings@1324 3120 this.root.appendChild(returnDateNode());
nickjillings@1324 3121 this.root.appendChild(interfaceContext.returnNavigator());
nickjillings@1324 3122 }
nickjillings@1324 3123 this.state = 1;
nickjillings@1324 3124 return this.root;
nickjillings@1324 3125 };
nickjillings@1324 3126 }