annotate ape.js @ 2028:c7848cef5a56

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