annotate core.js @ 1332:45b2f482baa5

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