annotate ape.js @ 933:1265e2aebf17

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