annotate core.js @ 501:9a8ede168aba Dev_main

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