annotate core.js @ 793:261d92ea87e1

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