annotate core.js @ 2050:acf57b56634a

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