annotate ape.js @ 963:ba734075da2d

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