annotate core.js @ 1520:349e0572ca2c

Feature #1298: <setup> node has an optional attribute testPages. Specify the number of pages the test participant to do and the tool will select a random page up to the number specified.
author Nicholas Jillings <nickjillings@users.noreply.github.com>
date Thu, 10 Sep 2015 13:16:16 +0100
parents 838d8e59c8ff
children 36a0054a0ee0
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 $(specification.audioHolders).each(function(index,elem){
nickjillings@1512 554 testState.stateMap.push(elem);
nickjillings@1512 555 });
nickjillings@1512 556
nickjillings@1512 557 testState.stateMap.push(specification.postTest);
nickjillings@1512 558
nickjillings@1512 559 // Obtain the metrics enabled
nickjillings@1512 560 $(specification.metrics).each(function(index,node){
nickjillings@1512 561 var enabled = node.textContent;
nickjillings@1512 562 switch(node.enabled)
nickjillings@1512 563 {
nickjillings@1512 564 case 'testTimer':
nickjillings@1512 565 sessionMetrics.prototype.enableTestTimer = true;
nickjillings@1512 566 break;
nickjillings@1512 567 case 'elementTimer':
nickjillings@1512 568 sessionMetrics.prototype.enableElementTimer = true;
nickjillings@1512 569 break;
nickjillings@1512 570 case 'elementTracker':
nickjillings@1512 571 sessionMetrics.prototype.enableElementTracker = true;
nickjillings@1512 572 break;
nickjillings@1512 573 case 'elementListenTracker':
nickjillings@1512 574 sessionMetrics.prototype.enableElementListenTracker = true;
nickjillings@1512 575 break;
nickjillings@1512 576 case 'elementInitialPosition':
nickjillings@1512 577 sessionMetrics.prototype.enableElementInitialPosition = true;
nickjillings@1512 578 break;
nickjillings@1512 579 case 'elementFlagListenedTo':
nickjillings@1512 580 sessionMetrics.prototype.enableFlagListenedTo = true;
nickjillings@1512 581 break;
nickjillings@1512 582 case 'elementFlagMoved':
nickjillings@1512 583 sessionMetrics.prototype.enableFlagMoved = true;
nickjillings@1512 584 break;
nickjillings@1512 585 case 'elementFlagComments':
nickjillings@1512 586 sessionMetrics.prototype.enableFlagComments = true;
nickjillings@1512 587 break;
nickjillings@1512 588 }
nickjillings@1512 589 });
nickjillings@1512 590
nickjillings@1512 591
nickjillings@1512 592
nickjillings@1512 593 // Detect the interface to use and load the relevant javascripts.
nickjillings@1512 594 var interfaceJS = document.createElement('script');
nickjillings@1512 595 interfaceJS.setAttribute("type","text/javascript");
nickjillings@1512 596 if (specification.interfaceType == 'APE') {
nickjillings@1512 597 interfaceJS.setAttribute("src","ape.js");
nickjillings@1512 598
nickjillings@1512 599 // APE comes with a css file
nickjillings@1512 600 var css = document.createElement('link');
nickjillings@1512 601 css.rel = 'stylesheet';
nickjillings@1512 602 css.type = 'text/css';
nickjillings@1512 603 css.href = 'ape.css';
nickjillings@1512 604
nickjillings@1512 605 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1514 606 } else if (specification.interfaceType == "MUSHRA")
nickjillings@1514 607 {
nickjillings@1514 608 interfaceJS.setAttribute("src","mushra.js");
nickjillings@1514 609
nickjillings@1514 610 // MUSHRA comes with a css file
nickjillings@1514 611 var css = document.createElement('link');
nickjillings@1514 612 css.rel = 'stylesheet';
nickjillings@1514 613 css.type = 'text/css';
nickjillings@1514 614 css.href = 'mushra.css';
nickjillings@1514 615
nickjillings@1514 616 document.getElementsByTagName("head")[0].appendChild(css);
nickjillings@1512 617 }
nickjillings@1512 618 document.getElementsByTagName("head")[0].appendChild(interfaceJS);
nickjillings@1512 619
nickjillings@1512 620 // Define window callbacks for interface
nickjillings@1512 621 window.onresize = function(event){resizeWindow(event);};
nickjillings@1512 622 }
nickjillings@1512 623
nickjillings@1512 624 function createProjectSave(destURL) {
nickjillings@1512 625 // Save the data from interface into XML and send to destURL
nickjillings@1512 626 // If destURL is null then download XML in client
nickjillings@1512 627 // Now time to render file locally
nickjillings@1512 628 var xmlDoc = interfaceXMLSave();
nickjillings@1512 629 var parent = document.createElement("div");
nickjillings@1512 630 parent.appendChild(xmlDoc);
nickjillings@1512 631 var file = [parent.innerHTML];
nickjillings@1512 632 if (destURL == "null" || destURL == undefined) {
nickjillings@1512 633 var bb = new Blob(file,{type : 'application/xml'});
nickjillings@1512 634 var dnlk = window.URL.createObjectURL(bb);
nickjillings@1512 635 var a = document.createElement("a");
nickjillings@1512 636 a.hidden = '';
nickjillings@1512 637 a.href = dnlk;
nickjillings@1512 638 a.download = "save.xml";
nickjillings@1512 639 a.textContent = "Save File";
nickjillings@1512 640
nickjillings@1512 641 popup.showPopup();
nickjillings@1512 642 popup.popupContent.innerHTML = null;
nickjillings@1512 643 popup.popupContent.appendChild(a);
nickjillings@1512 644 } else {
nickjillings@1512 645 var xmlhttp = new XMLHttpRequest;
nickjillings@1512 646 xmlhttp.open("POST",destURL,true);
nickjillings@1512 647 xmlhttp.setRequestHeader('Content-Type', 'text/xml');
nickjillings@1512 648 xmlhttp.onerror = function(){
nickjillings@1512 649 console.log('Error saving file to server! Presenting download locally');
nickjillings@1512 650 createProjectSave(null);
nickjillings@1512 651 };
nickjillings@1512 652 xmlhttp.onreadystatechange = function() {
nickjillings@1512 653 console.log(xmlhttp.status);
nickjillings@1512 654 if (xmlhttp.status != 200 && xmlhttp.readyState == 4) {
nickjillings@1512 655 createProjectSave(null);
nickjillings@1512 656 } else {
nickjillings@1512 657 popup.showPopup();
nickjillings@1512 658 popup.popupContent.innerHTML = null;
nickjillings@1512 659 popup.popupContent.textContent = "Thank you for performing this listening test";
nickjillings@1512 660 }
nickjillings@1512 661 };
nickjillings@1512 662 xmlhttp.send(file);
nickjillings@1512 663 }
nickjillings@1512 664 }
nickjillings@1512 665
nickjillings@1512 666 function errorSessionDump(msg){
nickjillings@1512 667 // Create the partial interface XML save
nickjillings@1512 668 // Include error node with message on why the dump occured
nickjillings@1512 669 var xmlDoc = interfaceXMLSave();
nickjillings@1512 670 var err = document.createElement('error');
nickjillings@1512 671 err.textContent = msg;
nickjillings@1512 672 xmlDoc.appendChild(err);
nickjillings@1512 673 var parent = document.createElement("div");
nickjillings@1512 674 parent.appendChild(xmlDoc);
nickjillings@1512 675 var file = [parent.innerHTML];
nickjillings@1512 676 var bb = new Blob(file,{type : 'application/xml'});
nickjillings@1512 677 var dnlk = window.URL.createObjectURL(bb);
nickjillings@1512 678 var a = document.createElement("a");
nickjillings@1512 679 a.hidden = '';
nickjillings@1512 680 a.href = dnlk;
nickjillings@1512 681 a.download = "save.xml";
nickjillings@1512 682 a.textContent = "Save File";
nickjillings@1512 683
nickjillings@1512 684 popup.showPopup();
nickjillings@1512 685 popup.popupContent.innerHTML = "ERROR : "+msg;
nickjillings@1512 686 popup.popupContent.appendChild(a);
nickjillings@1512 687 }
nickjillings@1512 688
nickjillings@1512 689 // Only other global function which must be defined in the interface class. Determines how to create the XML document.
nickjillings@1512 690 function interfaceXMLSave(){
nickjillings@1512 691 // Create the XML string to be exported with results
nickjillings@1512 692 var xmlDoc = document.createElement("BrowserEvaluationResult");
nickjillings@1512 693 var projectDocument = specification.projectXML;
nickjillings@1512 694 projectDocument.setAttribute('file-name',url);
nickjillings@1512 695 xmlDoc.appendChild(projectDocument);
nickjillings@1512 696 xmlDoc.appendChild(returnDateNode());
nickjillings@1512 697 for (var i=0; i<testState.stateResults.length; i++)
nickjillings@1512 698 {
nickjillings@1512 699 xmlDoc.appendChild(testState.stateResults[i]);
nickjillings@1512 700 }
nickjillings@1512 701
nickjillings@1512 702 return xmlDoc;
nickjillings@1512 703 }
nickjillings@1512 704
nickjillings@1512 705 function AudioEngine() {
nickjillings@1512 706
nickjillings@1512 707 // Create two output paths, the main outputGain and fooGain.
nickjillings@1512 708 // Output gain is default to 1 and any items for playback route here
nickjillings@1512 709 // Foo gain is used for analysis to ensure paths get processed, but are not heard
nickjillings@1512 710 // because web audio will optimise and any route which does not go to the destination gets ignored.
nickjillings@1512 711 this.outputGain = audioContext.createGain();
nickjillings@1512 712 this.fooGain = audioContext.createGain();
nickjillings@1512 713 this.fooGain.gain = 0;
nickjillings@1512 714
nickjillings@1512 715 // Use this to detect playback state: 0 - stopped, 1 - playing
nickjillings@1512 716 this.status = 0;
nickjillings@1512 717 this.audioObjectsReady = false;
nickjillings@1512 718
nickjillings@1512 719 // Connect both gains to output
nickjillings@1512 720 this.outputGain.connect(audioContext.destination);
nickjillings@1512 721 this.fooGain.connect(audioContext.destination);
nickjillings@1512 722
nickjillings@1512 723 // Create the timer Object
nickjillings@1512 724 this.timer = new timer();
nickjillings@1512 725 // Create session metrics
nickjillings@1512 726 this.metric = new sessionMetrics(this);
nickjillings@1512 727
nickjillings@1512 728 this.loopPlayback = false;
nickjillings@1512 729
nickjillings@1512 730 // Create store for new audioObjects
nickjillings@1512 731 this.audioObjects = [];
nickjillings@1512 732
nickjillings@1512 733 this.play = function(id) {
nickjillings@1512 734 // Start the timer and set the audioEngine state to playing (1)
nickjillings@1512 735 if (this.status == 0) {
nickjillings@1512 736 // Check if all audioObjects are ready
nickjillings@1512 737 if (this.audioObjectsReady == false) {
nickjillings@1512 738 this.audioObjectsReady = this.checkAllReady();
nickjillings@1512 739 }
nickjillings@1512 740 if (this.audioObjectsReady == true) {
nickjillings@1512 741 this.timer.startTest();
nickjillings@1512 742 if (this.loopPlayback)
nickjillings@1512 743 {this.setSynchronousLoop();}
nickjillings@1512 744 this.status = 1;
nickjillings@1512 745 }
nickjillings@1512 746 }
nickjillings@1512 747 if (this.status== 1) {
nickjillings@1512 748 if (id == undefined) {
nickjillings@1512 749 id = -1;
nickjillings@1512 750 } else {
nickjillings@1512 751 interfaceContext.playhead.setTimePerPixel(this.audioObjects[id]);
nickjillings@1512 752 }
nickjillings@1512 753 if (this.loopPlayback) {
nickjillings@1512 754 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 755 {
nickjillings@1512 756 this.audioObjects[i].play(this.timer.getTestTime()+1);
nickjillings@1512 757 if (id == i) {
nickjillings@1512 758 this.audioObjects[i].loopStart();
nickjillings@1512 759 } else {
nickjillings@1512 760 this.audioObjects[i].loopStop();
nickjillings@1512 761 }
nickjillings@1512 762 }
nickjillings@1512 763 } else {
nickjillings@1512 764 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 765 {
nickjillings@1512 766 if (i != id) {
nickjillings@1512 767 this.audioObjects[i].outputGain.gain.value = 0.0;
nickjillings@1512 768 this.audioObjects[i].stop();
nickjillings@1512 769 } else if (i == id) {
nickjillings@1512 770 this.audioObjects[id].outputGain.gain.value = 1.0;
nickjillings@1512 771 this.audioObjects[id].play(audioContext.currentTime+0.01);
nickjillings@1512 772 }
nickjillings@1512 773 }
nickjillings@1512 774 }
nickjillings@1512 775 interfaceContext.playhead.start();
nickjillings@1512 776 }
nickjillings@1512 777 };
nickjillings@1512 778
nickjillings@1512 779 this.stop = function() {
nickjillings@1512 780 // Send stop and reset command to all playback buffers and set audioEngine state to stopped (1)
nickjillings@1512 781 if (this.status == 1) {
nickjillings@1512 782 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 783 {
nickjillings@1512 784 this.audioObjects[i].stop();
nickjillings@1512 785 }
nickjillings@1512 786 interfaceContext.playhead.stop();
nickjillings@1512 787 this.status = 0;
nickjillings@1512 788 }
nickjillings@1512 789 };
nickjillings@1512 790
nickjillings@1512 791 this.newTrack = function(element) {
nickjillings@1512 792 // Pull data from given URL into new audio buffer
nickjillings@1512 793 // URLs must either be from the same source OR be setup to 'Access-Control-Allow-Origin'
nickjillings@1512 794
nickjillings@1512 795 // Create the audioObject with ID of the new track length;
nickjillings@1512 796 audioObjectId = this.audioObjects.length;
nickjillings@1512 797 this.audioObjects[audioObjectId] = new audioObject(audioObjectId);
nickjillings@1512 798
nickjillings@1512 799 // AudioObject will get track itself.
nickjillings@1512 800 this.audioObjects[audioObjectId].specification = element;
nickjillings@1512 801 this.audioObjects[audioObjectId].constructTrack(element.parent.hostURL + element.url);
nickjillings@1512 802 return this.audioObjects[audioObjectId];
nickjillings@1512 803 };
nickjillings@1512 804
nickjillings@1512 805 this.newTestPage = function() {
nickjillings@1512 806 this.state = 0;
nickjillings@1512 807 this.audioObjectsReady = false;
nickjillings@1512 808 this.metric.reset();
nickjillings@1512 809 this.audioObjects = [];
nickjillings@1512 810 };
nickjillings@1512 811
nickjillings@1512 812 this.checkAllPlayed = function() {
nickjillings@1512 813 arr = [];
nickjillings@1512 814 for (var id=0; id<this.audioObjects.length; id++) {
nickjillings@1512 815 if (this.audioObjects[id].metric.wasListenedTo == false) {
nickjillings@1512 816 arr.push(this.audioObjects[id].id);
nickjillings@1512 817 }
nickjillings@1512 818 }
nickjillings@1512 819 return arr;
nickjillings@1512 820 };
nickjillings@1512 821
nickjillings@1512 822 this.checkAllReady = function() {
nickjillings@1512 823 var ready = true;
nickjillings@1512 824 for (var i=0; i<this.audioObjects.length; i++) {
nickjillings@1512 825 if (this.audioObjects[i].state == 0) {
nickjillings@1512 826 // Track not ready
nickjillings@1512 827 console.log('WAIT -- audioObject '+i+' not ready yet!');
nickjillings@1512 828 ready = false;
nickjillings@1512 829 };
nickjillings@1512 830 }
nickjillings@1512 831 return ready;
nickjillings@1512 832 };
nickjillings@1512 833
nickjillings@1512 834 this.setSynchronousLoop = function() {
nickjillings@1512 835 // Pads the signals so they are all exactly the same length
nickjillings@1512 836 if (this.audioObjectsReady)
nickjillings@1512 837 {
nickjillings@1512 838 var length = 0;
nickjillings@1512 839 var lens = [];
nickjillings@1512 840 var maxId;
nickjillings@1512 841 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1512 842 {
nickjillings@1512 843 lens.push(this.audioObjects[i].buffer.length);
nickjillings@1512 844 if (length < this.audioObjects[i].buffer.length)
nickjillings@1512 845 {
nickjillings@1512 846 length = this.audioObjects[i].buffer.length;
nickjillings@1512 847 maxId = i;
nickjillings@1512 848 }
nickjillings@1512 849 }
nickjillings@1512 850 // Perform difference
nickjillings@1512 851 for (var i=0; i<lens.length; i++)
nickjillings@1512 852 {
nickjillings@1512 853 lens[i] = length - lens[i];
nickjillings@1512 854 }
nickjillings@1512 855 // Extract the audio and zero-pad
nickjillings@1512 856 for (var i=0; i<lens.length; i++)
nickjillings@1512 857 {
nickjillings@1512 858 var orig = this.audioObjects[i].buffer;
nickjillings@1512 859 var hold = audioContext.createBuffer(orig.numberOfChannels,length,orig.sampleRate);
nickjillings@1512 860 for (var c=0; c<orig.numberOfChannels; c++)
nickjillings@1512 861 {
nickjillings@1512 862 var inData = hold.getChannelData(c);
nickjillings@1512 863 var outData = orig.getChannelData(c);
nickjillings@1512 864 for (var n=0; n<orig.length; n++)
nickjillings@1512 865 {inData[n] = outData[n];}
nickjillings@1512 866 }
nickjillings@1512 867 this.audioObjects[i].buffer = hold;
nickjillings@1512 868 delete orig;
nickjillings@1512 869 }
nickjillings@1512 870 }
nickjillings@1512 871 };
nickjillings@1512 872
nickjillings@1512 873 }
nickjillings@1512 874
nickjillings@1512 875 function audioObject(id) {
nickjillings@1512 876 // The main buffer object with common control nodes to the AudioEngine
nickjillings@1512 877
nickjillings@1512 878 this.specification;
nickjillings@1512 879 this.id = id;
nickjillings@1512 880 this.state = 0; // 0 - no data, 1 - ready
nickjillings@1512 881 this.url = null; // Hold the URL given for the output back to the results.
nickjillings@1512 882 this.metric = new metricTracker(this);
nickjillings@1512 883
nickjillings@1512 884 // Bindings for GUI
nickjillings@1512 885 this.interfaceDOM = null;
nickjillings@1512 886 this.commentDOM = null;
nickjillings@1512 887
nickjillings@1512 888 // Create a buffer and external gain control to allow internal patching of effects and volume leveling.
nickjillings@1512 889 this.bufferNode = undefined;
nickjillings@1512 890 this.outputGain = audioContext.createGain();
nickjillings@1512 891
nickjillings@1512 892 // Default output gain to be zero
nickjillings@1512 893 this.outputGain.gain.value = 0.0;
nickjillings@1512 894
nickjillings@1512 895 // Connect buffer to the audio graph
nickjillings@1512 896 this.outputGain.connect(audioEngineContext.outputGain);
nickjillings@1512 897
nickjillings@1512 898 // the audiobuffer is not designed for multi-start playback
nickjillings@1512 899 // When stopeed, the buffer node is deleted and recreated with the stored buffer.
nickjillings@1512 900 this.buffer;
nickjillings@1512 901
nickjillings@1512 902 this.loopStart = function() {
nickjillings@1512 903 this.outputGain.gain.value = 1.0;
nickjillings@1512 904 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1512 905 };
nickjillings@1512 906
nickjillings@1512 907 this.loopStop = function() {
nickjillings@1512 908 if (this.outputGain.gain.value != 0.0) {
nickjillings@1512 909 this.outputGain.gain.value = 0.0;
nickjillings@1512 910 this.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@1512 911 }
nickjillings@1512 912 };
nickjillings@1512 913
nickjillings@1512 914 this.play = function(startTime) {
nickjillings@1512 915 if (this.bufferNode == undefined) {
nickjillings@1512 916 this.bufferNode = audioContext.createBufferSource();
nickjillings@1512 917 this.bufferNode.owner = this;
nickjillings@1512 918 this.bufferNode.connect(this.outputGain);
nickjillings@1512 919 this.bufferNode.buffer = this.buffer;
nickjillings@1512 920 this.bufferNode.loop = audioEngineContext.loopPlayback;
nickjillings@1512 921 this.bufferNode.onended = function() {
nickjillings@1512 922 // Safari does not like using 'this' to reference the calling object!
nickjillings@1512 923 event.srcElement.owner.metric.stopListening(audioEngineContext.timer.getTestTime(),event.srcElement.owner.getCurrentPosition());
nickjillings@1512 924 };
nickjillings@1512 925 if (this.bufferNode.loop == false) {
nickjillings@1512 926 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1512 927 }
nickjillings@1512 928 this.bufferNode.start(startTime);
nickjillings@1512 929 }
nickjillings@1512 930 };
nickjillings@1512 931
nickjillings@1512 932 this.stop = function() {
nickjillings@1512 933 if (this.bufferNode != undefined)
nickjillings@1512 934 {
nickjillings@1512 935 this.metric.stopListening(audioEngineContext.timer.getTestTime(),this.getCurrentPosition());
nickjillings@1512 936 this.bufferNode.stop(0);
nickjillings@1512 937 this.bufferNode = undefined;
nickjillings@1512 938 }
nickjillings@1512 939 };
nickjillings@1512 940
nickjillings@1512 941 this.getCurrentPosition = function() {
nickjillings@1512 942 var time = audioEngineContext.timer.getTestTime();
nickjillings@1512 943 if (this.bufferNode != undefined) {
nickjillings@1512 944 if (this.bufferNode.loop == true) {
nickjillings@1512 945 if (audioEngineContext.status == 1) {
nickjillings@1512 946 return time%this.buffer.duration;
nickjillings@1512 947 } else {
nickjillings@1512 948 return 0;
nickjillings@1512 949 }
nickjillings@1512 950 } else {
nickjillings@1512 951 if (this.metric.listenHold) {
nickjillings@1512 952 return time - this.metric.listenStart;
nickjillings@1512 953 } else {
nickjillings@1512 954 return 0;
nickjillings@1512 955 }
nickjillings@1512 956 }
nickjillings@1512 957 } else {
nickjillings@1512 958 return 0;
nickjillings@1512 959 }
nickjillings@1512 960 };
nickjillings@1512 961
nickjillings@1512 962 this.constructTrack = function(url) {
nickjillings@1512 963 var request = new XMLHttpRequest();
nickjillings@1512 964 this.url = url;
nickjillings@1512 965 request.open('GET',url,true);
nickjillings@1512 966 request.responseType = 'arraybuffer';
nickjillings@1512 967
nickjillings@1512 968 var audioObj = this;
nickjillings@1512 969
nickjillings@1512 970 // Create callback to decode the data asynchronously
nickjillings@1512 971 request.onloadend = function() {
nickjillings@1512 972 audioContext.decodeAudioData(request.response, function(decodedData) {
nickjillings@1512 973 audioObj.buffer = decodedData;
nickjillings@1512 974 audioObj.state = 1;
nickjillings@1512 975 if (audioObj.specification.type != 'outsidereference')
nickjillings@1512 976 {audioObj.interfaceDOM.enable();}
nickjillings@1512 977 }, function(){
nickjillings@1512 978 // Should only be called if there was an error, but sometimes gets called continuously
nickjillings@1512 979 // Check here if the error is genuine
nickjillings@1512 980 if (audioObj.state == 0 || audioObj.buffer == undefined) {
nickjillings@1512 981 // Genuine error
nickjillings@1512 982 console.log('FATAL - Error loading buffer on '+audioObj.id);
nickjillings@1512 983 if (request.status == 404)
nickjillings@1512 984 {
nickjillings@1512 985 console.log('FATAL - Fragment '+audioObj.id+' 404 error');
nickjillings@1512 986 console.log('URL: '+audioObj.url);
nickjillings@1512 987 errorSessionDump('Fragment '+audioObj.id+' 404 error');
nickjillings@1512 988 }
nickjillings@1512 989 }
nickjillings@1512 990 });
nickjillings@1512 991 };
nickjillings@1512 992 request.send();
nickjillings@1512 993 };
nickjillings@1512 994
nickjillings@1512 995 this.exportXMLDOM = function() {
nickjillings@1512 996 var root = document.createElement('audioElement');
nickjillings@1512 997 root.id = this.specification.id;
nickjillings@1512 998 root.setAttribute('url',this.url);
nickjillings@1512 999 var file = document.createElement('file');
nickjillings@1512 1000 file.setAttribute('sampleRate',this.buffer.sampleRate);
nickjillings@1512 1001 file.setAttribute('channels',this.buffer.numberOfChannels);
nickjillings@1512 1002 file.setAttribute('sampleCount',this.buffer.length);
nickjillings@1512 1003 file.setAttribute('duration',this.buffer.duration);
nickjillings@1512 1004 root.appendChild(file);
nickjillings@1512 1005 if (this.specification.type != 'outsidereference') {
nickjillings@1512 1006 root.appendChild(this.interfaceDOM.exportXMLDOM(this));
nickjillings@1512 1007 root.appendChild(this.commentDOM.exportXMLDOM(this));
nickjillings@1512 1008 if(this.specification.type == 'anchor') {
nickjillings@1512 1009 root.setAttribute('anchor',true);
nickjillings@1512 1010 } else if(this.specification.type == 'reference') {
nickjillings@1512 1011 root.setAttribute('reference',true);
nickjillings@1512 1012 }
nickjillings@1512 1013 }
nickjillings@1512 1014 root.appendChild(this.metric.exportXMLDOM());
nickjillings@1512 1015 return root;
nickjillings@1512 1016 };
nickjillings@1512 1017 }
nickjillings@1512 1018
nickjillings@1512 1019 function timer()
nickjillings@1512 1020 {
nickjillings@1512 1021 /* Timer object used in audioEngine to keep track of session timings
nickjillings@1512 1022 * Uses the timer of the web audio API, so sample resolution
nickjillings@1512 1023 */
nickjillings@1512 1024 this.testStarted = false;
nickjillings@1512 1025 this.testStartTime = 0;
nickjillings@1512 1026 this.testDuration = 0;
nickjillings@1512 1027 this.minimumTestTime = 0; // No minimum test time
nickjillings@1512 1028 this.startTest = function()
nickjillings@1512 1029 {
nickjillings@1512 1030 if (this.testStarted == false)
nickjillings@1512 1031 {
nickjillings@1512 1032 this.testStartTime = audioContext.currentTime;
nickjillings@1512 1033 this.testStarted = true;
nickjillings@1512 1034 this.updateTestTime();
nickjillings@1512 1035 audioEngineContext.metric.initialiseTest();
nickjillings@1512 1036 }
nickjillings@1512 1037 };
nickjillings@1512 1038 this.stopTest = function()
nickjillings@1512 1039 {
nickjillings@1512 1040 if (this.testStarted)
nickjillings@1512 1041 {
nickjillings@1512 1042 this.testDuration = this.getTestTime();
nickjillings@1512 1043 this.testStarted = false;
nickjillings@1512 1044 } else {
nickjillings@1512 1045 console.log('ERR: Test tried to end before beginning');
nickjillings@1512 1046 }
nickjillings@1512 1047 };
nickjillings@1512 1048 this.updateTestTime = function()
nickjillings@1512 1049 {
nickjillings@1512 1050 if (this.testStarted)
nickjillings@1512 1051 {
nickjillings@1512 1052 this.testDuration = audioContext.currentTime - this.testStartTime;
nickjillings@1512 1053 }
nickjillings@1512 1054 };
nickjillings@1512 1055 this.getTestTime = function()
nickjillings@1512 1056 {
nickjillings@1512 1057 this.updateTestTime();
nickjillings@1512 1058 return this.testDuration;
nickjillings@1512 1059 };
nickjillings@1512 1060 }
nickjillings@1512 1061
nickjillings@1512 1062 function sessionMetrics(engine)
nickjillings@1512 1063 {
nickjillings@1512 1064 /* Used by audioEngine to link to audioObjects to minimise the timer call timers;
nickjillings@1512 1065 */
nickjillings@1512 1066 this.engine = engine;
nickjillings@1512 1067 this.lastClicked = -1;
nickjillings@1512 1068 this.data = -1;
nickjillings@1512 1069 this.reset = function() {
nickjillings@1512 1070 this.lastClicked = -1;
nickjillings@1512 1071 this.data = -1;
nickjillings@1512 1072 };
nickjillings@1512 1073 this.initialiseTest = function(){};
nickjillings@1512 1074 }
nickjillings@1512 1075
nickjillings@1512 1076 function metricTracker(caller)
nickjillings@1512 1077 {
nickjillings@1512 1078 /* Custom object to track and collect metric data
nickjillings@1512 1079 * Used only inside the audioObjects object.
nickjillings@1512 1080 */
nickjillings@1512 1081
nickjillings@1512 1082 this.listenedTimer = 0;
nickjillings@1512 1083 this.listenStart = 0;
nickjillings@1512 1084 this.listenHold = false;
nickjillings@1512 1085 this.initialPosition = -1;
nickjillings@1512 1086 this.movementTracker = [];
nickjillings@1512 1087 this.listenTracker =[];
nickjillings@1512 1088 this.wasListenedTo = false;
nickjillings@1512 1089 this.wasMoved = false;
nickjillings@1512 1090 this.hasComments = false;
nickjillings@1512 1091 this.parent = caller;
nickjillings@1512 1092
nickjillings@1512 1093 this.initialised = function(position)
nickjillings@1512 1094 {
nickjillings@1512 1095 if (this.initialPosition == -1) {
nickjillings@1512 1096 this.initialPosition = position;
nickjillings@1512 1097 }
nickjillings@1512 1098 };
nickjillings@1512 1099
nickjillings@1512 1100 this.moved = function(time,position)
nickjillings@1512 1101 {
nickjillings@1512 1102 this.wasMoved = true;
nickjillings@1512 1103 this.movementTracker[this.movementTracker.length] = [time, position];
nickjillings@1512 1104 };
nickjillings@1512 1105
nickjillings@1512 1106 this.startListening = function(time)
nickjillings@1512 1107 {
nickjillings@1512 1108 if (this.listenHold == false)
nickjillings@1512 1109 {
nickjillings@1512 1110 this.wasListenedTo = true;
nickjillings@1512 1111 this.listenStart = time;
nickjillings@1512 1112 this.listenHold = true;
nickjillings@1512 1113
nickjillings@1512 1114 var evnt = document.createElement('event');
nickjillings@1512 1115 var testTime = document.createElement('testTime');
nickjillings@1512 1116 testTime.setAttribute('start',time);
nickjillings@1512 1117 var bufferTime = document.createElement('bufferTime');
nickjillings@1512 1118 bufferTime.setAttribute('start',this.parent.getCurrentPosition());
nickjillings@1512 1119 evnt.appendChild(testTime);
nickjillings@1512 1120 evnt.appendChild(bufferTime);
nickjillings@1512 1121 this.listenTracker.push(evnt);
nickjillings@1512 1122
nickjillings@1512 1123 console.log('slider ' + this.parent.id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1512 1124 }
nickjillings@1512 1125 };
nickjillings@1512 1126
nickjillings@1512 1127 this.stopListening = function(time,bufferStopTime)
nickjillings@1512 1128 {
nickjillings@1512 1129 if (this.listenHold == true)
nickjillings@1512 1130 {
nickjillings@1512 1131 var diff = time - this.listenStart;
nickjillings@1512 1132 this.listenedTimer += (diff);
nickjillings@1512 1133 this.listenStart = 0;
nickjillings@1512 1134 this.listenHold = false;
nickjillings@1512 1135
nickjillings@1512 1136 var evnt = this.listenTracker[this.listenTracker.length-1];
nickjillings@1512 1137 var testTime = evnt.getElementsByTagName('testTime')[0];
nickjillings@1512 1138 var bufferTime = evnt.getElementsByTagName('bufferTime')[0];
nickjillings@1512 1139 testTime.setAttribute('stop',time);
nickjillings@1512 1140 if (bufferStopTime == undefined) {
nickjillings@1512 1141 bufferTime.setAttribute('stop',this.parent.getCurrentPosition());
nickjillings@1512 1142 } else {
nickjillings@1512 1143 bufferTime.setAttribute('stop',bufferStopTime);
nickjillings@1512 1144 }
nickjillings@1512 1145 console.log('slider ' + this.parent.id + ' played for (' + diff + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1512 1146 }
nickjillings@1512 1147 };
nickjillings@1512 1148
nickjillings@1512 1149 this.exportXMLDOM = function() {
nickjillings@1512 1150 var root = document.createElement('metric');
nickjillings@1512 1151 if (audioEngineContext.metric.enableElementTimer) {
nickjillings@1512 1152 var mElementTimer = document.createElement('metricresult');
nickjillings@1512 1153 mElementTimer.setAttribute('name','enableElementTimer');
nickjillings@1512 1154 mElementTimer.textContent = this.listenedTimer;
nickjillings@1512 1155 root.appendChild(mElementTimer);
nickjillings@1512 1156 }
nickjillings@1512 1157 if (audioEngineContext.metric.enableElementTracker) {
nickjillings@1512 1158 var elementTrackerFull = document.createElement('metricResult');
nickjillings@1512 1159 elementTrackerFull.setAttribute('name','elementTrackerFull');
nickjillings@1512 1160 for (var k=0; k<this.movementTracker.length; k++)
nickjillings@1512 1161 {
nickjillings@1512 1162 var timePos = document.createElement('timePos');
nickjillings@1512 1163 timePos.id = k;
nickjillings@1512 1164 var time = document.createElement('time');
nickjillings@1512 1165 time.textContent = this.movementTracker[k][0];
nickjillings@1512 1166 var position = document.createElement('position');
nickjillings@1512 1167 position.textContent = this.movementTracker[k][1];
nickjillings@1512 1168 timePos.appendChild(time);
nickjillings@1512 1169 timePos.appendChild(position);
nickjillings@1512 1170 elementTrackerFull.appendChild(timePos);
nickjillings@1512 1171 }
nickjillings@1512 1172 root.appendChild(elementTrackerFull);
nickjillings@1512 1173 }
nickjillings@1512 1174 if (audioEngineContext.metric.enableElementListenTracker) {
nickjillings@1512 1175 var elementListenTracker = document.createElement('metricResult');
nickjillings@1512 1176 elementListenTracker.setAttribute('name','elementListenTracker');
nickjillings@1512 1177 for (var k=0; k<this.listenTracker.length; k++) {
nickjillings@1512 1178 elementListenTracker.appendChild(this.listenTracker[k]);
nickjillings@1512 1179 }
nickjillings@1512 1180 root.appendChild(elementListenTracker);
nickjillings@1512 1181 }
nickjillings@1512 1182 if (audioEngineContext.metric.enableElementInitialPosition) {
nickjillings@1512 1183 var elementInitial = document.createElement('metricResult');
nickjillings@1512 1184 elementInitial.setAttribute('name','elementInitialPosition');
nickjillings@1512 1185 elementInitial.textContent = this.initialPosition;
nickjillings@1512 1186 root.appendChild(elementInitial);
nickjillings@1512 1187 }
nickjillings@1512 1188 if (audioEngineContext.metric.enableFlagListenedTo) {
nickjillings@1512 1189 var flagListenedTo = document.createElement('metricResult');
nickjillings@1512 1190 flagListenedTo.setAttribute('name','elementFlagListenedTo');
nickjillings@1512 1191 flagListenedTo.textContent = this.wasListenedTo;
nickjillings@1512 1192 root.appendChild(flagListenedTo);
nickjillings@1512 1193 }
nickjillings@1512 1194 if (audioEngineContext.metric.enableFlagMoved) {
nickjillings@1512 1195 var flagMoved = document.createElement('metricResult');
nickjillings@1512 1196 flagMoved.setAttribute('name','elementFlagMoved');
nickjillings@1512 1197 flagMoved.textContent = this.wasMoved;
nickjillings@1512 1198 root.appendChild(flagMoved);
nickjillings@1512 1199 }
nickjillings@1512 1200 if (audioEngineContext.metric.enableFlagComments) {
nickjillings@1512 1201 var flagComments = document.createElement('metricResult');
nickjillings@1512 1202 flagComments.setAttribute('name','elementFlagComments');
nickjillings@1512 1203 if (this.parent.commentDOM == null)
nickjillings@1512 1204 {flag.textContent = 'false';}
nickjillings@1512 1205 else if (this.parent.commentDOM.textContent.length == 0)
nickjillings@1512 1206 {flag.textContent = 'false';}
nickjillings@1512 1207 else
nickjillings@1512 1208 {flag.textContet = 'true';}
nickjillings@1512 1209 root.appendChild(flagComments);
nickjillings@1512 1210 }
nickjillings@1512 1211
nickjillings@1512 1212 return root;
nickjillings@1512 1213 };
nickjillings@1512 1214 }
nickjillings@1512 1215
nickjillings@1512 1216 function randomiseOrder(input)
nickjillings@1512 1217 {
nickjillings@1512 1218 // This takes an array of information and randomises the order
nickjillings@1512 1219 var N = input.length;
nickjillings@1512 1220
nickjillings@1512 1221 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1512 1222 for (var counter = 0; counter < N; ++counter)
nickjillings@1512 1223 inputSequence.push(counter) // Fill array
nickjillings@1512 1224 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1512 1225
nickjillings@1512 1226 var holdArr = [];
nickjillings@1512 1227 var outputSequence = [];
nickjillings@1512 1228 for (var n=0; n<N; n++)
nickjillings@1512 1229 {
nickjillings@1512 1230 // First pick a random number
nickjillings@1512 1231 var r = Math.random();
nickjillings@1512 1232 // Multiply and floor by the number of elements left
nickjillings@1512 1233 r = Math.floor(r*input.length);
nickjillings@1512 1234 // Pick out that element and delete from the array
nickjillings@1512 1235 holdArr.push(input.splice(r,1)[0]);
nickjillings@1512 1236 // Do the same with sequence
nickjillings@1512 1237 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1512 1238 }
nickjillings@1512 1239 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1512 1240 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1512 1241 return holdArr;
nickjillings@1512 1242 }
nickjillings@1512 1243
nickjillings@1512 1244 function returnDateNode()
nickjillings@1512 1245 {
nickjillings@1512 1246 // Create an XML Node for the Date and Time a test was conducted
nickjillings@1512 1247 // Structure is
nickjillings@1512 1248 // <datetime>
nickjillings@1512 1249 // <date year="##" month="##" day="##">DD/MM/YY</date>
nickjillings@1512 1250 // <time hour="##" minute="##" sec="##">HH:MM:SS</time>
nickjillings@1512 1251 // </datetime>
nickjillings@1512 1252 var dateTime = new Date();
nickjillings@1512 1253 var year = document.createAttribute('year');
nickjillings@1512 1254 var month = document.createAttribute('month');
nickjillings@1512 1255 var day = document.createAttribute('day');
nickjillings@1512 1256 var hour = document.createAttribute('hour');
nickjillings@1512 1257 var minute = document.createAttribute('minute');
nickjillings@1512 1258 var secs = document.createAttribute('secs');
nickjillings@1512 1259
nickjillings@1512 1260 year.nodeValue = dateTime.getFullYear();
nickjillings@1512 1261 month.nodeValue = dateTime.getMonth()+1;
nickjillings@1512 1262 day.nodeValue = dateTime.getDate();
nickjillings@1512 1263 hour.nodeValue = dateTime.getHours();
nickjillings@1512 1264 minute.nodeValue = dateTime.getMinutes();
nickjillings@1512 1265 secs.nodeValue = dateTime.getSeconds();
nickjillings@1512 1266
nickjillings@1512 1267 var hold = document.createElement("datetime");
nickjillings@1512 1268 var date = document.createElement("date");
nickjillings@1512 1269 date.textContent = year.nodeValue+'/'+month.nodeValue+'/'+day.nodeValue;
nickjillings@1512 1270 var time = document.createElement("time");
nickjillings@1512 1271 time.textContent = hour.nodeValue+':'+minute.nodeValue+':'+secs.nodeValue;
nickjillings@1512 1272
nickjillings@1512 1273 date.setAttributeNode(year);
nickjillings@1512 1274 date.setAttributeNode(month);
nickjillings@1512 1275 date.setAttributeNode(day);
nickjillings@1512 1276 time.setAttributeNode(hour);
nickjillings@1512 1277 time.setAttributeNode(minute);
nickjillings@1512 1278 time.setAttributeNode(secs);
nickjillings@1512 1279
nickjillings@1512 1280 hold.appendChild(date);
nickjillings@1512 1281 hold.appendChild(time);
nickjillings@1512 1282 return hold
nickjillings@1512 1283
nickjillings@1512 1284 }
nickjillings@1512 1285
nickjillings@1512 1286 function testWaitIndicator() {
nickjillings@1512 1287 if (audioEngineContext.checkAllReady() == false) {
nickjillings@1512 1288 var hold = document.createElement("div");
nickjillings@1512 1289 hold.id = "testWaitIndicator";
nickjillings@1512 1290 hold.className = "indicator-box";
nickjillings@1512 1291 hold.style.zIndex = 3;
nickjillings@1512 1292 var span = document.createElement("span");
nickjillings@1512 1293 span.textContent = "Please wait! Elements still loading";
nickjillings@1512 1294 hold.appendChild(span);
nickjillings@1512 1295 var blank = document.createElement('div');
nickjillings@1512 1296 blank.className = 'testHalt';
nickjillings@1512 1297 blank.id = "testHaltBlank";
nickjillings@1512 1298 var body = document.getElementsByTagName('body')[0];
nickjillings@1512 1299 body.appendChild(hold);
nickjillings@1512 1300 body.appendChild(blank);
nickjillings@1512 1301 testWaitTimerIntervalHolder = setInterval(function(){
nickjillings@1512 1302 var ready = audioEngineContext.checkAllReady();
nickjillings@1512 1303 if (ready) {
nickjillings@1512 1304 var elem = document.getElementById('testWaitIndicator');
nickjillings@1512 1305 var blank = document.getElementById('testHaltBlank');
nickjillings@1512 1306 var body = document.getElementsByTagName('body')[0];
nickjillings@1512 1307 body.removeChild(elem);
nickjillings@1512 1308 body.removeChild(blank);
nickjillings@1512 1309 clearInterval(testWaitTimerIntervalHolder);
nickjillings@1512 1310 }
nickjillings@1512 1311 },500,false);
nickjillings@1512 1312 }
nickjillings@1512 1313 }
nickjillings@1512 1314
nickjillings@1512 1315 var testWaitTimerIntervalHolder = null;
nickjillings@1512 1316
nickjillings@1512 1317 function Specification() {
nickjillings@1512 1318 // Handles the decoding of the project specification XML into a simple JavaScript Object.
nickjillings@1512 1319
nickjillings@1512 1320 this.interfaceType;
nickjillings@1512 1321 this.commonInterface;
nickjillings@1512 1322 this.projectReturn;
nickjillings@1512 1323 this.randomiseOrder;
nickjillings@1512 1324 this.collectMetrics;
nickjillings@1520 1325 this.testPages;
nickjillings@1512 1326 this.preTest;
nickjillings@1512 1327 this.postTest;
nickjillings@1512 1328 this.metrics =[];
nickjillings@1512 1329
nickjillings@1512 1330 this.audioHolders = [];
nickjillings@1512 1331
nickjillings@1512 1332 this.decode = function() {
nickjillings@1512 1333 // projectXML - DOM Parsed document
nickjillings@1512 1334 this.projectXML = projectXML.childNodes[0];
nickjillings@1512 1335 var setupNode = projectXML.getElementsByTagName('setup')[0];
nickjillings@1512 1336 this.interfaceType = setupNode.getAttribute('interface');
nickjillings@1512 1337 this.projectReturn = setupNode.getAttribute('projectReturn');
nickjillings@1520 1338 this.testPages = setupNode.getAttribute('testPages');
nickjillings@1512 1339 if (setupNode.getAttribute('randomiseOrder') == "true") {
nickjillings@1512 1340 this.randomiseOrder = true;
nickjillings@1512 1341 } else {this.randomiseOrder = false;}
nickjillings@1512 1342 if (setupNode.getAttribute('collectMetrics') == "true") {
nickjillings@1512 1343 this.collectMetrics = true;
nickjillings@1512 1344 } else {this.collectMetrics = false;}
nickjillings@1520 1345 if (isNaN(Number(this.testPages)) || this.testPages == undefined)
nickjillings@1520 1346 {
nickjillings@1520 1347 this.testPages = null;
nickjillings@1520 1348 } else {
nickjillings@1520 1349 this.testPages = Number(this.testPages);
nickjillings@1520 1350 if (this.testPages == 0) {this.testPages = null;}
nickjillings@1520 1351 }
nickjillings@1512 1352 var metricCollection = setupNode.getElementsByTagName('Metric');
nickjillings@1512 1353
nickjillings@1512 1354 this.preTest = new this.prepostNode('pretest',setupNode.getElementsByTagName('PreTest'));
nickjillings@1512 1355 this.postTest = new this.prepostNode('posttest',setupNode.getElementsByTagName('PostTest'));
nickjillings@1512 1356
nickjillings@1512 1357 if (metricCollection.length > 0) {
nickjillings@1512 1358 metricCollection = metricCollection[0].getElementsByTagName('metricEnable');
nickjillings@1512 1359 for (var i=0; i<metricCollection.length; i++) {
nickjillings@1512 1360 this.metrics.push(new this.metricNode(metricCollection[i].textContent));
nickjillings@1512 1361 }
nickjillings@1512 1362 }
nickjillings@1512 1363
nickjillings@1512 1364 var commonInterfaceNode = setupNode.getElementsByTagName('interface');
nickjillings@1512 1365 if (commonInterfaceNode.length > 0) {
nickjillings@1512 1366 commonInterfaceNode = commonInterfaceNode[0];
nickjillings@1512 1367 } else {
nickjillings@1512 1368 commonInterfaceNode = undefined;
nickjillings@1512 1369 }
nickjillings@1512 1370
nickjillings@1512 1371 this.commonInterface = new function() {
nickjillings@1512 1372 this.OptionNode = function(child) {
nickjillings@1512 1373 this.type = child.nodeName;
nickjillings@1512 1374 if (this.type == 'option')
nickjillings@1512 1375 {
nickjillings@1512 1376 this.name = child.getAttribute('name');
nickjillings@1512 1377 }
nickjillings@1512 1378 else if (this.type == 'check') {
nickjillings@1512 1379 this.check = child.getAttribute('name');
nickjillings@1512 1380 if (this.check == 'scalerange') {
nickjillings@1512 1381 this.min = child.getAttribute('min');
nickjillings@1512 1382 this.max = child.getAttribute('max');
nickjillings@1512 1383 if (this.min == null) {this.min = 1;}
nickjillings@1512 1384 else if (Number(this.min) > 1 && this.min != null) {
nickjillings@1512 1385 this.min = Number(this.min)/100;
nickjillings@1512 1386 } else {
nickjillings@1512 1387 this.min = Number(this.min);
nickjillings@1512 1388 }
nickjillings@1512 1389 if (this.max == null) {this.max = 0;}
nickjillings@1512 1390 else if (Number(this.max) > 1 && this.max != null) {
nickjillings@1512 1391 this.max = Number(this.max)/100;
nickjillings@1512 1392 } else {
nickjillings@1512 1393 this.max = Number(this.max);
nickjillings@1512 1394 }
nickjillings@1512 1395 }
nickjillings@1512 1396 } else if (this.type == 'anchor' || this.type == 'reference') {
nickjillings@1512 1397 this.value = Number(child.textContent);
nickjillings@1512 1398 this.enforce = child.getAttribute('enforce');
nickjillings@1512 1399 if (this.enforce == 'true') {this.enforce = true;}
nickjillings@1512 1400 else {this.enforce = false;}
nickjillings@1512 1401 }
nickjillings@1512 1402 };
nickjillings@1512 1403 this.options = [];
nickjillings@1512 1404 if (commonInterfaceNode != undefined) {
nickjillings@1512 1405 var child = commonInterfaceNode.firstElementChild;
nickjillings@1512 1406 while (child != undefined) {
nickjillings@1512 1407 this.options.push(new this.OptionNode(child));
nickjillings@1512 1408 child = child.nextElementSibling;
nickjillings@1512 1409 }
nickjillings@1512 1410 }
nickjillings@1512 1411 };
nickjillings@1512 1412
nickjillings@1512 1413 var audioHolders = projectXML.getElementsByTagName('audioHolder');
nickjillings@1512 1414 for (var i=0; i<audioHolders.length; i++) {
nickjillings@1512 1415 this.audioHolders.push(new this.audioHolderNode(this,audioHolders[i]));
nickjillings@1512 1416 }
nickjillings@1512 1417
nickjillings@1520 1418 // New check if we need to randomise the test order
nickjillings@1520 1419 if (this.randomiseOrder)
nickjillings@1520 1420 {
nickjillings@1520 1421 this.audioHolders = randomiseOrder(this.audioHolders);
nickjillings@1520 1422 for (var i=0; i<this.audioHolders.length; i++)
nickjillings@1520 1423 {
nickjillings@1520 1424 this.audioHolders[i].presentedId = i;
nickjillings@1520 1425 }
nickjillings@1520 1426 }
nickjillings@1520 1427
nickjillings@1520 1428 if (this.testPages != null || this.testPages != undefined)
nickjillings@1520 1429 {
nickjillings@1520 1430 if (this.testPages > audioHolders.length)
nickjillings@1520 1431 {
nickjillings@1520 1432 console.log('Warning: You have specified '+audioHolders.length+' tests but requested '+this.testPages+' be completed!');
nickjillings@1520 1433 this.testPages = audioHolders.length;
nickjillings@1520 1434 }
nickjillings@1520 1435 var aH = this.audioHolders;
nickjillings@1520 1436 this.audioHolders = [];
nickjillings@1520 1437 for (var i=0; i<this.testPages; i++)
nickjillings@1520 1438 {
nickjillings@1520 1439 this.audioHolders.push(aH[i]);
nickjillings@1520 1440 }
nickjillings@1520 1441 }
nickjillings@1512 1442 };
nickjillings@1512 1443
nickjillings@1512 1444 this.prepostNode = function(type,Collection) {
nickjillings@1512 1445 this.type = type;
nickjillings@1512 1446 this.options = [];
nickjillings@1512 1447
nickjillings@1512 1448 this.OptionNode = function(child) {
nickjillings@1512 1449
nickjillings@1512 1450 this.childOption = function(element) {
nickjillings@1512 1451 this.type = 'option';
nickjillings@1512 1452 this.id = element.id;
nickjillings@1512 1453 this.name = element.getAttribute('name');
nickjillings@1512 1454 this.text = element.textContent;
nickjillings@1512 1455 };
nickjillings@1512 1456
nickjillings@1512 1457 this.type = child.nodeName;
nickjillings@1512 1458 if (child.nodeName == "question") {
nickjillings@1512 1459 this.id = child.id;
nickjillings@1512 1460 this.mandatory;
nickjillings@1512 1461 if (child.getAttribute('mandatory') == "true") {this.mandatory = true;}
nickjillings@1512 1462 else {this.mandatory = false;}
nickjillings@1512 1463 this.question = child.textContent;
nickjillings@1512 1464 if (child.getAttribute('boxsize') == null) {
nickjillings@1512 1465 this.boxsize = 'normal';
nickjillings@1512 1466 } else {
nickjillings@1512 1467 this.boxsize = child.getAttribute('boxsize');
nickjillings@1512 1468 }
nickjillings@1512 1469 } else if (child.nodeName == "statement") {
nickjillings@1512 1470 this.statement = child.textContent;
nickjillings@1512 1471 } else if (child.nodeName == "checkbox" || child.nodeName == "radio") {
nickjillings@1512 1472 var element = child.firstElementChild;
nickjillings@1512 1473 this.id = child.id;
nickjillings@1512 1474 if (element == null) {
nickjillings@1512 1475 console.log('Malformed' +child.nodeName+ 'entry');
nickjillings@1512 1476 this.statement = 'Malformed' +child.nodeName+ 'entry';
nickjillings@1512 1477 this.type = 'statement';
nickjillings@1512 1478 } else {
nickjillings@1512 1479 this.options = [];
nickjillings@1512 1480 while (element != null) {
nickjillings@1512 1481 if (element.nodeName == 'statement' && this.statement == undefined){
nickjillings@1512 1482 this.statement = element.textContent;
nickjillings@1512 1483 } else if (element.nodeName == 'option') {
nickjillings@1512 1484 this.options.push(new this.childOption(element));
nickjillings@1512 1485 }
nickjillings@1512 1486 element = element.nextElementSibling;
nickjillings@1512 1487 }
nickjillings@1512 1488 }
nickjillings@1512 1489 } else if (child.nodeName == "number") {
nickjillings@1512 1490 this.statement = child.textContent;
nickjillings@1512 1491 this.id = child.id;
nickjillings@1512 1492 this.min = child.getAttribute('min');
nickjillings@1512 1493 this.max = child.getAttribute('max');
nickjillings@1512 1494 this.step = child.getAttribute('step');
nickjillings@1512 1495 }
nickjillings@1512 1496 };
nickjillings@1512 1497
nickjillings@1512 1498 // On construction:
nickjillings@1512 1499 if (Collection.length != 0) {
nickjillings@1512 1500 Collection = Collection[0];
nickjillings@1512 1501 if (Collection.childElementCount != 0) {
nickjillings@1512 1502 var child = Collection.firstElementChild;
nickjillings@1512 1503 this.options.push(new this.OptionNode(child));
nickjillings@1512 1504 while (child.nextElementSibling != null) {
nickjillings@1512 1505 child = child.nextElementSibling;
nickjillings@1512 1506 this.options.push(new this.OptionNode(child));
nickjillings@1512 1507 }
nickjillings@1512 1508 }
nickjillings@1512 1509 }
nickjillings@1512 1510 };
nickjillings@1512 1511
nickjillings@1512 1512 this.metricNode = function(name) {
nickjillings@1512 1513 this.enabled = name;
nickjillings@1512 1514 };
nickjillings@1512 1515
nickjillings@1512 1516 this.audioHolderNode = function(parent,xml) {
nickjillings@1512 1517 this.type = 'audioHolder';
nickjillings@1512 1518 this.presentedId = parent.audioHolders.length;
nickjillings@1512 1519 this.interfaceNode = function(DOM) {
nickjillings@1512 1520 var title = DOM.getElementsByTagName('title');
nickjillings@1512 1521 if (title.length == 0) {this.title = null;}
nickjillings@1512 1522 else {this.title = title[0].textContent;}
nickjillings@1512 1523 this.options = parent.commonInterface.options;
nickjillings@1512 1524 var scale = DOM.getElementsByTagName('scale');
nickjillings@1512 1525 this.scale = [];
nickjillings@1512 1526 for (var i=0; i<scale.length; i++) {
nickjillings@1512 1527 var arr = [null, null];
nickjillings@1512 1528 arr[0] = scale[i].getAttribute('position');
nickjillings@1512 1529 arr[1] = scale[i].textContent;
nickjillings@1512 1530 this.scale.push(arr);
nickjillings@1512 1531 }
nickjillings@1512 1532 };
nickjillings@1512 1533
nickjillings@1512 1534 this.audioElementNode = function(parent,xml) {
nickjillings@1512 1535 this.url = xml.getAttribute('url');
nickjillings@1512 1536 this.id = xml.id;
nickjillings@1512 1537 this.parent = parent;
nickjillings@1512 1538 this.type = xml.getAttribute('type');
nickjillings@1512 1539 if (this.type == null) {this.type = "normal";}
nickjillings@1512 1540 if (this.type == 'anchor') {this.anchor = true;}
nickjillings@1512 1541 else {this.anchor = false;}
nickjillings@1512 1542 if (this.type == 'reference') {this.reference = true;}
nickjillings@1512 1543 else {this.reference = false;}
nickjillings@1512 1544
nickjillings@1512 1545 this.marker = xml.getAttribute('marker');
nickjillings@1512 1546 if (this.marker == null) {this.marker = undefined;}
nickjillings@1512 1547
nickjillings@1512 1548 if (this.anchor == true) {
nickjillings@1512 1549 if (this.marker != undefined) {this.enforce = true;}
nickjillings@1512 1550 else {this.enforce = enforceAnchor;}
nickjillings@1512 1551 this.marker = anchor;
nickjillings@1512 1552 }
nickjillings@1512 1553 else if (this.reference == true) {
nickjillings@1512 1554 if (this.marker != undefined) {this.enforce = true;}
nickjillings@1512 1555 else {this.enforce = enforceReference;}
nickjillings@1512 1556 this.marker = reference;
nickjillings@1512 1557 }
nickjillings@1512 1558
nickjillings@1512 1559 if (this.marker != undefined) {
nickjillings@1512 1560 this.marker = Number(this.marker);
nickjillings@1512 1561 if (this.marker > 1) {this.marker /= 100;}
nickjillings@1512 1562 }
nickjillings@1512 1563 };
nickjillings@1512 1564
nickjillings@1512 1565 this.commentQuestionNode = function(xml) {
nickjillings@1512 1566 this.childOption = function(element) {
nickjillings@1512 1567 this.type = 'option';
nickjillings@1512 1568 this.name = element.getAttribute('name');
nickjillings@1512 1569 this.text = element.textContent;
nickjillings@1512 1570 };
nickjillings@1512 1571 this.id = xml.id;
nickjillings@1512 1572 if (xml.getAttribute('mandatory') == 'true') {this.mandatory = true;}
nickjillings@1512 1573 else {this.mandatory = false;}
nickjillings@1512 1574 this.type = xml.getAttribute('type');
nickjillings@1512 1575 if (this.type == undefined) {this.type = 'text';}
nickjillings@1512 1576 switch (this.type) {
nickjillings@1512 1577 case 'text':
nickjillings@1512 1578 this.question = xml.textContent;
nickjillings@1512 1579 break;
nickjillings@1512 1580 case 'radio':
nickjillings@1512 1581 var child = xml.firstElementChild;
nickjillings@1512 1582 this.options = [];
nickjillings@1512 1583 while (child != undefined) {
nickjillings@1512 1584 if (child.nodeName == 'statement' && this.statement == undefined) {
nickjillings@1512 1585 this.statement = child.textContent;
nickjillings@1512 1586 } else if (child.nodeName == 'option') {
nickjillings@1512 1587 this.options.push(new this.childOption(child));
nickjillings@1512 1588 }
nickjillings@1512 1589 child = child.nextElementSibling;
nickjillings@1512 1590 }
nickjillings@1512 1591 break;
nickjillings@1512 1592 case 'checkbox':
nickjillings@1512 1593 var child = xml.firstElementChild;
nickjillings@1512 1594 this.options = [];
nickjillings@1512 1595 while (child != undefined) {
nickjillings@1512 1596 if (child.nodeName == 'statement' && this.statement == undefined) {
nickjillings@1512 1597 this.statement = child.textContent;
nickjillings@1512 1598 } else if (child.nodeName == 'option') {
nickjillings@1512 1599 this.options.push(new this.childOption(child));
nickjillings@1512 1600 }
nickjillings@1512 1601 child = child.nextElementSibling;
nickjillings@1512 1602 }
nickjillings@1512 1603 break;
nickjillings@1512 1604 }
nickjillings@1512 1605 };
nickjillings@1512 1606
nickjillings@1512 1607 this.id = xml.id;
nickjillings@1512 1608 this.hostURL = xml.getAttribute('hostURL');
nickjillings@1512 1609 this.sampleRate = xml.getAttribute('sampleRate');
nickjillings@1512 1610 if (xml.getAttribute('randomiseOrder') == "true") {this.randomiseOrder = true;}
nickjillings@1512 1611 else {this.randomiseOrder = false;}
nickjillings@1512 1612 this.repeatCount = xml.getAttribute('repeatCount');
nickjillings@1512 1613 if (xml.getAttribute('loop') == 'true') {this.loop = true;}
nickjillings@1512 1614 else {this.loop == false;}
nickjillings@1512 1615 if (xml.getAttribute('elementComments') == "true") {this.elementComments = true;}
nickjillings@1512 1616 else {this.elementComments = false;}
nickjillings@1512 1617
nickjillings@1512 1618 var anchor = xml.getElementsByTagName('anchor');
nickjillings@1512 1619 var enforceAnchor = false;
nickjillings@1512 1620 if (anchor.length == 0) {
nickjillings@1512 1621 // Find anchor in commonInterface;
nickjillings@1512 1622 for (var i=0; i<parent.commonInterface.options.length; i++) {
nickjillings@1512 1623 if(parent.commonInterface.options[i].type == 'anchor') {
nickjillings@1512 1624 anchor = parent.commonInterface.options[i].value;
nickjillings@1512 1625 enforceAnchor = parent.commonInterface.options[i].enforce;
nickjillings@1512 1626 break;
nickjillings@1512 1627 }
nickjillings@1512 1628 }
nickjillings@1512 1629 if (typeof(anchor) == "object") {
nickjillings@1512 1630 anchor = null;
nickjillings@1512 1631 }
nickjillings@1512 1632 } else {
nickjillings@1512 1633 anchor = anchor[0].textContent;
nickjillings@1512 1634 }
nickjillings@1512 1635
nickjillings@1512 1636 var reference = xml.getElementsByTagName('anchor');
nickjillings@1512 1637 var enforceReference = false;
nickjillings@1512 1638 if (reference.length == 0) {
nickjillings@1512 1639 // Find anchor in commonInterface;
nickjillings@1512 1640 for (var i=0; i<parent.commonInterface.options.length; i++) {
nickjillings@1512 1641 if(parent.commonInterface.options[i].type == 'reference') {
nickjillings@1512 1642 reference = parent.commonInterface.options[i].value;
nickjillings@1512 1643 enforceReference = parent.commonInterface.options[i].enforce;
nickjillings@1512 1644 break;
nickjillings@1512 1645 }
nickjillings@1512 1646 }
nickjillings@1512 1647 if (typeof(reference) == "object") {
nickjillings@1512 1648 reference = null;
nickjillings@1512 1649 }
nickjillings@1512 1650 } else {
nickjillings@1512 1651 reference = reference[0].textContent;
nickjillings@1512 1652 }
nickjillings@1512 1653
nickjillings@1512 1654 if (typeof(anchor) == 'number') {
nickjillings@1512 1655 if (anchor > 1 && anchor < 100) {anchor /= 100.0;}
nickjillings@1512 1656 }
nickjillings@1512 1657
nickjillings@1512 1658 if (typeof(reference) == 'number') {
nickjillings@1512 1659 if (reference > 1 && reference < 100) {reference /= 100.0;}
nickjillings@1512 1660 }
nickjillings@1512 1661
nickjillings@1512 1662 this.preTest = new parent.prepostNode('pretest',xml.getElementsByTagName('PreTest'));
nickjillings@1512 1663 this.postTest = new parent.prepostNode('posttest',xml.getElementsByTagName('PostTest'));
nickjillings@1512 1664
nickjillings@1512 1665 this.interfaces = [];
nickjillings@1512 1666 var interfaceDOM = xml.getElementsByTagName('interface');
nickjillings@1512 1667 for (var i=0; i<interfaceDOM.length; i++) {
nickjillings@1512 1668 this.interfaces.push(new this.interfaceNode(interfaceDOM[i]));
nickjillings@1512 1669 }
nickjillings@1512 1670
nickjillings@1512 1671 this.commentBoxPrefix = xml.getElementsByTagName('commentBoxPrefix');
nickjillings@1512 1672 if (this.commentBoxPrefix.length != 0) {
nickjillings@1512 1673 this.commentBoxPrefix = this.commentBoxPrefix[0].textContent;
nickjillings@1512 1674 } else {
nickjillings@1512 1675 this.commentBoxPrefix = "Comment on track";
nickjillings@1512 1676 }
nickjillings@1512 1677
nickjillings@1512 1678 this.audioElements =[];
nickjillings@1512 1679 var audioElementsDOM = xml.getElementsByTagName('audioElements');
nickjillings@1512 1680 this.outsideReference = null;
nickjillings@1512 1681 for (var i=0; i<audioElementsDOM.length; i++) {
nickjillings@1512 1682 if (audioElementsDOM[i].getAttribute('type') == 'outsidereference') {
nickjillings@1512 1683 if (this.outsideReference == null) {
nickjillings@1512 1684 this.outsideReference = new this.audioElementNode(this,audioElementsDOM[i]);
nickjillings@1512 1685 } else {
nickjillings@1512 1686 console.log('Error only one audioelement can be of type outsidereference per audioholder');
nickjillings@1512 1687 this.audioElements.push(new this.audioElementNode(this,audioElementsDOM[i]));
nickjillings@1512 1688 console.log('Element id '+audioElementsDOM[i].id+' made into normal node');
nickjillings@1512 1689 }
nickjillings@1512 1690 } else {
nickjillings@1512 1691 this.audioElements.push(new this.audioElementNode(this,audioElementsDOM[i]));
nickjillings@1512 1692 }
nickjillings@1512 1693 }
nickjillings@1512 1694
nickjillings@1512 1695 if (this.randomiseOrder) {
nickjillings@1512 1696 this.audioElements = randomiseOrder(this.audioElements);
nickjillings@1512 1697 }
nickjillings@1512 1698
nickjillings@1512 1699 // Check only one anchor and one reference per audioNode
nickjillings@1512 1700 var anchor = [];
nickjillings@1512 1701 var reference = [];
nickjillings@1512 1702 this.anchorId = null;
nickjillings@1512 1703 this.referenceId = null;
nickjillings@1512 1704 for (var i=0; i<this.audioElements.length; i++)
nickjillings@1512 1705 {
nickjillings@1512 1706 if (this.audioElements[i].anchor == true) {anchor.push(i);}
nickjillings@1512 1707 if (this.audioElements[i].reference == true) {reference.push(i);}
nickjillings@1512 1708 }
nickjillings@1512 1709
nickjillings@1512 1710 if (anchor.length > 1) {
nickjillings@1512 1711 console.log('Error - cannot have more than one anchor!');
nickjillings@1512 1712 console.log('Each anchor node will be a normal mode to continue the test');
nickjillings@1512 1713 for (var i=0; i<anchor.length; i++)
nickjillings@1512 1714 {
nickjillings@1512 1715 this.audioElements[anchor[i]].anchor = false;
nickjillings@1512 1716 this.audioElements[anchor[i]].value = undefined;
nickjillings@1512 1717 }
nickjillings@1512 1718 } else {this.anchorId = anchor[0];}
nickjillings@1512 1719 if (reference.length > 1) {
nickjillings@1512 1720 console.log('Error - cannot have more than one anchor!');
nickjillings@1512 1721 console.log('Each anchor node will be a normal mode to continue the test');
nickjillings@1512 1722 for (var i=0; i<reference.length; i++)
nickjillings@1512 1723 {
nickjillings@1512 1724 this.audioElements[reference[i]].reference = false;
nickjillings@1512 1725 this.audioElements[reference[i]].value = undefined;
nickjillings@1512 1726 }
nickjillings@1512 1727 } else {this.referenceId = reference[0];}
nickjillings@1512 1728
nickjillings@1512 1729 this.commentQuestions = [];
nickjillings@1512 1730 var commentQuestionsDOM = xml.getElementsByTagName('CommentQuestion');
nickjillings@1512 1731 for (var i=0; i<commentQuestionsDOM.length; i++) {
nickjillings@1512 1732 this.commentQuestions.push(new this.commentQuestionNode(commentQuestionsDOM[i]));
nickjillings@1512 1733 }
nickjillings@1512 1734 };
nickjillings@1512 1735 }
nickjillings@1512 1736
nickjillings@1512 1737 function Interface(specificationObject) {
nickjillings@1512 1738 // This handles the bindings between the interface and the audioEngineContext;
nickjillings@1512 1739 this.specification = specificationObject;
nickjillings@1512 1740 this.insertPoint = document.getElementById("topLevelBody");
nickjillings@1512 1741
nickjillings@1512 1742 // Bounded by interface!!
nickjillings@1512 1743 // Interface object MUST have an exportXMLDOM method which returns the various DOM levels
nickjillings@1512 1744 // For example, APE returns the slider position normalised in a <value> tag.
nickjillings@1512 1745 this.interfaceObjects = [];
nickjillings@1512 1746 this.interfaceObject = function(){};
nickjillings@1512 1747
nickjillings@1512 1748 this.commentBoxes = [];
nickjillings@1512 1749 this.elementCommentBox = function(audioObject) {
nickjillings@1512 1750 var element = audioObject.specification;
nickjillings@1512 1751 this.audioObject = audioObject;
nickjillings@1512 1752 this.id = audioObject.id;
nickjillings@1512 1753 var audioHolderObject = audioObject.specification.parent;
nickjillings@1512 1754 // Create document objects to hold the comment boxes
nickjillings@1512 1755 this.trackComment = document.createElement('div');
nickjillings@1512 1756 this.trackComment.className = 'comment-div';
nickjillings@1512 1757 this.trackComment.id = 'comment-div-'+audioObject.id;
nickjillings@1512 1758 // Create a string next to each comment asking for a comment
nickjillings@1512 1759 this.trackString = document.createElement('span');
nickjillings@1512 1760 this.trackString.innerHTML = audioHolderObject.commentBoxPrefix+' '+audioObject.id;
nickjillings@1512 1761 // Create the HTML5 comment box 'textarea'
nickjillings@1512 1762 this.trackCommentBox = document.createElement('textarea');
nickjillings@1512 1763 this.trackCommentBox.rows = '4';
nickjillings@1512 1764 this.trackCommentBox.cols = '100';
nickjillings@1512 1765 this.trackCommentBox.name = 'trackComment'+audioObject.id;
nickjillings@1512 1766 this.trackCommentBox.className = 'trackComment';
nickjillings@1512 1767 var br = document.createElement('br');
nickjillings@1512 1768 // Add to the holder.
nickjillings@1512 1769 this.trackComment.appendChild(this.trackString);
nickjillings@1512 1770 this.trackComment.appendChild(br);
nickjillings@1512 1771 this.trackComment.appendChild(this.trackCommentBox);
nickjillings@1512 1772
nickjillings@1512 1773 this.exportXMLDOM = function() {
nickjillings@1512 1774 var root = document.createElement('comment');
nickjillings@1512 1775 if (this.audioObject.specification.parent.elementComments) {
nickjillings@1512 1776 var question = document.createElement('question');
nickjillings@1512 1777 question.textContent = this.trackString.textContent;
nickjillings@1512 1778 var response = document.createElement('response');
nickjillings@1512 1779 response.textContent = this.trackCommentBox.value;
nickjillings@1512 1780 console.log("Comment frag-"+this.id+": "+response.textContent);
nickjillings@1512 1781 root.appendChild(question);
nickjillings@1512 1782 root.appendChild(response);
nickjillings@1512 1783 }
nickjillings@1512 1784 return root;
nickjillings@1512 1785 };
nickjillings@1512 1786 };
nickjillings@1512 1787
nickjillings@1512 1788 this.commentQuestions = [];
nickjillings@1512 1789
nickjillings@1512 1790 this.commentBox = function(commentQuestion) {
nickjillings@1512 1791 this.specification = commentQuestion;
nickjillings@1512 1792 // Create document objects to hold the comment boxes
nickjillings@1512 1793 this.holder = document.createElement('div');
nickjillings@1512 1794 this.holder.className = 'comment-div';
nickjillings@1512 1795 // Create a string next to each comment asking for a comment
nickjillings@1512 1796 this.string = document.createElement('span');
nickjillings@1512 1797 this.string.innerHTML = commentQuestion.question;
nickjillings@1512 1798 // Create the HTML5 comment box 'textarea'
nickjillings@1512 1799 this.textArea = document.createElement('textarea');
nickjillings@1512 1800 this.textArea.rows = '4';
nickjillings@1512 1801 this.textArea.cols = '100';
nickjillings@1512 1802 this.textArea.className = 'trackComment';
nickjillings@1512 1803 var br = document.createElement('br');
nickjillings@1512 1804 // Add to the holder.
nickjillings@1512 1805 this.holder.appendChild(this.string);
nickjillings@1512 1806 this.holder.appendChild(br);
nickjillings@1512 1807 this.holder.appendChild(this.textArea);
nickjillings@1512 1808
nickjillings@1512 1809 this.exportXMLDOM = function() {
nickjillings@1512 1810 var root = document.createElement('comment');
nickjillings@1512 1811 root.id = this.specification.id;
nickjillings@1512 1812 root.setAttribute('type',this.specification.type);
nickjillings@1512 1813 root.textContent = this.textArea.value;
nickjillings@1512 1814 console.log("Question: "+this.string.textContent);
nickjillings@1512 1815 console.log("Response: "+root.textContent);
nickjillings@1512 1816 return root;
nickjillings@1512 1817 };
nickjillings@1512 1818 };
nickjillings@1512 1819
nickjillings@1512 1820 this.radioBox = function(commentQuestion) {
nickjillings@1512 1821 this.specification = commentQuestion;
nickjillings@1512 1822 // Create document objects to hold the comment boxes
nickjillings@1512 1823 this.holder = document.createElement('div');
nickjillings@1512 1824 this.holder.className = 'comment-div';
nickjillings@1512 1825 // Create a string next to each comment asking for a comment
nickjillings@1512 1826 this.string = document.createElement('span');
nickjillings@1512 1827 this.string.innerHTML = commentQuestion.statement;
nickjillings@1512 1828 var br = document.createElement('br');
nickjillings@1512 1829 // Add to the holder.
nickjillings@1512 1830 this.holder.appendChild(this.string);
nickjillings@1512 1831 this.holder.appendChild(br);
nickjillings@1512 1832 this.options = [];
nickjillings@1512 1833 this.inputs = document.createElement('div');
nickjillings@1512 1834 this.span = document.createElement('div');
nickjillings@1512 1835 this.inputs.align = 'center';
nickjillings@1512 1836 this.inputs.style.marginLeft = '12px';
nickjillings@1512 1837 this.span.style.marginLeft = '12px';
nickjillings@1512 1838 this.span.align = 'center';
nickjillings@1512 1839 this.span.style.marginTop = '15px';
nickjillings@1512 1840
nickjillings@1512 1841 var optCount = commentQuestion.options.length;
nickjillings@1512 1842 var spanMargin = Math.floor(((600-(optCount*100))/(optCount))/2)+'px';
nickjillings@1512 1843 console.log(spanMargin);
nickjillings@1512 1844 for (var i=0; i<optCount; i++)
nickjillings@1512 1845 {
nickjillings@1512 1846 var div = document.createElement('div');
nickjillings@1512 1847 div.style.width = '100px';
nickjillings@1512 1848 div.style.float = 'left';
nickjillings@1512 1849 div.style.marginRight = spanMargin;
nickjillings@1512 1850 div.style.marginLeft = spanMargin;
nickjillings@1512 1851 var input = document.createElement('input');
nickjillings@1512 1852 input.type = 'radio';
nickjillings@1512 1853 input.name = commentQuestion.id;
nickjillings@1512 1854 input.setAttribute('setvalue',commentQuestion.options[i].name);
nickjillings@1512 1855 input.className = 'comment-radio';
nickjillings@1512 1856 div.appendChild(input);
nickjillings@1512 1857 this.inputs.appendChild(div);
nickjillings@1512 1858
nickjillings@1512 1859
nickjillings@1512 1860 div = document.createElement('div');
nickjillings@1512 1861 div.style.width = '100px';
nickjillings@1512 1862 div.style.float = 'left';
nickjillings@1512 1863 div.style.marginRight = spanMargin;
nickjillings@1512 1864 div.style.marginLeft = spanMargin;
nickjillings@1512 1865 div.align = 'center';
nickjillings@1512 1866 var span = document.createElement('span');
nickjillings@1512 1867 span.textContent = commentQuestion.options[i].text;
nickjillings@1512 1868 span.className = 'comment-radio-span';
nickjillings@1512 1869 div.appendChild(span);
nickjillings@1512 1870 this.span.appendChild(div);
nickjillings@1512 1871 this.options.push(input);
nickjillings@1512 1872 }
nickjillings@1512 1873 this.holder.appendChild(this.span);
nickjillings@1512 1874 this.holder.appendChild(this.inputs);
nickjillings@1512 1875
nickjillings@1512 1876 this.exportXMLDOM = function() {
nickjillings@1512 1877 var root = document.createElement('comment');
nickjillings@1512 1878 root.id = this.specification.id;
nickjillings@1512 1879 root.setAttribute('type',this.specification.type);
nickjillings@1512 1880 var question = document.createElement('question');
nickjillings@1512 1881 question.textContent = this.string.textContent;
nickjillings@1512 1882 var response = document.createElement('response');
nickjillings@1512 1883 var i=0;
nickjillings@1512 1884 while(this.options[i].checked == false) {
nickjillings@1512 1885 i++;
nickjillings@1512 1886 if (i >= this.options.length) {
nickjillings@1512 1887 break;
nickjillings@1512 1888 }
nickjillings@1512 1889 }
nickjillings@1512 1890 if (i >= this.options.length) {
nickjillings@1512 1891 response.textContent = 'null';
nickjillings@1512 1892 } else {
nickjillings@1512 1893 response.textContent = this.options[i].getAttribute('setvalue');
nickjillings@1512 1894 response.setAttribute('number',i);
nickjillings@1512 1895 }
nickjillings@1512 1896 console.log('Comment: '+question.textContent);
nickjillings@1512 1897 console.log('Response: '+response.textContent);
nickjillings@1512 1898 root.appendChild(question);
nickjillings@1512 1899 root.appendChild(response);
nickjillings@1512 1900 return root;
nickjillings@1512 1901 };
nickjillings@1512 1902 };
nickjillings@1512 1903
nickjillings@1512 1904 this.checkboxBox = function(commentQuestion) {
nickjillings@1512 1905 this.specification = commentQuestion;
nickjillings@1512 1906 // Create document objects to hold the comment boxes
nickjillings@1512 1907 this.holder = document.createElement('div');
nickjillings@1512 1908 this.holder.className = 'comment-div';
nickjillings@1512 1909 // Create a string next to each comment asking for a comment
nickjillings@1512 1910 this.string = document.createElement('span');
nickjillings@1512 1911 this.string.innerHTML = commentQuestion.statement;
nickjillings@1512 1912 var br = document.createElement('br');
nickjillings@1512 1913 // Add to the holder.
nickjillings@1512 1914 this.holder.appendChild(this.string);
nickjillings@1512 1915 this.holder.appendChild(br);
nickjillings@1512 1916 this.options = [];
nickjillings@1512 1917 this.inputs = document.createElement('div');
nickjillings@1512 1918 this.span = document.createElement('div');
nickjillings@1512 1919 this.inputs.align = 'center';
nickjillings@1512 1920 this.inputs.style.marginLeft = '12px';
nickjillings@1512 1921 this.span.style.marginLeft = '12px';
nickjillings@1512 1922 this.span.align = 'center';
nickjillings@1512 1923 this.span.style.marginTop = '15px';
nickjillings@1512 1924
nickjillings@1512 1925 var optCount = commentQuestion.options.length;
nickjillings@1512 1926 var spanMargin = Math.floor(((600-(optCount*100))/(optCount))/2)+'px';
nickjillings@1512 1927 console.log(spanMargin);
nickjillings@1512 1928 for (var i=0; i<optCount; i++)
nickjillings@1512 1929 {
nickjillings@1512 1930 var div = document.createElement('div');
nickjillings@1512 1931 div.style.width = '100px';
nickjillings@1512 1932 div.style.float = 'left';
nickjillings@1512 1933 div.style.marginRight = spanMargin;
nickjillings@1512 1934 div.style.marginLeft = spanMargin;
nickjillings@1512 1935 var input = document.createElement('input');
nickjillings@1512 1936 input.type = 'checkbox';
nickjillings@1512 1937 input.name = commentQuestion.id;
nickjillings@1512 1938 input.setAttribute('setvalue',commentQuestion.options[i].name);
nickjillings@1512 1939 input.className = 'comment-radio';
nickjillings@1512 1940 div.appendChild(input);
nickjillings@1512 1941 this.inputs.appendChild(div);
nickjillings@1512 1942
nickjillings@1512 1943
nickjillings@1512 1944 div = document.createElement('div');
nickjillings@1512 1945 div.style.width = '100px';
nickjillings@1512 1946 div.style.float = 'left';
nickjillings@1512 1947 div.style.marginRight = spanMargin;
nickjillings@1512 1948 div.style.marginLeft = spanMargin;
nickjillings@1512 1949 div.align = 'center';
nickjillings@1512 1950 var span = document.createElement('span');
nickjillings@1512 1951 span.textContent = commentQuestion.options[i].text;
nickjillings@1512 1952 span.className = 'comment-radio-span';
nickjillings@1512 1953 div.appendChild(span);
nickjillings@1512 1954 this.span.appendChild(div);
nickjillings@1512 1955 this.options.push(input);
nickjillings@1512 1956 }
nickjillings@1512 1957 this.holder.appendChild(this.span);
nickjillings@1512 1958 this.holder.appendChild(this.inputs);
nickjillings@1512 1959
nickjillings@1512 1960 this.exportXMLDOM = function() {
nickjillings@1512 1961 var root = document.createElement('comment');
nickjillings@1512 1962 root.id = this.specification.id;
nickjillings@1512 1963 root.setAttribute('type',this.specification.type);
nickjillings@1512 1964 var question = document.createElement('question');
nickjillings@1512 1965 question.textContent = this.string.textContent;
nickjillings@1512 1966 root.appendChild(question);
nickjillings@1512 1967 console.log('Comment: '+question.textContent);
nickjillings@1512 1968 for (var i=0; i<this.options.length; i++) {
nickjillings@1512 1969 var response = document.createElement('response');
nickjillings@1512 1970 response.textContent = this.options[i].checked;
nickjillings@1512 1971 response.setAttribute('name',this.options[i].getAttribute('setvalue'));
nickjillings@1512 1972 root.appendChild(response);
nickjillings@1512 1973 console.log('Response '+response.getAttribute('name') +': '+response.textContent);
nickjillings@1512 1974 }
nickjillings@1512 1975 return root;
nickjillings@1512 1976 };
nickjillings@1512 1977 };
nickjillings@1512 1978
nickjillings@1512 1979 this.createCommentBox = function(audioObject) {
nickjillings@1512 1980 var node = new this.elementCommentBox(audioObject);
nickjillings@1512 1981 this.commentBoxes.push(node);
nickjillings@1512 1982 audioObject.commentDOM = node;
nickjillings@1512 1983 return node;
nickjillings@1512 1984 };
nickjillings@1512 1985
nickjillings@1512 1986 this.sortCommentBoxes = function() {
nickjillings@1512 1987 var holder = [];
nickjillings@1512 1988 while (this.commentBoxes.length > 0) {
nickjillings@1512 1989 var node = this.commentBoxes.pop(0);
nickjillings@1512 1990 holder[node.id] = node;
nickjillings@1512 1991 }
nickjillings@1512 1992 this.commentBoxes = holder;
nickjillings@1512 1993 };
nickjillings@1512 1994
nickjillings@1512 1995 this.showCommentBoxes = function(inject, sort) {
nickjillings@1512 1996 if (sort) {interfaceContext.sortCommentBoxes();}
nickjillings@1512 1997 for (var i=0; i<interfaceContext.commentBoxes.length; i++) {
nickjillings@1512 1998 inject.appendChild(this.commentBoxes[i].trackComment);
nickjillings@1512 1999 }
nickjillings@1512 2000 };
nickjillings@1512 2001
nickjillings@1512 2002 this.deleteCommentBoxes = function() {
nickjillings@1512 2003 this.commentBoxes = [];
nickjillings@1512 2004 };
nickjillings@1512 2005
nickjillings@1512 2006 this.createCommentQuestion = function(element) {
nickjillings@1512 2007 var node;
nickjillings@1512 2008 if (element.type == 'text') {
nickjillings@1512 2009 node = new this.commentBox(element);
nickjillings@1512 2010 } else if (element.type == 'radio') {
nickjillings@1512 2011 node = new this.radioBox(element);
nickjillings@1512 2012 } else if (element.type == 'checkbox') {
nickjillings@1512 2013 node = new this.checkboxBox(element);
nickjillings@1512 2014 }
nickjillings@1512 2015 this.commentQuestions.push(node);
nickjillings@1512 2016 return node;
nickjillings@1512 2017 };
nickjillings@1512 2018
nickjillings@1512 2019 this.deleteCommentQuestions = function()
nickjillings@1512 2020 {
nickjillings@1512 2021 this.commentQuestions = [];
nickjillings@1512 2022 };
nickjillings@1512 2023
nickjillings@1512 2024 this.playhead = new function()
nickjillings@1512 2025 {
nickjillings@1512 2026 this.object = document.createElement('div');
nickjillings@1512 2027 this.object.className = 'playhead';
nickjillings@1512 2028 this.object.align = 'left';
nickjillings@1512 2029 var curTime = document.createElement('div');
nickjillings@1512 2030 curTime.style.width = '50px';
nickjillings@1512 2031 this.curTimeSpan = document.createElement('span');
nickjillings@1512 2032 this.curTimeSpan.textContent = '00:00';
nickjillings@1512 2033 curTime.appendChild(this.curTimeSpan);
nickjillings@1512 2034 this.object.appendChild(curTime);
nickjillings@1512 2035 this.scrubberTrack = document.createElement('div');
nickjillings@1512 2036 this.scrubberTrack.className = 'playhead-scrub-track';
nickjillings@1512 2037
nickjillings@1512 2038 this.scrubberHead = document.createElement('div');
nickjillings@1512 2039 this.scrubberHead.id = 'playhead-scrubber';
nickjillings@1512 2040 this.scrubberTrack.appendChild(this.scrubberHead);
nickjillings@1512 2041 this.object.appendChild(this.scrubberTrack);
nickjillings@1512 2042
nickjillings@1512 2043 this.timePerPixel = 0;
nickjillings@1512 2044 this.maxTime = 0;
nickjillings@1512 2045
nickjillings@1512 2046 this.playbackObject;
nickjillings@1512 2047
nickjillings@1512 2048 this.setTimePerPixel = function(audioObject) {
nickjillings@1512 2049 //maxTime must be in seconds
nickjillings@1512 2050 this.playbackObject = audioObject;
nickjillings@1512 2051 this.maxTime = audioObject.buffer.duration;
nickjillings@1512 2052 var width = 490; //500 - 10, 5 each side of the tracker head
nickjillings@1512 2053 this.timePerPixel = this.maxTime/490;
nickjillings@1512 2054 if (this.maxTime < 60) {
nickjillings@1512 2055 this.curTimeSpan.textContent = '0.00';
nickjillings@1512 2056 } else {
nickjillings@1512 2057 this.curTimeSpan.textContent = '00:00';
nickjillings@1512 2058 }
nickjillings@1512 2059 };
nickjillings@1512 2060
nickjillings@1512 2061 this.update = function() {
nickjillings@1512 2062 // Update the playhead position, startPlay must be called
nickjillings@1512 2063 if (this.timePerPixel > 0) {
nickjillings@1512 2064 var time = this.playbackObject.getCurrentPosition();
nickjillings@1512 2065 if (time > 0) {
nickjillings@1512 2066 var width = 490;
nickjillings@1512 2067 var pix = Math.floor(time/this.timePerPixel);
nickjillings@1512 2068 this.scrubberHead.style.left = pix+'px';
nickjillings@1512 2069 if (this.maxTime > 60.0) {
nickjillings@1512 2070 var secs = time%60;
nickjillings@1512 2071 var mins = Math.floor((time-secs)/60);
nickjillings@1512 2072 secs = secs.toString();
nickjillings@1512 2073 secs = secs.substr(0,2);
nickjillings@1512 2074 mins = mins.toString();
nickjillings@1512 2075 this.curTimeSpan.textContent = mins+':'+secs;
nickjillings@1512 2076 } else {
nickjillings@1512 2077 time = time.toString();
nickjillings@1512 2078 this.curTimeSpan.textContent = time.substr(0,4);
nickjillings@1512 2079 }
nickjillings@1512 2080 } else {
nickjillings@1512 2081 this.scrubberHead.style.left = '0px';
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
nickjillings@1512 2091 this.interval = undefined;
nickjillings@1512 2092
nickjillings@1512 2093 this.start = function() {
nickjillings@1512 2094 if (this.playbackObject != undefined && this.interval == undefined) {
nickjillings@1512 2095 if (this.maxTime < 60) {
nickjillings@1512 2096 this.interval = setInterval(function(){interfaceContext.playhead.update();},10);
nickjillings@1512 2097 } else {
nickjillings@1512 2098 this.interval = setInterval(function(){interfaceContext.playhead.update();},100);
nickjillings@1512 2099 }
nickjillings@1512 2100 }
nickjillings@1512 2101 };
nickjillings@1512 2102 this.stop = function() {
nickjillings@1512 2103 clearInterval(this.interval);
nickjillings@1512 2104 this.interval = undefined;
nickjillings@1512 2105 if (this.maxTime < 60) {
nickjillings@1512 2106 this.curTimeSpan.textContent = '0.00';
nickjillings@1512 2107 } else {
nickjillings@1512 2108 this.curTimeSpan.textContent = '00:00';
nickjillings@1512 2109 }
nickjillings@1512 2110 };
nickjillings@1512 2111 };
nickjillings@1512 2112
nickjillings@1512 2113 // Global Checkers
nickjillings@1512 2114 // These functions will help enforce the checkers
nickjillings@1512 2115 this.checkHiddenAnchor = function()
nickjillings@1512 2116 {
nickjillings@1512 2117 var audioHolder = testState.currentStateMap[testState.currentIndex];
nickjillings@1512 2118 if (audioHolder.anchorId != null)
nickjillings@1512 2119 {
nickjillings@1512 2120 var audioObject = audioEngineContext.audioObjects[audioHolder.anchorId];
nickjillings@1512 2121 if (audioObject.interfaceDOM.getValue() > audioObject.specification.marker && audioObject.interfaceDOM.enforce == true)
nickjillings@1512 2122 {
nickjillings@1512 2123 // Anchor is not set below
nickjillings@1512 2124 console.log('Anchor node not below marker value');
nickjillings@1512 2125 alert('Please keep listening');
nickjillings@1512 2126 return false;
nickjillings@1512 2127 }
nickjillings@1512 2128 }
nickjillings@1512 2129 return true;
nickjillings@1512 2130 };
nickjillings@1512 2131
nickjillings@1512 2132 this.checkHiddenReference = function()
nickjillings@1512 2133 {
nickjillings@1512 2134 var audioHolder = testState.currentStateMap[testState.currentIndex];
nickjillings@1512 2135 if (audioHolder.referenceId != null)
nickjillings@1512 2136 {
nickjillings@1512 2137 var audioObject = audioEngineContext.audioObjects[audioHolder.referenceId];
nickjillings@1512 2138 if (audioObject.interfaceDOM.getValue() < audioObject.specification.marker && audioObject.interfaceDOM.enforce == true)
nickjillings@1512 2139 {
nickjillings@1512 2140 // Anchor is not set below
nickjillings@1512 2141 console.log('Reference node not above marker value');
nickjillings@1512 2142 alert('Please keep listening');
nickjillings@1512 2143 return false;
nickjillings@1512 2144 }
nickjillings@1512 2145 }
nickjillings@1512 2146 return true;
nickjillings@1512 2147 };
nickjillings@1512 2148 }