annotate ape.js @ 97:396ee95ad102 Dev_main

Fixed Bug 1204: Multiple clicks creates multiple instances.
author Nicholas Jillings <n.g.r.jillings@se14.qmul.ac.uk>
date Fri, 01 May 2015 16:07:15 +0100
parents 4c370a73f30f
children 1c869162371b
rev   line source
nicholas@2 1 /**
nicholas@2 2 * ape.js
nicholas@2 3 * Create the APE interface
nicholas@2 4 */
nicholas@2 5
n@38 6 var currentState; // Keep track of the current state (pre/post test, which test, final test? first test?)
n@38 7 // preTest - In preTest state
n@38 8 // testRun-ID - In test running, test Id number at the end 'testRun-2'
n@38 9 // testRunPost-ID - Post test of test ID
n@38 10 // testRunPre-ID - Pre-test of test ID
n@38 11 // postTest - End of test, final submission!
n@38 12
n@32 13
nicholas@2 14 // Once this is loaded and parsed, begin execution
nicholas@2 15 loadInterface(projectXML);
nicholas@2 16
nicholas@2 17 function loadInterface(xmlDoc) {
nicholas@2 18
n@16 19 // Get the dimensions of the screen available to the page
nicholas@2 20 var width = window.innerWidth;
nicholas@2 21 var height = window.innerHeight;
nicholas@2 22
nicholas@2 23 // The injection point into the HTML page
nicholas@2 24 var insertPoint = document.getElementById("topLevelBody");
n@22 25 var testContent = document.createElement('div');
n@22 26 testContent.id = 'testContent';
nicholas@2 27
nicholas@7 28
nicholas@2 29 // Decode parts of the xmlDoc that are needed
nicholas@2 30 // xmlDoc MUST already be parsed by jQuery!
nicholas@2 31 var xmlSetup = xmlDoc.find('setup');
nicholas@2 32 // Should put in an error function here incase of malprocessed or malformed XML
nicholas@2 33
n@34 34 // Extract the different test XML DOM trees
n@50 35 var audioHolders = xmlDoc.find('audioHolder');
n@50 36 audioHolders.each(function(index,element) {
n@50 37 var repeatN = element.attributes['repeatCount'].value;
n@50 38 for (var r=0; r<=repeatN; r++) {
n@50 39 testXMLSetups[testXMLSetups.length] = element;
n@50 40 }
n@50 41 });
n@44 42
n@50 43 // New check if we need to randomise the test order
n@50 44 var randomise = xmlSetup[0].attributes['randomiseOrder'];
n@50 45 if (randomise != undefined) {
n@50 46 randomise = Boolean(randomise.value);
n@50 47 } else {
n@50 48 randomise = false;
n@50 49 }
n@50 50 if (randomise)
n@50 51 {
n@54 52 testXMLSetups = randomiseOrder(testXMLSetups);
n@50 53 }
n@44 54
n@50 55 // Obtain the metrics enabled
n@50 56 var metricNode = xmlSetup.find('Metric');
n@50 57 var metricNode = metricNode.find('metricEnable');
n@50 58 metricNode.each(function(index,node){
n@50 59 var enabled = node.textContent;
n@50 60 switch(enabled)
n@50 61 {
n@50 62 case 'testTimer':
n@50 63 sessionMetrics.prototype.enableTestTimer = true;
n@50 64 break;
n@50 65 case 'elementTimer':
n@50 66 sessionMetrics.prototype.enableElementTimer = true;
n@50 67 break;
n@50 68 case 'elementTracker':
n@50 69 sessionMetrics.prototype.enableElementTracker = true;
n@50 70 break;
n@50 71 case 'elementInitalPosition':
n@50 72 sessionMetrics.prototype.enableElementInitialPosition = true;
n@50 73 break;
n@50 74 case 'elementFlagListenedTo':
n@50 75 sessionMetrics.prototype.enableFlagListenedTo = true;
n@50 76 break;
n@50 77 case 'elementFlagMoved':
n@50 78 sessionMetrics.prototype.enableFlagMoved = true;
n@50 79 break;
n@50 80 case 'elementFlagComments':
n@50 81 sessionMetrics.prototype.enableFlagComments = true;
n@50 82 break;
n@50 83 }
n@50 84 });
n@34 85
n@52 86 // Create APE specific metric functions
n@52 87 audioEngineContext.metric.initialiseTest = function()
n@52 88 {
n@52 89 var sliders = document.getElementsByClassName('track-slider');
n@52 90 for (var i=0; i<sliders.length; i++)
n@52 91 {
n@52 92 audioEngineContext.audioObjects[i].metric.initialised(convSliderPosToRate(i));
n@52 93 }
n@52 94 };
n@52 95
n@52 96 audioEngineContext.metric.sliderMoveStart = function(id)
n@52 97 {
n@52 98 if (this.data == -1)
n@52 99 {
n@52 100 this.data = id;
n@52 101 } else {
n@52 102 console.log('ERROR: Metric tracker detecting two moves!');
n@52 103 this.data = -1;
n@52 104 }
n@52 105 };
n@52 106 audioEngineContext.metric.sliderMoved = function()
n@52 107 {
n@52 108 var time = audioEngineContext.timer.getTestTime();
n@52 109 var id = this.data;
n@52 110 this.data = -1;
n@52 111 var position = convSliderPosToRate(id);
n@52 112 if (audioEngineContext.timer.testStarted)
n@52 113 {
n@52 114 audioEngineContext.audioObjects[id].metric.moved(time,position);
n@52 115 }
n@52 116 };
n@52 117
n@52 118 audioEngineContext.metric.sliderPlayed = function(id)
n@52 119 {
n@52 120 var time = audioEngineContext.timer.getTestTime();
n@52 121 if (audioEngineContext.timer.testStarted)
n@52 122 {
n@52 123 if (this.lastClicked >= 0)
n@52 124 {
n@52 125 audioEngineContext.audioObjects[this.lastClicked].metric.listening(time);
n@52 126 }
n@52 127 this.lastClicked = id;
n@52 128 audioEngineContext.audioObjects[id].metric.listening(time);
n@52 129 }
n@52 130 };
n@52 131
nicholas@2 132 // Create the top div for the Title element
nicholas@2 133 var titleAttr = xmlSetup[0].attributes['title'];
nicholas@2 134 var title = document.createElement('div');
nicholas@2 135 title.className = "title";
nicholas@2 136 title.align = "center";
nicholas@2 137 var titleSpan = document.createElement('span');
nicholas@2 138
nicholas@2 139 // Set title to that defined in XML, else set to default
nicholas@2 140 if (titleAttr != undefined) {
n@25 141 titleSpan.innerHTML = titleAttr.value;
nicholas@2 142 } else {
b@75 143 titleSpan.innerHTML = 'Listening test';
nicholas@2 144 }
nicholas@2 145 // Insert the titleSpan element into the title div element.
nicholas@2 146 title.appendChild(titleSpan);
nicholas@2 147
n@47 148 var pagetitle = document.createElement('div');
n@47 149 pagetitle.className = "pageTitle";
n@47 150 pagetitle.align = "center";
n@47 151 var titleSpan = document.createElement('span');
n@47 152 titleSpan.id = "pageTitle";
n@47 153 pagetitle.appendChild(titleSpan);
n@47 154
nicholas@7 155 // Store the return URL path in global projectReturn
nicholas@7 156 projectReturn = xmlSetup[0].attributes['projectReturn'].value;
nicholas@7 157
nicholas@7 158 // Create Interface buttons!
nicholas@7 159 var interfaceButtons = document.createElement('div');
nicholas@7 160 interfaceButtons.id = 'interface-buttons';
nicholas@7 161
nicholas@7 162 // MANUAL DOWNLOAD POINT
nicholas@7 163 // If project return is null, this MUST be specified as the location to create the download link
nicholas@7 164 var downloadPoint = document.createElement('div');
nicholas@7 165 downloadPoint.id = 'download-point';
nicholas@7 166
nicholas@7 167 // Create playback start/stop points
nicholas@7 168 var playback = document.createElement("button");
n@25 169 playback.innerHTML = 'Start';
n@49 170 playback.id = 'playback-button';
n@16 171 // onclick function. Check if it is playing or not, call the correct function in the
n@16 172 // audioEngine, change the button text to reflect the next state.
nicholas@7 173 playback.onclick = function() {
nicholas@7 174 if (audioEngineContext.status == 0) {
nicholas@7 175 audioEngineContext.play();
n@25 176 this.innerHTML = 'Stop';
nicholas@7 177 } else {
nicholas@7 178 audioEngineContext.stop();
n@25 179 this.innerHTML = 'Start';
nicholas@7 180 }
n@16 181 };
nicholas@7 182 // Create Submit (save) button
nicholas@7 183 var submit = document.createElement("button");
n@25 184 submit.innerHTML = 'Submit';
n@43 185 submit.onclick = buttonSubmitClick;
n@49 186 submit.id = 'submit-button';
n@16 187 // Append the interface buttons into the interfaceButtons object.
nicholas@7 188 interfaceButtons.appendChild(playback);
nicholas@7 189 interfaceButtons.appendChild(submit);
nicholas@7 190 interfaceButtons.appendChild(downloadPoint);
nicholas@7 191
nicholas@2 192 // Now create the slider and HTML5 canvas boxes
nicholas@2 193
n@16 194 // Create the div box to center align
nicholas@2 195 var sliderBox = document.createElement('div');
nicholas@2 196 sliderBox.className = 'sliderCanvasDiv';
n@16 197 sliderBox.id = 'sliderCanvasHolder';
nicholas@2 198 sliderBox.align = 'center';
nicholas@2 199
n@16 200 // Create the slider box to hold the slider elements
nicholas@5 201 var canvas = document.createElement('div');
nicholas@2 202 canvas.id = 'slider';
n@16 203 // Must have a known EXACT width, as this is used later to determine the ratings
nicholas@5 204 canvas.style.width = width - 100 +"px";
nicholas@5 205 canvas.align = "left";
nicholas@2 206 sliderBox.appendChild(canvas);
n@16 207
n@47 208 // Create the div to hold any scale objects
n@47 209 var scale = document.createElement('div');
n@47 210 scale.className = 'sliderScale';
n@47 211 scale.id = 'sliderScaleHolder';
n@47 212 scale.align = 'left';
n@47 213 sliderBox.appendChild(scale);
n@47 214
n@16 215 // Global parent for the comment boxes on the page
nicholas@3 216 var feedbackHolder = document.createElement('div');
n@34 217 feedbackHolder.id = 'feedbackHolder';
nicholas@2 218
n@38 219 testContent.style.zIndex = 1;
n@38 220 insertPoint.innerHTML = null; // Clear the current schema
n@38 221
n@22 222 // Create pre and post test questions
n@38 223 var blank = document.createElement('div');
n@38 224 blank.className = 'testHalt';
n@22 225
n@38 226 var popupHolder = document.createElement('div');
n@38 227 popupHolder.id = 'popupHolder';
n@38 228 popupHolder.className = 'popupHolder';
n@38 229 popupHolder.style.position = 'absolute';
n@38 230 popupHolder.style.left = (window.innerWidth/2)-250 + 'px';
n@38 231 popupHolder.style.top = (window.innerHeight/2)-125 + 'px';
n@38 232 insertPoint.appendChild(popupHolder);
n@38 233 insertPoint.appendChild(blank);
n@38 234 hidePopup();
n@22 235
n@36 236 var preTest = xmlSetup.find('PreTest');
n@36 237 var postTest = xmlSetup.find('PostTest');
n@22 238 preTest = preTest[0];
n@22 239 postTest = postTest[0];
n@38 240
n@38 241 currentState = 'preTest';
n@22 242
n@22 243 // Create Pre-Test Box
n@22 244 if (preTest != undefined && preTest.children.length >= 1)
n@22 245 {
n@38 246 showPopup();
n@39 247 preTestPopupStart(preTest);
n@22 248 }
n@38 249
n@38 250 // Inject into HTML
n@38 251 testContent.appendChild(title); // Insert the title
n@47 252 testContent.appendChild(pagetitle);
n@38 253 testContent.appendChild(interfaceButtons);
n@38 254 testContent.appendChild(sliderBox);
n@38 255 testContent.appendChild(feedbackHolder);
n@38 256 insertPoint.appendChild(testContent);
n@22 257
n@36 258 // Load the full interface
n@39 259
nicholas@2 260 }
nicholas@5 261
n@39 262 function loadTest(id)
n@34 263 {
n@34 264 // Used to load a specific test page
n@39 265 var textXML = testXMLSetups[id];
n@34 266
n@34 267 var feedbackHolder = document.getElementById('feedbackHolder');
n@34 268 var canvas = document.getElementById('slider');
n@34 269 feedbackHolder.innerHTML = null;
n@34 270 canvas.innerHTML = null;
n@47 271
n@47 272 // Setup question title
n@47 273 var interfaceObj = $(textXML).find('interface');
n@47 274 var titleNode = interfaceObj.find('title');
n@47 275 if (titleNode[0] != undefined)
n@47 276 {
n@47 277 document.getElementById('pageTitle').textContent = titleNode[0].textContent;
n@47 278 }
n@47 279 var positionScale = canvas.style.width.substr(0,canvas.style.width.length-2);
n@47 280 var offset = 50-8; // Half the offset of the slider (window width -100) minus the body padding of 8
n@47 281 // TODO: AUTOMATE ABOVE!!
n@47 282 var scale = document.getElementById('sliderScaleHolder');
n@47 283 scale.innerHTML = null;
n@47 284 interfaceObj.find('scale').each(function(index,scaleObj){
n@47 285 var position = Number(scaleObj.attributes['position'].value)*0.01;
n@47 286 var pixelPosition = (position*positionScale)+offset;
n@47 287 var scaleDOM = document.createElement('span');
n@47 288 scaleDOM.textContent = scaleObj.textContent;
n@47 289 scale.appendChild(scaleDOM);
n@47 290 scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px';
n@47 291 });
n@34 292
n@34 293 // Extract the hostURL attribute. If not set, create an empty string.
n@34 294 var hostURL = textXML.attributes['hostURL'];
n@34 295 if (hostURL == undefined) {
n@34 296 hostURL = "";
n@34 297 } else {
n@34 298 hostURL = hostURL.value;
n@34 299 }
n@34 300 // Extract the sampleRate. If set, convert the string to a Number.
n@34 301 var hostFs = textXML.attributes['sampleRate'];
n@34 302 if (hostFs != undefined) {
n@34 303 hostFs = Number(hostFs.value);
n@34 304 }
n@34 305
n@34 306 /// CHECK FOR SAMPLE RATE COMPATIBILITY
n@34 307 if (hostFs != undefined) {
n@34 308 if (Number(hostFs) != audioContext.sampleRate) {
n@34 309 var errStr = 'Sample rates do not match! Requested '+Number(hostFs)+', got '+audioContext.sampleRate+'. Please set the sample rate to match before completing this test.';
n@34 310 alert(errStr);
n@34 311 return;
n@34 312 }
n@34 313 }
n@45 314
nicholas@66 315 var commentShow = textXML.attributes['elementComments'];
nicholas@66 316 if (commentShow != undefined) {
nicholas@66 317 if (commentShow.value == 'false') {commentShow = false;}
nicholas@66 318 else {commentShow = true;}
nicholas@66 319 } else {commentShow = true;}
nicholas@66 320
n@57 321 var loopPlayback = textXML.attributes['loop'];
n@57 322 if (loopPlayback != undefined)
n@57 323 {
n@57 324 loopPlayback = loopPlayback.value;
n@57 325 if (loopPlayback == 'true') {
n@57 326 loopPlayback = true;
n@57 327 } else {
n@57 328 loopPlayback = false;
n@57 329 }
n@57 330 } else {
n@57 331 loopPlayback = false;
n@57 332 }
n@57 333 audioEngineContext.loopPlayback = loopPlayback;
n@57 334
n@57 335 // Create AudioEngine bindings for playback
n@57 336 if (loopPlayback) {
n@57 337 audioEngineContext.play = function() {
n@57 338 // Send play command to all playback buffers for synchronised start
n@57 339 // Also start timer callbacks to detect if playback has finished
n@57 340 if (this.status == 0) {
n@57 341 this.timer.startTest();
n@57 342 // First get current clock
n@57 343 var timer = audioContext.currentTime;
n@57 344 // Add 3 seconds
n@57 345 timer += 3.0;
n@57 346 // Send play to all tracks
n@57 347 for (var i=0; i<this.audioObjects.length; i++)
n@57 348 {
n@57 349 this.audioObjects[i].play(timer);
n@57 350 }
n@57 351 this.status = 1;
n@57 352 }
n@57 353 };
n@57 354
n@57 355 audioEngineContext.stop = function() {
n@57 356 // Send stop and reset command to all playback buffers
n@57 357 if (this.status == 1) {
n@57 358 if (this.loopPlayback) {
n@57 359 for (var i=0; i<this.audioObjects.length; i++)
n@57 360 {
n@57 361 this.audioObjects[i].stop();
n@57 362 }
n@57 363 }
n@57 364 this.status = 0;
n@57 365 }
n@57 366 };
n@57 367
n@57 368 audioEngineContext.selectedTrack = function(id) {
n@57 369 for (var i=0; i<this.audioObjects.length; i++)
n@57 370 {
n@57 371 if (id == i) {
n@57 372 this.audioObjects[i].outputGain.gain.value = 1.0;
n@57 373 } else {
n@57 374 this.audioObjects[i].outputGain.gain.value = 0.0;
n@57 375 }
n@57 376 }
n@57 377 };
n@57 378 } else {
n@57 379 audioEngineContext.play = function() {
n@57 380 // Send play command to all playback buffers for synchronised start
n@57 381 // Also start timer callbacks to detect if playback has finished
n@57 382 if (this.status == 0) {
n@57 383 this.timer.startTest();
n@57 384 this.status = 1;
n@57 385 }
n@57 386 };
n@57 387
n@57 388 audioEngineContext.stop = function() {
n@57 389 // Send stop and reset command to all playback buffers
n@57 390 if (this.status == 1) {
n@57 391 if (this.loopPlayback) {
n@57 392 for (var i=0; i<this.audioObjects.length; i++)
n@57 393 {
n@57 394 this.audioObjects[i].stop();
n@57 395 }
n@57 396 }
n@57 397 this.status = 0;
n@57 398 }
n@57 399 };
n@57 400
n@57 401 audioEngineContext.selectedTrack = function(id) {
n@57 402 for (var i=0; i<this.audioObjects.length; i++)
n@57 403 {
n@97 404 this.audioObjects[i].outputGain.gain.value = 0.0;
n@97 405 this.audioObjects[i].stop();
n@57 406 }
n@97 407 this.audioObjects[id].outputGain.gain.value = 1.0;
n@97 408 this.audioObjects[id].play(audioContext.currentTime+0.01);
n@57 409 };
n@57 410 }
n@57 411
n@46 412 currentTestHolder = document.createElement('audioHolder');
n@46 413 currentTestHolder.id = textXML.id;
n@46 414 currentTestHolder.repeatCount = textXML.attributes['repeatCount'].value;
n@46 415 var currentPreTestHolder = document.createElement('preTest');
n@46 416 var currentPostTestHolder = document.createElement('postTest');
n@46 417 currentTestHolder.appendChild(currentPreTestHolder);
n@46 418 currentTestHolder.appendChild(currentPostTestHolder);
n@46 419
n@45 420 var randomise = textXML.attributes['randomiseOrder'];
n@45 421 if (randomise != undefined) {randomise = randomise.value;}
n@45 422 else {randomise = false;}
n@45 423
n@34 424 var audioElements = $(textXML).find('audioElements');
nicholas@58 425 currentTrackOrder = [];
n@34 426 audioElements.each(function(index,element){
n@45 427 // Find any blind-repeats
n@45 428 // Not implemented yet, but just incase
n@45 429 currentTrackOrder[index] = element;
n@45 430 });
n@45 431 if (randomise) {
n@54 432 currentTrackOrder = randomiseOrder(currentTrackOrder);
n@45 433 }
n@45 434
nicholas@58 435 // Delete any previous audioObjects associated with the audioEngine
nicholas@58 436 audioEngineContext.audioObjects = [];
nicholas@58 437
n@45 438 // Find all the audioElements from the audioHolder
n@45 439 $(currentTrackOrder).each(function(index,element){
n@34 440 // Find URL of track
n@34 441 // In this jQuery loop, variable 'this' holds the current audioElement.
n@34 442
n@34 443 // Now load each audio sample. First create the new track by passing the full URL
n@34 444 var trackURL = hostURL + this.attributes['url'].value;
n@34 445 audioEngineContext.newTrack(trackURL);
nicholas@66 446
nicholas@66 447 if (commentShow) {
nicholas@66 448 // Create document objects to hold the comment boxes
nicholas@66 449 var trackComment = document.createElement('div');
nicholas@66 450 trackComment.className = 'comment-div';
nicholas@66 451 // Create a string next to each comment asking for a comment
nicholas@66 452 var trackString = document.createElement('span');
nicholas@66 453 trackString.innerHTML = 'Comment on track '+index;
nicholas@66 454 // Create the HTML5 comment box 'textarea'
nicholas@66 455 var trackCommentBox = document.createElement('textarea');
nicholas@66 456 trackCommentBox.rows = '4';
nicholas@66 457 trackCommentBox.cols = '100';
nicholas@66 458 trackCommentBox.name = 'trackComment'+index;
nicholas@66 459 trackCommentBox.className = 'trackComment';
nicholas@66 460 var br = document.createElement('br');
nicholas@66 461 // Add to the holder.
nicholas@66 462 trackComment.appendChild(trackString);
nicholas@66 463 trackComment.appendChild(br);
nicholas@66 464 trackComment.appendChild(trackCommentBox);
nicholas@66 465 feedbackHolder.appendChild(trackComment);
nicholas@66 466 }
n@34 467
n@34 468 // Create a slider per track
n@34 469
n@34 470 var trackSliderObj = document.createElement('div');
n@34 471 trackSliderObj.className = 'track-slider';
n@34 472 trackSliderObj.id = 'track-slider-'+index;
n@34 473 // Distribute it randomnly
n@34 474 var w = window.innerWidth - 100;
n@34 475 w = Math.random()*w;
n@34 476 trackSliderObj.style.left = Math.floor(w)+50+'px';
n@34 477 trackSliderObj.innerHTML = '<span>'+index+'</span>';
n@34 478 trackSliderObj.draggable = true;
n@34 479 trackSliderObj.ondragend = dragEnd;
n@49 480 trackSliderObj.ondragstart = function()
n@49 481 {
n@49 482 var id = Number(this.id.substr(13,2)); // Maximum theoretical tracks is 99!
n@49 483 audioEngineContext.metric.sliderMoveStart(id);
n@49 484 };
n@34 485
n@34 486 // Onclick, switch playback to that track
n@34 487 trackSliderObj.onclick = function() {
n@34 488 // Get the track ID from the object ID
n@34 489 var id = Number(this.id.substr(13,2)); // Maximum theoretical tracks is 99!
n@49 490 audioEngineContext.metric.sliderPlayed(id);
n@34 491 audioEngineContext.selectedTrack(id);
n@34 492 };
n@34 493
n@34 494 canvas.appendChild(trackSliderObj);
n@34 495 });
n@39 496
nicholas@65 497 // Append any commentQuestion boxes
nicholas@65 498 var commentQuestions = $(textXML).find('CommentQuestion');
nicholas@65 499 $(commentQuestions).each(function(index,element) {
nicholas@65 500 // Create document objects to hold the comment boxes
nicholas@65 501 var trackComment = document.createElement('div');
nicholas@65 502 trackComment.className = 'comment-div commentQuestion';
nicholas@65 503 trackComment.id = element.attributes['id'].value;
nicholas@65 504 // Create a string next to each comment asking for a comment
nicholas@65 505 var trackString = document.createElement('span');
nicholas@65 506 trackString.innerHTML = element.textContent;
nicholas@65 507 // Create the HTML5 comment box 'textarea'
nicholas@65 508 var trackCommentBox = document.createElement('textarea');
nicholas@65 509 trackCommentBox.rows = '4';
nicholas@65 510 trackCommentBox.cols = '100';
nicholas@65 511 trackCommentBox.name = 'commentQuestion'+index;
nicholas@65 512 trackCommentBox.className = 'trackComment';
nicholas@65 513 var br = document.createElement('br');
nicholas@65 514 // Add to the holder.
nicholas@65 515 trackComment.appendChild(trackString);
nicholas@65 516 trackComment.appendChild(br);
nicholas@65 517 trackComment.appendChild(trackCommentBox);
nicholas@65 518 feedbackHolder.appendChild(trackComment);
nicholas@65 519 });
nicholas@65 520
n@39 521 // Now process any pre-test commands
n@39 522
n@44 523 var preTest = $(testXMLSetups[id]).find('PreTest')[0];
n@39 524 if (preTest.children.length > 0)
n@39 525 {
n@39 526 currentState = 'testRunPre-'+id;
n@39 527 preTestPopupStart(preTest);
n@39 528 showPopup();
n@39 529 } else {
n@39 530 currentState = 'testRun-'+id;
n@39 531 }
n@39 532 }
n@39 533
n@39 534 function preTestPopupStart(preTest)
n@39 535 {
n@39 536 var popupHolder = document.getElementById('popupHolder');
n@39 537 popupHolder.innerHTML = null;
n@39 538 // Parse the first box
n@39 539 var preTestOption = document.createElement('div');
n@39 540 preTestOption.id = 'preTest';
n@39 541 preTestOption.style.marginTop = '25px';
n@39 542 preTestOption.align = "center";
n@39 543 var child = preTest.children[0];
n@39 544 if (child.nodeName == 'statement')
n@39 545 {
n@39 546 preTestOption.innerHTML = '<span>'+child.innerHTML+'</span>';
n@39 547 } else if (child.nodeName == 'question')
n@39 548 {
n@39 549 var questionId = child.attributes['id'].value;
n@39 550 var textHold = document.createElement('span');
n@39 551 textHold.innerHTML = child.innerHTML;
n@39 552 textHold.id = questionId + 'response';
n@39 553 var textEnter = document.createElement('textarea');
n@39 554 preTestOption.appendChild(textHold);
n@39 555 preTestOption.appendChild(textEnter);
n@39 556 }
n@39 557 var nextButton = document.createElement('button');
n@39 558 nextButton.className = 'popupButton';
n@39 559 nextButton.value = '0';
n@39 560 nextButton.innerHTML = 'Next';
n@39 561 nextButton.onclick = popupButtonClick;
n@39 562
n@39 563 popupHolder.appendChild(preTestOption);
n@39 564 popupHolder.appendChild(nextButton);
n@34 565 }
n@34 566
n@38 567 function popupButtonClick()
n@38 568 {
n@38 569 // Global call from the 'Next' button click
n@38 570 if (currentState == 'preTest')
n@38 571 {
n@38 572 // At the start of the preTest routine!
n@39 573 var xmlTree = projectXML.find('setup');
n@39 574 var preTest = xmlTree.find('PreTest')[0];
n@39 575 this.value = preTestButtonClick(preTest,this.value);
n@39 576 } else if (currentState.substr(0,10) == 'testRunPre')
n@39 577 {
n@39 578 //Specific test pre-test
n@39 579 var testId = currentState.substr(11,currentState.length-10);
n@44 580 var preTest = $(testXMLSetups[testId]).find('PreTest')[0];
n@39 581 this.value = preTestButtonClick(preTest,this.value);
n@42 582 } else if (currentState.substr(0,11) == 'testRunPost')
n@42 583 {
n@42 584 // Specific test post-test
n@42 585 var testId = currentState.substr(12,currentState.length-11);
n@44 586 var preTest = $(testXMLSetups[testId]).find('PostTest')[0];
n@42 587 this.value = preTestButtonClick(preTest,this.value);
n@41 588 } else if (currentState == 'postTest')
n@41 589 {
n@41 590 // At the end of the test, running global post test
n@41 591 var xmlTree = projectXML.find('setup');
n@41 592 var PostTest = xmlTree.find('PostTest')[0];
n@41 593 this.value = preTestButtonClick(PostTest,this.value);
n@38 594 }
n@38 595 }
n@38 596
n@39 597 function preTestButtonClick(preTest,index)
n@34 598 {
n@34 599 // Called on click of pre-test button
n@36 600 // Need to find and parse preTest again!
n@36 601 var preTestOption = document.getElementById('preTest');
n@36 602 // Check if current state is a question!
n@38 603 if (preTest.children[index].nodeName == 'question') {
n@38 604 var questionId = preTest.children[index].attributes['id'].value;
n@36 605 var questionHold = document.createElement('comment');
n@36 606 var questionResponse = document.getElementById(questionId + 'response');
nicholas@64 607 var mandatory = preTest.children[index].attributes['mandatory'];
nicholas@64 608 if (mandatory != undefined){
nicholas@64 609 if (mandatory.value == 'true') {mandatory = true;}
nicholas@64 610 else {mandatory = false;}
nicholas@64 611 } else {mandatory = false;}
nicholas@64 612 if (mandatory == true && questionResponse.value.length == 0) {
nicholas@64 613 return index;
nicholas@64 614 }
n@36 615 questionHold.id = questionId;
n@36 616 questionHold.innerHTML = questionResponse.value;
n@46 617 postPopupResponse(questionHold);
n@36 618 }
n@38 619 index++;
n@38 620 if (index < preTest.children.length)
n@36 621 {
n@36 622 // More to process
n@38 623 var child = preTest.children[index];
n@36 624 if (child.nodeName == 'statement')
n@36 625 {
n@36 626 preTestOption.innerHTML = '<span>'+child.innerHTML+'</span>';
n@36 627 } else if (child.nodeName == 'question')
n@36 628 {
n@36 629 var textHold = document.createElement('span');
n@36 630 textHold.innerHTML = child.innerHTML;
n@36 631 var textEnter = document.createElement('textarea');
n@36 632 textEnter.id = child.attributes['id'].value + 'response';
n@36 633 var br = document.createElement('br');
n@36 634 preTestOption.innerHTML = null;
n@36 635 preTestOption.appendChild(textHold);
n@36 636 preTestOption.appendChild(br);
n@36 637 preTestOption.appendChild(textEnter);
n@36 638 }
n@36 639 } else {
n@36 640 // Time to clear
n@37 641 preTestOption.innerHTML = null;
n@43 642 if (currentState != 'postTest') {
n@43 643 hidePopup();
n@43 644 // Progress the state!
n@43 645 advanceState();
n@43 646 } else {
n@43 647 a = createProjectSave(projectReturn);
n@43 648 preTestOption.appendChild(a);
n@43 649 }
n@36 650 }
n@38 651 return index;
n@36 652 }
n@36 653
n@46 654 function postPopupResponse(response)
n@46 655 {
n@46 656 if (currentState == 'preTest') {
n@46 657 preTestQuestions.appendChild(response);
n@46 658 } else if (currentState == 'postTest') {
n@46 659 postTestQuestions.appendChild(response);
n@46 660 } else {
n@46 661 // Inside a specific test
n@46 662 if (currentState.substr(0,10) == 'testRunPre') {
n@46 663 // Pre Test
n@46 664 var store = $(currentTestHolder).find('preTest');
n@46 665 } else {
n@46 666 // Post Test
n@46 667 var store = $(currentTestHolder).find('postTest');
n@46 668 }
n@46 669 store[0].appendChild(response);
n@46 670 }
n@46 671 }
n@46 672
n@36 673 function showPopup()
n@36 674 {
n@37 675 var popupHolder = document.getElementById('popupHolder');
n@38 676 popupHolder.style.zIndex = 3;
n@37 677 popupHolder.style.visibility = 'visible';
n@37 678 var blank = document.getElementsByClassName('testHalt')[0];
n@37 679 blank.style.zIndex = 2;
n@37 680 blank.style.visibility = 'visible';
n@36 681 }
n@36 682
n@36 683 function hidePopup()
n@36 684 {
n@37 685 var popupHolder = document.getElementById('popupHolder');
n@37 686 popupHolder.style.zIndex = -1;
n@37 687 popupHolder.style.visibility = 'hidden';
n@37 688 var blank = document.getElementsByClassName('testHalt')[0];
n@37 689 blank.style.zIndex = -2;
n@37 690 blank.style.visibility = 'hidden';
n@34 691 }
n@34 692
nicholas@5 693 function dragEnd(ev) {
nicholas@5 694 // Function call when a div has been dropped
n@33 695 var slider = document.getElementById('slider');
n@51 696 var w = slider.style.width;
n@51 697 w = Number(w.substr(0,w.length-2));
n@51 698 var x = ev.x;
n@51 699 if (x >= 42 && x < w+42) {
n@51 700 this.style.left = (x)+'px';
nicholas@5 701 } else {
n@51 702 if (x<42) {
n@51 703 this.style.left = '42px';
nicholas@5 704 } else {
n@51 705 this.style.left = (w+42) + 'px';
nicholas@5 706 }
nicholas@5 707 }
n@49 708 audioEngineContext.metric.sliderMoved();
nicholas@5 709 }
nicholas@7 710
n@39 711 function advanceState()
n@39 712 {
n@39 713 console.log(currentState);
n@39 714 if (currentState == 'preTest')
n@39 715 {
n@39 716 // End of pre-test, begin the test
n@39 717 loadTest(0);
n@39 718 } else if (currentState.substr(0,10) == 'testRunPre')
n@39 719 {
n@39 720 // Start the test
n@39 721 var testId = currentState.substr(11,currentState.length-10);
n@39 722 currentState = 'testRun-'+testId;
n@42 723 } else if (currentState.substr(0,11) == 'testRunPost')
n@42 724 {
n@44 725 var testId = currentState.substr(12,currentState.length-11);
n@42 726 testEnded(testId);
n@40 727 } else if (currentState.substr(0,7) == 'testRun')
n@40 728 {
n@40 729 var testId = currentState.substr(8,currentState.length-7);
n@40 730 // Check if we have any post tests to perform
n@44 731 var postXML = $(testXMLSetups[testId]).find('PostTest')[0];
nicholas@69 732 if (postXML == undefined) {
nicholas@69 733 testEnded(testId);
nicholas@69 734 }
nicholas@69 735 else if (postXML.children.length > 0)
n@40 736 {
n@42 737 currentState = 'testRunPost-'+testId;
n@42 738 showPopup();
n@42 739 preTestPopupStart(postXML);
n@40 740 }
n@42 741 else {
n@40 742
n@40 743
n@42 744 // No post tests, check if we have another test to perform instead
nicholas@69 745
n@40 746 }
n@39 747 }
n@39 748 console.log(currentState);
n@39 749 }
n@39 750
n@42 751 function testEnded(testId)
n@42 752 {
n@45 753 pageXMLSave(testId);
n@42 754 if (testXMLSetups.length-1 > testId)
n@42 755 {
n@42 756 // Yes we have another test to perform
n@44 757 testId = (Number(testId)+1);
n@44 758 currentState = 'testRun-'+testId;
n@44 759 loadTest(testId);
n@42 760 } else {
n@42 761 console.log('Testing Completed!');
n@42 762 currentState = 'postTest';
n@42 763 // Check for any post tests
n@42 764 var xmlSetup = projectXML.find('setup');
n@42 765 var postTest = xmlSetup.find('PostTest')[0];
n@42 766 showPopup();
n@42 767 preTestPopupStart(postTest);
n@42 768 }
n@42 769 }
n@42 770
n@40 771 function buttonSubmitClick()
n@40 772 {
n@49 773 if (audioEngineContext.status == 1) {
n@49 774 var playback = document.getElementById('playback-button');
n@49 775 playback.click();
n@40 776 // This function is called when the submit button is clicked. Will check for any further tests to perform, or any post-test options
n@55 777 } else
n@55 778 {
n@55 779 if (audioEngineContext.timer.testStarted == false)
n@55 780 {
n@55 781 alert('You have not started the test! Please press start to begin the test!');
n@55 782 return;
n@55 783 }
n@49 784 }
n@40 785 if (currentState.substr(0,7) == 'testRun')
n@40 786 {
n@49 787 audioEngineContext.timer.stopTest();
n@40 788 advanceState();
n@40 789 }
n@40 790 }
n@40 791
n@51 792 function convSliderPosToRate(id)
n@51 793 {
n@51 794 var w = document.getElementById('slider').style.width;
n@51 795 var maxPix = w.substr(0,w.length-2);
n@51 796 var slider = document.getElementsByClassName('track-slider')[id];
n@51 797 var pix = slider.style.left;
n@51 798 pix = pix.substr(0,pix.length-2);
n@51 799 var rate = (pix-42)/maxPix;
n@51 800 return rate;
n@51 801 }
n@51 802
n@44 803 function pageXMLSave(testId)
n@44 804 {
n@44 805 // Saves a specific test page
n@46 806 var xmlDoc = currentTestHolder;
n@50 807 // Check if any session wide metrics are enabled
nicholas@67 808
nicholas@67 809 var commentShow = testXMLSetups[testId].attributes['elementComments'];
nicholas@67 810 if (commentShow != undefined) {
nicholas@67 811 if (commentShow.value == 'false') {commentShow = false;}
nicholas@67 812 else {commentShow = true;}
nicholas@67 813 } else {commentShow = true;}
nicholas@67 814
n@50 815 var metric = document.createElement('metric');
n@50 816 if (audioEngineContext.metric.enableTestTimer)
n@50 817 {
n@50 818 var testTime = document.createElement('metricResult');
n@50 819 testTime.id = 'testTime';
n@50 820 testTime.textContent = audioEngineContext.timer.testDuration;
n@50 821 metric.appendChild(testTime);
n@50 822 }
n@50 823 xmlDoc.appendChild(metric);
n@45 824 var trackSliderObjects = document.getElementsByClassName('track-slider');
n@45 825 var commentObjects = document.getElementsByClassName('comment-div');
n@45 826 for (var i=0; i<trackSliderObjects.length; i++)
n@45 827 {
n@45 828 var audioElement = document.createElement('audioElement');
n@45 829 audioElement.id = currentTrackOrder[i].attributes['id'].value;
n@45 830 audioElement.url = currentTrackOrder[i].attributes['url'].value;
n@51 831 var value = document.createElement('value');
n@51 832 value.innerHTML = convSliderPosToRate(i);
nicholas@67 833 if (commentShow) {
nicholas@67 834 var comment = document.createElement("comment");
nicholas@67 835 var question = document.createElement("question");
nicholas@67 836 var response = document.createElement("response");
nicholas@67 837 question.textContent = commentObjects[i].children[0].textContent;
nicholas@67 838 response.textContent = commentObjects[i].children[2].value;
nicholas@67 839 comment.appendChild(question);
nicholas@67 840 comment.appendChild(response);
nicholas@67 841 audioElement.appendChild(comment);
nicholas@67 842 }
n@45 843 audioElement.appendChild(value);
n@50 844 // Check for any per element metrics
n@50 845 var metric = document.createElement('metric');
n@50 846 var elementMetric = audioEngineContext.audioObjects[i].metric;
n@50 847 if (audioEngineContext.metric.enableElementTimer) {
n@50 848 var elementTimer = document.createElement('metricResult');
n@50 849 elementTimer.id = 'elementTimer';
n@50 850 elementTimer.textContent = elementMetric.listenedTimer;
n@50 851 metric.appendChild(elementTimer);
n@50 852 }
n@50 853 if (audioEngineContext.metric.enableElementTracker) {
n@50 854 var elementTrackerFull = document.createElement('metricResult');
n@50 855 elementTrackerFull.id = 'elementTrackerFull';
n@50 856 var data = elementMetric.movementTracker;
n@50 857 for (var k=0; k<data.length; k++)
n@50 858 {
n@50 859 var timePos = document.createElement('timePos');
n@50 860 timePos.id = k;
n@50 861 var time = document.createElement('time');
n@50 862 time.textContent = data[k][0];
n@50 863 var position = document.createElement('position');
n@50 864 position.textContent = data[k][1];
n@50 865 timePos.appendChild(time);
n@50 866 timePos.appendChild(position);
n@50 867 elementTrackerFull.appendChild(timePos);
n@50 868 }
n@50 869 metric.appendChild(elementTrackerFull);
n@50 870 }
n@50 871 if (audioEngineContext.metric.enableElementInitialPosition) {
n@50 872 var elementInitial = document.createElement('metricResult');
n@50 873 elementInitial.id = 'elementInitialPosition';
n@50 874 elementInitial.textContent = elementMetric.initialPosition;
n@50 875 metric.appendChild(elementInitial);
n@50 876 }
n@50 877 if (audioEngineContext.metric.enableFlagListenedTo) {
n@50 878 var flagListenedTo = document.createElement('metricResult');
n@50 879 flagListenedTo.id = 'elementFlagListenedTo';
n@50 880 flagListenedTo.textContent = elementMetric.wasListenedTo;
n@50 881 metric.appendChild(flagListenedTo);
n@50 882 }
n@50 883 if (audioEngineContext.metric.enableFlagMoved) {
n@50 884 var flagMoved = document.createElement('metricResult');
n@50 885 flagMoved.id = 'elementFlagMoved';
n@50 886 flagMoved.textContent = elementMetric.wasMoved;
n@50 887 metric.appendChild(flagMoved);
n@50 888 }
n@50 889 if (audioEngineContext.metric.enableFlagComments) {
n@50 890 var flagComments = document.createElement('metricResult');
n@50 891 flagComments.id = 'elementFlagComments';
n@50 892 if (response.textContent.length == 0) {flag.textContent = 'false';}
n@50 893 else {flag.textContet = 'true';}
n@50 894 metric.appendChild(flagComments);
n@50 895 }
n@50 896 audioElement.appendChild(metric);
n@45 897 xmlDoc.appendChild(audioElement);
n@45 898 }
nicholas@65 899 var commentQuestion = document.getElementsByClassName('commentQuestion');
nicholas@65 900 for (var i=0; i<commentQuestion.length; i++)
nicholas@65 901 {
nicholas@65 902 var cqHolder = document.createElement('CommentQuestion');
nicholas@65 903 var comment = document.createElement('comment');
nicholas@65 904 var question = document.createElement('question');
nicholas@65 905 cqHolder.id = commentQuestion[i].id;
nicholas@65 906 comment.textContent = commentQuestion[i].children[2].value;
nicholas@65 907 question.textContent = commentQuestion[i].children[0].textContent;
nicholas@65 908 cqHolder.appendChild(question);
nicholas@65 909 cqHolder.appendChild(comment);
nicholas@65 910 xmlDoc.appendChild(cqHolder);
nicholas@65 911 }
n@45 912 testResultsHolders[testId] = xmlDoc;
n@44 913 }
n@44 914
nicholas@7 915 // Only other global function which must be defined in the interface class. Determines how to create the XML document.
nicholas@7 916 function interfaceXMLSave(){
nicholas@7 917 // Create the XML string to be exported with results
nicholas@7 918 var xmlDoc = document.createElement("BrowserEvaluationResult");
n@45 919 for (var i=0; i<testResultsHolders.length; i++)
nicholas@7 920 {
n@45 921 xmlDoc.appendChild(testResultsHolders[i]);
nicholas@7 922 }
n@23 923 // Append Pre/Post Questions
n@23 924 xmlDoc.appendChild(preTestQuestions);
n@23 925 xmlDoc.appendChild(postTestQuestions);
n@23 926
nicholas@7 927 return xmlDoc;
nicholas@67 928 }