annotate core.js @ 1406:a2a0a3a6f36d

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