annotate core.js @ 1514:16e9ac82e8b0

Added mushra interface. Also added instructions for building your own interface (working copy).
author Nicholas Jillings <nickjillings@users.noreply.github.com>
date Tue, 28 Jul 2015 12:00:46 +0100
parents a2ba4db3fdb6
children f86d75be0d56
rev   line source
nickjillings@1512 1 /**
nickjillings@1512 2 * core.js
nickjillings@1512 3 *
nickjillings@1512 4 * Main script to run, calls all other core functions and manages loading/store to backend.
nickjillings@1512 5 * Also contains all global variables.
nickjillings@1512 6 */
nickjillings@1512 7
nickjillings@1512 8 /* create the web audio API context and store in audioContext*/
nickjillings@1512 9 var audioContext; // Hold the browser web audio API
nickjillings@1512 10 var projectXML; // Hold the parsed setup XML
nickjillings@1512 11 var specification;
nickjillings@1512 12 var interfaceContext;
nickjillings@1512 13 var popup; // Hold the interfacePopup object
nickjillings@1512 14 var testState;
nickjillings@1512 15 var currentTrackOrder = []; // Hold the current XML tracks in their (randomised) order
nickjillings@1512 16 var audioEngineContext; // The custome AudioEngine object
nickjillings@1512 17 var projectReturn; // Hold the URL for the return
nickjillings@1512 18
nickjillings@1512 19
nickjillings@1512 20 // Add a prototype to the bufferSourceNode to reference to the audioObject holding it
nickjillings@1512 21 AudioBufferSourceNode.prototype.owner = undefined;
nickjillings@1512 22
nickjillings@1512 23 window.onload = function() {
nickjillings@1512 24 // Function called once the browser has loaded all files.
nickjillings@1512 25 // This should perform any initial commands such as structure / loading documents
nickjillings@1512 26
nickjillings@1512 27 // Create a web audio API context
nickjillings@1512 28 // Fixed for cross-browser support
nickjillings@1512 29 var AudioContext = window.AudioContext || window.webkitAudioContext;
nickjillings@1512 30 audioContext = new AudioContext;
nickjillings@1512 31
nickjillings@1512 32 // Create test state
nickjillings@1512 33 testState = new stateMachine();
nickjillings@1512 34
nickjillings@1512 35 // Create the audio engine object
nickjillings@1512 36 audioEngineContext = new AudioEngine();
nickjillings@1512 37
nickjillings@1512 38 // Create the popup interface object
nickjillings@1512 39 popup = new interfacePopup();
nickjillings@1512 40
nickjillings@1512 41 // Create the specification object
nickjillings@1512 42 specification = new Specification();
nickjillings@1512 43
nickjillings@1512 44 // Create the interface object
nickjillings@1512 45 interfaceContext = new Interface(specification);
nickjillings@1512 46 };
nickjillings@1512 47
nickjillings@1512 48 function interfacePopup() {
nickjillings@1512 49 // Creates an object to manage the popup
nickjillings@1512 50 this.popup = null;
nickjillings@1512 51 this.popupContent = null;
nickjillings@1512 52 this.buttonProceed = null;
nickjillings@1512 53 this.buttonPrevious = null;
nickjillings@1512 54 this.popupOptions = null;
nickjillings@1512 55 this.currentIndex = null;
nickjillings@1512 56 this.responses = null;
nickjillings@1512 57
nickjillings@1512 58 this.createPopup = function(){
nickjillings@1512 59 // Create popup window interface
nickjillings@1512 60 var insertPoint = document.getElementById("topLevelBody");
nickjillings@1512 61 var blank = document.createElement('div');
nickjillings@1512 62 blank.className = 'testHalt';
nickjillings@1512 63
nickjillings@1512 64 this.popup = document.createElement('div');
nickjillings@1512 65 this.popup.id = 'popupHolder';
nickjillings@1512 66 this.popup.className = 'popupHolder';
nickjillings@1512 67 this.popup.style.position = 'absolute';
nickjillings@1512 68 this.popup.style.left = (window.innerWidth/2)-250 + 'px';
nickjillings@1512 69 this.popup.style.top = (window.innerHeight/2)-125 + 'px';
nickjillings@1512 70
nickjillings@1512 71 this.popupContent = document.createElement('div');
nickjillings@1512 72 this.popupContent.id = 'popupContent';
nickjillings@1512 73 this.popupContent.style.marginTop = '25px';
nickjillings@1512 74 this.popupContent.align = 'center';
nickjillings@1512 75 this.popup.appendChild(this.popupContent);
nickjillings@1512 76
nickjillings@1512 77 this.buttonProceed = document.createElement('button');
nickjillings@1512 78 this.buttonProceed.className = 'popupButton';
nickjillings@1512 79 this.buttonProceed.style.left = '440px';
nickjillings@1512 80 this.buttonProceed.style.top = '215px';
nickjillings@1512 81 this.buttonProceed.innerHTML = 'Next';
nickjillings@1512 82 this.buttonProceed.onclick = function(){popup.proceedClicked();};
nickjillings@1512 83
nickjillings@1512 84 this.buttonPrevious = document.createElement('button');
nickjillings@1512 85 this.buttonPrevious.className = 'popupButton';
nickjillings@1512 86 this.buttonPrevious.style.left = '10px';
nickjillings@1512 87 this.buttonPrevious.style.top = '215px';
nickjillings@1512 88 this.buttonPrevious.innerHTML = 'Back';
nickjillings@1512 89 this.buttonPrevious.onclick = function(){popup.previousClick();};
nickjillings@1512 90
nickjillings@1512 91 this.popup.style.zIndex = -1;
nickjillings@1512 92 this.popup.style.visibility = 'hidden';
nickjillings@1512 93 blank.style.zIndex = -2;
nickjillings@1512 94 blank.style.visibility = 'hidden';
nickjillings@1512 95 insertPoint.appendChild(this.popup);
nickjillings@1512 96 insertPoint.appendChild(blank);
nickjillings@1512 97 };
nickjillings@1512 98
nickjillings@1512 99 this.showPopup = function(){
nickjillings@1512 100 if (this.popup == null) {
nickjillings@1512 101 this.createPopup();
nickjillings@1512 102 }
nickjillings@1512 103 this.popup.style.zIndex = 3;
nickjillings@1512 104 this.popup.style.visibility = 'visible';
nickjillings@1512 105 var blank = document.getElementsByClassName('testHalt')[0];
nickjillings@1512 106 blank.style.zIndex = 2;
nickjillings@1512 107 blank.style.visibility = 'visible';
nickjillings@1512 108 $(window).keypress(function(e){
nickjillings@1512 109 if (e.keyCode == 13 && popup.popup.style.visibility == 'visible')
nickjillings@1512 110 {
nickjillings@1512 111 // Enter key pressed
nickjillings@1512 112 var textarea = $(popup.popupContent).find('textarea');
nickjillings@1512 113 if (textarea.length != 0)
nickjillings@1512 114 {
nickjillings@1512 115 if (textarea[0] == document.activeElement)
nickjillings@1512 116 {return;}
nickjillings@1512 117 }
nickjillings@1512 118 popup.buttonProceed.onclick();
nickjillings@1512 119 }
nickjillings@1512 120 });
nickjillings@1512 121 };
nickjillings@1512 122
nickjillings@1512 123 this.hidePopup = function(){
nickjillings@1512 124 this.popup.style.zIndex = -1;
nickjillings@1512 125 this.popup.style.visibility = 'hidden';
nickjillings@1512 126 var blank = document.getElementsByClassName('testHalt')[0];
nickjillings@1512 127 blank.style.zIndex = -2;
nickjillings@1512 128 blank.style.visibility = 'hidden';
nickjillings@1512 129 };
nickjillings@1512 130
nickjillings@1512 131 this.postNode = function() {
nickjillings@1512 132 // This will take the node from the popupOptions and display it
nickjillings@1512 133 var node = this.popupOptions[this.currentIndex];
nickjillings@1512 134 this.popupContent.innerHTML = null;
nickjillings@1512 135 if (node.type == 'statement') {
nickjillings@1512 136 var span = document.createElement('span');
nickjillings@1512 137 span.textContent = node.statement;
nickjillings@1512 138 this.popupContent.appendChild(span);
nickjillings@1512 139 } else if (node.type == 'question') {
nickjillings@1512 140 var span = document.createElement('span');
nickjillings@1512 141 span.textContent = node.question;
nickjillings@1512 142 var textArea = document.createElement('textarea');
nickjillings@1512 143 switch (node.boxsize) {
nickjillings@1512 144 case 'small':
nickjillings@1512 145 textArea.cols = "20";
nickjillings@1512 146 textArea.rows = "1";
nickjillings@1512 147 break;
nickjillings@1512 148 case 'normal':
nickjillings@1512 149 textArea.cols = "30";
nickjillings@1512 150 textArea.rows = "2";
nickjillings@1512 151 break;
nickjillings@1512 152 case 'large':
nickjillings@1512 153 textArea.cols = "40";
nickjillings@1512 154 textArea.rows = "5";
nickjillings@1512 155 break;
nickjillings@1512 156 case 'huge':
nickjillings@1512 157 textArea.cols = "50";
nickjillings@1512 158 textArea.rows = "10";
nickjillings@1512 159 break;
nickjillings@1512 160 }
nickjillings@1512 161 var br = document.createElement('br');
nickjillings@1512 162 this.popupContent.appendChild(span);
nickjillings@1512 163 this.popupContent.appendChild(br);
nickjillings@1512 164 this.popupContent.appendChild(textArea);
nickjillings@1512 165 this.popupContent.childNodes[2].focus();
nickjillings@1512 166 } else if (node.type == 'checkbox') {
nickjillings@1512 167 var span = document.createElement('span');
nickjillings@1512 168 span.textContent = node.statement;
nickjillings@1512 169 this.popupContent.appendChild(span);
nickjillings@1512 170 var optHold = document.createElement('div');
nickjillings@1512 171 optHold.id = 'option-holder';
nickjillings@1512 172 optHold.align = 'left';
nickjillings@1512 173 for (var i=0; i<node.options.length; i++) {
nickjillings@1512 174 var option = node.options[i];
nickjillings@1512 175 var input = document.createElement('input');
nickjillings@1512 176 input.id = option.id;
nickjillings@1512 177 input.type = 'checkbox';
nickjillings@1512 178 var span = document.createElement('span');
nickjillings@1512 179 span.textContent = option.text;
nickjillings@1512 180 var hold = document.createElement('div');
nickjillings@1512 181 hold.setAttribute('name','option');
nickjillings@1512 182 hold.style.float = 'left';
nickjillings@1512 183 hold.style.padding = '4px';
nickjillings@1512 184 hold.appendChild(input);
nickjillings@1512 185 hold.appendChild(span);
nickjillings@1512 186 optHold.appendChild(hold);
nickjillings@1512 187 }
nickjillings@1512 188 this.popupContent.appendChild(optHold);
nickjillings@1512 189 } else if (node.type == 'radio') {
nickjillings@1512 190 var span = document.createElement('span');
nickjillings@1512 191 span.textContent = node.statement;
nickjillings@1512 192 this.popupContent.appendChild(span);
nickjillings@1512 193 var optHold = document.createElement('div');
nickjillings@1512 194 optHold.id = 'option-holder';
nickjillings@1512 195 optHold.align = 'none';
nickjillings@1512 196 optHold.style.float = 'left';
nickjillings@1512 197 optHold.style.width = "100%";
nickjillings@1512 198 for (var i=0; i<node.options.length; i++) {
nickjillings@1512 199 var option = node.options[i];
nickjillings@1512 200 var input = document.createElement('input');
nickjillings@1512 201 input.id = option.name;
nickjillings@1512 202 input.type = 'radio';
nickjillings@1512 203 input.name = node.id;
nickjillings@1512 204 var span = document.createElement('span');
nickjillings@1512 205 span.textContent = option.text;
nickjillings@1512 206 var hold = document.createElement('div');
nickjillings@1512 207 hold.setAttribute('name','option');
nickjillings@1512 208 hold.style.padding = '4px';
nickjillings@1512 209 hold.appendChild(input);
nickjillings@1512 210 hold.appendChild(span);
nickjillings@1512 211 optHold.appendChild(hold);
nickjillings@1512 212 }
nickjillings@1512 213 this.popupContent.appendChild(optHold);
nickjillings@1512 214 } else if (node.type == 'number') {
nickjillings@1512 215 var span = document.createElement('span');
nickjillings@1512 216 span.textContent = node.statement;
nickjillings@1512 217 this.popupContent.appendChild(span);
nickjillings@1512 218 this.popupContent.appendChild(document.createElement('br'));
nickjillings@1512 219 var input = document.createElement('input');
nickjillings@1512 220 input.type = 'textarea';
nickjillings@1512 221 if (node.min != null) {input.min = node.min;}
nickjillings@1512 222 if (node.max != null) {input.max = node.max;}
nickjillings@1512 223 if (node.step != null) {input.step = node.step;}
nickjillings@1512 224 this.popupContent.appendChild(input);
nickjillings@1512 225 }
nickjillings@1512 226 this.popupContent.appendChild(this.buttonProceed);
nickjillings@1512 227 if(this.currentIndex+1 == this.popupOptions.length) {
nickjillings@1512 228 if (this.responses.nodeName == "PRETEST") {
nickjillings@1512 229 this.buttonProceed.textContent = 'Start';
nickjillings@1512 230 } else {
nickjillings@1512 231 this.buttonProceed.textContent = 'Submit';
nickjillings@1512 232 }
nickjillings@1512 233 } else {
nickjillings@1512 234 this.buttonProceed.textContent = 'Next';
nickjillings@1512 235 }
nickjillings@1512 236 if(this.currentIndex > 0)
nickjillings@1512 237 this.popupContent.appendChild(this.buttonPrevious);
nickjillings@1512 238 };
nickjillings@1512 239
nickjillings@1512 240 this.initState = function(node) {
nickjillings@1512 241 //Call this with your preTest and postTest nodes when needed to
nickjillings@1512 242 // initialise the popup procedure.
nickjillings@1512 243 this.popupOptions = node.options;
nickjillings@1512 244 if (this.popupOptions.length > 0) {
nickjillings@1512 245 if (node.type == 'pretest') {
nickjillings@1512 246 this.responses = document.createElement('PreTest');
nickjillings@1512 247 } else if (node.type == 'posttest') {
nickjillings@1512 248 this.responses = document.createElement('PostTest');
nickjillings@1512 249 } else {
nickjillings@1512 250 console.log ('WARNING - popup node neither pre or post!');
nickjillings@1512 251 this.responses = document.createElement('responses');
nickjillings@1512 252 }
nickjillings@1512 253 this.currentIndex = 0;
nickjillings@1512 254 this.showPopup();
nickjillings@1512 255 this.postNode();
nickjillings@1512 256 } else {
nickjillings@1512 257 advanceState();
nickjillings@1512 258 }
nickjillings@1512 259 };
nickjillings@1512 260
nickjillings@1512 261 this.proceedClicked = function() {
nickjillings@1512 262 // Each time the popup button is clicked!
nickjillings@1512 263 var node = this.popupOptions[this.currentIndex];
nickjillings@1512 264 if (node.type == 'question') {
nickjillings@1512 265 // Must extract the question data
nickjillings@1512 266 var textArea = $(popup.popupContent).find('textarea')[0];
nickjillings@1512 267 if (node.mandatory == true && textArea.value.length == 0) {
nickjillings@1512 268 alert('This question is mandatory');
nickjillings@1512 269 return;
nickjillings@1512 270 } else {
nickjillings@1512 271 // Save the text content
nickjillings@1512 272 var hold = document.createElement('comment');
nickjillings@1512 273 hold.id = node.id;
nickjillings@1512 274 hold.innerHTML = textArea.value;
nickjillings@1512 275 console.log("Question: "+ node.question);
nickjillings@1512 276 console.log("Question Response: "+ textArea.value);
nickjillings@1512 277 this.responses.appendChild(hold);
nickjillings@1512 278 }
nickjillings@1512 279 } else if (node.type == 'checkbox') {
nickjillings@1512 280 // Must extract checkbox data
nickjillings@1512 281 var optHold = document.getElementById('option-holder');
nickjillings@1512 282 var hold = document.createElement('checkbox');
nickjillings@1512 283 console.log("Checkbox: "+ node.statement);
nickjillings@1512 284 hold.id = node.id;
nickjillings@1512 285 for (var i=0; i<optHold.childElementCount; i++) {
nickjillings@1512 286 var input = optHold.childNodes[i].getElementsByTagName('input')[0];
nickjillings@1512 287 var statement = optHold.childNodes[i].getElementsByTagName('span')[0];
nickjillings@1512 288 var response = document.createElement('option');
nickjillings@1512 289 response.setAttribute('name',input.id);
nickjillings@1512 290 response.textContent = input.checked;
nickjillings@1512 291 hold.appendChild(response);
nickjillings@1512 292 console.log(input.id +': '+ input.checked);
nickjillings@1512 293 }
nickjillings@1512 294 this.responses.appendChild(hold);
nickjillings@1512 295 } else if (node.type == "radio") {
nickjillings@1512 296 var optHold = document.getElementById('option-holder');
nickjillings@1512 297 var hold = document.createElement('radio');
nickjillings@1512 298 var responseID = null;
nickjillings@1512 299 var i=0;
nickjillings@1512 300 while(responseID == null) {
nickjillings@1512 301 var input = optHold.childNodes[i].getElementsByTagName('input')[0];
nickjillings@1512 302 if (input.checked == true) {
nickjillings@1512 303 responseID = i;
nickjillings@1512 304 }
nickjillings@1512 305 i++;
nickjillings@1512 306 }
nickjillings@1512 307 hold.id = node.id;
nickjillings@1512 308 hold.setAttribute('name',node.options[responseID].name);
nickjillings@1512 309 hold.textContent = node.options[responseID].text;
nickjillings@1512 310 this.responses.appendChild(hold);
nickjillings@1512 311 } else if (node.type == "number") {
nickjillings@1512 312 var input = this.popupContent.getElementsByTagName('input')[0];
nickjillings@1512 313 if (node.mandatory == true && input.value.length == 0) {
nickjillings@1512 314 alert('This question is mandatory. Please enter a number');
nickjillings@1512 315 return;
nickjillings@1512 316 }
nickjillings@1512 317 var enteredNumber = Number(input.value);
nickjillings@1512 318 if (isNaN(enteredNumber)) {
nickjillings@1512 319 alert('Please enter a valid number');
nickjillings@1512 320 return;
nickjillings@1512 321 }
nickjillings@1512 322 if (enteredNumber < node.min && node.min != null) {
nickjillings@1512 323 alert('Number is below the minimum value of '+node.min);
nickjillings@1512 324 return;
nickjillings@1512 325 }
nickjillings@1512 326 if (enteredNumber > node.max && node.max != null) {
nickjillings@1512 327 alert('Number is above the maximum value of '+node.max);
nickjillings@1512 328 return;
nickjillings@1512 329 }
nickjillings@1512 330 var hold = document.createElement('number');
nickjillings@1512 331 hold.id = node.id;
nickjillings@1512 332 hold.textContent = input.value;
nickjillings@1512 333 this.responses.appendChild(hold);
nickjillings@1512 334 }
nickjillings@1512 335 this.currentIndex++;
nickjillings@1512 336 if (this.currentIndex < this.popupOptions.length) {
nickjillings@1512 337 this.postNode();
nickjillings@1512 338 } else {
nickjillings@1512 339 // Reached the end of the popupOptions
nickjillings@1512 340 this.hidePopup();
nickjillings@1512 341 if (this.responses.nodeName == testState.stateResults[testState.stateIndex].nodeName) {
nickjillings@1512 342 testState.stateResults[testState.stateIndex] = this.responses;
nickjillings@1512 343 } else {
nickjillings@1512 344 testState.stateResults[testState.stateIndex].appendChild(this.responses);
nickjillings@1512 345 }
nickjillings@1512 346 advanceState();
nickjillings@1512 347 }
nickjillings@1512 348 };
nickjillings@1512 349
nickjillings@1512 350 this.previousClick = function() {
nickjillings@1512 351 // Triggered when the 'Back' button is clicked in the survey
nickjillings@1512 352 if (this.currentIndex > 0) {
nickjillings@1512 353 this.currentIndex--;
nickjillings@1512 354 var node = this.popupOptions[this.currentIndex];
nickjillings@1512 355 if (node.type != 'statement') {
nickjillings@1512 356 var prevResp = this.responses.childNodes[this.responses.childElementCount-1];
nickjillings@1512 357 this.responses.removeChild(prevResp);
nickjillings@1512 358 }
nickjillings@1512 359 this.postNode();
nickjillings@1512 360 if (node.type == 'question') {
nickjillings@1512 361 this.popupContent.getElementsByTagName('textarea')[0].value = prevResp.textContent;
nickjillings@1512 362 } else if (node.type == 'checkbox') {
nickjillings@1512 363 var options = this.popupContent.getElementsByTagName('input');
nickjillings@1512 364 var savedOptions = prevResp.getElementsByTagName('option');
nickjillings@1512 365 for (var i=0; i<options.length; i++) {
nickjillings@1512 366 var id = options[i].id;
nickjillings@1512 367 for (var j=0; j<savedOptions.length; j++) {
nickjillings@1512 368 if (savedOptions[j].getAttribute('name') == id) {
nickjillings@1512 369 if (savedOptions[j].textContent == 'true') {options[i].checked = true;}
nickjillings@1512 370 else {options[i].checked = false;}
nickjillings@1512 371 break;
nickjillings@1512 372 }
nickjillings@1512 373 }
nickjillings@1512 374 }
nickjillings@1512 375 } else if (node.type == 'number') {
nickjillings@1512 376 this.popupContent.getElementsByTagName('input')[0].value = prevResp.textContent;
nickjillings@1512 377 } else if (node.type == 'radio') {
nickjillings@1512 378 var options = this.popupContent.getElementsByTagName('input');
nickjillings@1512 379 var name = prevResp.getAttribute('name');
nickjillings@1512 380 for (var i=0; i<options.length; i++) {
nickjillings@1512 381 if (options[i].id == name) {
nickjillings@1512 382 options[i].checked = true;
nickjillings@1512 383 break;
nickjillings@1512 384 }
nickjillings@1512 385 }
nickjillings@1512 386 }
nickjillings@1512 387 }
nickjillings@1512 388 };
nickjillings@1512 389 }
nickjillings@1512 390
nickjillings@1512 391 function advanceState()
nickjillings@1512 392 {
nickjillings@1512 393 // Just for complete clarity
nickjillings@1512 394 testState.advanceState();
nickjillings@1512 395 }
nickjillings@1512 396
nickjillings@1512 397 function stateMachine()
nickjillings@1512 398 {
nickjillings@1512 399 // Object prototype for tracking and managing the test state
nickjillings@1512 400 this.stateMap = [];
nickjillings@1512 401 this.stateIndex = null;
nickjillings@1512 402 this.currentStateMap = [];
nickjillings@1512 403 this.currentIndex = null;
nickjillings@1512 404 this.currentTestId = 0;
nickjillings@1512 405 this.stateResults = [];
nickjillings@1512 406 this.timerCallBackHolders = null;
nickjillings@1512 407 this.initialise = function(){
nickjillings@1512 408 if (this.stateMap.length > 0) {
nickjillings@1512 409 if(this.stateIndex != null) {
nickjillings@1512 410 console.log('NOTE - State already initialise');
nickjillings@1512 411 }
nickjillings@1512 412 this.stateIndex = -1;
nickjillings@1512 413 var that = this;
nickjillings@1512 414 var aH_pId = 0;
nickjillings@1512 415 for (var id=0; id<this.stateMap.length; id++){
nickjillings@1512 416 var name = this.stateMap[id].type;
nickjillings@1512 417 var obj = document.createElement(name);
nickjillings@1512 418 if (name == 'audioHolder') {
nickjillings@1512 419 obj.id = this.stateMap[id].id;
nickjillings@1512 420 obj.setAttribute('presentedid',aH_pId);
nickjillings@1512 421 aH_pId+=1;
nickjillings@1512 422 }
nickjillings@1512 423 this.stateResults.push(obj);
nickjillings@1512 424 }
nickjillings@1512 425 } else {
nickjillings@1512 426 console.log('FATAL - StateMap not correctly constructed. EMPTY_STATE_MAP');
nickjillings@1512 427 }
nickjillings@1512 428 };
nickjillings@1512 429 this.advanceState = function(){
nickjillings@1512 430 if (this.stateIndex == null) {
nickjillings@1512 431 this.initialise();
nickjillings@1512 432 }
nickjillings@1512 433 if (this.stateIndex == -1) {
nickjillings@1512 434 console.log('Starting test...');
nickjillings@1512 435 }
nickjillings@1512 436 if (this.currentIndex == null){
nickjillings@1512 437 if (this.currentStateMap.type == "audioHolder") {
nickjillings@1512 438 // Save current page
nickjillings@1512 439 this.testPageCompleted(this.stateResults[this.stateIndex],this.currentStateMap,this.currentTestId);
nickjillings@1512 440 this.currentTestId++;
nickjillings@1512 441 }
nickjillings@1512 442 this.stateIndex++;
nickjillings@1512 443 if (this.stateIndex >= this.stateMap.length) {
nickjillings@1512 444 console.log('Test Completed');
nickjillings@1512 445 createProjectSave(specification.projectReturn);
nickjillings@1512 446 } else {
nickjillings@1512 447 this.currentStateMap = this.stateMap[this.stateIndex];
nickjillings@1512 448 if (this.currentStateMap.type == "audioHolder") {
nickjillings@1512 449 console.log('Loading test page');
nickjillings@1512 450 loadTest(this.currentStateMap);
nickjillings@1512 451 this.initialiseInnerState(this.currentStateMap);
nickjillings@1512 452 } else if (this.currentStateMap.type == "pretest" || this.currentStateMap.type == "posttest") {
nickjillings@1512 453 if (this.currentStateMap.options.length >= 1) {
nickjillings@1512 454 popup.initState(this.currentStateMap);
nickjillings@1512 455 } else {
nickjillings@1512 456 this.advanceState();
nickjillings@1512 457 }
nickjillings@1512 458 } else {
nickjillings@1512 459 this.advanceState();
nickjillings@1512 460 }
nickjillings@1512 461 }
nickjillings@1512 462 } else {
nickjillings@1512 463 this.advanceInnerState();
nickjillings@1512 464 }
nickjillings@1512 465 };
nickjillings@1512 466
nickjillings@1512 467 this.testPageCompleted = function(store, testXML, testId) {
nickjillings@1512 468 // Function called each time a test page has been completed
nickjillings@1512 469 // Can be used to over-rule default behaviour
nickjillings@1512 470
nickjillings@1512 471 pageXMLSave(store, testXML);
nickjillings@1512 472 };
nickjillings@1512 473
nickjillings@1512 474 this.initialiseInnerState = function(node) {
nickjillings@1512 475 // Parses the received testXML for pre and post test options
nickjillings@1512 476 this.currentStateMap = [];
nickjillings@1512 477 var preTest = node.preTest;
nickjillings@1512 478 var postTest = node.postTest;
nickjillings@1512 479 if (preTest == undefined) {preTest = document.createElement("preTest");}
nickjillings@1512 480 if (postTest == undefined){postTest= document.createElement("postTest");}
nickjillings@1512 481 this.currentStateMap.push(preTest);
nickjillings@1512 482 this.currentStateMap.push(node);
nickjillings@1512 483 this.currentStateMap.push(postTest);
nickjillings@1512 484 this.currentIndex = -1;
nickjillings@1512 485 this.advanceInnerState();
nickjillings@1512 486 };
nickjillings@1512 487
nickjillings@1512 488 this.advanceInnerState = function() {
nickjillings@1512 489 this.currentIndex++;
nickjillings@1512 490 if (this.currentIndex >= this.currentStateMap.length) {
nickjillings@1512 491 this.currentIndex = null;
nickjillings@1512 492 this.currentStateMap = this.stateMap[this.stateIndex];
nickjillings@1512 493 this.advanceState();
nickjillings@1512 494 } else {
nickjillings@1512 495 if (this.currentStateMap[this.currentIndex].type == "audioHolder") {
nickjillings@1512 496 console.log("Loading test page"+this.currentTestId);
nickjillings@1512 497 } else if (this.currentStateMap[this.currentIndex].type == "pretest") {
nickjillings@1512 498 popup.initState(this.currentStateMap[this.currentIndex]);
nickjillings@1512 499 } else if (this.currentStateMap[this.currentIndex].type == "posttest") {
nickjillings@1512 500 popup.initState(this.currentStateMap[this.currentIndex]);
nickjillings@1512 501 } else {
nickjillings@1512 502 this.advanceInnerState();
nickjillings@1512 503 }
nickjillings@1512 504 }
nickjillings@1512 505 };
nickjillings@1512 506
nickjillings@1512 507 this.previousState = function(){};
nickjillings@1512 508 }
nickjillings@1512 509
nickjillings@1512 510 function testEnded(testId)
nickjillings@1512 511 {
nickjillings@1512 512 pageXMLSave(testId);
nickjillings@1512 513 if (testXMLSetups.length-1 > testId)
nickjillings@1512 514 {
nickjillings@1512 515 // Yes we have another test to perform
nickjillings@1512 516 testId = (Number(testId)+1);
nickjillings@1512 517 currentState = 'testRun-'+testId;
nickjillings@1512 518 loadTest(testId);
nickjillings@1512 519 } else {
nickjillings@1512 520 console.log('Testing Completed!');
nickjillings@1512 521 currentState = 'postTest';
nickjillings@1512 522 // Check for any post tests
nickjillings@1512 523 var xmlSetup = projectXML.find('setup');
nickjillings@1512 524 var postTest = xmlSetup.find('PostTest')[0];
nickjillings@1512 525 popup.initState(postTest);
nickjillings@1512 526 }
nickjillings@1512 527 }
nickjillings@1512 528
nickjillings@1512 529 function loadProjectSpec(url) {
nickjillings@1512 530 // Load the project document from the given URL, decode the XML and instruct audioEngine to get audio data
nickjillings@1512 531 // If url is null, request client to upload project XML document
nickjillings@1512 532 var r = new XMLHttpRequest();
nickjillings@1512 533 r.open('GET',url,true);
nickjillings@1512 534 r.onload = function() {
nickjillings@1512 535 loadProjectSpecCallback(r.response);
nickjillings@1512 536 };
nickjillings@1512 537 r.send();
nickjillings@1512 538 };
nickjillings@1512 539
nickjillings@1512 540 function loadProjectSpecCallback(response) {
nickjillings@1512 541 // Function called after asynchronous download of XML project specification
nickjillings@1512 542 //var decode = $.parseXML(response);
nickjillings@1512 543 //projectXML = $(decode);
nickjillings@1512 544
nickjillings@1512 545 var parse = new DOMParser();
nickjillings@1512 546 projectXML = parse.parseFromString(response,'text/xml');
nickjillings@1512 547
nickjillings@1512 548 // Build the specification
nickjillings@1512 549 specification.decode();
nickjillings@1512 550
nickjillings@1512 551 testState.stateMap.push(specification.preTest);
nickjillings@1512 552
nickjillings@1512 553 // New check if we need to randomise the test order
nickjillings@1512 554 if (specification.randomiseOrder)
nickjillings@1512 555 {
nickjillings@1512 556 specification.audioHolders = randomiseOrder(specification.audioHolders);
nickjillings@1512 557 for (var i=0; i<specification.audioHolders.length; i++)
nickjillings@1512 558 {
nickjillings@1512 559 specification.audioHolders[i].presentedId = i;
nickjillings@1512 560 }
nickjillings@1512 561 }
nickjillings@1512 562
nickjillings@1512 563 $(specification.audioHolders).each(function(index,elem){
nickjillings@1512 564 testState.stateMap.push(elem);
nickjillings@1512 565 });
nickjillings@1512 566
nickjillings@1512 567 testState.stateMap.push(specification.postTest);
nickjillings@1512 568
nickjillings@1512 569 // Obtain the metrics enabled
nickjillings@1512 570 $(specification.metrics).each(function(index,node){
nickjillings@1512 571 var enabled = node.textContent;
nickjillings@1512 572 switch(node.enabled)
nickjillings@1512 573 {
nickjillings@1512 574 case 'testTimer':
nickjillings@1512 575 sessionMetrics.prototype.enableTestTimer = true;
nickjillings@1512 576 break;
nickjillings@1512 577 case 'elementTimer':
nickjillings@1512 578 sessionMetrics.prototype.enableElementTimer = true;
nickjillings@1512 579 break;
nickjillings@1512 580 case 'elementTracker':
nickjillings@1512 581 sessionMetrics.prototype.enableElementTracker = true;
nickjillings@1512 582 break;
nickjillings@1512 583 case 'elementListenTracker':
nickjillings@1512 584 sessionMetrics.prototype.enableElementListenTracker = true;
nickjillings@1512 585 break;
nickjillings@1512 586 case 'elementInitialPosition':
nickjillings@1512 587 sessionMetrics.prototype.enableElementInitialPosition = true;
nickjillings@1512 588 break;
nickjillings@1512 589 case 'elementFlagListenedTo':
nickjillings@1512 590 sessionMetrics.prototype.enableFlagListenedTo = true;
nickjillings@1512 591 break;
nickjillings@1512 592 case 'elementFlagMoved':
nickjillings@1512 593 sessionMetrics.prototype.enableFlagMoved = true;
nickjillings@1512 594 break;
nickjillings@1512 595 case 'elementFlagComments':
nickjillings@1512 596 sessionMetrics.prototype.enableFlagComments = true;
nickjillings@1512 597 break;
nickjillings@1512 598 }
nickjillings@1512 599 });
nickjillings@1512 600
nickjillings@1512 601
nickjillings@1512 602
nickjillings@1512 603 // Detect the interface to use and load the relevant javascripts.
nickjillings@1512 604 var interfaceJS = document.createElement('script');
nickjillings@1512 605 interfaceJS.setAttribute("type","text/javascript");
nickjillings@1512 606 if (specification.interfaceType == 'APE') {
nickjillings@1512 607 interfaceJS.setAttribute("src","ape.js");
nickjillings@1512 608
nickjillings@1512 609 // APE comes with a css file
nickjillings@1512 610 var css = document.createElement('link');
nickjillings@1512 611 css.rel = 'stylesheet';
nickjillings@1512 612 css.type = 'text/css';
nickjillings@1512 613 css.href = 'ape.css';
nickjillings@1512 614
nickjillings@1512 615 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1514 616 } else if (specification.interfaceType == "MUSHRA")
nickjillings@1514 617 {
nickjillings@1514 618 interfaceJS.setAttribute("src","mushra.js");
nickjillings@1514 619
nickjillings@1514 620 // MUSHRA comes with a css file
nickjillings@1514 621 var css = document.createElement('link');
nickjillings@1514 622 css.rel = 'stylesheet';
nickjillings@1514 623 css.type = 'text/css';
nickjillings@1514 624 css.href = 'mushra.css';
nickjillings@1514 625
nickjillings@1514 626 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1512 627 }
nickjillings@1512 628 document.getElementsByTagName("head")[0].appendChild(interfaceJS);
nickjillings@1512 629
nickjillings@1512 630 // Define window callbacks for interface
nickjillings@1512 631 window.onresize = function(event){resizeWindow(event);};
nickjillings@1512 632 }
nickjillings@1512 633
nickjillings@1512 634 function createProjectSave(destURL) {
nickjillings@1512 635 // Save the data from interface into XML and send to destURL
nickjillings@1512 636 // If destURL is null then download XML in client
nickjillings@1512 637 // Now time to render file locally
nickjillings@1512 638 var xmlDoc = interfaceXMLSave();
nickjillings@1512 639 var parent = document.createElement("div");
nickjillings@1512 640 parent.appendChild(xmlDoc);
nickjillings@1512 641 var file = [parent.innerHTML];
nickjillings@1512 642 if (destURL == "null" || destURL == undefined) {
nickjillings@1512 643 var bb = new Blob(file,{type : 'application/xml'});
nickjillings@1512 644 var dnlk = window.URL.createObjectURL(bb);
nickjillings@1512 645 var a = document.createElement("a");
nickjillings@1512 646 a.hidden = '';
nickjillings@1512 647 a.href = dnlk;
nickjillings@1512 648 a.download = "save.xml";
nickjillings@1512 649 a.textContent = "Save File";
nickjillings@1512 650
nickjillings@1512 651 popup.showPopup();
nickjillings@1512 652 popup.popupContent.innerHTML = null;
nickjillings@1512 653 popup.popupContent.appendChild(a);
nickjillings@1512 654 } else {
nickjillings@1512 655 var xmlhttp = new XMLHttpRequest;
nickjillings@1512 656 xmlhttp.open("POST",destURL,true);
nickjillings@1512 657 xmlhttp.setRequestHeader('Content-Type', 'text/xml');
nickjillings@1512 658 xmlhttp.onerror = function(){
nickjillings@1512 659 console.log('Error saving file to server! Presenting download locally');
nickjillings@1512 660 createProjectSave(null);
nickjillings@1512 661 };
nickjillings@1512 662 xmlhttp.onreadystatechange = function() {
nickjillings@1512 663 console.log(xmlhttp.status);
nickjillings@1512 664 if (xmlhttp.status != 200 && xmlhttp.readyState == 4) {
nickjillings@1512 665 createProjectSave(null);
nickjillings@1512 666 } else {
nickjillings@1512 667 popup.showPopup();
nickjillings@1512 668 popup.popupContent.innerHTML = null;
nickjillings@1512 669 popup.popupContent.textContent = "Thank you for performing this listening test";
nickjillings@1512 670 }
nickjillings@1512 671 };
nickjillings@1512 672 xmlhttp.send(file);
nickjillings@1512 673 }
nickjillings@1512 674 }
nickjillings@1512 675
nickjillings@1512 676 function errorSessionDump(msg){
nickjillings@1512 677 // Create the partial interface XML save
nickjillings@1512 678 // Include error node with message on why the dump occured
nickjillings@1512 679 var xmlDoc = interfaceXMLSave();
nickjillings@1512 680 var err = document.createElement('error');
nickjillings@1512 681 err.textContent = msg;
nickjillings@1512 682 xmlDoc.appendChild(err);
nickjillings@1512 683 var parent = document.createElement("div");
nickjillings@1512 684 parent.appendChild(xmlDoc);
nickjillings@1512 685 var file = [parent.innerHTML];
nickjillings@1512 686 var bb = new Blob(file,{type : 'application/xml'});
nickjillings@1512 687 var dnlk = window.URL.createObjectURL(bb);
nickjillings@1512 688 var a = document.createElement("a");
nickjillings@1512 689 a.hidden = '';
nickjillings@1512 690 a.href = dnlk;
nickjillings@1512 691 a.download = "save.xml";
nickjillings@1512 692 a.textContent = "Save File";
nickjillings@1512 693
nickjillings@1512 694 popup.showPopup();
nickjillings@1512 695 popup.popupContent.innerHTML = "ERROR : "+msg;
nickjillings@1512 696 popup.popupContent.appendChild(a);
nickjillings@1512 697 }
nickjillings@1512 698
nickjillings@1512 699 // Only other global function which must be defined in the interface class. Determines how to create the XML document.
nickjillings@1512 700 function interfaceXMLSave(){
nickjillings@1512 701 // Create the XML string to be exported with results
nickjillings@1512 702 var xmlDoc = document.createElement("BrowserEvaluationResult");
nickjillings@1512 703 var projectDocument = specification.projectXML;
nickjillings@1512 704 projectDocument.setAttribute('file-name',url);
nickjillings@1512 705 xmlDoc.appendChild(projectDocument);
nickjillings@1512 706 xmlDoc.appendChild(returnDateNode());
nickjillings@1512 707 for (var i=0; i<testState.stateResults.length; i++)
nickjillings@1512 708 {
nickjillings@1512 709 xmlDoc.appendChild(testState.stateResults[i]);
nickjillings@1512 710 }
nickjillings@1512 711
nickjillings@1512 712 return xmlDoc;
nickjillings@1512 713 }
nickjillings@1512 714
nickjillings@1512 715 function AudioEngine() {
nickjillings@1512 716
nickjillings@1512 717 // Create two output paths, the main outputGain and fooGain.
nickjillings@1512 718 // Output gain is default to 1 and any items for playback route here
nickjillings@1512 719 // Foo gain is used for analysis to ensure paths get processed, but are not heard
nickjillings@1512 720 // because web audio will optimise and any route which does not go to the destination gets ignored.
nickjillings@1512 721 this.outputGain = audioContext.createGain();
nickjillings@1512 722 this.fooGain = audioContext.createGain();
nickjillings@1512 723 this.fooGain.gain = 0;
nickjillings@1512 724
nickjillings@1512 725 // Use this to detect playback state: 0 - stopped, 1 - playing
nickjillings@1512 726 this.status = 0;
nickjillings@1512 727 this.audioObjectsReady = false;
nickjillings@1512 728
nickjillings@1512 729 // Connect both gains to output
nickjillings@1512 730 this.outputGain.connect(audioContext.destination);
nickjillings@1512 731 this.fooGain.connect(audioContext.destination);
nickjillings@1512 732
nickjillings@1512 733 // Create the timer Object
nickjillings@1512 734 this.timer = new timer();
nickjillings@1512 735 // Create session metrics
nickjillings@1512 736 this.metric = new sessionMetrics(this);
nickjillings@1512 737
nickjillings@1512 738 this.loopPlayback = false;
nickjillings@1512 739
nickjillings@1512 740 // Create store for new audioObjects
nickjillings@1512 741 this.audioObjects = [];
nickjillings@1512 742
nickjillings@1512 743 this.play = function(id) {
nickjillings@1512 744 // Start the timer and set the audioEngine state to playing (1)
nickjillings@1512 745 if (this.status == 0) {
nickjillings@1512 746 // Check if all audioObjects are ready
nickjillings@1512 747 if (this.audioObjectsReady == false) {
nickjillings@1512 748 this.audioObjectsReady = this.checkAllReady();
nickjillings@1512 749 }
nickjillings@1512 750 if (this.audioObjectsReady == true) {
nickjillings@1512 751 this.timer.startTest();
nickjillings@1512 752 if (this.loopPlayback)
nickjillings@1512 753 {this.setSynchronousLoop();}
nickjillings@1512 754 this.status = 1;
nickjillings@1512 755 }
nickjillings@1512 756 }
nickjillings@1512 757 if (this.status== 1) {
nickjillings@1512 758 if (id == undefined) {
nickjillings@1512 759 id = -1;
nickjillings@1512 760 } else {
nickjillings@1512 761 interfaceContext.playhead.setTimePerPixel(this.audioObjects[id]);
nickjillings@1512 762 }
nickjillings@1512 763 if (this.loopPlayback) {
nickjillings@1512 764 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 765 {
nickjillings@1512 766 this.audioObjects[i].play(this.timer.getTestTime()+1);
nickjillings@1512 767 if (id == i) {
nickjillings@1512 768 this.audioObjects[i].loopStart();
nickjillings@1512 769 } else {
nickjillings@1512 770 this.audioObjects[i].loopStop();
nickjillings@1512 771 }
nickjillings@1512 772 }
nickjillings@1512 773 } else {
nickjillings@1512 774 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 775 {
nickjillings@1512 776 if (i != id) {
nickjillings@1512 777 this.audioObjects[i].outputGain.gain.value = 0.0;
nickjillings@1512 778 this.audioObjects[i].stop();
nickjillings@1512 779 } else if (i == id) {
nickjillings@1512 780 this.audioObjects[id].outputGain.gain.value = 1.0;
nickjillings@1512 781 this.audioObjects[id].play(audioContext.currentTime+0.01);
nickjillings@1512 782 }
nickjillings@1512 783 }
nickjillings@1512 784 }
nickjillings@1512 785 interfaceContext.playhead.start();
nickjillings@1512 786 }
nickjillings@1512 787 };
nickjillings@1512 788
nickjillings@1512 789 this.stop = function() {
nickjillings@1512 790 // Send stop and reset command to all playback buffers and set audioEngine state to stopped (1)
nickjillings@1512 791 if (this.status == 1) {
nickjillings@1512 792 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 793 {
nickjillings@1512 794 this.audioObjects[i].stop();
nickjillings@1512 795 }
nickjillings@1512 796 interfaceContext.playhead.stop();
nickjillings@1512 797 this.status = 0;
nickjillings@1512 798 }
nickjillings@1512 799 };
nickjillings@1512 800
nickjillings@1512 801 this.newTrack = function(element) {
nickjillings@1512 802 // Pull data from given URL into new audio buffer
nickjillings@1512 803 // URLs must either be from the same source OR be setup to 'Access-Control-Allow-Origin'
nickjillings@1512 804
nickjillings@1512 805 // Create the audioObject with ID of the new track length;
nickjillings@1512 806 audioObjectId = this.audioObjects.length;
nickjillings@1512 807 this.audioObjects[audioObjectId] = new audioObject(audioObjectId);
nickjillings@1512 808
nickjillings@1512 809 // AudioObject will get track itself.
nickjillings@1512 810 this.audioObjects[audioObjectId].specification = element;
nickjillings@1512 811 this.audioObjects[audioObjectId].constructTrack(element.parent.hostURL + element.url);
nickjillings@1512 812 return this.audioObjects[audioObjectId];
nickjillings@1512 813 };
nickjillings@1512 814
nickjillings@1512 815 this.newTestPage = function() {
nickjillings@1512 816 this.state = 0;
nickjillings@1512 817 this.audioObjectsReady = false;
nickjillings@1512 818 this.metric.reset();
nickjillings@1512 819 this.audioObjects = [];
nickjillings@1512 820 };
nickjillings@1512 821
nickjillings@1512 822 this.checkAllPlayed = function() {
nickjillings@1512 823 arr = [];
nickjillings@1512 824 for (var id=0; id<this.audioObjects.length; id++) {
nickjillings@1512 825 if (this.audioObjects[id].metric.wasListenedTo == false) {
nickjillings@1512 826 arr.push(this.audioObjects[id].id);
nickjillings@1512 827 }
nickjillings@1512 828 }
nickjillings@1512 829 return arr;
nickjillings@1512 830 };
nickjillings@1512 831
nickjillings@1512 832 this.checkAllReady = function() {
nickjillings@1512 833 var ready = true;
nickjillings@1512 834 for (var i=0; i<this.audioObjects.length; i++) {
nickjillings@1512 835 if (this.audioObjects[i].state == 0) {
nickjillings@1512 836 // Track not ready
nickjillings@1512 837 console.log('WAIT -- audioObject '+i+' not ready yet!');
nickjillings@1512 838 ready = false;
nickjillings@1512 839 };
nickjillings@1512 840 }
nickjillings@1512 841 return ready;
nickjillings@1512 842 };
nickjillings@1512 843
nickjillings@1512 844 this.setSynchronousLoop = function() {
nickjillings@1512 845 // Pads the signals so they are all exactly the same length
nickjillings@1512 846 if (this.audioObjectsReady)
nickjillings@1512 847 {
nickjillings@1512 848 var length = 0;
nickjillings@1512 849 var lens = [];
nickjillings@1512 850 var maxId;
nickjillings@1512 851 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 852 {
nickjillings@1512 853 lens.push(this.audioObjects[i].buffer.length);
nickjillings@1512 854 if (length < this.audioObjects[i].buffer.length)
nickjillings@1512 855 {
nickjillings@1512 856 length = this.audioObjects[i].buffer.length;
nickjillings@1512 857 maxId = i;
nickjillings@1512 858 }
nickjillings@1512 859 }
nickjillings@1512 860 // Perform difference
nickjillings@1512 861 for (var i=0; i<lens.length; i++)
nickjillings@1512 862 {
nickjillings@1512 863 lens[i] = length - lens[i];
nickjillings@1512 864 }
nickjillings@1512 865 // Extract the audio and zero-pad
nickjillings@1512 866 for (var i=0; i<lens.length; i++)
nickjillings@1512 867 {
nickjillings@1512 868 var orig = this.audioObjects[i].buffer;
nickjillings@1512 869 var hold = audioContext.createBuffer(orig.numberOfChannels,length,orig.sampleRate);
nickjillings@1512 870 for (var c=0; c<orig.numberOfChannels; c++)
nickjillings@1512 871 {
nickjillings@1512 872 var inData = hold.getChannelData(c);
nickjillings@1512 873 var outData = orig.getChannelData(c);
nickjillings@1512 874 for (var n=0; n<orig.length; n++)
nickjillings@1512 875 {inData[n] = outData[n];}
nickjillings@1512 876 }
nickjillings@1512 877 this.audioObjects[i].buffer = hold;
nickjillings@1512 878 delete orig;
nickjillings@1512 879 }
nickjillings@1512 880 }
nickjillings@1512 881 };
nickjillings@1512 882
nickjillings@1512 883 }
nickjillings@1512 884
nickjillings@1512 885 function audioObject(id) {
nickjillings@1512 886 // The main buffer object with common control nodes to the AudioEngine
nickjillings@1512 887
nickjillings@1512 888 this.specification;
nickjillings@1512 889 this.id = id;
nickjillings@1512 890 this.state = 0; // 0 - no data, 1 - ready
nickjillings@1512 891 this.url = null; // Hold the URL given for the output back to the results.
nickjillings@1512 892 this.metric = new metricTracker(this);
nickjillings@1512 893
nickjillings@1512 894 // Bindings for GUI
nickjillings@1512 895 this.interfaceDOM = null;
nickjillings@1512 896 this.commentDOM = null;
nickjillings@1512 897
nickjillings@1512 898 // Create a buffer and external gain control to allow internal patching of effects and volume leveling.
nickjillings@1512 899 this.bufferNode = undefined;
nickjillings@1512 900 this.outputGain = audioContext.createGain();
nickjillings@1512 901
nickjillings@1512 902 // Default output gain to be zero
nickjillings@1512 903 this.outputGain.gain.value = 0.0;
nickjillings@1512 904
nickjillings@1512 905 // Connect buffer to the audio graph
nickjillings@1512 906 this.outputGain.connect(audioEngineContext.outputGain);
nickjillings@1512 907
nickjillings@1512 908 // the audiobuffer is not designed for multi-start playback
nickjillings@1512 909 // When stopeed, the buffer node is deleted and recreated with the stored buffer.
nickjillings@1512 910 this.buffer;
nickjillings@1512 911
nickjillings@1512 912 this.loopStart = function() {
nickjillings@1512 913 this.outputGain.gain.value = 1.0;
nickjillings@1512 914 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1512 915 };
nickjillings@1512 916
nickjillings@1512 917 this.loopStop = function() {
nickjillings@1512 918 if (this.outputGain.gain.value != 0.0) {
nickjillings@1512 919 this.outputGain.gain.value = 0.0;
nickjillings@1512 920 this.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@1512 921 }
nickjillings@1512 922 };
nickjillings@1512 923
nickjillings@1512 924 this.play = function(startTime) {
nickjillings@1512 925 if (this.bufferNode == undefined) {
nickjillings@1512 926 this.bufferNode = audioContext.createBufferSource();
nickjillings@1512 927 this.bufferNode.owner = this;
nickjillings@1512 928 this.bufferNode.connect(this.outputGain);
nickjillings@1512 929 this.bufferNode.buffer = this.buffer;
nickjillings@1512 930 this.bufferNode.loop = audioEngineContext.loopPlayback;
nickjillings@1512 931 this.bufferNode.onended = function() {
nickjillings@1512 932 // Safari does not like using 'this' to reference the calling object!
nickjillings@1512 933 event.srcElement.owner.metric.stopListening(audioEngineContext.timer.getTestTime(),event.srcElement.owner.getCurrentPosition());
nickjillings@1512 934 };
nickjillings@1512 935 if (this.bufferNode.loop == false) {
nickjillings@1512 936 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1512 937 }
nickjillings@1512 938 this.bufferNode.start(startTime);
nickjillings@1512 939 }
nickjillings@1512 940 };
nickjillings@1512 941
nickjillings@1512 942 this.stop = function() {
nickjillings@1512 943 if (this.bufferNode != undefined)
nickjillings@1512 944 {
nickjillings@1512 945 this.metric.stopListening(audioEngineContext.timer.getTestTime(),this.getCurrentPosition());
nickjillings@1512 946 this.bufferNode.stop(0);
nickjillings@1512 947 this.bufferNode = undefined;
nickjillings@1512 948 }
nickjillings@1512 949 };
nickjillings@1512 950
nickjillings@1512 951 this.getCurrentPosition = function() {
nickjillings@1512 952 var time = audioEngineContext.timer.getTestTime();
nickjillings@1512 953 if (this.bufferNode != undefined) {
nickjillings@1512 954 if (this.bufferNode.loop == true) {
nickjillings@1512 955 if (audioEngineContext.status == 1) {
nickjillings@1512 956 return time%this.buffer.duration;
nickjillings@1512 957 } else {
nickjillings@1512 958 return 0;
nickjillings@1512 959 }
nickjillings@1512 960 } else {
nickjillings@1512 961 if (this.metric.listenHold) {
nickjillings@1512 962 return time - this.metric.listenStart;
nickjillings@1512 963 } else {
nickjillings@1512 964 return 0;
nickjillings@1512 965 }
nickjillings@1512 966 }
nickjillings@1512 967 } else {
nickjillings@1512 968 return 0;
nickjillings@1512 969 }
nickjillings@1512 970 };
nickjillings@1512 971
nickjillings@1512 972 this.constructTrack = function(url) {
nickjillings@1512 973 var request = new XMLHttpRequest();
nickjillings@1512 974 this.url = url;
nickjillings@1512 975 request.open('GET',url,true);
nickjillings@1512 976 request.responseType = 'arraybuffer';
nickjillings@1512 977
nickjillings@1512 978 var audioObj = this;
nickjillings@1512 979
nickjillings@1512 980 // Create callback to decode the data asynchronously
nickjillings@1512 981 request.onloadend = function() {
nickjillings@1512 982 audioContext.decodeAudioData(request.response, function(decodedData) {
nickjillings@1512 983 audioObj.buffer = decodedData;
nickjillings@1512 984 audioObj.state = 1;
nickjillings@1512 985 if (audioObj.specification.type != 'outsidereference')
nickjillings@1512 986 {audioObj.interfaceDOM.enable();}
nickjillings@1512 987 }, function(){
nickjillings@1512 988 // Should only be called if there was an error, but sometimes gets called continuously
nickjillings@1512 989 // Check here if the error is genuine
nickjillings@1512 990 if (audioObj.state == 0 || audioObj.buffer == undefined) {
nickjillings@1512 991 // Genuine error
nickjillings@1512 992 console.log('FATAL - Error loading buffer on '+audioObj.id);
nickjillings@1512 993 if (request.status == 404)
nickjillings@1512 994 {
nickjillings@1512 995 console.log('FATAL - Fragment '+audioObj.id+' 404 error');
nickjillings@1512 996 console.log('URL: '+audioObj.url);
nickjillings@1512 997 errorSessionDump('Fragment '+audioObj.id+' 404 error');
nickjillings@1512 998 }
nickjillings@1512 999 }
nickjillings@1512 1000 });
nickjillings@1512 1001 };
nickjillings@1512 1002 request.send();
nickjillings@1512 1003 };
nickjillings@1512 1004
nickjillings@1512 1005 this.exportXMLDOM = function() {
nickjillings@1512 1006 var root = document.createElement('audioElement');
nickjillings@1512 1007 root.id = this.specification.id;
nickjillings@1512 1008 root.setAttribute('url',this.url);
nickjillings@1512 1009 var file = document.createElement('file');
nickjillings@1512 1010 file.setAttribute('sampleRate',this.buffer.sampleRate);
nickjillings@1512 1011 file.setAttribute('channels',this.buffer.numberOfChannels);
nickjillings@1512 1012 file.setAttribute('sampleCount',this.buffer.length);
nickjillings@1512 1013 file.setAttribute('duration',this.buffer.duration);
nickjillings@1512 1014 root.appendChild(file);
nickjillings@1512 1015 if (this.specification.type != 'outsidereference') {
nickjillings@1512 1016 root.appendChild(this.interfaceDOM.exportXMLDOM(this));
nickjillings@1512 1017 root.appendChild(this.commentDOM.exportXMLDOM(this));
nickjillings@1512 1018 if(this.specification.type == 'anchor') {
nickjillings@1512 1019 root.setAttribute('anchor',true);
nickjillings@1512 1020 } else if(this.specification.type == 'reference') {
nickjillings@1512 1021 root.setAttribute('reference',true);
nickjillings@1512 1022 }
nickjillings@1512 1023 }
nickjillings@1512 1024 root.appendChild(this.metric.exportXMLDOM());
nickjillings@1512 1025 return root;
nickjillings@1512 1026 };
nickjillings@1512 1027 }
nickjillings@1512 1028
nickjillings@1512 1029 function timer()
nickjillings@1512 1030 {
nickjillings@1512 1031 /* Timer object used in audioEngine to keep track of session timings
nickjillings@1512 1032 * Uses the timer of the web audio API, so sample resolution
nickjillings@1512 1033 */
nickjillings@1512 1034 this.testStarted = false;
nickjillings@1512 1035 this.testStartTime = 0;
nickjillings@1512 1036 this.testDuration = 0;
nickjillings@1512 1037 this.minimumTestTime = 0; // No minimum test time
nickjillings@1512 1038 this.startTest = function()
nickjillings@1512 1039 {
nickjillings@1512 1040 if (this.testStarted == false)
nickjillings@1512 1041 {
nickjillings@1512 1042 this.testStartTime = audioContext.currentTime;
nickjillings@1512 1043 this.testStarted = true;
nickjillings@1512 1044 this.updateTestTime();
nickjillings@1512 1045 audioEngineContext.metric.initialiseTest();
nickjillings@1512 1046 }
nickjillings@1512 1047 };
nickjillings@1512 1048 this.stopTest = function()
nickjillings@1512 1049 {
nickjillings@1512 1050 if (this.testStarted)
nickjillings@1512 1051 {
nickjillings@1512 1052 this.testDuration = this.getTestTime();
nickjillings@1512 1053 this.testStarted = false;
nickjillings@1512 1054 } else {
nickjillings@1512 1055 console.log('ERR: Test tried to end before beginning');
nickjillings@1512 1056 }
nickjillings@1512 1057 };
nickjillings@1512 1058 this.updateTestTime = function()
nickjillings@1512 1059 {
nickjillings@1512 1060 if (this.testStarted)
nickjillings@1512 1061 {
nickjillings@1512 1062 this.testDuration = audioContext.currentTime - this.testStartTime;
nickjillings@1512 1063 }
nickjillings@1512 1064 };
nickjillings@1512 1065 this.getTestTime = function()
nickjillings@1512 1066 {
nickjillings@1512 1067 this.updateTestTime();
nickjillings@1512 1068 return this.testDuration;
nickjillings@1512 1069 };
nickjillings@1512 1070 }
nickjillings@1512 1071
nickjillings@1512 1072 function sessionMetrics(engine)
nickjillings@1512 1073 {
nickjillings@1512 1074 /* Used by audioEngine to link to audioObjects to minimise the timer call timers;
nickjillings@1512 1075 */
nickjillings@1512 1076 this.engine = engine;
nickjillings@1512 1077 this.lastClicked = -1;
nickjillings@1512 1078 this.data = -1;
nickjillings@1512 1079 this.reset = function() {
nickjillings@1512 1080 this.lastClicked = -1;
nickjillings@1512 1081 this.data = -1;
nickjillings@1512 1082 };
nickjillings@1512 1083 this.initialiseTest = function(){};
nickjillings@1512 1084 }
nickjillings@1512 1085
nickjillings@1512 1086 function metricTracker(caller)
nickjillings@1512 1087 {
nickjillings@1512 1088 /* Custom object to track and collect metric data
nickjillings@1512 1089 * Used only inside the audioObjects object.
nickjillings@1512 1090 */
nickjillings@1512 1091
nickjillings@1512 1092 this.listenedTimer = 0;
nickjillings@1512 1093 this.listenStart = 0;
nickjillings@1512 1094 this.listenHold = false;
nickjillings@1512 1095 this.initialPosition = -1;
nickjillings@1512 1096 this.movementTracker = [];
nickjillings@1512 1097 this.listenTracker =[];
nickjillings@1512 1098 this.wasListenedTo = false;
nickjillings@1512 1099 this.wasMoved = false;
nickjillings@1512 1100 this.hasComments = false;
nickjillings@1512 1101 this.parent = caller;
nickjillings@1512 1102
nickjillings@1512 1103 this.initialised = function(position)
nickjillings@1512 1104 {
nickjillings@1512 1105 if (this.initialPosition == -1) {
nickjillings@1512 1106 this.initialPosition = position;
nickjillings@1512 1107 }
nickjillings@1512 1108 };
nickjillings@1512 1109
nickjillings@1512 1110 this.moved = function(time,position)
nickjillings@1512 1111 {
nickjillings@1512 1112 this.wasMoved = true;
nickjillings@1512 1113 this.movementTracker[this.movementTracker.length] = [time, position];
nickjillings@1512 1114 };
nickjillings@1512 1115
nickjillings@1512 1116 this.startListening = function(time)
nickjillings@1512 1117 {
nickjillings@1512 1118 if (this.listenHold == false)
nickjillings@1512 1119 {
nickjillings@1512 1120 this.wasListenedTo = true;
nickjillings@1512 1121 this.listenStart = time;
nickjillings@1512 1122 this.listenHold = true;
nickjillings@1512 1123
nickjillings@1512 1124 var evnt = document.createElement('event');
nickjillings@1512 1125 var testTime = document.createElement('testTime');
nickjillings@1512 1126 testTime.setAttribute('start',time);
nickjillings@1512 1127 var bufferTime = document.createElement('bufferTime');
nickjillings@1512 1128 bufferTime.setAttribute('start',this.parent.getCurrentPosition());
nickjillings@1512 1129 evnt.appendChild(testTime);
nickjillings@1512 1130 evnt.appendChild(bufferTime);
nickjillings@1512 1131 this.listenTracker.push(evnt);
nickjillings@1512 1132
nickjillings@1512 1133 console.log('slider ' + this.parent.id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1512 1134 }
nickjillings@1512 1135 };
nickjillings@1512 1136
nickjillings@1512 1137 this.stopListening = function(time,bufferStopTime)
nickjillings@1512 1138 {
nickjillings@1512 1139 if (this.listenHold == true)
nickjillings@1512 1140 {
nickjillings@1512 1141 var diff = time - this.listenStart;
nickjillings@1512 1142 this.listenedTimer += (diff);
nickjillings@1512 1143 this.listenStart = 0;
nickjillings@1512 1144 this.listenHold = false;
nickjillings@1512 1145
nickjillings@1512 1146 var evnt = this.listenTracker[this.listenTracker.length-1];
nickjillings@1512 1147 var testTime = evnt.getElementsByTagName('testTime')[0];
nickjillings@1512 1148 var bufferTime = evnt.getElementsByTagName('bufferTime')[0];
nickjillings@1512 1149 testTime.setAttribute('stop',time);
nickjillings@1512 1150 if (bufferStopTime == undefined) {
nickjillings@1512 1151 bufferTime.setAttribute('stop',this.parent.getCurrentPosition());
nickjillings@1512 1152 } else {
nickjillings@1512 1153 bufferTime.setAttribute('stop',bufferStopTime);
nickjillings@1512 1154 }
nickjillings@1512 1155 console.log('slider ' + this.parent.id + ' played for (' + diff + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1512 1156 }
nickjillings@1512 1157 };
nickjillings@1512 1158
nickjillings@1512 1159 this.exportXMLDOM = function() {
nickjillings@1512 1160 var root = document.createElement('metric');
nickjillings@1512 1161 if (audioEngineContext.metric.enableElementTimer) {
nickjillings@1512 1162 var mElementTimer = document.createElement('metricresult');
nickjillings@1512 1163 mElementTimer.setAttribute('name','enableElementTimer');
nickjillings@1512 1164 mElementTimer.textContent = this.listenedTimer;
nickjillings@1512 1165 root.appendChild(mElementTimer);
nickjillings@1512 1166 }
nickjillings@1512 1167 if (audioEngineContext.metric.enableElementTracker) {
nickjillings@1512 1168 var elementTrackerFull = document.createElement('metricResult');
nickjillings@1512 1169 elementTrackerFull.setAttribute('name','elementTrackerFull');
nickjillings@1512 1170 for (var k=0; k<this.movementTracker.length; k++)
nickjillings@1512 1171 {
nickjillings@1512 1172 var timePos = document.createElement('timePos');
nickjillings@1512 1173 timePos.id = k;
nickjillings@1512 1174 var time = document.createElement('time');
nickjillings@1512 1175 time.textContent = this.movementTracker[k][0];
nickjillings@1512 1176 var position = document.createElement('position');
nickjillings@1512 1177 position.textContent = this.movementTracker[k][1];
nickjillings@1512 1178 timePos.appendChild(time);
nickjillings@1512 1179 timePos.appendChild(position);
nickjillings@1512 1180 elementTrackerFull.appendChild(timePos);
nickjillings@1512 1181 }
nickjillings@1512 1182 root.appendChild(elementTrackerFull);
nickjillings@1512 1183 }
nickjillings@1512 1184 if (audioEngineContext.metric.enableElementListenTracker) {
nickjillings@1512 1185 var elementListenTracker = document.createElement('metricResult');
nickjillings@1512 1186 elementListenTracker.setAttribute('name','elementListenTracker');
nickjillings@1512 1187 for (var k=0; k<this.listenTracker.length; k++) {
nickjillings@1512 1188 elementListenTracker.appendChild(this.listenTracker[k]);
nickjillings@1512 1189 }
nickjillings@1512 1190 root.appendChild(elementListenTracker);
nickjillings@1512 1191 }
nickjillings@1512 1192 if (audioEngineContext.metric.enableElementInitialPosition) {
nickjillings@1512 1193 var elementInitial = document.createElement('metricResult');
nickjillings@1512 1194 elementInitial.setAttribute('name','elementInitialPosition');
nickjillings@1512 1195 elementInitial.textContent = this.initialPosition;
nickjillings@1512 1196 root.appendChild(elementInitial);
nickjillings@1512 1197 }
nickjillings@1512 1198 if (audioEngineContext.metric.enableFlagListenedTo) {
nickjillings@1512 1199 var flagListenedTo = document.createElement('metricResult');
nickjillings@1512 1200 flagListenedTo.setAttribute('name','elementFlagListenedTo');
nickjillings@1512 1201 flagListenedTo.textContent = this.wasListenedTo;
nickjillings@1512 1202 root.appendChild(flagListenedTo);
nickjillings@1512 1203 }
nickjillings@1512 1204 if (audioEngineContext.metric.enableFlagMoved) {
nickjillings@1512 1205 var flagMoved = document.createElement('metricResult');
nickjillings@1512 1206 flagMoved.setAttribute('name','elementFlagMoved');
nickjillings@1512 1207 flagMoved.textContent = this.wasMoved;
nickjillings@1512 1208 root.appendChild(flagMoved);
nickjillings@1512 1209 }
nickjillings@1512 1210 if (audioEngineContext.metric.enableFlagComments) {
nickjillings@1512 1211 var flagComments = document.createElement('metricResult');
nickjillings@1512 1212 flagComments.setAttribute('name','elementFlagComments');
nickjillings@1512 1213 if (this.parent.commentDOM == null)
nickjillings@1512 1214 {flag.textContent = 'false';}
nickjillings@1512 1215 else if (this.parent.commentDOM.textContent.length == 0)
nickjillings@1512 1216 {flag.textContent = 'false';}
nickjillings@1512 1217 else
nickjillings@1512 1218 {flag.textContet = 'true';}
nickjillings@1512 1219 root.appendChild(flagComments);
nickjillings@1512 1220 }
nickjillings@1512 1221
nickjillings@1512 1222 return root;
nickjillings@1512 1223 };
nickjillings@1512 1224 }
nickjillings@1512 1225
nickjillings@1512 1226 function randomiseOrder(input)
nickjillings@1512 1227 {
nickjillings@1512 1228 // This takes an array of information and randomises the order
nickjillings@1512 1229 var N = input.length;
nickjillings@1512 1230
nickjillings@1512 1231 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1512 1232 for (var counter = 0; counter < N; ++counter)
nickjillings@1512 1233 inputSequence.push(counter) // Fill array
nickjillings@1512 1234 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1512 1235
nickjillings@1512 1236 var holdArr = [];
nickjillings@1512 1237 var outputSequence = [];
nickjillings@1512 1238 for (var n=0; n<N; n++)
nickjillings@1512 1239 {
nickjillings@1512 1240 // First pick a random number
nickjillings@1512 1241 var r = Math.random();
nickjillings@1512 1242 // Multiply and floor by the number of elements left
nickjillings@1512 1243 r = Math.floor(r*input.length);
nickjillings@1512 1244 // Pick out that element and delete from the array
nickjillings@1512 1245 holdArr.push(input.splice(r,1)[0]);
nickjillings@1512 1246 // Do the same with sequence
nickjillings@1512 1247 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1512 1248 }
nickjillings@1512 1249 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1512 1250 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1512 1251 return holdArr;
nickjillings@1512 1252 }
nickjillings@1512 1253
nickjillings@1512 1254 function returnDateNode()
nickjillings@1512 1255 {
nickjillings@1512 1256 // Create an XML Node for the Date and Time a test was conducted
nickjillings@1512 1257 // Structure is
nickjillings@1512 1258 // <datetime>
nickjillings@1512 1259 // <date year="##" month="##" day="##">DD/MM/YY</date>
nickjillings@1512 1260 // <time hour="##" minute="##" sec="##">HH:MM:SS</time>
nickjillings@1512 1261 // </datetime>
nickjillings@1512 1262 var dateTime = new Date();
nickjillings@1512 1263 var year = document.createAttribute('year');
nickjillings@1512 1264 var month = document.createAttribute('month');
nickjillings@1512 1265 var day = document.createAttribute('day');
nickjillings@1512 1266 var hour = document.createAttribute('hour');
nickjillings@1512 1267 var minute = document.createAttribute('minute');
nickjillings@1512 1268 var secs = document.createAttribute('secs');
nickjillings@1512 1269
nickjillings@1512 1270 year.nodeValue = dateTime.getFullYear();
nickjillings@1512 1271 month.nodeValue = dateTime.getMonth()+1;
nickjillings@1512 1272 day.nodeValue = dateTime.getDate();
nickjillings@1512 1273 hour.nodeValue = dateTime.getHours();
nickjillings@1512 1274 minute.nodeValue = dateTime.getMinutes();
nickjillings@1512 1275 secs.nodeValue = dateTime.getSeconds();
nickjillings@1512 1276
nickjillings@1512 1277 var hold = document.createElement("datetime");
nickjillings@1512 1278 var date = document.createElement("date");
nickjillings@1512 1279 date.textContent = year.nodeValue+'/'+month.nodeValue+'/'+day.nodeValue;
nickjillings@1512 1280 var time = document.createElement("time");
nickjillings@1512 1281 time.textContent = hour.nodeValue+':'+minute.nodeValue+':'+secs.nodeValue;
nickjillings@1512 1282
nickjillings@1512 1283 date.setAttributeNode(year);
nickjillings@1512 1284 date.setAttributeNode(month);
nickjillings@1512 1285 date.setAttributeNode(day);
nickjillings@1512 1286 time.setAttributeNode(hour);
nickjillings@1512 1287 time.setAttributeNode(minute);
nickjillings@1512 1288 time.setAttributeNode(secs);
nickjillings@1512 1289
nickjillings@1512 1290 hold.appendChild(date);
nickjillings@1512 1291 hold.appendChild(time);
nickjillings@1512 1292 return hold
nickjillings@1512 1293
nickjillings@1512 1294 }
nickjillings@1512 1295
nickjillings@1512 1296 function testWaitIndicator() {
nickjillings@1512 1297 if (audioEngineContext.checkAllReady() == false) {
nickjillings@1512 1298 var hold = document.createElement("div");
nickjillings@1512 1299 hold.id = "testWaitIndicator";
nickjillings@1512 1300 hold.className = "indicator-box";
nickjillings@1512 1301 hold.style.zIndex = 3;
nickjillings@1512 1302 var span = document.createElement("span");
nickjillings@1512 1303 span.textContent = "Please wait! Elements still loading";
nickjillings@1512 1304 hold.appendChild(span);
nickjillings@1512 1305 var blank = document.createElement('div');
nickjillings@1512 1306 blank.className = 'testHalt';
nickjillings@1512 1307 blank.id = "testHaltBlank";
nickjillings@1512 1308 var body = document.getElementsByTagName('body')[0];
nickjillings@1512 1309 body.appendChild(hold);
nickjillings@1512 1310 body.appendChild(blank);
nickjillings@1512 1311 testWaitTimerIntervalHolder = setInterval(function(){
nickjillings@1512 1312 var ready = audioEngineContext.checkAllReady();
nickjillings@1512 1313 if (ready) {
nickjillings@1512 1314 var elem = document.getElementById('testWaitIndicator');
nickjillings@1512 1315 var blank = document.getElementById('testHaltBlank');
nickjillings@1512 1316 var body = document.getElementsByTagName('body')[0];
nickjillings@1512 1317 body.removeChild(elem);
nickjillings@1512 1318 body.removeChild(blank);
nickjillings@1512 1319 clearInterval(testWaitTimerIntervalHolder);
nickjillings@1512 1320 }
nickjillings@1512 1321 },500,false);
nickjillings@1512 1322 }
nickjillings@1512 1323 }
nickjillings@1512 1324
nickjillings@1512 1325 var testWaitTimerIntervalHolder = null;
nickjillings@1512 1326
nickjillings@1512 1327 function Specification() {
nickjillings@1512 1328 // Handles the decoding of the project specification XML into a simple JavaScript Object.
nickjillings@1512 1329
nickjillings@1512 1330 this.interfaceType;
nickjillings@1512 1331 this.commonInterface;
nickjillings@1512 1332 this.projectReturn;
nickjillings@1512 1333 this.randomiseOrder;
nickjillings@1512 1334 this.collectMetrics;
nickjillings@1512 1335 this.preTest;
nickjillings@1512 1336 this.postTest;
nickjillings@1512 1337 this.metrics =[];
nickjillings@1512 1338
nickjillings@1512 1339 this.audioHolders = [];
nickjillings@1512 1340
nickjillings@1512 1341 this.decode = function() {
nickjillings@1512 1342 // projectXML - DOM Parsed document
nickjillings@1512 1343 this.projectXML = projectXML.childNodes[0];
nickjillings@1512 1344 var setupNode = projectXML.getElementsByTagName('setup')[0];
nickjillings@1512 1345 this.interfaceType = setupNode.getAttribute('interface');
nickjillings@1512 1346 this.projectReturn = setupNode.getAttribute('projectReturn');
nickjillings@1512 1347 if (setupNode.getAttribute('randomiseOrder') == "true") {
nickjillings@1512 1348 this.randomiseOrder = true;
nickjillings@1512 1349 } else {this.randomiseOrder = false;}
nickjillings@1512 1350 if (setupNode.getAttribute('collectMetrics') == "true") {
nickjillings@1512 1351 this.collectMetrics = true;
nickjillings@1512 1352 } else {this.collectMetrics = false;}
nickjillings@1512 1353 var metricCollection = setupNode.getElementsByTagName('Metric');
nickjillings@1512 1354
nickjillings@1512 1355 this.preTest = new this.prepostNode('pretest',setupNode.getElementsByTagName('PreTest'));
nickjillings@1512 1356 this.postTest = new this.prepostNode('posttest',setupNode.getElementsByTagName('PostTest'));
nickjillings@1512 1357
nickjillings@1512 1358 if (metricCollection.length > 0) {
nickjillings@1512 1359 metricCollection = metricCollection[0].getElementsByTagName('metricEnable');
nickjillings@1512 1360 for (var i=0; i<metricCollection.length; i++) {
nickjillings@1512 1361 this.metrics.push(new this.metricNode(metricCollection[i].textContent));
nickjillings@1512 1362 }
nickjillings@1512 1363 }
nickjillings@1512 1364
nickjillings@1512 1365 var commonInterfaceNode = setupNode.getElementsByTagName('interface');
nickjillings@1512 1366 if (commonInterfaceNode.length > 0) {
nickjillings@1512 1367 commonInterfaceNode = commonInterfaceNode[0];
nickjillings@1512 1368 } else {
nickjillings@1512 1369 commonInterfaceNode = undefined;
nickjillings@1512 1370 }
nickjillings@1512 1371
nickjillings@1512 1372 this.commonInterface = new function() {
nickjillings@1512 1373 this.OptionNode = function(child) {
nickjillings@1512 1374 this.type = child.nodeName;
nickjillings@1512 1375 if (this.type == 'option')
nickjillings@1512 1376 {
nickjillings@1512 1377 this.name = child.getAttribute('name');
nickjillings@1512 1378 }
nickjillings@1512 1379 else if (this.type == 'check') {
nickjillings@1512 1380 this.check = child.getAttribute('name');
nickjillings@1512 1381 if (this.check == 'scalerange') {
nickjillings@1512 1382 this.min = child.getAttribute('min');
nickjillings@1512 1383 this.max = child.getAttribute('max');
nickjillings@1512 1384 if (this.min == null) {this.min = 1;}
nickjillings@1512 1385 else if (Number(this.min) > 1 && this.min != null) {
nickjillings@1512 1386 this.min = Number(this.min)/100;
nickjillings@1512 1387 } else {
nickjillings@1512 1388 this.min = Number(this.min);
nickjillings@1512 1389 }
nickjillings@1512 1390 if (this.max == null) {this.max = 0;}
nickjillings@1512 1391 else if (Number(this.max) > 1 && this.max != null) {
nickjillings@1512 1392 this.max = Number(this.max)/100;
nickjillings@1512 1393 } else {
nickjillings@1512 1394 this.max = Number(this.max);
nickjillings@1512 1395 }
nickjillings@1512 1396 }
nickjillings@1512 1397 } else if (this.type == 'anchor' || this.type == 'reference') {
nickjillings@1512 1398 this.value = Number(child.textContent);
nickjillings@1512 1399 this.enforce = child.getAttribute('enforce');
nickjillings@1512 1400 if (this.enforce == 'true') {this.enforce = true;}
nickjillings@1512 1401 else {this.enforce = false;}
nickjillings@1512 1402 }
nickjillings@1512 1403 };
nickjillings@1512 1404 this.options = [];
nickjillings@1512 1405 if (commonInterfaceNode != undefined) {
nickjillings@1512 1406 var child = commonInterfaceNode.firstElementChild;
nickjillings@1512 1407 while (child != undefined) {
nickjillings@1512 1408 this.options.push(new this.OptionNode(child));
nickjillings@1512 1409 child = child.nextElementSibling;
nickjillings@1512 1410 }
nickjillings@1512 1411 }
nickjillings@1512 1412 };
nickjillings@1512 1413
nickjillings@1512 1414 var audioHolders = projectXML.getElementsByTagName('audioHolder');
nickjillings@1512 1415 for (var i=0; i<audioHolders.length; i++) {
nickjillings@1512 1416 this.audioHolders.push(new this.audioHolderNode(this,audioHolders[i]));
nickjillings@1512 1417 }
nickjillings@1512 1418
nickjillings@1512 1419 };
nickjillings@1512 1420
nickjillings@1512 1421 this.prepostNode = function(type,Collection) {
nickjillings@1512 1422 this.type = type;
nickjillings@1512 1423 this.options = [];
nickjillings@1512 1424
nickjillings@1512 1425 this.OptionNode = function(child) {
nickjillings@1512 1426
nickjillings@1512 1427 this.childOption = function(element) {
nickjillings@1512 1428 this.type = 'option';
nickjillings@1512 1429 this.id = element.id;
nickjillings@1512 1430 this.name = element.getAttribute('name');
nickjillings@1512 1431 this.text = element.textContent;
nickjillings@1512 1432 };
nickjillings@1512 1433
nickjillings@1512 1434 this.type = child.nodeName;
nickjillings@1512 1435 if (child.nodeName == "question") {
nickjillings@1512 1436 this.id = child.id;
nickjillings@1512 1437 this.mandatory;
nickjillings@1512 1438 if (child.getAttribute('mandatory') == "true") {this.mandatory = true;}
nickjillings@1512 1439 else {this.mandatory = false;}
nickjillings@1512 1440 this.question = child.textContent;
nickjillings@1512 1441 if (child.getAttribute('boxsize') == null) {
nickjillings@1512 1442 this.boxsize = 'normal';
nickjillings@1512 1443 } else {
nickjillings@1512 1444 this.boxsize = child.getAttribute('boxsize');
nickjillings@1512 1445 }
nickjillings@1512 1446 } else if (child.nodeName == "statement") {
nickjillings@1512 1447 this.statement = child.textContent;
nickjillings@1512 1448 } else if (child.nodeName == "checkbox" || child.nodeName == "radio") {
nickjillings@1512 1449 var element = child.firstElementChild;
nickjillings@1512 1450 this.id = child.id;
nickjillings@1512 1451 if (element == null) {
nickjillings@1512 1452 console.log('Malformed' +child.nodeName+ 'entry');
nickjillings@1512 1453 this.statement = 'Malformed' +child.nodeName+ 'entry';
nickjillings@1512 1454 this.type = 'statement';
nickjillings@1512 1455 } else {
nickjillings@1512 1456 this.options = [];
nickjillings@1512 1457 while (element != null) {
nickjillings@1512 1458 if (element.nodeName == 'statement' && this.statement == undefined){
nickjillings@1512 1459 this.statement = element.textContent;
nickjillings@1512 1460 } else if (element.nodeName == 'option') {
nickjillings@1512 1461 this.options.push(new this.childOption(element));
nickjillings@1512 1462 }
nickjillings@1512 1463 element = element.nextElementSibling;
nickjillings@1512 1464 }
nickjillings@1512 1465 }
nickjillings@1512 1466 } else if (child.nodeName == "number") {
nickjillings@1512 1467 this.statement = child.textContent;
nickjillings@1512 1468 this.id = child.id;
nickjillings@1512 1469 this.min = child.getAttribute('min');
nickjillings@1512 1470 this.max = child.getAttribute('max');
nickjillings@1512 1471 this.step = child.getAttribute('step');
nickjillings@1512 1472 }
nickjillings@1512 1473 };
nickjillings@1512 1474
nickjillings@1512 1475 // On construction:
nickjillings@1512 1476 if (Collection.length != 0) {
nickjillings@1512 1477 Collection = Collection[0];
nickjillings@1512 1478 if (Collection.childElementCount != 0) {
nickjillings@1512 1479 var child = Collection.firstElementChild;
nickjillings@1512 1480 this.options.push(new this.OptionNode(child));
nickjillings@1512 1481 while (child.nextElementSibling != null) {
nickjillings@1512 1482 child = child.nextElementSibling;
nickjillings@1512 1483 this.options.push(new this.OptionNode(child));
nickjillings@1512 1484 }
nickjillings@1512 1485 }
nickjillings@1512 1486 }
nickjillings@1512 1487 };
nickjillings@1512 1488
nickjillings@1512 1489 this.metricNode = function(name) {
nickjillings@1512 1490 this.enabled = name;
nickjillings@1512 1491 };
nickjillings@1512 1492
nickjillings@1512 1493 this.audioHolderNode = function(parent,xml) {
nickjillings@1512 1494 this.type = 'audioHolder';
nickjillings@1512 1495 this.presentedId = parent.audioHolders.length;
nickjillings@1512 1496 this.interfaceNode = function(DOM) {
nickjillings@1512 1497 var title = DOM.getElementsByTagName('title');
nickjillings@1512 1498 if (title.length == 0) {this.title = null;}
nickjillings@1512 1499 else {this.title = title[0].textContent;}
nickjillings@1512 1500 this.options = parent.commonInterface.options;
nickjillings@1512 1501 var scale = DOM.getElementsByTagName('scale');
nickjillings@1512 1502 this.scale = [];
nickjillings@1512 1503 for (var i=0; i<scale.length; i++) {
nickjillings@1512 1504 var arr = [null, null];
nickjillings@1512 1505 arr[0] = scale[i].getAttribute('position');
nickjillings@1512 1506 arr[1] = scale[i].textContent;
nickjillings@1512 1507 this.scale.push(arr);
nickjillings@1512 1508 }
nickjillings@1512 1509 };
nickjillings@1512 1510
nickjillings@1512 1511 this.audioElementNode = function(parent,xml) {
nickjillings@1512 1512 this.url = xml.getAttribute('url');
nickjillings@1512 1513 this.id = xml.id;
nickjillings@1512 1514 this.parent = parent;
nickjillings@1512 1515 this.type = xml.getAttribute('type');
nickjillings@1512 1516 if (this.type == null) {this.type = "normal";}
nickjillings@1512 1517 if (this.type == 'anchor') {this.anchor = true;}
nickjillings@1512 1518 else {this.anchor = false;}
nickjillings@1512 1519 if (this.type == 'reference') {this.reference = true;}
nickjillings@1512 1520 else {this.reference = false;}
nickjillings@1512 1521
nickjillings@1512 1522 this.marker = xml.getAttribute('marker');
nickjillings@1512 1523 if (this.marker == null) {this.marker = undefined;}
nickjillings@1512 1524
nickjillings@1512 1525 if (this.anchor == true) {
nickjillings@1512 1526 if (this.marker != undefined) {this.enforce = true;}
nickjillings@1512 1527 else {this.enforce = enforceAnchor;}
nickjillings@1512 1528 this.marker = anchor;
nickjillings@1512 1529 }
nickjillings@1512 1530 else if (this.reference == true) {
nickjillings@1512 1531 if (this.marker != undefined) {this.enforce = true;}
nickjillings@1512 1532 else {this.enforce = enforceReference;}
nickjillings@1512 1533 this.marker = reference;
nickjillings@1512 1534 }
nickjillings@1512 1535
nickjillings@1512 1536 if (this.marker != undefined) {
nickjillings@1512 1537 this.marker = Number(this.marker);
nickjillings@1512 1538 if (this.marker > 1) {this.marker /= 100;}
nickjillings@1512 1539 }
nickjillings@1512 1540 };
nickjillings@1512 1541
nickjillings@1512 1542 this.commentQuestionNode = function(xml) {
nickjillings@1512 1543 this.childOption = function(element) {
nickjillings@1512 1544 this.type = 'option';
nickjillings@1512 1545 this.name = element.getAttribute('name');
nickjillings@1512 1546 this.text = element.textContent;
nickjillings@1512 1547 };
nickjillings@1512 1548 this.id = xml.id;
nickjillings@1512 1549 if (xml.getAttribute('mandatory') == 'true') {this.mandatory = true;}
nickjillings@1512 1550 else {this.mandatory = false;}
nickjillings@1512 1551 this.type = xml.getAttribute('type');
nickjillings@1512 1552 if (this.type == undefined) {this.type = 'text';}
nickjillings@1512 1553 switch (this.type) {
nickjillings@1512 1554 case 'text':
nickjillings@1512 1555 this.question = xml.textContent;
nickjillings@1512 1556 break;
nickjillings@1512 1557 case 'radio':
nickjillings@1512 1558 var child = xml.firstElementChild;
nickjillings@1512 1559 this.options = [];
nickjillings@1512 1560 while (child != undefined) {
nickjillings@1512 1561 if (child.nodeName == 'statement' && this.statement == undefined) {
nickjillings@1512 1562 this.statement = child.textContent;
nickjillings@1512 1563 } else if (child.nodeName == 'option') {
nickjillings@1512 1564 this.options.push(new this.childOption(child));
nickjillings@1512 1565 }
nickjillings@1512 1566 child = child.nextElementSibling;
nickjillings@1512 1567 }
nickjillings@1512 1568 break;
nickjillings@1512 1569 case 'checkbox':
nickjillings@1512 1570 var child = xml.firstElementChild;
nickjillings@1512 1571 this.options = [];
nickjillings@1512 1572 while (child != undefined) {
nickjillings@1512 1573 if (child.nodeName == 'statement' && this.statement == undefined) {
nickjillings@1512 1574 this.statement = child.textContent;
nickjillings@1512 1575 } else if (child.nodeName == 'option') {
nickjillings@1512 1576 this.options.push(new this.childOption(child));
nickjillings@1512 1577 }
nickjillings@1512 1578 child = child.nextElementSibling;
nickjillings@1512 1579 }
nickjillings@1512 1580 break;
nickjillings@1512 1581 }
nickjillings@1512 1582 };
nickjillings@1512 1583
nickjillings@1512 1584 this.id = xml.id;
nickjillings@1512 1585 this.hostURL = xml.getAttribute('hostURL');
nickjillings@1512 1586 this.sampleRate = xml.getAttribute('sampleRate');
nickjillings@1512 1587 if (xml.getAttribute('randomiseOrder') == "true") {this.randomiseOrder = true;}
nickjillings@1512 1588 else {this.randomiseOrder = false;}
nickjillings@1512 1589 this.repeatCount = xml.getAttribute('repeatCount');
nickjillings@1512 1590 if (xml.getAttribute('loop') == 'true') {this.loop = true;}
nickjillings@1512 1591 else {this.loop == false;}
nickjillings@1512 1592 if (xml.getAttribute('elementComments') == "true") {this.elementComments = true;}
nickjillings@1512 1593 else {this.elementComments = false;}
nickjillings@1512 1594
nickjillings@1512 1595 var anchor = xml.getElementsByTagName('anchor');
nickjillings@1512 1596 var enforceAnchor = false;
nickjillings@1512 1597 if (anchor.length == 0) {
nickjillings@1512 1598 // Find anchor in commonInterface;
nickjillings@1512 1599 for (var i=0; i<parent.commonInterface.options.length; i++) {
nickjillings@1512 1600 if(parent.commonInterface.options[i].type == 'anchor') {
nickjillings@1512 1601 anchor = parent.commonInterface.options[i].value;
nickjillings@1512 1602 enforceAnchor = parent.commonInterface.options[i].enforce;
nickjillings@1512 1603 break;
nickjillings@1512 1604 }
nickjillings@1512 1605 }
nickjillings@1512 1606 if (typeof(anchor) == "object") {
nickjillings@1512 1607 anchor = null;
nickjillings@1512 1608 }
nickjillings@1512 1609 } else {
nickjillings@1512 1610 anchor = anchor[0].textContent;
nickjillings@1512 1611 }
nickjillings@1512 1612
nickjillings@1512 1613 var reference = xml.getElementsByTagName('anchor');
nickjillings@1512 1614 var enforceReference = false;
nickjillings@1512 1615 if (reference.length == 0) {
nickjillings@1512 1616 // Find anchor in commonInterface;
nickjillings@1512 1617 for (var i=0; i<parent.commonInterface.options.length; i++) {
nickjillings@1512 1618 if(parent.commonInterface.options[i].type == 'reference') {
nickjillings@1512 1619 reference = parent.commonInterface.options[i].value;
nickjillings@1512 1620 enforceReference = parent.commonInterface.options[i].enforce;
nickjillings@1512 1621 break;
nickjillings@1512 1622 }
nickjillings@1512 1623 }
nickjillings@1512 1624 if (typeof(reference) == "object") {
nickjillings@1512 1625 reference = null;
nickjillings@1512 1626 }
nickjillings@1512 1627 } else {
nickjillings@1512 1628 reference = reference[0].textContent;
nickjillings@1512 1629 }
nickjillings@1512 1630
nickjillings@1512 1631 if (typeof(anchor) == 'number') {
nickjillings@1512 1632 if (anchor > 1 && anchor < 100) {anchor /= 100.0;}
nickjillings@1512 1633 }
nickjillings@1512 1634
nickjillings@1512 1635 if (typeof(reference) == 'number') {
nickjillings@1512 1636 if (reference > 1 && reference < 100) {reference /= 100.0;}
nickjillings@1512 1637 }
nickjillings@1512 1638
nickjillings@1512 1639 this.preTest = new parent.prepostNode('pretest',xml.getElementsByTagName('PreTest'));
nickjillings@1512 1640 this.postTest = new parent.prepostNode('posttest',xml.getElementsByTagName('PostTest'));
nickjillings@1512 1641
nickjillings@1512 1642 this.interfaces = [];
nickjillings@1512 1643 var interfaceDOM = xml.getElementsByTagName('interface');
nickjillings@1512 1644 for (var i=0; i<interfaceDOM.length; i++) {
nickjillings@1512 1645 this.interfaces.push(new this.interfaceNode(interfaceDOM[i]));
nickjillings@1512 1646 }
nickjillings@1512 1647
nickjillings@1512 1648 this.commentBoxPrefix = xml.getElementsByTagName('commentBoxPrefix');
nickjillings@1512 1649 if (this.commentBoxPrefix.length != 0) {
nickjillings@1512 1650 this.commentBoxPrefix = this.commentBoxPrefix[0].textContent;
nickjillings@1512 1651 } else {
nickjillings@1512 1652 this.commentBoxPrefix = "Comment on track";
nickjillings@1512 1653 }
nickjillings@1512 1654
nickjillings@1512 1655 this.audioElements =[];
nickjillings@1512 1656 var audioElementsDOM = xml.getElementsByTagName('audioElements');
nickjillings@1512 1657 this.outsideReference = null;
nickjillings@1512 1658 for (var i=0; i<audioElementsDOM.length; i++) {
nickjillings@1512 1659 if (audioElementsDOM[i].getAttribute('type') == 'outsidereference') {
nickjillings@1512 1660 if (this.outsideReference == null) {
nickjillings@1512 1661 this.outsideReference = new this.audioElementNode(this,audioElementsDOM[i]);
nickjillings@1512 1662 } else {
nickjillings@1512 1663 console.log('Error only one audioelement can be of type outsidereference per audioholder');
nickjillings@1512 1664 this.audioElements.push(new this.audioElementNode(this,audioElementsDOM[i]));
nickjillings@1512 1665 console.log('Element id '+audioElementsDOM[i].id+' made into normal node');
nickjillings@1512 1666 }
nickjillings@1512 1667 } else {
nickjillings@1512 1668 this.audioElements.push(new this.audioElementNode(this,audioElementsDOM[i]));
nickjillings@1512 1669 }
nickjillings@1512 1670 }
nickjillings@1512 1671
nickjillings@1512 1672 if (this.randomiseOrder) {
nickjillings@1512 1673 this.audioElements = randomiseOrder(this.audioElements);
nickjillings@1512 1674 }
nickjillings@1512 1675
nickjillings@1512 1676 // Check only one anchor and one reference per audioNode
nickjillings@1512 1677 var anchor = [];
nickjillings@1512 1678 var reference = [];
nickjillings@1512 1679 this.anchorId = null;
nickjillings@1512 1680 this.referenceId = null;
nickjillings@1512 1681 for (var i=0; i<this.audioElements.length; i++)
nickjillings@1512 1682 {
nickjillings@1512 1683 if (this.audioElements[i].anchor == true) {anchor.push(i);}
nickjillings@1512 1684 if (this.audioElements[i].reference == true) {reference.push(i);}
nickjillings@1512 1685 }
nickjillings@1512 1686
nickjillings@1512 1687 if (anchor.length > 1) {
nickjillings@1512 1688 console.log('Error - cannot have more than one anchor!');
nickjillings@1512 1689 console.log('Each anchor node will be a normal mode to continue the test');
nickjillings@1512 1690 for (var i=0; i<anchor.length; i++)
nickjillings@1512 1691 {
nickjillings@1512 1692 this.audioElements[anchor[i]].anchor = false;
nickjillings@1512 1693 this.audioElements[anchor[i]].value = undefined;
nickjillings@1512 1694 }
nickjillings@1512 1695 } else {this.anchorId = anchor[0];}
nickjillings@1512 1696 if (reference.length > 1) {
nickjillings@1512 1697 console.log('Error - cannot have more than one anchor!');
nickjillings@1512 1698 console.log('Each anchor node will be a normal mode to continue the test');
nickjillings@1512 1699 for (var i=0; i<reference.length; i++)
nickjillings@1512 1700 {
nickjillings@1512 1701 this.audioElements[reference[i]].reference = false;
nickjillings@1512 1702 this.audioElements[reference[i]].value = undefined;
nickjillings@1512 1703 }
nickjillings@1512 1704 } else {this.referenceId = reference[0];}
nickjillings@1512 1705
nickjillings@1512 1706 this.commentQuestions = [];
nickjillings@1512 1707 var commentQuestionsDOM = xml.getElementsByTagName('CommentQuestion');
nickjillings@1512 1708 for (var i=0; i<commentQuestionsDOM.length; i++) {
nickjillings@1512 1709 this.commentQuestions.push(new this.commentQuestionNode(commentQuestionsDOM[i]));
nickjillings@1512 1710 }
nickjillings@1512 1711 };
nickjillings@1512 1712 }
nickjillings@1512 1713
nickjillings@1512 1714 function Interface(specificationObject) {
nickjillings@1512 1715 // This handles the bindings between the interface and the audioEngineContext;
nickjillings@1512 1716 this.specification = specificationObject;
nickjillings@1512 1717 this.insertPoint = document.getElementById("topLevelBody");
nickjillings@1512 1718
nickjillings@1512 1719 // Bounded by interface!!
nickjillings@1512 1720 // Interface object MUST have an exportXMLDOM method which returns the various DOM levels
nickjillings@1512 1721 // For example, APE returns the slider position normalised in a <value> tag.
nickjillings@1512 1722 this.interfaceObjects = [];
nickjillings@1512 1723 this.interfaceObject = function(){};
nickjillings@1512 1724
nickjillings@1512 1725 this.commentBoxes = [];
nickjillings@1512 1726 this.elementCommentBox = function(audioObject) {
nickjillings@1512 1727 var element = audioObject.specification;
nickjillings@1512 1728 this.audioObject = audioObject;
nickjillings@1512 1729 this.id = audioObject.id;
nickjillings@1512 1730 var audioHolderObject = audioObject.specification.parent;
nickjillings@1512 1731 // Create document objects to hold the comment boxes
nickjillings@1512 1732 this.trackComment = document.createElement('div');
nickjillings@1512 1733 this.trackComment.className = 'comment-div';
nickjillings@1512 1734 this.trackComment.id = 'comment-div-'+audioObject.id;
nickjillings@1512 1735 // Create a string next to each comment asking for a comment
nickjillings@1512 1736 this.trackString = document.createElement('span');
nickjillings@1512 1737 this.trackString.innerHTML = audioHolderObject.commentBoxPrefix+' '+audioObject.id;
nickjillings@1512 1738 // Create the HTML5 comment box 'textarea'
nickjillings@1512 1739 this.trackCommentBox = document.createElement('textarea');
nickjillings@1512 1740 this.trackCommentBox.rows = '4';
nickjillings@1512 1741 this.trackCommentBox.cols = '100';
nickjillings@1512 1742 this.trackCommentBox.name = 'trackComment'+audioObject.id;
nickjillings@1512 1743 this.trackCommentBox.className = 'trackComment';
nickjillings@1512 1744 var br = document.createElement('br');
nickjillings@1512 1745 // Add to the holder.
nickjillings@1512 1746 this.trackComment.appendChild(this.trackString);
nickjillings@1512 1747 this.trackComment.appendChild(br);
nickjillings@1512 1748 this.trackComment.appendChild(this.trackCommentBox);
nickjillings@1512 1749
nickjillings@1512 1750 this.exportXMLDOM = function() {
nickjillings@1512 1751 var root = document.createElement('comment');
nickjillings@1512 1752 if (this.audioObject.specification.parent.elementComments) {
nickjillings@1512 1753 var question = document.createElement('question');
nickjillings@1512 1754 question.textContent = this.trackString.textContent;
nickjillings@1512 1755 var response = document.createElement('response');
nickjillings@1512 1756 response.textContent = this.trackCommentBox.value;
nickjillings@1512 1757 console.log("Comment frag-"+this.id+": "+response.textContent);
nickjillings@1512 1758 root.appendChild(question);
nickjillings@1512 1759 root.appendChild(response);
nickjillings@1512 1760 }
nickjillings@1512 1761 return root;
nickjillings@1512 1762 };
nickjillings@1512 1763 };
nickjillings@1512 1764
nickjillings@1512 1765 this.commentQuestions = [];
nickjillings@1512 1766
nickjillings@1512 1767 this.commentBox = function(commentQuestion) {
nickjillings@1512 1768 this.specification = commentQuestion;
nickjillings@1512 1769 // Create document objects to hold the comment boxes
nickjillings@1512 1770 this.holder = document.createElement('div');
nickjillings@1512 1771 this.holder.className = 'comment-div';
nickjillings@1512 1772 // Create a string next to each comment asking for a comment
nickjillings@1512 1773 this.string = document.createElement('span');
nickjillings@1512 1774 this.string.innerHTML = commentQuestion.question;
nickjillings@1512 1775 // Create the HTML5 comment box 'textarea'
nickjillings@1512 1776 this.textArea = document.createElement('textarea');
nickjillings@1512 1777 this.textArea.rows = '4';
nickjillings@1512 1778 this.textArea.cols = '100';
nickjillings@1512 1779 this.textArea.className = 'trackComment';
nickjillings@1512 1780 var br = document.createElement('br');
nickjillings@1512 1781 // Add to the holder.
nickjillings@1512 1782 this.holder.appendChild(this.string);
nickjillings@1512 1783 this.holder.appendChild(br);
nickjillings@1512 1784 this.holder.appendChild(this.textArea);
nickjillings@1512 1785
nickjillings@1512 1786 this.exportXMLDOM = function() {
nickjillings@1512 1787 var root = document.createElement('comment');
nickjillings@1512 1788 root.id = this.specification.id;
nickjillings@1512 1789 root.setAttribute('type',this.specification.type);
nickjillings@1512 1790 root.textContent = this.textArea.value;
nickjillings@1512 1791 console.log("Question: "+this.string.textContent);
nickjillings@1512 1792 console.log("Response: "+root.textContent);
nickjillings@1512 1793 return root;
nickjillings@1512 1794 };
nickjillings@1512 1795 };
nickjillings@1512 1796
nickjillings@1512 1797 this.radioBox = function(commentQuestion) {
nickjillings@1512 1798 this.specification = commentQuestion;
nickjillings@1512 1799 // Create document objects to hold the comment boxes
nickjillings@1512 1800 this.holder = document.createElement('div');
nickjillings@1512 1801 this.holder.className = 'comment-div';
nickjillings@1512 1802 // Create a string next to each comment asking for a comment
nickjillings@1512 1803 this.string = document.createElement('span');
nickjillings@1512 1804 this.string.innerHTML = commentQuestion.statement;
nickjillings@1512 1805 var br = document.createElement('br');
nickjillings@1512 1806 // Add to the holder.
nickjillings@1512 1807 this.holder.appendChild(this.string);
nickjillings@1512 1808 this.holder.appendChild(br);
nickjillings@1512 1809 this.options = [];
nickjillings@1512 1810 this.inputs = document.createElement('div');
nickjillings@1512 1811 this.span = document.createElement('div');
nickjillings@1512 1812 this.inputs.align = 'center';
nickjillings@1512 1813 this.inputs.style.marginLeft = '12px';
nickjillings@1512 1814 this.span.style.marginLeft = '12px';
nickjillings@1512 1815 this.span.align = 'center';
nickjillings@1512 1816 this.span.style.marginTop = '15px';
nickjillings@1512 1817
nickjillings@1512 1818 var optCount = commentQuestion.options.length;
nickjillings@1512 1819 var spanMargin = Math.floor(((600-(optCount*100))/(optCount))/2)+'px';
nickjillings@1512 1820 console.log(spanMargin);
nickjillings@1512 1821 for (var i=0; i<optCount; i++)
nickjillings@1512 1822 {
nickjillings@1512 1823 var div = document.createElement('div');
nickjillings@1512 1824 div.style.width = '100px';
nickjillings@1512 1825 div.style.float = 'left';
nickjillings@1512 1826 div.style.marginRight = spanMargin;
nickjillings@1512 1827 div.style.marginLeft = spanMargin;
nickjillings@1512 1828 var input = document.createElement('input');
nickjillings@1512 1829 input.type = 'radio';
nickjillings@1512 1830 input.name = commentQuestion.id;
nickjillings@1512 1831 input.setAttribute('setvalue',commentQuestion.options[i].name);
nickjillings@1512 1832 input.className = 'comment-radio';
nickjillings@1512 1833 div.appendChild(input);
nickjillings@1512 1834 this.inputs.appendChild(div);
nickjillings@1512 1835
nickjillings@1512 1836
nickjillings@1512 1837 div = document.createElement('div');
nickjillings@1512 1838 div.style.width = '100px';
nickjillings@1512 1839 div.style.float = 'left';
nickjillings@1512 1840 div.style.marginRight = spanMargin;
nickjillings@1512 1841 div.style.marginLeft = spanMargin;
nickjillings@1512 1842 div.align = 'center';
nickjillings@1512 1843 var span = document.createElement('span');
nickjillings@1512 1844 span.textContent = commentQuestion.options[i].text;
nickjillings@1512 1845 span.className = 'comment-radio-span';
nickjillings@1512 1846 div.appendChild(span);
nickjillings@1512 1847 this.span.appendChild(div);
nickjillings@1512 1848 this.options.push(input);
nickjillings@1512 1849 }
nickjillings@1512 1850 this.holder.appendChild(this.span);
nickjillings@1512 1851 this.holder.appendChild(this.inputs);
nickjillings@1512 1852
nickjillings@1512 1853 this.exportXMLDOM = function() {
nickjillings@1512 1854 var root = document.createElement('comment');
nickjillings@1512 1855 root.id = this.specification.id;
nickjillings@1512 1856 root.setAttribute('type',this.specification.type);
nickjillings@1512 1857 var question = document.createElement('question');
nickjillings@1512 1858 question.textContent = this.string.textContent;
nickjillings@1512 1859 var response = document.createElement('response');
nickjillings@1512 1860 var i=0;
nickjillings@1512 1861 while(this.options[i].checked == false) {
nickjillings@1512 1862 i++;
nickjillings@1512 1863 if (i >= this.options.length) {
nickjillings@1512 1864 break;
nickjillings@1512 1865 }
nickjillings@1512 1866 }
nickjillings@1512 1867 if (i >= this.options.length) {
nickjillings@1512 1868 response.textContent = 'null';
nickjillings@1512 1869 } else {
nickjillings@1512 1870 response.textContent = this.options[i].getAttribute('setvalue');
nickjillings@1512 1871 response.setAttribute('number',i);
nickjillings@1512 1872 }
nickjillings@1512 1873 console.log('Comment: '+question.textContent);
nickjillings@1512 1874 console.log('Response: '+response.textContent);
nickjillings@1512 1875 root.appendChild(question);
nickjillings@1512 1876 root.appendChild(response);
nickjillings@1512 1877 return root;
nickjillings@1512 1878 };
nickjillings@1512 1879 };
nickjillings@1512 1880
nickjillings@1512 1881 this.checkboxBox = function(commentQuestion) {
nickjillings@1512 1882 this.specification = commentQuestion;
nickjillings@1512 1883 // Create document objects to hold the comment boxes
nickjillings@1512 1884 this.holder = document.createElement('div');
nickjillings@1512 1885 this.holder.className = 'comment-div';
nickjillings@1512 1886 // Create a string next to each comment asking for a comment
nickjillings@1512 1887 this.string = document.createElement('span');
nickjillings@1512 1888 this.string.innerHTML = commentQuestion.statement;
nickjillings@1512 1889 var br = document.createElement('br');
nickjillings@1512 1890 // Add to the holder.
nickjillings@1512 1891 this.holder.appendChild(this.string);
nickjillings@1512 1892 this.holder.appendChild(br);
nickjillings@1512 1893 this.options = [];
nickjillings@1512 1894 this.inputs = document.createElement('div');
nickjillings@1512 1895 this.span = document.createElement('div');
nickjillings@1512 1896 this.inputs.align = 'center';
nickjillings@1512 1897 this.inputs.style.marginLeft = '12px';
nickjillings@1512 1898 this.span.style.marginLeft = '12px';
nickjillings@1512 1899 this.span.align = 'center';
nickjillings@1512 1900 this.span.style.marginTop = '15px';
nickjillings@1512 1901
nickjillings@1512 1902 var optCount = commentQuestion.options.length;
nickjillings@1512 1903 var spanMargin = Math.floor(((600-(optCount*100))/(optCount))/2)+'px';
nickjillings@1512 1904 console.log(spanMargin);
nickjillings@1512 1905 for (var i=0; i<optCount; i++)
nickjillings@1512 1906 {
nickjillings@1512 1907 var div = document.createElement('div');
nickjillings@1512 1908 div.style.width = '100px';
nickjillings@1512 1909 div.style.float = 'left';
nickjillings@1512 1910 div.style.marginRight = spanMargin;
nickjillings@1512 1911 div.style.marginLeft = spanMargin;
nickjillings@1512 1912 var input = document.createElement('input');
nickjillings@1512 1913 input.type = 'checkbox';
nickjillings@1512 1914 input.name = commentQuestion.id;
nickjillings@1512 1915 input.setAttribute('setvalue',commentQuestion.options[i].name);
nickjillings@1512 1916 input.className = 'comment-radio';
nickjillings@1512 1917 div.appendChild(input);
nickjillings@1512 1918 this.inputs.appendChild(div);
nickjillings@1512 1919
nickjillings@1512 1920
nickjillings@1512 1921 div = document.createElement('div');
nickjillings@1512 1922 div.style.width = '100px';
nickjillings@1512 1923 div.style.float = 'left';
nickjillings@1512 1924 div.style.marginRight = spanMargin;
nickjillings@1512 1925 div.style.marginLeft = spanMargin;
nickjillings@1512 1926 div.align = 'center';
nickjillings@1512 1927 var span = document.createElement('span');
nickjillings@1512 1928 span.textContent = commentQuestion.options[i].text;
nickjillings@1512 1929 span.className = 'comment-radio-span';
nickjillings@1512 1930 div.appendChild(span);
nickjillings@1512 1931 this.span.appendChild(div);
nickjillings@1512 1932 this.options.push(input);
nickjillings@1512 1933 }
nickjillings@1512 1934 this.holder.appendChild(this.span);
nickjillings@1512 1935 this.holder.appendChild(this.inputs);
nickjillings@1512 1936
nickjillings@1512 1937 this.exportXMLDOM = function() {
nickjillings@1512 1938 var root = document.createElement('comment');
nickjillings@1512 1939 root.id = this.specification.id;
nickjillings@1512 1940 root.setAttribute('type',this.specification.type);
nickjillings@1512 1941 var question = document.createElement('question');
nickjillings@1512 1942 question.textContent = this.string.textContent;
nickjillings@1512 1943 root.appendChild(question);
nickjillings@1512 1944 console.log('Comment: '+question.textContent);
nickjillings@1512 1945 for (var i=0; i<this.options.length; i++) {
nickjillings@1512 1946 var response = document.createElement('response');
nickjillings@1512 1947 response.textContent = this.options[i].checked;
nickjillings@1512 1948 response.setAttribute('name',this.options[i].getAttribute('setvalue'));
nickjillings@1512 1949 root.appendChild(response);
nickjillings@1512 1950 console.log('Response '+response.getAttribute('name') +': '+response.textContent);
nickjillings@1512 1951 }
nickjillings@1512 1952 return root;
nickjillings@1512 1953 };
nickjillings@1512 1954 };
nickjillings@1512 1955
nickjillings@1512 1956 this.createCommentBox = function(audioObject) {
nickjillings@1512 1957 var node = new this.elementCommentBox(audioObject);
nickjillings@1512 1958 this.commentBoxes.push(node);
nickjillings@1512 1959 audioObject.commentDOM = node;
nickjillings@1512 1960 return node;
nickjillings@1512 1961 };
nickjillings@1512 1962
nickjillings@1512 1963 this.sortCommentBoxes = function() {
nickjillings@1512 1964 var holder = [];
nickjillings@1512 1965 while (this.commentBoxes.length > 0) {
nickjillings@1512 1966 var node = this.commentBoxes.pop(0);
nickjillings@1512 1967 holder[node.id] = node;
nickjillings@1512 1968 }
nickjillings@1512 1969 this.commentBoxes = holder;
nickjillings@1512 1970 };
nickjillings@1512 1971
nickjillings@1512 1972 this.showCommentBoxes = function(inject, sort) {
nickjillings@1512 1973 if (sort) {interfaceContext.sortCommentBoxes();}
nickjillings@1512 1974 for (var i=0; i<interfaceContext.commentBoxes.length; i++) {
nickjillings@1512 1975 inject.appendChild(this.commentBoxes[i].trackComment);
nickjillings@1512 1976 }
nickjillings@1512 1977 };
nickjillings@1512 1978
nickjillings@1512 1979 this.deleteCommentBoxes = function() {
nickjillings@1512 1980 this.commentBoxes = [];
nickjillings@1512 1981 };
nickjillings@1512 1982
nickjillings@1512 1983 this.createCommentQuestion = function(element) {
nickjillings@1512 1984 var node;
nickjillings@1512 1985 if (element.type == 'text') {
nickjillings@1512 1986 node = new this.commentBox(element);
nickjillings@1512 1987 } else if (element.type == 'radio') {
nickjillings@1512 1988 node = new this.radioBox(element);
nickjillings@1512 1989 } else if (element.type == 'checkbox') {
nickjillings@1512 1990 node = new this.checkboxBox(element);
nickjillings@1512 1991 }
nickjillings@1512 1992 this.commentQuestions.push(node);
nickjillings@1512 1993 return node;
nickjillings@1512 1994 };
nickjillings@1512 1995
nickjillings@1512 1996 this.deleteCommentQuestions = function()
nickjillings@1512 1997 {
nickjillings@1512 1998 this.commentQuestions = [];
nickjillings@1512 1999 };
nickjillings@1512 2000
nickjillings@1512 2001 this.playhead = new function()
nickjillings@1512 2002 {
nickjillings@1512 2003 this.object = document.createElement('div');
nickjillings@1512 2004 this.object.className = 'playhead';
nickjillings@1512 2005 this.object.align = 'left';
nickjillings@1512 2006 var curTime = document.createElement('div');
nickjillings@1512 2007 curTime.style.width = '50px';
nickjillings@1512 2008 this.curTimeSpan = document.createElement('span');
nickjillings@1512 2009 this.curTimeSpan.textContent = '00:00';
nickjillings@1512 2010 curTime.appendChild(this.curTimeSpan);
nickjillings@1512 2011 this.object.appendChild(curTime);
nickjillings@1512 2012 this.scrubberTrack = document.createElement('div');
nickjillings@1512 2013 this.scrubberTrack.className = 'playhead-scrub-track';
nickjillings@1512 2014
nickjillings@1512 2015 this.scrubberHead = document.createElement('div');
nickjillings@1512 2016 this.scrubberHead.id = 'playhead-scrubber';
nickjillings@1512 2017 this.scrubberTrack.appendChild(this.scrubberHead);
nickjillings@1512 2018 this.object.appendChild(this.scrubberTrack);
nickjillings@1512 2019
nickjillings@1512 2020 this.timePerPixel = 0;
nickjillings@1512 2021 this.maxTime = 0;
nickjillings@1512 2022
nickjillings@1512 2023 this.playbackObject;
nickjillings@1512 2024
nickjillings@1512 2025 this.setTimePerPixel = function(audioObject) {
nickjillings@1512 2026 //maxTime must be in seconds
nickjillings@1512 2027 this.playbackObject = audioObject;
nickjillings@1512 2028 this.maxTime = audioObject.buffer.duration;
nickjillings@1512 2029 var width = 490; //500 - 10, 5 each side of the tracker head
nickjillings@1512 2030 this.timePerPixel = this.maxTime/490;
nickjillings@1512 2031 if (this.maxTime < 60) {
nickjillings@1512 2032 this.curTimeSpan.textContent = '0.00';
nickjillings@1512 2033 } else {
nickjillings@1512 2034 this.curTimeSpan.textContent = '00:00';
nickjillings@1512 2035 }
nickjillings@1512 2036 };
nickjillings@1512 2037
nickjillings@1512 2038 this.update = function() {
nickjillings@1512 2039 // Update the playhead position, startPlay must be called
nickjillings@1512 2040 if (this.timePerPixel > 0) {
nickjillings@1512 2041 var time = this.playbackObject.getCurrentPosition();
nickjillings@1512 2042 if (time > 0) {
nickjillings@1512 2043 var width = 490;
nickjillings@1512 2044 var pix = Math.floor(time/this.timePerPixel);
nickjillings@1512 2045 this.scrubberHead.style.left = pix+'px';
nickjillings@1512 2046 if (this.maxTime > 60.0) {
nickjillings@1512 2047 var secs = time%60;
nickjillings@1512 2048 var mins = Math.floor((time-secs)/60);
nickjillings@1512 2049 secs = secs.toString();
nickjillings@1512 2050 secs = secs.substr(0,2);
nickjillings@1512 2051 mins = mins.toString();
nickjillings@1512 2052 this.curTimeSpan.textContent = mins+':'+secs;
nickjillings@1512 2053 } else {
nickjillings@1512 2054 time = time.toString();
nickjillings@1512 2055 this.curTimeSpan.textContent = time.substr(0,4);
nickjillings@1512 2056 }
nickjillings@1512 2057 } else {
nickjillings@1512 2058 this.scrubberHead.style.left = '0px';
nickjillings@1512 2059 if (this.maxTime < 60) {
nickjillings@1512 2060 this.curTimeSpan.textContent = '0.00';
nickjillings@1512 2061 } else {
nickjillings@1512 2062 this.curTimeSpan.textContent = '00:00';
nickjillings@1512 2063 }
nickjillings@1512 2064 }
nickjillings@1512 2065 }
nickjillings@1512 2066 };
nickjillings@1512 2067
nickjillings@1512 2068 this.interval = undefined;
nickjillings@1512 2069
nickjillings@1512 2070 this.start = function() {
nickjillings@1512 2071 if (this.playbackObject != undefined && this.interval == undefined) {
nickjillings@1512 2072 if (this.maxTime < 60) {
nickjillings@1512 2073 this.interval = setInterval(function(){interfaceContext.playhead.update();},10);
nickjillings@1512 2074 } else {
nickjillings@1512 2075 this.interval = setInterval(function(){interfaceContext.playhead.update();},100);
nickjillings@1512 2076 }
nickjillings@1512 2077 }
nickjillings@1512 2078 };
nickjillings@1512 2079 this.stop = function() {
nickjillings@1512 2080 clearInterval(this.interval);
nickjillings@1512 2081 this.interval = undefined;
nickjillings@1512 2082 if (this.maxTime < 60) {
nickjillings@1512 2083 this.curTimeSpan.textContent = '0.00';
nickjillings@1512 2084 } else {
nickjillings@1512 2085 this.curTimeSpan.textContent = '00:00';
nickjillings@1512 2086 }
nickjillings@1512 2087 };
nickjillings@1512 2088 };
nickjillings@1512 2089
nickjillings@1512 2090 // Global Checkers
nickjillings@1512 2091 // These functions will help enforce the checkers
nickjillings@1512 2092 this.checkHiddenAnchor = function()
nickjillings@1512 2093 {
nickjillings@1512 2094 var audioHolder = testState.currentStateMap[testState.currentIndex];
nickjillings@1512 2095 if (audioHolder.anchorId != null)
nickjillings@1512 2096 {
nickjillings@1512 2097 var audioObject = audioEngineContext.audioObjects[audioHolder.anchorId];
nickjillings@1512 2098 if (audioObject.interfaceDOM.getValue() > audioObject.specification.marker && audioObject.interfaceDOM.enforce == true)
nickjillings@1512 2099 {
nickjillings@1512 2100 // Anchor is not set below
nickjillings@1512 2101 console.log('Anchor node not below marker value');
nickjillings@1512 2102 alert('Please keep listening');
nickjillings@1512 2103 return false;
nickjillings@1512 2104 }
nickjillings@1512 2105 }
nickjillings@1512 2106 return true;
nickjillings@1512 2107 };
nickjillings@1512 2108
nickjillings@1512 2109 this.checkHiddenReference = function()
nickjillings@1512 2110 {
nickjillings@1512 2111 var audioHolder = testState.currentStateMap[testState.currentIndex];
nickjillings@1512 2112 if (audioHolder.referenceId != null)
nickjillings@1512 2113 {
nickjillings@1512 2114 var audioObject = audioEngineContext.audioObjects[audioHolder.referenceId];
nickjillings@1512 2115 if (audioObject.interfaceDOM.getValue() < audioObject.specification.marker && audioObject.interfaceDOM.enforce == true)
nickjillings@1512 2116 {
nickjillings@1512 2117 // Anchor is not set below
nickjillings@1512 2118 console.log('Reference node not above marker value');
nickjillings@1512 2119 alert('Please keep listening');
nickjillings@1512 2120 return false;
nickjillings@1512 2121 }
nickjillings@1512 2122 }
nickjillings@1512 2123 return true;
nickjillings@1512 2124 };
nickjillings@1512 2125 }