annotate core.js @ 1455:36352403f473

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