annotate core.js @ 1338:6cd9c2bce083

Interfaces properly handle outside reference objects. Better core.js comment box handling. InterfaceDOM return their presented ID rather than assumed index.
author Nicholas Jillings <nickjillings@users.noreply.github.com>
date Tue, 12 Jan 2016 17:10:39 +0000
parents 9a99872c700f
children 6f41badf6416
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@1334 750 if (this.currentStateMap.randomiseOrder)
nickjillings@1334 751 {
nickjillings@1334 752 this.currentStateMap.audioElements = randomiseOrder(this.currentStateMap.audioElements);
nickjillings@1334 753 }
nickjillings@1324 754 storage.createTestPageStore(this.currentStateMap);
nickjillings@1324 755 if (this.currentStateMap.preTest != null)
nickjillings@1324 756 {
nickjillings@1324 757 this.currentStatePosition = 'pre';
nickjillings@1324 758 popup.initState(this.currentStateMap.preTest,storage.testPages[this.stateIndex].preTest);
nickjillings@1318 759 } else {
nickjillings@1324 760 this.currentStatePosition = 'test';
nickjillings@1324 761 }
nickjillings@1324 762 interfaceContext.newPage(this.currentStateMap,storage.testPages[this.stateIndex]);
nickjillings@1324 763 return;
nickjillings@1324 764 }
nickjillings@1324 765 switch(this.currentStatePosition)
nickjillings@1324 766 {
nickjillings@1324 767 case 'pre':
nickjillings@1324 768 this.currentStatePosition = 'test';
nickjillings@1324 769 break;
nickjillings@1324 770 case 'test':
nickjillings@1324 771 this.currentStatePosition = 'post';
nickjillings@1324 772 // Save the data
nickjillings@1324 773 this.testPageCompleted();
nickjillings@1324 774 if (this.currentStateMap.postTest == null)
nickjillings@1324 775 {
nickjillings@1318 776 this.advanceState();
nickjillings@1324 777 return;
nickjillings@1324 778 } else {
nickjillings@1324 779 popup.initState(this.currentStateMap.postTest,storage.testPages[this.stateIndex].postTest);
nickjillings@1318 780 }
nickjillings@1324 781 break;
nickjillings@1324 782 case 'post':
nickjillings@1324 783 this.stateIndex++;
nickjillings@1324 784 this.currentStateMap = null;
nickjillings@1324 785 this.advanceState();
nickjillings@1324 786 break;
nickjillings@1324 787 };
nickjillings@1318 788 }
nickjillings@1318 789 };
nickjillings@1318 790
nickjillings@1324 791 this.testPageCompleted = function() {
nickjillings@1318 792 // Function called each time a test page has been completed
nickjillings@1324 793 var storePoint = storage.testPages[this.stateIndex];
nickjillings@1324 794 // First get the test metric
nickjillings@1324 795
nickjillings@1324 796 var metric = storePoint.XMLDOM.getElementsByTagName('metric')[0];
nickjillings@1318 797 if (audioEngineContext.metric.enableTestTimer)
nickjillings@1318 798 {
nickjillings@1324 799 var testTime = storePoint.parent.document.createElement('metricresult');
nickjillings@1318 800 testTime.id = 'testTime';
nickjillings@1318 801 testTime.textContent = audioEngineContext.timer.testDuration;
nickjillings@1318 802 metric.appendChild(testTime);
nickjillings@1318 803 }
nickjillings@1324 804
nickjillings@1318 805 var audioObjects = audioEngineContext.audioObjects;
nickjillings@1324 806 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 807 {
nickjillings@1324 808 ao.exportXMLDOM();
nickjillings@1318 809 }
nickjillings@1324 810 for (var element of interfaceContext.commentQuestions)
nickjillings@1324 811 {
nickjillings@1324 812 element.exportXMLDOM(storePoint);
nickjillings@1324 813 }
nickjillings@1324 814 pageXMLSave(storePoint.XMLDOM, this.currentStateMap);
nickjillings@1318 815 };
nickjillings@1318 816 }
nickjillings@1318 817
nickjillings@1318 818 function AudioEngine(specification) {
nickjillings@1318 819
nickjillings@1318 820 // Create two output paths, the main outputGain and fooGain.
nickjillings@1318 821 // Output gain is default to 1 and any items for playback route here
nickjillings@1318 822 // Foo gain is used for analysis to ensure paths get processed, but are not heard
nickjillings@1318 823 // because web audio will optimise and any route which does not go to the destination gets ignored.
nickjillings@1318 824 this.outputGain = audioContext.createGain();
nickjillings@1318 825 this.fooGain = audioContext.createGain();
nickjillings@1318 826 this.fooGain.gain = 0;
nickjillings@1318 827
nickjillings@1318 828 // Use this to detect playback state: 0 - stopped, 1 - playing
nickjillings@1318 829 this.status = 0;
nickjillings@1318 830
nickjillings@1318 831 // Connect both gains to output
nickjillings@1318 832 this.outputGain.connect(audioContext.destination);
nickjillings@1318 833 this.fooGain.connect(audioContext.destination);
nickjillings@1318 834
nickjillings@1318 835 // Create the timer Object
nickjillings@1318 836 this.timer = new timer();
nickjillings@1318 837 // Create session metrics
nickjillings@1318 838 this.metric = new sessionMetrics(this,specification);
nickjillings@1318 839
nickjillings@1318 840 this.loopPlayback = false;
nickjillings@1318 841
nickjillings@1324 842 this.pageStore = null;
nickjillings@1324 843
nickjillings@1318 844 // Create store for new audioObjects
nickjillings@1318 845 this.audioObjects = [];
nickjillings@1318 846
nickjillings@1318 847 this.buffers = [];
nickjillings@1318 848 this.bufferObj = function()
nickjillings@1318 849 {
nickjillings@1318 850 this.url = null;
nickjillings@1318 851 this.buffer = null;
nickjillings@1318 852 this.xmlRequest = new XMLHttpRequest();
nickjillings@1318 853 this.xmlRequest.parent = this;
nickjillings@1318 854 this.users = [];
nickjillings@1318 855 this.getMedia = function(url) {
nickjillings@1318 856 this.url = url;
nickjillings@1318 857 this.xmlRequest.open('GET',this.url,true);
nickjillings@1318 858 this.xmlRequest.responseType = 'arraybuffer';
nickjillings@1318 859
nickjillings@1318 860 var bufferObj = this;
nickjillings@1318 861
nickjillings@1318 862 // Create callback to decode the data asynchronously
nickjillings@1318 863 this.xmlRequest.onloadend = function() {
nickjillings@1318 864 audioContext.decodeAudioData(bufferObj.xmlRequest.response, function(decodedData) {
nickjillings@1318 865 bufferObj.buffer = decodedData;
nickjillings@1318 866 for (var i=0; i<bufferObj.users.length; i++)
nickjillings@1318 867 {
nickjillings@1318 868 bufferObj.users[i].state = 1;
nickjillings@1318 869 if (bufferObj.users[i].interfaceDOM != null)
nickjillings@1318 870 {
nickjillings@1318 871 bufferObj.users[i].bufferLoaded(bufferObj);
nickjillings@1318 872 }
nickjillings@1318 873 }
nickjillings@1318 874 calculateLoudness(bufferObj.buffer,"I");
nickjillings@1318 875 }, function(){
nickjillings@1318 876 // Should only be called if there was an error, but sometimes gets called continuously
nickjillings@1318 877 // Check here if the error is genuine
nickjillings@1318 878 if (bufferObj.buffer == undefined) {
nickjillings@1318 879 // Genuine error
nickjillings@1318 880 console.log('FATAL - Error loading buffer on '+audioObj.id);
nickjillings@1318 881 if (request.status == 404)
nickjillings@1318 882 {
nickjillings@1318 883 console.log('FATAL - Fragment '+audioObj.id+' 404 error');
nickjillings@1318 884 console.log('URL: '+audioObj.url);
nickjillings@1318 885 errorSessionDump('Fragment '+audioObj.id+' 404 error');
nickjillings@1318 886 }
nickjillings@1318 887 }
nickjillings@1318 888 });
nickjillings@1318 889 };
nickjillings@1318 890 this.progress = 0;
nickjillings@1318 891 this.progressCallback = function(event){
nickjillings@1318 892 if (event.lengthComputable)
nickjillings@1318 893 {
nickjillings@1318 894 this.parent.progress = event.loaded / event.total;
nickjillings@1318 895 for (var i=0; i<this.parent.users.length; i++)
nickjillings@1318 896 {
nickjillings@1318 897 if(this.parent.users[i].interfaceDOM != null)
nickjillings@1318 898 {
nickjillings@1318 899 if (typeof this.parent.users[i].interfaceDOM.updateLoading === "function")
nickjillings@1318 900 {
nickjillings@1318 901 this.parent.users[i].interfaceDOM.updateLoading(this.parent.progress*100);
nickjillings@1318 902 }
nickjillings@1318 903 }
nickjillings@1318 904 }
nickjillings@1318 905 }
nickjillings@1318 906 };
nickjillings@1318 907 this.xmlRequest.addEventListener("progress", this.progressCallback);
nickjillings@1318 908 this.xmlRequest.send();
nickjillings@1318 909 };
nickjillings@1318 910 };
nickjillings@1318 911
nickjillings@1318 912 this.play = function(id) {
nickjillings@1318 913 // Start the timer and set the audioEngine state to playing (1)
nickjillings@1318 914 if (this.status == 0 && this.loopPlayback) {
nickjillings@1318 915 // Check if all audioObjects are ready
nickjillings@1318 916 if(this.checkAllReady())
nickjillings@1318 917 {
nickjillings@1318 918 this.status = 1;
nickjillings@1318 919 this.setSynchronousLoop();
nickjillings@1318 920 }
nickjillings@1318 921 }
nickjillings@1318 922 else
nickjillings@1318 923 {
nickjillings@1318 924 this.status = 1;
nickjillings@1318 925 }
nickjillings@1318 926 if (this.status== 1) {
nickjillings@1318 927 this.timer.startTest();
nickjillings@1318 928 if (id == undefined) {
nickjillings@1318 929 id = -1;
nickjillings@1318 930 console.log('FATAL - Passed id was undefined - AudioEngineContext.play(id)');
nickjillings@1318 931 return;
nickjillings@1318 932 } else {
nickjillings@1318 933 interfaceContext.playhead.setTimePerPixel(this.audioObjects[id]);
nickjillings@1318 934 }
nickjillings@1318 935 if (this.loopPlayback) {
nickjillings@1318 936 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 937 {
nickjillings@1318 938 this.audioObjects[i].play(this.timer.getTestTime()+1);
nickjillings@1318 939 if (id == i) {
nickjillings@1318 940 this.audioObjects[i].loopStart();
nickjillings@1318 941 } else {
nickjillings@1318 942 this.audioObjects[i].loopStop();
nickjillings@1318 943 }
nickjillings@1318 944 }
nickjillings@1318 945 } else {
nickjillings@1318 946 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 947 {
nickjillings@1318 948 if (i != id) {
nickjillings@1318 949 this.audioObjects[i].outputGain.gain.value = 0.0;
nickjillings@1318 950 this.audioObjects[i].stop();
nickjillings@1318 951 } else if (i == id) {
nickjillings@1324 952 this.audioObjects[id].outputGain.gain.value = this.audioObjects[id].onplayGain;
nickjillings@1318 953 this.audioObjects[id].play(audioContext.currentTime+0.01);
nickjillings@1318 954 }
nickjillings@1318 955 }
nickjillings@1318 956 }
nickjillings@1318 957 interfaceContext.playhead.start();
nickjillings@1318 958 }
nickjillings@1318 959 };
nickjillings@1318 960
nickjillings@1318 961 this.stop = function() {
nickjillings@1318 962 // Send stop and reset command to all playback buffers and set audioEngine state to stopped (1)
nickjillings@1318 963 if (this.status == 1) {
nickjillings@1318 964 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 965 {
nickjillings@1318 966 this.audioObjects[i].stop();
nickjillings@1318 967 }
nickjillings@1318 968 interfaceContext.playhead.stop();
nickjillings@1318 969 this.status = 0;
nickjillings@1318 970 }
nickjillings@1318 971 };
nickjillings@1318 972
nickjillings@1318 973 this.newTrack = function(element) {
nickjillings@1318 974 // Pull data from given URL into new audio buffer
nickjillings@1318 975 // URLs must either be from the same source OR be setup to 'Access-Control-Allow-Origin'
nickjillings@1318 976
nickjillings@1318 977 // Create the audioObject with ID of the new track length;
nickjillings@1318 978 audioObjectId = this.audioObjects.length;
nickjillings@1318 979 this.audioObjects[audioObjectId] = new audioObject(audioObjectId);
nickjillings@1318 980
nickjillings@1318 981 // Check if audioObject buffer is currently stored by full URL
nickjillings@1324 982 var URL = testState.currentStateMap.hostURL + element.url;
nickjillings@1318 983 var buffer = null;
nickjillings@1318 984 for (var i=0; i<this.buffers.length; i++)
nickjillings@1318 985 {
nickjillings@1318 986 if (URL == this.buffers[i].url)
nickjillings@1318 987 {
nickjillings@1318 988 buffer = this.buffers[i];
nickjillings@1318 989 break;
nickjillings@1318 990 }
nickjillings@1318 991 }
nickjillings@1318 992 if (buffer == null)
nickjillings@1318 993 {
nickjillings@1318 994 console.log("[WARN]: Buffer was not loaded in pre-test! "+URL);
nickjillings@1318 995 buffer = new this.bufferObj();
nickjillings@1318 996 buffer.getMedia(URL);
nickjillings@1318 997 this.buffers.push(buffer);
nickjillings@1318 998 }
nickjillings@1318 999 this.audioObjects[audioObjectId].specification = element;
nickjillings@1318 1000 this.audioObjects[audioObjectId].url = URL;
nickjillings@1318 1001 buffer.users.push(this.audioObjects[audioObjectId]);
nickjillings@1324 1002 // Obtain store node
nickjillings@1324 1003 var aeNodes = this.pageStore.XMLDOM.getElementsByTagName('audioelement');
nickjillings@1324 1004 for (var i=0; i<aeNodes.length; i++)
nickjillings@1324 1005 {
nickjillings@1324 1006 if(aeNodes[i].id == element.id)
nickjillings@1324 1007 {
nickjillings@1324 1008 this.audioObjects[audioObjectId].storeDOM = aeNodes[i];
nickjillings@1324 1009 break;
nickjillings@1324 1010 }
nickjillings@1324 1011 }
nickjillings@1318 1012 if (buffer.buffer != null)
nickjillings@1318 1013 {
nickjillings@1318 1014 this.audioObjects[audioObjectId].bufferLoaded(buffer);
nickjillings@1318 1015 }
nickjillings@1318 1016 return this.audioObjects[audioObjectId];
nickjillings@1318 1017 };
nickjillings@1318 1018
nickjillings@1324 1019 this.newTestPage = function(store) {
nickjillings@1324 1020 this.pageStore = store;
nickjillings@1318 1021 this.state = 0;
nickjillings@1318 1022 this.audioObjectsReady = false;
nickjillings@1318 1023 this.metric.reset();
nickjillings@1318 1024 for (var i=0; i < this.buffers.length; i++)
nickjillings@1318 1025 {
nickjillings@1318 1026 this.buffers[i].users = [];
nickjillings@1318 1027 }
nickjillings@1318 1028 this.audioObjects = [];
nickjillings@1318 1029 };
nickjillings@1318 1030
nickjillings@1318 1031 this.checkAllPlayed = function() {
nickjillings@1318 1032 arr = [];
nickjillings@1318 1033 for (var id=0; id<this.audioObjects.length; id++) {
nickjillings@1318 1034 if (this.audioObjects[id].metric.wasListenedTo == false) {
nickjillings@1318 1035 arr.push(this.audioObjects[id].id);
nickjillings@1318 1036 }
nickjillings@1318 1037 }
nickjillings@1318 1038 return arr;
nickjillings@1318 1039 };
nickjillings@1318 1040
nickjillings@1318 1041 this.checkAllReady = function() {
nickjillings@1318 1042 var ready = true;
nickjillings@1318 1043 for (var i=0; i<this.audioObjects.length; i++) {
nickjillings@1318 1044 if (this.audioObjects[i].state == 0) {
nickjillings@1318 1045 // Track not ready
nickjillings@1318 1046 console.log('WAIT -- audioObject '+i+' not ready yet!');
nickjillings@1318 1047 ready = false;
nickjillings@1318 1048 };
nickjillings@1318 1049 }
nickjillings@1318 1050 return ready;
nickjillings@1318 1051 };
nickjillings@1318 1052
nickjillings@1318 1053 this.setSynchronousLoop = function() {
nickjillings@1318 1054 // Pads the signals so they are all exactly the same length
nickjillings@1318 1055 var length = 0;
nickjillings@1318 1056 var maxId;
nickjillings@1318 1057 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1058 {
nickjillings@1318 1059 if (length < this.audioObjects[i].buffer.buffer.length)
nickjillings@1318 1060 {
nickjillings@1318 1061 length = this.audioObjects[i].buffer.buffer.length;
nickjillings@1318 1062 maxId = i;
nickjillings@1318 1063 }
nickjillings@1318 1064 }
nickjillings@1318 1065 // Extract the audio and zero-pad
nickjillings@1318 1066 for (var i=0; i<this.audioObjects.length; i++)
nickjillings@1318 1067 {
nickjillings@1318 1068 var orig = this.audioObjects[i].buffer.buffer;
nickjillings@1318 1069 var hold = audioContext.createBuffer(orig.numberOfChannels,length,orig.sampleRate);
nickjillings@1318 1070 for (var c=0; c<orig.numberOfChannels; c++)
nickjillings@1318 1071 {
nickjillings@1318 1072 var inData = hold.getChannelData(c);
nickjillings@1318 1073 var outData = orig.getChannelData(c);
nickjillings@1318 1074 for (var n=0; n<orig.length; n++)
nickjillings@1318 1075 {inData[n] = outData[n];}
nickjillings@1318 1076 }
nickjillings@1320 1077 hold.playbackGain = orig.playbackGain;
nickjillings@1318 1078 hold.lufs = orig.lufs;
nickjillings@1318 1079 this.audioObjects[i].buffer.buffer = hold;
nickjillings@1318 1080 }
nickjillings@1318 1081 };
nickjillings@1318 1082
nickjillings@1318 1083 }
nickjillings@1318 1084
nickjillings@1318 1085 function audioObject(id) {
nickjillings@1318 1086 // The main buffer object with common control nodes to the AudioEngine
nickjillings@1318 1087
nickjillings@1318 1088 this.specification;
nickjillings@1318 1089 this.id = id;
nickjillings@1318 1090 this.state = 0; // 0 - no data, 1 - ready
nickjillings@1318 1091 this.url = null; // Hold the URL given for the output back to the results.
nickjillings@1318 1092 this.metric = new metricTracker(this);
nickjillings@1324 1093 this.storeDOM = null;
nickjillings@1318 1094
nickjillings@1318 1095 // Bindings for GUI
nickjillings@1318 1096 this.interfaceDOM = null;
nickjillings@1318 1097 this.commentDOM = null;
nickjillings@1318 1098
nickjillings@1318 1099 // Create a buffer and external gain control to allow internal patching of effects and volume leveling.
nickjillings@1318 1100 this.bufferNode = undefined;
nickjillings@1318 1101 this.outputGain = audioContext.createGain();
nickjillings@1318 1102
nickjillings@1318 1103 // Default output gain to be zero
nickjillings@1318 1104 this.outputGain.gain.value = 0.0;
nickjillings@1324 1105 this.onplayGain = 1.0;
nickjillings@1318 1106
nickjillings@1318 1107 // Connect buffer to the audio graph
nickjillings@1318 1108 this.outputGain.connect(audioEngineContext.outputGain);
nickjillings@1318 1109
nickjillings@1318 1110 // the audiobuffer is not designed for multi-start playback
nickjillings@1318 1111 // When stopeed, the buffer node is deleted and recreated with the stored buffer.
nickjillings@1318 1112 this.buffer;
nickjillings@1318 1113
nickjillings@1318 1114 this.bufferLoaded = function(callee)
nickjillings@1318 1115 {
nickjillings@1318 1116 // Called by the associated buffer when it has finished loading, will then 'bind' the buffer to the
nickjillings@1318 1117 // audioObject and trigger the interfaceDOM.enable() function for user feedback
nickjillings@1318 1118 if (audioEngineContext.loopPlayback){
nickjillings@1318 1119 // First copy the buffer into this.buffer
nickjillings@1318 1120 this.buffer = new audioEngineContext.bufferObj();
nickjillings@1318 1121 this.buffer.url = callee.url;
nickjillings@1318 1122 this.buffer.buffer = audioContext.createBuffer(callee.buffer.numberOfChannels, callee.buffer.length, callee.buffer.sampleRate);
nickjillings@1318 1123 for (var c=0; c<callee.buffer.numberOfChannels; c++)
nickjillings@1318 1124 {
nickjillings@1318 1125 var src = callee.buffer.getChannelData(c);
nickjillings@1318 1126 var dst = this.buffer.buffer.getChannelData(c);
nickjillings@1318 1127 for (var n=0; n<src.length; n++)
nickjillings@1318 1128 {
nickjillings@1318 1129 dst[n] = src[n];
nickjillings@1318 1130 }
nickjillings@1318 1131 }
nickjillings@1318 1132 } else {
nickjillings@1318 1133 this.buffer = callee;
nickjillings@1318 1134 }
nickjillings@1318 1135 this.state = 1;
nickjillings@1320 1136 this.buffer.buffer.playbackGain = callee.buffer.playbackGain;
nickjillings@1318 1137 this.buffer.buffer.lufs = callee.buffer.lufs;
nickjillings@1318 1138 var targetLUFS = this.specification.parent.loudness;
nickjillings@1318 1139 if (typeof targetLUFS === "number")
nickjillings@1318 1140 {
nickjillings@1320 1141 this.buffer.buffer.playbackGain = decibelToLinear(targetLUFS - this.buffer.buffer.lufs);
nickjillings@1318 1142 } else {
nickjillings@1320 1143 this.buffer.buffer.playbackGain = 1.0;
nickjillings@1318 1144 }
nickjillings@1318 1145 if (this.interfaceDOM != null) {
nickjillings@1318 1146 this.interfaceDOM.enable();
nickjillings@1318 1147 }
nickjillings@1324 1148 this.onplayGain = decibelToLinear(this.specification.gain)*this.buffer.buffer.playbackGain;
nickjillings@1324 1149 this.storeDOM.setAttribute('playGain',linearToDecibel(this.onplayGain));
nickjillings@1318 1150 };
nickjillings@1325 1151
nickjillings@1325 1152 this.bindInterface = function(interfaceObject)
nickjillings@1325 1153 {
nickjillings@1325 1154 this.interfaceDOM = interfaceObject;
nickjillings@1325 1155 this.metric.initialise(interfaceObject.getValue());
nickjillings@1325 1156 if (this.state == 1)
nickjillings@1325 1157 {
nickjillings@1325 1158 this.interfaceDOM.enable();
nickjillings@1325 1159 }
nickjillings@1338 1160 this.storeDOM.setAttribute('presentedId',interfaceObject.getPresentedId());
nickjillings@1325 1161 };
nickjillings@1318 1162
nickjillings@1318 1163 this.loopStart = function() {
nickjillings@1324 1164 this.outputGain.gain.value = this.onplayGain;
nickjillings@1318 1165 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1318 1166 };
nickjillings@1318 1167
nickjillings@1318 1168 this.loopStop = function() {
nickjillings@1318 1169 if (this.outputGain.gain.value != 0.0) {
nickjillings@1318 1170 this.outputGain.gain.value = 0.0;
nickjillings@1318 1171 this.metric.stopListening(audioEngineContext.timer.getTestTime());
nickjillings@1318 1172 }
nickjillings@1318 1173 };
nickjillings@1318 1174
nickjillings@1318 1175 this.play = function(startTime) {
nickjillings@1318 1176 if (this.bufferNode == undefined && this.buffer.buffer != undefined) {
nickjillings@1318 1177 this.bufferNode = audioContext.createBufferSource();
nickjillings@1318 1178 this.bufferNode.owner = this;
nickjillings@1318 1179 this.bufferNode.connect(this.outputGain);
nickjillings@1318 1180 this.bufferNode.buffer = this.buffer.buffer;
nickjillings@1318 1181 this.bufferNode.loop = audioEngineContext.loopPlayback;
nickjillings@1318 1182 this.bufferNode.onended = function(event) {
nickjillings@1318 1183 // Safari does not like using 'this' to reference the calling object!
nickjillings@1318 1184 //event.currentTarget.owner.metric.stopListening(audioEngineContext.timer.getTestTime(),event.currentTarget.owner.getCurrentPosition());
nickjillings@1318 1185 event.currentTarget.owner.stop();
nickjillings@1318 1186 };
nickjillings@1318 1187 if (this.bufferNode.loop == false) {
nickjillings@1318 1188 this.metric.startListening(audioEngineContext.timer.getTestTime());
nickjillings@1318 1189 }
nickjillings@1318 1190 this.bufferNode.start(startTime);
nickjillings@1318 1191 }
nickjillings@1318 1192 };
nickjillings@1318 1193
nickjillings@1318 1194 this.stop = function() {
nickjillings@1318 1195 if (this.bufferNode != undefined)
nickjillings@1318 1196 {
nickjillings@1318 1197 this.metric.stopListening(audioEngineContext.timer.getTestTime(),this.getCurrentPosition());
nickjillings@1318 1198 this.bufferNode.stop(0);
nickjillings@1318 1199 this.bufferNode = undefined;
nickjillings@1318 1200 }
nickjillings@1318 1201 };
nickjillings@1318 1202
nickjillings@1318 1203 this.getCurrentPosition = function() {
nickjillings@1318 1204 var time = audioEngineContext.timer.getTestTime();
nickjillings@1318 1205 if (this.bufferNode != undefined) {
nickjillings@1318 1206 if (this.bufferNode.loop == true) {
nickjillings@1318 1207 if (audioEngineContext.status == 1) {
nickjillings@1318 1208 return (time-this.metric.listenStart)%this.buffer.buffer.duration;
nickjillings@1318 1209 } else {
nickjillings@1318 1210 return 0;
nickjillings@1318 1211 }
nickjillings@1318 1212 } else {
nickjillings@1318 1213 if (this.metric.listenHold) {
nickjillings@1318 1214 return time - this.metric.listenStart;
nickjillings@1318 1215 } else {
nickjillings@1318 1216 return 0;
nickjillings@1318 1217 }
nickjillings@1318 1218 }
nickjillings@1318 1219 } else {
nickjillings@1318 1220 return 0;
nickjillings@1318 1221 }
nickjillings@1318 1222 };
nickjillings@1318 1223
nickjillings@1318 1224 this.exportXMLDOM = function() {
nickjillings@1324 1225 var file = storage.document.createElement('file');
nickjillings@1318 1226 file.setAttribute('sampleRate',this.buffer.buffer.sampleRate);
nickjillings@1318 1227 file.setAttribute('channels',this.buffer.buffer.numberOfChannels);
nickjillings@1318 1228 file.setAttribute('sampleCount',this.buffer.buffer.length);
nickjillings@1318 1229 file.setAttribute('duration',this.buffer.buffer.duration);
nickjillings@1324 1230 this.storeDOM.appendChild(file);
nickjillings@1324 1231 if (this.specification.type != 'outside-reference') {
nickjillings@1318 1232 var interfaceXML = this.interfaceDOM.exportXMLDOM(this);
nickjillings@1318 1233 if (interfaceXML.length == undefined) {
nickjillings@1324 1234 this.storeDOM.appendChild(interfaceXML);
nickjillings@1318 1235 } else {
nickjillings@1318 1236 for (var i=0; i<interfaceXML.length; i++)
nickjillings@1318 1237 {
nickjillings@1324 1238 this.storeDOM.appendChild(interfaceXML[i]);
nickjillings@1318 1239 }
nickjillings@1318 1240 }
nickjillings@1330 1241 if (this.commentDOM != null) {
nickjillings@1330 1242 this.storeDOM.appendChild(this.commentDOM.exportXMLDOM(this));
nickjillings@1330 1243 }
nickjillings@1318 1244 }
nickjillings@1324 1245 var nodes = this.metric.exportXMLDOM();
nickjillings@1324 1246 var mroot = this.storeDOM.getElementsByTagName('metric')[0];
nickjillings@1324 1247 for (var i=0; i<nodes.length; i++)
nickjillings@1324 1248 {
nickjillings@1324 1249 mroot.appendChild(nodes[i]);
nickjillings@1324 1250 }
nickjillings@1318 1251 };
nickjillings@1318 1252 }
nickjillings@1318 1253
nickjillings@1318 1254 function timer()
nickjillings@1318 1255 {
nickjillings@1318 1256 /* Timer object used in audioEngine to keep track of session timings
nickjillings@1318 1257 * Uses the timer of the web audio API, so sample resolution
nickjillings@1318 1258 */
nickjillings@1318 1259 this.testStarted = false;
nickjillings@1318 1260 this.testStartTime = 0;
nickjillings@1318 1261 this.testDuration = 0;
nickjillings@1318 1262 this.minimumTestTime = 0; // No minimum test time
nickjillings@1318 1263 this.startTest = function()
nickjillings@1318 1264 {
nickjillings@1318 1265 if (this.testStarted == false)
nickjillings@1318 1266 {
nickjillings@1318 1267 this.testStartTime = audioContext.currentTime;
nickjillings@1318 1268 this.testStarted = true;
nickjillings@1318 1269 this.updateTestTime();
nickjillings@1318 1270 audioEngineContext.metric.initialiseTest();
nickjillings@1318 1271 }
nickjillings@1318 1272 };
nickjillings@1318 1273 this.stopTest = function()
nickjillings@1318 1274 {
nickjillings@1318 1275 if (this.testStarted)
nickjillings@1318 1276 {
nickjillings@1318 1277 this.testDuration = this.getTestTime();
nickjillings@1318 1278 this.testStarted = false;
nickjillings@1318 1279 } else {
nickjillings@1318 1280 console.log('ERR: Test tried to end before beginning');
nickjillings@1318 1281 }
nickjillings@1318 1282 };
nickjillings@1318 1283 this.updateTestTime = function()
nickjillings@1318 1284 {
nickjillings@1318 1285 if (this.testStarted)
nickjillings@1318 1286 {
nickjillings@1318 1287 this.testDuration = audioContext.currentTime - this.testStartTime;
nickjillings@1318 1288 }
nickjillings@1318 1289 };
nickjillings@1318 1290 this.getTestTime = function()
nickjillings@1318 1291 {
nickjillings@1318 1292 this.updateTestTime();
nickjillings@1318 1293 return this.testDuration;
nickjillings@1318 1294 };
nickjillings@1318 1295 }
nickjillings@1318 1296
nickjillings@1318 1297 function sessionMetrics(engine,specification)
nickjillings@1318 1298 {
nickjillings@1318 1299 /* Used by audioEngine to link to audioObjects to minimise the timer call timers;
nickjillings@1318 1300 */
nickjillings@1318 1301 this.engine = engine;
nickjillings@1318 1302 this.lastClicked = -1;
nickjillings@1318 1303 this.data = -1;
nickjillings@1318 1304 this.reset = function() {
nickjillings@1318 1305 this.lastClicked = -1;
nickjillings@1318 1306 this.data = -1;
nickjillings@1318 1307 };
nickjillings@1318 1308
nickjillings@1318 1309 this.enableElementInitialPosition = false;
nickjillings@1318 1310 this.enableElementListenTracker = false;
nickjillings@1318 1311 this.enableElementTimer = false;
nickjillings@1318 1312 this.enableElementTracker = false;
nickjillings@1318 1313 this.enableFlagListenedTo = false;
nickjillings@1318 1314 this.enableFlagMoved = false;
nickjillings@1318 1315 this.enableTestTimer = false;
nickjillings@1318 1316 // Obtain the metrics enabled
nickjillings@1324 1317 for (var i=0; i<specification.metrics.enabled.length; i++)
nickjillings@1318 1318 {
nickjillings@1324 1319 var node = specification.metrics.enabled[i];
nickjillings@1324 1320 switch(node)
nickjillings@1318 1321 {
nickjillings@1318 1322 case 'testTimer':
nickjillings@1318 1323 this.enableTestTimer = true;
nickjillings@1318 1324 break;
nickjillings@1318 1325 case 'elementTimer':
nickjillings@1318 1326 this.enableElementTimer = true;
nickjillings@1318 1327 break;
nickjillings@1318 1328 case 'elementTracker':
nickjillings@1318 1329 this.enableElementTracker = true;
nickjillings@1318 1330 break;
nickjillings@1318 1331 case 'elementListenTracker':
nickjillings@1318 1332 this.enableElementListenTracker = true;
nickjillings@1318 1333 break;
nickjillings@1318 1334 case 'elementInitialPosition':
nickjillings@1318 1335 this.enableElementInitialPosition = true;
nickjillings@1318 1336 break;
nickjillings@1318 1337 case 'elementFlagListenedTo':
nickjillings@1318 1338 this.enableFlagListenedTo = true;
nickjillings@1318 1339 break;
nickjillings@1318 1340 case 'elementFlagMoved':
nickjillings@1318 1341 this.enableFlagMoved = true;
nickjillings@1318 1342 break;
nickjillings@1318 1343 case 'elementFlagComments':
nickjillings@1318 1344 this.enableFlagComments = true;
nickjillings@1318 1345 break;
nickjillings@1318 1346 }
nickjillings@1318 1347 }
nickjillings@1318 1348 this.initialiseTest = function(){};
nickjillings@1318 1349 }
nickjillings@1318 1350
nickjillings@1318 1351 function metricTracker(caller)
nickjillings@1318 1352 {
nickjillings@1318 1353 /* Custom object to track and collect metric data
nickjillings@1318 1354 * Used only inside the audioObjects object.
nickjillings@1318 1355 */
nickjillings@1318 1356
nickjillings@1318 1357 this.listenedTimer = 0;
nickjillings@1318 1358 this.listenStart = 0;
nickjillings@1318 1359 this.listenHold = false;
nickjillings@1318 1360 this.initialPosition = -1;
nickjillings@1318 1361 this.movementTracker = [];
nickjillings@1318 1362 this.listenTracker =[];
nickjillings@1318 1363 this.wasListenedTo = false;
nickjillings@1318 1364 this.wasMoved = false;
nickjillings@1318 1365 this.hasComments = false;
nickjillings@1318 1366 this.parent = caller;
nickjillings@1318 1367
nickjillings@1324 1368 this.initialise = function(position)
nickjillings@1318 1369 {
nickjillings@1318 1370 if (this.initialPosition == -1) {
nickjillings@1318 1371 this.initialPosition = position;
nickjillings@1325 1372 this.moved(0,position);
nickjillings@1318 1373 }
nickjillings@1318 1374 };
nickjillings@1318 1375
nickjillings@1318 1376 this.moved = function(time,position)
nickjillings@1318 1377 {
nickjillings@1325 1378 if (time > 0) {this.wasMoved = true;}
nickjillings@1318 1379 this.movementTracker[this.movementTracker.length] = [time, position];
nickjillings@1318 1380 };
nickjillings@1318 1381
nickjillings@1318 1382 this.startListening = function(time)
nickjillings@1318 1383 {
nickjillings@1318 1384 if (this.listenHold == false)
nickjillings@1318 1385 {
nickjillings@1318 1386 this.wasListenedTo = true;
nickjillings@1318 1387 this.listenStart = time;
nickjillings@1318 1388 this.listenHold = true;
nickjillings@1318 1389
nickjillings@1318 1390 var evnt = document.createElement('event');
nickjillings@1318 1391 var testTime = document.createElement('testTime');
nickjillings@1318 1392 testTime.setAttribute('start',time);
nickjillings@1318 1393 var bufferTime = document.createElement('bufferTime');
nickjillings@1318 1394 bufferTime.setAttribute('start',this.parent.getCurrentPosition());
nickjillings@1318 1395 evnt.appendChild(testTime);
nickjillings@1318 1396 evnt.appendChild(bufferTime);
nickjillings@1318 1397 this.listenTracker.push(evnt);
nickjillings@1318 1398
nickjillings@1318 1399 console.log('slider ' + this.parent.id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1318 1400 }
nickjillings@1318 1401 };
nickjillings@1318 1402
nickjillings@1318 1403 this.stopListening = function(time,bufferStopTime)
nickjillings@1318 1404 {
nickjillings@1318 1405 if (this.listenHold == true)
nickjillings@1318 1406 {
nickjillings@1318 1407 var diff = time - this.listenStart;
nickjillings@1318 1408 this.listenedTimer += (diff);
nickjillings@1318 1409 this.listenStart = 0;
nickjillings@1318 1410 this.listenHold = false;
nickjillings@1318 1411
nickjillings@1318 1412 var evnt = this.listenTracker[this.listenTracker.length-1];
nickjillings@1318 1413 var testTime = evnt.getElementsByTagName('testTime')[0];
nickjillings@1318 1414 var bufferTime = evnt.getElementsByTagName('bufferTime')[0];
nickjillings@1318 1415 testTime.setAttribute('stop',time);
nickjillings@1318 1416 if (bufferStopTime == undefined) {
nickjillings@1318 1417 bufferTime.setAttribute('stop',this.parent.getCurrentPosition());
nickjillings@1318 1418 } else {
nickjillings@1318 1419 bufferTime.setAttribute('stop',bufferStopTime);
nickjillings@1318 1420 }
nickjillings@1318 1421 console.log('slider ' + this.parent.id + ' played for (' + diff + ')'); // DEBUG/SAFETY: show played slider id
nickjillings@1318 1422 }
nickjillings@1318 1423 };
nickjillings@1318 1424
nickjillings@1318 1425 this.exportXMLDOM = function() {
nickjillings@1324 1426 var storeDOM = [];
nickjillings@1318 1427 if (audioEngineContext.metric.enableElementTimer) {
nickjillings@1324 1428 var mElementTimer = storage.document.createElement('metricresult');
nickjillings@1318 1429 mElementTimer.setAttribute('name','enableElementTimer');
nickjillings@1318 1430 mElementTimer.textContent = this.listenedTimer;
nickjillings@1324 1431 storeDOM.push(mElementTimer);
nickjillings@1318 1432 }
nickjillings@1318 1433 if (audioEngineContext.metric.enableElementTracker) {
nickjillings@1324 1434 var elementTrackerFull = storage.document.createElement('metricResult');
nickjillings@1318 1435 elementTrackerFull.setAttribute('name','elementTrackerFull');
nickjillings@1318 1436 for (var k=0; k<this.movementTracker.length; k++)
nickjillings@1318 1437 {
nickjillings@1324 1438 var timePos = storage.document.createElement('timePos');
nickjillings@1318 1439 timePos.id = k;
nickjillings@1324 1440 var time = storage.document.createElement('time');
nickjillings@1318 1441 time.textContent = this.movementTracker[k][0];
nickjillings@1318 1442 var position = document.createElement('position');
nickjillings@1318 1443 position.textContent = this.movementTracker[k][1];
nickjillings@1318 1444 timePos.appendChild(time);
nickjillings@1318 1445 timePos.appendChild(position);
nickjillings@1318 1446 elementTrackerFull.appendChild(timePos);
nickjillings@1318 1447 }
nickjillings@1324 1448 storeDOM.push(elementTrackerFull);
nickjillings@1318 1449 }
nickjillings@1318 1450 if (audioEngineContext.metric.enableElementListenTracker) {
nickjillings@1324 1451 var elementListenTracker = storage.document.createElement('metricResult');
nickjillings@1318 1452 elementListenTracker.setAttribute('name','elementListenTracker');
nickjillings@1318 1453 for (var k=0; k<this.listenTracker.length; k++) {
nickjillings@1318 1454 elementListenTracker.appendChild(this.listenTracker[k]);
nickjillings@1318 1455 }
nickjillings@1324 1456 storeDOM.push(elementListenTracker);
nickjillings@1318 1457 }
nickjillings@1318 1458 if (audioEngineContext.metric.enableElementInitialPosition) {
nickjillings@1324 1459 var elementInitial = storage.document.createElement('metricResult');
nickjillings@1318 1460 elementInitial.setAttribute('name','elementInitialPosition');
nickjillings@1318 1461 elementInitial.textContent = this.initialPosition;
nickjillings@1324 1462 storeDOM.push(elementInitial);
nickjillings@1318 1463 }
nickjillings@1318 1464 if (audioEngineContext.metric.enableFlagListenedTo) {
nickjillings@1324 1465 var flagListenedTo = storage.document.createElement('metricResult');
nickjillings@1318 1466 flagListenedTo.setAttribute('name','elementFlagListenedTo');
nickjillings@1318 1467 flagListenedTo.textContent = this.wasListenedTo;
nickjillings@1324 1468 storeDOM.push(flagListenedTo);
nickjillings@1318 1469 }
nickjillings@1318 1470 if (audioEngineContext.metric.enableFlagMoved) {
nickjillings@1324 1471 var flagMoved = storage.document.createElement('metricResult');
nickjillings@1318 1472 flagMoved.setAttribute('name','elementFlagMoved');
nickjillings@1318 1473 flagMoved.textContent = this.wasMoved;
nickjillings@1324 1474 storeDOM.push(flagMoved);
nickjillings@1318 1475 }
nickjillings@1318 1476 if (audioEngineContext.metric.enableFlagComments) {
nickjillings@1324 1477 var flagComments = storage.document.createElement('metricResult');
nickjillings@1318 1478 flagComments.setAttribute('name','elementFlagComments');
nickjillings@1318 1479 if (this.parent.commentDOM == null)
nickjillings@1318 1480 {flag.textContent = 'false';}
nickjillings@1318 1481 else if (this.parent.commentDOM.textContent.length == 0)
nickjillings@1318 1482 {flag.textContent = 'false';}
nickjillings@1318 1483 else
nickjillings@1318 1484 {flag.textContet = 'true';}
nickjillings@1324 1485 storeDOM.push(flagComments);
nickjillings@1318 1486 }
nickjillings@1324 1487 return storeDOM;
nickjillings@1318 1488 };
nickjillings@1318 1489 }
nickjillings@1318 1490
nickjillings@1318 1491 function randomiseOrder(input)
nickjillings@1318 1492 {
nickjillings@1318 1493 // This takes an array of information and randomises the order
nickjillings@1318 1494 var N = input.length;
nickjillings@1318 1495
nickjillings@1318 1496 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1318 1497 for (var counter = 0; counter < N; ++counter)
nickjillings@1318 1498 inputSequence.push(counter) // Fill array
nickjillings@1318 1499 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1318 1500
nickjillings@1318 1501 var holdArr = [];
nickjillings@1318 1502 var outputSequence = [];
nickjillings@1318 1503 for (var n=0; n<N; n++)
nickjillings@1318 1504 {
nickjillings@1318 1505 // First pick a random number
nickjillings@1318 1506 var r = Math.random();
nickjillings@1318 1507 // Multiply and floor by the number of elements left
nickjillings@1318 1508 r = Math.floor(r*input.length);
nickjillings@1318 1509 // Pick out that element and delete from the array
nickjillings@1318 1510 holdArr.push(input.splice(r,1)[0]);
nickjillings@1318 1511 // Do the same with sequence
nickjillings@1318 1512 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1318 1513 }
nickjillings@1318 1514 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1318 1515 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1318 1516 return holdArr;
nickjillings@1318 1517 }
nickjillings@1318 1518
nickjillings@1318 1519 function returnDateNode()
nickjillings@1318 1520 {
nickjillings@1318 1521 // Create an XML Node for the Date and Time a test was conducted
nickjillings@1318 1522 // Structure is
nickjillings@1318 1523 // <datetime>
nickjillings@1318 1524 // <date year="##" month="##" day="##">DD/MM/YY</date>
nickjillings@1318 1525 // <time hour="##" minute="##" sec="##">HH:MM:SS</time>
nickjillings@1318 1526 // </datetime>
nickjillings@1318 1527 var dateTime = new Date();
nickjillings@1318 1528 var year = document.createAttribute('year');
nickjillings@1318 1529 var month = document.createAttribute('month');
nickjillings@1318 1530 var day = document.createAttribute('day');
nickjillings@1318 1531 var hour = document.createAttribute('hour');
nickjillings@1318 1532 var minute = document.createAttribute('minute');
nickjillings@1318 1533 var secs = document.createAttribute('secs');
nickjillings@1318 1534
nickjillings@1318 1535 year.nodeValue = dateTime.getFullYear();
nickjillings@1318 1536 month.nodeValue = dateTime.getMonth()+1;
nickjillings@1318 1537 day.nodeValue = dateTime.getDate();
nickjillings@1318 1538 hour.nodeValue = dateTime.getHours();
nickjillings@1318 1539 minute.nodeValue = dateTime.getMinutes();
nickjillings@1318 1540 secs.nodeValue = dateTime.getSeconds();
nickjillings@1318 1541
nickjillings@1318 1542 var hold = document.createElement("datetime");
nickjillings@1318 1543 var date = document.createElement("date");
nickjillings@1318 1544 date.textContent = year.nodeValue+'/'+month.nodeValue+'/'+day.nodeValue;
nickjillings@1318 1545 var time = document.createElement("time");
nickjillings@1318 1546 time.textContent = hour.nodeValue+':'+minute.nodeValue+':'+secs.nodeValue;
nickjillings@1318 1547
nickjillings@1318 1548 date.setAttributeNode(year);
nickjillings@1318 1549 date.setAttributeNode(month);
nickjillings@1318 1550 date.setAttributeNode(day);
nickjillings@1318 1551 time.setAttributeNode(hour);
nickjillings@1318 1552 time.setAttributeNode(minute);
nickjillings@1318 1553 time.setAttributeNode(secs);
nickjillings@1318 1554
nickjillings@1318 1555 hold.appendChild(date);
nickjillings@1318 1556 hold.appendChild(time);
nickjillings@1318 1557 return hold;
nickjillings@1318 1558
nickjillings@1318 1559 }
nickjillings@1318 1560
nickjillings@1318 1561 function Specification() {
nickjillings@1318 1562 // Handles the decoding of the project specification XML into a simple JavaScript Object.
nickjillings@1318 1563
nickjillings@1324 1564 this.interface = null;
nickjillings@1324 1565 this.projectReturn = null;
nickjillings@1324 1566 this.randomiseOrder = null;
nickjillings@1324 1567 this.testPages = null;
nickjillings@1324 1568 this.pages = [];
nickjillings@1324 1569 this.metrics = null;
nickjillings@1324 1570 this.interfaces = null;
nickjillings@1324 1571 this.loudness = null;
nickjillings@1324 1572 this.errors = [];
nickjillings@1324 1573 this.schema = null;
nickjillings@1318 1574
nickjillings@1318 1575 this.randomiseOrder = function(input)
nickjillings@1318 1576 {
nickjillings@1318 1577 // This takes an array of information and randomises the order
nickjillings@1318 1578 var N = input.length;
nickjillings@1318 1579
nickjillings@1318 1580 var inputSequence = []; // For safety purposes: keep track of randomisation
nickjillings@1318 1581 for (var counter = 0; counter < N; ++counter)
nickjillings@1318 1582 inputSequence.push(counter) // Fill array
nickjillings@1318 1583 var inputSequenceClone = inputSequence.slice(0);
nickjillings@1318 1584
nickjillings@1318 1585 var holdArr = [];
nickjillings@1318 1586 var outputSequence = [];
nickjillings@1318 1587 for (var n=0; n<N; n++)
nickjillings@1318 1588 {
nickjillings@1318 1589 // First pick a random number
nickjillings@1318 1590 var r = Math.random();
nickjillings@1318 1591 // Multiply and floor by the number of elements left
nickjillings@1318 1592 r = Math.floor(r*input.length);
nickjillings@1318 1593 // Pick out that element and delete from the array
nickjillings@1318 1594 holdArr.push(input.splice(r,1)[0]);
nickjillings@1318 1595 // Do the same with sequence
nickjillings@1318 1596 outputSequence.push(inputSequence.splice(r,1)[0]);
nickjillings@1318 1597 }
nickjillings@1318 1598 console.log(inputSequenceClone.toString()); // print original array to console
nickjillings@1318 1599 console.log(outputSequence.toString()); // print randomised array to console
nickjillings@1318 1600 return holdArr;
nickjillings@1318 1601 };
nickjillings@1324 1602
nickjillings@1324 1603 this.processAttribute = function(attribute,schema)
nickjillings@1324 1604 {
nickjillings@1324 1605 // attribute is the string returned from getAttribute on the XML
nickjillings@1324 1606 // schema is the <xs:attribute> node
nickjillings@1324 1607 if (schema.getAttribute('name') == undefined && schema.getAttribute('ref') != undefined)
nickjillings@1324 1608 {
nickjillings@1324 1609 schema = this.schema.getElementsByName(schema.getAttribute('ref'))[0];
nickjillings@1324 1610 }
nickjillings@1324 1611 var defaultOpt = schema.getAttribute('default');
nickjillings@1324 1612 if (attribute == null) {
nickjillings@1324 1613 attribute = defaultOpt;
nickjillings@1324 1614 }
nickjillings@1324 1615 var dataType = schema.getAttribute('type');
nickjillings@1324 1616 if (typeof dataType == "string") { dataType = dataType.substr(3);}
nickjillings@1324 1617 else {dataType = "string";}
nickjillings@1324 1618 if (attribute == null)
nickjillings@1324 1619 {
nickjillings@1324 1620 return attribute;
nickjillings@1324 1621 }
nickjillings@1324 1622 switch(dataType)
nickjillings@1324 1623 {
nickjillings@1324 1624 case "boolean":
nickjillings@1324 1625 if (attribute == 'true'){attribute = true;}else{attribute=false;}
nickjillings@1324 1626 break;
nickjillings@1324 1627 case "negativeInteger":
nickjillings@1324 1628 case "positiveInteger":
nickjillings@1324 1629 case "nonNegativeInteger":
nickjillings@1324 1630 case "nonPositiveInteger":
nickjillings@1324 1631 case "integer":
nickjillings@1324 1632 case "decimal":
nickjillings@1324 1633 case "short":
nickjillings@1324 1634 attribute = Number(attribute);
nickjillings@1324 1635 break;
nickjillings@1324 1636 case "string":
nickjillings@1324 1637 default:
nickjillings@1324 1638 attribute = String(attribute);
nickjillings@1324 1639 break;
nickjillings@1324 1640 }
nickjillings@1324 1641 return attribute;
nickjillings@1324 1642 };
nickjillings@1318 1643
nickjillings@1318 1644 this.decode = function(projectXML) {
nickjillings@1324 1645 this.errors = [];
nickjillings@1318 1646 // projectXML - DOM Parsed document
nickjillings@1318 1647 this.projectXML = projectXML.childNodes[0];
nickjillings@1318 1648 var setupNode = projectXML.getElementsByTagName('setup')[0];
nickjillings@1324 1649 var schemaSetup = this.schema.getElementsByName('setup')[0];
nickjillings@1324 1650 // First decode the attributes
nickjillings@1324 1651 var attributes = schemaSetup.getElementsByTagName('attribute');
nickjillings@1324 1652 for (var i in attributes)
nickjillings@1318 1653 {
nickjillings@1324 1654 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1655 var attributeName = attributes[i].getAttribute('name');
nickjillings@1324 1656 var projectAttr = setupNode.getAttribute(attributeName);
nickjillings@1324 1657 projectAttr = this.processAttribute(projectAttr,attributes[i]);
nickjillings@1324 1658 switch(typeof projectAttr)
nickjillings@1318 1659 {
nickjillings@1324 1660 case "number":
nickjillings@1324 1661 case "boolean":
nickjillings@1324 1662 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 1663 break;
nickjillings@1324 1664 case "string":
nickjillings@1324 1665 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1666 break;
nickjillings@1318 1667 }
nickjillings@1324 1668
nickjillings@1318 1669 }
nickjillings@1318 1670
nickjillings@1324 1671 this.metrics = {
nickjillings@1324 1672 enabled: [],
nickjillings@1324 1673 decode: function(parent, xml) {
nickjillings@1324 1674 var children = xml.getElementsByTagName('metricenable');
nickjillings@1324 1675 for (var i in children) {
nickjillings@1324 1676 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1677 this.enabled.push(children[i].textContent);
nickjillings@1324 1678 }
nickjillings@1324 1679 },
nickjillings@1324 1680 encode: function(root) {
nickjillings@1324 1681 var node = root.createElement('metric');
nickjillings@1324 1682 for (var i in this.enabled)
nickjillings@1324 1683 {
nickjillings@1324 1684 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1685 var child = root.createElement('metricenable');
nickjillings@1324 1686 child.textContent = this.enabled[i];
nickjillings@1324 1687 node.appendChild(child);
nickjillings@1324 1688 }
nickjillings@1324 1689 return node;
nickjillings@1324 1690 }
nickjillings@1324 1691 };
nickjillings@1318 1692
nickjillings@1324 1693 this.metrics.decode(this,setupNode.getElementsByTagName('metric')[0]);
nickjillings@1324 1694
nickjillings@1324 1695 // Now process the survey node options
nickjillings@1324 1696 var survey = setupNode.getElementsByTagName('survey');
nickjillings@1324 1697 var surveySchema = specification.schema.getElementsByName('survey')[0];
nickjillings@1324 1698 for (var i in survey) {
nickjillings@1324 1699 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1700 var location = survey[i].getAttribute('location');
nickjillings@1324 1701 if (location == 'pre' || location == 'before')
nickjillings@1324 1702 {
nickjillings@1324 1703 if (this.preTest != null){this.errors.push("Already a pre/before test survey defined! Ignoring second!!");}
nickjillings@1324 1704 else {
nickjillings@1324 1705 this.preTest = new this.surveyNode();
nickjillings@1324 1706 this.preTest.decode(this,survey[i],surveySchema);
nickjillings@1324 1707 }
nickjillings@1324 1708 } else if (location == 'post' || location == 'after') {
nickjillings@1324 1709 if (this.postTest != null){this.errors.push("Already a post/after test survey defined! Ignoring second!!");}
nickjillings@1324 1710 else {
nickjillings@1324 1711 this.postTest = new this.surveyNode();
nickjillings@1324 1712 this.postTest.decode(this,survey[i],surveySchema);
nickjillings@1324 1713 }
nickjillings@1318 1714 }
nickjillings@1318 1715 }
nickjillings@1318 1716
nickjillings@1324 1717 var interfaceNode = setupNode.getElementsByTagName('interface');
nickjillings@1324 1718 if (interfaceNode.length > 1)
nickjillings@1324 1719 {
nickjillings@1324 1720 this.errors.push("Only one <interface> node in the <setup> node allowed! Others except first ingnored!");
nickjillings@1324 1721 }
nickjillings@1324 1722 this.interfaces = new this.interfaceNode();
nickjillings@1324 1723 if (interfaceNode.length != 0)
nickjillings@1324 1724 {
nickjillings@1324 1725 interfaceNode = interfaceNode[0];
nickjillings@1324 1726 this.interfaces.decode(this,interfaceNode,this.schema.getElementsByName('interface')[1]);
nickjillings@1318 1727 }
nickjillings@1318 1728
nickjillings@1324 1729 // Page tags
nickjillings@1324 1730 var pageTags = projectXML.getElementsByTagName('page');
nickjillings@1324 1731 var pageSchema = this.schema.getElementsByName('page')[0];
nickjillings@1324 1732 for (var i=0; i<pageTags.length; i++)
nickjillings@1318 1733 {
nickjillings@1324 1734 var node = new this.page();
nickjillings@1324 1735 node.decode(this,pageTags[i],pageSchema);
nickjillings@1324 1736 this.pages.push(node);
nickjillings@1318 1737 }
nickjillings@1318 1738 };
nickjillings@1318 1739
nickjillings@1318 1740 this.encode = function()
nickjillings@1318 1741 {
nickjillings@1324 1742 var root = document.implementation.createDocument(null,"waet");
nickjillings@1318 1743
nickjillings@1324 1744 // Build setup node
nickjillings@1318 1745
nickjillings@1318 1746 return root;
nickjillings@1318 1747 };
nickjillings@1318 1748
nickjillings@1324 1749 this.surveyNode = function() {
nickjillings@1324 1750 this.location = null;
nickjillings@1318 1751 this.options = [];
nickjillings@1324 1752 this.schema = null;
nickjillings@1318 1753
nickjillings@1318 1754 this.OptionNode = function() {
nickjillings@1318 1755 this.type = undefined;
nickjillings@1324 1756 this.schema = undefined;
nickjillings@1318 1757 this.id = undefined;
nickjillings@1318 1758 this.mandatory = undefined;
nickjillings@1318 1759 this.statement = undefined;
nickjillings@1318 1760 this.boxsize = undefined;
nickjillings@1318 1761 this.options = [];
nickjillings@1318 1762 this.min = undefined;
nickjillings@1318 1763 this.max = undefined;
nickjillings@1318 1764 this.step = undefined;
nickjillings@1318 1765
nickjillings@1324 1766 this.decode = function(parent,child,schema)
nickjillings@1318 1767 {
nickjillings@1324 1768 this.schema = schema;
nickjillings@1324 1769 var attributeMap = schema.getElementsByTagName('attribute');
nickjillings@1324 1770 for (var i in attributeMap){
nickjillings@1324 1771 if(isNaN(Number(i)) == true){break;}
nickjillings@1324 1772 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 1773 var projectAttr = child.getAttribute(attributeName);
nickjillings@1324 1774 projectAttr = parent.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 1775 switch(typeof projectAttr)
nickjillings@1324 1776 {
nickjillings@1324 1777 case "number":
nickjillings@1324 1778 case "boolean":
nickjillings@1324 1779 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 1780 break;
nickjillings@1324 1781 case "string":
nickjillings@1324 1782 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1783 break;
nickjillings@1318 1784 }
nickjillings@1324 1785 }
nickjillings@1324 1786 this.statement = child.getElementsByTagName('statement')[0].textContent;
nickjillings@1324 1787 if (this.type == "checkbox" || this.type == "radio") {
nickjillings@1324 1788 var children = child.getElementsByTagName('option');
nickjillings@1324 1789 if (children.length == null) {
nickjillings@1318 1790 console.log('Malformed' +child.nodeName+ 'entry');
nickjillings@1318 1791 this.statement = 'Malformed' +child.nodeName+ 'entry';
nickjillings@1318 1792 this.type = 'statement';
nickjillings@1318 1793 } else {
nickjillings@1318 1794 this.options = [];
nickjillings@1324 1795 for (var i in children)
nickjillings@1324 1796 {
nickjillings@1324 1797 if (isNaN(Number(i))==true){break;}
nickjillings@1324 1798 this.options.push({
nickjillings@1324 1799 name: children[i].getAttribute('name'),
nickjillings@1324 1800 text: children[i].textContent
nickjillings@1324 1801 });
nickjillings@1318 1802 }
nickjillings@1318 1803 }
nickjillings@1318 1804 }
nickjillings@1318 1805 };
nickjillings@1318 1806
nickjillings@1318 1807 this.exportXML = function(root)
nickjillings@1318 1808 {
nickjillings@1324 1809 var node = root.createElement('surveyelement');
nickjillings@1324 1810 node.setAttribute('type',this.type);
nickjillings@1324 1811 var statement = root.createElement('statement');
nickjillings@1324 1812 statement.textContent = this.statement;
nickjillings@1324 1813 node.appendChild(statement);
nickjillings@1318 1814 switch(this.type)
nickjillings@1318 1815 {
nickjillings@1318 1816 case "statement":
nickjillings@1318 1817 break;
nickjillings@1318 1818 case "question":
nickjillings@1318 1819 node.id = this.id;
nickjillings@1318 1820 node.setAttribute("mandatory",this.mandatory);
nickjillings@1318 1821 node.setAttribute("boxsize",this.boxsize);
nickjillings@1318 1822 break;
nickjillings@1318 1823 case "number":
nickjillings@1318 1824 node.id = this.id;
nickjillings@1318 1825 node.setAttribute("mandatory",this.mandatory);
nickjillings@1318 1826 node.setAttribute("min", this.min);
nickjillings@1318 1827 node.setAttribute("max", this.max);
nickjillings@1318 1828 node.setAttribute("step", this.step);
nickjillings@1318 1829 break;
nickjillings@1318 1830 case "checkbox":
nickjillings@1318 1831 case "radio":
nickjillings@1318 1832 node.id = this.id;
nickjillings@1318 1833 for (var i=0; i<this.options.length; i++)
nickjillings@1318 1834 {
nickjillings@1318 1835 var option = this.options[i];
nickjillings@1318 1836 var optionNode = root.createElement("option");
nickjillings@1318 1837 optionNode.setAttribute("name",option.name);
nickjillings@1318 1838 optionNode.textContent = option.text;
nickjillings@1318 1839 node.appendChild(optionNode);
nickjillings@1318 1840 }
nickjillings@1318 1841 break;
nickjillings@1318 1842 }
nickjillings@1318 1843 return node;
nickjillings@1318 1844 };
nickjillings@1318 1845 };
nickjillings@1324 1846 this.decode = function(parent,xml,schema) {
nickjillings@1324 1847 this.schema = schema;
nickjillings@1324 1848 this.location = xml.getAttribute('location');
nickjillings@1324 1849 if (this.location == 'before'){this.location = 'pre';}
nickjillings@1324 1850 else if (this.location == 'after'){this.location = 'post';}
nickjillings@1324 1851 var surveyentrySchema = schema.getElementsByTagName('element')[0];
nickjillings@1324 1852 for (var i in xml.children)
nickjillings@1324 1853 {
nickjillings@1324 1854 if(isNaN(Number(i))==true){break;}
nickjillings@1318 1855 var node = new this.OptionNode();
nickjillings@1324 1856 node.decode(parent,xml.children[i],surveyentrySchema);
nickjillings@1318 1857 this.options.push(node);
nickjillings@1324 1858 }
nickjillings@1324 1859 };
nickjillings@1324 1860 this.encode = function(root) {
nickjillings@1324 1861 var node = root.createElement('survey');
nickjillings@1324 1862 node.setAttribute('location',this.location);
nickjillings@1324 1863 for (var i=0; i<this.options.length; i++)
nickjillings@1324 1864 {
nickjillings@1324 1865 node.appendChild(this.options[i].exportXML());
nickjillings@1324 1866 }
nickjillings@1324 1867 return node;
nickjillings@1324 1868 };
nickjillings@1324 1869 };
nickjillings@1324 1870
nickjillings@1324 1871 this.interfaceNode = function()
nickjillings@1324 1872 {
nickjillings@1324 1873 this.title = null;
nickjillings@1324 1874 this.name = null;
nickjillings@1324 1875 this.options = [];
nickjillings@1324 1876 this.scales = [];
nickjillings@1324 1877 this.schema = null;
nickjillings@1324 1878
nickjillings@1324 1879 this.decode = function(parent,xml,schema) {
nickjillings@1324 1880 this.schema = schema;
nickjillings@1324 1881 this.name = xml.getAttribute('name');
nickjillings@1324 1882 var titleNode = xml.getElementsByTagName('title');
nickjillings@1324 1883 if (titleNode.length == 1)
nickjillings@1324 1884 {
nickjillings@1324 1885 this.title = titleNode[0].textContent;
nickjillings@1324 1886 }
nickjillings@1324 1887 var interfaceOptionNodes = xml.getElementsByTagName('interfaceoption');
nickjillings@1324 1888 // Extract interfaceoption node schema
nickjillings@1324 1889 var interfaceOptionNodeSchema = schema.getElementsByTagName('element');
nickjillings@1324 1890 for (var i=0; i<interfaceOptionNodeSchema.length; i++) {
nickjillings@1324 1891 if (interfaceOptionNodeSchema[i].getAttribute('name') == 'interfaceoption') {
nickjillings@1324 1892 interfaceOptionNodeSchema = interfaceOptionNodeSchema[i];
nickjillings@1324 1893 break;
nickjillings@1324 1894 }
nickjillings@1324 1895 }
nickjillings@1324 1896 var attributeMap = interfaceOptionNodeSchema.getElementsByTagName('attribute');
nickjillings@1324 1897 for (var i=0; i<interfaceOptionNodes.length; i++)
nickjillings@1324 1898 {
nickjillings@1324 1899 var ioNode = interfaceOptionNodes[i];
nickjillings@1324 1900 var option = {};
nickjillings@1324 1901 for (var j=0; j<attributeMap.length; j++)
nickjillings@1324 1902 {
nickjillings@1324 1903 var attributeName = attributeMap[j].getAttribute('name') || attributeMap[j].getAttribute('ref');
nickjillings@1324 1904 var projectAttr = ioNode.getAttribute(attributeName);
nickjillings@1324 1905 projectAttr = parent.processAttribute(projectAttr,attributeMap[j]);
nickjillings@1324 1906 switch(typeof projectAttr)
nickjillings@1324 1907 {
nickjillings@1324 1908 case "number":
nickjillings@1324 1909 case "boolean":
nickjillings@1324 1910 eval('option.'+attributeName+' = '+projectAttr);
nickjillings@1324 1911 break;
nickjillings@1324 1912 case "string":
nickjillings@1324 1913 eval('option.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1914 break;
nickjillings@1324 1915 }
nickjillings@1324 1916 }
nickjillings@1324 1917 this.options.push(option);
nickjillings@1324 1918 }
nickjillings@1324 1919
nickjillings@1324 1920 // Now the scales nodes
nickjillings@1324 1921 var scaleParent = xml.getElementsByTagName('scales');
nickjillings@1324 1922 if (scaleParent.length == 1) {
nickjillings@1324 1923 scaleParent = scaleParent[0];
nickjillings@1324 1924 for (var i=0; i<scaleParent.children.length; i++) {
nickjillings@1324 1925 var child = scaleParent.children[i];
nickjillings@1324 1926 this.scales.push({
nickjillings@1324 1927 text: child.textContent,
nickjillings@1324 1928 position: Number(child.getAttribute('position'))
nickjillings@1324 1929 });
nickjillings@1318 1930 }
nickjillings@1318 1931 }
nickjillings@1318 1932 };
nickjillings@1324 1933
nickjillings@1324 1934 this.encode = function(root) {
nickjillings@1324 1935
nickjillings@1324 1936 };
nickjillings@1318 1937 };
nickjillings@1318 1938
nickjillings@1324 1939 this.page = function() {
nickjillings@1318 1940 this.presentedId = undefined;
nickjillings@1318 1941 this.id = undefined;
nickjillings@1318 1942 this.hostURL = undefined;
nickjillings@1318 1943 this.randomiseOrder = undefined;
nickjillings@1318 1944 this.loop = undefined;
nickjillings@1324 1945 this.showElementComments = undefined;
nickjillings@1318 1946 this.outsideReference = null;
nickjillings@1318 1947 this.loudness = null;
nickjillings@1324 1948 this.preTest = null;
nickjillings@1324 1949 this.postTest = null;
nickjillings@1318 1950 this.interfaces = [];
nickjillings@1318 1951 this.commentBoxPrefix = "Comment on track";
nickjillings@1318 1952 this.audioElements = [];
nickjillings@1318 1953 this.commentQuestions = [];
nickjillings@1324 1954 this.schema = null;
nickjillings@1318 1955
nickjillings@1324 1956 this.decode = function(parent,xml,schema)
nickjillings@1318 1957 {
nickjillings@1324 1958 this.schema = schema;
nickjillings@1324 1959 var attributeMap = this.schema.getElementsByTagName('attribute');
nickjillings@1324 1960 for (var i=0; i<attributeMap.length; i++)
nickjillings@1318 1961 {
nickjillings@1324 1962 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 1963 var projectAttr = xml.getAttribute(attributeName);
nickjillings@1324 1964 projectAttr = parent.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 1965 switch(typeof projectAttr)
nickjillings@1318 1966 {
nickjillings@1324 1967 case "number":
nickjillings@1324 1968 case "boolean":
nickjillings@1324 1969 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 1970 break;
nickjillings@1324 1971 case "string":
nickjillings@1324 1972 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 1973 break;
nickjillings@1318 1974 }
nickjillings@1318 1975 }
nickjillings@1318 1976
nickjillings@1324 1977 // Get the Comment Box Prefix
nickjillings@1324 1978 var CBP = xml.getElementsByTagName('commentboxprefix');
nickjillings@1324 1979 if (CBP.length != 0) {
nickjillings@1324 1980 this.commentBoxPrefix = CBP[0].textContent;
nickjillings@1318 1981 }
nickjillings@1318 1982
nickjillings@1324 1983 // Now decode the interfaces
nickjillings@1324 1984 var interfaceNode = xml.getElementsByTagName('interface');
nickjillings@1324 1985 for (var i=0; i<interfaceNode.length; i++)
nickjillings@1324 1986 {
nickjillings@1324 1987 var node = new parent.interfaceNode();
nickjillings@1324 1988 node.decode(this,interfaceNode[i],parent.schema.getElementsByName('interface')[1]);
nickjillings@1324 1989 this.interfaces.push(node);
nickjillings@1324 1990 }
nickjillings@1318 1991
nickjillings@1324 1992 // Now process the survey node options
nickjillings@1324 1993 var survey = xml.getElementsByTagName('survey');
nickjillings@1324 1994 var surveySchema = parent.schema.getElementsByName('survey')[0];
nickjillings@1324 1995 for (var i in survey) {
nickjillings@1324 1996 if (isNaN(Number(i)) == true){break;}
nickjillings@1324 1997 var location = survey[i].getAttribute('location');
nickjillings@1324 1998 if (location == 'pre' || location == 'before')
nickjillings@1324 1999 {
nickjillings@1324 2000 if (this.preTest != null){this.errors.push("Already a pre/before test survey defined! Ignoring second!!");}
nickjillings@1324 2001 else {
nickjillings@1324 2002 this.preTest = new parent.surveyNode();
nickjillings@1324 2003 this.preTest.decode(parent,survey[i],surveySchema);
nickjillings@1324 2004 }
nickjillings@1324 2005 } else if (location == 'post' || location == 'after') {
nickjillings@1324 2006 if (this.postTest != null){this.errors.push("Already a post/after test survey defined! Ignoring second!!");}
nickjillings@1324 2007 else {
nickjillings@1324 2008 this.postTest = new parent.surveyNode();
nickjillings@1324 2009 this.postTest.decode(parent,survey[i],surveySchema);
nickjillings@1324 2010 }
nickjillings@1324 2011 }
nickjillings@1324 2012 }
nickjillings@1324 2013
nickjillings@1324 2014 // Now process the audioelement tags
nickjillings@1324 2015 var audioElements = xml.getElementsByTagName('audioelement');
nickjillings@1324 2016 var audioElementSchema = parent.schema.getElementsByName('audioelement')[0];
nickjillings@1324 2017 for (var i=0; i<audioElements.length; i++)
nickjillings@1324 2018 {
nickjillings@1324 2019 var node = new this.audioElementNode();
nickjillings@1324 2020 node.decode(this,audioElements[i],audioElementSchema);
nickjillings@1324 2021 this.audioElements.push(node);
nickjillings@1324 2022 }
nickjillings@1324 2023
nickjillings@1324 2024 // Now decode the commentquestions
nickjillings@1324 2025 var commentQuestions = xml.getElementsByTagName('commentquestion');
nickjillings@1324 2026 var commentQuestionSchema = parent.schema.getElementsByName('commentquestion')[0];
nickjillings@1324 2027 for (var i=0; i<commentQuestions.length; i++)
nickjillings@1324 2028 {
nickjillings@1318 2029 var node = new this.commentQuestionNode();
nickjillings@1324 2030 node.decode(parent,commentQuestions[i],commentQuestionSchema);
nickjillings@1318 2031 this.commentQuestions.push(node);
nickjillings@1318 2032 }
nickjillings@1318 2033 };
nickjillings@1318 2034
nickjillings@1318 2035 this.encode = function(root)
nickjillings@1318 2036 {
nickjillings@1318 2037 var AHNode = root.createElement("audioHolder");
nickjillings@1318 2038 AHNode.id = this.id;
nickjillings@1318 2039 AHNode.setAttribute("hostURL",this.hostURL);
nickjillings@1318 2040 AHNode.setAttribute("sampleRate",this.sampleRate);
nickjillings@1318 2041 AHNode.setAttribute("randomiseOrder",this.randomiseOrder);
nickjillings@1318 2042 AHNode.setAttribute("repeatCount",this.repeatCount);
nickjillings@1318 2043 AHNode.setAttribute("loop",this.loop);
nickjillings@1318 2044 AHNode.setAttribute("elementComments",this.elementComments);
nickjillings@1318 2045 if(this.loudness != null) {AHNode.setAttribute("loudness",this.loudness);}
nickjillings@1318 2046 if(this.initialPosition != null) {
nickjillings@1318 2047 AHNode.setAttribute("loudness",this.initialPosition*100);
nickjillings@1318 2048 }
nickjillings@1318 2049 for (var i=0; i<this.interfaces.length; i++)
nickjillings@1318 2050 {
nickjillings@1318 2051 AHNode.appendChild(this.interfaces[i].encode(root));
nickjillings@1318 2052 }
nickjillings@1318 2053
nickjillings@1318 2054 for (var i=0; i<this.audioElements.length; i++) {
nickjillings@1318 2055 AHNode.appendChild(this.audioElements[i].encode(root));
nickjillings@1318 2056 }
nickjillings@1318 2057 // Create <CommentQuestion>
nickjillings@1318 2058 for (var i=0; i<this.commentQuestions.length; i++)
nickjillings@1318 2059 {
nickjillings@1318 2060 AHNode.appendChild(this.commentQuestions[i].exportXML(root));
nickjillings@1318 2061 }
nickjillings@1318 2062
nickjillings@1318 2063 // Create <PreTest>
nickjillings@1318 2064 var AHPreTest = root.createElement("PreTest");
nickjillings@1318 2065 for (var i=0; i<this.preTest.options.length; i++)
nickjillings@1318 2066 {
nickjillings@1318 2067 AHPreTest.appendChild(this.preTest.options[i].exportXML(root));
nickjillings@1318 2068 }
nickjillings@1318 2069
nickjillings@1318 2070 var AHPostTest = root.createElement("PostTest");
nickjillings@1318 2071 for (var i=0; i<this.postTest.options.length; i++)
nickjillings@1318 2072 {
nickjillings@1318 2073 AHPostTest.appendChild(this.postTest.options[i].exportXML(root));
nickjillings@1318 2074 }
nickjillings@1318 2075 AHNode.appendChild(AHPreTest);
nickjillings@1318 2076 AHNode.appendChild(AHPostTest);
nickjillings@1318 2077 return AHNode;
nickjillings@1318 2078 };
nickjillings@1318 2079
nickjillings@1324 2080 this.commentQuestionNode = function() {
nickjillings@1324 2081 this.id = null;
nickjillings@1324 2082 this.type = undefined;
nickjillings@1318 2083 this.options = [];
nickjillings@1324 2084 this.statement = undefined;
nickjillings@1324 2085 this.schema = null;
nickjillings@1324 2086 this.decode = function(parent,xml,schema)
nickjillings@1318 2087 {
nickjillings@1324 2088 this.id = xml.id;
nickjillings@1324 2089 this.type = xml.getAttribute('type');
nickjillings@1324 2090 this.statement = xml.getElementsByTagName('statement')[0].textContent;
nickjillings@1324 2091 var optNodes = xml.getElementsByTagName('option');
nickjillings@1324 2092 for (var i=0; i<optNodes.length; i++)
nickjillings@1324 2093 {
nickjillings@1324 2094 var optNode = optNodes[i];
nickjillings@1324 2095 this.options.push({
nickjillings@1324 2096 name: optNode.getAttribute('name'),
nickjillings@1324 2097 text: optNode.textContent
nickjillings@1324 2098 });
nickjillings@1318 2099 }
nickjillings@1318 2100 };
nickjillings@1324 2101
nickjillings@1318 2102 this.encode = function(root)
nickjillings@1318 2103 {
nickjillings@1324 2104
nickjillings@1318 2105 };
nickjillings@1318 2106 };
nickjillings@1318 2107
nickjillings@1318 2108 this.audioElementNode = function() {
nickjillings@1318 2109 this.url = null;
nickjillings@1318 2110 this.id = null;
nickjillings@1318 2111 this.parent = null;
nickjillings@1324 2112 this.type = null;
nickjillings@1318 2113 this.marker = false;
nickjillings@1318 2114 this.enforce = false;
nickjillings@1318 2115 this.gain = 1.0;
nickjillings@1324 2116 this.schema = null;
nickjillings@1324 2117 this.parent = null;
nickjillings@1324 2118 this.decode = function(parent,xml,schema)
nickjillings@1318 2119 {
nickjillings@1324 2120 this.schema = schema;
nickjillings@1318 2121 this.parent = parent;
nickjillings@1324 2122 var attributeMap = this.schema.getElementsByTagName('attribute');
nickjillings@1324 2123 for (var i=0; i<attributeMap.length; i++)
nickjillings@1318 2124 {
nickjillings@1324 2125 var attributeName = attributeMap[i].getAttribute('name') || attributeMap[i].getAttribute('ref');
nickjillings@1324 2126 var projectAttr = xml.getAttribute(attributeName);
nickjillings@1324 2127 projectAttr = specification.processAttribute(projectAttr,attributeMap[i]);
nickjillings@1324 2128 switch(typeof projectAttr)
nickjillings@1318 2129 {
nickjillings@1324 2130 case "number":
nickjillings@1324 2131 case "boolean":
nickjillings@1324 2132 eval('this.'+attributeName+' = '+projectAttr);
nickjillings@1324 2133 break;
nickjillings@1324 2134 case "string":
nickjillings@1324 2135 eval('this.'+attributeName+' = "'+projectAttr+'"');
nickjillings@1324 2136 break;
nickjillings@1318 2137 }
nickjillings@1318 2138 }
nickjillings@1324 2139
nickjillings@1318 2140 };
nickjillings@1318 2141 this.encode = function(root)
nickjillings@1318 2142 {
nickjillings@1318 2143 var AENode = root.createElement("audioElements");
nickjillings@1318 2144 AENode.id = this.id;
nickjillings@1318 2145 AENode.setAttribute("url",this.url);
nickjillings@1318 2146 AENode.setAttribute("type",this.type);
nickjillings@1318 2147 AENode.setAttribute("gain",linearToDecibel(this.gain));
nickjillings@1318 2148 if (this.marker != false)
nickjillings@1318 2149 {
nickjillings@1318 2150 AENode.setAttribute("marker",this.marker*100);
nickjillings@1318 2151 }
nickjillings@1318 2152 return AENode;
nickjillings@1318 2153 };
nickjillings@1318 2154 };
nickjillings@1318 2155 };
nickjillings@1318 2156 }
nickjillings@1318 2157
nickjillings@1318 2158 function Interface(specificationObject) {
nickjillings@1318 2159 // This handles the bindings between the interface and the audioEngineContext;
nickjillings@1318 2160 this.specification = specificationObject;
nickjillings@1318 2161 this.insertPoint = document.getElementById("topLevelBody");
nickjillings@1318 2162
nickjillings@1324 2163 this.newPage = function(audioHolderObject,store)
nickjillings@1318 2164 {
nickjillings@1324 2165 audioEngineContext.newTestPage(store);
nickjillings@1318 2166 /// CHECK FOR SAMPLE RATE COMPATIBILITY
nickjillings@1318 2167 if (audioHolderObject.sampleRate != undefined) {
nickjillings@1318 2168 if (Number(audioHolderObject.sampleRate) != audioContext.sampleRate) {
nickjillings@1318 2169 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 2170 alert(errStr);
nickjillings@1318 2171 return;
nickjillings@1318 2172 }
nickjillings@1318 2173 }
nickjillings@1318 2174
nickjillings@1318 2175 audioEngineContext.loopPlayback = audioHolderObject.loop;
nickjillings@1318 2176 // Delete any previous audioObjects associated with the audioEngine
nickjillings@1318 2177 audioEngineContext.audioObjects = [];
nickjillings@1318 2178 interfaceContext.deleteCommentBoxes();
nickjillings@1318 2179 interfaceContext.deleteCommentQuestions();
nickjillings@1324 2180 loadTest(audioHolderObject,store);
nickjillings@1318 2181 };
nickjillings@1318 2182
nickjillings@1318 2183 // Bounded by interface!!
nickjillings@1318 2184 // Interface object MUST have an exportXMLDOM method which returns the various DOM levels
nickjillings@1318 2185 // For example, APE returns the slider position normalised in a <value> tag.
nickjillings@1318 2186 this.interfaceObjects = [];
nickjillings@1318 2187 this.interfaceObject = function(){};
nickjillings@1318 2188
nickjillings@1318 2189 this.resizeWindow = function(event)
nickjillings@1318 2190 {
nickjillings@1318 2191 popup.resize(event);
nickjillings@1318 2192 for(var i=0; i<this.commentBoxes.length; i++)
nickjillings@1318 2193 {this.commentBoxes[i].resize();}
nickjillings@1318 2194 for(var i=0; i<this.commentQuestions.length; i++)
nickjillings@1318 2195 {this.commentQuestions[i].resize();}
nickjillings@1318 2196 try
nickjillings@1318 2197 {
nickjillings@1318 2198 resizeWindow(event);
nickjillings@1318 2199 }
nickjillings@1318 2200 catch(err)
nickjillings@1318 2201 {
nickjillings@1318 2202 console.log("Warning - Interface does not have Resize option");
nickjillings@1318 2203 console.log(err);
nickjillings@1318 2204 }
nickjillings@1318 2205 };
nickjillings@1318 2206
nickjillings@1318 2207 this.returnNavigator = function()
nickjillings@1318 2208 {
nickjillings@1318 2209 var node = document.createElement("navigator");
nickjillings@1318 2210 var platform = document.createElement("platform");
nickjillings@1318 2211 platform.textContent = navigator.platform;
nickjillings@1318 2212 var vendor = document.createElement("vendor");
nickjillings@1318 2213 vendor.textContent = navigator.vendor;
nickjillings@1318 2214 var userAgent = document.createElement("uagent");
nickjillings@1318 2215 userAgent.textContent = navigator.userAgent;
nickjillings@1318 2216 node.appendChild(platform);
nickjillings@1318 2217 node.appendChild(vendor);
nickjillings@1318 2218 node.appendChild(userAgent);
nickjillings@1318 2219 return node;
nickjillings@1318 2220 };
nickjillings@1318 2221
nickjillings@1318 2222 this.commentBoxes = [];
nickjillings@1318 2223 this.elementCommentBox = function(audioObject) {
nickjillings@1318 2224 var element = audioObject.specification;
nickjillings@1318 2225 this.audioObject = audioObject;
nickjillings@1318 2226 this.id = audioObject.id;
nickjillings@1318 2227 var audioHolderObject = audioObject.specification.parent;
nickjillings@1318 2228 // Create document objects to hold the comment boxes
nickjillings@1318 2229 this.trackComment = document.createElement('div');
nickjillings@1318 2230 this.trackComment.className = 'comment-div';
nickjillings@1318 2231 this.trackComment.id = 'comment-div-'+audioObject.id;
nickjillings@1318 2232 // Create a string next to each comment asking for a comment
nickjillings@1318 2233 this.trackString = document.createElement('span');
nickjillings@1318 2234 this.trackString.innerHTML = audioHolderObject.commentBoxPrefix+' '+audioObject.id;
nickjillings@1318 2235 // Create the HTML5 comment box 'textarea'
nickjillings@1318 2236 this.trackCommentBox = document.createElement('textarea');
nickjillings@1318 2237 this.trackCommentBox.rows = '4';
nickjillings@1318 2238 this.trackCommentBox.cols = '100';
nickjillings@1318 2239 this.trackCommentBox.name = 'trackComment'+audioObject.id;
nickjillings@1318 2240 this.trackCommentBox.className = 'trackComment';
nickjillings@1318 2241 var br = document.createElement('br');
nickjillings@1318 2242 // Add to the holder.
nickjillings@1318 2243 this.trackComment.appendChild(this.trackString);
nickjillings@1318 2244 this.trackComment.appendChild(br);
nickjillings@1318 2245 this.trackComment.appendChild(this.trackCommentBox);
nickjillings@1318 2246
nickjillings@1318 2247 this.exportXMLDOM = function() {
nickjillings@1318 2248 var root = document.createElement('comment');
nickjillings@1318 2249 if (this.audioObject.specification.parent.elementComments) {
nickjillings@1318 2250 var question = document.createElement('question');
nickjillings@1318 2251 question.textContent = this.trackString.textContent;
nickjillings@1318 2252 var response = document.createElement('response');
nickjillings@1318 2253 response.textContent = this.trackCommentBox.value;
nickjillings@1318 2254 console.log("Comment frag-"+this.id+": "+response.textContent);
nickjillings@1318 2255 root.appendChild(question);
nickjillings@1318 2256 root.appendChild(response);
nickjillings@1318 2257 }
nickjillings@1318 2258 return root;
nickjillings@1318 2259 };
nickjillings@1318 2260 this.resize = function()
nickjillings@1318 2261 {
nickjillings@1318 2262 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2263 if (boxwidth >= 600)
nickjillings@1318 2264 {
nickjillings@1318 2265 boxwidth = 600;
nickjillings@1318 2266 }
nickjillings@1318 2267 else if (boxwidth < 400)
nickjillings@1318 2268 {
nickjillings@1318 2269 boxwidth = 400;
nickjillings@1318 2270 }
nickjillings@1318 2271 this.trackComment.style.width = boxwidth+"px";
nickjillings@1318 2272 this.trackCommentBox.style.width = boxwidth-6+"px";
nickjillings@1318 2273 };
nickjillings@1318 2274 this.resize();
nickjillings@1318 2275 };
nickjillings@1318 2276
nickjillings@1318 2277 this.commentQuestions = [];
nickjillings@1318 2278
nickjillings@1318 2279 this.commentBox = function(commentQuestion) {
nickjillings@1318 2280 this.specification = commentQuestion;
nickjillings@1318 2281 // Create document objects to hold the comment boxes
nickjillings@1318 2282 this.holder = document.createElement('div');
nickjillings@1318 2283 this.holder.className = 'comment-div';
nickjillings@1318 2284 // Create a string next to each comment asking for a comment
nickjillings@1318 2285 this.string = document.createElement('span');
nickjillings@1324 2286 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2287 // Create the HTML5 comment box 'textarea'
nickjillings@1318 2288 this.textArea = document.createElement('textarea');
nickjillings@1318 2289 this.textArea.rows = '4';
nickjillings@1318 2290 this.textArea.cols = '100';
nickjillings@1318 2291 this.textArea.className = 'trackComment';
nickjillings@1318 2292 var br = document.createElement('br');
nickjillings@1318 2293 // Add to the holder.
nickjillings@1318 2294 this.holder.appendChild(this.string);
nickjillings@1318 2295 this.holder.appendChild(br);
nickjillings@1318 2296 this.holder.appendChild(this.textArea);
nickjillings@1318 2297
nickjillings@1318 2298 this.exportXMLDOM = function() {
nickjillings@1318 2299 var root = document.createElement('comment');
nickjillings@1318 2300 root.id = this.specification.id;
nickjillings@1318 2301 root.setAttribute('type',this.specification.type);
nickjillings@1318 2302 root.textContent = this.textArea.value;
nickjillings@1318 2303 console.log("Question: "+this.string.textContent);
nickjillings@1318 2304 console.log("Response: "+root.textContent);
nickjillings@1318 2305 return root;
nickjillings@1318 2306 };
nickjillings@1318 2307 this.resize = function()
nickjillings@1318 2308 {
nickjillings@1318 2309 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2310 if (boxwidth >= 600)
nickjillings@1318 2311 {
nickjillings@1318 2312 boxwidth = 600;
nickjillings@1318 2313 }
nickjillings@1318 2314 else if (boxwidth < 400)
nickjillings@1318 2315 {
nickjillings@1318 2316 boxwidth = 400;
nickjillings@1318 2317 }
nickjillings@1318 2318 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2319 this.textArea.style.width = boxwidth-6+"px";
nickjillings@1318 2320 };
nickjillings@1318 2321 this.resize();
nickjillings@1318 2322 };
nickjillings@1318 2323
nickjillings@1318 2324 this.radioBox = function(commentQuestion) {
nickjillings@1318 2325 this.specification = commentQuestion;
nickjillings@1318 2326 // Create document objects to hold the comment boxes
nickjillings@1318 2327 this.holder = document.createElement('div');
nickjillings@1318 2328 this.holder.className = 'comment-div';
nickjillings@1318 2329 // Create a string next to each comment asking for a comment
nickjillings@1318 2330 this.string = document.createElement('span');
nickjillings@1318 2331 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2332 var br = document.createElement('br');
nickjillings@1318 2333 // Add to the holder.
nickjillings@1318 2334 this.holder.appendChild(this.string);
nickjillings@1318 2335 this.holder.appendChild(br);
nickjillings@1318 2336 this.options = [];
nickjillings@1318 2337 this.inputs = document.createElement('div');
nickjillings@1318 2338 this.span = document.createElement('div');
nickjillings@1318 2339 this.inputs.align = 'center';
nickjillings@1318 2340 this.inputs.style.marginLeft = '12px';
nickjillings@1318 2341 this.span.style.marginLeft = '12px';
nickjillings@1318 2342 this.span.align = 'center';
nickjillings@1318 2343 this.span.style.marginTop = '15px';
nickjillings@1318 2344
nickjillings@1318 2345 var optCount = commentQuestion.options.length;
nickjillings@1324 2346 for (var optNode of commentQuestion.options)
nickjillings@1318 2347 {
nickjillings@1318 2348 var div = document.createElement('div');
nickjillings@1318 2349 div.style.width = '80px';
nickjillings@1318 2350 div.style.float = 'left';
nickjillings@1318 2351 var input = document.createElement('input');
nickjillings@1318 2352 input.type = 'radio';
nickjillings@1318 2353 input.name = commentQuestion.id;
nickjillings@1324 2354 input.setAttribute('setvalue',optNode.name);
nickjillings@1318 2355 input.className = 'comment-radio';
nickjillings@1318 2356 div.appendChild(input);
nickjillings@1318 2357 this.inputs.appendChild(div);
nickjillings@1318 2358
nickjillings@1318 2359
nickjillings@1318 2360 div = document.createElement('div');
nickjillings@1318 2361 div.style.width = '80px';
nickjillings@1318 2362 div.style.float = 'left';
nickjillings@1318 2363 div.align = 'center';
nickjillings@1318 2364 var span = document.createElement('span');
nickjillings@1324 2365 span.textContent = optNode.text;
nickjillings@1318 2366 span.className = 'comment-radio-span';
nickjillings@1318 2367 div.appendChild(span);
nickjillings@1318 2368 this.span.appendChild(div);
nickjillings@1318 2369 this.options.push(input);
nickjillings@1318 2370 }
nickjillings@1318 2371 this.holder.appendChild(this.span);
nickjillings@1318 2372 this.holder.appendChild(this.inputs);
nickjillings@1318 2373
nickjillings@1318 2374 this.exportXMLDOM = function() {
nickjillings@1318 2375 var root = document.createElement('comment');
nickjillings@1318 2376 root.id = this.specification.id;
nickjillings@1318 2377 root.setAttribute('type',this.specification.type);
nickjillings@1318 2378 var question = document.createElement('question');
nickjillings@1318 2379 question.textContent = this.string.textContent;
nickjillings@1318 2380 var response = document.createElement('response');
nickjillings@1318 2381 var i=0;
nickjillings@1318 2382 while(this.options[i].checked == false) {
nickjillings@1318 2383 i++;
nickjillings@1318 2384 if (i >= this.options.length) {
nickjillings@1318 2385 break;
nickjillings@1318 2386 }
nickjillings@1318 2387 }
nickjillings@1318 2388 if (i >= this.options.length) {
nickjillings@1318 2389 response.textContent = 'null';
nickjillings@1318 2390 } else {
nickjillings@1318 2391 response.textContent = this.options[i].getAttribute('setvalue');
nickjillings@1318 2392 response.setAttribute('number',i);
nickjillings@1318 2393 }
nickjillings@1318 2394 console.log('Comment: '+question.textContent);
nickjillings@1318 2395 console.log('Response: '+response.textContent);
nickjillings@1318 2396 root.appendChild(question);
nickjillings@1318 2397 root.appendChild(response);
nickjillings@1318 2398 return root;
nickjillings@1318 2399 };
nickjillings@1318 2400 this.resize = function()
nickjillings@1318 2401 {
nickjillings@1318 2402 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2403 if (boxwidth >= 600)
nickjillings@1318 2404 {
nickjillings@1318 2405 boxwidth = 600;
nickjillings@1318 2406 }
nickjillings@1318 2407 else if (boxwidth < 400)
nickjillings@1318 2408 {
nickjillings@1318 2409 boxwidth = 400;
nickjillings@1318 2410 }
nickjillings@1318 2411 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2412 var text = this.holder.children[2];
nickjillings@1318 2413 var options = this.holder.children[3];
nickjillings@1318 2414 var optCount = options.children.length;
nickjillings@1318 2415 var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nickjillings@1318 2416 var options = options.firstChild;
nickjillings@1318 2417 var text = text.firstChild;
nickjillings@1318 2418 options.style.marginRight = spanMargin;
nickjillings@1318 2419 options.style.marginLeft = spanMargin;
nickjillings@1318 2420 text.style.marginRight = spanMargin;
nickjillings@1318 2421 text.style.marginLeft = spanMargin;
nickjillings@1318 2422 while(options.nextSibling != undefined)
nickjillings@1318 2423 {
nickjillings@1318 2424 options = options.nextSibling;
nickjillings@1318 2425 text = text.nextSibling;
nickjillings@1318 2426 options.style.marginRight = spanMargin;
nickjillings@1318 2427 options.style.marginLeft = spanMargin;
nickjillings@1318 2428 text.style.marginRight = spanMargin;
nickjillings@1318 2429 text.style.marginLeft = spanMargin;
nickjillings@1318 2430 }
nickjillings@1318 2431 };
nickjillings@1318 2432 this.resize();
nickjillings@1318 2433 };
nickjillings@1318 2434
nickjillings@1318 2435 this.checkboxBox = function(commentQuestion) {
nickjillings@1318 2436 this.specification = commentQuestion;
nickjillings@1318 2437 // Create document objects to hold the comment boxes
nickjillings@1318 2438 this.holder = document.createElement('div');
nickjillings@1318 2439 this.holder.className = 'comment-div';
nickjillings@1318 2440 // Create a string next to each comment asking for a comment
nickjillings@1318 2441 this.string = document.createElement('span');
nickjillings@1318 2442 this.string.innerHTML = commentQuestion.statement;
nickjillings@1318 2443 var br = document.createElement('br');
nickjillings@1318 2444 // Add to the holder.
nickjillings@1318 2445 this.holder.appendChild(this.string);
nickjillings@1318 2446 this.holder.appendChild(br);
nickjillings@1318 2447 this.options = [];
nickjillings@1318 2448 this.inputs = document.createElement('div');
nickjillings@1318 2449 this.span = document.createElement('div');
nickjillings@1318 2450 this.inputs.align = 'center';
nickjillings@1318 2451 this.inputs.style.marginLeft = '12px';
nickjillings@1318 2452 this.span.style.marginLeft = '12px';
nickjillings@1318 2453 this.span.align = 'center';
nickjillings@1318 2454 this.span.style.marginTop = '15px';
nickjillings@1318 2455
nickjillings@1318 2456 var optCount = commentQuestion.options.length;
nickjillings@1318 2457 for (var i=0; i<optCount; i++)
nickjillings@1318 2458 {
nickjillings@1318 2459 var div = document.createElement('div');
nickjillings@1318 2460 div.style.width = '80px';
nickjillings@1318 2461 div.style.float = 'left';
nickjillings@1318 2462 var input = document.createElement('input');
nickjillings@1318 2463 input.type = 'checkbox';
nickjillings@1318 2464 input.name = commentQuestion.id;
nickjillings@1318 2465 input.setAttribute('setvalue',commentQuestion.options[i].name);
nickjillings@1318 2466 input.className = 'comment-radio';
nickjillings@1318 2467 div.appendChild(input);
nickjillings@1318 2468 this.inputs.appendChild(div);
nickjillings@1318 2469
nickjillings@1318 2470
nickjillings@1318 2471 div = document.createElement('div');
nickjillings@1318 2472 div.style.width = '80px';
nickjillings@1318 2473 div.style.float = 'left';
nickjillings@1318 2474 div.align = 'center';
nickjillings@1318 2475 var span = document.createElement('span');
nickjillings@1318 2476 span.textContent = commentQuestion.options[i].text;
nickjillings@1318 2477 span.className = 'comment-radio-span';
nickjillings@1318 2478 div.appendChild(span);
nickjillings@1318 2479 this.span.appendChild(div);
nickjillings@1318 2480 this.options.push(input);
nickjillings@1318 2481 }
nickjillings@1318 2482 this.holder.appendChild(this.span);
nickjillings@1318 2483 this.holder.appendChild(this.inputs);
nickjillings@1318 2484
nickjillings@1318 2485 this.exportXMLDOM = function() {
nickjillings@1318 2486 var root = document.createElement('comment');
nickjillings@1318 2487 root.id = this.specification.id;
nickjillings@1318 2488 root.setAttribute('type',this.specification.type);
nickjillings@1318 2489 var question = document.createElement('question');
nickjillings@1318 2490 question.textContent = this.string.textContent;
nickjillings@1318 2491 root.appendChild(question);
nickjillings@1318 2492 console.log('Comment: '+question.textContent);
nickjillings@1318 2493 for (var i=0; i<this.options.length; i++) {
nickjillings@1318 2494 var response = document.createElement('response');
nickjillings@1318 2495 response.textContent = this.options[i].checked;
nickjillings@1318 2496 response.setAttribute('name',this.options[i].getAttribute('setvalue'));
nickjillings@1318 2497 root.appendChild(response);
nickjillings@1318 2498 console.log('Response '+response.getAttribute('name') +': '+response.textContent);
nickjillings@1318 2499 }
nickjillings@1318 2500 return root;
nickjillings@1318 2501 };
nickjillings@1318 2502 this.resize = function()
nickjillings@1318 2503 {
nickjillings@1318 2504 var boxwidth = (window.innerWidth-100)/2;
nickjillings@1318 2505 if (boxwidth >= 600)
nickjillings@1318 2506 {
nickjillings@1318 2507 boxwidth = 600;
nickjillings@1318 2508 }
nickjillings@1318 2509 else if (boxwidth < 400)
nickjillings@1318 2510 {
nickjillings@1318 2511 boxwidth = 400;
nickjillings@1318 2512 }
nickjillings@1318 2513 this.holder.style.width = boxwidth+"px";
nickjillings@1318 2514 var text = this.holder.children[2];
nickjillings@1318 2515 var options = this.holder.children[3];
nickjillings@1318 2516 var optCount = options.children.length;
nickjillings@1318 2517 var spanMargin = Math.floor(((boxwidth-20-(optCount*80))/(optCount))/2)+'px';
nickjillings@1318 2518 var options = options.firstChild;
nickjillings@1318 2519 var text = text.firstChild;
nickjillings@1318 2520 options.style.marginRight = spanMargin;
nickjillings@1318 2521 options.style.marginLeft = spanMargin;
nickjillings@1318 2522 text.style.marginRight = spanMargin;
nickjillings@1318 2523 text.style.marginLeft = spanMargin;
nickjillings@1318 2524 while(options.nextSibling != undefined)
nickjillings@1318 2525 {
nickjillings@1318 2526 options = options.nextSibling;
nickjillings@1318 2527 text = text.nextSibling;
nickjillings@1318 2528 options.style.marginRight = spanMargin;
nickjillings@1318 2529 options.style.marginLeft = spanMargin;
nickjillings@1318 2530 text.style.marginRight = spanMargin;
nickjillings@1318 2531 text.style.marginLeft = spanMargin;
nickjillings@1318 2532 }
nickjillings@1318 2533 };
nickjillings@1318 2534 this.resize();
nickjillings@1318 2535 };
nickjillings@1318 2536
nickjillings@1318 2537 this.createCommentBox = function(audioObject) {
nickjillings@1318 2538 var node = new this.elementCommentBox(audioObject);
nickjillings@1318 2539 this.commentBoxes.push(node);
nickjillings@1318 2540 audioObject.commentDOM = node;
nickjillings@1318 2541 return node;
nickjillings@1318 2542 };
nickjillings@1318 2543
nickjillings@1318 2544 this.sortCommentBoxes = function() {
nickjillings@1338 2545 this.commentBoxes.sort(function(a,b){return a.id - b.id;});
nickjillings@1318 2546 };
nickjillings@1318 2547
nickjillings@1318 2548 this.showCommentBoxes = function(inject, sort) {
nickjillings@1318 2549 if (sort) {interfaceContext.sortCommentBoxes();}
nickjillings@1338 2550 for (var box of interfaceContext.commentBoxes) {
nickjillings@1338 2551 inject.appendChild(box.trackComment);
nickjillings@1318 2552 }
nickjillings@1318 2553 };
nickjillings@1318 2554
nickjillings@1318 2555 this.deleteCommentBoxes = function() {
nickjillings@1318 2556 this.commentBoxes = [];
nickjillings@1318 2557 };
nickjillings@1318 2558
nickjillings@1318 2559 this.createCommentQuestion = function(element) {
nickjillings@1318 2560 var node;
nickjillings@1324 2561 if (element.type == 'question') {
nickjillings@1318 2562 node = new this.commentBox(element);
nickjillings@1318 2563 } else if (element.type == 'radio') {
nickjillings@1318 2564 node = new this.radioBox(element);
nickjillings@1318 2565 } else if (element.type == 'checkbox') {
nickjillings@1318 2566 node = new this.checkboxBox(element);
nickjillings@1318 2567 }
nickjillings@1318 2568 this.commentQuestions.push(node);
nickjillings@1318 2569 return node;
nickjillings@1318 2570 };
nickjillings@1318 2571
nickjillings@1318 2572 this.deleteCommentQuestions = function()
nickjillings@1318 2573 {
nickjillings@1318 2574 this.commentQuestions = [];
nickjillings@1318 2575 };
nickjillings@1318 2576
nickjillings@1318 2577 this.playhead = new function()
nickjillings@1318 2578 {
nickjillings@1318 2579 this.object = document.createElement('div');
nickjillings@1318 2580 this.object.className = 'playhead';
nickjillings@1318 2581 this.object.align = 'left';
nickjillings@1318 2582 var curTime = document.createElement('div');
nickjillings@1318 2583 curTime.style.width = '50px';
nickjillings@1318 2584 this.curTimeSpan = document.createElement('span');
nickjillings@1318 2585 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2586 curTime.appendChild(this.curTimeSpan);
nickjillings@1318 2587 this.object.appendChild(curTime);
nickjillings@1318 2588 this.scrubberTrack = document.createElement('div');
nickjillings@1318 2589 this.scrubberTrack.className = 'playhead-scrub-track';
nickjillings@1318 2590
nickjillings@1318 2591 this.scrubberHead = document.createElement('div');
nickjillings@1318 2592 this.scrubberHead.id = 'playhead-scrubber';
nickjillings@1318 2593 this.scrubberTrack.appendChild(this.scrubberHead);
nickjillings@1318 2594 this.object.appendChild(this.scrubberTrack);
nickjillings@1318 2595
nickjillings@1318 2596 this.timePerPixel = 0;
nickjillings@1318 2597 this.maxTime = 0;
nickjillings@1318 2598
nickjillings@1318 2599 this.playbackObject;
nickjillings@1318 2600
nickjillings@1318 2601 this.setTimePerPixel = function(audioObject) {
nickjillings@1318 2602 //maxTime must be in seconds
nickjillings@1318 2603 this.playbackObject = audioObject;
nickjillings@1318 2604 this.maxTime = audioObject.buffer.buffer.duration;
nickjillings@1318 2605 var width = 490; //500 - 10, 5 each side of the tracker head
nickjillings@1318 2606 this.timePerPixel = this.maxTime/490;
nickjillings@1318 2607 if (this.maxTime < 60) {
nickjillings@1318 2608 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2609 } else {
nickjillings@1318 2610 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2611 }
nickjillings@1318 2612 };
nickjillings@1318 2613
nickjillings@1318 2614 this.update = function() {
nickjillings@1318 2615 // Update the playhead position, startPlay must be called
nickjillings@1318 2616 if (this.timePerPixel > 0) {
nickjillings@1318 2617 var time = this.playbackObject.getCurrentPosition();
nickjillings@1318 2618 if (time > 0) {
nickjillings@1318 2619 var width = 490;
nickjillings@1318 2620 var pix = Math.floor(time/this.timePerPixel);
nickjillings@1318 2621 this.scrubberHead.style.left = pix+'px';
nickjillings@1318 2622 if (this.maxTime > 60.0) {
nickjillings@1318 2623 var secs = time%60;
nickjillings@1318 2624 var mins = Math.floor((time-secs)/60);
nickjillings@1318 2625 secs = secs.toString();
nickjillings@1318 2626 secs = secs.substr(0,2);
nickjillings@1318 2627 mins = mins.toString();
nickjillings@1318 2628 this.curTimeSpan.textContent = mins+':'+secs;
nickjillings@1318 2629 } else {
nickjillings@1318 2630 time = time.toString();
nickjillings@1318 2631 this.curTimeSpan.textContent = time.substr(0,4);
nickjillings@1318 2632 }
nickjillings@1318 2633 } else {
nickjillings@1318 2634 this.scrubberHead.style.left = '0px';
nickjillings@1318 2635 if (this.maxTime < 60) {
nickjillings@1318 2636 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2637 } else {
nickjillings@1318 2638 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2639 }
nickjillings@1318 2640 }
nickjillings@1318 2641 }
nickjillings@1318 2642 };
nickjillings@1318 2643
nickjillings@1318 2644 this.interval = undefined;
nickjillings@1318 2645
nickjillings@1318 2646 this.start = function() {
nickjillings@1318 2647 if (this.playbackObject != undefined && this.interval == undefined) {
nickjillings@1318 2648 if (this.maxTime < 60) {
nickjillings@1318 2649 this.interval = setInterval(function(){interfaceContext.playhead.update();},10);
nickjillings@1318 2650 } else {
nickjillings@1318 2651 this.interval = setInterval(function(){interfaceContext.playhead.update();},100);
nickjillings@1318 2652 }
nickjillings@1318 2653 }
nickjillings@1318 2654 };
nickjillings@1318 2655 this.stop = function() {
nickjillings@1318 2656 clearInterval(this.interval);
nickjillings@1318 2657 this.interval = undefined;
nickjillings@1318 2658 if (this.maxTime < 60) {
nickjillings@1318 2659 this.curTimeSpan.textContent = '0.00';
nickjillings@1318 2660 } else {
nickjillings@1318 2661 this.curTimeSpan.textContent = '00:00';
nickjillings@1318 2662 }
nickjillings@1318 2663 };
nickjillings@1318 2664 };
nickjillings@1318 2665
nickjillings@1318 2666 // Global Checkers
nickjillings@1318 2667 // These functions will help enforce the checkers
nickjillings@1318 2668 this.checkHiddenAnchor = function()
nickjillings@1318 2669 {
nickjillings@1324 2670 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2671 {
nickjillings@1324 2672 if (ao.specification.type == "anchor")
nickjillings@1318 2673 {
nickjillings@1325 2674 if (ao.interfaceDOM.getValue() > (ao.specification.marker/100) && ao.specification.marker > 0) {
nickjillings@1324 2675 // Anchor is not set below
nickjillings@1324 2676 console.log('Anchor node not below marker value');
nickjillings@1324 2677 alert('Please keep listening');
nickjillings@1324 2678 return false;
nickjillings@1324 2679 }
nickjillings@1318 2680 }
nickjillings@1318 2681 }
nickjillings@1318 2682 return true;
nickjillings@1318 2683 };
nickjillings@1318 2684
nickjillings@1318 2685 this.checkHiddenReference = function()
nickjillings@1318 2686 {
nickjillings@1324 2687 for (var ao of audioEngineContext.audioObjects)
nickjillings@1318 2688 {
nickjillings@1324 2689 if (ao.specification.type == "reference")
nickjillings@1318 2690 {
nickjillings@1325 2691 if (ao.interfaceDOM.getValue() < (ao.specification.marker/100) && ao.specification.marker > 0) {
nickjillings@1324 2692 // Anchor is not set below
nickjillings@1324 2693 console.log('Reference node not below marker value');
nickjillings@1324 2694 alert('Please keep listening');
nickjillings@1324 2695 return false;
nickjillings@1324 2696 }
nickjillings@1318 2697 }
nickjillings@1318 2698 }
nickjillings@1318 2699 return true;
nickjillings@1318 2700 };
nickjillings@1318 2701
nickjillings@1318 2702 this.checkFragmentsFullyPlayed = function ()
nickjillings@1318 2703 {
nickjillings@1318 2704 // Checks the entire file has been played back
nickjillings@1318 2705 // NOTE ! This will return true IF playback is Looped!!!
nickjillings@1318 2706 if (audioEngineContext.loopPlayback)
nickjillings@1318 2707 {
nickjillings@1318 2708 console.log("WARNING - Looped source: Cannot check fragments are fully played");
nickjillings@1318 2709 return true;
nickjillings@1318 2710 }
nickjillings@1318 2711 var check_pass = true;
nickjillings@1318 2712 var error_obj = [];
nickjillings@1318 2713 for (var i = 0; i<audioEngineContext.audioObjects.length; i++)
nickjillings@1318 2714 {
nickjillings@1318 2715 var object = audioEngineContext.audioObjects[i];
nickjillings@1318 2716 var time = object.buffer.buffer.duration;
nickjillings@1318 2717 var metric = object.metric;
nickjillings@1318 2718 var passed = false;
nickjillings@1318 2719 for (var j=0; j<metric.listenTracker.length; j++)
nickjillings@1318 2720 {
nickjillings@1318 2721 var bt = metric.listenTracker[j].getElementsByTagName('buffertime');
nickjillings@1318 2722 var start_time = Number(bt[0].getAttribute('start'));
nickjillings@1318 2723 var stop_time = Number(bt[0].getAttribute('stop'));
nickjillings@1318 2724 var delta = stop_time - start_time;
nickjillings@1318 2725 if (delta >= time)
nickjillings@1318 2726 {
nickjillings@1318 2727 passed = true;
nickjillings@1318 2728 break;
nickjillings@1318 2729 }
nickjillings@1318 2730 }
nickjillings@1318 2731 if (passed == false)
nickjillings@1318 2732 {
nickjillings@1318 2733 check_pass = false;
nickjillings@1318 2734 console.log("Continue listening to track-"+i);
nickjillings@1318 2735 error_obj.push(i);
nickjillings@1318 2736 }
nickjillings@1318 2737 }
nickjillings@1318 2738 if (check_pass == false)
nickjillings@1318 2739 {
nickjillings@1318 2740 var str_start = "You have not completely listened to fragments ";
nickjillings@1318 2741 for (var i=0; i<error_obj.length; i++)
nickjillings@1318 2742 {
nickjillings@1318 2743 str_start += error_obj[i];
nickjillings@1318 2744 if (i != error_obj.length-1)
nickjillings@1318 2745 {
nickjillings@1318 2746 str_start += ', ';
nickjillings@1318 2747 }
nickjillings@1318 2748 }
nickjillings@1318 2749 str_start += ". Please keep listening";
nickjillings@1318 2750 console.log("[ALERT]: "+str_start);
nickjillings@1318 2751 alert(str_start);
nickjillings@1318 2752 }
nickjillings@1318 2753 };
nickjillings@1318 2754 this.checkAllMoved = function()
nickjillings@1318 2755 {
nickjillings@1318 2756 var str = "You have not moved ";
nickjillings@1318 2757 var failed = [];
nickjillings@1318 2758 for (var i in audioEngineContext.audioObjects)
nickjillings@1318 2759 {
nickjillings@1318 2760 if(audioEngineContext.audioObjects[i].metric.wasMoved == false && audioEngineContext.audioObjects[i].specification.type != 'outsidereference')
nickjillings@1318 2761 {
nickjillings@1318 2762 failed.push(audioEngineContext.audioObjects[i].id);
nickjillings@1318 2763 }
nickjillings@1318 2764 }
nickjillings@1318 2765 if (failed.length == 0)
nickjillings@1318 2766 {
nickjillings@1318 2767 return true;
nickjillings@1318 2768 } else if (failed.length == 1)
nickjillings@1318 2769 {
nickjillings@1318 2770 str += 'track '+failed[0];
nickjillings@1318 2771 } else {
nickjillings@1318 2772 str += 'tracks ';
nickjillings@1318 2773 for (var i=0; i<failed.length-1; i++)
nickjillings@1318 2774 {
nickjillings@1318 2775 str += failed[i]+', ';
nickjillings@1318 2776 }
nickjillings@1318 2777 str += 'and '+failed[i];
nickjillings@1318 2778 }
nickjillings@1318 2779 str +='.';
nickjillings@1318 2780 alert(str);
nickjillings@1318 2781 console.log(str);
nickjillings@1318 2782 return false;
nickjillings@1318 2783 };
nickjillings@1318 2784 this.checkAllPlayed = function()
nickjillings@1318 2785 {
nickjillings@1318 2786 var str = "You have not played ";
nickjillings@1318 2787 var failed = [];
nickjillings@1318 2788 for (var i in audioEngineContext.audioObjects)
nickjillings@1318 2789 {
nickjillings@1318 2790 if(audioEngineContext.audioObjects[i].metric.wasListenedTo == false)
nickjillings@1318 2791 {
nickjillings@1318 2792 failed.push(audioEngineContext.audioObjects[i].id);
nickjillings@1318 2793 }
nickjillings@1318 2794 }
nickjillings@1318 2795 if (failed.length == 0)
nickjillings@1318 2796 {
nickjillings@1318 2797 return true;
nickjillings@1318 2798 } else if (failed.length == 1)
nickjillings@1318 2799 {
nickjillings@1318 2800 str += 'track '+failed[0];
nickjillings@1318 2801 } else {
nickjillings@1318 2802 str += 'tracks ';
nickjillings@1318 2803 for (var i=0; i<failed.length-1; i++)
nickjillings@1318 2804 {
nickjillings@1318 2805 str += failed[i]+', ';
nickjillings@1318 2806 }
nickjillings@1318 2807 str += 'and '+failed[i];
nickjillings@1318 2808 }
nickjillings@1318 2809 str +='.';
nickjillings@1318 2810 alert(str);
nickjillings@1318 2811 console.log(str);
nickjillings@1318 2812 return false;
nickjillings@1318 2813 };
nickjillings@1324 2814 }
nickjillings@1324 2815
nickjillings@1324 2816 function Storage()
nickjillings@1324 2817 {
nickjillings@1324 2818 // Holds results in XML format until ready for collection
nickjillings@1324 2819 this.globalPreTest = null;
nickjillings@1324 2820 this.globalPostTest = null;
nickjillings@1324 2821 this.testPages = [];
nickjillings@1324 2822 this.document = document.implementation.createDocument(null,"waetresult");
nickjillings@1324 2823 this.root = this.document.children[0];
nickjillings@1324 2824 this.state = 0;
nickjillings@1324 2825
nickjillings@1324 2826 this.initialise = function()
nickjillings@1324 2827 {
nickjillings@1324 2828 this.globalPreTest = new this.surveyNode(this,this.root,specification.preTest);
nickjillings@1324 2829 this.globalPostTest = new this.surveyNode(this,this.root,specification.postTest);
nickjillings@1324 2830 };
nickjillings@1324 2831
nickjillings@1324 2832 this.createTestPageStore = function(specification)
nickjillings@1324 2833 {
nickjillings@1324 2834 var store = new this.pageNode(this,specification);
nickjillings@1324 2835 this.testPages.push(store);
nickjillings@1324 2836 return this.testPages[this.testPages.length-1];
nickjillings@1324 2837 };
nickjillings@1324 2838
nickjillings@1324 2839 this.surveyNode = function(parent,root,specification)
nickjillings@1324 2840 {
nickjillings@1324 2841 this.specification = specification;
nickjillings@1324 2842 this.parent = parent;
nickjillings@1324 2843 this.XMLDOM = this.parent.document.createElement('survey');
nickjillings@1324 2844 this.XMLDOM.setAttribute('location',this.specification.location);
nickjillings@1324 2845 for (var optNode of this.specification.options)
nickjillings@1324 2846 {
nickjillings@1324 2847 if (optNode.type != 'statement')
nickjillings@1324 2848 {
nickjillings@1324 2849 var node = this.parent.document.createElement('surveyresult');
nickjillings@1324 2850 node.id = optNode.id;
nickjillings@1324 2851 node.setAttribute('type',optNode.type);
nickjillings@1324 2852 this.XMLDOM.appendChild(node);
nickjillings@1324 2853 }
nickjillings@1324 2854 }
nickjillings@1324 2855 root.appendChild(this.XMLDOM);
nickjillings@1324 2856
nickjillings@1324 2857 this.postResult = function(node)
nickjillings@1324 2858 {
nickjillings@1324 2859 // From popup: node is the popupOption node containing both spec. and results
nickjillings@1324 2860 // ID is the position
nickjillings@1324 2861 if (node.specification.type == 'statement'){return;}
nickjillings@1324 2862 var surveyresult = this.parent.document.getElementById(node.specification.id);
nickjillings@1324 2863 switch(node.specification.type)
nickjillings@1324 2864 {
nickjillings@1324 2865 case "number":
nickjillings@1324 2866 case "question":
nickjillings@1324 2867 var child = this.parent.document.createElement('response');
nickjillings@1324 2868 child.textContent = node.response;
nickjillings@1324 2869 surveyresult.appendChild(child);
nickjillings@1324 2870 break;
nickjillings@1324 2871 case "radio":
nickjillings@1324 2872 var child = this.parent.document.createElement('response');
nickjillings@1324 2873 child.setAttribute('name',node.response.name);
nickjillings@1324 2874 child.textContent = node.response.text;
nickjillings@1324 2875 surveyresult.appendChild(child);
nickjillings@1324 2876 break;
nickjillings@1324 2877 case "checkbox":
nickjillings@1324 2878 for (var i=0; i<node.response.length; i++)
nickjillings@1324 2879 {
nickjillings@1324 2880 var checkNode = this.parent.document.createElement('response');
nickjillings@1326 2881 checkNode.setAttribute('name',node.response.name);
nickjillings@1326 2882 checkNode.setAttribute('checked',node.response.checked);
nickjillings@1326 2883 surveyresult.appendChild(checkNode);
nickjillings@1324 2884 }
nickjillings@1324 2885 break;
nickjillings@1324 2886 }
nickjillings@1324 2887 };
nickjillings@1324 2888 };
nickjillings@1324 2889
nickjillings@1324 2890 this.pageNode = function(parent,specification)
nickjillings@1324 2891 {
nickjillings@1324 2892 // Create one store per test page
nickjillings@1324 2893 this.specification = specification;
nickjillings@1324 2894 this.parent = parent;
nickjillings@1324 2895 this.XMLDOM = this.parent.document.createElement('page');
nickjillings@1324 2896 this.XMLDOM.setAttribute('id',specification.id);
nickjillings@1324 2897 this.XMLDOM.setAttribute('presentedId',specification.presentedId);
nickjillings@1324 2898 this.preTest = new this.parent.surveyNode(parent,this.XMLDOM,specification.preTest);
nickjillings@1324 2899 this.postTest = new this.parent.surveyNode(parent,this.XMLDOM,specification.postTest);
nickjillings@1324 2900
nickjillings@1324 2901 // Add any page metrics
nickjillings@1324 2902 var page_metric = this.parent.document.createElement('metric');
nickjillings@1324 2903 this.XMLDOM.appendChild(page_metric);
nickjillings@1324 2904
nickjillings@1324 2905 // Add the audioelement
nickjillings@1324 2906 for (var element of this.specification.audioElements)
nickjillings@1324 2907 {
nickjillings@1324 2908 var aeNode = this.parent.document.createElement('audioelement');
nickjillings@1324 2909 aeNode.id = element.id;
nickjillings@1324 2910 aeNode.setAttribute('type',element.type);
nickjillings@1324 2911 aeNode.setAttribute('url', element.url);
nickjillings@1324 2912 aeNode.setAttribute('gain', element.gain);
nickjillings@1324 2913 if (element.type == 'anchor' || element.type == 'reference')
nickjillings@1324 2914 {
nickjillings@1324 2915 if (element.marker > 0)
nickjillings@1324 2916 {
nickjillings@1324 2917 aeNode.setAttribute('marker',element.marker);
nickjillings@1324 2918 }
nickjillings@1324 2919 }
nickjillings@1324 2920 var ae_metric = this.parent.document.createElement('metric');
nickjillings@1324 2921 aeNode.appendChild(ae_metric);
nickjillings@1324 2922 this.XMLDOM.appendChild(aeNode);
nickjillings@1324 2923 }
nickjillings@1324 2924
nickjillings@1324 2925 // Add any commentQuestions
nickjillings@1324 2926 for (var element of this.specification.commentQuestions)
nickjillings@1324 2927 {
nickjillings@1324 2928 var cqNode = this.parent.document.createElement('commentquestion');
nickjillings@1324 2929 cqNode.id = element.id;
nickjillings@1324 2930 cqNode.setAttribute('type',element.type);
nickjillings@1324 2931 var statement = this.parent.document.createElement('statement');
nickjillings@1324 2932 statement.textContent = cqNode.statement;
nickjillings@1324 2933 cqNode.appendChild(statement);
nickjillings@1324 2934 var response = this.parent.document.createElement('response');
nickjillings@1324 2935 cqNode.appendChild(response);
nickjillings@1324 2936 this.XMLDOM.appendChild(cqNode);
nickjillings@1324 2937 }
nickjillings@1324 2938
nickjillings@1324 2939 this.parent.root.appendChild(this.XMLDOM);
nickjillings@1324 2940 };
nickjillings@1324 2941 this.finish = function()
nickjillings@1324 2942 {
nickjillings@1324 2943 if (this.state == 0)
nickjillings@1324 2944 {
nickjillings@1324 2945 var projectDocument = specification.projectXML;
nickjillings@1324 2946 projectDocument.setAttribute('file-name',url);
nickjillings@1324 2947 this.root.appendChild(projectDocument);
nickjillings@1324 2948 this.root.appendChild(returnDateNode());
nickjillings@1324 2949 this.root.appendChild(interfaceContext.returnNavigator());
nickjillings@1324 2950 }
nickjillings@1324 2951 this.state = 1;
nickjillings@1324 2952 return this.root;
nickjillings@1324 2953 };
nickjillings@1324 2954 }