annotate ape.js @ 1633:29fafd5c2f92

Bug #1235: Slider, slider objects and scale markings are adjusted on window resize.
author Nicholas Jillings <nickjillings@users.noreply.github.com>
date Wed, 27 May 2015 11:49:20 +0100
parents 7c4b0de2d085
children 9c09cb530ec1
rev   line source
b@1608 1 /**
b@1608 2 * ape.js
b@1608 3 * Create the APE interface
b@1608 4 */
b@1608 5
b@1608 6 // preTest - In preTest state
b@1608 7 // testRun-ID - In test running, test Id number at the end 'testRun-2'
b@1608 8 // testRunPost-ID - Post test of test ID
b@1608 9 // testRunPre-ID - Pre-test of test ID
b@1608 10 // postTest - End of test, final submission!
b@1608 11
b@1608 12
b@1608 13 // Once this is loaded and parsed, begin execution
b@1608 14 loadInterface(projectXML);
b@1608 15
b@1608 16 function loadInterface(xmlDoc) {
b@1608 17
b@1608 18 // Get the dimensions of the screen available to the page
b@1608 19 var width = window.innerWidth;
b@1608 20 var height = window.innerHeight;
b@1608 21
b@1608 22 // The injection point into the HTML page
b@1608 23 var insertPoint = document.getElementById("topLevelBody");
b@1608 24 var testContent = document.createElement('div');
b@1608 25 testContent.id = 'testContent';
b@1608 26
b@1608 27
b@1608 28 // Decode parts of the xmlDoc that are needed
b@1608 29 // xmlDoc MUST already be parsed by jQuery!
b@1608 30 var xmlSetup = xmlDoc.find('setup');
b@1608 31 // Should put in an error function here incase of malprocessed or malformed XML
b@1608 32
b@1608 33 // Extract the different test XML DOM trees
b@1608 34 var audioHolders = xmlDoc.find('audioHolder');
b@1608 35 audioHolders.each(function(index,element) {
b@1608 36 var repeatN = element.attributes['repeatCount'].value;
b@1608 37 for (var r=0; r<=repeatN; r++) {
b@1608 38 testXMLSetups[testXMLSetups.length] = element;
b@1608 39 }
b@1608 40 });
b@1608 41
b@1608 42 // New check if we need to randomise the test order
b@1608 43 var randomise = xmlSetup[0].attributes['randomiseOrder'];
b@1608 44 if (randomise != undefined) {
nickjillings@1616 45 if (randomise.value === 'true'){
nickjillings@1616 46 randomise = true;
nickjillings@1616 47 } else {
nickjillings@1616 48 randomise = false;
nickjillings@1616 49 }
b@1608 50 } else {
b@1608 51 randomise = false;
b@1608 52 }
nickjillings@1616 53
b@1608 54 if (randomise)
b@1608 55 {
b@1608 56 testXMLSetups = randomiseOrder(testXMLSetups);
b@1608 57 }
b@1608 58
b@1608 59 // Obtain the metrics enabled
b@1608 60 var metricNode = xmlSetup.find('Metric');
b@1608 61 var metricNode = metricNode.find('metricEnable');
b@1608 62 metricNode.each(function(index,node){
b@1608 63 var enabled = node.textContent;
b@1608 64 switch(enabled)
b@1608 65 {
b@1608 66 case 'testTimer':
b@1608 67 sessionMetrics.prototype.enableTestTimer = true;
b@1608 68 break;
b@1608 69 case 'elementTimer':
b@1608 70 sessionMetrics.prototype.enableElementTimer = true;
b@1608 71 break;
b@1608 72 case 'elementTracker':
b@1608 73 sessionMetrics.prototype.enableElementTracker = true;
b@1608 74 break;
b@1608 75 case 'elementInitalPosition':
b@1608 76 sessionMetrics.prototype.enableElementInitialPosition = true;
b@1608 77 break;
b@1608 78 case 'elementFlagListenedTo':
b@1608 79 sessionMetrics.prototype.enableFlagListenedTo = true;
b@1608 80 break;
b@1608 81 case 'elementFlagMoved':
b@1608 82 sessionMetrics.prototype.enableFlagMoved = true;
b@1608 83 break;
b@1608 84 case 'elementFlagComments':
b@1608 85 sessionMetrics.prototype.enableFlagComments = true;
b@1608 86 break;
b@1608 87 }
b@1608 88 });
b@1608 89
b@1608 90 // Create APE specific metric functions
b@1608 91 audioEngineContext.metric.initialiseTest = function()
b@1608 92 {
b@1608 93 var sliders = document.getElementsByClassName('track-slider');
b@1608 94 for (var i=0; i<sliders.length; i++)
b@1608 95 {
b@1608 96 audioEngineContext.audioObjects[i].metric.initialised(convSliderPosToRate(i));
b@1608 97 }
b@1608 98 };
b@1608 99
b@1608 100 audioEngineContext.metric.sliderMoveStart = function(id)
b@1608 101 {
b@1608 102 if (this.data == -1)
b@1608 103 {
b@1608 104 this.data = id;
b@1608 105 } else {
b@1608 106 console.log('ERROR: Metric tracker detecting two moves!');
b@1608 107 this.data = -1;
b@1608 108 }
b@1608 109 };
b@1608 110 audioEngineContext.metric.sliderMoved = function()
b@1608 111 {
b@1608 112 var time = audioEngineContext.timer.getTestTime();
b@1608 113 var id = this.data;
b@1608 114 this.data = -1;
b@1608 115 var position = convSliderPosToRate(id);
b@1606 116 console.log('slider ' + id + ': '+ position + ' (' + time + ')'); // DEBUG/SAFETY: show position and slider id
b@1608 117 if (audioEngineContext.timer.testStarted)
b@1608 118 {
b@1608 119 audioEngineContext.audioObjects[id].metric.moved(time,position);
b@1608 120 }
b@1608 121 };
b@1608 122
b@1608 123 audioEngineContext.metric.sliderPlayed = function(id)
b@1608 124 {
b@1608 125 var time = audioEngineContext.timer.getTestTime();
b@1608 126 if (audioEngineContext.timer.testStarted)
b@1608 127 {
b@1608 128 if (this.lastClicked >= 0)
b@1608 129 {
b@1608 130 audioEngineContext.audioObjects[this.lastClicked].metric.listening(time);
b@1608 131 }
b@1608 132 this.lastClicked = id;
b@1608 133 audioEngineContext.audioObjects[id].metric.listening(time);
b@1608 134 }
b@1606 135 console.log('slider ' + id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id
b@1608 136 };
b@1608 137
b@1608 138 // Create the top div for the Title element
b@1608 139 var titleAttr = xmlSetup[0].attributes['title'];
b@1608 140 var title = document.createElement('div');
b@1608 141 title.className = "title";
b@1608 142 title.align = "center";
b@1608 143 var titleSpan = document.createElement('span');
b@1608 144
b@1608 145 // Set title to that defined in XML, else set to default
b@1608 146 if (titleAttr != undefined) {
b@1608 147 titleSpan.innerHTML = titleAttr.value;
b@1608 148 } else {
b@1608 149 titleSpan.innerHTML = 'Listening test';
b@1608 150 }
b@1608 151 // Insert the titleSpan element into the title div element.
b@1608 152 title.appendChild(titleSpan);
b@1608 153
b@1608 154 var pagetitle = document.createElement('div');
b@1608 155 pagetitle.className = "pageTitle";
b@1608 156 pagetitle.align = "center";
b@1608 157 var titleSpan = document.createElement('span');
b@1608 158 titleSpan.id = "pageTitle";
b@1608 159 pagetitle.appendChild(titleSpan);
b@1608 160
b@1608 161 // Store the return URL path in global projectReturn
b@1608 162 projectReturn = xmlSetup[0].attributes['projectReturn'].value;
b@1608 163
b@1608 164 // Create Interface buttons!
b@1608 165 var interfaceButtons = document.createElement('div');
b@1608 166 interfaceButtons.id = 'interface-buttons';
b@1608 167
b@1608 168 // MANUAL DOWNLOAD POINT
b@1608 169 // If project return is null, this MUST be specified as the location to create the download link
b@1608 170 var downloadPoint = document.createElement('div');
b@1608 171 downloadPoint.id = 'download-point';
b@1608 172
b@1608 173 // Create playback start/stop points
b@1608 174 var playback = document.createElement("button");
b@1609 175 playback.innerHTML = 'Stop';
b@1608 176 playback.id = 'playback-button';
b@1608 177 // onclick function. Check if it is playing or not, call the correct function in the
b@1608 178 // audioEngine, change the button text to reflect the next state.
b@1608 179 playback.onclick = function() {
b@1609 180 if (audioEngineContext.status == 1) {
b@1609 181 audioEngineContext.stop();
b@1608 182 this.innerHTML = 'Stop';
b@1606 183 var time = audioEngineContext.timer.getTestTime();
b@1606 184 console.log('Stopped at ' + time); // DEBUG/SAFETY
b@1608 185 }
b@1608 186 };
b@1608 187 // Create Submit (save) button
b@1608 188 var submit = document.createElement("button");
b@1608 189 submit.innerHTML = 'Submit';
b@1608 190 submit.onclick = buttonSubmitClick;
b@1608 191 submit.id = 'submit-button';
b@1608 192 // Append the interface buttons into the interfaceButtons object.
b@1608 193 interfaceButtons.appendChild(playback);
b@1608 194 interfaceButtons.appendChild(submit);
b@1608 195 interfaceButtons.appendChild(downloadPoint);
b@1608 196
b@1608 197 // Now create the slider and HTML5 canvas boxes
b@1608 198
b@1608 199 // Create the div box to center align
b@1608 200 var sliderBox = document.createElement('div');
b@1608 201 sliderBox.className = 'sliderCanvasDiv';
b@1608 202 sliderBox.id = 'sliderCanvasHolder';
b@1608 203
b@1608 204 // Create the slider box to hold the slider elements
b@1608 205 var canvas = document.createElement('div');
b@1608 206 canvas.id = 'slider';
nickjillings@1633 207 canvas.align = "left";
nickjillings@1633 208 canvas.addEventListener('dragover',function(event){
nickjillings@1633 209 event.preventDefault();
nickjillings@1633 210 return false;
nickjillings@1633 211 },false);
nickjillings@1633 212 var sliderMargin = document.createAttribute('marginsize');
nickjillings@1633 213 sliderMargin.nodeValue = 42; // Set default margins to 42px either side
b@1608 214 // Must have a known EXACT width, as this is used later to determine the ratings
nickjillings@1633 215 var w = (Number(sliderMargin.nodeValue)+8)*2;
nickjillings@1633 216 canvas.style.width = width - w +"px";
nickjillings@1633 217 canvas.style.marginLeft = sliderMargin.nodeValue +'px';
nickjillings@1633 218 canvas.setAttributeNode(sliderMargin);
b@1608 219 sliderBox.appendChild(canvas);
b@1608 220
b@1608 221 // Create the div to hold any scale objects
b@1608 222 var scale = document.createElement('div');
b@1608 223 scale.className = 'sliderScale';
b@1608 224 scale.id = 'sliderScaleHolder';
b@1608 225 scale.align = 'left';
b@1608 226 sliderBox.appendChild(scale);
b@1608 227
b@1608 228 // Global parent for the comment boxes on the page
b@1608 229 var feedbackHolder = document.createElement('div');
b@1608 230 feedbackHolder.id = 'feedbackHolder';
b@1608 231
b@1608 232 testContent.style.zIndex = 1;
b@1608 233 insertPoint.innerHTML = null; // Clear the current schema
b@1608 234
b@1608 235 // Create pre and post test questions
b@1608 236
b@1608 237 var preTest = xmlSetup.find('PreTest');
b@1608 238 var postTest = xmlSetup.find('PostTest');
b@1608 239 preTest = preTest[0];
b@1608 240 postTest = postTest[0];
b@1608 241
b@1608 242 currentState = 'preTest';
b@1608 243
b@1608 244 // Create Pre-Test Box
nickjillings@1612 245 if (preTest != undefined && preTest.childElementCount >= 1)
b@1608 246 {
nickjillings@1622 247 //popup.showPopup();
nickjillings@1622 248 //preTestPopupStart(preTest);
nickjillings@1622 249 popup.initState(preTest);
b@1608 250 }
b@1608 251
b@1608 252 // Inject into HTML
b@1608 253 testContent.appendChild(title); // Insert the title
b@1608 254 testContent.appendChild(pagetitle);
b@1608 255 testContent.appendChild(interfaceButtons);
b@1608 256 testContent.appendChild(sliderBox);
b@1608 257 testContent.appendChild(feedbackHolder);
b@1608 258 insertPoint.appendChild(testContent);
b@1608 259
b@1608 260 // Load the full interface
b@1608 261
b@1608 262 }
b@1608 263
b@1608 264 function loadTest(id)
b@1608 265 {
nickjillings@1617 266
nickjillings@1617 267 // Reset audioEngineContext.Metric globals for new test
nickjillings@1620 268 audioEngineContext.newTestPage();
nickjillings@1617 269
b@1608 270 // Used to load a specific test page
b@1608 271 var textXML = testXMLSetups[id];
b@1608 272
b@1608 273 var feedbackHolder = document.getElementById('feedbackHolder');
b@1608 274 var canvas = document.getElementById('slider');
b@1608 275 feedbackHolder.innerHTML = null;
b@1608 276 canvas.innerHTML = null;
b@1608 277
b@1608 278 // Setup question title
b@1608 279 var interfaceObj = $(textXML).find('interface');
b@1608 280 var titleNode = interfaceObj.find('title');
b@1608 281 if (titleNode[0] != undefined)
b@1608 282 {
b@1608 283 document.getElementById('pageTitle').textContent = titleNode[0].textContent;
b@1608 284 }
b@1608 285 var positionScale = canvas.style.width.substr(0,canvas.style.width.length-2);
nickjillings@1633 286 var offset = Number(document.getElementById('slider').attributes['marginsize'].value);
b@1608 287 var scale = document.getElementById('sliderScaleHolder');
b@1608 288 scale.innerHTML = null;
b@1608 289 interfaceObj.find('scale').each(function(index,scaleObj){
nickjillings@1633 290 var value = document.createAttribute('value');
b@1608 291 var position = Number(scaleObj.attributes['position'].value)*0.01;
nickjillings@1633 292 value.nodeValue = position;
b@1608 293 var pixelPosition = (position*positionScale)+offset;
b@1608 294 var scaleDOM = document.createElement('span');
b@1608 295 scaleDOM.textContent = scaleObj.textContent;
b@1608 296 scale.appendChild(scaleDOM);
b@1608 297 scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px';
nickjillings@1633 298 scaleDOM.setAttributeNode(value);
b@1608 299 });
b@1608 300
b@1608 301 // Extract the hostURL attribute. If not set, create an empty string.
b@1608 302 var hostURL = textXML.attributes['hostURL'];
b@1608 303 if (hostURL == undefined) {
b@1608 304 hostURL = "";
b@1608 305 } else {
b@1608 306 hostURL = hostURL.value;
b@1608 307 }
b@1608 308 // Extract the sampleRate. If set, convert the string to a Number.
b@1608 309 var hostFs = textXML.attributes['sampleRate'];
b@1608 310 if (hostFs != undefined) {
b@1608 311 hostFs = Number(hostFs.value);
b@1608 312 }
b@1608 313
b@1608 314 /// CHECK FOR SAMPLE RATE COMPATIBILITY
b@1608 315 if (hostFs != undefined) {
b@1608 316 if (Number(hostFs) != audioContext.sampleRate) {
b@1608 317 var errStr = 'Sample rates do not match! Requested '+Number(hostFs)+', got '+audioContext.sampleRate+'. Please set the sample rate to match before completing this test.';
b@1608 318 alert(errStr);
b@1608 319 return;
b@1608 320 }
b@1608 321 }
b@1608 322
b@1608 323 var commentShow = textXML.attributes['elementComments'];
b@1608 324 if (commentShow != undefined) {
b@1608 325 if (commentShow.value == 'false') {commentShow = false;}
b@1608 326 else {commentShow = true;}
b@1608 327 } else {commentShow = true;}
b@1608 328
b@1608 329 var loopPlayback = textXML.attributes['loop'];
b@1608 330 if (loopPlayback != undefined)
b@1608 331 {
b@1608 332 loopPlayback = loopPlayback.value;
b@1608 333 if (loopPlayback == 'true') {
b@1608 334 loopPlayback = true;
b@1608 335 } else {
b@1608 336 loopPlayback = false;
b@1608 337 }
b@1608 338 } else {
b@1608 339 loopPlayback = false;
b@1608 340 }
b@1608 341 audioEngineContext.loopPlayback = loopPlayback;
nickjillings@1617 342 loopPlayback = false;
b@1608 343 // Create AudioEngine bindings for playback
b@1608 344 if (loopPlayback) {
b@1608 345 audioEngineContext.selectedTrack = function(id) {
b@1608 346 for (var i=0; i<this.audioObjects.length; i++)
b@1608 347 {
b@1608 348 if (id == i) {
b@1608 349 this.audioObjects[i].outputGain.gain.value = 1.0;
b@1608 350 } else {
b@1608 351 this.audioObjects[i].outputGain.gain.value = 0.0;
b@1608 352 }
b@1608 353 }
b@1608 354 };
b@1608 355 } else {
b@1608 356 audioEngineContext.selectedTrack = function(id) {
b@1608 357 for (var i=0; i<this.audioObjects.length; i++)
b@1608 358 {
b@1607 359 this.audioObjects[i].outputGain.gain.value = 0.0;
b@1607 360 this.audioObjects[i].stop();
b@1607 361 }
b@1607 362 if (this.status == 1) {
b@1607 363 this.audioObjects[id].outputGain.gain.value = 1.0;
b@1607 364 this.audioObjects[id].play(audioContext.currentTime+0.01);
b@1608 365 }
b@1608 366 };
b@1608 367 }
b@1608 368
b@1608 369 currentTestHolder = document.createElement('audioHolder');
b@1608 370 currentTestHolder.id = textXML.id;
b@1608 371 currentTestHolder.repeatCount = textXML.attributes['repeatCount'].value;
b@1608 372
b@1608 373 var randomise = textXML.attributes['randomiseOrder'];
b@1608 374 if (randomise != undefined) {randomise = randomise.value;}
b@1608 375 else {randomise = false;}
b@1608 376
b@1608 377 var audioElements = $(textXML).find('audioElements');
b@1608 378 currentTrackOrder = [];
b@1608 379 audioElements.each(function(index,element){
b@1608 380 // Find any blind-repeats
b@1608 381 // Not implemented yet, but just in case
b@1608 382 currentTrackOrder[index] = element;
b@1608 383 });
b@1608 384 if (randomise) {
b@1608 385 currentTrackOrder = randomiseOrder(currentTrackOrder);
b@1608 386 }
b@1608 387
b@1608 388 // Delete any previous audioObjects associated with the audioEngine
b@1608 389 audioEngineContext.audioObjects = [];
b@1608 390
b@1608 391 // Find all the audioElements from the audioHolder
b@1608 392 $(currentTrackOrder).each(function(index,element){
b@1608 393 // Find URL of track
b@1608 394 // In this jQuery loop, variable 'this' holds the current audioElement.
b@1608 395
b@1608 396 // Now load each audio sample. First create the new track by passing the full URL
b@1608 397 var trackURL = hostURL + this.attributes['url'].value;
b@1608 398 audioEngineContext.newTrack(trackURL);
b@1608 399
b@1608 400 if (commentShow) {
b@1608 401 // Create document objects to hold the comment boxes
b@1608 402 var trackComment = document.createElement('div');
b@1608 403 trackComment.className = 'comment-div';
b@1608 404 // Create a string next to each comment asking for a comment
b@1608 405 var trackString = document.createElement('span');
b@1608 406 trackString.innerHTML = 'Comment on track '+index;
b@1608 407 // Create the HTML5 comment box 'textarea'
b@1608 408 var trackCommentBox = document.createElement('textarea');
b@1608 409 trackCommentBox.rows = '4';
b@1608 410 trackCommentBox.cols = '100';
b@1608 411 trackCommentBox.name = 'trackComment'+index;
b@1608 412 trackCommentBox.className = 'trackComment';
b@1608 413 var br = document.createElement('br');
b@1608 414 // Add to the holder.
b@1608 415 trackComment.appendChild(trackString);
b@1608 416 trackComment.appendChild(br);
b@1608 417 trackComment.appendChild(trackCommentBox);
b@1608 418 feedbackHolder.appendChild(trackComment);
b@1608 419 }
b@1608 420
b@1608 421 // Create a slider per track
b@1608 422
b@1608 423 var trackSliderObj = document.createElement('div');
b@1608 424 trackSliderObj.className = 'track-slider';
b@1608 425 trackSliderObj.id = 'track-slider-'+index;
b@1608 426 // Distribute it randomnly
b@1608 427 var w = window.innerWidth - 100;
b@1608 428 w = Math.random()*w;
b@1608 429 trackSliderObj.style.left = Math.floor(w)+50+'px';
b@1608 430 trackSliderObj.innerHTML = '<span>'+index+'</span>';
b@1608 431 trackSliderObj.draggable = true;
b@1608 432 trackSliderObj.ondragend = dragEnd;
b@1608 433 trackSliderObj.ondragstart = function()
b@1608 434 {
b@1608 435 var id = Number(this.id.substr(13,2)); // Maximum theoretical tracks is 99!
b@1608 436 audioEngineContext.metric.sliderMoveStart(id);
b@1608 437 };
b@1608 438
b@1608 439 // Onclick, switch playback to that track
b@1608 440 trackSliderObj.onclick = function() {
nickjillings@1615 441 // Start the test on first click, that way timings are more accurate.
nickjillings@1615 442 audioEngineContext.play();
b@1608 443 // Get the track ID from the object ID
b@1608 444 var id = Number(this.id.substr(13,2)); // Maximum theoretical tracks is 99!
nickjillings@1617 445 //audioEngineContext.metric.sliderPlayed(id);
b@1608 446 audioEngineContext.selectedTrack(id);
b@1608 447 // Currently playing track red, rest green
b@1608 448 document.getElementById('track-slider-'+index).style.backgroundColor = "#FF0000";
b@1608 449 for (var i = 0; i<$(currentTrackOrder).length; i++)
b@1608 450 {
b@1610 451 if (i!=index) // Make all other sliders green
b@1608 452 {
b@1608 453 document.getElementById('track-slider-'+i).style.backgroundColor = "rgb(100,200,100)";
b@1608 454 }
b@1608 455
b@1608 456 }
b@1608 457 };
b@1608 458
b@1608 459 canvas.appendChild(trackSliderObj);
b@1610 460
b@1608 461 });
b@1608 462
b@1608 463 // Append any commentQuestion boxes
b@1608 464 var commentQuestions = $(textXML).find('CommentQuestion');
b@1608 465 $(commentQuestions).each(function(index,element) {
b@1608 466 // Create document objects to hold the comment boxes
b@1608 467 var trackComment = document.createElement('div');
b@1608 468 trackComment.className = 'comment-div commentQuestion';
b@1608 469 trackComment.id = element.attributes['id'].value;
b@1608 470 // Create a string next to each comment asking for a comment
b@1608 471 var trackString = document.createElement('span');
b@1608 472 trackString.innerHTML = element.textContent;
b@1608 473 // Create the HTML5 comment box 'textarea'
b@1608 474 var trackCommentBox = document.createElement('textarea');
b@1608 475 trackCommentBox.rows = '4';
b@1608 476 trackCommentBox.cols = '100';
b@1608 477 trackCommentBox.name = 'commentQuestion'+index;
b@1608 478 trackCommentBox.className = 'trackComment';
b@1608 479 var br = document.createElement('br');
b@1608 480 // Add to the holder.
b@1608 481 trackComment.appendChild(trackString);
b@1608 482 trackComment.appendChild(br);
b@1608 483 trackComment.appendChild(trackCommentBox);
b@1608 484 feedbackHolder.appendChild(trackComment);
b@1608 485 });
b@1608 486
b@1608 487 // Now process any pre-test commands
b@1608 488
b@1608 489 var preTest = $(testXMLSetups[id]).find('PreTest')[0];
nickjillings@1612 490 if (preTest.childElementCount > 0)
b@1608 491 {
b@1608 492 currentState = 'testRunPre-'+id;
nickjillings@1622 493 //preTestPopupStart(preTest);
nickjillings@1622 494 popup.initState(preTest);
nickjillings@1622 495 //popup.showPopup();
b@1608 496 } else {
b@1608 497 currentState = 'testRun-'+id;
b@1608 498 }
b@1608 499 }
b@1608 500
nickjillings@1625 501
b@1608 502 function dragEnd(ev) {
b@1608 503 // Function call when a div has been dropped
b@1608 504 var slider = document.getElementById('slider');
nickjillings@1633 505 var marginSize = Number(slider.attributes['marginsize'].value);
b@1608 506 var w = slider.style.width;
b@1608 507 w = Number(w.substr(0,w.length-2));
nickjillings@1633 508 var x = ev.x - ev.view.screenX;
nickjillings@1633 509 if (x >= marginSize && x < w+marginSize) {
b@1608 510 this.style.left = (x)+'px';
b@1608 511 } else {
nickjillings@1633 512 if (x<marginSize) {
nickjillings@1633 513 this.style.left = marginSize+'px';
b@1608 514 } else {
nickjillings@1633 515 this.style.left = (w+marginSize) + 'px';
b@1608 516 }
b@1608 517 }
b@1608 518 audioEngineContext.metric.sliderMoved();
b@1608 519 }
b@1608 520
b@1609 521 function buttonSubmitClick() // TODO: Only when all songs have been played!
b@1608 522 {
nickjillings@1614 523 hasBeenPlayed = audioEngineContext.checkAllPlayed();
nickjillings@1614 524 if (hasBeenPlayed.length == 0) {
nickjillings@1614 525 if (audioEngineContext.status == 1) {
nickjillings@1614 526 var playback = document.getElementById('playback-button');
nickjillings@1614 527 playback.click();
nickjillings@1614 528 // This function is called when the submit button is clicked. Will check for any further tests to perform, or any post-test options
nickjillings@1614 529 } else
nickjillings@1614 530 {
nickjillings@1614 531 if (audioEngineContext.timer.testStarted == false)
nickjillings@1614 532 {
nickjillings@1614 533 alert('You have not started the test! Please press start to begin the test!');
nickjillings@1614 534 return;
nickjillings@1614 535 }
nickjillings@1614 536 }
nickjillings@1614 537 if (currentState.substr(0,7) == 'testRun')
nickjillings@1614 538 {
nickjillings@1614 539 hasBeenPlayed = []; // clear array to prepare for next test
nickjillings@1614 540 audioEngineContext.timer.stopTest();
nickjillings@1614 541 advanceState();
nickjillings@1614 542 }
b@1610 543 } else // if a fragment has not been played yet
b@1610 544 {
nickjillings@1614 545 str = "";
nickjillings@1614 546 if (hasBeenPlayed.length > 1) {
nickjillings@1614 547 for (var i=0; i<hasBeenPlayed.length; i++) {
nickjillings@1614 548 str = str + hasBeenPlayed[i];
nickjillings@1614 549 if (i < hasBeenPlayed.length-2){
nickjillings@1614 550 str += ", ";
nickjillings@1614 551 } else if (i == hasBeenPlayed.length-2) {
nickjillings@1614 552 str += " or ";
nickjillings@1614 553 }
nickjillings@1614 554 }
nickjillings@1614 555 alert('You have not played fragments ' + str + ' yet. Please listen, rate and comment all samples before submitting.');
nickjillings@1614 556 } else {
nickjillings@1614 557 alert('You have not played fragment ' + hasBeenPlayed[0] + ' yet. Please listen, rate and comment all samples before submitting.');
nickjillings@1614 558 }
b@1610 559 return;
b@1610 560 }
b@1608 561 }
b@1608 562
b@1608 563 function convSliderPosToRate(id)
b@1608 564 {
b@1608 565 var w = document.getElementById('slider').style.width;
nickjillings@1633 566 var marginsize = Number(document.getElementById('slider').attributes['marginsize'].value);
b@1608 567 var maxPix = w.substr(0,w.length-2);
b@1608 568 var slider = document.getElementsByClassName('track-slider')[id];
b@1608 569 var pix = slider.style.left;
b@1608 570 pix = pix.substr(0,pix.length-2);
nickjillings@1633 571 var rate = (pix-marginsize)/maxPix;
b@1608 572 return rate;
b@1608 573 }
b@1608 574
nickjillings@1633 575 function resizeWindow(event){
nickjillings@1633 576 // Function called when the window has been resized.
nickjillings@1633 577 // MANDATORY FUNCTION
nickjillings@1633 578
nickjillings@1633 579 // Store the slider marker values
nickjillings@1633 580 var holdValues = [];
nickjillings@1633 581 $(".track-slider").each(function(index,sliderObj){
nickjillings@1633 582 holdValues.push(convSliderPosToRate(index));
nickjillings@1633 583 });
nickjillings@1633 584
nickjillings@1633 585 var width = event.target.innerWidth;
nickjillings@1633 586 var canvas = document.getElementById('sliderCanvasHolder');
nickjillings@1633 587 var sliderDiv = canvas.children[0];
nickjillings@1633 588 var sliderScaleDiv = canvas.children[1];
nickjillings@1633 589 var marginsize = Number(sliderDiv.attributes['marginsize'].value);
nickjillings@1633 590 var w = (marginsize+8)*2;
nickjillings@1633 591 sliderDiv.style.width = width - w + 'px';
nickjillings@1633 592 var width = width - w;
nickjillings@1633 593 // Move sliders into new position
nickjillings@1633 594 $(".track-slider").each(function(index,sliderObj){
nickjillings@1633 595 var pos = holdValues[index];
nickjillings@1633 596 var pix = pos * width;
nickjillings@1633 597 sliderObj.style.left = pix+marginsize+'px';
nickjillings@1633 598 });
nickjillings@1633 599
nickjillings@1633 600 // Move scale labels
nickjillings@1633 601 $(sliderScaleDiv.children).each(function(index,scaleObj){
nickjillings@1633 602 var position = Number(scaleObj.attributes['value'].value);
nickjillings@1633 603 var pixelPosition = (position*width)+marginsize;
nickjillings@1633 604 scaleObj.style.left = Math.floor((pixelPosition-($(scaleObj).width()/2)))+'px';
nickjillings@1633 605 });
nickjillings@1633 606 }
nickjillings@1633 607
b@1608 608 function pageXMLSave(testId)
b@1608 609 {
b@1608 610 // Saves a specific test page
b@1608 611 var xmlDoc = currentTestHolder;
b@1608 612 // Check if any session wide metrics are enabled
b@1608 613
b@1608 614 var commentShow = testXMLSetups[testId].attributes['elementComments'];
b@1608 615 if (commentShow != undefined) {
b@1608 616 if (commentShow.value == 'false') {commentShow = false;}
b@1608 617 else {commentShow = true;}
b@1608 618 } else {commentShow = true;}
b@1608 619
b@1608 620 var metric = document.createElement('metric');
b@1608 621 if (audioEngineContext.metric.enableTestTimer)
b@1608 622 {
b@1608 623 var testTime = document.createElement('metricResult');
b@1608 624 testTime.id = 'testTime';
b@1608 625 testTime.textContent = audioEngineContext.timer.testDuration;
b@1608 626 metric.appendChild(testTime);
b@1608 627 }
b@1608 628 xmlDoc.appendChild(metric);
b@1608 629 var trackSliderObjects = document.getElementsByClassName('track-slider');
b@1608 630 var commentObjects = document.getElementsByClassName('comment-div');
b@1608 631 for (var i=0; i<trackSliderObjects.length; i++)
b@1608 632 {
b@1608 633 var audioElement = document.createElement('audioElement');
b@1608 634 audioElement.id = currentTrackOrder[i].attributes['id'].value;
b@1608 635 audioElement.url = currentTrackOrder[i].attributes['url'].value;
b@1608 636 var value = document.createElement('value');
b@1608 637 value.innerHTML = convSliderPosToRate(i);
b@1608 638 if (commentShow) {
b@1608 639 var comment = document.createElement("comment");
b@1608 640 var question = document.createElement("question");
b@1608 641 var response = document.createElement("response");
b@1608 642 question.textContent = commentObjects[i].children[0].textContent;
b@1608 643 response.textContent = commentObjects[i].children[2].value;
b@1606 644 console.log('Comment ' + i + ': ' + commentObjects[i].children[2].value); // DEBUG/SAFETY
b@1608 645 comment.appendChild(question);
b@1608 646 comment.appendChild(response);
b@1608 647 audioElement.appendChild(comment);
b@1608 648 }
b@1608 649 audioElement.appendChild(value);
b@1608 650 // Check for any per element metrics
b@1608 651 var metric = document.createElement('metric');
b@1608 652 var elementMetric = audioEngineContext.audioObjects[i].metric;
b@1608 653 if (audioEngineContext.metric.enableElementTimer) {
b@1608 654 var elementTimer = document.createElement('metricResult');
b@1608 655 elementTimer.id = 'elementTimer';
b@1608 656 elementTimer.textContent = elementMetric.listenedTimer;
b@1608 657 metric.appendChild(elementTimer);
b@1608 658 }
b@1608 659 if (audioEngineContext.metric.enableElementTracker) {
b@1608 660 var elementTrackerFull = document.createElement('metricResult');
b@1608 661 elementTrackerFull.id = 'elementTrackerFull';
b@1608 662 var data = elementMetric.movementTracker;
b@1608 663 for (var k=0; k<data.length; k++)
b@1608 664 {
b@1608 665 var timePos = document.createElement('timePos');
b@1608 666 timePos.id = k;
b@1608 667 var time = document.createElement('time');
b@1608 668 time.textContent = data[k][0];
b@1608 669 var position = document.createElement('position');
b@1608 670 position.textContent = data[k][1];
b@1608 671 timePos.appendChild(time);
b@1608 672 timePos.appendChild(position);
b@1608 673 elementTrackerFull.appendChild(timePos);
b@1608 674 }
b@1608 675 metric.appendChild(elementTrackerFull);
b@1608 676 }
b@1608 677 if (audioEngineContext.metric.enableElementInitialPosition) {
b@1608 678 var elementInitial = document.createElement('metricResult');
b@1608 679 elementInitial.id = 'elementInitialPosition';
b@1608 680 elementInitial.textContent = elementMetric.initialPosition;
b@1608 681 metric.appendChild(elementInitial);
b@1608 682 }
b@1608 683 if (audioEngineContext.metric.enableFlagListenedTo) {
b@1608 684 var flagListenedTo = document.createElement('metricResult');
b@1608 685 flagListenedTo.id = 'elementFlagListenedTo';
b@1608 686 flagListenedTo.textContent = elementMetric.wasListenedTo;
b@1608 687 metric.appendChild(flagListenedTo);
b@1608 688 }
b@1608 689 if (audioEngineContext.metric.enableFlagMoved) {
b@1608 690 var flagMoved = document.createElement('metricResult');
b@1608 691 flagMoved.id = 'elementFlagMoved';
b@1608 692 flagMoved.textContent = elementMetric.wasMoved;
b@1608 693 metric.appendChild(flagMoved);
b@1608 694 }
b@1608 695 if (audioEngineContext.metric.enableFlagComments) {
b@1608 696 var flagComments = document.createElement('metricResult');
b@1608 697 flagComments.id = 'elementFlagComments';
b@1608 698 if (response.textContent.length == 0) {flag.textContent = 'false';}
b@1608 699 else {flag.textContet = 'true';}
b@1608 700 metric.appendChild(flagComments);
b@1608 701 }
b@1608 702 audioElement.appendChild(metric);
b@1608 703 xmlDoc.appendChild(audioElement);
b@1608 704 }
b@1608 705 var commentQuestion = document.getElementsByClassName('commentQuestion');
b@1608 706 for (var i=0; i<commentQuestion.length; i++)
b@1608 707 {
b@1608 708 var cqHolder = document.createElement('CommentQuestion');
b@1608 709 var comment = document.createElement('comment');
b@1608 710 var question = document.createElement('question');
b@1608 711 cqHolder.id = commentQuestion[i].id;
b@1608 712 comment.textContent = commentQuestion[i].children[2].value;
b@1608 713 question.textContent = commentQuestion[i].children[0].textContent;
nickjillings@1630 714 console.log('Question ' + i + ': ' + commentQuestion[i].children[2].value); // DEBUG/SAFETY
b@1608 715 cqHolder.appendChild(question);
b@1608 716 cqHolder.appendChild(comment);
b@1608 717 xmlDoc.appendChild(cqHolder);
b@1608 718 }
b@1608 719 testResultsHolders[testId] = xmlDoc;
b@1608 720 }
b@1608 721
b@1608 722 // Only other global function which must be defined in the interface class. Determines how to create the XML document.
b@1608 723 function interfaceXMLSave(){
b@1608 724 // Create the XML string to be exported with results
b@1608 725 var xmlDoc = document.createElement("BrowserEvaluationResult");
nickjillings@1631 726 xmlDoc.appendChild(returnDateNode());
b@1608 727 for (var i=0; i<testResultsHolders.length; i++)
b@1608 728 {
b@1608 729 xmlDoc.appendChild(testResultsHolders[i]);
b@1608 730 }
b@1608 731 // Append Pre/Post Questions
b@1608 732 xmlDoc.appendChild(preTestQuestions);
b@1608 733 xmlDoc.appendChild(postTestQuestions);
b@1608 734
b@1608 735 return xmlDoc;
b@1608 736 }