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