annotate core.js @ 2034:8f977f991ecd

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