annotate core.js @ 1370:f329347e8918

New test creator tool. Still WIP, but much more dynamic. Based on XSD and external lists so far easier to modify.
author Nicholas Jillings <nickjillings@users.noreply.github.com>
date Wed, 10 Feb 2016 12:02:25 +0000
parents ebe6c10bd52d
children e49c4eeb4fb2
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@1370 120
nickjillings@1370 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@1316 953 this.progress = 0;
nickjillings@1316 954 this.status = 0;
nickjillings@1342 955 this.ready = function()
nickjillings@1342 956 {
nickjillings@1316 957 if (this.status >= 2)
nickjillings@1316 958 {
nickjillings@1316 959 this.status = 3;
nickjillings@1316 960 }
nickjillings@1342 961 for (var i=0; i<this.users.length; i++)
nickjillings@1342 962 {
nickjillings@1342 963 this.users[i].state = 1;
nickjillings@1342 964 if (this.users[i].interfaceDOM != null)
nickjillings@1342 965 {
nickjillings@1342 966 this.users[i].bufferLoaded(this);
nickjillings@1342 967 }
nickjillings@1342 968 }
nickjillings@1342 969 };
nickjillings@1318 970 this.getMedia = function(url) {
nickjillings@1318 971 this.url = url;
nickjillings@1318 972 this.xmlRequest.open('GET',this.url,true);
nickjillings@1318 973 this.xmlRequest.responseType = 'arraybuffer';
nickjillings@1318 974
nickjillings@1318 975 var bufferObj = this;
nickjillings@1318 976
nickjillings@1318 977 // Create callback to decode the data asynchronously
nickjillings@1318 978 this.xmlRequest.onloadend = function() {
nickjillings@1353 979 // Use inbuilt WAVE decoder first
nickjillings@1353 980 var waveObj = new WAVE();
nickjillings@1353 981 if (waveObj.open(bufferObj.xmlRequest.response) == 0)
nickjillings@1353 982 {
nickjillings@1353 983 bufferObj.buffer = audioContext.createBuffer(waveObj.num_channels,waveObj.num_samples,waveObj.sample_rate);
nickjillings@1353 984 for (var c=0; c<waveObj.num_channels; c++)
nickjillings@1353 985 {
nickjillings@1353 986 var buffer_ptr = bufferObj.buffer.getChannelData(c);
nickjillings@1353 987 for (var n=0; n<waveObj.num_samples; n++)
nickjillings@1353 988 {
nickjillings@1353 989 buffer_ptr[n] = waveObj.decoded_data[c][n];
nickjillings@1353 990 }
nickjillings@1353 991 }
nickjillings@1316 992
nickjillings@1353 993 delete waveObj;
nickjillings@1353 994 } else {
nickjillings@1353 995 audioContext.decodeAudioData(bufferObj.xmlRequest.response, function(decodedData) {
nickjillings@1353 996 bufferObj.buffer = decodedData;
nickjillings@1353 997 }, function(e){
nickjillings@1353 998 // Should only be called if there was an error, but sometimes gets called continuously
nickjillings@1353 999 // Check here if the error is genuine
nickjillings@1353 1000 if (bufferObj.xmlRequest.response == undefined) {
nickjillings@1353 1001 // Genuine error
nickjillings@1353 1002 console.log('FATAL - Error loading buffer on '+audioObj.id);
nickjillings@1353 1003 if (request.status == 404)
nickjillings@1353 1004 {
nickjillings@1353 1005 console.log('FATAL - Fragment '+audioObj.id+' 404 error');
nickjillings@1353 1006 console.log('URL: '+audioObj.url);
nickjillings@1353 1007 errorSessionDump('Fragment '+audioObj.id+' 404 error');
nickjillings@1353 1008 }
nickjillings@1316 1009 this.status = -1;
nickjillings@1353 1010 }
nickjillings@1353 1011 });
nickjillings@1353 1012 }
nickjillings@1353 1013 if (bufferObj.buffer != undefined)
nickjillings@1353 1014 {
nickjillings@1316 1015 bufferObj.status = 2;
nickjillings@1353 1016 calculateLoudness(bufferObj,"I");
nickjillings@1353 1017 }
nickjillings@1318 1018 };
nickjillings@1318 1019 this.progress = 0;
nickjillings@1318 1020 this.progressCallback = function(event){
nickjillings@1318 1021 if (event.lengthComputable)
nickjillings@1318 1022 {
nickjillings@1318 1023 this.parent.progress = event.loaded / event.total;
nickjillings@1318 1024 for (var i=0; i<this.parent.users.length; i++)
nickjillings@1318 1025 {
nickjillings@1318 1026 if(this.parent.users[i].interfaceDOM != null)
nickjillings@1318 1027 {
nickjillings@1318 1028 if (typeof this.parent.users[i].interfaceDOM.updateLoading === "function")
nickjillings@1318 1029 {
nickjillings@1318 1030 this.parent.users[i].interfaceDOM.updateLoading(this.parent.progress*100);
nickjillings@1318 1031 }
nickjillings@1318 1032 }
nickjillings@1318 1033 }
nickjillings@1318 1034 }
nickjillings@1318 1035 };
nickjillings@1318 1036 this.xmlRequest.addEventListener("progress", this.progressCallback);
nickjillings@1316 1037 this.status = 1;
nickjillings@1318 1038 this.xmlRequest.send();
nickjillings@1318 1039 };
nickjillings@1316 1040
nickjillings@1316 1041 this.registerAudioObject = function(audioObject)
nickjillings@1316 1042 {
nickjillings@1316 1043 // Called by an audioObject to register to the buffer for use
nickjillings@1316 1044 // First check if already in the register pool
nickjillings@1316 1045 for (var objects of this.users)
nickjillings@1316 1046 {
nickjillings@1316 1047 if (audioObject.id == objects.id){return 0;}
nickjillings@1316 1048 }
nickjillings@1316 1049 this.users.push(audioObject);
nickjillings@1316 1050 if (this.status == 3)
nickjillings@1316 1051 {
nickjillings@1316 1052 // The buffer is already ready, trigger bufferLoaded
nickjillings@1316 1053 audioObject.bufferLoaded(this);
nickjillings@1316 1054 }
nickjillings@1316 1055 }
nickjillings@1318 1056 };
nickjillings@1318 1057
nickjillings@1318 1058 this.play = function(id) {
nickjillings@1318 1059 // Start the timer and set the audioEngine state to playing (1)
nickjillings@1318 1060 if (this.status == 0 && this.loopPlayback) {
nickjillings@1318 1061 // Check if all audioObjects are ready
nickjillings@1318 1062 if(this.checkAllReady())
nickjillings@1318 1063 {
nickjillings@1318 1064 this.status = 1;
nickjillings@1318 1065 this.setSynchronousLoop();
nickjillings@1318 1066 }
nickjillings@1318 1067 }
nickjillings@1318 1068 else
nickjillings@1318 1069 {
nickjillings@1318 1070 this.status = 1;
nickjillings@1318 1071 }
nickjillings@1318 1072 if (this.status== 1) {
nickjillings@1318 1073 this.timer.startTest();
nickjillings@1318 1074 if (id == undefined) {
nickjillings@1318 1075 id = -1;
nickjillings@1318 1076 console.log('FATAL - Passed id was undefined - AudioEngineContext.play(id)');
nickjillings@1318 1077 return;
nickjillings@1318 1078 } else {
nickjillings@1318 1079 interfaceContext.playhead.setTimePerPixel(this.audioObjects[id]);
nickjillings@1318 1080 }
nickjillings@1318 1081 if (this.loopPlayback) {
nickjillings@1360 1082 var setTime = audioContext.currentTime+2;
nickjillings@1318 1083 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1084 {
nickjillings@1360 1085 this.audioObjects[i].play(setTime-2);
nickjillings@1318 1086 if (id == i) {
nickjillings@1360 1087 this.audioObjects[i].loopStart(setTime);
nickjillings@1318 1088 } else {
nickjillings@1360 1089 this.audioObjects[i].loopStop(setTime);
nickjillings@1318 1090 }
nickjillings@1318 1091 }
nickjillings@1318 1092 } else {
nickjillings@1360 1093 var setTime = audioContext.currentTime+0.1;
nickjillings@1318 1094 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1095 {
nickjillings@1318 1096 if (i != id) {
nickjillings@1360 1097 this.audioObjects[i].stop(setTime);
nickjillings@1318 1098 } else if (i == id) {
nickjillings@1360 1099 this.audioObjects[id].play(setTime);
nickjillings@1318 1100 }
nickjillings@1318 1101 }
nickjillings@1318 1102 }
nickjillings@1318 1103 interfaceContext.playhead.start();
nickjillings@1318 1104 }
nickjillings@1318 1105 };
nickjillings@1318 1106
nickjillings@1318 1107 this.stop = function() {
nickjillings@1318 1108 // Send stop and reset command to all playback buffers and set audioEngine state to stopped (1)
nickjillings@1318 1109 if (this.status == 1) {
nickjillings@1360 1110 var setTime = audioContext.currentTime+0.1;
nickjillings@1318 1111 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1112 {
nickjillings@1360 1113 this.audioObjects[i].stop(setTime);
nickjillings@1318 1114 }
nickjillings@1318 1115 interfaceContext.playhead.stop();
nickjillings@1318 1116 this.status = 0;
nickjillings@1318 1117 }
nickjillings@1318 1118 };
nickjillings@1318 1119
nickjillings@1318 1120 this.newTrack = function(element) {
nickjillings@1318 1121 // Pull data from given URL into new audio buffer
nickjillings@1318 1122 // URLs must either be from the same source OR be setup to 'Access-Control-Allow-Origin'
nickjillings@1318 1123
nickjillings@1318 1124 // Create the audioObject with ID of the new track length;
nickjillings@1318 1125 audioObjectId = this.audioObjects.length;
nickjillings@1318 1126 this.audioObjects[audioObjectId] = new audioObject(audioObjectId);
nickjillings@1318 1127
nickjillings@1318 1128 // Check if audioObject buffer is currently stored by full URL
nickjillings@1324 1129 var URL = testState.currentStateMap.hostURL + element.url;
nickjillings@1318 1130 var buffer = null;
nickjillings@1318 1131 for (var i=0; i<this.buffers.length; i++)
nickjillings@1318 1132 {
nickjillings@1318 1133 if (URL == this.buffers[i].url)
nickjillings@1318 1134 {
nickjillings@1318 1135 buffer = this.buffers[i];
nickjillings@1318 1136 break;
nickjillings@1318 1137 }
nickjillings@1318 1138 }
nickjillings@1318 1139 if (buffer == null)
nickjillings@1318 1140 {
nickjillings@1318 1141 console.log("[WARN]: Buffer was not loaded in pre-test! "+URL);
nickjillings@1318 1142 buffer = new this.bufferObj();
nickjillings@1316 1143 this.buffers.push(buffer);
nickjillings@1318 1144 buffer.getMedia(URL);
nickjillings@1318 1145 }
nickjillings@1318 1146 this.audioObjects[audioObjectId].specification = element;
nickjillings@1318 1147 this.audioObjects[audioObjectId].url = URL;
nickjillings@1324 1148 // Obtain store node
nickjillings@1324 1149 var aeNodes = this.pageStore.XMLDOM.getElementsByTagName('audioelement');
nickjillings@1324 1150 for (var i=0; i<aeNodes.length; i++)
nickjillings@1324 1151 {
nickjillings@1324 1152 if(aeNodes[i].id == element.id)
nickjillings@1324 1153 {
nickjillings@1324 1154 this.audioObjects[audioObjectId].storeDOM = aeNodes[i];
nickjillings@1324 1155 break;
nickjillings@1324 1156 }
nickjillings@1324 1157 }
nickjillings@1316 1158 buffer.registerAudioObject(this.audioObjects[audioObjectId]);
nickjillings@1318 1159 return this.audioObjects[audioObjectId];
nickjillings@1318 1160 };
nickjillings@1318 1161
nickjillings@1369 1162 this.newTestPage = function(audioHolderObject,store) {
nickjillings@1324 1163 this.pageStore = store;
nickjillings@1318 1164 this.state = 0;
nickjillings@1318 1165 this.audioObjectsReady = false;
nickjillings@1318 1166 this.metric.reset();
nickjillings@1318 1167 for (var i=0; i < this.buffers.length; i++)
nickjillings@1318 1168 {
nickjillings@1318 1169 this.buffers[i].users = [];
nickjillings@1318 1170 }
nickjillings@1318 1171 this.audioObjects = [];
nickjillings@1369 1172 this.timer = new timer();
nickjillings@1369 1173 this.loopPlayback = audioHolderObject.loop;
nickjillings@1318 1174 };
nickjillings@1318 1175
nickjillings@1318 1176 this.checkAllPlayed = function() {
nickjillings@1318 1177 arr = [];
nickjillings@1318 1178 for (var id=0; id<this.audioObjects.length; id++) {
nickjillings@1318 1179 if (this.audioObjects[id].metric.wasListenedTo == false) {
nickjillings@1318 1180 arr.push(this.audioObjects[id].id);
nickjillings@1318 1181 }
nickjillings@1318 1182 }
nickjillings@1318 1183 return arr;
nickjillings@1318 1184 };
nickjillings@1318 1185
nickjillings@1318 1186 this.checkAllReady = function() {
nickjillings@1318 1187 var ready = true;
nickjillings@1318 1188 for (var i=0; i<this.audioObjects.length; i++) {
nickjillings@1318 1189 if (this.audioObjects[i].state == 0) {
nickjillings@1318 1190 // Track not ready
nickjillings@1318 1191 console.log('WAIT -- audioObject '+i+' not ready yet!');
nickjillings@1318 1192 ready = false;
nickjillings@1318 1193 };
nickjillings@1318 1194 }
nickjillings@1318 1195 return ready;
nickjillings@1318 1196 };
nickjillings@1318 1197
nickjillings@1318 1198 this.setSynchronousLoop = function() {
nickjillings@1318 1199 // Pads the signals so they are all exactly the same length
nickjillings@1318 1200 var length = 0;
nickjillings@1318 1201 var maxId;
nickjillings@1318 1202 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1203 {
nickjillings@1318 1204 if (length < this.audioObjects[i].buffer.buffer.length)
nickjillings@1318 1205 {
nickjillings@1318 1206 length = this.audioObjects[i].buffer.buffer.length;
nickjillings@1318 1207 maxId = i;
nickjillings@1318 1208 }
nickjillings@1318 1209 }
nickjillings@1318 1210 // Extract the audio and zero-pad
nickjillings@1318 1211 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1212 {
nickjillings@1318 1213 var orig = this.audioObjects[i].buffer.buffer;
nickjillings@1318 1214 var hold = audioContext.createBuffer(orig.numberOfChannels,length,orig.sampleRate);
nickjillings@1318 1215 for (var c=0; c<orig.numberOfChannels; c++)
nickjillings@1318 1216 {
nickjillings@1318 1217 var inData = hold.getChannelData(c);
nickjillings@1318 1218 var outData = orig.getChannelData(c);
nickjillings@1318 1219 for (var n=0; n<orig.length; n++)
nickjillings@1318 1220 {inData[n] = outData[n];}
nickjillings@1318 1221 }
nickjillings@1320 1222 hold.playbackGain = orig.playbackGain;
nickjillings@1318 1223 hold.lufs = orig.lufs;
nickjillings@1318 1224 this.audioObjects[i].buffer.buffer = hold;
nickjillings@1318 1225 }
nickjillings@1318 1226 };
nickjillings@1370 1227
nickjillings@1370 1228 this.exportXML = function()
nickjillings@1370 1229 {
nickjillings@1370 1230
nickjillings@1370 1231 };
nickjillings@1318 1232
nickjillings@1318 1233 }
nickjillings@1318 1234
nickjillings@1318 1235 function audioObject(id) {
nickjillings@1318 1236 // The main buffer object with common control nodes to the AudioEngine
nickjillings@1318 1237
nickjillings@1318 1238 this.specification;
nickjillings@1318 1239 this.id = id;
nickjillings@1318 1240 this.state = 0; // 0 - no data, 1 - ready
nickjillings@1318 1241 this.url = null; // Hold the URL given for the output back to the results.
nickjillings@1318 1242 this.metric = new metricTracker(this);
nickjillings@1324 1243 this.storeDOM = null;
nickjillings@1318 1244
nickjillings@1318 1245 // Bindings for GUI
nickjillings@1318 1246 this.interfaceDOM = null;
nickjillings@1318 1247 this.commentDOM = null;
nickjillings@1318 1248
nickjillings@1318 1249 // Create a buffer and external gain control to allow internal patching of effects and volume leveling.
nickjillings@1318 1250 this.bufferNode = undefined;
nickjillings@1318 1251 this.outputGain = audioContext.createGain();
nickjillings@1318 1252
nickjillings@1324 1253 this.onplayGain = 1.0;
nickjillings@1318 1254
nickjillings@1318 1255 // Connect buffer to the audio graph
nickjillings@1318 1256 this.outputGain.connect(audioEngineContext.outputGain);
nickjillings@1318 1257
nickjillings@1318 1258 // the audiobuffer is not designed for multi-start playback
nickjillings@1318 1259 // When stopeed, the buffer node is deleted and recreated with the stored buffer.
nickjillings@1318 1260 this.buffer;
nickjillings@1318 1261
nickjillings@1318 1262 this.bufferLoaded = function(callee)
nickjillings@1318 1263 {
nickjillings@1318 1264 // Called by the associated buffer when it has finished loading, will then 'bind' the buffer to the
nickjillings@1318 1265 // audioObject and trigger the interfaceDOM.enable() function for user feedback
nickjillings@1318 1266 if (audioEngineContext.loopPlayback){
nickjillings@1318 1267 // First copy the buffer into this.buffer
nickjillings@1318 1268 this.buffer = new audioEngineContext.bufferObj();
nickjillings@1318 1269 this.buffer.url = callee.url;
nickjillings@1318 1270 this.buffer.buffer = audioContext.createBuffer(callee.buffer.numberOfChannels, callee.buffer.length, callee.buffer.sampleRate);
nickjillings@1318 1271 for (var c=0; c<callee.buffer.numberOfChannels; c++)
nickjillings@1318 1272 {
nickjillings@1318 1273 var src = callee.buffer.getChannelData(c);
nickjillings@1318 1274 var dst = this.buffer.buffer.getChannelData(c);
nickjillings@1318 1275 for (var n=0; n<src.length; n++)
nickjillings@1318 1276 {
nickjillings@1318 1277 dst[n] = src[n];
nickjillings@1318 1278 }
nickjillings@1318 1279 }
nickjillings@1318 1280 } else {
nickjillings@1318 1281 this.buffer = callee;
nickjillings@1318 1282 }
nickjillings@1318 1283 this.state = 1;
nickjillings@1320 1284 this.buffer.buffer.playbackGain = callee.buffer.playbackGain;
nickjillings@1318 1285 this.buffer.buffer.lufs = callee.buffer.lufs;
nickjillings@1348 1286 var targetLUFS = this.specification.parent.loudness || specification.loudness;
nickjillings@1318 1287 if (typeof targetLUFS === "number")
nickjillings@1318 1288 {
nickjillings@1320 1289 this.buffer.buffer.playbackGain = decibelToLinear(targetLUFS - this.buffer.buffer.lufs);
nickjillings@1318 1290 } else {
nickjillings@1320 1291 this.buffer.buffer.playbackGain = 1.0;
nickjillings@1318 1292 }
nickjillings@1318 1293 if (this.interfaceDOM != null) {
nickjillings@1318 1294 this.interfaceDOM.enable();
nickjillings@1318 1295 }
nickjillings@1324 1296 this.onplayGain = decibelToLinear(this.specification.gain)*this.buffer.buffer.playbackGain;
nickjillings@1324 1297 this.storeDOM.setAttribute('playGain',linearToDecibel(this.onplayGain));
nickjillings@1318 1298 };
nickjillings@1325 1299
nickjillings@1325 1300 this.bindInterface = function(interfaceObject)
nickjillings@1325 1301 {
nickjillings@1325 1302 this.interfaceDOM = interfaceObject;
nickjillings@1325 1303 this.metric.initialise(interfaceObject.getValue());
nickjillings@1325 1304 if (this.state == 1)
nickjillings@1325 1305 {
nickjillings@1325 1306 this.interfaceDOM.enable();
nickjillings@1325 1307 }
nickjillings@1338 1308 this.storeDOM.setAttribute('presentedId',interfaceObject.getPresentedId());
nickjillings@1325 1309 };
nickjillings@1318 1310
nickjillings@1360 1311 this.loopStart = function(setTime) {
nickjillings@1360 1312 this.outputGain.gain.linearRampToValueAtTime(this.onplayGain,setTime);
nickjillings@1318 1313 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1360 1314 this.interfaceDOM.startPlayback();
nickjillings@1318 1315 };
nickjillings@1318 1316
nickjillings@1360 1317 this.loopStop = function(setTime) {
nickjillings@1318 1318 if (this.outputGain.gain.value != 0.0) {
nickjillings@1360 1319 this.outputGain.gain.linearRampToValueAtTime(0.0,setTime);
nickjillings@1318 1320 this.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@1318 1321 }
nickjillings@1360 1322 this.interfaceDOM.stopPlayback();
nickjillings@1318 1323 };
nickjillings@1318 1324
nickjillings@1318 1325 this.play = function(startTime) {
nickjillings@1318 1326 if (this.bufferNode == undefined && this.buffer.buffer != undefined) {
nickjillings@1318 1327 this.bufferNode = audioContext.createBufferSource();
nickjillings@1318 1328 this.bufferNode.owner = this;
nickjillings@1318 1329 this.bufferNode.connect(this.outputGain);
nickjillings@1318 1330 this.bufferNode.buffer = this.buffer.buffer;
nickjillings@1318 1331 this.bufferNode.loop = audioEngineContext.loopPlayback;
nickjillings@1318 1332 this.bufferNode.onended = function(event) {
nickjillings@1318 1333 // Safari does not like using 'this' to reference the calling object!
nickjillings@1318 1334 //event.currentTarget.owner.metric.stopListening(audioEngineContext.timer.getTestTime(),event.currentTarget.owner.getCurrentPosition());
nickjillings@1360 1335 event.currentTarget.owner.stop(audioContext.currentTime+1);
nickjillings@1318 1336 };
nickjillings@1318 1337 if (this.bufferNode.loop == false) {
nickjillings@1318 1338 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1360 1339 this.outputGain.gain.setValueAtTime(this.onplayGain,startTime);
nickjillings@1360 1340 this.interfaceDOM.startPlayback();
nickjillings@1360 1341 } else {
nickjillings@1360 1342 this.outputGain.gain.setValueAtTime(0.0,startTime);
nickjillings@1360 1343 }
nickjillings@1318 1344 this.bufferNode.start(startTime);
nickjillings@1318 1345 }
nickjillings@1318 1346 };
nickjillings@1318 1347
nickjillings@1360 1348 this.stop = function(stopTime) {
nickjillings@1360 1349 this.outputGain.gain.cancelScheduledValues(audioContext.currentTime);
nickjillings@1318 1350 if (this.bufferNode != undefined)
nickjillings@1318 1351 {
nickjillings@1318 1352 this.metric.stopListening(audioEngineContext.timer.getTestTime(),this.getCurrentPosition());
nickjillings@1360 1353 this.bufferNode.stop(stopTime);
nickjillings@1318 1354 this.bufferNode = undefined;
nickjillings@1318 1355 }
nickjillings@1360 1356 this.outputGain.gain.value = 0.0;
nickjillings@1360 1357 this.interfaceDOM.stopPlayback();
nickjillings@1318 1358 };
nickjillings@1318 1359
nickjillings@1318 1360 this.getCurrentPosition = function() {
nickjillings@1318 1361 var time = audioEngineContext.timer.getTestTime();
nickjillings@1318 1362 if (this.bufferNode != undefined) {
nickjillings@1318 1363 if (this.bufferNode.loop == true) {
nickjillings@1318 1364 if (audioEngineContext.status == 1) {
nickjillings@1318 1365 return (time-this.metric.listenStart)%this.buffer.buffer.duration;
nickjillings@1318 1366 } else {
nickjillings@1318 1367 return 0;
nickjillings@1318 1368 }
nickjillings@1318 1369 } else {
nickjillings@1318 1370 if (this.metric.listenHold) {
nickjillings@1318 1371 return time - this.metric.listenStart;
nickjillings@1318 1372 } else {
nickjillings@1318 1373 return 0;
nickjillings@1318 1374 }
nickjillings@1318 1375 }
nickjillings@1318 1376 } else {
nickjillings@1318 1377 return 0;
nickjillings@1318 1378 }
nickjillings@1318 1379 };
nickjillings@1318 1380
nickjillings@1318 1381 this.exportXMLDOM = function() {
nickjillings@1324 1382 var file = storage.document.createElement('file');
nickjillings@1318 1383 file.setAttribute('sampleRate',this.buffer.buffer.sampleRate);
nickjillings@1318 1384 file.setAttribute('channels',this.buffer.buffer.numberOfChannels);
nickjillings@1318 1385 file.setAttribute('sampleCount',this.buffer.buffer.length);
nickjillings@1318 1386 file.setAttribute('duration',this.buffer.buffer.duration);
nickjillings@1324 1387 this.storeDOM.appendChild(file);
nickjillings@1324 1388 if (this.specification.type != 'outside-reference') {
nickjillings@1318 1389 var interfaceXML = this.interfaceDOM.exportXMLDOM(this);
nickjillings@1340 1390 if (interfaceXML != null)
nickjillings@1340 1391 {
nickjillings@1340 1392 if (interfaceXML.length == undefined) {
nickjillings@1340 1393 this.storeDOM.appendChild(interfaceXML);
nickjillings@1340 1394 } else {
nickjillings@1340 1395 for (var i=0; i<interfaceXML.length; i++)
nickjillings@1340 1396 {
nickjillings@1340 1397 this.storeDOM.appendChild(interfaceXML[i]);
nickjillings@1340 1398 }
nickjillings@1318 1399 }
nickjillings@1318 1400 }
nickjillings@1330 1401 if (this.commentDOM != null) {
nickjillings@1330 1402 this.storeDOM.appendChild(this.commentDOM.exportXMLDOM(this));
nickjillings@1330 1403 }
nickjillings@1318 1404 }
nickjillings@1324 1405 var nodes = this.metric.exportXMLDOM();
nickjillings@1324 1406 var mroot = this.storeDOM.getElementsByTagName('metric')[0];
nickjillings@1324 1407 for (var i=0; i<nodes.length; i++)
nickjillings@1324 1408 {
nickjillings@1324 1409 mroot.appendChild(nodes[i]);
nickjillings@1324 1410 }
nickjillings@1318 1411 };
nickjillings@1318 1412 }
nickjillings@1318 1413
nickjillings@1318 1414 function timer()
nickjillings@1318 1415 {
nickjillings@1318 1416 /* Timer object used in audioEngine to keep track of session timings
nickjillings@1318 1417 * Uses the timer of the web audio API, so sample resolution
nickjillings@1318 1418 */
nickjillings@1318 1419 this.testStarted = false;
nickjillings@1318 1420 this.testStartTime = 0;
nickjillings@1318 1421 this.testDuration = 0;
nickjillings@1318 1422 this.minimumTestTime = 0; // No minimum test time
nickjillings@1318 1423 this.startTest = function()
nickjillings@1318 1424 {
nickjillings@1318 1425 if (this.testStarted == false)
nickjillings@1318 1426 {
nickjillings@1318 1427 this.testStartTime = audioContext.currentTime;
nickjillings@1318 1428 this.testStarted = true;
nickjillings@1318 1429 this.updateTestTime();
nickjillings@1318 1430 audioEngineContext.metric.initialiseTest();
nickjillings@1318 1431 }
nickjillings@1318 1432 };
nickjillings@1318 1433 this.stopTest = function()
nickjillings@1318 1434 {
nickjillings@1318 1435 if (this.testStarted)
nickjillings@1318 1436 {
nickjillings@1318 1437 this.testDuration = this.getTestTime();
nickjillings@1318 1438 this.testStarted = false;
nickjillings@1318 1439 } else {
nickjillings@1318 1440 console.log('ERR: Test tried to end before beginning');
nickjillings@1318 1441 }
nickjillings@1318 1442 };
nickjillings@1318 1443 this.updateTestTime = function()
nickjillings@1318 1444 {
nickjillings@1318 1445 if (this.testStarted)
nickjillings@1318 1446 {
nickjillings@1318 1447 this.testDuration = audioContext.currentTime - this.testStartTime;
nickjillings@1318 1448 }
nickjillings@1318 1449 };
nickjillings@1318 1450 this.getTestTime = function()
nickjillings@1318 1451 {
nickjillings@1318 1452 this.updateTestTime();
nickjillings@1318 1453 return this.testDuration;
nickjillings@1318 1454 };
nickjillings@1318 1455 }
nickjillings@1318 1456
nickjillings@1318 1457 function sessionMetrics(engine,specification)
nickjillings@1318 1458 {
nickjillings@1318 1459 /* Used by audioEngine to link to audioObjects to minimise the timer call timers;
nickjillings@1318 1460 */
nickjillings@1318 1461 this.engine = engine;
nickjillings@1318 1462 this.lastClicked = -1;
nickjillings@1318 1463 this.data = -1;
nickjillings@1318 1464 this.reset = function() {
nickjillings@1318 1465 this.lastClicked = -1;
nickjillings@1318 1466 this.data = -1;
nickjillings@1318 1467 };
nickjillings@1318 1468
nickjillings@1318 1469 this.enableElementInitialPosition = false;
nickjillings@1318 1470 this.enableElementListenTracker = false;
nickjillings@1318 1471 this.enableElementTimer = false;
nickjillings@1318 1472 this.enableElementTracker = false;
nickjillings@1318 1473 this.enableFlagListenedTo = false;
nickjillings@1318 1474 this.enableFlagMoved = false;
nickjillings@1318 1475 this.enableTestTimer = false;
nickjillings@1318 1476 // Obtain the metrics enabled
nickjillings@1324 1477 for (var i=0; i<specification.metrics.enabled.length; i++)
nickjillings@1318 1478 {
nickjillings@1324 1479 var node = specification.metrics.enabled[i];
nickjillings@1324 1480 switch(node)
nickjillings@1318 1481 {
nickjillings@1318 1482 case 'testTimer':
nickjillings@1318 1483 this.enableTestTimer = true;
nickjillings@1318 1484 break;
nickjillings@1318 1485 case 'elementTimer':
nickjillings@1318 1486 this.enableElementTimer = true;
nickjillings@1318 1487 break;
nickjillings@1318 1488 case 'elementTracker':
nickjillings@1318 1489 this.enableElementTracker = true;
nickjillings@1318 1490 break;
nickjillings@1318 1491 case 'elementListenTracker':
nickjillings@1318 1492 this.enableElementListenTracker = true;
nickjillings@1318 1493 break;
nickjillings@1318 1494 case 'elementInitialPosition':
nickjillings@1318 1495 this.enableElementInitialPosition = true;
nickjillings@1318 1496 break;
nickjillings@1318 1497 case 'elementFlagListenedTo':
nickjillings@1318 1498 this.enableFlagListenedTo = true;
nickjillings@1318 1499 break;
nickjillings@1318 1500 case 'elementFlagMoved':
nickjillings@1318 1501 this.enableFlagMoved = true;
nickjillings@1318 1502 break;
nickjillings@1318 1503 case 'elementFlagComments':
nickjillings@1318 1504 this.enableFlagComments = true;
nickjillings@1318 1505 break;
nickjillings@1318 1506 }
nickjillings@1318 1507 }
nickjillings@1318 1508 this.initialiseTest = function(){};
nickjillings@1318 1509 }
nickjillings@1318 1510
nickjillings@1318 1511 function metricTracker(caller)
nickjillings@1318 1512 {
nickjillings@1318 1513 /* Custom object to track and collect metric data
nickjillings@1318 1514 * Used only inside the audioObjects object.
nickjillings@1318 1515 */
nickjillings@1318 1516
nickjillings@1318 1517 this.listenedTimer = 0;
nickjillings@1318 1518 this.listenStart = 0;
nickjillings@1318 1519 this.listenHold = false;
nickjillings@1318 1520 this.initialPosition = -1;
nickjillings@1318 1521 this.movementTracker = [];
nickjillings@1318 1522 this.listenTracker =[];
nickjillings@1318 1523 this.wasListenedTo = false;
nickjillings@1318 1524 this.wasMoved = false;
nickjillings@1318 1525 this.hasComments = false;
nickjillings@1318 1526 this.parent = caller;
nickjillings@1318 1527
nickjillings@1324 1528 this.initialise = function(position)
nickjillings@1318 1529 {
nickjillings@1318 1530 if (this.initialPosition == -1) {
nickjillings@1318 1531 this.initialPosition = position;
nickjillings@1325 1532 this.moved(0,position);
nickjillings@1318 1533 }
nickjillings@1318 1534 };
nickjillings@1318 1535
nickjillings@1318 1536 this.moved = function(time,position)
nickjillings@1318 1537 {
nickjillings@1325 1538 if (time > 0) {this.wasMoved = true;}
nickjillings@1318 1539 this.movementTracker[this.movementTracker.length] = [time, position];
nickjillings@1318 1540 };
nickjillings@1318 1541
nickjillings@1318 1542 this.startListening = function(time)
nickjillings@1318 1543 {
nickjillings@1318 1544 if (this.listenHold == false)
nickjillings@1318 1545 {
nickjillings@1318 1546 this.wasListenedTo = true;
nickjillings@1318 1547 this.listenStart = time;
nickjillings@1318 1548 this.listenHold = true;
nickjillings@1318 1549
nickjillings@1318 1550 var evnt = document.createElement('event');
nickjillings@1318 1551 var testTime = document.createElement('testTime');
nickjillings@1318 1552 testTime.setAttribute('start',time);
nickjillings@1318 1553 var bufferTime = document.createElement('bufferTime');
nickjillings@1318 1554 bufferTime.setAttribute('start',this.parent.getCurrentPosition());
nickjillings@1318 1555 evnt.appendChild(testTime);
nickjillings@1318 1556 evnt.appendChild(bufferTime);
nickjillings@1318 1557 this.listenTracker.push(evnt);
nickjillings@1318 1558
nickjillings@1318 1559 console.log('slider ' + this.parent.id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1318 1560 }
nickjillings@1318 1561 };
nickjillings@1318 1562
nickjillings@1318 1563 this.stopListening = function(time,bufferStopTime)
nickjillings@1318 1564 {
nickjillings@1318 1565 if (this.listenHold == true)
nickjillings@1318 1566 {
nickjillings@1318 1567 var diff = time - this.listenStart;
nickjillings@1318 1568 this.listenedTimer += (diff);
nickjillings@1318 1569 this.listenStart = 0;
nickjillings@1318 1570 this.listenHold = false;
nickjillings@1318 1571
nickjillings@1318 1572 var evnt = this.listenTracker[this.listenTracker.length-1];
nickjillings@1318 1573 var testTime = evnt.getElementsByTagName('testTime')[0];
nickjillings@1318 1574 var bufferTime = evnt.getElementsByTagName('bufferTime')[0];
nickjillings@1318 1575 testTime.setAttribute('stop',time);
nickjillings@1318 1576 if (bufferStopTime == undefined) {
nickjillings@1318 1577 bufferTime.setAttribute('stop',this.parent.getCurrentPosition());
nickjillings@1318 1578 } else {
nickjillings@1318 1579 bufferTime.setAttribute('stop',bufferStopTime);
nickjillings@1318 1580 }
nickjillings@1318 1581 console.log('slider ' + this.parent.id + ' played for (' + diff + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1318 1582 }
nickjillings@1318 1583 };
nickjillings@1318 1584
nickjillings@1318 1585 this.exportXMLDOM = function() {
nickjillings@1324 1586 var storeDOM = [];
nickjillings@1318 1587 if (audioEngineContext.metric.enableElementTimer) {
nickjillings@1324 1588 var mElementTimer = storage.document.createElement('metricresult');
nickjillings@1318 1589 mElementTimer.setAttribute('name','enableElementTimer');
nickjillings@1318 1590 mElementTimer.textContent = this.listenedTimer;
nickjillings@1324 1591 storeDOM.push(mElementTimer);
nickjillings@1318 1592 }
nickjillings@1318 1593 if (audioEngineContext.metric.enableElementTracker) {
nickjillings@1324 1594 var elementTrackerFull = storage.document.createElement('metricResult');
nickjillings@1318 1595 elementTrackerFull.setAttribute('name','elementTrackerFull');
nickjillings@1318 1596 for (var k=0; k<this.movementTracker.length; k++)
nickjillings@1318 1597 {
nickjillings@1324 1598 var timePos = storage.document.createElement('timePos');
nickjillings@1318 1599 timePos.id = k;
nickjillings@1324 1600 var time = storage.document.createElement('time');
nickjillings@1318 1601 time.textContent = this.movementTracker[k][0];
nickjillings@1318 1602 var position = document.createElement('position');
nickjillings@1318 1603 position.textContent = this.movementTracker[k][1];
nickjillings@1318 1604 timePos.appendChild(time);
nickjillings@1318 1605 timePos.appendChild(position);
nickjillings@1318 1606 elementTrackerFull.appendChild(timePos);
nickjillings@1318 1607 }
nickjillings@1324 1608 storeDOM.push(elementTrackerFull);
nickjillings@1318 1609 }
nickjillings@1318 1610 if (audioEngineContext.metric.enableElementListenTracker) {
nickjillings@1324 1611 var elementListenTracker = storage.document.createElement('metricResult');
nickjillings@1318 1612 elementListenTracker.setAttribute('name','elementListenTracker');
nickjillings@1318 1613 for (var k=0; k<this.listenTracker.length; k++) {
nickjillings@1318 1614 elementListenTracker.appendChild(this.listenTracker[k]);
nickjillings@1318 1615 }
nickjillings@1324 1616 storeDOM.push(elementListenTracker);
nickjillings@1318 1617 }
nickjillings@1318 1618 if (audioEngineContext.metric.enableElementInitialPosition) {
nickjillings@1324 1619 var elementInitial = storage.document.createElement('metricResult');
nickjillings@1318 1620 elementInitial.setAttribute('name','elementInitialPosition');
nickjillings@1318 1621 elementInitial.textContent = this.initialPosition;
nickjillings@1324 1622 storeDOM.push(elementInitial);
nickjillings@1318 1623 }
nickjillings@1318 1624 if (audioEngineContext.metric.enableFlagListenedTo) {
nickjillings@1324 1625 var flagListenedTo = storage.document.createElement('metricResult');
nickjillings@1318 1626 flagListenedTo.setAttribute('name','elementFlagListenedTo');
nickjillings@1318 1627 flagListenedTo.textContent = this.wasListenedTo;
nickjillings@1324 1628 storeDOM.push(flagListenedTo);
nickjillings@1318 1629 }
nickjillings@1318 1630 if (audioEngineContext.metric.enableFlagMoved) {
nickjillings@1324 1631 var flagMoved = storage.document.createElement('metricResult');
nickjillings@1318 1632 flagMoved.setAttribute('name','elementFlagMoved');
nickjillings@1318 1633 flagMoved.textContent = this.wasMoved;
nickjillings@1324 1634 storeDOM.push(flagMoved);
nickjillings@1318 1635 }
nickjillings@1318 1636 if (audioEngineContext.metric.enableFlagComments) {
nickjillings@1324 1637 var flagComments = storage.document.createElement('metricResult');
nickjillings@1318 1638 flagComments.setAttribute('name','elementFlagComments');
nickjillings@1318 1639 if (this.parent.commentDOM == null)
nickjillings@1318 1640 {flag.textContent = 'false';}
nickjillings@1318 1641 else if (this.parent.commentDOM.textContent.length == 0)
nickjillings@1318 1642 {flag.textContent = 'false';}
nickjillings@1318 1643 else
nickjillings@1318 1644 {flag.textContet = 'true';}
nickjillings@1324 1645 storeDOM.push(flagComments);
nickjillings@1318 1646 }
nickjillings@1324 1647 return storeDOM;
nickjillings@1318 1648 };
nickjillings@1318 1649 }
nickjillings@1318 1650
nickjillings@1318 1651 function randomiseOrder(input)
nickjillings@1318 1652 {
nickjillings@1318 1653 // This takes an array of information and randomises the order
nickjillings@1318 1654 var N = input.length;
nickjillings@1318 1655
nickjillings@1318 1656 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1318 1657 for (var counter = 0; counter < N; ++counter)
nickjillings@1318 1658 inputSequence.push(counter) // Fill array
nickjillings@1318 1659 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1318 1660
nickjillings@1318 1661 var holdArr = [];
nickjillings@1318 1662 var outputSequence = [];
nickjillings@1318 1663 for (var n=0; n<N; n++)
nickjillings@1318 1664 {
nickjillings@1318 1665 // First pick a random number
nickjillings@1318 1666 var r = Math.random();
nickjillings@1318 1667 // Multiply and floor by the number of elements left
nickjillings@1318 1668 r = Math.floor(r*input.length);
nickjillings@1318 1669 // Pick out that element and delete from the array
nickjillings@1318 1670 holdArr.push(input.splice(r,1)[0]);
nickjillings@1318 1671 // Do the same with sequence
nickjillings@1318 1672 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1318 1673 }
nickjillings@1318 1674 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1318 1675 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1318 1676 return holdArr;
nickjillings@1318 1677 }
nickjillings@1318 1678
nickjillings@1318 1679 function returnDateNode()
nickjillings@1318 1680 {
nickjillings@1318 1681 // Create an XML Node for the Date and Time a test was conducted
nickjillings@1318 1682 // Structure is
nickjillings@1318 1683 // <datetime>
nickjillings@1318 1684 // <date year="##" month="##" day="##">DD/MM/YY</date>
nickjillings@1318 1685 // <time hour="##" minute="##" sec="##">HH:MM:SS</time>
nickjillings@1318 1686 // </datetime>
nickjillings@1318 1687 var dateTime = new Date();
nickjillings@1318 1688 var year = document.createAttribute('year');
nickjillings@1318 1689 var month = document.createAttribute('month');
nickjillings@1318 1690 var day = document.createAttribute('day');
nickjillings@1318 1691 var hour = document.createAttribute('hour');
nickjillings@1318 1692 var minute = document.createAttribute('minute');
nickjillings@1318 1693 var secs = document.createAttribute('secs');
nickjillings@1318 1694
nickjillings@1318 1695 year.nodeValue = dateTime.getFullYear();
nickjillings@1318 1696 month.nodeValue = dateTime.getMonth()+1;
nickjillings@1318 1697 day.nodeValue = dateTime.getDate();
nickjillings@1318 1698 hour.nodeValue = dateTime.getHours();
nickjillings@1318 1699 minute.nodeValue = dateTime.getMinutes();
nickjillings@1318 1700 secs.nodeValue = dateTime.getSeconds();
nickjillings@1318 1701
nickjillings@1318 1702 var hold = document.createElement("datetime");
nickjillings@1318 1703 var date = document.createElement("date");
nickjillings@1318 1704 date.textContent = year.nodeValue+'/'+month.nodeValue+'/'+day.nodeValue;
nickjillings@1318 1705 var time = document.createElement("time");
nickjillings@1318 1706 time.textContent = hour.nodeValue+':'+minute.nodeValue+':'+secs.nodeValue;
nickjillings@1318 1707
nickjillings@1318 1708 date.setAttributeNode(year);
nickjillings@1318 1709 date.setAttributeNode(month);
nickjillings@1318 1710 date.setAttributeNode(day);
nickjillings@1318 1711 time.setAttributeNode(hour);
nickjillings@1318 1712 time.setAttributeNode(minute);
nickjillings@1318 1713 time.setAttributeNode(secs);
nickjillings@1318 1714
nickjillings@1318 1715 hold.appendChild(date);
nickjillings@1318 1716 hold.appendChild(time);
nickjillings@1318 1717 return hold;
nickjillings@1318 1718
nickjillings@1318 1719 }
nickjillings@1318 1720
nickjillings@1318 1721 function Specification() {
nickjillings@1318 1722 // Handles the decoding of the project specification XML into a simple JavaScript Object.
nickjillings@1318 1723
nickjillings@1324 1724 this.interface = null;
nickjillings@1324 1725 this.projectReturn = null;
nickjillings@1324 1726 this.randomiseOrder = null;
nickjillings@1324 1727 this.testPages = null;
nickjillings@1324 1728 this.pages = [];
nickjillings@1324 1729 this.metrics = null;
nickjillings@1324 1730 this.interfaces = null;
nickjillings@1324 1731 this.loudness = null;
nickjillings@1324 1732 this.errors = [];
nickjillings@1324 1733 this.schema = null;
nickjillings@1318 1734
nickjillings@1318 1735 this.randomiseOrder = function(input)
nickjillings@1318 1736 {
nickjillings@1318 1737 // This takes an array of information and randomises the order
nickjillings@1318 1738 var N = input.length;
nickjillings@1318 1739
nickjillings@1318 1740 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1318 1741 for (var counter = 0; counter < N; ++counter)
nickjillings@1318 1742 inputSequence.push(counter) // Fill array
nickjillings@1318 1743 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1318 1744
nickjillings@1318 1745 var holdArr = [];
nickjillings@1318 1746 var outputSequence = [];
nickjillings@1318 1747 for (var n=0; n<N; n++)
nickjillings@1318 1748 {
nickjillings@1318 1749 // First pick a random number
nickjillings@1318 1750 var r = Math.random();
nickjillings@1318 1751 // Multiply and floor by the number of elements left
nickjillings@1318 1752 r = Math.floor(r*input.length);
nickjillings@1318 1753 // Pick out that element and delete from the array
nickjillings@1318 1754 holdArr.push(input.splice(r,1)[0]);
nickjillings@1318 1755 // Do the same with sequence
nickjillings@1318 1756 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1318 1757 }
nickjillings@1318 1758 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1318 1759 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1318 1760 return holdArr;
nickjillings@1318 1761 };
nickjillings@1324 1762
nickjillings@1324 1763 this.processAttribute = function(attribute,schema)
nickjillings@1324 1764 {
nickjillings@1324 1765 // attribute is the string returned from getAttribute on the XML
nickjillings@1324 1766 // schema is the <xs:attribute> node
nickjillings@1324 1767 if (schema.getAttribute('name') == undefined && schema.getAttribute('ref') != undefined)
nickjillings@1324 1768 {
nickjillings@1348 1769 schema = this.schema.getAllElementsByName(schema.getAttribute('ref'))[0];
nickjillings@1324 1770 }
nickjillings@1324 1771 var defaultOpt = schema.getAttribute('default');
nickjillings@1324 1772 if (attribute == null) {
nickjillings@1324 1773 attribute = defaultOpt;
nickjillings@1324 1774 }
nickjillings@1324 1775 var dataType = schema.getAttribute('type');
nickjillings@1324 1776 if (typeof dataType == "string") { dataType = dataType.substr(3);}
nickjillings@1324 1777 else {dataType = "string";}
nickjillings@1324 1778 if (attribute == null)
nickjillings@1324 1779 {
nickjillings@1324 1780 return attribute;
nickjillings@1324 1781 }
nickjillings@1324 1782 switch(dataType)
nickjillings@1324 1783 {
nickjillings@1324 1784 case "boolean":
nickjillings@1324 1785 if (attribute == 'true'){attribute = true;}else{attribute=false;}
nickjillings@1324 1786 break;
nickjillings@1324 1787 case "negativeInteger":
nickjillings@1324 1788 case "positiveInteger":
nickjillings@1324 1789 case "nonNegativeInteger":
nickjillings@1324 1790 case "nonPositiveInteger":
nickjillings@1324 1791 case "integer":
nickjillings@1324 1792 case "decimal":
nickjillings@1324 1793 case "short":
nickjillings@1324 1794 attribute = Number(attribute);
nickjillings@1324 1795 break;
nickjillings@1324 1796 case "string":
nickjillings@1324 1797 default:
nickjillings@1324 1798 attribute = String(attribute);
nickjillings@1324 1799 break;
nickjillings@1324 1800 }
nickjillings@1324 1801 return attribute;
nickjillings@1324 1802 };
nickjillings@1318 1803
nickjillings@1318 1804 this.decode = function(projectXML) {
nickjillings@1324 1805 this.errors = [];
nickjillings@1318 1806 // projectXML - DOM Parsed document
nickjillings@1318 1807 this.projectXML = projectXML.childNodes[0];
nickjillings@1318 1808 var setupNode = projectXML.getElementsByTagName('setup')[0];
nickjillings@1348 1809 var schemaSetup = this.schema.getAllElementsByName('setup')[0];
nickjillings@1324 1810 // First decode the attributes
nickjillings@1348 1811 var attributes = schemaSetup.getAllElementsByTagName('xs:attribute');
nickjillings@1324 1812 for (var i in attributes)
nickjillings@1318 1813 {
nickjillings@1324 1814 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1815 var attributeName = attributes[i].getAttribute('name');
nickjillings@1324 1816 var projectAttr = setupNode.getAttribute(attributeName);
nickjillings@1324 1817 projectAttr = this.processAttribute(projectAttr,attributes[i]);
nickjillings@1324 1818 switch(typeof projectAttr)
nickjillings@1318 1819 {
nickjillings@1324 1820 case "number":
nickjillings@1324 1821 case "boolean":
nickjillings@1324 1822 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 1823 break;
nickjillings@1324 1824 case "string":
nickjillings@1324 1825 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1826 break;
nickjillings@1318 1827 }
nickjillings@1324 1828
nickjillings@1318 1829 }
nickjillings@1318 1830
nickjillings@1370 1831 this.metrics = new this.metricNode();
nickjillings@1318 1832
nickjillings@1324 1833 this.metrics.decode(this,setupNode.getElementsByTagName('metric')[0]);
nickjillings@1324 1834
nickjillings@1324 1835 // Now process the survey node options
nickjillings@1324 1836 var survey = setupNode.getElementsByTagName('survey');
nickjillings@1324 1837 for (var i in survey) {
nickjillings@1324 1838 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1839 var location = survey[i].getAttribute('location');
nickjillings@1324 1840 if (location == 'pre' || location == 'before')
nickjillings@1324 1841 {
nickjillings@1324 1842 if (this.preTest != null){this.errors.push("Already a pre/before test survey defined! Ignoring second!!");}
nickjillings@1324 1843 else {
nickjillings@1324 1844 this.preTest = new this.surveyNode();
nickjillings@1370 1845 this.preTest.decode(this,survey[i]);
nickjillings@1324 1846 }
nickjillings@1324 1847 } else if (location == 'post' || location == 'after') {
nickjillings@1324 1848 if (this.postTest != null){this.errors.push("Already a post/after test survey defined! Ignoring second!!");}
nickjillings@1324 1849 else {
nickjillings@1324 1850 this.postTest = new this.surveyNode();
nickjillings@1370 1851 this.postTest.decode(this,survey[i]);
nickjillings@1324 1852 }
nickjillings@1318 1853 }
nickjillings@1318 1854 }
nickjillings@1318 1855
nickjillings@1324 1856 var interfaceNode = setupNode.getElementsByTagName('interface');
nickjillings@1324 1857 if (interfaceNode.length > 1)
nickjillings@1324 1858 {
nickjillings@1324 1859 this.errors.push("Only one <interface> node in the <setup> node allowed! Others except first ingnored!");
nickjillings@1324 1860 }
nickjillings@1324 1861 this.interfaces = new this.interfaceNode();
nickjillings@1324 1862 if (interfaceNode.length != 0)
nickjillings@1324 1863 {
nickjillings@1324 1864 interfaceNode = interfaceNode[0];
nickjillings@1348 1865 this.interfaces.decode(this,interfaceNode,this.schema.getAllElementsByName('interface')[1]);
nickjillings@1318 1866 }
nickjillings@1318 1867
nickjillings@1324 1868 // Page tags
nickjillings@1324 1869 var pageTags = projectXML.getElementsByTagName('page');
nickjillings@1348 1870 var pageSchema = this.schema.getAllElementsByName('page')[0];
nickjillings@1324 1871 for (var i=0; i<pageTags.length; i++)
nickjillings@1318 1872 {
nickjillings@1324 1873 var node = new this.page();
nickjillings@1324 1874 node.decode(this,pageTags[i],pageSchema);
nickjillings@1324 1875 this.pages.push(node);
nickjillings@1318 1876 }
nickjillings@1318 1877 };
nickjillings@1318 1878
nickjillings@1318 1879 this.encode = function()
nickjillings@1318 1880 {
nickjillings@1324 1881 var root = document.implementation.createDocument(null,"waet");
nickjillings@1318 1882
nickjillings@1324 1883 // Build setup node
nickjillings@1318 1884
nickjillings@1318 1885 return root;
nickjillings@1318 1886 };
nickjillings@1318 1887
nickjillings@1324 1888 this.surveyNode = function() {
nickjillings@1324 1889 this.location = null;
nickjillings@1318 1890 this.options = [];
nickjillings@1370 1891 this.schema = specification.schema.getAllElementsByName('survey')[0];
nickjillings@1318 1892
nickjillings@1318 1893 this.OptionNode = function() {
nickjillings@1318 1894 this.type = undefined;
nickjillings@1370 1895 this.schema = specification.schema.getAllElementsByName('surveyentry')[0];
nickjillings@1318 1896 this.id = undefined;
nickjillings@1318 1897 this.mandatory = undefined;
nickjillings@1318 1898 this.statement = undefined;
nickjillings@1318 1899 this.boxsize = undefined;
nickjillings@1318 1900 this.options = [];
nickjillings@1318 1901 this.min = undefined;
nickjillings@1318 1902 this.max = undefined;
nickjillings@1318 1903 this.step = undefined;
nickjillings@1318 1904
nickjillings@1370 1905 this.decode = function(parent,child)
nickjillings@1318 1906 {
nickjillings@1370 1907 var attributeMap = this.schema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 1908 for (var i in attributeMap){
nickjillings@1324 1909 if(isNaN(Number(i)) == true){break;}
nickjillings@1324 1910 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 1911 var projectAttr = child.getAttribute(attributeName);
nickjillings@1324 1912 projectAttr = parent.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 1913 switch(typeof projectAttr)
nickjillings@1324 1914 {
nickjillings@1324 1915 case "number":
nickjillings@1324 1916 case "boolean":
nickjillings@1324 1917 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 1918 break;
nickjillings@1324 1919 case "string":
nickjillings@1324 1920 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1921 break;
nickjillings@1318 1922 }
nickjillings@1324 1923 }
nickjillings@1324 1924 this.statement = child.getElementsByTagName('statement')[0].textContent;
nickjillings@1324 1925 if (this.type == "checkbox" || this.type == "radio") {
nickjillings@1324 1926 var children = child.getElementsByTagName('option');
nickjillings@1324 1927 if (children.length == null) {
nickjillings@1318 1928 console.log('Malformed' +child.nodeName+ 'entry');
nickjillings@1318 1929 this.statement = 'Malformed' +child.nodeName+ 'entry';
nickjillings@1318 1930 this.type = 'statement';
nickjillings@1318 1931 } else {
nickjillings@1318 1932 this.options = [];
nickjillings@1324 1933 for (var i in children)
nickjillings@1324 1934 {
nickjillings@1324 1935 if (isNaN(Number(i))==true){break;}
nickjillings@1324 1936 this.options.push({
nickjillings@1324 1937 name: children[i].getAttribute('name'),
nickjillings@1324 1938 text: children[i].textContent
nickjillings@1324 1939 });
nickjillings@1318 1940 }
nickjillings@1318 1941 }
nickjillings@1318 1942 }
nickjillings@1318 1943 };
nickjillings@1318 1944
nickjillings@1318 1945 this.exportXML = function(root)
nickjillings@1318 1946 {
nickjillings@1324 1947 var node = root.createElement('surveyelement');
nickjillings@1324 1948 node.setAttribute('type',this.type);
nickjillings@1324 1949 var statement = root.createElement('statement');
nickjillings@1324 1950 statement.textContent = this.statement;
nickjillings@1324 1951 node.appendChild(statement);
nickjillings@1318 1952 switch(this.type)
nickjillings@1318 1953 {
nickjillings@1318 1954 case "statement":
nickjillings@1318 1955 break;
nickjillings@1318 1956 case "question":
nickjillings@1318 1957 node.id = this.id;
nickjillings@1318 1958 node.setAttribute("mandatory",this.mandatory);
nickjillings@1318 1959 node.setAttribute("boxsize",this.boxsize);
nickjillings@1318 1960 break;
nickjillings@1318 1961 case "number":
nickjillings@1318 1962 node.id = this.id;
nickjillings@1318 1963 node.setAttribute("mandatory",this.mandatory);
nickjillings@1318 1964 node.setAttribute("min", this.min);
nickjillings@1318 1965 node.setAttribute("max", this.max);
nickjillings@1318 1966 node.setAttribute("step", this.step);
nickjillings@1318 1967 break;
nickjillings@1318 1968 case "checkbox":
nickjillings@1318 1969 case "radio":
nickjillings@1318 1970 node.id = this.id;
nickjillings@1318 1971 for (var i=0; i<this.options.length; i++)
nickjillings@1318 1972 {
nickjillings@1318 1973 var option = this.options[i];
nickjillings@1318 1974 var optionNode = root.createElement("option");
nickjillings@1318 1975 optionNode.setAttribute("name",option.name);
nickjillings@1318 1976 optionNode.textContent = option.text;
nickjillings@1318 1977 node.appendChild(optionNode);
nickjillings@1318 1978 }
nickjillings@1318 1979 break;
nickjillings@1318 1980 }
nickjillings@1318 1981 return node;
nickjillings@1318 1982 };
nickjillings@1318 1983 };
nickjillings@1370 1984 this.decode = function(parent,xml) {
nickjillings@1324 1985 this.location = xml.getAttribute('location');
nickjillings@1324 1986 if (this.location == 'before'){this.location = 'pre';}
nickjillings@1324 1987 else if (this.location == 'after'){this.location = 'post';}
nickjillings@1324 1988 for (var i in xml.children)
nickjillings@1324 1989 {
nickjillings@1324 1990 if(isNaN(Number(i))==true){break;}
nickjillings@1318 1991 var node = new this.OptionNode();
nickjillings@1370 1992 node.decode(parent,xml.children[i]);
nickjillings@1318 1993 this.options.push(node);
nickjillings@1324 1994 }
nickjillings@1324 1995 };
nickjillings@1324 1996 this.encode = function(root) {
nickjillings@1324 1997 var node = root.createElement('survey');
nickjillings@1324 1998 node.setAttribute('location',this.location);
nickjillings@1324 1999 for (var i=0; i<this.options.length; i++)
nickjillings@1324 2000 {
nickjillings@1324 2001 node.appendChild(this.options[i].exportXML());
nickjillings@1324 2002 }
nickjillings@1324 2003 return node;
nickjillings@1324 2004 };
nickjillings@1324 2005 };
nickjillings@1324 2006
nickjillings@1324 2007 this.interfaceNode = function()
nickjillings@1324 2008 {
nickjillings@1324 2009 this.title = null;
nickjillings@1324 2010 this.name = null;
nickjillings@1324 2011 this.options = [];
nickjillings@1324 2012 this.scales = [];
nickjillings@1370 2013 this.schema = specification.schema.getAllElementsByName('interface')[1];
nickjillings@1324 2014
nickjillings@1370 2015 this.decode = function(parent,xml) {
nickjillings@1324 2016 this.name = xml.getAttribute('name');
nickjillings@1324 2017 var titleNode = xml.getElementsByTagName('title');
nickjillings@1324 2018 if (titleNode.length == 1)
nickjillings@1324 2019 {
nickjillings@1324 2020 this.title = titleNode[0].textContent;
nickjillings@1324 2021 }
nickjillings@1324 2022 var interfaceOptionNodes = xml.getElementsByTagName('interfaceoption');
nickjillings@1324 2023 // Extract interfaceoption node schema
nickjillings@1370 2024 var interfaceOptionNodeSchema = this.schema.getAllElementsByName('interfaceoption')[0];
nickjillings@1348 2025 var attributeMap = interfaceOptionNodeSchema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 2026 for (var i=0; i<interfaceOptionNodes.length; i++)
nickjillings@1324 2027 {
nickjillings@1324 2028 var ioNode = interfaceOptionNodes[i];
nickjillings@1324 2029 var option = {};
nickjillings@1324 2030 for (var j=0; j<attributeMap.length; j++)
nickjillings@1324 2031 {
nickjillings@1324 2032 var attributeName = attributeMap[j].getAttribute('name') || attributeMap[j].getAttribute('ref');
nickjillings@1324 2033 var projectAttr = ioNode.getAttribute(attributeName);
nickjillings@1324 2034 projectAttr = parent.processAttribute(projectAttr,attributeMap[j]);
nickjillings@1324 2035 switch(typeof projectAttr)
nickjillings@1324 2036 {
nickjillings@1324 2037 case "number":
nickjillings@1324 2038 case "boolean":
nickjillings@1324 2039 eval('option.'+attributeName+' = '+projectAttr);
nickjillings@1324 2040 break;
nickjillings@1324 2041 case "string":
nickjillings@1324 2042 eval('option.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 2043 break;
nickjillings@1324 2044 }
nickjillings@1324 2045 }
nickjillings@1324 2046 this.options.push(option);
nickjillings@1324 2047 }
nickjillings@1324 2048
nickjillings@1324 2049 // Now the scales nodes
nickjillings@1324 2050 var scaleParent = xml.getElementsByTagName('scales');
nickjillings@1324 2051 if (scaleParent.length == 1) {
nickjillings@1324 2052 scaleParent = scaleParent[0];
nickjillings@1324 2053 for (var i=0; i<scaleParent.children.length; i++) {
nickjillings@1324 2054 var child = scaleParent.children[i];
nickjillings@1324 2055 this.scales.push({
nickjillings@1324 2056 text: child.textContent,
nickjillings@1324 2057 position: Number(child.getAttribute('position'))
nickjillings@1324 2058 });
nickjillings@1318 2059 }
nickjillings@1318 2060 }
nickjillings@1318 2061 };
nickjillings@1324 2062
nickjillings@1324 2063 this.encode = function(root) {
nickjillings@1324 2064
nickjillings@1324 2065 };
nickjillings@1318 2066 };
nickjillings@1318 2067
nickjillings@1370 2068 this.metricNode = function() {
nickjillings@1370 2069 this.enabled = [];
nickjillings@1370 2070 this.decode = function(parent, xml) {
nickjillings@1370 2071 var children = xml.getElementsByTagName('metricenable');
nickjillings@1370 2072 for (var i in children) {
nickjillings@1370 2073 if (isNaN(Number(i)) == true){break;}
nickjillings@1370 2074 this.enabled.push(children[i].textContent);
nickjillings@1370 2075 }
nickjillings@1370 2076 }
nickjillings@1370 2077 this.encode = function(root) {
nickjillings@1370 2078 var node = root.createElement('metric');
nickjillings@1370 2079 for (var i in this.enabled)
nickjillings@1370 2080 {
nickjillings@1370 2081 if (isNaN(Number(i)) == true){break;}
nickjillings@1370 2082 var child = root.createElement('metricenable');
nickjillings@1370 2083 child.textContent = this.enabled[i];
nickjillings@1370 2084 node.appendChild(child);
nickjillings@1370 2085 }
nickjillings@1370 2086 return node;
nickjillings@1370 2087 }
nickjillings@1370 2088 }
nickjillings@1370 2089
nickjillings@1324 2090 this.page = function() {
nickjillings@1318 2091 this.presentedId = undefined;
nickjillings@1318 2092 this.id = undefined;
nickjillings@1318 2093 this.hostURL = undefined;
nickjillings@1318 2094 this.randomiseOrder = undefined;
nickjillings@1318 2095 this.loop = undefined;
nickjillings@1324 2096 this.showElementComments = undefined;
nickjillings@1318 2097 this.outsideReference = null;
nickjillings@1318 2098 this.loudness = null;
nickjillings@1324 2099 this.preTest = null;
nickjillings@1324 2100 this.postTest = null;
nickjillings@1318 2101 this.interfaces = [];
nickjillings@1318 2102 this.commentBoxPrefix = "Comment on track";
nickjillings@1318 2103 this.audioElements = [];
nickjillings@1318 2104 this.commentQuestions = [];
nickjillings@1370 2105 this.schema = specification.schema.getAllElementsByName("page")[0];
nickjillings@1318 2106
nickjillings@1370 2107 this.decode = function(parent,xml)
nickjillings@1318 2108 {
nickjillings@1348 2109 var attributeMap = this.schema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 2110 for (var i=0; i<attributeMap.length; i++)
nickjillings@1318 2111 {
nickjillings@1324 2112 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 2113 var projectAttr = xml.getAttribute(attributeName);
nickjillings@1324 2114 projectAttr = parent.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 2115 switch(typeof projectAttr)
nickjillings@1318 2116 {
nickjillings@1324 2117 case "number":
nickjillings@1324 2118 case "boolean":
nickjillings@1324 2119 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 2120 break;
nickjillings@1324 2121 case "string":
nickjillings@1324 2122 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 2123 break;
nickjillings@1318 2124 }
nickjillings@1318 2125 }
nickjillings@1318 2126
nickjillings@1324 2127 // Get the Comment Box Prefix
nickjillings@1324 2128 var CBP = xml.getElementsByTagName('commentboxprefix');
nickjillings@1324 2129 if (CBP.length != 0) {
nickjillings@1324 2130 this.commentBoxPrefix = CBP[0].textContent;
nickjillings@1318 2131 }
nickjillings@1318 2132
nickjillings@1324 2133 // Now decode the interfaces
nickjillings@1324 2134 var interfaceNode = xml.getElementsByTagName('interface');
nickjillings@1324 2135 for (var i=0; i<interfaceNode.length; i++)
nickjillings@1324 2136 {
nickjillings@1324 2137 var node = new parent.interfaceNode();
nickjillings@1348 2138 node.decode(this,interfaceNode[i],parent.schema.getAllElementsByName('interface')[1]);
nickjillings@1324 2139 this.interfaces.push(node);
nickjillings@1324 2140 }
nickjillings@1318 2141
nickjillings@1324 2142 // Now process the survey node options
nickjillings@1324 2143 var survey = xml.getElementsByTagName('survey');
nickjillings@1348 2144 var surveySchema = parent.schema.getAllElementsByName('survey')[0];
nickjillings@1324 2145 for (var i in survey) {
nickjillings@1324 2146 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 2147 var location = survey[i].getAttribute('location');
nickjillings@1324 2148 if (location == 'pre' || location == 'before')
nickjillings@1324 2149 {
nickjillings@1324 2150 if (this.preTest != null){this.errors.push("Already a pre/before test survey defined! Ignoring second!!");}
nickjillings@1324 2151 else {
nickjillings@1324 2152 this.preTest = new parent.surveyNode();
nickjillings@1324 2153 this.preTest.decode(parent,survey[i],surveySchema);
nickjillings@1324 2154 }
nickjillings@1324 2155 } else if (location == 'post' || location == 'after') {
nickjillings@1324 2156 if (this.postTest != null){this.errors.push("Already a post/after test survey defined! Ignoring second!!");}
nickjillings@1324 2157 else {
nickjillings@1324 2158 this.postTest = new parent.surveyNode();
nickjillings@1324 2159 this.postTest.decode(parent,survey[i],surveySchema);
nickjillings@1324 2160 }
nickjillings@1324 2161 }
nickjillings@1324 2162 }
nickjillings@1324 2163
nickjillings@1324 2164 // Now process the audioelement tags
nickjillings@1324 2165 var audioElements = xml.getElementsByTagName('audioelement');
nickjillings@1324 2166 for (var i=0; i<audioElements.length; i++)
nickjillings@1324 2167 {
nickjillings@1324 2168 var node = new this.audioElementNode();
nickjillings@1370 2169 node.decode(this,audioElements[i]);
nickjillings@1324 2170 this.audioElements.push(node);
nickjillings@1324 2171 }
nickjillings@1324 2172
nickjillings@1324 2173 // Now decode the commentquestions
nickjillings@1324 2174 var commentQuestions = xml.getElementsByTagName('commentquestion');
nickjillings@1324 2175 for (var i=0; i<commentQuestions.length; i++)
nickjillings@1324 2176 {
nickjillings@1318 2177 var node = new this.commentQuestionNode();
nickjillings@1370 2178 node.decode(parent,commentQuestions[i]);
nickjillings@1318 2179 this.commentQuestions.push(node);
nickjillings@1318 2180 }
nickjillings@1318 2181 };
nickjillings@1318 2182
nickjillings@1318 2183 this.encode = function(root)
nickjillings@1318 2184 {
nickjillings@1318 2185 var AHNode = root.createElement("audioHolder");
nickjillings@1318 2186 AHNode.id = this.id;
nickjillings@1318 2187 AHNode.setAttribute("hostURL",this.hostURL);
nickjillings@1318 2188 AHNode.setAttribute("sampleRate",this.sampleRate);
nickjillings@1318 2189 AHNode.setAttribute("randomiseOrder",this.randomiseOrder);
nickjillings@1318 2190 AHNode.setAttribute("repeatCount",this.repeatCount);
nickjillings@1318 2191 AHNode.setAttribute("loop",this.loop);
nickjillings@1318 2192 AHNode.setAttribute("elementComments",this.elementComments);
nickjillings@1318 2193 if(this.loudness != null) {AHNode.setAttribute("loudness",this.loudness);}
nickjillings@1318 2194 if(this.initialPosition != null) {
nickjillings@1318 2195 AHNode.setAttribute("loudness",this.initialPosition*100);
nickjillings@1318 2196 }
nickjillings@1318 2197 for (var i=0; i<this.interfaces.length; i++)
nickjillings@1318 2198 {
nickjillings@1318 2199 AHNode.appendChild(this.interfaces[i].encode(root));
nickjillings@1318 2200 }
nickjillings@1318 2201
nickjillings@1318 2202 for (var i=0; i<this.audioElements.length; i++) {
nickjillings@1318 2203 AHNode.appendChild(this.audioElements[i].encode(root));
nickjillings@1318 2204 }
nickjillings@1318 2205 // Create <CommentQuestion>
nickjillings@1318 2206 for (var i=0; i<this.commentQuestions.length; i++)
nickjillings@1318 2207 {
nickjillings@1318 2208 AHNode.appendChild(this.commentQuestions[i].exportXML(root));
nickjillings@1318 2209 }
nickjillings@1318 2210
nickjillings@1318 2211 // Create <PreTest>
nickjillings@1318 2212 var AHPreTest = root.createElement("PreTest");
nickjillings@1318 2213 for (var i=0; i<this.preTest.options.length; i++)
nickjillings@1318 2214 {
nickjillings@1318 2215 AHPreTest.appendChild(this.preTest.options[i].exportXML(root));
nickjillings@1318 2216 }
nickjillings@1318 2217
nickjillings@1318 2218 var AHPostTest = root.createElement("PostTest");
nickjillings@1318 2219 for (var i=0; i<this.postTest.options.length; i++)
nickjillings@1318 2220 {
nickjillings@1318 2221 AHPostTest.appendChild(this.postTest.options[i].exportXML(root));
nickjillings@1318 2222 }
nickjillings@1318 2223 AHNode.appendChild(AHPreTest);
nickjillings@1318 2224 AHNode.appendChild(AHPostTest);
nickjillings@1318 2225 return AHNode;
nickjillings@1318 2226 };
nickjillings@1318 2227
nickjillings@1324 2228 this.commentQuestionNode = function() {
nickjillings@1324 2229 this.id = null;
nickjillings@1324 2230 this.type = undefined;
nickjillings@1318 2231 this.options = [];
nickjillings@1324 2232 this.statement = undefined;
nickjillings@1370 2233 this.schema = specification.schema.getAllElementsByName('commentquestion')[0];
nickjillings@1370 2234 this.decode = function(parent,xml)
nickjillings@1318 2235 {
nickjillings@1324 2236 this.id = xml.id;
nickjillings@1324 2237 this.type = xml.getAttribute('type');
nickjillings@1324 2238 this.statement = xml.getElementsByTagName('statement')[0].textContent;
nickjillings@1324 2239 var optNodes = xml.getElementsByTagName('option');
nickjillings@1324 2240 for (var i=0; i<optNodes.length; i++)
nickjillings@1324 2241 {
nickjillings@1324 2242 var optNode = optNodes[i];
nickjillings@1324 2243 this.options.push({
nickjillings@1324 2244 name: optNode.getAttribute('name'),
nickjillings@1324 2245 text: optNode.textContent
nickjillings@1324 2246 });
nickjillings@1318 2247 }
nickjillings@1318 2248 };
nickjillings@1324 2249
nickjillings@1318 2250 this.encode = function(root)
nickjillings@1318 2251 {
nickjillings@1324 2252
nickjillings@1318 2253 };
nickjillings@1318 2254 };
nickjillings@1318 2255
nickjillings@1318 2256 this.audioElementNode = function() {
nickjillings@1318 2257 this.url = null;
nickjillings@1318 2258 this.id = null;
nickjillings@1318 2259 this.parent = null;
nickjillings@1324 2260 this.type = null;
nickjillings@1318 2261 this.marker = false;
nickjillings@1318 2262 this.enforce = false;
nickjillings@1318 2263 this.gain = 1.0;
nickjillings@1370 2264 this.schema = specification.schema.getAllElementsByName('audioelement')[0];;
nickjillings@1324 2265 this.parent = null;
nickjillings@1370 2266 this.decode = function(parent,xml)
nickjillings@1318 2267 {
nickjillings@1318 2268 this.parent = parent;
nickjillings@1348 2269 var attributeMap = this.schema.getAllElementsByTagName('xs:attribute');
nickjillings@1324 2270 for (var i=0; i<attributeMap.length; i++)
nickjillings@1318 2271 {
nickjillings@1324 2272 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 2273 var projectAttr = xml.getAttribute(attributeName);
nickjillings@1324 2274 projectAttr = specification.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 2275 switch(typeof projectAttr)
nickjillings@1318 2276 {
nickjillings@1324 2277 case "number":
nickjillings@1324 2278 case "boolean":
nickjillings@1324 2279 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 2280 break;
nickjillings@1324 2281 case "string":
nickjillings@1324 2282 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 2283 break;
nickjillings@1318 2284 }
nickjillings@1318 2285 }
nickjillings@1324 2286
nickjillings@1318 2287 };
nickjillings@1318 2288 this.encode = function(root)
nickjillings@1318 2289 {
nickjillings@1318 2290 var AENode = root.createElement("audioElements");
nickjillings@1318 2291 AENode.id = this.id;
nickjillings@1318 2292 AENode.setAttribute("url",this.url);
nickjillings@1318 2293 AENode.setAttribute("type",this.type);
nickjillings@1318 2294 AENode.setAttribute("gain",linearToDecibel(this.gain));
nickjillings@1318 2295 if (this.marker != false)
nickjillings@1318 2296 {
nickjillings@1318 2297 AENode.setAttribute("marker",this.marker*100);
nickjillings@1318 2298 }
nickjillings@1318 2299 return AENode;
nickjillings@1318 2300 };
nickjillings@1318 2301 };
nickjillings@1318 2302 };
nickjillings@1318 2303 }
nickjillings@1318 2304
nickjillings@1318 2305 function Interface(specificationObject) {
nickjillings@1318 2306 // This handles the bindings between the interface and the audioEngineContext;
nickjillings@1318 2307 this.specification = specificationObject;
nickjillings@1318 2308 this.insertPoint = document.getElementById("topLevelBody");
nickjillings@1318 2309
nickjillings@1324 2310 this.newPage = function(audioHolderObject,store)
nickjillings@1318 2311 {
nickjillings@1369 2312 audioEngineContext.newTestPage(audioHolderObject,store);
nickjillings@1318 2313 interfaceContext.deleteCommentBoxes();
nickjillings@1318 2314 interfaceContext.deleteCommentQuestions();
nickjillings@1324 2315 loadTest(audioHolderObject,store);
nickjillings@1318 2316 };
nickjillings@1318 2317
nickjillings@1318 2318 // Bounded by interface!!
nickjillings@1318 2319 // Interface object MUST have an exportXMLDOM method which returns the various DOM levels
nickjillings@1318 2320 // For example, APE returns the slider position normalised in a <value> tag.
nickjillings@1318 2321 this.interfaceObjects = [];
nickjillings@1318 2322 this.interfaceObject = function(){};
nickjillings@1318 2323
nickjillings@1318 2324 this.resizeWindow = function(event)
nickjillings@1318 2325 {
nickjillings@1318 2326 popup.resize(event);
nickjillings@1318 2327 for(var i=0; i<this.commentBoxes.length; i++)
nickjillings@1318 2328 {this.commentBoxes[i].resize();}
nickjillings@1318 2329 for(var i=0; i<this.commentQuestions.length; i++)
nickjillings@1318 2330 {this.commentQuestions[i].resize();}
nickjillings@1318 2331 try
nickjillings@1318 2332 {
nickjillings@1318 2333 resizeWindow(event);
nickjillings@1318 2334 }
nickjillings@1318 2335 catch(err)
nickjillings@1318 2336 {
nickjillings@1318 2337 console.log("Warning - Interface does not have Resize option");
nickjillings@1318 2338 console.log(err);
nickjillings@1318 2339 }
nickjillings@1318 2340 };
nickjillings@1318 2341
nickjillings@1318 2342 this.returnNavigator = function()
nickjillings@1318 2343 {
nickjillings@1362 2344 var node = storage.document.createElement("navigator");
nickjillings@1362 2345 var platform = storage.document.createElement("platform");
nickjillings@1318 2346 platform.textContent = navigator.platform;
nickjillings@1362 2347 var vendor = storage.document.createElement("vendor");
nickjillings@1318 2348 vendor.textContent = navigator.vendor;
nickjillings@1362 2349 var userAgent = storage.document.createElement("uagent");
nickjillings@1318 2350 userAgent.textContent = navigator.userAgent;
nickjillings@1362 2351 var screen = storage.document.createElement("window");
nickjillings@1362 2352 screen.setAttribute('innerWidth',window.innerWidth);
nickjillings@1362 2353 screen.setAttribute('innerHeight',window.innerHeight);
nickjillings@1318 2354 node.appendChild(platform);
nickjillings@1318 2355 node.appendChild(vendor);
nickjillings@1318 2356 node.appendChild(userAgent);
nickjillings@1362 2357 node.appendChild(screen);
nickjillings@1318 2358 return node;
nickjillings@1318 2359 };
nickjillings@1318 2360
nickjillings@1318 2361 this.commentBoxes = [];
nickjillings@1318 2362 this.elementCommentBox = function(audioObject) {
nickjillings@1318 2363 var element = audioObject.specification;
nickjillings@1318 2364 this.audioObject = audioObject;
nickjillings@1318 2365 this.id = audioObject.id;
nickjillings@1318 2366 var audioHolderObject = audioObject.specification.parent;
nickjillings@1318 2367 // Create document objects to hold the comment boxes
nickjillings@1318 2368 this.trackComment = document.createElement('div');
nickjillings@1318 2369 this.trackComment.className = 'comment-div';
nickjillings@1318 2370 this.trackComment.id = 'comment-div-'+audioObject.id;
nickjillings@1318 2371 // Create a string next to each comment asking for a comment
nickjillings@1318 2372 this.trackString = document.createElement('span');
nickjillings@1316 2373 this.trackString.innerHTML = audioHolderObject.commentBoxPrefix+' '+audioObject.interfaceDOM.getPresentedId();
nickjillings@1318 2374 // Create the HTML5 comment box 'textarea'
nickjillings@1318 2375 this.trackCommentBox = document.createElement('textarea');
nickjillings@1318 2376 this.trackCommentBox.rows = '4';
nickjillings@1318 2377 this.trackCommentBox.cols = '100';
nickjillings@1318 2378 this.trackCommentBox.name = 'trackComment'+audioObject.id;
nickjillings@1318 2379 this.trackCommentBox.className = 'trackComment';
nickjillings@1318 2380 var br = document.createElement('br');
nickjillings@1318 2381 // Add to the holder.
nickjillings@1318 2382 this.trackComment.appendChild(this.trackString);
nickjillings@1318 2383 this.trackComment.appendChild(br);
nickjillings@1318 2384 this.trackComment.appendChild(this.trackCommentBox);
nickjillings@1318 2385
nickjillings@1318 2386 this.exportXMLDOM = function() {
nickjillings@1318 2387 var root = document.createElement('comment');
nickjillings@1318 2388 if (this.audioObject.specification.parent.elementComments) {
nickjillings@1318 2389 var question = document.createElement('question');
nickjillings@1318 2390 question.textContent = this.trackString.textContent;
nickjillings@1318 2391 var response = document.createElement('response');
nickjillings@1318 2392 response.textContent = this.trackCommentBox.value;
nickjillings@1318 2393 console.log("Comment frag-"+this.id+": "+response.textContent);
nickjillings@1318 2394 root.appendChild(question);
nickjillings@1318 2395 root.appendChild(response);
nickjillings@1318 2396 }
nickjillings@1318 2397 return root;
nickjillings@1318 2398 };
nickjillings@1318 2399 this.resize = function()
nickjillings@1318 2400 {
nickjillings@1318 2401 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2402 if (boxwidth >= 600)
nickjillings@1318 2403 {
nickjillings@1318 2404 boxwidth = 600;
nickjillings@1318 2405 }
nickjillings@1318 2406 else if (boxwidth < 400)
nickjillings@1318 2407 {
nickjillings@1318 2408 boxwidth = 400;
nickjillings@1318 2409 }
nickjillings@1318 2410 this.trackComment.style.width = boxwidth+"px";
nickjillings@1318 2411 this.trackCommentBox.style.width = boxwidth-6+"px";
nickjillings@1318 2412 };
nickjillings@1318 2413 this.resize();
nickjillings@1318 2414 };
nickjillings@1318 2415
nickjillings@1318 2416 this.commentQuestions = [];
nickjillings@1318 2417
nickjillings@1318 2418 this.commentBox = function(commentQuestion) {
nickjillings@1318 2419 this.specification = commentQuestion;
nickjillings@1318 2420 // Create document objects to hold the comment boxes
nickjillings@1318 2421 this.holder = document.createElement('div');
nickjillings@1318 2422 this.holder.className = 'comment-div';
nickjillings@1318 2423 // Create a string next to each comment asking for a comment
nickjillings@1318 2424 this.string = document.createElement('span');
nickjillings@1324 2425 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2426 // Create the HTML5 comment box 'textarea'
nickjillings@1318 2427 this.textArea = document.createElement('textarea');
nickjillings@1318 2428 this.textArea.rows = '4';
nickjillings@1318 2429 this.textArea.cols = '100';
nickjillings@1318 2430 this.textArea.className = 'trackComment';
nickjillings@1318 2431 var br = document.createElement('br');
nickjillings@1318 2432 // Add to the holder.
nickjillings@1318 2433 this.holder.appendChild(this.string);
nickjillings@1318 2434 this.holder.appendChild(br);
nickjillings@1318 2435 this.holder.appendChild(this.textArea);
nickjillings@1318 2436
nickjillings@1318 2437 this.exportXMLDOM = function() {
nickjillings@1318 2438 var root = document.createElement('comment');
nickjillings@1318 2439 root.id = this.specification.id;
nickjillings@1318 2440 root.setAttribute('type',this.specification.type);
nickjillings@1318 2441 root.textContent = this.textArea.value;
nickjillings@1318 2442 console.log("Question: "+this.string.textContent);
nickjillings@1318 2443 console.log("Response: "+root.textContent);
nickjillings@1318 2444 return root;
nickjillings@1318 2445 };
nickjillings@1318 2446 this.resize = function()
nickjillings@1318 2447 {
nickjillings@1318 2448 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2449 if (boxwidth >= 600)
nickjillings@1318 2450 {
nickjillings@1318 2451 boxwidth = 600;
nickjillings@1318 2452 }
nickjillings@1318 2453 else if (boxwidth < 400)
nickjillings@1318 2454 {
nickjillings@1318 2455 boxwidth = 400;
nickjillings@1318 2456 }
nickjillings@1318 2457 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2458 this.textArea.style.width = boxwidth-6+"px";
nickjillings@1318 2459 };
nickjillings@1318 2460 this.resize();
nickjillings@1318 2461 };
nickjillings@1318 2462
nickjillings@1318 2463 this.radioBox = function(commentQuestion) {
nickjillings@1318 2464 this.specification = commentQuestion;
nickjillings@1318 2465 // Create document objects to hold the comment boxes
nickjillings@1318 2466 this.holder = document.createElement('div');
nickjillings@1318 2467 this.holder.className = 'comment-div';
nickjillings@1318 2468 // Create a string next to each comment asking for a comment
nickjillings@1318 2469 this.string = document.createElement('span');
nickjillings@1318 2470 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2471 var br = document.createElement('br');
nickjillings@1318 2472 // Add to the holder.
nickjillings@1318 2473 this.holder.appendChild(this.string);
nickjillings@1318 2474 this.holder.appendChild(br);
nickjillings@1318 2475 this.options = [];
nickjillings@1318 2476 this.inputs = document.createElement('div');
nickjillings@1318 2477 this.span = document.createElement('div');
nickjillings@1318 2478 this.inputs.align = 'center';
nickjillings@1318 2479 this.inputs.style.marginLeft = '12px';
nickjillings@1318 2480 this.span.style.marginLeft = '12px';
nickjillings@1318 2481 this.span.align = 'center';
nickjillings@1318 2482 this.span.style.marginTop = '15px';
nickjillings@1318 2483
nickjillings@1318 2484 var optCount = commentQuestion.options.length;
nickjillings@1324 2485 for (var optNode of commentQuestion.options)
nickjillings@1318 2486 {
nickjillings@1318 2487 var div = document.createElement('div');
nickjillings@1318 2488 div.style.width = '80px';
nickjillings@1318 2489 div.style.float = 'left';
nickjillings@1318 2490 var input = document.createElement('input');
nickjillings@1318 2491 input.type = 'radio';
nickjillings@1318 2492 input.name = commentQuestion.id;
nickjillings@1324 2493 input.setAttribute('setvalue',optNode.name);
nickjillings@1318 2494 input.className = 'comment-radio';
nickjillings@1318 2495 div.appendChild(input);
nickjillings@1318 2496 this.inputs.appendChild(div);
nickjillings@1318 2497
nickjillings@1318 2498
nickjillings@1318 2499 div = document.createElement('div');
nickjillings@1318 2500 div.style.width = '80px';
nickjillings@1318 2501 div.style.float = 'left';
nickjillings@1318 2502 div.align = 'center';
nickjillings@1318 2503 var span = document.createElement('span');
nickjillings@1324 2504 span.textContent = optNode.text;
nickjillings@1318 2505 span.className = 'comment-radio-span';
nickjillings@1318 2506 div.appendChild(span);
nickjillings@1318 2507 this.span.appendChild(div);
nickjillings@1318 2508 this.options.push(input);
nickjillings@1318 2509 }
nickjillings@1318 2510 this.holder.appendChild(this.span);
nickjillings@1318 2511 this.holder.appendChild(this.inputs);
nickjillings@1318 2512
nickjillings@1318 2513 this.exportXMLDOM = function() {
nickjillings@1318 2514 var root = document.createElement('comment');
nickjillings@1318 2515 root.id = this.specification.id;
nickjillings@1318 2516 root.setAttribute('type',this.specification.type);
nickjillings@1318 2517 var question = document.createElement('question');
nickjillings@1318 2518 question.textContent = this.string.textContent;
nickjillings@1318 2519 var response = document.createElement('response');
nickjillings@1318 2520 var i=0;
nickjillings@1318 2521 while(this.options[i].checked == false) {
nickjillings@1318 2522 i++;
nickjillings@1318 2523 if (i >= this.options.length) {
nickjillings@1318 2524 break;
nickjillings@1318 2525 }
nickjillings@1318 2526 }
nickjillings@1318 2527 if (i >= this.options.length) {
nickjillings@1318 2528 response.textContent = 'null';
nickjillings@1318 2529 } else {
nickjillings@1318 2530 response.textContent = this.options[i].getAttribute('setvalue');
nickjillings@1318 2531 response.setAttribute('number',i);
nickjillings@1318 2532 }
nickjillings@1318 2533 console.log('Comment: '+question.textContent);
nickjillings@1318 2534 console.log('Response: '+response.textContent);
nickjillings@1318 2535 root.appendChild(question);
nickjillings@1318 2536 root.appendChild(response);
nickjillings@1318 2537 return root;
nickjillings@1318 2538 };
nickjillings@1318 2539 this.resize = function()
nickjillings@1318 2540 {
nickjillings@1318 2541 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2542 if (boxwidth >= 600)
nickjillings@1318 2543 {
nickjillings@1318 2544 boxwidth = 600;
nickjillings@1318 2545 }
nickjillings@1318 2546 else if (boxwidth < 400)
nickjillings@1318 2547 {
nickjillings@1318 2548 boxwidth = 400;
nickjillings@1318 2549 }
nickjillings@1318 2550 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2551 var text = this.holder.children[2];
nickjillings@1318 2552 var options = this.holder.children[3];
nickjillings@1318 2553 var optCount = options.children.length;
nickjillings@1318 2554 var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nickjillings@1318 2555 var options = options.firstChild;
nickjillings@1318 2556 var text = text.firstChild;
nickjillings@1318 2557 options.style.marginRight = spanMargin;
nickjillings@1318 2558 options.style.marginLeft = spanMargin;
nickjillings@1318 2559 text.style.marginRight = spanMargin;
nickjillings@1318 2560 text.style.marginLeft = spanMargin;
nickjillings@1318 2561 while(options.nextSibling != undefined)
nickjillings@1318 2562 {
nickjillings@1318 2563 options = options.nextSibling;
nickjillings@1318 2564 text = text.nextSibling;
nickjillings@1318 2565 options.style.marginRight = spanMargin;
nickjillings@1318 2566 options.style.marginLeft = spanMargin;
nickjillings@1318 2567 text.style.marginRight = spanMargin;
nickjillings@1318 2568 text.style.marginLeft = spanMargin;
nickjillings@1318 2569 }
nickjillings@1318 2570 };
nickjillings@1318 2571 this.resize();
nickjillings@1318 2572 };
nickjillings@1318 2573
nickjillings@1318 2574 this.checkboxBox = function(commentQuestion) {
nickjillings@1318 2575 this.specification = commentQuestion;
nickjillings@1318 2576 // Create document objects to hold the comment boxes
nickjillings@1318 2577 this.holder = document.createElement('div');
nickjillings@1318 2578 this.holder.className = 'comment-div';
nickjillings@1318 2579 // Create a string next to each comment asking for a comment
nickjillings@1318 2580 this.string = document.createElement('span');
nickjillings@1318 2581 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2582 var br = document.createElement('br');
nickjillings@1318 2583 // Add to the holder.
nickjillings@1318 2584 this.holder.appendChild(this.string);
nickjillings@1318 2585 this.holder.appendChild(br);
nickjillings@1318 2586 this.options = [];
nickjillings@1318 2587 this.inputs = document.createElement('div');
nickjillings@1318 2588 this.span = document.createElement('div');
nickjillings@1318 2589 this.inputs.align = 'center';
nickjillings@1318 2590 this.inputs.style.marginLeft = '12px';
nickjillings@1318 2591 this.span.style.marginLeft = '12px';
nickjillings@1318 2592 this.span.align = 'center';
nickjillings@1318 2593 this.span.style.marginTop = '15px';
nickjillings@1318 2594
nickjillings@1318 2595 var optCount = commentQuestion.options.length;
nickjillings@1318 2596 for (var i=0; i<optCount; i++)
nickjillings@1318 2597 {
nickjillings@1318 2598 var div = document.createElement('div');
nickjillings@1318 2599 div.style.width = '80px';
nickjillings@1318 2600 div.style.float = 'left';
nickjillings@1318 2601 var input = document.createElement('input');
nickjillings@1318 2602 input.type = 'checkbox';
nickjillings@1318 2603 input.name = commentQuestion.id;
nickjillings@1318 2604 input.setAttribute('setvalue',commentQuestion.options[i].name);
nickjillings@1318 2605 input.className = 'comment-radio';
nickjillings@1318 2606 div.appendChild(input);
nickjillings@1318 2607 this.inputs.appendChild(div);
nickjillings@1318 2608
nickjillings@1318 2609
nickjillings@1318 2610 div = document.createElement('div');
nickjillings@1318 2611 div.style.width = '80px';
nickjillings@1318 2612 div.style.float = 'left';
nickjillings@1318 2613 div.align = 'center';
nickjillings@1318 2614 var span = document.createElement('span');
nickjillings@1318 2615 span.textContent = commentQuestion.options[i].text;
nickjillings@1318 2616 span.className = 'comment-radio-span';
nickjillings@1318 2617 div.appendChild(span);
nickjillings@1318 2618 this.span.appendChild(div);
nickjillings@1318 2619 this.options.push(input);
nickjillings@1318 2620 }
nickjillings@1318 2621 this.holder.appendChild(this.span);
nickjillings@1318 2622 this.holder.appendChild(this.inputs);
nickjillings@1318 2623
nickjillings@1318 2624 this.exportXMLDOM = function() {
nickjillings@1318 2625 var root = document.createElement('comment');
nickjillings@1318 2626 root.id = this.specification.id;
nickjillings@1318 2627 root.setAttribute('type',this.specification.type);
nickjillings@1318 2628 var question = document.createElement('question');
nickjillings@1318 2629 question.textContent = this.string.textContent;
nickjillings@1318 2630 root.appendChild(question);
nickjillings@1318 2631 console.log('Comment: '+question.textContent);
nickjillings@1318 2632 for (var i=0; i<this.options.length; i++) {
nickjillings@1318 2633 var response = document.createElement('response');
nickjillings@1318 2634 response.textContent = this.options[i].checked;
nickjillings@1318 2635 response.setAttribute('name',this.options[i].getAttribute('setvalue'));
nickjillings@1318 2636 root.appendChild(response);
nickjillings@1318 2637 console.log('Response '+response.getAttribute('name') +': '+response.textContent);
nickjillings@1318 2638 }
nickjillings@1318 2639 return root;
nickjillings@1318 2640 };
nickjillings@1318 2641 this.resize = function()
nickjillings@1318 2642 {
nickjillings@1318 2643 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2644 if (boxwidth >= 600)
nickjillings@1318 2645 {
nickjillings@1318 2646 boxwidth = 600;
nickjillings@1318 2647 }
nickjillings@1318 2648 else if (boxwidth < 400)
nickjillings@1318 2649 {
nickjillings@1318 2650 boxwidth = 400;
nickjillings@1318 2651 }
nickjillings@1318 2652 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2653 var text = this.holder.children[2];
nickjillings@1318 2654 var options = this.holder.children[3];
nickjillings@1318 2655 var optCount = options.children.length;
nickjillings@1318 2656 var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nickjillings@1318 2657 var options = options.firstChild;
nickjillings@1318 2658 var text = text.firstChild;
nickjillings@1318 2659 options.style.marginRight = spanMargin;
nickjillings@1318 2660 options.style.marginLeft = spanMargin;
nickjillings@1318 2661 text.style.marginRight = spanMargin;
nickjillings@1318 2662 text.style.marginLeft = spanMargin;
nickjillings@1318 2663 while(options.nextSibling != undefined)
nickjillings@1318 2664 {
nickjillings@1318 2665 options = options.nextSibling;
nickjillings@1318 2666 text = text.nextSibling;
nickjillings@1318 2667 options.style.marginRight = spanMargin;
nickjillings@1318 2668 options.style.marginLeft = spanMargin;
nickjillings@1318 2669 text.style.marginRight = spanMargin;
nickjillings@1318 2670 text.style.marginLeft = spanMargin;
nickjillings@1318 2671 }
nickjillings@1318 2672 };
nickjillings@1318 2673 this.resize();
nickjillings@1318 2674 };
nickjillings@1318 2675
nickjillings@1318 2676 this.createCommentBox = function(audioObject) {
nickjillings@1318 2677 var node = new this.elementCommentBox(audioObject);
nickjillings@1318 2678 this.commentBoxes.push(node);
nickjillings@1318 2679 audioObject.commentDOM = node;
nickjillings@1318 2680 return node;
nickjillings@1318 2681 };
nickjillings@1318 2682
nickjillings@1318 2683 this.sortCommentBoxes = function() {
nickjillings@1338 2684 this.commentBoxes.sort(function(a,b){return a.id - b.id;});
nickjillings@1318 2685 };
nickjillings@1318 2686
nickjillings@1318 2687 this.showCommentBoxes = function(inject, sort) {
nickjillings@1318 2688 if (sort) {interfaceContext.sortCommentBoxes();}
nickjillings@1338 2689 for (var box of interfaceContext.commentBoxes) {
nickjillings@1338 2690 inject.appendChild(box.trackComment);
nickjillings@1318 2691 }
nickjillings@1318 2692 };
nickjillings@1318 2693
nickjillings@1318 2694 this.deleteCommentBoxes = function() {
nickjillings@1318 2695 this.commentBoxes = [];
nickjillings@1318 2696 };
nickjillings@1318 2697
nickjillings@1318 2698 this.createCommentQuestion = function(element) {
nickjillings@1318 2699 var node;
nickjillings@1324 2700 if (element.type == 'question') {
nickjillings@1318 2701 node = new this.commentBox(element);
nickjillings@1318 2702 } else if (element.type == 'radio') {
nickjillings@1318 2703 node = new this.radioBox(element);
nickjillings@1318 2704 } else if (element.type == 'checkbox') {
nickjillings@1318 2705 node = new this.checkboxBox(element);
nickjillings@1318 2706 }
nickjillings@1318 2707 this.commentQuestions.push(node);
nickjillings@1318 2708 return node;
nickjillings@1318 2709 };
nickjillings@1318 2710
nickjillings@1318 2711 this.deleteCommentQuestions = function()
nickjillings@1318 2712 {
nickjillings@1318 2713 this.commentQuestions = [];
nickjillings@1318 2714 };
nickjillings@1318 2715
nickjillings@1318 2716 this.playhead = new function()
nickjillings@1318 2717 {
nickjillings@1318 2718 this.object = document.createElement('div');
nickjillings@1318 2719 this.object.className = 'playhead';
nickjillings@1318 2720 this.object.align = 'left';
nickjillings@1318 2721 var curTime = document.createElement('div');
nickjillings@1318 2722 curTime.style.width = '50px';
nickjillings@1318 2723 this.curTimeSpan = document.createElement('span');
nickjillings@1318 2724 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2725 curTime.appendChild(this.curTimeSpan);
nickjillings@1318 2726 this.object.appendChild(curTime);
nickjillings@1318 2727 this.scrubberTrack = document.createElement('div');
nickjillings@1318 2728 this.scrubberTrack.className = 'playhead-scrub-track';
nickjillings@1318 2729
nickjillings@1318 2730 this.scrubberHead = document.createElement('div');
nickjillings@1318 2731 this.scrubberHead.id = 'playhead-scrubber';
nickjillings@1318 2732 this.scrubberTrack.appendChild(this.scrubberHead);
nickjillings@1318 2733 this.object.appendChild(this.scrubberTrack);
nickjillings@1318 2734
nickjillings@1318 2735 this.timePerPixel = 0;
nickjillings@1318 2736 this.maxTime = 0;
nickjillings@1318 2737
nickjillings@1318 2738 this.playbackObject;
nickjillings@1318 2739
nickjillings@1318 2740 this.setTimePerPixel = function(audioObject) {
nickjillings@1318 2741 //maxTime must be in seconds
nickjillings@1318 2742 this.playbackObject = audioObject;
nickjillings@1318 2743 this.maxTime = audioObject.buffer.buffer.duration;
nickjillings@1318 2744 var width = 490; //500 - 10, 5 each side of the tracker head
nickjillings@1318 2745 this.timePerPixel = this.maxTime/490;
nickjillings@1318 2746 if (this.maxTime < 60) {
nickjillings@1318 2747 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2748 } else {
nickjillings@1318 2749 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2750 }
nickjillings@1318 2751 };
nickjillings@1318 2752
nickjillings@1318 2753 this.update = function() {
nickjillings@1318 2754 // Update the playhead position, startPlay must be called
nickjillings@1318 2755 if (this.timePerPixel > 0) {
nickjillings@1318 2756 var time = this.playbackObject.getCurrentPosition();
nickjillings@1367 2757 if (time > 0 && time < this.maxTime) {
nickjillings@1318 2758 var width = 490;
nickjillings@1318 2759 var pix = Math.floor(time/this.timePerPixel);
nickjillings@1318 2760 this.scrubberHead.style.left = pix+'px';
nickjillings@1318 2761 if (this.maxTime > 60.0) {
nickjillings@1318 2762 var secs = time%60;
nickjillings@1318 2763 var mins = Math.floor((time-secs)/60);
nickjillings@1318 2764 secs = secs.toString();
nickjillings@1318 2765 secs = secs.substr(0,2);
nickjillings@1318 2766 mins = mins.toString();
nickjillings@1318 2767 this.curTimeSpan.textContent = mins+':'+secs;
nickjillings@1318 2768 } else {
nickjillings@1318 2769 time = time.toString();
nickjillings@1318 2770 this.curTimeSpan.textContent = time.substr(0,4);
nickjillings@1318 2771 }
nickjillings@1318 2772 } else {
nickjillings@1318 2773 this.scrubberHead.style.left = '0px';
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@1318 2781 };
nickjillings@1318 2782
nickjillings@1318 2783 this.interval = undefined;
nickjillings@1318 2784
nickjillings@1318 2785 this.start = function() {
nickjillings@1318 2786 if (this.playbackObject != undefined && this.interval == undefined) {
nickjillings@1318 2787 if (this.maxTime < 60) {
nickjillings@1318 2788 this.interval = setInterval(function(){interfaceContext.playhead.update();},10);
nickjillings@1318 2789 } else {
nickjillings@1318 2790 this.interval = setInterval(function(){interfaceContext.playhead.update();},100);
nickjillings@1318 2791 }
nickjillings@1318 2792 }
nickjillings@1318 2793 };
nickjillings@1318 2794 this.stop = function() {
nickjillings@1318 2795 clearInterval(this.interval);
nickjillings@1318 2796 this.interval = undefined;
nickjillings@1318 2797 if (this.maxTime < 60) {
nickjillings@1318 2798 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2799 } else {
nickjillings@1318 2800 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2801 }
nickjillings@1318 2802 };
nickjillings@1318 2803 };
nickjillings@1354 2804
nickjillings@1354 2805 this.volume = new function()
nickjillings@1354 2806 {
nickjillings@1354 2807 // An in-built volume module which can be viewed on page
nickjillings@1354 2808 // Includes trackers on page-by-page data
nickjillings@1354 2809 // Volume does NOT reset to 0dB on each page load
nickjillings@1354 2810 this.valueLin = 1.0;
nickjillings@1354 2811 this.valueDB = 0.0;
nickjillings@1354 2812 this.object = document.createElement('div');
nickjillings@1354 2813 this.object.id = 'master-volume-holder';
nickjillings@1354 2814 this.slider = document.createElement('input');
nickjillings@1354 2815 this.slider.id = 'master-volume-control';
nickjillings@1354 2816 this.slider.type = 'range';
nickjillings@1354 2817 this.valueText = document.createElement('span');
nickjillings@1354 2818 this.valueText.id = 'master-volume-feedback';
nickjillings@1354 2819 this.valueText.textContent = '0dB';
nickjillings@1354 2820
nickjillings@1354 2821 this.slider.min = -60;
nickjillings@1354 2822 this.slider.max = 12;
nickjillings@1354 2823 this.slider.value = 0;
nickjillings@1354 2824 this.slider.step = 1;
nickjillings@1354 2825 this.slider.onmousemove = function(event)
nickjillings@1354 2826 {
nickjillings@1354 2827 interfaceContext.volume.valueDB = event.currentTarget.value;
nickjillings@1354 2828 interfaceContext.volume.valueLin = decibelToLinear(interfaceContext.volume.valueDB);
nickjillings@1354 2829 interfaceContext.volume.valueText.textContent = interfaceContext.volume.valueDB+'dB';
nickjillings@1354 2830 audioEngineContext.outputGain.gain.value = interfaceContext.volume.valueLin;
nickjillings@1354 2831 }
nickjillings@1354 2832 this.slider.onmouseup = function(event)
nickjillings@1354 2833 {
nickjillings@1354 2834 var storePoint = testState.currentStore.XMLDOM.children[0].getAllElementsByName('volumeTracker');
nickjillings@1354 2835 if (storePoint.length == 0)
nickjillings@1354 2836 {
nickjillings@1354 2837 storePoint = storage.document.createElement('metricresult');
nickjillings@1354 2838 storePoint.setAttribute('name','volumeTracker');
nickjillings@1354 2839 testState.currentStore.XMLDOM.children[0].appendChild(storePoint);
nickjillings@1354 2840 }
nickjillings@1354 2841 else {
nickjillings@1354 2842 storePoint = storePoint[0];
nickjillings@1354 2843 }
nickjillings@1354 2844 var node = storage.document.createElement('movement');
nickjillings@1354 2845 node.setAttribute('test-time',audioEngineContext.timer.getTestTime());
nickjillings@1354 2846 node.setAttribute('volume',interfaceContext.volume.valueDB);
nickjillings@1354 2847 node.setAttribute('format','dBFS');
nickjillings@1354 2848 storePoint.appendChild(node);
nickjillings@1354 2849 }
nickjillings@1354 2850
nickjillings@1355 2851 var title = document.createElement('div');
nickjillings@1355 2852 title.innerHTML = '<span>Master Volume Control</span>';
nickjillings@1355 2853 title.style.fontSize = '0.75em';
nickjillings@1355 2854 title.style.width = "100%";
nickjillings@1355 2855 title.align = 'center';
nickjillings@1355 2856 this.object.appendChild(title);
nickjillings@1355 2857
nickjillings@1354 2858 this.object.appendChild(this.slider);
nickjillings@1354 2859 this.object.appendChild(this.valueText);
nickjillings@1354 2860 }
nickjillings@1318 2861 // Global Checkers
nickjillings@1318 2862 // These functions will help enforce the checkers
nickjillings@1318 2863 this.checkHiddenAnchor = function()
nickjillings@1318 2864 {
nickjillings@1324 2865 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2866 {
nickjillings@1324 2867 if (ao.specification.type == "anchor")
nickjillings@1318 2868 {
nickjillings@1325 2869 if (ao.interfaceDOM.getValue() > (ao.specification.marker/100) && ao.specification.marker > 0) {
nickjillings@1324 2870 // Anchor is not set below
nickjillings@1324 2871 console.log('Anchor node not below marker value');
nickjillings@1324 2872 alert('Please keep listening');
nickjillings@1367 2873 this.storeErrorNode('Anchor node not below marker value');
nickjillings@1324 2874 return false;
nickjillings@1324 2875 }
nickjillings@1318 2876 }
nickjillings@1318 2877 }
nickjillings@1318 2878 return true;
nickjillings@1318 2879 };
nickjillings@1318 2880
nickjillings@1318 2881 this.checkHiddenReference = function()
nickjillings@1318 2882 {
nickjillings@1324 2883 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2884 {
nickjillings@1324 2885 if (ao.specification.type == "reference")
nickjillings@1318 2886 {
nickjillings@1325 2887 if (ao.interfaceDOM.getValue() < (ao.specification.marker/100) && ao.specification.marker > 0) {
nickjillings@1324 2888 // Anchor is not set below
nickjillings@1367 2889 console.log('Reference node not above marker value');
nickjillings@1367 2890 this.storeErrorNode('Reference node not above marker value');
nickjillings@1324 2891 alert('Please keep listening');
nickjillings@1324 2892 return false;
nickjillings@1324 2893 }
nickjillings@1318 2894 }
nickjillings@1318 2895 }
nickjillings@1318 2896 return true;
nickjillings@1318 2897 };
nickjillings@1318 2898
nickjillings@1318 2899 this.checkFragmentsFullyPlayed = function ()
nickjillings@1318 2900 {
nickjillings@1318 2901 // Checks the entire file has been played back
nickjillings@1318 2902 // NOTE ! This will return true IF playback is Looped!!!
nickjillings@1318 2903 if (audioEngineContext.loopPlayback)
nickjillings@1318 2904 {
nickjillings@1318 2905 console.log("WARNING - Looped source: Cannot check fragments are fully played");
nickjillings@1318 2906 return true;
nickjillings@1318 2907 }
nickjillings@1318 2908 var check_pass = true;
nickjillings@1318 2909 var error_obj = [];
nickjillings@1318 2910 for (var i = 0; i<audioEngineContext.audioObjects.length; i++)
nickjillings@1318 2911 {
nickjillings@1318 2912 var object = audioEngineContext.audioObjects[i];
nickjillings@1318 2913 var time = object.buffer.buffer.duration;
nickjillings@1318 2914 var metric = object.metric;
nickjillings@1318 2915 var passed = false;
nickjillings@1318 2916 for (var j=0; j<metric.listenTracker.length; j++)
nickjillings@1318 2917 {
nickjillings@1318 2918 var bt = metric.listenTracker[j].getElementsByTagName('buffertime');
nickjillings@1318 2919 var start_time = Number(bt[0].getAttribute('start'));
nickjillings@1318 2920 var stop_time = Number(bt[0].getAttribute('stop'));
nickjillings@1318 2921 var delta = stop_time - start_time;
nickjillings@1318 2922 if (delta >= time)
nickjillings@1318 2923 {
nickjillings@1318 2924 passed = true;
nickjillings@1318 2925 break;
nickjillings@1318 2926 }
nickjillings@1318 2927 }
nickjillings@1318 2928 if (passed == false)
nickjillings@1318 2929 {
nickjillings@1318 2930 check_pass = false;
nickjillings@1340 2931 console.log("Continue listening to track-"+audioEngineContext.audioObjects.interfaceDOM.getPresentedId());
nickjillings@1340 2932 error_obj.push(audioEngineContext.audioObjects.interfaceDOM.getPresentedId());
nickjillings@1318 2933 }
nickjillings@1318 2934 }
nickjillings@1318 2935 if (check_pass == false)
nickjillings@1318 2936 {
nickjillings@1318 2937 var str_start = "You have not completely listened to fragments ";
nickjillings@1318 2938 for (var i=0; i<error_obj.length; i++)
nickjillings@1318 2939 {
nickjillings@1318 2940 str_start += error_obj[i];
nickjillings@1318 2941 if (i != error_obj.length-1)
nickjillings@1318 2942 {
nickjillings@1318 2943 str_start += ', ';
nickjillings@1318 2944 }
nickjillings@1318 2945 }
nickjillings@1318 2946 str_start += ". Please keep listening";
nickjillings@1318 2947 console.log("[ALERT]: "+str_start);
nickjillings@1367 2948 this.storeErrorNode("[ALERT]: "+str_start);
nickjillings@1318 2949 alert(str_start);
nickjillings@1318 2950 }
nickjillings@1318 2951 };
nickjillings@1318 2952 this.checkAllMoved = function()
nickjillings@1318 2953 {
nickjillings@1318 2954 var str = "You have not moved ";
nickjillings@1318 2955 var failed = [];
nickjillings@1340 2956 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2957 {
nickjillings@1340 2958 if(ao.metric.wasMoved == false && ao.interfaceDOM.canMove() == true)
nickjillings@1318 2959 {
nickjillings@1340 2960 failed.push(ao.interfaceDOM.getPresentedId());
nickjillings@1318 2961 }
nickjillings@1318 2962 }
nickjillings@1318 2963 if (failed.length == 0)
nickjillings@1318 2964 {
nickjillings@1318 2965 return true;
nickjillings@1318 2966 } else if (failed.length == 1)
nickjillings@1318 2967 {
nickjillings@1318 2968 str += 'track '+failed[0];
nickjillings@1318 2969 } else {
nickjillings@1318 2970 str += 'tracks ';
nickjillings@1318 2971 for (var i=0; i<failed.length-1; i++)
nickjillings@1318 2972 {
nickjillings@1318 2973 str += failed[i]+', ';
nickjillings@1318 2974 }
nickjillings@1318 2975 str += 'and '+failed[i];
nickjillings@1318 2976 }
nickjillings@1318 2977 str +='.';
nickjillings@1318 2978 alert(str);
nickjillings@1318 2979 console.log(str);
nickjillings@1367 2980 this.storeErrorNode(str);
nickjillings@1318 2981 return false;
nickjillings@1318 2982 };
nickjillings@1318 2983 this.checkAllPlayed = function()
nickjillings@1318 2984 {
nickjillings@1318 2985 var str = "You have not played ";
nickjillings@1318 2986 var failed = [];
nickjillings@1340 2987 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2988 {
nickjillings@1340 2989 if(ao.metric.wasListenedTo == false)
nickjillings@1318 2990 {
nickjillings@1340 2991 failed.push(ao.interfaceDOM.getPresentedId());
nickjillings@1318 2992 }
nickjillings@1318 2993 }
nickjillings@1318 2994 if (failed.length == 0)
nickjillings@1318 2995 {
nickjillings@1318 2996 return true;
nickjillings@1318 2997 } else if (failed.length == 1)
nickjillings@1318 2998 {
nickjillings@1318 2999 str += 'track '+failed[0];
nickjillings@1318 3000 } else {
nickjillings@1318 3001 str += 'tracks ';
nickjillings@1318 3002 for (var i=0; i<failed.length-1; i++)
nickjillings@1318 3003 {
nickjillings@1318 3004 str += failed[i]+', ';
nickjillings@1318 3005 }
nickjillings@1318 3006 str += 'and '+failed[i];
nickjillings@1318 3007 }
nickjillings@1318 3008 str +='.';
nickjillings@1318 3009 alert(str);
nickjillings@1318 3010 console.log(str);
nickjillings@1367 3011 this.storeErrorNode(str);
nickjillings@1318 3012 return false;
nickjillings@1318 3013 };
nickjillings@1367 3014
nickjillings@1367 3015 this.storeErrorNode = function(errorMessage)
nickjillings@1367 3016 {
nickjillings@1367 3017 var time = audioEngineContext.timer.getTestTime();
nickjillings@1367 3018 var node = storage.document.createElement('error');
nickjillings@1367 3019 node.setAttribute('time',time);
nickjillings@1367 3020 node.textContent = errorMessage;
nickjillings@1367 3021 testState.currentStore.XMLDOM.appendChild(node);
nickjillings@1367 3022 };
nickjillings@1324 3023 }
nickjillings@1324 3024
nickjillings@1324 3025 function Storage()
nickjillings@1324 3026 {
nickjillings@1324 3027 // Holds results in XML format until ready for collection
nickjillings@1324 3028 this.globalPreTest = null;
nickjillings@1324 3029 this.globalPostTest = null;
nickjillings@1324 3030 this.testPages = [];
nickjillings@1324 3031 this.document = document.implementation.createDocument(null,"waetresult");
nickjillings@1324 3032 this.root = this.document.children[0];
nickjillings@1324 3033 this.state = 0;
nickjillings@1324 3034
nickjillings@1324 3035 this.initialise = function()
nickjillings@1324 3036 {
nickjillings@1342 3037 if (specification.preTest != undefined){this.globalPreTest = new this.surveyNode(this,this.root,specification.preTest);}
nickjillings@1342 3038 if (specification.postTest != undefined){this.globalPostTest = new this.surveyNode(this,this.root,specification.postTest);}
nickjillings@1324 3039 };
nickjillings@1324 3040
nickjillings@1324 3041 this.createTestPageStore = function(specification)
nickjillings@1324 3042 {
nickjillings@1324 3043 var store = new this.pageNode(this,specification);
nickjillings@1324 3044 this.testPages.push(store);
nickjillings@1324 3045 return this.testPages[this.testPages.length-1];
nickjillings@1324 3046 };
nickjillings@1324 3047
nickjillings@1324 3048 this.surveyNode = function(parent,root,specification)
nickjillings@1324 3049 {
nickjillings@1324 3050 this.specification = specification;
nickjillings@1324 3051 this.parent = parent;
nickjillings@1324 3052 this.XMLDOM = this.parent.document.createElement('survey');
nickjillings@1324 3053 this.XMLDOM.setAttribute('location',this.specification.location);
nickjillings@1324 3054 for (var optNode of this.specification.options)
nickjillings@1324 3055 {
nickjillings@1324 3056 if (optNode.type != 'statement')
nickjillings@1324 3057 {
nickjillings@1324 3058 var node = this.parent.document.createElement('surveyresult');
nickjillings@1324 3059 node.id = optNode.id;
nickjillings@1324 3060 node.setAttribute('type',optNode.type);
nickjillings@1324 3061 this.XMLDOM.appendChild(node);
nickjillings@1324 3062 }
nickjillings@1324 3063 }
nickjillings@1324 3064 root.appendChild(this.XMLDOM);
nickjillings@1324 3065
nickjillings@1324 3066 this.postResult = function(node)
nickjillings@1324 3067 {
nickjillings@1324 3068 // From popup: node is the popupOption node containing both spec. and results
nickjillings@1324 3069 // ID is the position
nickjillings@1324 3070 if (node.specification.type == 'statement'){return;}
nickjillings@1324 3071 var surveyresult = this.parent.document.getElementById(node.specification.id);
nickjillings@1324 3072 switch(node.specification.type)
nickjillings@1324 3073 {
nickjillings@1324 3074 case "number":
nickjillings@1324 3075 case "question":
nickjillings@1324 3076 var child = this.parent.document.createElement('response');
nickjillings@1324 3077 child.textContent = node.response;
nickjillings@1324 3078 surveyresult.appendChild(child);
nickjillings@1324 3079 break;
nickjillings@1324 3080 case "radio":
nickjillings@1324 3081 var child = this.parent.document.createElement('response');
nickjillings@1324 3082 child.setAttribute('name',node.response.name);
nickjillings@1324 3083 child.textContent = node.response.text;
nickjillings@1324 3084 surveyresult.appendChild(child);
nickjillings@1324 3085 break;
nickjillings@1324 3086 case "checkbox":
nickjillings@1324 3087 for (var i=0; i<node.response.length; i++)
nickjillings@1324 3088 {
nickjillings@1324 3089 var checkNode = this.parent.document.createElement('response');
nickjillings@1347 3090 checkNode.setAttribute('name',node.response[i].name);
nickjillings@1347 3091 checkNode.setAttribute('checked',node.response[i].checked);
nickjillings@1326 3092 surveyresult.appendChild(checkNode);
nickjillings@1324 3093 }
nickjillings@1324 3094 break;
nickjillings@1324 3095 }
nickjillings@1324 3096 };
nickjillings@1324 3097 };
nickjillings@1324 3098
nickjillings@1324 3099 this.pageNode = function(parent,specification)
nickjillings@1324 3100 {
nickjillings@1324 3101 // Create one store per test page
nickjillings@1324 3102 this.specification = specification;
nickjillings@1324 3103 this.parent = parent;
nickjillings@1324 3104 this.XMLDOM = this.parent.document.createElement('page');
nickjillings@1324 3105 this.XMLDOM.setAttribute('id',specification.id);
nickjillings@1324 3106 this.XMLDOM.setAttribute('presentedId',specification.presentedId);
nickjillings@1345 3107 if (specification.preTest != undefined){this.preTest = new this.parent.surveyNode(this.parent,this.XMLDOM,this.specification.preTest);}
nickjillings@1345 3108 if (specification.postTest != undefined){this.postTest = new this.parent.surveyNode(this.parent,this.XMLDOM,this.specification.postTest);}
nickjillings@1324 3109
nickjillings@1324 3110 // Add any page metrics
nickjillings@1324 3111 var page_metric = this.parent.document.createElement('metric');
nickjillings@1324 3112 this.XMLDOM.appendChild(page_metric);
nickjillings@1324 3113
nickjillings@1324 3114 // Add the audioelement
nickjillings@1324 3115 for (var element of this.specification.audioElements)
nickjillings@1324 3116 {
nickjillings@1324 3117 var aeNode = this.parent.document.createElement('audioelement');
nickjillings@1324 3118 aeNode.id = element.id;
nickjillings@1324 3119 aeNode.setAttribute('type',element.type);
nickjillings@1324 3120 aeNode.setAttribute('url', element.url);
nickjillings@1324 3121 aeNode.setAttribute('gain', element.gain);
nickjillings@1324 3122 if (element.type == 'anchor' || element.type == 'reference')
nickjillings@1324 3123 {
nickjillings@1324 3124 if (element.marker > 0)
nickjillings@1324 3125 {
nickjillings@1324 3126 aeNode.setAttribute('marker',element.marker);
nickjillings@1324 3127 }
nickjillings@1324 3128 }
nickjillings@1324 3129 var ae_metric = this.parent.document.createElement('metric');
nickjillings@1324 3130 aeNode.appendChild(ae_metric);
nickjillings@1324 3131 this.XMLDOM.appendChild(aeNode);
nickjillings@1324 3132 }
nickjillings@1324 3133
nickjillings@1324 3134 // Add any commentQuestions
nickjillings@1324 3135 for (var element of this.specification.commentQuestions)
nickjillings@1324 3136 {
nickjillings@1324 3137 var cqNode = this.parent.document.createElement('commentquestion');
nickjillings@1324 3138 cqNode.id = element.id;
nickjillings@1324 3139 cqNode.setAttribute('type',element.type);
nickjillings@1324 3140 var statement = this.parent.document.createElement('statement');
nickjillings@1324 3141 statement.textContent = cqNode.statement;
nickjillings@1324 3142 cqNode.appendChild(statement);
nickjillings@1324 3143 var response = this.parent.document.createElement('response');
nickjillings@1324 3144 cqNode.appendChild(response);
nickjillings@1324 3145 this.XMLDOM.appendChild(cqNode);
nickjillings@1324 3146 }
nickjillings@1324 3147
nickjillings@1324 3148 this.parent.root.appendChild(this.XMLDOM);
nickjillings@1324 3149 };
nickjillings@1324 3150 this.finish = function()
nickjillings@1324 3151 {
nickjillings@1324 3152 if (this.state == 0)
nickjillings@1324 3153 {
nickjillings@1324 3154 var projectDocument = specification.projectXML;
nickjillings@1324 3155 projectDocument.setAttribute('file-name',url);
nickjillings@1324 3156 this.root.appendChild(projectDocument);
nickjillings@1324 3157 this.root.appendChild(returnDateNode());
nickjillings@1324 3158 this.root.appendChild(interfaceContext.returnNavigator());
nickjillings@1324 3159 }
nickjillings@1324 3160 this.state = 1;
nickjillings@1324 3161 return this.root;
nickjillings@1324 3162 };
nickjillings@1324 3163 }