annotate core.js @ 1410:c0098cee84f2

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