annotate docs/SMC15/smc2015template.tex @ 761:af6cfa619c24

Browser GET support. In the project URL, you can select the test page to load by using http://server.com/index.html?url=server/path/to/project.xml
author Nicholas Jillings <nicholas.jillings@eecs.qmul.ac.uk>
date Thu, 17 Dec 2015 16:48:08 +0000
parents c73996a0fb21
children 8ab5f8969856
rev   line source
nicholas@755 1 % -----------------------------------------------
nicholas@755 2 % Template for SMC 2012
nicholas@755 3 % adapted from the template for SMC 2011, which was adapted from that of SMC 2010
nicholas@755 4 % -----------------------------------------------
nicholas@755 5
nicholas@755 6 \documentclass{article}
nicholas@755 7 \usepackage{smc2015}
nicholas@755 8 \usepackage{times}
nicholas@755 9 \usepackage{ifpdf}
nicholas@755 10 \usepackage[english]{babel}
nicholas@755 11 \usepackage{cite}
nicholas@755 12 \usepackage{enumitem}
nicholas@755 13 \usepackage{listings}
nicholas@755 14 \setitemize{noitemsep,topsep=0pt,parsep=0pt,partopsep=0pt}
nicholas@755 15
nicholas@755 16
nicholas@755 17
nicholas@755 18 \usepackage{color}
nicholas@755 19 \definecolor{grey}{rgb}{0.1,0.1,0.1}
nicholas@755 20 \definecolor{darkblue}{rgb}{0.0,0.0,0.6}
nicholas@755 21 \definecolor{cyan}{rgb}{0.0,0.6,0.6}
nicholas@755 22
nicholas@755 23
nicholas@755 24 \hyphenation{Java-script}
nicholas@755 25 \hyphenation{OPA-QUE}
nicholas@755 26
nicholas@755 27 %%%%%%%%%%%%%%%%%%%%%%%% Some useful packages %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
nicholas@755 28 %%%%%%%%%%%%%%%%%%%%%%%% See related documentation %%%%%%%%%%%%%%%%%%%%%%%%%%
nicholas@755 29 %\usepackage{amsmath} % popular packages from Am. Math. Soc. Please use the
nicholas@755 30 %\usepackage{amssymb} % related math environments (split, subequation, cases,
nicholas@755 31 %\usepackage{amsfonts}% multline, etc.)
nicholas@755 32 %\usepackage{bm} % Bold Math package, defines the command \bf{}
nicholas@755 33 %\usepackage{paralist}% extended list environments
nicholas@755 34 %%subfig.sty is the modern replacement for subfigure.sty. However, subfig.sty
nicholas@755 35 %%requires and automatically loads caption.sty which overrides class handling
nicholas@755 36 %%of captions. To prevent this problem, preload caption.sty with caption=false
nicholas@755 37 %\usepackage[caption=false]{caption}
nicholas@755 38 %\usepackage[font=footnotesize]{subfig}
nicholas@755 39
nicholas@755 40
nicholas@755 41 %user defined variables
nicholas@755 42 \def\papertitle{WEB AUDIO EVALUATION TOOL: A BROWSER-BASED LISTENING TEST ENVIRONMENT} %?
nicholas@755 43 \def\firstauthor{Nicholas Jillings}
nicholas@755 44 \def\secondauthor{Brecht De Man}
nicholas@755 45 \def\thirdauthor{David Moffat}
nicholas@755 46 \def\fourthauthor{Joshua D. Reiss}
nicholas@755 47
nicholas@755 48 % adds the automatic
nicholas@755 49 % Saves a lot of ouptut space in PDF... after conversion with the distiller
nicholas@755 50 % Delete if you cannot get PS fonts working on your system.
nicholas@755 51
nicholas@755 52 % pdf-tex settings: detect automatically if run by latex or pdflatex
nicholas@755 53 \newif\ifpdf
nicholas@755 54 \ifx\pdfoutput\relax
nicholas@755 55 \else
nicholas@755 56 \ifcase\pdfoutput
nicholas@755 57 \pdffalse
nicholas@755 58 \else
nicholas@755 59 \pdftrue
nicholas@755 60 \fi
nicholas@755 61
nicholas@755 62 \ifpdf % compiling with pdflatex
nicholas@755 63 \usepackage[pdftex,
nicholas@755 64 pdftitle={\papertitle},
nicholas@755 65 pdfauthor={\firstauthor, \secondauthor, \thirdauthor},
nicholas@755 66 bookmarksnumbered, % use section numbers with bookmarks
nicholas@755 67 pdfstartview=XYZ % start with zoom=100% instead of full screen;
nicholas@755 68 % especially useful if working with a big screen :-)
nicholas@755 69 ]{hyperref}
nicholas@755 70 %\pdfcompresslevel=9
nicholas@755 71
nicholas@755 72 \usepackage[pdftex]{graphicx}
nicholas@755 73 % declare the path(s) where your graphic files are and their extensions so
nicholas@755 74 %you won't have to specify these with every instance of \includegraphics
nicholas@755 75 \graphicspath{{./figures/}}
nicholas@755 76 \DeclareGraphicsExtensions{.pdf,.jpeg,.png}
nicholas@755 77
nicholas@755 78 \usepackage[figure,table]{hypcap}
nicholas@755 79
nicholas@755 80 \else % compiling with latex
nicholas@755 81 \usepackage[dvips,
nicholas@755 82 bookmarksnumbered, % use section numbers with bookmarks
nicholas@755 83 pdfstartview=XYZ % start with zoom=100% instead of full screen
nicholas@755 84 ]{hyperref} % hyperrefs are active in the pdf file after conversion
nicholas@755 85
nicholas@755 86 \usepackage[dvips]{epsfig,graphicx}
nicholas@755 87 % declare the path(s) where your graphic files are and their extensions so
nicholas@755 88 %you won't have to specify these with every instance of \includegraphics
nicholas@755 89 \graphicspath{{./figures/}}
nicholas@755 90 \DeclareGraphicsExtensions{.eps}
nicholas@755 91
nicholas@755 92 \usepackage[figure,table]{hypcap}
nicholas@755 93 \fi
nicholas@755 94
nicholas@755 95 %set up the hyperref package - make the links black without a surrounding frame
nicholas@755 96 \hypersetup{
nicholas@755 97 colorlinks,%
nicholas@755 98 citecolor=black,%
nicholas@755 99 filecolor=black,%
nicholas@755 100 linkcolor=black,%
nicholas@755 101 urlcolor=black
nicholas@755 102 }
nicholas@755 103
nicholas@755 104
nicholas@755 105 % Title.
nicholas@755 106 % ------
nicholas@755 107 \title{\papertitle}
nicholas@755 108
nicholas@755 109 % Authors
nicholas@755 110 % Please note that submissions are NOT anonymous, therefore
nicholas@755 111 % authors' names have to be VISIBLE in your manuscript.
nicholas@755 112 %
nicholas@755 113 % Single address
nicholas@755 114 % To use with only one author or several with the same address
nicholas@755 115 % ---------------
nicholas@755 116 %\oneauthor
nicholas@755 117 % {\firstauthor} {Affiliation1 \\ %
nicholas@755 118 % {\tt \href{mailto:author1@smcnetwork.org}{author1@smcnetwork.org}}}
nicholas@755 119
nicholas@755 120 %Two addresses
nicholas@755 121 %--------------
nicholas@755 122 % \twoauthors
nicholas@755 123 % {\firstauthor} {Affiliation1 \\ %
nicholas@755 124 % {\tt \href{mailto:author1@smcnetwork.org}{author1@smcnetwork.org}}}
nicholas@755 125 % {\secondauthor} {Affiliation2 \\ %
nicholas@755 126 % {\tt \href{mailto:author2@smcnetwork.org}{author2@smcnetwork.org}}}
nicholas@755 127
nicholas@755 128
nicholas@755 129
nicholas@755 130 % FIX!!!
nicholas@755 131 \fourauthors
nicholas@755 132 {\firstauthor} {%Affiliation1 \\
nicholas@755 133 {\tt \href{mailto:b.deman@qmul.ac.uk}{n.g.r.jillings@se14.qmul.ac.uk, }}}
nicholas@755 134 {\secondauthor} {%Affiliation2\\ %
nicholas@755 135 {\tt \href{mailto:n.g.r.jillings@se14.qmul.ac.uk}{\{b.deman,}}}
nicholas@755 136 {\thirdauthor} {%Affiliation3\\ %
nicholas@755 137 {\tt \href{mailto:d.j.moffat@qmul.ac.uk}{d.j.moffat, }}}
nicholas@755 138 {\fourthauthor} {%Affiliation4\\ %
nicholas@755 139 {\tt \href{mailto:joshua.reiss@qmul.ac.uk}{joshua.reiss\}@qmul.ac.uk}}}
nicholas@755 140
nicholas@755 141 % ***************************************** the document starts here ***************
nicholas@755 142 \begin{document}
nicholas@755 143 %
nicholas@755 144 \capstartfalse
nicholas@755 145 \maketitle
nicholas@755 146 \capstarttrue
nicholas@755 147 %
nicholas@755 148 \begin{abstract}
nicholas@755 149 Perceptual evaluation tests where subjects assess certain qualities of different audio fragments are an integral part of audio and music research. These require specialised software, usually custom-made, to collect large amounts of data using meticulously designed interfaces with carefully formulated questions, and play back audio with rapid switching between different samples.
nicholas@755 150 New functionality in HTML5 included in the Web Audio API allows for increasingly powerful media applications in a platform independent environment. The advantage of a web application is easy deployment on any platform, without requiring any other application, enabling multiple tests to be easily conducted across locations. In this paper we propose a tool supporting a wide variety of easily configurable, multi-stimulus perceptual audio evaluation tests over the web with multiple test interfaces, pre- and post-test surveys, custom configuration, collection of test metrics and other features. Test design and setup doesn't require programming background, and results are gathered automatically using web friendly formats for easy storing of results on a server.
nicholas@755 151 % Currently at 150, don't think anything more needs to be done here??
nicholas@755 152 %Place your abstract at the top left column on the first page.
nicholas@755 153 %Please write about 150-200 words that specifically highlight the purpose of your work,
nicholas@755 154 %its context, and provide a brief synopsis of your results.
nicholas@755 155 %Avoid equations in this part.\\
nicholas@755 156
nicholas@755 157 \end{abstract}
nicholas@755 158
nicholas@755 159 % TOTAL PAPER: Minimum 4 pages, 6 preferred, max. 8 (6 for demos/posters)\\
nicholas@755 160
nicholas@755 161 \section{Introduction}\label{sec:introduction}
nicholas@755 162
nicholas@755 163 %NICK: examples of what kind of audio applications HTML5 has made possible, with references to publications (or website)\\
nicholas@755 164
nicholas@755 165 Perceptual evaluation of audio plays an important role in a wide range of research on audio quality \cite{schoeffler2013impact,repp}, sound synthesis \cite{de2013real,durr2015implementation}, audio effect design \cite{deman2014a}, source separation \cite{mushram,uhlereiss}, music and emotion analysis \cite{song2013a,eerola2009prediction}, and many others \cite{friberg2011comparison}. % codec design?
nicholas@755 166
nicholas@755 167 %This work is based in part on the APE audio perceptual evaluation interface for MATLAB \cite{deman2014b}. An important drawback of this toolbox is the need to have MATLAB to create a test and even to run (barring the use of an executable generated by MATLAB), and limited compatibility with both earlier and newer versions of MATLAB, which makes it hard to maintain. On the other hand, a web application generally has the advantage of running in most browsers on most applications.
nicholas@755 168
nicholas@755 169 % IMPORTANT
nicholas@755 170 %[TO ADD: other interfaces for perceptual evaluation of audio, browser-based or not!] \\
nicholas@755 171 %BROWSER-BASED: \cite{song2013b,song2013a,beaqlejs} \\
nicholas@755 172 %MATLAB: \cite{whisper,mushram,scale}
nicholas@755 173 % to add: OPAQUE, Rumsey's repertory grid technique
nicholas@755 174
nicholas@755 175
nicholas@755 176 \begin{table}[htdp]
nicholas@755 177 \caption{Available audio perceptual evaluation tools}
nicholas@755 178 \begin{center}
nicholas@755 179 \begin{tabular}{|*{3}{l|}}
nicholas@755 180 % order?
nicholas@755 181 \hline
nicholas@755 182 \textbf{Name} & \textbf{Language} & \textbf{Ref.}\\
nicholas@755 183 \hline
nicholas@755 184 APE & MATLAB & \cite{deman2014b} \\
nicholas@755 185 BeaqleJS & HTML5/JS & \cite{beaqlejs}\\ % ABX, mushra
nicholas@755 186 %C4DM\footnote{http://isophonics.org/test - collection of listening tests developed by Gy\"{o}rgy Fazekas and Thomas Wilmering at Centre for Digital Music.} & JS & \cite{song2013a,song2013b}\\
nicholas@755 187 HULTI-GEN & Max & \cite{hulti-gen}\\
nicholas@755 188 MUSHRAM & MATLAB & \cite{mushram}\\ % type: mushra
nicholas@755 189 Scale & MATLAB & \cite{scale} \\
nicholas@755 190 WhisPER & MATLAB & \cite{whisper}\\
nicholas@755 191 \hline
nicholas@755 192 \end{tabular}
nicholas@755 193 \end{center}
nicholas@755 194 \label{tab:interfaces}
nicholas@755 195 \end{table}%
nicholas@755 196
nicholas@755 197 Various listening test design tools are already available, see Table \ref{tab:interfaces}. A few other listening test tools, such as OPAQUE \cite{opaque} and GuineaPig \cite{guineapig}, are described but not available to the public at the time of writing.
nicholas@755 198
nicholas@755 199 Many are MATLAB-based, useful for easily processing and visualising the data produced by the listening tests, but requiring MATLAB to be installed to run or - in the case of an executable created with MATLAB - at least create the test.
nicholas@755 200 Furthermore, compatibility is usually limited across different versions of MATLAB.
nicholas@755 201 Similarly, Max requires little or no programming background but it is proprietary software as well, which is especially undesirable when tests need to be deployed at different sites.
nicholas@755 202 More recently, BeaqleJS \cite{beaqlejs} makes use of the HTML5 audio capabilities and comes with a number of predefined, established test interfaces such as ABX and MUSHRA \cite{mushra}. BeaqleJS provides a number of similar features including saving of test data to a web server. The main difference is that with BeaqleJS, the configuration is done through writting a JavaScript file holding a JavaScript Object of the notation. Instead our presented system uses the XML document standard, which allows configuration outside of a web-centric editor. The results are also presented in XML again allowing 3\textsuperscript{rd} party editors and programs to easily access. Finally, the presented system does not require web access to run, instead being deployed with a Python server script. This is particularly useful in studios where machines may not, by design, be web connected, or use in locations where web access is limited.
nicholas@755 203
nicholas@755 204 A browser-based perceptual evaluation tool for audio has a number of advantages. First of all, it doesn't need any other software than a browser, meaning deployment is very easy and cheap. As such, it can also run on a variety of devices and platforms. The test can be hosted on a central server with subjects all over the world, who can simply go to a webpage. This means that multiple participants can take the test simultaneously, potentially in their usual listening environment if this is beneficial for the test. Naturally, the constraints on the listening environment and other variables still need to be controlled if they are important to the experiment. Depending on the requirements a survey or a variety of tests preceding the experiment could establish whether remote participants and their environments are adequate for the experiment at hand.
nicholas@755 205
nicholas@755 206 The Web Audio API is a high-level JavaScript Application Programming Interface (API) designed for real-time processing of audio inside the browser through various processing nodes\footnote{http://webaudio.github.io/web-audio-api/}. Various web sites have used the Web Audio API for creative purposes, such as drum machines and score creation tools\footnote{http://webaudio.github.io/demo-list/},
nicholas@755 207 others from the list show real-time captured audio processing such as room reverberation tools and a phase vocoder from the system microphone. The BBC Radiophonic Workshop shows effects used on famous TV shows such as Doctor Who, being simulated inside the browser\footnote{http://webaudio.prototyping.bbc.co.uk/}.
nicholas@755 208 Another example is the BBC R\&D personalised compressor which applies a dynamic range compressor on a radio station that dynamically adjusts the compressor settings to match the listener's environment \cite{mason2015compression}.
nicholas@755 209
nicholas@755 210
nicholas@755 211
nicholas@755 212 % [How is this one different from all these?] improve
nicholas@755 213
nicholas@755 214 % FLEXIBLE (reference (not) appropriate)
nicholas@755 215 In contrast with the tools listed above, we aim to provide an environment in which a variety of multi-stimulus tests can be designed, with a wide range of configurability, while keeping setup and collecting results as straightforward as possible. For instance, the option to provide free-text comment fields allows for tests with individual vocabulary methods, as opposed to only allowing quantitative scales associated to a fixed set of descriptors.
nicholas@755 216 % EASE OF USE: no need to go in the code
nicholas@755 217 To make the tool accessible to a wide range of researchers, we aim to offer maximum functionality even to those with little or no programming background. The tool we present can set up a listening test without reading or adjusting any code, provided no new types of interfaces need to be created.
nicholas@755 218
nicholas@755 219 % ENVIRONMENT %In this paper, we provide a listening test back end that allows for easy set up of a wide variety of listening tests, highly flexible yet very simple and not requiring any programming skills.
nicholas@755 220 Specifically, we present a browser-based perceptual evaluation tool from which any kind of multiple stimulus audio evaluation tool where subjects need to rank, rate, select, or comment on different audio samples can be built.
nicholas@755 221 We also include an example of the multiple stimulus user interface included with the APE tool \cite{deman2014b}, which presents the subject with a number of axes on which a number of markers, corresponding to audio samples, can be moved to reflect any subjective quality, as well as corresponding comment boxes.
nicholas@755 222 However, other graphical user interfaces can be put on top of the engine that we provide with minimal or no modifications. Examples of this are the MUSHRA test \cite{mushra}, single or multiple stimulus evaluation with a two-dimensional interface (such as valence and arousal dimensions), or simple annotation (using free-form text, check boxes, radio buttons or drop-down menus) of one or more audio samples at a time.
nicholas@755 223 In some cases, such as method of adjustment, where the audio is processed by the user, or AB test, where the interface does not show all audio samples to be evaluated at once \cite{bech}, the back end of the tool needs to be modified as well.
nicholas@755 224
nicholas@755 225 In the following sections, we describe the included interface in more detail, discuss the implementation, and cover considerations that were made in the design process of this tool.
nicholas@755 226
nicholas@755 227 %\section{Requirements}\label{sec:requirements}
nicholas@755 228 %???
nicholas@755 229 %
nicholas@755 230 %\begin{itemize}
nicholas@755 231 %\item
nicholas@755 232 %\end{itemize}
nicholas@755 233 \section{Interface}\label{sec:interface}
nicholas@755 234
nicholas@755 235 At this point, we have implemented the interface of the MATLAB-based APE (Audio Perceptual Evaluation) toolbox \cite{deman2014b}. This shows one marker for each simultaneously evaluated audio fragment on one or more horizontal axes, that can be moved to rate or rank the respective fragments in terms of any subjective property, as well as a comment box for every marker, and any extra text boxes for extra comments.
nicholas@755 236 The reason for such an interface, where all stimuli are presented on a single rating axis (or multiple axes if multiple subjective qualities need to be evaluated), is that it urges the subject to consider the rating and/or ranking of the stimuli relative to one another, as opposed to comparing each individual stimulus to a given reference, as is the case with e.g. a MUSHRA test \cite{mushra}. As such, it is ideal for any type of test where the goal is to carefully compare samples against each other, like perceptual evaluation of different mixes of music recordings \cite{deman2015a} or sound synthesis models \cite{durr2015implementation}, as opposed to comparing results of source separation algorithms \cite{mushram} or audio with lower data rate \cite{mushra} to a high quality reference signal.
nicholas@755 237
nicholas@755 238 The markers on the slider at the top of the page are positioned randomly, to minimise the bias that may be introduced when the initial positions are near the beginning, end or middle of the slider. Another approach is to place the markers outside of the slider bar at first and have the subject drag them in, but the authors believe this doesn't encourage careful consideration and comparison of the different fragments as the implicit goal of the test becomes to audition and drag each fragment in just once, rather than to compare all fragments rigorously.
nicholas@755 239
nicholas@755 240 See Figure \ref{fig:interface} for an example of the interface. %? change if a new interface is shown
nicholas@755 241
nicholas@755 242 %Most of these functions are specific to the APE interface design, for instance the AB test will need a different structure for the audio engine and loading of files, since multiple instances of the same file are required. % more generally these pertain to any typeof multi-stimulus test - not quite useful for AB tests, method of adjustment, ABX, and so on.
nicholas@755 243 %There are some areas of the design where certain design choices had to be made such as with the markers.
nicholas@755 244
nicholas@755 245 %For instance, the option to provide free-text comment fields allows for tests with individual vocabulary methods, as opposed to only allowing quantitative scales associated to a fixed set of descriptors.
nicholas@755 246
nicholas@755 247 \begin{figure*}[ht]
nicholas@755 248 \centering
nicholas@755 249 \includegraphics[width=.95\textwidth]{interface.png}
nicholas@755 250 \caption{Example interface, with one axis, seven fragments, and text, radio button and check box style comments.}
nicholas@755 251 \label{fig:interface}
nicholas@755 252 \end{figure*}
nicholas@755 253
nicholas@755 254
nicholas@755 255 \section{Architecture}\label{sec:architecture} % or implementation?
nicholas@755 256
nicholas@755 257 The tool uses entirely client side processing utilising the new HTML5 Web Audio API, supported by most major web browsers. The API allows for constructing audio processing elements and connecting them together to produce a high quality, real time signal process to manipulate audio streams. The API supports multichannel processing and has an accurate playback timer for precise, scheduled playback control. The API is controlled through the browser JavaScript engine and is therefore highly configurable. Processing is all performed in a low latency thread separate from the main JavaScript thread, so there is no blocking due to real time processing.
nicholas@755 258
nicholas@755 259 The web tool itself is split into several files to operate:
nicholas@755 260 \begin{itemize}
nicholas@755 261 \item \texttt{index.html}: The main index file to load the scripts, this is the file the browser must request to load.
nicholas@755 262 \item \texttt{core.js}: Contains global functions and object prototypes to define the audio playback engine, audio objects and loading media files
nicholas@755 263 \item \texttt{ape.js}: Parses setup files to create the interface as instructed, following the same style chain as the MATLAB APE Tool \cite{deman2014b}.
nicholas@755 264 \end{itemize}
nicholas@755 265
nicholas@755 266 The HTML file loads the \texttt{core.js} file along with a few other ancillary files (such as the jQuery JavaScript extensions\footnote{http://jquery.com/}), at which point the browser JavaScript begins to execute the on-page instructions, which gives the URL of the test setup XML document (outlined in Section \ref{sec:setupresultsformats}). \texttt{core.js} parses this document and executes the functions in \texttt{ape.js} to build the web page. The reason for separating these two files is to allow for further interface designs (such as MUSHRA \cite{mushra} or 2D rating \cite{bech}) to be used, which would still require the same underlying core functions outlined in \texttt{core.js}.
nicholas@755 267
nicholas@755 268 The \texttt{ape.js} file has several main functions but the most important are documented here. \textit{loadInterface(xmlDoc)} is called to decode the supplied project document in respect for the interface specified and define any global structures (such as the slider interface). It also identifies the number of pages in the test and randomises the order, if specified to do so. This is the only mandatory function in any of the interface files as this is called by \texttt{core.js} when the document is ready. \texttt{core.js} cannot 'see' any interface specific functions and therefore cannot assume any are available. Therefore \textit{loadInterface(xmlDoc)} is essential to set up the entire test environment. Because the interface files are loaded by \texttt{core.js} and because the functions in \texttt{core.js} are global, the interface files can `see' the \texttt{core.js} file and can therefore not only interact with it, but also modify it.
nicholas@755 269
nicholas@755 270 Each test page is loaded using \textit{loadTest(id)} which performs two major tasks: to populate the interface with the slider elements and comment boxes; and secondly to instruct the \textit{audioEngine} to load the audio fragments and construct the backend audio graph. \textit{loadTest(id)} also instructs the audio engine in \texttt{core.js} to create the \textit{audioObject}.
nicholas@755 271 These are custom audio nodes, one representing each audio element specified in each page.
nicholas@755 272 They consist of a \textit{bufferSourceNode} (a node which holds a buffer of audio samples for playback) and a \textit{gainNode}, both of which are Web Audio API Nodes. Various functions are applied, depending on which metrics are enabled, to record the interaction with the audio element. These nodes are then connected to the \textit{audioEngine} (itself a custom web audio node) containing a \textit{gainNode} (where the various \textit{audioObject}s connect to) for summation before passing the output to the \textit{destinationNode}, a permanent node of the Web Audio API created as the master output. Here, the browser then passes the audio information to the system. % Does this now make sense?
nicholas@755 273 % audio object/audioObject/Audio Object: -- should always be audioObject if talking about the JavaScript object, otherwise should say audio element or audio fragment.
nicholas@755 274
nicholas@755 275 When an \textit{audioObject} is created, it is given the URL of the audio sample to load. This is downloaded into the browser asynchronously using the \textit{XMLHttpRequest} object, which downloads any file into the JavaScript environment for further processing. This is particularly useful for the Web Audio API because it supports downloading of files in their binary form for decoding. Once downloaded the file is decoded using the Web Audio API offline decoder. This uses the browser available decoding schemes to decode the audio files into raw float32 arrays, which are in turn passed to the relevant \textit{audioObject} for playback.
nicholas@755 276
nicholas@755 277 Once each page of the test is completed, identified by pressing the Submit button, the \textit{pageXMLSave(testId)} is called to store all of the collected data until all pages of the test are completed. After the final test and any post-test questions are completed, the \textit{interfaceXMLSave()} function is called. This function generates the final XML file for submission as outlined in Section \ref{sec:setupresultsformats}.
nicholas@755 278
nicholas@755 279 \vspace{-1em}
nicholas@755 280
nicholas@755 281 \section{Support and limitations}\label{sec:support}
nicholas@755 282
nicholas@755 283 Different browsers support a different set of audio file formats and are not consistent in any format. Currently the Web Audio API is best supported in Chrome, Firefox, Opera and Safari. All of these support the use of the uncompressed WAV format. Although not a compact, web friendly format, most transport systems are of a high enough bandwidth this should not be a problem. Ogg Vorbis is another well supported format across the four supported major desktop browsers, as well as MP3 (although Firefox may not support all MP3 types\footnote{https://developer.mozilla.org/en-US/docs/Web/HTML/\\Supported\_media\_formats}). %https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats
nicholas@755 284 One issue of the Web Audio API is that the sample rate is assigned by the system sound device, rather than requested and does not have the ability to request a different one. % Does this make sense? The problem is across all audio files.
nicholas@755 285 As the sampling rate and the effect of resampling may be critical for some listening tests, the default operation when an audio file is loaded with a different sample rate to that of the system is to convert the sample rate. To provide a check for this, the desired sample rate can be supplied with the setup XML and checked against. If the sample rates do not match, a browser alert window is shown asking for the sample rate to be correctly adjusted.
nicholas@755 286 This happens before any loading or decoding of audio files so the browser will only be instructed to fetch files if the system sample rate meets the requirements, avoiding multiple requests for large files until they are actually needed.
nicholas@755 287
nicholas@755 288 %During playback, the playback nodes loop indefinitely until playback is stopped. The gain nodes in the \textit{audioObject}s enable dynamic muting of nodes. When a bar in the sliding ranking is clicked, the audio engine mutes all \textit{audioObject}s and un-mutes the clicked one. Therefore, if the audio samples are perfectly aligned up and of the same sample length, they will remain perfectly aligned with each other.
nicholas@755 289 % Don't think this is relevant anymore
nicholas@755 290
nicholas@755 291
nicholas@755 292 \section{Input and result files}\label{sec:setupresultsformats}
nicholas@755 293
nicholas@755 294 The setup and result files both use the common XML document format to outline the various parameters. The setup file determines the interface to use, the location of audio files, the number of pages and other parameters to define the testing environment. Having one document to modify allows for quick manipulation in a `human readable' form to create new tests, or adjust current ones, without needing to edit multiple web files. Furthermore, we also provide a simple web page to enter all these settings without needing to manipulate the raw XML. An example of such an XML document is presented below. % I mean the .js and .html files, though not sure if any better.
nicholas@755 295
nicholas@755 296
nicholas@755 297
nicholas@755 298
nicholas@755 299 \lstset{
nicholas@755 300 basicstyle=\ttfamily,
nicholas@755 301 columns=fullflexible,
nicholas@755 302 showstringspaces=false,
nicholas@755 303 commentstyle=\color{grey}\upshape
nicholas@755 304 }
nicholas@755 305
nicholas@755 306 \lstdefinelanguage{XML}
nicholas@755 307 {
nicholas@755 308 morestring=[b]",
nicholas@755 309 morestring=[s]{>}{<},
nicholas@755 310 morecomment=[s]{<?}{?>},
nicholas@755 311 stringstyle=\color{black} \bfseries,
nicholas@755 312 identifierstyle=\color{darkblue} \bfseries,
nicholas@755 313 keywordstyle=\color{cyan} \bfseries,
nicholas@755 314 morekeywords={xmlns,version,type},
nicholas@755 315 breaklines=true% list your attributes here
nicholas@755 316 }
nicholas@755 317 \scriptsize
nicholas@755 318 \lstset{language=XML}
nicholas@755 319
nicholas@755 320 \begin{lstlisting}
nicholas@755 321 <?xml version="1.0" encoding="utf-8"?>
nicholas@755 322 <BrowserEvalProjectDocument>
nicholas@755 323 <setup interface="APE" projectReturn="/save" randomiseOrder='false' collectMetrics='true'>
nicholas@755 324 <PreTest>
nicholas@755 325 <question id="location" mandatory="true">Please enter your location.</question>
nicholas@755 326 <number id="age" min="0">Please enter your age</number>
nicholas@755 327 </PreTest>
nicholas@755 328 <PostTest>
nicholas@755 329 <statement>Thank you for taking this listening test!</statement>
nicholas@755 330 </PostTest>
nicholas@755 331 <Metric>
nicholas@755 332 <metricEnable>testTimer</metricEnable>
nicholas@755 333 <metricEnable>elementTimer</metricEnable>
nicholas@755 334 <metricEnable>elementInitialPosition</metricEnable>
nicholas@755 335 <metricEnable>elementTracker</metricEnable>
nicholas@755 336 <metricEnable>elementFlagListenedTo</metricEnable>
nicholas@755 337 <metricEnable>elementFlagMoved</metricEnable>
nicholas@755 338 </Metric>
nicholas@755 339 <interface>
nicholas@755 340 <anchor>20</anchor>
nicholas@755 341 <reference>80</reference>
nicholas@755 342 </interface>
nicholas@755 343 </setup>
nicholas@755 344 <audioHolder id="test-0" hostURL="example_eval/" randomiseOrder='true'>
nicholas@755 345 <interface>
nicholas@755 346 <title>Example Test Question</title>
nicholas@755 347 <scale position="0">Min</scale>
nicholas@755 348 <scale position="100">Max</scale>
nicholas@755 349 <commentBoxPrefix>Comment on fragment</commentBoxPrefix>
nicholas@755 350 </interface>
nicholas@755 351 <audioElements url="1.wav" id="elem1"/>
nicholas@755 352 <audioElements url="2.wav" id="elem2"/>
nicholas@755 353 <audioElements url="3.wav" id="elem3"/>
nicholas@755 354 <CommentQuestion id="generalExperience" type="text">General Comments</CommentQuestion>
nicholas@755 355 <PreTest/>
nicholas@755 356 <PostTest>
nicholas@755 357 <question id="songGenre" mandatory="true">Please enter the genre of the song.</question>
nicholas@755 358 </PostTest>
nicholas@755 359 </audioHolder>
nicholas@755 360 </BrowserEvalProjectDocument>
nicholas@755 361
nicholas@755 362 \end{lstlisting}
nicholas@755 363
nicholas@755 364 \normalsize
nicholas@755 365 \vspace{-1em}
nicholas@755 366
nicholas@755 367 \subsection{Setup and configurability}
nicholas@755 368
nicholas@755 369 The setup document has several defined nodes and structure which are documented with the source code. For example, there is a section for general setup options where any pre-test and post-test questions and statements can be defined. Pre- and post-test dialogue boxes allow for comments or questions to be presented before or after the test, to convey listening test instructions, and gather information about the subject, listening environment, and overall experience of the test. In the example set up document above, a question box with the id `location' is added, which is set to be mandatory to answer. The question is in the PreTest node meaning it will appear before any testing will begin. When the result for the entire test is shown, the response will appear in the PreTest node with the id `location' allowing it to be found easily, provided the id values are meaningful.
nicholas@755 370
nicholas@755 371 We try to cater to a diverse audience with this toolbox, while ensuring it is simple, elegant and straightforward. To that end, we currently include the following options that can be easily switched on and off, by setting the value in the input XML file.
nicholas@755 372
nicholas@755 373 \begin{itemize}[leftmargin=*]%Should have used a description list for this.
nicholas@755 374 \item \textbf{Snap to corresponding position}: When enabled and a fragment is playing, the playhead skips to the same position in the next fragment that is clicked. Otherwise, each fragment is played from the start.
nicholas@755 375 \item \textbf{Loop fragments}: Repeat current fragment when end is reached, until the `Stop' or `Submit' button is clicked.
nicholas@755 376 \item \textbf{Comments}: Displays a separate comment box for each fragment in the page.
nicholas@755 377 \item \textbf{General comment}: Create additional comment boxes to the fragment comment boxes, with a custom question and various input formats such as checkbox or radio.
nicholas@755 378 \item \textbf{Resampling}: When this is enabled, fragments are resampled to match the subject's system's sample rate (a default feature of the Web Audio API). When it is not, an error is shown when the system does not match the requested sample rate.
nicholas@755 379 \item \textbf{Randomise page order}: Randomises the order in which different `pages' are presented. % are we calling this 'pages'?
nicholas@755 380 \item \textbf{Randomise fragment order}: Randomises the order and numbering of the markers and comment boxes corresponding to the fragments. Fragments are referenced to their given ID so referencing is possible (such as `this is much brighter than fragment 4').
nicholas@755 381 \item \textbf{Require (full) playback}: Require that each fragment has been played at least once, partly or fully.
nicholas@755 382 \item \textbf{Require moving}: Require that each marker is moved (dragged) at least once.
nicholas@755 383 \item \textbf{Require comments}: Require the subject to write a comment for each fragment.
nicholas@755 384 \item \textbf{Repeat test}: Number of times each page in the test should be repeated (none by default), to allow familiarisation with the content and experiment, and to investigate consistency of user and variability due to familiarity. These are all gathered before shuffling the order so repeated tests are not back-to-back if possible.
nicholas@755 385 \item \textbf{Returning to previous pages}: Indicates whether it is possible to go back to a previous `page' in the test.
nicholas@755 386 \item \textbf{Lowest rating below [value]}: To enforce a certain use of the rating scale, it can be required to rate at least one sample below a specified value.
nicholas@755 387 \item \textbf{Highest rating above [value]}: To enforce a certain use of the rating scale, it can be required to rate at least one sample above a specified value.
nicholas@755 388 \item \textbf{Reference}: Allows for a separate sample (outside of the axis) to be the `reference', which the subject can play back during the test to help with the task at hand \cite{mushra}.
nicholas@755 389 \item \textbf{Hidden reference/anchor}: Whether or not an explicit `reference' is provided, the `hidden reference' should be rated above a certain value \cite{mushra} - this can be enforced.
nicholas@755 390 Similarly, a `hidden anchor' should be rated lower than a certain value \cite{mushra}.
nicholas@755 391 \item \textbf{Show scrub bar}: Display a playhead on a scrub bar to show the position in the current fragment.
nicholas@755 392 %\item \textbf{Drag playhead}: If scrub bar is visible, allow dragging to move back or forward in a fragment.
nicholas@755 393 \end{itemize}
nicholas@755 394
nicholas@755 395 When one of these options is not included in the setup file, they assume a default value. As a result, the input file can be kept very compact if default values suffice for the test.
nicholas@755 396
nicholas@755 397 % loop, snap to corresponding position, comments, 'general' comment, require same sampling rate, different types of randomisation
nicholas@755 398
nicholas@755 399 \subsection{Results}
nicholas@755 400
nicholas@755 401 The results file is dynamically generated by the interface upon clicking the `Submit' button. This also executes checks, depending on the setup file, to ensure that all fragments have been played back, rated and commented on. The XML output returned contains a node per fragment and contains both the corresponding marker's position and any comments written in the associated comment box. The rating returned is normalised to be a value between 0 and 1, normalising the pixel representation of different browser windows. The results also contain information collected by any defined pre/post questions. An excerpt of an output file is presented below detailing the data collected for a single audioElement.
nicholas@755 402
nicholas@755 403 \scriptsize
nicholas@755 404 \lstset{language=XML}
nicholas@755 405
nicholas@755 406 \begin{lstlisting}
nicholas@755 407 <browserevaluationresult>
nicholas@755 408 <datetime>
nicholas@755 409 <date year="2015" month="5" day="28">2015/5/28</date>
nicholas@755 410 <time hour="13" minute="19" secs="17">13:19:17</time>
nicholas@755 411 </datetime>
nicholas@755 412 <pretest>
nicholas@755 413 <comment id="location">Control Room</comment>
nicholas@755 414 </pretest>
nicholas@755 415 <audioholder>
nicholas@755 416 <pretest></pretest>
nicholas@755 417 <posttest>
nicholas@755 418 <comment id="songGenre">Pop</comment>
nicholas@755 419 </posttest>
nicholas@755 420 <metric>
nicholas@755 421 <metricresult id="testTime">813.32</metricresult>
nicholas@755 422 </metric>
nicholas@755 423 <audioelement id="elem1">
nicholas@755 424 <comment>
nicholas@755 425 <question>Comment on fragment 1</question>
nicholas@755 426 <response>Good, but vocals too quiet.</response>
nicholas@755 427 </comment>
nicholas@755 428 <value>0.639010989010989</value>
nicholas@755 429 <metric>
nicholas@755 430 <metricresult id="elementTimer">111.05</metricresult>
nicholas@755 431 <metricresult id="elementTrackerFull">
nicholas@755 432 <timepos id="0">
nicholas@755 433 <time>61.60</time>
nicholas@755 434 <position>0.6390</position>
nicholas@755 435 </timepos>
nicholas@755 436 </metricresult>
nicholas@755 437 <metricresult id="elementInitialPosition">0.6571</metricresult>
nicholas@755 438 <metricresult id="elementFlagListenedTo">true</metricresult>
nicholas@755 439 </metric>
nicholas@755 440 </audioelement>
nicholas@755 441 </audioHolder>
nicholas@755 442 </browserevaluationresult>
nicholas@755 443
nicholas@755 444 \end{lstlisting}
nicholas@755 445
nicholas@755 446 \normalsize
nicholas@755 447 \vspace{-.5em}
nicholas@755 448 Each page of testing is returned with the results of the entire page included in the structure. One \texttt{audioelement} node is created per audio fragment per page, along with its ID. This includes several child nodes including the rating between 0 and 1, the comment, and any other collected metrics including how long the element was listened for, the initial position, and boolean flags showing if the element was listened to, moved and commented on. Furthermore, each user action (manipulation of any interface element, such as playback or moving a marker) can be logged along with a the corresponding time code.
nicholas@755 449 We also store session data such as the time the test took place and the duration of the test.
nicholas@755 450 We provide the option to store the results locally, and/or to have them sent to a server.
nicholas@755 451
nicholas@755 452 %Here is an example of the set up XML and the results XML: % perhaps best to refer to each XML after each section (set up <> results)
nicholas@755 453 % Should we include an Example of the input and output XML structure?? --> Sure.
nicholas@755 454
nicholas@755 455 %An example of the returned \textit{audioElement} node in the results XML file is as follows.
nicholas@755 456 %
nicholas@755 457 %\texttt{<audioelement id="8"> \\
nicholas@755 458 %<comment> \\
nicholas@755 459 %<question>Comment on track 0</question> \\
nicholas@755 460 %<response> The drums were punchy </response> \\
nicholas@755 461 %</comment> \\
nicholas@755 462 %<value> 0.25169491525423726 </value> \\
nicholas@755 463 %<metric> \\
nicholas@755 464 %<metricresult id="elementTimer"> \\ 2.3278004535147385< /metricresult> \\
nicholas@755 465 %<metricresult id="elementTrackerFull"> \\
nicholas@755 466 %<timepos id="0"> \\
nicholas@755 467 %<time>1.7937414965986385</time> \\
nicholas@755 468 %<position>0.41694915254237286</position> \\
nicholas@755 469 %</timepos> \\
nicholas@755 470 %<timepos id="1"> \\
nicholas@755 471 %<time>2.6993197278911563</time> \\
nicholas@755 472 %<position>0.45847457627118643</position> \\
nicholas@755 473 %</timepos> \\</metricresult> \\
nicholas@755 474 %<metricresult id="elementInitialPosition"> 0.47796610169491527 </metricresult> \\
nicholas@755 475 %<metricresult id="elementFlagListenedTo"> true< /metricresult> \\
nicholas@755 476 %<metricresult id="elementFlagMoved"> true </metricresult> \\
nicholas@755 477 %</metric> \\
nicholas@755 478 %</audioelement>}
nicholas@755 479
nicholas@755 480 % BRECHT: scripts
nicholas@755 481
nicholas@755 482 \begin{figure}[htpb]
nicholas@755 483 \centering
nicholas@755 484 \includegraphics[width=.45\textwidth]{boxplot.png}
nicholas@755 485 \caption{An example boxplot showing ratings by different subjects on fragments labeled `A' through `G'. }
nicholas@755 486 \label{fig:boxplot}
nicholas@755 487 \end{figure}
nicholas@755 488
nicholas@755 489 Python scripts are included to easily store ratings and comments in a CSV file, and to display graphs of numerical ratings (see Figure \ref{fig:boxplot}) or visualise the test's timeline.
nicholas@755 490 Visualisation of plots requires the free matplotlib library\footnote{http://matplotlib.org}.
nicholas@755 491
nicholas@755 492
nicholas@755 493 \section{Conclusions and future work}\label{sec:conclusions}
nicholas@755 494
nicholas@755 495 In this paper we have presented an approach to creating a browser-based listening test environment that can be used for a variety of types of perceptual evaluation of audio.
nicholas@755 496 Specifically, we discussed the use of the toolbox in the context of assessment of preference for different production practices, with identical source material.
nicholas@755 497 The purpose of this paper is to outline the design of this tool, to describe our implementation using basic HTML5 functionality, and to discuss design challenges and limitations of our approach. This tool differentiates itself from other perceptual audio tools by enabling web technologies for multiple participants to perform the test without the need for proprietary software such as MATLAB. The tool also allows for any interface to be built using HTML5 elements to create a variety of dynamic, multiple-stimulus listening test interfaces. It enables quick setup of simple tests with the ability to manage complex tests through a single file. Finally it uses the XML document format to store the results allowing for processing and analysis of results in various third party software such as MATLAB or Python.
nicholas@755 498
nicholas@755 499 % future work
nicholas@755 500 Further work may include the development of other common test designs, such as MUSHRA \cite{mushra}, 2D valence and arousal/activity \cite{eerola2009prediction}, and others. We will add functionality to assist with setting up large-scale tests with remote subjects, so this becomes straightforward and intuitive.
nicholas@755 501 In addition, we will keep on improving and expanding the tool, and highly welcome feedback and contributions from the community.
nicholas@755 502
nicholas@755 503 The source code of this tool can be found on \\ \texttt{code.soundsoftware.ac.uk/projects/}\\ \texttt{webaudioevaluationtool}.
nicholas@755 504
nicholas@755 505
nicholas@755 506 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
nicholas@755 507 %bibliography here
nicholas@755 508 \bibliography{smc2015template}
nicholas@755 509
nicholas@755 510 \end{document}