annotate core.js @ 776:0795031754d7

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