djmoffat@1099: /** djmoffat@1099: * mushra.js djmoffat@1099: * Create the MUSHRA interface djmoffat@1099: */ djmoffat@1099: djmoffat@1099: // Once this is loaded and parsed, begin execution djmoffat@1099: loadInterface(); djmoffat@1099: djmoffat@1099: function loadInterface() { djmoffat@1099: // Get the dimensions of the screen available to the page djmoffat@1099: var width = window.innerWidth; djmoffat@1099: var height = window.innerHeight; djmoffat@1099: djmoffat@1099: // The injection point into the HTML page djmoffat@1099: interfaceContext.insertPoint = document.getElementById("topLevelBody"); djmoffat@1099: var testContent = document.createElement('div'); djmoffat@1099: testContent.id = 'testContent'; djmoffat@1099: djmoffat@1099: // Create the top div for the Title element djmoffat@1099: var titleAttr = specification.title; djmoffat@1099: var title = document.createElement('div'); djmoffat@1099: title.className = "title"; djmoffat@1099: title.align = "center"; djmoffat@1099: var titleSpan = document.createElement('span'); djmoffat@1099: djmoffat@1099: // Set title to that defined in XML, else set to default djmoffat@1099: if (titleAttr != undefined) { djmoffat@1099: titleSpan.textContent = titleAttr; djmoffat@1099: } else { djmoffat@1099: titleSpan.textContent = 'Listening test'; djmoffat@1099: } djmoffat@1099: // Insert the titleSpan element into the title div element. djmoffat@1099: title.appendChild(titleSpan); djmoffat@1099: djmoffat@1099: var pagetitle = document.createElement('div'); djmoffat@1099: pagetitle.className = "pageTitle"; djmoffat@1099: pagetitle.align = "center"; djmoffat@1099: var titleSpan = document.createElement('span'); djmoffat@1099: titleSpan.id = "pageTitle"; djmoffat@1099: pagetitle.appendChild(titleSpan); djmoffat@1099: djmoffat@1099: // Create Interface buttons! djmoffat@1099: var interfaceButtons = document.createElement('div'); djmoffat@1099: interfaceButtons.id = 'interface-buttons'; djmoffat@1099: interfaceButtons.style.height = '25px'; djmoffat@1099: djmoffat@1099: // Create playback start/stop points djmoffat@1099: var playback = document.createElement("button"); djmoffat@1099: playback.innerHTML = 'Stop'; djmoffat@1099: playback.id = 'playback-button'; djmoffat@1099: playback.style.float = 'left'; djmoffat@1099: // onclick function. Check if it is playing or not, call the correct function in the djmoffat@1099: // audioEngine, change the button text to reflect the next state. djmoffat@1099: playback.onclick = function() { djmoffat@1099: if (audioEngineContext.status == 1) { djmoffat@1099: audioEngineContext.stop(); djmoffat@1099: this.innerHTML = 'Stop'; djmoffat@1099: var time = audioEngineContext.timer.getTestTime(); djmoffat@1099: console.log('Stopped at ' + time); // DEBUG/SAFETY djmoffat@1099: } djmoffat@1099: }; djmoffat@1099: // Create Submit (save) button djmoffat@1099: var submit = document.createElement("button"); djmoffat@1099: submit.innerHTML = 'Submit'; djmoffat@1099: submit.onclick = buttonSubmitClick; djmoffat@1099: submit.id = 'submit-button'; djmoffat@1099: submit.style.float = 'left'; djmoffat@1099: // Append the interface buttons into the interfaceButtons object. djmoffat@1099: interfaceButtons.appendChild(playback); djmoffat@1099: interfaceButtons.appendChild(submit); djmoffat@1099: djmoffat@1099: // Create a slider box djmoffat@1099: var sliderBox = document.createElement('div'); djmoffat@1099: sliderBox.style.width = "100%"; djmoffat@1099: sliderBox.style.height = window.innerHeight - 200+12 + 'px'; djmoffat@1099: sliderBox.style.marginBottom = '10px'; djmoffat@1099: sliderBox.id = 'slider'; djmoffat@1099: var scaleHolder = document.createElement('div'); djmoffat@1099: scaleHolder.id = "scale-holder"; djmoffat@1099: sliderBox.appendChild(scaleHolder); djmoffat@1099: var scaleText = document.createElement('div'); djmoffat@1099: scaleText.id = "scale-text-holder"; djmoffat@1099: scaleHolder.appendChild(scaleText); djmoffat@1099: var scaleCanvas = document.createElement('canvas'); djmoffat@1099: scaleCanvas.id = "scale-canvas"; djmoffat@1099: scaleHolder.appendChild(scaleCanvas); djmoffat@1099: var sliderObjectHolder = document.createElement('div'); djmoffat@1099: sliderObjectHolder.id = 'slider-holder'; djmoffat@1099: sliderObjectHolder.align = "center"; djmoffat@1099: sliderBox.appendChild(sliderObjectHolder); djmoffat@1099: djmoffat@1099: // Global parent for the comment boxes on the page djmoffat@1099: var feedbackHolder = document.createElement('div'); djmoffat@1099: feedbackHolder.id = 'feedbackHolder'; djmoffat@1099: djmoffat@1099: testContent.style.zIndex = 1; djmoffat@1099: interfaceContext.insertPoint.innerHTML = null; // Clear the current schema djmoffat@1099: djmoffat@1099: // Inject into HTML djmoffat@1099: testContent.appendChild(title); // Insert the title djmoffat@1099: testContent.appendChild(pagetitle); djmoffat@1099: testContent.appendChild(interfaceButtons); djmoffat@1099: testContent.appendChild(sliderBox); djmoffat@1099: testContent.appendChild(feedbackHolder); djmoffat@1099: interfaceContext.insertPoint.appendChild(testContent); djmoffat@1099: djmoffat@1099: // Load the full interface djmoffat@1099: testState.initialise(); djmoffat@1099: testState.advanceState(); djmoffat@1099: } djmoffat@1099: djmoffat@1099: function loadTest(audioHolderObject) djmoffat@1099: { djmoffat@1099: var id = audioHolderObject.id; djmoffat@1099: djmoffat@1099: var feedbackHolder = document.getElementById('feedbackHolder'); djmoffat@1099: feedbackHolder.innerHTML = null; djmoffat@1099: var interfaceObj = audioHolderObject.interfaces; djmoffat@1099: if (interfaceObj.length > 1) djmoffat@1099: { djmoffat@1099: console.log("WARNING - This interface only supports one node per page. Using first interface node"); djmoffat@1099: } djmoffat@1099: interfaceObj = interfaceObj[0]; djmoffat@1099: if(interfaceObj.title != null) djmoffat@1099: { djmoffat@1099: document.getElementById("pageTitle").textContent = interfaceObj.title; djmoffat@1099: } djmoffat@1099: var interfaceOptions = specification.interfaces.options.concat(interfaceObj.options); djmoffat@1099: for (var option of interfaceOptions) djmoffat@1099: { djmoffat@1099: if (option.type == "show") djmoffat@1099: { djmoffat@1099: switch(option.name) { djmoffat@1099: case "playhead": djmoffat@1099: var playbackHolder = document.getElementById('playback-holder'); djmoffat@1099: if (playbackHolder == null) djmoffat@1099: { djmoffat@1099: playbackHolder = document.createElement('div'); djmoffat@1099: playbackHolder.style.width = "100%"; djmoffat@1099: playbackHolder.align = 'center'; djmoffat@1099: playbackHolder.appendChild(interfaceContext.playhead.object); djmoffat@1099: feedbackHolder.appendChild(playbackHolder); djmoffat@1099: } djmoffat@1099: break; djmoffat@1099: case "page-count": djmoffat@1099: var pagecountHolder = document.getElementById('page-count'); djmoffat@1099: if (pagecountHolder == null) djmoffat@1099: { djmoffat@1099: pagecountHolder = document.createElement('div'); djmoffat@1099: pagecountHolder.id = 'page-count'; djmoffat@1099: } djmoffat@1099: pagecountHolder.innerHTML = 'Page '+(audioHolderObject.presentedId+1)+' of '+specification.pages.length+''; djmoffat@1099: var inject = document.getElementById('interface-buttons'); djmoffat@1099: inject.appendChild(pagecountHolder); djmoffat@1099: break; djmoffat@1099: case "volume": djmoffat@1099: if (document.getElementById('master-volume-holder') == null) djmoffat@1099: { djmoffat@1099: feedbackHolder.appendChild(interfaceContext.volume.object); djmoffat@1099: } djmoffat@1099: break; djmoffat@1099: } djmoffat@1099: } djmoffat@1099: } djmoffat@1099: djmoffat@1099: // Delete outside reference djmoffat@1099: var outsideReferenceHolder = document.getElementById('outside-reference'); djmoffat@1099: if (outsideReferenceHolder != null) { djmoffat@1099: document.getElementById('interface-buttons').removeChild(outsideReferenceHolder); djmoffat@1099: } djmoffat@1099: djmoffat@1099: var sliderBox = document.getElementById('slider-holder'); djmoffat@1099: sliderBox.innerHTML = null; djmoffat@1099: djmoffat@1099: var commentBoxPrefix = "Comment on track"; djmoffat@1099: if (interfaceObj.commentBoxPrefix != undefined) { djmoffat@1099: commentBoxPrefix = interfaceObj.commentBoxPrefix; djmoffat@1099: } djmoffat@1099: var loopPlayback = audioHolderObject.loop; djmoffat@1099: djmoffat@1099: currentTestHolder = document.createElement('audioHolder'); djmoffat@1099: currentTestHolder.id = audioHolderObject.id; djmoffat@1099: currentTestHolder.repeatCount = audioHolderObject.repeatCount; djmoffat@1099: djmoffat@1099: $(audioHolderObject.commentQuestions).each(function(index,element) { djmoffat@1099: var node = interfaceContext.createCommentQuestion(element); djmoffat@1099: feedbackHolder.appendChild(node.holder); djmoffat@1099: }); djmoffat@1099: djmoffat@1099: // Find all the audioElements from the audioHolder djmoffat@1099: var label = 0; djmoffat@1099: $(audioHolderObject.audioElements).each(function(index,element){ djmoffat@1099: // Find URL of track djmoffat@1099: // In this jQuery loop, variable 'this' holds the current audioElement. djmoffat@1099: djmoffat@1099: var audioObject = audioEngineContext.newTrack(element); djmoffat@1099: if (element.type == 'outside-reference') djmoffat@1099: { djmoffat@1099: // Construct outside reference; djmoffat@1099: var orNode = new outsideReferenceDOM(audioObject,index,document.getElementById('interface-buttons')); djmoffat@1099: audioObject.bindInterface(orNode); djmoffat@1099: } else { djmoffat@1099: // Create a slider per track djmoffat@1099: var sliderObj = new sliderObject(audioObject,label); djmoffat@1099: djmoffat@1099: if (typeof audioHolderObject.initialPosition === "number") djmoffat@1099: { djmoffat@1099: // Set the values djmoffat@1099: sliderObj.slider.value = audioHolderObject.initalPosition; djmoffat@1099: } else { djmoffat@1099: // Distribute it randomnly djmoffat@1099: sliderObj.slider.value = Math.random(); djmoffat@1099: } djmoffat@1099: sliderBox.appendChild(sliderObj.holder); djmoffat@1099: audioObject.bindInterface(sliderObj); djmoffat@1099: interfaceContext.createCommentBox(audioObject); djmoffat@1099: label += 1; djmoffat@1099: } djmoffat@1099: djmoffat@1099: }); djmoffat@1099: djmoffat@1099: // Auto-align djmoffat@1099: resizeWindow(null); djmoffat@1099: } djmoffat@1099: djmoffat@1099: function sliderObject(audioObject,label) djmoffat@1099: { djmoffat@1099: // Constructs the slider object. We use the HTML5 slider object djmoffat@1099: this.parent = audioObject; djmoffat@1099: this.holder = document.createElement('div'); djmoffat@1099: this.title = document.createElement('span'); djmoffat@1099: this.slider = document.createElement('input'); djmoffat@1099: this.play = document.createElement('button'); djmoffat@1099: djmoffat@1099: this.holder.className = 'track-slider'; djmoffat@1099: this.holder.style.height = window.innerHeight-200 + 'px'; djmoffat@1099: this.holder.appendChild(this.title); djmoffat@1099: this.holder.appendChild(this.slider); djmoffat@1099: this.holder.appendChild(this.play); djmoffat@1099: this.holder.align = "center"; djmoffat@1099: if (label == 0) djmoffat@1099: { djmoffat@1099: this.holder.style.marginLeft = '0px'; djmoffat@1099: } djmoffat@1099: this.holder.setAttribute('trackIndex',audioObject.id); djmoffat@1099: djmoffat@1099: this.title.textContent = label; djmoffat@1099: this.title.style.width = "100%"; djmoffat@1099: this.title.style.float = "left"; djmoffat@1099: djmoffat@1099: this.slider.type = "range"; djmoffat@1099: this.slider.className = "track-slider-range track-slider-not-moved"; djmoffat@1099: this.slider.min = "0"; djmoffat@1099: this.slider.max = "1"; djmoffat@1099: this.slider.step = "0.01"; djmoffat@1099: this.slider.setAttribute('orient','vertical'); djmoffat@1099: this.slider.style.height = window.innerHeight-250 + 'px'; djmoffat@1099: this.slider.onchange = function() djmoffat@1099: { djmoffat@1099: var time = audioEngineContext.timer.getTestTime(); djmoffat@1099: var id = Number(this.parentNode.getAttribute('trackIndex')); djmoffat@1099: audioEngineContext.audioObjects[id].metric.moved(time,this.value); djmoffat@1099: console.log('slider '+id+' moved to '+this.value+' ('+time+')'); djmoffat@1099: $(this).removeClass('track-slider-not-moved'); djmoffat@1099: }; djmoffat@1099: djmoffat@1099: this.play.textContent = "Loading..."; djmoffat@1099: this.play.value = audioObject.id; djmoffat@1099: this.play.style.float = "left"; djmoffat@1099: this.play.style.width = "100%"; djmoffat@1099: this.play.disabled = true; djmoffat@1099: this.play.setAttribute("playstate","ready"); djmoffat@1099: this.play.onclick = function(event) djmoffat@1099: { djmoffat@1099: var id = Number(event.currentTarget.value); djmoffat@1099: //audioEngineContext.metric.sliderPlayed(id); djmoffat@1099: if (event.currentTarget.getAttribute("playstate") == "ready") djmoffat@1099: {audioEngineContext.play(id);} djmoffat@1099: else if (event.currentTarget.getAttribute("playstate") == "playing") djmoffat@1099: {audioEngineContext.stop();} djmoffat@1099: }; djmoffat@1099: djmoffat@1099: this.enable = function() { djmoffat@1099: this.play.disabled = false; djmoffat@1099: this.play.textContent = "Play"; djmoffat@1099: $(this.slider).removeClass('track-slider-disabled'); djmoffat@1099: }; djmoffat@1099: djmoffat@1099: this.exportXMLDOM = function(audioObject) { djmoffat@1099: // Called by the audioObject holding this element. Must be present djmoffat@1099: var node = storage.document.createElement('value'); djmoffat@1099: node.textContent = this.slider.value; djmoffat@1099: return node; djmoffat@1099: }; djmoffat@1099: this.startPlayback = function() djmoffat@1099: { djmoffat@1099: // Called when playback has begun djmoffat@1099: this.play.setAttribute("playstate","playing"); djmoffat@1099: $(".track-slider").removeClass('track-slider-playing'); djmoffat@1099: $(this.holder).addClass('track-slider-playing'); djmoffat@1099: var outsideReference = document.getElementById('outside-reference'); djmoffat@1099: if (outsideReference != null) { djmoffat@1099: $(outsideReference).removeClass('track-slider-playing'); djmoffat@1099: } djmoffat@1099: this.play.textContent = "Stop"; djmoffat@1099: }; djmoffat@1099: this.stopPlayback = function() djmoffat@1099: { djmoffat@1099: // Called when playback has stopped. This gets called even if playback never started! djmoffat@1099: this.play.setAttribute("playstate","ready"); djmoffat@1099: $(this.holder).removeClass('track-slider-playing'); djmoffat@1099: this.play.textContent = "Play"; djmoffat@1099: }; djmoffat@1099: this.getValue = function() { djmoffat@1099: return this.slider.value; djmoffat@1099: }; djmoffat@1099: djmoffat@1099: this.resize = function(event) djmoffat@1099: { djmoffat@1099: this.holder.style.height = window.innerHeight-200 + 'px'; djmoffat@1099: this.slider.style.height = window.innerHeight-250 + 'px'; djmoffat@1099: }; djmoffat@1099: this.updateLoading = function(progress) djmoffat@1099: { djmoffat@1099: progress = String(progress); djmoffat@1099: progress = progress.substr(0,5); djmoffat@1099: this.play.textContent = "Loading: "+progress+"%"; djmoffat@1099: }; djmoffat@1099: djmoffat@1099: if (this.parent.state == 1) djmoffat@1099: { djmoffat@1099: this.enable(); djmoffat@1099: } djmoffat@1099: this.getPresentedId = function() djmoffat@1099: { djmoffat@1099: return this.title.textContent; djmoffat@1099: }; djmoffat@1099: this.canMove = function() djmoffat@1099: { djmoffat@1099: return true; djmoffat@1099: }; djmoffat@1099: } djmoffat@1099: djmoffat@1099: function outsideReferenceDOM(audioObject,index,inject) djmoffat@1099: { djmoffat@1099: this.parent = audioObject; djmoffat@1099: this.outsideReferenceHolder = document.createElement('button'); djmoffat@1099: this.outsideReferenceHolder.id = 'outside-reference'; djmoffat@1099: this.outsideReferenceHolder.className = 'outside-reference'; djmoffat@1099: this.outsideReferenceHolder.setAttribute('track-id',index); djmoffat@1099: this.outsideReferenceHolder.textContent = "Play Reference"; djmoffat@1099: this.outsideReferenceHolder.disabled = true; djmoffat@1099: djmoffat@1099: this.outsideReferenceHolder.onclick = function(event) djmoffat@1099: { djmoffat@1099: audioEngineContext.play(event.currentTarget.getAttribute('track-id')); djmoffat@1099: }; djmoffat@1099: inject.appendChild(this.outsideReferenceHolder); djmoffat@1099: this.enable = function() djmoffat@1099: { djmoffat@1099: if (this.parent.state == 1) djmoffat@1099: { djmoffat@1099: this.outsideReferenceHolder.disabled = false; djmoffat@1099: } djmoffat@1099: }; djmoffat@1099: this.updateLoading = function(progress) djmoffat@1099: { djmoffat@1099: if (progress != 100) djmoffat@1099: { djmoffat@1099: progress = String(progress); djmoffat@1099: progress = progress.split('.')[0]; djmoffat@1099: this.outsideReferenceHolder[0].children[0].textContent = progress+'%'; djmoffat@1099: } else { djmoffat@1099: this.outsideReferenceHolder[0].children[0].textContent = "Play Reference"; djmoffat@1099: } djmoffat@1099: }; djmoffat@1099: this.startPlayback = function() djmoffat@1099: { djmoffat@1099: // Called when playback has begun djmoffat@1099: $('.track-slider').removeClass('track-slider-playing'); djmoffat@1099: $('.comment-div').removeClass('comment-box-playing'); djmoffat@1099: $(this.outsideReferenceHolder).addClass('track-slider-playing'); djmoffat@1099: }; djmoffat@1099: this.stopPlayback = function() djmoffat@1099: { djmoffat@1099: // Called when playback has stopped. This gets called even if playback never started! djmoffat@1099: $(this.outsideReferenceHolder).removeClass('track-slider-playing'); djmoffat@1099: }; djmoffat@1099: this.exportXMLDOM = function(audioObject) djmoffat@1099: { djmoffat@1099: return null; djmoffat@1099: }; djmoffat@1099: this.getValue = function() djmoffat@1099: { djmoffat@1099: return 0; djmoffat@1099: }; djmoffat@1099: this.getPresentedId = function() djmoffat@1099: { djmoffat@1099: return 'reference'; djmoffat@1099: }; djmoffat@1099: this.canMove = function() djmoffat@1099: { djmoffat@1099: return false; djmoffat@1099: }; djmoffat@1099: } djmoffat@1099: djmoffat@1099: function resizeWindow(event) djmoffat@1099: { djmoffat@1099: // Function called when the window has been resized. djmoffat@1099: // MANDATORY FUNCTION djmoffat@1099: djmoffat@1099: var outsideRef = document.getElementById('outside-reference'); djmoffat@1099: if(outsideRef != null) djmoffat@1099: { djmoffat@1099: outsideRef.style.left = (window.innerWidth-120)/2 + 'px'; djmoffat@1099: } djmoffat@1099: djmoffat@1099: // Auto-align djmoffat@1099: var numObj = document.getElementsByClassName('track-slider').length; djmoffat@1099: var totalWidth = (numObj-1)*150+100; djmoffat@1099: var diff = (window.innerWidth - totalWidth)/2; djmoffat@1099: document.getElementById('slider').style.height = window.innerHeight - 180 + 'px'; djmoffat@1099: if (diff <= 0){diff = 0;} djmoffat@1099: document.getElementById('slider-holder').style.marginLeft = diff + 'px'; djmoffat@1099: for (var i in audioEngineContext.audioObjects) djmoffat@1099: { djmoffat@1099: if (audioEngineContext.audioObjects[i].specification.type != 'outside-reference'){ djmoffat@1099: audioEngineContext.audioObjects[i].interfaceDOM.resize(event); djmoffat@1099: } djmoffat@1099: } djmoffat@1099: document.getElementById('scale-holder').style.marginLeft = (diff-100) + 'px'; djmoffat@1099: document.getElementById('scale-text-holder').style.height = window.innerHeight-194 + 'px'; djmoffat@1099: var canvas = document.getElementById('scale-canvas'); djmoffat@1099: canvas.width = totalWidth; djmoffat@1099: canvas.height = window.innerHeight-194; djmoffat@1099: drawScale(); djmoffat@1099: } djmoffat@1099: djmoffat@1099: function drawScale() djmoffat@1099: { djmoffat@1099: var interfaceObj = testState.currentStateMap.interfaces[0]; djmoffat@1099: var scales = testState.currentStateMap.interfaces[0].scales; djmoffat@1099: scales = scales.sort(function(a,b) { djmoffat@1099: return a.position - b.position; djmoffat@1099: }); djmoffat@1099: var canvas = document.getElementById('scale-canvas'); djmoffat@1099: var ctx = canvas.getContext("2d"); djmoffat@1099: var height = canvas.height; djmoffat@1099: var width = canvas.width; djmoffat@1099: var draw_heights = [24, height-34]; djmoffat@1099: var textHolder = document.getElementById('scale-text-holder'); djmoffat@1099: textHolder.innerHTML = null; djmoffat@1099: var lastHeight = 0; djmoffat@1099: for (var scale of scales) djmoffat@1099: { djmoffat@1099: var posPercent = scale.position / 100.0; djmoffat@1099: var posPix = (1-posPercent)*(draw_heights[1]-draw_heights[0])+draw_heights[0]; djmoffat@1099: ctx.fillStyle = "#000000"; djmoffat@1099: ctx.setLineDash([1,2]); djmoffat@1099: ctx.moveTo(0,posPix); djmoffat@1099: ctx.lineTo(width,posPix); djmoffat@1099: ctx.stroke(); djmoffat@1099: var text = document.createElement('div'); djmoffat@1099: text.align = "right"; djmoffat@1099: var textC = document.createElement('span'); djmoffat@1099: textC.textContent = scale.text; djmoffat@1099: text.appendChild(textC); djmoffat@1099: text.className = "scale-text"; djmoffat@1099: textHolder.appendChild(text); djmoffat@1099: text.style.top = (posPix-9) + 'px'; djmoffat@1099: text.style.left = 100 - ($(text).width()+3) + 'px'; djmoffat@1099: lastHeight = posPix; djmoffat@1099: } djmoffat@1099: } djmoffat@1099: djmoffat@1099: function buttonSubmitClick() // TODO: Only when all songs have been played! djmoffat@1099: { djmoffat@1099: var checks = []; djmoffat@1099: checks = checks.concat(testState.currentStateMap.interfaces[0].options); djmoffat@1099: checks = checks.concat(specification.interfaces.options); djmoffat@1099: var canContinue = true; djmoffat@1099: djmoffat@1099: // Check that the anchor and reference objects are correctly placed djmoffat@1099: if (interfaceContext.checkHiddenAnchor() == false) {return;} djmoffat@1099: if (interfaceContext.checkHiddenReference() == false) {return;} djmoffat@1099: djmoffat@1099: for (var i=0; i saves djmoffat@1099: // Get the current information in store (remember to appendChild your data to it) djmoffat@1099: // pageSpecification is the current page node configuration djmoffat@1099: // To create new XML nodes, use storage.document.createElement(); djmoffat@1099: }