nickjillings@1683: /** nickjillings@1683: * ape.js nickjillings@1683: * Create the APE interface nickjillings@1683: */ nickjillings@1683: nickjillings@1648: // preTest - In preTest state nickjillings@1648: // testRun-ID - In test running, test Id number at the end 'testRun-2' nickjillings@1648: // testRunPost-ID - Post test of test ID nickjillings@1648: // testRunPre-ID - Pre-test of test ID nickjillings@1648: // postTest - End of test, final submission! nickjillings@1648: nickjillings@1642: nickjillings@1683: // Once this is loaded and parsed, begin execution nickjillings@1683: loadInterface(projectXML); nickjillings@1683: nickjillings@1683: function loadInterface(xmlDoc) { nickjillings@1683: nickjillings@1697: // Get the dimensions of the screen available to the page nickjillings@1683: var width = window.innerWidth; nickjillings@1683: var height = window.innerHeight; nickjillings@1683: nickjillings@1683: // The injection point into the HTML page nickjillings@1683: var insertPoint = document.getElementById("topLevelBody"); nickjillings@1702: var testContent = document.createElement('div'); nickjillings@1604: nickjillings@1702: testContent.id = 'testContent'; nickjillings@1683: nickjillings@1688: nickjillings@1683: // Decode parts of the xmlDoc that are needed nickjillings@1683: // xmlDoc MUST already be parsed by jQuery! nickjillings@1683: var xmlSetup = xmlDoc.find('setup'); nickjillings@1683: // Should put in an error function here incase of malprocessed or malformed XML nickjillings@1683: nickjillings@1634: // Create pre and post test questions nickjillings@1634: nickjillings@1634: var preTest = xmlSetup.find('PreTest'); nickjillings@1634: var postTest = xmlSetup.find('PostTest'); nickjillings@1634: preTest = preTest[0]; nickjillings@1634: postTest = postTest[0]; nickjillings@1634: nickjillings@1634: if (preTest == undefined) {preTest = document.createElement("preTest");} nickjillings@1634: if (postTest == undefined){postTest= document.createElement("postTest");} nickjillings@1634: nickjillings@1634: testState.stateMap.push(preTest); nickjillings@1634: nickjillings@1644: // Extract the different test XML DOM trees nickjillings@1660: var audioHolders = xmlDoc.find('audioHolder'); nickjillings@1634: var testXMLSetups = []; nickjillings@1660: audioHolders.each(function(index,element) { nickjillings@1660: var repeatN = element.attributes['repeatCount'].value; nickjillings@1660: for (var r=0; r<=repeatN; r++) { nickjillings@1634: testXMLSetups.push(element); nickjillings@1660: } nickjillings@1660: }); nickjillings@1654: nickjillings@1660: // New check if we need to randomise the test order nickjillings@1660: var randomise = xmlSetup[0].attributes['randomiseOrder']; nickjillings@1660: if (randomise != undefined) { nickjillings@1616: if (randomise.value === 'true'){ nickjillings@1616: randomise = true; nickjillings@1616: } else { nickjillings@1616: randomise = false; nickjillings@1616: } nickjillings@1660: } else { nickjillings@1660: randomise = false; nickjillings@1660: } nickjillings@1616: nickjillings@1660: if (randomise) nickjillings@1660: { nickjillings@1664: testXMLSetups = randomiseOrder(testXMLSetups); nickjillings@1660: } nickjillings@1634: nickjillings@1634: $(testXMLSetups).each(function(index,elem){ nickjillings@1634: testState.stateMap.push(elem); nickjillings@1634: }) nickjillings@1634: nickjillings@1634: testState.stateMap.push(postTest); nickjillings@1654: nickjillings@1660: // Obtain the metrics enabled nickjillings@1660: var metricNode = xmlSetup.find('Metric'); nickjillings@1660: var metricNode = metricNode.find('metricEnable'); nickjillings@1660: metricNode.each(function(index,node){ nickjillings@1660: var enabled = node.textContent; nickjillings@1660: switch(enabled) nickjillings@1660: { nickjillings@1660: case 'testTimer': nickjillings@1660: sessionMetrics.prototype.enableTestTimer = true; nickjillings@1660: break; nickjillings@1660: case 'elementTimer': nickjillings@1660: sessionMetrics.prototype.enableElementTimer = true; nickjillings@1660: break; nickjillings@1660: case 'elementTracker': nickjillings@1660: sessionMetrics.prototype.enableElementTracker = true; nickjillings@1660: break; nickjillings@1660: case 'elementInitalPosition': nickjillings@1660: sessionMetrics.prototype.enableElementInitialPosition = true; nickjillings@1660: break; nickjillings@1660: case 'elementFlagListenedTo': nickjillings@1660: sessionMetrics.prototype.enableFlagListenedTo = true; nickjillings@1660: break; nickjillings@1660: case 'elementFlagMoved': nickjillings@1660: sessionMetrics.prototype.enableFlagMoved = true; nickjillings@1660: break; nickjillings@1660: case 'elementFlagComments': nickjillings@1660: sessionMetrics.prototype.enableFlagComments = true; nickjillings@1660: break; nickjillings@1660: } nickjillings@1660: }); nickjillings@1644: nickjillings@1662: // Create APE specific metric functions nickjillings@1662: audioEngineContext.metric.initialiseTest = function() nickjillings@1662: { nickjillings@1662: }; nickjillings@1662: nickjillings@1662: audioEngineContext.metric.sliderMoveStart = function(id) nickjillings@1662: { nickjillings@1662: if (this.data == -1) nickjillings@1662: { nickjillings@1662: this.data = id; nickjillings@1662: } else { nickjillings@1662: console.log('ERROR: Metric tracker detecting two moves!'); nickjillings@1662: this.data = -1; nickjillings@1662: } nickjillings@1662: }; nickjillings@1662: audioEngineContext.metric.sliderMoved = function() nickjillings@1662: { nickjillings@1662: var time = audioEngineContext.timer.getTestTime(); nickjillings@1662: var id = this.data; nickjillings@1662: this.data = -1; nickjillings@1662: var position = convSliderPosToRate(id); b@1606: console.log('slider ' + id + ': '+ position + ' (' + time + ')'); // DEBUG/SAFETY: show position and slider id nickjillings@1662: if (audioEngineContext.timer.testStarted) nickjillings@1662: { nickjillings@1662: audioEngineContext.audioObjects[id].metric.moved(time,position); nickjillings@1662: } nickjillings@1662: }; nickjillings@1662: nickjillings@1662: audioEngineContext.metric.sliderPlayed = function(id) nickjillings@1662: { nickjillings@1662: var time = audioEngineContext.timer.getTestTime(); nickjillings@1662: if (audioEngineContext.timer.testStarted) nickjillings@1662: { nickjillings@1662: if (this.lastClicked >= 0) nickjillings@1662: { nickjillings@1662: audioEngineContext.audioObjects[this.lastClicked].metric.listening(time); nickjillings@1662: } nickjillings@1662: this.lastClicked = id; nickjillings@1662: audioEngineContext.audioObjects[id].metric.listening(time); nickjillings@1662: } b@1606: console.log('slider ' + id + ' played (' + time + ')'); // DEBUG/SAFETY: show played slider id nickjillings@1662: }; nickjillings@1662: nickjillings@1683: // Create the top div for the Title element nickjillings@1683: var titleAttr = xmlSetup[0].attributes['title']; nickjillings@1683: var title = document.createElement('div'); nickjillings@1683: title.className = "title"; nickjillings@1683: title.align = "center"; nickjillings@1683: var titleSpan = document.createElement('span'); nickjillings@1683: nickjillings@1683: // Set title to that defined in XML, else set to default nickjillings@1683: if (titleAttr != undefined) { nickjillings@1705: titleSpan.innerHTML = titleAttr.value; nickjillings@1683: } else { b@1714: titleSpan.innerHTML = 'Listening test'; nickjillings@1683: } nickjillings@1683: // Insert the titleSpan element into the title div element. nickjillings@1683: title.appendChild(titleSpan); nickjillings@1683: nickjillings@1657: var pagetitle = document.createElement('div'); nickjillings@1657: pagetitle.className = "pageTitle"; nickjillings@1657: pagetitle.align = "center"; nickjillings@1657: var titleSpan = document.createElement('span'); nickjillings@1657: titleSpan.id = "pageTitle"; nickjillings@1657: pagetitle.appendChild(titleSpan); nickjillings@1657: nickjillings@1688: // Store the return URL path in global projectReturn nickjillings@1603: projectReturn = xmlSetup[0].attributes['projectReturn']; nickjillings@1603: if (projectReturn == undefined) { nickjillings@1603: console.log("WARNING - projectReturn not specified! Will assume null."); nickjillings@1603: projectReturn = "null"; nickjillings@1603: } else { nickjillings@1603: projectReturn = projectReturn.value; nickjillings@1603: } nickjillings@1688: nickjillings@1688: // Create Interface buttons! nickjillings@1688: var interfaceButtons = document.createElement('div'); nickjillings@1688: interfaceButtons.id = 'interface-buttons'; nickjillings@1688: nickjillings@1688: // MANUAL DOWNLOAD POINT nickjillings@1688: // If project return is null, this MUST be specified as the location to create the download link nickjillings@1688: var downloadPoint = document.createElement('div'); nickjillings@1688: downloadPoint.id = 'download-point'; nickjillings@1688: nickjillings@1688: // Create playback start/stop points nickjillings@1688: var playback = document.createElement("button"); b@1609: playback.innerHTML = 'Stop'; nickjillings@1659: playback.id = 'playback-button'; nickjillings@1697: // onclick function. Check if it is playing or not, call the correct function in the nickjillings@1697: // audioEngine, change the button text to reflect the next state. nickjillings@1688: playback.onclick = function() { b@1609: if (audioEngineContext.status == 1) { b@1609: audioEngineContext.stop(); nickjillings@1705: this.innerHTML = 'Stop'; b@1606: var time = audioEngineContext.timer.getTestTime(); b@1606: console.log('Stopped at ' + time); // DEBUG/SAFETY nickjillings@1688: } nickjillings@1697: }; nickjillings@1688: // Create Submit (save) button nickjillings@1688: var submit = document.createElement("button"); nickjillings@1705: submit.innerHTML = 'Submit'; nickjillings@1653: submit.onclick = buttonSubmitClick; nickjillings@1659: submit.id = 'submit-button'; nickjillings@1697: // Append the interface buttons into the interfaceButtons object. nickjillings@1688: interfaceButtons.appendChild(playback); nickjillings@1688: interfaceButtons.appendChild(submit); nickjillings@1688: interfaceButtons.appendChild(downloadPoint); nickjillings@1688: nickjillings@1683: // Now create the slider and HTML5 canvas boxes nickjillings@1683: nickjillings@1697: // Create the div box to center align nickjillings@1683: var sliderBox = document.createElement('div'); nickjillings@1683: sliderBox.className = 'sliderCanvasDiv'; nickjillings@1697: sliderBox.id = 'sliderCanvasHolder'; nickjillings@1683: nickjillings@1697: // Create the slider box to hold the slider elements nickjillings@1686: var canvas = document.createElement('div'); nickjillings@1683: canvas.id = 'slider'; nickjillings@1633: canvas.align = "left"; nickjillings@1633: canvas.addEventListener('dragover',function(event){ nickjillings@1633: event.preventDefault(); nickjillings@1633: return false; nickjillings@1633: },false); nickjillings@1633: var sliderMargin = document.createAttribute('marginsize'); nickjillings@1633: sliderMargin.nodeValue = 42; // Set default margins to 42px either side nickjillings@1697: // Must have a known EXACT width, as this is used later to determine the ratings nickjillings@1633: var w = (Number(sliderMargin.nodeValue)+8)*2; nickjillings@1633: canvas.style.width = width - w +"px"; nickjillings@1633: canvas.style.marginLeft = sliderMargin.nodeValue +'px'; nickjillings@1633: canvas.setAttributeNode(sliderMargin); nickjillings@1683: sliderBox.appendChild(canvas); nickjillings@1697: nickjillings@1657: // Create the div to hold any scale objects nickjillings@1657: var scale = document.createElement('div'); nickjillings@1657: scale.className = 'sliderScale'; nickjillings@1657: scale.id = 'sliderScaleHolder'; nickjillings@1657: scale.align = 'left'; nickjillings@1657: sliderBox.appendChild(scale); nickjillings@1657: nickjillings@1697: // Global parent for the comment boxes on the page nickjillings@1684: var feedbackHolder = document.createElement('div'); nickjillings@1644: feedbackHolder.id = 'feedbackHolder'; nickjillings@1642: nickjillings@1648: testContent.style.zIndex = 1; nickjillings@1648: insertPoint.innerHTML = null; // Clear the current schema nickjillings@1648: nickjillings@1648: currentState = 'preTest'; nickjillings@1642: nickjillings@1648: // Inject into HTML nickjillings@1648: testContent.appendChild(title); // Insert the title nickjillings@1657: testContent.appendChild(pagetitle); nickjillings@1648: testContent.appendChild(interfaceButtons); nickjillings@1648: testContent.appendChild(sliderBox); nickjillings@1648: testContent.appendChild(feedbackHolder); nickjillings@1648: insertPoint.appendChild(testContent); nickjillings@1642: nickjillings@1646: // Load the full interface nickjillings@1634: testState.initialise(); nickjillings@1634: testState.advanceState(); nickjillings@1649: nickjillings@1642: } nickjillings@1642: nickjillings@1634: function loadTest(textXML) nickjillings@1644: { nickjillings@1617: nickjillings@1617: // Reset audioEngineContext.Metric globals for new test nickjillings@1620: audioEngineContext.newTestPage(); nickjillings@1617: nickjillings@1634: var id = textXML.id; nickjillings@1644: nickjillings@1644: var feedbackHolder = document.getElementById('feedbackHolder'); nickjillings@1644: var canvas = document.getElementById('slider'); nickjillings@1644: feedbackHolder.innerHTML = null; nickjillings@1644: canvas.innerHTML = null; nickjillings@1657: nickjillings@1657: // Setup question title nickjillings@1657: var interfaceObj = $(textXML).find('interface'); nickjillings@1657: var titleNode = interfaceObj.find('title'); nickjillings@1657: if (titleNode[0] != undefined) nickjillings@1657: { nickjillings@1657: document.getElementById('pageTitle').textContent = titleNode[0].textContent; nickjillings@1657: } nickjillings@1657: var positionScale = canvas.style.width.substr(0,canvas.style.width.length-2); nickjillings@1633: var offset = Number(document.getElementById('slider').attributes['marginsize'].value); nickjillings@1657: var scale = document.getElementById('sliderScaleHolder'); nickjillings@1657: scale.innerHTML = null; nickjillings@1657: interfaceObj.find('scale').each(function(index,scaleObj){ nickjillings@1633: var value = document.createAttribute('value'); nickjillings@1657: var position = Number(scaleObj.attributes['position'].value)*0.01; nickjillings@1633: value.nodeValue = position; nickjillings@1657: var pixelPosition = (position*positionScale)+offset; nickjillings@1657: var scaleDOM = document.createElement('span'); nickjillings@1657: scaleDOM.textContent = scaleObj.textContent; nickjillings@1657: scale.appendChild(scaleDOM); nickjillings@1657: scaleDOM.style.left = Math.floor((pixelPosition-($(scaleDOM).width()/2)))+'px'; nickjillings@1633: scaleDOM.setAttributeNode(value); nickjillings@1657: }); nickjillings@1644: nickjillings@1697: // Extract the hostURL attribute. If not set, create an empty string. nickjillings@1644: var hostURL = textXML.attributes['hostURL']; nickjillings@1688: if (hostURL == undefined) { nickjillings@1688: hostURL = ""; nickjillings@1688: } else { nickjillings@1688: hostURL = hostURL.value; nickjillings@1688: } nickjillings@1697: // Extract the sampleRate. If set, convert the string to a Number. nickjillings@1644: var hostFs = textXML.attributes['sampleRate']; nickjillings@1696: if (hostFs != undefined) { nickjillings@1696: hostFs = Number(hostFs.value); nickjillings@1688: } nickjillings@1688: nickjillings@1688: /// CHECK FOR SAMPLE RATE COMPATIBILITY nickjillings@1696: if (hostFs != undefined) { nickjillings@1688: if (Number(hostFs) != audioContext.sampleRate) { nickjillings@1688: 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: alert(errStr); nickjillings@1688: return; nickjillings@1688: } nickjillings@1688: } nickjillings@1655: nickjillings@1675: var commentShow = textXML.attributes['elementComments']; nickjillings@1675: if (commentShow != undefined) { nickjillings@1675: if (commentShow.value == 'false') {commentShow = false;} nickjillings@1675: else {commentShow = true;} nickjillings@1675: } else {commentShow = true;} nickjillings@1675: nickjillings@1667: var loopPlayback = textXML.attributes['loop']; nickjillings@1667: if (loopPlayback != undefined) nickjillings@1667: { nickjillings@1667: loopPlayback = loopPlayback.value; nickjillings@1667: if (loopPlayback == 'true') { nickjillings@1667: loopPlayback = true; nickjillings@1667: } else { nickjillings@1667: loopPlayback = false; nickjillings@1667: } nickjillings@1667: } else { nickjillings@1667: loopPlayback = false; nickjillings@1667: } nickjillings@1667: audioEngineContext.loopPlayback = loopPlayback; nickjillings@1667: // Create AudioEngine bindings for playback nickjillings@1667: if (loopPlayback) { nickjillings@1667: audioEngineContext.selectedTrack = function(id) { nickjillings@1667: for (var i=0; i'; nickjillings@1686: trackSliderObj.draggable = true; nickjillings@1686: trackSliderObj.ondragend = dragEnd; nickjillings@1659: trackSliderObj.ondragstart = function() nickjillings@1659: { nickjillings@1747: var id = Number(event.srcElement.attributes['trackIndex'].value); nickjillings@1659: audioEngineContext.metric.sliderMoveStart(id); nickjillings@1659: }; nickjillings@1689: nickjillings@1689: // Onclick, switch playback to that track nickjillings@1689: trackSliderObj.onclick = function() { nickjillings@1615: // Start the test on first click, that way timings are more accurate. nickjillings@1615: audioEngineContext.play(); nickjillings@1604: if (audioEngineContext.audioObjectsReady) { nickjillings@1604: // Cannot continue to issue play command until audioObjects reported as ready! nickjillings@1604: // Get the track ID from the object ID nickjillings@1747: var id = Number(event.srcElement.attributes['trackIndex'].value); nickjillings@1604: //audioEngineContext.metric.sliderPlayed(id); nickjillings@1604: audioEngineContext.selectedTrack(id); nickjillings@1604: // Currently playing track red, rest green nickjillings@1747: nickjillings@1747: //document.getElementById('track-slider-'+index).style.backgroundColor = "#FF0000"; nickjillings@1747: $('.track-slider').removeClass('track-slider-playing'); nickjillings@1747: $(event.srcElement).addClass('track-slider-playing'); nickjillings@1747: $('.comment-div').removeClass('comment-box-playing'); nickjillings@1747: $('#comment-div-'+id).addClass('comment-box-playing'); nickjillings@1604: } nickjillings@1696: }; nickjillings@1689: nickjillings@1686: canvas.appendChild(trackSliderObj); nickjillings@1739: audioEngineContext.audioObjects[index].metric.initialised(convSliderPosToRate(index)); b@1610: nickjillings@1696: }); nickjillings@1684: nickjillings@1674: // Append any commentQuestion boxes nickjillings@1674: var commentQuestions = $(textXML).find('CommentQuestion'); nickjillings@1674: $(commentQuestions).each(function(index,element) { nickjillings@1674: // Create document objects to hold the comment boxes nickjillings@1674: var trackComment = document.createElement('div'); nickjillings@1674: trackComment.className = 'comment-div commentQuestion'; nickjillings@1674: trackComment.id = element.attributes['id'].value; nickjillings@1674: // Create a string next to each comment asking for a comment nickjillings@1674: var trackString = document.createElement('span'); nickjillings@1674: trackString.innerHTML = element.textContent; nickjillings@1674: // Create the HTML5 comment box 'textarea' nickjillings@1674: var trackCommentBox = document.createElement('textarea'); nickjillings@1674: trackCommentBox.rows = '4'; nickjillings@1674: trackCommentBox.cols = '100'; nickjillings@1674: trackCommentBox.name = 'commentQuestion'+index; nickjillings@1674: trackCommentBox.className = 'trackComment'; nickjillings@1674: var br = document.createElement('br'); nickjillings@1674: // Add to the holder. nickjillings@1674: trackComment.appendChild(trackString); nickjillings@1674: trackComment.appendChild(br); nickjillings@1674: trackComment.appendChild(trackCommentBox); nickjillings@1674: feedbackHolder.appendChild(trackComment); nickjillings@1674: }); nickjillings@1746: nickjillings@1746: nickjillings@1746: testWaitIndicator(); nickjillings@1649: } nickjillings@1649: nickjillings@1686: nickjillings@1686: function dragEnd(ev) { nickjillings@1686: // Function call when a div has been dropped nickjillings@1643: var slider = document.getElementById('slider'); nickjillings@1633: var marginSize = Number(slider.attributes['marginsize'].value); nickjillings@1661: var w = slider.style.width; nickjillings@1661: w = Number(w.substr(0,w.length-2)); nickjillings@1661: var x = ev.x; nickjillings@1633: if (x >= marginSize && x < w+marginSize) { nickjillings@1661: this.style.left = (x)+'px'; nickjillings@1686: } else { nickjillings@1633: if (x 1) { nickjillings@1614: for (var i=0; i