annotate core.js @ 539:4a69b3ba474d Dev_main

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