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