annotate core.js @ 874:2ecb68305877

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