annotate core.js @ 410:6be81817d142 Dev_main

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