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