annotate core.js @ 1330:a7e81c4f4ace

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