n@619: /**
n@619:  * WAET Blank Template
n@619:  * Use this to start building your custom interface
n@619:  */
n@619: 
n@619: // Once this is loaded and parsed, begin execution
n@619: loadInterface();
n@619: 
n@619: function loadInterface() {
n@619: 	// Use this to do any one-time page / element construction. For instance, placing any stationary text objects,
n@619: 	// holding div's, or setting up any nodes which are present for the entire test sequence
n@619:     
n@621:     interfaceContext.insertPoint.innerHTML = null; // Clear the current schema
n@621:     
n@619:     // Custom comparator Object
n@619: 	Interface.prototype.comparator = null;
n@619:     
n@619:     // The injection point into the HTML page
n@619: 	interfaceContext.insertPoint = document.getElementById("topLevelBody");
n@619: 	var testContent = document.createElement('div');
n@619: 	testContent.id = 'testContent';
n@619:     
n@619:     // Create the top div for the Title element
n@619: 	var titleAttr = specification.title;
n@619: 	var title = document.createElement('div');
n@619: 	title.className = "title";
n@619: 	title.align = "center";
n@619: 	var titleSpan = document.createElement('span');
n@619:     
n@619:     // Set title to that defined in XML, else set to default
n@619: 	if (titleAttr != undefined) {
n@619: 		titleSpan.textContent = titleAttr;
n@619: 	} else {
n@619: 		titleSpan.textContent =  'Listening test';
n@619: 	}
n@619: 	// Insert the titleSpan element into the title div element.
n@619: 	title.appendChild(titleSpan);
n@619:     
n@619:     var pagetitle = document.createElement('div');
n@619: 	pagetitle.className = "pageTitle";
n@619: 	pagetitle.align = "center";
n@619: 	var titleSpan = document.createElement('span');
n@619: 	titleSpan.id = "pageTitle";
n@619: 	pagetitle.appendChild(titleSpan);
n@619: 	
n@619: 	// Create Interface buttons!
n@619: 	var interfaceButtons = document.createElement('div');
n@619: 	interfaceButtons.id = 'interface-buttons';
n@619: 	interfaceButtons.style.height = '25px';
n@619: 	
n@619: 	// Create playback start/stop points
n@619: 	var playback = document.createElement("button");
n@619: 	playback.innerHTML = 'Stop';
n@619: 	playback.id = 'playback-button';
n@619: 	playback.style.float = 'left';
n@619: 	// onclick function. Check if it is playing or not, call the correct function in the
n@619: 	// audioEngine, change the button text to reflect the next state.
n@619: 	playback.onclick = function() {
n@619: 		if (audioEngineContext.status == 1) {
n@619: 			audioEngineContext.stop();
n@619: 			this.innerHTML = 'Stop';
n@619:             var time = audioEngineContext.timer.getTestTime();
n@619:             console.log('Stopped at ' + time); // DEBUG/SAFETY
n@619: 		}
n@619: 	};
n@619: 	// Append the interface buttons into the interfaceButtons object.
n@619: 	interfaceButtons.appendChild(playback);
n@619: 	
n@619: 	// Global parent for the comment boxes on the page
n@619: 	var feedbackHolder = document.createElement('div');
n@619: 	feedbackHolder.id = 'feedbackHolder';
n@619: 	
n@619: 	// Construct the AB Boxes
n@619: 	var boxes = document.createElement('div');
n@619: 	boxes.align = "center";
n@619: 	boxes.id = "box-holders";
n@619:     boxes.style.float = "left";
n@619: 	
n@619: 	var submit = document.createElement('button');
n@619: 	submit.id = "submit";
n@619: 	submit.onclick = buttonSubmitClick;
n@619: 	submit.className = "big-button";
n@619: 	submit.textContent = "submit";
n@619: 	submit.style.position = "relative";
n@619: 	submit.style.left = (window.innerWidth-250)/2 + 'px';
n@619: 		
n@619: 	feedbackHolder.appendChild(boxes);
n@619: 	
n@619: 	// Inject into HTML
n@619: 	testContent.appendChild(title); // Insert the title
n@619: 	testContent.appendChild(pagetitle);
n@619: 	testContent.appendChild(interfaceButtons);
n@619: 	testContent.appendChild(feedbackHolder);
n@619: 	testContent.appendChild(submit);
n@619: 	interfaceContext.insertPoint.appendChild(testContent);
n@619: 
n@619: 	// Load the full interface
n@619: 	testState.initialise();
n@619: 	testState.advanceState();
n@619: };
n@619: 
n@619: function loadTest(page)
n@619: {
n@619: 	// Called each time a new test page is to be build. The page specification node is the only item passed in
n@621:     document.getElementById('box-holders').innerHTML = null;
n@621:     
n@621:     var interfaceObj = page.interfaces;
n@621: 	if (interfaceObj.length > 1)
n@621: 	{
n@621: 		console.log("WARNING - This interface only supports one <interface> node per page. Using first interface node");
n@621: 	}
n@621: 	interfaceObj = interfaceObj[0];
n@621: 	
n@621: 	if(interfaceObj.title != null)
n@621: 	{
n@621: 		document.getElementById("pageTitle").textContent = interfaceObj.title;
n@621: 	}
n@621:     
n@621:     var interfaceOptions = specification.interfaces.options.concat(interfaceObj.options);
n@621:     for (var option of interfaceOptions)
n@621:     {
n@621:         if (option.type == "show")
n@621:         {
n@621:             switch(option.name) {
n@621:                 case "playhead":
n@621:                     var playbackHolder = document.getElementById('playback-holder');
n@621:                     if (playbackHolder == null)
n@621:                     {
n@621:                         playbackHolder = document.createElement('div');
n@621:                         playbackHolder.style.width = "100%";
n@621:                         playbackHolder.style.float = "left";
n@621:                         playbackHolder.align = 'center';
n@621:                         playbackHolder.appendChild(interfaceContext.playhead.object);
n@621:                         feedbackHolder.appendChild(playbackHolder);
n@621:                     }
n@621:                     break;
n@621:                 case "page-count":
n@621:                     var pagecountHolder = document.getElementById('page-count');
n@621:                     if (pagecountHolder == null)
n@621:                     {
n@621:                         pagecountHolder = document.createElement('div');
n@621:                         pagecountHolder.id = 'page-count';
n@621:                     }
n@621:                     pagecountHolder.innerHTML = '<span>Page '+(testState.stateIndex+1)+' of '+testState.stateMap.length+'</span>';
n@621:                     var inject = document.getElementById('interface-buttons');
n@621:                     inject.appendChild(pagecountHolder);
n@621:                     break;
n@621:                 case "volume":
n@621:                     if (document.getElementById('master-volume-holder') == null)
n@621:                     {
n@621:                         feedbackHolder.appendChild(interfaceContext.volume.object);
n@621:                     }
n@621:                     break;
n@621:             }
n@621:         }
n@621:     }
n@621:     
n@619:     interfaceContext.comparator = new comparator(page);
n@621:     resizeWindow(null);
n@619: }
n@619: 
n@619: function comparator(page)
n@619: {
n@619:     // Build prototype constructor
n@619:     this.interfaceObject = function(element,label)
n@619:     {
n@619:         // An example node, you can make this however you want for each audioElement.
n@619:         // However, every audioObject (audioEngineContext.audioObject) MUST have an interface object with the following
n@619:         // You attach them by calling audioObject.bindInterface( )
n@619:         this.parent = element;
n@619:         this.id = element.id;
n@619:         this.value = 0;
n@619:         this.disabled = true;
n@619:         this.box = document.createElement('div');
n@619:         this.box.className = 'comparator-holder';
n@619: 		this.box.setAttribute('track-id',element.id);
n@619: 		this.box.id = 'comparator-'+label;
n@619:         this.selector = document.createElement('div');
n@619: 		this.selector.className = 'comparator-selector disabled';
n@619: 		var selectorText = document.createElement('span');
n@619: 		selectorText.textContent = label;
n@619: 		this.selector.appendChild(selectorText);
n@619: 		this.playback = document.createElement('button');
n@619: 		this.playback.className = 'comparator-button';
n@619: 		this.playback.disabled = true;
n@619: 		this.playback.textContent = "Listen";
n@619: 		this.box.appendChild(this.selector);
n@619: 		this.box.appendChild(this.playback);
n@619:         this.selector.onclick = function(event)
n@619: 		{
n@619:             var label = event.currentTarget.children[0].textContent;
n@619:             if (label == "X" || label == "x") {return;}
n@619: 			var time = audioEngineContext.timer.getTestTime();
n@619: 			if ($(event.currentTarget).hasClass('disabled'))
n@619: 			{
n@619: 				console.log("Please wait until sample has loaded");
n@619: 				return;
n@619: 			}
n@619: 			if (audioEngineContext.status == 0)
n@619: 			{
n@619: 				alert("Please listen to the samples before making a selection");
n@619: 				console.log("Please listen to the samples before making a selection");
n@619: 				return;
n@619:             }
n@619: 			var id = event.currentTarget.parentElement.getAttribute('track-id');
n@619: 			interfaceContext.comparator.selected = id;
n@619:             if ($(event.currentTarget).hasClass("selected")) {
n@619:                 $(".comparator-selector").removeClass('selected');
n@619:                 for (var i=0; i<interfaceContext.comparator.comparators.length; i++)
n@619:                 {
n@619:                      var obj = interfaceContext.comparator.comparators[i];
n@619:                     obj.parent.metric.moved(time,0);
n@619:                 }
n@619:             } else {
n@619:                 $(".comparator-selector").removeClass('selected');
n@619:                 $(event.currentTarget).addClass('selected');
n@619:                 for (var i=0; i<interfaceContext.comparator.comparators.length; i++)
n@619:                 {
n@619:                     var obj = interfaceContext.comparator.comparators[i];
n@619:                     if (i == id) {
n@619:                         obj.value = 1;
n@619:                     } else {
n@619:                         obj.value = 0;
n@619:                     }
n@619:                     obj.parent.metric.moved(time,obj.value);
n@619:                 }
n@619:                 console.log("Selected "+id+' ('+time+')');
n@619:             }
n@619: 		};
n@619:         this.playback.setAttribute("playstate","ready");
n@619: 		this.playback.onclick = function(event)
n@619: 		{
n@619: 			var id = event.currentTarget.parentElement.getAttribute('track-id');
n@619:             if (event.currentTarget.getAttribute("playstate") == "ready")
n@619:             {
n@619:                 audioEngineContext.play(id);
n@619:             } else if (event.currentTarget.getAttribute("playstate") == "playing") {
n@619:                 audioEngineContext.stop();
n@619:             }
n@619: 			
n@619: 		};
n@619:         this.enable = function()
n@619:         {
n@619:             // This is used to tell the interface object that playback of this node is ready
n@619:             if (this.parent.state == 1)
n@619: 			{
n@619: 				$(this.selector).removeClass('disabled');
n@619: 				this.playback.disabled = false;
n@619: 			}
n@619:         };
n@619:         this.updateLoading = function(progress)
n@619:         {
n@619:             // progress is a value from 0 to 100 indicating the current download state of media files
n@619:             if (progress != 100)
n@619: 			{
n@619: 				progress = String(progress);
n@619: 				progress = progress.split('.')[0];
n@619: 				this.playback.textContent = progress+'%';
n@619: 			} else {
n@619: 				this.playback.textContent = "Play";
n@619: 			}
n@619:         };
n@619:         this.error = function() {
n@619:             // audioObject has an error!!
n@619:             this.playback.textContent = "Error";
n@619:             $(this.playback).addClass("error-colour");
n@619:         };
n@619:         this.startPlayback = function()
n@619:         {
n@619:             // Called when playback has begun
n@619:             $('.comparator-button').text('Listen');
n@619:             $(this.playback).text('Stop');
n@619:             this.playback.setAttribute("playstate","playing");
n@619:         };
n@619:         this.stopPlayback = function()
n@619:         {
n@619:             // Called when playback has stopped. This gets called even if playback never started!
n@619:             $(this.playback).text('Listen');
n@619:             this.playback.setAttribute("playstate","ready");
n@619:         };
n@619:         this.getValue = function()
n@619:         {
n@619:             // Return the current value of the object. If there is no value, return 0
n@619:             return this.value;
n@619:         };
n@619:         this.getPresentedId = function()
n@619:         {
n@619:             // Return the presented ID of the object. For instance, the APE has sliders starting from 0. Whilst AB has alphabetical scale
n@619:             return this.selector.children[0].textContent;
n@619:         };
n@619:         this.canMove = function()
n@619:         {
n@619:             // Return either true or false if the interface object can be moved. AB / Reference cannot, whilst sliders can and therefore have a continuous scale.
n@619:             // These are checked primarily if the interface check option 'fragmentMoved' is enabled.
n@619:             return false;
n@619:         };
n@619:         this.exportXMLDOM = function(audioObject) {
n@619:             // Called by the audioObject holding this element to export the interface <value> node.
n@619:             // If there is no value node (such as outside reference), return null
n@619:             // If there are multiple value nodes (such as multiple scale / 2D scales), return an array of nodes with each value node having an 'interfaceName' attribute
n@619:             // Use storage.document.createElement('value'); to generate the XML node.
n@619:             var node = storage.document.createElement('value');
n@619: 			node.textContent = this.value;
n@619: 			return node;
n@619: 
n@619:         };
n@619:         this.error = function() {
n@619:             // If there is an error with the audioObject, this will be called to indicate a failure
n@619:         }
n@619:     };
n@619:     // Ensure there are only two comparisons per page
n@619:     if (page.audioElements.length != 2) {
n@619:         console.error('FATAL - There must be 2 <audioelement> nodes on each <page>: '+page.id);
n@619:         return;
n@619:     }
n@619:     // Build the three audio elements
n@619:     this.pair = [];
n@619:     this.X = null;
n@619:     this.boxHolders = document.getElementById('box-holders');
n@619:     for (var index=0; index<page.audioElements.length; index++) {
n@619:         var element = page.audioElements[index];
n@619:         if (element.type != 'normal')
n@619: 		{
n@619: 			console.log("WARNING - ABX can only have normal elements. Page "+page.id+", Element "+element.id);
n@619:             element.type = "normal";
n@619: 		}
n@619:         var audioObject = audioEngineContext.newTrack(element);
n@619:         var label;
n@619:         switch(audioObject.specification.parent.label) {
n@619:             case "none":
n@619:                 label = "";
n@619:                 break;
n@619:             case "number":
n@619:                 label = ""+index;
n@619:                 break;
n@619:             case "letter":
n@619:                 label = String.fromCharCode(97 + index);
n@619:                 break;
n@619:             default:
n@619:                 label = String.fromCharCode(65 + index);
n@619:                 break;
n@619:         }
n@619:         var node = new this.interfaceObject(audioObject,label);
n@619:         audioObject.bindInterface(node);
n@619:         this.pair.push(node);
n@619:         this.boxHolders.appendChild(node.box);
n@619:     }
n@619:     var elementId = Math.floor(Math.random() * 2); //Randomly pick A or B to be X
n@619:     var element = new page.audioElementNode();
n@619:     for (var atr in page.audioElements[elementId]) {
n@619:         eval("element."+atr+" = page.audioElements[elementId]."+atr);
n@619:     }
n@619:     element.id += "-X";
n@619:     if (typeof element.name == "string") {element.name+="-X";}
n@619:     page.audioElements.push(element);
n@619:     // Create the save place-holder for the 'X' element
n@619:     var root = testState.currentStore.XMLDOM;
n@619:     var aeNode = storage.document.createElement('audioelement');
n@619:     aeNode.setAttribute('ref',element.id);
n@619:     if (typeof element.name == "string"){aeNode.setAttribute('name',element.name);}
n@619:     aeNode.setAttribute('type','normal');
n@619:     aeNode.setAttribute('url',element.url);
n@619:     aeNode.setAttribute('gain',element.gain);
n@619:     aeNode.appendChild(storage.document.createElement('metric'));
n@619:     root.appendChild(aeNode);
n@619:     // Build the 'X' element
n@619:     var audioObject = audioEngineContext.newTrack(element);
n@619:     var label;
n@619:     switch(audioObject.specification.parent.label) {
n@619:         case "letter":
n@619:             label = "x";
n@619:             break;
n@619:         default:
n@619:             label = "X";
n@619:             break;
n@619:     }
n@619:     var node = new this.interfaceObject(audioObject,label);
n@619:     audioObject.bindInterface(node);
n@619:     this.X = node;
n@619:     this.boxHolders.appendChild(node.box);
n@619: }
n@619: 
n@619: function resizeWindow(event)
n@619: {
n@621: 	document.getElementById('submit').style.left = (window.innerWidth-250)/2 + 'px';
n@621: 	var numObj = 3;
n@621: 	var boxW = numObj*312;
n@621:     var diff = window.innerWidth - boxW;
n@621:     while (diff < 0)
n@621:     {
n@621:         numObj = Math.ceil(numObj/2);
n@621:         boxW = numObj*312;
n@621:         diff = window.innerWidth - boxW;
n@621:     }
n@621:     document.getElementById('box-holders').style.marginLeft = diff/2 + 'px';
n@621:     document.getElementById('box-holders').style.marginRight = diff/2 + 'px';
n@621:     document.getElementById('box-holders').style.width = boxW + 'px';
n@619: }
n@619: 
n@619: function buttonSubmitClick()
n@619: {
n@621: 	var checks = [];
n@621: 	checks = checks.concat(testState.currentStateMap.interfaces[0].options);
n@621: 	checks = checks.concat(specification.interfaces.options);
n@621: 	var canContinue = true;
n@621: 	
n@621: 	for (var i=0; i<checks.length; i++) {
n@621: 		if (checks[i].type == 'check')
n@621: 		{
n@621: 			switch(checks[i].name) {
n@621: 			case 'fragmentPlayed':
n@621: 				// Check if all fragments have been played
n@621: 				var checkState = interfaceContext.checkAllPlayed();
n@621: 				if (checkState == false) {canContinue = false;}
n@621: 				break;
n@621: 			case  'fragmentFullPlayback':
n@621: 				// Check all fragments have been played to their full length
n@621: 				var checkState = interfaceContext.checkFragmentsFullyPlayed();
n@621: 				if (checkState == false) {canContinue = false;}
n@621: 				break;
n@621: 			case 'fragmentMoved':
n@621: 				// Check all fragment sliders have been moved.
n@621: 				var checkState = interfaceContext.checkAllMoved();
n@621: 				if (checkState == false) {canContinue = false;}
n@621: 				break;
n@621: 			case 'fragmentComments':
n@621: 				// Check all fragment sliders have been moved.
n@621: 				var checkState = interfaceContext.checkAllCommented();
n@621: 				if (checkState == false) {canContinue = false;}
n@621: 				break;
n@621: 			default:
n@621: 				console.log("WARNING - Check option "+checks[i].check+" is not supported on this interface");
n@621: 				break;
n@621: 			}
n@621: 
n@621: 		}
n@621: 		if (!canContinue) {break;}
n@621: 	}
n@621: 	if (canContinue)
n@621: 	{
n@621: 	    if (audioEngineContext.status == 1) {
n@621: 	        var playback = document.getElementById('playback-button');
n@621: 	        playback.click();
n@621: 	    // This function is called when the submit button is clicked. Will check for any further tests to perform, or any post-test options
n@621: 	    } else
n@621: 	    {
n@621: 	        if (audioEngineContext.timer.testStarted == false)
n@621: 	        {
n@621: 	            alert('You have not started the test! Please press start to begin the test!');
n@621: 	            return;
n@621: 	        }
n@621: 	    }
n@621: 	    testState.advanceState();
n@621: 	}
n@619: }
n@619: 
n@619: function pageXMLSave(store, pageSpecification)
n@619: {
n@619: 	// MANDATORY
n@619: 	// Saves a specific test page
n@619: 	// You can use this space to add any extra nodes to your XML <audioHolder> saves
n@619: 	// Get the current <page> information in store (remember to appendChild your data to it)
n@619: 	// pageSpecification is the current page node configuration
n@619: 	// To create new XML nodes, use storage.document.createElement();
n@619: }