annotate core.js @ 1055:6bd41ef8b1e0

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