annotate core.js @ 491:261ae55a3e9e Dev_main

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